FileSearchPanel.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011-2021 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.filesearch;

import java.awt.Component;
import java.awt.Cursor;
import java.awt.GridLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.concurrent.CancellationException;
import java.util.concurrent.ExecutionException;
import java.util.logging.Level;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.SwingWorker;
import javax.swing.border.EmptyBorder;
import org.openide.DialogDisplayer;
import org.openide.NotifyDescriptor;
import org.openide.nodes.Node;
import org.openide.util.NbBundle;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException;
import org.sleuthkit.autopsy.corecomponents.DataResultTopComponent;
import org.sleuthkit.autopsy.corecomponents.TableFilterNode;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.coreutils.MessageNotifyUtil;
import org.sleuthkit.autopsy.datamodel.EmptyNode;
import org.sleuthkit.autopsy.filesearch.FileSearchFilter.FilterValidationException;
import org.sleuthkit.datamodel.AbstractFile;
import org.sleuthkit.datamodel.SleuthkitCase;
import org.sleuthkit.datamodel.TskCoreException;

@SuppressWarnings("PMD.SingularField") // UI widgets cause lots of false positives
class FileSearchPanel extends javax.swing.JPanel {
    
    private static final Logger logger = Logger.getLogger(FileSearchPanel.class.getName());
    private static final long serialVersionUID = 1L;
    private final List<FileSearchFilter> filters = new ArrayList<>();
    private static int resultWindowCount = 0; //keep track of result windows so they get unique names
    private static final MimeTypeFilter mimeTypeFilter = new MimeTypeFilter();
    private static final DataSourceFilter dataSourceFilter = new DataSourceFilter();
    private static final String EMPTY_WHERE_CLAUSE = NbBundle.getMessage(DateSearchFilter.class, "FileSearchPanel.emptyWhereClause.text");
    private static SwingWorker<TableFilterNode, Void> searchWorker = null;

    enum EVENT {
        CHECKED
    }

    FileSearchPanel() {
        initComponents();
        customizeComponents();
    }

    private void customizeComponents() {

        JLabel label = new JLabel(NbBundle.getMessage(this.getClass(), "FileSearchPanel.custComp.label.text"));
        label.setAlignmentX(Component.LEFT_ALIGNMENT);
        label.setBorder(new EmptyBorder(0, 0, 10, 0));

        JPanel panel1 = new JPanel();
        panel1.setLayout(new GridLayout(1, 2));
        panel1.add(new JLabel(""));
        JPanel panel2 = new JPanel();
        panel2.setLayout(new GridLayout(1, 2, 20, 0));
        JPanel panel3 = new JPanel();
        panel3.setLayout(new GridLayout(1, 2, 20, 0));
        JPanel panel4 = new JPanel();
        panel4.setLayout(new GridLayout(1, 2, 20, 0));
        JPanel panel5 = new JPanel();
        panel5.setLayout(new GridLayout(1, 2, 20, 0));

        // Create and add filter areas
        NameSearchFilter nameFilter = new NameSearchFilter();
        SizeSearchFilter sizeFilter = new SizeSearchFilter();
        DateSearchFilter dateFilter = new DateSearchFilter();
        KnownStatusSearchFilter knowStatusFilter = new KnownStatusSearchFilter();
        HashSearchFilter hashFilter = new HashSearchFilter();
        panel2.add(new FilterArea(NbBundle.getMessage(this.getClass(), "FileSearchPanel.filterTitle.name"), nameFilter));

        panel3.add(new FilterArea(NbBundle.getMessage(this.getClass(), "FileSearchPanel.filterTitle.metadata"), sizeFilter));

        panel2.add(new FilterArea(NbBundle.getMessage(this.getClass(), "FileSearchPanel.filterTitle.metadata"), dateFilter));
        panel3.add(new FilterArea(NbBundle.getMessage(this.getClass(), "FileSearchPanel.filterTitle.knownStatus"), knowStatusFilter));

        panel5.add(new FilterArea(NbBundle.getMessage(this.getClass(), "HashSearchPanel.md5CheckBox.text"), hashFilter));
        panel5.add(new JLabel(""));
        panel4.add(new FilterArea(NbBundle.getMessage(this.getClass(), "FileSearchPanel.filterTitle.metadata"), mimeTypeFilter));
        panel4.add(new FilterArea(NbBundle.getMessage(this.getClass(), "DataSourcePanel.dataSourceCheckBox.text"), dataSourceFilter));
        filterPanel.add(panel1);
        filterPanel.add(panel2);
        filterPanel.add(panel3);
        filterPanel.add(panel4);
        filterPanel.add(panel5);

        filters.add(nameFilter);
        filters.add(sizeFilter);
        filters.add(dateFilter);
        filters.add(knowStatusFilter);
        filters.add(hashFilter);
        filters.add(mimeTypeFilter);
        filters.add(dataSourceFilter);

        for (FileSearchFilter filter : this.getFilters()) {
            filter.addPropertyChangeListener(new PropertyChangeListener() {
                @Override
                public void propertyChange(PropertyChangeEvent evt) {
                    searchButton.setEnabled(isValidSearch());
                }
            });
        }
        addListenerToAll(new ActionListener() {
            @Override
            public void actionPerformed(ActionEvent e) {
                search();
            }
        });
        searchButton.setEnabled(isValidSearch());
    }

    void setDataSourceFilter(long dataSourceId) {
        dataSourceFilter.setSelectedDataSource(dataSourceId);
    }

    private boolean isValidSearch() {
        boolean enabled = false;
        for (FileSearchFilter filter : this.getFilters()) {
            if (filter.isEnabled()) {
                enabled = true;
                if (!filter.isValid()) {
                    errorLabel.setText(filter.getLastError());
                    return false;
                }
            }
        }
        errorLabel.setText("");
        return enabled;
    }

    @NbBundle.Messages({"FileSearchPanel.emptyNode.display.text=No results found.",
        "FileSearchPanel.searchingNode.display.text=Performing file search by attributes. Please wait.",
        "FileSearchPanel.searchingPath.text=File Search In Progress",
        "FileSearchPanel.cancelledSearch.text=Search Was Cancelled"})
    private void search() {
        if (searchWorker != null && searchWorker.isDone()) {
            searchWorker.cancel(true);
        }
        try {
            if (this.isValidSearch()) {
                // try to get the number of matches first
                Case currentCase = Case.getCurrentCaseThrows(); // get the most updated case
                 Node emptyNode = new TableFilterNode(new EmptyNode(Bundle.FileSearchPanel_searchingNode_display_text()), true);
                String title = NbBundle.getMessage(this.getClass(), "FileSearchPanel.search.results.title", ++resultWindowCount);
                String pathText = Bundle.FileSearchPanel_searchingPath_text();
                final DataResultTopComponent searchResultWin = DataResultTopComponent.createInstance(title, pathText,
                        emptyNode, 0);
                searchResultWin.requestActive(); // make it the active top component
                searchResultWin.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
                searchWorker = new SwingWorker<TableFilterNode, Void>() {
                    List<AbstractFile> contentList = null;

                    @Override
                    protected TableFilterNode doInBackground() throws Exception {
                        try {
                            SleuthkitCase tskDb = currentCase.getSleuthkitCase();
                            contentList = tskDb.findAllFilesWhere(getQuery());

                        } catch (TskCoreException ex) {
                            Logger logger = Logger.getLogger(this.getClass().getName());
                            logger.log(Level.WARNING, "Error while trying to get the number of matches.", ex); //NON-NLS
                        }
                        if (contentList == null) {
                            contentList = Collections.<AbstractFile>emptyList();
                        }
                        if (contentList.isEmpty()) {
                            return new TableFilterNode(new EmptyNode(Bundle.FileSearchPanel_emptyNode_display_text()), true);
                        }
                        SearchNode sn = new SearchNode(contentList);
                        return new TableFilterNode(sn, true, sn.getName());
                    }

                    @Override
                    protected void done() {
                        String pathText = NbBundle.getMessage(this.getClass(), "FileSearchPanel.search.results.pathText");
                        try {
                            TableFilterNode tableFilterNode = get();
                            if (tableFilterNode == null) {  //just incase this get() gets modified to return null or somehow can return null
                                tableFilterNode = new TableFilterNode(new EmptyNode(Bundle.FileSearchPanel_emptyNode_display_text()), true);
                            }
                            if (searchResultWin != null && searchResultWin.isOpened()) {
                                searchResultWin.setNode(tableFilterNode);
                                searchResultWin.requestActive(); // make it the active top component
                            }
                            if (contentList.size() > 10000) {
                                // show info
                                String msg = NbBundle.getMessage(this.getClass(), "FileSearchPanel.search.results.msg", contentList.size());
                                String details = NbBundle.getMessage(this.getClass(), "FileSearchPanel.search.results.details");
                                MessageNotifyUtil.Notify.info(msg, details);
                            }
                        } catch (InterruptedException | ExecutionException ex) {
                            logger.log(Level.SEVERE, "Error while performing file search by attributes", ex);
                        } catch (CancellationException ex) {
                            if (searchResultWin != null && searchResultWin.isOpened()) {
                                Node emptyNode = new TableFilterNode(new EmptyNode(Bundle.FileSearchPanel_cancelledSearch_text()), true);
                                searchResultWin.setNode(emptyNode);
                                pathText = Bundle.FileSearchPanel_cancelledSearch_text();
                            }
                            logger.log(Level.INFO, "File search by attributes was cancelled", ex);
                        } finally {
                            if (searchResultWin != null && searchResultWin.isOpened()) {
                                searchResultWin.setPath(pathText);
                                searchResultWin.requestActive(); // make it the active top component
                                searchResultWin.setCursor(Cursor.getPredefinedCursor(Cursor.DEFAULT_CURSOR));
                            }
                        }
                    }
                };
                if (searchResultWin != null && searchResultWin.isOpened()) {
                    searchResultWin.addPropertyChangeListener(new PropertyChangeListener() {
                        @Override
                        public void propertyChange(PropertyChangeEvent evt) {
                            if (evt.getPropertyName().equals("tcClosed") && !searchWorker.isDone() && evt.getOldValue() == null) {
                                searchWorker.cancel(true);
                                logger.log(Level.INFO, "User has closed the results window while search was in progress, search will be cancelled");
                            }
                        }
                    });
                }
                searchWorker.execute();
            } else {
                throw new FilterValidationException(
                        NbBundle.getMessage(this.getClass(), "FileSearchPanel.search.exception.noFilterSelected.msg"));
            }
        } catch (FilterValidationException | NoCurrentCaseException ex) {
            NotifyDescriptor d = new NotifyDescriptor.Message(
                    NbBundle.getMessage(this.getClass(), "FileSearchPanel.search.validationErr.msg", ex.getMessage()));
            DialogDisplayer.getDefault().notify(d);
        }
    }

    private String getQuery() throws FilterValidationException {

        //String query = "SELECT " + tempQuery + " FROM tsk_files WHERE ";
        String query = "";
        int i = 0;
        for (FileSearchFilter f : this.getEnabledFilters()) {
            String result = f.getPredicate();
            if (!result.isEmpty()) {
                if (i > 0) {
                    query += " AND (" + result + ")"; //NON-NLS
                } else {
                    query += " (" + result + ")"; //NON-NLS
                }
                ++i;
            }
        }

        if (query.isEmpty()) {
            throw new FilterValidationException(EMPTY_WHERE_CLAUSE);
        }
        return query;
    }

    private Collection<FileSearchFilter> getFilters() {
        return filters;
    }

    private Collection<FileSearchFilter> getEnabledFilters() {
        Collection<FileSearchFilter> enabledFilters = new ArrayList<>();

        for (FileSearchFilter f : this.getFilters()) {
            if (f.isEnabled()) {
                enabledFilters.add(f);
            }
        }

        return enabledFilters;
    }

    void resetCaseDependentFilters() {
        dataSourceFilter.resetDataSourceFilter();
        mimeTypeFilter.resetMimeTypeFilter();
    }

    void addListenerToAll(ActionListener l) {
        searchButton.addActionListener(l);
        for (FileSearchFilter fsf : getFilters()) {
            fsf.addActionListener(l);
        }
    }

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

        filterPanel = new javax.swing.JPanel();
        searchButton = new javax.swing.JButton();
        errorLabel = new javax.swing.JLabel();

        setPreferredSize(new java.awt.Dimension(300, 300));

        filterPanel.setBorder(javax.swing.BorderFactory.createEmptyBorder(10, 10, 10, 10));
        filterPanel.setPreferredSize(new java.awt.Dimension(300, 400));
        filterPanel.setLayout(new javax.swing.BoxLayout(filterPanel, javax.swing.BoxLayout.Y_AXIS));

        searchButton.setText(org.openide.util.NbBundle.getMessage(FileSearchPanel.class, "FileSearchPanel.searchButton.text")); // NOI18N

        errorLabel.setText(org.openide.util.NbBundle.getMessage(FileSearchPanel.class, "FileSearchPanel.errorLabel.text")); // NOI18N
        errorLabel.setForeground(new java.awt.Color(255, 51, 51));

        javax.swing.GroupLayout layout = new javax.swing.GroupLayout(this);
        this.setLayout(layout);
        layout.setHorizontalGroup(
            layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
            .addComponent(filterPanel, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE)
            .addGroup(javax.swing.GroupLayout.Alignment.TRAILING, layout.createSequentialGroup()
                .addContainerGap()
                .addComponent(errorLabel, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE)
                .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
                .addComponent(searchButton)
                .addContainerGap())
        );
        layout.setVerticalGroup(
            layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
            .addGroup(layout.createSequentialGroup()
                .addComponent(filterPanel, javax.swing.GroupLayout.DEFAULT_SIZE, 266, Short.MAX_VALUE)
                .addGroup(layout.createParallelGroup(javax.swing.GroupLayout.Alignment.TRAILING)
                    .addComponent(searchButton)
                    .addComponent(errorLabel))
                .addContainerGap())
        );
    }// </editor-fold>//GEN-END:initComponents

    // Variables declaration - do not modify//GEN-BEGIN:variables
    private javax.swing.JLabel errorLabel;
    private javax.swing.JPanel filterPanel;
    private javax.swing.JButton searchButton;
    // End of variables declaration//GEN-END:variables
}