autopsy-flatpak/HashDatabase/src/org/sleuthkit/autopsy/hashdatabase/HashLookupModuleFactory.java

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

import java.io.Serializable;
import java.util.ArrayList;
import javax.swing.JPanel;
import org.openide.util.NbBundle;
import org.openide.util.lookup.ServiceProvider;
import org.sleuthkit.autopsy.coreutils.Version;
import org.sleuthkit.autopsy.ingest.AbstractIngestModuleFactory;
import org.sleuthkit.autopsy.ingest.FileIngestModule;
import org.sleuthkit.autopsy.ingest.IngestModuleFactory;

/**
 * An factory that creates file ingest modules that do hash database lookups.
 */
@ServiceProvider(service=IngestModuleFactory.class)
public class HashLookupModuleFactory extends AbstractIngestModuleFactory { 
    @Override
    public String getModuleDisplayName() {
        return NbBundle.getMessage(HashDbIngestModule.class, "HashDbIngestModule.moduleName");
    }
    
    @Override
    public String getModuleDescription() {
        return NbBundle.getMessage(HashDbIngestModule.class, "HashDbIngestModule.moduleDescription");        
    }
    
    @Override
    public String getModuleVersionNumber() {
        return Version.getVersion();        
    }
    
    @Override
    public Serializable getDefaultIngestOptions() {
        return new IngestOptions();        
    }
    
    @Override
    public boolean providesIngestOptionsPanels() {
        return true;
    }
    
    @Override
    public JPanel getIngestOptionsPanel(Serializable ingestOptions) {
        HashDbSimpleConfigPanel ingestOptionsPanel = new HashDbSimpleConfigPanel();  
        ingestOptionsPanel.load();
        return ingestOptionsPanel;                
    }
    
    @Override
    public Serializable getIngestOptionsFromPanel(JPanel ingestOptionsPanel) throws InvalidOptionsException {
        if (!(ingestOptionsPanel instanceof HashDbSimpleConfigPanel)) {
            throw new InvalidOptionsException(""); // RJCTODO
        }

        HashDbSimpleConfigPanel panel = (HashDbSimpleConfigPanel)ingestOptionsPanel;
        panel.store();
                
        return new IngestOptions(); // RJCTODO
    }
    
    @Override
    public boolean providesGlobalOptionsPanels() {
        return true;    
    }
    
    @Override
    public JPanel getGlobalOptionsPanel() {
        HashDbConfigPanel globalOptionsPanel = new HashDbConfigPanel();        
        globalOptionsPanel.load();
        return globalOptionsPanel;
    }    
    
    @Override
    public void saveGlobalOptionsFromPanel(JPanel globalOptionsPanel) throws InvalidOptionsException {
        if (!(globalOptionsPanel instanceof HashDbConfigPanel)) {
            throw new InvalidOptionsException(""); // RJCTODO
        }
        
        HashDbConfigPanel panel = (HashDbConfigPanel)globalOptionsPanel;
        panel.store();
    }
    
    @Override
    public boolean isFileIngestModuleFactory() {
        return true;            
    }
    
    @Override
    public FileIngestModule createFileIngestModule(Serializable ingestOptions) throws InvalidOptionsException {
        return null; // RJCTODO
    }
    
    private static class IngestOptions implements Serializable {
        boolean alwaysCalcHashes = true;
        ArrayList<String> hashSetNames = new ArrayList<>();
    }
}