StateManager.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 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.communications;

import com.google.common.eventbus.Subscribe;
import java.util.HashSet;
import java.util.Set;
import org.sleuthkit.autopsy.communications.FiltersPanel.DateControlState;
import org.sleuthkit.autopsy.coreutils.History;
import org.sleuthkit.datamodel.CommunicationsFilter;

final class StateManager {
    
    private final History<CommunicationsState> historyManager = new History<>();
    private CommunicationsFilter comFilter;
    private final PinnedAccountModel pinModel;
    private DateControlState currentStartState;
    private DateControlState currentEndState;
    
    public StateManager(PinnedAccountModel pinModel){
        this.pinModel = pinModel;
        CVTEvents.getCVTEventBus().register(this);
    }
    
    @Subscribe
    void pinAccount(CVTEvents.PinAccountsEvent pinEvent) {
        if(pinEvent.isReplace()){
            HashSet<AccountDeviceInstanceKey> pinnedList = new HashSet<>();
            pinnedList.addAll(pinEvent.getAccountDeviceInstances());
            historyManager.advance(new CommunicationsState(comFilter, pinnedList, -1, currentStartState, currentEndState));
        } else {
            HashSet<AccountDeviceInstanceKey> pinnedList = new HashSet<>();
            pinnedList.addAll(pinEvent.getAccountDeviceInstances());
            pinnedList.addAll(pinModel.getPinnedAccounts());
            
            historyManager.advance(new CommunicationsState( comFilter, pinnedList, -1, currentStartState, currentEndState));
        }
    }
    
    @Subscribe
    void filterChange(CVTEvents.FilterChangeEvent filterEvent) {
        comFilter = filterEvent.getNewFilter();
        currentStartState = filterEvent.getStartControlState();
        currentEndState = filterEvent.getEndControlState();
        historyManager.advance(new CommunicationsState(comFilter, pinModel.getPinnedAccounts(), -1, currentStartState, currentEndState));
    }
    
    @Subscribe
    void unpinAccounts(CVTEvents.UnpinAccountsEvent pinEvent) {

        HashSet<AccountDeviceInstanceKey> pinnedList = new HashSet<>();
        pinnedList.addAll(pinModel.getPinnedAccounts());
        pinnedList.removeAll(pinEvent.getAccountDeviceInstances());
        
        historyManager.advance(new CommunicationsState(comFilter, pinnedList, -1, currentStartState, currentEndState));
    }
    
    @Subscribe
    void zoomedGraph(CVTEvents.ScaleChangeEvent zoomEvent) {
        historyManager.advance(new CommunicationsState(comFilter, pinModel.getPinnedAccounts(), zoomEvent.getZoomValue(), currentStartState, currentEndState));
    }
    
    public CommunicationsState retreat(){
        if(canRetreat()) {
            return historyManager.retreat();
        } else {
            return null;
        }
    }
    
    public CommunicationsState advance() {
        if(canAdvance()) {
            return historyManager.advance();
        } else {
            return null;
        }
    }
    
    public boolean canRetreat() {
        return historyManager.canRetreat();
    }
    
    public boolean canAdvance(){
        return historyManager.canAdvance();
    }

    final class CommunicationsState{
        private final CommunicationsFilter communcationFilter;
        private final Set<AccountDeviceInstanceKey> pinnedList;
        private final double zoomValue;
        private final DateControlState startDateState;
        private final DateControlState endDateState;
        
        protected CommunicationsState(CommunicationsFilter communcationFilter, 
                Set<AccountDeviceInstanceKey> pinnedList, double zoomValue, 
                DateControlState startDateState, DateControlState endDateState){
            this.pinnedList = pinnedList;
            this.communcationFilter = communcationFilter;
            this.zoomValue = zoomValue;
            this.startDateState = startDateState;
            this.endDateState = endDateState;
        }
   
        public boolean isZoomChange() {
            return (zoomValue != -1);
        }
        
        public Set<AccountDeviceInstanceKey> getPinnedList(){
            return pinnedList;
        }

        public CommunicationsFilter getCommunicationsFilter() {
            return communcationFilter;
        }
        
        public double getZoomValue() {
            return zoomValue;
        }
        
        public DateControlState getStartControlState() {
            return startDateState;
        }
        
        public DateControlState getEndControlState() {
            return endDateState;
        }
    }
}