KeywordHit.java

Go to the documentation of this file.

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

import java.sql.ResultSet;
import java.sql.SQLException;
import java.util.Comparator;
import java.util.Objects;
import java.util.Optional;
import org.apache.commons.lang3.StringUtils;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException;
import org.sleuthkit.datamodel.BlackboardAttribute;
import org.sleuthkit.datamodel.SleuthkitCase;
import org.sleuthkit.datamodel.TskCoreException;

class KeywordHit implements Comparable<KeywordHit> {

    private static final String GET_CONTENT_ID_FROM_ARTIFACT_ID = "SELECT obj_id FROM blackboard_artifacts WHERE artifact_id = ";

    private final long solrObjectId;
    private final int chunkId;
    private final String snippet;
    private final String hit;
   
    KeywordHit(String solrDocumentId, String snippet, String hit) {
        this.snippet = StringUtils.stripToEmpty(snippet);
        this.hit = hit;

        /*
         * Parse the Solr document id to get the Solr object id and chunk id.
         * The Solr object id will either be the object id of a file id or an
         * artifact id from the case database.
         *
         * For every object (file or artifact) there will at least two Solr
         * documents. One contains object metadata (chunk #1) and the second and
         * subsequent documents contain chunks of the text.
         */
        if(!solrDocumentId.isEmpty()) {
            String[] split = solrDocumentId.split(Server.CHUNK_ID_SEPARATOR);
            if (split.length == 1) {
                //chunk 0 has only the bare document id without the chunk id.
                this.solrObjectId = Long.parseLong(solrDocumentId);
                this.chunkId = 0;
            } else {
                this.solrObjectId = Long.parseLong(split[0]);
                this.chunkId = Integer.parseInt(split[1]);
            }
        } else {
            this.solrObjectId = 0;
            this.chunkId = 0;
        }
    }

    KeywordHit(int chunkId, long sourceID, String snippet, String hit) {
        this.snippet = StringUtils.stripToEmpty(snippet);
        this.hit = hit;
        this.chunkId = chunkId;
        this.solrObjectId = sourceID;
    }
    

    String getHit() {
        return hit;
    }

    String getSolrDocumentId() {
        return Long.toString(solrObjectId) + Server.CHUNK_ID_SEPARATOR + Long.toString(chunkId);
    }

    Long getSolrObjectId() {
        return this.solrObjectId;
    }

    Integer getChunkId() {
        return this.chunkId;
    }

    boolean hasSnippet() {
        return StringUtils.isNotBlank(this.snippet);
    }

    String getSnippet() {
        return this.snippet;
    }
    
    long getContentID() throws TskCoreException {
        if (isArtifactHit()) {
            // If the hit was in an artifact, look up the source content for the artifact.
            SleuthkitCase caseDb;
            try {
                caseDb = Case.getCurrentCaseThrows().getSleuthkitCase();
            } catch (NoCurrentCaseException ex) {
                throw new TskCoreException("Exception while getting open case.", ex);
            }
            try (SleuthkitCase.CaseDbQuery executeQuery =
                    caseDb.executeQuery(GET_CONTENT_ID_FROM_ARTIFACT_ID + this.solrObjectId);
                    ResultSet resultSet = executeQuery.getResultSet();) {
                if (resultSet.next()) {
                    return resultSet.getLong("obj_id");
                } else {
                    throw new TskCoreException("Failed to get obj_id for artifact with artifact_id =" + this.solrObjectId + ".  No matching artifact was found.");
                }
            } catch (SQLException ex) {
                throw new TskCoreException("Error getting obj_id for artifact with artifact_id =" + this.solrObjectId, ex);
            }
        } else {
            //else the object id is for content.
            return this.solrObjectId;
        }
    }

    boolean isArtifactHit() {
        // artifacts have negative obj ids
        return this.solrObjectId < 0;
    }

    Optional<Long> getArtifactID() {
        if (isArtifactHit()) {
            return Optional.of(solrObjectId);
        } else {
            return Optional.empty();
        }
    }

    @Override
    public boolean equals(Object obj) {
        if (null == obj) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        final KeywordHit other = (KeywordHit) obj;
        return compareTo(other) == 0;
    }
      
    @Override
    public int hashCode() {
        int hash = 7;
        hash = 37 * hash + (int) (this.solrObjectId ^ (this.solrObjectId >>> 32));
        hash = 37 * hash + this.chunkId;
        hash = 37 * hash + Objects.hashCode(this.snippet);
        hash = 37 * hash + Objects.hashCode(this.hit);
        return hash;
    }

    @Override
    public int compareTo(KeywordHit other) {
        return Comparator.comparing(KeywordHit::getSolrObjectId)
                .thenComparing(KeywordHit::getChunkId)
                .thenComparing(KeywordHit::getHit)
                .thenComparing(KeywordHit::getSnippet)
                .compare(this, other);
    }
}