DataResultTopComponent.java

Go to the documentation of this file.

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

import java.util.ArrayList;
import java.util.Collections;
import java.util.List;
import java.util.logging.Level;
import javax.swing.JComponent;
import org.openide.explorer.ExplorerManager;
import org.openide.explorer.ExplorerUtils;
import org.openide.nodes.Node;
import org.openide.util.NbBundle;
import org.openide.windows.Mode;
import org.openide.windows.RetainLocation;
import org.openide.windows.TopComponent;
import org.openide.windows.WindowManager;
import org.sleuthkit.autopsy.actions.AddBookmarkTagAction;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.corecomponentinterfaces.DataResult;
import org.sleuthkit.autopsy.corecomponentinterfaces.DataResultViewer;
import org.sleuthkit.autopsy.coreutils.Logger;

@RetainLocation("editor")
public class DataResultTopComponent extends TopComponent implements DataResult, ExplorerManager.Provider {

    private static final Logger logger = Logger.getLogger(DataResultTopComponent.class.getName());
    private final ExplorerManager explorerManager = new ExplorerManager();
    private final DataResultPanel dataResultPanel; //embedded component with all the logic
    private boolean isMain;
    private String customModeName;

    //keep track of tcs opened for menu presenters
    private static final List<String> activeComponentIds = Collections.synchronizedList(new ArrayList<String>());

    public DataResultTopComponent(boolean isMain, String title) {
        associateLookup(ExplorerUtils.createLookup(explorerManager, getActionMap()));
        this.dataResultPanel = new DataResultPanel(title, isMain);
        initComponents();
        customizeComponent(isMain, title);
    }

    DataResultTopComponent(String name, String mode, DataContentTopComponent customContentViewer) {
        associateLookup(ExplorerUtils.createLookup(explorerManager, getActionMap()));
        this.customModeName = mode;
        dataResultPanel = new DataResultPanel(name, customContentViewer);
        initComponents();
        customizeComponent(isMain, name);
    }

    private void customizeComponent(boolean isMain, String title) {
        this.isMain = isMain;
        this.customModeName = null;

        setToolTipText(NbBundle.getMessage(DataResultTopComponent.class, "HINT_NodeTableTopComponent"));

        setTitle(title); // set the title
        setName(title);
        getInputMap(JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT).put(AddBookmarkTagAction.BOOKMARK_SHORTCUT, "addBookmarkTag"); //NON-NLS
        getActionMap().put("addBookmarkTag", new AddBookmarkTagAction()); //NON-NLS

        putClientProperty(TopComponent.PROP_CLOSING_DISABLED, isMain); // set option to close compoment in GUI
        putClientProperty(TopComponent.PROP_MAXIMIZATION_DISABLED, true);
        putClientProperty(TopComponent.PROP_DRAGGING_DISABLED, true);

        activeComponentIds.add(title);
    }

    public static void initInstance(String pathText, Node givenNode, int totalMatches, DataResultTopComponent newDataResult) {
        newDataResult.setNumMatches(totalMatches);

        newDataResult.open(); // open it first so the component can be initialized

        // set the tree table view
        newDataResult.setNode(givenNode);
        newDataResult.setPath(pathText);

        newDataResult.requestActive();
    }

    public static DataResultTopComponent createInstance(String title, String pathText, Node givenNode, int totalMatches) {
        DataResultTopComponent newDataResult = new DataResultTopComponent(false, title);

        initInstance(pathText, givenNode, totalMatches, newDataResult);

        return newDataResult;
    }

    public static DataResultTopComponent createInstance(String title, final String mode, String pathText, Node givenNode, int totalMatches, DataContentTopComponent dataContentWindow) {
        DataResultTopComponent newDataResult = new DataResultTopComponent(title, mode, dataContentWindow);

        initInstance(pathText, givenNode, totalMatches, newDataResult);
        return newDataResult;
    }

    public static DataResultTopComponent createInstance(String title) {
        final DataResultTopComponent newDataResult = new DataResultTopComponent(false, title);

        return newDataResult;
    }

    @Override
    public ExplorerManager getExplorerManager() {
        return explorerManager;
    }

    public static List<String> getActiveComponentIds() {
        return new ArrayList<>(activeComponentIds);
    }

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

        org.sleuthkit.autopsy.corecomponents.DataResultPanel dataResultPanelLocal = dataResultPanel;

        javax.swing.GroupLayout layout = new javax.swing.GroupLayout(this);
        this.setLayout(layout);
        layout.setHorizontalGroup(
            layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
            .addComponent(dataResultPanelLocal, javax.swing.GroupLayout.DEFAULT_SIZE, 967, Short.MAX_VALUE)
        );
        layout.setVerticalGroup(
            layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
            .addComponent(dataResultPanelLocal, javax.swing.GroupLayout.DEFAULT_SIZE, 579, Short.MAX_VALUE)
        );
    }// </editor-fold>//GEN-END:initComponents
    // Variables declaration - do not modify//GEN-BEGIN:variables
    // End of variables declaration//GEN-END:variables

    @Override
    public int getPersistenceType() {
        if (customModeName == null) {
            return TopComponent.PERSISTENCE_NEVER;
        } else {
            return TopComponent.PERSISTENCE_ALWAYS;
        }
    }

    @Override
    public void open() {
        setCustomMode();
        super.open(); //To change body of generated methods, choose Tools | Templates.
    }

    @Override
    public List<DataResultViewer> getViewers() {
        return dataResultPanel.getViewers();
    }

    private void setCustomMode() {
        if (customModeName != null) {
            Mode mode = WindowManager.getDefault().findMode(customModeName);
            if (mode != null) {
                logger.log(Level.INFO, "Found custom mode, setting: {0}", customModeName);//NON-NLS
                mode.dockInto(this);
            } else {
                logger.log(Level.WARNING, "Could not find mode: {0}, will dock into the default one", customModeName);//NON-NLS
            }
        }
    }

    @Override
    public void componentOpened() {
        super.componentOpened();
        this.dataResultPanel.open();
    }

    @Override
    public void componentClosed() {
        super.componentClosed();
        activeComponentIds.remove(this.getName());
        dataResultPanel.close();
    }

    @Override
    protected String preferredID() {
        return getName();
    }

    @Override
    public String getPreferredID() {
        return getName();
    }

    @Override
    public void setNode(Node selectedNode) {
        dataResultPanel.setNode(selectedNode);
    }

    @Override
    public void setTitle(String title) {
        setName(title);
    }

    @Override
    public void setPath(String pathText) {
        dataResultPanel.setPath(pathText);
    }

    @Override
    public boolean isMain() {
        return isMain;
    }

    @Override
    public boolean canClose() {
        /*
         * If this is the results top component in the upper right of the main
         * window, only allow it to be closed when there's no case opened or no
         * data sources in the open case.
         */
        return (!this.isMain) || !Case.isCaseOpen() || Case.getCurrentCase().hasData() == false;
    }

    public void resetTabs(Node selectedNode) {

        dataResultPanel.resetTabs(selectedNode);
    }

    public void setSelectedNodes(Node[] selected) {
        dataResultPanel.setSelectedNodes(selected);
    }

    public Node getRootNode() {
        return dataResultPanel.getRootNode();
    }

    void setNumMatches(int matches) {
        this.dataResultPanel.setNumMatches(matches);
    }
}