Merge pull request #34 from Andre601/feature/update-checker

Add Update Checker
Update config description
2026-11-05 17:02:34 -05:00 · 2022-12-06 14:03:25 +01:00 · 2022-12-06 00:49:52 +01:00 · 2022-12-06 00:26:55 +01:00 · 2022-12-06 00:01:24 +01:00 · 2022-12-05 23:58:05 +01:00
21 changed files with 490 additions and 34 deletions
@@ -0,0 +1,96 @@
+# AdvancedServerList
+AdvancedServerList is a plugin that allowys you to customize your server's MOTD, favicon, Player count text and player count hover displayed in a player's multiplayer server list based on conditions and priorities.
+
+## Supported Platforms
+
+<a href="https://www.spigotmc.org" target="_blank">
+  <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/minimal/supported/spigot_vector.svg" width="64" alt="platform-spigot" title="Tested on Spigot">
+</a>
+<a href="https://papermc.io" target="_blank">
+  <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/minimal/supported/paper_vector.svg" width="64" alt="platform-paper" title="Tested on Paper">
+</a>
+<a href="https://www.spigotmc.org" target="_blank">
+  <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/minimal/supported/bungeecord_vector.svg" width="64" alt="platform-bungeecord" title="Tested on BungeeCord">
+</a>
+<a href="https://www.papermc.io" target="_blank">
+  <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/minimal/supported/waterfall_vector.svg" width="64" alt="platform-waterfall" title="Tested on Waterfall">
+</a>
+<a href="https://velocitypowered.com" target="_blank">
+  <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/minimal/supported/velocity_vector.svg" width="64" alt="platform-velocity" title="Tested on Velocity">
+</a>
+
+## What is a Server List Profile?
+A Server List Profile refers to a YAML file located in the plugin's `profiles` directory.  
+It allows you to configure specific aspects of the server display in the MC-Client's multiplayer server list, such as the MOTD, player count text, player count hover or Favicon.
+
+> [*Read More*][profiles]
+### Conditions
+Thanks to conditions can you determine when a profile should be displayed in the player’s server list, to allow displaying specific text (i.e. a warning when they are using an outdated version).
+
+When multiple profiles exist that have valid conditions will the one with the highest priority (Higher number = higher priority) be selected. Having no conditions makes the profile automatically return true.
+
+> [*Read More*][conditions]
+### Placeholders
+Placeholders can be used within conditions to further customize them. They can also be used in any other text option (motd, playerCount and players) to display their respective values.
+The format is `${<target> <identifier>}` which was adopted from BungeeTabListPlus. Depending on what platform you use the plugin on are only specific placeholders available.
+
+When using the SpigotMC/PaperMC version can you also use placeholders from [PlaceholderAPI][placeholderapi] using its `%<identifier>_<values>%` placeholder format. PlaceholderAPI needs to be installed for that.
+
+> [*Read More*][placeholders]
+### Formatting
+The plugin uses the MiniMessage format for a consistent, easy way of formatting your text.
+Only certain options are usable for each option. As an example does motd support HEX colours and gradients, while the other options only support default colour codes.
+
+> [*Read More*][minimessage]
+## Dependencies
+
+| Dependency       | Platforms     | Required? |
+| ---------------- | ------------- | --------- |
+| [ProtocolLib]    | Spigot        | Yes       |
+| [PlaceholderAPI] | Spigot, Paper | No        |
+
+## Statistics
+
+This plugin sends statistics to [bStats] to display.  
+You can disable this in the global bStats config file located in `/plugins/bstats/`
+
+- [BungeeCord][bstats-bungee]
+- [Paper/Spigot][bstats-spigot]
+- [Velocity][bstats-velocity]
+
+## Screenshots
+
+<a href="https://modrinth.com/plugin/advancedserverlist/gallery" target="_blank">
+  <img src="https://raw.githubusercontent.com/intergrav/devins-badges/v2/assets/cozy/documentation/modrinth-gallery_vector.svg" width="208" alt="gallery" title="Check out the Gallery">
+</a>
+
+## Support
+<a href="https://discord.gg/6dazXp6" target="_blank">
+  <img src="https://raw.githubusercontent.com/intergrav/devins-badges/v2/assets/minimal/social/discord-singular_vector.svg" width="64" alt="discord" title="Join my Discord Server">
+</a>
+<a href="https://app.revolt.chat/invite/74TpERXA" target="_blank">
+  <img src="https://raw.githubusercontent.com/intergrav/devins-badges/v2/assets/minimal/social/revolt-singular_vector.svg" width="64" alt="revolt" title="Join my Revolt Server">
+</a>
+<a href="https://blobfox.coffee/@andre_601" target="_blank">
+  <img src="https://raw.githubusercontent.com/intergrav/devins-badges/v2/assets/minimal/social/mastodon-singular_vector.svg" width="64" alt="revolt" title="Chat with me on Mastodon">
+</a>
+
+<!-- Links -->
+[profiles]: https://github.com/Andre601/AdvancedServerList/wiki/Profiles
+[conditions]: https://github.com/Andre601/AdvancedServerList/wiki/Profiles#conditions
+[placeholders]: https://github.com/Andre601/AdvancedServerList/wiki/Profiles#placeholders
+[minimessage]: https://github.com/Andre601/AdvancedServerList/wiki/Profiles#minimessage
+
+[placeholderapi]: https://www.spigotmc.org/resources/6245/
+
+[modrinth]: https://modrinth.com/plugin/advancedserverlist
+
+[protocollib]: https://www.spigotmc.org/resources/1997/
+[placeholderapi]: https://www.spigotmc.org/resources/6245/
+
+[bstats]: https://bstats.org
+[bstats-bungee]: https://bstats.org/plugin/bungeecord/AdvancedServerList/15585
+[bstats-spigot]: https://bstats.org/plugin/bukkit/AdvancedServerList/15584
+[bstats-velocity]: https://bstats.org/plugin/velocity/AdvancedServerList/15587
+
+[gallery]: https://modrinth.com/mod/advancedserverlist/gallery
@@ -1,7 +1,27 @@
 # AdvancedServerList
-![platform] ![tested]
+<a href="https://modrinth.com/plugin/advancedserverlist" target="_blank">
+  <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/available/modrinth_vector.svg" height="64" align="right" alt="modrinth" title="Available on Modrinth">
+</a>

-AdvancedServerList is a plugin made for SpigotMC, PaperMC, BungeeCord/Waterfall and Velocity. It allows you to create server list profiles to display based on priority and conditions.
+AdvancedServerList is a plugin that allowys you to customize your server's MOTD, favicon, Player count text and player count hover displayed in a player's multiplayer server list based on conditions and priorities.
+
+## Supported Platforms
+
+<a href="https://www.spigotmc.org" target="_blank">
+  <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/minimal/supported/spigot_vector.svg" height="64" alt="platform-spigot" title="Tested on Spigot">
+</a>
+<a href="https://papermc.io" target="_blank">
+  <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/minimal/supported/paper_vector.svg" height="64" alt="platform-paper" title="Tested on Paper">
+</a>
+<a href="https://www.spigotmc.org" target="_blank">
+  <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/minimal/supported/bungeecord_vector.svg" height="64" alt="platform-bungeecord" title="Tested on BungeeCord">
+</a>
+<a href="https://www.papermc.io" target="_blank">
+  <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/minimal/supported/waterfall_vector.svg" height="64" alt="platform-waterfall" title="Tested on Waterfall">
+</a>
+<a href="https://velocitypowered.com" target="_blank">
+  <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/minimal/supported/velocity_vector.svg" height="64" alt="platform-velocity" title="Tested on Velocity">
+</a>

 ## What is a Server List Profile?
 A Server List Profile refers to a YAML file located in the plugin's `profiles` directory.  
@@ -30,12 +50,6 @@ Only certain options are usable for each option. As an example does motd support

 > [*Read More*][minimessage]

-## Downloads
-
-<a href="https://modrinth.com/plugin/advancedserverlist" target="_blank">
-  <img src="https://raw.githubusercontent.com/intergrav/devins-badges/main/badges/modrinth_vector.svg" height="64" />
-</a>
-
 ## Dependencies

 | Dependency       | Platforms     | Required? |
@@ -55,7 +69,18 @@ You can disable this in the global bStats config file located in `/plugins/bstat
 ## Screenshots

 <a href="https://modrinth.com/plugin/advancedserverlist/gallery" target="_blank">
-  <img src="https://raw.githubusercontent.com/intergrav/devins-badges/main/badges/modrinth-gallery_vector.svg" height="64" />
+  <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/cozy/documentation/modrinth-gallery_vector.svg" height="64" alt="gallery" title="Check out the Gallery">
+</a>
+
+## Support
+<a href="https://discord.gg/6dazXp6" target="_blank">
+  <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/minimal/social/discord-singular_vector.svg" height="64" alt="discord" title="Join my Discord Server">
+</a>
+<a href="https://app.revolt.chat/invite/74TpERXA" target="_blank">
+  <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/minimal/social/revolt-singular_vector.svg" height="64" alt="revolt" title="Join my Revolt Server">
+</a>
+<a href="https://blobfox.coffee/@andre_601" target="_blank">
+  <img src="https://cdn.jsdelivr.net/npm/@intergrav/devins-badges@2/assets/minimal/social/mastodon-singular_vector.svg" height="64" alt="mastodon" title="Chat with me on Mastodon">
 </a>

 <!-- Links -->
@@ -77,8 +102,3 @@ You can disable this in the global bStats config file located in `/plugins/bstat
 [bstats-velocity]: https://bstats.org/plugin/velocity/AdvancedServerList/15587

 [gallery]: https://modrinth.com/mod/advancedserverlist/gallery
-
-<!-- Badges -->
-[platform]: https://img.shields.io/badge/Platforms-Spigot%20%7C%20Paper%20%7C%20BungeeCord%20%7C%20Velocity-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9IjI0IiBoZWlnaHQ9IjI0IiBmaWxsPSJ3aGl0ZSI+PHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMTEuMDYzIDEuNDU2YTEuNzUgMS43NSAwIDAxMS44NzQgMGw4LjM4MyA1LjMxNmExLjc1IDEuNzUgMCAwMTAgMi45NTZsLTguMzgzIDUuMzE2YTEuNzUgMS43NSAwIDAxLTEuODc0IDBMMi42OCA5LjcyOGExLjc1IDEuNzUgMCAwMTAtMi45NTZsOC4zODMtNS4zMTZ6bTEuMDcxIDEuMjY3YS4yNS4yNSAwIDAwLS4yNjggMEwzLjQ4MyA4LjAzOWEuMjUuMjUgMCAwMDAgLjQyMmw4LjM4MyA1LjMxNmEuMjUuMjUgMCAwMC4yNjggMGw4LjM4My01LjMxNmEuMjUuMjUgMCAwMDAtLjQyMmwtOC4zODMtNS4zMTZ6Ij48L3BhdGg+PHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMS44NjcgMTIuMzI0YS43NS43NSAwIDAxMS4wMzUtLjIzMmw4Ljk2NCA1LjY4NWEuMjUuMjUgMCAwMC4yNjggMGw4Ljk2NC01LjY4NWEuNzUuNzUgMCAwMS44MDQgMS4yNjdsLTguOTY1IDUuNjg1YTEuNzUgMS43NSAwIDAxLTEuODc0IDBsLTguOTY1LTUuNjg1YS43NS43NSAwIDAxLS4yMzEtMS4wMzV6Ij48L3BhdGg+PHBhdGggZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMS44NjcgMTYuMzI0YS43NS43NSAwIDAxMS4wMzUtLjIzMmw4Ljk2NCA1LjY4NWEuMjUuMjUgMCAwMC4yNjggMGw4Ljk2NC01LjY4NWEuNzUuNzUgMCAwMS44MDQgMS4yNjdsLTguOTY1IDUuNjg1YTEuNzUgMS43NSAwIDAxLTEuODc0IDBsLTguOTY1LTUuNjg1YS43NS43NSAwIDAxLS4yMzEtMS4wMzV6Ij48L3BhdGg+PC9zdmc+
-
-[tested]: https://img.shields.io/badge/Tested%20Versions-1.19%20%7C%201.19.1%20%7C%201.19.2-blue?style=for-the-badge&logo=image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHZpZXdCb3g9IjAgMCAyNCAyNCIgd2lkdGg9IjI0IiBoZWlnaHQ9IjI0IiBmaWxsPSJ3aGl0ZSI+PHBhdGggZD0iTTE3LjI4IDkuMjhhLjc1Ljc1IDAgMDAtMS4wNi0xLjA2bC01Ljk3IDUuOTctMi40Ny0yLjQ3YS43NS43NSAwIDAwLTEuMDYgMS4wNmwzIDNhLjc1Ljc1IDAgMDAxLjA2IDBsNi41LTYuNXoiPjwvcGF0aD48cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGQ9Ik0zLjc1IDJBMS43NSAxLjc1IDAgMDAyIDMuNzV2MTYuNWMwIC45NjYuNzg0IDEuNzUgMS43NSAxLjc1aDE2LjVBMS43NSAxLjc1IDAgMDAyMiAyMC4yNVYzLjc1QTEuNzUgMS43NSAwIDAwMjAuMjUgMkgzLjc1ek0zLjUgMy43NWEuMjUuMjUgMCAwMS4yNS0uMjVoMTYuNWEuMjUuMjUgMCAwMS4yNS4yNXYxNi41YS4yNS4yNSAwIDAxLS4yNS4yNUgzLjc1YS4yNS4yNSAwIDAxLS4yNS0uMjVWMy43NXoiPjwvcGF0aD48L3N2Zz4=
@@ -103,7 +103,7 @@
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
-                <version>3.4.0</version>
+                <version>3.4.1</version>
                <configuration>
                    <createDependencyReducedPom>false</createDependencyReducedPom>
                    <relocations>
@@ -123,6 +123,10 @@
                            <pattern>com.github.benmanes.caffeine</pattern>
                            <shadedPattern>ch.andre601.advancedserverlist.bungeecord.depends.caffeine</shadedPattern>
                        </relocation>
+                        <relocation>
+                            <pattern>okhttp3</pattern>
+                            <shadedPattern>ch.andre601.advancedserverlist.bungeecord.depends.okhttp3</shadedPattern>
+                        </relocation>
                    </relocations>
                    <filters>
                        <filter>
@@ -30,8 +30,8 @@ import ch.andre601.advancedserverlist.bungeecord.events.JoinEvent;
 import ch.andre601.advancedserverlist.bungeecord.events.PingEvent;
 import ch.andre601.advancedserverlist.bungeecord.logging.BungeeLogger;
 import ch.andre601.advancedserverlist.core.AdvancedServerList;
-import ch.andre601.advancedserverlist.core.interfaces.core.ProxyCore;
 import ch.andre601.advancedserverlist.core.interfaces.PluginLogger;
+import ch.andre601.advancedserverlist.core.interfaces.core.ProxyCore;
 import ch.andre601.advancedserverlist.core.parsing.ComponentParser;
 import ch.andre601.advancedserverlist.core.profiles.favicon.FaviconHandler;
 import ch.andre601.advancedserverlist.core.profiles.replacer.placeholders.Placeholders;
@@ -122,6 +122,11 @@ public class BungeeCordCore extends Plugin implements ProxyCore<Favicon, ServerP
        return getProxy().getVersion();
    }
    
+    @Override
+    public String getLoader(){
+        return "bungeecord";
+    }
+    
    @Override
    public List<ServerPing.PlayerInfo> createPlayers(List<String> lines, Placeholders... placeholders){
        List<ServerPing.PlayerInfo> players = new ArrayList<>(lines.size());
@@ -52,24 +52,34 @@
        <dependency>
            <groupId>net.kyori</groupId>
            <artifactId>adventure-api</artifactId>
-            <version>4.11.0</version>
+            <version>4.12.0</version>
        </dependency>
        <dependency>
            <groupId>net.kyori</groupId>
            <artifactId>adventure-text-minimessage</artifactId>
-            <version>4.11.0</version>
+            <version>4.12.0</version>
        </dependency>
        <dependency>
            <groupId>net.kyori</groupId>
            <artifactId>adventure-text-serializer-legacy</artifactId>
-            <version>4.11.0</version>
+            <version>4.12.0</version>
        </dependency>
        <dependency>
            <groupId>com.github.ben-manes.caffeine</groupId>
            <artifactId>caffeine</artifactId>
-            <version>3.1.1</version>
+            <version>3.1.2</version>
            <scope>compile</scope>
        </dependency>
+        <dependency>
+            <groupId>com.google.code.gson</groupId>
+            <artifactId>gson</artifactId>
+            <version>2.9.1</version>
+        </dependency>
+        <dependency>
+            <groupId>com.squareup.okhttp3</groupId>
+            <artifactId>okhttp</artifactId>
+            <version>4.10.0</version>
+        </dependency>
    </dependencies>

    <build>
@@ -89,7 +99,7 @@
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
-                <version>3.4.0</version>
+                <version>3.4.1</version>
                <configuration>
                    <createDependencyReducedPom>false</createDependencyReducedPom>
                    <filters>
@@ -25,6 +25,7 @@

 package ch.andre601.advancedserverlist.core;

+import ch.andre601.advancedserverlist.core.check.UpdateChecker;
 import ch.andre601.advancedserverlist.core.commands.CommandHandler;
 import ch.andre601.advancedserverlist.core.file.FileHandler;
 import ch.andre601.advancedserverlist.core.interfaces.core.PluginCore;
@@ -33,7 +34,7 @@ import ch.andre601.advancedserverlist.core.profiles.players.PlayerHandler;
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.file.Path;
-import java.util.*;
+import java.util.Properties;

 public class AdvancedServerList{
    
@@ -42,6 +43,8 @@ public class AdvancedServerList{
    private final CommandHandler commandHandler;
    private final PlayerHandler playerHandler;
    
+    private UpdateChecker updateChecker;
+    
    private String version;
    
    public AdvancedServerList(PluginCore<?> plugin){
@@ -76,6 +79,12 @@ public class AdvancedServerList{
    public void disable(){
        getPlugin().getPluginLogger().info("Saving cache.data file...");
        getPlayerHandler().save();
+        
+        if(updateChecker != null){
+            getPlugin().getPluginLogger().info("Disabling Update Checker...");
+            updateChecker.disable();
+        }
+        
        getPlugin().getPluginLogger().info("AdvancedServerList disabled!");
    }
    
@@ -88,7 +97,6 @@ public class AdvancedServerList{
        resolveVersion();
    
        getPlugin().getPluginLogger().info("Starting AdvancedServerList v%s...", version);
-    
        getPlugin().getPluginLogger().info("Platform: " + plugin.getPlatformName() + " " + plugin.getPlatformVersion());
        
        if(getFileHandler().loadConfig()){
@@ -125,6 +133,9 @@ public class AdvancedServerList{
        getPlugin().getPluginLogger().info("Metrics loaded!");
    
        getPlugin().getPluginLogger().info("AdvancedServerList is ready!");
+        
+        if(getFileHandler().getBoolean("check_updates"))
+            this.updateChecker = new UpdateChecker(this);
    }
    
    private void printBanner(){
@@ -0,0 +1,37 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2022 Andre_601
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+
+package ch.andre601.advancedserverlist.core.check;
+
+import org.jetbrains.annotations.NotNull;
+
+import java.util.concurrent.ThreadFactory;
+
+public class UpdateCheckThread implements ThreadFactory{
+    @Override
+    public Thread newThread(@NotNull Runnable r){
+        return new Thread(r, "AdvancedServerList Update-Thread");
+    }
+}
@@ -0,0 +1,214 @@
+/*
+ * MIT License
+ *
+ * Copyright (c) 2022 Andre_601
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ *
+ */
+
+package ch.andre601.advancedserverlist.core.check;
+
+import ch.andre601.advancedserverlist.core.AdvancedServerList;
+import ch.andre601.advancedserverlist.core.interfaces.PluginLogger;
+import com.google.gson.FieldNamingPolicy;
+import com.google.gson.Gson;
+import com.google.gson.GsonBuilder;
+import com.google.gson.JsonSyntaxException;
+import io.leangen.geantyref.TypeToken;
+import okhttp3.OkHttpClient;
+import okhttp3.Request;
+import okhttp3.Response;
+import okhttp3.ResponseBody;
+
+import java.io.IOException;
+import java.lang.reflect.Type;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.concurrent.*;
+
+public class UpdateChecker{
+    
+    private final String url = "https://api.modrinth.com/v2/project/advancedserverlist/version?loaders=[\"%s\"]";
+    private final OkHttpClient client = new OkHttpClient();
+    
+    private final AdvancedServerList core;
+    private final PluginLogger logger;
+    private final String loader;
+    
+    private final Type listType = new TypeToken<ArrayList<ModrinthVersion>>(){}.getType();
+    private final Gson gson = new GsonBuilder()
+        .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
+        .setPrettyPrinting()
+        .setLenient()
+        .create();
+    
+    private final ScheduledExecutorService executor = Executors.newSingleThreadScheduledExecutor(new UpdateCheckThread());
+    
+    public UpdateChecker(AdvancedServerList core){
+        this.core = core;
+        this.logger = core.getPlugin().getPluginLogger();
+        this.loader = core.getPlugin().getLoader();
+        
+        startUpdateChecker();
+    }
+    
+    public void startUpdateChecker(){
+        executor.scheduleAtFixedRate(() -> {
+            logger.info("Checking for a new update...");
+            checkUpdate().whenComplete((version, throwable) -> {
+                if(version == null || throwable != null){
+                    logger.warn("Failed to look for any updates. See previous messages for reasons.");
+                    return;
+                }
+        
+                int result = version.compare(core.getVersion());
+                switch(result){
+                    case -2 -> {
+                        logger.warn("Encountered an exception while comparing versions. Are they valid?");
+                        logger.warn("Own version: %s; New version: %s", core.getVersion(), version.getVersionNumber());
+                    }
+                    case -1 -> logger.info("You seem to run a newer version compared to Modrinth. Are you running a dev build?");
+                    case 0 -> logger.info("No new update found. You're running the latest version!");
+                    case 1 -> printUpdateBanner(version.getVersionNumber(), version.getId());
+                }
+            });
+        }, 0L, 12L, TimeUnit.HOURS);
+    }
+    
+    public void disable(){
+        executor.shutdown();
+        try{
+            if(!executor.awaitTermination(1, TimeUnit.SECONDS)){
+                executor.shutdownNow();
+                if(!executor.awaitTermination(1, TimeUnit.SECONDS))
+                    logger.warn("Scheduler didn't terminate in time!");
+            }
+        }catch(InterruptedException ex){
+            executor.shutdownNow();
+            Thread.currentThread().interrupt();
+        }
+    }
+    
+    private CompletableFuture<ModrinthVersion> checkUpdate(){
+        return CompletableFuture.supplyAsync(() -> {
+            PluginLogger logger = core.getPlugin().getPluginLogger();
+            if(core.getVersion().equals("UNKNOWN")){
+                logger.warn("Cannot perform Update check! Plugin version couldn't be parsed.");
+                return null;
+            }
+            
+            Request request = new Request.Builder()
+                .url(String.format(url, loader))
+                .header("User-Agent", "AdvancedServerList-" + loader + "/" + core.getVersion())
+                .build();
+            
+            try(Response response = client.newCall(request).execute()){
+                if(!response.isSuccessful()){
+                    logger.warn("Encountered a non-successful response from Modrinth! Code: %d", response.code());
+                    return null;
+                }
+    
+                ResponseBody body = response.body();
+                if(body == null){
+                    logger.warn("Received an empty Response body from Modrinth!");
+                    return null;
+                }
+                
+                String responseString = body.string();
+                if(responseString.isEmpty()){
+                    logger.warn("Received an empty Response body from Modrinth!");
+                    return null;
+                }
+                
+                List<ModrinthVersion> list = gson.fromJson(responseString, listType);
+                if(list == null || list.isEmpty()){
+                    logger.warn("Couldn't convert JSON Array into a valid list.");
+                    return null;
+                }
+                
+                ModrinthVersion version = list.get(0);
+                if(version.getVersionNumber() == null || version.getVersionNumber().isEmpty()){
+                    logger.warn("Cannot check latest version. Received version number was null/empty.");
+                    return null;
+                }
+                
+                return version;
+            }catch(JsonSyntaxException ex){
+                logger.warn("Encountered invalid JSON from Response body!", ex);
+                return null;
+            }catch(IOException ex){
+                logger.warn("Encountered Exception while checking for an update!", ex);
+                return null;
+            }
+        });
+    }
+    
+    private void printUpdateBanner(String version, String versionId){
+        logger.info("==================================================================");
+        logger.info("You are running an outdated version of AdvancedServerList!");
+        logger.info("");
+        logger.info("Your version: %s", core.getVersion());
+        logger.info("Modrinth version: %s", version);
+        logger.info("");
+        logger.info("You can download the latest release from here:");
+        logger.info("https://modrinth.com/plugin/advancedserverlist/version/%s", versionId);
+        logger.info("==================================================================");
+    }
+    
+    public static class ModrinthVersion{
+        private String id;
+        private String versionNumber;
+        
+        public ModrinthVersion(String id, String versionNumber){
+            this.id = id;
+            this.versionNumber = versionNumber;
+        }
+    
+        public String getId(){
+            return id;
+        }
+    
+        public String getVersionNumber(){
+            return versionNumber;
+        }
+        
+        public int compare(String version){
+            String[] oldParts = version.split("\\.");
+            String[] newParts = versionNumber.split("\\.");
+            int length = Math.max(oldParts.length, newParts.length);
+            
+            for(int i = 0; i < length; i++){
+                try{
+                    int oldPart = i < oldParts.length ? Integer.parseInt(oldParts[i]) : 0;
+                    int newPart = i < newParts.length ? Integer.parseInt(newParts[i]) : 0;
+                    
+                    if(oldPart < newPart)
+                        return 1;
+                    
+                    if(oldPart > newPart)
+                        return -1;
+                }catch(NumberFormatException ex){
+                    return -2;
+                }
+            }
+            return 0;
+        }
+    }
+}
@@ -156,4 +156,8 @@ public class FileHandler{
    public String getString(String def, Object... path){
        return node.node(path).getString(def);
    }
+    
+    public boolean getBoolean(Object... path){
+        return node.node(path).getBoolean();
+    }
 }
@@ -52,4 +52,6 @@ public interface PluginCore<F>{
    String getPlatformName();
    
    String getPlatformVersion();
+    
+    String getLoader();
 }
@@ -33,7 +33,6 @@ import java.io.IOException;
 import java.nio.charset.StandardCharsets;
 import java.nio.file.Files;
 import java.nio.file.Path;
-import java.nio.file.StandardOpenOption;
 import java.util.List;
 import java.util.Map;
 import java.util.StringJoiner;
@@ -54,6 +53,12 @@ public class PlayerHandler{
            core.getPlugin().getPluginLogger().info("No cache.data present. Skipping...");
            return;
        }
+        
+        if(core.getFileHandler().getBoolean("disable_cache")){
+            core.getPlugin().getPluginLogger().info("Cache disabled. Skipping player loading...");
+            return;
+        }
+        
        List<String> lines;
        try{
            lines = Files.readAllLines(cache);
@@ -86,6 +91,11 @@ public class PlayerHandler{
            core.getPlugin().getPluginLogger().info("No data to save. Skipping...");
            return;
        }
+    
+        if(core.getFileHandler().getBoolean("disable_cache")){
+            core.getPlugin().getPluginLogger().info("Cache disabled. Skipping player saving...");
+            return;
+        }
        
        StringJoiner joiner = new StringJoiner("\n");
        for(Map.Entry<String, String> entry : players){
@@ -93,7 +103,7 @@ public class PlayerHandler{
        }
        
        try{
-            BufferedWriter writer = Files.newBufferedWriter(cache, StandardCharsets.UTF_8, StandardOpenOption.WRITE);
+            BufferedWriter writer = Files.newBufferedWriter(cache, StandardCharsets.UTF_8);
            
            writer.write(joiner.toString());
            writer.close();
@@ -105,13 +115,16 @@ public class PlayerHandler{
    }
    
    public void addPlayer(String name, String ip){
-        if(players.containsKey(name))
+        if(players.containsKey(name) || core.getFileHandler().getBoolean("disable_cache"))
            return;
        
        players.add(name, ip);
    }
    
    public String getPlayerByIp(String ip){
+        if(core.getFileHandler().getBoolean("disable_cache"))
+            core.getFileHandler().getString("Anonymous", "unknown_player");
+        
        for(Map.Entry<String, String> entry : players){
            if(entry.getValue().equals(ip))
                return entry.getKey();
@@ -1,4 +1,20 @@
 #
 # Used for when AdvancedServerList doesn't have a cached player to use for ${player name}
 #
-unknown_player: "Anonymous"
+unknown_player: "Anonymous"
+
+#
+# Should the Caching of players be disabled?
+#
+# When set to true will AdvancedServerList not load any players from the cache.data file (if present) nor save any to it.
+# Placeholders that rely on the player being cached (such as ${player isWhitelisted}) will not work while this option is enabled.
+#
+disable_cache: false
+
+#
+# Should AdvancedServerList check for new versions?
+#
+# When set to true will AdvancedServerList check for a new version on modrinth.com every 12 hours and inform you in the
+# console about whether it found any new update or not.
+#
+check_updates: true
@@ -101,7 +101,7 @@
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
-                <version>3.4.0</version>
+                <version>3.4.1</version>
                <configuration>
                    <createDependencyReducedPom>false</createDependencyReducedPom>
                    <relocations>
@@ -156,8 +156,9 @@ public class PaperCore extends JavaPlugin implements ServerCore<CachedServerIcon
        return getServer().getVersion();
    }
    
-    private void enable(){
-        this.core = new AdvancedServerList(this);
+    @Override
+    public String getLoader(){
+        return "paper";
    }
    
    @Override
@@ -181,4 +182,8 @@ public class PaperCore extends JavaPlugin implements ServerCore<CachedServerIcon
        
        return players;
    }
+    
+    private void enable(){
+        this.core = new AdvancedServerList(this);
+    }
 }
@@ -7,6 +7,9 @@ main: 'ch.andre601.advancedserverlist.paper.PaperCore'

 api-version: 1.19

+libraries:
+  - 'com.squareup.okhttp3:okhttp:4.10.0'
+
 softdepend:
  - 'PlaceholderAPI'

@@ -12,7 +12,7 @@
    <properties>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
        
-        <plugin.version>1.6.2</plugin.version>
+        <plugin.version>1.7.0</plugin.version>
        <plugin.description>Create multiple Server lists based on conditions.</plugin.description>
        
        <maven.compiler.source>16</maven.compiler.source>
@@ -141,6 +141,11 @@ public class SpigotCore extends JavaPlugin implements ServerCore<WrappedServerPi
        return getServer().getVersion();
    }
    
+    @Override
+    public String getLoader(){
+        return "spigot";
+    }
+    
    @Override
    public List<WrappedGameProfile> createPlayers(List<String> lines, OfflinePlayer player, Placeholders... placeholders){
        List<WrappedGameProfile> players = new ArrayList<>(lines.size());
@@ -47,7 +47,8 @@ import org.bukkit.OfflinePlayer;
 import org.bukkit.event.Listener;

 import java.net.InetSocketAddress;
-import java.util.*;
+import java.util.HashMap;
+import java.util.Map;

 public class PingEvent implements Listener{
    
@@ -13,6 +13,7 @@ libraries:
  - 'net.kyori:adventure-text-minimessage:4.11.0'
  - 'net.kyori:adventure-text-serializer-legacy:4.11.0'
  - 'net.kyori:adventure-platform-bukkit:4.1.2'
+  - 'com.squareup.okhttp3:okhttp:4.10.0'

 softdepend:
  - 'ProtocolLib'
@@ -88,7 +88,7 @@
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-shade-plugin</artifactId>
-                <version>3.4.0</version>
+                <version>3.4.1</version>
                <configuration>
                    <createDependencyReducedPom>false</createDependencyReducedPom>
                    <relocations>
@@ -104,6 +104,10 @@
                            <pattern>com.github.benmanes.caffeine</pattern>
                            <shadedPattern>ch.andre601.advancedserverlist.velocity.depends.caffeine</shadedPattern>
                        </relocation>
+                        <relocation>
+                            <pattern>okhttp3</pattern>
+                            <shadedPattern>ch.andre601.advancedserverlist.velocity.depends.okhttp3</shadedPattern>
+                        </relocation>
                    </relocations>
                    <filters>
                        <filter>
@@ -26,8 +26,8 @@
 package ch.andre601.advancedserverlist.velocity;

 import ch.andre601.advancedserverlist.core.AdvancedServerList;
-import ch.andre601.advancedserverlist.core.interfaces.core.ProxyCore;
 import ch.andre601.advancedserverlist.core.interfaces.PluginLogger;
+import ch.andre601.advancedserverlist.core.interfaces.core.ProxyCore;
 import ch.andre601.advancedserverlist.core.parsing.ComponentParser;
 import ch.andre601.advancedserverlist.core.profiles.favicon.FaviconHandler;
 import ch.andre601.advancedserverlist.core.profiles.replacer.placeholders.Placeholders;
@@ -162,6 +162,11 @@ public class VelocityCore implements ProxyCore<Favicon, ServerPing.SamplePlayer>
        return getProxy().getVersion().getVersion();
    }
    
+    @Override
+    public String getLoader(){
+        return "velocity";
+    }
+    
    public ProxyServer getProxy(){
        return proxy;
    }
Author	SHA1	Message	Date
Andre_601	6f06c47de7	Merge pull request #34 from Andre601/feature/update-checker Add Update Checker	2022-12-06 14:03:25 +01:00
Andre601	ad3ba0c8b3	Update config description	2022-12-06 00:49:52 +01:00
Andre601	12d8d930dd	Use a ScheduledExecutorService instead of Timer	2022-12-06 00:26:55 +01:00
Andre601	9a30a6b679	Add info line	2022-12-06 00:01:24 +01:00
Andre601	b82cf69d43	Simplify more.	2022-12-05 23:58:05 +01:00
Andre601	fb6d93b455	Init timer only when UpdateChecker is used.	2022-12-05 23:55:54 +01:00
Andre601	a1276da68f	Fix exceptions	2022-12-05 23:13:21 +01:00
Andre601	25c053d495	Use timer class from Java	2022-12-05 22:24:19 +01:00
Andre601	39c1fb5452	Better version comparison.	2022-12-05 21:26:24 +01:00
Andre601	48edebc043	Add config option	2022-12-03 20:29:45 +01:00
Andre601	3a672378ff	Add Update Checker	2022-12-03 20:23:21 +01:00
Andre_601	9db9f2be7f	Merge pull request #33 from Andre601/dependabot/maven/core/net.kyori-adventure-api-4.12.0 Bump adventure-api from 4.11.0 to 4.12.0 in /core	2022-11-28 16:31:53 +01:00
Andre_601	2cf47e351b	Merge pull request #32 from Andre601/dependabot/maven/core/net.kyori-adventure-text-minimessage-4.12.0 Bump adventure-text-minimessage from 4.11.0 to 4.12.0 in /core	2022-11-28 16:31:39 +01:00
Andre_601	36abdb83cd	Merge pull request #31 from Andre601/dependabot/maven/core/net.kyori-adventure-text-serializer-legacy-4.12.0 Bump adventure-text-serializer-legacy from 4.11.0 to 4.12.0 in /core	2022-11-28 16:31:21 +01:00
dependabot[bot]	ad950bf330	Bump adventure-api from 4.11.0 to 4.12.0 in /core Bumps [adventure-api](https://github.com/KyoriPowered/adventure) from 4.11.0 to 4.12.0. - [Release notes](https://github.com/KyoriPowered/adventure/releases) - [Commits](https://github.com/KyoriPowered/adventure/compare/v4.11.0...v4.12.0) --- updated-dependencies: - dependency-name: net.kyori:adventure-api dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>	2022-11-28 15:12:17 +00:00
dependabot[bot]	143753d309	Bump adventure-text-minimessage from 4.11.0 to 4.12.0 in /core Bumps [adventure-text-minimessage](https://github.com/KyoriPowered/adventure) from 4.11.0 to 4.12.0. - [Release notes](https://github.com/KyoriPowered/adventure/releases) - [Commits](https://github.com/KyoriPowered/adventure/compare/v4.11.0...v4.12.0) --- updated-dependencies: - dependency-name: net.kyori:adventure-text-minimessage dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>	2022-11-28 15:12:10 +00:00
dependabot[bot]	0c37c21650	Bump adventure-text-serializer-legacy from 4.11.0 to 4.12.0 in /core Bumps [adventure-text-serializer-legacy](https://github.com/KyoriPowered/adventure) from 4.11.0 to 4.12.0. - [Release notes](https://github.com/KyoriPowered/adventure/releases) - [Commits](https://github.com/KyoriPowered/adventure/compare/v4.11.0...v4.12.0) --- updated-dependencies: - dependency-name: net.kyori:adventure-text-serializer-legacy dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>	2022-11-28 15:12:04 +00:00
Andre_601	40a6b4f059	Merge pull request #30 from Andre601/dependabot/maven/core/com.github.ben-manes.caffeine-caffeine-3.1.2 Bump caffeine from 3.1.1 to 3.1.2 in /core	2022-11-24 16:24:36 +01:00
dependabot[bot]	965e87d71b	Bump caffeine from 3.1.1 to 3.1.2 in /core Bumps [caffeine](https://github.com/ben-manes/caffeine) from 3.1.1 to 3.1.2. - [Release notes](https://github.com/ben-manes/caffeine/releases) - [Commits](https://github.com/ben-manes/caffeine/compare/v3.1.1...v3.1.2) --- updated-dependencies: - dependency-name: com.github.ben-manes.caffeine:caffeine dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>	2022-11-24 15:08:34 +00:00
Andre_601	202a22f33a	Update README.md	2022-11-21 15:20:02 +01:00
Andre_601	a4b2a6c350	Update MODRINTH.md	2022-11-21 15:03:28 +01:00
Andre601	ba55f5299b	Bump version	2022-11-07 22:29:04 +01:00
Andre_601	24fdf798cf	Merge pull request #29 from Andre601/feature/disable-cache-option Add option to disable Cache	2022-11-07 22:28:16 +01:00
Andre601	e208d181b7	Add option to disable Cache	2022-11-07 22:14:50 +01:00
Andre_601	6c15c7b259	Merge pull request #28 from Andre601/dependabot/maven/paper/org.apache.maven.plugins-maven-shade-plugin-3.4.1 Bump maven-shade-plugin from 3.4.0 to 3.4.1 in /paper	2022-10-27 17:55:21 +02:00
Andre_601	dcd76a43f5	Merge pull request #27 from Andre601/dependabot/maven/bungeecord/org.apache.maven.plugins-maven-shade-plugin-3.4.1 Bump maven-shade-plugin from 3.4.0 to 3.4.1 in /bungeecord	2022-10-27 17:55:10 +02:00
Andre_601	adc2060499	Merge pull request #26 from Andre601/dependabot/maven/velocity/org.apache.maven.plugins-maven-shade-plugin-3.4.1 Bump maven-shade-plugin from 3.4.0 to 3.4.1 in /velocity	2022-10-27 17:55:01 +02:00
Andre_601	4d6befc857	Merge pull request #25 from Andre601/dependabot/maven/core/org.apache.maven.plugins-maven-shade-plugin-3.4.1 Bump maven-shade-plugin from 3.4.0 to 3.4.1 in /core	2022-10-27 17:54:52 +02:00
dependabot[bot]	7cfb792471	Bump maven-shade-plugin from 3.4.0 to 3.4.1 in /paper Bumps [maven-shade-plugin](https://github.com/apache/maven-shade-plugin) from 3.4.0 to 3.4.1. - [Release notes](https://github.com/apache/maven-shade-plugin/releases) - [Commits](https://github.com/apache/maven-shade-plugin/compare/maven-shade-plugin-3.4.0...maven-shade-plugin-3.4.1) --- updated-dependencies: - dependency-name: org.apache.maven.plugins:maven-shade-plugin dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>	2022-10-27 15:41:21 +00:00
dependabot[bot]	d46245eefa	Bump maven-shade-plugin from 3.4.0 to 3.4.1 in /bungeecord Bumps [maven-shade-plugin](https://github.com/apache/maven-shade-plugin) from 3.4.0 to 3.4.1. - [Release notes](https://github.com/apache/maven-shade-plugin/releases) - [Commits](https://github.com/apache/maven-shade-plugin/compare/maven-shade-plugin-3.4.0...maven-shade-plugin-3.4.1) --- updated-dependencies: - dependency-name: org.apache.maven.plugins:maven-shade-plugin dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>	2022-10-27 15:41:17 +00:00
dependabot[bot]	d5e0fd3d7a	Bump maven-shade-plugin from 3.4.0 to 3.4.1 in /velocity Bumps [maven-shade-plugin](https://github.com/apache/maven-shade-plugin) from 3.4.0 to 3.4.1. - [Release notes](https://github.com/apache/maven-shade-plugin/releases) - [Commits](https://github.com/apache/maven-shade-plugin/compare/maven-shade-plugin-3.4.0...maven-shade-plugin-3.4.1) --- updated-dependencies: - dependency-name: org.apache.maven.plugins:maven-shade-plugin dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>	2022-10-27 15:41:11 +00:00
dependabot[bot]	496e246b9e	Bump maven-shade-plugin from 3.4.0 to 3.4.1 in /core Bumps [maven-shade-plugin](https://github.com/apache/maven-shade-plugin) from 3.4.0 to 3.4.1. - [Release notes](https://github.com/apache/maven-shade-plugin/releases) - [Commits](https://github.com/apache/maven-shade-plugin/compare/maven-shade-plugin-3.4.0...maven-shade-plugin-3.4.1) --- updated-dependencies: - dependency-name: org.apache.maven.plugins:maven-shade-plugin dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com>	2022-10-27 15:41:11 +00:00
Andre_601	e263a45f1c	width and not height	2022-10-05 17:40:40 +02:00
Andre_601	edfc977730	Update MODRINTH.md	2022-10-05 17:40:01 +02:00
Andre_601	5910c26b4b	Add waterfall badge	2022-10-03 23:49:07 +02:00
Andre_601	5b9c506a89	Use jsdelivr url	2022-09-26 00:17:47 +02:00
Andre_601	913ddd7834	Create MODRINTH.md	2022-09-22 13:41:05 +02:00
Andre_601	397c7ea59a	Merge pull request #23 from Andre601/feature/readme-new-badges Prepare readme for new badges	2022-09-21 01:48:30 +02:00
Andre_601	6e7b2541e1	Update README.md	2022-09-21 01:48:22 +02:00
Andre_601	241c15a452	Update README.md	2022-09-20 22:07:40 +02:00
Andre_601	62c5d13aa2	Prepare readme for new badges	2022-09-20 22:05:33 +02:00
Andre601	3a73c5ce6b	Fix wrong open-perms for certain OS	2022-09-20 00:41:33 +02:00
Andre_601	bf54e8eb0b	Yes I update the README a lot today...	2022-09-18 01:45:46 +02:00
Andre_601	aa2cabedbf	Update README.md	2022-09-18 01:09:01 +02:00
Andre_601	66878626e1	Update README.md	2022-09-17 23:35:34 +02:00
Andre_601	f6f3f3d8b6	Update README.md	2022-09-17 23:25:48 +02:00