Merge pull request #1253 from PlaceholderAPI/t3/enforce-cloud-update-verification

Enforce eCloud restrictions on updates

build.gradle.kts

@@ -9,7 +9,7 @@ plugins {
 }
 
 group = "me.clip"
-version = "2.12.3-DEV-${System.getProperty("BUILD_NUMBER")}"
+version = "2.12.4-DEV-${System.getProperty("BUILD_NUMBER")}"
 
 description = "An awesome placeholder provider!"
 

src/main/java/me/clip/placeholderapi/PlaceholderAPI.java

@@ -65,8 +65,8 @@ public final class PlaceholderAPI {
     @NotNull
     public static String setPlaceholders(final OfflinePlayer player,
                                          @NotNull final String text) {
-        final LocalExpansionManager manager = PlaceholderAPIPlugin.getInstance().getLocalExpansionManager();
-        return REPLACER_PERCENT.apply(text, player, manager::getExpansion, manager::resolvePlaceholderValue);
+        return REPLACER_PERCENT.apply(text, player,
+                PlaceholderAPIPlugin.getInstance().getLocalExpansionManager()::getExpansion);
     }
 
     /**
@@ -124,8 +124,8 @@ public final class PlaceholderAPI {
     @NotNull
     public static String setBracketPlaceholders(final OfflinePlayer player,
                                                 @NotNull final String text) {
-        final LocalExpansionManager manager = PlaceholderAPIPlugin.getInstance().getLocalExpansionManager();
-        return REPLACER_BRACKET.apply(text, player, manager::getExpansion, manager::resolvePlaceholderValue);
+        return REPLACER_BRACKET.apply(text, player,
+                PlaceholderAPIPlugin.getInstance().getLocalExpansionManager()::getExpansion);
     }
 
     /**

src/main/java/me/clip/placeholderapi/PlaceholderHook.java

@@ -35,40 +35,8 @@ public abstract class PlaceholderHook {
         return onPlaceholderRequest(null, params);
     }
 
-    /**
-     * Override this method when a placeholder should return a non-string value for type handling.
-     * <br>The default delegates to {@link #onPlaceholderTypeHandledRequest(Player, String)} with an online
-     * {@link Player}, matching the behavior of {@link #onRequest(OfflinePlayer, String)}.
-     *
-     * @param player Player to parse the placeholder against
-     * @param params Placeholder parameters
-     * @return Object to resolve through type handlers, or null to leave the placeholder unchanged
-     */
-    @Nullable
-    public Object onTypeHandledRequest(final OfflinePlayer player, @NotNull final String params) {
-        if (player != null && player.isOnline()) {
-            return onPlaceholderTypeHandledRequest(player.getPlayer(), params);
-        }
-
-        return onPlaceholderTypeHandledRequest(null, params);
-    }
-
     @Nullable
     public String onPlaceholderRequest(final Player player, @NotNull final String params) {
         return null;
     }
-
-    /**
-     * Override this method when a player placeholder should return a non-string value for type handling.
-     * <br>The default returns null so legacy string placeholders are only resolved through
-     * {@link #onRequest(OfflinePlayer, String)}.
-     *
-     * @param player Online player to parse the placeholder against
-     * @param params Placeholder parameters
-     * @return Object to resolve through type handlers, or null to leave the placeholder unchanged
-     */
-    @Nullable
-    public Object onPlaceholderTypeHandledRequest(final Player player, @NotNull final String params) {
-        return null;
-    }
 }

src/main/java/me/clip/placeholderapi/commands/impl/cloud/CommandECloudDownload.java

@@ -20,7 +20,6 @@
 
 package me.clip.placeholderapi.commands.impl.cloud;
 
-import java.util.Arrays;
 import java.util.List;
 import java.util.Optional;
 import java.util.stream.Stream;
@@ -39,16 +38,6 @@ public final class CommandECloudDownload extends PlaceholderCommand {
         super("download");
     }
 
-    private boolean isBlockedExpansion(String name) {
-        String env = System.getenv("PAPI_BLOCKED_EXPANSIONS");
-        if (env == null) {
-            return false;
-        }
-
-        return Arrays.stream(env.split(","))
-                .anyMatch(s -> s.equalsIgnoreCase(name));
-    }
-
     @Override
     public void evaluate(@NotNull final PlaceholderAPIPlugin plugin,
                          @NotNull final CommandSender sender, @NotNull final String alias,
@@ -59,12 +48,6 @@ public final class CommandECloudDownload extends PlaceholderCommand {
             return;
         }
 
-        if (isBlockedExpansion(params.get(0))) {
-            Msg.msg(sender,
-                    "&cThis expansion can't be downloaded.");
-            return;
-        }
-
         final CloudExpansion expansion = plugin.getCloudExpansionManager()
                 .findCloudExpansionByName(params.get(0)).orElse(null);
         if (expansion == null) {
@@ -91,11 +74,6 @@ public final class CommandECloudDownload extends PlaceholderCommand {
             }
         }
 
-        if (!version.isVerified()) {
-            Msg.msg(sender, "&cThe expansion '&f" + params.get(0) + "&c' is not verified and can only be downloaded manually from &fhttps://ecloud.placeholderapi.com");
-            return;
-        }
-
         plugin.getCloudExpansionManager().downloadExpansion(expansion, version)
                 .whenComplete((file, exception) -> {
                     if (exception != null) {

src/main/java/me/clip/placeholderapi/expansion/PlaceholderContext.java

@@ -1,33 +0,0 @@
-package me.clip.placeholderapi.expansion;
-
-import org.bukkit.entity.Player;
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
-
-public final class PlaceholderContext<T> {
-    @Nullable private final Player player;
-    @NotNull private final T type;
-    @NotNull private final String args;
-
-    public PlaceholderContext(@Nullable final Player player, @NotNull final T type,
-                              @NotNull final String args) {
-        this.player = player;
-        this.type = type;
-        this.args = args;
-    }
-
-    @Nullable
-    public Player player() {
-        return player;
-    }
-
-    @NotNull
-    public T type() {
-        return type;
-    }
-
-    @NotNull
-    public String args() {
-        return args;
-    }
-}

src/main/java/me/clip/placeholderapi/expansion/PlaceholderExpansion.java

@@ -20,7 +20,6 @@
 
 package me.clip.placeholderapi.expansion;
 
-import java.util.Collection;
 import java.util.Collections;
 import java.util.List;
 import java.util.logging.Level;
@@ -141,10 +140,6 @@ public abstract class PlaceholderExpansion extends PlaceholderHook {
                 || Bukkit.getPluginManager().getPlugin(getRequiredPlugin()) != null;
     }
 
-    public Collection<TypeHandler<?>> provideTypeHandlers() {
-        return Collections.emptyList();
-    }
-
     /**
      * Attempt to register this PlaceholderExpansion
      *

src/main/java/me/clip/placeholderapi/expansion/TypeHandler.java

@@ -1,15 +0,0 @@
-package me.clip.placeholderapi.expansion;
-
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
-
-public interface TypeHandler<T> {
-    Class<T> typeClass();
-
-    default boolean includeDerivatives() {
-        return true;
-    }
-
-    @Nullable
-    String onRequest(@NotNull final PlaceholderContext<T> context);
-}

src/main/java/me/clip/placeholderapi/expansion/manager/CloudExpansionManager.java

@@ -33,6 +33,7 @@ import java.nio.channels.Channels;
 import java.nio.channels.ReadableByteChannel;
 import java.nio.charset.StandardCharsets;
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.List;
@@ -274,6 +275,16 @@ public final class CloudExpansionManager {
     @NotNull
     public CompletableFuture<File> downloadExpansion(@NotNull final CloudExpansion expansion,
                                                      @NotNull final CloudExpansion.Version version) {
+        final String blockedExpansions = System.getenv("PAPI_BLOCKED_EXPANSIONS");
+        if (blockedExpansions != null && Arrays.stream(blockedExpansions.split(","))
+                .anyMatch(name -> name.equalsIgnoreCase(expansion.getName()))) {
+            return failedDownload("This expansion can't be downloaded.");
+        }
+
+        if (!version.isVerified()) {
+            return failedDownload("The expansion is not verified and can only be downloaded manually from https://ecloud.placeholderapi.com");
+        }
+
         final CompletableFuture<File> previous = await.get(toIndexName(expansion));
         if (previous != null) {
             return previous;
@@ -309,4 +320,10 @@ public final class CloudExpansionManager {
         return download;
     }
 
+    private CompletableFuture<File> failedDownload(String message) {
+        final CompletableFuture<File> failed = new CompletableFuture<>();
+        failed.completeExceptionally(new IllegalArgumentException(message));
+        return failed;
+    }
+
 }

src/main/java/me/clip/placeholderapi/expansion/manager/LocalExpansionManager.java

@@ -44,16 +44,19 @@ import me.clip.placeholderapi.PlaceholderAPIPlugin;
 import me.clip.placeholderapi.events.ExpansionRegisterEvent;
 import me.clip.placeholderapi.events.ExpansionUnregisterEvent;
 import me.clip.placeholderapi.events.ExpansionsLoadedEvent;
-import me.clip.placeholderapi.expansion.*;
+import me.clip.placeholderapi.expansion.Cacheable;
+import me.clip.placeholderapi.expansion.Cleanable;
+import me.clip.placeholderapi.expansion.Configurable;
+import me.clip.placeholderapi.expansion.PlaceholderExpansion;
+import me.clip.placeholderapi.expansion.Taskable;
+import me.clip.placeholderapi.expansion.VersionSpecific;
 import me.clip.placeholderapi.expansion.cloud.CloudExpansion;
 import me.clip.placeholderapi.util.FileUtil;
 import me.clip.placeholderapi.util.Futures;
 import me.clip.placeholderapi.util.Msg;
 import org.bukkit.Bukkit;
-import org.bukkit.OfflinePlayer;
 import org.bukkit.command.CommandSender;
 import org.bukkit.configuration.file.FileConfiguration;
-import org.bukkit.entity.Player;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.EventPriority;
 import org.bukkit.event.HandlerList;
@@ -83,7 +86,6 @@ public final class LocalExpansionManager implements Listener {
 
     @NotNull
     private final Map<String, PlaceholderExpansion> expansions = new ConcurrentHashMap<>();
-    private final Map<Class<?>, TypeHandler> typeHandlers = new ConcurrentHashMap<>();
     private final ReentrantLock expansionsLock = new ReentrantLock();
 
 
@@ -206,64 +208,6 @@ public final class LocalExpansionManager implements Listener {
         return Optional.empty();
     }
 
-    @Nullable
-    public String resolvePlaceholderValue(@NotNull final PlaceholderExpansion expansion, @Nullable final OfflinePlayer player,
-                                          @NotNull final String args) {
-        Object value = expansion.onRequest(player, args);
-
-        if (value != null) {
-            return (String) value;
-        }
-
-        value = expansion.onTypeHandledRequest(player, args);
-
-        if (value instanceof String) {
-            return (String) value;
-        }
-
-        if (value != null) {
-            return resolveTypeHandler(value, player, args);
-        }
-
-        return null;
-    }
-
-    @Nullable
-    public String resolveTypeHandler(@NotNull final Object value, @Nullable final OfflinePlayer player,
-                                     @NotNull final String args) {
-        TypeHandler handler = null;
-
-        for (final TypeHandler<?> typeHandler : typeHandlers.values()) {
-            if (typeHandler.typeClass() == value.getClass()) {
-                handler = typeHandler;
-            }
-        }
-
-        if (handler == null) {
-            for (final TypeHandler<?> typeHandler : typeHandlers.values()) {
-                if (typeHandler.includeDerivatives() && typeHandler.typeClass().isAssignableFrom(value.getClass())) {
-                    handler = typeHandler;
-                }
-            }
-        }
-
-        if (handler == null) {
-            Msg.warn("Failed to resolve type handler for placeholder %s and type %s", args, value.getClass().getSimpleName());
-            return null;
-        }
-
-        return handler.onRequest(new PlaceholderContext<>(player(player), value, args));
-    }
-
-    @Nullable
-    private Player player(@Nullable final OfflinePlayer player) {
-        if (player == null || !player.isOnline()) {
-            return null;
-        }
-
-        return player.getPlayer();
-    }
-
     /**
      * Attempt to register a {@link PlaceholderExpansion}
      *
@@ -284,16 +228,6 @@ public final class LocalExpansionManager implements Listener {
             return false;
         }
 
-        for (final TypeHandler<?> typeHandler : expansion.provideTypeHandlers()) {
-            if (typeHandler.typeClass().isAssignableFrom(String.class)) {
-                Msg.warn("Failed to load type handler %s from expansion %s as there is already a type handler for this type.",
-                        expansion.getIdentifier(), typeHandler.typeClass().getSimpleName());
-                continue;
-            }
-
-            typeHandlers.putIfAbsent(typeHandler.typeClass(), typeHandler);
-        }
-
         if (expansion instanceof Configurable) {
             Map<String, Object> defaults = ((Configurable) expansion).getDefaults();
             String pre = "expansions." + identifier + ".";

src/main/java/me/clip/placeholderapi/replacer/CharsReplacer.java

@@ -47,17 +47,15 @@ public final class CharsReplacer implements Replacer {
      * @param text   The raw text containing potential placeholders to be replaced.
      * @param player The {@link OfflinePlayer} to contextually parse the placeholders against.
      * May be {@code null} if no player context is available.
-     * @param lookup A function that maps a lowercase identifier string to a registered
-     * {@link PlaceholderExpansion}.
-     * @param resolver Resolves a registered {@link PlaceholderExpansion} to its replacement value.
-     * @return A string with all valid placeholders replaced by their respective values.
-     * Returns the original text if no placeholders are found.
-     */
-    @NotNull
-    @Override
-    public String apply(@NotNull final String text, @Nullable final OfflinePlayer player,
-                        @NotNull final Function<String, @Nullable PlaceholderExpansion> lookup,
-                        @NotNull final PlaceholderResolver resolver) {
+     * @param lookup A function that maps a lowercase identifier string to a registered
+     * {@link PlaceholderExpansion}.
+     * @return A string with all valid placeholders replaced by their respective values.
+     * Returns the original text if no placeholders are found.
+     */
+    @NotNull
+    @Override
+    public String apply(@NotNull final String text, @Nullable final OfflinePlayer player,
+                        @NotNull final Function<String, @Nullable PlaceholderExpansion> lookup) {
         final char head = closure.head;
         int startPlaceholder = text.indexOf(head);
 
@@ -124,10 +122,10 @@ public final class CharsReplacer implements Replacer {
 
             final PlaceholderExpansion expansion = lookup.apply(identifier.toLowerCase(Locale.ROOT));
             String replacement = null;
-
-            if (expansion != null) {
-                replacement = resolver.resolve(expansion, player, parameters);
-            }
+
+            if (expansion != null) {
+                replacement = expansion.onRequest(player, parameters);
+            }
 
             if (replacement != null) {
                 builder.append(replacement);
@@ -150,4 +148,4 @@ public final class CharsReplacer implements Replacer {
         return builder.toString();
     }
 
-}
+}

src/main/java/me/clip/placeholderapi/replacer/Replacer.java

@@ -29,26 +29,10 @@ import org.jetbrains.annotations.Nullable;
 
 public interface Replacer {
 
-    @NotNull
-    default String apply(@NotNull final String text, @Nullable final OfflinePlayer player,
-                         @NotNull final Function<String, @Nullable PlaceholderExpansion> lookup) {
-        return apply(text, player, lookup, PlaceholderExpansion::onRequest);
-    }
-
     @NotNull
     String apply(@NotNull final String text, @Nullable final OfflinePlayer player,
-                 @NotNull final Function<String, @Nullable PlaceholderExpansion> lookup,
-                 @NotNull final PlaceholderResolver resolver);
+                 @NotNull final Function<String, @Nullable PlaceholderExpansion> lookup);
 
-    @FunctionalInterface
-    interface PlaceholderResolver {
-
-        @Nullable
-        String resolve(@NotNull final PlaceholderExpansion expansion,
-                       @Nullable final OfflinePlayer player,
-                       @NotNull final String params);
-
-    }
 
     enum Closure {
         BRACKET('{', '}'),