From 95fe4577be4992ded9466c4a52492b54a3a668c7 Mon Sep 17 00:00:00 2001
From: MiniDigger <mini.digger@live.de>
Date: Fri, 20 Apr 2018 17:28:22 +0200
Subject: [PATCH] add a new annotation to hide commands from tabcompletion and
 help (#124)

* add a new annotation to hide commands from tabcompletion and help (implements #123)

* do the annotation lookup once
---
 .../java/co/aikar/commands/BaseCommand.java   |  4 +++
 .../java/co/aikar/commands/CommandHelp.java   |  3 +-
 .../co/aikar/commands/RegisteredCommand.java  |  6 +++-
 .../co/aikar/commands/annotation/Private.java | 34 +++++++++++++++++++
 .../java/co/aikar/acfexample/ACFExample.java  |  3 ++
 .../acfexample/SomeCommand_ExtraSubs.java     | 14 ++++++++
 6 files changed, 62 insertions(+), 2 deletions(-)
 create mode 100644 core/src/main/java/co/aikar/commands/annotation/Private.java

diff --git a/core/src/main/java/co/aikar/commands/BaseCommand.java b/core/src/main/java/co/aikar/commands/BaseCommand.java
index 9b2502d3..a1231bf0 100644
--- a/core/src/main/java/co/aikar/commands/BaseCommand.java
+++ b/core/src/main/java/co/aikar/commands/BaseCommand.java
@@ -518,6 +518,10 @@ public abstract class BaseCommand {
                     continue;
                 }
 
+                if(value.isPrivate){
+                    continue;
+                }
+
                 String[] split = ACFPatterns.SPACE.split(value.prefSubCommand);
                 cmds.add(split[cmdIndex]);
             }
diff --git a/core/src/main/java/co/aikar/commands/CommandHelp.java b/core/src/main/java/co/aikar/commands/CommandHelp.java
index 1d91aab4..c5b4fef5 100644
--- a/core/src/main/java/co/aikar/commands/CommandHelp.java
+++ b/core/src/main/java/co/aikar/commands/CommandHelp.java
@@ -65,7 +65,8 @@ public class CommandHelp {
             }
 
             RegisteredCommand regCommand = e.getValue();
-            if (regCommand.hasPermission(issuer) && !seen.contains(regCommand)) {
+
+            if (!regCommand.isPrivate && regCommand.hasPermission(issuer) && !seen.contains(regCommand)) {
                 this.helpEntries.add(new HelpEntry(this, regCommand));
                 seen.add(regCommand);
             }
diff --git a/core/src/main/java/co/aikar/commands/RegisteredCommand.java b/core/src/main/java/co/aikar/commands/RegisteredCommand.java
index 10dd076d..225c8c9f 100644
--- a/core/src/main/java/co/aikar/commands/RegisteredCommand.java
+++ b/core/src/main/java/co/aikar/commands/RegisteredCommand.java
@@ -29,6 +29,7 @@ import co.aikar.commands.annotation.CommandPermission;
 import co.aikar.commands.annotation.Conditions;
 import co.aikar.commands.annotation.Description;
 import co.aikar.commands.annotation.HelpSearchTags;
+import co.aikar.commands.annotation.Private;
 import co.aikar.commands.annotation.Syntax;
 import co.aikar.commands.contexts.ContextResolver;
 import com.google.common.collect.ImmutableSet;
@@ -64,6 +65,8 @@ public class RegisteredCommand <CEC extends CommandExecutionContext<CEC, ? exten
     String conditions;
     public String helpSearchTags;
 
+    boolean isPrivate;
+
     final int requiredResolvers;
     final int consumeInputResolvers;
     final int doesNotConsumeInputResolvers;
@@ -82,7 +85,7 @@ public class RegisteredCommand <CEC extends CommandExecutionContext<CEC, ? exten
         this.prefSubCommand = prefSubCommand;
 
         this.permission = annotations.getAnnotationValue(method, CommandPermission.class, Annotations.REPLACEMENTS | Annotations.NO_EMPTY);
-        this.complete   = annotations.getAnnotationValue(method, CommandCompletion.class);
+        this.complete = annotations.getAnnotationValue(method, CommandCompletion.class);
         this.helpText = annotations.getAnnotationValue(method, Description.class, Annotations.REPLACEMENTS | Annotations.DEFAULT_EMPTY);
         this.conditions = annotations.getAnnotationValue(method, Conditions.class, Annotations.REPLACEMENTS | Annotations.NO_EMPTY);
         this.helpSearchTags = annotations.getAnnotationValue(method, HelpSearchTags.class, Annotations.REPLACEMENTS | Annotations.NO_EMPTY);
@@ -91,6 +94,7 @@ public class RegisteredCommand <CEC extends CommandExecutionContext<CEC, ? exten
         //noinspection unchecked
         this.parameters = new CommandParameter[parameters.length];
 
+        this.isPrivate = annotations.hasAnnotation(method, Private.class);
 
         int requiredResolvers = 0;
         int consumeInputResolvers = 0;
diff --git a/core/src/main/java/co/aikar/commands/annotation/Private.java b/core/src/main/java/co/aikar/commands/annotation/Private.java
new file mode 100644
index 00000000..a4410bb6
--- /dev/null
+++ b/core/src/main/java/co/aikar/commands/annotation/Private.java
@@ -0,0 +1,34 @@
+/*
+ * Copyright (c) 2016-2018 Daniel Ennis (Aikar) - MIT License
+ *
+ *  Permission is hereby granted, free of charge, to any person obtaining
+ *  a copy of this software and associated documentation files (the
+ *  "Software"), to deal in the Software without restriction, including
+ *  without limitation the rights to use, copy, modify, merge, publish,
+ *  distribute, sublicense, and/or sell copies of the Software, and to
+ *  permit persons to whom the Software is furnished to do so, subject to
+ *  the following conditions:
+ *
+ *  The above copyright notice and this permission notice shall be
+ *  included in all copies or substantial portions of the Software.
+ *
+ *  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ *  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+ *  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ *  NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+ *  LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+ *  OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+ *  WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+package co.aikar.commands.annotation;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+
+/**
+ * Marks a command to not be included in stuff like tab completion and help pages
+ */
+@Retention(RetentionPolicy.RUNTIME)
+public @interface Private {
+}
diff --git a/example/src/main/java/co/aikar/acfexample/ACFExample.java b/example/src/main/java/co/aikar/acfexample/ACFExample.java
index dd66162b..48c9f709 100644
--- a/example/src/main/java/co/aikar/acfexample/ACFExample.java
+++ b/example/src/main/java/co/aikar/acfexample/ACFExample.java
@@ -44,6 +44,9 @@ public final class ACFExample extends JavaPlugin {
         // 1: Create Command Manager for your respective platform
         commandManager = new BukkitCommandManager(this);
 
+        // optional: enable unstable api to use help
+        commandManager.enableUnstableAPI("help");
+
         // 2: Setup some replacement values that may be used inside of the annotations dynamically.
         commandManager.getCommandReplacements().addReplacements(
                 // key - value
diff --git a/example/src/main/java/co/aikar/acfexample/SomeCommand_ExtraSubs.java b/example/src/main/java/co/aikar/acfexample/SomeCommand_ExtraSubs.java
index ce200bd8..de197d9f 100644
--- a/example/src/main/java/co/aikar/acfexample/SomeCommand_ExtraSubs.java
+++ b/example/src/main/java/co/aikar/acfexample/SomeCommand_ExtraSubs.java
@@ -24,8 +24,11 @@
 package co.aikar.acfexample;
 
 import co.aikar.commands.BaseCommand;
+import co.aikar.commands.CommandHelp;
 import co.aikar.commands.annotation.CommandAlias;
 import co.aikar.commands.annotation.CommandCompletion;
+import co.aikar.commands.annotation.HelpCommand;
+import co.aikar.commands.annotation.Private;
 import co.aikar.commands.annotation.Subcommand;
 import org.bukkit.command.CommandSender;
 
@@ -37,4 +40,15 @@ public class SomeCommand_ExtraSubs extends BaseCommand {
     public void onTestSub2(CommandSender sender, String hi) {
         sender.sendMessage(hi);
     }
+
+    @Private
+    @Subcommand("testsub private")
+    public void privateSub(CommandSender sender){
+        sender.sendMessage("Am a sneaky ninja!");
+    }
+
+    @HelpCommand
+    public void help(CommandSender sender, CommandHelp help){
+        help.showHelp();
+    }
 }