AddContentToHashDbAction.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2013-2019 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.modules.hashdatabase;

import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.logging.Level;
import javax.swing.AbstractAction;
import javax.swing.JMenu;
import javax.swing.JMenuItem;
import javax.swing.JOptionPane;
import org.apache.commons.lang3.StringUtils;
import org.openide.util.NbBundle;
import org.openide.util.Utilities;
import org.openide.util.actions.Presenter;
import org.openide.windows.WindowManager;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.ingest.IngestManager;
import static org.sleuthkit.autopsy.modules.hashdatabase.HashDbManager.HashDb;
import org.sleuthkit.datamodel.AbstractFile;
import org.sleuthkit.datamodel.HashUtility;
import org.sleuthkit.datamodel.TskCoreException;

public final class AddContentToHashDbAction extends AbstractAction implements Presenter.Popup {

    private static AddContentToHashDbAction instance;

    private final static String SINGLE_SELECTION_NAME = NbBundle.getMessage(AddContentToHashDbAction.class,
            "AddContentToHashDbAction.singleSelectionName");
    private final static String MULTI_SELECTION_NAME = NbBundle.getMessage(AddContentToHashDbAction.class,
            "AddContentToHashDbAction.multipleSelectionName");

    //During ingest display strings. This text will be greyed out and unclickable
    private final static String SINGLE_SELECTION_NAME_DURING_INGEST = NbBundle.getMessage(AddContentToHashDbAction.class,
            "AddContentToHashDbAction.singleSelectionNameDuringIngest");
    private final static String MULTI_SELECTION_NAME_DURING_INGEST = NbBundle.getMessage(AddContentToHashDbAction.class,
            "AddContentToHashDbAction.multipleSelectionNameDuringIngest");

    //No MD5 Hash and Empty File display strings. This text will be greyed out and unclickable
    private final static String SINGLE_SELECTION_NAME_EMPTY_FILE = NbBundle.getMessage(AddContentToHashDbAction.class,
            "AddContentToHashDbAction.singleSelectionNameEmpty");
    private final static String MULTI_SELECTION_NAME_EMPTY_FILE = NbBundle.getMessage(AddContentToHashDbAction.class,
            "AddContentToHashDbAction.multipleSelectionNameEmpty");
    private final static String SINGLE_SELECTION_NAME_NO_MD5 = NbBundle.getMessage(AddContentToHashDbAction.class,
            "AddContentToHashDbAction.singleSelectionNameNoMD5");
    private final static String MULTI_SELECTION_NAME_NO_MD5 = NbBundle.getMessage(AddContentToHashDbAction.class,
            "AddContentToHashDbAction.multipleSelectionNameNoMD5");
    private static final long serialVersionUID = 1L;

    public static synchronized AddContentToHashDbAction getInstance() {
        if (null == instance) {
            instance = new AddContentToHashDbAction();
        }
        return instance;
    }

    private AddContentToHashDbAction() {
    }

    public JMenuItem getMenuForFiles(Collection<AbstractFile> selectedFiles) {
        return new AddContentToHashDbMenu(selectedFiles);
    }

    @Override
    public JMenuItem getPopupPresenter() {
        return new AddContentToHashDbMenu();
    }

    @Override
    public void actionPerformed(ActionEvent event) {
    }

    // Instances of this class are used to implement the a pop up menu for this
    // action.
    private final class AddContentToHashDbMenu extends JMenu {

        private static final long serialVersionUID = 1L;

        AddContentToHashDbMenu(Collection<AbstractFile> selectedFiles) {
            super(SINGLE_SELECTION_NAME);
            int numberOfFilesSelected = selectedFiles.size();

            // Disable the menu if file ingest is in progress.
            if (IngestManager.getInstance().isIngestRunning()) {
                setEnabled(false);
                setTextBasedOnNumberOfSelections(numberOfFilesSelected,
                        SINGLE_SELECTION_NAME_DURING_INGEST,
                        MULTI_SELECTION_NAME_DURING_INGEST);
                return;
            } else if (numberOfFilesSelected == 0) {
                setEnabled(false);
                return;
            }
            setTextBasedOnNumberOfSelections(numberOfFilesSelected,
                    SINGLE_SELECTION_NAME,
                    MULTI_SELECTION_NAME);

            // Disable the menu if md5 have not been computed or if the file size 
            // is empty. Display the appropriate reason to the user.
            for (AbstractFile file : selectedFiles) {
                if (file.getSize() == 0) {
                    setEnabled(false);
                    setTextBasedOnNumberOfSelections(numberOfFilesSelected,
                            SINGLE_SELECTION_NAME_EMPTY_FILE,
                            MULTI_SELECTION_NAME_EMPTY_FILE);
                    return;
                } else if (null == file.getMd5Hash() || StringUtils.isBlank(file.getMd5Hash())) {
                    setEnabled(false);
                    setTextBasedOnNumberOfSelections(numberOfFilesSelected,
                            SINGLE_SELECTION_NAME_NO_MD5,
                            MULTI_SELECTION_NAME_NO_MD5);
                    return;
                }
            }
            addExistingHashDatabases(selectedFiles);
            // Add a "New Hash Set..." menu item. Selecting this item invokes a
            // a hash database creation dialog and adds the selected files to the 
            // the new database.
            addSeparator();
            JMenuItem newHashSetItem = new JMenuItem(NbBundle.getMessage(this.getClass(),
                    "AddContentToHashDbAction.ContentMenu.createDbItem"));
            newHashSetItem.addActionListener(new ActionListener() {
                @Override
                public void actionPerformed(ActionEvent e) {
                    HashDb hashDb = new HashDbCreateDatabaseDialog().getHashDatabase();
                    if (null != hashDb) {
                        addFilesToHashSet(selectedFiles, hashDb);
                    }
                }
            });
            add(newHashSetItem);
        }

        private void addExistingHashDatabases(Collection<AbstractFile> selectedFiles) {
            // Get the current set of updateable hash databases and add each
            // one to the menu as a separate menu item. Selecting a hash database
            // adds the selected files to the selected database.
            final List<HashDb> hashDatabases = HashDbManager.getInstance().getUpdateableHashSets();
            if (!hashDatabases.isEmpty()) {
                for (final HashDb database : hashDatabases) {
                    JMenuItem databaseItem = add(database.getHashSetName());
                    databaseItem.addActionListener(new ActionListener() {
                        @Override
                        public void actionPerformed(ActionEvent e) {
                            addFilesToHashSet(selectedFiles, database);
                        }
                    });
                }
            } else {
                JMenuItem empty = new JMenuItem(
                        NbBundle.getMessage(this.getClass(),
                                "AddContentToHashDbAction.ContentMenu.noHashDbsConfigd"));
                empty.setEnabled(false);
                add(empty);
            }
        }

        AddContentToHashDbMenu() {
            // Get any AbstractFile objects from the lookup of the currently focused top component. 
            this(new HashSet<>(Utilities.actionsGlobalContext().lookupAll(AbstractFile.class)));

        }

        private void setTextBasedOnNumberOfSelections(int numberOfFilesSelected,
                String singleSelection, String multiSelection) {
            if (numberOfFilesSelected > 1) {
                setText(multiSelection);
            } else {
                setText(singleSelection);
            }
        }

        private void addFilesToHashSet(final Collection<? extends AbstractFile> files, HashDb hashSet) {
            for (AbstractFile file : files) {
                String md5Hash = file.getMd5Hash();
                if (null != md5Hash) {
                    // don't let them add the hash for an empty file to the DB
                    if (HashUtility.isNoDataMd5(md5Hash)) { //NON-NLS
                        Logger.getLogger(AddContentToHashDbAction.class.getName()).log(Level.INFO, "Not adding " + file.getName() + " to hash set (empty content)"); //NON-NLS
                        JOptionPane.showMessageDialog(WindowManager.getDefault().getMainWindow(),
                                NbBundle.getMessage(this.getClass(),
                                        "AddContentToHashDbAction.addFilesToHashSet.unableToAddFileEmptyMsg",
                                        file.getName()),
                                NbBundle.getMessage(this.getClass(),
                                        "AddContentToHashDbAction.addFilesToHashSet.addToHashDbErr1.text"),
                                JOptionPane.ERROR_MESSAGE);
                        continue;
                    }
                    try {
                        hashSet.addHashes(file);
                    } catch (TskCoreException ex) {
                        Logger.getLogger(AddContentToHashDbAction.class.getName()).log(Level.SEVERE, "Error adding to hash set", ex); //NON-NLS
                        JOptionPane.showMessageDialog(WindowManager.getDefault().getMainWindow(),
                                NbBundle.getMessage(this.getClass(),
                                        "AddContentToHashDbAction.addFilesToHashSet.unableToAddFileMsg",
                                        file.getName()),
                                NbBundle.getMessage(this.getClass(),
                                        "AddContentToHashDbAction.addFilesToHashSet.addToHashDbErr2.text"),
                                JOptionPane.ERROR_MESSAGE);
                    }
                } else {
                    JOptionPane.showMessageDialog(WindowManager.getDefault().getMainWindow(),
                            NbBundle.getMessage(this.getClass(),
                                    "AddContentToHashDbAction.addFilesToHashSet.unableToAddFileSzMsg",
                                    files.size() > 1 ? NbBundle
                                    .getMessage(this.getClass(),
                                            "AddContentToHashDbAction.addFilesToHashSet.files") : NbBundle
                                            .getMessage(this.getClass(),
                                                    "AddContentToHashDbAction.addFilesToHashSet.file")),
                            NbBundle.getMessage(this.getClass(),
                                    "AddContentToHashDbAction.addFilesToHashSet.addToHashDbErr3.text"),
                            JOptionPane.ERROR_MESSAGE);
                    break;
                }
            }
        }
    }
}