AddImageWizardAddingProgressPanel.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011-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.awt.Color;
import java.awt.Cursor;
import java.awt.EventQueue;
import java.awt.Window;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashSet;
import java.util.Iterator;
import java.util.List;
import java.util.Set;
import java.util.UUID;
import java.util.logging.Level;
import javax.swing.JOptionPane;
import javax.swing.SwingUtilities;
import javax.swing.event.ChangeEvent;
import javax.swing.event.ChangeListener;
import org.openide.WizardDescriptor;
import org.openide.util.HelpCtx;
import org.openide.util.Lookup;
import org.openide.util.NbBundle;
import org.openide.windows.WindowManager;
import org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessor;
import org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessorCallback;
import org.sleuthkit.autopsy.corecomponentinterfaces.DataSourceProcessorProgressMonitor;
import org.sleuthkit.autopsy.coreutils.PlatformUtil;
import org.sleuthkit.autopsy.ingest.IngestJobSettings;
import org.sleuthkit.autopsy.ingest.IngestManager;
import org.sleuthkit.autopsy.ingest.runIngestModuleWizard.ShortcutWizardDescriptorPanel;
import org.sleuthkit.datamodel.Content;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.datamodel.Host;

@SuppressWarnings("PMD.SingularField") // UI widgets cause lots of false positives
class AddImageWizardAddingProgressPanel extends ShortcutWizardDescriptorPanel {

    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 DataSourceProcessor dsProcessor = null;
    private boolean cancelled;
    private boolean imgAdded = false;
    private boolean ingested = false;
    private AddImageWizardAddingProgressVisual component;
    private final Set<ChangeListener> listeners = new HashSet<>(1); // or can use ChangeSupport in NB 6.0
    private final List<Content> newContents = Collections.synchronizedList(new ArrayList<>());
    private final DSPProgressMonitorImpl dspProgressMonitorImpl = new DSPProgressMonitorImpl();
    private IngestJobSettings ingestJobSettings;

    AddImageWizardAddingProgressPanel(AddImageAction action) {
        this.addImageAction = action;
    }

    DSPProgressMonitorImpl getDSPProgressMonitorImpl() {
        return dspProgressMonitorImpl;
    }

    private class DSPProgressMonitorImpl implements DataSourceProcessorProgressMonitor {

        @Override
        public void setIndeterminate(final boolean indeterminate) {
            // update the progress bar asynchronously
            EventQueue.invokeLater(new Runnable() {
                @Override
                public void run() {
                    getComponent().getProgressBar().setIndeterminate(indeterminate);
                }
            });
        }

        @Override
        public void setProgress(final int progress) {
            // update the progress bar asynchronously
            EventQueue.invokeLater(new Runnable() {
                @Override
                public void run() {
                    getComponent().getProgressBar().setValue(progress);
                }
            });
        }

        @Override
        public void setProgressMax(final int max) {
            // update the progress bar asynchronously
            EventQueue.invokeLater(new Runnable() {
                @Override
                public void run() {
                    getComponent().getProgressBar().setMaximum(max);
                }
            });
        }

        @Override
        public void setProgressText(final String text) {
            // update the progress UI asynchronously
            EventQueue.invokeLater(new Runnable() {
                @Override
                public void run() {
                    getComponent().setProgressMsgText(text);
                }
            });
        }

    }

    @Override
    public AddImageWizardAddingProgressVisual getComponent() {
        if (component == null) {
            component = new AddImageWizardAddingProgressVisual();
        }
        return component;
    }

    @Override
    public HelpCtx getHelp() {
        // Show no Help button for this panel:
        return HelpCtx.DEFAULT_HELP;
    }

    @Override
    public boolean isValid() {
        // set the focus to the next button of the wizard dialog if it's enabled
        if (imgAdded) {
            Lookup.getDefault().lookup(AddImageAction.class).requestFocusButton(
                    NbBundle.getMessage(this.getClass(), "AddImageWizardAddingProgressPanel.isValid.focusNext"));
        }

        return imgAdded;
    }

    void setStateStarted() {
        component.getProgressBar().setIndeterminate(true);
        component.setProgressBarTextAndColor(
                NbBundle.getMessage(this.getClass(), "AddImageWizardAddingProgressPanel.stateStarted.progressBarText"), 0, Color.black);
    }

    void setStateFinished() {
        imgAdded = true;
        getComponent().setStateFinished();
        fireChangeEvent();
    }

    @Override
    public final void addChangeListener(ChangeListener l) {
        synchronized (listeners) {
            listeners.add(l);
        }
    }

    @Override
    public final void removeChangeListener(ChangeListener l) {
        synchronized (listeners) {
            listeners.remove(l);
        }
    }

    protected final void fireChangeEvent() {
        Iterator<ChangeListener> it;
        synchronized (listeners) {
            it = new HashSet<>(listeners).iterator();
        }
        ChangeEvent ev = new ChangeEvent(this);
        while (it.hasNext()) {
            it.next().stateChanged(ev);
        }
    }

    @Override
    public void readSettings(WizardDescriptor settings) {
        // Start ingest if it hasn't already been started 
        startIngest();
        settings.setOptions(new Object[]{WizardDescriptor.PREVIOUS_OPTION, WizardDescriptor.NEXT_OPTION, WizardDescriptor.FINISH_OPTION, WizardDescriptor.CANCEL_OPTION});
        if (imgAdded) {
            getComponent().setStateFinished();
        }
    }

    void resetReadyToIngest() {
        this.readyToIngest = false;
    }

    void setIngestJobSettings(IngestJobSettings ingestSettings) {
        showWarnings(ingestSettings);
        this.readyToIngest = true;
        this.ingestJobSettings = ingestSettings;
    }

    @Override
    public void storeSettings(WizardDescriptor settings) {
        //why did we do this? -jm
        //  getComponent().resetInfoPanel();
    }

    void addErrors(String errorString, boolean critical) {
        getComponent().showErrors(errorString, critical);
    }

    private void startIngest() {
        if (!newContents.isEmpty() && readyToIngest && !ingested) {
            ingested = true;
            if (dsProcessor != null && !dsProcessor.supportsIngestStream()) {
                IngestManager.getInstance().queueIngestJob(newContents, ingestJobSettings);
            }
            setStateFinished();
        }
    }

    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(WindowManager.getDefault().getMainWindow(), warningMessage.toString());
        }
    }

    void startDataSourceProcessing(DataSourceProcessor dsp, Host selectedHost) {
        if (dsProcessor == null) {  //this can only be run once
            final UUID dataSourceId = UUID.randomUUID();
            newContents.clear();
            cleanupTask = null;
            dsProcessor = dsp;
            new Thread(() -> {
                // 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 {
                        WindowManager.getDefault().getMainWindow().setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
                        cancelDataSourceProcessing(dataSourceId);
                        cancelled = true;
                        WindowManager.getDefault().getMainWindow().setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
                    }
                };

                cleanupTask.enable();

                try {
                    Case.getCurrentCaseThrows().notifyAddingDataSource(dataSourceId);
                } catch (NoCurrentCaseException ex) {
                    Logger.getLogger(AddImageWizardAddingProgressVisual.class.getName()).log(Level.SEVERE, "Exception while getting open case.", ex); //NON-NLS
                }

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

                // Kick off the DSProcessor
                if (dsProcessor.supportsIngestStream()) {
                    // Set readyToIngest to false to prevent the wizard from starting ingest a second time.
                    readyToIngest = false;
                    dsProcessor.runWithIngestStream(selectedHost, ingestJobSettings, getDSPProgressMonitorImpl(), cbObj);
                } else {
                    dsProcessor.run(selectedHost, getDSPProgressMonitorImpl(), cbObj);
                }
            }).start();
            setStateStarted();
        }
    }

    /*
     * 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 = getComponent();
        if (panel != null) {
            Window w = SwingUtilities.getWindowAncestor(panel);
            if (w != null) {
                w.toFront();
            }
        }
        // Tell the panel we're done
        setStateFinished();

        //check the result and display to user
        if (result == DataSourceProcessorCallback.DataSourceProcessorResult.NO_ERRORS) {
            getComponent().setProgressBarTextAndColor(
                    NbBundle.getMessage(this.getClass(), "AddImageWizardIngestConfigPanel.dsProcDone.noErrs.text"), 100, Color.black);
        } else {
            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
            addErrors(err, critErr);
        }
        final Level level = critErr ? Level.SEVERE : Level.WARNING;
        new Thread(() -> {
            //log error messages as Severe if there was a critical error otherwise as Warning.
            //logging performed off of UI thread
            for (String err : errList) {
                Logger.getLogger(AddImageWizardAddingProgressVisual.class.getName()).log(level, "DatasourceID: {0} Error Message: {1}", new Object[]{dataSourceId.toString(), err});
            }
            //notify the UI of the new content added to the case
            try {
                if (!contents.isEmpty()) {
                    Case.getCurrentCaseThrows().notifyDataSourceAdded(contents.get(0), dataSourceId);
                } else {
                    Case.getCurrentCaseThrows().notifyFailedAddingDataSource(dataSourceId);
                }
            } catch (NoCurrentCaseException ex) {
                Logger.getLogger(AddImageWizardAddingProgressVisual.class.getName()).log(Level.SEVERE, "Exception while getting open case.", ex); //NON-NLS
            }
        }).start();

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

    }
}