chore: make update-checker more configurable and link other download pages (#3091)

PierreSchwang · web-flow · commit 2b314280455b · 2025-02-05T10:16:18.000+01:00
diff --git a/worldedit-bukkit/src/main/java/com/sk89q/worldedit/bukkit/WorldEditListener.java b/worldedit-bukkit/src/main/java/com/sk89q/worldedit/bukkit/WorldEditListener.java
@@ -21,6 +21,7 @@
 
 package com.sk89q.worldedit.bukkit;
 
+import com.fastasyncworldedit.core.configuration.Settings;
 import com.fastasyncworldedit.core.util.UpdateNotification;
 import com.sk89q.worldedit.LocalSession;
 import com.sk89q.worldedit.WorldEdit;
@@ -102,7 +103,9 @@ public void onJoin(PlayerJoinEvent event) {
         if ((session = WorldEdit.getInstance().getSessionManager().getIfPresent(player)) != null) {
             session.loadDefaults(player, true);
         }
-        UpdateNotification.doUpdateNotification(player);
+        if (Settings.settings().ENABLED_COMPONENTS.NOTIFY_UPDATE_INGAME) {
+            UpdateNotification.doUpdateNotification(player);
+        }
     }
     //FAWE end
 
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/configuration/Settings.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/configuration/Settings.java
@@ -289,8 +289,18 @@ public static final class ENABLED_COMPONENTS {
         @Comment({"Show additional information in console. It helps us at IntellectualSites to find out more about an issue.",
                 "Leave it off if you don't need it, it can spam your console."})
         public boolean DEBUG = false;
-        @Comment({"Whether or not FAWE should notify you on startup about new versions available."})
-        public boolean UPDATE_NOTIFICATIONS = true;
+
+        @Migrate("enabled-components.update-notification")
+        @Comment({"Whether or not FAWE should notify you on startup about new available snapshots."})
+        public boolean SNAPSHOT_UPDATE_NOTIFICATIONS = true;
+
+        @Migrate("enabled-components.update-notification")
+        @Comment({"Whether or not FAWE should notify you on startup about new releases."})
+        public boolean RELEASE_UPDATE_NOTIFICATIONS = true;
+
+        @Migrate("enabled-components.update-notification")
+        @Comment({"Whether or not FAWE should notify you for updates (snapshot / release) on join (with the required permission)"})
+        public boolean NOTIFY_UPDATE_INGAME = true;
 
     }
 
diff --git a/worldedit-core/src/main/java/com/fastasyncworldedit/core/util/UpdateNotification.java b/worldedit-core/src/main/java/com/fastasyncworldedit/core/util/UpdateNotification.java
@@ -4,82 +4,144 @@
 import com.fastasyncworldedit.core.FaweVersion;
 import com.fastasyncworldedit.core.configuration.Caption;
 import com.fastasyncworldedit.core.configuration.Settings;
+import com.sk89q.util.StringUtil;
 import com.sk89q.worldedit.extension.platform.Actor;
 import com.sk89q.worldedit.internal.util.LogManagerCompat;
 import com.sk89q.worldedit.util.formatting.text.TextComponent;
 import com.sk89q.worldedit.util.formatting.text.event.ClickEvent;
+import com.sk89q.worldedit.util.formatting.text.format.TextColor;
 import org.apache.logging.log4j.Logger;
-import org.w3c.dom.Document;
+import org.jetbrains.annotations.VisibleForTesting;
 
-import javax.xml.XMLConstants;
-import javax.xml.parsers.DocumentBuilder;
-import javax.xml.parsers.DocumentBuilderFactory;
-import java.io.InputStream;
 import java.net.URI;
 import java.net.http.HttpClient;
 import java.net.http.HttpRequest;
 import java.net.http.HttpResponse;
-import java.time.Duration;
-import java.time.temporal.ChronoUnit;
+import java.util.Arrays;
+import java.util.List;
+import java.util.concurrent.CompletableFuture;
+import java.util.concurrent.TimeUnit;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
 
 public class UpdateNotification {
 
+    private static final String GITHUB_LAST_RELEASE = "https://api.github.com/repos/IntellectualSites/FastAsyncWorldEdit/releases/latest";
+    private static final String JENKINS_LAST_BUILD = "https://ci.athion.net/job/FastAsyncWorldEdit/lastSuccessfulBuild/api/json";
+
+    private static final String LINK_DOWNLOAD_SPIGOTMC = "https://www.spigotmc.org/resources/13932";
+    private static final String LINK_DOWNLOAD_JENKINS = "https://ci.athion.net/job/FastAsyncWorldEdit";
+    private static final String LINK_DOWNLOAD_MODRINTH = "https://modrinth.com/plugin/fastasyncworldedit";
+    private static final String LINK_DOWNLOAD_HANGAR = "https://hangar.papermc.io/IntellectualSites/FastAsyncWorldEdit";
+
+    private static final String CONSOLE_NOTIFICATION_OUTDATED_RELEASE = """
+            A new release for FastAsyncWorldEdit is available: {}. You are currently on {}.
+            Download from {}, {} or {}""";
+    private static final String CONSOLE_NOTIFICATION_OUTDATED_BUILD = """
+                                An update for FastAsyncWorldEdit is available. You are {} build(s) out of date.
+                                You are running build {}, the latest version is build {}.
+                                Update at {}""";
+
     private static final Logger LOGGER = LogManagerCompat.getLogger();
+    private static final HttpClient HTTP_CLIENT = HttpClient.newHttpClient();
+    private static final Pattern GITHUB_RESPONSE_TAG_NAME_PATTERN = Pattern.compile("\"tag_name\":\"([\\d.]+)\"");
+    private static final Pattern JENKINS_RESPONSE_BUILD_PATTERN = Pattern.compile("\"number\":(\\d+)");
 
-    private static boolean hasUpdate;
-    private static String faweVersion = "";
+    private static volatile int[] lastRelease;
+    private static volatile int lastBuild = -1;
 
     /**
      * Check whether a new build with a higher build number than the current build is available.
      */
     public static void doUpdateCheck() {
-        if (Settings.settings().ENABLED_COMPONENTS.UPDATE_NOTIFICATIONS) {
-            final HttpRequest request = HttpRequest
-                    .newBuilder()
-                    .uri(URI.create("https://ci.athion.net/job/FastAsyncWorldEdit/api/xml/"))
-                    .timeout(Duration.of(10L, ChronoUnit.SECONDS))
-                    .build();
-            HttpClient.newHttpClient()
-                    .sendAsync(request, HttpResponse.BodyHandlers.ofInputStream())
-                    .whenComplete((response, thrown) -> {
-                        if (thrown != null) {
-                            LOGGER.error("Update check failed: {} ", thrown.getMessage());
-                        }
-                        processResponseBody(response.body());
-                    });
-
+        if (hasUpdateInfo()) {
+            return;
+        }
+        final FaweVersion installedVersion = Fawe.instance().getVersion();
+        if (installedVersion == null || (installedVersion.build == 0 && installedVersion.snapshot)) {
+            LOGGER.warn("You are using a snapshot or a custom version of FAWE. " +
+                    "This is not an official build distributed via https://www.spigotmc.org/resources/13932/");
+            return;
+        }
+        if (Settings.settings().ENABLED_COMPONENTS.SNAPSHOT_UPDATE_NOTIFICATIONS) {
+            checkLatestBuild().orTimeout(10, TimeUnit.SECONDS).whenComplete((build, throwable) -> {
+                if (throwable != null) {
+                    LOGGER.error("Failed to check for latest build", throwable);
+                    return;
+                }
+                lastBuild = build;
+                int difference = lastBuild - installedVersion.build;
+                if (difference < 1) {
+                    return;
+                }
+                LOGGER.warn(CONSOLE_NOTIFICATION_OUTDATED_BUILD, difference, installedVersion.build, lastBuild, LINK_DOWNLOAD_JENKINS);
+            });
+        }
+        if (Settings.settings().ENABLED_COMPONENTS.RELEASE_UPDATE_NOTIFICATIONS) {
+            checkLatestRelease().orTimeout(10, TimeUnit.SECONDS).whenComplete((version, throwable) -> {
+                if (throwable != null) {
+                    LOGGER.error("Failed to check for latest release", throwable);
+                    return;
+                }
+                lastRelease = version;
+                if (installedVersion.semver != null && hasUpdateSemver(installedVersion.semver, version)) {
+                    LOGGER.warn(CONSOLE_NOTIFICATION_OUTDATED_RELEASE,
+                            StringUtil.joinString(lastRelease, ".", 0),
+                            StringUtil.joinString(installedVersion.semver, ".", 0),
+                            LINK_DOWNLOAD_MODRINTH, LINK_DOWNLOAD_HANGAR, LINK_DOWNLOAD_SPIGOTMC
+                    );
+                }
+            });
         }
     }
 
-    private static void processResponseBody(InputStream body) {
-        try {
-            DocumentBuilderFactory dbf = DocumentBuilderFactory.newInstance();
-            dbf.setFeature(XMLConstants.FEATURE_SECURE_PROCESSING, true);
-            DocumentBuilder db = dbf.newDocumentBuilder();
-            Document doc = db.parse(body);
-            faweVersion = doc.getElementsByTagName("lastSuccessfulBuild").item(0).getFirstChild().getTextContent();
-            FaweVersion faweVersion = Fawe.instance().getVersion();
-            if (faweVersion.build == 0 && faweVersion.snapshot) {
-                LOGGER.warn("You are using a snapshot or a custom version of FAWE. This is not an official build distributed " +
-                        "via https://www.spigotmc.org/resources/13932/");
-                return;
+    private static CompletableFuture<int[]> checkLatestRelease() {
+        return HTTP_CLIENT.sendAsync(
+                HttpRequest.newBuilder().GET().uri(URI.create(GITHUB_LAST_RELEASE)).build(),
+                HttpResponse.BodyHandlers.ofString()
+        ).thenApply(response -> {
+            if (response.statusCode() != 200) {
+                throw new UpdateCheckException("GitHub returned status code " + response.statusCode());
             }
-            if (faweVersion.snapshot && faweVersion.build < Integer.parseInt(UpdateNotification.faweVersion)) {
-                hasUpdate = true;
-                int versionDifference = Integer.parseInt(UpdateNotification.faweVersion) - faweVersion.build;
-                LOGGER.warn(
-                        """
-                                An update for FastAsyncWorldEdit is available. You are {} build(s) out of date.
-                                You are running build {}, the latest version is build {}.
-                                Update at https://www.spigotmc.org/resources/13932/""",
-                        versionDifference,
-                        faweVersion.build,
-                        UpdateNotification.faweVersion
-                );
+            return response.body();
+        }).thenApply(body -> {
+            final Matcher matcher = GITHUB_RESPONSE_TAG_NAME_PATTERN.matcher(body);
+            if (!matcher.find()) {
+                throw new UpdateCheckException("Couldn't find tag name in response");
             }
-        } catch (Exception ignored) {
-            LOGGER.error("Unable to check for updates. Skipping.");
-        }
+            try {
+                return Arrays.stream(matcher.group(1).split("\\.")).toList().stream().mapToInt(Integer::parseInt).toArray();
+            } catch (NumberFormatException e) {
+                throw new UpdateCheckException("Couldn't parse version", e);
+            }
+        }).thenApply(version -> {
+            if (version.length != 3) {
+                throw new UpdateCheckException("Retrieved malformed version (%s)".formatted(Arrays.toString(version)));
+            }
+            return version;
+        });
+    }
+
+    private static CompletableFuture<Integer> checkLatestBuild() {
+        return HTTP_CLIENT.sendAsync(
+                HttpRequest.newBuilder().GET().uri(URI.create(JENKINS_LAST_BUILD)).build(),
+                HttpResponse.BodyHandlers.ofString()
+        ).thenApply(response -> {
+            if (response.statusCode() != 200) {
+                throw new UpdateCheckException("Jenkins returned status code " + response.statusCode());
+            }
+            return response.body();
+        }).thenApply(body -> {
+            final Matcher matcher = JENKINS_RESPONSE_BUILD_PATTERN.matcher(body);
+            if (!matcher.find()) {
+                throw new UpdateCheckException("Couldn't find latest build in response");
+            }
+            try {
+                return Integer.parseInt(matcher.group(1));
+            } catch (NumberFormatException e) {
+                throw new UpdateCheckException("Couldn't parse build", e);
+            }
+        });
     }
 
     /**
@@ -88,21 +150,86 @@ private static void processResponseBody(InputStream body) {
      * @param actor The player to notify.
      */
     public static void doUpdateNotification(Actor actor) {
-        if (Settings.settings().ENABLED_COMPONENTS.UPDATE_NOTIFICATIONS) {
-            if (actor.hasPermission("fawe.admin") && UpdateNotification.hasUpdate) {
-                FaweVersion faweVersion = Fawe.instance().getVersion();
-                int versionDifference = Integer.parseInt(UpdateNotification.faweVersion) - faweVersion.build;
+        if (!isAnyUpdateCheckEnabled() || !actor.hasPermission("fawe.admin") || !hasUpdateInfo()) {
+            return;
+        }
+        final FaweVersion installed = Fawe.instance().getVersion();
+        if (installed == null) {
+            return;
+        }
+        if (lastBuild != -1 && Settings.settings().ENABLED_COMPONENTS.SNAPSHOT_UPDATE_NOTIFICATIONS) {
+            int difference = lastBuild - installed.build;
+            if (difference > 0) {
+                actor.print(Caption.of(
+                        "fawe.info.update-available.build",
+                        difference, installed.build, lastBuild,
+                        TextComponent.of(LINK_DOWNLOAD_JENKINS).clickEvent(ClickEvent.openUrl(LINK_DOWNLOAD_JENKINS))
+                ));
+            }
+        }
+        if (installed.semver != null && lastRelease != null && Settings.settings().ENABLED_COMPONENTS.RELEASE_UPDATE_NOTIFICATIONS) {
+            if (hasUpdateSemver(installed.semver, lastRelease)) {
                 actor.print(Caption.of(
-                        "fawe.info.update-available",
-                        versionDifference,
-                        faweVersion.build,
-                        UpdateNotification.faweVersion,
-                        TextComponent
-                                .of("https://www.spigotmc.org/resources/13932/")
-                                .clickEvent(ClickEvent.openUrl("https://www.spigotmc.org/resources/13932/"))
+                        "fawe.info.update-available.release",
+                        StringUtil.joinString(lastRelease, ".", 0),
+                        StringUtil.joinString(installed.semver, ".", 0),
+                        TextComponent.empty().children(List.of(
+                                TextComponent
+                                        .of("Modrinth")
+                                        .color(TextColor.GREEN)
+                                        .clickEvent(ClickEvent.openUrl(LINK_DOWNLOAD_MODRINTH)),
+                                TextComponent.empty().color(TextColor.GRAY)
+                        )),
+                        TextComponent.empty().children(List.of(
+                                TextComponent
+                                        .of("Hangar")
+                                        .color(TextColor.BLUE)
+                                        .clickEvent(ClickEvent.openUrl(LINK_DOWNLOAD_HANGAR)),
+                                TextComponent.empty().color(TextColor.GRAY)
+                        )),
+                        TextComponent.empty().children(List.of(
+                                TextComponent
+                                        .of("SpigotMC")
+                                        .color(TextColor.GOLD)
+                                        .clickEvent(ClickEvent.openUrl(LINK_DOWNLOAD_SPIGOTMC)),
+                                TextComponent.empty().color(TextColor.GRAY)
+                        ))
                 ));
             }
         }
     }
 
+    @VisibleForTesting
+    static boolean hasUpdateSemver(int[] installed, int[] latest) {
+        for (int i = 0; i < Math.max(installed.length, latest.length); i++) {
+            final int installedPart = i < installed.length ? installed[i] : 0;
+            final int latestPart = i < latest.length ? latest[i] : 0;
+            if (installedPart != latestPart) {
+                return installedPart < latestPart;
+            }
+        }
+        return false;
+    }
+
+    private static boolean hasUpdateInfo() {
+        return lastRelease != null || lastBuild != -1;
+    }
+
+    private static boolean isAnyUpdateCheckEnabled() {
+        return Settings.settings().ENABLED_COMPONENTS.RELEASE_UPDATE_NOTIFICATIONS
+                || Settings.settings().ENABLED_COMPONENTS.SNAPSHOT_UPDATE_NOTIFICATIONS;
+    }
+
+    private static final class UpdateCheckException extends RuntimeException {
+
+        public UpdateCheckException(final String message) {
+            super("Failed to check for update: " + message);
+        }
+
+        public UpdateCheckException(final String message, final Throwable cause) {
+            super("Failed to check for update: " + message, cause);
+        }
+
+    }
+
 }
diff --git a/worldedit-core/src/main/resources/lang/strings.json b/worldedit-core/src/main/resources/lang/strings.json
@@ -14,7 +14,8 @@
   "fawe.info.worldedit.oom.admin": "Possible options:\n - //fast\n - Do smaller edits\n - Allocate more memory\n - Disable `max-memory-percent`",
   "fawe.info.temporarily-not-working": "Temporarily not working",
   "fawe.info.light-blocks": "Light blocks are more reliable than light sources, please use the blocks. This command is deprecated and will be removed in a future version.",
-  "fawe.info.update-available": "An update for FastAsyncWorldEdit is available. You are {0} build(s) out of date.\nYou are running build {1}, the latest version is build {2}.\nUpdate at {3}",
+  "fawe.info.update-available.build": "An update for FastAsyncWorldEdit is available. You are {0} build(s) behind.\nYou are running build {1}, the latest build is {2}.\nUpdate at {3}",
+  "fawe.info.update-available.release": "A new release for FastAsyncWorldEdit is available: {0}. You are currently on {1}. Download from {2}, {3} or {4}.",
   "fawe.web.generating.link": "Uploading {0}, please wait...",
   "fawe.web.generating.link.failed": "Failed to generate download link!",
   "fawe.web.download.link": "{0}",
diff --git a/worldedit-core/src/test/java/com/fastasyncworldedit/core/util/UpdateNotificationTest.java b/worldedit-core/src/test/java/com/fastasyncworldedit/core/util/UpdateNotificationTest.java
@@ -0,0 +1,30 @@
+package com.fastasyncworldedit.core.util;
+
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.CsvSource;
+
+import java.util.Arrays;
+
+import static org.junit.jupiter.api.Assertions.*;
+
+class UpdateNotificationTest {
+
+    @ParameterizedTest
+    @CsvSource({"1.0.0,2.0.0", "1.0.0,1.1.0", "1.0.0,1.0.1", "1.0.0,1.0.0.1"})
+    void hasUpdateSemver_true(String installed, String latest) {
+        assertTrue(UpdateNotification.hasUpdateSemver(
+                Arrays.stream(installed.split("\\.")).mapToInt(Integer::parseInt).toArray(),
+                Arrays.stream(latest.split("\\.")).mapToInt(Integer::parseInt).toArray()
+        ));
+    }
+
+    @ParameterizedTest
+    @CsvSource({"1.0.0,1.0.0", "2.0.0,1.9.9", "1.0.0,1.0", "1.0,1.0.0"})
+    void hasUpdateSemver_false(String installed, String latest) {
+        assertFalse(UpdateNotification.hasUpdateSemver(
+                Arrays.stream(installed.split("\\.")).mapToInt(Integer::parseInt).toArray(),
+                Arrays.stream(latest.split("\\.")).mapToInt(Integer::parseInt).toArray()
+        ));
+    }
+
+}
