GeoPath.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.logging.Level;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.datamodel.BlackboardArtifact;
import org.sleuthkit.datamodel.Content;
import org.sleuthkit.datamodel.SleuthkitCase;
import org.sleuthkit.datamodel.TskCoreException;

public class GeoPath {
    private static final Logger LOGGER = Logger.getLogger(GeoPath.class.getName());
    
    private final List<Waypoint> waypointList;
    private final String pathName;
    private final BlackboardArtifact artifact;

    static public List<Route> getRoutes(SleuthkitCase skCase) throws GeoLocationDataException {
        List<BlackboardArtifact> artifacts = null;
        try {
            artifacts = skCase.getBlackboardArtifacts(BlackboardArtifact.ARTIFACT_TYPE.TSK_GPS_ROUTE);
        } catch (TskCoreException ex) {
            throw new GeoLocationDataException("Unable to get artifacts for type: TSK_GPS_BOOKMARK", ex);
        }

        List<Route> routes = new ArrayList<>();
        for (BlackboardArtifact artifact : artifacts) {
            Route route = new Route(artifact);
            routes.add(route);
        }
        return routes;
    }

    public static GeoLocationParseResult<Track> getTracks(SleuthkitCase skCase, List<? extends Content> sourceList) throws GeoLocationDataException {
        List<BlackboardArtifact> artifacts = null;
        boolean allParsedSuccessfully = true;
        List<Track> tracks = new ArrayList<>();
        try {
            artifacts = skCase.getBlackboardArtifacts(BlackboardArtifact.ARTIFACT_TYPE.TSK_GPS_TRACK);
            for (BlackboardArtifact artifact : artifacts) {
                if (sourceList == null || sourceList.contains(artifact.getDataSource())) {
                    try {
                        tracks.add(new Track(artifact));
                        
                    } catch (GeoLocationDataException e) {
                        LOGGER.log(Level.WARNING, "Error loading track from artifact with ID " + artifact.getArtifactID(), e);
                        allParsedSuccessfully = false;
                    }
                }
            }
        } catch (TskCoreException ex) {
            throw new GeoLocationDataException("Unable to get artifacts for type: TSK_GPS_BOOKMARK", ex);
        }
        return new GeoLocationParseResult<Track>(tracks, allParsedSuccessfully);
    }
    
    public static GeoLocationParseResult<Area> getAreas(SleuthkitCase skCase, List<? extends Content> sourceList) throws GeoLocationDataException {
        List<BlackboardArtifact> artifacts;
        boolean allParsedSuccessfully = true;
        List<Area> areas = new ArrayList<>();
        try {
            artifacts = skCase.getBlackboardArtifacts(BlackboardArtifact.ARTIFACT_TYPE.TSK_GPS_AREA);
            for (BlackboardArtifact artifact : artifacts) {
                if (sourceList == null || sourceList.contains(artifact.getDataSource())) {
                    try {
                        areas.add(new Area(artifact));
                        
                    } catch (GeoLocationDataException e) {
                        LOGGER.log(Level.WARNING, "Error loading track from artifact with ID " + artifact.getArtifactID(), e);
                        allParsedSuccessfully = false;
                    }
                }
            }
        } catch (TskCoreException ex) {
            throw new GeoLocationDataException("Unable to get artifacts for type: TSK_GPS_BOOKMARK", ex);
        }
        return new GeoLocationParseResult<>(areas, allParsedSuccessfully);
    }    

    GeoPath(BlackboardArtifact artifact, String pathName) {
        this.waypointList = new ArrayList<>();
        this.pathName = pathName;
        this.artifact = artifact;
    }

    final void addToPath(Waypoint point) {
        waypointList.add(point);
    }

    final public List<Waypoint> getPath() {
        return Collections.unmodifiableList(waypointList);
    }

    public final BlackboardArtifact getArtifact() {
        return artifact;
    }

    public String getLabel() {
        return pathName != null ? pathName : "";
    }
}