Merge pull request #3406 from Multiverse/feat/papi-config

Add config options `warn-invalid-papi-format` and `invalid-papi-format-returns-blank`

Author: benwoo1110

src/main/java/org/mvplugins/multiverse/core/PlaceholderExpansionHook.java

@@ -13,6 +13,7 @@
 import org.jetbrains.annotations.Nullable;
 import org.jvnet.hk2.annotations.Service;
 
+import org.mvplugins.multiverse.core.config.CoreConfig;
 import org.mvplugins.multiverse.core.economy.MVEconomist;
 import org.mvplugins.multiverse.core.utils.MinecraftTimeFormatter;
 import org.mvplugins.multiverse.core.utils.REPatterns;
@@ -28,12 +29,17 @@
 final class PlaceholderExpansionHook extends PlaceholderExpansion {
 
     private final MultiverseCore plugin;
+    private final CoreConfig coreConfig;
     private final WorldManager worldManager;
     private final MVEconomist economist;
 
     @Inject
-    public PlaceholderExpansionHook(MultiverseCore plugin, WorldManager worldManager, MVEconomist economist) {
+    public PlaceholderExpansionHook(@NotNull MultiverseCore plugin,
+                                    @NotNull CoreConfig coreConfig,
+                                    @NotNull WorldManager worldManager,
+                                    @NotNull MVEconomist economist) {
         this.plugin = plugin;
+        this.coreConfig = coreConfig;
         this.worldManager = worldManager;
         this.economist = economist;
     }
@@ -44,6 +50,13 @@ public boolean register() {
         return super.register();
     }
 
+    @Override
+    public void warning(String msg) {
+        if (coreConfig.getWarnInvalidPapiFormat()) {
+            super.warning(msg);
+        }
+    }
+
     @Override
     public @NotNull String getIdentifier() {
         return "multiverse-core";
@@ -84,22 +97,20 @@ public boolean persist() {
 
         final var placeholder = paramsArray.remove(0).toLowerCase(Locale.ENGLISH);
 
-        String worldName = parseWorldName(offlinePlayer, paramsArray);
-        if (worldName == null) return null;
-
-        return worldManager.getWorld(worldName)
-                .onEmpty(() -> warning("Multiverse World not found: " + worldName))
+        return parseWorldName(offlinePlayer, paramsArray)
+                .flatMap(worldName -> worldManager.getWorld(worldName)
+                    .onEmpty(() -> warning("Multiverse World not found: " + worldName)))
                 .flatMap(world -> world.asLoadedWorld()
                         .flatMap(loadedWorld -> getLoadedWorldPlaceHolderValue(placeholder, paramsArray, loadedWorld))
                         .orElse(() -> getWorldPlaceHolderValue(placeholder, paramsArray, world)))
-                .getOrNull();
+                .getOrElse(() -> coreConfig.getInvalidPapiFormatReturnsBlank() ? "" : null);
     }
 
-    private @Nullable String parseWorldName(OfflinePlayer offlinePlayer, List<String> paramsArray) {
+    private @NotNull Option<String> parseWorldName(OfflinePlayer offlinePlayer, List<String> paramsArray) {
         // No world defined, get from player
         if (paramsArray.isEmpty()) {
             if (offlinePlayer instanceof Player player) {
-                return player.getWorld().getName();
+                return Option.of(player.getWorld().getName());
             } else {
                 warning("You must specify a world name for non-player placeholders");
                 return null;
@@ -110,15 +121,15 @@ public boolean persist() {
         String paramWorldName = paramsArray.get(paramsArray.size() - 1);
         if (worldManager.isWorld(paramWorldName)) {
             paramsArray.remove(paramsArray.size() - 1);
-            return paramWorldName;
+            return Option.of(paramWorldName);
         }
 
         // Param not a world, fallback to player
         if (offlinePlayer instanceof Player player) {
-            return player.getWorld().getName();
+            return Option.of(player.getWorld().getName());
         }
         warning("Multiverse World not found: " + paramWorldName);
-        return null;
+        return Option.none();
     }
 
     private @NotNull Option<String> getWorldPlaceHolderValue(@NotNull String placeholder,

src/main/java/org/mvplugins/multiverse/core/config/CoreConfig.java

@@ -493,6 +493,26 @@ public boolean isRegisterPapiHook() {
         return configHandle.get(configNodes.registerPapiHook);
     }
 
+    @ApiStatus.AvailableSince("5.5")
+    public Try<Void> setWarnInvalidPapiFormat(boolean warnInvalidPapiFormat) {
+        return configHandle.set(configNodes.warnInvalidPapiFormat, warnInvalidPapiFormat);
+    }
+
+    @ApiStatus.AvailableSince("5.5")
+    public boolean getWarnInvalidPapiFormat() {
+        return configHandle.get(configNodes.warnInvalidPapiFormat);
+    }
+
+    @ApiStatus.AvailableSince("5.5")
+    public Try<Void> setInvalidPapiFormatReturnsBlank(boolean invalidPapiFormatReturnsBlank) {
+        return configHandle.set(configNodes.invalidPapiFormatReturnsBlank, invalidPapiFormatReturnsBlank);
+    }
+
+    @ApiStatus.AvailableSince("5.5")
+    public  boolean getInvalidPapiFormatReturnsBlank() {
+        return configHandle.get(configNodes.invalidPapiFormatReturnsBlank);
+    }
+
     /**
      * {@inheritDoc}
      */

src/main/java/org/mvplugins/multiverse/core/config/CoreConfigNodes.java

@@ -390,6 +390,23 @@ private <N extends Node> N node(N node) {
             .name("register-papi-hook")
             .build());
 
+    final ConfigNode<Boolean> warnInvalidPapiFormat = node(ConfigNode.builder("messaging.warn-invalid-papi-format", Boolean.class)
+            .comment("")
+            .comment("This config option defines whether or not Multiverse should warn about invalid PlaceholderAPI formats.")
+            .comment("Only applies if PlaceholderAPI is installed, and only to multiverse placeholders.")
+            .defaultValue(true)
+            .name("warn-invalid-papi-format")
+            .build());
+
+    final ConfigNode<Boolean> invalidPapiFormatReturnsBlank = node(ConfigNode.builder("messaging.invalid-papi-format-returns-blank", Boolean.class)
+            .comment("")
+            .comment("By default, invalid formats will return the original placeholder string.")
+            .comment("This config option defines whether or not Multiverse should show invalid PlaceholderAPI formats as blank.")
+            .comment("Only applies if PlaceholderAPI is installed, and only to multiverse placeholders.")
+            .defaultValue(false)
+            .name("invalid-papi-format-returns-blank")
+            .build());
+
     final ConfigNode<Locale> defaultLocale = node(ConfigNode.builder("messaging.default-locale", Locale.class)
             .comment("")
             .comment("This config option defines the default language Multiverse should use.")

src/test/resources/configs/fresh_config.yml

@@ -36,6 +36,8 @@ messaging:
   enable-chat-prefix: false
   chat-prefix-format: '[%world%]%chat%'
   register-papi-hook: true
+  warn-invalid-papi-format: true
+  invalid-papi-format-returns-blank: false
   default-locale: en
   per-player-locale: true