DeleteFileBlackboardArtifactTagAction.java

Go to the documentation of this file.

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

import java.awt.event.ActionEvent;
import java.util.ArrayList;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import java.util.concurrent.ExecutionException;
import java.util.logging.Level;
import java.util.stream.Collectors;
import javafx.application.Platform;
import javafx.scene.control.Alert;
import javax.swing.AbstractAction;
import javax.swing.JMenu;
import javax.swing.JMenuItem;
import javax.swing.SwingWorker;
import org.openide.util.NbBundle;
import org.openide.util.Utilities;
import org.openide.util.actions.Presenter;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException;
import org.sleuthkit.autopsy.casemodule.services.TagsManager;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.datamodel.BlackboardArtifactItem;
import org.sleuthkit.autopsy.tags.TagUtils;
import org.sleuthkit.datamodel.BlackboardArtifact;
import org.sleuthkit.datamodel.BlackboardArtifactTag;
import org.sleuthkit.datamodel.TagName;
import org.sleuthkit.datamodel.TskCoreException;

@NbBundle.Messages({
    "DeleteFileBlackboardArtifactTagAction.deleteTag=Remove Result Tag"
})
public class DeleteFileBlackboardArtifactTagAction extends AbstractAction implements Presenter.Popup {

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

    private static final long serialVersionUID = 1L;
    private static final String MENU_TEXT = NbBundle.getMessage(DeleteFileBlackboardArtifactTagAction.class,
            "DeleteFileBlackboardArtifactTagAction.deleteTag");

    // This class is a singleton to support multi-selection of nodes, since 
    // org.openide.nodes.NodeOp.findActions(Node[] nodes) will only pick up an Action if every 
    // node in the array returns a reference to the same action object from Node.getActions(boolean).    
    private static DeleteFileBlackboardArtifactTagAction instance;

    public static synchronized DeleteFileBlackboardArtifactTagAction getInstance() {
        if (null == instance) {
            instance = new DeleteFileBlackboardArtifactTagAction();
        }
        return instance;
    }

    private DeleteFileBlackboardArtifactTagAction() {
        super(MENU_TEXT);
    }

    @Override
    public JMenuItem getPopupPresenter() {
        return new TagMenu();
    }

    public JMenuItem getMenuForArtifacts(Collection<BlackboardArtifact> selectedArtifacts) {
        return new TagMenu(selectedArtifacts);
    }

    @Override
    public void actionPerformed(ActionEvent event) {
    }

    protected String getActionDisplayName() {
        return MENU_TEXT;
    }

    @NbBundle.Messages({"# {0} - artifactID",
        "DeleteFileBlackboardArtifactTagAction.deleteTag.alert=Unable to untag artifact {0}."})
    protected void deleteTag(TagName tagName, BlackboardArtifactTag artifactTag, long artifactId) {
        new SwingWorker<Void, Void>() {

            @Override
            protected Void doInBackground() throws Exception {
                TagsManager tagsManager;
                try {
                    tagsManager = Case.getCurrentCaseThrows().getServices().getTagsManager();
                } catch (NoCurrentCaseException ex) {
                    logger.log(Level.SEVERE, "Error untagging artifact. No open case found.", ex); //NON-NLS
                    Platform.runLater(()
                            -> new Alert(Alert.AlertType.ERROR, Bundle.DeleteFileBlackboardArtifactTagAction_deleteTag_alert(artifactId)).show()
                    );
                    return null;
                }

                try {
                    logger.log(Level.INFO, "Removing tag {0} from {1}", new Object[]{tagName.getDisplayName(), artifactTag.getContent().getName()}); //NON-NLS
                    tagsManager.deleteBlackboardArtifactTag(artifactTag);
                } catch (TskCoreException tskCoreException) {
                    logger.log(Level.SEVERE, "Error untagging artifact", tskCoreException); //NON-NLS
                    Platform.runLater(()
                            -> new Alert(Alert.AlertType.ERROR, Bundle.DeleteFileBlackboardArtifactTagAction_deleteTag_alert(artifactId)).show()
                    );
                }
                return null;
            }

            @Override
            protected void done() {
                super.done();
                try {
                    get();
                } catch (InterruptedException | ExecutionException ex) {
                    logger.log(Level.SEVERE, "Unexpected exception while untagging artifact", ex); //NON-NLS
                }
            }
        }.execute();
    }

    @NbBundle.Messages({"# {0} - artifactID",
        "DeleteFileBlackboardArtifactTagAction.deleteTags.alert=Unable to untag artifact {0}."})
    private final class TagMenu extends JMenu {

        private static final long serialVersionUID = 1L;

        TagMenu() {
            this(Utilities.actionsGlobalContext()
                    .lookupAll(BlackboardArtifactItem.class)
                    .stream()
                    .map((bai) -> (BlackboardArtifact) bai.getTskContent())
                    .collect(Collectors.toSet()));
        }

        TagMenu(Collection<BlackboardArtifact> selectedBlackboardArtifactsList) {
            super(getActionDisplayName());
            if (!selectedBlackboardArtifactsList.isEmpty()) {
                BlackboardArtifact artifact
                        = selectedBlackboardArtifactsList.iterator().next();

                Map<String, TagName> tagNamesMap = null;
                List<String> standardTagNames = TagsManager.getStandardTagNames();
                List<JMenuItem> standardTagMenuitems = new ArrayList<>();
                try {
                    // Get the current set of tag names.
                    TagsManager tagsManager = Case.getCurrentCaseThrows().getServices().getTagsManager();

                    tagNamesMap = new TreeMap<>(tagsManager.getDisplayNamesToTagNamesMap());
                } catch (TskCoreException | NoCurrentCaseException ex) {
                    Logger.getLogger(TagsManager.class.getName()).log(Level.SEVERE, "Failed to get tag names", ex); //NON-NLS
                }

                // Each tag name in the current set of tags gets its own menu item in
                // the "Quick Tags" sub-menu. Selecting one of these menu items adds
                // a tag with the associated tag name.
                if (null != tagNamesMap && !tagNamesMap.isEmpty()) {
                    try {
                        List<BlackboardArtifactTag> existingTagsList
                                = Case.getCurrentCaseThrows().getServices().getTagsManager()
                                        .getBlackboardArtifactTagsByArtifact(artifact);

                        for (Map.Entry<String, TagName> entry : tagNamesMap.entrySet()) {
                            String tagDisplayName = entry.getKey();

                            TagName tagName = entry.getValue();
                            for (BlackboardArtifactTag artifactTag : existingTagsList) {
                                if (tagDisplayName.equals(artifactTag.getName().getDisplayName())) {
                                    JMenuItem tagNameItem = new JMenuItem(TagUtils.getDecoratedTagDisplayName(tagName));
                                    tagNameItem.addActionListener((ActionEvent e) -> {
                                        deleteTag(tagName, artifactTag, artifact.getArtifactID());
                                    });
                                    // Show custom tags before predefined tags in the menu
                                    if (standardTagNames.contains(tagDisplayName)) {
                                        standardTagMenuitems.add(tagNameItem);
                                    } else {
                                        add(tagNameItem);
                                    }
                                }
                            }
                        }
                    } catch (TskCoreException | NoCurrentCaseException ex) {
                        Logger.getLogger(TagMenu.class.getName())
                                .log(Level.SEVERE, "Error retrieving tags for TagMenu", ex); //NON-NLS
                    }
                }

                if ((getItemCount() > 0) && !standardTagMenuitems.isEmpty()) {
                    addSeparator();
                }
                standardTagMenuitems.forEach((menuItem) -> {
                    add(menuItem);
                });
                if (getItemCount() == 0) {
                    setEnabled(false);
                }
            }
        }
    }

}