AbstractContent.java

Go to the documentation of this file.

/*
 * Sleuth Kit Data Model
 *
 * Copyright 2011-2016 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 com.google.common.annotations.Beta;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.logging.Level;
import java.util.logging.Logger;
import org.sleuthkit.datamodel.Blackboard.BlackboardException;
import org.sleuthkit.datamodel.BlackboardArtifact.ARTIFACT_TYPE;
import org.sleuthkit.datamodel.BlackboardAttribute.ATTRIBUTE_TYPE;
import org.sleuthkit.datamodel.SleuthkitCase.CaseDbConnection;
import org.sleuthkit.datamodel.SleuthkitCase.CaseDbTransaction;
import org.sleuthkit.datamodel.SleuthkitCase.ObjectInfo;

public abstract class AbstractContent implements Content {

        private final static BlackboardArtifact.Type GEN_INFO_TYPE = new BlackboardArtifact.Type(ARTIFACT_TYPE.TSK_GEN_INFO);
        public final static long UNKNOWN_ID = -1;
        private final SleuthkitCase db;
        private final long objId;
        private final String name;
        private volatile Content parent;
        private volatile String uniquePath;
        protected long parentId;
        private volatile boolean hasChildren;
        private volatile boolean checkedHasChildren;
        private volatile int childrenCount;
        private BlackboardArtifact genInfoArtifact = null;

        protected AbstractContent(SleuthkitCase db, long obj_id, String name) {
                this.db = db;
                this.objId = obj_id;
                this.name = name;
                this.parentId = UNKNOWN_ID;

                checkedHasChildren = false;
                hasChildren = false;
                childrenCount = -1;
        }

        @Override
        public String getName() {
                return this.name;
        }

        /*
         * This base implementation simply walks the hierarchy appending its own
         * name to the result of calling its parent's getUniquePath() method (with
         * interleaving forward slashes).
         */
        @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 = "";
                        if (!name.isEmpty()) {
                                tempUniquePath = "/" + getName();
                        }

                        Content myParent = getParent();
                        if (myParent != null) {
                                tempUniquePath = myParent.getUniquePath() + tempUniquePath;
                        }

                        // Don't update uniquePath until it is complete.
                        uniquePath = tempUniquePath;
                }
                return uniquePath;
        }

        @Override
        public boolean hasChildren() throws TskCoreException {
                if (checkedHasChildren == true) {
                        return hasChildren;
                }

                hasChildren = this.getSleuthkitCase().getHasChildren(this);
                checkedHasChildren = true;

                return hasChildren;
        }

        @Override
        public int getChildrenCount() throws TskCoreException {
                if (childrenCount != -1) {
                        return childrenCount;
                }

                childrenCount = this.getSleuthkitCase().getContentChildrenCount(this);

                hasChildren = childrenCount > 0;
                checkedHasChildren = true;

                return childrenCount;
        }

        @Override
        public Content getParent() 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 (parent == null) {
                        Optional<Long> parentIdOpt = getParentId();
                        if (!parentIdOpt.isPresent()) {
                                parent = null;
                        } else {
                                parent = db.getContentById(parentIdOpt.get());
                        }
                }
                return parent;
        }

        void setParent(Content parent) {
                this.parent = parent;
        }

        @Beta
        public Optional<Long> getParentId() throws TskCoreException {
                if (parentId == UNKNOWN_ID) {
                        ObjectInfo parentInfo = db.getParentInfo(this);
                        if (parentInfo != null) {
                                parentId = parentInfo.getId();
                        }
                }

                return parentId == UNKNOWN_ID
                                ? Optional.empty()
                                : Optional.of(parentId);
        }

        void setParentId(long parentId) {
                this.parentId = parentId;
        }

        @Override
        public long getId() {
                return this.objId;
        }

        @Override
        public List<Content> getChildren() throws TskCoreException {
                List<Content> children = new ArrayList<Content>();

                children.addAll(getSleuthkitCase().getAbstractFileChildren(this));
                children.addAll(getSleuthkitCase().getBlackboardArtifactChildren(this));

                return children;

        }

        @Override
        public List<Long> getChildrenIds() throws TskCoreException {

                List<Long> childrenIDs = new ArrayList<Long>();

                childrenIDs.addAll(getSleuthkitCase().getAbstractFileChildrenIds(this));
                childrenIDs.addAll(getSleuthkitCase().getBlackboardArtifactChildrenIds(this));

                return childrenIDs;
        }

        // classes should override this if they can be a data source 
        @Override
        public Content getDataSource() throws TskCoreException {
                Content myParent = getParent();
                if (myParent == null) {
                        return null;
                }

                return myParent.getDataSource();
        }

        boolean isPoolContent() throws TskCoreException {
                return getPool() != null;
        }

        Volume getPoolVolume() throws TskCoreException {
                Content myParent = getParent();
                if (myParent == null) {
                        return null;
                }

                if (!(myParent instanceof AbstractContent)) {
                        return null;
                }

                if (myParent instanceof Volume) {
                        // This is potentially it, but need to check that this is a volume under a pool
                        if (((Volume) myParent).isPoolContent()) {
                                return (Volume) myParent;
                        } else {
                                // There are no pools in the hierarchy, so we're done
                                return null;
                        }
                }

                // Try one level higher
                return ((AbstractContent) myParent).getPoolVolume();
        }

        Pool getPool() throws TskCoreException {
                Content myParent = getParent();
                if (myParent == null) {
                        return null;
                }

                if (!(myParent instanceof AbstractContent)) {
                        return null;
                }

                if (myParent instanceof Pool) {
                        return (Pool) myParent;
                }

                // Try one level higher
                return ((AbstractContent) myParent).getPool();
        }

        public SleuthkitCase getSleuthkitCase() {
                return db;
        }

        @Override
        public boolean equals(Object obj) {
                if (obj == null) {
                        return false;
                }
                if (getClass() != obj.getClass()) {
                        return false;
                }
                final AbstractContent other = (AbstractContent) obj;
                if (this.objId != other.objId) {
                        return false;
                }

                try {
                        // New children may have been added to an existing content
                        // object in which case they are not equal.
                        if (this.getChildrenCount() != other.getChildrenCount()) {
                                return false;
                        }
                } catch (TskCoreException ex) {
                        Logger.getLogger(AbstractContent.class.getName()).log(Level.SEVERE, null, ex);
                }

                return true;
        }

        @Override
        public int hashCode() {
                int hash = 7 + (int) (this.objId ^ (this.objId >>> 32));
                try {
                        hash = 41 * hash + this.getChildrenCount();
                } catch (TskCoreException ex) {
                        Logger.getLogger(AbstractContent.class.getName()).log(Level.SEVERE, null, ex);
                }
                return hash;
        }

        @Deprecated
        @Override
        public BlackboardArtifact newArtifact(int artifactTypeID) throws TskCoreException {
                // don't let them make more than 1 GEN_INFO
                if (artifactTypeID == ARTIFACT_TYPE.TSK_GEN_INFO.getTypeID()) {
                        return getGenInfoArtifact(true);
                }
                BlackboardArtifact.Type artifactType = db.getBlackboard().getArtifactType(artifactTypeID);
                switch (artifactType.getCategory()) {
                        case DATA_ARTIFACT:
                                return this.newDataArtifact(artifactType, Collections.emptyList());
                        case ANALYSIS_RESULT: {
                                AnalysisResultAdded addedResult = this.newAnalysisResult(artifactType, Score.SCORE_UNKNOWN, null, null, null, Collections.emptyList());
                                return addedResult.getAnalysisResult();
                        }
                        default:
                                throw new TskCoreException(String.format("Unknown category: %s for artifact type id: %d",
                                                artifactType.getCategory().getName(), artifactTypeID));
                }
        }

        @Override
        public AnalysisResultAdded newAnalysisResult(BlackboardArtifact.Type artifactType, Score score, String conclusion, String configuration, String justification, Collection<BlackboardAttribute> attributesList) throws TskCoreException {

                long dataSourceObjectId = this.getDataSource().getId();
                CaseDbTransaction trans = db.beginTransaction();
                try {
                        AnalysisResultAdded resultAdded = db.getBlackboard().newAnalysisResult(artifactType, objId, dataSourceObjectId, score, conclusion, configuration, justification, attributesList, trans);

                        trans.commit();
                        return resultAdded;
                } catch (BlackboardException ex) {
                        trans.rollback();
                        throw new TskCoreException(String.format("Error adding analysis result to content with objId = %d.", objId), ex);
                }
        }

        @Override
        public AnalysisResultAdded newAnalysisResult(BlackboardArtifact.Type artifactType, Score score, String conclusion, String configuration, String justification, Collection<BlackboardAttribute> attributesList, long dataSourceId) throws TskCoreException {

                long dataSourceObjectId = dataSourceId;
                CaseDbTransaction trans = db.beginTransaction();
                try {
                        AnalysisResultAdded resultAdded = db.getBlackboard().newAnalysisResult(artifactType, objId, dataSourceObjectId, score, conclusion, configuration, justification, attributesList, trans);

                        trans.commit();
                        return resultAdded;
                } catch (BlackboardException ex) {
                        trans.rollback();
                        throw new TskCoreException(String.format("Error adding analysis result to content with objId = %d.", objId), ex);
                }
        }

        @Override
        public DataArtifact newDataArtifact(BlackboardArtifact.Type artifactType, Collection<BlackboardAttribute> attributesList, Long osAccountId) throws TskCoreException {
                return db.getBlackboard().newDataArtifact(artifactType, objId, this.getDataSource().getId(), attributesList, osAccountId);
        }

        @Override
        public DataArtifact newDataArtifact(BlackboardArtifact.Type artifactType, Collection<BlackboardAttribute> attributesList, Long osAccountId, long dataSourceId) throws TskCoreException {
                return db.getBlackboard().newDataArtifact(artifactType, objId, 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 ArrayList<BlackboardArtifact> getArtifacts(int artifactTypeID) throws TskCoreException {
                if (artifactTypeID == ARTIFACT_TYPE.TSK_GEN_INFO.getTypeID()) {
                        if (genInfoArtifact == null) // don't make one if it doesn't already exist
                        {
                                getGenInfoArtifact(false);
                        }

                        ArrayList<BlackboardArtifact> list = new ArrayList<BlackboardArtifact>();
                        // genInfoArtifact coudl still be null if there isn't an artifact
                        if (genInfoArtifact != null) {
                                list.add(genInfoArtifact);
                        }
                        return list;
                }
                return db.getBlackboardArtifacts(artifactTypeID, objId);
        }

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

        @Override
        public BlackboardArtifact getGenInfoArtifact() throws TskCoreException {
                return getGenInfoArtifact(true);
        }

        @Override
        public BlackboardArtifact getGenInfoArtifact(boolean create) throws TskCoreException {
                if (genInfoArtifact != null) {
                        return genInfoArtifact;
                }

                // go to db directly to avoid infinite loop
                ArrayList<BlackboardArtifact> arts = db.getBlackboardArtifacts(BlackboardArtifact.ARTIFACT_TYPE.TSK_GEN_INFO, objId);
                BlackboardArtifact retArt;
                if (arts.isEmpty()) {
                        if (create) {
                                retArt = this.newDataArtifact(GEN_INFO_TYPE, Collections.emptyList());
                        } else {
                                return null;
                        }
                } else {
                        retArt = arts.get(0);
                }
                genInfoArtifact = retArt;
                return retArt;
        }

        @Override
        public ArrayList<BlackboardAttribute> getGenInfoAttributes(ATTRIBUTE_TYPE attr_type) throws TskCoreException {
                ArrayList<BlackboardAttribute> returnList = new ArrayList<BlackboardAttribute>();

                if (genInfoArtifact == null) {
                        getGenInfoArtifact(false);
                        if (genInfoArtifact == null) {
                                return returnList;
                        }
                }

                for (BlackboardAttribute attribute : genInfoArtifact.getAttributes()) {
                        if (attribute.getAttributeType().getTypeID() == attr_type.getTypeID()) {
                                returnList.add(attribute);
                        }
                }

                return returnList;
        }

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

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

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

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

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

        @Override
        public long getArtifactsCount(String artifactTypeName) throws TskCoreException {
                return db.getBlackboardArtifactsCount(artifactTypeName, objId);
        }

        @Override
        public long getArtifactsCount(int artifactTypeID) throws TskCoreException {
                return db.getBlackboardArtifactsCount(artifactTypeID, objId);
        }

        @Override
        public long getArtifactsCount(ARTIFACT_TYPE type) throws TskCoreException {
                return db.getBlackboardArtifactsCount(type, objId);
        }

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

        @Override
        public Set<String> getHashSetNames() throws TskCoreException {
                Set<String> hashNames = new HashSet<String>();
                ArrayList<BlackboardArtifact> artifacts = getArtifacts(BlackboardArtifact.ARTIFACT_TYPE.TSK_HASHSET_HIT);

                for (BlackboardArtifact a : artifacts) {
                        BlackboardAttribute attribute = a.getAttribute(new BlackboardAttribute.Type(ATTRIBUTE_TYPE.TSK_SET_NAME));
                        if (attribute != null) {
                                hashNames.add(attribute.getValueString());
                        }
                }
                return Collections.unmodifiableSet(hashNames);
        }

        @Override
        public String toString() {
                return toString(true);
        }

        public String toString(boolean preserveState) {
                if (preserveState) {
                        return "AbstractContent [\t" + "objId " + String.format("%010d", objId) + "\t" //NON-NLS
                                        + "name " + name + "\t" + "parentId " + parentId + "\t" //NON-NLS
                                        + "\t" + "checkedHasChildren " + checkedHasChildren //NON-NLS
                                        + "\t" + "hasChildren " + hasChildren //NON-NLS
                                        + "\t" + "childrenCount " + childrenCount //NON-NLS
                                        + "uniquePath " + uniquePath + "]\t"; //NON-NLS
                } else {
                        try {
                                if (getParent() != null) {
                                        return "AbstractContent [\t" + "objId " + String.format("%010d", objId) //NON-NLS
                                                        + "\t" + "name " + name //NON-NLS
                                                        + "\t" + "checkedHasChildren " + checkedHasChildren //NON-NLS
                                                        + "\t" + "hasChildren " + hasChildren //NON-NLS
                                                        + "\t" + "childrenCount " + childrenCount //NON-NLS
                                                        + "\t" + "getUniquePath " + getUniquePath() //NON-NLS
                                                        + "\t" + "getParent " + getParent().getId() + "]\t"; //NON-NLS
                                } else {
                                        return "AbstractContent [\t" + "objId " //NON-NLS
                                                        + String.format("%010d", objId) + "\t" + "name " + name //NON-NLS
                                                        + "\t" + "checkedHasChildren " + checkedHasChildren //NON-NLS
                                                        + "\t" + "hasChildren " + hasChildren //NON-NLS
                                                        + "\t" + "childrenCount " + childrenCount //NON-NLS
                                                        + "\t" + "uniquePath " + getUniquePath() //NON-NLS
                                                        + "\t" + "parentId " + parentId + "]\t"; //NON-NLS
                                }
                        } catch (TskCoreException ex) {
                                Logger.getLogger(AbstractContent.class.getName()).log(Level.SEVERE, "Could not find Parent", ex); //NON-NLS
                                return "AbstractContent [\t" + "objId " + String.format("%010d", objId) + "\t" //NON-NLS
                                                + "name " + name + "\t" + "parentId " + parentId + "\t" //NON-NLS
                                                + "\t" + "checkedHasChildren " + checkedHasChildren //NON-NLS
                                                + "\t" + "hasChildren " + hasChildren //NON-NLS
                                                + "\t" + "childrenCount " + childrenCount //NON-NLS
                                                + "uniquePath " + uniquePath + "]\t";  //NON-NLS
                        }
                }
        }
}