ThreadChildNodeFactory.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 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.communications.relationships;

import java.util.Comparator;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.logging.Level;
import javax.swing.Action;
import org.openide.nodes.AbstractNode;
import org.openide.nodes.ChildFactory;
import org.openide.nodes.Children;
import org.openide.nodes.Node;
import org.openide.nodes.Sheet;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.datamodel.NodeProperty;
import org.sleuthkit.datamodel.BlackboardArtifact;
import org.sleuthkit.datamodel.BlackboardAttribute;
import org.sleuthkit.datamodel.Content;
import org.sleuthkit.datamodel.TskCoreException;

final class ThreadChildNodeFactory extends ChildFactory<BlackboardArtifact> {

    private static final Logger logger = Logger.getLogger(ThreadChildNodeFactory.class.getName());

    private SelectionInfo selectionInfo;
    
    private final Action preferredAction;
    
    ThreadChildNodeFactory(Action preferredAction) {
        this.preferredAction = preferredAction;
    }
    
    public void refresh(SelectionInfo selectionInfo) {
        this.selectionInfo = selectionInfo;
        refresh(true);
    }
    
    @Override
    protected boolean createKeys(List<BlackboardArtifact> list) {
        if(selectionInfo == null) {
            return true;
        }
        
        try {
            final Set<Content> relationshipSources = selectionInfo.getRelationshipSources();
            createRootMessageKeys(list, relationshipSources) ;
        } catch (TskCoreException ex) {
            logger.log(Level.SEVERE, "Failed to load relationship sources.", ex); //NON-NLS
            return false;
        }

        return true;
    }
    
    private boolean createRootMessageKeys(List<BlackboardArtifact> list, Set<Content> relationshipSources) throws TskCoreException{
        Map<String, BlackboardArtifact> rootMessageMap = new HashMap<>();
        for(Content content: relationshipSources) {
            if(!(content instanceof BlackboardArtifact)) {
                continue;
            }
            
            BlackboardArtifact bba = (BlackboardArtifact) content;
            BlackboardArtifact.ARTIFACT_TYPE fromID = BlackboardArtifact.ARTIFACT_TYPE.fromID(bba.getArtifactTypeID());

            if (fromID == BlackboardArtifact.ARTIFACT_TYPE.TSK_EMAIL_MSG
                    || fromID == BlackboardArtifact.ARTIFACT_TYPE.TSK_MESSAGE) {

                // We want email and message artifacts that do not have "threadIDs" to appear as one thread in the UI
                // To achive this assign any artifact that does not have a threadID
                // the "UNTHREADED_ID"
                String threadID = MessageNode.UNTHREADED_ID;
                
                BlackboardAttribute attribute = bba.getAttribute(new BlackboardAttribute.Type(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_THREAD_ID));

                if(attribute != null) {
                    threadID = attribute.getValueString();
                } 

                BlackboardArtifact tableArtifact = rootMessageMap.get(threadID);
                if(tableArtifact == null) {
                    rootMessageMap.put(threadID, bba);          
                } else {
                    // Get the date of the message
                    BlackboardAttribute tableAttribute = null;
                    switch(fromID) {
                        case TSK_EMAIL_MSG:
                            tableAttribute = tableArtifact.getAttribute(new BlackboardAttribute.Type(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DATETIME_SENT));
                            attribute = bba.getAttribute(new BlackboardAttribute.Type(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DATETIME_SENT));
                            // put the earliest message into the table
                            if(tableAttribute != null 
                                    && attribute != null 
                                    && tableAttribute.getValueLong() > attribute.getValueLong()) {
                                rootMessageMap.put(threadID, bba);
                            }
                        break;
                        case TSK_MESSAGE:
                            tableAttribute = tableArtifact.getAttribute(new BlackboardAttribute.Type(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DATETIME));
                            attribute = bba.getAttribute(new BlackboardAttribute.Type(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DATETIME));
                            // put the earliest message into the table
                            if(tableAttribute != null 
                                    && attribute != null 
                                    && tableAttribute.getValueLong() < attribute.getValueLong()) {
                                rootMessageMap.put(threadID, bba);
                            }
                            break;
                        case TSK_CALLLOG:
                            tableAttribute = tableArtifact.getAttribute(new BlackboardAttribute.Type(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DATETIME_START));
                            attribute = bba.getAttribute(new BlackboardAttribute.Type(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DATETIME_START));
                            // put the earliest message into the table
                            if(tableAttribute != null 
                                    && attribute != null 
                                    && tableAttribute.getValueLong() > attribute.getValueLong()) {
                                rootMessageMap.put(threadID, bba);
                            }
                            break;
                    }

                    
                }
            }
        }

        for(BlackboardArtifact bba: rootMessageMap.values()) {
             list.add(bba);
        }
        
        list.sort(new ThreadDateComparator());
            
        return true;
    }

    @Override
    protected Node createNodeForKey(BlackboardArtifact bba) {
        BlackboardAttribute attribute = null;
        try {
            attribute = bba.getAttribute(new BlackboardAttribute.Type(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_THREAD_ID)); 
        } catch (TskCoreException ex) {
            logger.log(Level.WARNING, String.format("Unable to get threadID for artifact: %s", bba.getName()), ex);
        } 
        
        if (attribute != null) {
            return new ThreadNode(bba, attribute.getValueString(), preferredAction);
        } else {
            // Only one of these should occur.
            return new UnthreadedNode();
        }         
    }
    
    final class UnthreadedNode extends AbstractNode {
        UnthreadedNode() {
            super(Children.LEAF);
            setDisplayName("Unthreaded");
            this.setIconBaseWithExtension("org/sleuthkit/autopsy/communications/images/unthreaded.png" );
        }
        
         @Override
        protected Sheet createSheet() {
            Sheet sheet = super.createSheet();
            Sheet.Set sheetSet = sheet.get(Sheet.PROPERTIES);
            if (sheetSet == null) {
                sheetSet = Sheet.createPropertiesSet();
                sheet.put(sheetSet);
            }
            
            // Give this node a threadID of "UNTHEADED_ID"
            sheetSet.put(new NodeProperty<>("ThreadID", "ThreadID","",MessageNode.UNTHREADED_ID));
            
            return sheet;
        }
    }
    
    class ThreadDateComparator implements Comparator<BlackboardArtifact> {

        @Override
        public int compare(BlackboardArtifact bba1, BlackboardArtifact bba2) {
            BlackboardAttribute attribute1 = null;
            BlackboardAttribute attribute2 = null;
            // Inializing to Long.MAX_VALUE so that if a BlackboardArtifact of 
            // any unexpected type is passed in, it will bubble to the top of 
            // the list.
            long dateTime1 = Long.MAX_VALUE;
            long dateTime2 = Long.MAX_VALUE;

            if (bba1 != null) {
                BlackboardArtifact.ARTIFACT_TYPE fromID = BlackboardArtifact.ARTIFACT_TYPE.fromID(bba1.getArtifactTypeID());
                if (fromID != null) {
                    try {
                        switch (fromID) {
                            case TSK_EMAIL_MSG:
                                attribute1 = bba1.getAttribute(new BlackboardAttribute.Type(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DATETIME_SENT));

                                break;
                            case TSK_MESSAGE:
                                attribute1 = bba1.getAttribute(new BlackboardAttribute.Type(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DATETIME));

                                break;
                            case TSK_CALLLOG:
                                attribute1 = bba1.getAttribute(new BlackboardAttribute.Type(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DATETIME_START));

                                break;
                        }
                    } catch (TskCoreException ex) {
                        logger.log(Level.WARNING, String.format("Unable to compare attributes for artifact %d", bba1.getArtifactID()), ex);
                    }
                }
            }

            if (bba1 != null) {
                BlackboardArtifact.ARTIFACT_TYPE fromID = BlackboardArtifact.ARTIFACT_TYPE.fromID(bba2.getArtifactTypeID());
                if (fromID != null) {
                    try {
                        switch (fromID) {
                            case TSK_EMAIL_MSG:
                                attribute2 = bba2.getAttribute(new BlackboardAttribute.Type(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DATETIME_SENT));
                                break;
                            case TSK_MESSAGE:
                                attribute2 = bba2.getAttribute(new BlackboardAttribute.Type(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DATETIME));
                                break;
                            case TSK_CALLLOG:
                                attribute2 = bba2.getAttribute(new BlackboardAttribute.Type(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DATETIME_START));
                                break;
                        }
                    } catch (TskCoreException ex) {
                        logger.log(Level.WARNING, String.format("Unable to compare attributes for artifact %d", bba2.getArtifactID()), ex);
                    }
                }
            }

            if (attribute1 != null) {
                dateTime1 = attribute1.getValueLong();
            }

            if (attribute2 != null) {
                dateTime2 = attribute2.getValueLong();
            }

            return Long.compare(dateTime1, dateTime2) * -1;
        }
    }
}