Self-delete command responses if command has been deleted.

Saladoc · Saladoc · commit d91717078736 · 2018-12-04T12:57:46.000+01:00
diff --git a/src/main/java/org/javacord/bot/Main.java b/src/main/java/org/javacord/bot/Main.java
@@ -15,6 +15,7 @@
 import org.javacord.bot.commands.Sdcf4jCommand;
 import org.javacord.bot.commands.SetupCommand;
 import org.javacord.bot.commands.WikiCommand;
+import org.javacord.bot.listeners.CommandCleanupListener;
 
 import java.io.BufferedReader;
 import java.io.IOException;
@@ -71,6 +72,8 @@ public static void main(String[] args) throws IOException {
         handler.registerCommand(new WikiCommand());
         handler.registerCommand(new Sdcf4jCommand());
         handler.registerCommand(new InfoCommand());
+
+        api.addMessageDeleteListener(new CommandCleanupListener());
     }
 
     private static void setupLogging() throws IOException {
diff --git a/src/main/java/org/javacord/bot/commands/DocsCommand.java b/src/main/java/org/javacord/bot/commands/DocsCommand.java
@@ -4,9 +4,11 @@
 import de.btobastian.sdcf4j.CommandExecutor;
 import org.javacord.api.DiscordApi;
 import org.javacord.api.entity.channel.TextChannel;
+import org.javacord.api.entity.message.Message;
 import org.javacord.api.entity.message.embed.EmbedBuilder;
 import org.javacord.api.util.logging.ExceptionLogger;
 import org.javacord.bot.Constants;
+import org.javacord.bot.listeners.CommandCleanupListener;
 import org.javacord.bot.util.javadoc.parser.JavadocClass;
 import org.javacord.bot.util.javadoc.parser.JavadocMethod;
 import org.javacord.bot.util.javadoc.parser.JavadocParser;
@@ -32,10 +34,12 @@ public class DocsCommand implements CommandExecutor {
      * The parameters that indicate searching for class names only.
      */
     private static final Set<String> classParams = new HashSet<>(Arrays.asList("classes", "class", "c"));
+
     /**
      * The parameters that indicate searching for method names only.
      */
     private static final Set<String> methodParams = new HashSet<>(Arrays.asList("methods", "method", "m"));
+
     /**
      * The parameters that indicate also searching internal packages and the core docs.
      */
@@ -45,11 +49,12 @@ public class DocsCommand implements CommandExecutor {
      * Executes the {@code !docs} command.
      *
      * @param channel The channel where the command was issued.
+     * @param message The message the command was issued in.
      * @param args    The arguments given to the command.
      * @throws IOException If the Javacord icon stream cannot be closed properly.
      */
     @Command(aliases = {"!docs"}, async = true)
-    public void onCommand(TextChannel channel, String[] args) throws IOException {
+    public void onCommand(TextChannel channel, Message message, String[] args) throws IOException {
         try (InputStream javacord3Icon = getClass().getClassLoader().getResourceAsStream("javacord3_icon.png")) {
             EmbedBuilder embed = new EmbedBuilder()
                     .setThumbnail(javacord3Icon, "png")
@@ -76,6 +81,7 @@ public void onCommand(TextChannel channel, String[] args) throws IOException {
                     populateMethods(channel.getApi(), embed, searchString, searchAll);
                 }
             }
+            CommandCleanupListener.insertResponseTracker(embed, message.getId());
             channel.sendMessage(embed).join();
         } catch (Throwable t) {
             channel.sendMessage(
diff --git a/src/main/java/org/javacord/bot/commands/ExampleCommand.java b/src/main/java/org/javacord/bot/commands/ExampleCommand.java
@@ -3,8 +3,10 @@
 import de.btobastian.sdcf4j.Command;
 import de.btobastian.sdcf4j.CommandExecutor;
 import org.javacord.api.entity.channel.TextChannel;
+import org.javacord.api.entity.message.Message;
 import org.javacord.api.entity.message.embed.EmbedBuilder;
 import org.javacord.bot.Constants;
+import org.javacord.bot.listeners.CommandCleanupListener;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -18,16 +20,17 @@ public class ExampleCommand implements CommandExecutor {
      * Executes the {@code !example} command.
      *
      * @param channel The channel where the command was issued.
+     * @param message The message the command was issued in.
      * @throws IOException If the Javacord icon stream cannot be closed properly.
      */
     @Command(aliases = {"!example"}, async = true)
-    public void onCommand(TextChannel channel) throws IOException {
+    public void onCommand(TextChannel channel, Message message) throws IOException {
         try (InputStream javacord3Icon = getClass().getClassLoader().getResourceAsStream("javacord3_icon.png")) {
             EmbedBuilder embed = new EmbedBuilder()
                     .setThumbnail(javacord3Icon, "png")
                     .setColor(Constants.JAVACORD_ORANGE)
                     .addField("Example Bot", "https://github.com/Javacord/Example-Bot");
-
+            CommandCleanupListener.insertResponseTracker(embed, message.getId());
             channel.sendMessage(embed).join();
         }
     }
diff --git a/src/main/java/org/javacord/bot/commands/GitHubCommand.java b/src/main/java/org/javacord/bot/commands/GitHubCommand.java
@@ -3,8 +3,10 @@
 import de.btobastian.sdcf4j.Command;
 import de.btobastian.sdcf4j.CommandExecutor;
 import org.javacord.api.entity.channel.TextChannel;
+import org.javacord.api.entity.message.Message;
 import org.javacord.api.entity.message.embed.EmbedBuilder;
 import org.javacord.bot.Constants;
+import org.javacord.bot.listeners.CommandCleanupListener;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -18,16 +20,18 @@ public class GitHubCommand implements CommandExecutor {
      * Executes the {@code !github} command.
      *
      * @param channel The channel where the command was issued.
+     * @param message The message the command was issued in.
      * @throws IOException If the Javacord icon stream cannot be closed properly.
      */
     @Command(aliases = {"!github"}, async = true)
-    public void onCommand(TextChannel channel) throws IOException {
+    public void onCommand(TextChannel channel, Message message) throws IOException {
         try (InputStream javacord3Icon = getClass().getClassLoader().getResourceAsStream("javacord3_icon.png")) {
             EmbedBuilder embed = new EmbedBuilder()
                     .addField("Javacord", "https://github.com/Javacord/Javacord")
                     .addField("Example Bot", "https://github.com/Javacord/Example-Bot")
                     .setThumbnail(javacord3Icon, "png")
                     .setColor(Constants.JAVACORD_ORANGE);
+            CommandCleanupListener.insertResponseTracker(embed, message.getId());
             channel.sendMessage(embed).join();
         }
     }
diff --git a/src/main/java/org/javacord/bot/commands/GradleCommand.java b/src/main/java/org/javacord/bot/commands/GradleCommand.java
@@ -4,8 +4,10 @@
 import de.btobastian.sdcf4j.CommandExecutor;
 import org.javacord.api.Javacord;
 import org.javacord.api.entity.channel.TextChannel;
+import org.javacord.api.entity.message.Message;
 import org.javacord.api.entity.message.embed.EmbedBuilder;
 import org.javacord.bot.Constants;
+import org.javacord.bot.listeners.CommandCleanupListener;
 
 /**
  * The !gradle command which is used to get information about Javacord with Gradle.
@@ -16,9 +18,10 @@ public class GradleCommand implements CommandExecutor {
      * Executes the {@code !gradle} command.
      *
      * @param channel The channel where the command was issued.
+     * @param message The message the command was issued in.
      */
     @Command(aliases = {"!gradle"}, async = true)
-    public void onCommand(TextChannel channel) {
+    public void onCommand(TextChannel channel, Message message) {
         EmbedBuilder embed = new EmbedBuilder()
                 .setColor(Constants.JAVACORD_ORANGE)
                 .addField("Dependency",
@@ -33,6 +36,7 @@ public void onCommand(TextChannel channel) {
                                 + "```")
                 .addField("Setup Guide", "• [IntelliJ](https://javacord.org/wiki/getting-started/intellij-gradle/)");
 
+        CommandCleanupListener.insertResponseTracker(embed, message.getId());
         channel.sendMessage(embed).join();
     }
 
diff --git a/src/main/java/org/javacord/bot/commands/InfoCommand.java b/src/main/java/org/javacord/bot/commands/InfoCommand.java
@@ -5,18 +5,21 @@
 import org.javacord.api.DiscordApi;
 import org.javacord.api.Javacord;
 import org.javacord.api.entity.channel.TextChannel;
+import org.javacord.api.entity.message.Message;
 import org.javacord.api.entity.message.embed.EmbedBuilder;
 import org.javacord.bot.Constants;
+import org.javacord.bot.listeners.CommandCleanupListener;
 
 public class InfoCommand implements CommandExecutor {
 
     /**
      * Executes the {@code !info} command.
      *
      * @param channel The channel where the command was issued.
+     * @param message The message the command was issued in.
      */
     @Command(aliases = "!info", async = true)
-    public void handleCommand(TextChannel channel) {
+    public void handleCommand(TextChannel channel, Message message) {
         final DiscordApi api = channel.getApi();
         EmbedBuilder embed = new EmbedBuilder()
                 .setColor(Constants.JAVACORD_ORANGE)
@@ -28,6 +31,7 @@ public void handleCommand(TextChannel channel) {
                 .addInlineField("Javacord Version", Javacord.VERSION)
                 .addInlineField("sdcf4j Version", "v1.0.10");
 
+        CommandCleanupListener.insertResponseTracker(embed, message.getId());
         channel.sendMessage(embed).join();
     }
 
diff --git a/src/main/java/org/javacord/bot/commands/InviteCommand.java b/src/main/java/org/javacord/bot/commands/InviteCommand.java
@@ -3,8 +3,10 @@
 import de.btobastian.sdcf4j.Command;
 import de.btobastian.sdcf4j.CommandExecutor;
 import org.javacord.api.entity.channel.TextChannel;
+import org.javacord.api.entity.message.Message;
 import org.javacord.api.entity.message.embed.EmbedBuilder;
 import org.javacord.bot.Constants;
+import org.javacord.bot.listeners.CommandCleanupListener;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -18,16 +20,18 @@ public class InviteCommand implements CommandExecutor {
      * Executes the {@code !invite} command.
      *
      * @param channel The channel where the command was issued.
+     * @param message The message the command was issued in.
      * @throws IOException If the Javacord icon stream cannot be closed properly.
      */
     @Command(aliases = {"!invite"}, async = true)
-    public void onCommand(TextChannel channel) throws IOException {
+    public void onCommand(TextChannel channel, Message message) throws IOException {
         try (InputStream javacord3Icon = getClass().getClassLoader().getResourceAsStream("javacord3_icon.png")) {
             EmbedBuilder embed = new EmbedBuilder()
                     .setThumbnail(javacord3Icon, "png")
                     .setColor(Constants.JAVACORD_ORANGE)
                     .addField("Invite Link", "https://discordapp.com/invite/0qJ2jjyneLEgG7y3");
 
+            CommandCleanupListener.insertResponseTracker(embed, message.getId());
             channel.sendMessage(embed).join();
         }
     }
diff --git a/src/main/java/org/javacord/bot/commands/MavenCommand.java b/src/main/java/org/javacord/bot/commands/MavenCommand.java
@@ -4,8 +4,10 @@
 import de.btobastian.sdcf4j.CommandExecutor;
 import org.javacord.api.Javacord;
 import org.javacord.api.entity.channel.TextChannel;
+import org.javacord.api.entity.message.Message;
 import org.javacord.api.entity.message.embed.EmbedBuilder;
 import org.javacord.bot.Constants;
+import org.javacord.bot.listeners.CommandCleanupListener;
 
 /**
  * The !maven command which is used to get information about Javacord with Maven.
@@ -16,9 +18,10 @@ public class MavenCommand implements CommandExecutor {
      * Executes the {@code !maven} command.
      *
      * @param channel The channel where the command was issued.
+     * @param message The message the command was issued in.
      */
     @Command(aliases = {"!maven"}, async = true)
-    public void onCommand(TextChannel channel) {
+    public void onCommand(TextChannel channel, Message message) {
         EmbedBuilder embed = new EmbedBuilder()
                 .setColor(Constants.JAVACORD_ORANGE)
                 .addField("Dependency",
@@ -35,6 +38,7 @@ public void onCommand(TextChannel channel) {
                         "• [IntelliJ](https://javacord.org/wiki/getting-started/intellij-maven/)\n"
                                 + "• [Eclipse](https://javacord.org/wiki/getting-started/eclipse-maven/)");
 
+        CommandCleanupListener.insertResponseTracker(embed, message.getId());
         channel.sendMessage(embed).join();
     }
 
diff --git a/src/main/java/org/javacord/bot/commands/Sdcf4jCommand.java b/src/main/java/org/javacord/bot/commands/Sdcf4jCommand.java
@@ -3,25 +3,29 @@
 import de.btobastian.sdcf4j.Command;
 import de.btobastian.sdcf4j.CommandExecutor;
 import org.javacord.api.entity.channel.TextChannel;
+import org.javacord.api.entity.message.Message;
 import org.javacord.api.entity.message.embed.EmbedBuilder;
 import org.javacord.bot.Constants;
+import org.javacord.bot.listeners.CommandCleanupListener;
 
 public class Sdcf4jCommand implements CommandExecutor {
 
     /**
      * Executes the {@code !sdcf4j} command.
      *
      * @param channel The channel where the command was issued.
+     * @param message The message the command was issued in.
      */
     @Command(aliases = {"!sdcf4j", "!commands"}, async = true)
-    public void onCommand(TextChannel channel) {
+    public void onCommand(TextChannel channel, Message message) {
 
         EmbedBuilder embed = new EmbedBuilder()
                 .setTitle("SDCF4J")
                 .setDescription("A simple discord command framework, compatible with Javacord, JDA and Discord4J")
                 .addInlineField("GitHub", "https://github.com/Bastian/sdcf4j")
                 .addInlineField("Wiki", "https://github.com/Bastian/sdcf4j/wiki")
                 .setColor(Constants.JAVACORD_ORANGE);
+        CommandCleanupListener.insertResponseTracker(embed, message.getId());
         channel.sendMessage(embed).join();
     }
 
diff --git a/src/main/java/org/javacord/bot/commands/SetupCommand.java b/src/main/java/org/javacord/bot/commands/SetupCommand.java
@@ -3,8 +3,10 @@
 import de.btobastian.sdcf4j.Command;
 import de.btobastian.sdcf4j.CommandExecutor;
 import org.javacord.api.entity.channel.TextChannel;
+import org.javacord.api.entity.message.Message;
 import org.javacord.api.entity.message.embed.EmbedBuilder;
 import org.javacord.bot.Constants;
+import org.javacord.bot.listeners.CommandCleanupListener;
 
 /**
  * The !setup command which is used to get information useful for first setup.
@@ -15,9 +17,10 @@ public class SetupCommand implements CommandExecutor {
      * Executes the {@code !setup} command.
      *
      * @param channel The channel where the command was issued.
+     * @param message The message the command was issued in.
      */
     @Command(aliases = {"!setup"}, async = true)
-    public void onCommand(TextChannel channel) {
+    public void onCommand(TextChannel channel, Message message) {
         EmbedBuilder embed = new EmbedBuilder()
                 .setColor(Constants.JAVACORD_ORANGE)
                 .addField("Gradle Dependency",
@@ -45,6 +48,7 @@ public void onCommand(TextChannel channel) {
                                 + "• [IntelliJ + Maven](https://javacord.org/wiki/getting-started/intellij-maven/)\n"
                                 + "• [Eclipse + Maven](https://javacord.org/wiki/getting-started/eclipse-maven/)");
 
+        CommandCleanupListener.insertResponseTracker(embed, message.getId());
         channel.sendMessage(embed).join();
     }
 
diff --git a/src/main/java/org/javacord/bot/commands/WikiCommand.java b/src/main/java/org/javacord/bot/commands/WikiCommand.java
@@ -4,9 +4,11 @@
 import de.btobastian.sdcf4j.CommandExecutor;
 import org.javacord.api.DiscordApi;
 import org.javacord.api.entity.channel.TextChannel;
+import org.javacord.api.entity.message.Message;
 import org.javacord.api.entity.message.embed.EmbedBuilder;
 import org.javacord.api.util.logging.ExceptionLogger;
 import org.javacord.bot.Constants;
+import org.javacord.bot.listeners.CommandCleanupListener;
 import org.javacord.bot.util.wiki.parser.WikiPage;
 import org.javacord.bot.util.wiki.parser.WikiParser;
 
@@ -30,11 +32,12 @@ public class WikiCommand implements CommandExecutor {
      *
      * @param api The Discord api.
      * @param channel The channel where the command was issued.
+     * @param message The message triggering the command.
      * @param args The command's arguments.
      * @throws IOException If the connection to the wiki failed.
      */
     @Command(aliases = {"!wiki"}, async = true)
-    public void onCommand(DiscordApi api, TextChannel channel, String[] args) throws IOException {
+    public void onCommand(DiscordApi api, TextChannel channel, Message message, String[] args) throws IOException {
         try (InputStream javacord3Icon = getClass().getClassLoader().getResourceAsStream("javacord3_icon.png")) {
             EmbedBuilder embed = new EmbedBuilder()
                     .setThumbnail(getClass().getClassLoader().getResourceAsStream("javacord3_icon.png"), "png")
@@ -64,6 +67,7 @@ public void onCommand(DiscordApi api, TextChannel channel, String[] args) throws
                         populatePages(api, embed, defaultSearch(searchString));
                 }
             }
+            CommandCleanupListener.insertResponseTracker(embed, message.getId());
             channel.sendMessage(embed).join();
         } catch (Throwable t) {
             channel.sendMessage("Something went wrong: ```" + ExceptionLogger.unwrapThrowable(t).getMessage() + "```")
diff --git a/src/main/java/org/javacord/bot/listeners/CommandCleanupListener.java b/src/main/java/org/javacord/bot/listeners/CommandCleanupListener.java
