hex/string viewer handle case when file offset could not be read, which can happen e.g. for deleted content

This commit is contained in:
adam-m 2013-01-31 16:16:12 -05:00
parent 2cadfadfa9
commit 5b21911756
2 changed files with 232 additions and 197 deletions

View File

@ -39,44 +39,47 @@ import org.sleuthkit.datamodel.TskException;
/** /**
* Hex view of file contents. * Hex view of file contents.
*/ */
@ServiceProvider(service = DataContentViewer.class, position=1) @ServiceProvider(service = DataContentViewer.class, position = 1)
public class DataContentViewerHex extends javax.swing.JPanel implements DataContentViewer { public class DataContentViewerHex extends javax.swing.JPanel implements DataContentViewer {
private static long currentOffset = 0; private static long currentOffset = 0;
private static final long pageLength = 16384; private static final long pageLength = 16384;
private final byte[] data = new byte[(int)pageLength]; private final byte[] data = new byte[(int) pageLength];
private static int currentPage = 1; private static int currentPage = 1;
private Content dataSource; private Content dataSource;
// for error handling // for error handling
private String className = this.getClass().toString(); private String className = this.getClass().toString();
/** Creates new form DataContentViewerHex */ /**
* Creates new form DataContentViewerHex
*/
public DataContentViewerHex() { public DataContentViewerHex() {
initComponents(); initComponents();
customizeComponents(); customizeComponents();
this.resetComponent(); this.resetComponent();
} }
private void customizeComponents(){ private void customizeComponents() {
outputViewPane.setComponentPopupMenu(rightClickMenu); outputViewPane.setComponentPopupMenu(rightClickMenu);
ActionListener actList = new ActionListener(){ ActionListener actList = new ActionListener() {
@Override @Override
public void actionPerformed(ActionEvent e){ public void actionPerformed(ActionEvent e) {
JMenuItem jmi = (JMenuItem) e.getSource(); JMenuItem jmi = (JMenuItem) e.getSource();
if(jmi.equals(copyMenuItem)) if (jmi.equals(copyMenuItem)) {
outputViewPane.copy(); outputViewPane.copy();
else if(jmi.equals(selectAllMenuItem)) } else if (jmi.equals(selectAllMenuItem)) {
outputViewPane.selectAll(); outputViewPane.selectAll();
} }
}
}; };
copyMenuItem.addActionListener(actList); copyMenuItem.addActionListener(actList);
selectAllMenuItem.addActionListener(actList); selectAllMenuItem.addActionListener(actList);
} }
/** This method is called from within the constructor to /**
* initialize the form. * This method is called from within the constructor to initialize the form.
* WARNING: Do NOT modify this code. The content of this method is * WARNING: Do NOT modify this code. The content of this method is always
* always regenerated by the Form Editor. * regenerated by the Form Editor.
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
// <editor-fold defaultstate="collapsed" desc="Generated Code">//GEN-BEGIN:initComponents // <editor-fold defaultstate="collapsed" desc="Generated Code">//GEN-BEGIN:initComponents
@ -257,7 +260,7 @@ public class DataContentViewerHex extends javax.swing.JPanel implements DataCont
private void goToPageTextFieldActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_goToPageTextFieldActionPerformed private void goToPageTextFieldActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_goToPageTextFieldActionPerformed
String pageNumberStr = goToPageTextField.getText(); String pageNumberStr = goToPageTextField.getText();
int pageNumber = 0; int pageNumber = 0;
int maxPage = Math.round((dataSource.getSize()-1) / pageLength) + 1; int maxPage = Math.round((dataSource.getSize() - 1) / pageLength) + 1;
try { try {
pageNumber = Integer.parseInt(pageNumberStr); pageNumber = Integer.parseInt(pageNumberStr);
} catch (NumberFormatException ex) { } catch (NumberFormatException ex) {
@ -268,12 +271,11 @@ public class DataContentViewerHex extends javax.swing.JPanel implements DataCont
"Invalid page number", JOptionPane.WARNING_MESSAGE); "Invalid page number", JOptionPane.WARNING_MESSAGE);
return; return;
} }
currentOffset = (pageNumber-1) * pageLength; currentOffset = (pageNumber - 1) * pageLength;
currentPage = pageNumber; currentPage = pageNumber;
currentPageLabel.setText(Integer.toString(currentPage)); currentPageLabel.setText(Integer.toString(currentPage));
setDataView(dataSource, currentOffset, false); setDataView(dataSource, currentOffset, false);
}//GEN-LAST:event_goToPageTextFieldActionPerformed }//GEN-LAST:event_goToPageTextFieldActionPerformed
// Variables declaration - do not modify//GEN-BEGIN:variables // Variables declaration - do not modify//GEN-BEGIN:variables
private javax.swing.JMenuItem copyMenuItem; private javax.swing.JMenuItem copyMenuItem;
private javax.swing.JLabel currentPageLabel; private javax.swing.JLabel currentPageLabel;
@ -300,23 +302,39 @@ public class DataContentViewerHex extends javax.swing.JPanel implements DataCont
* @param reset whether to reset the dataView or not * @param reset whether to reset the dataView or not
*/ */
public void setDataView(Content dataSource, long offset, boolean reset) { public void setDataView(Content dataSource, long offset, boolean reset) {
if (dataSource == null) {
return;
}
// change the cursor to "waiting cursor" for this operation // change the cursor to "waiting cursor" for this operation
this.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR)); this.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
try {
try {
this.dataSource = dataSource;
int bytesRead =0; this.dataSource = dataSource;
String errorText = null;
Boolean setVisible = false;
int bytesRead = 0;
if (!reset && dataSource.getSize() > 0) { if (!reset && dataSource.getSize() > 0) {
try {
bytesRead = dataSource.read(data, offset, pageLength); // read the data bytesRead = dataSource.read(data, offset, pageLength); // read the data
} catch (TskException ex) {
setVisible = true;
errorText = "(offset " + currentOffset + "-" + (currentOffset + pageLength)
+ " could not be read)";
Logger.getLogger(this.className).log(Level.WARNING, "Error while trying to show the hex content.", ex);
}
} }
// set the data on the bottom and show it // set the data on the bottom and show it
Boolean setVisible = false;
if (bytesRead > 0) { if (bytesRead > 0) {
setVisible = true; setVisible = true;
} }
else {
errorText = "(offset " + currentOffset + "-" + (currentOffset + pageLength)
+ " could not be read)";
setVisible = true;
}
// disable or enable the next button // disable or enable the next button
if (!reset && offset + pageLength < dataSource.getSize()) { if (!reset && offset + pageLength < dataSource.getSize()) {
@ -333,14 +351,20 @@ public class DataContentViewerHex extends javax.swing.JPanel implements DataCont
} }
if (setVisible) { if (setVisible) {
int totalPage = Math.round((dataSource.getSize()-1) / pageLength) + 1; int totalPage = Math.round((dataSource.getSize() - 1) / pageLength) + 1;
totalPageLabel.setText(Integer.toString(totalPage)); totalPageLabel.setText(Integer.toString(totalPage));
currentPageLabel.setText(Integer.toString(currentPage)); currentPageLabel.setText(Integer.toString(currentPage));
setComponentsVisibility(true); // shows the components that not needed setComponentsVisibility(true); // shows the components that not needed
// set the output view // set the output view
int showLength = bytesRead<pageLength?bytesRead:(int)pageLength; int showLength = bytesRead < pageLength ? bytesRead : (int) pageLength;
if (errorText == null) {
outputViewPane.setText(DataConversion.byteArrayToHex(data, showLength, offset, outputViewPane.getFont())); outputViewPane.setText(DataConversion.byteArrayToHex(data, showLength, offset, outputViewPane.getFont()));
}
else {
outputViewPane.setText(errorText);
}
} else { } else {
// reset or hide the labels // reset or hide the labels
totalPageLabel.setText(""); totalPageLabel.setText("");
@ -350,18 +374,14 @@ public class DataContentViewerHex extends javax.swing.JPanel implements DataCont
} }
outputViewPane.moveCaretPosition(0); outputViewPane.moveCaretPosition(0);
} catch (TskException ex) {
// TODO: maybe make this error bubble up further
Logger.getLogger(this.className).log(Level.WARNING, "Error while trying to show the hex content.", ex);
}
} finally {
this.setCursor(null); this.setCursor(null);
}
} }
@Override @Override
public void setNode(Node selectedNode) { public void setNode(Node selectedNode) {
if(!isSupported(selectedNode)) { if (!isSupported(selectedNode)) {
setDataView(null, 0, true); setDataView(null, 0, true);
return; return;
} }
@ -423,21 +443,21 @@ public class DataContentViewerHex extends javax.swing.JPanel implements DataCont
@Override @Override
public boolean isSupported(Node node) { public boolean isSupported(Node node) {
if(node == null) { if (node == null) {
return false; return false;
} }
FsContent fsContent = node.getLookup().lookup(FsContent.class); Content content = node.getLookup().lookup(Content.class);
LayoutFile lc = node.getLookup().lookup(LayoutFile.class);
if(fsContent != null && fsContent.getSize() != 0) if (content != null && content.getSize() != 0) {
return true;
if(lc != null && lc.getSize() != 0)
return true; return true;
}
return false; return false;
} }
@Override @Override
public int isPreferred(Node node, boolean isSupported) { public int isPreferred(Node node, boolean isSupported) {
if(isSupported) { if (isSupported) {
return 1; return 1;
} else { } else {
return 0; return 0;
@ -450,12 +470,13 @@ public class DataContentViewerHex extends javax.swing.JPanel implements DataCont
} }
/* Show the right click menu only if evt is the correct mouse event */ /* Show the right click menu only if evt is the correct mouse event */
private void maybeShowPopup(java.awt.event.MouseEvent evt){ private void maybeShowPopup(java.awt.event.MouseEvent evt) {
if(evt.isPopupTrigger()){ if (evt.isPopupTrigger()) {
rightClickMenu.setLocation(evt.getLocationOnScreen()); rightClickMenu.setLocation(evt.getLocationOnScreen());
rightClickMenu.setVisible(true); rightClickMenu.setVisible(true);
copyMenuItem.setEnabled(outputViewPane.getSelectedText() != null); copyMenuItem.setEnabled(outputViewPane.getSelectedText() != null);
}else } else {
rightClickMenu.setVisible(false); rightClickMenu.setVisible(false);
} }
}
} }

View File

@ -44,38 +44,40 @@ import org.sleuthkit.datamodel.TskException;
/** /**
* Viewer displays strings extracted from contents. * Viewer displays strings extracted from contents.
*/ */
@ServiceProvider(service = DataContentViewer.class, position=2) @ServiceProvider(service = DataContentViewer.class, position = 2)
public class DataContentViewerString extends javax.swing.JPanel implements DataContentViewer { public class DataContentViewerString extends javax.swing.JPanel implements DataContentViewer {
private static long currentOffset = 0; private static long currentOffset = 0;
private static final long pageLength = 16384; private static final long pageLength = 16384;
private final byte[] data = new byte[(int)pageLength]; private final byte[] data = new byte[(int) pageLength];
private static int currentPage = 1; private static int currentPage = 1;
private Content dataSource; private Content dataSource;
// for error handling // for error handling
private String className = this.getClass().toString(); private String className = this.getClass().toString();
//string extract utility //string extract utility
private final StringExtract stringExtract = new StringExtract(); private final StringExtract stringExtract = new StringExtract();
/** Creates new form DataContentViewerString */ /**
* Creates new form DataContentViewerString
*/
public DataContentViewerString() { public DataContentViewerString() {
initComponents(); initComponents();
customizeComponents(); customizeComponents();
this.resetComponent(); this.resetComponent();
} }
private void customizeComponents(){ private void customizeComponents() {
outputViewPane.setComponentPopupMenu(rightClickMenu); outputViewPane.setComponentPopupMenu(rightClickMenu);
ActionListener actList = new ActionListener(){ ActionListener actList = new ActionListener() {
@Override @Override
public void actionPerformed(ActionEvent e){ public void actionPerformed(ActionEvent e) {
JMenuItem jmi = (JMenuItem) e.getSource(); JMenuItem jmi = (JMenuItem) e.getSource();
if(jmi.equals(copyMenuItem)) if (jmi.equals(copyMenuItem)) {
outputViewPane.copy(); outputViewPane.copy();
else if(jmi.equals(selectAllMenuItem)) } else if (jmi.equals(selectAllMenuItem)) {
outputViewPane.selectAll(); outputViewPane.selectAll();
} }
}
}; };
copyMenuItem.addActionListener(actList); copyMenuItem.addActionListener(actList);
selectAllMenuItem.addActionListener(actList); selectAllMenuItem.addActionListener(actList);
@ -87,10 +89,10 @@ public class DataContentViewerString extends javax.swing.JPanel implements DataC
} }
/** This method is called from within the constructor to /**
* initialize the form. * This method is called from within the constructor to initialize the form.
* WARNING: Do NOT modify this code. The content of this method is * WARNING: Do NOT modify this code. The content of this method is always
* always regenerated by the Form Editor. * regenerated by the Form Editor.
*/ */
@SuppressWarnings("unchecked") @SuppressWarnings("unchecked")
// <editor-fold defaultstate="collapsed" desc="Generated Code">//GEN-BEGIN:initComponents // <editor-fold defaultstate="collapsed" desc="Generated Code">//GEN-BEGIN:initComponents
@ -273,7 +275,7 @@ public class DataContentViewerString extends javax.swing.JPanel implements DataC
private void goToPageTextFieldActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_goToPageTextFieldActionPerformed private void goToPageTextFieldActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_goToPageTextFieldActionPerformed
String pageNumberStr = goToPageTextField.getText(); String pageNumberStr = goToPageTextField.getText();
int pageNumber; int pageNumber;
int maxPage = Math.round((dataSource.getSize()-1) / pageLength) + 1; int maxPage = Math.round((dataSource.getSize() - 1) / pageLength) + 1;
try { try {
pageNumber = Integer.parseInt(pageNumberStr); pageNumber = Integer.parseInt(pageNumberStr);
} catch (NumberFormatException ex) { } catch (NumberFormatException ex) {
@ -284,7 +286,7 @@ public class DataContentViewerString extends javax.swing.JPanel implements DataC
"Invalid page number", JOptionPane.WARNING_MESSAGE); "Invalid page number", JOptionPane.WARNING_MESSAGE);
return; return;
} }
currentOffset = (pageNumber-1) * pageLength; currentOffset = (pageNumber - 1) * pageLength;
currentPage = pageNumber; currentPage = pageNumber;
currentPageLabel.setText(Integer.toString(currentPage)); currentPageLabel.setText(Integer.toString(currentPage));
setDataView(dataSource, currentOffset, false); setDataView(dataSource, currentOffset, false);
@ -296,7 +298,6 @@ public class DataContentViewerString extends javax.swing.JPanel implements DataC
setDataView(dataSource, currentOffset, false); setDataView(dataSource, currentOffset, false);
} }
}//GEN-LAST:event_languageComboActionPerformed }//GEN-LAST:event_languageComboActionPerformed
// Variables declaration - do not modify//GEN-BEGIN:variables // Variables declaration - do not modify//GEN-BEGIN:variables
private javax.swing.JMenuItem copyMenuItem; private javax.swing.JMenuItem copyMenuItem;
private javax.swing.JLabel currentPageLabel; private javax.swing.JLabel currentPageLabel;
@ -325,21 +326,30 @@ public class DataContentViewerString extends javax.swing.JPanel implements DataC
* @param reset whether to reset the dataView or not * @param reset whether to reset the dataView or not
*/ */
public void setDataView(Content dataSource, long offset, boolean reset) { public void setDataView(Content dataSource, long offset, boolean reset) {
if (dataSource == null) {
return;
}
// change the cursor to "waiting cursor" for this operation // change the cursor to "waiting cursor" for this operation
this.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR)); this.setCursor(Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR));
try {
try {
this.dataSource = dataSource; this.dataSource = dataSource;
int bytesRead = 0; int bytesRead = 0;
if (!reset && dataSource.getSize() > 0) {
bytesRead = dataSource.read(data, offset, pageLength); // read the data
}
// set the data on the bottom and show it // set the data on the bottom and show it
String text = ""; String text = "";
Boolean setVisible = false; Boolean setVisible = false;
if (!reset && dataSource.getSize() > 0) {
try {
bytesRead = dataSource.read(data, offset, pageLength); // read the data
} catch (TskException ex) {
text = "(offset " + currentOffset + "-" + (currentOffset + pageLength)
+ " could not be read)";
setVisible = true;
Logger logger = Logger.getLogger(this.className);
logger.log(Level.WARNING, "Error while trying to show the String content.", ex);
}
}
if (bytesRead > 0) { if (bytesRead > 0) {
//text = DataConversion.getString(data, bytesRead, 4); //text = DataConversion.getString(data, bytesRead, 4);
@ -353,6 +363,10 @@ public class DataContentViewerString extends javax.swing.JPanel implements DataC
} }
setVisible = true; setVisible = true;
} else {
text = "(offset " + currentOffset + "-" + (currentOffset + pageLength)
+ " could not be read)";
setVisible = true;
} }
// disable or enable the next button // disable or enable the next button
@ -370,7 +384,7 @@ public class DataContentViewerString extends javax.swing.JPanel implements DataC
} }
if (setVisible) { if (setVisible) {
int totalPage = Math.round((dataSource.getSize()-1) / pageLength) + 1; int totalPage = Math.round((dataSource.getSize() - 1) / pageLength) + 1;
totalPageLabel.setText(Integer.toString(totalPage)); totalPageLabel.setText(Integer.toString(totalPage));
currentPageLabel.setText(Integer.toString(currentPage)); currentPageLabel.setText(Integer.toString(currentPage));
outputViewPane.setText(text); // set the output view outputViewPane.setText(text); // set the output view
@ -383,13 +397,9 @@ public class DataContentViewerString extends javax.swing.JPanel implements DataC
setComponentsVisibility(false); // hides the components that not needed setComponentsVisibility(false); // hides the components that not needed
} }
outputViewPane.moveCaretPosition(0); outputViewPane.moveCaretPosition(0);
} catch (TskException ex) {
Logger logger = Logger.getLogger(this.className);
logger.log(Level.WARNING, "Error while trying to show the String content.", ex);
}
} finally {
this.setCursor(null); this.setCursor(null);
}
} }
/** /**
@ -414,26 +424,25 @@ public class DataContentViewerString extends javax.swing.JPanel implements DataC
@Override @Override
public void setNode(Node selectedNode) { public void setNode(Node selectedNode) {
if(!isSupported(selectedNode)) { if (!isSupported(selectedNode)) {
setDataView(null, 0, true); setDataView(null, 0, true);
return; return;
} }
if (selectedNode != null) { if (selectedNode != null) {
Lookup lookup = selectedNode.getLookup(); Lookup lookup = selectedNode.getLookup();
Content content = lookup.lookup(Content.class); Content content = lookup.lookup(Content.class);
if (content != null) { if (content
!= null) {
this.setDataView(content, 0, false); this.setDataView(content, 0, false);
return; return;
} } else {
else{
StringContent scontent = selectedNode.getLookup().lookup(StringContent.class); StringContent scontent = selectedNode.getLookup().lookup(StringContent.class);
if(scontent != null){ if (scontent != null) {
this.setDataView(scontent); this.setDataView(scontent);
return; return;
} }
} }
} }
this.setDataView(null, 0, true); this.setDataView(null, 0, true);
} }
@ -467,21 +476,25 @@ public class DataContentViewerString extends javax.swing.JPanel implements DataC
@Override @Override
public boolean isSupported(Node node) { public boolean isSupported(Node node) {
if(node == null) { if (node == null) {
return false; return false;
} }
FsContent fsContent = node.getLookup().lookup(FsContent.class); Content content = node.getLookup().lookup(Content.class);
LayoutFile lc = node.getLookup().lookup(LayoutFile.class);
if(fsContent != null && fsContent.getSize() != 0) if (content
return true; != null && content.getSize()
if(lc != null && lc.getSize() != 0) != 0) {
return true; return true;
}
return false; return false;
} }
@Override @Override
public int isPreferred(Node node, boolean isSupported) { public int isPreferred(Node node, boolean isSupported) {
if(node != null && isSupported){ if (node != null && isSupported) {
return 1; return 1;
} else { } else {
return 0; return 0;
@ -518,12 +531,13 @@ public class DataContentViewerString extends javax.swing.JPanel implements DataC
} }
/* Show the right click menu only if evt is the correct mouse event */ /* Show the right click menu only if evt is the correct mouse event */
private void maybeShowPopup(java.awt.event.MouseEvent evt){ private void maybeShowPopup(java.awt.event.MouseEvent evt) {
if(evt.isPopupTrigger()){ if (evt.isPopupTrigger()) {
rightClickMenu.setLocation(evt.getLocationOnScreen()); rightClickMenu.setLocation(evt.getLocationOnScreen());
rightClickMenu.setVisible(true); rightClickMenu.setVisible(true);
copyMenuItem.setEnabled(outputViewPane.getSelectedText() != null); copyMenuItem.setEnabled(outputViewPane.getSelectedText() != null);
}else } else {
rightClickMenu.setVisible(false); rightClickMenu.setVisible(false);
} }
}
} }