AbstractContentNode.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011-2019 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.datamodel;

import com.google.common.util.concurrent.ThreadFactoryBuilder;
import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.List;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.logging.Level;
import org.apache.commons.lang3.tuple.Pair;
import org.openide.nodes.Children;
import org.openide.nodes.Sheet;

import org.openide.util.lookup.Lookups;
import org.openide.util.Lookup;
import org.openide.util.NbBundle;
import org.openide.util.NbBundle.Messages;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException;
import org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance;
import org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance.Type;
import org.sleuthkit.autopsy.corecomponents.DataResultViewerTable;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.datamodel.AnalysisResult;
import org.sleuthkit.datamodel.BlackboardArtifact.ARTIFACT_TYPE;
import org.sleuthkit.datamodel.Content;
import org.sleuthkit.datamodel.Score;
import org.sleuthkit.datamodel.SleuthkitCase;
import org.sleuthkit.datamodel.Tag;
import org.sleuthkit.datamodel.TskCoreException;
import org.sleuthkit.datamodel.TskData;
import org.sleuthkit.datamodel.TskException;

public abstract class AbstractContentNode<T extends Content> extends ContentNode {

    protected final T content;
    private static final Logger logger = Logger.getLogger(AbstractContentNode.class.getName());

    static final ExecutorService backgroundTasksPool;
    private static final Integer MAX_POOL_SIZE = 10;

    @NbBundle.Messages({"AbstractContentNode.nodescription=no description",
        "AbstractContentNode.valueLoading=value loading"})
    protected static final String NO_DESCR = Bundle.AbstractContentNode_nodescription();
    protected static final String VALUE_LOADING = Bundle.AbstractContentNode_valueLoading();

    enum NodeSpecificEvents {
        TRANSLATION_AVAILABLE,
        SCO_AVAILABLE
    }

    static {
        //Initialize this pool only once! This will be used by every instance of AAFN
        //to do their heavy duty SCO column and translation updates.
        backgroundTasksPool = Executors.newFixedThreadPool(MAX_POOL_SIZE,
                new ThreadFactoryBuilder().setNameFormat("content-node-background-task-%d").build());
    }

    AbstractContentNode(T content) {
        this(content, Lookups.singleton(content));
    }

    AbstractContentNode(T content, Lookup lookup) {
        super(Children.create(new ContentChildren(content), true), lookup);
        this.content = content;
        //super.setName(ContentUtils.getSystemName(content));
        super.setName("content_" + Long.toString(content.getId())); //NON-NLS
    }

    public T getContent() {
        return content;
    }

    @Override
    public void setName(String name) {
        super.setName(name);
    }

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

    public boolean hasVisibleContentChildren() {
        return contentHasVisibleContentChildren(content);
    }

    public static boolean contentHasVisibleContentChildren(Content c) {
        if (c != null) {

            try {
                if (!c.hasChildren()) {
                    return false;
                }
            } catch (TskCoreException ex) {

                logger.log(Level.SEVERE, "Error checking if the node has children, for content: " + c, ex); //NON-NLS
                return false;
            }

            String query = "SELECT COUNT(obj_id) AS count FROM "
                    + " ( SELECT obj_id FROM tsk_objects WHERE par_obj_id = " + c.getId() + " AND type = "
                    + TskData.ObjectType.ARTIFACT.getObjectType()
                    + "   INTERSECT SELECT artifact_obj_id FROM blackboard_artifacts WHERE obj_id = " + c.getId()
                    + "     AND (artifact_type_id = " + ARTIFACT_TYPE.TSK_EMAIL_MSG.getTypeID()
                    + " OR artifact_type_id = " + ARTIFACT_TYPE.TSK_MESSAGE.getTypeID() + ") "
                    + "   UNION SELECT obj_id FROM tsk_objects WHERE par_obj_id = " + c.getId()
                    + "     AND type = " + TskData.ObjectType.ABSTRACTFILE.getObjectType() + ") AS OBJECT_IDS"; //NON-NLS;

            try (SleuthkitCase.CaseDbQuery dbQuery = Case.getCurrentCaseThrows().getSleuthkitCase().executeQuery(query)) {
                ResultSet resultSet = dbQuery.getResultSet();
                if (resultSet.next()) {
                    return (0 < resultSet.getInt("count"));
                }
            } catch (TskCoreException | SQLException | NoCurrentCaseException ex) {
                logger.log(Level.SEVERE, "Error checking if the node has children, for content: " + c, ex); //NON-NLS
            }
        }
        return false;
    }

    public boolean hasContentChildren() {
        boolean hasChildren = false;

        if (content != null) {
            try {
                hasChildren = content.hasChildren();
            } catch (TskCoreException ex) {
                logger.log(Level.SEVERE, "Error checking if the node has children, for content: " + content, ex); //NON-NLS
            }
        }

        return hasChildren;
    }

    public List<Long> getContentChildrenIds() {
        List<Long> childrenIds = null;

        if (content != null) {
            try {
                childrenIds = content.getChildrenIds();
            } catch (TskCoreException ex) {
                logger.log(Level.SEVERE, "Error getting children ids, for content: " + content, ex); //NON-NLS
            }
        }

        return childrenIds;

    }

    public List<Content> getContentChildren() {
        List<Content> children = null;

        if (content != null) {
            try {
                children = content.getChildren();
            } catch (TskCoreException ex) {
                logger.log(Level.SEVERE, "Error getting children, for content: " + content, ex); //NON-NLS
            }
        }

        return children;

    }

    public int getContentChildrenCount() {
        int childrenCount = -1;

        if (content != null) {
            try {
                childrenCount = content.getChildrenCount();
            } catch (TskCoreException ex) {
                logger.log(Level.SEVERE, "Error checking node content children count, for content: " + content, ex); //NON-NLS
            }
        }

        return childrenCount;
    }

    public int read(byte[] buf, long offset, long len) throws TskException {
        return content.read(buf, offset, len);
    }

    protected synchronized void updateSheet(NodeProperty<?>... newProps) {
        //Refresh ONLY those properties in the sheet currently. Subclasses may have 
        //only added a subset of our properties or their own props.s
        Sheet visibleSheet = this.getSheet();
        Sheet.Set visibleSheetSet = visibleSheet.get(Sheet.PROPERTIES);
        Property<?>[] visibleProps = visibleSheetSet.getProperties();
        for (NodeProperty<?> newProp : newProps) {
            for (int i = 0; i < visibleProps.length; i++) {
                if (visibleProps[i].getName().equals(newProp.getName())) {
                    visibleProps[i] = newProp;
                }
            }
        }
        visibleSheetSet.put(visibleProps);
        visibleSheet.put(visibleSheetSet);
        //setSheet() will notify Netbeans to update this node in the UI.
        this.setSheet(visibleSheet);
    }

    abstract protected List<Tag> getAllTagsFromDatabase();

    abstract protected CorrelationAttributeInstance getCorrelationAttributeInstance();

    @Messages({
        "# {0} - significanceDisplayName",
        "AbstractContentNode_getScorePropertyAndDescription_description=Has an {0} analysis result score"
    })
    protected Pair<Score, String> getScorePropertyAndDescription(List<Tag> tags) {
        Score score = Score.SCORE_UNKNOWN;
        try {
            score = this.content.getAggregateScore();
        } catch (TskCoreException ex) {
            logger.log(Level.WARNING, "Unable to get aggregate score for content with id: " + this.content.getId(), ex);
        }
        
        String significanceDisplay = score.getSignificance().getDisplayName();
        String description = Bundle.AbstractContentNode_getScorePropertyAndDescription_description(significanceDisplay);
        return Pair.of(score, description);
    }

    abstract protected DataResultViewerTable.HasCommentStatus getCommentProperty(List<Tag> tags, CorrelationAttributeInstance attribute);

    abstract protected Pair<Long, String> getCountPropertyAndDescription(Type attributeType, String attributeValue, String defaultDescription);
}