ImageUtils.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011-2018 Basis Technology Corp.
 *
 * Copyright 2012 42six Solutions.
 * Contact: aebadirad <at> 42six <dot> com
 * Project Contact/Architect: 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.coreutils;
 
import com.google.common.collect.ImmutableSortedSet;
import java.awt.Image;
import java.awt.image.BufferedImage;
import java.io.BufferedInputStream;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.EnumSet;
import java.util.Iterator;
import java.util.List;
import java.util.Objects;
import static java.util.Objects.nonNull;
import java.util.SortedSet;
import java.util.TreeSet;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ExecutionException;
import java.util.concurrent.Executor;
import java.util.concurrent.Executors;
import java.util.logging.Level;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javafx.concurrent.Task;
import javafx.embed.swing.SwingFXUtils;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import javax.imageio.IIOException;
import javax.imageio.ImageIO;
import javax.imageio.ImageReadParam;
import javax.imageio.ImageReader;
import javax.imageio.event.IIOReadProgressListener;
import javax.imageio.stream.ImageInputStream;
import org.apache.commons.lang3.StringUtils;
import org.apache.commons.lang3.concurrent.BasicThreadFactory;
import org.openide.util.NbBundle;
import org.openide.util.NbBundle.Messages;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException;
import org.sleuthkit.autopsy.corelibs.OpenCvLoader;
import org.sleuthkit.autopsy.corelibs.ScalrWrapper;
import org.sleuthkit.autopsy.modules.filetypeid.FileTypeDetector;
import org.sleuthkit.autopsy.modules.filetypeid.FileTypeDetector.FileTypeDetectorInitException;
import org.sleuthkit.datamodel.AbstractFile;
import org.sleuthkit.datamodel.Content;
import org.sleuthkit.datamodel.ReadContentInputStream;
import org.sleuthkit.datamodel.TskCoreException;

public class ImageUtils {
 
    private static final Logger LOGGER = Logger.getLogger(ImageUtils.class.getName());

    private static final String FORMAT = "png"; //NON-NLS
 
    public static final int ICON_SIZE_SMALL = 50;
    public static final int ICON_SIZE_MEDIUM = 100;
    public static final int ICON_SIZE_LARGE = 200;
 
    private static final BufferedImage DEFAULT_THUMBNAIL;
 
    private static final List<String> GIF_EXTENSION_LIST = Arrays.asList("gif");
    private static final SortedSet<String> GIF_MIME_SET = ImmutableSortedSet.copyOf(new String[]{"image/gif"});
 
    private static final List<String> SUPPORTED_IMAGE_EXTENSIONS = new ArrayList<>();
    private static final SortedSet<String> SUPPORTED_IMAGE_MIME_TYPES;
 
    private static final boolean FFMPEG_LOADED;

    @Messages({"ImageUtils.ffmpegLoadedError.title=OpenCV FFMpeg",
        "ImageUtils.ffmpegLoadedError.msg=OpenCV FFMpeg library failed to load, see log for more details"})
    private static final ConcurrentHashMap<Long, File> cacheFileMap = new ConcurrentHashMap<>();
 
    static {
        ImageIO.scanForPlugins();
        BufferedImage tempImage;
        try {
            tempImage = ImageIO.read(ImageUtils.class.getResourceAsStream("/org/sleuthkit/autopsy/images/file-icon.png"));//NON-NLS
        } catch (IOException ex) {
            LOGGER.log(Level.SEVERE, "Failed to load default icon.", ex); //NON-NLS
            tempImage = null;
        }
        DEFAULT_THUMBNAIL = tempImage;
        boolean tempFfmpegLoaded = false;
        if (OpenCvLoader.openCvIsLoaded()) {
            try {
                if (System.getProperty("os.arch").equals("amd64") || System.getProperty("os.arch").equals("x86_64")) { //NON-NLS
                    System.loadLibrary("opencv_ffmpeg2413_64"); //NON-NLS
                } else {
                    System.loadLibrary("opencv_ffmpeg2413"); //NON-NLS
                }
                tempFfmpegLoaded = true;
            } catch (UnsatisfiedLinkError e) {
                tempFfmpegLoaded = false;
                LOGGER.log(Level.SEVERE, Bundle.ImageUtils_ffmpegLoadedError_msg(), e); //NON-NLS
                MessageNotifyUtil.Notify.show(Bundle.ImageUtils_ffmpegLoadedError_title(), Bundle.ImageUtils_ffmpegLoadedError_msg(), MessageNotifyUtil.MessageType.WARNING);
            }
        }
        FFMPEG_LOADED = tempFfmpegLoaded;
 
        // remove any empty extension types provided by ImageIO.getReaderFileSuffixes()
        // This prevents extensions added by SPI implementations from causing errors 
        // (i.e. 'jai-imageio' utilized with IcePDF)
        List<String> imageSuffixList = Arrays.stream(ImageIO.getReaderFileSuffixes())
            .filter((extension) -> StringUtils.isNotBlank(extension))
            .collect(Collectors.toList());
        
        SUPPORTED_IMAGE_EXTENSIONS.addAll(imageSuffixList);
        SUPPORTED_IMAGE_EXTENSIONS.add("tec"); // Add JFIF .tec files
        SUPPORTED_IMAGE_EXTENSIONS.removeIf("db"::equals); // remove db files
 
        List<String> mimeTypeList = Stream.of(ImageIO.getReaderMIMETypes())
                // remove any empty mime types provided by ImageIO.getReaderMIMETypes()
                // This prevents mime types added by SPI implementations from causing errors 
                // (i.e. 'jai-imageio' utilized with IcePDF)
                .filter((mimeType) -> StringUtils.isNotBlank(mimeType))
                .collect(Collectors.toList());
        
        SUPPORTED_IMAGE_MIME_TYPES = new TreeSet<>(mimeTypeList);
        /*
         * special cases and variants that we support, but don't get registered
         * with ImageIO automatically
         */
        SUPPORTED_IMAGE_MIME_TYPES.addAll(Arrays.asList(
                "image/x-rgb", //NON-NLS
                "image/x-ms-bmp", //NON-NLS
                "image/x-portable-graymap", //NON-NLS
                "image/x-portable-bitmap", //NON-NLS
                "image/webp", //NON-NLS
                "application/x-123")); //TODO: is this correct? -jm //NON-NLS
        SUPPORTED_IMAGE_MIME_TYPES.removeIf("application/octet-stream"::equals); //NON-NLS
 
        //Clear the file map when the case changes, so we don't accidentaly get images from the old case.
        Case.addEventTypeSubscriber(EnumSet.of(Case.Events.CURRENT_CASE), evt -> cacheFileMap.clear());
    }

    private static FileTypeDetector fileTypeDetector;

    private static final Executor imageSaver
            = Executors.newSingleThreadExecutor(new BasicThreadFactory.Builder()
                    .namingPattern("thumbnail-saver-%d").build()); //NON-NLS
 
    public static List<String> getSupportedImageExtensions() {
        return Collections.unmodifiableList(SUPPORTED_IMAGE_EXTENSIONS);
    }
 
    public static SortedSet<String> getSupportedImageMimeTypes() {
        return Collections.unmodifiableSortedSet(SUPPORTED_IMAGE_MIME_TYPES);
    }
    
    public static Image getDefaultThumbnail() {
        return DEFAULT_THUMBNAIL;
    }

    public static boolean thumbnailSupported(Content content) {
 
        if (!(content instanceof AbstractFile)) {
            return false;
        }
        AbstractFile file = (AbstractFile) content;

        List<String> supportedExtensions = new ArrayList<>(SUPPORTED_IMAGE_EXTENSIONS);
        supportedExtensions.addAll(VideoUtils.getSupportedVideoExtensions());
        if (isSupportedMediaExtension(file, supportedExtensions)) {
            return true;
        }
 
        return VideoUtils.isVideoThumbnailSupported(file)
               || isImageThumbnailSupported(file);
    }

    public static boolean isImageThumbnailSupported(AbstractFile file) {
        return isMediaThumbnailSupported(file, "image/", SUPPORTED_IMAGE_MIME_TYPES, SUPPORTED_IMAGE_EXTENSIONS) || hasImageFileHeader(file);//NON-NLS
    }

    public static boolean isGIF(AbstractFile file) {
        return isMediaThumbnailSupported(file, null, GIF_MIME_SET, GIF_EXTENSION_LIST);
    }

    static boolean isMediaThumbnailSupported(AbstractFile file, String mimeTypePrefix, final Collection<String> supportedMimeTypes, final List<String> supportedExtension) {
        if (false == file.isFile() || file.getSize() <= 0) {
            return false;
        }
 
        if (isSupportedMediaExtension(file, supportedExtension)) {
            return true;
        } else {
            try {
                String mimeType = getFileTypeDetector().getMIMEType(file);
                if (StringUtils.isNotBlank(mimeTypePrefix) && mimeType.startsWith(mimeTypePrefix)) {
                    return true;
                }
                return supportedMimeTypes.contains(mimeType);
            } catch (FileTypeDetectorInitException ex) {
                LOGGER.log(Level.SEVERE, "Error determining MIME type of " + getContentPathSafe(file), ex);//NON-NLS
                return false;
            }
        }
    }

    static boolean isSupportedMediaExtension(final AbstractFile file, final List<String> supportedExtensions) {
        String extension = file.getNameExtension();
 
        return (StringUtils.isNotBlank(extension) && supportedExtensions.contains(extension));
    }

    synchronized private static FileTypeDetector getFileTypeDetector() throws FileTypeDetector.FileTypeDetectorInitException {
        if (fileTypeDetector == null) {
            fileTypeDetector = new FileTypeDetector();
        }
        return fileTypeDetector;
    }

    public static BufferedImage getThumbnail(Content content, int iconSize) {
        if (content instanceof AbstractFile) {
            AbstractFile file = (AbstractFile) content;
            if (ImageUtils.isGIF(file)) {
                /*
                 * Intercepting the image reading code for GIFs here allows us
                 * to rescale easily, but we lose animations.
                 */
                try (BufferedInputStream bufferedReadContentStream = getBufferedReadContentStream(file);) {
                    if (Thread.interrupted()) {
                        return DEFAULT_THUMBNAIL;
                    }
                    final BufferedImage image = ImageIO.read(bufferedReadContentStream);
                    if (image != null) {
                        if (Thread.interrupted()) {
                            return DEFAULT_THUMBNAIL;
                        }
                        return ScalrWrapper.resizeHighQuality(image, iconSize, iconSize);
                    }
                } catch (IOException iOException) {
                    LOGGER.log(Level.WARNING, "Failed to get thumbnail for " + getContentPathSafe(content), iOException); //NON-NLS
                }
                return DEFAULT_THUMBNAIL;
            }
 
            Task<javafx.scene.image.Image> thumbnailTask = newGetThumbnailTask(file, iconSize, true);
            if (Thread.interrupted()) {
                return DEFAULT_THUMBNAIL;
            }
            thumbnailTask.run();
            try {
                return SwingFXUtils.fromFXImage(thumbnailTask.get(), null);
            } catch (InterruptedException | ExecutionException ex) {
                LOGGER.log(Level.WARNING, "Failed to get thumbnail for " + getContentPathSafe(content), ex); //NON-NLS
            }
        }
        return DEFAULT_THUMBNAIL;
    }

    private static BufferedInputStream getBufferedReadContentStream(AbstractFile file) {
        return new BufferedInputStream(new ReadContentInputStream(file));
    }

    @Nullable
    public static File getCachedThumbnailFile(Content content, int iconSize) {
        getThumbnail(content, iconSize);
        return getCachedThumbnailLocation(content.getId());
    }

    private static File getCachedThumbnailLocation(long fileID) {
        return cacheFileMap.computeIfAbsent(fileID, id -> {
            try {
                String cacheDirectory = Case.getCurrentCaseThrows().getCacheDirectory();
                return Paths.get(cacheDirectory, "thumbnails", fileID + ".png").toFile(); //NON-NLS
            } catch (NoCurrentCaseException e) {
                LOGGER.log(Level.INFO, "Could not get cached thumbnail location.  No case is open."); //NON-NLS
                return null;
            }
        });
    }

    public static boolean hasImageFileHeader(AbstractFile file) {
        return isJpegFileHeader(file) || isPngFileHeader(file);
    }

    public static boolean isJpegFileHeader(AbstractFile file) {
        if (file.getSize() < 100) {
            return false;
        }
 
        try {
            byte[] fileHeaderBuffer = readHeader(file, 2);
            /*
             * Check for the JPEG header. Since Java bytes are signed, we cast
             * them to an int first.
             */
            return (((fileHeaderBuffer[0] & 0xff) == 0xff) && ((fileHeaderBuffer[1] & 0xff) == 0xd8));
        } catch (TskCoreException ex) {
            //ignore if can't read the first few bytes, not a JPEG
            return false;
        }
    }

    private static long getJfifStartOfImageOffset(AbstractFile file) {
        byte[] fileHeaderBuffer;
        long length;
        try {
            length = file.getSize();
            if (length % 2 != 0) {
                length -= 1; // Make it an even number so we can parse two bytes at a time
            }
            if (length >= 1024) {
                length = 1024;
            }
            fileHeaderBuffer = readHeader(file, (int) length); // read up to first 1024 bytes
        } catch (TskCoreException ex) {
            // Couldn't read header. Let ImageIO try it.
            return 0;
        }
 
        if (fileHeaderBuffer != null) {
            for (int index = 0; index < length; index += 2) {
                // Look for Start Of Image marker and return the index when it's found
                if ((fileHeaderBuffer[index] == (byte) 0xFF) && (fileHeaderBuffer[index + 1] == (byte) 0xD8)) {
                    return index;
                }
            }
        }
 
        // Didn't match JFIF. Let ImageIO try to open it from offset 0.
        return 0;
    }

    public static boolean isPngFileHeader(AbstractFile file) {
        if (file.getSize() < 10) {
            return false;
        }
 
        try {
            byte[] fileHeaderBuffer = readHeader(file, 8);
            /*
             * Check for the png header. Since Java bytes are signed, we cast
             * them to an int first.
             */
            return (((fileHeaderBuffer[1] & 0xff) == 0x50) && ((fileHeaderBuffer[2] & 0xff) == 0x4E)
                    && ((fileHeaderBuffer[3] & 0xff) == 0x47) && ((fileHeaderBuffer[4] & 0xff) == 0x0D)
                    && ((fileHeaderBuffer[5] & 0xff) == 0x0A) && ((fileHeaderBuffer[6] & 0xff) == 0x1A)
                    && ((fileHeaderBuffer[7] & 0xff) == 0x0A));
 
        } catch (TskCoreException ex) {
            //ignore if can't read the first few bytes, not an png
            return false;
        }
    }
 
    private static byte[] readHeader(AbstractFile file, int buffLength) throws TskCoreException {
        byte[] fileHeaderBuffer = new byte[buffLength];
        int bytesRead = file.read(fileHeaderBuffer, 0, buffLength);
 
        if (bytesRead != buffLength) {
            //ignore if can't read the first few bytes, not an image
            throw new TskCoreException("Could not read " + buffLength + " bytes from " + file.getName());//NON-NLS
        }
        return fileHeaderBuffer;
    }

    static public int getImageWidth(AbstractFile file) throws IOException {
        return getImageProperty(file,
                "ImageIO could not determine width of {0}: ", //NON-NLS
                imageReader -> imageReader.getWidth(0)
        );
    }

    static public int getImageHeight(AbstractFile file) throws IOException {
        return getImageProperty(file,
                "ImageIO could not determine height of {0}: ", //NON-NLS
                imageReader -> imageReader.getHeight(0)
        );
 
    }

    @FunctionalInterface
    private static interface PropertyExtractor<T> {
 
        public T extract(ImageReader reader) throws IOException;
    }

    private static <T> T getImageProperty(AbstractFile file, final String errorTemplate, PropertyExtractor<T> propertyExtractor) throws IOException {
        try (InputStream inputStream = getBufferedReadContentStream(file);
                ImageInputStream input = ImageIO.createImageInputStream(inputStream)) {
            if (input == null) {
                IIOException iioException = new IIOException("Could not create ImageInputStream.");
                LOGGER.log(Level.WARNING, errorTemplate + iioException.toString(), getContentPathSafe(file));
                throw iioException;
            }
            Iterator<ImageReader> readers = ImageIO.getImageReaders(input);
 
            if (readers.hasNext()) {
                ImageReader reader = readers.next();
                reader.setInput(input);
                try {
                    return propertyExtractor.extract(reader);
                } catch (IOException ex) {
                    LOGGER.log(Level.WARNING, errorTemplate + ex.toString(), getContentPathSafe(file));
                    throw ex;
                } finally {
                    reader.dispose();
                }
            } else {
                IIOException iioException = new IIOException("No ImageReader found.");
                LOGGER.log(Level.WARNING, errorTemplate + iioException.toString(), getContentPathSafe(file));
                throw iioException;
            }
        }
    }

    public static Task<javafx.scene.image.Image> newGetThumbnailTask(AbstractFile file, int iconSize, boolean defaultOnFailure) {
        return new GetThumbnailTask(file, iconSize, defaultOnFailure);
 
    }

    static private class GetThumbnailTask extends ReadImageTaskBase {
 
        private static final String FAILED_TO_READ_IMAGE_FOR_THUMBNAIL_GENERATION = "Failed to read {0} for thumbnail generation."; //NON-NLS
 
        private final int iconSize;
        private final File cacheFile;
        private final boolean defaultOnFailure;
 
        @NbBundle.Messages({"# {0} - file name",
            "GetOrGenerateThumbnailTask.loadingThumbnailFor=Loading thumbnail for {0}",
            "# {0} - file name",
            "GetOrGenerateThumbnailTask.generatingPreviewFor=Generating preview for {0}"})
        private GetThumbnailTask(AbstractFile file, int iconSize, boolean defaultOnFailure) {
            super(file);
            updateMessage(Bundle.GetOrGenerateThumbnailTask_loadingThumbnailFor(file.getName()));
            this.iconSize = iconSize;
            this.defaultOnFailure = defaultOnFailure;
            this.cacheFile = getCachedThumbnailLocation(file.getId());
        }
 
        @Override
        protected javafx.scene.image.Image call() throws Exception {
            if (isCancelled()) {
                return null;
            }
            if (isGIF(file)) {
                return readImage();
            }
 
            // If a thumbnail file is already saved locally, just read that.
            if (cacheFile != null) {
                synchronized (cacheFile) {
                    if (cacheFile.exists()) {
                        try {
                            if (isCancelled()) {
                                return null;
                            }
                            BufferedImage cachedThumbnail = ImageIO.read(cacheFile);
                            if (isCancelled()) {
                                return null;
                            }
                            if (nonNull(cachedThumbnail) && cachedThumbnail.getWidth() == iconSize) {
                                return SwingFXUtils.toFXImage(cachedThumbnail, null);
                            }
                        } catch (Exception ex) {
                            LOGGER.log(Level.WARNING, "ImageIO had a problem reading the cached thumbnail for {0}: " + ex.toString(), ImageUtils.getContentPathSafe(file)); //NON-NLS
                            cacheFile.delete();  //since we can't read the file we might as well delete it.
                        }
                    }
                }
            }
 
            //There was no correctly-sized cached thumbnail so make one.
            BufferedImage thumbnail = null;
            if (VideoUtils.isVideoThumbnailSupported(file)) {
                if (FFMPEG_LOADED) {
                    updateMessage(Bundle.GetOrGenerateThumbnailTask_generatingPreviewFor(file.getName()));
                    if (isCancelled()) {
                        return null;
                    }
                    thumbnail = VideoUtils.generateVideoThumbnail(file, iconSize);
                }
                if (null == thumbnail) {
                    if (defaultOnFailure) {
                        thumbnail = DEFAULT_THUMBNAIL;
                    } else {
                        throw new IIOException("Failed to generate a thumbnail for " + getContentPathSafe(file));//NON-NLS
                    }
                }
 
            } else {
                if (isCancelled()) {
                    return null;
                }
                //read the image into a buffered image.
                //TODO: I don't like this, we just converted it from BufferedIamge to fx Image -jm
                BufferedImage bufferedImage = SwingFXUtils.fromFXImage(readImage(), null);
                if (null == bufferedImage) {
                    String msg = MessageFormat.format(FAILED_TO_READ_IMAGE_FOR_THUMBNAIL_GENERATION, getContentPathSafe(file));
                    LOGGER.log(Level.WARNING, msg);
                    throw new IIOException(msg);
                }
                updateProgress(-1, 1);
                if (isCancelled()) {
                    return null;
                }
                //resize, or if that fails, crop it
                try {
                    if (isCancelled()) {
                        return null;
                    }
                    thumbnail = ScalrWrapper.resizeFast(bufferedImage, iconSize);
                } catch (IllegalArgumentException | OutOfMemoryError e) {
                    // if resizing does not work due to extreme aspect ratio or oom, crop the image instead.
                    LOGGER.log(Level.WARNING, "Cropping {0}, because it could not be scaled: " + e.toString(), ImageUtils.getContentPathSafe(file)); //NON-NLS
 
                    final int height = bufferedImage.getHeight();
                    final int width = bufferedImage.getWidth();
                    if (iconSize < height || iconSize < width) {
                        final int cropHeight = Math.min(iconSize, height);
                        final int cropWidth = Math.min(iconSize, width);
                        try {
                            if (isCancelled()) {
                                return null;
                            }
                            if (isCancelled()) {
                                return null;
                            }
                            thumbnail = ScalrWrapper.cropImage(bufferedImage, cropWidth, cropHeight);
                        } catch (Exception cropException) {
                            LOGGER.log(Level.WARNING, "Could not crop {0}: " + cropException.toString(), ImageUtils.getContentPathSafe(file)); //NON-NLS
                        }
                    }
                } catch (Exception e) {
                    LOGGER.log(Level.WARNING, "Could not scale {0}: " + e.toString(), ImageUtils.getContentPathSafe(file)); //NON-NLS
                    throw e;
                }
            }
 
            updateProgress(-1, 1);
 
            //if we got a valid thumbnail save it
            if ((cacheFile != null) && thumbnail != null && DEFAULT_THUMBNAIL != thumbnail) {
                saveThumbnail(thumbnail);
            }
            if (isCancelled()) {
                return null;
            }
            return SwingFXUtils.toFXImage(thumbnail, null);
        }

        private void saveThumbnail(BufferedImage thumbnail) {
            imageSaver.execute(() -> {
                try {
                    synchronized (cacheFile) {
                        Path path = Paths.get(cacheFile.getParent()); 
                        File thumbsDir = Paths.get(cacheFile.getParent()).toFile();
                        if (!thumbsDir.exists()) {
                            thumbsDir.mkdirs();
                        }
        
                        if (cacheFile.exists()) {
                            cacheFile.delete();
                        }
                        ImageIO.write(thumbnail, FORMAT, cacheFile);
                    }
                } catch (Exception ex) {
                    LOGGER.log(Level.WARNING, "Could not write thumbnail for {0}: " + ex.toString(), ImageUtils.getContentPathSafe(file)); //NON-NLS
                }
            });
        }
    }

    public static Task<javafx.scene.image.Image> newReadImageTask(AbstractFile file) {
        return new ReadImageTask(file);
 
    }

    @NbBundle.Messages({
        "# {0} - file name",
        "ReadImageTask.mesageText=Reading image: {0}"})
    static private class ReadImageTask extends ReadImageTaskBase {
 
        ReadImageTask(AbstractFile file) {
            super(file);
            updateMessage(Bundle.ReadImageTask_mesageText(file.getName()));
        }
 
        @Override
        protected javafx.scene.image.Image call() throws Exception {
            return readImage();
        }
    }

    static private abstract class ReadImageTaskBase extends Task<javafx.scene.image.Image> implements IIOReadProgressListener {
 
        private static final String IMAGEIO_COULD_NOT_READ_UNSUPPORTED_OR_CORRUPT = "ImageIO could not read {0}.  It may be unsupported or corrupt"; //NON-NLS
        final AbstractFile file;
 
        ReadImageTaskBase(AbstractFile file) {
            this.file = file;
        }
 
        protected javafx.scene.image.Image readImage() throws IOException {
            if (isCancelled()) {
                return null;
            }
            if (ImageUtils.isGIF(file)) {
                //use JavaFX to directly read GIF to preserve potential animation
                javafx.scene.image.Image image = new javafx.scene.image.Image(getBufferedReadContentStream(file));
                if (image.isError() == false) {
                    return image;
                }
            } else if (file.getNameExtension().equalsIgnoreCase("tec")) { //NON-NLS
                ReadContentInputStream readContentInputStream = new ReadContentInputStream(file);
                // Find first Start Of Image marker
                readContentInputStream.seek(getJfifStartOfImageOffset(file));
                //use JavaFX to directly read .tec files
                javafx.scene.image.Image image = new javafx.scene.image.Image(new BufferedInputStream(readContentInputStream));
                if (image.isError() == false) {
                    return image;
                }
            }
            //fall through to default image reading code if there was an error
            return getImageProperty(file, "ImageIO could not read {0}: ",
                    imageReader -> {
                        imageReader.addIIOReadProgressListener(ReadImageTaskBase.this);
                        /*
                         * This is the important part, get or create a
                         * ImageReadParam, create a destination image to hold
                         * the decoded result, then pass that image with the
                         * param.
                         */
                        ImageReadParam param = imageReader.getDefaultReadParam();
                        BufferedImage bufferedImage = imageReader.getImageTypes(0).next().createBufferedImage(imageReader.getWidth(0), imageReader.getHeight(0));
                        param.setDestination(bufferedImage);
                        try {
                            if (isCancelled()) {
                                return null;
                            }
                            bufferedImage = imageReader.read(0, param); //should always be same bufferedImage object
                        } catch (IOException iOException) {
                            LOGGER.log(Level.WARNING, IMAGEIO_COULD_NOT_READ_UNSUPPORTED_OR_CORRUPT + ": " + iOException.toString(), ImageUtils.getContentPathSafe(file)); //NON-NLS
                        } finally {
                            imageReader.removeIIOReadProgressListener(ReadImageTaskBase.this);
                        }
                        if (isCancelled()) {
                            return null;
                        }
                        return SwingFXUtils.toFXImage(bufferedImage, null);
                    }
            );
        }
 
        @Override
        public void imageProgress(ImageReader reader, float percentageDone) {
            //update this task with the progress reported by ImageReader.read
            updateProgress(percentageDone, 100);
            if (isCancelled()) {
                reader.removeIIOReadProgressListener(this);
                reader.abort();
                reader.dispose();
            }
        }
 
        @Override
        public boolean isCancelled() {
            if (Thread.interrupted()) {
                this.cancel(true);
                return true;
            }
            return super.isCancelled();
        }
 
        @Override
        protected void succeeded() {
            super.succeeded();
            try {
                javafx.scene.image.Image fxImage = get();
                if (fxImage == null) {
                    LOGGER.log(Level.WARNING, IMAGEIO_COULD_NOT_READ_UNSUPPORTED_OR_CORRUPT, ImageUtils.getContentPathSafe(file));
                } else if (fxImage.isError()) {
                    //if there was somekind of error, log it
                    LOGGER.log(Level.WARNING, IMAGEIO_COULD_NOT_READ_UNSUPPORTED_OR_CORRUPT + ": " + Objects.toString(fxImage.getException()), ImageUtils.getContentPathSafe(file));
                }
            } catch (InterruptedException | ExecutionException ex) {
                failed();
            }
        }
 
        @Override
        protected void failed() {
            super.failed();
            LOGGER.log(Level.WARNING, IMAGEIO_COULD_NOT_READ_UNSUPPORTED_OR_CORRUPT + ": " + Objects.toString(getException()), ImageUtils.getContentPathSafe(file));
        }
 
        @Override
        public void imageComplete(ImageReader source) {
            updateProgress(100, 100);
        }
 
        @Override
        public void imageStarted(ImageReader source, int imageIndex) {
        }
 
        @Override
        public void sequenceStarted(ImageReader source, int minIndex) {
        }
 
        @Override
        public void sequenceComplete(ImageReader source) {
        }
 
        @Override
        public void thumbnailStarted(ImageReader source, int imageIndex, int thumbnailIndex) {
        }
 
        @Override
        public void thumbnailProgress(ImageReader source, float percentageDone) {
        }
 
        @Override
        public void thumbnailComplete(ImageReader source) {
        }
 
        @Override
        public void readAborted(ImageReader source) {
        }
    }

    static String getContentPathSafe(Content content) {
        try {
            return content.getUniquePath();
        } catch (TskCoreException tskCoreException) {
            String contentName = content.getName();
            LOGGER.log(Level.SEVERE, "Failed to get unique path for " + contentName, tskCoreException); //NON-NLS
            return contentName;
        }
    }

    @Deprecated
    public static Image getDefaultIcon() {
        return getDefaultThumbnail();
    }

    @Deprecated
 
    public static File getFile(long id) {
        return getCachedThumbnailLocation(id);
    }

    @Nonnull
    @Deprecated
    public static BufferedImage getIcon(Content content, int iconSize) {
        return getThumbnail(content, iconSize);
    }

    @Nullable
    @Deprecated
    public static File getIconFile(Content content, int iconSize) {
        return getCachedThumbnailFile(content, iconSize);
 
    }
}