Index.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2011-2017 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.text.SimpleDateFormat;
import java.util.Date;
import org.apache.commons.lang.math.NumberUtils;
import org.sleuthkit.autopsy.coreutils.UNCPathUtilities;

final class Index {

    private final String indexPath;
    private final String schemaVersion;
    private final String solrVersion;
    private final String indexName;
    private static final String DEFAULT_CORE_NAME = "text_index"; //NON-NLS
    private final UNCPathUtilities uncPathUtilities = new UNCPathUtilities();

    Index(String indexPath, String solrVersion, String schemaVersion, String coreName, String caseName) {
        this.indexPath = uncPathUtilities.convertPathToUNC(indexPath);
        this.solrVersion = solrVersion;
        this.schemaVersion = schemaVersion;
        if (coreName == null || coreName.isEmpty()) {
            // come up with a new core name
            coreName = createCoreName(caseName);
        }
        this.indexName = coreName;
    }

    private String createCoreName(String caseName) {
        String coreName = sanitizeCoreName(caseName);
        SimpleDateFormat dateFormat = new SimpleDateFormat("yyyyMMdd_HHmmss");
        Date date = new Date();
        return coreName + "_" + dateFormat.format(date);
    }

    static private String sanitizeCoreName(String coreName) {

        String result;
        
        // Allow these characters: '-', '.', '0'-'9', 'A'-'Z', '_', and 'a'-'z'.
        // Replace all else with '_'.
        result = coreName.replaceAll("[^-.0-9A-Z_a-z]", "_"); // NON-NLS

        // Make it all lowercase
        result = result.toLowerCase();

        // Must not start with hyphen
        if (result.length() > 0 && (result.codePointAt(0) == '-')) {
            result = "_" + result;
        }

        if (result.isEmpty()) {
            result = DEFAULT_CORE_NAME;
        }

        return result;
    }

    String getIndexPath() {
        return indexPath;
    }

    String getSchemaVersion() {
        return schemaVersion;
    }

    String getSolrVersion() {
        return solrVersion;
    }

    String getIndexName() {
        return indexName;
    }

    boolean isCompatible(String version) {
        // Versions are compatible if they have the same major version no
        int currentMajorVersion = NumberUtils.toInt(schemaVersion.substring(0, schemaVersion.indexOf('.')));
        int givenMajorVersion = NumberUtils.toInt(version.substring(0, version.indexOf('.')));

        return currentMajorVersion == givenMajorVersion;
    }
}