feat: added update manager [macata#17] (#27)

DazedNConfused- · web-flow · commit 97a2e5d374ea · 2024-07-04T14:08:43.000-03:00
diff --git a/README.md b/README.md
@@ -41,6 +41,7 @@ Just put the `macatalauncher.jar` in some folder of your choice and double click
   - No more having to move folders between `Cataclysm.app`s on each Experimental upgrade!
   - This shared data directory is located at `/<macata_launcher_folder>/userdir`
 - [x] Soundpack management
+- [x] Launcher autoupdater
 
 ### Planned
 
@@ -54,6 +55,10 @@ Just put the `macatalauncher.jar` in some folder of your choice and double click
   - I want to focus mainly on macOS since there are already some excellent launchers for Windows and Linux already.
     - Having said that, given the current launcher architecture, I would like to think it wouldn't be terribly hard to support Linux and/or Windows. Just a couple of changes to the [launcher class](src/main/java/com/dazednconfused/catalauncher/launcher/CDDALauncherManager.java) maybe? PRs welcome!
 
+## Build
+
+Just run `mvn package` and a `macatalauncher-x.x.x.jar` binary will be built in the `target` directory.
+
 ## FAQ
 
 ### Why Yet Another Launcher?
diff --git a/pom.xml b/pom.xml
@@ -6,7 +6,7 @@
 
     <groupId>com.dazednconfused</groupId>
     <artifactId>macatalauncher</artifactId>
-    <version>0.1</version>
+    <version>0.2.0</version>
 
     <properties>
         <maven.compiler.source>11</maven.compiler.source>
@@ -79,7 +79,7 @@
                             <archive>
                                 <manifest>
                                     <addClasspath>true</addClasspath>
-                                    <mainClass>com.dazednconfused.catalauncher.gui.MainWindow</mainClass>
+                                    <mainClass>com.dazednconfused.catalauncher.Application</mainClass>
                                 </manifest>
                             </archive>
                         </configuration>
@@ -90,7 +90,7 @@
                         <configuration>
                             <archive>
                                 <manifest>
-                                    <mainClass>com.dazednconfused.catalauncher.gui.MainWindow</mainClass>
+                                    <mainClass>com.dazednconfused.catalauncher.Application</mainClass>
                                 </manifest>
                             </archive>
                             <descriptorRefs>
diff --git a/src/main/java/com/dazednconfused/catalauncher/configuration/Configuration.java b/src/main/java/com/dazednconfused/catalauncher/configuration/Configuration.java
@@ -9,6 +9,7 @@ public class Configuration {
     private String cddaPath;
     private boolean backupOnExit;
     private boolean debug;
+    private boolean shouldLookForUpdates;
 
     public Configuration() {
     }
@@ -37,6 +38,14 @@ public void setDebug(boolean debug) {
         this.debug = debug;
     }
 
+    public boolean isShouldLookForUpdates() {
+        return shouldLookForUpdates;
+    }
+
+    public void setShouldLookForUpdates(boolean shouldLookForUpdates) {
+        this.shouldLookForUpdates = shouldLookForUpdates;
+    }
+
     @Override
     public String toString() {
         return Try.of(() -> new ObjectMapper().writeValueAsString(this)).getOrElse(super::toString);
diff --git a/src/main/java/com/dazednconfused/catalauncher/configuration/ConfigurationManager.java b/src/main/java/com/dazednconfused/catalauncher/configuration/ConfigurationManager.java
@@ -86,6 +86,15 @@ public void setDebug(boolean debug) {
         save(this.configuration);
     }
 
+    public boolean isShouldLookForUpdates() {
+        return this.configuration.isShouldLookForUpdates();
+    }
+
+    public void setShouldLookForUpdates(boolean shouldLookForUpdates) {
+        this.configuration.setShouldLookForUpdates(shouldLookForUpdates);
+        save(this.configuration);
+    }
+
     /**
      * Saves the given {@link Configuration} to disk.
      * */
diff --git a/src/main/java/com/dazednconfused/catalauncher/gui/ConfirmDialog.java b/src/main/java/com/dazednconfused/catalauncher/gui/ConfirmDialog.java
@@ -21,6 +21,8 @@
 
 public class ConfirmDialog extends JDialog {
 
+    public static final Consumer<Boolean> DO_NOTHING_ACTION = bool -> { }; // does nothing - represents an empty action
+
     private static final String ERROR_ICON = extractIconFrom(ICONS_PATH + "/" + "errorDialog.svg");
     private static final String INFO_ICON = extractIconFrom(ICONS_PATH + "/" + "informationDialog.svg");
     private static final String WARN_ICON = extractIconFrom(ICONS_PATH + "/" + "warningDialog.svg");
@@ -32,13 +34,30 @@ public class ConfirmDialog extends JDialog {
     private JSVGCanvas iconSvg;
 
     /**
-     * Constructor.
+     * Shows a confirmation dialog, which is basically a {@link JDialog} composed of a {@link String} {@code message}, a {@link ConfirmDialogType}
+     * which gives visual feedback of the severity of the message by means of different icons, and a {@link Consumer} action
+     * to be triggered upon confirmation or cancellation of the dialog.
+     *
+     * @param message The message to show in the dialog.
+     * @param dialogType The type of dialog, representing its severity. Applicable types are {@link ConfirmDialogType#INFO},
+     *                   {@link ConfirmDialogType#WARNING} and {@link ConfirmDialogType#ERROR}. {@link ConfirmDialogType#NONE}
+     *                   is equivalent to using {@link ConfirmDialogType#INFO}.
+     * @param doOnResult The action to be executed upon <i>confirmation</i> (user clicks the {@code OK} button) or <i>cancellation</i>
+     *                   (user clicks the {@code Cancel} button and/or exits the {@link JDialog} by simply closing it).
+     *                   <ul>
+     *                      <li>A <i>confirmation</i> will pass a {@code true} to the provided consumer.</li>
+     *                      <li>A <i>cancellation</i> will pass a {@code false} to the provided consumer.</li>
+     *                   </ul>
+     *                   If <i>confirmation</i> or <i>cancellation</i> is irrelevant for the desired {@link ConfirmDialog}
+     *                   (ie: we just want to show a non-actionable message to the user), then a {@link #DO_NOTHING_ACTION}
+     *                   may be passed to this parameter. This will make the resulting {@link JDialog} to only have an {@code OK}
+     *                   button that will just close the dialog and nothing else.
      * */
     public ConfirmDialog(String message, ConfirmDialogType dialogType, Consumer<Boolean> doOnResult) {
 
         // initialize dialog ---
         setContentPane(contentPane);
-        setModal(true);
+        setModalityType(ModalityType.APPLICATION_MODAL);
 
         // set default button ---
         getRootPane().setDefaultButton(buttonCancel);
@@ -76,6 +95,16 @@ public void windowClosing(WindowEvent e) {
 
         // call onCancel() on ESCAPE ---
         contentPane.registerKeyboardAction(e -> onCancel(doOnResult), KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0), JComponent.WHEN_ANCESTOR_OF_FOCUSED_COMPONENT);
+
+        // if defined action is DO_NOTHING_ACTION, then the OK/Cancel buttons do virtually the same thing: nothing
+        // hide the OK button from view, there is no need for redundancy
+        // also, make the Cancel feel like an 'OK' button from a user's perspective
+        if (doOnResult == DO_NOTHING_ACTION) {
+            buttonOK.setVisible(false);
+            buttonCancel.setText("OK");
+        }
+
+        this.spawnOnTopOfParentComponent(); // without this, dialog gets created _behind_ parent and doesn't come on top until Swing redraws, for some reason
     }
 
     /**
@@ -88,11 +117,31 @@ public void packCenterAndShow(JPanel parent) {
         this.setVisible(true);
     }
 
+    /**
+     * Forces this {@link JDialog} to always spawn on top of its parent.
+     * */
+    private void spawnOnTopOfParentComponent() {
+        final JDialog thisDialog = this;
+        this.addWindowListener(new java.awt.event.WindowAdapter() {
+            @Override
+            public void windowOpened(java.awt.event.WindowEvent evt) {
+                thisDialog.toFront();
+                thisDialog.requestFocus();
+            }
+        });
+    }
+
+    /**
+     * Represents the action to be taken when the {@code OK} button is clicked.
+     * */
     private void onOK(Consumer<Boolean> doOnResult) {
         doOnResult.accept(true);
         dispose();
     }
 
+    /**
+     * Represents the action to be taken when the {@code Cancel} button is clicked.
+     * */
     private void onCancel(Consumer<Boolean> doOnResult) {
         doOnResult.accept(false);
         dispose();
diff --git a/src/main/java/com/dazednconfused/catalauncher/gui/MainWindow.java b/src/main/java/com/dazednconfused/catalauncher/gui/MainWindow.java
@@ -139,6 +139,8 @@ public MainWindow() {
         };
 
         this.refreshGuiElements();
+
+        new Thread(this::checkForUpdates).start(); // check for updates on a background thread, to not slow down application's startup
     }
 
     /**
@@ -639,8 +641,8 @@ private static JMenuBar buildMenuBarFor(Component parent) {
         about.addActionListener(e -> {
             LOGGER.trace("About button clicked");
 
-            AboutDialog aboutDialog = new AboutDialog();
-            aboutDialog.packCenterAndShow(parent);
+            VersionManagerWindow versionManagerWindow = new VersionManagerWindow();
+            versionManagerWindow.packCenterAndShow(parent);
         });
         helpMenu.add(about);
 
@@ -730,4 +732,13 @@ public boolean isCellEditable(int row, int column) {
         };
         this.soundpacksTable.setModel(tableModel);
     }
+
+    /**
+     * Checks for new software releases if the {@link ConfigurationManager} dictates said process should be carried out.
+     * */
+    private void checkForUpdates() {
+        if (ConfigurationManager.getInstance().isShouldLookForUpdates()) {
+            VersionManagerWindow.checkForUpdates(this.mainPanel, false);
+        }
+    }
 }
diff --git a/src/main/java/com/dazednconfused/catalauncher/gui/VersionManagerWindow.form b/src/main/java/com/dazednconfused/catalauncher/gui/VersionManagerWindow.form
@@ -1,9 +1,9 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<form xmlns="http://www.intellij.com/uidesigner/form/" version="1" bind-to-class="com.dazednconfused.catalauncher.gui.AboutDialog">
-  <grid id="cbd77" binding="contentPane" layout-manager="GridLayoutManager" row-count="6" column-count="1" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
+<form xmlns="http://www.intellij.com/uidesigner/form/" version="1" bind-to-class="com.dazednconfused.catalauncher.gui.VersionManagerWindow">
+  <grid id="cbd77" binding="contentPane" layout-manager="GridLayoutManager" row-count="7" column-count="1" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
     <margin top="10" left="10" bottom="10" right="10"/>
     <constraints>
-      <xy x="48" y="54" width="436" height="393"/>
+      <xy x="48" y="54" width="465" height="393"/>
     </constraints>
     <properties/>
     <border type="none"/>
@@ -173,6 +173,38 @@
           <grid row="1" column="0" row-span="1" col-span="1" vsize-policy="6" hsize-policy="1" anchor="0" fill="2" indent="0" use-parent-layout="false"/>
         </constraints>
       </vspacer>
+      <grid id="afc62" layout-manager="GridLayoutManager" row-count="1" column-count="3" same-size-horizontally="false" same-size-vertically="false" hgap="-1" vgap="-1">
+        <margin top="0" left="0" bottom="0" right="0"/>
+        <constraints>
+          <grid row="6" column="0" row-span="1" col-span="1" vsize-policy="3" hsize-policy="3" anchor="0" fill="3" indent="0" use-parent-layout="false"/>
+        </constraints>
+        <properties/>
+        <border type="none"/>
+        <children>
+          <component id="4383c" class="javax.swing.JCheckBox" binding="autoUpdaterCheckbox">
+            <constraints>
+              <grid row="0" column="0" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="8" fill="0" indent="0" use-parent-layout="false"/>
+            </constraints>
+            <properties>
+              <selected value="false"/>
+              <text value="Automatically check for updates at startup"/>
+            </properties>
+          </component>
+          <hspacer id="e225b">
+            <constraints>
+              <grid row="0" column="1" row-span="1" col-span="1" vsize-policy="1" hsize-policy="6" anchor="0" fill="1" indent="0" use-parent-layout="false"/>
+            </constraints>
+          </hspacer>
+          <component id="6930e" class="javax.swing.JButton" binding="updateNowButton">
+            <constraints>
+              <grid row="0" column="2" row-span="1" col-span="1" vsize-policy="0" hsize-policy="3" anchor="0" fill="1" indent="0" use-parent-layout="false"/>
+            </constraints>
+            <properties>
+              <text value="Check Updates"/>
+            </properties>
+          </component>
+        </children>
+      </grid>
     </children>
   </grid>
 </form>
diff --git a/src/main/java/com/dazednconfused/catalauncher/gui/VersionManagerWindow.java b/src/main/java/com/dazednconfused/catalauncher/gui/VersionManagerWindow.java
@@ -2,7 +2,9 @@
 
 import static com.dazednconfused.catalauncher.helper.Constants.APP_NAME;
 
+import com.dazednconfused.catalauncher.configuration.ConfigurationManager;
 import com.dazednconfused.catalauncher.helper.GitInfoManager;
+import com.dazednconfused.catalauncher.update.UpdateManager;
 
 import io.vavr.control.Try;
 
@@ -15,6 +17,8 @@
 
 import javax.imageio.ImageIO;
 import javax.swing.ImageIcon;
+import javax.swing.JButton;
+import javax.swing.JCheckBox;
 import javax.swing.JComponent;
 import javax.swing.JDialog;
 import javax.swing.JLabel;
@@ -24,9 +28,9 @@
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
-public class AboutDialog extends JDialog {
+public class VersionManagerWindow extends JDialog {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(AboutDialog.class);
+    private static final Logger LOGGER = LoggerFactory.getLogger(VersionManagerWindow.class);
 
     private static final String LOGO_PATH = "logo/logo.png";
 
@@ -36,11 +40,13 @@ public class AboutDialog extends JDialog {
     private JLabel buildCommitLabel;
     private JLabel buildTimeLabel;
     private JLabel logoLabel;
+    private JCheckBox autoUpdaterCheckbox;
+    private JButton updateNowButton;
 
     /**
      * Constructor.
      * */
-    public AboutDialog() {
+    public VersionManagerWindow() {
 
         // initialize dialog ---
         setContentPane(contentPane);
@@ -58,6 +64,19 @@ public AboutDialog() {
         buildCommitLabel.setText("Build " + GitInfoManager.getInstance().getCommitIdFull());
         buildTimeLabel.setText(GitInfoManager.getInstance().getBuildTime());
 
+        // configure update now button ---
+        updateNowButton.addActionListener(e -> {
+            LOGGER.trace("Update now button clicked");
+            checkForUpdates(contentPane, true);
+        });
+
+        // configure auto-update checkbox ---
+        this.autoUpdaterCheckbox.setSelected(ConfigurationManager.getInstance().isShouldLookForUpdates());
+        autoUpdaterCheckbox.addActionListener(e -> {
+            LOGGER.trace("Auto updater checkbox changed to [{}]", autoUpdaterCheckbox.isSelected());
+            ConfigurationManager.getInstance().setShouldLookForUpdates(autoUpdaterCheckbox.isSelected());
+        });
+
         // call onOK() when cross is clicked ---
         setDefaultCloseOperation(DO_NOTHING_ON_CLOSE);
         addWindowListener(new WindowAdapter() {
@@ -70,6 +89,46 @@ public void windowClosing(WindowEvent e) {
         contentPane.registerKeyboardAction(e -> dispose(), KeyStroke.getKeyStroke(KeyEvent.VK_ESCAPE, 0), JComponent.WHEN_FOCUSED);
     }
 
+    /**
+     * Checks for new binary releases and prompts the user in case an update is available.
+     * */
+    public static void checkForUpdates(JPanel parent, boolean showDialogIfNoUpdateAvailable) {
+        LOGGER.info("Checking for updates...");
+
+        boolean updateAvailable = UpdateManager.isUpdateAvailable().orElse(false);
+
+        if (!updateAvailable) {
+            LOGGER.debug("No update is available");
+
+            if (!showDialogIfNoUpdateAvailable) {
+                LOGGER.trace("Skipping showing 'no update available' dialog because showDialogIfNoUpdateAvailable is false'");
+                return;
+            }
+
+            ConfirmDialog confirmDialog = new ConfirmDialog(
+                "There were no updates found",
+                ConfirmDialog.ConfirmDialogType.NONE,
+                ConfirmDialog.DO_NOTHING_ACTION
+            );
+
+            confirmDialog.packCenterAndShow(parent);
+        } else {
+            LOGGER.debug("Update is available");
+            ConfirmDialog confirmDialog = new ConfirmDialog(
+                "A new version is available! Check the releases page now?",
+                ConfirmDialog.ConfirmDialogType.INFO,
+                confirmed -> {
+                    if (confirmed) {
+                        UpdateManager.openLatestReleaseInDefaultBrowser();
+                    } else {
+                        LOGGER.debug("Aborting update process due to user input");
+                    }
+                }
+            );
+            confirmDialog.packCenterAndShow(parent);
+        }
+    }
+
     /**
      * Packs ({@link #pack()}), centers ({@link #setLocationRelativeTo(Component)}) and sets the current dialog as visible
      * ({@link #setVisible(boolean)}).
diff --git a/src/main/java/com/dazednconfused/catalauncher/helper/Constants.java b/src/main/java/com/dazednconfused/catalauncher/helper/Constants.java
@@ -12,6 +12,9 @@ public class Constants {
     public static final String CUSTOM_MODS_DIR = CUSTOM_USER_DIR + "mods/";
     public static final String CUSTOM_TRASHED_SAVE_PATH = LAUNCHER_ROOT_FOLDER + "/trashed/saves/";
     public static final String SAVE_BACKUP_PATH = LAUNCHER_ROOT_FOLDER + "/backups";
+    public static final String GITHUB_REPOSITORY_OWNER = "DazedNConfused-";
+    public static final String GITHUB_REPOSITORY_NAME = "macata-launcher";
+
 
     // resources
     public static final String ICONS_PATH = "icon/svg";
diff --git a/src/main/java/com/dazednconfused/catalauncher/update/UpdateManager.java b/src/main/java/com/dazednconfused/catalauncher/update/UpdateManager.java
diff --git a/src/main/java/com/dazednconfused/catalauncher/update/Version.java b/src/main/java/com/dazednconfused/catalauncher/update/Version.java
diff --git a/src/test/java/update/VersionTest.java b/src/test/java/update/VersionTest.java
