DataSourceSummaryTabbedPane.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * 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.datasourcesummary.ui;

import java.awt.CardLayout;
import java.awt.Component;
import java.beans.PropertyChangeListener;
import java.util.Arrays;
import java.util.EnumSet;
import java.util.List;
import java.util.function.Consumer;
import java.util.function.Function;
import org.openide.util.NbBundle.Messages;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.casemodule.IngestJobInfoPanel;
import org.sleuthkit.autopsy.datasourcesummary.ui.ExcelExportAction.ExportableTab;
import org.sleuthkit.autopsy.datasourcesummary.uiutils.ExcelExport.ExcelSheetExport;
import org.sleuthkit.datamodel.DataSource;

@Messages({
    "DataSourceSummaryTabbedPane_typesTab_title=Types",
    "DataSourceSummaryTabbedPane_detailsTab_title=Container",
    "DataSourceSummaryTabbedPane_userActivityTab_title=User Activity",
    "DataSourceSummaryTabbedPane_ingestHistoryTab_title=Ingest History",
    "DataSourceSummaryTabbedPane_recentFileTab_title=Recent Files",
    "DataSourceSummaryTabbedPane_pastCasesTab_title=Past Cases",
    "DataSourceSummaryTabbedPane_analysisTab_title=Analysis",
    "DataSourceSummaryTabbedPane_geolocationTab_title=Geolocation",
    "DataSourceSummaryTabbedPane_timelineTab_title=Timeline",
    "DataSourceSummaryTabbedPane_exportTab_title=Export"
})
public class DataSourceSummaryTabbedPane extends javax.swing.JPanel {

    private class DataSourceTab implements ExportableTab {

        private final String tabTitle;
        private final Component component;
        private final Consumer<DataSource> onDataSource;
        private final Function<DataSource, List<ExcelSheetExport>> excelExporter;
        private final Runnable onClose;
        private final Runnable onInit;

        DataSourceTab(String tabTitle, BaseDataSourceSummaryPanel panel) {
            this(tabTitle, panel, panel::setDataSource, panel::getExports, panel::close, panel::init);
            panel.setParentCloseListener(() -> notifyParentClose());
        }

        DataSourceTab(String tabTitle, Component component, Consumer<DataSource> onDataSource,
                Function<DataSource, List<ExcelSheetExport>> excelExporter, Runnable onClose,
                Runnable onInit) {
            this.tabTitle = tabTitle;
            this.component = component;
            this.onDataSource = onDataSource;
            this.excelExporter = excelExporter;
            this.onClose = onClose;
            this.onInit = onInit;
        }

        @Override
        public String getTabTitle() {
            return tabTitle;
        }

        Component getComponent() {
            return component;
        }

        Consumer<DataSource> getOnDataSource() {
            return onDataSource;
        }

        @Override
        public List<ExcelSheetExport> getExcelExports(DataSource dataSource) {
            return excelExporter == null ? null : excelExporter.apply(dataSource);
        }

        public Runnable getOnClose() {
            return onClose;
        }

        public Runnable getOnInit() {
            return onInit;
        }
    }

    private static final long serialVersionUID = 1L;

    // needs to match value provided for card layout in designed
    private static final String TABBED_PANE = "tabbedPane";
    private static final String NO_DATASOURCE_PANE = "noDataSourcePane";

    private Runnable notifyParentClose = null;
    private final IngestJobInfoPanel ingestHistoryPanel = new IngestJobInfoPanel();

    // create an export panel whose button triggers the export to XLSX action
    private final ExportPanel exportPanel = new ExportPanel();

    private final List<DataSourceTab> tabs = Arrays.asList(
            new DataSourceTab(Bundle.DataSourceSummaryTabbedPane_typesTab_title(), new TypesPanel()),
            new DataSourceTab(Bundle.DataSourceSummaryTabbedPane_userActivityTab_title(), new UserActivityPanel()),
            new DataSourceTab(Bundle.DataSourceSummaryTabbedPane_analysisTab_title(), new AnalysisPanel()),
            new DataSourceTab(Bundle.DataSourceSummaryTabbedPane_recentFileTab_title(), new RecentFilesPanel()),
            new DataSourceTab(Bundle.DataSourceSummaryTabbedPane_pastCasesTab_title(), new PastCasesPanel()),
            new DataSourceTab(Bundle.DataSourceSummaryTabbedPane_geolocationTab_title(), new GeolocationPanel()),
            new DataSourceTab(Bundle.DataSourceSummaryTabbedPane_timelineTab_title(), new TimelinePanel()),
            // do nothing on closing 
            new DataSourceTab(
                    Bundle.DataSourceSummaryTabbedPane_ingestHistoryTab_title(),
                    ingestHistoryPanel,
                    ingestHistoryPanel::setDataSource,
                    IngestJobExcelExport::getExports,
                    null,
                    null),
            new DataSourceTab(Bundle.DataSourceSummaryTabbedPane_detailsTab_title(), new ContainerPanel()),
            new DataSourceTab(
                    Bundle.DataSourceSummaryTabbedPane_exportTab_title(),
                    exportPanel,
                    null,
                    null,
                    null,
                    null)
    );

    // the action that does the export
    private final ExcelExportAction exportAction = new ExcelExportAction(tabs);

    private DataSource dataSource = null;
    private CardLayout cardLayout;

    private final PropertyChangeListener caseEventsListener = (evt) -> {
        if (evt.getPropertyName().equals(Case.Events.CURRENT_CASE.toString()) && evt.getNewValue() == null) {
            setDataSource(null);
        }
    };

    public DataSourceSummaryTabbedPane() {
        initComponents();
        postInit();
        Case.addEventTypeSubscriber(EnumSet.of(Case.Events.CURRENT_CASE), caseEventsListener);
    }

    private void notifyParentClose() {
        if (notifyParentClose != null) {
            notifyParentClose.run();
        }
    }

    void setParentCloseListener(Runnable parentCloseAction) {
        notifyParentClose = parentCloseAction;
    }

    private void postInit() {
        // get the card layout
        cardLayout = (CardLayout) this.getLayout();

        // set up the tabs
        for (DataSourceTab tab : tabs) {
            tabbedPane.addTab(tab.getTabTitle(), tab.getComponent());
            
            // initialize the tab pane if it has an initialization method
            Runnable onInitMethod = tab.getOnInit();
            if (onInitMethod != null) {
                onInitMethod.run();
            }
        }

        // set this to no datasource initially
        cardLayout.show(this, NO_DATASOURCE_PANE);

        // set action for when user requests xlsx export
        exportPanel.setXlsxExportAction(() -> exportAction.accept(getDataSource()));
    }

    public DataSource getDataSource() {
        return dataSource;
    }

    public void setDataSource(DataSource dataSource) {
        this.dataSource = dataSource;

        for (DataSourceTab tab : tabs) {
            if (tab.getOnDataSource() != null) {
                tab.getOnDataSource().accept(dataSource);
            }
        }

        if (this.dataSource == null) {
            cardLayout.show(this, NO_DATASOURCE_PANE);
        } else {
            cardLayout.show(this, TABBED_PANE);
        }
    }

    public void close() {
        for (DataSourceTab tab : tabs) {
            if (tab.getOnClose() != null) {
                tab.getOnClose().run();
            }
        }

        Case.removeEventTypeSubscriber(EnumSet.of(Case.Events.CURRENT_CASE), caseEventsListener);
    }

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

        javax.swing.JPanel noDataSourcePane = new javax.swing.JPanel();
        javax.swing.JLabel noDataSourceLabel = new javax.swing.JLabel();
        javax.swing.JPanel tabContentPane = new javax.swing.JPanel();
        tabbedPane = new javax.swing.JTabbedPane();

        setLayout(new java.awt.CardLayout());

        noDataSourcePane.setLayout(new java.awt.BorderLayout());

        noDataSourceLabel.setHorizontalAlignment(javax.swing.SwingConstants.CENTER);
        org.openide.awt.Mnemonics.setLocalizedText(noDataSourceLabel, org.openide.util.NbBundle.getMessage(DataSourceSummaryTabbedPane.class, "DataSourceSummaryTabbedPane.noDataSourceLabel.text")); // NOI18N
        noDataSourcePane.add(noDataSourceLabel, java.awt.BorderLayout.CENTER);

        add(noDataSourcePane, "noDataSourcePane");

        tabContentPane.setLayout(new java.awt.BorderLayout());
        tabContentPane.add(tabbedPane, java.awt.BorderLayout.CENTER);

        add(tabContentPane, "tabbedPane");
    }// </editor-fold>//GEN-END:initComponents


    // Variables declaration - do not modify//GEN-BEGIN:variables
    private javax.swing.JTabbedPane tabbedPane;
    // End of variables declaration//GEN-END:variables
}