EventCluster.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2018-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.timeline.ui.detailview.datamodel;
 
import static java.util.Collections.emptySet;
import static java.util.Collections.singleton;
import java.util.Comparator;
import java.util.HashSet;
import java.util.Objects;
import java.util.Optional;
import java.util.Set;
import java.util.SortedSet;
import org.joda.time.Interval;
import org.sleuthkit.autopsy.timeline.utils.IntervalUtils;
import org.sleuthkit.datamodel.TimelineEventType;
import org.sleuthkit.datamodel.TimelineEvent;
import org.sleuthkit.datamodel.TimelineLevelOfDetail;

public class EventCluster implements MultiEvent<EventStripe> {
 
    final private EventStripe parent;

    final private Interval span;

    final private TimelineEventType type;

    final private String description;

    private final TimelineLevelOfDetail lod;

    final private Set<Long> eventIDs;

    private final Set<Long> tagged;

    private final Set<Long> hashHits;

    public static EventCluster merge(EventCluster cluster1, EventCluster cluster2) {
 
        if (cluster1.getEventType() != cluster2.getEventType()) {
            throw new IllegalArgumentException("event clusters are not compatible: they have different types");
        }
 
        if (!cluster1.getDescription().equals(cluster2.getDescription())) {
            throw new IllegalArgumentException("event clusters are not compatible: they have different descriptions");
        }
 
        Interval spanningInterval = IntervalUtils.span(cluster1.span, cluster2.span);
 
        Set<Long> idsUnion = cluster1.getEventIDs();
        if(!idsUnion.isEmpty()) {
            idsUnion.addAll(cluster2.getEventIDs());
        } else {
            idsUnion = cluster2.getEventIDs();
        }
        
        Set<Long> hashHitsUnion = cluster1.getEventIDsWithHashHits();
        if(!hashHitsUnion.isEmpty()) {
            hashHitsUnion.addAll(cluster2.getEventIDsWithHashHits());
        } else {
            hashHitsUnion = cluster2.getEventIDsWithHashHits();
        }
        
        Set<Long> taggedUnion = cluster1.getEventIDsWithTags();
        if(!taggedUnion.isEmpty()) {
            taggedUnion.addAll(cluster2.getEventIDsWithTags()); 
        } else {
            taggedUnion = cluster2.getEventIDsWithTags();
        }
 
        return new EventCluster(spanningInterval,
                cluster1.getEventType(), idsUnion, hashHitsUnion, taggedUnion,
                cluster1.getDescription(), cluster1.lod);
    }
 
    private EventCluster(Interval spanningInterval, TimelineEventType type, Set<Long> eventIDs,
                         Set<Long> hashHits, Set<Long> tagged, String description, TimelineLevelOfDetail lod,
                         EventStripe parent) {
 
        this.span = spanningInterval;
 
        this.type = type;
        this.hashHits = hashHits;
        this.tagged = tagged;
        this.description = description;
        this.eventIDs = eventIDs;
        this.lod = lod;
        this.parent = parent;
    }
 
    public EventCluster(Interval spanningInterval, TimelineEventType type, Set<Long> eventIDs,
                        Set<Long> hashHits, Set<Long> tagged, String description, TimelineLevelOfDetail lod) {
        this(spanningInterval, type, eventIDs, hashHits, tagged, description, lod, null);
    }
 
 
    public EventCluster(TimelineEvent event, TimelineEventType type, TimelineLevelOfDetail lod) {
        this.span = new Interval(event.getEventTimeInMs(), event.getEventTimeInMs());
        this.type = type;
 
        this.eventIDs = new HashSet<>();
        this.eventIDs.add(event.getEventID());
        this.hashHits = event.eventSourceHasHashHits()? new HashSet<>(eventIDs) : emptySet();
        this.tagged = event.eventSourceIsTagged()? new HashSet<>(eventIDs) : emptySet();
        this.lod = lod;
        this.description = event.getDescription(lod);
        this.parent = null;
    }

    @Override
    public Optional<EventStripe> getParent() {
        return Optional.ofNullable(parent);
    }

    @Override
    public Optional<EventStripe> getParentStripe() {
        //since this clusters parent must be an event stripe just delegate to getParent();
        return getParent();
    }
 
    public Interval getSpan() {
        return span;
    }
 
    @Override
    public long getStartMillis() {
        return span.getStartMillis();
    }
 
    @Override
    public long getEndMillis() {
        return span.getEndMillis();
    }
 
    @Override
    public Set<Long> getEventIDs() {
        return eventIDs;
    }
 
    @Override
    public Set<Long> getEventIDsWithHashHits() {
        return hashHits;
    }
 
    @Override
    public Set<Long> getEventIDsWithTags() {
        return tagged;
    }
 
    @Override
    public String getDescription() {
        return description;
    }
 
    @Override
    public TimelineEventType getEventType() {
        return type;
    }
 
    @Override
    public TimelineLevelOfDetail getDescriptionLevel() {
        return lod;
    }

    public EventCluster withParent(EventStripe parent) {
 
        return new EventCluster(span, type, eventIDs, hashHits, tagged, description, lod, parent);
    }
 
    @Override
    public SortedSet<EventCluster> getClusters() {
        return DetailsViewModel.copyAsSortedSet(singleton(this), Comparator.comparing(cluster -> true));
    }
 
    @Override
    public String toString() {
        return "EventCluster{" + "description=" + description + ", eventIDs=" + eventIDs.size() + '}';
    }
 
    @Override
    public int hashCode() {
        int hash = 7;
        hash = 23 * hash + Objects.hashCode(this.type);
        hash = 23 * hash + Objects.hashCode(this.description);
        hash = 23 * hash + Objects.hashCode(this.lod);
        hash = 23 * hash + Objects.hashCode(this.eventIDs);
        return hash;
    }
 
    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final EventCluster other = (EventCluster) obj;
        if (!Objects.equals(this.description, other.description)) {
            return false;
        }
        if (!Objects.equals(this.type, other.type)) {
            return false;
        }
        if (this.lod != other.lod) {
            return false;
        }
        return Objects.equals(this.eventIDs, other.eventIDs);
    }
}