ContactCache.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.guiutils;

import com.google.common.cache.CacheBuilder;
import com.google.common.cache.CacheLoader;
import com.google.common.cache.LoadingCache;
import java.beans.PropertyChangeListener;
import java.sql.SQLException;
import java.util.ArrayList;
import java.util.EnumSet;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.TimeUnit;
import java.util.logging.Level;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.ingest.IngestManager;
import static org.sleuthkit.autopsy.ingest.IngestManager.IngestModuleEvent.DATA_ADDED;
import org.sleuthkit.autopsy.ingest.ModuleDataEvent;
import org.sleuthkit.datamodel.Account;
import org.sleuthkit.datamodel.BlackboardArtifact;
import org.sleuthkit.datamodel.BlackboardAttribute;
import static org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE.TSK_NAME;
import org.sleuthkit.datamodel.TskCoreException;

public final class ContactCache {

    private static final Logger logger = Logger.getLogger(ContactCache.class.getName());

    private static ContactCache instance;

    private final LoadingCache<String, Map<String, List<BlackboardArtifact>>> accountMap;

    public static synchronized List<BlackboardArtifact> getContacts(Account account) throws ExecutionException {
        return getInstance().accountMap.get("realMap").get(account.getTypeSpecificID());
    }

    public static synchronized List<String> getContactNameList(String accountTypeSpecificID) throws TskCoreException {
        List<BlackboardArtifact> contactList;
        try {
            contactList = getInstance().accountMap.get("realMap").get(accountTypeSpecificID);
        } catch (ExecutionException ex) {
            throw new TskCoreException("Unable to get contact list from cache", ex);
        }
        List<String> contactNameList = new ArrayList<>();

        if (contactList != null) {
            for (BlackboardArtifact artifact : contactList) {
                BlackboardAttribute attribute = artifact.getAttribute(new BlackboardAttribute.Type(BlackboardAttribute.ATTRIBUTE_TYPE.fromID(TSK_NAME.getTypeID())));
                if (attribute != null && !contactNameList.contains(attribute.getValueString())) {
                    contactNameList.add(attribute.getValueString());
                }
            }
        }

        return contactNameList;
    }

    static synchronized void invalidateCache() {
        getInstance().accountMap.invalidateAll();
    }

    private ContactCache() {

        accountMap = CacheBuilder.newBuilder().expireAfterAccess(10, TimeUnit.MINUTES).build(
                new CacheLoader<String, Map<String, List<BlackboardArtifact>>>() {
            @Override
            public Map<String, List<BlackboardArtifact>> load(String key) {
                try {
                    return buildMap();
                } catch (SQLException | TskCoreException ex) {
                    logger.log(Level.WARNING, "Failed to build account to contact map", ex);
                }
                return new HashMap<>();  // Return an empty map if there is an exception to avoid NPE and continual trying.
            }
        });

        PropertyChangeListener ingestListener = pce -> {
            String eventType = pce.getPropertyName();
            if (eventType.equals(DATA_ADDED.toString())) {
                ModuleDataEvent eventData = (ModuleDataEvent) pce.getOldValue();
                if (eventData.getBlackboardArtifactType().getTypeID() == BlackboardArtifact.ARTIFACT_TYPE.TSK_CONTACT.getTypeID()) {
                    invalidateCache();
                }
            }
        };

        IngestManager.getInstance().addIngestModuleEventListener(EnumSet.of(DATA_ADDED), ingestListener);
    }

    private static synchronized ContactCache getInstance() {
        if (instance == null) {
            instance = new ContactCache();
        }

        return instance;
    }

    private Map<String, List<BlackboardArtifact>> buildMap() throws TskCoreException, SQLException {
        Map<String, List<BlackboardArtifact>> acctMap = new HashMap<>();
        List<BlackboardArtifact> contactList = Case.getCurrentCase().getSleuthkitCase().getBlackboardArtifacts(BlackboardArtifact.ARTIFACT_TYPE.TSK_CONTACT);

        for (BlackboardArtifact contactArtifact : contactList) {
            List<BlackboardAttribute> contactAttributes = contactArtifact.getAttributes();
            for (BlackboardAttribute attribute : contactAttributes) {
                String typeName = attribute.getAttributeType().getTypeName();

                if (typeName.startsWith("TSK_EMAIL")
                        || typeName.startsWith("TSK_PHONE")
                        || typeName.startsWith("TSK_NAME")
                        || typeName.startsWith("TSK_ID")) {
                    String accountID = attribute.getValueString();
                    List<BlackboardArtifact> artifactList = acctMap.get(accountID);
                    if (artifactList == null) {
                        artifactList = new ArrayList<>();
                        acctMap.put(accountID, artifactList);
                    }
                    if (!artifactList.contains(contactArtifact)) {
                        artifactList.add(contactArtifact);
                    }
                }
            }

        }

        return acctMap;
    }
}