HashSetFilterPanel.java

Go to the documentation of this file.

/*
 * Autopsy
 *
 * Copyright 2020 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.discovery.ui;

import java.util.ArrayList;
import org.sleuthkit.autopsy.discovery.search.AbstractFilter;
import java.util.List;
import java.util.logging.Level;
import javax.swing.JCheckBox;
import javax.swing.JLabel;
import javax.swing.event.ListSelectionListener;
import org.openide.util.NbBundle;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.coreutils.ThreadConfined;
import org.sleuthkit.autopsy.discovery.search.SearchFiltering;
import org.sleuthkit.datamodel.BlackboardArtifact;
import org.sleuthkit.datamodel.BlackboardAttribute;
import org.sleuthkit.datamodel.TskCoreException;

final class HashSetFilterPanel extends AbstractDiscoveryFilterPanel {

    private static final long serialVersionUID = 1L;
    private final static Logger logger = Logger.getLogger(HashSetFilterPanel.class.getName());

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    HashSetFilterPanel() {
        initComponents();
        setUpHashFilter();
        add(hashSetList);
    }

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    private void setUpHashFilter() {
        try {
            hashSetList.clearList();
            List<String> setNames = DiscoveryUiUtils.getSetNames(BlackboardArtifact.ARTIFACT_TYPE.TSK_HASHSET_HIT,
                    BlackboardAttribute.ATTRIBUTE_TYPE.TSK_SET_NAME);
            for (String name : setNames) {
                hashSetList.addElement(name, null, name);
            }
        } catch (TskCoreException ex) {
            logger.log(Level.SEVERE, "Error loading hash set names", ex);
            hashSetCheckbox.setEnabled(false);
            hashSetList.setEnabled(false);
        }
    }

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

        hashSetCheckbox = new javax.swing.JCheckBox();
        hashSetList = new org.sleuthkit.autopsy.guiutils.CheckBoxListPanel<>();

        org.openide.awt.Mnemonics.setLocalizedText(hashSetCheckbox, org.openide.util.NbBundle.getMessage(HashSetFilterPanel.class, "HashSetFilterPanel.hashSetCheckbox.text")); // NOI18N
        hashSetCheckbox.setMaximumSize(new java.awt.Dimension(150, 25));
        hashSetCheckbox.setMinimumSize(new java.awt.Dimension(150, 25));
        hashSetCheckbox.setPreferredSize(new java.awt.Dimension(150, 25));
        hashSetCheckbox.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                hashSetCheckboxActionPerformed(evt);
            }
        });

        setMinimumSize(new java.awt.Dimension(250, 30));
        setPreferredSize(new java.awt.Dimension(250, 30));
        setLayout(new java.awt.BorderLayout());
        add(hashSetList, java.awt.BorderLayout.CENTER);
    }// </editor-fold>//GEN-END:initComponents

    private void hashSetCheckboxActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_hashSetCheckboxActionPerformed
        hashSetList.setEnabled(hashSetCheckbox.isSelected());
    }//GEN-LAST:event_hashSetCheckboxActionPerformed


    // Variables declaration - do not modify//GEN-BEGIN:variables
    private javax.swing.JCheckBox hashSetCheckbox;
    private org.sleuthkit.autopsy.guiutils.CheckBoxListPanel<String> hashSetList;
    // End of variables declaration//GEN-END:variables

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    @Override
    void configurePanel(boolean selected, List<?> selectedItems) {
        boolean hasHashSets = isFilterSupported();
        hashSetCheckbox.setEnabled(hasHashSets);
        hashSetCheckbox.setSelected(selected && hasHashSets);
        if (hashSetCheckbox.isEnabled() && hashSetCheckbox.isSelected()) {
            hashSetList.setEnabled(true);
            if (selectedItems != null) {
                List<String> setList = new ArrayList<>();
                for (Object item : selectedItems) {
                    if (item instanceof String) {
                        setList.add((String) item);
                    }
                }
                if (!setList.isEmpty()) {
                    hashSetList.setSelectedElements(setList);
                }
            }
        } else {
            hashSetList.setEnabled(false);
        }
    }

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    @Override
    JCheckBox getCheckbox() {
        return hashSetCheckbox;
    }

    @Override
    JLabel getAdditionalLabel() {
        return null;
    }

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    @NbBundle.Messages({"HashSetFilterPanel.error.text=At least one hash set name must be selected."})
    @Override
    String checkForError() {
        if (hashSetCheckbox.isSelected() && hashSetList.getSelectedElements().isEmpty()) {
            return Bundle.HashSetFilterPanel_error_text();
        }
        return "";
    }

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    @Override
    AbstractFilter getFilter() {
        if (hashSetCheckbox.isSelected()) {
            List<String> setList = hashSetList.getSelectedElements();
            return new SearchFiltering.InterestingFileSetFilter(setList);
        }
        return null;
    }
    
    @Override
    void addListSelectionListener(ListSelectionListener listener) {
        hashSetList.addListSelectionListener(listener);
    }

    @Override
    boolean isFilterSupported() {
        return !hashSetList.isEmpty();
    }

}