DataSourceSummaryReport.java

Go to the documentation of this file.

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

import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import java.util.logging.Level;
import java.util.stream.Collectors;
import javax.swing.JPanel;
import org.openide.util.NbBundle;
import org.openide.util.lookup.ServiceProvider;
import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.casemodule.NoCurrentCaseException;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.report.GeneralReportModule;
import org.sleuthkit.autopsy.report.GeneralReportSettings;
import org.sleuthkit.autopsy.report.ReportProgressPanel;
import org.sleuthkit.datamodel.Content;
import org.sleuthkit.datamodel.DataSource;
import org.sleuthkit.datamodel.TskCoreException;

@ServiceProvider(service = GeneralReportModule.class)
public class DataSourceSummaryReport implements GeneralReportModule {

    private static final Logger logger = Logger.getLogger(DataSourceSummaryReport.class.getName());
    private static DataSourceSummaryReport instance;

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

    public DataSourceSummaryReport() {
    }

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

    @Override
    public String getRelativeFilePath() {
        return "";
    }

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

    @Override
    public JPanel getConfigurationPanel() {
        return null;
    }
    
    @Override
    public boolean supportsDataSourceSelection() {
        return true;
    }
    
    @NbBundle.Messages({
        "DataSourceSummaryReport.error.noOpenCase=No currently open case.",
        "DataSourceSummaryReport.error.noDataSources=No data sources selected for report.",
        "DataSourceSummaryReport.failedToCompleteReport=Failed to complete report.",
        "DataSourceSummaryReport.excelFileWriteError=Could not write the xlsx file.",})
    @Override
    public void generateReport(GeneralReportSettings settings, ReportProgressPanel progressPanel) {
        progressPanel.start();
        Case currentCase;
        try {
            currentCase = Case.getCurrentCaseThrows();
        } catch (NoCurrentCaseException ex) {
            progressPanel.complete(ReportProgressPanel.ReportStatus.ERROR, Bundle.DataSourceSummaryReport_error_noOpenCase());
            logger.log(Level.SEVERE, "Exception while getting open case.", ex); //NON-NLS
            return;
        }
        
        String errorMessage = "";
        ReportProgressPanel.ReportStatus result = ReportProgressPanel.ReportStatus.COMPLETE;
        List<Content> selectedDataSources = new ArrayList<>();
        if(settings.getSelectedDataSources() == null) {
            // Process all data sources if the list is null.
            try {
                selectedDataSources = currentCase.getDataSources();                
                List<Long> dsIDs = selectedDataSources
                        .stream()
                        .map(Content::getId)
                        .collect(Collectors.toList());
                settings.setSelectedDataSources(dsIDs);
            } catch (TskCoreException ex) {
                result = ReportProgressPanel.ReportStatus.ERROR;
                errorMessage = Bundle.DataSourceSummaryReport_failedToCompleteReport();
                logger.log(Level.SEVERE, "Could not get the datasources from the case", ex);
                progressPanel.complete(result, errorMessage);
                return;
            }
        } else {
            for (Long dsID : settings.getSelectedDataSources()) {
                try {
                    selectedDataSources.add(currentCase.getSleuthkitCase().getContentById(dsID));
                } catch (TskCoreException ex) {
                    result = ReportProgressPanel.ReportStatus.ERROR;
                    errorMessage = Bundle.DataSourceSummaryReport_failedToCompleteReport();
                    logger.log(Level.SEVERE, "Could not get the datasources from the case", ex);
                    progressPanel.complete(result, errorMessage);
                    return;
                }
            }
        }
        
        if (selectedDataSources.isEmpty()) {
            result = ReportProgressPanel.ReportStatus.ERROR;
            progressPanel.complete(result, Bundle.DataSourceSummaryReport_error_noDataSources());
            logger.log(Level.SEVERE, "No data sources selected for report."); //NON-NLS
            return;            
        }
        
        // looop over all selected data sources
        for (Content dataSource : selectedDataSources){
            if (dataSource instanceof DataSource) {
                try {
                    new ExcelExportAction().exportToXLSX(progressPanel, (DataSource) dataSource, settings.getReportDirectoryPath());
                } catch (IOException | ExcelExport.ExcelExportException ex) {
                    errorMessage = Bundle.DataSourceSummaryReport_excelFileWriteError();
                    logger.log(Level.SEVERE, errorMessage, ex); //NON-NLS
                    progressPanel.complete(ReportProgressPanel.ReportStatus.ERROR, errorMessage);
                    return;
                }
            }
        }

        progressPanel.complete(result, errorMessage);
    }

}