ModuleSettings.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011 Basis Technology Corp.
 * Contact: carrier <at> sleuthkit <dot> org
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.sleuthkit.autopsy.coreutils;

import java.io.File;
import java.io.FileInputStream;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;
import java.util.Properties;
import java.util.Set;
import java.util.logging.Level;

public class ModuleSettings {

    // The directory where the properties file is located
    private final static String moduleDirPath = PlatformUtil.getUserConfigDirectory();
    public static final String DEFAULT_CONTEXT = "GeneralContext"; //NON-NLS
    public static final String MAIN_SETTINGS = "Case"; //NON-NLS

    private ModuleSettings() {}

    public static boolean makeConfigFile(String moduleName){
        if(!configExists(moduleName)){
            File propPath = new File(moduleDirPath + File.separator + moduleName + ".properties");
            File parent = new File(propPath.getParent());
            if(! parent.exists()){
                parent.mkdirs();
            }
            Properties props = new Properties();
            try{
            propPath.createNewFile();
            FileOutputStream fos = new FileOutputStream(propPath);
            props.store(fos, "");
            fos.close();
            }
            catch(IOException e){
                Logger.getLogger(ModuleSettings.class.getName()).log(Level.WARNING, "Was not able to create a new properties file.", e); //NON-NLS
                return false;
            }
            return true;
        }
        return false;
    }
    
    
    public static boolean configExists(String moduleName){
        File f = new File(moduleDirPath + File.separator + moduleName + ".properties");
        return f.exists();
    }
    
    public static boolean settingExists(String moduleName, String settingName){
        if(! configExists(moduleName)){
            return false;
        }
        try{
            Properties props = fetchProperties(moduleName);
            return (props.getProperty(settingName) != null);
        }
        catch(IOException e){
            return false;
        }
        
    }
    
    private static String getPropertyPath(String moduleName){
        if(configExists(moduleName)){
            return moduleDirPath + File.separator + moduleName + ".properties"; //NON-NLS
        }
        
        return null;
    }
   
    public static String getConfigSetting(String moduleName, String settingName) {
        if (!configExists(moduleName)) {
            makeConfigFile(moduleName);
            Logger.getLogger(ModuleSettings.class.getName()).log(Level.INFO, "File did not exist. Created file [" + moduleName + ".properties]"); //NON-NLS NON-NLS
        }

        try {
            Properties props = fetchProperties(moduleName);

            return props.getProperty(settingName);
        } catch (IOException e) {
            Logger.getLogger(ModuleSettings.class.getName()).log(Level.WARNING, "Could not read config file [" + moduleName + "]", e); //NON-NLS
            return null;
        }

    }
       
    
    public static Map< String, String> getConfigSettings(String moduleName) {

        if (!configExists(moduleName)) {
            makeConfigFile(moduleName);
            Logger.getLogger(ModuleSettings.class.getName()).log(Level.INFO, "File did not exist. Created file [" + moduleName + ".properties]"); //NON-NLS NON-NLS
        }
        try {
            Properties props = fetchProperties(moduleName);

            Set<String> keys = props.stringPropertyNames();
            Map<String, String> map = new HashMap<String, String>();

            for (String s : keys) {
                map.put(s, props.getProperty(s));
            }

            return map;
        } catch (IOException e) {
            Logger.getLogger(ModuleSettings.class.getName()).log(Level.WARNING, "Could not read config file [" + moduleName + "]", e); //NON-NLS
            return null;
        }
    }

    public static synchronized void setConfigSettings(String moduleName, Map<String, String> settings) {
        if (!configExists(moduleName)) {
            makeConfigFile(moduleName);
            Logger.getLogger(ModuleSettings.class.getName()).log(Level.INFO, "File did not exist. Created file [" + moduleName + ".properties]"); //NON-NLS NON-NLS
        }
        try {
            Properties props = fetchProperties(moduleName);

            for (Map.Entry<String, String> kvp : settings.entrySet()) {
                props.setProperty(kvp.getKey(), kvp.getValue());
            }

            File path = new File(getPropertyPath(moduleName));
            FileOutputStream fos = new FileOutputStream(path);
            props.store(fos, "Changed config settings(batch)"); //NON-NLS
            fos.close();
        } catch (IOException e) {
            Logger.getLogger(ModuleSettings.class.getName()).log(Level.WARNING, "Property file exists for [" + moduleName + "] at [" + getPropertyPath(moduleName) + "] but could not be loaded.", e); //NON-NLS NON-NLS NON-NLS
        }
    }
    
    public static synchronized void setConfigSetting(String moduleName, String settingName, String settingVal) {
        if (!configExists(moduleName)) {
            makeConfigFile(moduleName);
            Logger.getLogger(ModuleSettings.class.getName()).log(Level.INFO, "File did not exist. Created file [" + moduleName + ".properties]"); //NON-NLS NON-NLS
        }

        try {
            Properties props = fetchProperties(moduleName);

            props.setProperty(settingName, settingVal);

            File path = new File(getPropertyPath(moduleName));
            FileOutputStream fos = new FileOutputStream(path);
            props.store(fos, "Changed config settings(single)"); //NON-NLS
            fos.close();
        } catch (IOException e) {
            Logger.getLogger(ModuleSettings.class.getName()).log(Level.WARNING, "Property file exists for [" + moduleName + "] at [" + getPropertyPath(moduleName) + "] but could not be loaded.", e); //NON-NLS NON-NLS NON-NLS
        }
    }

    public static synchronized void removeProperty(String moduleName, String key){
        try{
            if(getConfigSetting(moduleName, key) != null){
            Properties props = fetchProperties(moduleName);
            
            props.remove(key);
            File path = new File(getPropertyPath(moduleName));
            FileOutputStream fos = new FileOutputStream(path);
            props.store(fos, "Removed " + key); //NON-NLS
            fos.close();
            }
        }
        catch(IOException e ){
            Logger.getLogger(ModuleSettings.class.getName()).log(Level.WARNING, "Could not remove property from file, file not found", e); //NON-NLS
        }
    }
    
    private static Properties fetchProperties(String moduleName)throws IOException{
        InputStream inputStream = new FileInputStream(getPropertyPath(moduleName));
        Properties props = new Properties();
        props.load(inputStream);
        inputStream.close();
        return props;
    }
    
    public static File getPropertyFile(String moduleName) {
        String path = getPropertyPath(moduleName);
        if (path == null){
            return null;
        }
        else{
        return new File(getPropertyPath(moduleName));
        }
    }
}