AddHashValuesToDatabaseProgressDialog.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.modules.hashdatabase;

import java.awt.Color;
import java.awt.Component;
import java.awt.Dimension;
import java.util.ArrayList;
import java.util.List;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JScrollPane;
import javax.swing.JTextArea;
import javax.swing.SwingWorker;
import org.apache.commons.lang3.StringUtils;
import org.openide.util.NbBundle;
import org.sleuthkit.autopsy.modules.hashdatabase.HashDbManager.HashDb;
import org.sleuthkit.datamodel.HashEntry;
import org.sleuthkit.datamodel.TskCoreException;

@SuppressWarnings("PMD.SingularField") // UI widgets cause lots of false positives
public class AddHashValuesToDatabaseProgressDialog extends javax.swing.JDialog {

    private final AddHashValuesToDatabaseDialog parentRef;
    private boolean disposeParent = false;
    private final HashDb hashDb;
    private final List<HashEntry> hashes;
    private final List<String> invalidHashes;
    
    // Matches hash with optional comma separated comment.
    private static final Pattern HASH_LINE_PATTERN = Pattern.compile("^([a-fA-F0-9]{32})(,(.*))?$");
    // The regex group for the hash.
    private static final int HASH_GROUP = 1;
    // The regex group for the comment.
    private static final int COMMENT_GROUP = 3;
    
    private String errorTitle;
    private String errorMessage;
    private final String text;

    AddHashValuesToDatabaseProgressDialog(AddHashValuesToDatabaseDialog parent, HashDb hashDb, String text) {
        super(parent);
        initComponents();
        display(parent);
        this.hashes = new ArrayList<>();
        this.invalidHashes = new ArrayList<>();
        this.parentRef = parent;
        this.hashDb = hashDb;
        this.text = text;
    }

    private void display(Component parent) {
        setLocationRelativeTo(parent);
        setVisible(true);
    }

    final void addHashValuesToDatabase() {
        parentRef.enableAddHashValuesToDatabaseDialog(false);
        new SwingWorker<Object, Void>() {

            @Override
            protected Object doInBackground() throws Exception {
                // parse the text for md5 hashes.
                statusLabel.setText(NbBundle.getMessage(AddHashValuesToDatabaseProgressDialog.class, "AddHashValuesToDatabaseProgressDialog.addHashValuesToDatabase.parsing"));
                getHashesFromTextArea(text);

                // Perform checks for invalid input. Then perform insertion 
                // of hashes in the database.
                if (!invalidHashes.isEmpty()) {
                    statusLabel.setText(NbBundle.getMessage(AddHashValuesToDatabaseProgressDialog.class, "AddHashValuesToDatabaseProgressDialog.addHashValuesToDatabase.invalidHash"));
                    finish(false);
                    errorTitle = NbBundle.getMessage(AddHashValuesToDatabaseProgressDialog.class, "AddHashValuesToDatabaseProgressDialog.addHashValuesToDatabase.invaliHash.msg");
                    errorMessage = "";
                    for (String invalidHash : invalidHashes) {
                        errorMessage = errorMessage + invalidHash + "\n"; // NON-NLS
                    }
                    showErrorsButton.setVisible(true);
                    showErrorsButton.requestFocus();
                } else if (hashes.isEmpty()) {
                    statusLabel.setText(NbBundle.getMessage(AddHashValuesToDatabaseProgressDialog.class, "AddHashValuesToDatabaseProgressDialog.addHashValuesToDatabase.noHashesToAdd"));
                    finish(false);
                } else {
                    try {
                        hashDb.addHashes(hashes);
                        okButton.requestFocus();
                        statusLabel.setText(NbBundle.getMessage(AddHashValuesToDatabaseProgressDialog.class, "AddHashValuesToDatabaseProgressDialog.addHashValuesToDatabase.success", hashes.size()));
                        finish(true);
                        disposeParent = true;
                    } catch (TskCoreException ex) {
                        statusLabel.setText(NbBundle.getMessage(AddHashValuesToDatabaseProgressDialog.class, "AddHashValuesToDatabaseProgressDialog.addHashValuesToDatabase.errorAddingValidHash"));
                        finish(false);
                        errorTitle = NbBundle.getMessage(AddHashValuesToDatabaseProgressDialog.class, "AddHashValuesToDatabaseProgressDialog.addHashValuesToDatabase.errorAddingValidHash.msg");
                        errorMessage = ex.toString();
                        showErrorsButton.setVisible(true);
                        showErrorsButton.requestFocus();
                    }
                }
                return null;
            }
        }.execute();
    }

    private void finish(boolean success) {
        okButton.setEnabled(true);
        addingHashesToDatabaseProgressBar.setIndeterminate(false);
        addingHashesToDatabaseProgressBar.setValue(addingHashesToDatabaseProgressBar.getMaximum());
        if (success) {
            // a hack to set progressbar color.
            addingHashesToDatabaseProgressBar.setStringPainted(true);
            addingHashesToDatabaseProgressBar.setForeground(new Color(50, 205, 50));
            addingHashesToDatabaseProgressBar.setString("");
        } else {
            // a hack to set progressbar color.
            addingHashesToDatabaseProgressBar.setStringPainted(true);
            addingHashesToDatabaseProgressBar.setForeground(new Color(178, 34, 34));
            addingHashesToDatabaseProgressBar.setString("");
        }

    }

    private void getHashesFromTextArea(String text) {
        String[] linesInTextArea = text.split("\\r?\\n"); // NON-NLS
        // These entries may be of <MD5> or <MD5, comment> format
        for (String hashEntry : linesInTextArea) {
            hashEntry = hashEntry.trim();
            Matcher m = HASH_LINE_PATTERN.matcher(hashEntry);
            if (m.find()) {               
                String hash = m.group(HASH_GROUP);
                
                // if there was a match and the match is not empty, assign to comment
                String comment = StringUtils.isNotBlank(m.group(COMMENT_GROUP)) ? 
                    m.group(COMMENT_GROUP).trim() : null;
                
                hashes.add(new HashEntry(null, hash, null, null, comment));
            } else {
                if (!hashEntry.isEmpty()) {
                    invalidHashes.add(hashEntry);
                }
            }
        }
    }

    @SuppressWarnings("unchecked")
    // <editor-fold defaultstate="collapsed" desc="Generated Code">//GEN-BEGIN:initComponents
    private void initComponents() {

        addingHashesToDatabaseProgressBar = new javax.swing.JProgressBar();
        okButton = new javax.swing.JButton();
        statusLabel = new javax.swing.JLabel();
        showErrorsButton = new javax.swing.JButton();

        setDefaultCloseOperation(javax.swing.WindowConstants.DO_NOTHING_ON_CLOSE);
        setTitle(org.openide.util.NbBundle.getMessage(AddHashValuesToDatabaseProgressDialog.class, "AddHashValuesToDatabaseProgressDialog.title")); // NOI18N

        addingHashesToDatabaseProgressBar.setIndeterminate(true);

        org.openide.awt.Mnemonics.setLocalizedText(okButton, org.openide.util.NbBundle.getMessage(AddHashValuesToDatabaseProgressDialog.class, "AddHashValuesToDatabaseProgressDialog.okButton.text")); // NOI18N
        okButton.setEnabled(false);
        okButton.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                okButtonActionPerformed(evt);
            }
        });

        org.openide.awt.Mnemonics.setLocalizedText(statusLabel, org.openide.util.NbBundle.getMessage(AddHashValuesToDatabaseProgressDialog.class, "AddHashValuesToDatabaseProgressDialog.statusLabel.text")); // NOI18N

        org.openide.awt.Mnemonics.setLocalizedText(showErrorsButton, org.openide.util.NbBundle.getMessage(AddHashValuesToDatabaseProgressDialog.class, "AddHashValuesToDatabaseProgressDialog.showErrorsButton.text")); // NOI18N
        showErrorsButton.setVisible(false);
        showErrorsButton.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                showErrorsButtonActionPerformed(evt);
            }
        });

        javax.swing.GroupLayout layout = new javax.swing.GroupLayout(getContentPane());
        getContentPane().setLayout(layout);
        layout.setHorizontalGroup(
            layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
            .addGroup(layout.createSequentialGroup()
                .addContainerGap()
                .addGroup(layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
                    .addGroup(layout.createSequentialGroup()
                        .addComponent(statusLabel)
                        .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED, javax.swing.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE)
                        .addComponent(showErrorsButton))
                    .addGroup(layout.createSequentialGroup()
                        .addComponent(addingHashesToDatabaseProgressBar, javax.swing.GroupLayout.PREFERRED_SIZE, 300, javax.swing.GroupLayout.PREFERRED_SIZE)
                        .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED, 55, Short.MAX_VALUE)
                        .addComponent(okButton)))
                .addContainerGap())
        );
        layout.setVerticalGroup(
            layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
            .addGroup(layout.createSequentialGroup()
                .addContainerGap()
                .addGroup(layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
                    .addComponent(addingHashesToDatabaseProgressBar, javax.swing.GroupLayout.PREFERRED_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.PREFERRED_SIZE)
                    .addComponent(okButton))
                .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
                .addGroup(layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
                    .addComponent(statusLabel)
                    .addComponent(showErrorsButton))
                .addContainerGap(javax.swing.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE))
        );

        pack();
    }// </editor-fold>//GEN-END:initComponents

    private void okButtonActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_okButtonActionPerformed
        parentRef.enableAddHashValuesToDatabaseDialog(true);
        if (disposeParent) {
            parentRef.dispose();
        }
        this.dispose();
    }//GEN-LAST:event_okButtonActionPerformed

    private void showErrorsButtonActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_showErrorsButtonActionPerformed
        JLabel textLabel = new JLabel(errorTitle);
        JTextArea textArea = new JTextArea(errorMessage);
        textArea.setEditable(false);
        JScrollPane scrollPane = new JScrollPane(textArea);
        scrollPane.setPreferredSize(new Dimension(250, 100));
        Object[] jOptionPaneComponents = {textLabel, scrollPane};
        JOptionPane.showMessageDialog(this, jOptionPaneComponents, "Error:\n", JOptionPane.OK_OPTION); // NON-NLS
    }//GEN-LAST:event_showErrorsButtonActionPerformed

    // Variables declaration - do not modify//GEN-BEGIN:variables
    private javax.swing.JProgressBar addingHashesToDatabaseProgressBar;
    private javax.swing.JButton okButton;
    private javax.swing.JButton showErrorsButton;
    private javax.swing.JLabel statusLabel;
    // End of variables declaration//GEN-END:variables
}