DomainArtifactsTabPanel.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 org.sleuthkit.autopsy.contentviewers.artifactviewers.GeneralPurposeArtifactViewer;
import com.google.common.eventbus.Subscribe;
import java.awt.Dimension;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.util.logging.Level;
import javax.swing.JPanel;
import javax.swing.JSplitPane;
import javax.swing.SwingUtilities;
import javax.swing.event.ListSelectionEvent;
import javax.swing.event.ListSelectionListener;
import org.sleuthkit.autopsy.contentviewers.artifactviewers.DefaultTableArtifactContentViewer;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.coreutils.ThreadConfined;
import org.sleuthkit.autopsy.discovery.search.DiscoveryEventUtils;
import org.sleuthkit.datamodel.BlackboardArtifact;

final class DomainArtifactsTabPanel extends JPanel {

    private static final long serialVersionUID = 1L;
    private final static Logger logger = Logger.getLogger(DomainArtifactsTabPanel.class.getName());
    private final ArtifactsListPanel listPanel;
    private final BlackboardArtifact.ARTIFACT_TYPE artifactType;
    private AbstractArtifactDetailsPanel rightPanel = null;
    private int dividerLocation = 300;
    private final PropertyChangeListener dividerListener;

    private ArtifactRetrievalStatus status = ArtifactRetrievalStatus.UNPOPULATED;
    private final ListSelectionListener listener = new ListSelectionListener() {
        @Override
        public void valueChanged(ListSelectionEvent event) {
            if (!event.getValueIsAdjusting()) {
                mainSplitPane.removePropertyChangeListener(dividerListener);
                rightPanel.setArtifact(listPanel.getSelectedArtifact());
                mainSplitPane.setDividerLocation(dividerLocation);
                mainSplitPane.addPropertyChangeListener(JSplitPane.DIVIDER_LOCATION_PROPERTY, dividerListener);
            }
        }
    };

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    DomainArtifactsTabPanel(BlackboardArtifact.ARTIFACT_TYPE type) {
        initComponents();
        dividerListener = new PropertyChangeListener() {
            @Override
            public void propertyChange(PropertyChangeEvent evt) {
                if (evt.getPropertyName().equalsIgnoreCase(JSplitPane.DIVIDER_LOCATION_PROPERTY)
                        && evt.getNewValue() instanceof Integer
                        && evt.getOldValue() instanceof Integer
                        && (JSplitPane.UNDEFINED_CONDITION != (int) evt.getNewValue())) {
                    dividerLocation = (int) evt.getNewValue();
                }
            }
        };
        this.artifactType = type;
        listPanel = new ArtifactsListPanel(artifactType);
        listPanel.setPreferredSize(new Dimension(100, 20));
        listPanel.addMouseListener(new ArtifactMenuMouseAdapter(listPanel));

        mainSplitPane.setLeftComponent(listPanel);
        add(mainSplitPane);
        setRightComponent();
        mainSplitPane.addPropertyChangeListener(JSplitPane.DIVIDER_LOCATION_PROPERTY, dividerListener);
        dividerLocation = mainSplitPane.getDividerLocation();
        listPanel.addSelectionListener(listener);
    }

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    private void setRightComponent() {
        switch (artifactType) {
            case TSK_WEB_HISTORY:
            case TSK_WEB_COOKIE:
            case TSK_WEB_SEARCH_QUERY:
            case TSK_WEB_BOOKMARK:
                rightPanel = new GeneralPurposeArtifactViewer();
                break;
            case TSK_WEB_DOWNLOAD:
            case TSK_WEB_CACHE:
                rightPanel = new ContentViewerDetailsPanel();
                break;
            default:
                rightPanel = new DefaultTableArtifactContentViewer();
                break;
        }
        if (rightPanel != null) {
            mainSplitPane.setRightComponent(rightPanel.getComponent());
        }
    }

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    void focusList() {
        listPanel.focusList();
    }

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    ArtifactRetrievalStatus getStatus() {
        return status;
    }

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    void setStatus(ArtifactRetrievalStatus status) {
        this.status = status;
        mainSplitPane.removePropertyChangeListener(dividerListener);
        if (status == ArtifactRetrievalStatus.UNPOPULATED) {
            listPanel.clearList();
            removeAll();
            add(mainSplitPane);
            if (rightPanel != null) {
                rightPanel.setArtifact(null);
            }
        } else if (status == ArtifactRetrievalStatus.POPULATING) {
            removeAll();
            add(new LoadingPanel(artifactType.getDisplayName()));
        }
        mainSplitPane.setDividerLocation(dividerLocation);
        mainSplitPane.addPropertyChangeListener(JSplitPane.DIVIDER_LOCATION_PROPERTY, dividerListener);
    }

    @Subscribe
    void handleArtifactSearchResultEvent(DiscoveryEventUtils.ArtifactSearchResultEvent artifactresultEvent) {
        if (artifactType == artifactresultEvent.getArtifactType() && status == ArtifactRetrievalStatus.POPULATING) {
            SwingUtilities.invokeLater(() -> {
                mainSplitPane.removePropertyChangeListener(dividerListener);
                listPanel.removeSelectionListener(listener);
                listPanel.addArtifacts(artifactresultEvent.getListOfArtifacts());
                status = ArtifactRetrievalStatus.POPULATED;
                setEnabled(!listPanel.isEmpty());
                listPanel.addSelectionListener(listener);
                listPanel.selectFirst();
                removeAll();
                add(mainSplitPane);
                mainSplitPane.setDividerLocation(dividerLocation);
                mainSplitPane.addPropertyChangeListener(JSplitPane.DIVIDER_LOCATION_PROPERTY, dividerListener);
                if (artifactresultEvent.shouldGrabFocus()) {
                    focusList();
                }
                revalidate();
                repaint();
                try {
                    DiscoveryEventUtils.getDiscoveryEventBus().unregister(this);
                } catch (IllegalArgumentException notRegistered) {
                    logger.log(Level.INFO, "Attempting to unregister tab which was not registered");
                    // attempting to remove a tab that was never registered
                }
            });
        }
    }

    @ThreadConfined(type = ThreadConfined.ThreadType.AWT)
    BlackboardArtifact.ARTIFACT_TYPE getArtifactType() {
        return artifactType;
    }

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

        mainSplitPane = new javax.swing.JSplitPane();

        mainSplitPane.setDividerLocation(dividerLocation);
        mainSplitPane.setResizeWeight(0.2);
        mainSplitPane.setLastDividerLocation(250);

        setCursor(new java.awt.Cursor(java.awt.Cursor.DEFAULT_CURSOR));
        setMinimumSize(new java.awt.Dimension(0, 0));
        setLayout(new java.awt.BorderLayout());
    }// </editor-fold>//GEN-END:initComponents


    // Variables declaration - do not modify//GEN-BEGIN:variables
    private javax.swing.JSplitPane mainSplitPane;
    // End of variables declaration//GEN-END:variables

    enum ArtifactRetrievalStatus {
        UNPOPULATED(),
        POPULATING(),
        POPULATED();
    }

}