AbstractWaypointFetcher.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;

import java.util.ArrayList;
import java.util.List;
import java.util.Set;
import java.util.logging.Level;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.geolocation.datamodel.GeoLocationDataException;
import org.sleuthkit.autopsy.geolocation.datamodel.GeoLocationParseResult;
import org.sleuthkit.autopsy.geolocation.datamodel.Area;
import org.sleuthkit.autopsy.geolocation.datamodel.Track;
import org.sleuthkit.autopsy.geolocation.datamodel.Waypoint;
import org.sleuthkit.autopsy.geolocation.datamodel.WaypointBuilder;
import org.sleuthkit.datamodel.BlackboardArtifact.ARTIFACT_TYPE;

public abstract class AbstractWaypointFetcher implements WaypointBuilder.WaypointFilterQueryCallBack {

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

    private final GeoFilter filters;

    protected AbstractWaypointFetcher(GeoFilter filters) {
        this.filters = filters;
    }

    void getWaypoints() throws GeoLocationDataException {
        Case currentCase = Case.getCurrentCase();
        WaypointBuilder.getAllWaypoints(currentCase.getSleuthkitCase(),
                filters.getDataSources(),
                filters.getArtifactTypes(),
                filters.showAllWaypoints(),
                filters.getMostRecentNumDays(),
                filters.showWaypointsWithoutTimeStamp(),
                this);

    }

    protected abstract void handleFilteredWaypointSet(Set<MapWaypoint> mapWaypoints, List<Set<MapWaypoint>> tracks, 
        List<Set<MapWaypoint>> areas, boolean wasEntirelySuccessful);

    @Override
    public void process(GeoLocationParseResult<Waypoint> waypointResults) {
        GeoLocationParseResult<Track> trackResults = null;
        if (filters.getArtifactTypes().contains(ARTIFACT_TYPE.TSK_GPS_TRACK)) {
            try {
                trackResults = Track.getTracks(Case.getCurrentCase().getSleuthkitCase(), filters.getDataSources());
            } catch (GeoLocationDataException ex) {
                logger.log(Level.WARNING, "Exception thrown while retrieving list of Tracks", ex);
            }
        }
        
        GeoLocationParseResult<Area> areaResults = null;
        if (filters.getArtifactTypes().contains(ARTIFACT_TYPE.TSK_GPS_AREA)) {
            try {
                areaResults = Area.getAreas(Case.getCurrentCase().getSleuthkitCase(), filters.getDataSources());
            } catch (GeoLocationDataException ex) {
                logger.log(Level.WARNING, "Exception thrown while retrieving list of Areas", ex);
            }
        }
              
        GeoDataSet geoDataSet = createWaypointList(
            waypointResults.getItems(),
            (trackResults == null) ? new ArrayList<>() : trackResults.getItems(),
            (areaResults == null) ? new ArrayList<>() : areaResults.getItems());

        
        final Set<MapWaypoint> pointSet = MapWaypoint.getWaypoints(geoDataSet.getWaypoints());
        final List<Set<MapWaypoint>> trackSets = new ArrayList<>();
        for (List<Waypoint> t : geoDataSet.getTracks()) {
            trackSets.add(MapWaypoint.getWaypoints(t));
        }
        final List<Set<MapWaypoint>> areaSets = new ArrayList<>();
        for (List<Waypoint> t : geoDataSet.getAreas()) {
            areaSets.add(MapWaypoint.getWaypoints(t));
        }

        handleFilteredWaypointSet(
            pointSet, trackSets, areaSets,
            (trackResults == null || trackResults.isSuccessfullyParsed()) 
                && (areaResults == null || areaResults.isSuccessfullyParsed())
                && waypointResults.isSuccessfullyParsed());
    }

    private GeoDataSet createWaypointList(List<Waypoint> waypoints, List<Track> tracks, List<Area> areas) {
        final List<Waypoint> completeList = new ArrayList<>();
        List<List<Waypoint>> filteredTracks = new ArrayList<>();
        List<List<Waypoint>> filteredAreas = new ArrayList<>();

        if (tracks != null) {
            Long timeRangeEnd;
            Long timeRangeStart;
            if (!filters.showAllWaypoints()) {
                // Figure out what the most recent time is given the filtered
                // waypoints and the tracks.
                timeRangeEnd = getMostRecent(waypoints, tracks);
                timeRangeStart = timeRangeEnd - (86400 * filters.getMostRecentNumDays());

                completeList.addAll(getWaypointsInRange(timeRangeStart, timeRangeEnd, waypoints));

                filteredTracks = getTracksInRange(timeRangeStart, timeRangeEnd, tracks);
                for (List<Waypoint> filteredTrack : filteredTracks) {
                    completeList.addAll(filteredTrack);
                }
            } else {
                completeList.addAll(waypoints);
                for (Track track : tracks) {
                    completeList.addAll(track.getPath());
                    filteredTracks.add(track.getPath());
                }
            }
        } else {
            completeList.addAll(waypoints);
        }
        
        // Areas don't have timestamps so add all of them
        for (Area area : areas) {
            completeList.addAll(area.getPath());
            filteredAreas.add(area.getPath());
        }
        
        return new GeoDataSet(completeList, filteredTracks, filteredAreas);
    }

    private List<Waypoint> getWaypointsInRange(Long timeRangeStart, Long timeRangeEnd, List<Waypoint> waypoints) {
        List<Waypoint> completeList = new ArrayList<>();
        // Add all of the waypoints that fix into the time range.
        if (waypoints != null) {
            for (Waypoint point : waypoints) {
                Long time = point.getTimestamp();
                if ((time == null && filters.showWaypointsWithoutTimeStamp())
                        || (time != null && (time >= timeRangeStart && time <= timeRangeEnd))) {

                    completeList.add(point);
                }
            }
        }
        return completeList;
    }

    private List<List<Waypoint>> getTracksInRange(Long timeRangeStart, Long timeRangeEnd, List<Track> tracks) {
        List<List<Waypoint>> ret = new ArrayList<>();
        if (tracks != null) {
            for (Track track : tracks) {
                Long trackTime = track.getStartTime();

                if ((trackTime == null && filters.showWaypointsWithoutTimeStamp())
                        || (trackTime != null && (trackTime >= timeRangeStart && trackTime <= timeRangeEnd))) {
                    ret.add(track.getPath());
                }
            }
        }
        return ret;
    }

    private Long findMostRecentTimestamp(List<Waypoint> points) {

        Long mostRecent = null;

        for (Waypoint point : points) {
            if (mostRecent == null) {
                mostRecent = point.getTimestamp();
            } else {
                mostRecent = Math.max(mostRecent, point.getTimestamp());
            }
        }

        return mostRecent;
    }

    private Long findMostRecentTracks(List<Track> tracks) {
        Long mostRecent = null;

        for (Track track : tracks) {
            if (mostRecent == null) {
                mostRecent = track.getStartTime();
            } else if (track.getStartTime() != null) {
                mostRecent = Math.max(mostRecent, track.getStartTime());
            }
        }

        return mostRecent;
    }

    private Long getMostRecent(List<Waypoint> points, List<Track> tracks) {
        Long waypointMostRecent = findMostRecentTimestamp(points);
        Long trackMostRecent = findMostRecentTracks(tracks);

        if (waypointMostRecent != null && trackMostRecent != null) {
            return Math.max(waypointMostRecent, trackMostRecent);
        } else if (waypointMostRecent == null && trackMostRecent != null) {
            return trackMostRecent;
        } else if (waypointMostRecent != null && trackMostRecent == null) {
            return waypointMostRecent;
        }

        return -1L;
    }
    
    static class GeoDataSet {
        private final List<Waypoint> waypoints;
        private final List<List<Waypoint>> tracks;
        private final List<List<Waypoint>> areas;
        
        GeoDataSet(List<Waypoint> waypoints, List<List<Waypoint>> tracks, List<List<Waypoint>> areas) {
            this.waypoints = waypoints;
            this.tracks = tracks;
            this.areas = areas;
        }
        
        List<Waypoint> getWaypoints() {
            return waypoints;
        }
        
        List<List<Waypoint>> getTracks() {
            return tracks;
        }
        
        List<List<Waypoint>> getAreas() {
            return areas;
        }
    }        
}