FileNode.java

Go to the documentation of this file.

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

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.logging.Level;
import javax.swing.Action;
import org.apache.commons.lang3.StringUtils;
import org.openide.util.NbBundle;
import org.openide.util.Utilities;
import org.sleuthkit.autopsy.actions.AddContentTagAction;
import org.sleuthkit.autopsy.actions.DeleteFileContentTagAction;
import org.sleuthkit.autopsy.coreutils.ContextMenuExtensionPoint;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.directorytree.ExportCSVAction;
import org.sleuthkit.autopsy.directorytree.ExternalViewerAction;
import org.sleuthkit.autopsy.directorytree.ExternalViewerShortcutAction;
import org.sleuthkit.autopsy.directorytree.ExtractAction;
import org.sleuthkit.autopsy.directorytree.NewWindowViewAction;
import org.sleuthkit.autopsy.directorytree.ViewContextAction;
import org.sleuthkit.autopsy.modules.embeddedfileextractor.ExtractArchiveWithPasswordAction;
import org.sleuthkit.autopsy.timeline.actions.ViewFileInTimelineAction;
import org.sleuthkit.datamodel.AbstractFile;
import org.sleuthkit.datamodel.BlackboardArtifact;
import org.sleuthkit.datamodel.TskCoreException;
import org.sleuthkit.datamodel.TskData.TSK_DB_FILES_TYPE_ENUM;
import org.sleuthkit.datamodel.TskData.TSK_FS_NAME_FLAG_ENUM;

public class FileNode extends AbstractFsContentNode<AbstractFile> {

    private static final Logger logger = Logger.getLogger(FileNode.class.getName());

    static String getIconForFileType(AbstractFile file) {
        String ext = file.getNameExtension();
        if (StringUtils.isBlank(ext)) {
            return "org/sleuthkit/autopsy/images/file-icon.png"; //NON-NLS
        } else {
            ext = "." + ext;
        }
        if (FileTypeExtensions.getImageExtensions().contains(ext)) {
            return "org/sleuthkit/autopsy/images/image-file.png"; //NON-NLS
        }
        if (FileTypeExtensions.getVideoExtensions().contains(ext)) {
            return "org/sleuthkit/autopsy/images/video-file.png"; //NON-NLS
        }
        if (FileTypeExtensions.getAudioExtensions().contains(ext)) {
            return "org/sleuthkit/autopsy/images/audio-file.png"; //NON-NLS
        }
        if (FileTypeExtensions.getDocumentExtensions().contains(ext)) {
            return "org/sleuthkit/autopsy/images/doc-file.png"; //NON-NLS
        }
        if (FileTypeExtensions.getExecutableExtensions().contains(ext)) {
            return "org/sleuthkit/autopsy/images/exe-file.png"; //NON-NLS
        }
        if (FileTypeExtensions.getTextExtensions().contains(ext)) {
            return "org/sleuthkit/autopsy/images/text-file.png"; //NON-NLS
        }
        if (FileTypeExtensions.getWebExtensions().contains(ext)) {
            return "org/sleuthkit/autopsy/images/web-file.png"; //NON-NLS
        }
        if (FileTypeExtensions.getPDFExtensions().contains(ext)) {
            return "org/sleuthkit/autopsy/images/pdf-file.png"; //NON-NLS
        }
        if (FileTypeExtensions.getArchiveExtensions().contains(ext)) {
            return "org/sleuthkit/autopsy/images/archive-file.png"; //NON-NLS
        }
        return "org/sleuthkit/autopsy/images/file-icon.png"; //NON-NLS
    }

    public FileNode(AbstractFile file) {
        this(file, true);
        setIcon(file);
    }

    public FileNode(AbstractFile file, boolean directoryBrowseMode) {
        super(file, directoryBrowseMode);
        setIcon(file);
    }

    /*
     * Sets the icon for the node, based on properties of the AbstractFile.
     */
    private void setIcon(AbstractFile file) {
        if (file.isDirNameFlagSet(TSK_FS_NAME_FLAG_ENUM.UNALLOC)) {
            if (file.getType().equals(TSK_DB_FILES_TYPE_ENUM.CARVED)) {
                this.setIconBaseWithExtension("org/sleuthkit/autopsy/images/carved-file-x-icon-16.png"); //NON-NLS
            } else {
                this.setIconBaseWithExtension("org/sleuthkit/autopsy/images/file-icon-deleted.png"); //NON-NLS
            }
        } else {
            this.setIconBaseWithExtension(getIconForFileType(file));
        }
    }

    @Override
    @NbBundle.Messages({
        "FileNode.getActions.viewFileInDir.text=View File in Directory",
        "FileNode.getActions.viewInNewWin.text=View Item in New Window",
        "FileNode.getActions.openInExtViewer.text=Open in External Viewer  Ctrl+E",
        "FileNode.getActions.searchFilesSameMD5.text=Search for files with the same MD5 hash"})
    public Action[] getActions(boolean context) {
        List<Action> actionsList = new ArrayList<>();

        if (!this.getDirectoryBrowseMode()) {
            actionsList.add(new ViewContextAction(Bundle.FileNode_getActions_viewFileInDir_text(), this));   
        }
        actionsList.add(ViewFileInTimelineAction.createViewFileAction(getContent()));
        actionsList.add(null); // Creates an item separator

        actionsList.add(new NewWindowViewAction(Bundle.FileNode_getActions_viewInNewWin_text(), this));
        final Collection<AbstractFile> selectedFilesList
                = new HashSet<>(Utilities.actionsGlobalContext().lookupAll(AbstractFile.class));
        if (selectedFilesList.size() == 1) {
            actionsList.add(new ExternalViewerAction(
                    Bundle.FileNode_getActions_openInExtViewer_text(), this));
        } else {
            actionsList.add(ExternalViewerShortcutAction.getInstance());
        }
        
        actionsList.add(null); // Creates an item separator

        actionsList.add(ExtractAction.getInstance());
        actionsList.add(ExportCSVAction.getInstance());
        actionsList.add(null); // Creates an item separator

        actionsList.add(AddContentTagAction.getInstance());
        if (1 == selectedFilesList.size()) {
            actionsList.add(DeleteFileContentTagAction.getInstance());
        }
        actionsList.addAll(ContextMenuExtensionPoint.getActions());
        if (FileTypeExtensions.getArchiveExtensions().contains("." + this.content.getNameExtension().toLowerCase())) {
            try {
                if (this.content.getArtifacts(BlackboardArtifact.ARTIFACT_TYPE.TSK_ENCRYPTION_DETECTED).size() > 0) {
                    actionsList.add(new ExtractArchiveWithPasswordAction(this.getContent()));
                }
            } catch (TskCoreException ex) {
                logger.log(Level.WARNING, "Unable to add unzip with password action to context menus", ex);
            }
        }
        
        actionsList.add(null);
        actionsList.addAll(Arrays.asList(super.getActions(true)));
        
        return actionsList.toArray(new Action[actionsList.size()]);
    }

    @Override
    public <T> T accept(ContentNodeVisitor<T> visitor) {
        return visitor.visit(this);
    }

    @Override
    public <T> T accept(DisplayableItemNodeVisitor<T> visitor) {
        return visitor.visit(this);
    }

    @Override
    public boolean isLeafTypeNode() {
        /*
         * A FileNode may have FileNodes for derived files as children.
         */
        return false;
    }

    @Override
    public String getItemType() {
        return getClass().getName();
    }
}