feat: inheritance-aware plot limits / permission ranges

Core/src/main/java/com/plotsquared/core/PlotPlatform.java

@@ -31,6 +31,7 @@ import com.plotsquared.core.generator.IndependentPlotGenerator;
 import com.plotsquared.core.inject.annotations.DefaultGenerator;
 import com.plotsquared.core.location.World;
 import com.plotsquared.core.permissions.PermissionHandler;
+import com.plotsquared.core.permissions.RangedPermissionResolver;
 import com.plotsquared.core.player.PlotPlayer;
 import com.plotsquared.core.plot.expiration.ExpireManager;
 import com.plotsquared.core.plot.world.PlotAreaManager;
@@ -349,6 +350,10 @@ public interface PlotPlatform<P> extends LocaleHolder {
         return injector().getInstance(PermissionHandler.class);
     }
 
+    default @NonNull RangedPermissionResolver rangedPermissionResolver() {
+        return injector().getInstance(RangedPermissionResolver.class);
+    }
+
     /**
      * Get the {@link ServicePipeline} implementation
      *

Core/src/main/java/com/plotsquared/core/configuration/Settings.java

@@ -525,8 +525,8 @@ public class Settings extends Config {
     public static final class Limit {
 
         @Comment("Should the limit be global (over multiple worlds)")
-        public static boolean GLOBAL =
-                false;
+        public static boolean GLOBAL = false;
+
         @Comment({"The max range of integer permissions to check for, e.g. 'plots.plot.127' or 'plots.set.flag.mob-cap.127'",
                 "The value covers the permission range to check, you need to assign the permission to players/groups still",
                 "Modifying the value does NOT change the amount of plots players can claim"})
@@ -737,6 +737,7 @@ public class Settings extends Config {
 
         @Comment("If \"instabreak\" should consider the used tool.")
         public static boolean INSTABREAK_CONSIDER_TOOL = false;
+
     }
 
     @Comment({"Enable or disable parts of the plugin",
@@ -830,4 +831,17 @@ public class Settings extends Config {
 
     }
 
+    @Comment({"Permission-Resolver specific settings"})
+    public static final class Permissions {
+
+        @Comment({
+                "use the new LuckPerms resolver for ranged permissions (e.g., plots.plot.<number>).",
+                "in contrary to the default resolver, this resolver can handle inheritance of permissions.",
+                "e.g. if the player has multiple matching permissions, for example, due to multiple group memberships " +
+                        "(plots.plot.5 & plots.plot.15), this resolver would use 15 as the limit as opposed to the previous 5."
+        })
+        public static boolean USE_LUCKPERMS_RANGE_RESOLVER = false;
+
+    }
+
 }

Core/src/main/java/com/plotsquared/core/permissions/RangedPermissionResolver.java

@@ -0,0 +1,126 @@
+/*
+ * PlotSquared, a land and world management plugin for Minecraft.
+ * Copyright (C) IntellectualSites <https://intellectualsites.com>
+ * Copyright (C) IntellectualSites team and contributors
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package com.plotsquared.core.permissions;
+
+import com.plotsquared.core.player.PlotPlayer;
+import org.checkerframework.checker.index.qual.NonNegative;
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+import java.util.stream.IntStream;
+
+/**
+ * Represents a resolver for ranged permissions. Return values depend on the actual implementation (see Bukkit module).
+ * <br>
+ * Even though this interface is not linked to platform implementations by design, implementation-specific details are added to
+ * the Javadocs.
+ *
+ * @since TODO
+ */
+public interface RangedPermissionResolver {
+
+    int INFINITE_RANGE_VALUE = Integer.MAX_VALUE;
+
+    /**
+     * Gets the applicable range value of a player for a specific permission stub
+     * ({@code plots.plot} would check for {@code plots.plot.<numeric>}).
+     * <br>
+     * The standard bukkit implementation would return the lowest numeric value, while the LuckPerms specific resolver would
+     * try returning the highest possible value.
+     *
+     * @param player       the permission holder
+     * @param stub         the permission stub to check against
+     * @param worldContext the optional world context of the action requiring the range
+     * @param range        the maximum permission range to check against (for the default bukkit resolver)
+     * @return the applicable range value of the player for the given permission stub
+     * @since TODO
+     */
+    @NonNegative
+    int getPermissionRange(
+            final @NonNull PlotPlayer<?> player,
+            final @NonNull String stub,
+            final @Nullable String worldContext,
+            final @NonNegative int range
+    );
+
+    /**
+     * Gets a stream of all applicable permission range values for the given stub. The stream is unordered by default. If a
+     * specific order is needed, use the stateful {@link IntStream#sorted()} operation.
+     * <br>
+     * The standard bukkit implementation will only return a stream containing a single value equal to
+     * {@link #getPermissionRange(PlotPlayer, String, String, int)}. For LuckPerms, all applicable node values will be in the
+     * stream.
+     *
+     * @param player       the permission holder
+     * @param stub         the permission stub to check against
+     * @param worldContext the optional world context of the action requiring the range
+     * @param range        the maximum permission range to check against (for the default bukkit resolver)
+     * @return a stream of all applicable permission range values for the given stub
+     * @since TODO
+     */
+    @NonNull
+    IntStream streamFullPermissionRange(
+            final @NonNull PlotPlayer<?> player,
+            final @NonNull String stub,
+            final @Nullable String worldContext,
+            final @NonNegative int range
+    );
+
+    /**
+     * Checks if the given player has a wildcard range for the given permission stub.
+     * <br>
+     * For example, if checking for the stub {@code plots.plot}, this method would check for:
+     * <ul>
+     *     <li>{@code *}</li>
+     *     <li>{@code plots.admin}</li>
+     *     <li>{@code plots.plot.*}</li>
+     *     <li>{@code plots.*}</li>
+     * </ul>
+     *
+     * @param player       the permission holder
+     * @param stub         the permission stub to check against
+     * @param worldContext the optional world context of the action requiring the range
+     * @return {@code true} if the player has a wildcard range for the given permission stub, else {@code false}
+     * @since TODO
+     */
+    default boolean hasWildcardRange(
+            final @NonNull PlotPlayer<?> player,
+            final @NonNull String stub,
+            final @Nullable String worldContext
+    ) {
+        if (player.hasPermission(Permission.PERMISSION_STAR) ||
+                player.hasPermission(Permission.PERMISSION_ADMIN) ||
+                player.hasPermission(worldContext, stub + ".*")) {
+            return true;
+        }
+        String node = stub;
+        while (true) {
+            int lastIndex = node.lastIndexOf('.');
+            if (lastIndex == -1) {
+                break;
+            }
+            node = node.substring(0, lastIndex);
+            if (player.hasPermission(worldContext, node + ".*")) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+}