ExcelReport.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2013-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.report.modules.excel;

import java.io.FileOutputStream;
import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.List;
import java.util.logging.Level;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.openide.util.NbBundle;
import org.openide.util.NbBundle.Messages;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.report.infrastructure.TableReportModule;
import org.sleuthkit.datamodel.TskCoreException;

class ExcelReport implements TableReportModule {

    private static final Logger logger = Logger.getLogger(ExcelReport.class.getName());
    private static ExcelReport instance;
    private static final int EXCEL_CELL_MAXIMUM_SIZE = 36767; //Specified at:https://poi.apache.org/apidocs/org/apache/poi/ss/SpreadsheetVersion.html

    private Workbook wb;
    private Sheet sheet;
    private CellStyle titleStyle;
    private CellStyle setStyle;
    private CellStyle elementStyle;
    private int rowIndex = 0;
    private int sheetColCount = 0;
    private String reportPath;

    // Get the default instance of this report
    public static synchronized ExcelReport getDefault() {
        if (instance == null) {
            instance = new ExcelReport();
        }
        return instance;
    }

    // Hidden constructor
    private ExcelReport() {
    }

    @Override
    public void startReport(String baseReportDir) {
        // Set the path and save it for when the report is written to disk.
        this.reportPath = baseReportDir + getRelativeFilePath();

        // Make a workbook.
        wb = new XSSFWorkbook();

        // Create some cell styles.
        // TODO: The commented out cell style settings below do not work as desired when
        // the output file is loaded by MS Excel or OfficeLibre. The font height and weight
        // settings only work as expected when the output file is loaded by OfficeLibre.
        // The alignment and text wrap settings appear to have no effect.
        titleStyle = wb.createCellStyle();
//        titleStyle.setBorderBottom((short) 1);
        Font titleFont = wb.createFont();
        titleFont.setFontHeightInPoints((short) 12);
        titleStyle.setFont(titleFont);
        titleStyle.setAlignment(HorizontalAlignment.LEFT);
        titleStyle.setWrapText(true);

        setStyle = wb.createCellStyle();
        Font setFont = wb.createFont();
        setFont.setFontHeightInPoints((short) 14);
        setFont.setBold(true);
        setStyle.setFont(setFont);
        setStyle.setAlignment(HorizontalAlignment.LEFT);
        setStyle.setWrapText(true);

        elementStyle = wb.createCellStyle();
//        elementStyle.setF illBackgroundColor(HSSFColor.LIGHT_YELLOW.index);
        Font elementFont = wb.createFont();
        elementFont.setFontHeightInPoints((short) 14);
        elementStyle.setFont(elementFont);
        elementStyle.setAlignment(HorizontalAlignment.LEFT);
        elementStyle.setWrapText(true);

        writeSummaryWorksheet();
    }

    @Override
    public void endReport() {
        FileOutputStream out = null;
        try {
            out = new FileOutputStream(reportPath);
            wb.write(out);
            Case.getCurrentCaseThrows().addReport(reportPath, NbBundle.getMessage(this.getClass(),
                    "ReportExcel.endReport.srcModuleName.text"), "");
        } catch (IOException ex) {
            logger.log(Level.SEVERE, "Failed to write Excel report.", ex); //NON-NLS
        } catch (TskCoreException ex) {
            String errorMessage = String.format("Error adding %s to case as a report", reportPath); //NON-NLS
            logger.log(Level.SEVERE, errorMessage, ex);
        } catch (NoCurrentCaseException ex) {
            logger.log(Level.SEVERE, "Exception while getting open case.", ex); //NON-NLS
        } finally {
            if (out != null) {
                try {
                    out.close();
                } catch (IOException ex) {
                }
            }
        }
    }

    @Override
    public void startDataType(String name, String description) {
        // Create a worksheet for the data type (assumed to be an artifact type).
        name = escapeForExcel(name);
        sheet = wb.createSheet(name);
        sheet.setAutobreaks(true);
        rowIndex = 0;

        // There will be at least two columns, one each for the artifacts count and its label.
        sheetColCount = 2;
    }

    @Override
    public void endDataType() {
        // Now that the sheet is complete, size the columns to the content.
        for (int i = 0; i < sheetColCount; ++i) {
            sheet.autoSizeColumn(i);
        }
    }

    @Override
    public void startSet(String setName) {
        setName = escapeForExcel(setName);
        Row row = sheet.createRow(rowIndex);
        row.setRowStyle(setStyle);
        row.createCell(0).setCellValue(setName);
        ++rowIndex;
    }

    @Override
    public void endSet() {
        // Add an empty row as a separator.
        sheet.createRow(rowIndex);
        ++rowIndex;
    }

    @Override
    public void addSetIndex(List<String> sets) {
        // Ignored in Excel Report
    }

    @Override
    public void addSetElement(String elementName) {
        elementName = escapeForExcel(elementName);
        Row row = sheet.createRow(rowIndex);
        row.setRowStyle(elementStyle);
        row.createCell(0).setCellValue(elementName);
        ++rowIndex;
    }

    @Override
    public void startTable(List<String> titles) {
        int tableColCount = 0;
        Row row = sheet.createRow(rowIndex);
        row.setRowStyle(titleStyle);
        for (int i = 0; i < titles.size(); i++) {
            row.createCell(i).setCellValue(titles.get(i));
            ++tableColCount;
        }
        ++rowIndex;

        // Keep track of the number of columns with data in them for later column auto-sizing.
        if (tableColCount > sheetColCount) {
            sheetColCount = tableColCount;
        }
    }

    @Override
    public void endTable() {
        // Add an empty row as a separator.
        sheet.createRow(rowIndex);
        ++rowIndex;
    }

    @Override
    @NbBundle.Messages({
        "ReportExcel.exceptionMessage.dataTooLarge=Value is too long to fit into an Excel cell. ",
        "ReportExcel.exceptionMessage.errorText=Error showing data into an Excel cell."
    })
    public void addRow(List<String> rowData) {
        Row row = sheet.createRow(rowIndex);
        for (int i = 0; i < rowData.size(); ++i) {
            Cell excelCell = row.createCell(i);
            try {
                excelCell.setCellValue(rowData.get(i));
            } catch (Exception e) {
                if (e instanceof java.lang.IllegalArgumentException && rowData.get(i).length() > EXCEL_CELL_MAXIMUM_SIZE) {
                    excelCell.setCellValue(Bundle.ReportExcel_exceptionMessage_dataTooLarge() + e.getMessage());
                } else {
                    excelCell.setCellValue(Bundle.ReportExcel_exceptionMessage_errorText());
                }
            }
        }
        ++rowIndex;
    }

    @Override
    public String dateToString(long date) {
        SimpleDateFormat sdf = new java.text.SimpleDateFormat("yyyy/MM/dd HH:mm:ss");
        return sdf.format(new java.util.Date(date * 1000));
    }

    @Override
    public String getName() {
        return NbBundle.getMessage(this.getClass(), "ReportExcel.getName.text");
    }

    @Override
    public String getDescription() {
        return NbBundle.getMessage(this.getClass(), "ReportExcel.getDesc.text");
    }

    @Override
    public String getRelativeFilePath() {
        return "Excel.xlsx"; //NON-NLS
    }

    private static String escapeForExcel(String text) {
        return text.replaceAll("[\\/\\:\\?\\*\\\\]", "_");
    }

    @Messages({
        "ReportExcel.writeSummary.sheetName=Summary",
        "ReportExcel.writeSummary.summary=Summary",
        "ReportExcel.writeSummary.caseName=Case Name:",
        "ReportExcel.writeSummary.numImages=Number of Images:",
        "ReportExcel.writeSummary.caseNum=Case Number:",
        "ReportExcel.writeSummary.caseNotes=Case Notes:",
        "ReportExcel.writeSummary.examiner=Examiner:"
    })
    private void writeSummaryWorksheet() {
        Case currentCase;
        try {
            currentCase = Case.getCurrentCaseThrows();
        } catch (NoCurrentCaseException ex) {
            logger.log(Level.SEVERE, "Exception while getting open case.", ex); //NON-NLS
            return;
        }
        sheet = wb.createSheet(Bundle.ReportExcel_writeSummary_sheetName());
        rowIndex = 0;

        Row row = sheet.createRow(rowIndex);
        row.setRowStyle(setStyle);
        row.createCell(0).setCellValue(Bundle.ReportExcel_writeSummary_summary());
        ++rowIndex;

        sheet.createRow(rowIndex);
        ++rowIndex;

        row = sheet.createRow(rowIndex);
        row.setRowStyle(setStyle);
        row.createCell(0).setCellValue(Bundle.ReportExcel_writeSummary_caseName());
        row.createCell(1).setCellValue(currentCase.getDisplayName());
        ++rowIndex;

        if (!currentCase.getNumber().isEmpty()) {
            row = sheet.createRow(rowIndex);
            row.setRowStyle(setStyle);
            row.createCell(0).setCellValue(Bundle.ReportExcel_writeSummary_caseNum());
            row.createCell(1).setCellValue(currentCase.getNumber());
            ++rowIndex;
        }

        row = sheet.createRow(rowIndex);
        row.setRowStyle(setStyle);
        row.createCell(0).setCellValue(Bundle.ReportExcel_writeSummary_numImages());
        int numImages;
        try {
            numImages = currentCase.getDataSources().size();
        } catch (TskCoreException ex) {
            numImages = 0;
        }
        row.createCell(1).setCellValue(numImages);
        ++rowIndex;

        if (!currentCase.getCaseNotes().isEmpty()) {
            row = sheet.createRow(rowIndex);
            row.setRowStyle(setStyle);
            row.createCell(0).setCellValue(Bundle.ReportExcel_writeSummary_caseNotes());
            row.createCell(1).setCellValue(currentCase.getCaseNotes());
            ++rowIndex;
        }

        if (!currentCase.getExaminer().isEmpty()) {
            row = sheet.createRow(rowIndex);
            row.setRowStyle(setStyle);
            row.createCell(0).setCellValue(Bundle.ReportExcel_writeSummary_examiner());
            row.createCell(1).setCellValue(currentCase.getExaminer());
            ++rowIndex;
        }

        sheet.autoSizeColumn(0);
        sheet.autoSizeColumn(1);
    }
}