Autopsy  4.8.0
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-2018 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 import org.openide.util.NbBundle;
32 
33 //This file contains constants and settings for KeywordSearch
34 class KeywordSearchSettings {
35 
36  public static final String MODULE_NAME = NbBundle.getMessage(KeywordSearchSettings.class, "KeywordSearchSettings.moduleName.text");
37  static final String PROPERTIES_OPTIONS = NbBundle.getMessage(KeywordSearchSettings.class, "KeywordSearchSettings.properties_options.text", MODULE_NAME);
38  static final String PROPERTIES_NSRL = NbBundle.getMessage(KeywordSearchSettings.class, "KeywordSearchSettings.propertiesNSRL.text", MODULE_NAME);
39  static final String PROPERTIES_SCRIPTS = NbBundle.getMessage(KeywordSearchSettings.class, "KeywordSearchSettings.propertiesScripts.text", MODULE_NAME);
40  static final String SHOW_SNIPPETS = "showSnippets"; //NON-NLS
41  static final boolean DEFAULT_SHOW_SNIPPETS = true;
42  static final String OCR_ENABLED = "ocrEnabled"; //NON-NLS
43  static final boolean OCR_ENABLED_DEFAULT = false; // NON-NLS
44  private static boolean skipKnown = true;
45  private static final Logger logger = Logger.getLogger(KeywordSearchSettings.class.getName());
46  private static UpdateFrequency UpdateFreq = UpdateFrequency.DEFAULT;
47  private static List<StringExtract.StringExtractUnicodeTable.SCRIPT> stringExtractScripts = new ArrayList<>();
48  private static Map<String, String> stringExtractOptions = new HashMap<>();
49 
55  static UpdateFrequency getUpdateFrequency() {
56  if (ModuleSettings.getConfigSetting(PROPERTIES_OPTIONS, "UpdateFrequency") != null) { //NON-NLS
57  return UpdateFrequency.valueOf(ModuleSettings.getConfigSetting(PROPERTIES_OPTIONS, "UpdateFrequency")); //NON-NLS
58  }
59  //if it failed, return the default/last known value
60  logger.log(Level.WARNING, "Could not read property for UpdateFrequency, returning backup value."); //NON-NLS
61  return UpdateFrequency.DEFAULT;
62  }
63 
69  static void setUpdateFrequency(UpdateFrequency freq) {
70  ModuleSettings.setConfigSetting(PROPERTIES_OPTIONS, "UpdateFrequency", freq.name()); //NON-NLS
71  UpdateFreq = freq;
72  }
73 
80  static void setSkipKnown(boolean skip) {
81  ModuleSettings.setConfigSetting(PROPERTIES_NSRL, "SkipKnown", Boolean.toString(skip)); //NON-NLS
82  skipKnown = skip;
83  }
84 
91  static boolean getSkipKnown() {
92  if (ModuleSettings.getConfigSetting(PROPERTIES_NSRL, "SkipKnown") != null) { //NON-NLS
93  return Boolean.parseBoolean(ModuleSettings.getConfigSetting(PROPERTIES_NSRL, "SkipKnown")); //NON-NLS
94  }
95  //if it fails, return the default/last known value
96  logger.log(Level.WARNING, "Could not read property for SkipKnown, returning backup value."); //NON-NLS
97  return skipKnown;
98  }
99 
105  static void setStringExtractScripts(List<StringExtract.StringExtractUnicodeTable.SCRIPT> scripts) {
106  stringExtractScripts.clear();
107  stringExtractScripts.addAll(scripts);
108 
109  //Disabling scripts that weren't selected
110  for (String s : ModuleSettings.getConfigSettings(PROPERTIES_SCRIPTS).keySet()) {
111  if (!scripts.contains(StringExtract.StringExtractUnicodeTable.SCRIPT.valueOf(s))) {
112  ModuleSettings.setConfigSetting(PROPERTIES_SCRIPTS, s, "false"); //NON-NLS
113  }
114  }
115  //Writing and enabling selected scripts
116  for (StringExtract.StringExtractUnicodeTable.SCRIPT s : stringExtractScripts) {
117  ModuleSettings.setConfigSetting(PROPERTIES_SCRIPTS, s.name(), "true"); //NON-NLS
118  }
119 
120  }
121 
128  static void setStringExtractOption(String key, String val) {
129  stringExtractOptions.put(key, val);
130  ModuleSettings.setConfigSetting(PROPERTIES_OPTIONS, key, val);
131  }
132 
138  static void setOcrOption(boolean enabled) {
139  ModuleSettings.setConfigSetting(PROPERTIES_OPTIONS, OCR_ENABLED, (enabled ? "true" : "false")); //NON-NLS
140  }
141 
147  static boolean getOcrOption() {
148  if (ModuleSettings.settingExists(PROPERTIES_OPTIONS, OCR_ENABLED)) {
149  return ModuleSettings.getConfigSetting(PROPERTIES_OPTIONS, OCR_ENABLED).equals("true"); //NON-NLS
150  } else {
151  return OCR_ENABLED_DEFAULT;
152  }
153  }
154 
155  static void setShowSnippets(boolean showSnippets) {
156  ModuleSettings.setConfigSetting(PROPERTIES_OPTIONS, SHOW_SNIPPETS, (showSnippets ? "true" : "false")); //NON-NLS
157  }
158 
159  static boolean getShowSnippets() {
160  if (ModuleSettings.settingExists(PROPERTIES_OPTIONS, SHOW_SNIPPETS)) {
161  return ModuleSettings.getConfigSetting(PROPERTIES_OPTIONS, SHOW_SNIPPETS).equals("true"); //NON-NLS
162  } else {
163  return DEFAULT_SHOW_SNIPPETS;
164  }
165  }
166 
172  static List<SCRIPT> getStringExtractScripts() {
173  if (ModuleSettings.getConfigSettings(PROPERTIES_SCRIPTS) != null && !ModuleSettings.getConfigSettings(PROPERTIES_SCRIPTS).isEmpty()) {
174  List<SCRIPT> scripts = new ArrayList<>();
175  for (Map.Entry<String, String> kvp : ModuleSettings.getConfigSettings(PROPERTIES_SCRIPTS).entrySet()) {
176  if (kvp.getValue().equals("true")) { //NON-NLS
177  scripts.add(SCRIPT.valueOf(kvp.getKey()));
178  }
179  }
180  return scripts;
181  }
182  //if it failed, try to return the built-in list maintained by the singleton.
183  logger.log(Level.WARNING, "Could not read properties for extracting scripts, returning backup values."); //NON-NLS
184  return new ArrayList<>(stringExtractScripts);
185  }
186 
194  static String getStringExtractOption(String key) {
195  if (ModuleSettings.getConfigSetting(PROPERTIES_OPTIONS, key) != null) {
196  return ModuleSettings.getConfigSetting(PROPERTIES_OPTIONS, key);
197  } else {
198  logger.log(Level.WARNING, "Could not read property for key {0}, returning backup value.", key); //NON-NLS
199  return stringExtractOptions.get(key);
200  }
201  }
202 
208  static Map<String, String> getStringExtractOptions() {
209  Map<String, String> settings = ModuleSettings.getConfigSettings(PROPERTIES_OPTIONS);
210  if (settings == null) {
211  Map<String, String> settingsv2 = new HashMap<>();
212  logger.log(Level.WARNING, "Could not read properties for {0}.properties, returning backup values", PROPERTIES_OPTIONS); //NON-NLS
213  settingsv2.putAll(stringExtractOptions);
214  return settingsv2;
215  } else {
216  return settings;
217  }
218  }
219 
224  static void setDefaults() {
225  logger.log(Level.INFO, "Detecting default settings."); //NON-NLS
226  //setting default NSRL
227  if (!ModuleSettings.settingExists(KeywordSearchSettings.PROPERTIES_NSRL, "SkipKnown")) { //NON-NLS
228  logger.log(Level.INFO, "No configuration for NSRL found, generating default..."); //NON-NLS
229  KeywordSearchSettings.setSkipKnown(true);
230  }
231  //setting default Update Frequency
232  if (!ModuleSettings.settingExists(KeywordSearchSettings.PROPERTIES_OPTIONS, "UpdateFrequency")) { //NON-NLS
233  logger.log(Level.INFO, "No configuration for Update Frequency found, generating default..."); //NON-NLS
234  KeywordSearchSettings.setUpdateFrequency(UpdateFrequency.DEFAULT);
235  }
236  //setting default Extract UTF8
237  if (!ModuleSettings.settingExists(KeywordSearchSettings.PROPERTIES_OPTIONS, StringsTextExtractor.ExtractOptions.EXTRACT_UTF8.toString())) {
238  logger.log(Level.INFO, "No configuration for UTF8 found, generating default..."); //NON-NLS
239  KeywordSearchSettings.setStringExtractOption(StringsTextExtractor.ExtractOptions.EXTRACT_UTF8.toString(), Boolean.TRUE.toString());
240  }
241  //setting default Extract UTF16
242  if (!ModuleSettings.settingExists(KeywordSearchSettings.PROPERTIES_OPTIONS, StringsTextExtractor.ExtractOptions.EXTRACT_UTF16.toString())) {
243  logger.log(Level.INFO, "No configuration for UTF16 found, generating defaults..."); //NON-NLS
244  KeywordSearchSettings.setStringExtractOption(StringsTextExtractor.ExtractOptions.EXTRACT_UTF16.toString(), Boolean.TRUE.toString());
245  }
246  //setting OCR default (disabled by default)
247  if (!ModuleSettings.settingExists(KeywordSearchSettings.PROPERTIES_OPTIONS, OCR_ENABLED)) {
248  logger.log(Level.INFO, "No configuration for OCR found, generating defaults..."); //NON-NLS
249  KeywordSearchSettings.setOcrOption(OCR_ENABLED_DEFAULT);
250  }
251  //setting default Latin-1 Script
252  if (!ModuleSettings.settingExists(KeywordSearchSettings.PROPERTIES_SCRIPTS, SCRIPT.LATIN_1.name())) {
253  logger.log(Level.INFO, "No configuration for Scripts found, generating defaults..."); //NON-NLS
254  ModuleSettings.setConfigSetting(KeywordSearchSettings.PROPERTIES_SCRIPTS, SCRIPT.LATIN_1.name(), Boolean.toString(true));
255  }
256  }
257 }

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