Waypoint.java

Go to the documentation of this file.

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

import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.sleuthkit.datamodel.AbstractFile;
import org.sleuthkit.datamodel.BlackboardArtifact;
import org.sleuthkit.datamodel.BlackboardAttribute;
import org.sleuthkit.datamodel.Content;
import org.sleuthkit.datamodel.TskCoreException;

public class Waypoint {

    final private Long timestamp;
    final private Double longitude;
    final private Double latitude;
    final private Double altitude;
    final private String label;
    final private AbstractFile image;
    final private BlackboardArtifact artifact;
    final private GeoPath parentGeoPath;
    final private Content content;

    final private List<Waypoint.Property> propertiesList;

    static final BlackboardAttribute.ATTRIBUTE_TYPE[] ALREADY_HANDLED_ATTRIBUTES = {
        BlackboardAttribute.ATTRIBUTE_TYPE.TSK_NAME,
        BlackboardAttribute.ATTRIBUTE_TYPE.TSK_GEO_LONGITUDE,
        BlackboardAttribute.ATTRIBUTE_TYPE.TSK_GEO_LATITUDE,
        BlackboardAttribute.ATTRIBUTE_TYPE.TSK_GEO_ALTITUDE,
        BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DATETIME,
        BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DATETIME_CREATED,
        BlackboardAttribute.ATTRIBUTE_TYPE.TSK_GEO_LATITUDE_START,
        BlackboardAttribute.ATTRIBUTE_TYPE.TSK_GEO_LONGITUDE_START,
        BlackboardAttribute.ATTRIBUTE_TYPE.TSK_GEO_LATITUDE_END,
        BlackboardAttribute.ATTRIBUTE_TYPE.TSK_GEO_LONGITUDE_END,};

    Waypoint(BlackboardArtifact artifact, String label, Long timestamp, Double latitude, Double longitude, Double altitude, AbstractFile image, Map<BlackboardAttribute.ATTRIBUTE_TYPE, BlackboardAttribute> attributeMap, GeoPath parentGeoPath) throws GeoLocationDataException {
        if (longitude == null || latitude == null) {
            throw new GeoLocationDataException("Invalid waypoint, null value passed for longitude or latitude");
        }

        this.artifact = artifact;
        this.label = label;
        this.image = image;
        this.timestamp = timestamp;
        this.longitude = longitude;
        this.latitude = latitude;
        this.altitude = altitude;
        this.parentGeoPath = parentGeoPath;

        propertiesList = createGeolocationProperties(attributeMap);
        try {
            content = artifact.getSleuthkitCase().getContentById(artifact.getObjectID());
        } catch (TskCoreException ex) {
            throw new GeoLocationDataException(String.format("Failed to get contend for artifact id (%d)", artifact.getId()), ex);
        }
    }

    public BlackboardArtifact getArtifact() {
        return artifact;
    }

    public Long getTimestamp() {
        return timestamp;
    }

    public String getLabel() {
        return label;
    }

    public Double getLatitude() {
        return latitude;
    }

    public Double getLongitude() {
        return longitude;
    }

    public Double getAltitude() {
        return altitude;
    }

    public AbstractFile getImage() {
        return image;
    }

    public List<Waypoint.Property> getOtherProperties() {
        return Collections.unmodifiableList(propertiesList);
    }

    public GeoPath getParentGeoPath() {
        return parentGeoPath;
    }

    static Map<BlackboardAttribute.ATTRIBUTE_TYPE, BlackboardAttribute> getAttributesFromArtifactAsMap(BlackboardArtifact artifact) throws GeoLocationDataException {
        Map<BlackboardAttribute.ATTRIBUTE_TYPE, BlackboardAttribute> attributeMap = new HashMap<>();
        try {
            List<BlackboardAttribute> attributeList = artifact.getAttributes();
            for (BlackboardAttribute attribute : attributeList) {
                try{
                    BlackboardAttribute.ATTRIBUTE_TYPE type = BlackboardAttribute.ATTRIBUTE_TYPE.fromID(attribute.getAttributeType().getTypeID());
                    attributeMap.put(type, attribute);
                } catch(IllegalArgumentException ex) {
                    // This was thrown due to a custom attribute that geolocation
                    // does not currently support.
                }
            }
        } catch (TskCoreException ex) {
            throw new GeoLocationDataException("Unable to get attributes from artifact", ex);
        }

        return attributeMap;
    }

    static List<Waypoint.Property> createGeolocationProperties(Map<BlackboardAttribute.ATTRIBUTE_TYPE, BlackboardAttribute> attributeMap) throws GeoLocationDataException {
        List<Waypoint.Property> list = new ArrayList<>();
        
        if(attributeMap != null) {

            Set<BlackboardAttribute.ATTRIBUTE_TYPE> keys = new HashSet<>(attributeMap.keySet());

            for (BlackboardAttribute.ATTRIBUTE_TYPE type : ALREADY_HANDLED_ATTRIBUTES) {
                keys.remove(type);
            }

            for (BlackboardAttribute.ATTRIBUTE_TYPE type : keys) {
                // Don't add JSON properties to this list.
                if (type.getValueType() == BlackboardAttribute.TSK_BLACKBOARD_ATTRIBUTE_VALUE_TYPE.JSON) {
                    continue;
                }
                String key = type.getDisplayName();
                String value = attributeMap.get(type).getDisplayString();

                list.add(new Waypoint.Property(key, value));
            }
        }
        return list;
    }
    
    public Content getContent() {
        return content;
    }
   
    public final static class Property {

        private final String displayName;
        private final String value;

        Property(String displayName, String value) {
            this.displayName = displayName;
            this.value = value;
        }

        public String getDisplayName() {
            return displayName;
        }

        public String getValue() {
            return value;
        }
    }
}