From 6a17ec4b085d5a7d6dc6617e4084188fa5991b84 Mon Sep 17 00:00:00 2001
From: 0xNF <nflower@hpa-w7-df-vm2.basistech.net>
Date: Fri, 21 Sep 2012 14:29:21 -0400
Subject: [PATCH 1/4] Got rid of old call to ModuleSettings.getUserDir().

---
 .../autopsy/keywordsearch/KeywordSearchListsAbstract.java     | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchListsAbstract.java b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchListsAbstract.java
index f6a1b82179..31fccbddc4 100644
--- a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchListsAbstract.java
+++ b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchListsAbstract.java
@@ -26,8 +26,8 @@ import java.util.Date;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
-import org.sleuthkit.autopsy.coreutils.ModuleSettings;
 import org.sleuthkit.autopsy.coreutils.Logger;
+import org.sleuthkit.autopsy.coreutils.PlatformUtil;
 import org.sleuthkit.datamodel.BlackboardAttribute;
 
 /**
@@ -39,7 +39,7 @@ public abstract class KeywordSearchListsAbstract {
     Map<String, KeywordSearchList> theLists; //the keyword data
     static KeywordSearchListsXML currentInstance = null;
     private static final String CUR_LISTS_FILE_NAME = "keywords.xml";
-    private static String CUR_LISTS_FILE = ModuleSettings.getUserDirPath() + File.separator + CUR_LISTS_FILE_NAME;
+    private static String CUR_LISTS_FILE = PlatformUtil.getUserDirectory() + File.separator + CUR_LISTS_FILE_NAME;
     protected static final Logger logger = Logger.getLogger(KeywordSearchListsAbstract.class.getName());
     PropertyChangeSupport changeSupport;
 

From 0f898555060a39ad08becd41c7f5093732e5cc08 Mon Sep 17 00:00:00 2001
From: 0xNF <nflower@hpa-w7-df-vm2.basistech.net>
Date: Fri, 21 Sep 2012 14:30:12 -0400
Subject: [PATCH 2/4] Keyword Search settings are now persistant via
 ModuleSettings

---
 .../KeywordSearchIngestModule.java            | 82 +++++++++++++++++--
 1 file changed, 73 insertions(+), 9 deletions(-)

diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestModule.java b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestModule.java
index d4f98cf5a4..66c689a040 100644
--- a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestModule.java
+++ b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestModule.java
@@ -39,6 +39,7 @@ import org.netbeans.api.progress.ProgressHandle;
 import org.netbeans.api.progress.ProgressHandleFactory;
 import org.openide.util.Cancellable;
 import org.sleuthkit.autopsy.casemodule.Case;
+import org.sleuthkit.autopsy.coreutils.ModuleSettings;
 import org.sleuthkit.autopsy.coreutils.StopWatch;
 import org.sleuthkit.autopsy.coreutils.StringExtract.StringExtractUnicodeTable.SCRIPT;
 import org.sleuthkit.autopsy.ingest.IngestServices;
@@ -92,6 +93,9 @@ public final class KeywordSearchIngestModule implements IngestModuleAbstractFile
     private static final Logger logger = Logger.getLogger(KeywordSearchIngestModule.class.getName());
     public static final String MODULE_NAME = "Keyword Search";
     public static final String MODULE_DESCRIPTION = "Performs file indexing and periodic search using keywords and regular expressions in lists.";     final public static String MODULE_VERSION = "1.0";
+    public static final String PROP_SCRIPTS = MODULE_NAME + "_Scripts";
+    public static final String PROP_OPTIONS = MODULE_NAME + "_Options";
+    public static final String PROP_NSRL = MODULE_NAME + "_NSRL";
     private String args;
     private static KeywordSearchIngestModule instance = null;
     private IngestServices services;
@@ -106,7 +110,7 @@ public final class KeywordSearchIngestModule implements IngestModuleAbstractFile
     private Indexer indexer;
     private Searcher currentSearcher;
     private Searcher finalSearcher;
-    private volatile boolean searcherDone = true; //mark as done, until it's inited
+    private volatile boolean searcherDone = true; //mark as done, until it's initedf
     private Map<Keyword, List<Long>> currentResults;
     private static final ReentrantReadWriteLock rwLock = new ReentrantReadWriteLock(true); //use fairness policy
     private static final Lock searcherLock = rwLock.writeLock();
@@ -122,6 +126,7 @@ public final class KeywordSearchIngestModule implements IngestModuleAbstractFile
     private final List<SCRIPT> stringExtractScripts = new ArrayList<SCRIPT>();
     private Map<String,String> stringExtractOptions = new HashMap<String,String>();
     
+    
     private final GetIsFileKnownV getIsFileKnown = new GetIsFileKnownV();
     private KeywordSearchConfigurationPanel panel;
 
@@ -134,10 +139,18 @@ public final class KeywordSearchIngestModule implements IngestModuleAbstractFile
     //private constructor to ensure singleton instance 
     private KeywordSearchIngestModule() {
         //set default script 
-        stringExtractScripts.add(SCRIPT.LATIN_1);
         
-        stringExtractOptions.put(AbstractFileExtract.ExtractOptions.EXTRACT_UTF8.toString(), Boolean.TRUE.toString());
+     if(ModuleSettings.getConfigSetting(PROP_OPTIONS, AbstractFileExtract.ExtractOptions.EXTRACT_UTF8.toString()) == null){
+         stringExtractOptions.put(AbstractFileExtract.ExtractOptions.EXTRACT_UTF8.toString(), Boolean.TRUE.toString());
+     }
+     if(ModuleSettings.getConfigSetting(PROP_SCRIPTS, SCRIPT.LATIN_1.name()) == null){
+        ModuleSettings.setConfigSetting(PROP_SCRIPTS, SCRIPT.LATIN_1.name(), Boolean.toString(true));
+        stringExtractScripts.add(SCRIPT.LATIN_1);
+     }
+     if(ModuleSettings.getConfigSetting(PROP_OPTIONS, AbstractFileExtract.ExtractOptions.EXTRACT_UTF16.toString()) == null){
         stringExtractOptions.put(AbstractFileExtract.ExtractOptions.EXTRACT_UTF16.toString(), Boolean.TRUE.toString());
+     }
+     
     }
 
     /**
@@ -354,11 +367,37 @@ public final class KeywordSearchIngestModule implements IngestModuleAbstractFile
         logger.log(Level.INFO, "init()");
         services = IngestServices.getDefault();
         initialized = false;
-
+        
         caseHandle = Case.getCurrentCase().getSleuthkitCase();
 
         ingester = Server.getIngester();
 
+        //use the settings files to set values
+        
+        //Grabbing skipKnown
+        if(! ModuleSettings.getConfigSettings(PROP_NSRL).isEmpty()){
+            skipKnown = Boolean.parseBoolean(ModuleSettings.getConfigSetting(PROP_NSRL, "SkipKnown"));
+        }
+        
+      
+        //populating stringExtractOptions
+        if(! ModuleSettings.getConfigSettings(PROP_OPTIONS).isEmpty()){
+            stringExtractOptions = ModuleSettings.getConfigSettings(PROP_OPTIONS);
+        }
+        
+        System.out.println("PRE-EMPTY TEST: SCRIPTS EXISTS?: " + ModuleSettings.configExists(PROP_SCRIPTS));
+        //populating stringExtractScripts
+        if(! ModuleSettings.getConfigSettings(PROP_SCRIPTS).isEmpty()){
+            System.out.println("POST-EMPTY TEST: CONFIG SCRIPTS EXISTS?: " + ModuleSettings.configExists(PROP_SCRIPTS));
+            System.out.println("CONFIG SCRIPTS VALUES: " + ModuleSettings.getConfigSettings(PROP_SCRIPTS).values().toString());
+            for(Map.Entry<String,String> kvp: ModuleSettings.getConfigSettings(PROP_SCRIPTS).entrySet()){
+                if(kvp.getKey() != null && Boolean.parseBoolean(kvp.getValue())){
+                   stringExtractScripts.add(SCRIPT.valueOf(kvp.getKey()));
+                }
+            }
+        }
+
+
         //initialize extractors
         stringExtractor = new AbstractFileStringExtract();
         stringExtractor.setScripts(stringExtractScripts);
@@ -1114,10 +1153,14 @@ public final class KeywordSearchIngestModule implements IngestModuleAbstractFile
      * reported by HashDB module
      */
     void setSkipKnown(boolean skip) {
-        this.skipKnown = skip;
+        ModuleSettings.setConfigSetting(PROP_NSRL, "SkipKnown", Boolean.toString(skip));
+        skipKnown = skip;
     }
 
     boolean getSkipKnown() {
+        if(ModuleSettings.getConfigSetting(PROP_NSRL, "SkipKnown") != null){
+            skipKnown = Boolean.parseBoolean(ModuleSettings.getConfigSetting(PROP_NSRL, "SkipKnown"));
+        }
         return skipKnown;
     }
 
@@ -1131,6 +1174,15 @@ public final class KeywordSearchIngestModule implements IngestModuleAbstractFile
     void setStringExtractScripts(List<SCRIPT> scripts) {
         this.stringExtractScripts.clear();
         this.stringExtractScripts.addAll(scripts);
+        
+        for(String s : ModuleSettings.getConfigSettings(PROP_SCRIPTS).keySet()){
+            if (! scripts.contains(SCRIPT.valueOf(s))){
+                ModuleSettings.setConfigSetting(PROP_SCRIPTS, s, "false");
+            }
+        }
+        for(SCRIPT s : stringExtractScripts){
+            ModuleSettings.setConfigSetting(PROP_SCRIPTS, s.name(), "true");
+        }
 
     }
 
@@ -1139,7 +1191,17 @@ public final class KeywordSearchIngestModule implements IngestModuleAbstractFile
      *
      * @return the list of currently used script
      */
-    List<SCRIPT> getStringExtractScripts() {
+    List<SCRIPT> getStringExtractScripts(){
+        if(ModuleSettings.getConfigSettings(PROP_SCRIPTS) != null && !ModuleSettings.getConfigSettings(PROP_SCRIPTS).isEmpty()){
+            List<SCRIPT> scripts = new ArrayList<SCRIPT>();
+            for(Map.Entry<String,String> kvp : ModuleSettings.getConfigSettings(PROP_SCRIPTS).entrySet()){
+                if(kvp.getValue().equals("true")){
+                    scripts.add(SCRIPT.valueOf(kvp.getKey()));
+                }
+            }
+            return scripts;
+        }
+        //if it failed, try to return the built-in list maintained by the singleton.
         return new ArrayList<SCRIPT>(this.stringExtractScripts);
     }
     
@@ -1150,6 +1212,7 @@ public final class KeywordSearchIngestModule implements IngestModuleAbstractFile
      */
     void setStringExtractOption(String key, String val) {
         this.stringExtractOptions.put(key, val);
+        ModuleSettings.setConfigSetting(PROP_OPTIONS, key, val);
     }
     
     /**
@@ -1158,12 +1221,13 @@ public final class KeywordSearchIngestModule implements IngestModuleAbstractFile
      * @return option string value, or empty string if the option is not set
      */
     String getStringExtractOption(String key) {
-        if (this.stringExtractOptions.containsKey(key)) {
-            return this.stringExtractOptions.get(key);
+        if (ModuleSettings.getConfigSetting(PROP_OPTIONS, key) != null){
+            return ModuleSettings.getConfigSetting(PROP_OPTIONS, key);
         }
         else {
-            return "";
+            return this.stringExtractOptions.get(key);
         }
+        
     }
     
 }

From c19e11603eaca5947346bf7aa8d77580108fa3df Mon Sep 17 00:00:00 2001
From: 0xNF <nflower@hpa-w7-df-vm2.basistech.net>
Date: Fri, 21 Sep 2012 15:58:06 -0400
Subject: [PATCH 3/4] Fixed typo

---
 .../autopsy/keywordsearch/KeywordSearchIngestModule.java        | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestModule.java b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestModule.java
index 66c689a040..af83e2f6d5 100644
--- a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestModule.java
+++ b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestModule.java
@@ -110,7 +110,7 @@ public final class KeywordSearchIngestModule implements IngestModuleAbstractFile
     private Indexer indexer;
     private Searcher currentSearcher;
     private Searcher finalSearcher;
-    private volatile boolean searcherDone = true; //mark as done, until it's initedf
+    private volatile boolean searcherDone = true; //mark as done, until it's inited
     private Map<Keyword, List<Long>> currentResults;
     private static final ReentrantReadWriteLock rwLock = new ReentrantReadWriteLock(true); //use fairness policy
     private static final Lock searcherLock = rwLock.writeLock();

From 08033cbf211969f42c9f4c2ea8f1f35571c5d5b6 Mon Sep 17 00:00:00 2001
From: 0xNF <nflower@hpa-w7-df-vm2.basistech.net>
Date: Fri, 21 Sep 2012 16:17:24 -0400
Subject: [PATCH 4/4] Add boolean parsing error catching.

---
 .../KeywordSearchIngestModule.java             | 18 +++++++++++++++---
 1 file changed, 15 insertions(+), 3 deletions(-)

diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestModule.java b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestModule.java
index af83e2f6d5..39d2f69a7a 100644
--- a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestModule.java
+++ b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestModule.java
@@ -376,7 +376,12 @@ public final class KeywordSearchIngestModule implements IngestModuleAbstractFile
         
         //Grabbing skipKnown
         if(! ModuleSettings.getConfigSettings(PROP_NSRL).isEmpty()){
+            try{
             skipKnown = Boolean.parseBoolean(ModuleSettings.getConfigSetting(PROP_NSRL, "SkipKnown"));
+             }
+          catch(Exception e){
+              Logger.getLogger(KeywordSearchIngestModule.class.getName()).log(Level.WARNING, "Could not parse boolean value from properties file.", e);
+          }
         }
         
       
@@ -385,16 +390,18 @@ public final class KeywordSearchIngestModule implements IngestModuleAbstractFile
             stringExtractOptions = ModuleSettings.getConfigSettings(PROP_OPTIONS);
         }
         
-        System.out.println("PRE-EMPTY TEST: SCRIPTS EXISTS?: " + ModuleSettings.configExists(PROP_SCRIPTS));
         //populating stringExtractScripts
         if(! ModuleSettings.getConfigSettings(PROP_SCRIPTS).isEmpty()){
-            System.out.println("POST-EMPTY TEST: CONFIG SCRIPTS EXISTS?: " + ModuleSettings.configExists(PROP_SCRIPTS));
-            System.out.println("CONFIG SCRIPTS VALUES: " + ModuleSettings.getConfigSettings(PROP_SCRIPTS).values().toString());
+          try{
             for(Map.Entry<String,String> kvp: ModuleSettings.getConfigSettings(PROP_SCRIPTS).entrySet()){
                 if(kvp.getKey() != null && Boolean.parseBoolean(kvp.getValue())){
                    stringExtractScripts.add(SCRIPT.valueOf(kvp.getKey()));
                 }
             }
+          }
+          catch(Exception e ){
+              Logger.getLogger(KeywordSearchIngestModule.class.getName()).log(Level.WARNING, "Could not parse boolean value from properties file.", e);
+          }
         }
 
 
@@ -1158,9 +1165,14 @@ public final class KeywordSearchIngestModule implements IngestModuleAbstractFile
     }
 
     boolean getSkipKnown() {
+        try{
         if(ModuleSettings.getConfigSetting(PROP_NSRL, "SkipKnown") != null){
             skipKnown = Boolean.parseBoolean(ModuleSettings.getConfigSetting(PROP_NSRL, "SkipKnown"));
         }
+         }
+          catch(Exception e ){
+              Logger.getLogger(KeywordSearchIngestModule.class.getName()).log(Level.WARNING, "Could not parse boolean value from properties file.", e);
+          }
         return skipKnown;
     }