From 3cc94caecad36f79488a8c9485de7a8dbfc96df3 Mon Sep 17 00:00:00 2001
From: adam-m <amalinowski@basistech.com>
Date: Fri, 24 Feb 2012 19:12:35 -0500
Subject: [PATCH] keyword search ingest: more granular cancellation

---
 .../KeywordSearchIngestService.java           | 56 ++++++++++---------
 1 file changed, 30 insertions(+), 26 deletions(-)

diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestService.java b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestService.java
index 3d028e05b6..cfdfb46196 100644
--- a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestService.java
+++ b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchIngestService.java
@@ -70,8 +70,7 @@ public final class KeywordSearchIngestService implements IngestServiceFsContent
     private volatile int messageID = 0;
     private volatile boolean finalRun = false;
     private SleuthkitCase caseHandle = null;
-    
-     // TODO: use a more robust method than checking file extension to determine
+    // TODO: use a more robust method than checking file extension to determine
     // whether to try a file
     // supported extensions list from http://www.lucidimagination.com/devzone/technical-articles/content-extraction-tika
     static final String[] ingestibleExtensions = {"tar", "jar", "zip", "bzip2",
@@ -81,8 +80,7 @@ public final class KeywordSearchIngestService implements IngestServiceFsContent
 
     public enum IngestStatus {
 
-        INGESTED, EXTRACTED_INGESTED, SKIPPED,
-    };
+        INGESTED, EXTRACTED_INGESTED, SKIPPED,};
     private Map<Long, IngestStatus> ingestStatus;
     private Map<String, List<FsContent>> reportedHits; //already reported hits
 
@@ -102,7 +100,7 @@ public final class KeywordSearchIngestService implements IngestServiceFsContent
             commit();
             commitIndex = false;
             indexChangeNotify();
-            
+
             updateKeywords();
             //start search if previous not running
             if (keywords != null && !keywords.isEmpty() && searcherDone) {
@@ -183,7 +181,7 @@ public final class KeywordSearchIngestService implements IngestServiceFsContent
         ingestStatus = new HashMap<Long, IngestStatus>();
 
         reportedHits = new HashMap<String, List<FsContent>>();
-        
+
         keywords = new ArrayList<Keyword>();
         keywordLists = new ArrayList<String>();
 
@@ -224,16 +222,17 @@ public final class KeywordSearchIngestService implements IngestServiceFsContent
     public boolean isConfigurable() {
         return true;
     }
-    
+
     @Override
-    public boolean hasBackgroundJobsRunning() {    
+    public boolean hasBackgroundJobsRunning() {
         if (searcher != null && searcherDone == false) {
-                return true;
+            return true;
+        } else {
+            return false;
         }
-        else return false;
-        
+
         //no need to check timer thread
-        
+
     }
 
     private void commit() {
@@ -290,37 +289,39 @@ public final class KeywordSearchIngestService implements IngestServiceFsContent
      */
     private void initKeywords() {
         KeywordSearchListsXML loader = KeywordSearchListsXML.getCurrent();
-        
+
         keywords.clear();
         keywordLists.clear();
-        
-        for(KeywordSearchList list : loader.getListsL()){
-            if(list.getUseForIngest())
+
+        for (KeywordSearchList list : loader.getListsL()) {
+            if (list.getUseForIngest()) {
                 keywordLists.add(list.getName());
-                keywords.addAll(list.getKeywords());
+            }
+            keywords.addAll(list.getKeywords());
         }
     }
-    
+
     /**
      * Retrieve the updated keyword search lists from the XML loader
      */
     private void updateKeywords() {
         KeywordSearchListsXML loader = KeywordSearchListsXML.getCurrent();
-        
+
         keywords.clear();
-        
-        for(String name : keywordLists) {
+
+        for (String name : keywordLists) {
             keywords.addAll(loader.getList(name).getKeywords());
         }
     }
-    
+
     List<String> getKeywordLists() {
         return keywordLists == null ? new ArrayList<String>() : keywordLists;
     }
-    
+
     void addToKeywordLists(String name) {
-        if(!keywordLists.contains(name))
+        if (!keywordLists.contains(name)) {
             keywordLists.add(name);
+        }
     }
 
     //CommitTimer wakes up every interval ms
@@ -510,6 +511,9 @@ public final class KeywordSearchIngestService implements IngestServiceFsContent
                     //write results to BB
                     Collection<BlackboardArtifact> newArtifacts = new ArrayList<BlackboardArtifact>(); //new artifacts to report
                     for (FsContent hitFile : newResults) {
+                        if (this.isCancelled()) {
+                            return null;
+                        }
                         Collection<KeywordWriteResult> written = del.writeToBlackBoard(hitFile);
                         for (KeywordWriteResult res : written) {
                             newArtifacts.add(res.getArtifact());
@@ -527,7 +531,7 @@ public final class KeywordSearchIngestService implements IngestServiceFsContent
                                 subjectSb.append(keyword);
                                 uniqueKey = keyword;
                             }
-                     
+
                             subjectSb.append(">");
                             //String uniqueKey = queryStr;
 
@@ -545,7 +549,7 @@ public final class KeywordSearchIngestService implements IngestServiceFsContent
                                     detailsSb.append("<br />");
                                 }
                             }
-              
+
                             //file
                             detailsSb.append("File: ");
                             detailsSb.append(hitFile.getParentPath()).append(hitFile.getName());