LayoutFile.java

Go to the documentation of this file.

/*
 * SleuthKit Java Bindings
 *
 * Copyright 2011-2022 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.Collections;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.sleuthkit.datamodel.TskData.FileKnown;
import org.sleuthkit.datamodel.TskData.TSK_DB_FILES_TYPE_ENUM;
import org.sleuthkit.datamodel.TskData.TSK_FS_ATTR_TYPE_ENUM;
import org.sleuthkit.datamodel.TskData.TSK_FS_META_TYPE_ENUM;
import org.sleuthkit.datamodel.TskData.TSK_FS_NAME_FLAG_ENUM;
import org.sleuthkit.datamodel.TskData.TSK_FS_NAME_TYPE_ENUM;

public class LayoutFile extends AbstractFile {

        private long imageHandle = -1;

        LayoutFile(SleuthkitCase db,
                        long objId,
                        long dataSourceObjectId,
                        Long fileSystemObjectId,
                        String name,
                        TSK_DB_FILES_TYPE_ENUM fileType,
                        TSK_FS_NAME_TYPE_ENUM dirType, TSK_FS_META_TYPE_ENUM metaType,
                        TSK_FS_NAME_FLAG_ENUM dirFlag, short metaFlags,
                        long size,
                        long ctime, long crtime, long atime, long mtime,
                        String md5Hash, String sha256Hash, String sha1Hash,
                        FileKnown knownState,
                        String parentPath, String mimeType,
                        String ownerUid,
                        Long osAccountObjId) {
                        
                super(db, objId, dataSourceObjectId, fileSystemObjectId, TSK_FS_ATTR_TYPE_ENUM.TSK_FS_ATTR_TYPE_DEFAULT, 0, name, fileType, 0L, 0, dirType, metaType, dirFlag, metaFlags, size, ctime, crtime, atime, mtime, (short) 0, 0, 0, md5Hash, sha256Hash, sha1Hash, knownState, parentPath, mimeType, SleuthkitCase.extractExtension(name), ownerUid, osAccountObjId, TskData.CollectedStatus.UNKNOWN, Collections.emptyList());
        }

        public int getNumParts() {
                int numParts = 0;
                try {
                        numParts = getRanges().size();
                } catch (TskCoreException ex) {
                        Logger.getLogger(LayoutFile.class.getName()).log(Level.SEVERE, String.format("Error getting layout ranges for layout file (objId = %d)", getId()), ex); //NON-NLS
                }
                return numParts;
        }

        @Override
        public boolean isRoot() {
                return false;
        }

        @Override
        public void close() {
        }

        @Override
        protected int readInt(byte[] buf, long offset, long len) throws TskCoreException {
                long offsetInThisLayoutContent = 0; // current offset in this LayoutContent
                int bytesRead = 0; // Bytes read so far
                
                // if the caller has requested more data than we have in the file
                // then make sure we don't go beyond the end of the file
                long readLen = len;
                if (offset + readLen > size) 
                        readLen = size - offset;

                if (imageHandle == -1) {
                        Content dataSource = getDataSource();
                        if ((dataSource != null) && (dataSource instanceof Image)) {
                                Image image = (Image) dataSource;
                                imageHandle = image.getImageHandle();
                        } else {
                                throw new TskCoreException("Data Source of LayoutFile is not Image");
                        }
                }

                for (TskFileRange range : getRanges()) {
                        if (bytesRead < readLen) { // we haven't read enough yet
                                if (offset < offsetInThisLayoutContent + range.getByteLen()) { // if we are in a range object we want to read from
                                        long offsetInRange = 0; // how far into the current range object to start reading
                                        if (bytesRead == 0) { // we haven't read anything yet so we want to read from the correct offset in this range object
                                                offsetInRange = offset - offsetInThisLayoutContent; // start reading from the correct offset
                                        }
                                        long offsetInImage = range.getByteStart() + offsetInRange; // how far into the image to start reading
                                        long lenToReadInRange = Math.min(range.getByteLen() - offsetInRange, readLen - bytesRead); // how much we can read this time
                                        int lenRead = readImgToOffset(imageHandle, buf, bytesRead, offsetInImage, (int) lenToReadInRange);
                                        bytesRead += lenRead;
                                        if (lenToReadInRange != lenRead) { // If image read failed or was cut short
                                                break;
                                        }
                                }
                                offsetInThisLayoutContent += range.getByteLen();
                        } else { // we're done reading
                                break;
                        }
                }
                return bytesRead;
        }

        private int readImgToOffset(long imgHandle, byte[] buf, int offsetInBuf, long offsetInImage, int lenToRead) throws TskCoreException {
                byte[] currentBuffer = new byte[lenToRead]; // the buffer for the current range object
                int lenRead = SleuthkitJNI.readImg(imgHandle, currentBuffer, offsetInImage, lenToRead);
                System.arraycopy(currentBuffer, 0, buf, offsetInBuf, lenToRead); // copy what we just read into the main buffer
                return lenRead;
        }

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

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

        @Override
        public String toString(boolean preserveState) {
                return super.toString(preserveState) + "LayoutFile [\t" + "]\t"; //NON-NLS
        }
}