StartupWindowProvider.java

Go to the documentation of this file.

/*
 * Autopsy Forensic Browser
 *
 * Copyright 2013-2019 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.casemodule;

import java.awt.Frame;
import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.util.Collection;
import java.util.Iterator;
import java.util.logging.Level;
import javax.swing.SwingUtilities;
import org.apache.commons.io.FileUtils;
import org.apache.commons.lang3.StringUtils;
import org.openide.util.Lookup;
import org.openide.util.NbBundle;
import org.openide.windows.WindowManager;
import org.sleuthkit.autopsy.apputils.ResetWindowsAction;
import org.sleuthkit.autopsy.commandlineingest.CommandLineIngestManager;
import org.sleuthkit.autopsy.commandlineingest.CommandLineOpenCaseManager;
import org.sleuthkit.autopsy.commandlineingest.CommandLineOptionProcessor;
import org.sleuthkit.autopsy.commandlineingest.CommandLineStartupWindow;
import org.sleuthkit.autopsy.core.RuntimeProperties;
import org.sleuthkit.autopsy.core.UserPreferences;
import org.sleuthkit.autopsy.coreutils.Logger;
import org.sleuthkit.autopsy.coreutils.MessageNotifyUtil;

public class StartupWindowProvider implements StartupWindowInterface {

    private static volatile StartupWindowProvider instance;
    private static final Logger logger = Logger.getLogger(StartupWindowProvider.class.getName());
    private volatile StartupWindowInterface startupWindowToUse;

    public static StartupWindowProvider getInstance() {
        if (instance == null) {
            synchronized (StartupWindowProvider.class) {
                if (instance == null) {
                    instance = new StartupWindowProvider();
                    instance.init();
                }
            }
        }

        return instance;
    }

    @NbBundle.Messages({
        "# {0} - autFilePath",
        "StartupWindowProvider.openCase.noFile=Unable to open previously open case because metadata file not found at: {0}",
        "# {0} - reOpenFilePath",
        "StartupWindowProvider.openCase.deleteOpenFailure=Unable to open or delete file containing path {0} to previously open case. The previous case will not be opened.",
        "# {0} - autFilePath",
        "StartupWindowProvider.openCase.cantOpen=Unable to open previously open case with metadata file: {0}"})
    private void init() {
        if (startupWindowToUse == null) {
            // first check whether we are running from command line
            // or if we are running headless. Assume headless if the top level
            // window is not visible.
            boolean headless = !WindowManager.getDefault().getMainWindow().isVisible();
            if (isRunningFromCommandLine() || headless) {

                String defaultArg = getDefaultArgument();
                if (defaultArg != null) {
                    new CommandLineOpenCaseManager(defaultArg).start();
                    return;
                } else {
                    // Autopsy is running from command line
                    logger.log(Level.INFO, "Running from command line"); //NON-NLS
                    if(!headless) {
                        startupWindowToUse = new CommandLineStartupWindow();
                    }
                    // kick off command line processing
                    new CommandLineIngestManager().start();
                    return;
                }
            }

            if (RuntimeProperties.runningWithGUI()) {
                checkSolr();
            }
            //discover the registered windows
            Collection<? extends StartupWindowInterface> startupWindows
                    = Lookup.getDefault().lookupAll(StartupWindowInterface.class);

            int windowsCount = startupWindows.size();
            switch (windowsCount) {
                case 1:
                    startupWindowToUse = startupWindows.iterator().next();
                    logger.log(Level.INFO, "Will use the default startup window: {0}", startupWindowToUse.toString()); //NON-NLS
                    break;
                case 2: {
                    //pick the non default one
                    Iterator<? extends StartupWindowInterface> it = startupWindows.iterator();
                    while (it.hasNext()) {
                        StartupWindowInterface window = it.next();
                        if (!org.sleuthkit.autopsy.casemodule.StartupWindow.class.isInstance(window)) {
                            startupWindowToUse = window;
                            logger.log(Level.INFO, "Will use the custom startup window: {0}", startupWindowToUse.toString()); //NON-NLS
                            break;
                        }
                    }
                    break;
                }
                default: {
                    // select first non-Autopsy start up window
                    Iterator<? extends StartupWindowInterface> it = startupWindows.iterator();
                    while (it.hasNext()) {
                        StartupWindowInterface window = it.next();
                        if (!window.getClass().getCanonicalName().startsWith("org.sleuthkit.autopsy")) {
                            startupWindowToUse = window;
                            logger.log(Level.INFO, "Will use the custom startup window: {0}", startupWindowToUse.toString()); //NON-NLS
                            break;
                        }
                    }
                    break;
                }
            }

            if (startupWindowToUse == null) {
                logger.log(Level.SEVERE, "Unexpected error, no startup window chosen, using the default"); //NON-NLS
                startupWindowToUse = new org.sleuthkit.autopsy.casemodule.StartupWindow();
            }
        }
        File openPreviousCaseFile = new File(ResetWindowsAction.getCaseToReopenFilePath());

        if (openPreviousCaseFile.exists()) {
            //do actual opening on another thread
            new Thread(() -> {
                String caseFilePath = "";
                String unableToOpenMessage = null;
                try {
                    //avoid readFileToString having ambiguous arguments 
                    Charset encoding = null;
                    caseFilePath = FileUtils.readFileToString(openPreviousCaseFile, encoding);
                    if (new File(caseFilePath).exists()) {
                        FileUtils.forceDelete(openPreviousCaseFile);
                        //close the startup window as we attempt to open the case
                        close();
                        Case.openAsCurrentCase(caseFilePath);

                    } else {
                        unableToOpenMessage = Bundle.StartupWindowProvider_openCase_noFile(caseFilePath);
                        logger.log(Level.WARNING, unableToOpenMessage);
                    }
                } catch (IOException ex) {
                    unableToOpenMessage = Bundle.StartupWindowProvider_openCase_deleteOpenFailure(ResetWindowsAction.getCaseToReopenFilePath());
                    logger.log(Level.WARNING, unableToOpenMessage, ex);
                } catch (CaseActionException ex) {
                    unableToOpenMessage = Bundle.StartupWindowProvider_openCase_cantOpen(caseFilePath);
                    logger.log(Level.WARNING, unableToOpenMessage, ex);
                }

                if (RuntimeProperties.runningWithGUI() && !StringUtils.isBlank(unableToOpenMessage)) {
                    final String message = unableToOpenMessage;
                    SwingUtilities.invokeLater(() -> {
                        MessageNotifyUtil.Message.warn(message);
                        //the case was not opened restore the startup window
                        open();
                    });
                }
            }).start();
        }
    }

    private void checkSolr() {

        // if Multi-User settings are enabled and Solr8 server is not configured,
        // display an error message and a dialog
        if (UserPreferences.getIsMultiUserModeEnabled() && UserPreferences.getIndexingServerHost().isEmpty()) {
            // Solr 8 host name is not configured. This could be the first time user 
            // runs Autopsy with Solr 8. Display a message.
            MessageNotifyUtil.Notify.error(NbBundle.getMessage(CueBannerPanel.class, "SolrNotConfiguredDialog.title"),
                    NbBundle.getMessage(SolrNotConfiguredDialog.class, "SolrNotConfiguredDialog.EmptyKeywordSearchHostName"));

            SolrNotConfiguredDialog dialog = new SolrNotConfiguredDialog();
            dialog.setVisible(true);
        }
    }

    private boolean isRunningFromCommandLine() {

        CommandLineOptionProcessor processor = Lookup.getDefault().lookup(CommandLineOptionProcessor.class);
        if (processor != null) {
            return processor.isRunFromCommandLine();
        }
        return false;
    }

    private String getDefaultArgument() {
        CommandLineOptionProcessor processor = Lookup.getDefault().lookup(CommandLineOptionProcessor.class);
        if (processor != null) {
            return processor.getDefaultArgument();
        }
        return null;
    }

    @Override
    public void open() {
        if (startupWindowToUse != null) {
            startupWindowToUse.open();
        }
    }

    @Override
    public void close() {
        if (startupWindowToUse != null) {
            startupWindowToUse.close();
        }
    }

    public StartupWindowInterface getStartupWindow() {
        return startupWindowToUse;
    }
}