IngestJobSettingsPanel.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011-2018 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.ingest;
 
import org.sleuthkit.autopsy.python.FactoryClassNameNormalizer;
import java.awt.Component;
import java.awt.event.ActionEvent;
import java.awt.event.WindowAdapter;
import java.awt.event.WindowEvent;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
import javax.swing.DefaultComboBoxModel;
import javax.swing.Icon;
import javax.swing.ImageIcon;
import javax.swing.JDialog;
import javax.swing.JLabel;
import javax.swing.JTable;
import javax.swing.ListSelectionModel;
import javax.swing.SwingUtilities;
import javax.swing.event.ListSelectionEvent;
import javax.swing.table.AbstractTableModel;
import javax.swing.table.DefaultTableCellRenderer;
import javax.swing.table.TableColumn;
import org.openide.util.NbBundle.Messages;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.casemodule.IngestJobInfoPanel;
import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException;
import org.sleuthkit.autopsy.corecomponents.AdvancedConfigurationDialog;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.modules.interestingitems.FilesSet;
import org.sleuthkit.autopsy.modules.interestingitems.FilesSetDefsPanel;
import org.sleuthkit.autopsy.modules.interestingitems.FilesSetPanel;
import org.sleuthkit.datamodel.Content;
import org.sleuthkit.datamodel.IngestJobInfo;
import org.sleuthkit.datamodel.IngestModuleInfo;
import org.sleuthkit.datamodel.SleuthkitCase;
import org.sleuthkit.datamodel.TskCoreException;
import org.sleuthkit.autopsy.modules.interestingitems.FilesSetsManager;

@SuppressWarnings("PMD.SingularField") // UI widgets cause lots of false positives
public final class IngestJobSettingsPanel extends javax.swing.JPanel {
 
    private static final long serialVersionUID = 1L;
    private static ImageIcon warningIcon = new ImageIcon(IngestJobSettingsPanel.class.getResource("/org/sleuthkit/autopsy/images/warning_triangle.png"));
    private static ImageIcon infoIcon = new ImageIcon(IngestJobSettingsPanel.class.getResource("/org/sleuthkit/autopsy/images/information-frame.png"));
    private final IngestJobSettings settings;
    private final List<Content> dataSources = new ArrayList<>();
    private final List<IngestJobInfo> ingestJobs = new ArrayList<>();
    private final List<IngestModuleModel> modules = new ArrayList<>();
    private final IngestModulesTableModel tableModel = new IngestModulesTableModel();
    private IngestModuleModel selectedModule;
    private static final Logger logger = Logger.getLogger(IngestJobSettingsPanel.class.getName());

    public IngestJobSettingsPanel(IngestJobSettings settings) {
        this.settings = settings;
        for (IngestModuleTemplate moduleTemplate : settings.getIngestModuleTemplates()) {
            modules.add(new IngestModuleModel(moduleTemplate));
        }
        initComponents();
        customizeComponents();
        fileIngestFilterComboBox.setSelectedItem(settings.getFileFilter().getName());
    }

    public IngestJobSettingsPanel(IngestJobSettings settings, List<Content> dataSources) {
        this.settings = settings;
        this.dataSources.addAll(dataSources);
        try {
            SleuthkitCase skCase = Case.getCurrentCaseThrows().getSleuthkitCase();
            ingestJobs.addAll(skCase.getIngestJobs());
        } catch (NoCurrentCaseException ex) {
            logger.log(Level.SEVERE, "No open case", ex);
        } catch (TskCoreException ex) {
            logger.log(Level.SEVERE, "Failed to load ingest job information", ex);
        }
        for (IngestModuleTemplate moduleTemplate : settings.getIngestModuleTemplates()) {
            this.modules.add(new IngestModuleModel(moduleTemplate));
        }
        initComponents();
        customizeComponents();
        fileIngestFilterComboBox.setSelectedItem(settings.getFileFilter().getName());
    }

    public IngestJobSettings getSettings() {
        List<IngestModuleTemplate> moduleTemplates = new ArrayList<>();
        for (IngestModuleModel module : modules) {
            IngestModuleTemplate moduleTemplate = module.getIngestModuleTemplate();
            if (module.hasModuleSettingsPanel()) {
                IngestModuleIngestJobSettings moduleSettings = module.getModuleSettingsPanel().getSettings();
                moduleTemplate.setModuleSettings(moduleSettings);
            }
            moduleTemplates.add(moduleTemplate);
        }
        this.settings.setIngestModuleTemplates(moduleTemplates);
        return this.settings;
    }
 
    @Messages({"IngestJobSettingsPanel.noPerRunSettings=The selected module has no per-run settings."})
    private void customizeComponents() {
        modulesTable.setModel(tableModel);
        modulesTable.setTableHeader(null);
        modulesTable.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
 
        // Set the column widths in the table model and add a custom cell 
        // renderer that will display module descriptions from the module models 
        // as tooltips.
        IngestModulesTableRenderer renderer = new IngestModulesTableRenderer();
        int width = modulesScrollPane.getPreferredSize().width;
        for (int i = 0; i < modulesTable.getColumnCount(); ++i) {
            TableColumn column = modulesTable.getColumnModel().getColumn(i);
            if (0 == i) {
                column.setPreferredWidth(((int) (width * 0.15)));
            } else {
                column.setCellRenderer(renderer);
                column.setPreferredWidth(((int) (width * 0.84)));
            }
        }
 
        // Add a selection listener to the table model that will display the  
        // ingest job options panel of the currently selected module model and 
        // enable or disable the resources configuration panel invocation button.
        modulesTable.getSelectionModel().addListSelectionListener((ListSelectionEvent e) -> {
            ListSelectionModel listSelectionModel = (ListSelectionModel) e.getSource();
            if (!listSelectionModel.isSelectionEmpty()) {
                int index = listSelectionModel.getMinSelectionIndex();
                selectedModule = modules.get(index);
                ingestSettingsPanel.removeAll();
                if (null != selectedModule.getModuleSettingsPanel()) {
                    ingestSettingsPanel.add(selectedModule.getModuleSettingsPanel());
                } else {
                    ingestSettingsPanel.add(new JLabel(Bundle.IngestJobSettingsPanel_noPerRunSettings()));
                }
                ingestSettingsPanel.revalidate();
                ingestSettingsPanel.repaint();
                globalSettingsButton.setEnabled(null != selectedModule.getGlobalSettingsPanel());
                descriptionLabel.setText(selectedModule.getDescription());
                descriptionLabel.setToolTipText(selectedModule.getDescription());
            }
        });
        modulesTable.setRowSelectionInterval(0, 0);
        this.modulesTable.getColumnModel().getColumn(0).setMaxWidth(22);
        this.modulesTable.getColumnModel().getColumn(1).setMaxWidth(20);
        this.modulesTable.getColumnModel().getColumn(1).setMinWidth(20);
        modulesTable.setRowHeight(20);
 
        /*
         * Only enable the ingest jobs history panel if there are data sources
         * and jobs for which to display the history.
         */
        pastJobsButton.setEnabled(!dataSources.isEmpty() && !ingestJobs.isEmpty());
    }
 
    void setPastJobsButtonVisible(boolean isVisible) {
        pastJobsButton.setVisible(isVisible);
    }

    @SuppressWarnings("unchecked")
    // <editor-fold defaultstate="collapsed" desc="Generated Code">//GEN-BEGIN:initComponents
    private void initComponents() {
 
        timeGroup = new javax.swing.ButtonGroup();
        modulesScrollPane = new javax.swing.JScrollPane();
        modulesTable = new javax.swing.JTable();
        jPanel1 = new javax.swing.JPanel();
        globalSettingsButton = new javax.swing.JButton();
        jSeparator2 = new javax.swing.JSeparator();
        descriptionLabel = new javax.swing.JLabel();
        jScrollPane1 = new javax.swing.JScrollPane();
        ingestSettingsPanel = new javax.swing.JPanel();
        jButtonSelectAll = new javax.swing.JButton();
        jButtonDeselectAll = new javax.swing.JButton();
        pastJobsButton = new javax.swing.JButton();
        fileIngestFilterLabel = new javax.swing.JLabel();
        fileIngestFilterComboBox = new javax.swing.JComboBox<>();
 
        setMaximumSize(new java.awt.Dimension(5750, 3000));
        setMinimumSize(new java.awt.Dimension(0, 0));
        setPreferredSize(new java.awt.Dimension(625, 450));
 
        modulesScrollPane.setBorder(javax.swing.BorderFactory.createLineBorder(new java.awt.Color(160, 160, 160)));
        modulesScrollPane.setMinimumSize(new java.awt.Dimension(0, 0));
        modulesScrollPane.setPreferredSize(new java.awt.Dimension(160, 160));
 
        modulesTable.setBackground(new java.awt.Color(240, 240, 240));
        modulesTable.setModel(new javax.swing.table.DefaultTableModel(
            new Object [][] {
 
            },
            new String [] {
 
            }
        ));
        modulesTable.setShowHorizontalLines(false);
        modulesTable.setShowVerticalLines(false);
        modulesScrollPane.setViewportView(modulesTable);
 
        jPanel1.setBorder(javax.swing.BorderFactory.createLineBorder(new java.awt.Color(160, 160, 160)));
        jPanel1.setPreferredSize(new java.awt.Dimension(338, 257));
 
        globalSettingsButton.setText(org.openide.util.NbBundle.getMessage(IngestJobSettingsPanel.class, "IngestJobSettingsPanel.globalSettingsButton.text")); // NOI18N
        globalSettingsButton.setActionCommand(org.openide.util.NbBundle.getMessage(IngestJobSettingsPanel.class, "IngestJobSettingsPanel.globalSettingsButton.actionCommand")); // NOI18N
        globalSettingsButton.setEnabled(false);
        globalSettingsButton.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                globalSettingsButtonActionPerformed(evt);
            }
        });
 
        descriptionLabel.setText("DO NOT REMOVE. This dummy text is used to anchor the inner panel's size to the outer panel, while still being expandable. Without this the expandability behavior doesn't work well. This text will never be shown, as it would only be shown when no module is selected (which is not possible).");
 
        jScrollPane1.setBorder(null);
        jScrollPane1.setPreferredSize(new java.awt.Dimension(250, 180));
 
        ingestSettingsPanel.setMinimumSize(new java.awt.Dimension(0, 300));
        ingestSettingsPanel.setLayout(new javax.swing.BoxLayout(ingestSettingsPanel, javax.swing.BoxLayout.PAGE_AXIS));
        jScrollPane1.setViewportView(ingestSettingsPanel);
 
        javax.swing.GroupLayout jPanel1Layout = new javax.swing.GroupLayout(jPanel1);
        jPanel1.setLayout(jPanel1Layout);
        jPanel1Layout.setHorizontalGroup(
            jPanel1Layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
            .addComponent(jSeparator2, javax.swing.GroupLayout.Alignment.TRAILING)
            .addGroup(jPanel1Layout.createSequentialGroup()
                .addGap(8, 8, 8)
                .addGroup(jPanel1Layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
                    .addComponent(descriptionLabel, javax.swing.GroupLayout.PREFERRED_SIZE, 0, Short.MAX_VALUE)
                    .addComponent(jScrollPane1, javax.swing.GroupLayout.Alignment.TRAILING, javax.swing.GroupLayout.DEFAULT_SIZE, 266, Short.MAX_VALUE)
                    .addGroup(javax.swing.GroupLayout.Alignment.TRAILING, jPanel1Layout.createSequentialGroup()
                        .addGap(0, 0, Short.MAX_VALUE)
                        .addComponent(globalSettingsButton)))
                .addGap(8, 8, 8))
        );
        jPanel1Layout.setVerticalGroup(
            jPanel1Layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
            .addGroup(javax.swing.GroupLayout.Alignment.TRAILING, jPanel1Layout.createSequentialGroup()
                .addContainerGap()
                .addComponent(jScrollPane1, javax.swing.GroupLayout.DEFAULT_SIZE, 328, Short.MAX_VALUE)
                .addGap(18, 18, 18)
                .addComponent(jSeparator2, javax.swing.GroupLayout.PREFERRED_SIZE, 2, javax.swing.GroupLayout.PREFERRED_SIZE)
                .addGap(8, 8, 8)
                .addComponent(descriptionLabel, javax.swing.GroupLayout.PREFERRED_SIZE, 19, javax.swing.GroupLayout.PREFERRED_SIZE)
                .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
                .addComponent(globalSettingsButton)
                .addGap(8, 8, 8))
        );
 
        jButtonSelectAll.setText(org.openide.util.NbBundle.getMessage(IngestJobSettingsPanel.class, "IngestJobSettingsPanel.jButtonSelectAll.text")); // NOI18N
        jButtonSelectAll.setMargin(new java.awt.Insets(2, 8, 2, 8));
        jButtonSelectAll.setMaximumSize(new java.awt.Dimension(87, 23));
        jButtonSelectAll.setMinimumSize(new java.awt.Dimension(87, 23));
        jButtonSelectAll.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                jButtonSelectAllActionPerformed(evt);
            }
        });
 
        jButtonDeselectAll.setText(org.openide.util.NbBundle.getMessage(IngestJobSettingsPanel.class, "IngestJobSettingsPanel.jButtonDeselectAll.text")); // NOI18N
        jButtonDeselectAll.setMargin(new java.awt.Insets(2, 8, 2, 8));
        jButtonDeselectAll.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                jButtonDeselectAllActionPerformed(evt);
            }
        });
 
        pastJobsButton.setText(org.openide.util.NbBundle.getMessage(IngestJobSettingsPanel.class, "IngestJobSettingsPanel.pastJobsButton.text")); // NOI18N
        pastJobsButton.setMargin(new java.awt.Insets(2, 8, 2, 8));
        pastJobsButton.setMaximumSize(new java.awt.Dimension(87, 23));
        pastJobsButton.setMinimumSize(new java.awt.Dimension(87, 23));
        pastJobsButton.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                pastJobsButtonActionPerformed(evt);
            }
        });
 
        fileIngestFilterLabel.setText(org.openide.util.NbBundle.getMessage(IngestJobSettingsPanel.class, "IngestJobSettingsPanel.fileIngestFilterLabel.text")); // NOI18N
 
        fileIngestFilterComboBox.setModel(new DefaultComboBoxModel<>(getComboBoxContents()));
        fileIngestFilterComboBox.addActionListener(new java.awt.event.ActionListener() {
            public void actionPerformed(java.awt.event.ActionEvent evt) {
                fileIngestFilterComboBoxActionPerformed(evt);
            }
        });
 
        javax.swing.GroupLayout layout = new javax.swing.GroupLayout(this);
        this.setLayout(layout);
        layout.setHorizontalGroup(
            layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
            .addGroup(layout.createSequentialGroup()
                .addGap(5, 5, 5)
                .addGroup(layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING, false)
                    .addGroup(layout.createSequentialGroup()
                        .addComponent(jButtonSelectAll, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE)
                        .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
                        .addComponent(jButtonDeselectAll, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE)
                        .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
                        .addComponent(pastJobsButton, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE))
                    .addComponent(modulesScrollPane, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE)
                    .addComponent(fileIngestFilterLabel)
                    .addComponent(fileIngestFilterComboBox, 0, javax.swing.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE))
                .addGap(4, 4, 4)
                .addComponent(jPanel1, javax.swing.GroupLayout.DEFAULT_SIZE, 284, Short.MAX_VALUE)
                .addGap(5, 5, 5))
        );
 
        layout.linkSize(javax.swing.SwingConstants.HORIZONTAL, new java.awt.Component[] {jButtonDeselectAll, jButtonSelectAll, pastJobsButton});
 
        layout.setVerticalGroup(
            layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
            .addGroup(javax.swing.GroupLayout.Alignment.TRAILING, layout.createSequentialGroup()
                .addContainerGap()
                .addGroup(layout.createParallelGroup(javax.swing.GroupLayout.Alignment.TRAILING)
                    .addGroup(layout.createSequentialGroup()
                        .addComponent(fileIngestFilterLabel)
                        .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
                        .addComponent(fileIngestFilterComboBox, javax.swing.GroupLayout.PREFERRED_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.PREFERRED_SIZE)
                        .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
                        .addComponent(modulesScrollPane, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE)
                        .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
                        .addGroup(layout.createParallelGroup(javax.swing.GroupLayout.Alignment.BASELINE)
                            .addComponent(jButtonSelectAll, javax.swing.GroupLayout.PREFERRED_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.PREFERRED_SIZE)
                            .addComponent(jButtonDeselectAll)
                            .addComponent(pastJobsButton, javax.swing.GroupLayout.PREFERRED_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.PREFERRED_SIZE)))
                    .addComponent(jPanel1, javax.swing.GroupLayout.DEFAULT_SIZE, 426, Short.MAX_VALUE))
                .addContainerGap())
        );
    }// </editor-fold>//GEN-END:initComponents
 
    private void globalSettingsButtonActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_globalSettingsButtonActionPerformed
        final AdvancedConfigurationDialog dialog = new AdvancedConfigurationDialog(true);
 
        dialog.addApplyButtonListener((ActionEvent e) -> {
            if (selectedModule.hasGlobalSettingsPanel()) {
                selectedModule.saveResourcesConfig();
            }
            dialog.close();
        });
 
        dialog.addWindowListener(new WindowAdapter() {
            @Override
            public void windowClosing(WindowEvent e) {
                dialog.close();
            }
        });
 
        dialog.display(selectedModule.getGlobalSettingsPanel());
    }//GEN-LAST:event_globalSettingsButtonActionPerformed
 
    private void jButtonSelectAllActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_jButtonSelectAllActionPerformed
        SelectAllModules(true);
    }//GEN-LAST:event_jButtonSelectAllActionPerformed
 
    private void jButtonDeselectAllActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_jButtonDeselectAllActionPerformed
        SelectAllModules(false);
    }//GEN-LAST:event_jButtonDeselectAllActionPerformed
    @Messages({"IngestJobSettingsPanel.pastJobsButton.action.frame.title=Ingest History"})
    private void pastJobsButtonActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_pastJobsButtonActionPerformed
        JDialog topFrame = (JDialog) SwingUtilities.getWindowAncestor(this);
        JDialog dialog = new JDialog(topFrame, Bundle.IngestJobSettingsPanel_pastJobsButton_action_frame_title(), false);
        IngestJobInfoPanel ingestInfo = new IngestJobInfoPanel();
        dialog.add(ingestInfo);
        dialog.setLocationRelativeTo(topFrame);
        dialog.setResizable(true);
        dialog.pack();
        dialog.setVisible(true);
    }//GEN-LAST:event_pastJobsButtonActionPerformed
 
    private void fileIngestFilterComboBoxActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_fileIngestFilterComboBoxActionPerformed
        if (fileIngestFilterComboBox.getSelectedItem().toString().equals(FilesSetPanel.getCreateNewFileIngestFilterString())) {
            final AdvancedConfigurationDialog dialog = new AdvancedConfigurationDialog(true);
            FilesSetDefsPanel fileIngestFilterPanel;
            fileIngestFilterPanel = new FilesSetDefsPanel(FilesSetDefsPanel.PANEL_TYPE.FILE_INGEST_FILTERS);
            fileIngestFilterPanel.load();
            //save the filters that exist before any are created
            final ArrayList<String> oldFilterList = new ArrayList<>(Arrays.asList(getComboBoxContents()));
            dialog.addApplyButtonListener(
                    (ActionEvent e) -> {
                        fileIngestFilterPanel.store();
                        ArrayList<FilesSet> newFilterList = new ArrayList<>();
                        try {
                            newFilterList.addAll(FilesSetsManager.getInstance().getCustomFileIngestFilters().values());
                        } catch (FilesSetsManager.FilesSetsManagerException ex) {
                            logger.log(Level.SEVERE, "Failed to get user created file ingest filters, only default available for selection", ex); //NON-NLS
                        }
                        String filterToSelect = settings.getFileFilter().getName();
                        for (FilesSet filter : newFilterList) {  //getting one of the recently created filters
                            if (!oldFilterList.contains(filter.getName())) {
                                //set newly created filter to selected filter
                                filterToSelect = filter.getName();
                                break;
                            }
                        }
                        fileIngestFilterComboBox.setModel(new DefaultComboBoxModel<>(getComboBoxContents()));
                        //set the selected filter after the comboBox Contents were updated to include it
                        fileIngestFilterComboBox.setSelectedItem(filterToSelect);
                        //refresh the saved filter in use case where the selected modified filter 
                        //has the same name as a previously existing filter
                        updateSelectedFilter(filterToSelect);
                        dialog.close();
                    }
            );
            dialog.display(fileIngestFilterPanel);
            //return to saved selection in case they cancel out of filter creation 
            fileIngestFilterComboBox.setSelectedItem(settings.getFileFilter().getName());
        } else if (evt.getActionCommand().equals("comboBoxChanged")) {
            updateSelectedFilter(fileIngestFilterComboBox.getSelectedItem().toString());
        }
    }//GEN-LAST:event_fileIngestFilterComboBoxActionPerformed
 
    private void updateSelectedFilter(String filterName) {
        try {
            Map<String, FilesSet> fileIngestFilters = FilesSetsManager.getInstance()
                    .getCustomFileIngestFilters();
            for (FilesSet fSet : FilesSetsManager.getStandardFileIngestFilters()) {
                fileIngestFilters.put(fSet.getName(), fSet);
            }
            settings.setFileFilter(fileIngestFilters
                    .get(filterName));
        } catch (FilesSetsManager.FilesSetsManagerException ex) {
            settings.setFileFilter(FilesSetsManager.getDefaultFilter());
            logger.log(Level.SEVERE, "Failed to get file ingest filter from combobox selection, default filter being used", ex); //NON-NLS
        }
    }

    private String[] getComboBoxContents() {
        ArrayList<String> nameList = new ArrayList<>();
        for (FilesSet fSet : FilesSetsManager.getStandardFileIngestFilters()) {
            nameList.add(fSet.getName());
        }
        try {
            for (FilesSet fSet : FilesSetsManager.getInstance().getCustomFileIngestFilters().values()) {
                nameList.add(fSet.getName());
            }
        } catch (FilesSetsManager.FilesSetsManagerException ex) {
            logger.log(Level.SEVERE, "Failed to get user created file ingest filters for combo box, only default available for selection", ex); //NON-NLS
        }
        nameList.add(FilesSetPanel.getCreateNewFileIngestFilterString());
        return nameList.toArray(new String[nameList.size()]);
    }
 
    private void SelectAllModules(boolean set) {
        for (IngestModuleModel module : modules) {
            module.setEnabled(set);
        }
        modulesTable.repaint();
    }
 
    // Variables declaration - do not modify//GEN-BEGIN:variables
    private javax.swing.JLabel descriptionLabel;
    private javax.swing.JComboBox<String> fileIngestFilterComboBox;
    private javax.swing.JLabel fileIngestFilterLabel;
    private javax.swing.JButton globalSettingsButton;
    private javax.swing.JPanel ingestSettingsPanel;
    private javax.swing.JButton jButtonDeselectAll;
    private javax.swing.JButton jButtonSelectAll;
    private javax.swing.JPanel jPanel1;
    private javax.swing.JScrollPane jScrollPane1;
    private javax.swing.JSeparator jSeparator2;
    private javax.swing.JScrollPane modulesScrollPane;
    private javax.swing.JTable modulesTable;
    private javax.swing.JButton pastJobsButton;
    private javax.swing.ButtonGroup timeGroup;
    // End of variables declaration//GEN-END:variables

    static private class IngestModuleModel {
 
        private final IngestModuleTemplate moduleTemplate;
        private IngestModuleGlobalSettingsPanel globalSettingsPanel = null;
        private IngestModuleIngestJobSettingsPanel moduleSettingsPanel = null;
 
        IngestModuleModel(IngestModuleTemplate moduleTemplate) {
            this.moduleTemplate = moduleTemplate;
            if (moduleTemplate.hasModuleSettingsPanel()) {
                moduleSettingsPanel = moduleTemplate.getModuleSettingsPanel();
            }
            if (moduleTemplate.hasGlobalSettingsPanel()) {
                globalSettingsPanel = moduleTemplate.getGlobalSettingsPanel();
            }
        }
 
        IngestModuleTemplate getIngestModuleTemplate() {
            return moduleTemplate;
        }
 
        String getName() {
            return moduleTemplate.getModuleName();
        }
 
        String getDescription() {
            return moduleTemplate.getModuleDescription();
        }
 
        void setEnabled(boolean enabled) {
            moduleTemplate.setEnabled(enabled);
        }
 
        boolean isEnabled() {
            return moduleTemplate.isEnabled();
        }
 
        boolean hasModuleSettingsPanel() {
            return moduleTemplate.hasModuleSettingsPanel();
        }
 
        IngestModuleIngestJobSettingsPanel getModuleSettingsPanel() {
            return moduleSettingsPanel;
        }
 
        boolean hasGlobalSettingsPanel() {
            return moduleTemplate.hasGlobalSettingsPanel();
        }
 
        IngestModuleGlobalSettingsPanel getGlobalSettingsPanel() {
            return globalSettingsPanel;
        }
 
        void saveResourcesConfig() {
            globalSettingsPanel.saveSettings();
        }
    }

    private class IngestModulesTableModel extends AbstractTableModel {
 
        private static final long serialVersionUID = 1L;
 
        @Override
        public int getRowCount() {
            return modules.size();
        }
 
        @Override
        public int getColumnCount() {
            return 3;
        }
 
        @Override
        public Object getValueAt(int rowIndex, int columnIndex) {
            IngestModuleModel module = modules.get(rowIndex);
            switch (columnIndex) {
                case 0:
                    return module.isEnabled();
                case 1:
                    return getIcon(module);
                default:
                    return module.getName();
            }
        }
 
        @Override
        public boolean isCellEditable(int rowIndex, int columnIndex) {
            return columnIndex == 0;
        }
 
        @Override
        public void setValueAt(Object aValue, int rowIndex, int columnIndex) {
            if (columnIndex == 0) {
                modules.get(rowIndex).setEnabled((boolean) aValue);
            }
        }
 
        @Override
        public Class<?> getColumnClass(int c) {
            return getValueAt(0, c).getClass();
        }
 
        private ImageIcon getIcon(IngestModuleModel module) {
            if (dataSources.isEmpty() || ingestJobs.isEmpty()) {
                return null;
            }
            boolean previousVersionRun = false;
            for (IngestJobInfo ingestJob : ingestJobs) {
                if (ingestJob.getStatus() != IngestJobInfo.IngestJobStatusType.COMPLETED) {
                    continue;
                }
                long objectId = ingestJob.getObjectId();
                boolean isSameDataSource = false;
                for (Content dataSource : dataSources) {
                    isSameDataSource = isSameDataSource || dataSource.getId() == objectId;
                }
                if (isSameDataSource) {
                    IngestModuleFactory factory = module.getIngestModuleTemplate().getModuleFactory();
                    if (factory.isDataSourceIngestModuleFactory()) {
                        String uniqueName = FactoryClassNameNormalizer.normalize(factory.getClass().getCanonicalName()) + "-"
                                + factory.getModuleDisplayName() + "-"
                                + factory.getModuleVersionNumber();
                        for (IngestModuleInfo ingestModuleInfo : ingestJob.getIngestModuleInfo()) {
                            boolean sameModule = ingestModuleInfo.getUniqueName().equals(uniqueName);
                            if (sameModule) {
                                if (ingestModuleInfo.getVersion().equals(module.getIngestModuleTemplate().getModuleFactory().getModuleVersionNumber())) {
                                    return warningIcon;
                                }
                            }
                            previousVersionRun = previousVersionRun || sameModule;
                        }
                    }
                    if (factory.isFileIngestModuleFactory()) {
                        String uniqueName = FactoryClassNameNormalizer.normalize(factory.getClass().getCanonicalName()) + "-"
                                + factory.getModuleDisplayName() + "-"
                                + factory.getModuleVersionNumber();
                        for (IngestModuleInfo ingestModuleInfo : ingestJob.getIngestModuleInfo()) {
                            boolean sameModule = ingestModuleInfo.getUniqueName().equals(uniqueName);
                            if (sameModule) {
                                if (ingestModuleInfo.getVersion().equals(module.getIngestModuleTemplate().getModuleFactory().getModuleVersionNumber())) {
                                    return warningIcon;
                                }
                            }
                            previousVersionRun = previousVersionRun || sameModule;
                        }
                    }
                }
            }
            if (previousVersionRun) {
                return infoIcon;
            }
            return null;
        }
    }

    @Messages({"IngestJobSettingsPanel.IngestModulesTableRenderer.warning.message=This ingest module has been run before on this data source.",
        "IngestJobSettingsPanel.IngestModulesTableRenderer.info.message=A previous version of this ingest module has been run before on this data source."})
    private class IngestModulesTableRenderer extends DefaultTableCellRenderer {
 
        private static final long serialVersionUID = 1L;
 
        List<String> tooltips = new ArrayList<>();
 
        public IngestModulesTableRenderer() {
            for (IngestModuleModel moduleTemplate : modules) {
                tooltips.add(moduleTemplate.getDescription());
            }
        }
 
        @Override
        public Component getTableCellRendererComponent(JTable table, Object value, boolean isSelected, boolean hasFocus, int row, int column) {
            super.getTableCellRendererComponent(table, value, isSelected, hasFocus, row, column);
            if (2 == column) {
                setIcon(null);
                setToolTipText(tooltips.get(row));
            } else if (1 == column) {
                setIcon((Icon) value);
                setText("");
                if (warningIcon.equals(value)) {
                    setToolTipText(Bundle.IngestJobSettingsPanel_IngestModulesTableRenderer_warning_message());
                } else if (infoIcon.equals(value)) {
                    setToolTipText(Bundle.IngestJobSettingsPanel_IngestModulesTableRenderer_info_message());
                }
            }
            return this;
        }
    }
}