implement cancel reason

Author: CyR1en

src/main/java/com/cyr1en/commandprompter/commands/MainCommand.java

@@ -1,6 +1,7 @@
 package com.cyr1en.commandprompter.commands;
 
 import com.cyr1en.commandprompter.CommandPrompter;
+import com.cyr1en.commandprompter.prompt.PromptManager;
 import dev.jorel.commandapi.CommandAPICommand;
 import dev.jorel.commandapi.executors.CommandArguments;
 import org.bukkit.command.CommandSender;
@@ -71,7 +72,7 @@ public void exec(CommandSender sender, CommandArguments args) {
                 return;
             }
 
-            plugin.getPromptManager().cancel(sender);
+            plugin.getPromptManager().cancel(sender, PromptManager.CancelReason.Manual);
         }
 
     }

src/main/java/com/cyr1en/commandprompter/hook/hooks/CarbonChatHook.java

@@ -46,7 +46,7 @@ public void handle(CarbonChatEvent event) {
         var cancel = getPlugin().getConfiguration().cancelKeyword();
 
         if (cancel.equalsIgnoreCase(serializedMsg)) {
-            promptManager.cancel(player);
+            promptManager.cancel(player, PromptManager.CancelReason.Manual);
             event.message(Component.empty());
             return;
         }

src/main/java/com/cyr1en/commandprompter/prompt/PromptManager.java

@@ -116,7 +116,8 @@ public Class<? extends Prompt> put(String key, Class<? extends Prompt> value) {
     public void parse(PromptContext context) {
         var queueHash = promptParser.parsePrompts(context);
         var timeout = plugin.getConfiguration().promptTimeout();
-        scheduler.runTaskLater(plugin, () -> cancel(context.getPromptedPlayer(), queueHash), 20L * timeout);
+        scheduler.runTaskLater(plugin, () ->
+                cancel(context.getPromptedPlayer(), queueHash, CancelReason.Timeout), 20L * timeout);
     }
 
     public void sendPrompt(CommandSender sender) {
@@ -233,7 +234,7 @@ public PromptParser getParser() {
         return promptParser;
     }
 
-    public void cancel(CommandSender sender, int queueHash) {
+    public void cancel(CommandSender sender, int queueHash, CancelReason reason) {
         if (!promptRegistry.containsKey(sender))
             return;
         plugin.getPluginLogger().debug("queueHash: " + queueHash);
@@ -259,8 +260,8 @@ public void cancel(CommandSender sender, int queueHash) {
         plugin.getPluginLogger().debug("Command completion called for: %s", sender.getName());
     }
 
-    public void cancel(CommandSender sender) {
-        cancel(sender, -1);
+    public void cancel(CommandSender sender, CancelReason reason) {
+        cancel(sender, -1, reason);
     }
 
     public Pattern getArgumentPattern(String... additionalKeys) {
@@ -283,4 +284,12 @@ public void clearPromptRegistry() {
     public CommandPrompter getPlugin() {
         return plugin;
     }
+
+    public static enum CancelReason {
+        GUIExit,
+        GUIErr,
+        Manual,
+        Timeout,
+        BlankInput
+    }
 }

src/main/java/com/cyr1en/commandprompter/prompt/prompts/AnvilPrompt.java

@@ -33,7 +33,6 @@
 import org.bukkit.ChatColor;
 import org.bukkit.Material;
 import org.bukkit.enchantments.Enchantment;
-import org.bukkit.entity.Player;
 import org.bukkit.inventory.ItemFlag;
 import org.bukkit.inventory.ItemStack;
 import org.jetbrains.annotations.NotNull;
@@ -44,6 +43,8 @@
 import java.util.Objects;
 import java.util.concurrent.atomic.AtomicBoolean;
 
+import static com.cyr1en.commandprompter.prompt.PromptManager.CancelReason;
+
 public class AnvilPrompt extends AbstractPrompt {
 
     public static char BLANK_CHAR = '\u00A0'; // No-Break Space
@@ -68,7 +69,7 @@ private AnvilGUI.Builder makeAnvil(List<String> parts, ItemStack item, ItemStack
         builder.onClose(p -> {
             if (isComplete.get())
                 return;
-            getPromptManager().cancel(p.getPlayer());
+            getPromptManager().cancel(p.getPlayer(), CancelReason.GUIExit);
         });
 
         var promptText = getPlugin().getPromptConfig().promptMessage();
@@ -98,7 +99,7 @@ private AnvilGUI.Builder getBuilder(AtomicBoolean isComplete) {
         builder.onClick((slot, stateSnapshot) -> {
             var cancelEnabled = getPlugin().getPromptConfig().enableCancelItem();
             if (slot == AnvilGUI.Slot.INPUT_RIGHT && cancelEnabled) {
-                getPromptManager().cancel(stateSnapshot.getPlayer());
+                getPromptManager().cancel(stateSnapshot.getPlayer(), CancelReason.Manual);
                 return Collections.singletonList(AnvilGUI.ResponseAction.close());
             }
 
@@ -109,7 +110,7 @@ private AnvilGUI.Builder getBuilder(AtomicBoolean isComplete) {
                     ChatColor.translateAlternateColorCodes('&', stateSnapshot.getText()));
             var cancelKeyword = getPlugin().getConfiguration().cancelKeyword();
             if (cancelKeyword.equalsIgnoreCase(message)) {
-                getPromptManager().cancel(stateSnapshot.getPlayer());
+                getPromptManager().cancel(stateSnapshot.getPlayer(), CancelReason.Manual);
                 return Collections.singletonList(AnvilGUI.ResponseAction.close());
             }
 

src/main/java/com/cyr1en/commandprompter/prompt/prompts/ChatPrompt.java

@@ -159,7 +159,7 @@ public void onResponse(Player player, String msg, Cancellable event) {
             var cancelKeyword = plugin.getConfiguration().cancelKeyword();
 
             if (cancelKeyword.equalsIgnoreCase(message))
-                manager.cancel(player);
+                manager.cancel(player, PromptManager.CancelReason.Manual);
 
             var queue = manager.getPromptRegistry().get(player);
             if (Objects.isNull(queue))

src/main/java/com/cyr1en/commandprompter/prompt/prompts/PlayerUIPrompt.java

@@ -27,6 +27,7 @@
 import com.cyr1en.commandprompter.CommandPrompter;
 import com.cyr1en.commandprompter.hook.hooks.VanishHook;
 import com.cyr1en.commandprompter.prompt.PromptContext;
+import com.cyr1en.commandprompter.prompt.PromptManager;
 import com.cyr1en.commandprompter.prompt.PromptParser;
 import com.cyr1en.commandprompter.prompt.ui.CacheFilter;
 import com.cyr1en.commandprompter.prompt.ui.HeadCache;
@@ -157,7 +158,7 @@ private int getCapturingGroup(CacheFilter cacheFilter) {
     private void send(Player p) {
         gui.setOnClose(e -> {
             if (!isSearching)
-                getPromptManager().cancel(p);
+                getPromptManager().cancel(p, PromptManager.CancelReason.Manual);
         });
 
         var skullPane = new PaginatedPane(0, 0, 9, size - 1);

src/main/java/com/cyr1en/commandprompter/prompt/prompts/SignPrompt.java

@@ -2,6 +2,7 @@
 
 import com.cyr1en.commandprompter.CommandPrompter;
 import com.cyr1en.commandprompter.prompt.PromptContext;
+import com.cyr1en.commandprompter.prompt.PromptManager;
 import com.cyr1en.commandprompter.prompt.PromptParser;
 import com.cyr1en.commandprompter.util.Util;
 import com.cyr1en.kiso.utils.FastStrings;
@@ -53,7 +54,7 @@ else if (parts.size() > 4)
             gui.open((Player) getContext().getPromptedPlayer());
         } catch (SignGUIVersionException e) {
             getPlugin().getPluginLogger().err("SignGUI version exception: " + e.getMessage());
-            getPromptManager().cancel(getContext().getPromptedPlayer());
+            getPromptManager().cancel(getContext().getPromptedPlayer(), PromptManager.CancelReason.GUIErr);
         }
     }
 
@@ -77,13 +78,13 @@ private List<SignGUIAction> process(List<String> parts, Player p, String[] s) {
         // If the sign contains the same message as the prompt
         // we'll consider the command completion cancelled.
         if (response.isBlank()) {
-            getPromptManager().cancel(p);
+            getPromptManager().cancel(p, PromptManager.CancelReason.BlankInput);
             return Collections.emptyList();
         }
 
         var cancelKeyword = getPlugin().getConfiguration().cancelKeyword();
         if (cancelKeyword.equalsIgnoreCase(response)) {
-            getPromptManager().cancel(p);
+            getPromptManager().cancel(p, PromptManager.CancelReason.Manual);
             return Collections.emptyList();
         }
         var ctx = new PromptContext.Builder()

src/main/java/com/cyr1en/commandprompter/prompt/ui/inventory/ControlPane.java

@@ -2,6 +2,7 @@
 
 import com.cyr1en.commandprompter.CommandPrompter;
 import com.cyr1en.commandprompter.prompt.PromptContext;
+import com.cyr1en.commandprompter.prompt.PromptManager;
 import com.cyr1en.commandprompter.prompt.prompts.PlayerUIPrompt;
 import com.cyr1en.commandprompter.util.ServerUtil;
 import com.cyr1en.commandprompter.util.Util;
@@ -92,7 +93,7 @@ private void setupButtons() {
         addItem(plugin.getPromptConfig().cancelText(), cancelIS, cancelLoc, cancelCMD,
                 c -> {
                     c.setCancelled(true);
-                    plugin.getPromptManager().cancel(ctx.getPromptedPlayer());
+                    plugin.getPromptManager().cancel(ctx.getPromptedPlayer(), PromptManager.CancelReason.Manual);
                     ((Player) ctx.getPromptedPlayer()).closeInventory();
                 });