PortableCaseInterestingItemsListPanel.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 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.report.infrastructure;

import org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModuleSettings;
import java.awt.Component;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.awt.event.MouseAdapter;
import java.awt.event.MouseEvent;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import javax.swing.JCheckBox;
import javax.swing.JLabel;
import javax.swing.JList;
import javax.swing.ListCellRenderer;
import javax.swing.ListModel;
import javax.swing.event.ListDataListener;
import org.openide.util.NbBundle;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.report.modules.portablecase.PortableCaseReportModule.GetInterestingItemSetNamesCallback;
import org.sleuthkit.datamodel.BlackboardArtifact;
import org.sleuthkit.datamodel.BlackboardAttribute;
import org.sleuthkit.datamodel.TskCoreException;

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

    private List<String> setNames;
    private final Map<String, Boolean> setNameSelections = new LinkedHashMap<>();
    private final SetNamesListModel setNamesListModel = new SetNamesListModel();
    private final SetNamesListCellRenderer setNamesRenderer = new SetNamesListCellRenderer();
    private Map<String, Long> setCounts;

    private final ReportWizardPortableCaseOptionsPanel wizPanel;
    private final PortableCaseReportModuleSettings settings;
    private final boolean useCaseSpecificData;

    PortableCaseInterestingItemsListPanel(ReportWizardPortableCaseOptionsPanel wizPanel, PortableCaseReportModuleSettings options, boolean useCaseSpecificData) {
        this.wizPanel = wizPanel;
        this.useCaseSpecificData = useCaseSpecificData;
        this.settings = options;
        initComponents();
        customizeComponents();

        // update tag selection
        jAllSetsCheckBox.setSelected(settings.areAllSetsSelected());
        setNamesListBox.setEnabled(!jAllSetsCheckBox.isSelected());
        selectButton.setEnabled(!jAllSetsCheckBox.isSelected());
        deselectButton.setEnabled(!jAllSetsCheckBox.isSelected());
        selectAllSets(jAllSetsCheckBox.isSelected());

        this.jAllSetsCheckBox.addItemListener(new ItemListener() {
            @Override
            public void itemStateChanged(ItemEvent e) {
                setNamesListBox.setEnabled(!jAllSetsCheckBox.isSelected());
                selectButton.setEnabled(!jAllSetsCheckBox.isSelected());
                deselectButton.setEnabled(!jAllSetsCheckBox.isSelected());
                selectAllSets(jAllSetsCheckBox.isSelected());
            }
        });
    }

    @NbBundle.Messages({
        "PortableCaseInterestingItemsListPanel.error.errorTitle=Error getting intesting item set names for case",
        "PortableCaseInterestingItemsListPanel.error.noOpenCase=There is no case open",
        "PortableCaseInterestingItemsListPanel.error.errorLoadingTags=Error loading interesting item set names",})
    @SuppressWarnings("deprecation")
    private void customizeComponents() {

        // Get the set names in use for the current case.
        setNames = new ArrayList<>();
        setCounts = new HashMap<>();

        // only try to load tag names if we are displaying case specific data, otherwise
        // we will be displaying case specific data in command line wizard if there is 
        // a case open in the background
        if (useCaseSpecificData) {
            try {
                // Get all SET_NAMEs from interesting item artifacts
                String innerSelect = "SELECT (value_text) AS set_name FROM blackboard_attributes WHERE (artifact_type_id = '"
                        + BlackboardArtifact.ARTIFACT_TYPE.TSK_INTERESTING_ITEM.getTypeID() + "' OR artifact_type_id = '"
                        + BlackboardArtifact.ARTIFACT_TYPE.TSK_INTERESTING_FILE_HIT.getTypeID() + "' OR artifact_type_id = '"
                        + BlackboardArtifact.ARTIFACT_TYPE.TSK_INTERESTING_ARTIFACT_HIT.getTypeID() + "') AND attribute_type_id = '"
                        + BlackboardAttribute.ATTRIBUTE_TYPE.TSK_SET_NAME.getTypeID() + "'"; // NON-NLS

                // Get the count of each SET_NAME
                String query = "set_name, count(1) AS set_count FROM (" + innerSelect + ") set_names GROUP BY set_name"; // NON-NLS

                GetInterestingItemSetNamesCallback callback = new GetInterestingItemSetNamesCallback();
                Case.getCurrentCaseThrows().getSleuthkitCase().getCaseDbAccessManager().select(query, callback);
                setCounts = callback.getSetCountMap();
                setNames.addAll(setCounts.keySet());
            } catch (TskCoreException ex) {
                Logger.getLogger(ReportWizardPortableCaseOptionsVisualPanel.class.getName()).log(Level.SEVERE, "Failed to get interesting item set names", ex); // NON-NLS
            } catch (NoCurrentCaseException ex) {
                // There may not be a case open when configuring report modules for Command Line execution
                if (Case.isCaseOpen()) {
                    Logger.getLogger(ReportWizardPortableCaseOptionsVisualPanel.class.getName()).log(Level.SEVERE, "Exception while getting open case.", ex); // NON-NLS
                }
            }
        }
        Collections.sort(setNames);

        // Mark the set names as unselected. Note that setNameSelections is a
        // LinkedHashMap so that order is preserved and the setNames and setNameSelections
        // containers are "parallel" containers.
        for (String setName : setNames) {
            setNameSelections.put(setName, Boolean.FALSE);
        }

        // Set up the tag names JList component to be a collection of check boxes
        // for selecting tag names. The mouse click listener updates setNameSelections
        // to reflect user choices.
        setNamesListBox.setModel(setNamesListModel);
        setNamesListBox.setCellRenderer(setNamesRenderer);
        setNamesListBox.setVisibleRowCount(-1);
        setNamesListBox.addMouseListener(new MouseAdapter() {
            @Override
            public void mousePressed(MouseEvent evt) {
                JList<?> list = (JList) evt.getSource();
                int index = list.locationToIndex(evt.getPoint());
                if (index > -1) {
                    String value = setNamesListModel.getElementAt(index);
                    setNameSelections.put(value, !setNameSelections.get(value));
                    list.repaint();
                    updateSetNameList();
                }
            }
        });
    }

    private void updateSetNameList() {
        settings.updateSetNames(getSelectedSetNames());
        settings.setAllSetsSelected(jAllSetsCheckBox.isSelected());
        wizPanel.setFinish(settings.isValid());
    }

    private class SetNamesListModel implements ListModel<String> {

        @Override
        public int getSize() {
            return setNames.size();
        }

        @Override
        public String getElementAt(int index) {
            return setNames.get(index);
        }

        @Override
        public void addListDataListener(ListDataListener l) {
            // Nothing to do
        }

        @Override
        public void removeListDataListener(ListDataListener l) {
            // Nothing to do
        }
    }

    private class SetNamesListCellRenderer extends JCheckBox implements ListCellRenderer<String> {

        private static final long serialVersionUID = 1L;

        @Override
        public Component getListCellRendererComponent(JList<? extends String> list, String value, int index, boolean isSelected, boolean cellHasFocus) {
            if (value != null) {
                setEnabled(list.isEnabled());
                setSelected(setNameSelections.get(value));
                setFont(list.getFont());
                setBackground(list.getBackground());
                setForeground(list.getForeground());
                String text = value + " (" + setCounts.get(value) + ")";
                setText(text); // NON-NLS
                setToolTipText(text);
                return this;
            }
            return new JLabel();
        }
    }

    private List<String> getSelectedSetNames() {
        List<String> selectedSetNames = new ArrayList<>();
        for (String setName : setNames) {
            if (setNameSelections.get(setName)) {
                selectedSetNames.add(setName);
            }
        }
        return selectedSetNames;
    }

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

        jPanel1 = new javax.swing.JPanel();
        jScrollPane1 = new javax.swing.JScrollPane();
        setNamesListBox = new javax.swing.JList<>();
        descLabel = new javax.swing.JLabel();
        selectButton = new javax.swing.JButton();
        deselectButton = new javax.swing.JButton();
        jAllSetsCheckBox = new javax.swing.JCheckBox();

        jScrollPane1.setViewportView(setNamesListBox);

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

        org.openide.awt.Mnemonics.setLocalizedText(selectButton, org.openide.util.NbBundle.getMessage(PortableCaseInterestingItemsListPanel.class, "PortableCaseInterestingItemsListPanel.selectButton.text")); // NOI18N
        selectButton.setMaximumSize(new java.awt.Dimension(87, 23));
        selectButton.setMinimumSize(new java.awt.Dimension(87, 23));
        selectButton.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                selectButtonActionPerformed(evt);
            }
        });

        org.openide.awt.Mnemonics.setLocalizedText(deselectButton, org.openide.util.NbBundle.getMessage(PortableCaseInterestingItemsListPanel.class, "PortableCaseInterestingItemsListPanel.deselectButton.text")); // NOI18N
        deselectButton.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                deselectButtonActionPerformed(evt);
            }
        });

        org.openide.awt.Mnemonics.setLocalizedText(jAllSetsCheckBox, org.openide.util.NbBundle.getMessage(PortableCaseInterestingItemsListPanel.class, "PortableCaseInterestingItemsListPanel.jAllSetsCheckBox.text")); // NOI18N
        jAllSetsCheckBox.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                jAllSetsCheckBoxActionPerformed(evt);
            }
        });

        javax.swing.GroupLayout jPanel1Layout = new javax.swing.GroupLayout(jPanel1);
        jPanel1.setLayout(jPanel1Layout);
        jPanel1Layout.setHorizontalGroup(
            jPanel1Layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
            .addGroup(jPanel1Layout.createSequentialGroup()
                .addContainerGap()
                .addGroup(jPanel1Layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
                    .addComponent(jScrollPane1, javax.swing.GroupLayout.PREFERRED_SIZE, 0, Short.MAX_VALUE)
                    .addGroup(jPanel1Layout.createSequentialGroup()
                        .addGroup(jPanel1Layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
                            .addComponent(descLabel)
                            .addGroup(jPanel1Layout.createSequentialGroup()
                                .addComponent(selectButton, javax.swing.GroupLayout.PREFERRED_SIZE, 96, javax.swing.GroupLayout.PREFERRED_SIZE)
                                .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
                                .addComponent(deselectButton))
                            .addComponent(jAllSetsCheckBox))
                        .addGap(0, 8, Short.MAX_VALUE)))
                .addContainerGap())
        );
        jPanel1Layout.setVerticalGroup(
            jPanel1Layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
            .addGroup(jPanel1Layout.createSequentialGroup()
                .addGap(6, 6, 6)
                .addComponent(descLabel)
                .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.UNRELATED)
                .addComponent(jAllSetsCheckBox)
                .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
                .addComponent(jScrollPane1, javax.swing.GroupLayout.DEFAULT_SIZE, 159, Short.MAX_VALUE)
                .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
                .addGroup(jPanel1Layout.createParallelGroup(javax.swing.GroupLayout.Alignment.BASELINE)
                    .addComponent(selectButton, javax.swing.GroupLayout.PREFERRED_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.PREFERRED_SIZE)
                    .addComponent(deselectButton)))
        );

        javax.swing.GroupLayout layout = new javax.swing.GroupLayout(this);
        this.setLayout(layout);
        layout.setHorizontalGroup(
            layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
            .addComponent(jPanel1, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE)
        );
        layout.setVerticalGroup(
            layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
            .addComponent(jPanel1, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE)
        );
    }// </editor-fold>//GEN-END:initComponents

    private void deselectButtonActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_deselectButtonActionPerformed
        selectAllSets(false);
    }//GEN-LAST:event_deselectButtonActionPerformed

    private void selectButtonActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_selectButtonActionPerformed
        selectAllSets(true);
    }//GEN-LAST:event_selectButtonActionPerformed

    private void jAllSetsCheckBoxActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_jAllSetsCheckBoxActionPerformed
        selectAllSets(true);
    }//GEN-LAST:event_jAllSetsCheckBoxActionPerformed

    private void selectAllSets(boolean select) {
        Boolean state = Boolean.TRUE;
        if (!select) {
            state = Boolean.FALSE;
        }
        for (String setName : setNames) {
            setNameSelections.put(setName, state);
        }
        updateSetNameList();
        setNamesListBox.repaint();
    }

    // Variables declaration - do not modify//GEN-BEGIN:variables
    private javax.swing.JLabel descLabel;
    private javax.swing.JButton deselectButton;
    private javax.swing.JCheckBox jAllSetsCheckBox;
    private javax.swing.JPanel jPanel1;
    private javax.swing.JScrollPane jScrollPane1;
    private javax.swing.JButton selectButton;
    private javax.swing.JList<String> setNamesListBox;
    // End of variables declaration//GEN-END:variables
}