mstoeck3/autopsy-flatpak
1
0
Fork 0
mirror of https://github.com/overcuriousity/autopsy-flatpak.git synced 2025-07-19 11:07:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Implement module settings persistence for HTML report

Browse Source
This commit is contained in:
Eugene Livis 2019-08-21 16:53:17 -04:00
parent d74e68be49
commit d37354d392
7 changed files with 96 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Core/src/org/sleuthkit/autopsy/report/HTMLReportModuleSettings.java
View File

@ -28,6 +28,11 @@ class HTMLReportModuleSettings implements ReportModuleSettings {
private String header;
private String footer;
HTMLReportModuleSettings() {
this.header = "";
this.footer = "";
}
HTMLReportModuleSettings(String header, String footer) {
this.header = header;
this.footer = footer;

62
Core/src/org/sleuthkit/autopsy/report/ReportHTML.java
View File

@ -64,7 +64,6 @@ import org.sleuthkit.autopsy.contentviewers.imagetagging.ImageTagsUtil;
import org.sleuthkit.autopsy.coreutils.EscapeUtil;
import org.sleuthkit.autopsy.coreutils.ImageUtils;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.coreutils.ModuleSettings;
import org.sleuthkit.autopsy.coreutils.Version;
import org.sleuthkit.autopsy.datamodel.ContentUtils.ExtractFscContentVisitor;
import org.sleuthkit.autopsy.ingest.IngestManager;
@ -99,7 +98,7 @@ class ReportHTML implements TableReportModule {
private Integer rowCount; // number of rows (aka artifacts or tags) for the current data type
private Writer out;
private ReportHTMLConfigurationPanel configPanel;
private final ReportHTMLConfigurationPanel configPanel = new ReportHTMLConfigurationPanel();
private final ReportBranding reportBranding;
@ -118,9 +117,6 @@ class ReportHTML implements TableReportModule {
@Override
public JPanel getConfigurationPanel() {
if (configPanel == null) {
configPanel = new ReportHTMLConfigurationPanel();
}
return configPanel;
}
@ -131,27 +127,37 @@ class ReportHTML implements TableReportModule {
*/
@Override
public ReportModuleSettings getDefaultConfiguration() {
return new NoReportModuleSettings();
return new HTMLReportModuleSettings();
}
/**
/**
* Get current configuration for this report module.
*
* @return Object which contains current report module settings.
*/
@Override
public ReportModuleSettings getConfiguration() {
return new NoReportModuleSettings();
return configPanel.getConfiguration();
}
/**
/**
* Set report module configuration.
*
* @param settings Object which contains report module settings.
*/
@Override
public void setConfiguration(ReportModuleSettings settings) {
// NO-OP
if (settings instanceof HTMLReportModuleSettings) {
configPanel.setConfiguration((HTMLReportModuleSettings) settings);
return;
}
if (settings instanceof NoReportModuleSettings) {
configPanel.setConfiguration((HTMLReportModuleSettings) getDefaultConfiguration());
return;
}
throw new IllegalArgumentException("Expected settings argument to be an instance of HTMLReportModuleSettings");
}
// Refesh the member variables
@ -396,9 +402,6 @@ class ReportHTML implements TableReportModule {
*/
@Override
public void startReport(String baseReportDir) {
// Save settings
ModuleSettings.setConfigSetting("HTMLReport", "header", configPanel.getHeader()); //NON-NLS
ModuleSettings.setConfigSetting("HTMLReport", "footer", configPanel.getFooter()); //NON-NLS
// Refresh the HTML report
try {
@ -444,7 +447,7 @@ class ReportHTML implements TableReportModule {
* to this page, and setup the web page header. Note: This method is a
* temporary workaround to avoid modifying the TableReportModule interface.
*
* @param name Name of the data type
* @param name Name of the data type
* @param comment Comment on the data type, may be the empty string
*/
@Override
@ -461,9 +464,9 @@ class ReportHTML implements TableReportModule {
try {
StringBuilder page = new StringBuilder();
page.append("<html>\n<head>\n\t<title>").append(name).append("</title>\n\t<link rel=\"stylesheet\" type=\"text/css\" href=\"index.css\" />\n<meta http-equiv=\"Content-Type\" content=\"text/html; charset=utf-8\">\n</head>\n<body>\n") //NON-NLS
.append(writePageHeader())
.append("<div id=\"header\">").append(name).append("</div>\n")
.append("<div id=\"content\">\n"); //NON-NLS
.append(writePageHeader())
.append("<div id=\"header\">").append(name).append("</div>\n")
.append("<div id=\"content\">\n"); //NON-NLS
if (!description.isEmpty()) {
page.append("<p><strong>"); //NON-NLS
page.append(description);
@ -627,7 +630,7 @@ class ReportHTML implements TableReportModule {
* Start a new table with the given column headers. Note: This method is a
* temporary workaround to avoid modifying the TableReportModule interface.
*
* @param columnHeaders column headers
* @param columnHeaders column headers
* @param sourceArtifact source blackboard artifact for the table data
*/
public void startContentTagsTable(List<String> columnHeaders) {
@ -677,9 +680,9 @@ class ReportHTML implements TableReportModule {
/**
* Add a row to the current table.
*
* @param row values for each cell in the row
* @param row values for each cell in the row
* @param escapeText whether or not the text of the row should be escaped,
* true for escaped, false for not escaped
* true for escaped, false for not escaped
*/
private void addRow(List<String> row, boolean escapeText) {
StringBuilder builder = new StringBuilder();
@ -704,10 +707,9 @@ class ReportHTML implements TableReportModule {
* Saves a local copy of a tagged file and adds a row with a hyper link to
* the file. The content of the hyperlink is provided in linkHTMLContent.
*
* @param row Values for each data cell in the row
* @param file The file to link to in the report.
* @param tagName the name of the tag that the content was flagged
* by
* @param row Values for each data cell in the row
* @param file The file to link to in the report.
* @param tagName the name of the tag that the content was flagged by
* @param linkHTMLContent the html that will be the body of the link
*/
public void addRowWithTaggedContentHyperlink(List<String> row, ContentTag contentTag) {
@ -834,7 +836,7 @@ class ReportHTML implements TableReportModule {
.getTagsManager().getContentTagsByContent(file);
List<ImageTagRegion> imageTags = getTaggedRegions(contentTags);
if(!imageTags.isEmpty()) {
if (!imageTags.isEmpty()) {
//Write the tags to the fullsize and thumbnail images
BufferedImage fullImageWithTags = ImageTagsUtil.getImageWithTags(file, imageTags);
@ -864,7 +866,7 @@ class ReportHTML implements TableReportModule {
}
// save copies of the orginal image and thumbnail image
if(thumbnailPath == null) {
if (thumbnailPath == null) {
thumbnailPath = prepareThumbnail(file);
}
@ -885,7 +887,7 @@ class ReportHTML implements TableReportModule {
.append("\" target=\"_top\"><img src=\"")
.append(thumbnailPath).append("\" title=\"").append(nameInImage).append("\"/></a><br>") //NON-NLS
.append(file.getName()).append("<br>"); //NON-NLS
if(imageWithTagsFullPath != null) {
if (imageWithTagsFullPath != null) {
linkToThumbnail.append("<a href=\"").append(contentPath).append("\" target=\"_top\">View Original</a><br>");
}
@ -971,9 +973,9 @@ class ReportHTML implements TableReportModule {
/**
* Save a local copy of the given file in the reports folder.
*
* @param file File to save
* @param file File to save
* @param dirName Custom top-level folder to use to store the files in (tag
* name, etc.)
* name, etc.)
*
* @return Path to where file was stored (relative to root of HTML folder)
*/
@ -1516,7 +1518,7 @@ class ReportHTML implements TableReportModule {
* @param file The file from which to create the thumbnail.
*
* @return The path to the thumbnail file, or null if a thumbnail couldn't
* be created.
* be created.
*/
private String prepareThumbnail(AbstractFile file) {
BufferedImage bufferedThumb = ImageUtils.getThumbnail(file, ImageUtils.ICON_SIZE_MEDIUM);

12
Core/src/org/sleuthkit/autopsy/report/ReportHTMLConfigurationPanel.java
View File

@ -18,8 +18,6 @@
*/
package org.sleuthkit.autopsy.report;
import org.sleuthkit.autopsy.coreutils.ModuleSettings;
/**
* The panel shown for all TableReportModules when configuring report modules.
*/
@ -31,14 +29,8 @@ final class ReportHTMLConfigurationPanel extends javax.swing.JPanel {
*/
ReportHTMLConfigurationPanel() {
initComponents();
// Load settings
// ELTODO REMOVE
String header = ModuleSettings.getConfigSetting("HTMLReport", "header"); //NON-NLS
String footer = ModuleSettings.getConfigSetting("HTMLReport", "footer"); //NON-NLS
headerTextField.setText(header != null ? header : "");
footerTextField.setText(footer != null ? footer : "");
headerTextField.setText("");
footerTextField.setText("");
}
void setConfiguration(HTMLReportModuleSettings settings) {

15
Core/src/org/sleuthkit/autopsy/report/ReportModuleConfig.java
View File

@ -32,7 +32,7 @@ final class ReportModuleConfig implements Serializable {
private boolean enabled;
/**
* Creates ModuleStatus object.
* Creates ReportModuleConfig object.
*
* @param module Implementation of a ReportModule interface
* @param enabled Boolean flag whether the module is enabled
@ -43,6 +43,19 @@ final class ReportModuleConfig implements Serializable {
this.settings = new NoReportModuleSettings();
}
/**
* Creates ReportModuleConfig object.
*
* @param module Implementation of a ReportModule interface
* @param enabled Boolean flag whether the module is enabled
* @param settings Report module settings object
*/
ReportModuleConfig(ReportModule module, boolean enabled, ReportModuleSettings settings) {
this.moduleName = module.getClass().getCanonicalName();
this.enabled = enabled;
this.settings = settings;
}
/**
* Get full canonical report module name.
*

18
Core/src/org/sleuthkit/autopsy/report/ReportVisualPanel1.java
View File

@ -22,6 +22,7 @@ import java.awt.BorderLayout;
import java.awt.Component;
import java.util.ArrayList;
import static java.util.Collections.swap;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.logging.Level;
@ -50,7 +51,7 @@ final class ReportVisualPanel1 extends JPanel implements ListSelectionListener {
private List<TableReportModule> tableModules = new ArrayList<>();
private List<FileReportModule> fileModules = new ArrayList<>();
private PortableCaseReportModule portableCaseModule;
private final Map<String, ReportModuleConfig> moduleConfigs;
private Map<String, ReportModuleConfig> moduleConfigs;
private Integer selectedIndex;
/**
@ -120,10 +121,6 @@ final class ReportVisualPanel1 extends JPanel implements ListSelectionListener {
if (moduleConfigs == null) {
// get default module configuration
settings = module.getDefaultConfiguration();
// update config for this module
ReportModuleConfig moduleConfig = new ReportModuleConfig(module, false);
moduleConfig.setModuleSettings(settings);
moduleConfigs.put(module.getName(), moduleConfig);
} else {
// get configuration for this module
ReportModuleConfig config = moduleConfigs.get(module.getClass().getCanonicalName());
@ -133,10 +130,6 @@ final class ReportVisualPanel1 extends JPanel implements ListSelectionListener {
} else {
// get default module configuration
settings = module.getDefaultConfiguration();
// update config for this module
ReportModuleConfig moduleConfig = new ReportModuleConfig(module, false);
moduleConfig.setModuleSettings(settings);
moduleConfigs.put(module.getName(), moduleConfig);
}
}
// set module configuration
@ -230,14 +223,11 @@ final class ReportVisualPanel1 extends JPanel implements ListSelectionListener {
* @return
*/
Map<String, ReportModuleConfig> getUpdatedModuleConfigs() {
moduleConfigs = new HashMap<>();
for (ReportModule module : modules) {
// get updated module configuration
ReportModuleSettings settings = module.getConfiguration();
// update ReportModuleConfig for this module
ReportModuleConfig moduleConfig = new ReportModuleConfig(module, false);
moduleConfig.setModuleSettings(settings);
moduleConfigs.put(module.getName(), moduleConfig);
moduleConfigs.put(module.getClass().getCanonicalName(), new ReportModuleConfig(module, false, settings));
}
return moduleConfigs;
}

2
Core/src/org/sleuthkit/autopsy/report/ReportWizardAction.java
View File

@ -57,7 +57,7 @@ public final class ReportWizardAction extends CallableSystemAction implements Pr
private static final Logger logger = Logger.getLogger(ReportWizardAction.class.getName());
private static final String REPORTING_CONFIGURATION_NAME = "ReportAction";
private static final boolean DISPLAY_CASE_SPECIFIC_DATA = false; //ELTODO true;
private static final boolean DISPLAY_CASE_SPECIFIC_DATA = true;
private static final boolean RUN_REPORTS = true;
private final JButton toolbarButton = new JButton();
private static final String ACTION_NAME = NbBundle.getMessage(ReportWizardAction.class, "ReportWizardAction.actionName.text");

2
Core/src/org/sleuthkit/autopsy/report/ReportingConfigLoader.java
View File

@ -108,7 +108,7 @@ final class ReportingConfigLoader {
// read each ReportModuleSettings object individually
for (Iterator<Entry<String, ReportModuleConfig>> iterator = moduleConfigs.entrySet().iterator(); iterator.hasNext();) {
ReportModuleConfig moduleConfig = (ReportModuleConfig) iterator.next().getValue();
ReportModuleConfig moduleConfig = iterator.next().getValue();
filePath = reportDirPath.toString() + File.separator + moduleConfig.getModuleClassName() + REPORT_SETTINGS_FILE_EXTENSION;
try (NbObjectInputStream in = new NbObjectInputStream(new FileInputStream(filePath))) {
moduleConfig.setModuleSettings((ReportModuleSettings) in.readObject());