KeywordSearchModuleFactory.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2014-2021 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.keywordsearch;

import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashSet;
import java.util.List;
import org.openide.util.NbBundle;
import org.openide.util.lookup.ServiceProvider;
import org.sleuthkit.autopsy.coreutils.Version;
import org.sleuthkit.autopsy.ingest.AnalysisResultIngestModule;
import org.sleuthkit.autopsy.ingest.DataArtifactIngestModule;
import org.sleuthkit.autopsy.ingest.FileIngestModule;
import org.sleuthkit.autopsy.ingest.IngestModuleFactory;
import org.sleuthkit.autopsy.ingest.IngestModuleIngestJobSettings;
import org.sleuthkit.autopsy.ingest.IngestModuleIngestJobSettingsPanel;
import org.sleuthkit.autopsy.ingest.IngestModuleGlobalSettingsPanel;

@ServiceProvider(service = IngestModuleFactory.class)
public class KeywordSearchModuleFactory implements IngestModuleFactory {

    private static final HashSet<String> defaultDisabledKeywordListNames = new HashSet<>(Arrays.asList("Phone Numbers", "IP Addresses", "URLs", "Credit Card Numbers")); //NON-NLS
    private KeywordSearchJobSettingsPanel jobSettingsPanel = null;

    @Override
    public String getModuleDisplayName() {
        return getModuleName();
    }

    static String getModuleName() {
        return NbBundle.getMessage(KeywordSearchIngestModule.class, "KeywordSearchIngestModule.moduleName");
    }

    @Override
    public String getModuleDescription() {
        return NbBundle.getMessage(KeywordSearchIngestModule.class, "KeywordSearchIngestModule.moduleDescription");
    }

    @Override
    public String getModuleVersionNumber() {
        return Version.getVersion();
    }

    @Override
    public IngestModuleIngestJobSettings getDefaultIngestJobSettings() {
        XmlKeywordSearchList listManager = XmlKeywordSearchList.getCurrent();
        List<String> enabledKeywordLists = new ArrayList<>();
        List<KeywordList> keywordLists = listManager.getListsL();
        for (KeywordList keywordList : keywordLists) {
            if (!defaultDisabledKeywordListNames.contains(keywordList.getName())) {
                enabledKeywordLists.add(keywordList.getName());
            }
        }
        return new KeywordSearchJobSettings(enabledKeywordLists);
    }

    @Override
    public boolean hasIngestJobSettingsPanel() {
        return true;
    }

    @Override
    public IngestModuleIngestJobSettingsPanel getIngestJobSettingsPanel(IngestModuleIngestJobSettings settings) {
        assert settings instanceof KeywordSearchJobSettings;
        if (!(settings instanceof KeywordSearchJobSettings)) {
            throw new IllegalArgumentException(NbBundle.getMessage(this.getClass(),
                    "KeywordSearchModuleFactory.getIngestJobSettingsPanel.exception.msg"));
        }

        if (jobSettingsPanel == null) {
            jobSettingsPanel = new KeywordSearchJobSettingsPanel((KeywordSearchJobSettings) settings);
        } else {
            jobSettingsPanel.reset((KeywordSearchJobSettings) settings);
        }
        return jobSettingsPanel;
    }

    @Override
    public boolean hasGlobalSettingsPanel() {
        return true;
    }

    @Override
    public IngestModuleGlobalSettingsPanel getGlobalSettingsPanel() {
        KeywordSearchGlobalSettingsPanel globalSettingsPanel = new KeywordSearchGlobalSettingsPanel();
        globalSettingsPanel.load();
        return globalSettingsPanel;
    }

    @Override
    public boolean isFileIngestModuleFactory() {
        return true;
    }

    @Override
    public FileIngestModule createFileIngestModule(IngestModuleIngestJobSettings settings) {
        assert settings instanceof KeywordSearchJobSettings;
        if (!(settings instanceof KeywordSearchJobSettings)) {
            throw new IllegalArgumentException(NbBundle.getMessage(this.getClass(),
                    "KeywordSearchModuleFactory.createFileIngestModule.exception.msg"));
        }
        return new KeywordSearchIngestModule((KeywordSearchJobSettings) settings);
    }
    
    @Override
    public boolean isDataArtifactIngestModuleFactory() {
        return true;
    }

    @Override
    public DataArtifactIngestModule createDataArtifactIngestModule(IngestModuleIngestJobSettings settings) {
        if (!(settings instanceof KeywordSearchJobSettings)) {
            throw new IllegalArgumentException(NbBundle.getMessage(this.getClass(),
                    "KeywordSearchModuleFactory.createFileIngestModule.exception.msg"));
        }
        
        return new KwsDataArtifactIngestModule((KeywordSearchJobSettings) settings);
    }    
    
    @Override
    public boolean isAnalysisResultIngestModuleFactory() {
        return true;
    }    
 
    @Override
    public AnalysisResultIngestModule createAnalysisResultIngestModule(IngestModuleIngestJobSettings settings) {
        if (!(settings instanceof KeywordSearchJobSettings)) {
            throw new IllegalArgumentException(NbBundle.getMessage(this.getClass(),
                    "KeywordSearchModuleFactory.createFileIngestModule.exception.msg"));
        }
        
        return new KwsAnalysisResultIngestModule((KeywordSearchJobSettings) settings);
    }    
    
}