Prevent unauthorized access to categories

Author: Revxrsal

common/src/main/java/revxrsal/commands/command/CommandCategory.java

@@ -70,6 +70,15 @@ public interface CommandCategory {
      */
     @NotNull CommandPermission getPermission();
 
+    /**
+     * Returns whether is this category secret or not. This
+     * will only return true if all the children categories and commands
+     * of this category are secret.
+     *
+     * @return Is this category secret or not.
+     */
+    boolean isSecret();
+
     /**
      * Returns an unmodifiable view of all the sub-categories in this
      * category.

common/src/main/java/revxrsal/commands/core/BaseAutoCompleter.java

@@ -199,7 +199,7 @@ private List<String> getCompletions(CommandActor actor, @Unmodifiable ArgumentSt
                 if (!c.isSecret() && c.getPermission().canExecute(actor)) suggestions.add(c.getName());
             });
             category.getCategories().values().forEach(c -> {
-                if (c.getPermission().canExecute(actor)) suggestions.add(c.getName());
+                if (!c.isSecret() && c.getPermission().canExecute(actor)) suggestions.add(c.getName());
             });
         }
         return suggestions

common/src/main/java/revxrsal/commands/core/BaseCommandCategory.java

@@ -50,6 +50,18 @@ final class BaseCommandCategory implements CommandCategory {
         return permission;
     }
 
+    @Override public boolean isSecret() {
+        for (ExecutableCommand command : commands.values()) {
+            if (command.isSecret()) continue;
+            return false;
+        }
+        for (CommandCategory category : categories.values()) {
+            if (category.isSecret()) continue;
+            return false;
+        }
+        return true;
+    }
+
     private final Map<CommandPath, CommandCategory> unmodifiableCategories = Collections.unmodifiableMap(categories);
 
     @Override public @NotNull @UnmodifiableView Map<CommandPath, CommandCategory> getCategories() {

common/src/main/java/revxrsal/commands/core/BaseCommandDispatcher.java

@@ -60,6 +60,8 @@ private Object searchCategory(CommandActor actor, BaseCommandCategory category,
             arguments.removeFirst();
             return execute(executable, actor, arguments);
         }
+        if (!category.getPermission().canExecute(actor))
+            throw new NoPermissionException(null, category, category.getPermission());
         BaseCommandCategory found = (BaseCommandCategory) category.getCategories().get(path);
         if (found == null) {
             if (category.defaultAction == null)

common/src/main/java/revxrsal/commands/core/BaseCommandHandler.java

@@ -107,7 +107,7 @@ public BaseCommandHandler() {
         });
         registerCondition((actor, command, arguments) -> {
             if (!command.getPermission().canExecute(actor))
-                throw new NoPermissionException(command, command.getPermission());
+                throw new NoPermissionException(command, command.getParent(), command.getPermission());
         });
     }
 

common/src/main/java/revxrsal/commands/exception/NoPermissionException.java

@@ -3,13 +3,18 @@
 import lombok.AllArgsConstructor;
 import lombok.Getter;
 import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
 import revxrsal.commands.command.CommandActor;
+import revxrsal.commands.command.CommandCategory;
 import revxrsal.commands.command.CommandPermission;
 import revxrsal.commands.command.ExecutableCommand;
 
 /**
  * Thrown when a {@link CommandActor} lacks the required permission to
- * execute the given command
+ * execute the given command or category.
+ * <p>
+ * Note that {@link #getCommand()} may be null when the user attempts
+ * to access a category in which they do not have permission.
  */
 @Getter
 @AllArgsConstructor
@@ -19,7 +24,12 @@ public class NoPermissionException extends RuntimeException {
     /**
      * The command being executed
      */
-    private final @NotNull ExecutableCommand command;
+    private final @Nullable ExecutableCommand command;
+
+    /**
+     * The category being accessed.
+     */
+    private final CommandCategory category;
 
     /**
      * The permission the actor lacks