Autopsy  3.1
Graphical digital forensics platform for The Sleuth Kit and other tools.
KeywordSearchSettings.java
Go to the documentation of this file.
1 /*
2  * Autopsy Forensic Browser
3  *
4  * Copyright 2012-2014 Basis Technology Corp.
5  * Contact: carrier <at> sleuthkit <dot> org
6  *
7  * Licensed under the Apache License, Version 2.0 (the "License");
8  * you may not use this file except in compliance with the License.
9  * You may obtain a copy of the License at
10  *
11  * http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing, software
14  * distributed under the License is distributed on an "AS IS" BASIS,
15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
16  * See the License for the specific language governing permissions and
17  * limitations under the License.
18  */
19 package org.sleuthkit.autopsy.keywordsearch;
20 
21 import java.util.ArrayList;
22 import java.util.HashMap;
23 import java.util.List;
24 import java.util.Map;
25 import java.util.logging.Level;
26 
27 import org.openide.util.NbBundle;
33 
34 //This file contains constants and settings for KeywordSearch
35 class KeywordSearchSettings {
36 
37  public static final String MODULE_NAME = NbBundle.getMessage(KeywordSearchSettings.class, "KeywordSearchSettings.moduleName.text");
38  static final String PROPERTIES_OPTIONS = NbBundle.getMessage(KeywordSearchSettings.class, "KeywordSearchSettings.properties_options.text", MODULE_NAME);
39  static final String PROPERTIES_NSRL = NbBundle.getMessage(KeywordSearchSettings.class, "KeywordSearchSettings.propertiesNSRL.text", MODULE_NAME);
40  static final String PROPERTIES_SCRIPTS = NbBundle.getMessage(KeywordSearchSettings.class, "KeywordSearchSettings.propertiesScripts.text", MODULE_NAME);
41  static final String SHOW_SNIPPETS = "showSnippets"; //NON-NLS
42  static final boolean DEFAULT_SHOW_SNIPPETS = true;
43  private static boolean skipKnown = true;
44  private static final Logger logger = Logger.getLogger(KeywordSearchSettings.class.getName());
45  private static UpdateFrequency UpdateFreq = UpdateFrequency.DEFAULT;
46  private static List<StringExtract.StringExtractUnicodeTable.SCRIPT> stringExtractScripts = new ArrayList<>();
47  private static Map<String, String> stringExtractOptions = new HashMap<>();
48 
54  static UpdateFrequency getUpdateFrequency() {
55  if (ModuleSettings.getConfigSetting(PROPERTIES_OPTIONS, "UpdateFrequency") != null) { //NON-NLS
56  return UpdateFrequency.valueOf(ModuleSettings.getConfigSetting(PROPERTIES_OPTIONS, "UpdateFrequency")); //NON-NLS
57  }
58  //if it failed, return the default/last known value
59  logger.log(Level.WARNING, "Could not read property for UpdateFrequency, returning backup value."); //NON-NLS
60  return UpdateFrequency.DEFAULT;
61  }
62 
68  static void setUpdateFrequency(UpdateFrequency freq) {
69  ModuleSettings.setConfigSetting(PROPERTIES_OPTIONS, "UpdateFrequency", freq.name()); //NON-NLS
70  UpdateFreq = freq;
71  }
72 
79  static void setSkipKnown(boolean skip) {
80  ModuleSettings.setConfigSetting(PROPERTIES_NSRL, "SkipKnown", Boolean.toString(skip)); //NON-NLS
81  skipKnown = skip;
82  }
83 
90  static boolean getSkipKnown() {
91  if (ModuleSettings.getConfigSetting(PROPERTIES_NSRL, "SkipKnown") != null) { //NON-NLS
92  return Boolean.parseBoolean(ModuleSettings.getConfigSetting(PROPERTIES_NSRL, "SkipKnown")); //NON-NLS
93  }
94  //if it fails, return the default/last known value
95  logger.log(Level.WARNING, "Could not read property for SkipKnown, returning backup value."); //NON-NLS
96  return skipKnown;
97  }
98 
104  static void setStringExtractScripts(List<StringExtract.StringExtractUnicodeTable.SCRIPT> scripts) {
105  stringExtractScripts.clear();
106  stringExtractScripts.addAll(scripts);
107 
108  //Disabling scripts that weren't selected
109  for (String s : ModuleSettings.getConfigSettings(PROPERTIES_SCRIPTS).keySet()) {
110  if (!scripts.contains(StringExtract.StringExtractUnicodeTable.SCRIPT.valueOf(s))) {
111  ModuleSettings.setConfigSetting(PROPERTIES_SCRIPTS, s, "false"); //NON-NLS
112  }
113  }
114  //Writing and enabling selected scripts
115  for (StringExtract.StringExtractUnicodeTable.SCRIPT s : stringExtractScripts) {
116  ModuleSettings.setConfigSetting(PROPERTIES_SCRIPTS, s.name(), "true"); //NON-NLS
117  }
118 
119  }
120 
127  static void setStringExtractOption(String key, String val) {
128  stringExtractOptions.put(key, val);
129  ModuleSettings.setConfigSetting(PROPERTIES_OPTIONS, key, val);
130  }
131 
132  static void setShowSnippets(boolean showSnippets) {
133  ModuleSettings.setConfigSetting(PROPERTIES_OPTIONS, SHOW_SNIPPETS, (showSnippets ? "true" : "false")); //NON-NLS
134  }
135 
136  static boolean getShowSnippets() {
137  if (ModuleSettings.settingExists(PROPERTIES_OPTIONS, SHOW_SNIPPETS)) {
138  return ModuleSettings.getConfigSetting(PROPERTIES_OPTIONS, SHOW_SNIPPETS).equals("true"); //NON-NLS
139  } else {
140  return DEFAULT_SHOW_SNIPPETS;
141  }
142  }
143 
149  static List<SCRIPT> getStringExtractScripts() {
150  if (ModuleSettings.getConfigSettings(PROPERTIES_SCRIPTS) != null && !ModuleSettings.getConfigSettings(PROPERTIES_SCRIPTS).isEmpty()) {
151  List<SCRIPT> scripts = new ArrayList<>();
152  for (Map.Entry<String, String> kvp : ModuleSettings.getConfigSettings(PROPERTIES_SCRIPTS).entrySet()) {
153  if (kvp.getValue().equals("true")) { //NON-NLS
154  scripts.add(SCRIPT.valueOf(kvp.getKey()));
155  }
156  }
157  return scripts;
158  }
159  //if it failed, try to return the built-in list maintained by the singleton.
160  logger.log(Level.WARNING, "Could not read properties for extracting scripts, returning backup values."); //NON-NLS
161  return new ArrayList<>(stringExtractScripts);
162  }
163 
170  static String getStringExtractOption(String key) {
171  if (ModuleSettings.getConfigSetting(PROPERTIES_OPTIONS, key) != null) {
172  return ModuleSettings.getConfigSetting(PROPERTIES_OPTIONS, key);
173  } else {
174  logger.log(Level.WARNING, "Could not read property for key {0}, returning backup value.", key); //NON-NLS
175  return stringExtractOptions.get(key);
176  }
177  }
178 
184  static Map<String, String> getStringExtractOptions() {
185  Map<String, String> settings = ModuleSettings.getConfigSettings(PROPERTIES_OPTIONS);
186  if (settings == null) {
187  Map<String, String> settingsv2 = new HashMap<>();
188  logger.log(Level.WARNING, "Could not read properties for {0}.properties, returning backup values", PROPERTIES_OPTIONS); //NON-NLS
189  settingsv2.putAll(stringExtractOptions);
190  return settingsv2;
191  } else {
192  return settings;
193  }
194  }
195 
200  static void setDefaults() {
201  logger.log(Level.INFO, "Detecting default settings."); //NON-NLS
202  //setting default NSRL
203  if (!ModuleSettings.settingExists(KeywordSearchSettings.PROPERTIES_NSRL, "SkipKnown")) { //NON-NLS
204  logger.log(Level.INFO, "No configuration for NSRL found, generating default..."); //NON-NLS
205  KeywordSearchSettings.setSkipKnown(true);
206  }
207  //setting default Update Frequency
208  if (!ModuleSettings.settingExists(KeywordSearchSettings.PROPERTIES_OPTIONS, "UpdateFrequency")) { //NON-NLS
209  logger.log(Level.INFO, "No configuration for Update Frequency found, generating default..."); //NON-NLS
210  KeywordSearchSettings.setUpdateFrequency(UpdateFrequency.DEFAULT);
211  }
212  //setting default Extract UTF8
213  if (!ModuleSettings.settingExists(KeywordSearchSettings.PROPERTIES_OPTIONS, TextExtractor.ExtractOptions.EXTRACT_UTF8.toString())) {
214  logger.log(Level.INFO, "No configuration for UTF8 found, generating default..."); //NON-NLS
215  KeywordSearchSettings.setStringExtractOption(TextExtractor.ExtractOptions.EXTRACT_UTF8.toString(), Boolean.TRUE.toString());
216  }
217  //setting default Extract UTF16
218  if (!ModuleSettings.settingExists(KeywordSearchSettings.PROPERTIES_OPTIONS, TextExtractor.ExtractOptions.EXTRACT_UTF16.toString())) {
219  logger.log(Level.INFO, "No configuration for UTF16 found, generating defaults..."); //NON-NLS
220  KeywordSearchSettings.setStringExtractOption(TextExtractor.ExtractOptions.EXTRACT_UTF16.toString(), Boolean.TRUE.toString());
221  }
222  //setting default Latin-1 Script
223  if (!ModuleSettings.settingExists(KeywordSearchSettings.PROPERTIES_SCRIPTS, SCRIPT.LATIN_1.name())) {
224  logger.log(Level.INFO, "No configuration for Scripts found, generating defaults..."); //NON-NLS
225  ModuleSettings.setConfigSetting(KeywordSearchSettings.PROPERTIES_SCRIPTS, SCRIPT.LATIN_1.name(), Boolean.toString(true));
226  }
227  }
228 }

Copyright © 2012-2015 Basis Technology. Generated on: Mon Oct 19 2015
This work is licensed under a Creative Commons Attribution-Share Alike 3.0 United States License.