From 9dfe64a71aa5393c52dfcb553cc4b5f76e960a2d Mon Sep 17 00:00:00 2001
From: Eugene Livis <elivis@basistech.com>
Date: Fri, 15 Jul 2016 13:05:57 -0400
Subject: [PATCH] Code and comment cleanup

---
 .../keywordsearch/HighlightedText.java        | 33 +------------------
 .../KeywordSearchResultFactory.java           | 24 +-------------
 2 files changed, 2 insertions(+), 55 deletions(-)

diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/HighlightedText.java b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/HighlightedText.java
index 1ed1941a1b..8601349b97 100644
--- a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/HighlightedText.java
+++ b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/HighlightedText.java
@@ -298,47 +298,16 @@ class HighlightedText implements IndexedText, TextMarkupLookup {
 
         String highLightField = null;
 
-        //String highlightQuery = keywordHitQuery;
-
         if (isRegex) {
             highLightField = LuceneQuery.HIGHLIGHT_FIELD_REGEX;
-            //escape special lucene chars if not already escaped (if not a compound query)
-            //TODO a better way to mark it a compound highlight query
-            
-            // ELDEBUG:
-            //final String findSubstr = LuceneQuery.HIGHLIGHT_FIELD_REGEX + ":";
-            //if (!highlightQuery.contains(findSubstr)) {
-            //    highlightQuery = KeywordSearchUtil.escapeLuceneQuery(highlightQuery);
-            //}
         } else {
             highLightField = LuceneQuery.HIGHLIGHT_FIELD_LITERAL;
-            //escape special lucene chars always for literal queries query
-            //highlightQuery = KeywordSearchUtil.escapeLuceneQuery(highlightQuery);
         }
 
         SolrQuery q = new SolrQuery();
         q.setShowDebugInfo(DEBUG); //debug
 
-        /*String queryStr = null;
-
-        if (isRegex) {
-            StringBuilder sb = new StringBuilder();
-            sb.append(highLightField).append(":");
-            if (group) {
-                sb.append("\"");
-            }
-            sb.append(highlightQuery);
-            if (group) {
-                sb.append("\"");
-            }
-            queryStr = sb.toString();
-        } else {
-            //use default field, simplifies query
-            //always force grouping/quotes
-            queryStr = KeywordSearchUtil.quoteQuery(highlightQuery);
-        }*/
-
-        //q.setQuery(queryStr);
+        // input query has already been escaped
         q.setQuery(keywordHitQuery);
 
         String contentIdStr = Long.toString(this.objectId);
diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchResultFactory.java b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchResultFactory.java
index 9570336182..8afad89cfc 100644
--- a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchResultFactory.java
+++ b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/KeywordSearchResultFactory.java
@@ -247,7 +247,6 @@ class KeywordSearchResultFactory extends ChildFactory<KeyValueQueryContent> {
      * @return
      */
     private String getHighlightQuery(KeywordSearchQuery query, boolean literal_query, QueryResults queryResults, Content content) {
-        //String highlightQueryEscaped;
         StringBuilder highlightQuery = new StringBuilder();
         if (literal_query) {
             //literal, treat as non-regex, non-term component query
@@ -255,12 +254,9 @@ class KeywordSearchResultFactory extends ChildFactory<KeyValueQueryContent> {
         } else {
             //construct a Solr query using aggregated terms to get highlighting
             //the query is executed later on demand
-
             if (queryResults.getKeywords().size() == 1) {
                 //simple case, no need to process subqueries and do special escaping
                 Keyword term = queryResults.getKeywords().iterator().next();
-                //highlightQuery.append(term.toString());
-                //highlightQuery.append(LuceneQuery.HIGHLIGHT_FIELD_REGEX).append(":").append(KeywordSearchUtil.escapeLuceneQuery(term.toString()));
                 highlightQuery.append(LuceneQuery.HIGHLIGHT_FIELD_REGEX).append(":").append(KeywordSearchUtil.escapeLuceneQuery(term.getQuery()));
             } else {
                 //find terms for this content hit
@@ -277,33 +273,15 @@ class KeywordSearchResultFactory extends ChildFactory<KeyValueQueryContent> {
                 final int lastTerm = hitTerms.size() - 1;
                 int curTerm = 0;
                 for (Keyword term : hitTerms) {
-                    //escape subqueries, they shouldn't be escaped again later
-                    //StringBuilder currentKeywordQuery = new StringBuilder();
-                    //currentKeywordQuery.append(LuceneQuery.HIGHLIGHT_FIELD_REGEX).append(":").append(KeywordSearchUtil.escapeLuceneQuery(term));                    
-                    //highlightQuery.append(KeywordSearchUtil.quoteQuery(currentKeywordQuery.toString()));
-                    
+                    //escape subqueries, MAKE SURE they are not escaped again later
                     highlightQuery.append(LuceneQuery.HIGHLIGHT_FIELD_REGEX).append(":").append("\"").append(KeywordSearchUtil.escapeLuceneQuery(term.getQuery())).append("\"");    
-                    
-                    /*final String termS = KeywordSearchUtil.escapeLuceneQuery(term);
-                    highlightQuery.append("\"");
-                    highlightQuery.append(termS);
-                    highlightQuery.append("\"");*/
-                    
-                    //highlightQuery.append(term);    // ELDEBUG
                     if (lastTerm != curTerm) {
                         highlightQuery.append(" "); //acts as OR ||
-                        //force HIGHLIGHT_FIELD_REGEX index and stored content
-                        //in each term after first. First term taken care by HighlightedMatchesSource
-                       
-                        //highlightQuery.append(LuceneQuery.HIGHLIGHT_FIELD_REGEX).append(":");
                     }
 
                     ++curTerm;
                 }
             }
-            //String highlightQueryEscaped = KeywordSearchUtil.escapeLuceneQuery(highlightQuery.toString());
-            
-            //highlightQueryEscaped = highlightQuery.toString();
         }
 
         return highlightQuery.toString();