ThumbnailViewChildren.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011-19 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.corecomponents;

import com.google.common.collect.Lists;
import com.google.common.util.concurrent.ThreadFactoryBuilder;
import java.awt.Image;
import java.awt.Toolkit;
import java.awt.image.BufferedImage;
import java.io.IOException;
import java.lang.ref.SoftReference;
import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.concurrent.Callable;
import java.util.concurrent.CancellationException;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.concurrent.FutureTask;
import java.util.logging.Level;
import java.util.stream.Collectors;
import java.util.stream.IntStream;
import java.util.stream.Stream;
import javax.imageio.ImageIO;
import javax.swing.SwingUtilities;
import javax.swing.Timer;
import org.apache.commons.lang3.StringUtils;
import org.netbeans.api.progress.ProgressHandle;
import org.netbeans.api.progress.ProgressHandleFactory;
import org.openide.nodes.AbstractNode;
import org.openide.nodes.Children;
import org.openide.nodes.FilterNode;
import org.openide.nodes.Node;
import org.openide.util.NbBundle;
import org.openide.util.lookup.Lookups;
import org.sleuthkit.autopsy.corecomponents.ResultViewerPersistence.SortCriterion;
import static org.sleuthkit.autopsy.corecomponents.ResultViewerPersistence.loadSortCriteria;
import org.sleuthkit.autopsy.coreutils.ImageUtils;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.datamodel.AbstractFile;
import org.sleuthkit.datamodel.Content;

class ThumbnailViewChildren extends Children.Keys<Integer> {

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

    @NbBundle.Messages("ThumbnailViewChildren.progress.cancelling=(Cancelling)")
    private static final String CANCELLING_POSTIX = Bundle.ThumbnailViewChildren_progress_cancelling();
    
    private static Image waitingIcon;
    
    static final int IMAGES_PER_PAGE = 200;

    private final ExecutorService executor = Executors.newFixedThreadPool(3,
            new ThreadFactoryBuilder().setNameFormat("Thumbnail-Loader-%d").build());
    private final List<ThumbnailViewNode.ThumbnailLoadTask> tasks = new ArrayList<>();

    private final Node parent;
    private final List<List<Node>> pages = new ArrayList<>();
    private int thumbSize;
    

    private static Image getWaitingIcon() {
        if (waitingIcon == null) {
            String imgPath = "/org/sleuthkit/autopsy/images/working_spinner.gif";
            try {
                waitingIcon = ImageIO.read(ThumbnailViewNode.class.getResource(imgPath));    
            } catch (IOException ex) {
                logger.log(Level.WARNING, "There was an error loading image: " + imgPath, ex);
            }
        }

        return waitingIcon;
    }

    ThumbnailViewChildren(Node parent, int thumbSize) {
        super(true); //support lazy loading

        this.parent = parent;
        this.thumbSize = thumbSize;
    }

    @Override
    protected void addNotify() {
        super.addNotify();

        /*
         * TODO: When lazy loading of original nodes is fixed, we should be
         * asking the datamodel for the children instead and not counting the
         * children nodes (which might not be preloaded at this point).
         */
        // get list of supported children sorted by persisted criteria
        final List<Node> suppContent
                = Stream.of(parent.getChildren().getNodes())
                        .filter(ThumbnailViewChildren::isSupported)
                        .sorted(getComparator())
                        .collect(Collectors.toList());

        if (suppContent.isEmpty()) {
            //if there are no images, there is nothing more to do
            return;
        }

        //divide the supported content into buckets
        pages.addAll(Lists.partition(suppContent, IMAGES_PER_PAGE));

        //the keys are just the indices into the pages list.
        setKeys(IntStream.range(0, pages.size()).boxed().collect(Collectors.toList()));
    }

    private synchronized Comparator<Node> getComparator() {
        Comparator<Node> comp = (node1, node2) -> 0; //eveything is equal.

        if (!(parent instanceof TableFilterNode)) {
            return comp;
        } else {
            List<SortCriterion> sortCriteria = loadSortCriteria((TableFilterNode) parent);

            return sortCriteria.stream()
                    .map(this::getCriterionComparator)
                    .collect(Collectors.reducing(Comparator::thenComparing))
                    .orElse(comp); // default to unordered if nothing is persisted
        }
    }

    private Comparator<Node> getCriterionComparator(SortCriterion criterion) {
        @SuppressWarnings("unchecked")
        Comparator<Node> c = Comparator.comparing(node -> getPropertyValue(node, criterion.getProperty()),
                Comparator.nullsFirst(Comparator.naturalOrder()));// Null values go first, unless reversed below.
        switch (criterion.getSortOrder()) {
            case DESCENDING:
            case UNSORTED:
                return c.reversed();
            case ASCENDING:
            default:
                return c;
        }
    }

    @SuppressWarnings("rawtypes")
    private Comparable getPropertyValue(Node node, Node.Property<?> prop) {
        for (Node.PropertySet ps : node.getPropertySets()) {
            for (Node.Property<?> p : ps.getProperties()) {
                if (p.equals(prop)) {
                    try {
                        if (p.getValue() instanceof Comparable) {
                            return (Comparable) p.getValue();
                        } else {
                            //if the value is not comparable use its string representation
                            return p.getValue().toString();
                        }

                    } catch (IllegalAccessException | InvocationTargetException ex) {
                        logger.log(Level.WARNING, "Error getting value for thumbnail children", ex);
                    }
                }
            }
        }
        return null;
    }

    @Override
    protected void removeNotify() {
        super.removeNotify();
        pages.clear();
    }

    @Override
    protected Node[] createNodes(Integer pageNum) {
        return new Node[]{new ThumbnailPageNode(pageNum, pages.get(pageNum))};

    }

    private static boolean isSupported(Node node) {
        if (node != null) {
            Content content = node.getLookup().lookup(AbstractFile.class);
            if (content != null) {
                return ImageUtils.thumbnailSupported(content);
            }
        }
        return false;
    }

    public void setThumbsSize(int thumbSize) {
        this.thumbSize = thumbSize;
        for (Node page : getNodes()) {
            for (Node node : page.getChildren().getNodes()) {
                ((ThumbnailViewNode) node).setThumbSize(thumbSize);
            }
        }
    }

    synchronized void cancelLoadingThumbnails() {
        tasks.forEach(task -> task.cancel(Boolean.TRUE));
        executor.shutdownNow();
        tasks.clear();
    }

    private synchronized ThumbnailViewNode.ThumbnailLoadTask loadThumbnail(ThumbnailViewNode node) {
        if (executor.isShutdown() == false) {
            ThumbnailViewNode.ThumbnailLoadTask task = node.new ThumbnailLoadTask();
            tasks.add(task);
            executor.submit(task);
            return task;
        } else {
            return null;
        }
    }

    private class ThumbnailViewNode extends FilterNode {

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

        private SoftReference<Image> thumbCache = null;
        private int thumbSize;
        private final Content content;

        private ThumbnailLoadTask thumbTask;
        private Timer waitSpinnerTimer;

        private ThumbnailViewNode(Node wrappedNode, int thumbSize) {
            super(wrappedNode, FilterNode.Children.LEAF);
            this.thumbSize = thumbSize;
            this.content = this.getLookup().lookup(AbstractFile.class);
        }

        @Override
        public String getDisplayName() {
            return StringUtils.abbreviate(super.getDisplayName(), 18);
        }

        @Override
        @NbBundle.Messages({"# {0} - file name",
            "ThumbnailViewNode.progressHandle.text=Generating thumbnail for {0}"})
        synchronized public Image getIcon(int type) {
            if (content == null) {
                return ImageUtils.getDefaultThumbnail();
            }

            if (thumbCache != null) {
                Image thumbnail = thumbCache.get();
                if (thumbnail != null) {
                    return thumbnail;
                }
            }

            if (thumbTask == null) {
                thumbTask = loadThumbnail(ThumbnailViewNode.this);

            }
            if (waitSpinnerTimer == null) {
                waitSpinnerTimer = new Timer(1, actionEvent -> fireIconChange());
                waitSpinnerTimer.start();
            }
            
            return getWaitingIcon();
        }

        synchronized void setThumbSize(int iconSize) {
            this.thumbSize = iconSize;
            thumbCache = null;
            if (thumbTask != null) {
                thumbTask.cancel(true);
                thumbTask = null;
            }

        }

        private class ThumbnailLoadTask extends FutureTask<Image> {

            private final ProgressHandle progressHandle;
            private final String progressText;
            private boolean cancelled = false;

            ThumbnailLoadTask() {
                super(new Callable<Image>() {  //Does not work as lambda expression in dependent projects in IDE
                    public Image call() {
                        return ImageUtils.getThumbnail(content, thumbSize);
                    }
                });
                //super(() -> ImageUtils.getThumbnail(content, thumbSize));
                progressText = Bundle.ThumbnailViewNode_progressHandle_text(content.getName());

                progressHandle = ProgressHandleFactory.createSystemHandle(progressText);
                progressHandle.setInitialDelay(500);
                progressHandle.start();
            }

            @Override
            synchronized public boolean cancel(boolean mayInterrupt) {
                cancelled = true;
                progressHandle.suspend(progressText + " " + CANCELLING_POSTIX);
                return super.cancel(mayInterrupt);
            }

            @Override
            synchronized public boolean isCancelled() {
                return cancelled || super.isCancelled(); //To change body of generated methods, choose Tools | Templates.
            }

            @Override
            synchronized protected void done() {
                progressHandle.finish();
                SwingUtilities.invokeLater(() -> {

                    if (waitSpinnerTimer != null) {
                        waitSpinnerTimer.stop();
                        waitSpinnerTimer = null;
                    }

                    try {
                        if (isCancelled() == false) {
                            thumbCache = new SoftReference<>(get());
                            fireIconChange();
                        }
                    } catch (CancellationException ex) {
                        //Task was cancelled, do nothing
                    } catch (InterruptedException | ExecutionException ex) {
                        if (false == (ex.getCause() instanceof CancellationException)) {
                            logger.log(Level.SEVERE, "Error getting thumbnail icon for " + content.getName(), ex); //NON-NLS
                        }
                    }
                });
            }
        }
    }

    private class ThumbnailPageNode extends AbstractNode {

        private ThumbnailPageNode(Integer pageNum, List<Node> childNodes) {

            super(new ThumbnailPageNodeChildren(childNodes), Lookups.singleton(pageNum));
            setName(Integer.toString(pageNum + 1));
            int from = 1 + (pageNum * IMAGES_PER_PAGE);
            int to = from + ((ThumbnailPageNodeChildren) getChildren()).getChildCount() - 1;
            setDisplayName(from + "-" + to);

            this.setIconBaseWithExtension("org/sleuthkit/autopsy/images/Folder-icon.png"); //NON-NLS
        }
    }

    private class ThumbnailPageNodeChildren extends Children.Keys<Node> {

        /*
         * wrapped original nodes
         */
        private List<Node> keyNodes = null;

        ThumbnailPageNodeChildren(List<Node> keyNodes) {
            super(true);
            this.keyNodes = keyNodes;
        }

        @Override
        protected void addNotify() {
            super.addNotify();
            setKeys(keyNodes);
        }

        @Override
        protected void removeNotify() {
            super.removeNotify();
            setKeys(Collections.emptyList());
        }

        int getChildCount() {
            return keyNodes.size();
        }

        @Override
        protected Node[] createNodes(Node wrapped) {
            if (wrapped != null) {
                final ThumbnailViewNode thumb = new ThumbnailViewNode(wrapped, thumbSize);
                return new Node[]{thumb};
            } else {
                return new Node[]{};
            }
        }
    }
}