PastOccurrencesFilterPanel.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 java.util.List;
import javax.swing.JCheckBox;
import javax.swing.JLabel;
import javax.swing.event.ListSelectionListener;
import org.openide.util.NbBundle;
import org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository;
import org.sleuthkit.autopsy.coreutils.ThreadConfined;
import org.sleuthkit.autopsy.discovery.search.AbstractFilter;
import org.sleuthkit.autopsy.discovery.search.SearchData;
import org.sleuthkit.autopsy.discovery.search.SearchData.Type;
import org.sleuthkit.autopsy.discovery.search.SearchFiltering;

final class PastOccurrencesFilterPanel extends AbstractDiscoveryFilterPanel {

    private static final long serialVersionUID = 1L;
    private final Type type;

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    PastOccurrencesFilterPanel(Type type) {
        initComponents();
        this.type = type;
        setUpFrequencyFilter();
        add(crFrequencyList);
    }

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

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

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

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

    private void pastOccurrencesCheckboxActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_pastOccurrencesCheckboxActionPerformed
        crFrequencyList.setEnabled(pastOccurrencesCheckbox.isSelected());
    }//GEN-LAST:event_pastOccurrencesCheckboxActionPerformed

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    private void setUpFrequencyFilter() {
        crFrequencyList.clearList();
        if (!CentralRepository.isEnabled()) {
            if (type != Type.DOMAIN) {
                for (SearchData.Frequency freq : SearchData.Frequency.getOptionsForFilteringWithoutCr()) {
                    crFrequencyList.addElement(freq.toString(), null, freq);
                }
            }
        } else {
            for (SearchData.Frequency freq : SearchData.Frequency.getOptionsForFilteringWithCr()) {
                if (type != Type.DOMAIN || freq != SearchData.Frequency.KNOWN) {
                    crFrequencyList.addElement(freq.toString(), null, freq);
                }
            }
        }
    }

    // Variables declaration - do not modify//GEN-BEGIN:variables
    private org.sleuthkit.autopsy.guiutils.CheckBoxListPanel<SearchData.Frequency> crFrequencyList;
    private javax.swing.JCheckBox pastOccurrencesCheckbox;
    // End of variables declaration//GEN-END:variables

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    @Override
    void configurePanel(boolean selected, List<?> selectedItems) {
        boolean canBeFilteredOn = type != Type.DOMAIN || CentralRepository.isEnabled();
        pastOccurrencesCheckbox.setEnabled(canBeFilteredOn);
        pastOccurrencesCheckbox.setSelected(selected && canBeFilteredOn);

        if (pastOccurrencesCheckbox.isEnabled() && pastOccurrencesCheckbox.isSelected()) {
            crFrequencyList.setEnabled(true);
            if (selectedItems != null) {
                List<SearchData.Frequency> frequencyList = new ArrayList<>();
                for (Object item : selectedItems) {
                    if (item instanceof SearchData.Frequency) {
                        frequencyList.add((SearchData.Frequency) item);
                    }
                }
                if (!frequencyList.isEmpty()) {
                    crFrequencyList.setSelectedElements(frequencyList);
                }
            }
        } else {
            crFrequencyList.setEnabled(false);
        }
    }

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

    @Override
    JLabel getAdditionalLabel() {
        return null;
    }

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    @NbBundle.Messages({"PastOccurrencesFilterPanel.error.text=At least one value in the past occurrence filter must be selected."})
    @Override
    String checkForError() {
        if (pastOccurrencesCheckbox.isSelected() && crFrequencyList.getSelectedElements().isEmpty()) {
            return Bundle.PastOccurrencesFilterPanel_error_text();
        }
        return "";
    }

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    @Override
    AbstractFilter getFilter() {
        if (pastOccurrencesCheckbox.isSelected()) {
            List<SearchData.Frequency> frequencies = crFrequencyList.getSelectedElements();
            return new SearchFiltering.FrequencyFilter(frequencies);
        }
        return null;
    }

    @Override
    void addListSelectionListener(ListSelectionListener listener) {
        crFrequencyList.addListSelectionListener(listener);
    }

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

}