Merge pull request #978 from JulianVennen/block-unverified-expansions

Add environment variable to override cloud_allowunverified_expansions

.github/label-commenter-config.yml

@@ -1,8 +1,8 @@
 comment:
   footer: "\
-    ----\n\n
+    ----<br><br>
-    > **Note**\n
+    > [!NOTE]<br>
-    > *This is an automated response created by a **GitHub Action***\n
+    > *This is an automated response created by a **GitHub Action***<br>
     > *Mentioning the bot won't have any effect!*
     "
 

build.gradle.kts

@@ -26,7 +26,7 @@ dependencies {
     implementation("org.bstats:bstats-bukkit:3.0.1")
     implementation("net.kyori:adventure-platform-bukkit:4.3.0")
 
-    compileOnly("org.spigotmc:spigot-api:1.19-R0.1-SNAPSHOT")
+    compileOnly("org.spigotmc:spigot-api:1.20-R0.1-SNAPSHOT")
     compileOnlyApi("org.jetbrains:annotations:23.0.0")
 
     testImplementation("org.openjdk.jmh:jmh-core:1.32")

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

@@ -20,6 +20,7 @@
 
 package me.clip.placeholderapi.commands.impl.cloud;
 
+import java.util.Arrays;
 import java.util.List;
 import java.util.Optional;
 import java.util.stream.Stream;
@@ -37,6 +38,25 @@ 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));
+  }
+
+  private boolean areUnverifiedExpansionsAllowed(@NotNull final PlaceholderAPIPlugin plugin) {
+    String env = System.getenv("PAPI_ALLOW_UNVERIFIED_EXPANSIONS");
+    if (env != null) {
+      return env.equalsIgnoreCase("true");
+    }
+
+    return plugin.getPlaceholderAPIConfig().cloudAllowUnverifiedExpansions();
+  }
+
   @Override
   public void evaluate(@NotNull final PlaceholderAPIPlugin plugin,
       @NotNull final CommandSender sender, @NotNull final String alias,
@@ -47,6 +67,12 @@ 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) {
@@ -55,6 +81,11 @@ public final class CommandECloudDownload extends PlaceholderCommand {
       return;
     }
 
+    if (!expansion.isVerified() && !this.areUnverifiedExpansionsAllowed(plugin)) {
+      Msg.msg(sender, "&cThe expansion '&f" + params.get(0) + "&c' is not verified and can only be downloaded manually from &fhttps://placeholderapi.com/ecloud");
+      return;
+    }
+
     final CloudExpansion.Version version;
     if (params.size() < 2) {
       version = expansion.getVersion(expansion.getLatestVersion());
@@ -86,9 +117,7 @@ public final class CommandECloudDownload extends PlaceholderCommand {
                   .getVersion() + "] &ato file: &f" + file.getName(),
               "&aMake sure to type &f/papi reload &ato enable your new expansion!");
 
-          plugin.getCloudExpansionManager().clean();
+          plugin.getCloudExpansionManager().load();
-          plugin.getCloudExpansionManager()
-              .fetch(plugin.getPlaceholderAPIConfig().cloudAllowUnverifiedExpansions());
         });
   }
 

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

@@ -38,9 +38,7 @@ public final class CommandECloudRefresh extends PlaceholderCommand {
   public void evaluate(@NotNull final PlaceholderAPIPlugin plugin,
       @NotNull final CommandSender sender, @NotNull final String alias,
       @NotNull @Unmodifiable final List<String> params) {
-    plugin.getCloudExpansionManager().clean();
+    plugin.getCloudExpansionManager().load();
-    plugin.getCloudExpansionManager()
-        .fetch(plugin.getPlaceholderAPIConfig().cloudAllowUnverifiedExpansions());
 
     Msg.msg(sender,
         "&aThe eCloud manager has been refreshed!");

src/main/java/me/clip/placeholderapi/commands/impl/local/CommandExpansionRegister.java

@@ -54,7 +54,7 @@ public final class CommandExpansionRegister extends PlaceholderCommand {
     final LocalExpansionManager manager = plugin.getLocalExpansionManager();
 
     final File file = new File(manager.getExpansionsFolder(), params.get(0));
-    if (!file.exists()) {
+    if (!file.exists() || !file.getParentFile().equals(manager.getExpansionsFolder())) {
       Msg.msg(sender,
           "&cThe file &f" + file.getName() + "&c doesn't exist!");
       return;

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

@@ -46,7 +46,8 @@ public enum NMSVersion {
   SPIGOT_1_18_R1("v1_18_R1"),
   SPIGOT_1_19_R1("v1_19_R1"),
   SPIGOT_1_19_R2("v1_19_R2"),
-  SPIGOT_1_19_R3("v1_19_R3");
+  SPIGOT_1_19_R3("v1_19_R3"),
+  SPIGOT_1_20_R1("v1_20_R1");
 
   private final String version;
 

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

@@ -40,6 +40,14 @@ import org.jetbrains.annotations.Nullable;
  */
 public abstract class PlaceholderExpansion extends PlaceholderHook {
 
+  /**
+   * The type is {@link Type#INTERNAL} by default.
+   * For external expansions, the type is updated on {@link me.clip.placeholderapi.expansion.manager.LocalExpansionManager#register(Class) register}.
+   * @since 2.11.4
+   */
+  @ApiStatus.Internal
+  protected Type expansionType = Type.INTERNAL;
+
   /**
    * The placeholder identifier of this expansion. May not contain {@literal %},
    * {@literal {}} or _
@@ -159,6 +167,27 @@ public abstract class PlaceholderExpansion extends PlaceholderHook {
     return PlaceholderAPIPlugin.getInstance();
   }
 
+  /**
+   * Get the type of the expansion
+   *
+   * @return the type of the expansion
+   * @since 2.11.4
+   */
+  @ApiStatus.Internal
+  public Type getExpansionType() {
+    return expansionType;
+  }
+
+  /**
+   * Set the type of the expansion
+   * @param expansionType the new type
+   * @since 2.11.4
+   */
+  @ApiStatus.Internal
+  public void setExpansionType(Type expansionType) {
+    this.expansionType = expansionType;
+  }
+
   // === Configuration ===
   
   /**
@@ -166,7 +195,7 @@ public abstract class PlaceholderExpansion extends PlaceholderHook {
    * null when not specified.
    * <br>You may use the {@link Configurable} interface to define default values set
    * 
-   * @return ConfigurationSection that this epxpansion has.
+   * @return ConfigurationSection that this expansion has.
    */
   @Nullable
   public final ConfigurationSection getConfigSection() {
@@ -394,8 +423,8 @@ public abstract class PlaceholderExpansion extends PlaceholderHook {
    */
   @Override
   public final String toString() {
-    return String.format("PlaceholderExpansion[name: '%s', author: '%s', version: '%s']", getName(),
+    return String.format("PlaceholderExpansion[name: '%s', author: '%s', version: '%s', type: '%s']", getName(),
-        getAuthor(), getVersion());
+        getAuthor(), getVersion(), getExpansionType());
   }
 
   // === Deprecated API ===
@@ -432,4 +461,19 @@ public abstract class PlaceholderExpansion extends PlaceholderHook {
   public String getLink() {
     return null;
   }
+
+  public enum Type {
+
+    /**
+     * An expansion provided by a plugin is considered internal
+     */
+    INTERNAL,
+
+    /**
+     * An expansion loaded from the expansions folder is considered external
+     */
+    EXTERNAL
+
+  }
+
 }

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

@@ -100,7 +100,7 @@ public final class CloudExpansionManager {
 
   public void load() {
     clean();
-    fetch(plugin.getPlaceholderAPIConfig().cloudAllowUnverifiedExpansions());
+    fetch();
   }
 
   public void kill() {
@@ -170,7 +170,7 @@ public final class CloudExpansionManager {
     await.clear();
   }
 
-  public void fetch(final boolean allowUnverified) {
+  public void fetch() {
     plugin.getLogger().info("Fetching available expansion information...");
 
     ASYNC_EXECUTOR.submit(
@@ -190,9 +190,6 @@ public final class CloudExpansionManager {
                   || expansion.getVersion(expansion.getLatestVersion()) == null) {
                 toRemove.add(entry.getKey());
               }
-              if (!allowUnverified && !expansion.isVerified()) {
-                toRemove.add(entry.getKey());
-              }
             }
 
             for (String name : toRemove) {
@@ -203,7 +200,7 @@ public final class CloudExpansionManager {
             plugin.getLogger().log(Level.WARNING, "Failed to download expansion information", e);
           }
 
-          // loop thru what's left on the main thread
+          // loop through what's left on the main thread
           plugin
               .getServer()
               .getScheduler()

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

@@ -187,6 +187,8 @@ public final class LocalExpansionManager implements Listener {
           return Optional.empty();
         }
       }
+
+      expansion.setExpansionType(PlaceholderExpansion.Type.EXTERNAL);
       
       if (!expansion.register()) {
         Msg.warn("Cannot load expansion %s due to an unknown issue.", expansion.getIdentifier());
@@ -209,6 +211,11 @@ public final class LocalExpansionManager implements Listener {
     return Optional.empty();
   }
 
+  /**
+   * Attempt to register a {@link PlaceholderExpansion}
+   * @param expansion the expansion to register
+   * @return if the expansion was registered
+   */
   @ApiStatus.Internal
   public boolean register(@NotNull final PlaceholderExpansion expansion) {
     final String identifier = expansion.getIdentifier().toLowerCase(Locale.ROOT);
@@ -216,10 +223,10 @@ public final class LocalExpansionManager implements Listener {
     if (!expansion.canRegister()) {
       return false;
     }
-    
+
-    if (expansions.containsKey(identifier)) {
+    // Avoid loading two external expansions with the same identifier
-      Msg.warn("Failed to load expansion %s. Identifier is already in use.",
+    if (expansion.getExpansionType() == PlaceholderExpansion.Type.EXTERNAL && expansions.containsKey(identifier)) {
-          expansion.getIdentifier());
+      Msg.warn("Failed to load external expansion %s. Identifier is already in use.", expansion.getIdentifier());
       return false;
     }
 
@@ -287,21 +294,24 @@ public final class LocalExpansionManager implements Listener {
       Bukkit.getPluginManager().registerEvents(((Listener) expansion), plugin);
     }
     
-    Msg.info("Successfully registered expansion: %s [%s]", expansion.getIdentifier(),
+    Msg.info(
-        expansion.getVersion());
+            "Successfully registered %s expansion: %s [%s]",
+            expansion.getExpansionType().name().toLowerCase(),
+            expansion.getIdentifier(),
+            expansion.getVersion()
+    );
 
     if (expansion instanceof Taskable) {
       ((Taskable) expansion).start();
     }
 
-    if (plugin.getPlaceholderAPIConfig().isCloudEnabled()) {
+    // Check eCloud for updates only if the expansion is external
-      final Optional<CloudExpansion> cloudExpansionOptional =
+    if (plugin.getPlaceholderAPIConfig().isCloudEnabled() && expansion.getExpansionType() == PlaceholderExpansion.Type.EXTERNAL) {
-          plugin.getCloudExpansionManager().findCloudExpansionByName(identifier);
+      final Optional<CloudExpansion> cloudExpansionOptional = plugin.getCloudExpansionManager().findCloudExpansionByName(identifier);
       if (cloudExpansionOptional.isPresent()) {
         CloudExpansion cloudExpansion = cloudExpansionOptional.get();
         cloudExpansion.setHasExpansion(true);
-        cloudExpansion.setShouldUpdate(
+        cloudExpansion.setShouldUpdate(!cloudExpansion.getLatestVersion().equals(expansion.getVersion()));
-            !cloudExpansion.getLatestVersion().equals(expansion.getVersion()));
       }
     }