GH-519 Improved PermissionResolver and added support for LuckPerms (#519)

* fabric implements PermissionResolver

* Implement support for luckperms

* Update fabric.mod.json

* Remove the declaration of accesswinder from the build script of example fabric

* Use permission service by other platforms

* Add the option to choose lazy/blocking mode for LuckPermsPermissionResolver

* Add modmenu and update icons

* Fabric platform support for PermissionService

* Add nativePermission option to LiteFabricSettings. Fix suggestions based on permissions for fabric

---------

Co-authored-by: Rollczi <[email protected]>

Author: huanmeng-qwq

.github/TODO.md

@@ -6,7 +6,7 @@ TODO
 - [x] @Async @Execute
 - [ ] @Timeout(second = 10)
 - [x] @Arg
-- [x] @Arg Option<T>
+- [x] @Arg Optional<T>
 - [ ] @Arg @Strict Option<T>
 - [x] @Arg Optional<T>
 - [x] @Arg CompletableFuture<User>
@@ -22,7 +22,7 @@ TODO
 - [x] @Arg Set<T> // for example 1, 4, 5
 - [ ] @Arg Map<K, V> // for example key1=value1, key2=value2 // do wyrzucenia chyba
 - [ ] @Suggest
-- [ ] @Literal
+- [x] @Literal
 - [x] @Validate(validator = MyValidator.class)
 - [x] @Cooldown - Określa cza s, przez który użytkownik nie może ponownie użyć danej komendy po jej wykonaniu.
 - [ ] @Cooldown(second = 10, bypass = "myplugin.bypass.cooldown", scope = CooldownScope.GLOBAL)
@@ -362,5 +362,17 @@ Command banCommand = new Command("ban")
     }
 }
 
+class Main {
+    
+    public static void main(String[] args) {
+        
+      LiteCommands liteCommands = LiteBukkitPlatform.create()
+         .commands(new BanCommand())
+         .argument();
+      
+      
+    }
+    
+}
 
 ```

buildSrc/src/main/kotlin/Versions.kt

@@ -52,4 +52,7 @@ object Versions {
     const val HIBERNATE_VALIDATOR = "8.0.2.Final"
     const val EXPRESSLY = "5.0.0"
 
+    // LuckPerms
+    const val LUCKPERMS_API = "5.4"
+
 }

examples/fabric/build.gradle.kts

@@ -12,6 +12,8 @@ repositories {
     mavenCentral()
     maven("https://repo.panda-lang.org/releases/")
     maven("https://maven.fabricmc.net/")
+    maven("https://api.modrinth.com/maven")
+    maven("https://maven.terraformersmc.com/releases/")
 }
 
 dependencies {
@@ -21,12 +23,17 @@ dependencies {
     modImplementation("net.fabricmc:fabric-loader:0.16.7")
     modImplementation("net.fabricmc.fabric-api:fabric-api:0.106.0+1.21.1")
 
-//    modImplementation("dev.rollczi:litecommands-fabric:3.9.7") // <-- uncomment in your project
-    implementation(project(path = ":litecommands-fabric", configuration = "namedElements"))
+    modLocalRuntime("maven.modrinth:fabric-permissions-api:0.3.3")
+    modLocalRuntime("maven.modrinth:luckperms:v5.4.140-fabric")
+    modLocalRuntime("com.terraformersmc:modmenu:11.0.3")
 
+    // modImplementation("dev.rollczi:litecommands-fabric:3.9.7") <-- uncomment in your project
+    // modImplementation("dev.rollczi:litecommands-luckperms:3.9.7") <-- uncomment in your project
+    implementation(project(path = ":litecommands-fabric", configuration = "namedElements")) // <-- REMOVE THIS
+    implementation(project(":litecommands-luckperms")) // <-- REMOVE THIS
 }
 
 sourceSets.test {
     java.setSrcDirs(emptyList<String>())
     resources.setSrcDirs(emptyList<String>())
-}
+}

examples/fabric/src/main/java/dev/rollczi/example/fabric/server/ServerExampleFabric.java

@@ -2,13 +2,15 @@
 
 import dev.rollczi.example.fabric.server.command.ExampleCommand;
 import dev.rollczi.litecommands.fabric.LiteFabricFactory;
+import dev.rollczi.litecommands.luckperms.LuckPermsPermissionResolver;
 import net.fabricmc.api.DedicatedServerModInitializer;
 
 public class ServerExampleFabric implements DedicatedServerModInitializer {
     @Override
     public void onInitializeServer() {
         LiteFabricFactory.server()
-                .commands(new ExampleCommand())
-                .build();
+            .permissionResolver(LuckPermsPermissionResolver.lazy())
+            .commands(new ExampleCommand())
+            .build();
     }
 }

examples/fabric/src/main/java/dev/rollczi/example/fabric/server/command/ExampleCommand.java

@@ -3,9 +3,12 @@
 import dev.rollczi.litecommands.annotations.argument.Arg;
 import dev.rollczi.litecommands.annotations.async.Async;
 import dev.rollczi.litecommands.annotations.command.Command;
+import dev.rollczi.litecommands.annotations.context.Context;
 import dev.rollczi.litecommands.annotations.execute.Execute;
 import dev.rollczi.litecommands.annotations.join.Join;
+import dev.rollczi.litecommands.annotations.permission.Permission;
 import dev.rollczi.litecommands.annotations.quoted.Quoted;
+import dev.rollczi.litecommands.platform.PlatformSender;
 import net.minecraft.server.network.ServerPlayerEntity;
 import net.minecraft.text.Text;
 
@@ -31,4 +34,11 @@ String thread1() {
     String thread2() {
         return Thread.currentThread().getName();
     }
+
+    @Execute(name = "admin")
+    @Permission("permission.admin")
+    String admin(@Context PlatformSender sender) {
+        return "Hi " + sender.getName() + ", you have permission!";
+    }
+
 }

examples/fabric/src/main/resources/assets/litecommands/icon.png

@@ -21,5 +21,8 @@
         "client": [
             "dev.rollczi.example.fabric.client.ClientExampleFabric"
         ]
+    },
+    "depends": {
+        "luckperms": "*"
     }
 }

examples/fabric/src/main/resources/fabric.mod.json

@@ -7,6 +7,7 @@
 
 import java.lang.annotation.Annotation;
 
+@Deprecated
 @FunctionalInterface
 public interface AnnotatedValidator<SENDER, T, A extends Annotation> {
 

litecommands-annotations/src/dev/rollczi/litecommands/annotations/validator/requirment/AnnotatedValidator.java

@@ -6,6 +6,7 @@
 
 import java.lang.annotation.Annotation;
 
+@Deprecated
 public class AnnotatedValidatorProcessor<SENDER, T, A extends Annotation> implements AnnotationProcessor<SENDER> {
 
     private final Class<A> annotationClass;

litecommands-annotations/src/dev/rollczi/litecommands/annotations/validator/requirment/AnnotatedValidatorProcessor.java

@@ -8,6 +8,7 @@
 
 import java.lang.annotation.Annotation;
 
+@Deprecated
 class RequirementAnnotatedValidatorImpl<SENDER, T, A extends Annotation> implements RequirementValidator<SENDER, T> {
 
     private final AnnotatedValidator<SENDER, T, A> validator;

litecommands-annotations/src/dev/rollczi/litecommands/annotations/validator/requirment/RequirementAnnotatedValidatorImpl.java

@@ -4,6 +4,7 @@
 import dev.rollczi.litecommands.command.CommandRoute;
 import dev.rollczi.litecommands.invocation.Invocation;
 import dev.rollczi.litecommands.permission.MissingPermissions;
+import dev.rollczi.litecommands.permission.PermissionService;
 import dev.rollczi.litecommands.platform.PlatformInvocationListener;
 import dev.rollczi.litecommands.platform.PlatformSender;
 import dev.rollczi.litecommands.platform.PlatformSuggestionListener;
@@ -31,14 +32,17 @@ public class BukkitCommand extends Command {
     private final CommandRoute<CommandSender> commandRoute;
     private final PlatformInvocationListener<CommandSender> invocationHook;
     private final PlatformSuggestionListener<CommandSender> suggestionHook;
+    private final PermissionService permissionService;
+
     private boolean syncTabComplete = false;
 
-    BukkitCommand(LiteBukkitSettings settings, CommandRoute<CommandSender> commandRoute, PlatformInvocationListener<CommandSender> invocationHook, PlatformSuggestionListener<CommandSender> suggestionHook) {
+    BukkitCommand(LiteBukkitSettings settings, CommandRoute<CommandSender> commandRoute, PlatformInvocationListener<CommandSender> invocationHook, PlatformSuggestionListener<CommandSender> suggestionHook, PermissionService permissionService) {
         super(commandRoute.getName(), "", "/" + commandRoute.getName(), commandRoute.getAliases());
         this.settings = settings;
         this.commandRoute = commandRoute;
         this.invocationHook = invocationHook;
         this.suggestionHook = suggestionHook;
+        this.permissionService = permissionService;
     }
 
     public void setSyncTabComplete(boolean syncTabComplete) {
@@ -50,7 +54,7 @@ public boolean execute(@NotNull CommandSender sender, @NotNull String alias, Str
         ParseableInput<?> input = ParseableInput.raw(args);
         PlatformSender platformSender = new BukkitPlatformSender(sender);
 
-        this.invocationHook.execute(new Invocation<>(sender, platformSender, commandRoute.getName(), alias, input), input);
+        this.invocationHook.execute(new Invocation<>(platformSender, commandRoute.getName(), alias, input), input);
         return true;
     }
 
@@ -83,7 +87,7 @@ public boolean execute(@NotNull CommandSender sender, @NotNull String alias, Str
     public CompletableFuture<Set<Suggestion>> suggest(CommandSender sender, String alias, String[] args) {
         SuggestionInput<?> input = SuggestionInput.raw(args);
         PlatformSender platformSender = new BukkitPlatformSender(sender);
-        Invocation<CommandSender> invocation = new Invocation<>(sender, platformSender, commandRoute.getName(), alias, input);
+        Invocation<CommandSender> invocation = new Invocation<>(platformSender, commandRoute.getName(), alias, input);
 
         return CompletableFuture.completedFuture(this.suggestionHook.suggest(invocation, input).getSuggestions()); // TODO Run suggestion asynchronously inside LiteCommands platform
     }
@@ -94,9 +98,7 @@ public boolean testPermissionSilent(@NotNull CommandSender target) {
             return super.testPermissionSilent(target);
         }
 
-        MissingPermissions check = MissingPermissions.check(new BukkitPlatformSender(target), commandRoute);
-
-        return check.isPermitted();
+        return permissionService.isPermitted(new BukkitPlatformSender(target), commandRoute);
     }
 
     public CommandRoute<CommandSender> getCommandRoute() {

litecommands-bukkit/src/dev/rollczi/litecommands/bukkit/BukkitCommand.java

@@ -1,6 +1,7 @@
 package dev.rollczi.litecommands.bukkit;
 
 import dev.rollczi.litecommands.command.CommandRoute;
+import dev.rollczi.litecommands.permission.PermissionService;
 import dev.rollczi.litecommands.platform.AbstractSimplePlatform;
 import dev.rollczi.litecommands.platform.Platform;
 import dev.rollczi.litecommands.platform.PlatformInvocationListener;
@@ -9,13 +10,16 @@
 
 class BukkitPlatform extends AbstractSimplePlatform<CommandSender, LiteBukkitSettings> implements Platform<CommandSender, LiteBukkitSettings> {
 
-    BukkitPlatform(LiteBukkitSettings settings) {
+    private final PermissionService permissionService;
+
+    BukkitPlatform(LiteBukkitSettings settings, PermissionService permissionService) {
         super(settings, sender -> new BukkitPlatformSender(sender));
+        this.permissionService = permissionService;
     }
 
     @Override
     protected void hook(CommandRoute<CommandSender> commandRoute, PlatformInvocationListener<CommandSender> invocationHook, PlatformSuggestionListener<CommandSender> suggestionHook) {
-        BukkitCommand bukkitSimpleCommand = new BukkitCommand(settings, commandRoute, invocationHook, suggestionHook);
+        BukkitCommand bukkitSimpleCommand = new BukkitCommand(settings, commandRoute, invocationHook, suggestionHook, permissionService);
 
         this.settings.tabCompleter().register(settings.fallbackPrefix(), bukkitSimpleCommand);
         this.settings.commandsRegistry().register(commandRoute.getName(), settings.fallbackPrefix(), bukkitSimpleCommand);

litecommands-bukkit/src/dev/rollczi/litecommands/bukkit/BukkitPlatform.java

@@ -15,11 +15,6 @@ public BukkitPlatformSender(CommandSender handle) {
         this.handle = handle;
     }
 
-    @Override
-    public boolean hasPermission(String permission) {
-        return this.handle.hasPermission(permission);
-    }
-
     @Override
     public String getName() {
         return this.handle.getName();
@@ -49,9 +44,13 @@ public Identifier getIdentifier() {
     }
 
     @Override
-    public Comparable<Void> sendMessage(String message) {
+    public Object getHandle() {
+        return this.handle;
+    }
+
+    @Override
+    public void sendMessage(String message) {
         this.handle.sendMessage(message);
-        return null;
     }
 
 }

litecommands-bukkit/src/dev/rollczi/litecommands/bukkit/BukkitPlatformSender.java

@@ -1,5 +1,6 @@
 package dev.rollczi.litecommands.bukkit;
 
+import dev.rollczi.litecommands.LiteCommandsBaseBuilder;
 import dev.rollczi.litecommands.LiteCommandsBuilder;
 import dev.rollczi.litecommands.LiteCommandsFactory;
 import dev.rollczi.litecommands.bukkit.argument.LocationArgument;
@@ -14,6 +15,9 @@
 import dev.rollczi.litecommands.bukkit.context.WorldContext;
 import dev.rollczi.litecommands.bukkit.util.BukkitFallbackPrefixUtil;
 import dev.rollczi.litecommands.message.MessageRegistry;
+import dev.rollczi.litecommands.permission.PermissionResolver;
+import dev.rollczi.litecommands.platform.Platform;
+import dev.rollczi.litecommands.platform.PlatformSettings;
 import dev.rollczi.litecommands.reflect.type.TypeRange;
 import org.bukkit.Location;
 import org.bukkit.OfflinePlayer;
@@ -25,6 +29,7 @@
 import org.bukkit.plugin.Plugin;
 import org.bukkit.plugin.java.JavaPlugin;
 import org.bukkit.scheduler.BukkitScheduler;
+import org.jetbrains.annotations.NotNull;
 
 public final class LiteBukkitFactory {
 
@@ -56,12 +61,20 @@ public static <B extends LiteCommandsBuilder<CommandSender, LiteBukkitSettings,
         return builder(plugin, server, settings);
     }
 
+
     @SuppressWarnings("unchecked")
     public static <B extends LiteCommandsBuilder<CommandSender, LiteBukkitSettings, B>> B builder(Plugin plugin, Server server, LiteBukkitSettings settings) {
-        return (B) LiteCommandsFactory.builder(CommandSender.class, new BukkitPlatform(settings)).self((builder, internal) -> {
+        return (B) builder0(plugin, server, settings);
+    }
+
+    @SuppressWarnings("unchecked")
+    private static <B extends LiteCommandsBaseBuilder<CommandSender, LiteBukkitSettings, B>> B builder0(Plugin plugin, Server server, LiteBukkitSettings settings) {
+        return LiteCommandsFactory.<CommandSender, LiteBukkitSettings, B>builder(CommandSender.class, builder -> new BukkitPlatform(settings, builder.getPermissionService())).self((builder, internal) -> {
             MessageRegistry<CommandSender> messageRegistry = internal.getMessageRegistry();
 
             builder
+                .permissionResolver(PermissionResolver.createDefault(CommandSender.class, (sender, permission) -> sender.hasPermission(permission)))
+
                 .bind(Plugin.class, () -> plugin)
                 .bind(Server.class, () -> server)
                 .bind(BukkitScheduler.class, () -> server.getScheduler())

litecommands-bukkit/src/dev/rollczi/litecommands/bukkit/LiteBukkitFactory.java

@@ -5,6 +5,7 @@
 import dev.rollczi.litecommands.invocation.Invocation;
 import dev.rollczi.litecommands.meta.Meta;
 import dev.rollczi.litecommands.permission.MissingPermissions;
+import dev.rollczi.litecommands.permission.PermissionService;
 import dev.rollczi.litecommands.platform.PlatformInvocationListener;
 import dev.rollczi.litecommands.platform.PlatformSuggestionListener;
 import dev.rollczi.litecommands.argument.suggester.input.SuggestionInput;
@@ -17,14 +18,16 @@
 class BungeeCommand extends Command implements TabExecutor {
 
     private final LiteBungeeSettings settings;
+    private final PermissionService permissionService;
     private final CommandRoute<CommandSender> commandSection;
     private final String label;
     private final PlatformInvocationListener<CommandSender> executeListener;
     private final PlatformSuggestionListener<CommandSender> suggestionListener;
 
-    public BungeeCommand(LiteBungeeSettings settings, CommandRoute<CommandSender> command, String label, PlatformInvocationListener<CommandSender> executeListener, PlatformSuggestionListener<CommandSender> suggestionListener) {
+    public BungeeCommand(LiteBungeeSettings settings, PermissionService permissionService, CommandRoute<CommandSender> command, String label, PlatformInvocationListener<CommandSender> executeListener, PlatformSuggestionListener<CommandSender> suggestionListener) {
         super(label, "", label);
         this.settings = settings;
+        this.permissionService = permissionService;
         this.commandSection = command;
         this.label = label;
         this.executeListener = executeListener;
@@ -35,7 +38,7 @@ public BungeeCommand(LiteBungeeSettings settings, CommandRoute<CommandSender> co
     public void execute(CommandSender sender, String[] args) {
         ParseableInput<?> input = ParseableInput.raw(args);
         BungeeSender platformSender = new BungeeSender(sender);
-        Invocation<CommandSender> invocation = new Invocation<>(sender, platformSender, this.commandSection.getName(), this.label, input);
+        Invocation<CommandSender> invocation = new Invocation<>(platformSender, this.commandSection.getName(), this.label, input);
 
         this.executeListener.execute(invocation, input);
     }
@@ -44,7 +47,7 @@ public void execute(CommandSender sender, String[] args) {
     public Iterable<String> onTabComplete(CommandSender sender, String[] args) {
         SuggestionInput<?> input = SuggestionInput.raw(args);
         BungeeSender platformSender = new BungeeSender(sender);
-        Invocation<CommandSender> invocation = new Invocation<>(sender, platformSender, this.commandSection.getName(), this.label, input);
+        Invocation<CommandSender> invocation = new Invocation<>(platformSender, this.commandSection.getName(), this.label, input);
 
         return this.suggestionListener.suggest(invocation, input)
             .asMultiLevelList();
@@ -55,9 +58,7 @@ public boolean hasPermission(CommandSender sender) {
         boolean isNative = commandSection.meta().get(Meta.NATIVE_PERMISSIONS);
 
         if (isNative || settings.isNativePermissions()) {
-            MissingPermissions missingPermissions = MissingPermissions.check(new BungeeSender(sender), this.commandSection);
-
-            return missingPermissions.isPermitted();
+            return permissionService.isPermitted(new BungeeSender(sender), this.commandSection);
         }
 
         return super.hasPermission(sender);

litecommands-bungee/src/dev/rollczi/litecommands/bungee/BungeeCommand.java

@@ -1,6 +1,7 @@
 package dev.rollczi.litecommands.bungee;
 
 import dev.rollczi.litecommands.command.CommandRoute;
+import dev.rollczi.litecommands.permission.PermissionService;
 import dev.rollczi.litecommands.platform.AbstractSimplePlatform;
 import dev.rollczi.litecommands.platform.PlatformInvocationListener;
 import dev.rollczi.litecommands.platform.PlatformSuggestionListener;
@@ -17,17 +18,19 @@ class BungeePlatform extends AbstractSimplePlatform<CommandSender, LiteBungeeSet
 
     private final Plugin plugin;
     private final PluginManager pluginManager;
+    private final PermissionService permissionService;
 
-    public BungeePlatform(Plugin plugin, LiteBungeeSettings liteBungeeSettings) {
+    public BungeePlatform(Plugin plugin, LiteBungeeSettings liteBungeeSettings, PermissionService permissionService) {
         super(liteBungeeSettings, sender -> new BungeeSender(sender));
         this.plugin = plugin;
         this.pluginManager = plugin.getProxy().getPluginManager();
+        this.permissionService = permissionService;
     }
 
     @Override
     protected void hook(CommandRoute<CommandSender> commandRoute, PlatformInvocationListener<CommandSender> invocationHook, PlatformSuggestionListener<CommandSender> suggestionHook) {
         for (String label : commandRoute.names()) {
-            BungeeCommand command = new BungeeCommand(settings, commandRoute, label, invocationHook, suggestionHook);
+            BungeeCommand command = new BungeeCommand(settings, permissionService, commandRoute, label, invocationHook, suggestionHook);
 
             pluginManager.registerCommand(this.plugin, command);
         }