IngestProfiles.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011-2019 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.ingest;

import java.io.File;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.List;
import java.util.logging.Level;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.FilenameUtils;
import org.sleuthkit.autopsy.ingest.profile.IngestProfilePaths;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.coreutils.ModuleSettings;
import org.sleuthkit.autopsy.coreutils.PlatformUtil;

public final class IngestProfiles {

    private static final String PROFILE_NAME_KEY = "Profile_Name";
    private static final String PROFILE_DESC_KEY = "Profile_Description";
    private static final String PROFILE_FILTER_KEY = "Profile_Filter";
    private static final String SETTINGS_FILE_PREFIX = IngestProfilePaths.getInstance().getIngestProfilePrefix();
    private static final Logger logger = Logger.getLogger(IngestProfiles.class.getName());

    static String getIngestProfilePrefix() {
        return SETTINGS_FILE_PREFIX;
    }

    static String getExecutionContext(String profileName) {
        return SETTINGS_FILE_PREFIX + profileName;
    }

    private static String getSanitizedProfile(String executionContext) {
        return (executionContext != null && executionContext.startsWith(getIngestProfilePrefix()))
                ? executionContext.substring(getIngestProfilePrefix().length())
                : executionContext;
    }

    private static File getRootSettingsFile(String profileName) {
        return Paths.get(
                PlatformUtil.getUserConfigDirectory(), 
                IngestJobSettings.getModuleSettingsResource(
                        getExecutionContext(getSanitizedProfile(profileName))) + ".properties"
                ).toFile();
    }

    private static File getSettingsDirectory(String profileName) {
        return IngestJobSettings.getSavedModuleSettingsFolder(getExecutionContext(getSanitizedProfile(profileName))).toFile();
    }

    public synchronized static List<IngestProfile> getIngestProfiles() {
        File dir = new File(IngestJobSettings.getBaseSettingsPath());
        // find all settings files for ingest profiles (starts with ingest profiles prefix)
        File[] directoryListing = dir.listFiles((file) -> file.getName() != null && file.getName().startsWith(getIngestProfilePrefix()) && file.isFile());
        List<IngestProfile> profileList = new ArrayList<>();
        if (directoryListing != null) {
            for (File child : directoryListing) {
                String resourceName = FilenameUtils.removeExtension(child.getName());
                String profileName = getSanitizedProfile(resourceName);
                String moduleSettingsResource = IngestJobSettings.getModuleSettingsResource(resourceName);
                String desc = ModuleSettings.getConfigSetting(moduleSettingsResource, PROFILE_DESC_KEY);
                String fileIngestFilter = ModuleSettings.getConfigSetting(moduleSettingsResource, PROFILE_FILTER_KEY);
                profileList.add(new IngestProfile(profileName, desc, fileIngestFilter));
            }
        }
        return profileList;
    }

    synchronized static void setProfiles(List<IngestProfile> profiles) {
        for (IngestProfile profile : profiles) {
            IngestProfile.saveProfile(profile);
        }
    }

    public static final class IngestProfile {

        private final String name;
        private final String description;
        private final String fileIngestFilter;

        IngestProfile(String name, String desc, String selectedFilter) {
            this.name = name;
            this.description = desc;
            this.fileIngestFilter = selectedFilter;
        }

        @Override
        public String toString() {
            return getName();
        }

        String getName() {
            return name;
        }

        public String getDescription() {
            return description;
        }

        public String getFileIngestFilter() {
            return fileIngestFilter;
        }

        synchronized static void deleteProfile(IngestProfile selectedProfile) {
            deleteProfile(selectedProfile.getName());
        }
        
        synchronized static void deleteProfile(String profileName) {
            try {
                File rootSettingsFile = getRootSettingsFile(profileName);
                File settingsDirectory = getSettingsDirectory(profileName);
                Files.deleteIfExists(rootSettingsFile.toPath());
                FileUtils.deleteDirectory(settingsDirectory);
            } catch (IOException ex) {
                logger.log(Level.WARNING, "Error deleting directory for profile " + profileName, ex);
            }
        }        

        synchronized static void renameProfile(String oldName, String newName) {
            if (!oldName.equals(newName)) { //if renameProfile was called with the new name being the same as the old name, it is complete already
                File oldRootSettings = getRootSettingsFile(oldName);
                File newRootSettings = getRootSettingsFile(newName);
                oldRootSettings.renameTo(newRootSettings);

                File oldSettingsFolder = getSettingsDirectory(oldName);
                File newSettingsFolder = getSettingsDirectory(newName);
                oldSettingsFolder.renameTo(newSettingsFolder);
            }
        }

        synchronized static void saveProfile(IngestProfile profile) {
            String context = IngestJobSettings.getModuleSettingsResource(getExecutionContext(profile.getName()));
            ModuleSettings.setConfigSetting(context, PROFILE_NAME_KEY, profile.getName());
            ModuleSettings.setConfigSetting(context, PROFILE_DESC_KEY, profile.getDescription());
            ModuleSettings.setConfigSetting(context, PROFILE_FILTER_KEY, profile.getFileIngestFilter());
        }
    }
}