Volume.java

Go to the documentation of this file.

/*
 * Sleuth Kit Data Model
 * 
 * Copyright 2011-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.datamodel;

import java.util.ResourceBundle;
import java.util.ArrayList;
import java.util.List;

public class Volume extends AbstractContent {

        private long addr;
        private long startSector; //in sectors, relative to volume system start
        private long lengthInSectors; //in sectors
        private long flags;
        private String desc;
        private volatile long volumeHandle = 0;
        private volatile String uniquePath;
        private static ResourceBundle bundle = ResourceBundle.getBundle("org.sleuthkit.datamodel.Bundle");

        protected Volume(SleuthkitCase db, long obj_id, long addr, long startSector, long lengthInSectors, long flags, String desc) {
                super(db, obj_id, "vol" + Long.toString(addr)); //NON-NLS
                this.addr = addr;
                this.startSector = startSector;
                this.lengthInSectors = lengthInSectors;
                this.uniquePath = null;
                this.flags = flags;
                if (!desc.equals("")) {
                        this.desc = desc;
                } else {
                        this.desc = bundle.getString("Volume.desc.text");
                }
        }

        @Override
        public int read(byte[] buf, long offset, long len) throws TskCoreException {
                synchronized (this) {
                        Content myParent = getParent();
                        if (!(myParent instanceof VolumeSystem)) {
                                throw new TskCoreException(bundle.getString("Volume.read.exception.msg1.text"));
                        }
                        VolumeSystem parentVs = (VolumeSystem) myParent;
                        
                        // Reading from APFS volumes/volume systems is not yet supported
                        if (parentVs.getType().equals(TskData.TSK_VS_TYPE_ENUM.TSK_VS_TYPE_APFS)) {
                                throw new TskCoreException("Reading APFS pool volumes not yet supported");
                        }
                        
                        // read from the volume
                        if (volumeHandle == 0) {
                                volumeHandle = SleuthkitJNI.openVsPart(parentVs.getVolumeSystemHandle(), addr);
                        }

                }
                return SleuthkitJNI.readVsPart(volumeHandle, buf, offset, len);
        }

        @Override
        public void close() {
        // there is nothing to free. The VolumeSystem structure
        // in C++ contains this structure and will free it. 
        volumeHandle = 0;
        }

        @Override
        public void finalize() throws Throwable {
                try {
                        close();
                } finally {
                        super.finalize();
                }
        }

        @Override
        public long getSize() {
                return lengthInSectors * 512;
        }

        @Override
        public String getUniquePath() throws TskCoreException {
                // It is possible that multiple threads could be doing this calculation
                // simultaneously, but it's worth the potential extra processing to prevent deadlocks.
                if(uniquePath == null) {
                        String tempUniquePath = "";
                        String name = getName();
                        if (!name.isEmpty()) {
                                tempUniquePath = "/vol_" + name; //NON-NLS
                        }

                        Content myParent = getParent();
                        if (myParent != null) {
                                tempUniquePath = myParent.getUniquePath() + tempUniquePath;
                        }
                        
                        // Don't update uniquePath until it is complete.
                        uniquePath = tempUniquePath;
                }
                return uniquePath;
        }

        //methods get exact data from database. could be manipulated to get more
        //meaningful data.
        public long getAddr() {
                return addr;
        }

        public long getStart() {
                return startSector;
        }

        public long getLength() {
                return lengthInSectors;
        }

        public long getFlags() {
                return flags;
        }

        public String getFlagsAsString() {
                return Volume.vsFlagToString(flags);
        }

        public String getDescription() {
                return desc;
        }

        // ----- Here all the methods for vs flags conversion / mapping -----
        public static String vsFlagToValue(long vsFlag) {

                String result = "";

                for (TskData.TSK_VS_PART_FLAG_ENUM flag : TskData.TSK_VS_PART_FLAG_ENUM.values()) {
                        if (flag.getVsFlag() == vsFlag) {
                                result = flag.toString();
                        }
                }
                return result;
        }

        public static long valueToVsFlag(String vsFlag) {

                long result = 0;

                for (TskData.TSK_VS_PART_FLAG_ENUM flag : TskData.TSK_VS_PART_FLAG_ENUM.values()) {
                        if (flag.toString().equals(vsFlag)) {
                                result = flag.getVsFlag();
                        }
                }
                return result;
        }

        public static String vsFlagToString(long vsFlag) {

                String result = "";

                long allocFlag = TskData.TSK_VS_PART_FLAG_ENUM.TSK_VS_PART_FLAG_ALLOC.getVsFlag();
                long unallocFlag = TskData.TSK_VS_PART_FLAG_ENUM.TSK_VS_PART_FLAG_UNALLOC.getVsFlag();

                // some variables that might be needed in the future
                long metaFlag = TskData.TSK_VS_PART_FLAG_ENUM.TSK_VS_PART_FLAG_META.getVsFlag();
                long allFlag = TskData.TSK_VS_PART_FLAG_ENUM.TSK_VS_PART_FLAG_ALL.getVsFlag();

                if ((vsFlag & allocFlag) == allocFlag) {
                        result = bundle.getString("Volume.vsFlagToString.allocated");
                }
                if ((vsFlag & unallocFlag) == unallocFlag) {
                        result = bundle.getString("Volume.vsFlagToString.unallocated");
                }
                // ... add more code here if needed

                return result;
        }

        @Override
        public <T> T accept(SleuthkitItemVisitor<T> v) {
                return v.visit(this);
        }

        @Override
        public <T> T accept(ContentVisitor<T> v) {
                return v.visit(this);
        }

        @Override
        public List<Content> getChildren() throws TskCoreException {
                return getSleuthkitCase().getVolumeChildren(this);
        }

        @Override
        public List<Long> getChildrenIds() throws TskCoreException {
                return getSleuthkitCase().getVolumeChildrenIds(this);
        }

        public List<FileSystem> getFileSystems() throws TskCoreException {

                List<Content> children = getChildren();
                List<FileSystem> fileSystems = new ArrayList<FileSystem>();
                for (Content child : children) {
                        if (child instanceof FileSystem) {
                                fileSystems.add((FileSystem) child);
                        }
                }

                return fileSystems;
        }

        @Override
        public String toString(boolean preserveState) {
                return super.toString(preserveState) + "Volume [\t" + "addr " + addr + "\t" + "desc " + desc + "\t" + "flags " + flags + "\t" + "length " + lengthInSectors + "\t" + "start " + startSector + "]\t"; //NON-NLS
        }
}