19 package org.sleuthkit.autopsy.core;
22 import java.io.FileInputStream;
23 import java.io.IOException;
24 import java.nio.file.Paths;
25 import java.util.Arrays;
26 import java.util.List;
27 import java.util.Properties;
29 import java.util.prefs.BackingStoreException;
31 import java.util.prefs.PreferenceChangeListener;
32 import org.apache.commons.lang3.StringUtils;
33 import org.apache.commons.lang3.tuple.Triple;
34 import org.openide.util.Lookup;
35 import org.python.icu.util.TimeZone;
80 private static final ConfigProperties
viewPreferences =
new ConfigProperties(VIEW_PREFERENCE_PATH);
82 private static final ConfigProperties
modePreferences =
new ConfigProperties(MODE_PREFERENCE_PATH);
90 viewPreferences.load();
91 machineSpecificPreferences.load();
92 modePreferences.load();
93 externalServicePreferences.load();
94 }
catch (IOException ex) {
135 private static final String
MODE =
"AutopsyMode";
165 KEEP_PREFERRED_VIEWER,
166 HIDE_KNOWN_FILES_IN_DATA_SRCS_TREE,
167 HIDE_KNOWN_FILES_IN_VIEWS_TREE,
168 HIDE_SLACK_FILES_IN_DATA_SRCS_TREE,
169 HIDE_SLACK_FILES_IN_VIEWS_TREE,
170 DISPLAY_TIMES_IN_LOCAL_TIME,
171 TIME_ZONE_FOR_DISPLAYS,
172 GROUP_ITEMS_IN_TREE_BY_DATASOURCE,
173 SHOW_ONLY_CURRENT_USER_TAGS,
175 DISPLAY_TRANSLATED_NAMES,
176 EXTERNAL_HEX_EDITOR_PATH,
177 RESULTS_TABLE_PAGE_SIZE
182 NUMBER_OF_FILE_INGEST_THREADS,
183 PROCESS_TIME_OUT_ENABLED,
184 PROCESS_TIME_OUT_HOURS,
187 HEALTH_MONITOR_REPORT_PATH,
189 GEO_OSM_TILE_ZIP_PATH,
190 GEO_MBTILES_FILE_PATH
202 IS_MULTI_USER_MODE_ENABLED,
204 OCR_TRANSLATION_ENABLED,
205 EXTERNAL_DATABASE_HOSTNAME_OR_IP,
206 EXTERNAL_DATABASE_PORTNUMBER,
207 EXTERNAL_DATABASE_NAME,
208 EXTERNAL_DATABASE_USER,
209 EXTERNAL_DATABASE_PASSWORD,
210 EXTERNAL_DATABASE_TYPE,
217 MESSAGE_SERVICE_PASSWORD,
218 MESSAGE_SERVICE_USER,
219 MESSAGE_SERVICE_HOST,
220 MESSAGE_SERVICE_PORT,
221 TEXT_TRANSLATOR_NAME,
222 GEO_OSM_SERVER_ADDRESS
227 static void updateConfig() {
228 List<Triple<File, ConfigProperties, List<String>>> fileAndKeys = Arrays.asList(
229 Triple.of(
new File(MODE_PREFERENCE_PATH), modePreferences, MODE_PREFERENCE_KEYS),
230 Triple.of(
new File(MACHINE_SPECIFIC_PREFERENCE_PATH), machineSpecificPreferences, MACHINE_PREFERENCE_KEYS),
231 Triple.of(
new File(VIEW_PREFERENCE_PATH), viewPreferences, VIEW_PREFERENCE_KEYS),
232 Triple.of(
new File(EXTERNAL_SERVICE_PREFERENCE_PATH), externalServicePreferences, EXTERNAL_SERVICE_KEYS)
235 boolean newSettingsExist = fileAndKeys.stream().anyMatch(triple -> triple.getLeft().exists());
237 File oldSettingsFile =
new File(LEGACY_CONFIG_PATH);
239 if (oldSettingsFile.exists() && !newSettingsExist) {
241 Properties allProperties =
new Properties();
242 try (FileInputStream oldPropsStream =
new FileInputStream(oldSettingsFile)) {
243 allProperties.load(oldPropsStream);
246 for (Triple<File, ConfigProperties, List<String>> fileKeys : fileAndKeys) {
247 ConfigProperties newProperties = fileKeys.getMiddle();
248 for (String key : fileKeys.getRight()) {
249 String val = allProperties.getProperty(key);
251 newProperties.put(key, val);
256 }
catch (IOException ex) {
260 ex.printStackTrace();
303 viewPreferences.sync();
304 machineSpecificPreferences.sync();
305 modePreferences.sync();
306 externalServicePreferences.sync();
317 viewPreferences.flush();
318 machineSpecificPreferences.flush();
319 modePreferences.flush();
320 externalServicePreferences.flush();
324 viewPreferences.addPreferenceChangeListener(listener);
325 machineSpecificPreferences.addPreferenceChangeListener(listener);
326 modePreferences.addPreferenceChangeListener(listener);
327 externalServicePreferences.addPreferenceChangeListener(listener);
331 viewPreferences.removePreferenceChangeListener(listener);
332 machineSpecificPreferences.removePreferenceChangeListener(listener);
333 modePreferences.removePreferenceChangeListener(listener);
334 externalServicePreferences.removePreferenceChangeListener(listener);
338 return viewPreferences.getBoolean(KEEP_PREFERRED_VIEWER,
false);
342 viewPreferences.putBoolean(KEEP_PREFERRED_VIEWER, value);
346 return viewPreferences.getBoolean(HIDE_KNOWN_FILES_IN_DATA_SRCS_TREE,
false);
350 viewPreferences.putBoolean(HIDE_KNOWN_FILES_IN_DATA_SRCS_TREE, value);
354 return viewPreferences.getBoolean(HIDE_KNOWN_FILES_IN_VIEWS_TREE,
true);
358 viewPreferences.putBoolean(HIDE_KNOWN_FILES_IN_VIEWS_TREE, value);
362 return viewPreferences.getBoolean(HIDE_SLACK_FILES_IN_DATA_SRCS_TREE,
true);
366 viewPreferences.putBoolean(HIDE_SLACK_FILES_IN_DATA_SRCS_TREE, value);
370 return viewPreferences.getBoolean(HIDE_SLACK_FILES_IN_VIEWS_TREE,
true);
374 viewPreferences.putBoolean(HIDE_SLACK_FILES_IN_VIEWS_TREE, value);
378 return viewPreferences.getBoolean(DISPLAY_TIMES_IN_LOCAL_TIME,
true);
382 viewPreferences.putBoolean(DISPLAY_TIMES_IN_LOCAL_TIME, value);
386 return viewPreferences.get(TIME_ZONE_FOR_DISPLAYS, TimeZone.GMT_ZONE.getID());
390 viewPreferences.put(TIME_ZONE_FOR_DISPLAYS, timeZone);
394 return machineSpecificPreferences.getInt(NUMBER_OF_FILE_INGEST_THREADS, 2);
398 machineSpecificPreferences.putInt(NUMBER_OF_FILE_INGEST_THREADS, value);
403 return viewPreferences.getBoolean(GROUP_ITEMS_IN_TREE_BY_DATASOURCE,
false);
408 viewPreferences.putBoolean(GROUP_ITEMS_IN_TREE_BY_DATASOURCE, value);
418 return viewPreferences.getBoolean(SHOW_ONLY_CURRENT_USER_TAGS,
false);
428 viewPreferences.putBoolean(SHOW_ONLY_CURRENT_USER_TAGS, value);
439 return viewPreferences.getBoolean(HIDE_SCO_COLUMNS,
false);
450 viewPreferences.putBoolean(HIDE_SCO_COLUMNS, value);
454 viewPreferences.putBoolean(DISPLAY_TRANSLATED_NAMES, value);
458 return viewPreferences.getBoolean(DISPLAY_TRANSLATED_NAMES, DISPLAY_TRANSLATED_NAMES_DEFAULT);
471 dbType = DbType.valueOf(externalServicePreferences.get(EXTERNAL_DATABASE_TYPE,
"POSTGRESQL"));
472 }
catch (Exception ex) {
473 dbType = DbType.SQLITE;
476 return new CaseDbConnectionInfo(
477 externalServicePreferences.get(EXTERNAL_DATABASE_HOSTNAME_OR_IP,
""),
478 externalServicePreferences.get(EXTERNAL_DATABASE_PORTNUMBER,
"5432"),
479 externalServicePreferences.get(EXTERNAL_DATABASE_USER,
""),
483 throw new UserPreferencesException(
"Failure converting password hex text to text.", ex);
496 externalServicePreferences.put(EXTERNAL_DATABASE_HOSTNAME_OR_IP, connectionInfo.getHost());
497 externalServicePreferences.put(EXTERNAL_DATABASE_PORTNUMBER, connectionInfo.getPort());
498 externalServicePreferences.put(EXTERNAL_DATABASE_USER, connectionInfo.getUserName());
504 externalServicePreferences.put(EXTERNAL_DATABASE_TYPE, connectionInfo.getDbType().toString());
508 externalServicePreferences.putBoolean(IS_MULTI_USER_MODE_ENABLED, enabled);
512 return isMultiUserSupported() && externalServicePreferences.getBoolean(IS_MULTI_USER_MODE_ENABLED,
false);
526 if (multiUserSupported == null) {
528 multiUserSupported = Lookup.getDefault().lookupAll(
AutopsyService.class).stream()
529 .anyMatch(obj -> obj.getClass().getName().equalsIgnoreCase(
"org.sleuthkit.autopsy.keywordsearch.SolrSearchService"));
536 return externalServicePreferences.get(SOLR8_SERVER_HOST,
"");
540 externalServicePreferences.put(SOLR8_SERVER_HOST, hostName);
544 return externalServicePreferences.get(SOLR8_SERVER_PORT,
"8983");
548 externalServicePreferences.putInt(SOLR8_SERVER_PORT, port);
552 return externalServicePreferences.get(SOLR4_SERVER_HOST,
"");
556 externalServicePreferences.put(SOLR4_SERVER_HOST, hostName);
560 return externalServicePreferences.get(SOLR4_SERVER_PORT,
"");
564 externalServicePreferences.put(SOLR4_SERVER_PORT, port);
568 return externalServicePreferences.get(ZK_SERVER_HOST,
"");
572 externalServicePreferences.put(ZK_SERVER_HOST, hostName);
576 return externalServicePreferences.get(ZK_SERVER_PORT,
"9983");
580 externalServicePreferences.put(ZK_SERVER_PORT, port);
584 externalServicePreferences.put(TEXT_TRANSLATOR_NAME, textTranslatorName);
588 return externalServicePreferences.get(TEXT_TRANSLATOR_NAME, null);
592 externalServicePreferences.putBoolean(OCR_TRANSLATION_ENABLED, enableOcr);
596 return externalServicePreferences.getBoolean(OCR_TRANSLATION_ENABLED,
true);
607 externalServicePreferences.put(MESSAGE_SERVICE_HOST, info.getHost());
608 externalServicePreferences.put(MESSAGE_SERVICE_PORT, Integer.toString(info.getPort()));
609 externalServicePreferences.put(MESSAGE_SERVICE_USER, info.getUserName());
627 port = Integer.parseInt(externalServicePreferences.get(MESSAGE_SERVICE_PORT, DEFAULT_PORT_STRING));
628 }
catch (NumberFormatException ex) {
635 externalServicePreferences.get(MESSAGE_SERVICE_HOST,
""),
637 externalServicePreferences.get(MESSAGE_SERVICE_USER,
""),
640 throw new UserPreferencesException(
"Failed to convert password hex text to text.", ex);
650 int timeOut = machineSpecificPreferences.getInt(PROCESS_TIME_OUT_HOURS, DEFAULT_PROCESS_TIMEOUT_HR);
666 machineSpecificPreferences.putInt(PROCESS_TIME_OUT_HOURS, value);
677 boolean enabled = machineSpecificPreferences.getBoolean(PROCESS_TIME_OUT_ENABLED,
false);
689 machineSpecificPreferences.putBoolean(PROCESS_TIME_OUT_ENABLED, enabled);
707 modePreferences.put(APP_NAME, name);
716 return machineSpecificPreferences.getInt(MAX_NUM_OF_LOG_FILE, LOG_FILE_NUM_INT);
734 machineSpecificPreferences.putInt(MAX_NUM_OF_LOG_FILE, count);
746 return machineSpecificPreferences.getInt(SOLR_MAX_JVM_SIZE, DEFAULT_SOLR_HEAP_SIZE_MB_64BIT_PLATFORM);
748 return machineSpecificPreferences.getInt(SOLR_MAX_JVM_SIZE, DEFAULT_SOLR_HEAP_SIZE_MB_32BIT_PLATFORM);
758 machineSpecificPreferences.putInt(SOLR_MAX_JVM_SIZE, maxSize);
767 return viewPreferences.getInt(RESULTS_TABLE_PAGE_SIZE, 10_000);
776 viewPreferences.putInt(RESULTS_TABLE_PAGE_SIZE, pageSize);
785 viewPreferences.put(EXTERNAL_HEX_EDITOR_PATH, executablePath);
795 return viewPreferences.get(EXTERNAL_HEX_EDITOR_PATH, Paths.get(
"C:",
"Program Files",
"HxD",
"HxD.exe").toString());
804 externalServicePreferences.putInt(GEO_TILE_OPTION, option);
814 return externalServicePreferences.getInt(GEO_TILE_OPTION, 0);
823 machineSpecificPreferences.put(GEO_OSM_TILE_ZIP_PATH, absolutePath);
833 return machineSpecificPreferences.get(GEO_OSM_TILE_ZIP_PATH,
"");
843 externalServicePreferences.put(GEO_OSM_SERVER_ADDRESS, address);
852 return externalServicePreferences.get(GEO_OSM_SERVER_ADDRESS,
"");
861 machineSpecificPreferences.put(GEO_MBTILES_FILE_PATH, absolutePath);
870 return machineSpecificPreferences.get(GEO_MBTILES_FILE_PATH,
"");
889 File appTempDir = null;
893 appTempDir = (StringUtils.isBlank(customDirectory))
895 : Paths.get(customDirectory,
getAppName(), TEMP_FOLDER).toFile();
907 if (!appTempDir.exists()) {
911 return appTempDir.getAbsolutePath();
920 machineSpecificPreferences.put(HEALTH_MONITOR_REPORT_PATH, reportPath);
930 return machineSpecificPreferences.get(HEALTH_MONITOR_REPORT_PATH,
"");
static void setZkServerHost(String hostName)
static synchronized String getConfigSetting(String moduleName, String settingName)
static boolean getUseOcrInTranslation()
static final String HIDE_SLACK_FILES_IN_VIEWS_TREE
static int getDefaultLogFileCount()
static void setGroupItemsInTreeByDatasource(boolean value)
static final ConfigProperties externalServicePreferences
static final ConfigProperties viewPreferences
static final boolean DISPLAY_TRANSLATED_NAMES_DEFAULT
static String getGeolocationOsmZipPath()
static final String HIDE_KNOWN_FILES_IN_VIEWS_TREE
static void setProcessTimeOutHrs(int value)
static void setZkServerPort(String port)
static final String VIEW_PREFERENCE_PATH
static void setKeepPreferredContentViewer(boolean value)
static String getExternalHexEditorPath()
static String getAppTempDirectory()
static int getProcessTimeOutHrs()
static String getSolr4ServerPort()
static String getTextTranslatorName()
static final String HIDE_SCO_COLUMNS
static boolean hideSlackFilesInDataSourcesTree()
static final List< String > EXTERNAL_SERVICE_KEYS
static final String LEGACY_CONFIG_PATH
static final int DEFAULT_PROCESS_TIMEOUT_HR
static String getIndexingServerPort()
static String getZkServerPort()
static final String SOLR_MAX_JVM_SIZE
static final String GROUP_ITEMS_IN_TREE_BY_DATASOURCE
static void setNumberOfFileIngestThreads(int value)
static String getAppName()
static void reloadFromStorage()
static void setGeolocationTileOption(int option)
static void setDisplayTimesInLocalTime(boolean value)
static final String EXTERNAL_DATABASE_NAME
static Boolean multiUserSupported
static final String EXTERNAL_DATABASE_USER
static int getLogFileCount()
static final String TEXT_TRANSLATOR_NAME
static void setMode(SelectedMode mode)
static final String GEO_OSM_TILE_ZIP_PATH
static boolean groupItemsInTreeByDatasource()
static final ConfigProperties modePreferences
static final String DEFAULT_PORT_STRING
static void setUseOcrInTranslation(boolean enableOcr)
static boolean getIsMultiUserModeEnabled()
static void setHideSlackFilesInViewsTree(boolean value)
static void setHealthMonitorReportPath(String reportPath)
static String getCustomTempDirectory()
static final ConfigProperties machineSpecificPreferences
static CaseDbConnectionInfo getDatabaseConnectionInfo()
static final String SHOW_ONLY_CURRENT_USER_TAGS
static boolean keepPreferredContentViewer()
static String getZkServerHost()
static boolean hideKnownFilesInViewsTree()
static void setHideSCOColumns(boolean value)
static void setIsTimeOutEnabled(boolean enabled)
static final List< String > MODE_PREFERENCE_KEYS
static void setMaxSolrVMSize(int maxSize)
static void setSolr4ServerPort(String port)
static void setResultsTablePageSize(int pageSize)
static String getGeolocationMBTilesFilePath()
static final String HIDE_KNOWN_FILES_IN_DATA_SRCS_TREE
static int getMaxSolrVMSize()
static final String EXTERNAL_HEX_EDITOR_PATH
static void setIsMultiUserModeEnabled(boolean enabled)
static final String SETTINGS_PROPERTIES
static void removeChangeListener(PreferenceChangeListener listener)
static final List< String > VIEW_PREFERENCE_KEYS
static void setMessageServiceConnectionInfo(MessageServiceConnectionInfo info)
static synchronized boolean settingExists(String moduleName, String settingName)
static final String IS_MULTI_USER_MODE_ENABLED
static final String NUMBER_OF_FILE_INGEST_THREADS
static boolean showOnlyCurrentUserTags()
static final String MODE_PREFERENCE_PATH
static final int DEFAULT_SOLR_HEAP_SIZE_MB_64BIT_PLATFORM
static void setHideKnownFilesInViewsTree(boolean value)
static boolean getIsTimeOutEnabled()
static int numberOfFileIngestThreads()
static final String DISPLAY_TIMES_IN_LOCAL_TIME
static void setTextTranslatorName(String textTranslatorName)
static final String SOLR8_SERVER_PORT
static void setAppName(String name)
static final String OCR_TRANSLATION_ENABLED
static boolean displayTranslatedFileNames()
static String getHealthMonitorReportPath()
static final int DEFAULT_PORT_INT
static void setDatabaseConnectionInfo(CaseDbConnectionInfo connectionInfo)
static final String EXTERNAL_DATABASE_PORTNUMBER
static final String PROCESS_TIME_OUT_ENABLED
static void setTimeZoneForDisplays(String timeZone)
static final String KEEP_PREFERRED_VIEWER
static File getSystemTempDirFile()
static synchronized void setConfigSetting(String moduleName, String settingName, String settingVal)
static final String SOLR8_SERVER_HOST
static final String RESULTS_TABLE_PAGE_SIZE
static final String GEO_MBTILES_FILE_PATH
static final String MESSAGE_SERVICE_PORT
static void saveToStorage()
static void setIndexingServerHost(String hostName)
static final String EXTERNAL_SERVICE_PREFERENCE_PATH
static void setDisplayTranslatedFileNames(boolean value)
static final String SOLR4_SERVER_PORT
static final String DISPLAY_TRANSLATED_NAMES
static final String MESSAGE_SERVICE_PASSWORD
static boolean getHideSCOColumns()
static boolean hideSlackFilesInViewsTree()
static String getSolr4ServerHost()
static final String HIDE_SLACK_FILES_IN_DATA_SRCS_TREE
static int getGeolocationtTileOption()
static final String ZK_SERVER_PORT
static void setHideSlackFilesInDataSourcesTree(boolean value)
static void setHideKnownFilesInDataSourcesTree(boolean value)
static void setIndexingServerPort(int port)
static void setGeolocationOsmZipPath(String absolutePath)
static final String PROCESS_TIME_OUT_HOURS
static void setLogFileCount(int count)
static final int LOG_FILE_NUM_INT
static final int DEFAULT_SOLR_HEAP_SIZE_MB_32BIT_PLATFORM
static String getSharedPreferencePath(String identifier)
static TempDirChoice getTempDirChoice()
static final String TEMP_FOLDER
static final String MESSAGE_SERVICE_HOST
static final String APP_NAME
static int getResultsTablePageSize()
static String getGeolocationOsmServerAddress()
static boolean isMultiUserSupported()
static boolean hideKnownFilesInDataSourcesTree()
static String getTimeZoneForDisplays()
static void setExternalHexEditorPath(String executablePath)
static final String MESSAGE_SERVICE_USER
static final String HEALTH_MONITOR_REPORT_PATH
static final String GEO_TILE_OPTION
static void addChangeListener(PreferenceChangeListener listener)
static final String ZK_SERVER_HOST
static final String EXTERNAL_DATABASE_TYPE
static final List< String > MACHINE_PREFERENCE_KEYS
static void setGeolocationMBTilesFilePath(String absolutePath)
static void setSolr4ServerHost(String hostName)
static void setShowOnlyCurrentUserTags(boolean value)
static String convertTextToHexText(String property)
static final String GEO_OSM_SERVER_ADDRESS
static void setGeolocationOsmServerAddress(String address)
static SelectedMode getMode()
static String getIndexingServerHost()
static final String TIME_ZONE_FOR_DISPLAYS
static boolean displayTimesInLocalTime()
static final String EXTERNAL_DATABASE_PASSWORD
static final String SOLR4_SERVER_HOST
static final String MAX_NUM_OF_LOG_FILE
static final String EXTERNAL_DATABASE_HOSTNAME_OR_IP
static final String MACHINE_SPECIFIC_PREFERENCE_PATH
static String getConfigPreferencePath(String identifier)
static MessageServiceConnectionInfo getMessageServiceConnectionInfo()
static String convertHexTextToText(String property)