Autopsy  4.17.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
KeywordSearchJobSettingsPanel.java
Go to the documentation of this file.
1 /*
2  * Autopsy Forensic Browser
3  *
4  * Copyright 2011-2018 Basis Technology Corp.
5  * Contact: carrier <at> sleuthkit <dot> org
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  */
19 package org.sleuthkit.autopsy.keywordsearch;
20 
21 import java.awt.Component;
22 import java.beans.PropertyChangeEvent;
23 import java.beans.PropertyChangeListener;
24 import java.util.ArrayList;
25 import java.util.HashMap;
26 import java.util.List;
27 import java.util.Map;
28 import javax.swing.JLabel;
29 import javax.swing.JTable;
30 import javax.swing.ListSelectionModel;
31 import javax.swing.table.AbstractTableModel;
32 import javax.swing.table.DefaultTableCellRenderer;
33 import javax.swing.table.TableColumn;
34 import org.sleuthkit.autopsy.coreutils.StringExtract.StringExtractUnicodeTable.SCRIPT;
35 import org.sleuthkit.autopsy.guiutils.SimpleTableCellRenderer;
36 import org.sleuthkit.autopsy.ingest.IngestModuleIngestJobSettings;
37 import org.sleuthkit.autopsy.ingest.IngestModuleIngestJobSettingsPanel;
38 import org.sleuthkit.autopsy.keywordsearch.KeywordSearchIngestModule.StringsExtractOptions;
39 
43 @SuppressWarnings("PMD.SingularField") // UI widgets cause lots of false positives
44 public final class KeywordSearchJobSettingsPanel extends IngestModuleIngestJobSettingsPanel implements PropertyChangeListener {
45 
46  private final KeywordListsTableModel tableModel = new KeywordListsTableModel();
47  private final List<String> keywordListNames = new ArrayList<>();
48  private final Map<String, Boolean> keywordListStates = new HashMap<>();
49  private final XmlKeywordSearchList keywordListsManager = XmlKeywordSearchList.getCurrent();
50 
51  KeywordSearchJobSettingsPanel(KeywordSearchJobSettings initialSettings) {
52  initializeKeywordListSettings(initialSettings);
53  initComponents();
54  customizeComponents();
55  }
56 
57  private void initializeKeywordListSettings(KeywordSearchJobSettings settings) {
58  keywordListNames.clear();
59  keywordListStates.clear();
60  List<KeywordList> keywordLists = keywordListsManager.getListsL();
61  for (KeywordList list : keywordLists) {
62  String listName = list.getName();
63  keywordListNames.add(listName);
64  keywordListStates.put(listName, settings.keywordListIsEnabled(listName));
65  }
66  }
67 
68  private void customizeComponents() {
69  customizeKeywordListsTable();
70  displayLanguages();
71  displayEncodings();
72  keywordListsManager.addPropertyChangeListener(this);
73  languagesLabel.setText("<html>" + org.openide.util.NbBundle.getMessage(KeywordSearchJobSettingsPanel.class, "KeywordSearchJobSettingsPanel.languagesLabel.text") + "</html>"); // NOI18N NON-NLS
74  }
75 
76  private void customizeKeywordListsTable() {
77  listsTable.setModel(tableModel);
78  listsTable.setTableHeader(null);
79  listsTable.setSelectionMode(ListSelectionModel.SINGLE_SELECTION);
80  final int width = listsScrollPane.getPreferredSize().width;
81  listsTable.setAutoResizeMode(JTable.AUTO_RESIZE_NEXT_COLUMN);
82  TableColumn column;
83  for (int i = 0; i < listsTable.getColumnCount(); i++) {
84  column = listsTable.getColumnModel().getColumn(i);
85  if (i == 0) {
86  column.setPreferredWidth(((int) (width * 0.07)));
87  } else {
88  column.setPreferredWidth(((int) (width * 0.92)));
89  }
90  }
91  }
92 
93  private void displayLanguages() {
94  List<SCRIPT> scripts = KeywordSearchSettings.getStringExtractScripts();
95  StringBuilder langs = new StringBuilder();
96  langs.append("<html>"); //NON-NLS
97  for (int i = 0; i < scripts.size(); i++) {
98  langs.append(scripts.get(i).toString());
99  if (i + 1 < scripts.size()) {
100  langs.append(", ");
101  }
102  }
103  langs.append("</html>"); //NON-NLS
104  String langsS = langs.toString();
105  this.languagesValLabel.setText(langsS);
106  this.languagesValLabel.setToolTipText(langsS);
107  }
108 
109  private void displayEncodings() {
110  String utf8 = KeywordSearchSettings.getStringExtractOption(StringsExtractOptions.EXTRACT_UTF8.toString());
111  String utf16 = KeywordSearchSettings.getStringExtractOption(StringsExtractOptions.EXTRACT_UTF16.toString());
112  ArrayList<String> encodingsList = new ArrayList<>();
113  if (utf8 == null || Boolean.parseBoolean(utf8)) {
114  encodingsList.add("UTF8");
115  }
116  if (utf16 == null || Boolean.parseBoolean(utf16)) {
117  encodingsList.add("UTF16"); //NON-NLS
118  }
119  String encodings = encodingsList.toString();
120  encodings = encodings.substring(1, encodings.length() - 1);
121  keywordSearchEncodings.setText(encodings);
122  }
123 
124  @Override
125  public void propertyChange(PropertyChangeEvent event) {
126  if (event.getPropertyName().equals(XmlKeywordSearchList.ListsEvt.LIST_ADDED.name())
127  || event.getPropertyName().equals(XmlKeywordSearchList.ListsEvt.LIST_DELETED.name())
128  || event.getPropertyName().equals(XmlKeywordSearchList.ListsEvt.LIST_UPDATED.name())
129  || event.getPropertyName().equals(XmlKeywordSearchList.LanguagesEvent.LANGUAGES_CHANGED.name())) {
130  update();
131  }
132  }
133 
134  private void update() {
135  updateKeywordListSettings();
136  displayLanguages();
137  displayEncodings();
138  tableModel.fireTableDataChanged();
139  }
140 
141  private void updateKeywordListSettings() {
142  // Get the names of the current set of keyword lists.
143  List<KeywordList> keywordLists = keywordListsManager.getListsL();
144  List<String> currentListNames = new ArrayList<>();
145  for (KeywordList list : keywordLists) {
146  currentListNames.add(list.getName());
147  }
148 
149  // Remove deleted lists from the list states map.
150  for (String listName : keywordListNames) {
151  if (!currentListNames.contains(listName)) {
152  keywordListStates.remove(listName);
153  }
154  }
155 
156  // Reset the names list and add any new lists to the states map.
157  keywordListNames.clear();
158  for (String currentListName : currentListNames) {
159  keywordListNames.add(currentListName);
160  if (!keywordListStates.containsKey(currentListName)) {
161  keywordListStates.put(currentListName, Boolean.TRUE);
162  }
163  }
164  }
165 
166  @Override
167  public IngestModuleIngestJobSettings getSettings() {
168  List<String> enabledListNames = new ArrayList<>();
169  List<String> disabledListNames = new ArrayList<>();
170  for (String listName : keywordListNames) {
171  if (keywordListStates.get(listName)) {
172  enabledListNames.add(listName);
173  } else {
174  disabledListNames.add(listName);
175  }
176  }
177  return new KeywordSearchJobSettings(enabledListNames, disabledListNames);
178  }
179 
180  void reset(KeywordSearchJobSettings newSettings) {
181  initializeKeywordListSettings(newSettings);
182  displayLanguages();
183  displayEncodings();
184  tableModel.fireTableDataChanged();
185  }
186 
187  private class KeywordListsTableModel extends AbstractTableModel {
188 
189  @Override
190  public int getRowCount() {
191  return KeywordSearchJobSettingsPanel.this.keywordListNames.size();
192  }
193 
194  @Override
195  public int getColumnCount() {
196  return 2;
197  }
198 
199  @Override
200  public Object getValueAt(int rowIndex, int columnIndex) {
201  String listName = KeywordSearchJobSettingsPanel.this.keywordListNames.get(rowIndex);
202  if (columnIndex == 0) {
203  return keywordListStates.get(listName);
204  } else {
205  return listName;
206  }
207  }
208 
209  @Override
210  public boolean isCellEditable(int rowIndex, int columnIndex) {
211  return columnIndex == 0;
212  }
213 
214  @Override
215  public void setValueAt(Object aValue, int rowIndex, int columnIndex) {
216  String listName = KeywordSearchJobSettingsPanel.this.keywordListNames.get(rowIndex);
217  if (columnIndex == 0) {
218  keywordListStates.put(listName, (Boolean) aValue);
219  }
220  }
221 
222  @Override
223  public Class<?> getColumnClass(int c) {
224  return getValueAt(0, c).getClass();
225  }
226  }
227 
233  @SuppressWarnings("unchecked")
234  // <editor-fold defaultstate="collapsed" desc="Generated Code">//GEN-BEGIN:initComponents
235  private void initComponents() {
236 
237  listsScrollPane = new javax.swing.JScrollPane();
238  listsTable = new javax.swing.JTable();
239  titleLabel = new javax.swing.JLabel();
240  languagesLabel = new javax.swing.JLabel();
241  languagesValLabel = new javax.swing.JLabel();
242  encodingsLabel = new javax.swing.JLabel();
243  keywordSearchEncodings = new javax.swing.JLabel();
244 
245  setPreferredSize(new java.awt.Dimension(300, 170));
246 
247  listsScrollPane.setBorder(javax.swing.BorderFactory.createEtchedBorder());
248  listsScrollPane.setPreferredSize(new java.awt.Dimension(300, 100));
249 
250  listsTable.setBackground(new java.awt.Color(240, 240, 240));
251  listsTable.setModel(new javax.swing.table.DefaultTableModel(
252  new Object [][] {
253 
254  },
255  new String [] {
256 
257  }
258  ));
259  listsTable.setShowHorizontalLines(false);
260  listsTable.setShowVerticalLines(false);
261  listsScrollPane.setViewportView(listsTable);
262  listsTable.setDefaultRenderer(String.class, new SimpleTableCellRenderer());
263 
264  titleLabel.setText(org.openide.util.NbBundle.getMessage(KeywordSearchJobSettingsPanel.class, "KeywordSearchJobSettingsPanel.titleLabel.text")); // NOI18N
265 
266  languagesLabel.setText(org.openide.util.NbBundle.getMessage(KeywordSearchJobSettingsPanel.class, "KeywordSearchJobSettingsPanel.languagesLabel.text")); // NOI18N
267  languagesLabel.setToolTipText(org.openide.util.NbBundle.getMessage(KeywordSearchJobSettingsPanel.class, "KeywordSearchJobSettingsPanel.languagesLabel.toolTipText")); // NOI18N
268  languagesLabel.setPreferredSize(new java.awt.Dimension(294, 35));
269  languagesLabel.setVerticalTextPosition(javax.swing.SwingConstants.BOTTOM);
270 
271  languagesValLabel.setText(org.openide.util.NbBundle.getMessage(KeywordSearchJobSettingsPanel.class, "KeywordSearchJobSettingsPanel.languagesValLabel.text")); // NOI18N
272  languagesValLabel.setToolTipText(org.openide.util.NbBundle.getMessage(KeywordSearchJobSettingsPanel.class, "KeywordSearchJobSettingsPanel.languagesValLabel.toolTipText")); // NOI18N
273 
274  encodingsLabel.setText(org.openide.util.NbBundle.getMessage(KeywordSearchJobSettingsPanel.class, "KeywordSearchJobSettingsPanel.encodingsLabel.text")); // NOI18N
275 
276  keywordSearchEncodings.setText(org.openide.util.NbBundle.getMessage(KeywordSearchJobSettingsPanel.class, "KeywordSearchJobSettingsPanel.keywordSearchEncodings.text")); // NOI18N
277 
278  javax.swing.GroupLayout layout = new javax.swing.GroupLayout(this);
279  this.setLayout(layout);
280  layout.setHorizontalGroup(
281  layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
282  .addGroup(layout.createSequentialGroup()
283  .addContainerGap()
284  .addGroup(layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
285  .addGroup(layout.createSequentialGroup()
286  .addComponent(listsScrollPane, javax.swing.GroupLayout.PREFERRED_SIZE, 0, Short.MAX_VALUE)
287  .addContainerGap())
288  .addGroup(layout.createSequentialGroup()
289  .addGap(10, 10, 10)
290  .addComponent(languagesValLabel, javax.swing.GroupLayout.PREFERRED_SIZE, 274, javax.swing.GroupLayout.PREFERRED_SIZE)
291  .addContainerGap(javax.swing.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE))
292  .addComponent(languagesLabel, javax.swing.GroupLayout.Alignment.TRAILING, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE)
293  .addGroup(layout.createSequentialGroup()
294  .addGroup(layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
295  .addComponent(titleLabel)
296  .addGroup(layout.createSequentialGroup()
297  .addComponent(encodingsLabel)
298  .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.UNRELATED)
299  .addComponent(keywordSearchEncodings)))
300  .addGap(0, 0, Short.MAX_VALUE))))
301  );
302  layout.setVerticalGroup(
303  layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
304  .addGroup(layout.createSequentialGroup()
305  .addGap(7, 7, 7)
306  .addComponent(titleLabel)
307  .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
308  .addComponent(listsScrollPane, javax.swing.GroupLayout.DEFAULT_SIZE, 41, Short.MAX_VALUE)
309  .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.UNRELATED)
310  .addComponent(languagesLabel, javax.swing.GroupLayout.PREFERRED_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.PREFERRED_SIZE)
311  .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
312  .addComponent(languagesValLabel)
313  .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.UNRELATED)
314  .addGroup(layout.createParallelGroup(javax.swing.GroupLayout.Alignment.BASELINE)
315  .addComponent(encodingsLabel)
316  .addComponent(keywordSearchEncodings))
317  .addContainerGap())
318  );
319  }// </editor-fold>//GEN-END:initComponents
320  // Variables declaration - do not modify//GEN-BEGIN:variables
321  private javax.swing.JLabel encodingsLabel;
322  private javax.swing.JLabel keywordSearchEncodings;
323  private javax.swing.JLabel languagesLabel;
324  private javax.swing.JLabel languagesValLabel;
325  private javax.swing.JScrollPane listsScrollPane;
326  private javax.swing.JTable listsTable;
327  private javax.swing.JLabel titleLabel;
328  // End of variables declaration//GEN-END:variables
329 }

Copyright © 2012-2021 Basis Technology. Generated on: Tue Jan 19 2021
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.