NodeData.java

Go to the documentation of this file.

/*
 * Central Repository
 *
 * Copyright 2018-2021 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.centralrepository.application;
 
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.centralrepository.datamodel.CorrelationAttributeInstance;
import org.sleuthkit.autopsy.centralrepository.datamodel.CentralRepoException;
import org.sleuthkit.datamodel.AbstractFile;
import org.sleuthkit.datamodel.DataSource;
import org.sleuthkit.datamodel.TskCoreException;
import org.sleuthkit.datamodel.TskData;
import org.sleuthkit.datamodel.TskDataException;

public class NodeData {
 
    // For now hard code the string for the central repo files type, since 
    // getting it dynamically can fail.
    private static final String FILE_TYPE_STR = "Files";
    private static final String CSV_ITEM_SEPARATOR = "\",\"";
 
    private final String caseName;
    private String deviceID;
    private String dataSourceName;
    private final String filePath;
    private final String typeStr;
    private final String value;
    private TskData.FileKnown known;
    private String comment;
 
    private AbstractFile originalAbstractFile = null;
    private CorrelationAttributeInstance originalCorrelationInstance = null;

    public NodeData(CorrelationAttributeInstance instance, CorrelationAttributeInstance.Type type, String value) {
        caseName = instance.getCorrelationCase().getDisplayName();
        deviceID = instance.getCorrelationDataSource().getDeviceID();
        dataSourceName = instance.getCorrelationDataSource().getName();
        filePath = instance.getFilePath();
        this.typeStr = type.getDisplayName();
        this.value = value;
        known = instance.getKnownStatus();
        comment = instance.getComment();
 
        originalCorrelationInstance = instance;
    }

    NodeData(AbstractFile newFile, Case autopsyCase) throws CentralRepoException {
        caseName = autopsyCase.getDisplayName();
        try {
            DataSource dataSource = autopsyCase.getSleuthkitCase().getDataSource(newFile.getDataSource().getId());
            deviceID = dataSource.getDeviceId();
            dataSourceName = dataSource.getName();
        } catch (TskDataException | TskCoreException ex) {
            throw new CentralRepoException("Error loading data source for abstract file ID " + newFile.getId(), ex);
        }
 
        filePath = newFile.getParentPath() + newFile.getName();
        typeStr = FILE_TYPE_STR;
        value = newFile.getMd5Hash();
        known = newFile.getKnown();
        comment = "";
 
        originalAbstractFile = newFile;
    }

    boolean isFileType() {
        return FILE_TYPE_STR.equals(typeStr);
    }

    void updateKnown(TskData.FileKnown newKnownStatus) {
        known = newKnownStatus;
    }

    public void updateComment(String newComment) {
        comment = newComment;
    }

    public String getCaseName() {
        return caseName;
    }

    public String getDeviceID() {
        return deviceID;
    }

    public String getDataSourceName() {
        return dataSourceName;
    }

    public String getFilePath() {
        return filePath;
    }

    public String getType() {
        return typeStr;
    }

    public String getValue() {
        return value;
    }

    public TskData.FileKnown getKnown() {
        return known;
    }

    public String getComment() {
        return comment;
    }

    public AbstractFile getAbstractFile() throws CentralRepoException {
        if (originalAbstractFile == null) {
            throw new CentralRepoException("AbstractFile is null");
        }
        return originalAbstractFile;
    }

    public CorrelationAttributeInstance getCorrelationAttributeInstance() throws CentralRepoException {
        if (originalCorrelationInstance == null) {
            throw new CentralRepoException("CorrelationAttributeInstance is null");
        }
        return originalCorrelationInstance;
    }

    public static String getCsvItemSeparator() {
        return CSV_ITEM_SEPARATOR;
    }

    String toCsvString() {
        StringBuilder line = new StringBuilder("\"");
        line.append(getCaseName()).append(CSV_ITEM_SEPARATOR)
                .append(getDataSourceName()).append(CSV_ITEM_SEPARATOR)
                .append(getType()).append(CSV_ITEM_SEPARATOR)
                .append(getValue()).append(CSV_ITEM_SEPARATOR)
                .append(getKnown().toString()).append(CSV_ITEM_SEPARATOR)
                .append(getFilePath()).append(CSV_ITEM_SEPARATOR)
                .append(getComment()).append('"')
                .append(System.getProperty("line.separator"));
        return line.toString();
    }
}