KwsAnalysisResultIngestModule.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2021-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.io.Reader;
import java.util.logging.Level;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.ingest.AnalysisResultIngestModule;
import org.sleuthkit.autopsy.ingest.IngestJobContext;
import org.sleuthkit.autopsy.ingest.IngestModule;
import org.sleuthkit.datamodel.AnalysisResult;
import org.sleuthkit.datamodel.BlackboardArtifact;

public class KwsAnalysisResultIngestModule implements AnalysisResultIngestModule  {

    private static final Logger LOGGER = Logger.getLogger(KeywordSearchIngestModule.class.getName());
    private static final int TSK_KEYWORD_HIT_TYPE_ID = BlackboardArtifact.Type.TSK_KEYWORD_HIT.getTypeID();
    private IngestJobContext context;
    private final KeywordSearchJobSettings settings;

    KwsAnalysisResultIngestModule(KeywordSearchJobSettings settings) {
        this.settings = settings;
    }
    
    @Override
    public void startUp(IngestJobContext context) throws IngestModule.IngestModuleException {
        this.context = context;
    }

    @Override
    public IngestModule.ProcessResult process(AnalysisResult result) {
        try {
            if (result.getType().getTypeID() != TSK_KEYWORD_HIT_TYPE_ID) {
                Ingester ingester = Ingester.getDefault();
                Reader blackboardExtractedTextReader = KeywordSearchUtil.getReader(result);
                String sourceName = result.getDisplayName() + "_" + result.getArtifactID();
                ingester.indexMetaDataOnly(result, sourceName);
                ingester.search(blackboardExtractedTextReader, 
                        result.getArtifactID(), 
                        sourceName, result, 
                        context, true,
                        settings.isIndexToSolrEnabled(), 
                        settings.getNamesOfEnabledKeyWordLists());
            }
        } catch (Exception ex) {
            LOGGER.log(Level.SEVERE, String.format("Error indexing analysis result '%s' (job ID=%d)", result, context.getJobId()), ex); //NON-NLS
            return IngestModule.ProcessResult.ERROR;
        }
        return IngestModule.ProcessResult.OK;
    }    
    
}