Autopsy  4.14.0
Graphical digital forensics platform for The Sleuth Kit and other tools.
StringsContentPanel.java
Go to the documentation of this file.
1 /*
2  * Autopsy Forensic Browser
3  *
4  * Copyright 2011-2019 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.contentviewers.textcontentviewer;
20 
21 import java.awt.Cursor;
22 import java.awt.event.ActionEvent;
23 import java.awt.event.ActionListener;
24 import java.util.List;
25 import java.util.logging.Level;
26 import org.openide.util.NbBundle;
28 import javax.swing.JMenuItem;
29 import javax.swing.JOptionPane;
30 import org.apache.commons.lang3.StringUtils;
35 import org.sleuthkit.datamodel.Content;
36 import org.sleuthkit.datamodel.TskCoreException;
37 
41 @SuppressWarnings("PMD.SingularField") // UI widgets cause lots of false positives
42 public class StringsContentPanel extends javax.swing.JPanel {
43 
44  private static long currentOffset = 0;
45  private static final long PAGE_LENGTH = 16384;
46  private static final long serialVersionUID = 1L;
47  private final byte[] data = new byte[(int) PAGE_LENGTH];
48  private static int currentPage = 1;
49  private Content dataSource;
50  //string extract utility
51  private final StringExtract stringExtract = new StringExtract();
52  private static final Logger logger = Logger.getLogger(StringsContentPanel.class.getName());
53 
58  initComponents();
59  customizeComponents();
60  this.resetDisplay();
61  }
62 
63  private void customizeComponents() {
64  outputViewPane.setComponentPopupMenu(rightClickMenu);
65  ActionListener actList = (ActionEvent e) -> {
66  JMenuItem jmi = (JMenuItem) e.getSource();
67  if (jmi.equals(copyMenuItem)) {
68  outputViewPane.copy();
69  } else if (jmi.equals(selectAllMenuItem)) {
70  outputViewPane.selectAll();
71  }
72  };
73  copyMenuItem.addActionListener(actList);
74  selectAllMenuItem.addActionListener(actList);
75 
76  List<SCRIPT> supportedScripts = StringExtract.getSupportedScripts();
77  supportedScripts.forEach((s) -> {
78  languageCombo.addItem(s);
79  });
80 
81  }
82 
83  final void resetDisplay() {
84  // clear / reset the fields
85  currentPage = 1;
86  currentOffset = 0;
87  this.dataSource = null;
88  currentPageLabel.setText("");
89  totalPageLabel.setText("");
90  prevPageButton.setEnabled(false);
91  nextPageButton.setEnabled(false);
92  outputViewPane.setText(""); // reset the output view
93  setComponentsVisibility(false); // hides the components that not needed
94  }
95 
101  @SuppressWarnings("unchecked")
102  // <editor-fold defaultstate="collapsed" desc="Generated Code">//GEN-BEGIN:initComponents
103  private void initComponents() {
104 
105  rightClickMenu = new javax.swing.JPopupMenu();
106  copyMenuItem = new javax.swing.JMenuItem();
107  selectAllMenuItem = new javax.swing.JMenuItem();
108  outputScrollPane = new javax.swing.JScrollPane();
109  outputViewPane = new javax.swing.JTextPane();
110  controlScrollPane = new javax.swing.JScrollPane();
111  controlPanel = new javax.swing.JPanel();
112  totalPageLabel = new javax.swing.JLabel();
113  ofLabel = new javax.swing.JLabel();
114  currentPageLabel = new javax.swing.JLabel();
115  pageLabel = new javax.swing.JLabel();
116  nextPageButton = new javax.swing.JButton();
117  pageLabel2 = new javax.swing.JLabel();
118  prevPageButton = new javax.swing.JButton();
119  goToPageLabel = new javax.swing.JLabel();
120  goToPageTextField = new javax.swing.JTextField();
121  languageCombo = new javax.swing.JComboBox<>();
122  languageLabel = new javax.swing.JLabel();
123 
124  copyMenuItem.setText(org.openide.util.NbBundle.getMessage(StringsContentPanel.class, "StringsContentPanel.copyMenuItem.text")); // NOI18N
125  rightClickMenu.add(copyMenuItem);
126 
127  selectAllMenuItem.setText(org.openide.util.NbBundle.getMessage(StringsContentPanel.class, "StringsContentPanel.selectAllMenuItem.text")); // NOI18N
128  rightClickMenu.add(selectAllMenuItem);
129 
130  setMinimumSize(new java.awt.Dimension(5, 5));
131  setPreferredSize(new java.awt.Dimension(100, 58));
132 
133  outputScrollPane.setPreferredSize(new java.awt.Dimension(640, 402));
134 
135  outputViewPane.setEditable(false);
136  outputViewPane.setPreferredSize(new java.awt.Dimension(100, 40));
137  outputScrollPane.setViewportView(outputViewPane);
138 
139  controlScrollPane.setHorizontalScrollBarPolicy(javax.swing.ScrollPaneConstants.HORIZONTAL_SCROLLBAR_NEVER);
140  controlScrollPane.setVerticalScrollBarPolicy(javax.swing.ScrollPaneConstants.VERTICAL_SCROLLBAR_NEVER);
141 
142  totalPageLabel.setText(org.openide.util.NbBundle.getMessage(StringsContentPanel.class, "StringsContentPanel.totalPageLabel.text_1")); // NOI18N
143 
144  ofLabel.setText(org.openide.util.NbBundle.getMessage(StringsContentPanel.class, "StringsContentPanel.ofLabel.text_1")); // NOI18N
145 
146  currentPageLabel.setText(org.openide.util.NbBundle.getMessage(StringsContentPanel.class, "StringsContentPanel.currentPageLabel.text_1")); // NOI18N
147  currentPageLabel.setMaximumSize(new java.awt.Dimension(18, 14));
148  currentPageLabel.setPreferredSize(new java.awt.Dimension(18, 14));
149 
150  pageLabel.setText(org.openide.util.NbBundle.getMessage(StringsContentPanel.class, "StringsContentPanel.pageLabel.text_1")); // NOI18N
151  pageLabel.setMaximumSize(new java.awt.Dimension(33, 14));
152  pageLabel.setMinimumSize(new java.awt.Dimension(33, 14));
153 
154  nextPageButton.setIcon(new javax.swing.ImageIcon(getClass().getResource("/org/sleuthkit/autopsy/corecomponents/btn_step_forward.png"))); // NOI18N
155  nextPageButton.setText(org.openide.util.NbBundle.getMessage(StringsContentPanel.class, "StringsContentPanel.nextPageButton.text")); // NOI18N
156  nextPageButton.setBorderPainted(false);
157  nextPageButton.setContentAreaFilled(false);
158  nextPageButton.setDisabledIcon(new javax.swing.ImageIcon(getClass().getResource("/org/sleuthkit/autopsy/corecomponents/btn_step_forward_disabled.png"))); // NOI18N
159  nextPageButton.setMargin(new java.awt.Insets(2, 0, 2, 0));
160  nextPageButton.setPreferredSize(new java.awt.Dimension(55, 23));
161  nextPageButton.setRolloverIcon(new javax.swing.ImageIcon(getClass().getResource("/org/sleuthkit/autopsy/corecomponents/btn_step_forward_hover.png"))); // NOI18N
162  nextPageButton.addActionListener(new java.awt.event.ActionListener() {
163  public void actionPerformed(java.awt.event.ActionEvent evt) {
164  nextPageButtonActionPerformed(evt);
165  }
166  });
167 
168  pageLabel2.setText(org.openide.util.NbBundle.getMessage(StringsContentPanel.class, "StringsContentPanel.pageLabel2.text")); // NOI18N
169  pageLabel2.setMaximumSize(new java.awt.Dimension(29, 14));
170  pageLabel2.setMinimumSize(new java.awt.Dimension(29, 14));
171 
172  prevPageButton.setIcon(new javax.swing.ImageIcon(getClass().getResource("/org/sleuthkit/autopsy/corecomponents/btn_step_back.png"))); // NOI18N
173  prevPageButton.setText(org.openide.util.NbBundle.getMessage(StringsContentPanel.class, "StringsContentPanel.prevPageButton.text")); // NOI18N
174  prevPageButton.setBorderPainted(false);
175  prevPageButton.setContentAreaFilled(false);
176  prevPageButton.setDisabledIcon(new javax.swing.ImageIcon(getClass().getResource("/org/sleuthkit/autopsy/corecomponents/btn_step_back_disabled.png"))); // NOI18N
177  prevPageButton.setMargin(new java.awt.Insets(2, 0, 2, 0));
178  prevPageButton.setPreferredSize(new java.awt.Dimension(55, 23));
179  prevPageButton.setRolloverIcon(new javax.swing.ImageIcon(getClass().getResource("/org/sleuthkit/autopsy/corecomponents/btn_step_back_hover.png"))); // NOI18N
180  prevPageButton.addActionListener(new java.awt.event.ActionListener() {
181  public void actionPerformed(java.awt.event.ActionEvent evt) {
182  prevPageButtonActionPerformed(evt);
183  }
184  });
185 
186  goToPageLabel.setText(org.openide.util.NbBundle.getMessage(StringsContentPanel.class, "StringsContentPanel.goToPageLabel.text")); // NOI18N
187 
188  goToPageTextField.setText(org.openide.util.NbBundle.getMessage(StringsContentPanel.class, "StringsContentPanel.goToPageTextField.text")); // NOI18N
189  goToPageTextField.addActionListener(new java.awt.event.ActionListener() {
190  public void actionPerformed(java.awt.event.ActionEvent evt) {
191  goToPageTextFieldActionPerformed(evt);
192  }
193  });
194 
195  languageCombo.setToolTipText(org.openide.util.NbBundle.getMessage(StringsContentPanel.class, "StringsContentPanel.languageCombo.toolTipText")); // NOI18N
196  languageCombo.addActionListener(new java.awt.event.ActionListener() {
197  public void actionPerformed(java.awt.event.ActionEvent evt) {
198  languageComboActionPerformed(evt);
199  }
200  });
201 
202  languageLabel.setText(org.openide.util.NbBundle.getMessage(StringsContentPanel.class, "StringsContentPanel.languageLabel.text")); // NOI18N
203  languageLabel.setToolTipText(org.openide.util.NbBundle.getMessage(StringsContentPanel.class, "StringsContentPanel.languageLabel.toolTipText")); // NOI18N
204 
205  javax.swing.GroupLayout controlPanelLayout = new javax.swing.GroupLayout(controlPanel);
206  controlPanel.setLayout(controlPanelLayout);
207  controlPanelLayout.setHorizontalGroup(
208  controlPanelLayout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
209  .addGroup(controlPanelLayout.createSequentialGroup()
210  .addContainerGap()
211  .addComponent(pageLabel, javax.swing.GroupLayout.PREFERRED_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.PREFERRED_SIZE)
212  .addGap(18, 18, 18)
213  .addComponent(currentPageLabel, javax.swing.GroupLayout.PREFERRED_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.PREFERRED_SIZE)
214  .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.UNRELATED)
215  .addComponent(ofLabel)
216  .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.UNRELATED)
217  .addComponent(totalPageLabel)
218  .addGap(50, 50, 50)
219  .addComponent(pageLabel2, javax.swing.GroupLayout.PREFERRED_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.PREFERRED_SIZE)
220  .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
221  .addComponent(prevPageButton, javax.swing.GroupLayout.PREFERRED_SIZE, 23, javax.swing.GroupLayout.PREFERRED_SIZE)
222  .addGap(0, 0, 0)
223  .addComponent(nextPageButton, javax.swing.GroupLayout.PREFERRED_SIZE, 23, javax.swing.GroupLayout.PREFERRED_SIZE)
224  .addGap(18, 18, 18)
225  .addComponent(goToPageLabel)
226  .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
227  .addComponent(goToPageTextField, javax.swing.GroupLayout.PREFERRED_SIZE, 79, javax.swing.GroupLayout.PREFERRED_SIZE)
228  .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED, javax.swing.GroupLayout.DEFAULT_SIZE, Short.MAX_VALUE)
229  .addComponent(languageLabel)
230  .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED)
231  .addComponent(languageCombo, javax.swing.GroupLayout.PREFERRED_SIZE, 155, javax.swing.GroupLayout.PREFERRED_SIZE)
232  .addContainerGap())
233  );
234  controlPanelLayout.setVerticalGroup(
235  controlPanelLayout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
236  .addGroup(controlPanelLayout.createSequentialGroup()
237  .addGroup(controlPanelLayout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
238  .addGroup(controlPanelLayout.createParallelGroup(javax.swing.GroupLayout.Alignment.BASELINE)
239  .addComponent(pageLabel, javax.swing.GroupLayout.PREFERRED_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.PREFERRED_SIZE)
240  .addComponent(currentPageLabel, javax.swing.GroupLayout.PREFERRED_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.PREFERRED_SIZE)
241  .addComponent(ofLabel)
242  .addComponent(totalPageLabel))
243  .addComponent(pageLabel2, javax.swing.GroupLayout.PREFERRED_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.PREFERRED_SIZE)
244  .addComponent(nextPageButton, javax.swing.GroupLayout.PREFERRED_SIZE, 23, javax.swing.GroupLayout.PREFERRED_SIZE)
245  .addComponent(prevPageButton, javax.swing.GroupLayout.PREFERRED_SIZE, 23, javax.swing.GroupLayout.PREFERRED_SIZE)
246  .addComponent(goToPageLabel)
247  .addGroup(controlPanelLayout.createParallelGroup(javax.swing.GroupLayout.Alignment.BASELINE)
248  .addComponent(goToPageTextField, javax.swing.GroupLayout.PREFERRED_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.PREFERRED_SIZE)
249  .addComponent(languageCombo, javax.swing.GroupLayout.PREFERRED_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.PREFERRED_SIZE)
250  .addComponent(languageLabel)))
251  .addGap(0, 0, 0))
252  );
253 
254  controlScrollPane.setViewportView(controlPanel);
255 
256  javax.swing.GroupLayout layout = new javax.swing.GroupLayout(this);
257  this.setLayout(layout);
258  layout.setHorizontalGroup(
259  layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
260  .addComponent(outputScrollPane, javax.swing.GroupLayout.PREFERRED_SIZE, 0, Short.MAX_VALUE)
261  .addComponent(controlScrollPane, javax.swing.GroupLayout.DEFAULT_SIZE, 100, Short.MAX_VALUE)
262  );
263  layout.setVerticalGroup(
264  layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING)
265  .addGroup(layout.createSequentialGroup()
266  .addComponent(controlScrollPane, javax.swing.GroupLayout.PREFERRED_SIZE, javax.swing.GroupLayout.DEFAULT_SIZE, javax.swing.GroupLayout.PREFERRED_SIZE)
267  .addGap(7, 7, 7)
268  .addComponent(outputScrollPane, javax.swing.GroupLayout.DEFAULT_SIZE, 26, Short.MAX_VALUE))
269  );
270  }// </editor-fold>//GEN-END:initComponents
271 
272  private void languageComboActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_languageComboActionPerformed
273  if (dataSource != null) {
274  setDataView(dataSource, currentOffset);
275  }
276  }//GEN-LAST:event_languageComboActionPerformed
277 
278  private void goToPageTextFieldActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_goToPageTextFieldActionPerformed
279  String pageNumberStr = goToPageTextField.getText();
280  int pageNumber;
281  int maxPage = Math.round((dataSource.getSize() - 1) / PAGE_LENGTH) + 1;
282  try {
283  pageNumber = Integer.parseInt(pageNumberStr);
284  } catch (NumberFormatException ex) {
285  pageNumber = maxPage + 1;
286  }
287  if (pageNumber > maxPage || pageNumber < 1) {
288  JOptionPane.showMessageDialog(this,
289  NbBundle.getMessage(this.getClass(),
290  "StringsTextViewer.goToPageTextField.msgDlg",
291  maxPage),
292  NbBundle.getMessage(this.getClass(),
293  "StringsTextViewer.goToPageTextField.err"),
294  JOptionPane.WARNING_MESSAGE);
295  return;
296  }
297  currentOffset = (pageNumber - 1) * PAGE_LENGTH;
298  currentPage = pageNumber;
299  currentPageLabel.setText(Integer.toString(currentPage));
300  setDataView(dataSource, currentOffset);
301  }//GEN-LAST:event_goToPageTextFieldActionPerformed
302 
303  private void prevPageButtonActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_prevPageButtonActionPerformed
304  //@@@ this is part of the code dealing with the data viewer. could be copied/removed to implement the scrollbar
305  currentOffset -= PAGE_LENGTH;
306  currentPage -= 1;
307  currentPageLabel.setText(Integer.toString(currentPage));
308  setDataView(dataSource, currentOffset);
309  }//GEN-LAST:event_prevPageButtonActionPerformed
310 
311  private void nextPageButtonActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_nextPageButtonActionPerformed
312  //@@@ this is part of the code dealing with the data viewer. could be copied/removed to implement the scrollbar
313  currentOffset += PAGE_LENGTH;
314  currentPage += 1;
315  currentPageLabel.setText(Integer.toString(currentPage));
316  setDataView(dataSource, currentOffset);
317  }//GEN-LAST:event_nextPageButtonActionPerformed
318 
319  // Variables declaration - do not modify//GEN-BEGIN:variables
320  private javax.swing.JPanel controlPanel;
321  private javax.swing.JScrollPane controlScrollPane;
322  private javax.swing.JMenuItem copyMenuItem;
323  private javax.swing.JLabel currentPageLabel;
324  private javax.swing.JLabel goToPageLabel;
325  private javax.swing.JTextField goToPageTextField;
326  private javax.swing.JComboBox<SCRIPT> languageCombo;
327  private javax.swing.JLabel languageLabel;
328  private javax.swing.JButton nextPageButton;
329  private javax.swing.JLabel ofLabel;
330  private javax.swing.JScrollPane outputScrollPane;
331  private javax.swing.JTextPane outputViewPane;
332  private javax.swing.JLabel pageLabel;
333  private javax.swing.JLabel pageLabel2;
334  private javax.swing.JButton prevPageButton;
335  private javax.swing.JPopupMenu rightClickMenu;
336  private javax.swing.JMenuItem selectAllMenuItem;
337  private javax.swing.JLabel totalPageLabel;
338  // End of variables declaration//GEN-END:variables
339 
346  void setDataView(Content dataSource, long offset) {
347  if (dataSource == null) {
348  return;
349  }
350  // change the cursor to "waiting cursor" for this operation
351  this.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
352  this.dataSource = dataSource;
353  int bytesRead = 0;
354  // set the data on the bottom and show it
355 
356  if (dataSource.getSize() > 0) {
357  try {
358  bytesRead = dataSource.read(data, offset, PAGE_LENGTH); // read the data
359  } catch (TskCoreException ex) {
360  logger.log(Level.WARNING, "Error while trying to show the String content.", ex); //NON-NLS
361  }
362  }
363  String text;
364  if (bytesRead > 0) {
365  //text = DataConversion.getString(data, bytesRead, 4);
366  final SCRIPT selScript = (SCRIPT) languageCombo.getSelectedItem();
367  stringExtract.setEnabledScript(selScript);
368  StringExtractResult res = stringExtract.extract(data, bytesRead, 0);
369  text = res.getText();
370  if (StringUtils.isBlank(text)) {
371  text = NbBundle.getMessage(this.getClass(),
372  "StringsTextViewer.setDataView.errorNoText", currentOffset,
373  currentOffset + PAGE_LENGTH);
374  }
375  } else {
376  text = NbBundle.getMessage(this.getClass(), "StringsTextViewer.setDataView.errorText", currentOffset,
377  currentOffset + PAGE_LENGTH);
378  }
379 
380  // disable or enable the next button
381  if (offset + PAGE_LENGTH < dataSource.getSize()) {
382  nextPageButton.setEnabled(true);
383  } else {
384  nextPageButton.setEnabled(false);
385  }
386 
387  if (offset == 0) {
388  prevPageButton.setEnabled(false);
389  currentPage = 1; // reset the page number
390  } else {
391  prevPageButton.setEnabled(true);
392  }
393 
394  int totalPage = Math.round((dataSource.getSize() - 1) / PAGE_LENGTH) + 1;
395  totalPageLabel.setText(Integer.toString(totalPage));
396  currentPageLabel.setText(Integer.toString(currentPage));
397  outputViewPane.setText(text); // set the output view
398  setComponentsVisibility(true); // shows the components that not needed
399  outputViewPane.moveCaretPosition(0);
400 
401  this.setCursor(null);
402  }
403 
404  void setDataView(StringContent dataSource) {
405  this.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
406  try {
407  this.dataSource = null;
408 
409  // set the data on the bottom and show it
410  String text = dataSource.getString();
411  nextPageButton.setEnabled(false);
412  prevPageButton.setEnabled(false);
413  currentPage = 1;
414 
415  int totalPage = 1;
416  totalPageLabel.setText(Integer.toString(totalPage));
417  currentPageLabel.setText(Integer.toString(currentPage));
418  outputViewPane.setText(text); // set the output view
419  setComponentsVisibility(true); // shows the components that not needed
420  outputViewPane.moveCaretPosition(0);
421  } finally {
422  this.setCursor(null);
423  }
424  }
425 
431  private void setComponentsVisibility(boolean isVisible) {
432  currentPageLabel.setVisible(isVisible);
433  totalPageLabel.setVisible(isVisible);
434  ofLabel.setVisible(isVisible);
435  prevPageButton.setVisible(isVisible);
436  nextPageButton.setVisible(isVisible);
437  pageLabel.setVisible(isVisible);
438  pageLabel2.setVisible(isVisible);
439  goToPageTextField.setVisible(isVisible);
440  goToPageLabel.setVisible(isVisible);
441  languageCombo.setVisible(isVisible);
442  languageLabel.setVisible(isVisible);
443  }
444 
445 }
StringExtractResult extract(byte[] buff, int len, int offset)
synchronized static Logger getLogger(String name)
Definition: Logger.java:124

Copyright © 2012-2020 Basis Technology. Generated on: Wed Apr 8 2020
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.