ContentUtils.java

Go to the documentation of this file.

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

import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.text.SimpleDateFormat;
import java.util.TimeZone;
import java.util.concurrent.Future;
import java.util.function.Supplier;
import java.util.logging.Level;
import java.util.prefs.PreferenceChangeEvent;
import java.util.prefs.PreferenceChangeListener;
import javax.swing.SwingWorker;
import org.netbeans.api.progress.ProgressHandle;
import org.openide.util.NbBundle;
import org.sleuthkit.autopsy.core.UserPreferences;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.datamodel.AbstractFile;
import org.sleuthkit.datamodel.Content;
import org.sleuthkit.datamodel.ContentVisitor;
import org.sleuthkit.datamodel.DerivedFile;
import org.sleuthkit.datamodel.Directory;
import org.sleuthkit.datamodel.File;
import org.sleuthkit.datamodel.Image;
import org.sleuthkit.datamodel.LayoutFile;
import org.sleuthkit.datamodel.LocalFile;
import org.sleuthkit.datamodel.LocalDirectory;
import org.sleuthkit.datamodel.ReadContentInputStream;
import org.sleuthkit.datamodel.ReadContentInputStream.ReadContentInputStreamException;
import org.sleuthkit.datamodel.SlackFile;
import org.sleuthkit.datamodel.TskCoreException;
import org.sleuthkit.datamodel.VirtualDirectory;

public final class ContentUtils {

    private final static Logger logger = Logger.getLogger(ContentUtils.class.getName());
    private static boolean displayTimesInLocalTime = UserPreferences.displayTimesInLocalTime();
    private static final SimpleDateFormat dateFormatter = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss z");
    private static final SimpleDateFormat dateFormatterISO8601 = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss'Z'");

    static {
        UserPreferences.addChangeListener(new PreferenceChangeListener() {
            @Override
            public void preferenceChange(PreferenceChangeEvent evt) {
                if (evt.getKey().equals(UserPreferences.DISPLAY_TIMES_IN_LOCAL_TIME)) {
                    displayTimesInLocalTime = UserPreferences.displayTimesInLocalTime();
                }
            }
        });
    }

    private ContentUtils() {
        throw new AssertionError();
    }

    public static String getStringTime(long epochSeconds, TimeZone tzone) {
        String time = "0000-00-00 00:00:00";
        if (epochSeconds != 0) {
            synchronized (dateFormatter) {
                dateFormatter.setTimeZone(tzone);
                time = dateFormatter.format(new java.util.Date(epochSeconds * 1000));
            }
        }
        return time;
    }

    public static String getStringTimeISO8601(long epochSeconds, TimeZone tzone) {
        String time = "0000-00-00T00:00:00Z"; //NON-NLS
        if (epochSeconds != 0) {
            synchronized (dateFormatterISO8601) {
                dateFormatterISO8601.setTimeZone(tzone);
                time = dateFormatterISO8601.format(new java.util.Date(epochSeconds * 1000));
            }
        }

        return time;
    }

    public static String getStringTime(long epochSeconds, Content content) {
        return getStringTime(epochSeconds, getTimeZone(content));
    }

    public static String getStringTimeISO8601(long epochSeconds, Content c) {
        return getStringTimeISO8601(epochSeconds, getTimeZone(c));
    }

    public static TimeZone getTimeZone(Content content) {

        try {
            if (!shouldDisplayTimesInLocalTime()) {
                return TimeZone.getTimeZone(UserPreferences.getTimeZoneForDisplays());
            } else {
                final Content dataSource = content.getDataSource();
                if ((dataSource != null) && (dataSource instanceof Image)) {
                    Image image = (Image) dataSource;
                    return TimeZone.getTimeZone(image.getTimeZone());
                } else {
                    //case such as top level VirtualDirectory
                    return TimeZone.getDefault();
                }
            }
        } catch (TskCoreException ex) {
            return TimeZone.getDefault();
        }
    }
    private static final SystemNameVisitor systemName = new SystemNameVisitor();

    public static String getSystemName(Content content) {
        return content.accept(systemName);
    }

    private static class SystemNameVisitor extends ContentVisitor.Default<String> {

        SystemNameVisitor() {
        }

        @Override
        protected String defaultVisit(Content cntnt) {
            return cntnt.getName() + ":" + Long.toString(cntnt.getId());
        }
    }
    private static final int TO_FILE_BUFFER_SIZE = 8192;

    public static <T> long writeToFile(Content content, java.io.File outputFile,
            ProgressHandle progress, Future<T> worker, boolean source) throws IOException {
        InputStream in = new ReadContentInputStream(content);

        // Get the unit size for a progress bar
        int unit = (int) (content.getSize() / 100);
        long totalRead = 0;

        try (FileOutputStream out = new FileOutputStream(outputFile, false)) {
            byte[] buffer = new byte[TO_FILE_BUFFER_SIZE];
            int len = in.read(buffer);
            while (len != -1) {
                // If there is a worker, check for a cancelation
                if (worker != null && worker.isCancelled()) {
                    break;
                }
                out.write(buffer, 0, len);
                len = in.read(buffer);
                totalRead += len;
                // If there is a progress bar and this is the source file,
                // report any progress
                if (progress != null && source && totalRead >= TO_FILE_BUFFER_SIZE) {
                    int totalProgress = (int) (totalRead / unit);
                    progress.progress(content.getName(), totalProgress);
                    // If it's not the source, just update the file being processed
                } else if (progress != null && !source) {
                    progress.progress(content.getName());
                }
            }
        } finally {
            in.close();
        }
        return totalRead;
    }

    public static void writeToFile(Content content, java.io.File outputFile) throws IOException {
        writeToFile(content, outputFile, null, null, false);
    }

    public static long writeToFile(Content content, java.io.File outputFile,
            Supplier<Boolean> cancelCheck) throws IOException {
        InputStream in = new ReadContentInputStream(content);
        long totalRead = 0;

        try (FileOutputStream out = new FileOutputStream(outputFile, false)) {
            byte[] buffer = new byte[TO_FILE_BUFFER_SIZE];
            int len = in.read(buffer);
            while (len != -1) {
                out.write(buffer, 0, len);
                totalRead += len;
                if (cancelCheck.get()) {
                    break;
                }
                len = in.read(buffer);
            }
        } finally {
            in.close();
        }
        return totalRead;
    }

    public static long writeToFile(Content content, java.io.File outputFile,
            Supplier<Boolean> cancelCheck, long startingOffset, long endingOffset) throws IOException {
        
        InputStream in = new ReadContentInputStream(content);
        long totalRead = 0;
        try (FileOutputStream out = new FileOutputStream(outputFile, false)) {
            long offsetSkipped = in.skip(startingOffset); 
            if (offsetSkipped != startingOffset) {
                in.close();
                throw new IOException(String.format("Skipping file to starting offset {0} was not successful only skipped to offset {1}.", startingOffset, offsetSkipped));            
            }
            byte[] buffer = new byte[TO_FILE_BUFFER_SIZE];
            int len = in.read(buffer);
            long writeFileLength = endingOffset - startingOffset;
            writeFileLength = writeFileLength - TO_FILE_BUFFER_SIZE;
            while (len != -1 && writeFileLength != 0) {
                out.write(buffer, 0, len);
                totalRead += len;
                if (cancelCheck.get()) {
                    break;
                }
                if (writeFileLength > TO_FILE_BUFFER_SIZE) {
                    len = in.read(buffer);
                    writeFileLength = writeFileLength - TO_FILE_BUFFER_SIZE;
                } else {
                    int writeLength = (int)writeFileLength;
                    byte[] lastBuffer = new byte[writeLength];
                    len = in.read(lastBuffer);
                    out.write(lastBuffer, 0, len);
                    totalRead += len;
                    writeFileLength = 0;
                }
            }
                
        } finally {
            in.close();
        }
        return totalRead;
    }

    public static boolean isDotDirectory(AbstractFile dir) {
        String name = dir.getName();
        return name.equals(".") || name.equals("..");
    }

    public static class ExtractFscContentVisitor<T, V> extends ContentVisitor.Default<Void> {

        java.io.File dest;
        ProgressHandle progress;
        SwingWorker<T, V> worker;
        boolean source = false;

        public ExtractFscContentVisitor(java.io.File dest,
                ProgressHandle progress, SwingWorker<T, V> worker, boolean source) {
            this.dest = dest;
            this.progress = progress;
            this.worker = worker;
            this.source = source;
        }

        public ExtractFscContentVisitor(java.io.File dest) {
            this.dest = dest;
        }

        public static <T, V> void extract(Content cntnt, java.io.File dest, ProgressHandle progress, SwingWorker<T, V> worker) {
            cntnt.accept(new ExtractFscContentVisitor<>(dest, progress, worker, true));
        }

        @Override
        public Void visit(File file) {
            try {
                ContentUtils.writeToFile(file, dest, progress, worker, source);
            } catch (ReadContentInputStreamException ex) {
                logger.log(Level.WARNING,
                        String.format("Error reading file '%s' (id=%d).",
                                file.getName(), file.getId()), ex); //NON-NLS
            } catch (IOException ex) {
                logger.log(Level.SEVERE,
                        String.format("Error extracting file '%s' (id=%d) to '%s'.",
                                file.getName(), file.getId(), dest.getAbsolutePath()), ex); //NON-NLS
            }
            return null;
        }

        @Override
        public Void visit(LayoutFile file) {
            try {
                ContentUtils.writeToFile(file, dest, progress, worker, source);
            } catch (ReadContentInputStreamException ex) {
                logger.log(Level.WARNING,
                        String.format("Error reading file '%s' (id=%d).",
                                file.getName(), file.getId()), ex); //NON-NLS
            } catch (IOException ex) {
                logger.log(Level.SEVERE,
                        String.format("Error extracting unallocated content file '%s' (id=%d) to '%s'.",
                                file.getName(), file.getId(), dest.getAbsolutePath()), ex); //NON-NLS
            }
            return null;
        }

        @Override
        public Void visit(DerivedFile file) {
            try {
                ContentUtils.writeToFile(file, dest, progress, worker, source);
            } catch (ReadContentInputStreamException ex) {
                logger.log(Level.WARNING,
                        String.format("Error reading file '%s' (id=%d).",
                                file.getName(), file.getId()), ex); //NON-NLS
            } catch (IOException ex) {
                logger.log(Level.SEVERE,
                        String.format("Error extracting derived file '%s' (id=%d) to '%s'.",
                                file.getName(), file.getId(), dest.getAbsolutePath()), ex); //NON-NLS
            }
            return null;
        }

        @Override
        public Void visit(LocalFile file) {
            try {
                ContentUtils.writeToFile(file, dest, progress, worker, source);
            } catch (ReadContentInputStreamException ex) {
                logger.log(Level.WARNING,
                        String.format("Error reading file '%s' (id=%d).",
                                file.getName(), file.getId()), ex); //NON-NLS
            } catch (IOException ex) {
                logger.log(Level.SEVERE,
                        String.format("Error extracting local file '%s' (id=%d) to '%s'.",
                                file.getName(), file.getId(), dest.getAbsolutePath()), ex); //NON-NLS
            }
            return null;
        }

        @Override
        public Void visit(SlackFile file) {
            try {
                ContentUtils.writeToFile(file, dest, progress, worker, source);
            } catch (ReadContentInputStreamException ex) {
                logger.log(Level.WARNING,
                        String.format("Error reading file '%s' (id=%d).",
                                file.getName(), file.getId()), ex); //NON-NLS
            } catch (IOException ex) {
                logger.log(Level.SEVERE,
                        String.format("Error extracting slack file '%s' (id=%d) to '%s'.",
                                file.getName(), file.getId(), dest.getAbsolutePath()), ex); //NON-NLS
            }
            return null;
        }

        @Override
        public Void visit(Directory dir) {
            return visitDir(dir);
        }

        @Override
        public Void visit(VirtualDirectory dir) {
            return visitDir(dir);
        }

        @Override
        public Void visit(LocalDirectory dir) {
            return visitDir(dir);
        }

        private java.io.File getFsContentDest(Content content) {
            String path = dest.getAbsolutePath() + java.io.File.separator
                    + content.getName();
            return new java.io.File(path);
        }

        public Void visitDir(AbstractFile dir) {

            // don't extract . and .. directories
            if (isDotDirectory(dir)) {
                return null;
            }

            dest.mkdir();

            try {
                int numProcessed = 0;
                // recurse on children
                for (Content child : dir.getChildren()) {
                    if (child instanceof AbstractFile) { //ensure the directory's artifact children are ignored
                        java.io.File childFile = getFsContentDest(child);
                        ExtractFscContentVisitor<T, V> childVisitor
                                = new ExtractFscContentVisitor<>(childFile, progress, worker, false);
                        // If this is the source directory of an extract it
                        // will have a progress and worker, and will keep track
                        // of the progress bar's progress
                        if (worker != null && worker.isCancelled()) {
                            break;
                        }
                        if (progress != null && source) {
                            progress.progress(child.getName(), numProcessed);
                        }
                        child.accept(childVisitor);
                        numProcessed++;
                    }
                }
            } catch (TskCoreException ex) {
                logger.log(Level.SEVERE,
                        "Trouble fetching children to extract.", ex); //NON-NLS
            }

            return null;
        }

        @Override
        protected Void defaultVisit(Content content) {
            throw new UnsupportedOperationException(NbBundle.getMessage(this.getClass(),
                    "ContentUtils.exception.msg",
                    content.getClass().getSimpleName()));
        }
    }

    public static boolean shouldDisplayTimesInLocalTime() {
        return displayTimesInLocalTime;
    }

}