DomainSearchThumbnailLoader.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.discovery.search;

import com.google.common.cache.CacheLoader;
import java.awt.Image;
import java.util.List;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import org.sleuthkit.autopsy.coreutils.ImageUtils;
import org.sleuthkit.datamodel.BlackboardArtifact;
import org.sleuthkit.datamodel.AbstractFile;
import static org.sleuthkit.datamodel.BlackboardArtifact.ARTIFACT_TYPE.TSK_WEB_CACHE;
import static org.sleuthkit.datamodel.BlackboardArtifact.ARTIFACT_TYPE.TSK_WEB_DOWNLOAD;
import org.sleuthkit.datamodel.BlackboardAttribute;
import org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE;
import org.sleuthkit.datamodel.Content;
import org.sleuthkit.datamodel.DataSource;
import org.sleuthkit.datamodel.SleuthkitCase;
import org.sleuthkit.datamodel.TskCoreException;

import org.openide.util.ImageUtilities;

public class DomainSearchThumbnailLoader extends CacheLoader<DomainSearchThumbnailRequest, Image> {

    private static final String UNSUPPORTED_IMAGE = "org/sleuthkit/autopsy/images/image-extraction-not-supported.png";
    private static final List<String> SUPPORTED_EXTENSIONS = Arrays.asList("jpg", "svg", "png", "webp", "ico", "gif");
    private static final List<String> SUPPORTED_MIMETYPES = Arrays.asList(
            "image/gif", "image/jpeg", "image/png", "image/webp", 
            "image/svg+xml", "image/vnd.microsoft.icon", "image/x-icon");
    private static final String ICO_EXTENSION = "ico";
    private static final List<String> ICO_MIMETYPES = Arrays.asList("image/vnd.microsoft.icon", "image/x-icon");
    private final DomainSearchArtifactsCache artifactsCache;

    public DomainSearchThumbnailLoader() {
        this(new DomainSearchArtifactsCache());
    }

    DomainSearchThumbnailLoader(DomainSearchArtifactsCache artifactsCache) {
        this.artifactsCache = artifactsCache;
    }

    @Override
    public Image load(DomainSearchThumbnailRequest thumbnailRequest) throws TskCoreException, DiscoveryException, InterruptedException {
        final SleuthkitCase caseDb = thumbnailRequest.getSleuthkitCase();
        final DomainSearchArtifactsRequest webDownloadsRequest = new DomainSearchArtifactsRequest(
                caseDb, thumbnailRequest.getDomain(), TSK_WEB_DOWNLOAD);
        final List<BlackboardArtifact> webDownloads = artifactsCache.get(webDownloadsRequest);
        final List<AbstractFile> webDownloadPictures = getCandidatesFromWebDownloads(caseDb, webDownloads);
        Collections.sort(webDownloadPictures, (file1, file2) -> {
            // Push ICO to the back of the sorted collection, so that ICO
            // is a last resort matching type.
            if (isIco(file1) && isIco(file2)) {
                return Long.compare(file1.getSize(), file2.getSize());
            } else if (isIco(file1)) {
                return 1;
            } else if (isIco(file2)) {
                return -1;
            } else {
                return Long.compare(file1.getCrtime(), file2.getCrtime());
            }
        });
        
        for (int i = webDownloadPictures.size() - 1; i >= 0; i--) {
            if(Thread.currentThread().isInterrupted()) {
                throw new InterruptedException();
            }
            // Get the most recent image, according to creation time.
            final AbstractFile mostRecent = webDownloadPictures.get(i);

            final Image candidateThumbnail = ImageUtils.getThumbnail(mostRecent, thumbnailRequest.getIconSize());
            if (candidateThumbnail != ImageUtils.getDefaultThumbnail()) {
                return candidateThumbnail;
            }
        }
        final DomainSearchArtifactsRequest webCacheRequest = new DomainSearchArtifactsRequest(
                caseDb, thumbnailRequest.getDomain(), TSK_WEB_CACHE);
        final List<BlackboardArtifact> webCacheArtifacts = artifactsCache.get(webCacheRequest);
        final List<AbstractFile> webCachePictures = getCandidatesFromWebCache(caseDb, webCacheArtifacts);
        Collections.sort(webCachePictures, (file1, file2) -> {
            // Push ICO to the back of the sorted collection, so that ICO
            // is a last resort matching type.
            if (isIco(file1) && isIco(file2)) {
                return Long.compare(file1.getSize(), file2.getSize());
            } else if (isIco(file1)) {
                return 1;
            } else if (isIco(file2)) {
                return -1;
            } else {
                return Long.compare(file1.getSize(), file2.getSize());
            }
        });
        for (int i = webCachePictures.size() - 1; i >= 0; i--) {
            if(Thread.currentThread().isInterrupted()) {
                throw new InterruptedException();
            }
            // Get the largest image, according to file size.
            final AbstractFile largest = webCachePictures.get(i);
            final Image candidateThumbnail = ImageUtils.getThumbnail(largest, thumbnailRequest.getIconSize());
            if (candidateThumbnail != ImageUtils.getDefaultThumbnail()) {
                return candidateThumbnail;
            }
        }
        return ImageUtilities.loadImage(UNSUPPORTED_IMAGE, false);
    }

    private List<AbstractFile> getCandidatesFromWebDownloads(SleuthkitCase caseDb, List<BlackboardArtifact> artifacts) throws TskCoreException, InterruptedException {
        final List<AbstractFile> candidates = new ArrayList<>();
        for (BlackboardArtifact artifact : artifacts) {
            if(Thread.currentThread().isInterrupted()) {
                throw new InterruptedException();
            }
            final Content sourceContent = caseDb.getContentById(artifact.getObjectID());
            addIfSupported(candidates, sourceContent);
        }
        return candidates;
    }
    
    private boolean isIco(AbstractFile file) {
        return ICO_EXTENSION.equals(file.getNameExtension()) 
                || ICO_MIMETYPES.contains(file.getMIMEType());
    }

    private List<AbstractFile> getCandidatesFromWebCache(SleuthkitCase caseDb, List<BlackboardArtifact> artifacts) throws TskCoreException, InterruptedException {
        final BlackboardAttribute.Type TSK_PATH_ID = new BlackboardAttribute.Type(ATTRIBUTE_TYPE.TSK_PATH_ID);
        final List<AbstractFile> candidates = new ArrayList<>();
        for (BlackboardArtifact artifact : artifacts) {
            if(Thread.currentThread().isInterrupted()) {
                throw new InterruptedException();
            }
            final BlackboardAttribute tskPathId = artifact.getAttribute(TSK_PATH_ID);
            if (tskPathId != null) {
                final Content sourceContent = caseDb.getContentById(tskPathId.getValueLong());
                addIfSupported(candidates, sourceContent);
            }
        }
        return candidates;
    }

    private void addIfSupported(List<AbstractFile> files, Content sourceContent) {
        if ((sourceContent instanceof AbstractFile) && !(sourceContent instanceof DataSource)) {
            final AbstractFile file = (AbstractFile) sourceContent;
            if (SUPPORTED_EXTENSIONS.contains(file.getNameExtension())
                    || SUPPORTED_MIMETYPES.contains(file.getMIMEType())) {
                files.add(file);
            }
        }
    }
}