CommunicationArtifactViewerHelper.java

Go to the documentation of this file.

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

import java.awt.Dimension;
import java.awt.Font;
import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.Toolkit;
import java.awt.datatransfer.StringSelection;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.ArrayList;
import java.util.List;
import javax.swing.JLabel;
import javax.swing.JMenuItem;
import javax.swing.JComponent;
import javax.swing.JPanel;
import javax.swing.JPopupMenu;
import javax.swing.JTextPane;
import javax.swing.SwingUtilities;
import org.openide.util.NbBundle;
import org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepository;

final class CommunicationArtifactViewerHelper {

    // Number of columns in the gridbag layout.
    private final static int MAX_COLS = 4;

    final static int LEFT_INSET = 12;

    private CommunicationArtifactViewerHelper() {

    }

    static JLabel addHeader(JPanel panel, GridBagLayout gridbagLayout, GridBagConstraints constraints, String headerString) {

        Insets savedInsets = constraints.insets;

        // create label for heading
        javax.swing.JLabel headingLabel = new javax.swing.JLabel();

        // add a blank line before the start of new section, unless it's 
        // the first section
        if (constraints.gridy != 0) {
            addBlankLine(panel, gridbagLayout, constraints);
        }
        constraints.gridy++;
        constraints.gridx = 0;

        // let the header span all of the row
        constraints.gridwidth = MAX_COLS;
        constraints.insets = new Insets(0, 0, 0, 0); // No inset for header

        // set text
        headingLabel.setText(headerString);

        // make it large and bold
        headingLabel.setFont(headingLabel.getFont().deriveFont(Font.BOLD, headingLabel.getFont().getSize() + 2));

        // add to panel
        gridbagLayout.setConstraints(headingLabel, constraints);
        panel.add(headingLabel);

        // reset constraints to normal
        constraints.gridwidth = 1;

        // add line end glue
        addLineEndGlue(panel, gridbagLayout, constraints);

        //restore insets
        constraints.insets = savedInsets;

        return headingLabel;
    }

    static void addNameValueRow(JPanel panel, GridBagLayout gridbagLayout, GridBagConstraints constraints, String keyString, String valueString) {
        addKey(panel, gridbagLayout, constraints, keyString);
        addValue(panel, gridbagLayout, constraints, valueString);
    }

    static void addComponent(JPanel panel, GridBagLayout gridbagLayout, GridBagConstraints constraints, JComponent component) {

        // add to panel
        gridbagLayout.setConstraints(component, constraints);
        panel.add(component);
    }

    static void addLineEndGlue(JPanel panel, GridBagLayout gridbagLayout, GridBagConstraints constraints) {
        // Place the filler just past the last column.
        constraints.gridx = MAX_COLS;

        double savedWeightX = constraints.weightx;
        int savedFill = constraints.fill;

        constraints.weightx = 1.0; // take up all the horizontal space
        constraints.fill = GridBagConstraints.BOTH;

        javax.swing.Box.Filler horizontalFiller = new javax.swing.Box.Filler(new Dimension(0, 0), new Dimension(0, 0), new Dimension(32767, 0));
        gridbagLayout.setConstraints(horizontalFiller, constraints);
        panel.add(horizontalFiller);

        // restore fill & weight
        constraints.fill = savedFill;
        constraints.weightx = savedWeightX;
    }

    static void addPageEndGlue(JPanel panel, GridBagLayout gridbagLayout, GridBagConstraints constraints) {

        constraints.gridx = 0;

        double savedWeighty = constraints.weighty;
        int savedFill = constraints.fill;

        constraints.weighty = 1.0; // take up all the vertical space
        constraints.fill = GridBagConstraints.VERTICAL;

        javax.swing.Box.Filler vertFiller = new javax.swing.Box.Filler(new Dimension(0, 0), new Dimension(0, 0), new Dimension(0, 32767));
        gridbagLayout.setConstraints(vertFiller, constraints);
        panel.add(vertFiller, constraints);

        //Resore weight & fill
        constraints.weighty = savedWeighty;
        constraints.fill = savedFill;
    }

    static void addBlankLine(JPanel panel, GridBagLayout gridbagLayout, GridBagConstraints constraints) {
        constraints.gridy++;
        constraints.gridx = 0;

        javax.swing.JLabel filler = new javax.swing.JLabel(" ");
        gridbagLayout.setConstraints(filler, constraints);
        panel.add(filler);

        addLineEndGlue(panel, gridbagLayout, constraints);
    }

    static JLabel addKey(JPanel panel, GridBagLayout gridbagLayout, GridBagConstraints constraints, String keyString) {
        return addKeyAtCol(panel, gridbagLayout, constraints, keyString, 0);
    }

    static JLabel addKeyAtCol(JPanel panel, GridBagLayout gridbagLayout, GridBagConstraints constraints, String keyString, int gridx) {

        // create label
        javax.swing.JLabel keyLabel = new javax.swing.JLabel();

        constraints.gridy++;
        constraints.gridx = gridx < MAX_COLS - 1 ? gridx : MAX_COLS - 2;

        // set text
        keyLabel.setText(keyString + ": ");

        // add to panel
        gridbagLayout.setConstraints(keyLabel, constraints);
        panel.add(keyLabel);

        return keyLabel;
    }

    static JTextPane addValue(JPanel panel, GridBagLayout gridbagLayout, GridBagConstraints constraints, String valueString) {
        return addValueAtCol(panel, gridbagLayout, constraints, valueString, 1);
    }

    static JTextPane addValueAtCol(JPanel panel, GridBagLayout gridbagLayout, GridBagConstraints constraints, String valueString, int gridx) {
        // create label,
        JTextPane valueField = new JTextPane();
        valueField.setEditable(false);
        valueField.setOpaque(false);

        constraints.gridx = gridx < MAX_COLS ? gridx : MAX_COLS - 1;

        GridBagConstraints cloneConstraints = (GridBagConstraints) constraints.clone();

        // let the value span 2 cols
        cloneConstraints.gridwidth = 2;
        cloneConstraints.fill = GridBagConstraints.BOTH;

        // set text
        valueField.setText(valueString);

        // attach a right click menu with Copy option
        valueField.addMouseListener(new java.awt.event.MouseAdapter() {
            @Override
            public void mouseClicked(java.awt.event.MouseEvent evt) {
                valueLabelMouseClicked(evt, valueField);
            }
        });

        // add label to panel
        gridbagLayout.setConstraints(valueField, cloneConstraints);
        panel.add(valueField);

        // end the line
        addLineEndGlue(panel, gridbagLayout, constraints);

        return valueField;
    }

    static JLabel addMessageRow(JPanel panel, GridBagLayout gridbagLayout, GridBagConstraints constraints, String messageString) {
        return addMessageRow(panel, gridbagLayout, constraints, messageString, 0);
    }

    static JLabel addMessageRow(JPanel panel, GridBagLayout gridbagLayout, GridBagConstraints constraints, String messageString, int gridx) {

        // create label
        javax.swing.JLabel messageLabel = new javax.swing.JLabel();

        constraints.gridy++;
        constraints.gridx = gridx < MAX_COLS - 1 ? gridx : MAX_COLS - 2;

        int savedGridwidth = constraints.gridwidth;

        constraints.gridwidth = 3;

        // set text
        messageLabel.setText(messageString);

        // add to panel
        gridbagLayout.setConstraints(messageLabel, constraints);
        panel.add(messageLabel);

        addLineEndGlue(panel, gridbagLayout, constraints);

        // restore constraints
        constraints.gridwidth = savedGridwidth;

        return messageLabel;
    }

    @NbBundle.Messages({
        "CommunicationArtifactViewerHelper_persona_label=Persona: ",
        "CommunicationArtifactViewerHelper_persona_searching=Searching...",
        "CommunicationArtifactViewerHelper_persona_unknown=Unknown",
        "CommunicationArtifactViewerHelper_persona_button_view=View",
        "CommunicationArtifactViewerHelper_persona_button_create=Create"
    })

    static List<AccountPersonaSearcherData> addPersonaRow(JPanel panel, GridBagLayout gridbagLayout, GridBagConstraints constraints, String accountIdentifier) {
        List<AccountPersonaSearcherData> dataList = new ArrayList<>();

        constraints.gridy++;
        constraints.gridx = 1;

        Insets savedInsets = constraints.insets;

        // extra Indent in
        constraints.insets = new java.awt.Insets(0, 2 * LEFT_INSET, 0, 0);

        // create label
        javax.swing.JLabel personaLabel = new javax.swing.JLabel();
        String personaLabelText = Bundle.CommunicationArtifactViewerHelper_persona_label();
        personaLabelText = personaLabelText.concat(CentralRepository.isEnabled()
                ? Bundle.CommunicationArtifactViewerHelper_persona_searching()
                : Bundle.CommunicationArtifactViewerHelper_persona_unknown());

        personaLabel.setText(personaLabelText);

        // add to panel
        gridbagLayout.setConstraints(personaLabel, constraints);
        panel.add(personaLabel);

        // restore constraint
        constraints.insets = savedInsets;

        constraints.gridx++;

        // Place a button as place holder. It will be enabled when persona is available. 
        javax.swing.JButton personaButton = new javax.swing.JButton();
        personaButton.setText(Bundle.CommunicationArtifactViewerHelper_persona_button_view());
        personaButton.setMargin(new Insets(0, 5, 0, 5));
        personaButton.setEnabled(false);

        gridbagLayout.setConstraints(personaButton, constraints);
        panel.add(personaButton);

        if (CentralRepository.isEnabled()) {
            // kick off a task to find the persona for this account
            dataList.add(new AccountPersonaSearcherData(accountIdentifier, personaLabel, personaButton));
        } else {
            personaLabel.setEnabled(false);
        }

        addLineEndGlue(panel, gridbagLayout, constraints);

        return dataList;
    }

    @NbBundle.Messages({
        "# {0} - contact name",
        "CommunicationArtifactViewerHelper_contact_label=Contact: {0}",
        "CommunicationArtifactViewerHelper_contact_label_unknown=Unknown"
    })
    static JComponent addContactRow(JPanel panel, GridBagLayout gridbagLayout, GridBagConstraints constraints, String contactId) {
        // Increase the y value because we are not calling the addKey
        constraints.gridy++;
        //Don't change the origian constraints, just make a copy to modify
        GridBagConstraints indentedConstraints = (GridBagConstraints) constraints.clone();

        // Add an indent to match persona labels
        indentedConstraints.insets = new java.awt.Insets(0, 2 * LEFT_INSET, 0, 0);

        String contactInfo = Bundle.CommunicationArtifactViewerHelper_contact_label(contactId != null && !contactId.isEmpty() ? contactId : Bundle.CommunicationArtifactViewerHelper_contact_label_unknown());

        return addValueAtCol(panel, gridbagLayout, indentedConstraints, contactInfo, 1);
    }

    @NbBundle.Messages({
        "CommunicationArtifactViewerHelper_menuitem_copy=Copy"
    })
    private static void valueLabelMouseClicked(java.awt.event.MouseEvent evt, JTextPane valueLabel) {
        if (SwingUtilities.isRightMouseButton(evt)) {
            JPopupMenu popup = new JPopupMenu();

            JMenuItem copyMenu = new JMenuItem(Bundle.CommunicationArtifactViewerHelper_menuitem_copy()); // NON-NLS
            copyMenu.addActionListener(new ActionListener() {
                @Override
                public void actionPerformed(ActionEvent e) {
                    Toolkit.getDefaultToolkit().getSystemClipboard().setContents(new StringSelection(valueLabel.getText()), null);
                }
            });

            popup.add(copyMenu);
            popup.show(valueLabel, evt.getX(), evt.getY());
        }
    }
}