Merge pull request 'Add debug option for log messages' (#194) from feature/add-debug into master

Reviewed-on: https://codeberg.org/Andre601/AdvancedServerList/pulls/194

.github/workflows/docs-deploy.yml

@@ -24,7 +24,7 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - name: Set up Python 3.7
-        uses: actions/setup-python@v4
+        uses: actions/setup-python@v5
         with:
           python-version: 3.x
       - name: Create/Get Cache
@@ -39,11 +39,11 @@ jobs:
       - name: Build docs
         run: mkdocs build
       - name: Configure GitHub Pages
-        uses: actions/configure-pages@v3
+        uses: actions/configure-pages@v4
       - name: Upload artifact
         uses: actions/upload-pages-artifact@v2
         with:
           path: 'site/'
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v3

.woodpecker/publish_assets.yml

@@ -4,7 +4,7 @@ when:
 
 steps:
   createFiles:
-    image: maven:3.9.5-eclipse-temurin-17
+    image: maven:3.9.6-eclipse-temurin-17
     secrets:
       - source: cb_token
         target: codeberg_api_token

bungeecord/src/main/java/ch/andre601/advancedserverlist/bungeecord/BungeeCordCore.java

@@ -46,7 +46,7 @@ public class BungeeCordCore extends Plugin implements PluginCore<Favicon>{
     
     private AdvancedServerList<Favicon> core;
     private FaviconHandler<Favicon> faviconHandler = null;
-    private final PluginLogger logger = new BungeeLogger(getLogger());
+    private final PluginLogger logger = new BungeeLogger(this);
     
     @Override
     public void onEnable(){

bungeecord/src/main/java/ch/andre601/advancedserverlist/bungeecord/logging/BungeeLogger.java

@@ -25,6 +25,7 @@
 
 package ch.andre601.advancedserverlist.bungeecord.logging;
 
+import ch.andre601.advancedserverlist.bungeecord.BungeeCordCore;
 import ch.andre601.advancedserverlist.core.interfaces.PluginLogger;
 
 import java.util.logging.Level;
@@ -32,10 +33,24 @@ import java.util.logging.Logger;
 
 public class BungeeLogger implements PluginLogger{
     
+    private final BungeeCordCore plugin;
     private final Logger logger;
     
-    public BungeeLogger(Logger logger){
-        this.logger = logger;
+    public BungeeLogger(BungeeCordCore plugin){
+        this.plugin = plugin;
+        this.logger = plugin.getLogger();
+    }
+    
+    @Override
+    public void debug(Class<?> clazz, String msg, Object... args){
+        if(plugin.isDebugEnabled())
+            info("[DEBUG] [" + clazz.getSimpleName() + "] " + msg, args);
+    }
+    
+    @Override
+    public void debugWarn(Class<?> clazz, String msg, Object... args){
+        if(plugin.isDebugEnabled())
+            warn("[DEBUG] [" + clazz.getSimpleName() + "] " + msg, args);
     }
     
     @Override

bungeecord/src/main/java/ch/andre601/advancedserverlist/bungeecord/objects/BungeeServerPlaceholders.java

@@ -60,7 +60,7 @@ public class BungeeServerPlaceholders extends PlaceholderProvider{
                         if(serverName.isEmpty())
                             continue;
                         
-                        ServerInfo info = proxy.getServers().get(serverName);
+                        ServerInfo info = proxy.getServers().get(serverName.strip());
                         if(info == null)
                             continue;
                         

core/pom.xml

@@ -41,6 +41,7 @@
     <properties>
         <maven.compiler.source>16</maven.compiler.source>
         <maven.compiler.target>16</maven.compiler.target>
+        <plugin.config.version>3</plugin.config.version>
     </properties>
     
     <repositories>

core/src/main/java/ch/andre601/advancedserverlist/core/AdvancedServerList.java

@@ -136,7 +136,7 @@ public class AdvancedServerList<F>{
         }
         
         if(getFileHandler().loadProfiles()){
-            getPlugin().getPluginLogger().info("Successfully loaded " + getFileHandler().getProfiles().size() + " profiles!");
+            getPlugin().getPluginLogger().info("Successfully loaded %d profile(s)!", getFileHandler().getProfiles().size());
         }else{
             getPlugin().getPluginLogger().warn("Unable to load profiles! Check previous lines for errors.");
             return;

core/src/main/java/ch/andre601/advancedserverlist/core/check/UpdateChecker.java

@@ -81,10 +81,12 @@ public class UpdateChecker{
                     logger.warn("Failed to look for any updates. See previous messages for reasons.");
                     return;
                 }
-        
+                
+                logger.debug(UpdateChecker.class, "Comparing versions...");
+                
                 int result = version.compare(core.getVersion());
                 switch(result){
-                    case -1 -> printUpdateBanner(version.getVersionNumber(), version.getId(), version.isRelease());
+                    case -1 -> printUpdateBanner(version);
                     case 0 -> logger.info("No new update found. You're running the latest version!");
                     case 1 -> logger.info(
                         "Your version (%s) is higher than the latest release (%s). Are you running a dev build?",
@@ -119,21 +121,31 @@ public class UpdateChecker{
     private CompletableFuture<ModrinthVersion> checkUpdate(){
         return CompletableFuture.supplyAsync(() -> {
             PluginLogger logger = core.getPlugin().getPluginLogger();
+            String finalUrl = String.format(url, loader);
+            
+            logger.debug(UpdateChecker.class, "Looking for updates on '%s'...", finalUrl);
+            
             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))
+                .url(finalUrl)
                 .header("User-Agent", "AdvancedServerList-" + loader + "/" + core.getVersion())
                 .build();
             
+            logger.debug(UpdateChecker.class, "Connecting to website...");
+            
             try(Response response = client.newCall(request).execute()){
+                logger.debug(UpdateChecker.class, "Connected! Checking response code...");
+                
                 if(!response.isSuccessful()){
                     logger.warn("Encountered a non-successful response from Modrinth! Code: %d", response.code());
                     return null;
                 }
+                
+                logger.debug(UpdateChecker.class, "Received positive response code '%d'", response.code());
     
                 ResponseBody body = response.body();
                 if(body == null){
@@ -147,6 +159,8 @@ public class UpdateChecker{
                     return null;
                 }
                 
+                logger.debug(UpdateChecker.class, "Received non-empty response body. Parsing it from JSON Array...");
+                
                 List<ModrinthVersion> list = gson.fromJson(responseString, listType);
                 if(list == null || list.isEmpty()){
                     logger.warn("Couldn't convert JSON Array into a valid list.");
@@ -155,11 +169,15 @@ public class UpdateChecker{
                 
                 ModrinthVersion version = list.get(0);
                 
+                logger.debug(UpdateChecker.class, "Found entry '%s'", version);
+                
                 if(version.getVersionNumber() == null || version.getVersionNumber().isEmpty()){
                     logger.warn("Cannot check latest version. Received version number was null/empty.");
                     return null;
                 }
                 
+                logger.debug(UpdateChecker.class, "Successfully parsed version!");
+                
                 return version;
             }catch(JsonSyntaxException ex){
                 logger.warn("Encountered invalid JSON from Response body!", ex);
@@ -171,22 +189,22 @@ public class UpdateChecker{
         });
     }
     
-    private void printUpdateBanner(String version, String versionId, boolean isRelease){
+    private void printUpdateBanner(ModrinthVersion version){
         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("Modrinth version: %s", version.getVersionNumber());
         logger.info("");
         
-        if(!isRelease){
+        if(!version.isRelease()){
             logger.info("WARNING: This release is an Alpha/Beta! It may contain");
             logger.info("         breaking changes!");
             logger.info("");
         }
         
         logger.info("You can download the latest release from here:");
-        logger.info("https://modrinth.com/plugin/advancedserverlist/version/%s", versionId);
+        logger.info("https://modrinth.com/plugin/advancedserverlist/version/%s", version.getId());
         logger.info("==================================================================");
     }
     
@@ -219,5 +237,10 @@ public class UpdateChecker{
         public int compare(String version){
             return FlexVerComparator.compare(version, versionNumber);
         }
+        
+        @Override
+        public String toString(){
+            return String.format("ModrinthVersion{id=%s,versionNumber=%s,versionType=%s}", id, versionNumber, versionNumber);
+        }
     }
 }

core/src/main/java/ch/andre601/advancedserverlist/core/events/PingEventHandler.java

@@ -30,6 +30,7 @@ import ch.andre601.advancedserverlist.api.objects.GenericPlayer;
 import ch.andre601.advancedserverlist.api.objects.GenericServer;
 import ch.andre601.advancedserverlist.api.profiles.ProfileEntry;
 import ch.andre601.advancedserverlist.core.compat.maintenance.MaintenanceUtil;
+import ch.andre601.advancedserverlist.core.interfaces.PluginLogger;
 import ch.andre601.advancedserverlist.core.interfaces.core.PluginCore;
 import ch.andre601.advancedserverlist.core.interfaces.events.GenericEventWrapper;
 import ch.andre601.advancedserverlist.core.compat.papi.PAPIUtil;
@@ -44,11 +45,17 @@ public class PingEventHandler{
     private static MaintenanceUtil maintenanceUtil = null;
     
     public static <F, P extends GenericPlayer> void handleEvent(GenericEventWrapper<F, P> event){
-        if(event.isInvalidProtocol() || event.isMaintenanceModeActive())
+        event.getPlugin().getPluginLogger().debug(PingEventHandler.class, "Received ping event. Handling it...");
+        if(event.isInvalidProtocol() || event.isMaintenanceModeActive()){
+            event.getPlugin().getPluginLogger().debug(PingEventHandler.class, "Not handling event. Either protocol was invalid of Maintenance is enabled.");
             return;
+        }
         
         PluginCore<F> plugin = event.getPlugin();
         String host = event.getVirtualHost();
+        PluginLogger logger = plugin.getPluginLogger();
+        
+        logger.debug(PingEventHandler.class, "Protocol valid. Continue handling...");
         
         int online = event.getOnlinePlayers();
         int max = event.getMaxPlayers();
@@ -61,32 +68,50 @@ public class PingEventHandler{
         
         ServerListProfile profile = ProfileManager.resolveProfile(plugin.getCore(), player, server);
         
-        if(profile == null)
+        if(profile == null){
+            logger.debugWarn(PingEventHandler.class, "Server List Profile couldn't be resolved properly. Cancelling event handling...");
             return;
+        }
+        
+        logger.debug(PingEventHandler.class, "Received valid Server List Profile. Calling PreServerListSetEvent...");
         
         GenericServerListEvent e = event.callEvent(ProfileManager.merge(profile));
-        if(e == null || e.isCancelled())
+        if(e == null || e.isCancelled()){
+            logger.debug(PingEventHandler.class, "PreServerListSetEvent was cancelled. Stopping ping handling...");
             return;
+        }
+        
+        logger.debug(PingEventHandler.class, "PreServerListSetEvent completed. Proceeding with ping handling...");
         
         ProfileEntry entry = e.getEntry();
-        if(entry.isInvalid())
+        if(entry.isInvalid()){
+            logger.debugWarn(PingEventHandler.class, "No valid ProfileEntry retrieved. Cancelling ping handling...");
             return;
+        }
         
         boolean extraPlayers = ProfileManager.checkOption(entry.extraPlayersEnabled());
         
         if(extraPlayers){
             max = online + (entry.extraPlayersCount() == null ? 0 : entry.extraPlayersCount());
+            
+            logger.debug(PingEventHandler.class, "Extra Players enabled. Applying '%d' as max player count...", max);
+            
             event.setMaxPlayers(max);
         }
         
         if(ProfileManager.checkOption(entry.maxPlayersEnabled()) && !extraPlayers){
             max = (entry.maxPlayersCount() == null) ? 0 : entry.maxPlayersCount();
+            
+            logger.debug(PingEventHandler.class, "Max Players enabled. Applying '%d' as max player count...", max);
+            
             event.setMaxPlayers(max);
         }
         
         GenericServer finalServer = event.createGenericServer(online, max, host);
         
         if(ProfileManager.checkOption(entry.motd())){
+            logger.debug(PingEventHandler.class, "MOTD set. Applying '%s'...", String.join("\\n", entry.motd()));
+            
             event.setMotd(
                 ComponentParser.list(entry.motd())
                     .modifyText(text -> StringReplacer.replace(text, player, finalServer))
@@ -98,10 +123,14 @@ public class PingEventHandler{
         boolean hidePlayers = ProfileManager.checkOption(entry.hidePlayersEnabled());
         
         if(hidePlayers){
+            logger.debug(PingEventHandler.class, "Hide Players enabled. Hiding player count...");
+            
             event.hidePlayers();
         }
         
         if(ProfileManager.checkOption(entry.playerCountText()) && !hidePlayers){
+            logger.debug(PingEventHandler.class, "Player Count Text set. Applying '%s'...", entry.playerCountText());
+            
             event.setPlayerCount(
                 ComponentParser.text(entry.playerCountText())
                     .modifyText(text -> StringReplacer.replace(text, player, finalServer))
@@ -111,14 +140,19 @@ public class PingEventHandler{
         }
         
         if(ProfileManager.checkOption(entry.players()) && !hidePlayers){
+            logger.debug(PingEventHandler.class, "Player Count Hover set. Applying '%s'...", String.join("\\n", entry.players()));
+            
             event.setPlayers(entry.players(), player, server);
         }
         
         if(ProfileManager.checkOption(entry.favicon())){
+            logger.debug(PingEventHandler.class, "Favicon set. Resolving '%s'...", entry.favicon());
+            
             String favicon = StringReplacer.replace(entry.favicon(), player, server);
             
             F fav = plugin.getFaviconHandler().getFavicon(favicon, image -> {
                 try{
+                    logger.debug(PingEventHandler.class, "Converting BufferedImage to Server or Proxy Favicon instance...");
                     return event.createFavicon(image);
                 }catch(Exception ex){
                     plugin.getPluginLogger().warn("Encountered an Exception while creating Favicon!", ex);
@@ -127,12 +161,17 @@ public class PingEventHandler{
             });
             
             if(fav == null){
+                logger.debugWarn(PingEventHandler.class, "Favicon was invalid or not yet resolved! Using default favicon of Server/Proxy...");
+                
                 event.setDefaultFavicon();
             }else{
+                logger.debug(PingEventHandler.class, "Applying favicon...");
+                
                 event.setFavicon(fav);
             }
         }
         
+        logger.debug(PingEventHandler.class, "Event handling completed. Updating Ping data...");
         event.updateEvent();
     }
     

core/src/main/java/ch/andre601/advancedserverlist/core/file/ConfigMigrator.java

@@ -25,6 +25,7 @@
 
 package ch.andre601.advancedserverlist.core.file;
 
+import ch.andre601.advancedserverlist.core.AdvancedServerList;
 import ch.andre601.advancedserverlist.core.interfaces.PluginLogger;
 import org.spongepowered.configurate.ConfigurateException;
 import org.spongepowered.configurate.ConfigurationNode;
@@ -32,16 +33,31 @@ import org.spongepowered.configurate.NodePath;
 import org.spongepowered.configurate.transformation.ConfigurationTransformation;
 import org.spongepowered.configurate.transformation.TransformAction;
 
+import java.io.IOException;
+import java.io.InputStream;
+import java.util.Properties;
+
 public class ConfigMigrator{
     
-    public static final int LATEST = 1;
+    public static final int LATEST = resolveConfigVersion();
     
     private ConfigMigrator(){}
     
     public static ConfigurationTransformation.Versioned create(){
         return ConfigurationTransformation.versionedBuilder()
             .versionKey("configVersion")
-            .addVersion(LATEST, oneToTwo())
+            .addVersion(LATEST, twoToThree())
+            .addVersion(2, oneToTwo())
+            .build();
+    }
+    
+    public static ConfigurationTransformation twoToThree(){
+        return ConfigurationTransformation.builder()
+            .addAction(NodePath.path(), ((path, value) -> {
+                value.node("debug").set(false);
+                
+                return null;
+            }))
             .build();
     }
     
@@ -67,9 +83,21 @@ public class ConfigMigrator{
             versioned.apply(node);
             final int endVersion = versioned.version(node);
             if(startVersion < endVersion)
-                logger.info("Migrated config.yml from " + startVersion + " to " + endVersion);
+                logger.info("Migrated config.yml from v" + startVersion + " to v" + endVersion);
         }
         
         return node;
     }
+    
+    private static int resolveConfigVersion(){
+        try(InputStream is = AdvancedServerList.class.getResourceAsStream("/version.properties")){
+            Properties properties = new Properties();
+            
+            properties.load(is);
+            
+            return Integer.parseInt(properties.getProperty("config-version"));
+        }catch(IOException | NumberFormatException ex){
+            return -1;
+        }
+    }
 }

core/src/main/java/ch/andre601/advancedserverlist/core/file/FileHandler.java

@@ -157,7 +157,7 @@ public class FileHandler{
                 continue;
             
             profiles.add(ServerListProfile.Builder.resolve(file.getName(), tmp, logger).build());
-            logger.info("Loaded " + file.getName());
+            logger.info("Loaded '%s'!", file.getName());
         }
         
         if(profiles.isEmpty()){
@@ -178,7 +178,7 @@ public class FileHandler{
         try{
             return loader.load();
         }catch(IOException ex){
-            logger.warn("Cannot load " + path.toFile().getName() + " due to an IOException!", ex);
+            logger.warn("Cannot load '%s' due to an IOException!", ex, path.toFile().getName());
             return null;
         }
     }
@@ -214,7 +214,7 @@ public class FileHandler{
             }
             
             Files.copy(config, configBackup.toPath(), StandardCopyOption.REPLACE_EXISTING);
-            logger.info("Saved backup as '" + configBackup.getName() + "'!");
+            logger.info("Saved backup as '%s'!", configBackup.getName());
             
             return true;
         }catch(IOException ex){

core/src/main/java/ch/andre601/advancedserverlist/core/interfaces/PluginLogger.java

@@ -27,6 +27,10 @@ package ch.andre601.advancedserverlist.core.interfaces;
 
 public interface PluginLogger{
     
+    void debug(Class<?> clazz, String msg, Object... args);
+    
+    void debugWarn(Class<?> clazz, String msg, Object... args);
+    
     void info(String msg, Object... args);
     
     void warn(String msg, Object... args);

core/src/main/java/ch/andre601/advancedserverlist/core/interfaces/core/PluginCore.java

@@ -54,4 +54,8 @@ public interface PluginCore<F>{
     String getPlatformVersion();
     
     String getLoader();
+    
+    default boolean isDebugEnabled(){
+        return getCore().getFileHandler().getBoolean("debug");
+    }
 }

core/src/main/java/ch/andre601/advancedserverlist/core/profiles/favicon/FaviconHandler.java

@@ -70,21 +70,34 @@ public class FaviconHandler<F>{
     
     private CompletableFuture<F> convert(String input, Function<BufferedImage, F> function){
         return CompletableFuture.supplyAsync(() -> {
+            core.getPlugin().getPluginLogger().debug(FaviconHandler.class, "Getting BufferedImage for input '%s'...", input);
+            
             BufferedImage img = resolveImage(core, input);
-            if(img == null)
+            if(img == null){
+                core.getPlugin().getPluginLogger().debugWarn(FaviconHandler.class, "No BufferedImage could be created!");
+                
                 return null;
+            }
+            
+            core.getPlugin().getPluginLogger().debug(FaviconHandler.class, "Received BufferedImage! Applying it...");
             
             return function.apply(img);
         }, faviconThreadPool);
     }
     
     private BufferedImage resolveImage(AdvancedServerList<F> core, String input){
+        core.getPlugin().getPluginLogger().debug(FaviconHandler.class, "Resolving favicon for input '%s'...", input);
+        
         InputStream stream;
         
         if(input.toLowerCase(Locale.ROOT).startsWith("https://")){
+            core.getPlugin().getPluginLogger().debug(FaviconHandler.class, "URL detected. Getting file from it...");
+            
             stream = getFromUrl(core, input);
         }else
         if(input.toLowerCase(Locale.ROOT).endsWith(".png")){
+            core.getPlugin().getPluginLogger().debug(FaviconHandler.class, "Image file detected. Trying to reolve it...");
+            
             File folder = core.getPlugin().getFolderPath().resolve("favicons").toFile();
             if(!folder.exists()){
                 core.getPlugin().getPluginLogger().warn("Cannot get Favicon %s from favicons folder. Folder doesn't exist!", input);
@@ -95,12 +108,16 @@ public class FaviconHandler<F>{
             
             try{
                 stream = new FileInputStream(file);
+                
+                core.getPlugin().getPluginLogger().debug(FaviconHandler.class, "Resolved image file!");
             }catch(IOException ex){
                 core.getPlugin().getPluginLogger().warn("Cannot create Favicon from File %s.", input);
                 core.getPlugin().getPluginLogger().warn("Cause: %s", ex.getMessage());
                 return null;
             }
         }else{
+            core.getPlugin().getPluginLogger().debug(FaviconHandler.class, "Possible player name/UUID detected. Using https://mc-heads.net/avatar/%s/64...", input);
+            
             stream = getFromUrl(core, "https://mc-heads.net/avatar/" + input + "/64");
         }
         
@@ -116,6 +133,8 @@ public class FaviconHandler<F>{
                 return null;
             }
             
+            core.getPlugin().getPluginLogger().debug(FaviconHandler.class, "Resizing image to 64x64 pixels...");
+            
             BufferedImage favicon = new BufferedImage(64, 64, BufferedImage.TYPE_INT_ARGB);
             Graphics2D img = favicon.createGraphics();
             
@@ -123,6 +142,7 @@ public class FaviconHandler<F>{
             img.drawImage(original, 0, 0, 64, 64, null);
             img.dispose();
             
+            core.getPlugin().getPluginLogger().debug(FaviconHandler.class, "Image resized!");
             return favicon;
         }catch(IOException ex){
             core.getPlugin().getPluginLogger().warn("Unable to create Favicon. Encountered IOException during creation.");
@@ -133,11 +153,14 @@ public class FaviconHandler<F>{
     
     private InputStream getFromUrl(AdvancedServerList<F> core, String url){
         try{
+            core.getPlugin().getPluginLogger().debug(FaviconHandler.class, "Resolving URL '%s'...", url);
+            
             URL faviconUrl = new URL(url);
             URLConnection connection = faviconUrl.openConnection();
             connection.setRequestProperty("User-Agent", "AdvancedServerList/" + core.getVersion());
             connection.connect();
             
+            core.getPlugin().getPluginLogger().debug(FaviconHandler.class, "URL resolved!");
             return connection.getInputStream();
         }catch(IOException ex){
             core.getPlugin().getPluginLogger().warn("Error while connecting to %s for Favicon creation.", url);

core/src/main/resources/config.yml

@@ -31,10 +31,21 @@ disableCache: false
 #
 checkUpdates: true
 
+#
+# Should debug mode be enabled?
+#
+# When set to true will AdvancedServerList print additional messages to the console prefixed with "[DEBUG]".
+# It is recommended to only enable this when having problems or when being told to by the plugin dev, as it could
+# otherwise cause significant spam in your console.
+#
+# Defaults to false when not present.
+#
+debug: false
+
 #
 # DO NOT EDIT!
 #
 # This is used internally to determine if the config needs to be migrated.
 # Changing or even removing this option could result in your config being broken.
 #
-config-version: 2
+config-version: ${plugin.config.version}

core/src/main/resources/version.properties

@@ -23,4 +23,5 @@
 #
 #
 
-version=${plugin.version}
+version=${plugin.version}
+config-version=${plugin.config.version}

docs/getting-started/index.md

@@ -25,12 +25,12 @@ The plugin is also available on these platforms, but not actively updated there
 [spigot]: https://www.spigotmc.org/resources/102910/
 [hangar]: https://hangar.papermc.io/Andre_601/AdvancedServerList
 
-The plugin is available for Spigot, Paper, BungeeCord, Waterfall and Velocity, and has been tested on these platforms. It may support additional forks, but this is not guaranteed.
+The plugin is available for Paper, BungeeCord, Waterfall and Velocity, and has been tested on these platforms. It may support additional forks, but this is not guaranteed.
 
-The plugin also supports these additional plugins. Depending on the platform they are used in is the plugin required.
+The plugin also supports these additional plugins. They are all optional.
 
 - [PlaceholderAPI] - Used on the Spigot and Paper server for additional Placeholder parsing.
-- - [ViaVersion] - Used on the Spigot and Paper server for additional protocol version handling.
+- [ViaVersion] - Used on the Paper server for additional protocol version handling.
 - [PAPIProxyBridge] - Used on BungeeCord, Waterfall and Velocity for PlaceholderAPI support.
 - [Maintenance] - Used to disable server list handling while maintenance is active.
 
@@ -46,11 +46,11 @@ Here is a quick table showing the jar file name with the platforms it is made fo
 
 | Jar file name                                 | Platforms             |
 |-----------------------------------------------|-----------------------|
-| `AdvancedServerList-Paper-{version}.jar`      | Spigot, Paper         |
+| `AdvancedServerList-Paper-{version}.jar`      | Paper                 |
 | `AdvancedServerList-BungeeCord-{version}.jar` | BungeeCord, Waterfall |
 | `AdvancedServerList-Velocity-{version}.jar`   | Velocity              |
 
-After you added it to your plugins folder - alongside any other dependency you may want or need - (re)start your server or proxy to enable the plugin.  
+After you added it to your plugins folder - alongside any other dependency you may want - (re)start your server or proxy to enable the plugin.  
 If everything goes well should AdvancedServerList create a folder named `AdvancedServerList` (`advancedserverlist` on Velocity) with additional files and folders inside of it.
 
 ### Folder structure
@@ -254,7 +254,8 @@ These functions include, but aren't limited to:
 
 - Setting the default name and UUID used for an unknown (Not cached) player.
 - Disabling/Enabling caching of players.
-- Disabling/Enabling checking for updates
+- Disabling/Enabling checking for updates.
+- Disabling/Enabling debug mode.
 - The config version used for migration. Don't touch this, or it may reset your config.
 
 Similar to the default.yml is this file containing comments to try and explain the settings in questions.  
@@ -295,6 +296,17 @@ disableCache: false
 #
 checkUpdates: true
 
+#
+# Should debug mode be enabled?
+#
+# When set to true will AdvancedServerList print additional messages to the console prefixed with "[DEBUG]".
+# It is recommended to only enable this when having problems or when being told to by the plugin dev, as it could
+# otherwise cause significant spam in your console.
+#
+# Defaults to false when not present.
+#
+debug: false
+
 #
 # DO NOT EDIT!
 #

paper/pom.xml

@@ -100,7 +100,7 @@
         <dependency>
             <groupId>com.viaversion</groupId>
             <artifactId>viaversion-api</artifactId>
-            <version>4.8.1</version>
+            <version>4.9.2</version>
             <scope>provided</scope>
         </dependency>
     </dependencies>

paper/src/main/java/ch/andre601/advancedserverlist/paper/PaperCore.java

@@ -46,7 +46,7 @@ import java.nio.file.Path;
 
 public class PaperCore extends JavaPlugin implements PluginCore<CachedServerIcon>{
     
-    private final PluginLogger logger = new PaperLogger(this.getLogger());
+    private final PluginLogger logger = new PaperLogger(this);
     
     private AdvancedServerList<CachedServerIcon> core;
     private FaviconHandler<CachedServerIcon> faviconHandler = null;

paper/src/main/java/ch/andre601/advancedserverlist/paper/logging/PaperLogger.java

@@ -26,16 +26,31 @@
 package ch.andre601.advancedserverlist.paper.logging;
 
 import ch.andre601.advancedserverlist.core.interfaces.PluginLogger;
+import ch.andre601.advancedserverlist.paper.PaperCore;
 
 import java.util.logging.Level;
 import java.util.logging.Logger;
 
 public class PaperLogger implements PluginLogger{
     
+    private final PaperCore plugin;
     private final Logger logger;
     
-    public PaperLogger(Logger logger){
-        this.logger = logger;
+    public PaperLogger(PaperCore plugin){
+        this.plugin = plugin;
+        this.logger = plugin.getLogger();
+    }
+    
+    @Override
+    public void debug(Class<?> clazz, String msg, Object... args){
+        if(plugin.isDebugEnabled())
+            info("[DEBUG] [" + clazz.getSimpleName() + "] " + msg, args);
+    }
+    
+    @Override
+    public void debugWarn(Class<?> clazz, String msg, Object... args){
+        if(plugin.isDebugEnabled())
+            warn("[DEBUG] [" + clazz.getSimpleName() + "] " + msg, args);
     }
     
     @Override

paper/src/main/java/ch/andre601/advancedserverlist/paper/objects/placeholders/PaperServerPlaceholders.java

@@ -54,7 +54,7 @@ public class PaperServerPlaceholders extends PlaceholderProvider{
                         if(worldName.isEmpty())
                             continue;
                         
-                        World world = paperServer.worlds().get(worldName);
+                        World world = paperServer.worlds().get(worldName.strip());
                         if(world == null)
                             continue;
                         

pom.xml

@@ -38,7 +38,7 @@
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.build.commit/>
         
-        <plugin.version>3.6.0</plugin.version>
+        <plugin.version>3.6.1</plugin.version>
         <plugin.description>Create multiple Server lists based on conditions.</plugin.description>
         
         <api.version>v3.1.0</api.version>

requirements.txt

@@ -1,4 +1,4 @@
-mkdocs-material==9.4.14
+mkdocs-material==9.5.2
 mkdocs-glightbox==0.3.5
 mkdocs-awesome-pages-plugin==2.9.2
 git+https://github.com/Andre601/mkdocs-pagenav-generator

velocity/src/main/java/ch/andre601/advancedserverlist/velocity/VelocityCore.java

@@ -61,7 +61,7 @@ public class VelocityCore implements PluginCore<Favicon>{
     
     @Inject
     public VelocityCore(ProxyServer proxy, @DataDirectory Path path, Metrics.Factory metrics){
-        this.logger = new VelocityLogger(LoggerFactory.getLogger("AdvancedServerList"));
+        this.logger = new VelocityLogger(this, LoggerFactory.getLogger("AdvancedServerList"));
         
         this.proxy = proxy;
         this.path = path;

velocity/src/main/java/ch/andre601/advancedserverlist/velocity/logging/VelocityLogger.java

@@ -26,16 +26,31 @@
 package ch.andre601.advancedserverlist.velocity.logging;
 
 import ch.andre601.advancedserverlist.core.interfaces.PluginLogger;
+import ch.andre601.advancedserverlist.velocity.VelocityCore;
 import org.slf4j.Logger;
 
 public class VelocityLogger implements PluginLogger{
     
+    private final VelocityCore plugin;
     private final Logger logger;
     
-    public VelocityLogger(Logger logger){
+    public VelocityLogger(VelocityCore plugin, Logger logger){
+        this.plugin = plugin;
         this.logger = logger;
     }
     
+    @Override
+    public void debug(Class<?> clazz, String msg, Object... args){
+        if(plugin.isDebugEnabled())
+            info("[DEBUG] [" + clazz.getSimpleName() + "] " + msg, args);
+    }
+    
+    @Override
+    public void debugWarn(Class<?> clazz, String msg, Object... args){
+        if(plugin.isDebugEnabled())
+            warn("[DEBUG] [" + clazz.getSimpleName() + "] " + msg, args);
+    }
+    
     @Override
     public void info(String msg, Object... args){
         logger.info(String.format(msg, args));

velocity/src/main/java/ch/andre601/advancedserverlist/velocity/objects/VelocityServerPlaceholders.java

@@ -58,7 +58,7 @@ public class VelocityServerPlaceholders extends PlaceholderProvider{
                         if(serverName.isEmpty())
                             continue;
                         
-                        RegisteredServer registeredServer = proxy.getServers().get(serverName);
+                        RegisteredServer registeredServer = proxy.getServers().get(serverName.strip());
                         if(registeredServer == null)
                             continue;
                         

version-uploader/pom.xml

@@ -58,7 +58,7 @@
         <dependency>
             <groupId>org.apache.httpcomponents.client5</groupId>
             <artifactId>httpclient5</artifactId>
-            <version>5.2.3</version>
+            <version>5.3</version>
             <scope>compile</scope>
         </dependency>
         <dependency>