ExtractUnallocAction.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.directorytree;

import java.awt.Component;
import java.awt.Frame;
import java.awt.event.ActionEvent;
import java.io.File;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.lang.reflect.InvocationTargetException;
import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator;
import java.util.List;
import java.util.Set;
import java.util.HashSet;
import java.util.concurrent.ExecutionException;
import java.util.logging.Level;
import javax.swing.AbstractAction;
import javax.swing.JFileChooser;
import static javax.swing.JFileChooser.SAVE_DIALOG;
import javax.swing.JOptionPane;
import javax.swing.SwingUtilities;
import javax.swing.SwingWorker;
import org.netbeans.api.progress.ProgressHandle;
import org.openide.util.Cancellable;
import org.openide.util.NbBundle;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.coreutils.MessageNotifyUtil;
import org.sleuthkit.autopsy.guiutils.JFileChooserFactory;
import org.sleuthkit.datamodel.AbstractContent;
import org.sleuthkit.datamodel.AbstractFile;
import org.sleuthkit.datamodel.Content;
import org.sleuthkit.datamodel.ContentVisitor;
import org.sleuthkit.datamodel.Directory;
import org.sleuthkit.datamodel.FileSystem;
import org.sleuthkit.datamodel.Image;
import org.sleuthkit.datamodel.LayoutFile;
import org.sleuthkit.datamodel.TskCoreException;
import org.sleuthkit.datamodel.VirtualDirectory;
import org.sleuthkit.datamodel.Volume;
import org.sleuthkit.datamodel.VolumeSystem;

final class ExtractUnallocAction extends AbstractAction {

    private static final Logger logger = Logger.getLogger(ExtractUnallocAction.class.getName());
    private static final long serialVersionUID = 1L;

    private static final Set<String> volumesInProgress = new HashSet<>();
    private static final Set<Long> imagesInProgress = new HashSet<>();
    private static String userDefinedExportPath;

    private final Volume volume;
    private final Image image;

    private final JFileChooserFactory chooserFactory;

    ExtractUnallocAction(String title, Volume volume) {
        this(title, null, volume);
        
    }

    ExtractUnallocAction(String title, Image image) {
        this(title, image, null);
    }

    ExtractUnallocAction(String title, Image image, Volume volume) {
        super(title);

        this.volume = null;
        this.image = image;
        
        chooserFactory = new JFileChooserFactory(CustomFileChooser.class);
    }

    @NbBundle.Messages({"# {0} - fileName",
        "ExtractUnallocAction.volumeInProgress=Already extracting unallocated space into {0} - will skip this volume",
        "ExtractUnallocAction.volumeError=Error extracting unallocated space from volume",
        "ExtractUnallocAction.noFiles=No unallocated files found on volume",
        "ExtractUnallocAction.imageError=Error extracting unallocated space from image",
        "ExtractUnallocAction.noOpenCase.errMsg=No open case available."})
    @Override
    public void actionPerformed(ActionEvent event) {

        Case openCase;
        try {
            openCase = Case.getCurrentCaseThrows();
        } catch (NoCurrentCaseException ex) {
            MessageNotifyUtil.Message.info(Bundle.ExtractUnallocAction_noOpenCase_errMsg());
            return;
        }

        JFileChooser fileChooser = chooserFactory.getChooser();

        fileChooser.setCurrentDirectory(new File(getExportDirectory(openCase)));
        if (JFileChooser.APPROVE_OPTION != fileChooser.showSaveDialog((Component) event.getSource())) {
            return;
        }

        String destination = fileChooser.getSelectedFile().getPath();
        updateExportDirectory(destination, openCase);

        if (image != null && isImageInProgress(image.getId())) {
            MessageNotifyUtil.Message.info(NbBundle.getMessage(this.getClass(), "ExtractUnallocAction.notifyMsg.unallocAlreadyBeingExtr.msg"));
            JOptionPane.showMessageDialog(new Frame(), "Unallocated Space is already being extracted on this Image. Please select a different Image.");
            return;
        }

        ExtractUnallocWorker worker = new ExtractUnallocWorker(openCase, destination);
        worker.execute();
    }

    private String getExportDirectory(Case openCase) {
        String caseExportPath = openCase.getExportDirectory();

        if (userDefinedExportPath == null) {
            return caseExportPath;
        }

        File file = new File(userDefinedExportPath);
        if (file.exists() == false || file.isDirectory() == false) {
            return caseExportPath;
        }

        return userDefinedExportPath;
    }

    private void updateExportDirectory(String exportPath, Case openCase) {
        if (exportPath.equalsIgnoreCase(openCase.getExportDirectory())) {
            userDefinedExportPath = null;
        } else {
            userDefinedExportPath = exportPath;
        }
    }

    private List<LayoutFile> getUnallocFiles(Content content) {
        UnallocVisitor unallocVisitor = new UnallocVisitor();
        try {
            for (Content contentChild : content.getChildren()) {
                if (contentChild instanceof AbstractContent) {
                    return contentChild.accept(unallocVisitor);  //call on first non-artifact child added to database
                }
            }
        } catch (TskCoreException tce) {
            logger.log(Level.WARNING, "Couldn't get a list of Unallocated Files, failed at sending out the visitor ", tce); //NON-NLS
        }
        return Collections.emptyList();
    }

    synchronized static private void addVolumeInProgress(String volumeOutputFileName) throws TskCoreException {
        if (volumesInProgress.contains(volumeOutputFileName)) {
            throw new TskCoreException("Already writing unallocated space to " + volumeOutputFileName);
        }
        volumesInProgress.add(volumeOutputFileName);
    }

    synchronized static private void removeVolumeInProgress(String volumeOutputFileName) {
        volumesInProgress.remove(volumeOutputFileName);
    }

    synchronized static private boolean isVolumeInProgress(String volumeOutputFileName) {
        return volumesInProgress.contains(volumeOutputFileName);
    }

    synchronized static private void addImageInProgress(Long objId) throws TskCoreException {
        if (imagesInProgress.contains(objId)) {
            throw new TskCoreException("Image " + objId + " is in use");
        }
        imagesInProgress.add(objId);
    }

    synchronized static private void removeImageInProgress(Long objId) {
        imagesInProgress.remove(objId);
    }

    synchronized static private boolean isImageInProgress(Long objId) {
        return imagesInProgress.contains(objId);
    }

    private class ExtractUnallocWorker extends SwingWorker<Integer, Integer> {

        private ProgressHandle progress;
        private boolean canceled = false;
        private final List<OutputFileData> outputFileDataList = new ArrayList<>();
        private File currentlyProcessing;
        private int totalSizeinMegs;
        long totalBytes = 0;
        private final String destination;
        private Case openCase;

        ExtractUnallocWorker(Case openCase, String destination) {
            this.destination = destination;
            this.openCase = openCase;
        }

        private int toMb(long bytes) {
            if (bytes > 1024 && (bytes / 1024.0) <= Double.MAX_VALUE) {
                double megabytes = ((bytes / 1024.0) / 1024.0);//Bytes -> Megabytes
                if (megabytes <= Integer.MAX_VALUE) {
                    return (int) Math.ceil(megabytes);
                }
            }
            return 0;
        }

        @Override
        protected Integer doInBackground() {
            try {
                initalizeFilesToExtract();
                progress = ProgressHandle.createHandle(
                        NbBundle.getMessage(this.getClass(), "ExtractUnallocAction.progress.extractUnalloc.title"), new Cancellable() {
                    @Override
                    public boolean cancel() {
                        logger.log(Level.INFO, "Canceling extraction of unallocated space"); //NON-NLS
                        canceled = true;
                        if (progress != null) {
                            progress.setDisplayName(NbBundle.getMessage(this.getClass(),
                                    "ExtractUnallocAction.progress.displayName.cancelling.text"));
                        }
                        return true;
                    }
                });
                int MAX_BYTES = 8192;
                byte[] buf = new byte[MAX_BYTES];    //read 8kb at a time                         

                //Begin the actual File IO
                progress.start(totalSizeinMegs);
                int kbs = 0; //Each completion of the while loop adds one to kbs. 16kb * 64 = 1mb. 
                int mbs = 0; //Increments every 128th tick of  kbs
                for (OutputFileData outputFileData : this.outputFileDataList) {
                    currentlyProcessing = outputFileData.getFile();
                    logger.log(Level.INFO, "Writing Unalloc file to {0}", currentlyProcessing.getPath()); //NON-NLS
                    try (OutputStream outputStream = new FileOutputStream(currentlyProcessing)) {
                        long bytes = 0;
                        int i = 0;
                        while (i < outputFileData.getLayouts().size() && bytes != outputFileData.getSizeInBytes()) {
                            LayoutFile layoutFile = outputFileData.getLayouts().get(i);
                            long offsetPerFile = 0L;
                            int bytesRead;
                            while (offsetPerFile != layoutFile.getSize() && !canceled) {
                                if (++kbs % 128 == 0) {
                                    mbs++;
                                    progress.progress(NbBundle.getMessage(this.getClass(),
                                            "ExtractUnallocAction.processing.counter.msg",
                                            mbs, totalSizeinMegs), mbs - 1);
                                }
                                bytesRead = layoutFile.read(buf, offsetPerFile, MAX_BYTES);
                                offsetPerFile += bytesRead;
                                outputStream.write(buf, 0, bytesRead);
                            }
                            bytes += layoutFile.getSize();
                            i++;
                        }
                        outputStream.flush();
                    }

                    if (canceled) {
                        outputFileData.getFile().delete();
                        logger.log(Level.INFO, "Canceled extraction of {0} and deleted file", outputFileData.getFileName()); //NON-NLS
                    } else {
                        logger.log(Level.INFO, "Finished writing unalloc file {0}", outputFileData.getFile().getPath()); //NON-NLS
                    }
                }
                progress.finish();

            } catch (IOException ex) {
                logger.log(Level.WARNING, "Could not create Unalloc File; error writing file", ex); //NON-NLS
                return -1;
            } catch (TskCoreException ex) {
                logger.log(Level.WARNING, "Could not create Unalloc File; error getting image info", ex); //NON-NLS
                return -1;
            }
            return 1;
        }

        @Override
        protected void done() {
            if (image != null) {
                removeImageInProgress(image.getId());
            }
            for (OutputFileData u : outputFileDataList) {
                removeVolumeInProgress(u.getFileName());
            }

            try {
                get();
                if (!canceled && !outputFileDataList.isEmpty()) {
                    MessageNotifyUtil.Notify.info(NbBundle.getMessage(this.getClass(),
                            "ExtractUnallocAction.done.notifyMsg.completedExtract.title"),
                            NbBundle.getMessage(this.getClass(),
                                    "ExtractUnallocAction.done.notifyMsg.completedExtract.msg",
                                    outputFileDataList.get(0).getFile().getParent()));
                }
            } catch (InterruptedException | ExecutionException ex) {
                MessageNotifyUtil.Notify.error(
                        NbBundle.getMessage(this.getClass(), "ExtractUnallocAction.done.errMsg.title"),
                        NbBundle.getMessage(this.getClass(), "ExtractUnallocAction.done.errMsg.msg", ex.getMessage()));
                logger.log(Level.SEVERE, "Failed to extract unallocated space", ex);
            } // catch and ignore if we were cancelled
            catch (java.util.concurrent.CancellationException ex) {
            }
        }

        private void initalizeFilesToExtract() throws TskCoreException {
            List<OutputFileData> filesToExtract = new ArrayList<>();

            if (volume != null) {
                OutputFileData outputFileData = new OutputFileData(volume, openCase);
                filesToExtract.add(outputFileData);

            } else {
                if (hasVolumeSystem(image)) {
                    for (Volume v : getVolumes(image)) {
                        OutputFileData outputFileData = new OutputFileData(v, openCase);
                        filesToExtract.add(outputFileData);
                    }
                } else {
                    OutputFileData outputFileData = new OutputFileData(image, openCase);
                    filesToExtract.add(outputFileData);
                }
            }

            if (filesToExtract.isEmpty() == false) {

                List<OutputFileData> copyList = new ArrayList<OutputFileData>() {
                    {
                        addAll(filesToExtract);
                    }
                };

                for (OutputFileData outputFileData : filesToExtract) {
                    outputFileData.setPath(destination);
                    if (outputFileData.getLayouts() != null && !outputFileData.getLayouts().isEmpty() && (!isVolumeInProgress(outputFileData.getFileName()))) {
                        //Format for single Unalloc File is ImgName-Unalloc-ImgObjectID-VolumeID.dat  

                        // Check if there is already a file with this name
                        if (outputFileData.getFile().exists()) {
                            final Result dialogResult = new Result();
                            try {
                                SwingUtilities.invokeAndWait(new Runnable() {
                                    @Override
                                    public void run() {
                                        dialogResult.set(JOptionPane.showConfirmDialog(new Frame(), NbBundle.getMessage(this.getClass(),
                                                "ExtractUnallocAction.confDlg.unallocFileAlreadyExist.msg",
                                                outputFileData.getFileName())));
                                    }
                                });
                            } catch (InterruptedException | InvocationTargetException ex) {
                               logger.log(Level.SEVERE, "An error occured launching confirmation dialog for extract unalloc actions", ex);
                            }

                            if (dialogResult.value == JOptionPane.YES_OPTION) {
                                // If the user wants to overwrite, delete the exising output file
                                outputFileData.getFile().delete();
                            } else {
                                // Otherwise remove it from the list of output files
                                copyList.remove(outputFileData);
                            }
                        }
                    } else {
                        // The output file for this volume could not be created for one of the following reasons
                        if (outputFileData.getLayouts() == null) {
                            logger.log(Level.SEVERE, "Tried to get unallocated content but the list of unallocated files was null"); //NON-NLS
                        } else if (outputFileData.getLayouts().isEmpty()) {
                            logger.log(Level.WARNING, "No unallocated files found in volume"); //NON-NLS
                            copyList.remove(outputFileData);
                        } else {
                            logger.log(Level.WARNING, "Tried to get unallocated content but the volume is locked");  // NON_NLS
                            copyList.remove(outputFileData);
                        }
                    }
                }

                if (!copyList.isEmpty()) {

                    setDataFileList(copyList);

                }
            }
        }

        private void setDataFileList(List<OutputFileData> outputFileDataList) throws TskCoreException {

            if (image != null) {
                addImageInProgress(image.getId());
            }

            //Getting the total megs this worker is going to be doing            
            for (OutputFileData outputFileData : outputFileDataList) {
                try {
                    // If a volume is locked, skip it but continue trying to process any other requested volumes
                    addVolumeInProgress(outputFileData.getFileName());
                    totalBytes += outputFileData.getSizeInBytes();
                    this.outputFileDataList.add(outputFileData);
                } catch (TskCoreException ex) {
                    logger.log(Level.WARNING, "Already extracting data into {0}", outputFileData.getFileName());
                }
            }

            // If we don't have anything to output (because of locking), throw an exception
            if (this.outputFileDataList.isEmpty()) {
                throw new TskCoreException("No unallocated files can be extracted");
            }

            totalSizeinMegs = toMb(totalBytes);
        }
    }

    private boolean hasVolumeSystem(Image img) {
        try {
            for (Content c : img.getChildren()) {
                if (c instanceof VolumeSystem) {
                    return true;
                }
            }
        } catch (TskCoreException ex) {
            logger.log(Level.SEVERE, "Unable to determine if image has a volume system, extraction may be incomplete", ex); //NON-NLS
        }
        return false;
    }

    private List<Volume> getVolumes(Image img) {
        List<Volume> volumes = new ArrayList<>();
        try {
            for (Content v : img.getChildren().get(0).getChildren()) {
                if (v instanceof Volume) {
                    volumes.add((Volume) v);
                }
            }
        } catch (TskCoreException tce) {
            logger.log(Level.WARNING, "Could not get volume information from image. Extraction may be incomplete", tce); //NON-NLS
        }
        return volumes;
    }

    private static class UnallocVisitor extends ContentVisitor.Default<List<LayoutFile>> {

        @Override
        public List<LayoutFile> visit(final org.sleuthkit.datamodel.LayoutFile lf) {
            return new ArrayList<LayoutFile>() {
                {
                    add(lf);
                }
            };
        }

        @Override
        public List<LayoutFile> visit(FileSystem fs) {
            try {
                for (Content c : fs.getChildren()) {
                    if (c instanceof AbstractFile) {
                        if (((AbstractFile) c).isRoot()) {
                            return c.accept(this);
                        }
                    }
                }
            } catch (TskCoreException ex) {
                logger.log(Level.WARNING, "Couldn't get a list of Unallocated Files, failed at visiting FileSystem " + fs.getId(), ex); //NON-NLS
            }
            return Collections.emptyList();
        }

        @Override
        public List<LayoutFile> visit(VirtualDirectory vd) {
            try {
                List<LayoutFile> layoutFiles = new ArrayList<>();
                for (Content layout : vd.getChildren()) {
                    if (layout instanceof LayoutFile) {
                        layoutFiles.add((LayoutFile) layout);
                    }
                }
                return layoutFiles;
            } catch (TskCoreException ex) {
                logger.log(Level.WARNING, "Could not get list of Layout Files, failed at visiting Layout Directory", ex); //NON-NLS
            }
            return Collections.emptyList();
        }

        @Override
        public List<LayoutFile> visit(Directory dir) {
            try {
                for (Content c : dir.getChildren()) {
                    // Only the $Unalloc dir will contain unallocated files
                    if ((c instanceof VirtualDirectory) && (c.getName().equals(VirtualDirectory.NAME_UNALLOC))) {
                        return c.accept(this);
                    }
                }
            } catch (TskCoreException ex) {
                logger.log(Level.WARNING, "Couldn't get a list of Unallocated Files, failed at visiting Directory " + dir.getId(), ex); //NON-NLS
            }
            return Collections.emptyList();
        }

        @Override
        protected List<LayoutFile> defaultVisit(Content cntnt) {
            return Collections.emptyList();
        }
    }

    private class SortObjId implements Comparator<LayoutFile> {

        @Override
        public int compare(LayoutFile o1, LayoutFile o2) {
            if (o1.getId() == o2.getId()) {
                return 0;
            }
            if (o1.getId() > o2.getId()) {
                return 1;
            } else {
                return -1;
            }
        }
    }

    private class OutputFileData {

        private final List<LayoutFile> layoutFiles;
        private final long sizeInBytes;
        private long volumeId;
        private long imageId;
        private String imageName;
        private final String fileName;
        private File fileInstance;

        OutputFileData(Image img, Case openCase) {
            this.layoutFiles = getUnallocFiles(img);
            Collections.sort(layoutFiles, new SortObjId());
            this.volumeId = 0;
            this.imageId = img.getId();
            this.imageName = img.getName();
            this.fileName = this.imageName + "-Unalloc-" + this.imageId + "-" + 0 + ".dat"; //NON-NLS
            this.fileInstance = new File(openCase.getExportDirectory() + File.separator + this.fileName);
            this.sizeInBytes = calcSizeInBytes();
        }

        OutputFileData(Volume volume, Case openCase) {
            try {
                this.imageName = volume.getDataSource().getName();
                this.imageId = volume.getDataSource().getId();
                this.volumeId = volume.getId();
            } catch (TskCoreException tce) {
                logger.log(Level.WARNING, "Unable to properly create ExtractUnallocAction, extraction may be incomplete", tce); //NON-NLS
                this.imageName = "";
                this.imageId = 0;
            }
            this.fileName = this.imageName + "-Unalloc-" + this.imageId + "-" + volumeId + ".dat"; //NON-NLS
            this.fileInstance = new File(openCase.getExportDirectory() + File.separator + this.fileName);
            this.layoutFiles = getUnallocFiles(volume);
            Collections.sort(layoutFiles, new SortObjId());
            this.sizeInBytes = calcSizeInBytes();
        }

        //Getters
        int size() {
            return layoutFiles.size();
        }

        private long calcSizeInBytes() {
            long size = 0L;
            for (LayoutFile f : layoutFiles) {
                size += f.getSize();
            }
            return size;
        }

        long getSizeInBytes() {
            return this.sizeInBytes;
        }

        long getVolumeId() {
            return this.volumeId;
        }

        long getImageId() {
            return this.imageId;
        }

        String getImageName() {
            return this.imageName;
        }

        List<LayoutFile> getLayouts() {
            return this.layoutFiles;
        }

        String getFileName() {
            return this.fileName;
        }

        File getFile() {
            return this.fileInstance;
        }

        void setPath(String path) {
            this.fileInstance = new File(path + File.separator + this.fileName);
        }
    }

    // A Custome JFileChooser for this Action Class.
    public static class CustomFileChooser extends JFileChooser {

        private static final long serialVersionUID = 1L;

        public CustomFileChooser() {
            initalize();
        }

        private void initalize() {
            setDialogTitle(
                    NbBundle.getMessage(this.getClass(), "ExtractUnallocAction.dlgTitle.selectDirToSaveTo.msg"));
            setFileSelectionMode(JFileChooser.DIRECTORIES_ONLY);
            setAcceptAllFileFilterUsed(false);
        }

        @Override
        public void approveSelection() {
            File f = getSelectedFile();
            if (!f.exists() && getDialogType() == SAVE_DIALOG || !f.canWrite()) {
                JOptionPane.showMessageDialog(this, NbBundle.getMessage(this.getClass(),
                        "ExtractUnallocAction.msgDlg.folderDoesntExist.msg"));
                return;
            }
            super.approveSelection();
        }
    }

    // Small helper class for use with SwingUtilities involkAndWait to get
    // the result from the launching of the JOptionPane.
    private class Result {
        private int value;

        void set(int value) {
            this.value = value;
        }

        int value() {
            return value;
        }
    }
}