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

Completed integration of first draft of new ingest config code

Browse Source
This commit is contained in:
Richard Cordovano 2014-02-21 13:45:12 -05:00
parent 44b155df4c
commit 2155d2567c
5 changed files with 313 additions and 384 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
Core/src/org/sleuthkit/autopsy/casemodule/AddImageWizardIngestConfigPanel.java
View File

@ -73,8 +73,8 @@ class AddImageWizardIngestConfigPanel implements WizardDescriptor.Panel<WizardDe
this.progressPanel = proPanel; this.progressPanel = proPanel;
this.dataSourcePanel = dsPanel; this.dataSourcePanel = dsPanel;
ingestConfig = Lookup.getDefault().lookup(IngestConfigurator.class); ingestConfig = new IngestConfigurator(AddImageWizardIngestConfigPanel.class.getCanonicalName());
List<String> messages = ingestConfig.setContext(AddImageWizardIngestConfigPanel.class.getCanonicalName()); List<String> messages = ingestConfig.getMissingIngestModuleErrorMessages();
if (messages.isEmpty() == false) { if (messages.isEmpty() == false) {
StringBuilder warning = new StringBuilder(); StringBuilder warning = new StringBuilder();
for (String message : messages) { for (String message : messages) {
@ -187,8 +187,12 @@ class AddImageWizardIngestConfigPanel implements WizardDescriptor.Panel<WizardDe
*/ */
@Override @Override
public void storeSettings(WizardDescriptor settings) { public void storeSettings(WizardDescriptor settings) {
//save previously selected config try {
ingestConfig.save(); ingestConfig.save();
}
catch (IngestConfigurator.IngestConfigurationException ex) {
// RJCTODO: Decide what to do here
}
// Start ingest if it hasn't already been started // Start ingest if it hasn't already been started
readyToIngest = true; readyToIngest = true;
startIngest(); startIngest();

321
Core/src/org/sleuthkit/autopsy/ingest/GeneralIngestConfigurator.java
View File

@ -1,321 +0,0 @@
/*
* Autopsy Forensic Browser
*
* Copyright 2013-2014 Basis Technology Corp.
* Contact: carrier <at> sleuthkit <dot> org
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.sleuthkit.autopsy.ingest;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import javax.swing.JPanel;
import org.sleuthkit.autopsy.coreutils.ModuleSettings;
import org.sleuthkit.datamodel.Content;
/**
* Controller to allow a user to set context-sensitive ingest module options,
* enable/disable ingest modules, and set general ingest options. Provides an
* ingest module module model class and instances of a UI component to its
* clients (Model-View-Controller design pattern).
*/
public class GeneralIngestConfigurator {
private static final String ENABLED_INGEST_MODULES_KEY = "Enabled_Ingest_Modules";
private static final String DISABLED_INGEST_MODULES_KEY = "Disabled_Ingest_Modules";
private static final String PARSE_UNALLOC_SPACE_KEY = "Process_Unallocated_Space";
private final IngestManager ingestManager = IngestManager.getDefault();
private String context = null;
private boolean processUnallocatedSpace = false;
private IngestConfigurationPanel ingestConfigPanel = null;
private List<Content> contentToIngest = null; // RJCTODO: Remove if start() method removed
public class IngestConfigurationException extends Exception {
IngestConfigurationException(String message) {
super(message);
}
}
/**
* RJCTODO
* @param context
*/
public GeneralIngestConfigurator() {
}
/**
* RJCTODO
* @param context
* @return
*/
public List<String> setContext(String context) {
this.context = context;
return initializeForContext();
}
private List<String> initializeForContext() {
// Get the enabled and disabled ingest modules settings for the current
// context. The default settings make all ingest modules enabled.
List<IngestModuleFactory> moduleFactories = IngestManager.getDefault().getIngestModuleFactories(); // RJCTODO: Put in uniqueness test in loader!
HashSet<String> loadedModuleNames = new HashSet<>();
for (IngestModuleFactory moduleFactory : moduleFactories) {
loadedModuleNames.add(moduleFactory.getModuleDisplayName());
}
HashSet<String> enabledModuleNames = getModulesNamesFromSetting(ENABLED_INGEST_MODULES_KEY, makeCommaSeparatedList(loadedModuleNames));
HashSet<String> disabledModuleNames = getModulesNamesFromSetting(DISABLED_INGEST_MODULES_KEY, "");
// Create ingest module templates for the ingest module pipelines and
// wrap them in ingest module models to pass to the ingest configuration
// panel (view). The initial enabled/disabled state of the module models
// comes from the context-sensitive settings.
HashSet<String> knownModuleNames = new HashSet<>();
List<IngestModuleModel> modules = new ArrayList<>();
for (IngestModuleFactory moduleFactory : moduleFactories) {
// NOTE: In the future, this code will be modified to get the ingest
// options for each modules for the current context; for now just
// get the default ingest options.
IngestModuleTemplate moduleTemplate = new IngestModuleTemplate(moduleFactory, moduleFactory.getDefaultIngestOptions());
String moduleName = moduleFactory.getModuleDisplayName();
IngestModuleModel module = new IngestModuleModel(moduleTemplate, enabledModuleNames.contains(moduleName));
if (!enabledModuleNames.contains(moduleName) && !enabledModuleNames.contains(moduleName)) {
// The module factory was loaded, but the module name does not
// appear in the enabled/disabled module settings. Treat the
// module as a new module and enable it by default.
module.setEnabled(true);
enabledModuleNames.add(moduleName); // RJCTODO: Put in uniqueness test, i.e., check return value!
}
modules.add(module);
knownModuleNames.add(moduleName);
}
// Check for missing modules and update the enabled/disabled ingest
// module settings. This way the settings for the context will be
// up-to-date, even if save() is never called.
List<String> errorMessages = new ArrayList<>();
for (String moduleName : enabledModuleNames) {
if (!knownModuleNames.contains(moduleName)) {
errorMessages.add(moduleName + " was previously enabled, but could not be found");
enabledModuleNames.remove(moduleName);
disabledModuleNames.add(moduleName);
}
}
ModuleSettings.setConfigSetting(context, ENABLED_INGEST_MODULES_KEY, makeCommaSeparatedList(enabledModuleNames));
ModuleSettings.setConfigSetting(context, DISABLED_INGEST_MODULES_KEY, makeCommaSeparatedList(disabledModuleNames));
// Get the process unallocated space flag setting. If the setting does
// not exist yet, default it to false.
if (ModuleSettings.settingExists(context, PARSE_UNALLOC_SPACE_KEY) == false) {
ModuleSettings.setConfigSetting(context, PARSE_UNALLOC_SPACE_KEY, "false");
}
processUnallocatedSpace = Boolean.parseBoolean(ModuleSettings.getConfigSetting(context, PARSE_UNALLOC_SPACE_KEY));
// Make the configuration panel for the current context (view).
ingestConfigPanel = new IngestConfigurationPanel(modules, processUnallocatedSpace);
return errorMessages;
}
private static String makeCommaSeparatedList(HashSet<String> input) {
if (input == null || input.isEmpty()) {
return "";
}
ArrayList<String> list = new ArrayList<>();
list.addAll(input);
StringBuilder csvList = new StringBuilder();
for (int i = 0; i < list.size() - 1; ++i) {
csvList.append(list.get(i)).append(", ");
}
csvList.append(list.get(list.size() - 1));
return csvList.toString();
}
private HashSet<String> getModulesNamesFromSetting(String key, String defaultSetting) {
// Get the ingest modules setting from the user's config file.
// If there is no such setting yet, create the default setting.
if (ModuleSettings.settingExists(context, key) == false) {
ModuleSettings.setConfigSetting(context, key, defaultSetting);
}
HashSet<String> moduleNames = new HashSet<>();
String modulesSetting = ModuleSettings.getConfigSetting(context, key);
if (!modulesSetting.isEmpty()) {
String[] settingNames = modulesSetting.split(", ");
for (String name : settingNames) {
// Map some old core module names to the current core module names.
switch (name) {
case "Thunderbird Parser":
case "MBox Parser":
moduleNames.add("Email Parser");
break;
case "File Extension Mismatch Detection":
case "Extension Mismatch Detector":
moduleNames.add("File Extension Mismatch Detector");
break;
default:
moduleNames.add(name);
}
}
}
return moduleNames;
}
public JPanel getIngestConfigPanel() throws IngestConfigurationException {
if (null == context || null == ingestConfigPanel) {
throw new IngestConfigurationException("Ingest context not set");
}
return ingestConfigPanel;
}
public void save() throws IngestConfigurationException {
if (null == context || null == ingestConfigPanel) {
throw new IngestConfigurationException("Ingest context not set");
}
List<IngestModuleModel> modules = ingestConfigPanel.getIngestModules();
// Save the enbaled/disabled ingest module settings for the current context.
HashSet<String> enabledModuleNames = new HashSet<>();
HashSet<String> disabledModuleNames = new HashSet<>();
for (IngestModuleModel module : modules) {
if (module.isEnabled()) {
enabledModuleNames.add(module.getModuleName());
}
else {
disabledModuleNames.add(module.getModuleName());
}
}
ModuleSettings.setConfigSetting(context, ENABLED_INGEST_MODULES_KEY, makeCommaSeparatedList(enabledModuleNames));
ModuleSettings.setConfigSetting(context, DISABLED_INGEST_MODULES_KEY, makeCommaSeparatedList(disabledModuleNames));
// Save the process unallocated space setting for this context.
String processUnalloc = Boolean.toString(ingestConfigPanel.getProcessUnallocSpace());
ModuleSettings.setConfigSetting(context, PARSE_UNALLOC_SPACE_KEY, processUnalloc);
// Get the ingest module options for each ingest module.
// NOTE: In the future, this code will be modified to persist the ingest
// options for each ingest module for the current context.
// RJCTODO: Decide whether to set the ingest options here or in the dialog; in the dialog allows corrections by user
// if (currentModule != null && currentModule.hasSimpleConfiguration()) {
// currentModule.saveSimpleConfiguration();
// }
}
// RJCTODO: If time permits, make it so that this class is not responsible
// starting and running the ingest - probably need to do this anyway, at
// least if the IngestConfigurator interface goes away and this becomes the
// IngestConfigurator class.
public void setContent(List<Content> inputContent) {
this.contentToIngest = inputContent;
}
// RJCTODO: If time permits, make it so that this class is not responsible
// starting and running the ingest - probably need to do this anyway, at
// least if the IngestConfigurator interface goes away and this becomes the
// IngestConfigurator class.
public void start() {
// Get the list of ingest modules selected by the user.
// RJCTODO:
// List<IngestModuleAbstract> modulesToStart = ingestConfigPanel.getModulesToStart();
List<IngestModuleAbstract> modulesToStart = new ArrayList<>();
// Get the user's selection of whether or not to process unallocated space.
ingestManager.setProcessUnallocSpace(processUnallocatedSpace);
if (!modulesToStart.isEmpty() && contentToIngest != null) {
// Queue the ingest process.
ingestManager.scheduleDataSource(modulesToStart, contentToIngest);
}
}
// RJCTODO: If time permits, make it so that this class is not responsible
// starting and running the ingest - probably need to do this anyway, at
// least if the IngestConfigurator interface goes away and this becomes the
// IngestConfigurator class.
public boolean isIngestRunning() {
return ingestManager.isIngestRunning();
}
/**
* A model of an ingest module tailored for the view used to configure
* ingest modules.
*/
static class IngestModuleModel {
private final IngestModuleTemplate moduleTemplate;
private final IngestModuleFactory moduleFactory;
private final JPanel ingestOptionsPanel;
private final JPanel globalOptionsPanel;
private boolean enabled = true;
IngestModuleModel(IngestModuleTemplate moduleTemplate, boolean enabled) {
this.moduleTemplate = moduleTemplate;
moduleFactory = moduleTemplate.getIngestModuleFactory();
if (moduleFactory.providesIngestOptionsPanels()) {
ingestOptionsPanel = moduleFactory.getIngestOptionsPanel(moduleTemplate.getIngestOptions());
}
else {
ingestOptionsPanel = null;
}
if (moduleFactory.providesGlobalOptionsPanels()) {
globalOptionsPanel = moduleFactory.getGlobalOptionsPanel();
}
else {
globalOptionsPanel = null;
}
this.enabled = enabled;
}
String getModuleName() {
return moduleFactory.getModuleDisplayName();
}
String getModuleDescription() {
return moduleFactory.getModuleDescription();
}
void setEnabled(boolean enabled) {
this.enabled = enabled;
}
boolean isEnabled() {
return enabled;
}
boolean hasIngestOptionsPanel() {
return moduleFactory.providesIngestOptionsPanels();
}
JPanel getIngestOptionsPanel() {
return ingestOptionsPanel;
}
boolean hasGlobalOptionsPanel() {
return moduleFactory.providesGlobalOptionsPanels();
}
JPanel getGlobalOptionsPanel() {
return globalOptionsPanel;
}
void saveGlobalOptions() throws IngestModuleFactory.InvalidOptionsException {
// RJCTODO: Check for null.
moduleFactory.saveGlobalOptionsFromPanel(globalOptionsPanel);
}
private IngestModuleTemplate getIngestModuleTemplate() {
return moduleTemplate;
}
}
}

2
Core/src/org/sleuthkit/autopsy/ingest/IngestConfigurationPanel.java
View File

@ -33,7 +33,7 @@ import javax.swing.table.AbstractTableModel;
import javax.swing.table.DefaultTableCellRenderer; import javax.swing.table.DefaultTableCellRenderer;
import javax.swing.table.TableColumn; import javax.swing.table.TableColumn;
import org.sleuthkit.autopsy.corecomponents.AdvancedConfigurationDialog; import org.sleuthkit.autopsy.corecomponents.AdvancedConfigurationDialog;
import org.sleuthkit.autopsy.ingest.GeneralIngestConfigurator.IngestModuleModel; import org.sleuthkit.autopsy.ingest.IngestConfigurator.IngestModuleModel;
/** /**
* User interface component to allow a user to set ingest module options and * User interface component to allow a user to set ingest module options and

337
Core/src/org/sleuthkit/autopsy/ingest/IngestConfigurator.java
View File

@ -1,84 +1,315 @@
/* /*
* Autopsy Forensic Browser * Autopsy Forensic Browser
* *
* Copyright 2011-2013 Basis Technology Corp. * Copyright 2013-2014 Basis Technology Corp.
* Contact: carrier <at> sleuthkit <dot> org * Contact: carrier <at> sleuthkit <dot> org
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at * You may obtain a copy of the License at
* *
* http://www.apache.org/licenses/LICENSE-2.0 * http://www.apache.org/licenses/LICENSE-2.0
* *
* Unless required by applicable law or agreed to in writing, software * Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, * distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and * See the License for the specific language governing permissions and
* limitations under the License. * limitations under the License.
*/ */
package org.sleuthkit.autopsy.ingest; package org.sleuthkit.autopsy.ingest;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List; import java.util.List;
import javax.swing.JPanel; import javax.swing.JPanel;
import org.sleuthkit.autopsy.coreutils.ModuleSettings;
import org.sleuthkit.datamodel.Content; import org.sleuthkit.datamodel.Content;
/** /**
* Instances of this class provide the following services: * Controller to allow a user to set context-sensitive ingest module options,
* 1. A way to save and load the ingest process configuration settings for a * enable/disable ingest modules, and set general ingest options. Provides an
* given ingest process context. * ingest module module model class and instances of a UI component to its
* 2. A UI component for configuring ingest process settings. * clients (Model-View-Controller design pattern).
* 3. A way to specify input content and start the ingest process for a
* given ingest process context.
*/ */
// @@@ This interface needs to be re-designed. An interface for allowing the public class IngestConfigurator {
// authors of ingest modules to expose context sensitive module configuration private static final String ENABLED_INGEST_MODULES_KEY = "Enabled_Ingest_Modules";
// settings needs to be provided; there also needs to be a way for users to private static final String DISABLED_INGEST_MODULES_KEY = "Disabled_Ingest_Modules";
// configure the ingest process that uses those modules. These are separate private static final String PARSE_UNALLOC_SPACE_KEY = "Process_Unallocated_Space";
// concerns; likewise, kicking off an ingest process for particular content in private final IngestManager ingestManager = IngestManager.getDefault();
// a particular context is a separate concern. private final String context;
public interface IngestConfigurator { private List<String> missingIngestModuleErrorMessages = new ArrayList<>();
/** private boolean processUnallocatedSpace = false;
* Specifies the ingest process context for the purpose of choosing, saving, private IngestConfigurationPanel ingestConfigPanel = null;
* and loading ingest process configuration settings; also determines what private List<Content> contentToIngest = null; // RJCTODO: Remove if start() method removed
* configuration settings will be in effect if the setContent() and start()
* methods are called to start the ingest process for some content specified public class IngestConfigurationException extends Exception {
* using the setContent() method. IngestConfigurationException(String message) {
* @return A list, possibly empty, of messages describing errors that super(message);
* occurred when loading the configuration settings. }
*/ }
public List<String> setContext(String contextName);
/** /**
* Provides a UI component for choosing ingest process configuration * RJCTODO
* settings for the ingest process context specified using the setContext() * @param context
* method.
*/ */
JPanel getIngestConfigPanel(); public IngestConfigurator(String context) {
this.context = context;
initializeForContext();
}
/**
* RJCTODO
* @return
*/
public List<String> getMissingIngestModuleErrorMessages() {
return missingIngestModuleErrorMessages;
}
private void initializeForContext() {
// Get the enabled and disabled ingest modules settings for the current
// context. The default settings make all ingest modules enabled.
List<IngestModuleFactory> moduleFactories = IngestManager.getDefault().getIngestModuleFactories(); // RJCTODO: Put in uniqueness test in loader!
HashSet<String> loadedModuleNames = new HashSet<>();
for (IngestModuleFactory moduleFactory : moduleFactories) {
loadedModuleNames.add(moduleFactory.getModuleDisplayName());
}
HashSet<String> enabledModuleNames = getModulesNamesFromSetting(ENABLED_INGEST_MODULES_KEY, makeCommaSeparatedList(loadedModuleNames));
HashSet<String> disabledModuleNames = getModulesNamesFromSetting(DISABLED_INGEST_MODULES_KEY, "");
// Create ingest module templates for the ingest module pipelines and
// wrap them in ingest module models to pass to the ingest configuration
// panel (view). The initial enabled/disabled state of the module models
// comes from the context-sensitive settings.
HashSet<String> knownModuleNames = new HashSet<>();
List<IngestConfigurator.IngestModuleModel> modules = new ArrayList<>();
for (IngestModuleFactory moduleFactory : moduleFactories) {
// NOTE: In the future, this code will be modified to get the ingest
// options for each modules for the current context; for now just
// get the default ingest options.
IngestModuleTemplate moduleTemplate = new IngestModuleTemplate(moduleFactory, moduleFactory.getDefaultIngestOptions());
String moduleName = moduleFactory.getModuleDisplayName();
IngestConfigurator.IngestModuleModel module = new IngestConfigurator.IngestModuleModel(moduleTemplate, enabledModuleNames.contains(moduleName));
if (!enabledModuleNames.contains(moduleName) && !enabledModuleNames.contains(moduleName)) {
// The module factory was loaded, but the module name does not
// appear in the enabled/disabled module settings. Treat the
// module as a new module and enable it by default.
module.setEnabled(true);
enabledModuleNames.add(moduleName); // RJCTODO: Put in uniqueness test, i.e., check return value!
}
modules.add(module);
knownModuleNames.add(moduleName);
}
// Check for missing modules and update the enabled/disabled ingest
// module settings. This way the settings for the context will be
// up-to-date, even if save() is never called.
for (String moduleName : enabledModuleNames) {
if (!knownModuleNames.contains(moduleName)) {
missingIngestModuleErrorMessages.add(moduleName + " was previously enabled, but could not be found");
enabledModuleNames.remove(moduleName);
disabledModuleNames.add(moduleName);
}
}
ModuleSettings.setConfigSetting(context, ENABLED_INGEST_MODULES_KEY, makeCommaSeparatedList(enabledModuleNames));
ModuleSettings.setConfigSetting(context, DISABLED_INGEST_MODULES_KEY, makeCommaSeparatedList(disabledModuleNames));
/** // Get the process unallocated space flag setting. If the setting does
* Saves the ingest process configuration settings for the ingest process // not exist yet, default it to false.
* context specified using the setContext() method. if (ModuleSettings.settingExists(context, PARSE_UNALLOC_SPACE_KEY) == false) {
*/ ModuleSettings.setConfigSetting(context, PARSE_UNALLOC_SPACE_KEY, "false");
void save(); }
processUnallocatedSpace = Boolean.parseBoolean(ModuleSettings.getConfigSetting(context, PARSE_UNALLOC_SPACE_KEY));
// Make the configuration panel for the current context (view).
ingestConfigPanel = new IngestConfigurationPanel(modules, processUnallocatedSpace);
}
/** private static String makeCommaSeparatedList(HashSet<String> input) {
* Sets the input content for an ingest process prior to calling start() to if (input == null || input.isEmpty()) {
* run the process using the process configuration settings for the context return "";
* specified using setContext(). }
*/
void setContent(List<Content> inputContent); ArrayList<String> list = new ArrayList<>();
list.addAll(input);
StringBuilder csvList = new StringBuilder();
for (int i = 0; i < list.size() - 1; ++i) {
csvList.append(list.get(i)).append(", ");
}
csvList.append(list.get(list.size() - 1));
return csvList.toString();
}
private HashSet<String> getModulesNamesFromSetting(String key, String defaultSetting) {
// Get the ingest modules setting from the user's config file.
// If there is no such setting yet, create the default setting.
if (ModuleSettings.settingExists(context, key) == false) {
ModuleSettings.setConfigSetting(context, key, defaultSetting);
}
HashSet<String> moduleNames = new HashSet<>();
String modulesSetting = ModuleSettings.getConfigSetting(context, key);
if (!modulesSetting.isEmpty()) {
String[] settingNames = modulesSetting.split(", ");
for (String name : settingNames) {
// Map some old core module names to the current core module names.
switch (name) {
case "Thunderbird Parser":
case "MBox Parser":
moduleNames.add("Email Parser");
break;
case "File Extension Mismatch Detection":
case "Extension Mismatch Detector":
moduleNames.add("File Extension Mismatch Detector");
break;
default:
moduleNames.add(name);
}
}
}
return moduleNames;
}
public JPanel getIngestConfigPanel() {
return ingestConfigPanel;
}
public void save() throws IngestConfigurationException {
if (null == context || null == ingestConfigPanel) {
throw new IngestConfigurationException("Ingest context not set");
}
List<IngestModuleModel> modules = ingestConfigPanel.getIngestModules();
// Save the enbaled/disabled ingest module settings for the current context.
HashSet<String> enabledModuleNames = new HashSet<>();
HashSet<String> disabledModuleNames = new HashSet<>();
for (IngestModuleModel module : modules) {
if (module.isEnabled()) {
enabledModuleNames.add(module.getModuleName());
}
else {
disabledModuleNames.add(module.getModuleName());
}
}
ModuleSettings.setConfigSetting(context, ENABLED_INGEST_MODULES_KEY, makeCommaSeparatedList(enabledModuleNames));
ModuleSettings.setConfigSetting(context, DISABLED_INGEST_MODULES_KEY, makeCommaSeparatedList(disabledModuleNames));
// Save the process unallocated space setting for this context.
String processUnalloc = Boolean.toString(ingestConfigPanel.getProcessUnallocSpace());
ModuleSettings.setConfigSetting(context, PARSE_UNALLOC_SPACE_KEY, processUnalloc);
// Get the ingest module options for each ingest module.
// NOTE: In the future, this code will be modified to persist the ingest
// options for each ingest module for the current context.
// RJCTODO: Decide whether to set the ingest options here or in the dialog; in the dialog allows corrections by user
// if (currentModule != null && currentModule.hasSimpleConfiguration()) {
// currentModule.saveSimpleConfiguration();
// }
}
// RJCTODO: If time permits, make it so that this class is not responsible
// starting and running the ingest - probably need to do this anyway, at
// least if the IngestConfigurator interface goes away and this becomes the
// IngestConfigurator class.
public void setContent(List<Content> inputContent) {
this.contentToIngest = inputContent;
}
// RJCTODO: If time permits, make it so that this class is not responsible
// starting and running the ingest - probably need to do this anyway, at
// least if the IngestConfigurator interface goes away and this becomes the
// IngestConfigurator class.
public void start() {
// Get the list of ingest modules selected by the user.
// RJCTODO:
// List<IngestModuleAbstract> modulesToStart = ingestConfigPanel.getModulesToStart();
List<IngestModuleAbstract> modulesToStart = new ArrayList<>();
// Get the user's selection of whether or not to process unallocated space.
ingestManager.setProcessUnallocSpace(processUnallocatedSpace);
if (!modulesToStart.isEmpty() && contentToIngest != null) {
// Queue the ingest process.
ingestManager.scheduleDataSource(modulesToStart, contentToIngest);
}
}
// RJCTODO: If time permits, make it so that this class is not responsible
// starting and running the ingest - probably need to do this anyway, at
// least if the IngestConfigurator interface goes away and this becomes the
// IngestConfigurator class.
public boolean isIngestRunning() {
return ingestManager.isIngestRunning();
}
/** /**
* Starts (queues) the ingest process for the content specified using the * A model of an ingest module tailored for the view used to configure
* setContent() method, using the configuration settings corresponding to * ingest modules.
* the ingest process context specified using the setContext() method.
*/ */
void start(); static class IngestModuleModel {
private final IngestModuleTemplate moduleTemplate;
private final IngestModuleFactory moduleFactory;
private final JPanel ingestOptionsPanel;
private final JPanel globalOptionsPanel;
private boolean enabled = true;
IngestModuleModel(IngestModuleTemplate moduleTemplate, boolean enabled) {
this.moduleTemplate = moduleTemplate;
moduleFactory = moduleTemplate.getIngestModuleFactory();
if (moduleFactory.providesIngestOptionsPanels()) {
ingestOptionsPanel = moduleFactory.getIngestOptionsPanel(moduleTemplate.getIngestOptions());
}
else {
ingestOptionsPanel = null;
}
if (moduleFactory.providesGlobalOptionsPanels()) {
globalOptionsPanel = moduleFactory.getGlobalOptionsPanel();
}
else {
globalOptionsPanel = null;
}
this.enabled = enabled;
}
String getModuleName() {
return moduleFactory.getModuleDisplayName();
}
/** String getModuleDescription() {
* Returns true if any ingest process is running, false otherwise. return moduleFactory.getModuleDescription();
* Note that the running process may or may not be the process started }
* (queued) by an invocation of the start() method.
*/ void setEnabled(boolean enabled) {
boolean isIngestRunning(); this.enabled = enabled;
}
boolean isEnabled() {
return enabled;
}
boolean hasIngestOptionsPanel() {
return moduleFactory.providesIngestOptionsPanels();
}
JPanel getIngestOptionsPanel() {
return ingestOptionsPanel;
}
boolean hasGlobalOptionsPanel() {
return moduleFactory.providesGlobalOptionsPanels();
}
JPanel getGlobalOptionsPanel() {
return globalOptionsPanel;
}
void saveGlobalOptions() throws IngestModuleFactory.InvalidOptionsException {
// RJCTODO: Check for null.
moduleFactory.saveGlobalOptionsFromPanel(globalOptionsPanel);
}
private IngestModuleTemplate getIngestModuleTemplate() {
return moduleTemplate;
}
}
} }

25
Core/src/org/sleuthkit/autopsy/ingest/IngestDialog.java
View File

@ -46,8 +46,8 @@ public class IngestDialog extends JDialog {
public IngestDialog(JFrame frame, String title, boolean modal) { public IngestDialog(JFrame frame, String title, boolean modal) {
super(frame, title, modal); super(frame, title, modal);
ingestConfigurator = new GeneralIngestConfigurator(); ingestConfigurator = new IngestConfigurator(IngestDialog.class.getCanonicalName());
List<String> messages = ingestConfigurator.setContext(IngestDialog.class.getCanonicalName()); List<String> messages = ingestConfigurator.getMissingIngestModuleErrorMessages();
if (messages.isEmpty() == false) { if (messages.isEmpty() == false) {
StringBuilder warning = new StringBuilder(); StringBuilder warning = new StringBuilder();
for (String message : messages) { for (String message : messages) {
@ -83,7 +83,12 @@ public class IngestDialog extends JDialog {
@Override @Override
public void actionPerformed(ActionEvent e) { public void actionPerformed(ActionEvent e) {
ingestConfigurator.save(); try {
ingestConfigurator.save();
}
catch (IngestConfigurator.IngestConfigurationException ex) {
// RJCTODO: Decide what to do here.
}
ingestConfigurator.start(); ingestConfigurator.start();
close(); close();
} }
@ -92,7 +97,12 @@ public class IngestDialog extends JDialog {
@Override @Override
public void actionPerformed(ActionEvent e) { public void actionPerformed(ActionEvent e) {
ingestConfigurator.save(); try {
ingestConfigurator.save();
}
catch (IngestConfigurator.IngestConfigurationException ex) {
// RJCTODO: Decide what to do here.
}
close(); close();
} }
}); });
@ -100,7 +110,12 @@ public class IngestDialog extends JDialog {
@Override @Override
public void windowClosing(WindowEvent e) { public void windowClosing(WindowEvent e) {
ingestConfigurator.save(); try {
ingestConfigurator.save();
}
catch (IngestConfigurator.IngestConfigurationException ex) {
// RJCTODO: Decide what to do here.
}
close(); close();
} }
}); });