IngestModuleCheckUtil.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2020 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.datasourcesummary.datamodel;

import java.util.Map;
import java.util.stream.Collectors;
import org.apache.commons.lang3.StringUtils;
import org.openide.util.NbBundle.Messages;
import org.sleuthkit.autopsy.datasourcesummary.datamodel.SleuthkitCaseProvider.SleuthkitCaseProviderException;
import org.sleuthkit.datamodel.DataSource;
import org.sleuthkit.datamodel.IngestJobInfo;
import org.sleuthkit.datamodel.IngestModuleInfo;
import org.sleuthkit.datamodel.SleuthkitCase;
import org.sleuthkit.datamodel.TskCoreException;

@Messages({
    "IngestModuleCheckUtil_recentActivityModuleName=Recent Activity",
    
})
public class IngestModuleCheckUtil {
    public static final String RECENT_ACTIVITY_FACTORY = "org.sleuthkit.autopsy.recentactivity.RecentActivityExtracterModuleFactory";
    public static final String RECENT_ACTIVITY_MODULE_NAME = Bundle.IngestModuleCheckUtil_recentActivityModuleName();
    
    // IngestModuleInfo separator for unique_name
    private static final String UNIQUE_NAME_SEPARATOR = "-";

    private final SleuthkitCaseProvider caseProvider;
        
    public IngestModuleCheckUtil() {
        this(SleuthkitCaseProvider.DEFAULT);

    }

    public IngestModuleCheckUtil(SleuthkitCaseProvider provider) {

        this.caseProvider = provider;
    }

    
    private static String getFullyQualifiedFactory(IngestModuleInfo info) {
        if (info == null) {
            return null;
        }
        
        String qualifiedName = info.getUniqueName();
        if (StringUtils.isBlank(qualifiedName)) {
            return null;
        }
        
        return qualifiedName.split(UNIQUE_NAME_SEPARATOR)[0];
    }
        

    private static boolean hasIngestModule(IngestJobInfo info, String fullyQualifiedFactory) {
        if (info == null || info.getIngestModuleInfo() == null || StringUtils.isBlank(fullyQualifiedFactory)) {
            return false;
        }

        return info.getIngestModuleInfo().stream()
                .anyMatch((moduleInfo) -> {
                    String thisQualifiedFactory = getFullyQualifiedFactory(moduleInfo);
                    return fullyQualifiedFactory.equalsIgnoreCase(thisQualifiedFactory);
                });
    }

    public boolean isModuleIngested(DataSource dataSource, String fullyQualifiedFactory)
            throws TskCoreException, SleuthkitCaseProviderException {
        if (dataSource == null) {
            return false;
        }

        long dataSourceId = dataSource.getId();

        return caseProvider.get().getIngestJobs().stream()
                .anyMatch((ingestJob) -> {
                    return ingestJob != null
                            && ingestJob.getObjectId() == dataSourceId
                            && hasIngestModule(ingestJob, fullyQualifiedFactory);
                });

    }
    
    public static Map<String, String> getFactoryDisplayNames(SleuthkitCase skCase) throws TskCoreException {
        return skCase.getIngestJobs().stream()
                .flatMap(ingestJob -> ingestJob.getIngestModuleInfo().stream())
                .collect(Collectors.toMap(
                        (moduleInfo) -> getFullyQualifiedFactory(moduleInfo), 
                        (moduleInfo) -> moduleInfo.getDisplayName(),
                        (a,b) -> a));
    }
}