AddImageWizardIngestConfigPanel.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011-2015 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 org.openide.util.NbBundle;
import java.awt.Color;
import java.awt.Component;
import java.awt.Window;
import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.UUID;
import javax.swing.JButton;
import javax.swing.JOptionPane;
import javax.swing.SwingUtilities;
import javax.swing.event.ChangeListener;
import org.openide.WizardDescriptor;
import org.openide.util.HelpCtx;
import org.sleuthkit.datamodel.Content;
import org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessorCallback;
import org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor;
import org.sleuthkit.autopsy.coreutils.PlatformUtil;
import org.sleuthkit.autopsy.ingest.IngestJobSettings;
import org.sleuthkit.autopsy.ingest.IngestJobSettingsPanel;
import org.sleuthkit.autopsy.ingest.IngestManager;

class AddImageWizardIngestConfigPanel implements WizardDescriptor.Panel<WizardDescriptor> {

    private final IngestJobSettingsPanel ingestJobSettingsPanel;

    private Component component = null;

    private final List<Content> newContents = Collections.synchronizedList(new ArrayList<Content>());
    private boolean ingested = false;
    private boolean readyToIngest = false;

    // task that will clean up the created database file if the wizard is cancelled before it finishes
    private AddImageAction.CleanupTask cleanupTask;

    private final AddImageAction addImageAction;

    private final AddImageWizardAddingProgressPanel progressPanel;
    private final AddImageWizardChooseDataSourcePanel dataSourcePanel;

    private DataSourceProcessor dsProcessor;
    private boolean cancelled;

    AddImageWizardIngestConfigPanel(AddImageWizardChooseDataSourcePanel dsPanel, AddImageAction action, AddImageWizardAddingProgressPanel proPanel) {
        this.addImageAction = action;
        this.progressPanel = proPanel;
        this.dataSourcePanel = dsPanel;

        IngestJobSettings ingestJobSettings = new IngestJobSettings(AddImageWizardIngestConfigPanel.class.getCanonicalName());
        showWarnings(ingestJobSettings);
        this.ingestJobSettingsPanel = new IngestJobSettingsPanel(ingestJobSettings);
    }

    @Override
    public Component getComponent() {
        if (component == null) {
            component = new AddImageWizardIngestConfigVisual(this.ingestJobSettingsPanel);
        }
        return component;
    }

    @Override
    public HelpCtx getHelp() {
        // Show no Help button for this panel:
        return HelpCtx.DEFAULT_HELP;
        // If you have context help:
        // return new HelpCtx(SampleWizardPanel1.class);
    }

    @Override
    public boolean isValid() {
        // If it is always OK to press Next or Finish, then:
        return true;
        // If it depends on some condition (form filled out...), then:
        // return someCondition();
        // and when this condition changes (last form field filled in...) then:
        // fireChangeEvent();
        // and uncomment the complicated stuff below.
    }

    @Override
    public final void addChangeListener(ChangeListener l) {
    }

    @Override
    public final void removeChangeListener(ChangeListener l) {
    }

    // You can use a settings object to keep track of state. Normally the
    // settings object will be the WizardDescriptor, so you can use
    // WizardDescriptor.getProperty & putProperty to store information entered
    // by the user.
    @Override
    public void readSettings(WizardDescriptor settings) {
        JButton cancel = new JButton(
                NbBundle.getMessage(this.getClass(), "AddImageWizardIngestConfigPanel.CANCEL_BUTTON.text"));
        cancel.setEnabled(false);
        settings.setOptions(new Object[]{WizardDescriptor.PREVIOUS_OPTION, WizardDescriptor.NEXT_OPTION, WizardDescriptor.FINISH_OPTION, cancel});
        cleanupTask = null;
        readyToIngest = false;

        newContents.clear();

        // Start processing the data source by handing it off to the selected DSP, 
        // so it gets going in the background while the user is still picking the Ingest modules
        startDataSourceProcessing(settings);
    }

    @Override
    public void storeSettings(WizardDescriptor settings) {
        IngestJobSettings ingestJobSettings = this.ingestJobSettingsPanel.getSettings();
        ingestJobSettings.save();
        showWarnings(ingestJobSettings);

        // Start ingest if it hasn't already been started
        readyToIngest = true;
        startIngest();
    }

    private static void showWarnings(IngestJobSettings ingestJobSettings) {
        List<String> warnings = ingestJobSettings.getWarnings();
        if (warnings.isEmpty() == false) {
            StringBuilder warningMessage = new StringBuilder();
            for (String warning : warnings) {
                warningMessage.append(warning).append("\n");
            }
            JOptionPane.showMessageDialog(null, warningMessage.toString());
        }
    }

    private void startIngest() {
        if (!newContents.isEmpty() && readyToIngest && !ingested) {
            ingested = true;
            IngestManager.getInstance().queueIngestJob(newContents, ingestJobSettingsPanel.getSettings());
            progressPanel.setStateFinished();
        }
    }

    private void startDataSourceProcessing(WizardDescriptor settings) {
        final UUID dataSourceId = UUID.randomUUID();

        // Add a cleanup task to interrupt the background process if the
        // wizard exits while the background process is running.
        cleanupTask = addImageAction.new CleanupTask() {
            @Override
            void cleanup() throws Exception {
                cancelDataSourceProcessing(dataSourceId);
                cancelled = true;
            }
        };

        cleanupTask.enable();

        // get the selected DSProcessor
        dsProcessor = dataSourcePanel.getComponent().getCurrentDSProcessor();

        new Thread(() -> {
            Case.getCurrentCase().notifyAddingDataSource(dataSourceId);
        }).start();
        DataSourceProcessorCallback cbObj = new DataSourceProcessorCallback() {
            @Override
            public void doneEDT(DataSourceProcessorCallback.DataSourceProcessorResult result, List<String> errList, List<Content> contents) {
                dataSourceProcessorDone(dataSourceId, result, errList, contents);
            }
        };

        progressPanel.setStateStarted();

        // Kick off the DSProcessor 
        dsProcessor.run(progressPanel.getDSPProgressMonitorImpl(), cbObj);

    }

    /*
     * Cancels the data source processing - in case the users presses 'Cancel'
     */
    private void cancelDataSourceProcessing(UUID dataSourceId) {
        dsProcessor.cancel();
    }

    /*
     * Callback for the data source processor. Invoked by the DSP on the EDT
     * thread, when it finishes processing the data source.
     */
    private void dataSourceProcessorDone(UUID dataSourceId, DataSourceProcessorCallback.DataSourceProcessorResult result, List<String> errList, List<Content> contents) {
        // disable the cleanup task
        cleanupTask.disable();

        // Get attention for the process finish
        // this caused a crash on OS X
        if (PlatformUtil.isWindowsOS() == true) {
            java.awt.Toolkit.getDefaultToolkit().beep(); //BEEP!
        }
        AddImageWizardAddingProgressVisual panel = progressPanel.getComponent();
        if (panel != null) {
            Window w = SwingUtilities.getWindowAncestor(panel);
            if (w != null) {
                w.toFront();
            }
        }
        // Tell the panel we're done
        progressPanel.setStateFinished();

        //check the result and display to user
        if (result == DataSourceProcessorCallback.DataSourceProcessorResult.NO_ERRORS) {
            progressPanel.getComponent().setProgressBarTextAndColor(
                    NbBundle.getMessage(this.getClass(), "AddImageWizardIngestConfigPanel.dsProcDone.noErrs.text"), 100, Color.black);
        } else {
            progressPanel.getComponent().setProgressBarTextAndColor(
                    NbBundle.getMessage(this.getClass(), "AddImageWizardIngestConfigPanel.dsProcDone.errs.text"), 100, Color.red);
        }

        //if errors, display them on the progress panel
        boolean critErr = false;
        if (result == DataSourceProcessorCallback.DataSourceProcessorResult.CRITICAL_ERRORS) {
            critErr = true;
        }
        for (String err : errList) {
            //  TBD: there probably should be an error level for each error
            progressPanel.addErrors(err, critErr);
        }

        //notify the UI of the new content added to the case
        new Thread(() -> {
            if (!contents.isEmpty()) {
                Case.getCurrentCase().notifyDataSourceAdded(contents.get(0), dataSourceId);
            } else {
                Case.getCurrentCase().notifyFailedAddingDataSource(dataSourceId);
            }
        }).start();

        if (!cancelled) {
            newContents.clear();
            newContents.addAll(contents);
            progressPanel.setStateStarted();
            startIngest();
        } else {
            cancelled = false;
        }

    }
}