AddTagAction.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.actions;

import java.awt.event.ActionEvent;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.TreeMap;
import java.util.logging.Level;
import javax.swing.AbstractAction;
import javax.swing.JMenu;
import javax.swing.JMenuItem;
import org.openide.util.NbBundle;
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.datamodel.Content;
import org.sleuthkit.datamodel.TagName;
import org.sleuthkit.datamodel.TskCoreException;
import org.sleuthkit.datamodel.TskData;

abstract class AddTagAction extends AbstractAction implements Presenter.Popup {

    private static final long serialVersionUID = 1L;
    private static final String NO_COMMENT = "";
    private final Collection<Content> content = new HashSet<>();

    AddTagAction(String menuText) {
        super(menuText);
    }

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

    Collection<Content> getContentToTag() {
        return Collections.unmodifiableCollection(content);
    }

    public JMenuItem getMenuForContent(Collection<? extends Content> contentToTag) {
        content.clear();
        content.addAll(contentToTag);
        return new TagMenu();
    }

    @Override
    @SuppressWarnings("NoopMethodInAbstractClass")
    public void actionPerformed(ActionEvent event) {
    }

    abstract protected String getActionDisplayName();

    abstract protected void addTag(TagName tagName, String comment);

    // @@@ This user interface has some significant usability issues and needs
    // to be reworked.
    private final class TagMenu extends JMenu {

        private static final long serialVersionUID = 1L;

        TagMenu() {
            super(getActionDisplayName());

            // Get the current set of tag names.
            Map<String, TagName> tagNamesMap = null;
            List<String> standardTagNames = TagsManager.getStandardTagNames();
            try {
                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
            }

            // Create a menu item for each of the existing and visible tags.
            // Selecting one of these menu items adds  a tag with the associated tag name.
            List<JMenuItem> standardTagMenuitems = new ArrayList<>();
            if (null != tagNamesMap && !tagNamesMap.isEmpty()) {
                for (Map.Entry<String, TagName> entry : tagNamesMap.entrySet()) {
                    String tagDisplayName = entry.getKey();
                    String notableString = entry.getValue().getKnownStatus() == TskData.FileKnown.BAD ? TagsManager.getNotableTagLabel() : "";
                    JMenuItem tagNameItem = new JMenuItem(tagDisplayName + notableString);
                    // for the bookmark tag name only, added shortcut label
                    if (tagDisplayName.equals(NbBundle.getMessage(AddTagAction.class, "AddBookmarkTagAction.bookmark.text"))) {
                        tagNameItem.setAccelerator(AddBookmarkTagAction.BOOKMARK_SHORTCUT);
                    }

                    tagNameItem.addActionListener((ActionEvent e) -> {
                        getAndAddTag(entry.getKey(), entry.getValue(), NO_COMMENT);
                    });

                    // Show custom tags before predefined tags in the menu
                    if (standardTagNames.contains(tagDisplayName)) {
                        standardTagMenuitems.add(tagNameItem);
                    } else {
                        add(tagNameItem);
                    }
                }
            }

            if (getItemCount() > 0) {
                addSeparator();
            }

            standardTagMenuitems.forEach((menuItem) -> {
                add(menuItem);
            });

            addSeparator();

            // Create a "Choose Tag and Comment..." menu item. Selecting this item initiates
            // a dialog that can be used to create or select a tag name with an
            // optional comment and adds a tag with the resulting name.
            JMenuItem tagAndCommentItem = new JMenuItem(
                    NbBundle.getMessage(this.getClass(), "AddTagAction.tagAndComment"));
            tagAndCommentItem.addActionListener((ActionEvent e) -> {
                GetTagNameAndCommentDialog.TagNameAndComment tagNameAndComment = GetTagNameAndCommentDialog.doDialog();
                if (null != tagNameAndComment) {
                    addTag(tagNameAndComment.getTagName(), tagNameAndComment.getComment());
                }
            });
            add(tagAndCommentItem);

            // Create a  "New Tag..." menu item.
            // Selecting this item initiates a dialog that can be used to create
            // or select a tag name and adds a tag with the resulting name.
            JMenuItem newTagMenuItem = new JMenuItem(NbBundle.getMessage(this.getClass(), "AddTagAction.newTag"));
            newTagMenuItem.addActionListener((ActionEvent e) -> {
                TagName tagName = GetTagNameDialog.doDialog();
                if (null != tagName) {
                    addTag(tagName, NO_COMMENT);
                }
            });
            add(newTagMenuItem);

        }

        private void getAndAddTag(String tagDisplayName, TagName tagName, String comment) {
            Case openCase;
            try {
                openCase = Case.getCurrentCaseThrows();
            } catch (NoCurrentCaseException ex) {
                Logger.getLogger(AddTagAction.class.getName()).log(Level.SEVERE, "Exception while getting open case.", ex); // NON-NLS
                return;
            }

            if (tagName == null) {
                try {
                    tagName = openCase.getServices().getTagsManager().addTagName(tagDisplayName);
                } catch (TagsManager.TagNameAlreadyExistsException ex) {
                    try {
                        tagName = openCase.getServices().getTagsManager().getDisplayNamesToTagNamesMap().get(tagDisplayName);
                    } catch (TskCoreException ex1) {
                        Logger.getLogger(AddTagAction.class.getName()).log(Level.SEVERE, tagDisplayName + " already exists in database but an error occurred in retrieving it.", ex1); //NON-NLS
                    }
                } catch (TskCoreException ex) {
                    Logger.getLogger(AddTagAction.class.getName()).log(Level.SEVERE, "Error adding " + tagDisplayName + " tag name", ex); //NON-NLS
                }
            }
            addTag(tagName, comment);
        }
    }
}