Report.java

Go to the documentation of this file.

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

import java.io.IOException;
import java.nio.ByteBuffer;
import java.nio.channels.FileChannel;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import static java.nio.file.StandardOpenOption.READ;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.sleuthkit.datamodel.Blackboard.BlackboardException;
import org.sleuthkit.datamodel.SleuthkitCase.CaseDbTransaction;

public class Report implements Content {

        private static final BlackboardArtifact.Type KEYWORD_HIT_TYPE = new BlackboardArtifact.Type(BlackboardArtifact.ARTIFACT_TYPE.TSK_KEYWORD_HIT);
        static long ID_NOT_SET = -1;
        private long objectId = ID_NOT_SET;
        private final String pathAsString;
        private final Path pathAsPath; // NULL if path is for a URL
        private final long createdTime;
        private final String sourceModuleName;
        private final String reportName;

        private Content parent; // The object from which the report was generated. 

        private final SleuthkitCase db; // A reference to the database instance.
        private FileChannel fileChannel = null; // Used to read report content.

        private static final Logger LOGGER = Logger.getLogger(Report.class.getName());

        Report(SleuthkitCase db, long id, String path, long createdTime, String sourceModuleName, String reportName, Content parent) {
                this.db = db;
                this.objectId = id;
                this.pathAsString = path;
                if (path.startsWith("http")) {
                        this.pathAsPath = null;
                } else {
                        this.pathAsPath = Paths.get(path);
                }

                this.createdTime = createdTime;
                this.sourceModuleName = sourceModuleName;
                this.reportName = reportName;
                this.parent = parent;
        }

        @Override
        public long getId() {
                return objectId;
        }

        public String getPath() {
                return (pathAsPath != null ? pathAsPath.toString() : pathAsString);
        }

        public long getCreatedTime() {
                return createdTime;
        }

        public String getSourceModuleName() {
                return this.sourceModuleName;
        }

        public String getReportName() {
                return reportName;
        }

        @Override
        public int read(byte[] buf, long offset, long len) throws TskCoreException {
                if (pathAsPath == null || Files.isDirectory(pathAsPath)) {
                        return 0;
                }

                int totalBytesRead = 0;
                ByteBuffer data = ByteBuffer.wrap(buf);
                try {
                        if (fileChannel == null) {
                                fileChannel = FileChannel.open(pathAsPath, READ);
                        }
                        fileChannel.position(offset);
                        int bytesRead = 0;
                        do {
                                bytesRead = fileChannel.read(data);
                                if (bytesRead != -1) {
                                        totalBytesRead += bytesRead;
                                }
                        } while (bytesRead != -1 && data.hasRemaining());
                } catch (IOException ex) {
                        LOGGER.log(Level.SEVERE, "Failed to read report file.", ex);
                }

                return totalBytesRead;
        }

        @Override
        public void close() {
                try {
                        if (fileChannel != null) {
                                fileChannel.close();
                        }
                } catch (IOException ex) {
                        LOGGER.log(Level.WARNING, "Failed to close report file.", ex);
                }
        }

        @Override
        public long getSize() {
                try {
                        return (pathAsPath != null ? Files.size(pathAsPath) : 0);
                } catch (IOException ex) {
                        LOGGER.log(Level.SEVERE, "Failed to get size of report.", ex);
                        // If we cannot determine the size of the report, return zero
                        // to prevent attempts to read content.
                        return 0;
                }
        }

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

        @Override
        public String getName() {
                return reportName;
        }

        @Override
        public String getUniquePath() throws TskCoreException {
                // @@@ This is wrong...  we need to use the same logic is in AbstractContent.getUniquePath(). 
                return getPath();
        }

        @Override
        public Content getDataSource() throws TskCoreException {
                if (null == parent) {
                        return null;
                } else {
                        return parent.getDataSource();
                }
        }

        @Override
        public List<Content> getChildren() throws TskCoreException {
                return Collections.<Content>emptyList();
        }

        @Override
        public boolean hasChildren() throws TskCoreException {
                return false;
        }

        @Override
        public int getChildrenCount() throws TskCoreException {
                return 0;
        }

        @Override
        public Content getParent() throws TskCoreException {
                if (parent == null) {
                        SleuthkitCase.ObjectInfo parentInfo;
                        parentInfo = db.getParentInfo(this);
                        if (parentInfo == null) {
                                parent = null;
                        } else {
                                parent = db.getContentById(parentInfo.getId());
                        }
                }
                return parent;
        }

        @Override
        public List<Long> getChildrenIds() throws TskCoreException {
                return Collections.<Long>emptyList();
        }

        @Deprecated
        @Override
        public BlackboardArtifact newArtifact(int artifactTypeID) throws TskCoreException {
                if (artifactTypeID != BlackboardArtifact.ARTIFACT_TYPE.TSK_KEYWORD_HIT.getTypeID()) {
                        throw new TskCoreException("Reports can only have keyword hit artifacts.");
                }

                long fileObjId = getId();
                long dsObjId = getDataSource() == null ? null : getDataSource().getId();

                try {
                        return db.getBlackboard().newAnalysisResult(
                                        KEYWORD_HIT_TYPE, fileObjId, dsObjId, Score.SCORE_UNKNOWN,
                                        null, null, null, Collections.emptyList())
                                        .getAnalysisResult();
                } catch (BlackboardException ex) {
                        throw new TskCoreException("Unable to get analysis result for keword hit.", ex);
                }
        }

        @Override
        public AnalysisResultAdded newAnalysisResult(BlackboardArtifact.Type artifactType, Score score, String conclusion, String configuration, String justification, Collection<BlackboardAttribute> attributesList) throws TskCoreException {
                // Get the data source before opening the transaction
                long dataSourceObjId = getDataSource().getId();
                
                CaseDbTransaction trans = db.beginTransaction();
                try {
                        AnalysisResultAdded resultAdded = db.getBlackboard().newAnalysisResult(artifactType, objectId, dataSourceObjId, score, conclusion, configuration, justification, attributesList, trans);

                        trans.commit();
                        return resultAdded;
                } catch (BlackboardException ex) {
                        trans.rollback();
                        throw new TskCoreException("Error adding analysis result.", ex);
                }
        }

        @Override
        public AnalysisResultAdded newAnalysisResult(BlackboardArtifact.Type artifactType, Score score, String conclusion, String configuration, String justification, Collection<BlackboardAttribute> attributesList, long dataSourceId) throws TskCoreException {
                CaseDbTransaction trans = db.beginTransaction();
                try {
                        AnalysisResultAdded resultAdded = db.getBlackboard().newAnalysisResult(artifactType, objectId, dataSourceId, score, conclusion, configuration, justification, attributesList, trans);

                        trans.commit();
                        return resultAdded;
                } catch (BlackboardException ex) {
                        trans.rollback();
                        throw new TskCoreException("Error adding analysis result.", ex);
                }
        }

        @Override
        public DataArtifact newDataArtifact(BlackboardArtifact.Type artifactType, Collection<BlackboardAttribute> attributesList, Long osAccountId) throws TskCoreException {

                if (artifactType.getTypeID() != BlackboardArtifact.ARTIFACT_TYPE.TSK_KEYWORD_HIT.getTypeID() &&
                                artifactType.getTypeID() != BlackboardArtifact.ARTIFACT_TYPE.TSK_ACCOUNT.getTypeID()) {
                        throw new TskCoreException("Reports can only have keyword hit artifacts.");
                }
                
                return db.getBlackboard().newDataArtifact(artifactType, objectId, this.getDataSource().getId(), attributesList, osAccountId);
        }

        @Override
        public DataArtifact newDataArtifact(BlackboardArtifact.Type artifactType, Collection<BlackboardAttribute> attributesList, Long osAccountId, long dataSourceId) throws TskCoreException {

                if (artifactType.getTypeID() != BlackboardArtifact.ARTIFACT_TYPE.TSK_KEYWORD_HIT.getTypeID() &&
                                artifactType.getTypeID() != BlackboardArtifact.ARTIFACT_TYPE.TSK_ACCOUNT.getTypeID()) {
                        throw new TskCoreException("Reports can only have keyword hit artifacts.");
                }               
                return db.getBlackboard().newDataArtifact(artifactType, objectId, dataSourceId, attributesList, osAccountId);
        }

        @Override
        public DataArtifact newDataArtifact(BlackboardArtifact.Type artifactType, Collection<BlackboardAttribute> attributesList) throws TskCoreException {
                return newDataArtifact(artifactType, attributesList, null);
        }
        
        @Deprecated
        @SuppressWarnings("deprecation")
        @Override
        public BlackboardArtifact newArtifact(BlackboardArtifact.ARTIFACT_TYPE type) throws TskCoreException {
                return newArtifact(type.getTypeID());
        }

        @Override
        public ArrayList<BlackboardArtifact> getArtifacts(String artifactTypeName) throws TskCoreException {
                return getArtifacts(db.getBlackboard().getArtifactType(artifactTypeName).getTypeID());
        }

        @Override
        public BlackboardArtifact getGenInfoArtifact() throws TskCoreException {
                // TSK_GEN_INFO artifact is obsolete.
                return null;
        }

        @Override
        public BlackboardArtifact getGenInfoArtifact(boolean create) throws TskCoreException {
                // TSK_GEN_INFO artifact is obsolete.
                return null;
        }

        @Override
        public ArrayList<BlackboardAttribute> getGenInfoAttributes(BlackboardAttribute.ATTRIBUTE_TYPE attr_type) throws TskCoreException {
                // TSK_GEN_INFO artifact is obsolete.
                return null;
        }

        @Override
        public ArrayList<BlackboardArtifact> getArtifacts(int artifactTypeID) throws TskCoreException {
                if (artifactTypeID != BlackboardArtifact.ARTIFACT_TYPE.TSK_KEYWORD_HIT.getTypeID()) {
                        throw new TskCoreException("Reports can only have keyword hit artifacts.");
                }
                return db.getBlackboardArtifacts(artifactTypeID, objectId);
        }

        @Override
        public ArrayList<BlackboardArtifact> getArtifacts(BlackboardArtifact.ARTIFACT_TYPE type) throws TskCoreException {
                return getArtifacts(type.getTypeID());
        }

        @Override
        public ArrayList<BlackboardArtifact> getAllArtifacts() throws TskCoreException {
                return db.getMatchingArtifacts("WHERE obj_id = " + objectId); //NON-NLS
        }

        @Override
        public List<AnalysisResult> getAllAnalysisResults() throws TskCoreException {
                return db.getBlackboard().getAnalysisResults(objectId);
        }
        
        @Override
        public List<DataArtifact> getAllDataArtifacts() throws TskCoreException {
                return db.getBlackboard().getDataArtifactsBySource(objectId);
        }

        @Override
        public List<AnalysisResult> getAnalysisResults(BlackboardArtifact.Type artifactType) throws TskCoreException {
                return db.getBlackboard().getAnalysisResults(objectId, artifactType.getTypeID());
        }

        @Override
        public Score getAggregateScore() throws TskCoreException {
                return db.getScoringManager().getAggregateScore(objectId);
        }

        @Override
        public Set<String> getHashSetNames() throws TskCoreException {
                return Collections.<String>emptySet();
        }

        @Override
        public long getArtifactsCount(String artifactTypeName) throws TskCoreException {
                return getArtifactsCount(db.getBlackboard().getArtifactType(artifactTypeName).getTypeID());
        }

        @Override
        public long getArtifactsCount(int artifactTypeID) throws TskCoreException {
                if (artifactTypeID != BlackboardArtifact.ARTIFACT_TYPE.TSK_KEYWORD_HIT.getTypeID()) {
                        throw new TskCoreException("Reports can only have keyword hit artifacts.");
                }
                return db.getBlackboardArtifactsCount(artifactTypeID, objectId);
        }

        @Override
        public long getArtifactsCount(BlackboardArtifact.ARTIFACT_TYPE type) throws TskCoreException {
                return getArtifactsCount(type.getTypeID());
        }

        @Override
        public long getAllArtifactsCount() throws TskCoreException {
                return db.getBlackboardArtifactsCount(objectId);
        }

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