MediaViewImagePanel.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.contentviewers;

import java.awt.EventQueue;
import java.awt.event.ActionEvent;
import java.awt.image.BufferedImage;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.beans.PropertyChangeSupport;
import java.io.File;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import static java.util.Objects.nonNull;
import java.util.SortedSet;
import java.util.concurrent.ExecutionException;
import java.util.logging.Level;
import java.util.stream.Collectors;
import javafx.application.Platform;
import javafx.collections.ListChangeListener.Change;
import javafx.concurrent.Task;
import javafx.embed.swing.JFXPanel;
import javafx.geometry.Pos;
import javafx.geometry.Rectangle2D;
import javafx.scene.Cursor;
import javafx.scene.Group;
import javafx.scene.Scene;
import javafx.scene.control.Button;
import javafx.scene.control.Label;
import javafx.scene.control.ProgressBar;
import javafx.scene.control.ScrollPane;
import javafx.scene.control.ScrollPane.ScrollBarPolicy;
import javafx.scene.image.Image;
import javafx.scene.image.ImageView;
import javafx.scene.layout.VBox;
import javafx.scene.transform.Rotate;
import javafx.scene.transform.Scale;
import javafx.scene.transform.Translate;
import javax.imageio.ImageIO;
import javax.swing.JFileChooser;
import javafx.scene.Node;
import javax.swing.JMenuItem;
import javax.swing.JOptionPane;
import javax.swing.JPanel;
import javax.swing.JPopupMenu;
import javax.swing.JSeparator;
import javax.swing.SwingUtilities;
import javax.swing.SwingWorker;
import org.apache.commons.io.FilenameUtils;
import org.controlsfx.control.MaskerPane;
import org.openide.util.NbBundle;
import org.python.google.common.collect.Lists;
import org.sleuthkit.autopsy.actions.GetTagNameAndCommentDialog;
import org.sleuthkit.autopsy.actions.GetTagNameAndCommentDialog.TagNameAndComment;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException;
import org.sleuthkit.autopsy.casemodule.services.contentviewertags.ContentViewerTagManager;
import org.sleuthkit.autopsy.casemodule.services.contentviewertags.ContentViewerTagManager.ContentViewerTag;
import org.sleuthkit.autopsy.casemodule.services.contentviewertags.ContentViewerTagManager.SerializationException;
import org.sleuthkit.autopsy.contentviewers.imagetagging.ImageTagsUtil;
import org.sleuthkit.autopsy.contentviewers.imagetagging.ImageTagControls;
import org.sleuthkit.autopsy.contentviewers.imagetagging.ImageTagRegion;
import org.sleuthkit.autopsy.contentviewers.imagetagging.ImageTagCreator;
import org.sleuthkit.autopsy.contentviewers.imagetagging.ImageTag;
import org.sleuthkit.autopsy.contentviewers.imagetagging.ImageTagsGroup;
import org.sleuthkit.autopsy.corelibs.OpenCvLoader;
import org.sleuthkit.autopsy.coreutils.ImageUtils;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.coreutils.PlatformUtil;
import org.sleuthkit.autopsy.datamodel.FileNode;
import org.sleuthkit.autopsy.directorytree.ExternalViewerAction;
import org.sleuthkit.datamodel.AbstractFile;
import org.sleuthkit.datamodel.ContentTag;
import org.sleuthkit.datamodel.TskCoreException;

@NbBundle.Messages({"MediaViewImagePanel.externalViewerButton.text=Open in External Viewer  Ctrl+E",
    "MediaViewImagePanel.errorLabel.text=Could not load file into Media View.",
    "MediaViewImagePanel.errorLabel.OOMText=Could not load file into Media View: insufficent memory."})
@SuppressWarnings("PMD.SingularField") // UI widgets cause lots of false positives
class MediaViewImagePanel extends JPanel implements MediaFileViewer.MediaViewPanel {

    private static final Image EXTERNAL = new Image(MediaViewImagePanel.class.getResource("/org/sleuthkit/autopsy/images/external.png").toExternalForm());
    private final static Logger LOGGER = Logger.getLogger(MediaViewImagePanel.class.getName());

    private final boolean fxInited;

    private JFXPanel fxPanel;
    private AbstractFile file;
    private Group masterGroup;
    private ImageTagsGroup tagsGroup;
    private ImageTagCreator imageTagCreator;
    private ImageView fxImageView;
    private ScrollPane scrollPane;
    private final ProgressBar progressBar = new ProgressBar();
    private final MaskerPane maskerPane = new MaskerPane();

    private final JPopupMenu imageTaggingOptions = new JPopupMenu();
    private final JMenuItem createTagMenuItem;
    private final JMenuItem deleteTagMenuItem;
    private final JMenuItem hideTagsMenuItem;
    private final JMenuItem exportTagsMenuItem;

    private final JFileChooser exportChooser;

    private final PropertyChangeSupport pcs = new PropertyChangeSupport(this);

    private double zoomRatio;
    private double rotation; // Can be 0, 90, 180, and 270.

    private boolean autoResize = true; // Auto resize when the user changes the size
    // of the content viewer unless the user has used the zoom buttons.
    private static final double[] ZOOM_STEPS = {
        0.0625, 0.125, 0.25, 0.375, 0.5, 0.75,
        1, 1.5, 2, 2.5, 3, 4, 5, 6, 8, 10};

    private static final double MIN_ZOOM_RATIO = 0.0625; // 6.25%
    private static final double MAX_ZOOM_RATIO = 10.0; // 1000%

    static {
        ImageIO.scanForPlugins();
    }

    static private final SortedSet<String> supportedMimes = ImageUtils.getSupportedImageMimeTypes();

    static private final List<String> supportedExtensions = ImageUtils.getSupportedImageExtensions().stream()
            .map("."::concat) //NOI18N
            .collect(Collectors.toList());

    private Task<Image> readImageTask;

    @NbBundle.Messages({
        "MediaViewImagePanel.createTagOption=Create",
        "MediaViewImagePanel.deleteTagOption=Delete",
        "MediaViewImagePanel.hideTagOption=Hide",
        "MediaViewImagePanel.exportTagOption=Export"
    })
    public MediaViewImagePanel() {
        initComponents();
        fxInited = org.sleuthkit.autopsy.core.Installer.isJavaFxInited();

        exportChooser = new JFileChooser();
        exportChooser.setDialogTitle(Bundle.MediaViewImagePanel_fileChooserTitle());

        //Build popupMenu when Tags Menu button is pressed.
        createTagMenuItem = new JMenuItem(Bundle.MediaViewImagePanel_createTagOption());
        createTagMenuItem.addActionListener((event) -> createTag());
        imageTaggingOptions.add(createTagMenuItem);

        imageTaggingOptions.add(new JSeparator());

        deleteTagMenuItem = new JMenuItem(Bundle.MediaViewImagePanel_deleteTagOption());
        deleteTagMenuItem.addActionListener((event) -> deleteTag());
        imageTaggingOptions.add(deleteTagMenuItem);

        imageTaggingOptions.add(new JSeparator());

        hideTagsMenuItem = new JMenuItem(Bundle.MediaViewImagePanel_hideTagOption());
        hideTagsMenuItem.addActionListener((event) -> showOrHideTags());
        imageTaggingOptions.add(hideTagsMenuItem);

        imageTaggingOptions.add(new JSeparator());

        exportTagsMenuItem = new JMenuItem(Bundle.MediaViewImagePanel_exportTagOption());
        exportTagsMenuItem.addActionListener((event) -> exportTags());
        imageTaggingOptions.add(exportTagsMenuItem);

        imageTaggingOptions.setPopupSize(300, 150);

        //Disable image tagging for non-windows users or upon failure to load OpenCV.
        if (!PlatformUtil.isWindowsOS() || !OpenCvLoader.openCvIsLoaded()) {
            tagsMenu.setEnabled(false);
            imageTaggingOptions.setEnabled(false);
        }

        if (fxInited) {
            Platform.runLater(new Runnable() {
                @Override
                public void run() {
                    // build jfx ui (we could do this in FXML?)
                    fxImageView = new ImageView();  // will hold image
                    masterGroup = new Group(fxImageView);
                    tagsGroup = new ImageTagsGroup(fxImageView);
                    tagsGroup.getChildren().addListener((Change<? extends Node> c) -> {
                        if (c.getList().isEmpty()) {
                            pcs.firePropertyChange(new PropertyChangeEvent(this,
                                    "state", null, State.EMPTY));
                        }
                    });

                    subscribeTagMenuItemsToStateChanges();

                    masterGroup.getChildren().add(tagsGroup);

                    //Update buttons when users select (or unselect) image tags.
                    tagsGroup.addFocusChangeListener((event) -> {
                        if (event.getPropertyName().equals(ImageTagControls.NOT_FOCUSED.getName())) {
                            if (masterGroup.getChildren().contains(imageTagCreator)) {
                                return;
                            }

                            if (tagsGroup.getChildren().isEmpty()) {
                                pcs.firePropertyChange(new PropertyChangeEvent(this,
                                        "state", null, State.EMPTY));
                            } else {
                                pcs.firePropertyChange(new PropertyChangeEvent(this,
                                        "state", null, State.CREATE));
                            }
                        } else if (event.getPropertyName().equals(ImageTagControls.FOCUSED.getName())) {
                            pcs.firePropertyChange(new PropertyChangeEvent(this,
                                    "state", null, State.SELECTED));
                        }
                    });

                    scrollPane = new ScrollPane(masterGroup); // scrolls and sizes imageview
                    scrollPane.getStyleClass().add("bg"); //NOI18N
                    scrollPane.setVbarPolicy(ScrollBarPolicy.AS_NEEDED);
                    scrollPane.setHbarPolicy(ScrollBarPolicy.AS_NEEDED);

                    fxPanel = new JFXPanel(); // bridge jfx-swing
                    Scene scene = new Scene(scrollPane); //root of jfx tree
                    scene.getStylesheets().add(MediaViewImagePanel.class.getResource("MediaViewImagePanel.css").toExternalForm()); //NOI18N
                    fxPanel.setScene(scene);

                    fxImageView.setSmooth(true);
                    fxImageView.setCache(true);

                    EventQueue.invokeLater(() -> {
                        add(fxPanel);//add jfx ui to JPanel
                    });
                }
            });
        }
    }

    private void subscribeTagMenuItemsToStateChanges() {
        pcs.addPropertyChangeListener((event) -> {
            State currentState = (State) event.getNewValue();
            switch (currentState) {
                case CREATE:
                    createTagMenuItem.setEnabled(true);
                    deleteTagMenuItem.setEnabled(false);
                    hideTagsMenuItem.setEnabled(true);
                    exportTagsMenuItem.setEnabled(true);
                    break;
                case SELECTED:
                    if (masterGroup.getChildren().contains(imageTagCreator)) {
                        imageTagCreator.disconnect();
                        masterGroup.getChildren().remove(imageTagCreator);
                    }
                    createTagMenuItem.setEnabled(false);
                    deleteTagMenuItem.setEnabled(true);
                    hideTagsMenuItem.setEnabled(true);
                    exportTagsMenuItem.setEnabled(true);
                    break;
                case HIDDEN:
                    createTagMenuItem.setEnabled(false);
                    deleteTagMenuItem.setEnabled(false);
                    hideTagsMenuItem.setEnabled(true);
                    hideTagsMenuItem.setText(DisplayOptions.SHOW_TAGS.getName());
                    exportTagsMenuItem.setEnabled(false);
                    break;
                case VISIBLE:
                    createTagMenuItem.setEnabled(true);
                    deleteTagMenuItem.setEnabled(false);
                    hideTagsMenuItem.setEnabled(true);
                    hideTagsMenuItem.setText(DisplayOptions.HIDE_TAGS.getName());
                    exportTagsMenuItem.setEnabled(true);
                    break;
                case DEFAULT:
                case EMPTY:
                    if (masterGroup.getChildren().contains(imageTagCreator)) {
                        imageTagCreator.disconnect();
                    }
                    createTagMenuItem.setEnabled(true);
                    deleteTagMenuItem.setEnabled(false);
                    hideTagsMenuItem.setEnabled(false);
                    hideTagsMenuItem.setText(DisplayOptions.HIDE_TAGS.getName());
                    exportTagsMenuItem.setEnabled(false);
                    break;
                case NONEMPTY:
                    createTagMenuItem.setEnabled(true);
                    deleteTagMenuItem.setEnabled(false);
                    hideTagsMenuItem.setEnabled(true);
                    exportTagsMenuItem.setEnabled(true);
                    break;
                case DISABLE:
                    createTagMenuItem.setEnabled(false);
                    deleteTagMenuItem.setEnabled(false);
                    hideTagsMenuItem.setEnabled(false);
                    exportTagsMenuItem.setEnabled(false);
                    break;
                default:
                    break;
            }
        });
    }

    public boolean isInited() {
        return fxInited;
    }

    public void reset() {
        Platform.runLater(() -> {
            fxImageView.setViewport(new Rectangle2D(0, 0, 0, 0));
            fxImageView.setImage(null);
            pcs.firePropertyChange(new PropertyChangeEvent(this,
                    "state", null, State.DEFAULT));
            masterGroup.getChildren().clear();
            scrollPane.setContent(null);
            scrollPane.setContent(masterGroup);
        });
    }

    private void showErrorNode(String errorMessage, AbstractFile file) {
        final Button externalViewerButton = new Button(Bundle.MediaViewImagePanel_externalViewerButton_text(), new ImageView(EXTERNAL));
        externalViewerButton.setOnAction(actionEvent
                -> //fx ActionEvent
                /*
                 * TODO: why is the name passed into the action constructor? it
                 * means we duplicate this string all over the place -jm
                 */ new ExternalViewerAction(Bundle.MediaViewImagePanel_externalViewerButton_text(), new FileNode(file))
                        .actionPerformed(new ActionEvent(this, ActionEvent.ACTION_PERFORMED, "")) //Swing ActionEvent 
        );

        final VBox errorNode = new VBox(10, new Label(errorMessage), externalViewerButton);
        errorNode.setAlignment(Pos.CENTER);
    }

    void showImageFx(final AbstractFile file) {
        if (!fxInited) {
            return;
        }

        Platform.runLater(() -> {
            if (readImageTask != null) {
                readImageTask.cancel();
            }
            readImageTask = ImageUtils.newReadImageTask(file);
            readImageTask.setOnSucceeded(succeeded -> {
                if (!Case.isCaseOpen()) {
                    /*
                     * Handle the in-between condition when case is being closed
                     * and an image was previously selected
                     *
                     * NOTE: I think this is unnecessary -jm
                     */
                    reset();
                    return;
                }

                try {
                    autoResize = true;
                    Image fxImage = readImageTask.get();
                    masterGroup.getChildren().clear();
                    tagsGroup.getChildren().clear();
                    this.file = file;
                    if (nonNull(fxImage)) {
                        // We have a non-null image, so let's show it.
                        fxImageView.setImage(fxImage);
                        resetView();
                        masterGroup.getChildren().add(fxImageView);
                        masterGroup.getChildren().add(tagsGroup);

                        try {
                            List<ContentTag> tags = Case.getCurrentCase().getServices()
                                    .getTagsManager().getContentTagsByContent(file);

                            List<ContentViewerTag<ImageTagRegion>> contentViewerTags = getContentViewerTags(tags);
                            //Add all image tags                            
                            tagsGroup = buildImageTagsGroup(contentViewerTags);
                            if (!tagsGroup.getChildren().isEmpty()) {
                                pcs.firePropertyChange(new PropertyChangeEvent(this,
                                        "state", null, State.NONEMPTY));
                            }
                        } catch (TskCoreException | NoCurrentCaseException ex) {
                            LOGGER.log(Level.WARNING, "Could not retrieve image tags for file in case db", ex); //NON-NLS
                        }
                        scrollPane.setContent(masterGroup);
                    } else {
                        showErrorNode(Bundle.MediaViewImagePanel_errorLabel_text(), file);
                    }
                } catch (InterruptedException | ExecutionException ex) {
                    showErrorNode(Bundle.MediaViewImagePanel_errorLabel_text(), file);
                }
                scrollPane.setCursor(Cursor.DEFAULT);
            });
            readImageTask.setOnFailed(failed -> {
                if (!Case.isCaseOpen()) {
                    /*
                     * Handle in-between condition when case is being closed and
                     * an image was previously selected
                     *
                     * NOTE: I think this is unnecessary -jm
                     */
                    reset();
                    return;
                }
                Throwable exception = readImageTask.getException();
                if (exception instanceof OutOfMemoryError
                        && exception.getMessage().contains("Java heap space")) {
                    showErrorNode(Bundle.MediaViewImagePanel_errorLabel_OOMText(), file);
                } else {
                    showErrorNode(Bundle.MediaViewImagePanel_errorLabel_text(), file);
                }

                scrollPane.setCursor(Cursor.DEFAULT);
            });

            maskerPane.setProgressNode(progressBar);
            progressBar.progressProperty().bind(readImageTask.progressProperty());
            maskerPane.textProperty().bind(readImageTask.messageProperty());
            scrollPane.setContent(null); // Prevent content display issues.
            scrollPane.setCursor(Cursor.WAIT);
            new Thread(readImageTask).start();
        });
    }

    private List<ContentViewerTag<ImageTagRegion>> getContentViewerTags(List<ContentTag> contentTags)
            throws TskCoreException, NoCurrentCaseException {
        List<ContentViewerTag<ImageTagRegion>> contentViewerTags = new ArrayList<>();
        for (ContentTag contentTag : contentTags) {
            ContentViewerTag<ImageTagRegion> contentViewerTag = ContentViewerTagManager
                    .getTag(contentTag, ImageTagRegion.class);
            if (contentViewerTag == null) {
                continue;
            }

            contentViewerTags.add(contentViewerTag);
        }
        return contentViewerTags;
    }

    private ImageTagsGroup buildImageTagsGroup(List<ContentViewerTag<ImageTagRegion>> contentViewerTags) {

        contentViewerTags.forEach(contentViewerTag -> {
            tagsGroup.getChildren().add(buildImageTag(contentViewerTag));
        });

        return tagsGroup;
    }

    @Override
    public List<String> getSupportedMimeTypes() {
        return Collections.unmodifiableList(Lists.newArrayList(supportedMimes));
    }

    @Override
    public List<String> getSupportedExtensions() {
        return getExtensions();
    }

    public List<String> getExtensions() {
        return Collections.unmodifiableList(supportedExtensions);
    }

    @Override
    public boolean isSupported(AbstractFile file) {
        return ImageUtils.isImageThumbnailSupported(file);
    }

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

        toolbar = new javax.swing.JToolBar();
        rotationTextField = new javax.swing.JTextField();
        rotateLeftButton = new javax.swing.JButton();
        rotateRightButton = new javax.swing.JButton();
        jSeparator1 = new javax.swing.JToolBar.Separator();
        zoomTextField = new javax.swing.JTextField();
        zoomOutButton = new javax.swing.JButton();
        zoomInButton = new javax.swing.JButton();
        jSeparator2 = new javax.swing.JToolBar.Separator();
        zoomResetButton = new javax.swing.JButton();
        filler1 = new javax.swing.Box.Filler(new java.awt.Dimension(0, 0), new java.awt.Dimension(0, 0), new java.awt.Dimension(0, 0));
        filler2 = new javax.swing.Box.Filler(new java.awt.Dimension(0, 0), new java.awt.Dimension(0, 0), new java.awt.Dimension(32767, 0));
        jPanel1 = new javax.swing.JPanel();
        tagsMenu = new javax.swing.JButton();

        setBackground(new java.awt.Color(0, 0, 0));
        addComponentListener(new java.awt.event.ComponentAdapter() {
            public void componentResized(java.awt.event.ComponentEvent evt) {
                formComponentResized(evt);
            }
        });
        setLayout(new javax.swing.BoxLayout(this, javax.swing.BoxLayout.Y_AXIS));

        toolbar.setFloatable(false);
        toolbar.setRollover(true);
        toolbar.setMaximumSize(new java.awt.Dimension(32767, 23));
        toolbar.setName(""); // NOI18N

        rotationTextField.setEditable(false);
        rotationTextField.setHorizontalAlignment(javax.swing.JTextField.RIGHT);
        rotationTextField.setText(org.openide.util.NbBundle.getMessage(MediaViewImagePanel.class, "MediaViewImagePanel.rotationTextField.text")); // NOI18N
        rotationTextField.setMaximumSize(new java.awt.Dimension(50, 2147483647));
        rotationTextField.setMinimumSize(new java.awt.Dimension(50, 20));
        rotationTextField.setPreferredSize(new java.awt.Dimension(50, 20));
        toolbar.add(rotationTextField);

        rotateLeftButton.setIcon(new javax.swing.ImageIcon(getClass().getResource("/org/sleuthkit/autopsy/contentviewers/images/rotate-left.png"))); // NOI18N
        org.openide.awt.Mnemonics.setLocalizedText(rotateLeftButton, org.openide.util.NbBundle.getMessage(MediaViewImagePanel.class, "MediaViewImagePanel.rotateLeftButton.text")); // NOI18N
        rotateLeftButton.setToolTipText(org.openide.util.NbBundle.getMessage(MediaViewImagePanel.class, "MediaViewImagePanel.rotateLeftButton.toolTipText")); // NOI18N
        rotateLeftButton.setFocusable(false);
        rotateLeftButton.setHorizontalTextPosition(javax.swing.SwingConstants.CENTER);
        rotateLeftButton.setMaximumSize(new java.awt.Dimension(24, 24));
        rotateLeftButton.setMinimumSize(new java.awt.Dimension(24, 24));
        rotateLeftButton.setPreferredSize(new java.awt.Dimension(24, 24));
        rotateLeftButton.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                rotateLeftButtonActionPerformed(evt);
            }
        });
        toolbar.add(rotateLeftButton);

        rotateRightButton.setIcon(new javax.swing.ImageIcon(getClass().getResource("/org/sleuthkit/autopsy/contentviewers/images/rotate-right.png"))); // NOI18N
        org.openide.awt.Mnemonics.setLocalizedText(rotateRightButton, org.openide.util.NbBundle.getMessage(MediaViewImagePanel.class, "MediaViewImagePanel.rotateRightButton.text")); // NOI18N
        rotateRightButton.setFocusable(false);
        rotateRightButton.setHorizontalTextPosition(javax.swing.SwingConstants.CENTER);
        rotateRightButton.setMaximumSize(new java.awt.Dimension(24, 24));
        rotateRightButton.setMinimumSize(new java.awt.Dimension(24, 24));
        rotateRightButton.setPreferredSize(new java.awt.Dimension(24, 24));
        rotateRightButton.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                rotateRightButtonActionPerformed(evt);
            }
        });
        toolbar.add(rotateRightButton);

        jSeparator1.setMaximumSize(new java.awt.Dimension(6, 20));
        toolbar.add(jSeparator1);

        zoomTextField.setEditable(false);
        zoomTextField.setHorizontalAlignment(javax.swing.JTextField.RIGHT);
        zoomTextField.setText(org.openide.util.NbBundle.getMessage(MediaViewImagePanel.class, "MediaViewImagePanel.zoomTextField.text")); // NOI18N
        zoomTextField.setMaximumSize(new java.awt.Dimension(50, 2147483647));
        zoomTextField.setMinimumSize(new java.awt.Dimension(50, 20));
        zoomTextField.setPreferredSize(new java.awt.Dimension(50, 20));
        toolbar.add(zoomTextField);

        zoomOutButton.setIcon(new javax.swing.ImageIcon(getClass().getResource("/org/sleuthkit/autopsy/contentviewers/images/zoom-out.png"))); // NOI18N
        org.openide.awt.Mnemonics.setLocalizedText(zoomOutButton, org.openide.util.NbBundle.getMessage(MediaViewImagePanel.class, "MediaViewImagePanel.zoomOutButton.text")); // NOI18N
        zoomOutButton.setFocusable(false);
        zoomOutButton.setHorizontalTextPosition(javax.swing.SwingConstants.CENTER);
        zoomOutButton.setMaximumSize(new java.awt.Dimension(24, 24));
        zoomOutButton.setMinimumSize(new java.awt.Dimension(24, 24));
        zoomOutButton.setPreferredSize(new java.awt.Dimension(24, 24));
        zoomOutButton.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                zoomOutButtonActionPerformed(evt);
            }
        });
        toolbar.add(zoomOutButton);

        zoomInButton.setIcon(new javax.swing.ImageIcon(getClass().getResource("/org/sleuthkit/autopsy/contentviewers/images/zoom-in.png"))); // NOI18N
        org.openide.awt.Mnemonics.setLocalizedText(zoomInButton, org.openide.util.NbBundle.getMessage(MediaViewImagePanel.class, "MediaViewImagePanel.zoomInButton.text")); // NOI18N
        zoomInButton.setFocusable(false);
        zoomInButton.setHorizontalTextPosition(javax.swing.SwingConstants.CENTER);
        zoomInButton.setMaximumSize(new java.awt.Dimension(24, 24));
        zoomInButton.setMinimumSize(new java.awt.Dimension(24, 24));
        zoomInButton.setPreferredSize(new java.awt.Dimension(24, 24));
        zoomInButton.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                zoomInButtonActionPerformed(evt);
            }
        });
        toolbar.add(zoomInButton);

        jSeparator2.setMaximumSize(new java.awt.Dimension(6, 20));
        toolbar.add(jSeparator2);

        org.openide.awt.Mnemonics.setLocalizedText(zoomResetButton, org.openide.util.NbBundle.getMessage(MediaViewImagePanel.class, "MediaViewImagePanel.zoomResetButton.text")); // NOI18N
        zoomResetButton.setFocusable(false);
        zoomResetButton.setHorizontalTextPosition(javax.swing.SwingConstants.CENTER);
        zoomResetButton.setVerticalTextPosition(javax.swing.SwingConstants.BOTTOM);
        zoomResetButton.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                zoomResetButtonActionPerformed(evt);
            }
        });
        toolbar.add(zoomResetButton);
        toolbar.add(filler1);
        toolbar.add(filler2);
        toolbar.add(jPanel1);

        org.openide.awt.Mnemonics.setLocalizedText(tagsMenu, org.openide.util.NbBundle.getMessage(MediaViewImagePanel.class, "MediaViewImagePanel.tagsMenu.text_1")); // NOI18N
        tagsMenu.setFocusable(false);
        tagsMenu.setHorizontalTextPosition(javax.swing.SwingConstants.CENTER);
        tagsMenu.setMaximumSize(new java.awt.Dimension(75, 21));
        tagsMenu.setMinimumSize(new java.awt.Dimension(75, 21));
        tagsMenu.setPreferredSize(new java.awt.Dimension(75, 21));
        tagsMenu.setVerticalTextPosition(javax.swing.SwingConstants.BOTTOM);
        tagsMenu.addMouseListener(new java.awt.event.MouseAdapter() {
            public void mousePressed(java.awt.event.MouseEvent evt) {
                tagsMenuMousePressed(evt);
            }
        });
        toolbar.add(tagsMenu);

        add(toolbar);
    }// </editor-fold>//GEN-END:initComponents

    private void rotateLeftButtonActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_rotateLeftButtonActionPerformed
        autoResize = false;
        
        rotation = (rotation + 270) % 360;
        updateView();
    }//GEN-LAST:event_rotateLeftButtonActionPerformed

    private void rotateRightButtonActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_rotateRightButtonActionPerformed
        autoResize = false;
        
        rotation = (rotation + 90) % 360;
        updateView();
    }//GEN-LAST:event_rotateRightButtonActionPerformed

    private void zoomInButtonActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_zoomInButtonActionPerformed
        autoResize = false;
        // Find the next zoom step.
        for (int i = 0; i < ZOOM_STEPS.length; i++) {
            if (zoomRatio < ZOOM_STEPS[i]) {
                zoomRatio = ZOOM_STEPS[i];
                break;
            }
        }
        updateView();
    }//GEN-LAST:event_zoomInButtonActionPerformed

    private void zoomOutButtonActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_zoomOutButtonActionPerformed
        autoResize = false;
        // Find the next zoom step.
        for (int i = ZOOM_STEPS.length - 1; i >= 0; i--) {
            if (zoomRatio > ZOOM_STEPS[i]) {
                zoomRatio = ZOOM_STEPS[i];
                break;
            }
        }
        updateView();
    }//GEN-LAST:event_zoomOutButtonActionPerformed

    private void zoomResetButtonActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_zoomResetButtonActionPerformed
        autoResize = true;
        resetView();
    }//GEN-LAST:event_zoomResetButtonActionPerformed

    private void formComponentResized(java.awt.event.ComponentEvent evt) {//GEN-FIRST:event_formComponentResized
        if (autoResize) {
            resetView();
        } else {
            updateView();
        }
    }//GEN-LAST:event_formComponentResized

    private void deleteTag() {
        Platform.runLater(() -> {
            ImageTag tagInFocus = tagsGroup.getFocus();
            if (tagInFocus == null) {
                return;
            }

            try {
                ContentViewerTag<ImageTagRegion> contentViewerTag = tagInFocus.getContentViewerTag();
                scrollPane.setCursor(Cursor.WAIT);
                ContentViewerTagManager.deleteTag(contentViewerTag);
                Case.getCurrentCase().getServices().getTagsManager().deleteContentTag(contentViewerTag.getContentTag());
                tagsGroup.getChildren().remove(tagInFocus);
            } catch (TskCoreException | NoCurrentCaseException ex) {
                LOGGER.log(Level.WARNING, "Could not delete image tag in case db", ex); //NON-NLS
            }

            scrollPane.setCursor(Cursor.DEFAULT);
        });

        pcs.firePropertyChange(new PropertyChangeEvent(this,
                "state", null, State.CREATE));
    }

    private void createTag() {
        pcs.firePropertyChange(new PropertyChangeEvent(this,
                "state", null, State.DISABLE));
        imageTagCreator = new ImageTagCreator(fxImageView);

        PropertyChangeListener newTagListener = (event) -> {
            SwingUtilities.invokeLater(() -> {
                ImageTagRegion tag = (ImageTagRegion) event.getNewValue();
                //Ask the user for tag name and comment
                TagNameAndComment result = GetTagNameAndCommentDialog.doDialog();
                if (result != null) {
                    //Persist and build image tag
                    Platform.runLater(() -> {
                        try {
                            scrollPane.setCursor(Cursor.WAIT);
                            ContentViewerTag<ImageTagRegion> contentViewerTag = storeImageTag(tag, result);
                            ImageTag imageTag = buildImageTag(contentViewerTag);
                            tagsGroup.getChildren().add(imageTag);
                        } catch (TskCoreException | SerializationException | NoCurrentCaseException ex) {
                            LOGGER.log(Level.WARNING, "Could not save new image tag in case db", ex); //NON-NLS
                        }

                        scrollPane.setCursor(Cursor.DEFAULT);
                    });
                }

                pcs.firePropertyChange(new PropertyChangeEvent(this,
                        "state", null, State.CREATE));
            });

            //Remove image tag creator from panel
            Platform.runLater(() -> {
                imageTagCreator.disconnect();
                masterGroup.getChildren().remove(imageTagCreator);
            });
        };

        imageTagCreator.addNewTagListener(newTagListener);
        Platform.runLater(() -> masterGroup.getChildren().add(imageTagCreator));
    }

    private ImageTag buildImageTag(ContentViewerTag<ImageTagRegion> contentViewerTag) {
        ImageTag imageTag = new ImageTag(contentViewerTag, fxImageView);

        //Automatically persist edits made by user
        imageTag.subscribeToEditEvents((edit) -> {
            try {
                scrollPane.setCursor(Cursor.WAIT);
                ImageTagRegion newRegion = (ImageTagRegion) edit.getNewValue();
                ContentViewerTagManager.updateTag(contentViewerTag, newRegion);
            } catch (SerializationException | TskCoreException | NoCurrentCaseException ex) {
                LOGGER.log(Level.WARNING, "Could not save edit for image tag in case db", ex); //NON-NLS
            }
            scrollPane.setCursor(Cursor.DEFAULT);
        });
        return imageTag;
    }

    private ContentViewerTag<ImageTagRegion> storeImageTag(ImageTagRegion data, TagNameAndComment result)
            throws TskCoreException, SerializationException, NoCurrentCaseException {
        scrollPane.setCursor(Cursor.WAIT);
        try {
            ContentTag contentTag = Case.getCurrentCaseThrows().getServices().getTagsManager()
                    .addContentTag(file, result.getTagName(), result.getComment());
            return ContentViewerTagManager.saveTag(contentTag, data);
        } finally {
            scrollPane.setCursor(Cursor.DEFAULT);
        }
    }

    private void showOrHideTags() {
        Platform.runLater(() -> {
            if (DisplayOptions.HIDE_TAGS.getName().equals(hideTagsMenuItem.getText())) {
                //Temporarily remove the tags group and update buttons
                masterGroup.getChildren().remove(tagsGroup);
                hideTagsMenuItem.setText(DisplayOptions.SHOW_TAGS.getName());
                tagsGroup.clearFocus();
                pcs.firePropertyChange(new PropertyChangeEvent(this,
                        "state", null, State.HIDDEN));
            } else {
                //Add tags group back in and update buttons
                masterGroup.getChildren().add(tagsGroup);
                hideTagsMenuItem.setText(DisplayOptions.HIDE_TAGS.getName());
                pcs.firePropertyChange(new PropertyChangeEvent(this,
                        "state", null, State.VISIBLE));
            }
        });
    }

    @NbBundle.Messages({
        "MediaViewImagePanel.exportSaveText=Save",
        "MediaViewImagePanel.successfulExport=Tagged image was successfully saved.",
        "MediaViewImagePanel.unsuccessfulExport=Unable to export tagged image to disk.",
        "MediaViewImagePanel.fileChooserTitle=Choose a save location"
    })
    private void exportTags() {
        tagsGroup.clearFocus();
        exportChooser.setFileSelectionMode(JFileChooser.DIRECTORIES_ONLY);
        //Always base chooser location to export folder
        exportChooser.setCurrentDirectory(new File(Case.getCurrentCase().getExportDirectory()));
        int returnVal = exportChooser.showDialog(this, Bundle.MediaViewImagePanel_exportSaveText());
        if (returnVal == JFileChooser.APPROVE_OPTION) {
            new SwingWorker<Void, Void>() {
                @Override
                protected Void doInBackground() {
                    try {
                        //Retrieve content viewer tags
                        List<ContentTag> tags = Case.getCurrentCase().getServices()
                                .getTagsManager().getContentTagsByContent(file);
                        List<ContentViewerTag<ImageTagRegion>> contentViewerTags = getContentViewerTags(tags);

                        //Pull out image tag regions
                        Collection<ImageTagRegion> regions = contentViewerTags.stream()
                                .map(cvTag -> cvTag.getDetails()).collect(Collectors.toList());

                        //Apply tags to image and write to file
                        BufferedImage taggedImage = ImageTagsUtil.getImageWithTags(file, regions);
                        Path output = Paths.get(exportChooser.getSelectedFile().getPath(),
                                FilenameUtils.getBaseName(file.getName()) + "-with_tags.png"); //NON-NLS
                        ImageIO.write(taggedImage, "png", output.toFile());

                        JOptionPane.showMessageDialog(null, Bundle.MediaViewImagePanel_successfulExport());
                    } catch (Exception ex) { //Runtime exceptions may spill out of ImageTagsUtil from JavaFX.
                        //This ensures we (devs and users) have something when it doesn't work.
                        LOGGER.log(Level.WARNING, "Unable to export tagged image to disk", ex); //NON-NLS
                        JOptionPane.showMessageDialog(null, Bundle.MediaViewImagePanel_unsuccessfulExport());
                    }
                    return null;
                }
            }.execute();
        }
    }

    private void tagsMenuMousePressed(java.awt.event.MouseEvent evt) {//GEN-FIRST:event_tagsMenuMousePressed
        if (imageTaggingOptions.isEnabled()) {
            imageTaggingOptions.show(tagsMenu, -300 + tagsMenu.getWidth(), tagsMenu.getHeight() + 3);
        }
    }//GEN-LAST:event_tagsMenuMousePressed

    enum DisplayOptions {
        HIDE_TAGS("Hide"),
        SHOW_TAGS("Show");

        private final String name;

        DisplayOptions(String name) {
            this.name = name;
        }

        String getName() {
            return name;
        }
    }

    enum State {
        HIDDEN,
        VISIBLE,
        SELECTED,
        CREATE,
        EMPTY,
        NONEMPTY,
        DEFAULT,
        DISABLE;
    }

    // Variables declaration - do not modify//GEN-BEGIN:variables
    private javax.swing.Box.Filler filler1;
    private javax.swing.Box.Filler filler2;
    private javax.swing.JPanel jPanel1;
    private javax.swing.JToolBar.Separator jSeparator1;
    private javax.swing.JToolBar.Separator jSeparator2;
    private javax.swing.JButton rotateLeftButton;
    private javax.swing.JButton rotateRightButton;
    private javax.swing.JTextField rotationTextField;
    private javax.swing.JButton tagsMenu;
    private javax.swing.JToolBar toolbar;
    private javax.swing.JButton zoomInButton;
    private javax.swing.JButton zoomOutButton;
    private javax.swing.JButton zoomResetButton;
    private javax.swing.JTextField zoomTextField;
    // End of variables declaration//GEN-END:variables

    private void resetView() {
        Image image = fxImageView.getImage();
        if (image == null) {
            return;
        }

        double imageWidth = image.getWidth();
        double imageHeight = image.getHeight();
        double scrollPaneWidth = fxPanel.getWidth();
        double scrollPaneHeight = fxPanel.getHeight();
        double zoomRatioWidth = scrollPaneWidth / imageWidth;
        double zoomRatioHeight = scrollPaneHeight / imageHeight;

        // Use the smallest ratio size to fit the entire image in the view area.
        zoomRatio = zoomRatioWidth < zoomRatioHeight ? zoomRatioWidth : zoomRatioHeight;

        rotation = 0;

        scrollPane.setHvalue(0);
        scrollPane.setVvalue(0);

        updateView();
    }

    private void updateView() {
        Image image = fxImageView.getImage();
        if (image == null) {
            return;
        }

        // Image dimensions
        double imageWidth = image.getWidth();
        double imageHeight = image.getHeight();

        // Image dimensions with zooming applied
        double adjustedImageWidth = imageWidth * zoomRatio;
        double adjustedImageHeight = imageHeight * zoomRatio;

        // ImageView viewport dimensions
        double viewportWidth;
        double viewportHeight;

        // Panel dimensions
        double panelWidth = fxPanel.getWidth();
        double panelHeight = fxPanel.getHeight();

        // Coordinates to center the image on the panel
        double centerOffsetX = (panelWidth / 2) - (imageWidth / 2);
        double centerOffsetY = (panelHeight / 2) - (imageHeight / 2);

        // Coordinates to keep the image inside the left/top boundaries
        double leftOffsetX;
        double topOffsetY;

        // Scroll bar positions
        double scrollX = scrollPane.getHvalue();
        double scrollY = scrollPane.getVvalue();

        // Scroll bar position boundaries (work-around for viewport size bug)
        double maxScrollX;
        double maxScrollY;

        // Set viewport size and translation offsets.
        if ((rotation % 180) == 0) {
            // Rotation is 0 or 180.
            viewportWidth = adjustedImageWidth;
            viewportHeight = adjustedImageHeight;
            leftOffsetX = (adjustedImageWidth - imageWidth) / 2;
            topOffsetY = (adjustedImageHeight - imageHeight) / 2;
            maxScrollX = (adjustedImageWidth - panelWidth) / (imageWidth - panelWidth);
            maxScrollY = (adjustedImageHeight - panelHeight) / (imageHeight - panelHeight);
        } else {
            // Rotation is 90 or 270.
            viewportWidth = adjustedImageHeight;
            viewportHeight = adjustedImageWidth;
            leftOffsetX = (adjustedImageHeight - imageWidth) / 2;
            topOffsetY = (adjustedImageWidth - imageHeight) / 2;
            maxScrollX = (adjustedImageHeight - panelWidth) / (imageWidth - panelWidth);
            maxScrollY = (adjustedImageWidth - panelHeight) / (imageHeight - panelHeight);
        }

        // Work around bug that truncates image if dimensions are too small.
        if (viewportWidth < imageWidth) {
            viewportWidth = imageWidth;
            if (scrollX > maxScrollX) {
                scrollX = maxScrollX;
            }
        }
        if (viewportHeight < imageHeight) {
            viewportHeight = imageHeight;
            if (scrollY > maxScrollY) {
                scrollY = maxScrollY;
            }
        }

        // Update the viewport size.
        fxImageView.setViewport(new Rectangle2D(
                0, 0, viewportWidth, viewportHeight));

        // Step 1: Zoom
        Scale scale = new Scale();
        scale.setX(zoomRatio);
        scale.setY(zoomRatio);
        scale.setPivotX(imageWidth / 2);
        scale.setPivotY(imageHeight / 2);

        // Step 2: Rotate
        Rotate rotate = new Rotate();
        rotate.setPivotX(imageWidth / 2);
        rotate.setPivotY(imageHeight / 2);
        rotate.setAngle(rotation);

        // Step 3: Position
        Translate translate = new Translate();
        translate.setX(viewportWidth > fxPanel.getWidth() ? leftOffsetX : centerOffsetX);
        translate.setY(viewportHeight > fxPanel.getHeight() ? topOffsetY : centerOffsetY);

        // Add the transforms in reverse order of intended execution.
        // Note: They MUST be added in this order to ensure translate is
        // executed last.
        masterGroup.getTransforms().clear();
        masterGroup.getTransforms().addAll(translate, rotate, scale);

        // Adjust scroll bar positions for view changes.
        if (viewportWidth > fxPanel.getWidth()) {
            scrollPane.setHvalue(scrollX);
        }
        if (viewportHeight > fxPanel.getHeight()) {
            scrollPane.setVvalue(scrollY);
        }

        // Update all image controls to reflect the current values.
        zoomOutButton.setEnabled(zoomRatio > MIN_ZOOM_RATIO);
        zoomInButton.setEnabled(zoomRatio < MAX_ZOOM_RATIO);
        rotationTextField.setText((int) rotation + "°");
        zoomTextField.setText((Math.round(zoomRatio * 100.0)) + "%");
    }
}