FilesSetsManager.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2014-2018 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.modules.interestingitems;

import java.io.File;
import java.io.IOException;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Observable;
import org.apache.commons.io.FileUtils;
import org.openide.util.NbBundle;
import org.sleuthkit.autopsy.coreutils.PlatformUtil;
import org.sleuthkit.autopsy.modules.interestingitems.FilesSet.Rule;
import org.sleuthkit.autopsy.modules.interestingitems.FilesSet.Rule.MetaTypeCondition;

public final class FilesSetsManager extends Observable {

    @NbBundle.Messages({"FilesSetsManager.allFilesAndDirectories=All Files and Directories (Not Unallocated Space)",
        "FilesSetsManager.allFilesDirectoriesAndUnallocated=All Files, Directories, and Unallocated Space"})
    private static final List<String> ILLEGAL_FILE_NAME_CHARS = Collections.unmodifiableList(new ArrayList<>(Arrays.asList("\\", "/", ":", "*", "?", "\"", "<", ">")));
    private static final List<String> ILLEGAL_FILE_PATH_CHARS = Collections.unmodifiableList(new ArrayList<>(Arrays.asList("\\", ":", "*", "?", "\"", "<", ">")));
    private static final String LEGACY_FILES_SET_DEFS_FILE_NAME = "InterestingFilesSetDefs.xml"; //NON-NLS
    private static final String INTERESTING_FILES_SET_DEFS_NAME = "InterestingFileSets.settings";
    private static final String FILE_INGEST_FILTER_DEFS_NAME = "FileIngestFilterDefs.settings";
    private static final String LEGACY_SETTINGS_PATH = PlatformUtil.getUserConfigDirectory();
    private static final String SETTINGS_PATH = PlatformUtil.getModuleConfigDirectory();
    private static final String FILE_FILTER_PATH = Paths.get(SETTINGS_PATH, FILE_INGEST_FILTER_DEFS_NAME).toAbsolutePath().toString();
    private static final String INTERESTING_ITEM_PATH = Paths.get(SETTINGS_PATH, INTERESTING_FILES_SET_DEFS_NAME).toAbsolutePath().toString();
    private static final Object FILE_INGEST_FILTER_LOCK = new Object();
    private static final Object INTERESTING_FILES_SET_LOCK = new Object();
    private static FilesSetsManager instance;
    private static final FilesSet FILES_DIRS_INGEST_FILTER = new FilesSet(
            Bundle.FilesSetsManager_allFilesAndDirectories(), Bundle.FilesSetsManager_allFilesAndDirectories(), false, true, new HashMap<String, Rule>() {
        {
            put(Bundle.FilesSetsManager_allFilesAndDirectories(),
                    new Rule(Bundle.FilesSetsManager_allFilesAndDirectories(), null,
                            new MetaTypeCondition(MetaTypeCondition.Type.ALL), null, null, null, null, null));
        }
    });
    private static final FilesSet FILES_DIRS_UNALLOC_INGEST_FILTER = new FilesSet(
            Bundle.FilesSetsManager_allFilesDirectoriesAndUnallocated(), Bundle.FilesSetsManager_allFilesDirectoriesAndUnallocated(),
            false, false, new HashMap<String, Rule>() {
        {
            put(Bundle.FilesSetsManager_allFilesDirectoriesAndUnallocated(),
                    new Rule(Bundle.FilesSetsManager_allFilesDirectoriesAndUnallocated(), null,
                            new MetaTypeCondition(MetaTypeCondition.Type.ALL), null, null, null, null, null));
        }
    });


    public synchronized static FilesSetsManager getInstance() {
        if (instance == null) {
            instance = new FilesSetsManager();
        }
        return instance;
    }

    static String getFileFilterPath() {
        return FILE_FILTER_PATH;
    }
    
    static String getInterestingItemPath() {
        return INTERESTING_ITEM_PATH;
    }
    
    static List<String> getIllegalFileNameChars() {
        return FilesSetsManager.ILLEGAL_FILE_NAME_CHARS;
    }

    static List<String> getIllegalFilePathChars() {
        return FilesSetsManager.ILLEGAL_FILE_PATH_CHARS;
    }

    public static List<FilesSet> getStandardFileIngestFilters() {
        return Arrays.asList(FILES_DIRS_UNALLOC_INGEST_FILTER, FILES_DIRS_INGEST_FILTER);
    }

    public Map<String, FilesSet> getCustomFileIngestFilters() throws FilesSetsManagerException {
        synchronized (FILE_INGEST_FILTER_LOCK) {
            return FileSetsDefinitions.readSerializedDefinitions(PlatformUtil.getModuleConfigDirectory(), FILE_INGEST_FILTER_DEFS_NAME);
        }
    }

    public static FilesSet getDefaultFilter() {
        return FILES_DIRS_UNALLOC_INGEST_FILTER;
    }

    void setCustomFileIngestFilters(Map<String, FilesSet> filesSets) throws FilesSetsManagerException {
        synchronized (FILE_INGEST_FILTER_LOCK) {
            FileSetsDefinitions.writeDefinitionsFile(PlatformUtil.getModuleConfigDirectory(), FILE_INGEST_FILTER_DEFS_NAME, filesSets);
        }
    }

    public Map<String, FilesSet> getInterestingFilesSets() throws FilesSetsManagerException {
        synchronized (INTERESTING_FILES_SET_LOCK) {
            return InterestingItemsFilesSetSettings.readDefinitionsFile(PlatformUtil.getModuleConfigDirectory(), INTERESTING_FILES_SET_DEFS_NAME, LEGACY_FILES_SET_DEFS_FILE_NAME);
        }
    }

    void setInterestingFilesSets(Map<String, FilesSet> filesSets) throws FilesSetsManagerException {
        synchronized (INTERESTING_FILES_SET_LOCK) {
            InterestingItemsFilesSetSettings.writeDefinitionsFile(PlatformUtil.getModuleConfigDirectory(), INTERESTING_FILES_SET_DEFS_NAME, filesSets);
            this.setChanged();
            this.notifyObservers();
        }
    }

    void upgradeConfig() throws IOException {
        for (String fileName : new String[]{LEGACY_FILES_SET_DEFS_FILE_NAME, FILE_INGEST_FILTER_DEFS_NAME, INTERESTING_FILES_SET_DEFS_NAME }) {
            File oldPath = Paths.get(LEGACY_SETTINGS_PATH, fileName).toFile();
            File newPath = Paths.get(SETTINGS_PATH, fileName).toFile();
            
            if (oldPath.exists() && !newPath.exists()) {
                newPath.getParentFile().mkdirs();
                FileUtils.copyFile(oldPath, newPath);
            }
        }
    }

    public static class FilesSetsManagerException extends Exception {

        FilesSetsManagerException() {

        }

        FilesSetsManagerException(String message) {
            super(message);
        }

        FilesSetsManagerException(String message, Throwable cause) {
            super(message, cause);
        }

        FilesSetsManagerException(Throwable cause) {
            super(cause);
        }
    }
}