Adding Maintenance placeholders

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

addons/banplugins/pom.xml

@@ -52,7 +52,7 @@
         </repository>
         <repository>
             <id>papermc</id>
-            <url>https://papermc.io/repo/repository/maven-public/</url>
+            <url>https://repo.papermc.io/repository/maven-public/</url>
         </repository>
         <repository>
             <id>libertybans</id>
@@ -79,7 +79,7 @@
         <dependency>
             <groupId>io.papermc.paper</groupId>
             <artifactId>paper-api</artifactId>
-            <version>1.20-R0.1-SNAPSHOT</version>
+            <version>1.21-R0.1-SNAPSHOT</version>
             <scope>provided</scope>
         </dependency>
         <dependency>

bungeecord/src/main/java/ch/andre601/advancedserverlist/bungeecord/listeners/BungeeEventWrapper.java

@@ -31,7 +31,8 @@ import ch.andre601.advancedserverlist.api.profiles.ProfileEntry;
 import ch.andre601.advancedserverlist.bungeecord.BungeeCordCore;
 import ch.andre601.advancedserverlist.bungeecord.objects.impl.BungeePlayerImpl;
 import ch.andre601.advancedserverlist.bungeecord.objects.impl.BungeeProxyImpl;
-import ch.andre601.advancedserverlist.core.events.PingEventHandler;
+import ch.andre601.advancedserverlist.core.compat.maintenance.MaintenanceUtil;
+import ch.andre601.advancedserverlist.core.compat.papi.PAPIUtil;
 import ch.andre601.advancedserverlist.core.interfaces.core.PluginCore;
 import ch.andre601.advancedserverlist.core.interfaces.events.GenericEventWrapper;
 import ch.andre601.advancedserverlist.core.objects.CachedPlayer;
@@ -137,7 +138,7 @@ public class BungeeEventWrapper implements GenericEventWrapper<Favicon, BungeePl
         if(plugin.getProxy().getPluginManager().getPlugin("Maintenance") == null)
             return false;
         
-        return PingEventHandler.getMaintenanceUtil().isMaintenanceEnabled();
+        return MaintenanceUtil.get().isMaintenanceEnabled();
     }
     
     @Override
@@ -165,10 +166,10 @@ public class BungeeEventWrapper implements GenericEventWrapper<Favicon, BungeePl
         if(plugin.getProxy().getPluginManager().getPlugin("PAPIProxyBridge") == null)
             return text;
         
-        if(!PingEventHandler.getPAPIUtil().isCompatible())
+        if(!PAPIUtil.get().isCompatible())
             return text;
         
-        String server = PingEventHandler.getPAPIUtil().getServer();
+        String server = PAPIUtil.get().getServer();
         if(server == null || server.isEmpty())
             return text;
         
@@ -176,11 +177,11 @@ public class BungeeEventWrapper implements GenericEventWrapper<Favicon, BungeePl
         if(serverInfo == null || serverInfo.getPlayers().isEmpty())
             return text;
         
-        ProxiedPlayer carrier = PingEventHandler.getPAPIUtil().getPlayer(serverInfo.getPlayers());
+        ProxiedPlayer carrier = PAPIUtil.get().getPlayer(serverInfo.getPlayers());
         if(carrier == null)
             return text;
         
-        return PingEventHandler.getPAPIUtil().parse(text, carrier.getUniqueId(), player.getUUID());
+        return PAPIUtil.get().parse(text, carrier.getUniqueId(), player.getUUID());
     }
     
     @Override

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

@@ -87,7 +87,7 @@ public class BungeeServerPlaceholders extends PlaceholderProvider{
                 if(args.length > 2)
                     yield null;
                 
-                if(args.length == 2){
+                if(args.length == 2 && args[1] != null && !args[1].isEmpty()){
                     ServerInfo info = proxy.getServers().get(args[1]);
                     if(info == null)
                         yield null;

core/pom.xml

@@ -137,7 +137,7 @@
         <dependency>
             <groupId>net.william278</groupId>
             <artifactId>papiproxybridge</artifactId>
-            <version>1.6.1</version>
+            <version>1.6.2</version>
             <scope>provided</scope>
         </dependency>
         <dependency>

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

@@ -29,6 +29,7 @@ import ch.andre601.advancedserverlist.api.AdvancedServerListAPI;
 import ch.andre601.advancedserverlist.api.PlaceholderProvider;
 import ch.andre601.advancedserverlist.core.check.UpdateChecker;
 import ch.andre601.advancedserverlist.core.commands.CommandHandler;
+import ch.andre601.advancedserverlist.core.compat.maintenance.MaintenancePlaceholder;
 import ch.andre601.advancedserverlist.core.file.FileHandler;
 import ch.andre601.advancedserverlist.core.interfaces.core.PluginCore;
 import ch.andre601.advancedserverlist.core.profiles.conditions.ProfileConditionParser;
@@ -59,7 +60,16 @@ public class AdvancedServerList<F>{
         this.commandHandler = new CommandHandler(this);
         this.playerHandler = new PlayerHandler(this);
         
-        placeholders.forEach(AdvancedServerList.getApi()::addPlaceholderProvider);
+        plugin.getPluginLogger().info("Registering internal Placeholders...");
+        
+        placeholders.forEach(this::addPlaceholder);
+        
+        if(plugin.isPluginEnabled("Maintenance")){
+            plugin.getPluginLogger().info("Found Maintenance Plugin. Registering extra Placeholder...");
+            addPlaceholder(new MaintenancePlaceholder(this));
+        }
+        
+        plugin.getPluginLogger().info("Completed internal Placeholder registration!");
         
         load();
     }
@@ -68,6 +78,10 @@ public class AdvancedServerList<F>{
         return new AdvancedServerList<>(plugin, Arrays.asList(placeholders));
     }
     
+    public static AdvancedServerListAPI getApi(){
+        return api;
+    }
+    
     public PluginCore<F> getPlugin(){
         return plugin;
     }
@@ -88,10 +102,6 @@ public class AdvancedServerList<F>{
         return version;
     }
     
-    public static AdvancedServerListAPI getApi(){
-        return api;
-    }
-    
     public ProfileConditionParser getParser(){
         return parser;
     }
@@ -195,4 +205,9 @@ public class AdvancedServerList<F>{
             version = "UNKNOWN";
         }
     }
+    
+    private void addPlaceholder(PlaceholderProvider placeholderProvider){
+        getPlugin().getPluginLogger().info("Registering %s Placeholders...", placeholderProvider.getIdentifier());
+        AdvancedServerList.getApi().addPlaceholderProvider(placeholderProvider);
+    }
 }

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

@@ -51,10 +51,6 @@ import java.util.concurrent.TimeUnit;
 
 public class UpdateChecker{
     
-    @SuppressWarnings("FieldCanBeLocal")
-    // 'https://api.modrinth.com/v2/project/advancedserverlist/version?loaders=["%s"]' URL encoded.
-    private final String url = "https://api.modrinth.com/v2/project/advancedserverlist/version?loaders=%%5B%%22%s%%22%%5D";
-    
     private final Type listType = new TypeToken<ArrayList<ModrinthVersion>>(){}.getType();
     private final Gson gson = new GsonBuilder()
         .setFieldNamingPolicy(FieldNamingPolicy.LOWER_CASE_WITH_UNDERSCORES)
@@ -151,7 +147,11 @@ public class UpdateChecker{
     }
     
     private CompletableFuture<ModrinthVersion> performUpdateCheck(){
-        String finalUrl = String.format(url, loader);
+        String finalUrl = String.format(
+            // 'https://api.modrinth.com/v2/project/advancedserverlist/version?loaders=["%s"]' URL encoded.
+            "https://api.modrinth.com/v2/project/advancedserverlist/version?loaders=%%5B%%22%s%%22%%5D",
+            loader
+        );
         
         logger.debug(UpdateChecker.class, "Checking '%s' for updates...", finalUrl);
         

core/src/main/java/ch/andre601/advancedserverlist/core/compat/maintenance/MaintenancePlaceholder.java

@@ -0,0 +1,24 @@
+package ch.andre601.advancedserverlist.core.compat.maintenance;
+
+import ch.andre601.advancedserverlist.api.PlaceholderProvider;
+import ch.andre601.advancedserverlist.api.objects.GenericPlayer;
+import ch.andre601.advancedserverlist.api.objects.GenericServer;
+import ch.andre601.advancedserverlist.core.AdvancedServerList;
+
+public class MaintenancePlaceholder extends PlaceholderProvider{
+    
+    private final AdvancedServerList<?> plugin;
+    
+    public MaintenancePlaceholder(AdvancedServerList<?> plugin){
+        super("maintenance");
+        
+        this.plugin = plugin;
+    }
+    @Override
+    public String parsePlaceholder(String placeholder, GenericPlayer player, GenericServer server){
+        if(!placeholder.equals("maintenanceEnabled") || !plugin.getPlugin().isPluginEnabled("Maintenance"))
+            return null;
+        
+        return String.valueOf(MaintenanceUtil.get().isMaintenanceEnabled());
+    }
+}

core/src/main/java/ch/andre601/advancedserverlist/core/compat/maintenance/MaintenanceUtil.java

@@ -30,12 +30,21 @@ import eu.kennytv.maintenance.api.MaintenanceProvider;
 
 public class MaintenanceUtil{
     
+    private static MaintenanceUtil instance;
+    
     private final Maintenance api;
     
-    public MaintenanceUtil(){
+    private MaintenanceUtil(){
         this.api = MaintenanceProvider.get();
     }
     
+    public static MaintenanceUtil get(){
+        if(instance != null)
+            return instance;
+        
+        return (instance = new MaintenanceUtil());
+    }
+    
     public boolean isMaintenanceEnabled(){
         return api.isMaintenance();
     }

core/src/main/java/ch/andre601/advancedserverlist/core/compat/papi/PAPIUtil.java

@@ -38,14 +38,22 @@ import java.util.concurrent.CompletionException;
 
 public class PAPIUtil{
     
-    private final PlaceholderAPI papi;
+    private static PAPIUtil instance;
     
     private final CacheUtil<String> cache = new CacheUtil<>(Duration.ofSeconds(5));
+    private final PlaceholderAPI papi;
     
-    public PAPIUtil(){
+    private PAPIUtil(){
         this.papi = PlaceholderAPI.createInstance();
     }
     
+    public static PAPIUtil get(){
+        if(instance != null)
+            return instance;
+        
+        return (instance = new PAPIUtil());
+    }
+    
     // Make sure the version of PAPIProxyBridge we get has the required methods we need...
     @SuppressWarnings("BooleanMethodIsAlwaysInverted")
     public boolean isCompatible(){

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

@@ -29,8 +29,6 @@ import ch.andre601.advancedserverlist.api.events.GenericServerListEvent;
 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.compat.papi.PAPIUtil;
 import ch.andre601.advancedserverlist.core.interfaces.PluginLogger;
 import ch.andre601.advancedserverlist.core.interfaces.core.PluginCore;
 import ch.andre601.advancedserverlist.core.interfaces.events.GenericEventWrapper;
@@ -41,9 +39,6 @@ import ch.andre601.advancedserverlist.core.profiles.replacer.StringReplacer;
 
 public class PingEventHandler{
     
-    private static PAPIUtil papiUtil = null;
-    private static MaintenanceUtil maintenanceUtil = null;
-    
     public static <F, P extends GenericPlayer> ProfileEntry handleEvent(GenericEventWrapper<F, P> event){
         event.getPlugin().getPluginLogger().debug(PingEventHandler.class, "Received ping event. Handling it...");
         if(event.isInvalidProtocol()){
@@ -169,20 +164,6 @@ public class PingEventHandler{
         return entry;
     }
     
-    public static PAPIUtil getPAPIUtil(){
-        if(papiUtil != null)
-            return papiUtil;
-        
-        return (papiUtil = new PAPIUtil());
-    }
-    
-    public static MaintenanceUtil getMaintenanceUtil(){
-        if(maintenanceUtil != null)
-            return maintenanceUtil;
-        
-        return (maintenanceUtil = new MaintenanceUtil());
-    }
-    
     private static <F, P extends GenericPlayer> boolean ignoreMaintenance(GenericEventWrapper<F, P> event, String option){
         if(!event.isMaintenanceModeActive())
             return true;

core/src/main/java/ch/andre601/advancedserverlist/core/profiles/ServerListProfile.java

@@ -56,9 +56,8 @@ public record ServerListProfile(int priority, String condition, ProfileEntry def
             for(ParseWarnCollector.Context context : collector.getWarnings()){
                 logger.warn("  - At position %s:", context.position() == -1 ? "Unknown" : context.position());
                 logger.warn("    %s", condition);
-                logger.warn(" ".repeat(context.position() + 5) + "^");
+                logger.warn(" ".repeat(context.position() + 4) + "^");
                 logger.warn("    -> %s", context.message());
-                
             }
         }
         

core/src/main/java/ch/andre601/advancedserverlist/core/profiles/replacer/StringReplacer.java

@@ -64,8 +64,6 @@ public class StringReplacer{
     
     private static String parsePlaceholder0(String input, ParsePosition position, GenericPlayer player, GenericServer server, ParseWarnCollector collector){
         AdvancedServerListAPI api = AdvancedServerList.getApi();
-        
-        int placeholderStart = position.getIndex() - 2;
         int index = position.getIndex();
         
         StringBuilder identifier = new StringBuilder();
@@ -113,7 +111,7 @@ public class StringReplacer{
                 raw.append(' ').append(valuesStr);
             
             if(collector != null)
-                collector.appendWarningFormatted(placeholderStart, "Placeholder '%s' does not have a closing bracket (})", raw.toString());
+                collector.appendWarningFormatted(index, "Placeholder '%s' does not have a closing bracket (})", raw.toString());
             
             return raw.toString();
         }
@@ -128,7 +126,7 @@ public class StringReplacer{
             raw.append('}');
             
             if(collector != null)
-                collector.appendWarningFormatted(placeholderStart, "Placeholder '%s' does not have any available PlaceholderProvider", raw.toString());
+                collector.appendWarningFormatted(index, "Placeholder '%s' does not have any available PlaceholderProvider", raw.toString());
             
             return raw.toString();
         }
@@ -143,7 +141,7 @@ public class StringReplacer{
             raw.append('}');
             
             if(collector != null)
-                collector.appendWarningFormatted(placeholderStart, "Placeholder '%s' has an invalid value String '%s'", raw.toString(), valuesStr);
+                collector.appendWarningFormatted(index, "Placeholder '%s' has an invalid value String '%s'", raw.toString(), valuesStr);
             
             return raw.toString();
         }

docs/profiles/placeholders.md

@@ -11,7 +11,7 @@ It also has built-in [PlaceholderAPI support](#placeholderapi) for Spigot and Pa
 
 The following placeholders are available in AdvancedServerList itself. Please note that not all placeholders are available on all platforms.
 
-### Player Placeholders
+### Player
 
 These placeholders use the player who pinged the server, to return values. They may require the player to be cached in order to work.
 
@@ -52,6 +52,14 @@ These placeholders use values given by the server/proxy AdvancedServerList runs
     An optional server name can be provided to display the IP/Domain associated with that server. This only works on BungeeCord or Velocity.  
     **Example:** `${server host survival}` would display the IP/Domain associated with the `survival` server.
 
+### Maintenance
+
+These placeholders require the [Maintenance](https://hangar.papermc.io/kennytv/Maintenance) plugin to work.
+
+| Placeholder                         | Description                                                    |
+|-------------------------------------|----------------------------------------------------------------|
+| `${maintenance maintenanceEnabled}` | Returns whether the Global maintenance mode is enabled or not. |
+
 ## PlaceholderAPI
 
 Please visit the [PlaceholderAPI page](../placeholderapi/index.md) for how AdvancedServerList works with PlaceholderAPI.

paper/pom.xml

@@ -46,7 +46,7 @@
     <repositories>
         <repository>
             <id>papermc</id>
-            <url>https://papermc.io/repo/repository/maven-public/</url>
+            <url>https://repo.papermc.io/repository/maven-public/</url>
         </repository>
         <repository>
             <id>placeholderapi-repo</id>
@@ -99,7 +99,7 @@
         <dependency>
             <groupId>com.viaversion</groupId>
             <artifactId>viaversion-api</artifactId>
-            <version>5.0.2</version>
+            <version>5.0.3</version>
             <scope>provided</scope>
         </dependency>
 

paper/src/main/java/ch/andre601/advancedserverlist/paper/listeners/PaperEventWrapper.java

@@ -28,7 +28,7 @@ package ch.andre601.advancedserverlist.paper.listeners;
 import ch.andre601.advancedserverlist.api.events.GenericServerListEvent;
 import ch.andre601.advancedserverlist.api.objects.GenericServer;
 import ch.andre601.advancedserverlist.api.profiles.ProfileEntry;
-import ch.andre601.advancedserverlist.core.events.PingEventHandler;
+import ch.andre601.advancedserverlist.core.compat.maintenance.MaintenanceUtil;
 import ch.andre601.advancedserverlist.core.interfaces.core.PluginCore;
 import ch.andre601.advancedserverlist.core.interfaces.events.GenericEventWrapper;
 import ch.andre601.advancedserverlist.core.objects.CachedPlayer;
@@ -126,7 +126,7 @@ public class PaperEventWrapper implements GenericEventWrapper<CachedServerIcon,
         if(!Bukkit.getPluginManager().isPluginEnabled("Maintenance"))
             return false;
         
-        return PingEventHandler.getMaintenanceUtil().isMaintenanceEnabled();
+        return MaintenanceUtil.get().isMaintenanceEnabled();
     }
     
     @Override

pom.xml

@@ -37,7 +37,7 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         
-        <plugin.version>4.12.1</plugin.version>
+        <plugin.version>4.13.0</plugin.version>
         <plugin.description>Create multiple Server lists based on conditions.</plugin.description>
         
         <api.version>3.3.0</api.version>
@@ -45,7 +45,7 @@
         <dependency.adventure-api>4.17.0</dependency.adventure-api>
         <dependency.adventure-text-minimessage>4.17.0</dependency.adventure-text-minimessage>
         <dependency.adventure-text-serializer-legacy>4.17.0</dependency.adventure-text-serializer-legacy>
-        <dependency.adventure-platform-bungeecord>4.3.3</dependency.adventure-platform-bungeecord>
+        <dependency.adventure-platform-bungeecord>4.3.4</dependency.adventure-platform-bungeecord>
         <dependency.configurate-yaml>4.1.2</dependency.configurate-yaml>
         
         <maven.compiler.source>16</maven.compiler.source>

requirements.txt

@@ -1,3 +1,3 @@
-mkdocs-material==9.5.30
+mkdocs-material==9.5.31
 mkdocs-glightbox==0.4.0
 git+https://github.com/Andre601/mkdocs-pagenav-generator

velocity/pom.xml

@@ -46,7 +46,7 @@
     <repositories>
         <repository>
             <id>velocity-repo</id>
-            <url>https://papermc.io/repo/repository/maven-public/</url>
+            <url>https://repo.papermc.io/repository/maven-public/</url>
         </repository>
     </repositories>
     

velocity/src/main/java/ch/andre601/advancedserverlist/velocity/listeners/VelocityEventWrapper.java

@@ -28,7 +28,8 @@ package ch.andre601.advancedserverlist.velocity.listeners;
 import ch.andre601.advancedserverlist.api.events.GenericServerListEvent;
 import ch.andre601.advancedserverlist.api.objects.GenericServer;
 import ch.andre601.advancedserverlist.api.profiles.ProfileEntry;
-import ch.andre601.advancedserverlist.core.events.PingEventHandler;
+import ch.andre601.advancedserverlist.core.compat.maintenance.MaintenanceUtil;
+import ch.andre601.advancedserverlist.core.compat.papi.PAPIUtil;
 import ch.andre601.advancedserverlist.core.interfaces.core.PluginCore;
 import ch.andre601.advancedserverlist.core.interfaces.events.GenericEventWrapper;
 import ch.andre601.advancedserverlist.core.objects.CachedPlayer;
@@ -44,7 +45,10 @@ import com.velocitypowered.api.proxy.server.ServerPing;
 import com.velocitypowered.api.util.Favicon;
 import net.kyori.adventure.text.Component;
 
-import java.util.*;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.UUID;
 import java.util.concurrent.ExecutionException;
 
 public class VelocityEventWrapper implements GenericEventWrapper<Favicon, VelocityPlayerImpl>{
@@ -133,7 +137,7 @@ public class VelocityEventWrapper implements GenericEventWrapper<Favicon, Veloci
         if(!plugin.getProxy().getPluginManager().isLoaded("maintenance"))
             return false;
         
-        return PingEventHandler.getMaintenanceUtil().isMaintenanceEnabled();
+        return MaintenanceUtil.get().isMaintenanceEnabled();
     }
     
     @Override
@@ -165,10 +169,10 @@ public class VelocityEventWrapper implements GenericEventWrapper<Favicon, Veloci
         if(!plugin.getProxy().getPluginManager().isLoaded("papiproxybridge"))
             return text;
         
-        if(!PingEventHandler.getPAPIUtil().isCompatible())
+        if(!PAPIUtil.get().isCompatible())
             return text;
         
-        String server = PingEventHandler.getPAPIUtil().getServer();
+        String server = PAPIUtil.get().getServer();
         if(server == null || server.isEmpty())
             return text;
         
@@ -176,11 +180,11 @@ public class VelocityEventWrapper implements GenericEventWrapper<Favicon, Veloci
         if(registeredServer == null || registeredServer.getPlayersConnected().isEmpty())
             return text;
         
-        Player carrier = PingEventHandler.getPAPIUtil().getPlayer(registeredServer.getPlayersConnected());
+        Player carrier = PAPIUtil.get().getPlayer(registeredServer.getPlayersConnected());
         if(carrier == null)
             return text;
         
-        return PingEventHandler.getPAPIUtil().parse(text, carrier.getUniqueId(), player.getUUID());
+        return PAPIUtil.get().parse(text, carrier.getUniqueId(), player.getUUID());
     }
     
     @Override

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

@@ -88,7 +88,7 @@ public class VelocityServerPlaceholders extends PlaceholderProvider{
                 if(args.length > 2)
                     yield null;
                 
-                if(args.length == 2){
+                if(args.length == 2 && args[1] != null && !args[1].isEmpty()){
                     RegisteredServer info = proxy.getServers().get(args[1]);
                     if(info == null)
                         yield null;