UiSnapShotReportWriter.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2016 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.report.uisnapshot;

import com.github.mustachejava.DefaultMustacheFactory;
import com.github.mustachejava.Mustache;
import com.github.mustachejava.MustacheFactory;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.Writer;
import java.nio.charset.Charset;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.text.SimpleDateFormat;
import java.util.Date;
import java.util.HashMap;
import org.apache.commons.lang3.StringUtils;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.ingest.IngestManager;
import org.sleuthkit.autopsy.report.ReportBranding;

public abstract class UiSnapShotReportWriter {

    private final static MustacheFactory mf = new DefaultMustacheFactory();

    private final Case currentCase;
    private final Path reportFolderPath;
    private final String reportName;
    private final ReportBranding reportBranding;

    private Date generationDate;

    protected UiSnapShotReportWriter(Case currentCase, Path reportFolderPath, String reportName, Date generationDate) {
        this.currentCase = currentCase;
        this.reportFolderPath = reportFolderPath;
        this.reportName = reportName;
        this.generationDate = generationDate;

        this.reportBranding = new ReportBranding();
    }

    public Path writeReport() throws IOException {
        //ensure directory exists 
        Files.createDirectories(reportFolderPath);

        copyResources();

        writeSummaryHTML();
        writeSnapShotHTMLFile();
        return writeIndexHTML();
    }
    
    protected String getReportName() {
        return reportName;
    }
    
    protected Path getReportFolderPath() {
        return reportFolderPath;
    }
    
    protected Case getCurrentCase() {
        return currentCase;
    }

    protected abstract void writeSnapShotHTMLFile() throws IOException ;

    private Path writeIndexHTML() throws IOException {
        //make a map of context objects to resolve template paramaters against
        HashMap<String, Object> indexContext = new HashMap<>();
        indexContext.put("reportBranding", reportBranding); //NON-NLS
        indexContext.put("reportName", reportName); //NON-NLS
        Path reportIndexFile = reportFolderPath.resolve("index.html"); //NON-NLS

        fillTemplateAndWrite("/org/sleuthkit/autopsy/report/uisnapshot/index_template.html", "Index", indexContext, reportIndexFile); //NON-NLS
        return reportIndexFile;
    }

    private void writeSummaryHTML() throws IOException {
        //make a map of context objects to resolve template paramaters against
        HashMap<String, Object> summaryContext = new HashMap<>();
        summaryContext.put("reportName", reportName); //NON-NLS
        summaryContext.put("reportBranding", reportBranding); //NON-NLS
        summaryContext.put("generationDateTime", new SimpleDateFormat("yyyy/MM/dd HH:mm:ss").format(generationDate)); //NON-NLS
        summaryContext.put("ingestRunning", IngestManager.getInstance().isIngestRunning()); //NON-NLS
        summaryContext.put("currentCase", currentCase); //NON-NLS
        String agencyLogo = "agency_logo.png"; //default name for agency logo.
        if (StringUtils.isNotBlank(reportBranding.getAgencyLogoPath())){
            agencyLogo = Paths.get(reportBranding.getAgencyLogoPath()).getFileName().toString();
        }
        summaryContext.put("agencyLogoFileName", agencyLogo);
        fillTemplateAndWrite("/org/sleuthkit/autopsy/report/uisnapshot/summary_template.html", "Summary", summaryContext, reportFolderPath.resolve("summary.html")); //NON-NLS
    }

    protected void fillTemplateAndWrite(final String templateLocation, final String templateName, Object context, final Path outPutFile) throws IOException {

        Mustache summaryMustache = mf.compile(new InputStreamReader(UiSnapShotReportWriter.class.getResourceAsStream(templateLocation)), templateName);
        try (Writer writer = Files.newBufferedWriter(outPutFile, Charset.forName("UTF-8"))) { //NON-NLS
            summaryMustache.execute(writer, context);
        }
    }

    private void copyResources() throws IOException {

        //pull generator and agency logos from branding
        String generatorLogoPath = reportBranding.getGeneratorLogoPath();
        if (StringUtils.isNotBlank(generatorLogoPath)) {
            Files.copy(Files.newInputStream(Paths.get(generatorLogoPath)), reportFolderPath.resolve("generator_logo.png")); //NON-NLS
        }
        String agencyLogoPath = reportBranding.getAgencyLogoPath();
        if (StringUtils.isNotBlank(agencyLogoPath)) {
            Files.copy(Files.newInputStream(Paths.get(agencyLogoPath)), reportFolderPath.resolve(Paths.get(reportBranding.getAgencyLogoPath()).getFileName())); //NON-NLS
        }
        
        //copy favicon
        if (StringUtils.isBlank(agencyLogoPath)) {
            copyInternalResource("/org/sleuthkit/autopsy/report/images/favicon.ico", "favicon.ico");
        } else {
            Files.copy(Files.newInputStream(Paths.get(agencyLogoPath)), reportFolderPath.resolve("favicon.ico")); //NON-NLS           
        }

        copyInternalResource("/org/sleuthkit/autopsy/report/uisnapshot/navigation.html", "nav.html");
        copyInternalResource("/org/sleuthkit/autopsy/report/images/summary.png", "summary.png");
        copyInternalResource("/org/sleuthkit/autopsy/report/images/image.png", "snapshot_icon.png");
        copyInternalResource("/org/sleuthkit/autopsy/report/uisnapshot/index.css", "index.css");
        copyInternalResource("/org/sleuthkit/autopsy/report/uisnapshot/summary.css", "summary.css");
    }
    
    private void copyInternalResource(String internalPath, String fileName) throws IOException{
        try (InputStream resource = UiSnapShotReportWriter.class.getResourceAsStream(internalPath)) { //NON-NLS
            Files.copy(resource, reportFolderPath.resolve(fileName)); //NON-NLS
        }
    }
}