TranslationContentPanel.java

Go to the documentation of this file.

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

import com.google.common.base.Strings;
import com.google.common.collect.ImmutableBiMap;
import java.awt.ComponentOrientation;
import java.awt.Font;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import javax.swing.JComboBox;
import org.openide.util.NbBundle;
import org.openide.util.NbBundle.Messages;
import org.sleuthkit.autopsy.corecomponents.AutoWrappingJTextPane;
import org.sleuthkit.autopsy.guiutils.WrapLayout;

@SuppressWarnings("PMD.SingularField") // UI widgets cause lots of false positives
public class TranslationContentPanel extends javax.swing.JPanel {

    private static final ImmutableBiMap<String, String> LANGUAGE_NAMES;
    private static final long serialVersionUID = 1L;
    private int lastSelectedIndex = 0;
    
    private final AutoWrappingJTextPane DISPLAY_PANE;

    public TranslationContentPanel() {
        initComponents();
        additionalInitComponents();
              
        DISPLAY_PANE = new AutoWrappingJTextPane();
        DISPLAY_PANE.setEditable(false);
        textScrollPane.setViewportView(DISPLAY_PANE);
        reset();
    }

    final void removeDisplayTextOptions(String option) {
        displayTextComboBox.removeItem(option);
    }

    public void display(String text, ComponentOrientation direction, int font) {
        DISPLAY_PANE.setComponentOrientation(direction);
        DISPLAY_PANE.setText(text);
        DISPLAY_PANE.setFont(new Font(DISPLAY_PANE.getFont().getName(),
                font, DISPLAY_PANE.getFont().getSize()));
        DISPLAY_PANE.setCaretPosition(0);
    }

    void addDisplayTextActionListener(ActionListener listener) {
        displayTextComboBox.addActionListener(listener);
    }

    final void addOcrDropDownActionListener(ActionListener listener) {
        ocrDropdown.addActionListener(listener);
    }

    String getDisplayDropDownSelection() {
        return (String) displayTextComboBox.getSelectedItem();
    }

    String getSelectedOcrLanguagePack() {
        String selection = (String) ocrDropdown.getSelectedItem();
        return Strings.nullToEmpty(LANGUAGE_NAMES.inverse().get(selection));
    }

    private void removeAllActionListeners(JComboBox<String> dropDown) {
        for (ActionListener listener : dropDown.getActionListeners()) {
            dropDown.removeActionListener(listener);
        }
    }
    
    void setWarningLabelMsg(String msg) {
        warningLabel.setText(msg);
    }

    @NbBundle.Messages({"TranslationContentPanel.autoDetectOCR=Autodetect language"})
    final void reset() {
        display("", ComponentOrientation.LEFT_TO_RIGHT, Font.PLAIN);

        removeAllActionListeners(displayTextComboBox);
        displayTextComboBox.removeAllItems();
        displayTextComboBox.addItem(DisplayDropdownOptions.TRANSLATED_TEXT.toString());
        displayTextComboBox.addItem(DisplayDropdownOptions.ORIGINAL_TEXT.toString());

        enableOCRSelection(false);
        removeAllActionListeners(ocrDropdown);
        ocrDropdown.removeAllItems();
    }

    final void enableOCRSelection(boolean enabled) {
        ocrLabel.setEnabled(enabled);
        ocrDropdown.setEnabled(enabled);
    }

    void addLanguagePackNames(List<String> languagePackAbbreviations) {
        //Put the default at the top of the list.
        ocrDropdown.addItem(Bundle.TranslationContentPanel_autoDetectOCR());

        //Create a shallow copy of the input list for sorting
        List<String> localCopy = new ArrayList<>(languagePackAbbreviations);

        localCopy.stream().sorted().forEach((abbrev) -> {
            if (LANGUAGE_NAMES.get(abbrev) != null) {
                ocrDropdown.addItem(LANGUAGE_NAMES.get(abbrev));
            }
        });

        ocrDropdown.setSelectedIndex(lastSelectedIndex);
        addOcrDropDownActionListener((ActionEvent e) -> {
            lastSelectedIndex = ocrDropdown.getSelectedIndex();
        });
    }

    private static ImmutableBiMap<String, String> createLanguageBiMap() {
        return ImmutableBiMap.<String, String>builder()
                .put("afr", "Afrikaans")
                .put("amh", "Amharic")
                .put("ara", "Arabic")
                .put("asm", "Assamese")
                .put("aze", "Azerbaijani")
                .put("aze_cyrl", "Azerbaijani - Cyrillic")
                .put("bel", "Belarusian")
                .put("ben", "Bengali")
                .put("bod", "Tibetan")
                .put("bos", "Bosnian")
                .put("bul", "Bulgarian")
                .put("cat", "Catalan; Valencian")
                .put("ceb", "Cebuano")
                .put("ces", "Czech")
                .put("chi_sim", "Chinese - Simplified")
                .put("chi_tra", "Chinese - Traditional")
                .put("chr", "Cherokee")
                .put("cym", "Welsh")
                .put("dan", "Danish")
                .put("deu", "German")
                .put("dzo", "Dzongkha")
                .put("ell", "Greek, Modern (1453-)")
                .put("eng", "English")
                .put("enm", "English, Middle (1100-1500)")
                .put("epo", "Esperanto")
                .put("est", "Estonian")
                .put("eus", "Basque")
                .put("fas", "Persian")
                .put("fin", "Finnish")
                .put("fra", "French")
                .put("frk", "Frankish")
                .put("frm", "French, Middle (ca. 1400-1600)")
                .put("gle", "Irish")
                .put("glg", "Galician")
                .put("grc", "Greek, Ancient (-1453)")
                .put("guj", "Gujarati")
                .put("hat", "Haitian; Haitian Creole")
                .put("heb", "Hebrew")
                .put("hin", "Hindi")
                .put("hrv", "Croatian")
                .put("hun", "Hungarian")
                .put("iku", "Inuktitut")
                .put("ind", "Indonesian")
                .put("isl", "Icelandic")
                .put("ita", "Italian")
                .put("ita_old", "Italian - Old")
                .put("jav", "Javanese")
                .put("jpn", "Japanese")
                .put("kan", "Kannada")
                .put("kat", "Georgian")
                .put("kat_old", "Georgian - Old")
                .put("kaz", "Kazakh")
                .put("khm", "Central Khmer")
                .put("kir", "Kirghiz; Kyrgyz")
                .put("kor", "Korean")
                .put("kur", "Kurdish")
                .put("lao", "Lao")
                .put("lat", "Latin")
                .put("lav", "Latvian")
                .put("lit", "Lithuanian")
                .put("mal", "Malayalam")
                .put("mar", "Marathi")
                .put("mkd", "Macedonian")
                .put("mlt", "Maltese")
                .put("msa", "Malay")
                .put("mya", "Burmese")
                .put("nep", "Nepali")
                .put("nld", "Dutch; Flemish")
                .put("nor", "Norwegian")
                .put("ori", "Oriya")
                .put("pan", "Panjabi; Punjabi")
                .put("pol", "Polish")
                .put("por", "Portuguese")
                .put("pus", "Pushto; Pashto")
                .put("ron", "Romanian; Moldavian; Moldovan")
                .put("rus", "Russian")
                .put("san", "Sanskrit")
                .put("sin", "Sinhala; Sinhalese")
                .put("slk", "Slovak")
                .put("slv", "Slovenian")
                .put("spa", "Spanish; Castilian")
                .put("spa_old", "Spanish; Castilian - Old")
                .put("sqi", "Albanian")
                .put("srp", "Serbian")
                .put("srp_latn", "Serbian - Latin")
                .put("swa", "Swahili")
                .put("swe", "Swedish")
                .put("syr", "Syriac")
                .put("tam", "Tamil")
                .put("tel", "Telugu")
                .put("tgk", "Tajik")
                .put("tgl", "Tagalog")
                .put("tha", "Thai")
                .put("tir", "Tigrinya")
                .put("tur", "Turkish")
                .put("uig", "Uighur; Uyghur")
                .put("ukr", "Ukrainian")
                .put("urd", "Urdu")
                .put("uzb", "Uzbek")
                .put("uzb_cyrl", "Uzbek - Cyrillic")
                .put("vie", "Vietnamese")
                .put("yid", "Yiddish")
                .build();
    }

    static {
        //https://github.com/tesseract-ocr/tesseract/wiki/Data-Files
        LANGUAGE_NAMES = createLanguageBiMap();
    }

    private void additionalInitComponents() {
        // use wrap layout for better component wrapping
        WrapLayout layout = new WrapLayout(0,5);
        layout.setOppositeAligned(Arrays.asList(showPanel, ocrPanel));
        controlPanel.setLayout(layout);
    }

    @Messages({"TranslatedContentPanel.comboBoxOption.originalText=Original Text (Up to 25KB)",
        "TranslatedContentPanel.comboBoxOption.translatedText=Translated Text"})
    static enum DisplayDropdownOptions {
        ORIGINAL_TEXT(Bundle.TranslatedContentPanel_comboBoxOption_originalText()),
        TRANSLATED_TEXT(Bundle.TranslatedContentPanel_comboBoxOption_translatedText());

        private final String displayString;

        DisplayDropdownOptions(String displayString) {
            this.displayString = displayString;
        }

        @Override
        public String toString() {
            return displayString;
        }
    }

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

        controlPanel = new javax.swing.JPanel();
        javax.swing.JPanel warningLabelPanel = new javax.swing.JPanel();
        warningLabel = new javax.swing.JLabel();
        jSeparator1 = new javax.swing.JSeparator();
        showPanel = new javax.swing.JPanel();
        showLabel = new javax.swing.JLabel();
        javax.swing.JSeparator jSepMed1 = new javax.swing.JSeparator();
        displayTextComboBox = new javax.swing.JComboBox<>();
        ocrPanel = new javax.swing.JPanel();
        javax.swing.JSeparator jSepLarge1 = new javax.swing.JSeparator();
        ocrLabel = new javax.swing.JLabel();
        javax.swing.JSeparator jSepMed2 = new javax.swing.JSeparator();
        ocrDropdown = new javax.swing.JComboBox<>();
        textScrollPane = new javax.swing.JScrollPane();

        setMaximumSize(new java.awt.Dimension(2000, 2000));
        setMinimumSize(new java.awt.Dimension(250, 2));
        setName(""); // NOI18N
        setPreferredSize(new java.awt.Dimension(250, 58));
        setVerifyInputWhenFocusTarget(false);
        setLayout(new java.awt.BorderLayout());

        controlPanel.setMaximumSize(new java.awt.Dimension(20000, 20000));
        controlPanel.setMinimumSize(new java.awt.Dimension(2, 25));
        controlPanel.setName(""); // NOI18N
        controlPanel.setLayout(new java.awt.FlowLayout(java.awt.FlowLayout.LEFT, 5, 0));

        warningLabelPanel.setMaximumSize(new java.awt.Dimension(32767, 25));
        warningLabelPanel.setMinimumSize(new java.awt.Dimension(2, 25));
        warningLabelPanel.setLayout(new java.awt.FlowLayout(java.awt.FlowLayout.CENTER, 0, 0));

        warningLabel.setIcon(new javax.swing.ImageIcon(getClass().getResource("/org/sleuthkit/autopsy/images/warning16.png"))); // NOI18N
        warningLabel.setMaximumSize(new java.awt.Dimension(250, 25));
        warningLabel.setMinimumSize(new java.awt.Dimension(150, 25));
        warningLabel.setPreferredSize(null);
        warningLabelPanel.add(warningLabel);

        jSeparator1.setMaximumSize(new java.awt.Dimension(1, 25));
        jSeparator1.setMinimumSize(new java.awt.Dimension(1, 25));
        jSeparator1.setPreferredSize(new java.awt.Dimension(1, 25));
        warningLabelPanel.add(jSeparator1);

        controlPanel.add(warningLabelPanel);

        showPanel.setMaximumSize(new java.awt.Dimension(32767, 25));
        showPanel.setMinimumSize(new java.awt.Dimension(0, 25));
        showPanel.setLayout(new java.awt.FlowLayout(java.awt.FlowLayout.CENTER, 0, 0));

        org.openide.awt.Mnemonics.setLocalizedText(showLabel, org.openide.util.NbBundle.getMessage(TranslationContentPanel.class, "TranslationContentPanel.showLabel.text")); // NOI18N
        showLabel.setMaximumSize(new java.awt.Dimension(42, 25));
        showLabel.setMinimumSize(new java.awt.Dimension(42, 25));
        showLabel.setPreferredSize(null);
        showPanel.add(showLabel);

        jSepMed1.setPreferredSize(new java.awt.Dimension(5, 0));
        showPanel.add(jSepMed1);

        displayTextComboBox.setMaximumSize(new java.awt.Dimension(170, 25));
        displayTextComboBox.setMinimumSize(new java.awt.Dimension(170, 25));
        displayTextComboBox.setPreferredSize(new java.awt.Dimension(170, 25));
        showPanel.add(displayTextComboBox);

        controlPanel.add(showPanel);

        ocrPanel.setMaximumSize(new java.awt.Dimension(32767, 25));
        ocrPanel.setMinimumSize(new java.awt.Dimension(0, 25));
        ocrPanel.setLayout(new java.awt.FlowLayout(java.awt.FlowLayout.CENTER, 0, 0));

        jSepLarge1.setPreferredSize(new java.awt.Dimension(10, 0));
        ocrPanel.add(jSepLarge1);
        jSepLarge1.getAccessibleContext().setAccessibleName(org.openide.util.NbBundle.getMessage(TranslationContentPanel.class, "TranslationContentPanel.jSepLarge1.AccessibleContext.accessibleName")); // NOI18N

        org.openide.awt.Mnemonics.setLocalizedText(ocrLabel, org.openide.util.NbBundle.getMessage(TranslationContentPanel.class, "TranslationContentPanel.ocrLabel.text")); // NOI18N
        ocrLabel.setEnabled(false);
        ocrLabel.setMaximumSize(new java.awt.Dimension(40, 25));
        ocrLabel.setMinimumSize(new java.awt.Dimension(25, 16));
        ocrLabel.setPreferredSize(null);
        ocrPanel.add(ocrLabel);

        jSepMed2.setPreferredSize(new java.awt.Dimension(5, 0));
        ocrPanel.add(jSepMed2);

        ocrDropdown.setModel(new javax.swing.DefaultComboBoxModel<>(new String[] { "N/A" }));
        ocrDropdown.setEnabled(false);
        ocrDropdown.setMaximumSize(new java.awt.Dimension(170, 25));
        ocrDropdown.setMinimumSize(new java.awt.Dimension(170, 25));
        ocrDropdown.setName(""); // NOI18N
        ocrDropdown.setPreferredSize(new java.awt.Dimension(170, 25));
        ocrPanel.add(ocrDropdown);

        controlPanel.add(ocrPanel);

        add(controlPanel, java.awt.BorderLayout.NORTH);

        textScrollPane.setHorizontalScrollBarPolicy(javax.swing.ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER);
        textScrollPane.setMaximumSize(new java.awt.Dimension(20000, 20000));
        textScrollPane.setMinimumSize(new java.awt.Dimension(20, 20));
        textScrollPane.setPreferredSize(new java.awt.Dimension(20, 20));
        add(textScrollPane, java.awt.BorderLayout.CENTER);
    }// </editor-fold>//GEN-END:initComponents

    // Variables declaration - do not modify//GEN-BEGIN:variables
    private javax.swing.JPanel controlPanel;
    private javax.swing.JComboBox<String> displayTextComboBox;
    private javax.swing.JSeparator jSeparator1;
    private javax.swing.JComboBox<String> ocrDropdown;
    private javax.swing.JLabel ocrLabel;
    private javax.swing.JPanel ocrPanel;
    private javax.swing.JLabel showLabel;
    private javax.swing.JPanel showPanel;
    private javax.swing.JScrollPane textScrollPane;
    private javax.swing.JLabel warningLabel;
    // End of variables declaration//GEN-END:variables
}