TextExtractorFactory.java

Go to the documentation of this file.

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

import java.util.Arrays;
import java.util.List;
import org.openide.util.Lookup;
import org.sleuthkit.datamodel.AbstractFile;
import org.sleuthkit.datamodel.BlackboardArtifact;
import org.sleuthkit.datamodel.Content;
import org.sleuthkit.datamodel.Report;

public class TextExtractorFactory {

    public static TextExtractor getExtractor(Content content, Lookup context) throws NoTextExtractorFound {
        if (content instanceof AbstractFile) {
            for (TextExtractor extractor : getFileExtractors((AbstractFile) content, context)) {
                if (extractor.isSupported()) {
                    return extractor;
                }
            }
        } else if (content instanceof BlackboardArtifact) {
            TextExtractor artifactExtractor = new ArtifactTextExtractor((BlackboardArtifact) content);
            artifactExtractor.setExtractionSettings(context);
            return artifactExtractor;
        } else if (content instanceof Report) {
            TextExtractor reportExtractor = new TikaTextExtractor(content);
            reportExtractor.setExtractionSettings(context);
            return reportExtractor;
        }

        throw new NoTextExtractorFound(
                String.format("Could not find a suitable reader for "
                        + "content with name [%s] and id=[%d].",
                        content.getName(), content.getId())
        );
    }

    private static List<TextExtractor> getFileExtractors(AbstractFile content, Lookup context) {
        List<TextExtractor> fileExtractors = Arrays.asList(
                new HtmlTextExtractor(content),
                new SqliteTextExtractor(content),
                new TikaTextExtractor(content));

        fileExtractors.forEach((fileExtractor) -> {
            fileExtractor.setExtractionSettings(context);
        });

        return fileExtractors;
    }

    public static TextExtractor getExtractor(Content content) throws NoTextExtractorFound {
        return TextExtractorFactory.getExtractor(content, null);
    }

    public static TextExtractor getStringsExtractor(Content content, Lookup context) {
        StringsTextExtractor stringsInstance = new StringsTextExtractor(content);
        stringsInstance.setExtractionSettings(context);
        return stringsInstance;
    }

    public static class NoTextExtractorFound extends Exception {

        public NoTextExtractorFound(String msg) {
            super(msg);
        }

        public NoTextExtractorFound(Throwable ex) {
            super(ex);
        }

        private NoTextExtractorFound(String msg, Throwable ex) {
            super(msg, ex);
        }
    }
}