TextExtractor.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2012 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.util.Arrays;
import java.util.List;
import java.util.Map;
import org.sleuthkit.autopsy.coreutils.StringExtract.StringExtractUnicodeTable.SCRIPT;
import org.sleuthkit.datamodel.AbstractFile;

interface TextExtractor {

    enum ExtractOptions {

        EXTRACT_UTF16, 
        EXTRACT_UTF8, 
    };
    
    //generally text extractors should ignore archives
    //and let unpacking modules take case of them
    static final List<String> ARCHIVE_MIME_TYPES =
            Arrays.asList(
            //ignore unstructured binary and compressed data, for which string extraction or unzipper works better
            "application/x-7z-compressed", //NON-NLS
            "application/x-ace-compressed", //NON-NLS
            "application/x-alz-compressed", //NON-NLS
            "application/x-arj", //NON-NLS
            "application/vnd.ms-cab-compressed", //NON-NLS
            "application/x-cfs-compressed", //NON-NLS
            "application/x-dgc-compressed", //NON-NLS
            "application/x-apple-diskimage", //NON-NLS
            "application/x-gca-compressed", //NON-NLS
            "application/x-dar", //NON-NLS
            "application/x-lzx", //NON-NLS
            "application/x-lzh", //NON-NLS
            "application/x-rar-compressed", //NON-NLS
            "application/x-stuffit", //NON-NLS
            "application/x-stuffitx", //NON-NLS
            "application/x-gtar", //NON-NLS
            "application/x-archive", //NON-NLS
            "application/x-executable", //NON-NLS
            "application/x-gzip", //NON-NLS
            "application/zip", //NON-NLS
            "application/x-zoo", //NON-NLS
            "application/x-cpio", //NON-NLS
            "application/x-shar", //NON-NLS
            "application/x-tar", //NON-NLS
            "application/x-bzip", //NON-NLS
            "application/x-bzip2", //NON-NLS
            "application/x-lzip", //NON-NLS
            "application/x-lzma", //NON-NLS
            "application/x-lzop", //NON-NLS
            "application/x-z", //NON-NLS
            "application/x-compress"); //NON-NLS

    int getNumChunks();

    AbstractFile getSourceFile();

    boolean index(AbstractFile sourceFile) throws Ingester.IngesterException;

    boolean setScripts(List<SCRIPT> extractScript);

    List<SCRIPT> getScripts();

    Map<String, String> getOptions();

    void setOptions(Map<String, String> options);

    boolean isContentTypeSpecific();

    boolean isSupported(AbstractFile file, String detectedFormat);
}