Merge pull request 'Allow handling of options while Maintenance is active' (#244) from feature/configure-maintenance-support into master

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

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

@@ -30,7 +30,6 @@ import ch.andre601.advancedserverlist.core.events.PingEventHandler;
 import net.md_5.bungee.api.event.ProxyPingEvent;
 import net.md_5.bungee.api.plugin.Listener;
 import net.md_5.bungee.event.EventHandler;
-import net.md_5.bungee.event.EventPriority;
 
 public class PingEvent implements Listener{
     
@@ -41,7 +40,7 @@ public class PingEvent implements Listener{
         plugin.getProxy().getPluginManager().registerListener(plugin, this);
     }
     
-    @EventHandler(priority = EventPriority.LOW)
+    @EventHandler(priority = 90) // Maintenance has Event Priority 80, so we need to be AFTER it.
     public void onProxyPing(ProxyPingEvent event){
         PingEventHandler.handleEvent(new BungeeEventWrapper(plugin, event));
     }

core/pom.xml

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

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

@@ -46,8 +46,8 @@ public class PingEventHandler{
     
     public static <F, P extends GenericPlayer> void handleEvent(GenericEventWrapper<F, P> event){
         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.");
+        if(event.isInvalidProtocol()){
+            event.getPlugin().getPluginLogger().debug(PingEventHandler.class, "Not handling event. Protocol was invalid.");
             return;
         }
         
@@ -91,7 +91,7 @@ public class PingEventHandler{
         
         boolean extraPlayers = ProfileManager.checkOption(entry.extraPlayersEnabled());
         
-        if(extraPlayers){
+        if(extraPlayers && ignoreMaintenance(event, "extraPlayers")){
             max = online + (entry.extraPlayersCount() == null ? 0 : entry.extraPlayersCount());
             
             logger.debug(PingEventHandler.class, "Extra Players enabled. Applying '%d' as max player count...", max);
@@ -99,7 +99,7 @@ public class PingEventHandler{
             event.setMaxPlayers(max);
         }
         
-        if(ProfileManager.checkOption(entry.maxPlayersEnabled()) && !extraPlayers){
+        if(ProfileManager.checkOption(entry.maxPlayersEnabled()) && !extraPlayers && ignoreMaintenance(event, "maxPlayers")){
             max = (entry.maxPlayersCount() == null) ? 0 : entry.maxPlayersCount();
             
             logger.debug(PingEventHandler.class, "Max Players enabled. Applying '%d' as max player count...", max);
@@ -109,7 +109,7 @@ public class PingEventHandler{
         
         GenericServer finalServer = event.createGenericServer(online, max, host);
         
-        if(ProfileManager.checkOption(entry.motd())){
+        if(ProfileManager.checkOption(entry.motd()) && ignoreMaintenance(event, "motd")){
             logger.debug(PingEventHandler.class, "MOTD set. Applying '%s'...", String.join("\\n", entry.motd()));
             
             event.setMotd(
@@ -122,13 +122,13 @@ public class PingEventHandler{
         
         boolean hidePlayers = ProfileManager.checkOption(entry.hidePlayersEnabled());
         
-        if(hidePlayers){
+        if(hidePlayers && ignoreMaintenance(event, "hidePlayers")){
             logger.debug(PingEventHandler.class, "Hide Players enabled. Hiding player count...");
             
             event.hidePlayers();
         }
         
-        if(ProfileManager.checkOption(entry.playerCountText()) && !hidePlayers){
+        if(ProfileManager.checkOption(entry.playerCountText()) && !hidePlayers && ignoreMaintenance(event, "playerCountText")){
             logger.debug(PingEventHandler.class, "Player Count Text set. Applying '%s'...", entry.playerCountText());
             
             event.setPlayerCount(
@@ -139,13 +139,13 @@ public class PingEventHandler{
             );
         }
         
-        if(ProfileManager.checkOption(entry.players()) && !hidePlayers){
+        if(ProfileManager.checkOption(entry.players()) && !hidePlayers && ignoreMaintenance(event, "playerCountHover")){
             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())){
+        if(ProfileManager.checkOption(entry.favicon()) && ignoreMaintenance(event, "favicon")){
             logger.debug(PingEventHandler.class, "Favicon set. Resolving '%s'...", entry.favicon());
             
             String faviconString = StringReplacer.replace(entry.favicon(), player, server);
@@ -180,4 +180,11 @@ public class PingEventHandler{
         
         return (maintenanceUtil = new MaintenanceUtil());
     }
+    
+    private static <F, P extends GenericPlayer> boolean ignoreMaintenance(GenericEventWrapper<F, P> event, String option){
+        if(!event.isMaintenanceModeActive())
+            return true;
+        
+        return !event.getPlugin().getCore().getFileHandler().getBool(true, "disableDuringMaintenance", option);
+    }
 }

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

@@ -46,12 +46,29 @@ public class ConfigMigrator{
     public static ConfigurationTransformation.Versioned create(){
         return ConfigurationTransformation.versionedBuilder()
             .versionKey("configVersion")
-            .addVersion(LATEST, threeToFour())
+            .addVersion(LATEST, fourToFive())
+            .addVersion(4, threeToFour())
             .addVersion(3, twoToThree())
             .addVersion(2, oneToTwo())
             .build();
     }
     
+    public static ConfigurationTransformation fourToFive(){
+        return ConfigurationTransformation.builder()
+            .addAction(NodePath.path(), (path, value) -> {
+                value.node("disableDuringMaintenance", "motd").set(true);
+                value.node("disableDuringMaintenance", "favicon").set(true);
+                value.node("disableDuringMaintenance", "hidePlayers").set(true);
+                value.node("disableDuringMaintenance", "playerCountText").set(true);
+                value.node("disableDuringMaintenance", "playerCountHover").set(true);
+                value.node("disableDuringMaintenance", "extraPlayers").set(true);
+                value.node("disableDuringMaintenance", "maxPlayers").set(true);
+                
+                return null;
+            })
+            .build();
+    }
+    
     public static ConfigurationTransformation threeToFour(){
         return ConfigurationTransformation.builder()
             .addAction(NodePath.path(), (path, value) -> {

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

@@ -187,8 +187,12 @@ public class FileHandler{
         return node.node(path).getString(def);
     }
     
+    public boolean getBool(boolean def, Object... path){
+        return node.node(path).getBoolean(def);
+    }
+    
     public boolean getBoolean(Object... path){
-        return node.node(path).getBoolean();
+        return getBool(false, path);
     }
     
     public long getLong(long def, long limit, Object... path){

core/src/main/resources/config.yml

@@ -50,6 +50,42 @@ debug: false
 #
 faviconCacheTime: 1
 
+#
+# List of options that should be disabled while the Maintenance Mode of the plugin Maintenance is active.
+# Any option not listed here will NOT be disabled, meaning AdvancedServerList will continue to handle it.
+#
+# Each option defaults to true when not present, disabling said option while Maintenance is active.
+#
+disableDuringMaintenance:
+  #
+  # When true (Default), disables handling of MOTD while Maintenance is enabled.
+  #
+  motd: true
+  #
+  # When true (Default), disables handling of Favicon while Maintenance is enabled.
+  #
+  favicon: true
+  #
+  # When true (Default), disables hiding of player count while Maintenance is enabled.
+  #
+  hidePlayers: true
+  #
+  # When true (Default), disables handling of player count text while Maintenance is enabled.
+  #
+  playerCountText: true
+  #
+  # When true (Default), disables handling of player count hover while Maintenance is enabled.
+  #
+  playerCountHover: true
+  #
+  # When true (Default), disables use of extra players feature while Maintenance is enabled.
+  #
+  extraPlayers: true
+  #
+  # When true (Default), disables use of max players feature while Maintenance is enabled.
+  #
+  maxPlayers: true
+
 #
 # DO NOT EDIT!
 #

docs/.pages.yml

@@ -1,10 +0,0 @@
-nav:
-  - Home:  index.md
-  - getting-started
-  - commands
-  - profiles
-  - examples
-  - migration
-  - api
-  - addons
-  - PlaceholderAPI: placeholderapi

docs/api/.pages.yml

@@ -1,2 +0,0 @@
-nav:
-  - ...

docs/api/reference/.pages.yml

@@ -1,6 +0,0 @@
-nav:
-  - index.md
-  - api: api
-  - platform-bukkit: platform-bukkit
-  - platform-bungeecord: platform-bungeecord
-  - platform-velocity: platform-velocity

docs/api/reference/api/.pages.yml

@@ -1,3 +0,0 @@
-nav:
-  - index.md
-  - ch.andre601.advancedserverlist.api: ch.andre601.advancedserverlist.api

docs/api/reference/platform-bukkit/.pages.yml

@@ -1,3 +0,0 @@
-nav:
-  - index.md
-  - ch.andre601.advancedserverlist.api.bukkit: ch.andre601.advancedserverlist.api.bukkit

docs/api/reference/platform-bungeecord/.pages.yml

@@ -1,3 +0,0 @@
-nav:
-  - index.md
-  - ch.andre601.advancedserverlist.api.bungeecord: ch.andre601.advancedserverlist.api.bungeecord

docs/api/reference/platform-velocity/.pages.yml

@@ -1,3 +0,0 @@
-nav:
-  - index.md
-  - ch.andre601.advancedserverlist.api.velocity: ch.andre601.advancedserverlist.api.velocity

docs/index.md

@@ -58,18 +58,54 @@ All listed dependencies are optional.
 
 ## Pages
 
-- [Getting started](getting-started/index.md)
-- [Commands](commands/index.md)
-- [Profiles](profiles/index.md)
-    - [Formatting](profiles/formatting.md)
-    - [Placeholders](profiles/placeholders.md)
-- [Examples](examples/index.md)
-- [Migration](migration/index.md)
-    - [v1.5.3 to v1.6.0](migration/v1_5_3-to-v1_6_0.md)
-    - [v1.9.0 to v1.10.0](migration/v1_9_0-to-v1_10_0.md)
-- [API](api/index.md)
-    - [Changelog](api/changelog.md)
-    - [Javadocs](api/javadocs.md) (External site)
-    - [Source Code](api/source.md) (External site)
-    - [Reference](api/reference/index.md)
-- [PlaceholderAPI](placeholderapi/index.md)
+<div class="grid cards" markdown>
+
+-   [:octicons-milestone-24: **Getting Started**](getting-started/index.md)
+    
+    ----
+    
+    A simple guide on how to get started with AdvancedServerList.
+
+-   [:octicons-rel-file-path-24: **Commands**](commands/index.md)
+    
+    ----
+    
+    A list of all available commands in AdvancedServerList.
+
+-   [:octicons-note-24: **Profiles**](profiles/index.md)
+    
+    ----
+    
+    Pages containing information about the Server List Profile System and all its available options.
+
+-   [:octicons-list-unordered-24: **Examples**](examples/index.md)
+    
+    ----
+    
+    Collection of various profile examples to use for different situations.
+
+-   [:octicons-file-directory-symlink-24: **Migration**](migration/index.md)
+    
+    ----
+    
+    Pages explaining how to migrate from one version of the plugin to another.
+
+-   [:octicons-command-palette-24: **API**](api/index.md)
+    
+    ----
+    
+    Pages all about the API of AdvancedServerList.
+
+-   [:octicons-plus-circle-24: **Addons**](addons/index.md)
+    
+    ----
+    
+    Pages listing 1st-party and 3rd-party add-ons for AdvancedServerList.
+    
+-   [:material-percent: **PlaceholderAPI**](placeholderapi/index.md)
+    
+    ----
+    
+    Information about available placeholders to use in PlaceholderAPI and how to use placeholders from other plugins in AdvancedServerList using PlaceholderAPI.
+
+</div>

docs/migration/.pages.yml

@@ -1,7 +0,0 @@
-nav:
-  - index.md
-  - v3_8_0-to-v3_9_0.md
-  - v3_7_0-to-v3_8_0.md
-  - pre-v3_7_0-to-v3_7_0.md
-  - v1_9_0-to-v1_10_0.md
-  - v1_5_3-to-v1_6_0.md

docs/migration/index.md

@@ -12,6 +12,12 @@ Note that these pages only cover server list profile files. The config.yml is au
 
 <div class="grid cards" markdown>
 
+-   [**v3.8.0 to v3.9.0**](v3_8_0-to-v3_9_0.md)
+    
+    ----
+    
+    Migrate from version 3.8.0 to 3.9.0.
+
 -   [**v3.7.0 to v3.8.0**](v3_7_0-to-v3_8_0.md)
 
     ----

docs/migration/pre-v3_7_0-to-v3_7_0.md

@@ -49,8 +49,12 @@ priority: 0
 -conditions:
 -  - '${player protocol} >= 763'
 -  - '${player isWhitelisted} == true'
++# The text can all be in one line. This is only for better readability.
 +condition: |
 +  ${player protocol} >= 763 and
 +  ${player isWhitelisted}
+
+motd:
+  - 'Welcome ${player name}!'
 ```
 ///

docs/migration/v3_7_0-to-v3_8_0.md

@@ -18,7 +18,7 @@ Here is a before and after example to help visualize the change:
 ```yaml
 priority: 0
 
-conditions: '${server host} <- "survival"'
+condition: '${server host} <- "survival"'
 
 motd:
   - 'Welcome ${player name}!'

docs/migration/v3_8_0-to-v3_9_0.md

@@ -18,7 +18,7 @@ Here is a before and after example to help visualize the change:
 ```yaml
 priority: 0
 
-conditions: '${player name} ~= "Someone"'
+condition: '${player name} ~= "Someone"'
 
 motd:
   - 'Welcome ${player name}!'

mkdocs.yml

@@ -69,8 +69,6 @@ extra:
 plugins:
   - search
   - glightbox
-  - awesome-pages:
-      filename: .pages.yml
   - pagenav-generator
 
 markdown_extensions:
@@ -107,4 +105,74 @@ markdown_extensions:
 
 hooks:
   - docs/.hooks/badges.py
-  - docs/.hooks/replacer.py
+  - docs/.hooks/replacer.py
+
+nav:
+  - Home: index.md
+  - Getting Started: getting-started/index.md
+  - Commands: commands/index.md
+  - Profiles:
+    - profiles/index.md
+    - Expressions: profiles/expressions.md
+    - Formatting: profiles/formatting.md
+    - Placeholders: profiles/placeholders.md
+  - Examples: examples/index.md
+  - Migration:
+    - migration/index.md
+    - v3.8.0 to v3.9.0: migration/v3_8_0-to-v3_9_0.md
+    - v3.7.0 to v3.8.0: migration/v3_7_0-to-v3_8_0.md
+    - '< v3.7.0 to v3.7.0': migration/pre-v3_7_0-to-v3_7_0.md
+    - v1.9.0 to v1.10.0: migration/v1_9_0-to-v1_10_0.md
+    - v1.5.3 to v1.6.0: migration/v1_5_3-to-v1_6_0.md
+  - API:
+    - api/index.md
+    - Changelog: api/changelog.md
+    - Javadocs: api/javadocs.md
+    - Source Code: api/source.md
+    - Reference:
+      - api/reference/index.md
+      - api:
+        - api/reference/api/index.md
+        - ch.andre601.advancedserverlist.api:
+          - api/reference/api/ch.andre601.advancedserverlist.api/advancedserverlistapi.md
+          - api/reference/api/ch.andre601.advancedserverlist.api/placeholderprovider.md
+          - events:
+            - api/reference/api/ch.andre601.advancedserverlist.api/events/genericserverlistevent.md
+          - exceptions:
+            - api/reference/api/ch.andre601.advancedserverlist.api/exceptions/invalidplaceholderproviderexception.md
+          - objects:
+            - api/reference/api/ch.andre601.advancedserverlist.api/objects/genericplayer.md
+            - api/reference/api/ch.andre601.advancedserverlist.api/objects/genericserver.md
+            - api/reference/api/ch.andre601.advancedserverlist.api/objects/nullbool.md
+          - profiles:
+            - '<api__record></api__record> ProfileEntry':
+              - api/reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/index.md
+              - api/reference/api/ch.andre601.advancedserverlist.api/profiles/profileentry/builder.md
+      - platform-bukkit:
+        - api/reference/platform-bukkit/index.md
+        - ch.andre601.advancedserverlist.api.bukkit:
+          - events:
+            - api/reference/platform-bukkit/ch.andre601.advancedserverlist.api.bukkit/events/preserverlistsetevent.md
+          - objects:
+            - api/reference/platform-bukkit/ch.andre601.advancedserverlist.api.bukkit/objects/bukkitplayer.md
+            - api/reference/platform-bukkit/ch.andre601.advancedserverlist.api.bukkit/objects/bukkitserver.md
+      - platform-bungeecord:
+        - api/reference/platform-bungeecord/index.md
+        - ch.andre601.advancedserverlist.api.bungeecord:
+          - events:
+            - api/reference/platform-bungeecord/ch.andre601.advancedserverlist.api.bungeecord/events/preserverlistsetevent.md
+          - objects:
+            - api/reference/platform-bungeecord/ch.andre601.advancedserverlist.api.bungeecord/objects/bungeeplayer.md
+            - api/reference/platform-bungeecord/ch.andre601.advancedserverlist.api.bungeecord/objects/bungeeproxy.md
+      - platform-velocity:
+        - api/reference/platform-velocity/index.md
+        - ch.andre601.advancedserverlist.api.velocity:
+          - events:
+            - api/reference/platform-velocity/ch.andre601.advancedserverlist.api.velocity/events/preserverlistsetevent.md
+          - objects:
+            - api/reference/platform-velocity/ch.andre601.advancedserverlist.api.velocity/objects/velocityplayer.md
+            - api/reference/platform-velocity/ch.andre601.advancedserverlist.api.velocity/objects/velocityproxy.md
+  - Addons:
+    - addons/index.md
+    - BanPlugins: addons/banplugins.md
+  - PlaceholderAPI: placeholderapi/index.md

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

@@ -29,6 +29,7 @@ import ch.andre601.advancedserverlist.core.events.PingEventHandler;
 import ch.andre601.advancedserverlist.paper.PaperCore;
 import com.destroystokyo.paper.event.server.PaperServerListPingEvent;
 import org.bukkit.event.EventHandler;
+import org.bukkit.event.EventPriority;
 import org.bukkit.event.Listener;
 
 public class PingEvent implements Listener{
@@ -40,7 +41,7 @@ public class PingEvent implements Listener{
         plugin.getServer().getPluginManager().registerEvents(this, plugin);
     }
     
-    @EventHandler
+    @EventHandler(priority = EventPriority.HIGHEST) // Maintenance plugin has HIGHEST priority, so ASL needs too.
     public void onPaperServerListPing(PaperServerListPingEvent event){
         PingEventHandler.handleEvent(new PaperEventWrapper(plugin, event));
     }

pom.xml

@@ -37,7 +37,7 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         
-        <plugin.version>4.4.0</plugin.version>
+        <plugin.version>4.5.0</plugin.version>
         <plugin.description>Create multiple Server lists based on conditions.</plugin.description>
         
         <api.version>3.2.1</api.version>

requirements.txt

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

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

@@ -40,7 +40,7 @@ public class PingEvent{
         plugin.getProxy().getEventManager().register(plugin, this);
     }
     
-    @Subscribe(order = PostOrder.EARLY)
+    @Subscribe(order = PostOrder.LAST) // Maintenance has LAST priority, so ASL needs it too.
     public void onProxyPing(ProxyPingEvent event){
         PingEventHandler.handleEvent(new VelocityEventWrapper(plugin, event));
     }