LocalDiskDSProcessor.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2013-2017 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.io.File;
import java.nio.file.Path;
import java.util.Calendar;
import java.util.UUID;
import javax.swing.JPanel;
import org.openide.util.NbBundle;
import org.openide.util.lookup.ServiceProvider;
import org.openide.util.lookup.ServiceProviders;
import org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessorCallback;
import org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessorProgressMonitor;
import org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor;
import org.sleuthkit.autopsy.coreutils.DriveUtils;
import org.sleuthkit.autopsy.imagewriter.ImageWriterSettings;
import org.sleuthkit.autopsy.framework.AutoIngestDataSourceProcessor;

@ServiceProviders(value = {
    @ServiceProvider(service = DataSourceProcessor.class),
    @ServiceProvider(service = AutoIngestDataSourceProcessor.class)}
)
public class LocalDiskDSProcessor implements DataSourceProcessor, AutoIngestDataSourceProcessor {

    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 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.refreshTable();
        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.getContentPaths();
            timeZone = configPanel.getTimeZone();
            ignoreFatOrphanFiles = configPanel.getNoFatOrphans();
            if (configPanel.getImageWriterEnabled()) {
                imageWriterSettings = configPanel.getImageWriterSettings();
            } else {
                imageWriterSettings = null;
            }
        }
        addDiskTask = new AddImageTask(deviceId, drivePath, timeZone, ignoreFatOrphanFiles, imageWriterSettings, progressMonitor, callback);
        new Thread(addDiskTask).start();
    }

    public void run(String deviceId, String drivePath, String timeZone, boolean ignoreFatOrphanFiles, DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callback) {
        addDiskTask = new AddImageTask(deviceId, drivePath, timeZone, ignoreFatOrphanFiles, imageWriterSettings, progressMonitor, 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;
    }

    @Override
    public int canProcess(Path dataSourcePath) throws AutoIngestDataSourceProcessorException {

        // verify that the data source is not a file or a directory
        File file = dataSourcePath.toFile();
        // ELTODO this needs to be tested more. should I keep isDirectory or just test for isFile?
        if (file.isFile() || file.isDirectory()) {
            return 0;
        }

        // check whether data source is an existing disk or partition
        // ELTODO this needs to be tested more. do these methods actually work correctly? 
        // or should I use PlatformUtil.getPhysicalDrives() and PlatformUtil.getPartitions() instead?
        String path = dataSourcePath.toString();
        if ((DriveUtils.isPhysicalDrive(path) || DriveUtils.isPartition(path)) && DriveUtils.driveExists(path)) {
            return 90;
        }

        return 0;
    }

    @Override
    public void process(String deviceId, Path dataSourcePath, DataSourceProcessorProgressMonitor progressMonitor, DataSourceProcessorCallback callBack) throws AutoIngestDataSourceProcessorException {
        this.deviceId = deviceId;
        this.drivePath = dataSourcePath.toString();
        this.timeZone = Calendar.getInstance().getTimeZone().getID();
        this.ignoreFatOrphanFiles = false;
        setDataSourceOptionsCalled = true;
        run(deviceId, drivePath, timeZone, ignoreFatOrphanFiles, progressMonitor, callBack);
    }

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

}