Merge pull request #113 from TheNextLvl-net/placeholderapi

Refactored placeholder handling system

Author: NonSwag

plugin/src/main/java/net/thenextlvl/service/ServicePlugin.java

@@ -29,10 +29,11 @@
 import net.thenextlvl.service.controller.permission.SuperPermsPermissionController;
 import net.thenextlvl.service.listener.CitizensListener;
 import net.thenextlvl.service.listener.FancyNpcsListener;
-import net.thenextlvl.service.placeholder.chat.ServiceChatPlaceholderExpansion;
-import net.thenextlvl.service.placeholder.economy.ServiceBankPlaceholderExpansion;
-import net.thenextlvl.service.placeholder.economy.ServiceEconomyPlaceholderExpansion;
-import net.thenextlvl.service.placeholder.group.ServiceGroupPlaceholderExpansion;
+import net.thenextlvl.service.placeholder.api.PlaceholderExpansionBuilder;
+import net.thenextlvl.service.placeholder.chat.ServiceChatPlaceholderStore;
+import net.thenextlvl.service.placeholder.economy.ServiceBankPlaceholderStore;
+import net.thenextlvl.service.placeholder.economy.ServiceEconomyPlaceholderStore;
+import net.thenextlvl.service.placeholder.group.ServiceGroupPlaceholderStore;
 import net.thenextlvl.service.version.PluginVersionChecker;
 import net.thenextlvl.service.wrapper.VaultChatServiceWrapper;
 import net.thenextlvl.service.wrapper.VaultEconomyServiceWrapper;
@@ -52,6 +53,7 @@
 import org.jspecify.annotations.Nullable;
 
 import java.nio.file.Path;
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Locale;
 import java.util.function.Function;
@@ -105,10 +107,12 @@ public void onEnable() {
 
     private void registerPlaceholders() {
         if (getServer().getPluginManager().getPlugin("PlaceholderAPI") == null) return;
-        new ServiceBankPlaceholderExpansion(this).register();
-        new ServiceChatPlaceholderExpansion(this).register();
-        new ServiceEconomyPlaceholderExpansion(this).register();
-        new ServiceGroupPlaceholderExpansion(this).register();
+        new PlaceholderExpansionBuilder(this)
+                .registerStore(new ServiceBankPlaceholderStore(this))
+                .registerStore(new ServiceChatPlaceholderStore(this))
+                .registerStore(new ServiceEconomyPlaceholderStore(this))
+                .registerStore(new ServiceGroupPlaceholderStore(this))
+                .register();
     }
 
     public ComponentBundle bundle() {

plugin/src/main/java/net/thenextlvl/service/placeholder/ServicePlaceholderExpansion.java

@@ -0,0 +1,82 @@
+package net.thenextlvl.service.placeholder.api;
+
+import me.clip.placeholderapi.expansion.PlaceholderExpansion;
+import net.thenextlvl.service.ServicePlugin;
+import org.bukkit.OfflinePlayer;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
+
+import java.util.Collection;
+import java.util.HashSet;
+import java.util.Objects;
+import java.util.Set;
+
+@NullMarked
+public class PlaceholderExpansionBuilder extends PlaceholderExpansion {
+    private final Set<PlaceholderStore<?>> stores = new HashSet<>();
+    private final String identifier;
+
+    private String author;
+    private String version;
+
+    protected final ServicePlugin plugin;
+
+    public PlaceholderExpansionBuilder(ServicePlugin plugin, String identifier) {
+        this.author = String.join(", ", plugin.getPluginMeta().getAuthors());
+        this.version = plugin.getPluginMeta().getVersion();
+        this.identifier = identifier;
+        this.plugin = plugin;
+    }
+
+    public PlaceholderExpansionBuilder(ServicePlugin plugin) {
+        this(plugin, "serviceio");
+    }
+
+    public final PlaceholderExpansionBuilder registerStore(PlaceholderStore<?> store) {
+        if (store.isEnabled()) stores.add(store);
+        return this;
+    }
+
+    public final PlaceholderExpansionBuilder setAuthors(Collection<String> authors) {
+        this.author = String.join(", ", authors);
+        return this;
+    }
+
+    public PlaceholderExpansionBuilder setVersion(String version) {
+        this.version = version;
+        return this;
+    }
+
+    @Override
+    public boolean canRegister() {
+        return !stores.isEmpty() && super.canRegister();
+    }
+
+    @Override
+    public final String getIdentifier() {
+        return identifier;
+    }
+
+    @Override
+    public final String getAuthor() {
+        return author;
+    }
+
+    @Override
+    public String getVersion() {
+        return version;
+    }
+
+    @Override
+    public final boolean persist() {
+        return true;
+    }
+
+    @Override
+    public final @Nullable String onRequest(@Nullable OfflinePlayer player, String params) {
+        return player == null ? null : stores.stream()
+                .map(store -> store.resolve(player, params))
+                .filter(Objects::nonNull)
+                .findAny().orElse(null);
+    }
+}

plugin/src/main/java/net/thenextlvl/service/placeholder/api/PlaceholderExpansionBuilder.java

@@ -1,4 +1,4 @@
-package net.thenextlvl.service.placeholder;
+package net.thenextlvl.service.placeholder.api;
 
 import com.google.common.base.Preconditions;
 import org.bukkit.OfflinePlayer;

plugin/src/main/java/net/thenextlvl/service/placeholder/PlaceholderResolver.java renamed to plugin/src/main/java/net/thenextlvl/service/placeholder/api/PlaceholderResolver.java

@@ -0,0 +1,54 @@
+package net.thenextlvl.service.placeholder.api;
+
+import net.thenextlvl.service.ServicePlugin;
+import org.bukkit.OfflinePlayer;
+import org.jspecify.annotations.Nullable;
+
+import java.util.HashMap;
+import java.util.Map;
+import java.util.regex.Pattern;
+
+public abstract class PlaceholderStore<T> {
+    private final Map<Pattern, PlaceholderResolver> resolvers = new HashMap<>();
+    private final @Nullable T provider;
+    
+    protected final ServicePlugin plugin;
+
+    public PlaceholderStore(ServicePlugin plugin, Class<T> providerClass) {
+        this.plugin = plugin;
+        this.provider = plugin.getServer().getServicesManager().load(providerClass);
+        if (provider == null) return;
+        registerResolvers(provider);
+        plugin.getComponentLogger().info("Registered placeholders for {} ({})",
+                provider.getClass().getSimpleName(), providerClass.getSimpleName());
+    }
+
+    public final void registerResolver(Pattern pattern, PlaceholderResolver resolver) {
+        resolvers.put(pattern, resolver);
+    }
+
+    protected final void registerResolver(String regex, PlaceholderResolver resolver) {
+        resolvers.put(Pattern.compile(regex.replace("%s", "([^{}_]+)")), resolver);
+    }
+
+    protected abstract void registerResolvers(T provider);
+
+    public final @Nullable String resolve(OfflinePlayer player, String params) {
+        try {
+            for (var entry : resolvers.entrySet()) {
+                var matcher = entry.getKey().matcher(params);
+                if (!matcher.matches()) continue;
+                return entry.getValue().resolve(player, matcher);
+            }
+            return null;
+        } catch (Exception e) {
+            var name = player.getName() != null ? player.getName() : player.getUniqueId().toString();
+            plugin.getComponentLogger().warn("Failed to resolve placeholder '{}' for player {}", params, name, e);
+            return null;
+        }
+    }
+
+    public final boolean isEnabled() {
+        return provider != null;
+    }
+}

plugin/src/main/java/net/thenextlvl/service/placeholder/api/PlaceholderStore.java

@@ -3,12 +3,12 @@
 import net.thenextlvl.service.ServicePlugin;
 import net.thenextlvl.service.api.chat.ChatController;
 import net.thenextlvl.service.api.model.Display;
-import net.thenextlvl.service.placeholder.ServicePlaceholderExpansion;
+import net.thenextlvl.service.placeholder.api.PlaceholderStore;
 import org.jspecify.annotations.NullMarked;
 
 @NullMarked
-public class ServiceChatPlaceholderExpansion extends ServicePlaceholderExpansion<ChatController> {
-    public ServiceChatPlaceholderExpansion(ServicePlugin plugin) {
+public class ServiceChatPlaceholderStore extends PlaceholderStore<ChatController> {
+    public ServiceChatPlaceholderStore(ServicePlugin plugin) {
         super(plugin, ChatController.class);
     }
 

plugin/src/main/java/net/thenextlvl/service/placeholder/chat/ServiceChatPlaceholderExpansion.java renamed to plugin/src/main/java/net/thenextlvl/service/placeholder/chat/ServiceChatPlaceholderStore.java

@@ -3,15 +3,15 @@
 import net.thenextlvl.service.ServicePlugin;
 import net.thenextlvl.service.api.economy.bank.Bank;
 import net.thenextlvl.service.api.economy.bank.BankController;
-import net.thenextlvl.service.placeholder.ServicePlaceholderExpansion;
+import net.thenextlvl.service.placeholder.api.PlaceholderStore;
 import org.jspecify.annotations.NullMarked;
 
 import java.math.BigDecimal;
 import java.util.stream.Collectors;
 
 @NullMarked
-public class ServiceBankPlaceholderExpansion extends ServicePlaceholderExpansion<BankController> {
-    public ServiceBankPlaceholderExpansion(ServicePlugin plugin) {
+public class ServiceBankPlaceholderStore extends PlaceholderStore<BankController> {
+    public ServiceBankPlaceholderStore(ServicePlugin plugin) {
         super(plugin, BankController.class);
     }
 

plugin/src/main/java/net/thenextlvl/service/placeholder/economy/ServiceBankPlaceholderExpansion.java renamed to plugin/src/main/java/net/thenextlvl/service/placeholder/economy/ServiceBankPlaceholderStore.java

@@ -3,14 +3,14 @@
 import net.thenextlvl.service.ServicePlugin;
 import net.thenextlvl.service.api.economy.Account;
 import net.thenextlvl.service.api.economy.EconomyController;
-import net.thenextlvl.service.placeholder.ServicePlaceholderExpansion;
+import net.thenextlvl.service.placeholder.api.PlaceholderStore;
 import org.jspecify.annotations.NullMarked;
 
 import java.math.BigDecimal;
 
 @NullMarked
-public class ServiceEconomyPlaceholderExpansion extends ServicePlaceholderExpansion<EconomyController> {
-    public ServiceEconomyPlaceholderExpansion(ServicePlugin plugin) {
+public class ServiceEconomyPlaceholderStore extends PlaceholderStore<EconomyController> {
+    public ServiceEconomyPlaceholderStore(ServicePlugin plugin) {
         super(plugin, EconomyController.class);
     }
 

plugin/src/main/java/net/thenextlvl/service/placeholder/economy/ServiceEconomyPlaceholderExpansion.java renamed to plugin/src/main/java/net/thenextlvl/service/placeholder/economy/ServiceEconomyPlaceholderStore.java

@@ -4,14 +4,14 @@
 import net.thenextlvl.service.api.group.Group;
 import net.thenextlvl.service.api.group.GroupController;
 import net.thenextlvl.service.api.group.GroupHolder;
-import net.thenextlvl.service.placeholder.ServicePlaceholderExpansion;
+import net.thenextlvl.service.placeholder.api.PlaceholderStore;
 import org.jspecify.annotations.NullMarked;
 
 import java.util.stream.Collectors;
 
 @NullMarked
-public class ServiceGroupPlaceholderExpansion extends ServicePlaceholderExpansion<GroupController> {
-    public ServiceGroupPlaceholderExpansion(ServicePlugin plugin) {
+public class ServiceGroupPlaceholderStore extends PlaceholderStore<GroupController> {
+    public ServiceGroupPlaceholderStore(ServicePlugin plugin) {
         super(plugin, GroupController.class);
     }