Track.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 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.List;
import java.util.Map;
import java.util.logging.Level;
import org.openide.util.NbBundle.Messages;
import org.sleuthkit.datamodel.BlackboardArtifact;
import org.sleuthkit.datamodel.BlackboardAttribute;
import org.sleuthkit.datamodel.blackboardutils.attributes.BlackboardJsonAttrUtil;
import org.sleuthkit.datamodel.blackboardutils.attributes.BlackboardJsonAttrUtil.InvalidJsonException;
import org.sleuthkit.datamodel.blackboardutils.attributes.GeoTrackPoints;
import org.sleuthkit.autopsy.coreutils.Logger;

public final class Track extends GeoPath {
    private static final Logger LOGGER = Logger.getLogger(Track.class.getName());
    
    private final Long startTimestamp;
    private final Long endTimeStamp;

    public Track(BlackboardArtifact artifact) throws GeoLocationDataException {
        this(artifact, Waypoint.getAttributesFromArtifactAsMap(artifact));
    }

    private Track(BlackboardArtifact artifact, Map<BlackboardAttribute.ATTRIBUTE_TYPE, BlackboardAttribute> attributeMap) throws GeoLocationDataException {
        super(artifact, getTrackName(attributeMap));

        GeoTrackPoints points = getPointsList(attributeMap);
        buildPath(points, artifact);

        startTimestamp = points.getStartTime();
        endTimeStamp = points.getEndTime();
    }

    public Long getStartTime() {
        return startTimestamp;
    }

    public Long getEndTime() {
        return endTimeStamp;
    }

    private static String getTrackName(Map<BlackboardAttribute.ATTRIBUTE_TYPE, BlackboardAttribute> attributeMap) {
        BlackboardAttribute attribute = attributeMap.get(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_NAME);

        return attribute != null ? attribute.getValueString() : "";
    }

    @Messages({
        "# {0} - track name",
        "GEOTrack_point_label_header=Trackpoint for track: {0}"
    })
    private void buildPath(GeoTrackPoints points, BlackboardArtifact artifact) throws GeoLocationDataException {
        for (GeoTrackPoints.TrackPoint point : points) {
            addToPath(new TrackWaypoint(artifact, Bundle.GEOTrack_point_label_header(getLabel()), point));
        }
    }

    private GeoTrackPoints getPointsList(Map<BlackboardAttribute.ATTRIBUTE_TYPE, BlackboardAttribute> attributeMap) throws GeoLocationDataException {
        BlackboardAttribute attribute = attributeMap.get(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_GEO_TRACKPOINTS);
        if (attribute == null) {
            LOGGER.log(Level.SEVERE, "No TSK_GEO_TRACKPOINTS attribute was present on the artifact.");
            throw new GeoLocationDataException("No TSK_GEO_TRACKPOINTS attribute present in attribute map to parse.");
        }

        try {
            return BlackboardJsonAttrUtil.fromAttribute(attribute, GeoTrackPoints.class);
        } catch (InvalidJsonException ex) {
            LOGGER.log(Level.SEVERE, "TSK_GEO_TRACKPOINTS could not be properly parsed from TSK_GEO_TRACKPOINTS attribute.");
            throw new GeoLocationDataException("Unable to parse track points in TSK_GEO_TRACKPOINTS attribute", ex);
        }
    }

    final class TrackWaypoint extends Waypoint {

        private final List<Waypoint.Property> propertyList;

        TrackWaypoint(BlackboardArtifact artifact, String pointLabel, GeoTrackPoints.TrackPoint point) throws GeoLocationDataException {
            super(artifact, pointLabel,
                    point.getTimeStamp(),
                    point.getLatitude(),
                    point.getLongitude(),
                    point.getAltitude(),
                    null,
                    null,
                    Track.this);

            propertyList = createPropertyList(point);
        }

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

        @Messages({
            "Track_distanceTraveled_displayName=Distance traveled",
            "Track_distanceFromHome_displayName=Distance from home point"
        })
        private List<Waypoint.Property> createPropertyList(GeoTrackPoints.TrackPoint point) {
            List<Waypoint.Property> list = new ArrayList<>();

            Long timestamp = point.getTimeStamp();
            if (timestamp != null) {
                list.add(new Property(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_DATETIME.getDisplayName(), timestamp.toString()));
            }

            Double value = point.getVelocity();
            if (value != null) {
                list.add(new Property(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_GEO_VELOCITY.getDisplayName(), value.toString()));
            }

            value = point.getDistanceTraveled();
            if (value != null) {
                list.add(new Property(Bundle.Track_distanceTraveled_displayName(), value.toString()));
            }

            value = point.getDistanceFromHomePoint();
            if (value != null) {
                list.add(new Property(Bundle.Track_distanceFromHome_displayName(), value.toString()));
            }

            return list;
        }
    }
}