Autopsy
4.19.3
Graphical digital forensics platform for The Sleuth Kit and other tools.
|
Inherits org.sleuthkit.autopsy.report.infrastructure.TableReportModule.
Public Member Functions | |
void | addRow (List< String > row) |
void | addRowWithTaggedContentHyperlink (List< String > row, ContentTag contentTag) |
void | addSetElement (String elementName) |
void | addSetIndex (List< String > sets) |
void | addThumbnailRows (Set< Content > images) |
String | dateToString (long date) |
void | endDataType () |
void | endReport () |
void | endSet () |
void | endTable () |
ReportModuleSettings | getConfiguration () |
JPanel | getConfigurationPanel () |
ReportModuleSettings | getDefaultConfiguration () |
String | getDescription () |
String | getName () |
String | getRelativeFilePath () |
String | saveContent (AbstractFile file, String dirName) |
void | setConfiguration (ReportModuleSettings settings) |
void | startContentTagsTable (List< String > columnHeaders) |
void | startDataType (String name, String description) |
void | startReport (String baseReportDir) |
void | startSet (String setName) |
void | startTable (List< String > titles) |
Static Public Member Functions | |
static synchronized HTMLReport | getDefault () |
Static Public Attributes | |
static Integer | THUMBNAIL_COLUMNS = 5 |
Private Member Functions | |
HTMLReport () | |
void | addRow (List< String > row, boolean escapeText) |
String | dataTypeToFileName (String dataType) |
boolean | failsContentCheck (Content c) |
String | formatHtmlString (String text) |
List< ImageTagRegion > | getTaggedRegions (List< ContentTag > contentTags) |
void | initializePanel () |
String | makeCustomUniqueFilePath (AbstractFile file, String dirName) |
String | prepareThumbnail (AbstractFile file) |
void | refresh () throws NoCurrentCaseException |
String | useDataTypeIcon (String dataType) |
void | writeCss () |
void | writeIndex () |
void | writeNav () |
String | writePageFooter () |
String | writePageHeader () |
void | writeSummary () |
StringBuilder | writeSummaryCaseDetails () |
StringBuilder | writeSummaryImageInfo () |
StringBuilder | writeSummaryIngestHistoryInfo (SleuthkitCase skCase, List< IngestJobInfo > ingestJobs) |
StringBuilder | writeSummarySoftwareInfo (SleuthkitCase skCase, List< IngestJobInfo > ingestJobs) |
Private Attributes | |
HTMLReportConfigurationPanel | configPanel |
Case | currentCase |
String | currentDataType |
Map< String, Integer > | dataTypes |
Writer | out |
String | path |
final ReportBranding | reportBranding |
Integer | rowCount |
String | subPath |
String | thumbsPath |
Static Private Attributes | |
static final String | HTML_SUBDIR = "content" |
static HTMLReport | instance |
static final Logger | logger = Logger.getLogger(HTMLReport.class.getName()) |
static final int | MAX_THUMBS_PER_PAGE = 1000 |
static final String | THUMBS_REL_PATH = "thumbs" + File.separator |
Definition at line 87 of file HTMLReport.java.
|
private |
Definition at line 118 of file HTMLReport.java.
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.getDefault().
void org.sleuthkit.autopsy.report.modules.html.HTMLReport.addRow | ( | List< String > | row | ) |
Add a row to the current table, escaping the text to be contained in the row.
row | values for each cell in the row |
Implements org.sleuthkit.autopsy.report.infrastructure.TableReportModule.
Definition at line 735 of file HTMLReport.java.
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.addRowWithTaggedContentHyperlink(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.addThumbnailRows().
|
private |
Add a row to the current table.
row | values for each cell in the row |
escapeText | whether or not the text of the row should be escaped, true for escaped, false for not escaped |
Definition at line 746 of file HTMLReport.java.
References org.sleuthkit.autopsy.coreutils.EscapeUtil.escapeHtml().
void org.sleuthkit.autopsy.report.modules.html.HTMLReport.addRowWithTaggedContentHyperlink | ( | List< String > | row, |
ContentTag | contentTag | ||
) |
Saves a local copy of a tagged file and adds a row with a hyper link to the file.
row | Values for each data cell in the row |
contentTag | The tag |
Definition at line 772 of file HTMLReport.java.
References org.sleuthkit.autopsy.report.modules.html.HTMLReport.addRow(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.saveContent().
void org.sleuthkit.autopsy.report.modules.html.HTMLReport.addSetElement | ( | String | elementName | ) |
Add a new element to the current set.
elementName | name of the element |
Implements org.sleuthkit.autopsy.report.infrastructure.TableReportModule.
Definition at line 660 of file HTMLReport.java.
void org.sleuthkit.autopsy.report.modules.html.HTMLReport.addSetIndex | ( | List< String > | sets | ) |
Add an index to the current page for all the sets about to be added.
sets | list of set names to be added |
Implements org.sleuthkit.autopsy.report.infrastructure.TableReportModule.
Definition at line 640 of file HTMLReport.java.
void org.sleuthkit.autopsy.report.modules.html.HTMLReport.addThumbnailRows | ( | Set< Content > | images | ) |
Add the body of the thumbnails table.
images |
Definition at line 854 of file HTMLReport.java.
References org.sleuthkit.autopsy.report.modules.html.HTMLReport.addRow(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.endDataType(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.endTable(), org.sleuthkit.autopsy.coreutils.FileUtil.escapeFileName(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.failsContentCheck(), org.sleuthkit.autopsy.casemodule.services.TagsManager.getContentTagsByContent(), org.sleuthkit.autopsy.casemodule.Case.getCurrentCase(), org.sleuthkit.autopsy.contentviewers.imagetagging.ImageTagsUtil.getImageWithTags(), org.sleuthkit.autopsy.casemodule.services.TagsManager.getNotableTagLabel(), org.sleuthkit.autopsy.casemodule.Case.getServices(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.getTaggedRegions(), org.sleuthkit.autopsy.casemodule.services.Services.getTagsManager(), org.sleuthkit.autopsy.contentviewers.imagetagging.ImageTagsUtil.getThumbnailWithTags(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.makeCustomUniqueFilePath(), org.sleuthkit.autopsy.contentviewers.imagetagging.ImageTagsUtil.IconSize.MEDIUM, org.sleuthkit.autopsy.report.modules.html.HTMLReport.prepareThumbnail(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.saveContent(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.startDataType(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.startTable(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.THUMBNAIL_COLUMNS.
|
private |
Generate a file name for the given datatype, by replacing any undesirable chars, like /, or spaces
dataType | data type for which to generate a file name |
Definition at line 203 of file HTMLReport.java.
References org.sleuthkit.autopsy.coreutils.FileUtil.escapeFileName().
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.startDataType(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.useDataTypeIcon(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeNav().
String org.sleuthkit.autopsy.report.modules.html.HTMLReport.dateToString | ( | long | date | ) |
Return a String date for the long date given.
date | date as a long |
Implements org.sleuthkit.autopsy.report.infrastructure.TableReportModule.
Definition at line 1063 of file HTMLReport.java.
void org.sleuthkit.autopsy.report.modules.html.HTMLReport.endDataType | ( | ) |
End the current data type. Write the end of the web page and close the output stream.
Implements org.sleuthkit.autopsy.report.infrastructure.TableReportModule.
Definition at line 548 of file HTMLReport.java.
References org.sleuthkit.autopsy.report.modules.html.HTMLReport.writePageFooter().
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.addThumbnailRows().
void org.sleuthkit.autopsy.report.modules.html.HTMLReport.endReport | ( | ) |
End this report. Close the output stream if necessary, and write the navigation menu with the data types given throughout the report.
Implements org.sleuthkit.autopsy.report.infrastructure.TableReportModule.
Definition at line 494 of file HTMLReport.java.
References org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeNav().
void org.sleuthkit.autopsy.report.modules.html.HTMLReport.endSet | ( | ) |
End the current set.
Implements org.sleuthkit.autopsy.report.infrastructure.TableReportModule.
Definition at line 626 of file HTMLReport.java.
void org.sleuthkit.autopsy.report.modules.html.HTMLReport.endTable | ( | ) |
End the current table.
Implements org.sleuthkit.autopsy.report.infrastructure.TableReportModule.
Definition at line 720 of file HTMLReport.java.
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.addThumbnailRows().
|
private |
Definition at line 983 of file HTMLReport.java.
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.addThumbnailRows().
|
private |
Apply escape sequence to special characters. Line feed and carriage return character combinations will be converted to HTML line breaks.
text | The text to format. |
Definition at line 1616 of file HTMLReport.java.
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummaryCaseDetails().
ReportModuleSettings org.sleuthkit.autopsy.report.modules.html.HTMLReport.getConfiguration | ( | ) |
Get current configuration for this report module.
Implements org.sleuthkit.autopsy.report.ReportModule.
Definition at line 150 of file HTMLReport.java.
References org.sleuthkit.autopsy.report.modules.html.HTMLReport.initializePanel().
JPanel org.sleuthkit.autopsy.report.modules.html.HTMLReport.getConfigurationPanel | ( | ) |
Returns the configuration panel for the report, which is displayed in the report configuration step of the report wizard.
Implements org.sleuthkit.autopsy.report.ReportModule.
Definition at line 123 of file HTMLReport.java.
References org.sleuthkit.autopsy.report.modules.html.HTMLReport.configPanel, and org.sleuthkit.autopsy.report.modules.html.HTMLReport.initializePanel().
|
static |
Definition at line 110 of file HTMLReport.java.
References org.sleuthkit.autopsy.report.modules.html.HTMLReport.HTMLReport(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.instance.
ReportModuleSettings org.sleuthkit.autopsy.report.modules.html.HTMLReport.getDefaultConfiguration | ( | ) |
Get default configuration for this report module.
Implements org.sleuthkit.autopsy.report.ReportModule.
Definition at line 140 of file HTMLReport.java.
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.setConfiguration().
String org.sleuthkit.autopsy.report.modules.html.HTMLReport.getDescription | ( | ) |
Gets a one-line, user friendly description of the type of report this module generates.
Implements org.sleuthkit.autopsy.report.ReportModule.
Definition at line 1079 of file HTMLReport.java.
String org.sleuthkit.autopsy.report.modules.html.HTMLReport.getName | ( | ) |
Get the name of the report this module generates.
Implements org.sleuthkit.autopsy.report.ReportModule.
Definition at line 1074 of file HTMLReport.java.
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummaryIngestHistoryInfo().
String org.sleuthkit.autopsy.report.modules.html.HTMLReport.getRelativeFilePath | ( | ) |
Gets the relative path of the report file, if any, generated by this module. The path should be relative to the location that gets passed in to generateReport() (or similar).
Implements org.sleuthkit.autopsy.report.ReportModule.
Definition at line 1069 of file HTMLReport.java.
|
private |
Finds all associated image tags.
contentTags |
Definition at line 832 of file HTMLReport.java.
References org.sleuthkit.autopsy.casemodule.services.contentviewertags.ContentViewerTagManager.ContentViewerTag< T >.getDetails(), and org.sleuthkit.autopsy.casemodule.services.contentviewertags.ContentViewerTagManager.getTag().
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.addThumbnailRows().
|
private |
|
private |
Definition at line 993 of file HTMLReport.java.
References org.sleuthkit.autopsy.coreutils.FileUtil.escapeFileName().
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.addThumbnailRows(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.saveContent().
|
private |
Create a thumbnail of a given file.
file | The file from which to create the thumbnail. |
Definition at line 1581 of file HTMLReport.java.
References org.sleuthkit.autopsy.coreutils.FileUtil.escapeFileName(), org.sleuthkit.autopsy.coreutils.ImageUtils.getThumbnail(), and org.sleuthkit.autopsy.coreutils.ImageUtils.ICON_SIZE_MEDIUM.
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.addThumbnailRows().
|
private |
Definition at line 177 of file HTMLReport.java.
References org.sleuthkit.autopsy.casemodule.Case.close(), and org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows().
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.startReport().
String org.sleuthkit.autopsy.report.modules.html.HTMLReport.saveContent | ( | AbstractFile | file, |
String | dirName | ||
) |
Save a local copy of the given file in the reports folder.
file | File to save |
dirName | Custom top-level folder to use to store the files in (tag name, etc.) |
Definition at line 1040 of file HTMLReport.java.
References org.sleuthkit.autopsy.datamodel.ContentUtils.ExtractFscContentVisitor< T, V >.extract(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.makeCustomUniqueFilePath().
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.addRowWithTaggedContentHyperlink(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.addThumbnailRows().
void org.sleuthkit.autopsy.report.modules.html.HTMLReport.setConfiguration | ( | ReportModuleSettings | settings | ) |
Set report module configuration.
settings | Object which contains report module settings. |
Implements org.sleuthkit.autopsy.report.ReportModule.
Definition at line 161 of file HTMLReport.java.
References org.sleuthkit.autopsy.report.modules.html.HTMLReport.getDefaultConfiguration(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.initializePanel().
void org.sleuthkit.autopsy.report.modules.html.HTMLReport.startContentTagsTable | ( | List< String > | columnHeaders | ) |
Start a new table with the given column headers. Note: This method is a temporary workaround to avoid modifying the TableReportModule interface.
columnHeaders | column headers |
Definition at line 695 of file HTMLReport.java.
void org.sleuthkit.autopsy.report.modules.html.HTMLReport.startDataType | ( | String | name, |
String | description | ||
) |
Start a new HTML page for the given data type. Update the output stream to this page, and setup the web page header. Note: This method is a temporary workaround to avoid modifying the TableReportModule interface.
name | Name of the data type |
description | Comment on the data type, may be the empty string |
Implements org.sleuthkit.autopsy.report.infrastructure.TableReportModule.
Definition at line 514 of file HTMLReport.java.
References org.sleuthkit.autopsy.report.modules.html.HTMLReport.dataTypeToFileName(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.writePageHeader().
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.addThumbnailRows().
void org.sleuthkit.autopsy.report.modules.html.HTMLReport.startReport | ( | String | baseReportDir | ) |
Start this report by setting the path, refreshing member variables, and writing the skeleton for the HTML report.
baseReportDir | path to save the report |
Implements org.sleuthkit.autopsy.report.infrastructure.TableReportModule.
Definition at line 464 of file HTMLReport.java.
References org.sleuthkit.autopsy.report.modules.html.HTMLReport.refresh(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.THUMBS_REL_PATH, org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeCss(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeIndex(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummary().
void org.sleuthkit.autopsy.report.modules.html.HTMLReport.startSet | ( | String | setName | ) |
Start a new set under the current data type.
setName | name of the new set |
Implements org.sleuthkit.autopsy.report.infrastructure.TableReportModule.
Definition at line 610 of file HTMLReport.java.
void org.sleuthkit.autopsy.report.modules.html.HTMLReport.startTable | ( | List< String > | titles | ) |
Start a new table with the given column titles.
titles | column titles |
Implements org.sleuthkit.autopsy.report.infrastructure.TableReportModule.
Definition at line 674 of file HTMLReport.java.
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.addThumbnailRows().
|
private |
Copies a suitable icon for the given data type in the output directory and returns the icon file name to use for the given data type.
Definition at line 217 of file HTMLReport.java.
References org.sleuthkit.autopsy.report.modules.html.HTMLReport.dataTypeToFileName().
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeNav().
|
private |
Write the stylesheet for this report.
Definition at line 1086 of file HTMLReport.java.
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.startReport().
|
private |
Write the index page for this report.
Definition at line 1150 of file HTMLReport.java.
References org.sleuthkit.autopsy.casemodule.Case.addReport(), org.sleuthkit.autopsy.report.ReportBranding.getAgencyLogoPath(), org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), org.sleuthkit.autopsy.casemodule.Case.getDisplayName(), and org.sleuthkit.autopsy.report.ReportBranding.getReportTitle().
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.startReport().
|
private |
Write the navigation menu for this report.
Definition at line 1208 of file HTMLReport.java.
References org.sleuthkit.autopsy.report.modules.html.HTMLReport.dataTypeToFileName(), org.sleuthkit.autopsy.report.ReportBranding.getAgencyLogoPath(), org.sleuthkit.autopsy.report.ReportBranding.getGeneratorLogoPath(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.useDataTypeIcon().
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.endReport().
|
private |
Write HTML-formatted page footer text based on the text provided in the configuration panel.
Definition at line 593 of file HTMLReport.java.
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.endDataType(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummary().
|
private |
Write HTML-formatted page header text based on the text provided in the configuration panel.
Definition at line 576 of file HTMLReport.java.
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.startDataType(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummary().
|
private |
Write the summary of the current case for this report.
Definition at line 1300 of file HTMLReport.java.
References org.sleuthkit.autopsy.casemodule.Case.getCurrentCaseThrows(), org.sleuthkit.autopsy.report.ReportBranding.getGeneratorLogoPath(), org.sleuthkit.autopsy.ingest.IngestManager.getInstance(), org.sleuthkit.autopsy.report.ReportBranding.getReportFooter(), org.sleuthkit.autopsy.report.ReportBranding.getReportTitle(), org.sleuthkit.autopsy.casemodule.Case.getSleuthkitCase(), org.sleuthkit.autopsy.ingest.IngestManager.isIngestRunning(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.writePageFooter(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.writePageHeader(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummaryCaseDetails(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummaryImageInfo(), org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummaryIngestHistoryInfo(), and org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummarySoftwareInfo().
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.startReport().
|
private |
Write the case details section of the summary for this report.
Definition at line 1403 of file HTMLReport.java.
References org.sleuthkit.autopsy.report.modules.html.HTMLReport.formatHtmlString(), org.sleuthkit.autopsy.report.ReportBranding.getAgencyLogoPath(), org.sleuthkit.autopsy.casemodule.Case.getCaseNotes(), org.sleuthkit.autopsy.casemodule.Case.getDataSources(), org.sleuthkit.autopsy.casemodule.Case.getDisplayName(), org.sleuthkit.autopsy.casemodule.Case.getExaminer(), and org.sleuthkit.autopsy.casemodule.Case.getNumber().
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummary().
|
private |
Write the Image Information section of the summary for this report.
Definition at line 1471 of file HTMLReport.java.
References org.sleuthkit.autopsy.casemodule.Case.getDataSources().
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummary().
|
private |
Write the Ingest History section of the summary for this report.
Definition at line 1540 of file HTMLReport.java.
References org.sleuthkit.autopsy.report.modules.html.HTMLReport.getName().
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummary().
|
private |
Write the software information section of the summary for this report.
Definition at line 1505 of file HTMLReport.java.
References org.sleuthkit.autopsy.coreutils.Version.getVersion().
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.writeSummary().
|
private |
Definition at line 105 of file HTMLReport.java.
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.getConfigurationPanel().
|
private |
Definition at line 94 of file HTMLReport.java.
|
private |
Definition at line 101 of file HTMLReport.java.
|
private |
Definition at line 97 of file HTMLReport.java.
|
staticprivate |
Definition at line 93 of file HTMLReport.java.
|
staticprivate |
Definition at line 91 of file HTMLReport.java.
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.getDefault().
|
staticprivate |
Definition at line 89 of file HTMLReport.java.
|
staticprivate |
Definition at line 92 of file HTMLReport.java.
|
private |
Definition at line 103 of file HTMLReport.java.
|
private |
Definition at line 98 of file HTMLReport.java.
|
private |
Definition at line 107 of file HTMLReport.java.
|
private |
Definition at line 102 of file HTMLReport.java.
|
private |
Definition at line 100 of file HTMLReport.java.
|
static |
Definition at line 95 of file HTMLReport.java.
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.addThumbnailRows().
|
staticprivate |
Definition at line 90 of file HTMLReport.java.
Referenced by org.sleuthkit.autopsy.report.modules.html.HTMLReport.startReport().
|
private |
Definition at line 99 of file HTMLReport.java.
Copyright © 2012-2022 Basis Technology. Generated on: Sat Apr 1 2023
This work is licensed under a
Creative Commons Attribution-Share Alike 3.0 United States License.