LocalDiskDSProcessor.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2013-2018 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.sleuthkit.autopsy.casemodule;

import java.util.ArrayList;
import java.util.Calendar;
import java.util.List;
import java.util.UUID;
import java.util.logging.Level;
import javax.swing.JPanel;
import org.openide.util.NbBundle;
import org.openide.util.lookup.ServiceProvider;
import org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessorCallback;
import org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessorProgressMonitor;
import org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.imagewriter.ImageWriterSettings;
import org.sleuthkit.datamodel.Image;
import org.sleuthkit.datamodel.SleuthkitJNI;
import org.sleuthkit.datamodel.TskCoreException;

@ServiceProvider(service = DataSourceProcessor.class)
public class LocalDiskDSProcessor implements DataSourceProcessor {

    private final Logger logger = Logger.getLogger(LocalDiskDSProcessor.class.getName());
    private static final String DATA_SOURCE_TYPE = NbBundle.getMessage(LocalDiskDSProcessor.class, "LocalDiskDSProcessor.dsType.text");
    private final LocalDiskPanel configPanel;
    private AddImageTask addDiskTask;
    /*
     * TODO: Remove the setDataSourceOptionsCalled flag and the settings fields
     * when the deprecated method setDataSourceOptions is removed.
     */
    private String deviceId;
    private String drivePath;
    private int sectorSize;
    private String timeZone;
    private ImageWriterSettings imageWriterSettings;
    private boolean ignoreFatOrphanFiles;
    private boolean setDataSourceOptionsCalled;

    public LocalDiskDSProcessor() {
        configPanel = LocalDiskPanel.getDefault();
    }

    public static String getType() {
        return DATA_SOURCE_TYPE;
    }

    @Override
    public String getDataSourceType() {
        return DATA_SOURCE_TYPE;
    }

    @Override
    public JPanel getPanel() {
        configPanel.resetLocalDiskSelection();
        return configPanel;
    }

    @Override
    public boolean isPanelValid() {
        return configPanel.validatePanel();
    }

    @Override
    public void run(DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callback) {
        if (!setDataSourceOptionsCalled) {
            deviceId = UUID.randomUUID().toString();
            drivePath = configPanel.getContentPath();
            sectorSize = configPanel.getSectorSize();
            timeZone = configPanel.getTimeZone();
            ignoreFatOrphanFiles = configPanel.getNoFatOrphans();
            if (configPanel.getImageWriterEnabled()) {
                imageWriterSettings = configPanel.getImageWriterSettings();
            } else {
                imageWriterSettings = null;
            }
        }

        Image image;
        try {
            image = SleuthkitJNI.addImageToDatabase(Case.getCurrentCase().getSleuthkitCase(),
                new String[]{drivePath}, sectorSize,
                timeZone, null, null, null, deviceId);
        } catch (TskCoreException ex) {
            logger.log(Level.SEVERE, "Error adding local disk with path " + drivePath + " to database", ex);
            final List<String> errors = new ArrayList<>();
            errors.add(ex.getMessage());
            callback.done(DataSourceProcessorCallback.DataSourceProcessorResult.CRITICAL_ERRORS, errors, new ArrayList<>());
            return;
        }   

        addDiskTask = new AddImageTask(
                new AddImageTask.ImageDetails(deviceId, image, sectorSize, timeZone, ignoreFatOrphanFiles, null, null, null, imageWriterSettings), 
                progressMonitor,
                new StreamingAddDataSourceCallbacks(new DefaultIngestStream()), 
                new StreamingAddImageTaskCallback(new DefaultIngestStream(), callback));
        new Thread(addDiskTask).start();
    }

    public void run(String deviceId, String drivePath, String timeZone, boolean ignoreFatOrphanFiles, DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callback) {
        run(deviceId, drivePath, 0, timeZone, ignoreFatOrphanFiles, progressMonitor, callback);
    }

    private void run(String deviceId, String drivePath, int sectorSize, String timeZone, boolean ignoreFatOrphanFiles, DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callback) {
        Image image;
        try {
            image = SleuthkitJNI.addImageToDatabase(Case.getCurrentCase().getSleuthkitCase(),
                new String[]{drivePath}, sectorSize,
                timeZone, null, null, null, deviceId);
        } catch (TskCoreException ex) {
            logger.log(Level.SEVERE, "Error adding local disk with path " + drivePath + " to database", ex);
            final List<String> errors = new ArrayList<>();
            errors.add(ex.getMessage());
            callback.done(DataSourceProcessorCallback.DataSourceProcessorResult.CRITICAL_ERRORS, errors, new ArrayList<>());
            return;
        } 
        
            addDiskTask = new AddImageTask(new AddImageTask.ImageDetails(deviceId, image, sectorSize, timeZone, ignoreFatOrphanFiles, null, null, null, imageWriterSettings), 
                progressMonitor, 
                new StreamingAddDataSourceCallbacks(new DefaultIngestStream()), 
                new StreamingAddImageTaskCallback(new DefaultIngestStream(), callback));
        new Thread(addDiskTask).start();
    }

    @Override
    public void cancel() {
        if (null != addDiskTask) {
            addDiskTask.cancelTask();
        }
    }

    @Override
    public void reset() {
        deviceId = null;
        drivePath = null;
        timeZone = null;
        ignoreFatOrphanFiles = false;
        setDataSourceOptionsCalled = false;
    }

    @Deprecated
    public void setDataSourceOptions(String drivePath, String timeZone, boolean ignoreFatOrphanFiles) {
        this.deviceId = UUID.randomUUID().toString();
        this.drivePath = drivePath;
        this.sectorSize = 0;
        this.timeZone = Calendar.getInstance().getTimeZone().getID();
        this.ignoreFatOrphanFiles = ignoreFatOrphanFiles;
        setDataSourceOptionsCalled = true;
    }

}