MekHQ.java

/*
 * MekHQ.java
 *
 * Copyright (c) 2009 - Jay Lawson (jaylawson39 at yahoo.com). All Rights Reserved.
 * Copyright (c) 2020-2022 - The MegaMek Team. All Rights Reserved.
 *
 * This file is part of MekHQ.
 *
 * MekHQ is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * MekHQ is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with MekHQ. If not, see <http://www.gnu.org/licenses/>.
 */
package mekhq;

import megamek.MegaMek;
import megamek.client.Client;
import megamek.client.generator.RandomNameGenerator;
import megamek.client.generator.RandomUnitGenerator;
import megamek.client.ui.preferences.PreferencesNode;
import megamek.client.ui.preferences.SuitePreferences;
import megamek.client.ui.swing.GUIPreferences;
import megamek.client.ui.swing.gameConnectionDialogs.ConnectDialog;
import megamek.client.ui.swing.gameConnectionDialogs.HostDialog;
import megamek.common.event.*;
import megamek.server.GameManager;
import megamek.server.Server;
import megameklab.MegaMekLab;
import mekhq.campaign.Campaign;
import mekhq.campaign.CampaignController;
import mekhq.campaign.ResolveScenarioTracker;
import mekhq.campaign.event.ScenarioResolvedEvent;
import mekhq.campaign.handler.XPHandler;
import mekhq.campaign.mission.AtBContract;
import mekhq.campaign.mission.AtBScenario;
import mekhq.campaign.mission.Scenario;
import mekhq.campaign.storyarc.StoryArc;
import mekhq.campaign.stratcon.StratconRulesManager;
import mekhq.campaign.unit.Unit;
import mekhq.gui.CampaignGUI;
import mekhq.gui.StoryArcEditorGUI;
import mekhq.gui.dialog.ResolveScenarioWizardDialog;
import mekhq.gui.dialog.RetirementDefectionDialog;
import mekhq.gui.panels.StartupScreenPanel;
import mekhq.gui.preferences.StringPreference;
import mekhq.gui.utilities.ObservableString;
import mekhq.service.AutosaveService;
import mekhq.service.IAutosaveService;
import org.apache.logging.log4j.LogManager;

import javax.swing.*;
import javax.swing.text.DefaultEditorKit;
import java.awt.*;
import java.awt.event.KeyEvent;
import java.beans.PropertyChangeEvent;
import java.beans.PropertyChangeListener;
import java.io.File;
import java.io.FileNotFoundException;
import java.util.List;
import java.util.stream.Stream;

/**
 * The main class of the application.
 */
public class MekHQ implements GameListener {
    //region Variable Declarations
    private static final SuitePreferences mhqPreferences = new SuitePreferences();
    private static final MHQOptions mhqOptions = new MHQOptions();
    private static final EventBus EVENT_BUS = new EventBus();

    private static ObservableString selectedTheme;

    // Deprecated directory options
    private static ObservableString personnelDirectory;
    private static ObservableString partsDirectory;
    private static ObservableString planetsDirectory;
    private static ObservableString starMapsDirectory;
    private static ObservableString unitsDirectory;
    private static ObservableString campaignsDirectory;
    private static ObservableString scenarioTemplatesDirectory;
    private static ObservableString financesDirectory;

    // stuff related to MM games
    private Server myServer = null;
    private GameThread gameThread = null;
    private Scenario currentScenario = null;
    private Client client = null;

    // the actual campaign - this is where the good stuff is
    private CampaignController campaignController;
    private CampaignGUI campaignGUI;
    private StoryArcEditorGUI storyArcEditorGUI;

    private IconPackage iconPackage = new IconPackage();

    private final IAutosaveService autosaveService;
    //endregion Variable Declarations

    public static SuitePreferences getMHQPreferences() {
        return mhqPreferences;
    }

    public static MHQOptions getMHQOptions() {
        return mhqOptions;
    }

    public static ObservableString getSelectedTheme() {
        return selectedTheme;
    }

    public static ObservableString getPersonnelDirectory() {
        return personnelDirectory;
    }

    public static ObservableString getPartsDirectory() {
        return partsDirectory;
    }

    public static ObservableString getPlanetsDirectory() {
        return planetsDirectory;
    }

    public static ObservableString getStarMapsDirectory() {
        return starMapsDirectory;
    }

    public static ObservableString getUnitsDirectory() {
        return unitsDirectory;
    }

    public static ObservableString getCampaignsDirectory() {
        return campaignsDirectory;
    }

    public static ObservableString getScenarioTemplatesDirectory() {
        return scenarioTemplatesDirectory;
    }

    public static ObservableString getFinancesDirectory() {
        return financesDirectory;
    }

    protected static MekHQ getInstance() {
        return new MekHQ();
    }

    private MekHQ() {
        this.autosaveService = new AutosaveService();
    }

    /**
     * At startup create and show the main frame of the application.
     */
    protected void startup() {
        // Setup user preferences
        MegaMek.getMMPreferences().loadFromFile(MHQConstants.MM_PREFERENCES_FILE);
        MegaMekLab.getMMLPreferences().loadFromFile(MHQConstants.MML_PREFERENCES_FILE);
        getMHQPreferences().loadFromFile(MHQConstants.MHQ_PREFERENCES_FILE);

        setUserPreferences();

        initEventHandlers();
        // create a start-up frame and display it
        new StartupScreenPanel(this).getFrame().setVisible(true);
    }

    /**
     * restart back to the splash screen
     */
    public void restart() {

        // Actually close MHQ
        if (campaignGUI != null) {
            campaignGUI.getFrame().dispose();
        }

        new StartupScreenPanel(this).getFrame().setVisible(true);
    }

    @Deprecated // These need to be migrated to the Suite Constants / Suite Options Setup
    private void setUserPreferences() {
        try {
            PreferencesNode preferences = MekHQ.getMHQPreferences().forClass(MekHQ.class);

            // TODO: complete integration of Suite Preferences, including GUIPreferences
            selectedTheme = new ObservableString("selectedTheme", GUIPreferences.UI_THEME);
            selectedTheme.addPropertyChangeListener(new MekHqPropertyChangedListener());
            preferences.manage(new StringPreference(selectedTheme));

            personnelDirectory = new ObservableString("personnelDirectory", ".");
            preferences.manage(new StringPreference(personnelDirectory));

            partsDirectory = new ObservableString("partsDirectory", ".");
            preferences.manage(new StringPreference(partsDirectory));

            planetsDirectory = new ObservableString("planetsDirectory", ".");
            preferences.manage(new StringPreference(planetsDirectory));

            starMapsDirectory = new ObservableString("starMapsDirectory", ".");
            preferences.manage(new StringPreference(starMapsDirectory));

            unitsDirectory = new ObservableString("unitsDirectory", ".");
            preferences.manage(new StringPreference(unitsDirectory));

            campaignsDirectory = new ObservableString("campaignsDirectory", "./campaigns");
            preferences.manage(new StringPreference(campaignsDirectory));

            scenarioTemplatesDirectory = new ObservableString("scenarioTemplatesDirectory", ".");
            preferences.manage(new StringPreference(scenarioTemplatesDirectory));

            financesDirectory = new ObservableString("financesDirectory", ".");
            preferences.manage(new StringPreference(financesDirectory));
        } catch (Exception ex) {
            LogManager.getLogger().error("Failed to set user preferences", ex);
        }
    }

    public void exit() {
        int savePrompt = JOptionPane.showConfirmDialog(null, "Do you want to save the game before quitting MekHQ?",
                "Save First?", JOptionPane.YES_NO_CANCEL_OPTION, JOptionPane.QUESTION_MESSAGE);
        if ((savePrompt == JOptionPane.CANCEL_OPTION) || (savePrompt == JOptionPane.CLOSED_OPTION)) {
            return;
        } else if ((savePrompt == JOptionPane.YES_OPTION) && !getCampaigngui().saveCampaign(null)) {
            // When the user did not actually save the game, don't close MHQ
            return;
        }

        // Actually close MHQ
        if (campaignGUI != null) {
            campaignGUI.getFrame().dispose();
        }

        MegaMek.getMMPreferences().saveToFile(MHQConstants.MM_PREFERENCES_FILE);
        MegaMekLab.getMMLPreferences().saveToFile(MHQConstants.MML_PREFERENCES_FILE);
        getMHQPreferences().saveToFile(MHQConstants.MHQ_PREFERENCES_FILE);

        System.exit(0);
    }

    public void showNewView() {
        campaignGUI = new CampaignGUI(this);
    }

    public void showNewStoryArcEditor(StoryArc arc) {
        storyArcEditorGUI = new StoryArcEditorGUI(this, arc);
    }

    /**
     * Main method launching the application.
     */
    public static void main(String... args) {
        // First, create a global default exception handler
        Thread.setDefaultUncaughtExceptionHandler((thread, t) -> {
            LogManager.getLogger().error("Uncaught Exception Detected", t);
            final String name = t.getClass().getName();
            JOptionPane.showMessageDialog(null,
                    String.format("Uncaught %s detected. Please open up an issue containing all logs, campaign save file, and customs at https://github.com/MegaMek/mekhq/issues", name),
                    "Uncaught " + name, JOptionPane.ERROR_MESSAGE);
        });

        // Second, let's handle logging
        MegaMek.initializeLogging(MHQConstants.PROJECT_NAME);
        MegaMekLab.initializeLogging(MHQConstants.PROJECT_NAME);
        MekHQ.initializeLogging(MHQConstants.PROJECT_NAME);

        // Third, let's handle suite graphical setup initialization
        MegaMek.initializeSuiteGraphicalSetups(MHQConstants.PROJECT_NAME);

        // Finally, let's handle startup
        SwingUtilities.invokeLater(() -> MekHQ.getInstance().startup());
    }

    public static void initializeLogging(final String originProject) {
        LogManager.getLogger().info(getUnderlyingInformation(originProject));
    }

    /**
     * @param originProject the project that launched MekHQ
     * @return the underlying information for this launch of MekHQ
     */
    public static String getUnderlyingInformation(final String originProject) {
        return MegaMek.getUnderlyingInformation(originProject, MHQConstants.PROJECT_NAME);
    }

    public Server getMyServer() {
        return myServer;
    }

    public Campaign getCampaign() {
        return campaignController.getLocalCampaign();
    }

    public void setCampaign(Campaign c) {
        campaignController = new CampaignController(c);
    }

    public CampaignController getCampaignController() {
        return campaignController;
    }

    /**
     * @return the campaigngui
     */
    public CampaignGUI getCampaigngui() {
        return campaignGUI;
    }

    /**
     * @param campaigngui the campaigngui to set
     */
    public void setCampaigngui(CampaignGUI campaigngui) {
        this.campaignGUI = campaigngui;
    }

    public void joinGame(Scenario scenario, List<Unit> meks) {
        ConnectDialog joinGameDialog = new ConnectDialog(campaignGUI.getFrame(), campaignGUI.getCampaign().getName());
        joinGameDialog.setVisible(true);

        if (!joinGameDialog.dataValidation("MegaMek.ConnectDialog.title")) {
            return;
        }

        final String playerName = joinGameDialog.getPlayerName();
        final String serverAddress = joinGameDialog.getServerAddress();
        final int port = joinGameDialog.getPort();
        joinGameDialog.dispose();

        try {
            client = new Client(playerName, serverAddress, port);
        } catch (Exception e) {
            LogManager.getLogger().error("Failed to connect to server properly", e);
            return;
        }

        client.getGame().addGameListener(this);
        currentScenario = scenario;

        // Start the game thread
        gameThread = new GameThread(playerName, client, this, meks, scenario, false);
        gameThread.start();
    }

    public void startHost(Scenario scenario, boolean loadSavegame, List<Unit> meks) {
        HostDialog hostDialog = new HostDialog(campaignGUI.getFrame(), getCampaign().getName());
        hostDialog.setVisible(true);

        if (!hostDialog.dataValidation("MegaMek.HostGameAlert.title")) {
            stopHost();
            return;
        }

        this.autosaveService.requestBeforeMissionAutosave(getCampaign());

        final String playerName = hostDialog.getPlayerName();
        final String password = hostDialog.getServerPass();
        final int port = hostDialog.getPort();
        final boolean register = hostDialog.isRegister();
        final String metaserver = register ? hostDialog.getMetaserver() : "";

        // Force cleanup of the current modal, since we are (possibly) about to display
        // a new one and MacOS
        // seems to struggle with that (see https://github.com/MegaMek/mekhq/issues/953)
        hostDialog.dispose();

        try {
            myServer = new Server(password, port, new GameManager(), register, metaserver);
            if (loadSavegame) {
                FileDialog f = new FileDialog(campaignGUI.getFrame(), "Load Savegame");
                f.setDirectory(System.getProperty("user.dir") + "/savegames");
                f.setVisible(true);
                if (null != f.getFile()) {
                    getMyServer().loadGame(new File(f.getDirectory(), f.getFile()));
                } else {
                    stopHost();
                    return; // exceptions as flow control? no thanks.
                }
            }
        } catch (FileNotFoundException ex) {
            // The dialog was cancelled or the file not found
            // Return to the UI
            stopHost();
            return;
        } catch (Exception ex) {
            LogManager.getLogger().error("Failed to start up server", ex);
            stopHost();
            return;
        }

        client = new Client(playerName, "127.0.0.1", port);

        client.getGame().addGameListener(this);
        currentScenario = scenario;

        // Start the game thread
        if (getCampaign().getCampaignOptions().isUseAtB() && (scenario instanceof AtBScenario)) {
            gameThread = new AtBGameThread(playerName, password, client, this, meks, (AtBScenario) scenario);
        } else {
            gameThread = new GameThread(playerName, password, client, this, meks, scenario);
        }
        gameThread.start();
    }

    // Stop & send the close game event to the Server
    public synchronized void stopHost() {
        if (getMyServer() != null) {
            getMyServer().die();
            myServer = null;
        }
        currentScenario = null;
    }

    @Override
    public void gameBoardChanged(GameBoardChangeEvent e) {

    }

    @Override
    public void gameBoardNew(GameBoardNewEvent e) {

    }

    @Override
    public void gameEnd(GameEndEvent e) {

    }

    @Override
    public void gameEntityChange(GameEntityChangeEvent e) {

    }

    @Override
    public void gameEntityNew(GameEntityNewEvent e) {

    }

    @Override
    public void gameEntityNewOffboard(GameEntityNewOffboardEvent e) {

    }

    @Override
    public void gameEntityRemove(GameEntityRemoveEvent e) {

    }

    @Override
    public void gameMapQuery(GameMapQueryEvent e) {

    }

    @Override
    public void gameNewAction(GameNewActionEvent e) {

    }

    @Override
    public void gamePhaseChange(GamePhaseChangeEvent e) {

    }

    @Override
    public void gameVictory(GameVictoryEvent gve) {
        // Prevent double run
        if (gameThread.stopRequested()) {
            return;
        }

        try {
            boolean control = JOptionPane.showConfirmDialog(campaignGUI.getFrame(),
                    "Did your side control the battlefield at the end of the scenario?", "Control of Battlefield?",
                    JOptionPane.YES_NO_OPTION, JOptionPane.QUESTION_MESSAGE) == JOptionPane.YES_OPTION;
            ResolveScenarioTracker tracker = new ResolveScenarioTracker(currentScenario, getCampaign(), control);
            tracker.setClient(gameThread.getClient());
            tracker.setEvent(gve);
            tracker.processGame();
            ResolveScenarioWizardDialog resolveDialog = new ResolveScenarioWizardDialog(campaignGUI.getFrame(), true,
                    tracker);
            resolveDialog.setVisible(true);
            if (campaignGUI.getCampaign().getCampaignOptions().isUseAtB()
                    && (campaignGUI.getCampaign().getMission(currentScenario.getMissionId()) instanceof AtBContract)
                    && !campaignGUI.getCampaign().getRetirementDefectionTracker().getRetirees().isEmpty()) {
                RetirementDefectionDialog rdd = new RetirementDefectionDialog(campaignGUI,
                        (AtBContract) campaignGUI.getCampaign().getMission(currentScenario.getMissionId()), false);
                rdd.setVisible(true);
                if (!rdd.wasAborted()) {
                    getCampaign().applyRetirement(rdd.totalPayout(), rdd.getUnitAssignments());
                }
            }
            // we need to trigger ScenarioResolvedEvent before stopping the thread or currentScenario may become null
            MekHQ.triggerEvent(new ScenarioResolvedEvent(currentScenario));
            gameThread.requestStop();
            // MegaMek dumps these in the deployment phase to free memory
            if (getCampaign().getCampaignOptions().isUseAtB()) {
                RandomUnitGenerator.getInstance();
                RandomNameGenerator.getInstance();
            }
            // MegaMek creates some temporary files that MHQ needs to remove between runs
            final File tempImageDirectory = new File("data/images/temp");
            if (tempImageDirectory.isDirectory()) {
                // This can't be null because of the above
                Stream.of(tempImageDirectory.listFiles()).filter(file -> file.getName().endsWith(".png")).forEach(File::delete);
            }
        } catch (Exception ex) {
            LogManager.getLogger().error("", ex);
        }
    }

    @Override
    public void gamePlayerChange(GamePlayerChangeEvent e) {

    }

    @Override
    public void gamePlayerChat(GamePlayerChatEvent e) {

    }

    @Override
    public void gamePlayerConnected(GamePlayerConnectedEvent e) {

    }

    @Override
    public void gamePlayerDisconnected(GamePlayerDisconnectedEvent e) {

    }

    @Override
    public void gameReport(GameReportEvent e) {

    }

    @Override
    public void gameSettingsChange(GameSettingsChangeEvent e) {

    }

    @Override
    public void gameTurnChange(GameTurnChangeEvent e) {

    }

    @Override
    public void gameClientFeedbackRequest(GameCFREvent e) {
    }

    public IconPackage getIconPackage() {
        return iconPackage;
    }

    /*
     * Access methods for event bus.
     */
    static public void registerHandler(Object handler) {
        EVENT_BUS.register(handler);
    }

    static public boolean triggerEvent(MMEvent event) {
        return EVENT_BUS.trigger(event);
    }

    static public void unregisterHandler(Object handler) {
        EVENT_BUS.unregister(handler);
    }

    /**
     * TODO : This needs to be way more flexible, but it will do for now.
     */
    private void initEventHandlers() {
        EVENT_BUS.register(new XPHandler());

        StratconRulesManager srm = new StratconRulesManager();
        srm.startup();
        EVENT_BUS.register(srm);
    }

    private static void setLookAndFeel(String themeName) {
        Runnable runnable = () -> {
            try {
                UIManager.setLookAndFeel(themeName);
                if (System.getProperty("os.name", "").startsWith("Mac OS X")) {
                    // Ensure OSX key bindings are used for copy, paste etc
                    addOSXKeyStrokes((InputMap) UIManager.get("EditorPane.focusInputMap"));
                    addOSXKeyStrokes((InputMap) UIManager.get("FormattedTextField.focusInputMap"));
                    addOSXKeyStrokes((InputMap) UIManager.get("TextField.focusInputMap"));
                    addOSXKeyStrokes((InputMap) UIManager.get("TextPane.focusInputMap"));
                    addOSXKeyStrokes((InputMap) UIManager.get("TextArea.focusInputMap"));
                }

                for (final Frame frame : Frame.getFrames()) {
                    SwingUtilities.updateComponentTreeUI(frame);
                }

                for (Window window : Window.getWindows()) {
                    SwingUtilities.updateComponentTreeUI(window);
                }
            } catch (ClassNotFoundException | InstantiationException | IllegalAccessException
                    | UnsupportedLookAndFeelException e) {
                LogManager.getLogger().error("", e);
            }
        };
        SwingUtilities.invokeLater(runnable);
    }

    private static class MekHqPropertyChangedListener implements PropertyChangeListener {
        @Override
        public void propertyChange(PropertyChangeEvent evt) {
            if (evt.getSource().equals(selectedTheme)) {
                setLookAndFeel((String) evt.getNewValue());
            }
        }
    }

    private static void addOSXKeyStrokes(InputMap inputMap) {
        inputMap.put(KeyStroke.getKeyStroke(KeyEvent.VK_C, KeyEvent.META_DOWN_MASK), DefaultEditorKit.copyAction);
        inputMap.put(KeyStroke.getKeyStroke(KeyEvent.VK_X, KeyEvent.META_DOWN_MASK), DefaultEditorKit.cutAction);
        inputMap.put(KeyStroke.getKeyStroke(KeyEvent.VK_V, KeyEvent.META_DOWN_MASK), DefaultEditorKit.pasteAction);
        inputMap.put(KeyStroke.getKeyStroke(KeyEvent.VK_A, KeyEvent.META_DOWN_MASK), DefaultEditorKit.selectAllAction);
    }
}