Merge pull request #123 from Matyrobbrt/command-clearing

KiriCattus · web-flow · commit 4861c53da3bf · 2022-01-31T15:49:24.000Z
Add command clearing to the shutdown command
diff --git a/dependencies.gradle b/dependencies.gradle
@@ -12,7 +12,7 @@ ext {
     jdaChewtilsVersion = "2.0-interactions-SNAPSHOT"
     guavaVersion = "31.0.1-jre"
     gsonVersion = "2.8.9"
-    logbackClassicVersion = "1.2.10"
+    logbackClassicVersion = "1.2.5"
     tomlVersion = "3.6.5"
     sqliteJdbcVersion = "3.36.0.3"
     linkieCoreVersion = "1.0.92"
diff --git a/src/main/java/com/mcmoddev/mmdbot/modules/commands/bot/management/CmdShutdown.java b/src/main/java/com/mcmoddev/mmdbot/modules/commands/bot/management/CmdShutdown.java
@@ -23,9 +23,17 @@
 import com.jagrosh.jdautilities.command.SlashCommand;
 import com.mcmoddev.mmdbot.MMDBot;
 import com.jagrosh.jdautilities.command.SlashCommandEvent;
+import com.mcmoddev.mmdbot.utilities.Utils;
+import net.dv8tion.jda.api.interactions.InteractionHook;
+import net.dv8tion.jda.api.interactions.commands.OptionMapping;
+import net.dv8tion.jda.api.interactions.commands.OptionType;
+import net.dv8tion.jda.api.interactions.commands.build.OptionData;
 
+import java.util.List;
 import java.util.Timer;
 import java.util.TimerTask;
+import java.util.concurrent.ExecutionException;
+import java.util.concurrent.atomic.AtomicReference;
 
 /**
  * Shut down the bot and the JDA instance gracefully.
@@ -44,6 +52,9 @@ public CmdShutdown() {
         help = "Shuts the bot down without restarting it. (Only usable by KiriCattus)";
         category = new Category("Management");
         ownerCommand = true;
+        guildOnly = false;
+        options = List.of(new OptionData(OptionType.BOOLEAN, "clear_global", "If the shutdown should clear global commands."),
+            new OptionData(OptionType.BOOLEAN, "clear_guild", "If the shutdown should clear guild commands."));
     }
 
     /**
@@ -54,8 +65,56 @@ public CmdShutdown() {
     @Override
     protected void execute(final SlashCommandEvent event) {
         event.reply("Shutting down the bot!").queue();
+        final var clearGlobal = Utils.getArgumentOr(event, "clear_global", OptionMapping::getAsBoolean, false);
+        final var clearGuild = Utils.getArgumentOr(event, "clear_guild", OptionMapping::getAsBoolean, false);
+        if (clearGuild && !event.isFromGuild()) {
+            event.reply("You cannot clear guild commands if you are not in a guild!").queue();
+            return;
+        }
+        if (clearGuild) {
+            try {
+                AtomicReference<InteractionHook> msg = new AtomicReference<>(
+                    event.getInteraction().reply("Waiting for command deletion...").submit().get());
+                MMDBot.LOGGER.warn(
+                    "Deleting the guild commands of the guild with the id {} at the request of {} via Discord!",
+                    event.getGuild().getIdLong(), event.getUser().getName());
+                new Thread(() -> {
+                    Utils.clearGuildCommands(event.getGuild(), () -> {
+                        msg.get().editOriginal("Shutting down the bot!").queue();
+                        executeShutdown(event);
+                    });
+                }, "GuildCommandClearing").start();
+            } catch (InterruptedException | ExecutionException e) {
+                e.printStackTrace();
+                event.getInteraction().reply("Error! Shutdown cancelled!").queue();
+            }
+            return;
+        }
+        if (clearGlobal) {
+            try {
+                AtomicReference<InteractionHook> msg = new AtomicReference<>(
+                    event.getInteraction().reply("Waiting for command deletion...").submit().get());
+                MMDBot.LOGGER.warn(
+                    "Deleting the global commands at the request of {} via Discord!", event.getUser().getName());
+                new Thread(() -> {
+                    Utils.clearGlobalCommands(() -> {
+                        msg.get().editOriginal("Shutting down the bot!").queue();
+                        executeShutdown(event);
+                    });
+                }, "GlobalCommandClearing").start();
+            } catch (InterruptedException | ExecutionException e) {
+                e.printStackTrace();
+                event.getInteraction().reply("Error! Shutdown cancelled!").queue();
+            }
+            return;
+        }
+        event.deferReply().setContent("Shutting down the bot!").mentionRepliedUser(false).queue();
+        executeShutdown(event);
+    }
+
+    private void executeShutdown(final SlashCommandEvent event) {
         //Shut down the JDA instance gracefully.
-        event.getJDA().shutdown();
+        MMDBot.getInstance().shutdown();
         MMDBot.LOGGER.warn("Shutting down the bot by request of " + event.getUser().getName() + " via Discord!");
         new Timer().schedule(new TimerTask() {
             @Override
diff --git a/src/main/java/com/mcmoddev/mmdbot/modules/commands/server/tricks/CmdListTricks.java b/src/main/java/com/mcmoddev/mmdbot/modules/commands/server/tricks/CmdListTricks.java
@@ -88,7 +88,7 @@ protected EmbedBuilder getEmbed(int from) {
     public class TrickListListener extends ButtonListener {
         @Override
         public String getButtonID() {
-            return "tricklist";
+            return CmdListTricks.this.getName();
         }
     }
 
diff --git a/src/main/java/com/mcmoddev/mmdbot/modules/logging/LoggingModule.java b/src/main/java/com/mcmoddev/mmdbot/modules/logging/LoggingModule.java
@@ -32,8 +32,11 @@
 import com.mcmoddev.mmdbot.modules.logging.users.UserBanned;
 import com.mcmoddev.mmdbot.utilities.ThreadedEventListener;
 import com.mcmoddev.mmdbot.utilities.Utils;
+import com.mcmoddev.mmdbot.utilities.console.ConsoleChannelButtonListener;
 import net.dv8tion.jda.api.entities.TextChannel;
+import net.dv8tion.jda.api.hooks.EventListener;
 
+import java.util.concurrent.Executor;
 import java.util.concurrent.Executors;
 import java.util.function.Consumer;
 
@@ -45,28 +48,35 @@
  */
 public class LoggingModule {
 
+    private static final Executor THREAD_POOL = Executors.newFixedThreadPool(2, r -> Utils.setThreadDaemon(new Thread(r, "LoggingListener"), true));
+
     /**
      * Setup and load the bots logging module.
      */
     public static void setupLoggingModule() {
         if (MMDBot.getConfig().isEventLoggingModuleEnabled()) {
             MMDBot.getInstance()
                 .addEventListener(
-                    new EventUserJoined(),
-                    new EventUserLeft(),
-                    new EventNicknameChanged(),
-                    new EventRoleAdded(),
-                    new EventRoleRemoved(),
-                    new EventReactionAdded(),
-                    new UserBanned(),
+                    loggingEvent(new EventUserJoined()),
+                    loggingEvent(new EventUserLeft()),
+                    loggingEvent(new EventNicknameChanged()),
+                    loggingEvent(new EventRoleAdded()),
+                    loggingEvent(new EventRoleRemoved()),
+                    loggingEvent(new EventReactionAdded()),
+                    loggingEvent(new UserBanned()),
+                    loggingEvent(new ConsoleChannelButtonListener()),
                     new ThreadedEventListener(new ScamDetector(), Executors.newSingleThreadExecutor(r -> Utils.setThreadDaemon(new Thread(r, "ScamDetector"), true))),
-                    ThreadChannelCreatorEvents.create());
+                    loggingEvent(new ThreadChannelCreatorEvents()));
             MMDBot.LOGGER.warn("Event logging module enabled and loaded.");
         } else {
             MMDBot.LOGGER.warn("Event logging module disabled via config, Discord event logging won't work right now!");
         }
     }
 
+    private static EventListener loggingEvent(EventListener listener) {
+        return new ThreadedEventListener(listener, THREAD_POOL);
+    }
+
     public static void executeInLoggingChannel(LoggingType loggingType, Consumer<TextChannel> channel) {
         Utils.getChannelIfPresent(MMDBot.getConfig().getChannel("events." + loggingType.toString()), channel);
     }
diff --git a/src/main/java/com/mcmoddev/mmdbot/modules/logging/misc/ThreadChannelCreatorEvents.java b/src/main/java/com/mcmoddev/mmdbot/modules/logging/misc/ThreadChannelCreatorEvents.java
@@ -35,16 +35,6 @@
 
 public class ThreadChannelCreatorEvents extends ListenerAdapter {
 
-    private static final Executor THREAD_POOL = Executors.newSingleThreadExecutor(r -> Utils.setThreadDaemon(new Thread(r, "ThreadCreator"), true));
-
-    public static EventListener create() {
-        return new ThreadedEventListener(new ThreadChannelCreatorEvents(), THREAD_POOL);
-    }
-
-    private ThreadChannelCreatorEvents() {
-
-    }
-
     @Override
     public void onMessageReceived(@NotNull final MessageReceivedEvent event) {
         if (!event.isFromGuild() || event.isFromThread() || event.isWebhookMessage() || event.getAuthor().isBot() || event.getAuthor().isSystem()) {
diff --git a/src/main/java/com/mcmoddev/mmdbot/utilities/ThreadedEventListener.java b/src/main/java/com/mcmoddev/mmdbot/utilities/ThreadedEventListener.java
@@ -21,27 +21,53 @@
 package com.mcmoddev.mmdbot.utilities;
 
 import com.mcmoddev.mmdbot.MMDBot;
+import com.mcmoddev.mmdbot.utilities.console.MMDMarkers;
+import net.dv8tion.jda.api.EmbedBuilder;
 import net.dv8tion.jda.api.events.GenericEvent;
 import net.dv8tion.jda.api.hooks.EventListener;
+import net.dv8tion.jda.api.interactions.callbacks.IReplyCallback;
 
 import javax.annotation.Nonnull;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.UUID;
 import java.util.concurrent.Executor;
 import java.util.concurrent.Executors;
 
 public record ThreadedEventListener(EventListener listener, Executor threadPool) implements EventListener {
 
+    public static final Map<UUID, Exception> CAUGHT_EXCEPTIONS = Collections.synchronizedMap(new HashMap<>() {
+        @Override
+        public Exception put(final UUID key, final Exception value) {
+            if (size() < 100) {
+                return super.put(key, value);
+            }
+            return get(key);
+        }
+    });
+
     public ThreadedEventListener(@Nonnull final EventListener listener) {
         this(listener, Executors.newSingleThreadExecutor(r -> Utils.setThreadDaemon(new Thread(r), true)));
     }
 
     @Override
     public void onEvent(GenericEvent event) {
-        try {
-            if (listener != null) {
-                threadPool.execute(() -> listener.onEvent(event));
-            }
-        } catch (Exception e) {
-            MMDBot.LOGGER.error("Error while executing threaded event!", e);
+        if (listener != null) {
+            threadPool.execute(() -> {
+                try {
+                    listener.onEvent(event);
+                } catch (Exception e) {
+                    final var id= UUID.randomUUID();
+                    // We need the ID argument for console channel logging!
+                    MMDBot.LOGGER.error(MMDMarkers.CAUGHT_THREADED_EVENT_EXCEPTIONS, "Error while executing threaded event! Error: ", id, e);
+                    // Reply to the user in order to inform them
+                    if (event instanceof IReplyCallback replyCallback) {
+                        replyCallback.deferReply(true).addEmbeds(new EmbedBuilder().setTitle("This interaction failed due to an exception.").setDescription(e.toString()).build()).queue();
+                    }
+                    CAUGHT_EXCEPTIONS.put(id, e);
+                }
+            });
         }
     }
 
diff --git a/src/main/java/com/mcmoddev/mmdbot/utilities/Utils.java b/src/main/java/com/mcmoddev/mmdbot/utilities/Utils.java
@@ -44,6 +44,7 @@
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import javax.annotation.Nonnull;
 import java.time.Instant;
 import java.time.OffsetDateTime;
 import java.time.ZoneOffset;
@@ -54,8 +55,10 @@
 import java.util.Objects;
 import java.util.Optional;
 import java.util.StringJoiner;
+import java.util.concurrent.ExecutionException;
 import java.util.concurrent.TimeUnit;
 import java.util.function.Consumer;
+import java.util.function.Function;
 import java.util.function.LongPredicate;
 import java.util.stream.Collectors;
 
@@ -577,6 +580,15 @@ public static String getOrEmpty(SlashCommandEvent event, String name) {
         return getOrEmpty(event.getOption(name));
     }
 
+    public static <T> T getArgumentOr(SlashCommandEvent event, String name, Function<OptionMapping, T> getter, T orElse) {
+        final var option = event.getOption(name);
+        if (option != null) {
+            return getter.apply(option);
+        } else {
+            return orElse;
+        }
+    }
+
     /**
      * Creates a discord link pointing to the specified message
      * @param guildId the ID of the guild of the message
@@ -609,4 +621,34 @@ public static void executeInDMs(final long userId, Consumer<PrivateChannel> cons
     public static String uppercaseFirstLetter(final String string) {
         return string.substring(0, 1).toUpperCase(Locale.ROOT) + string.substring(1);
     }
+
+    public static void clearGuildCommands(final @Nonnull Guild guild, final Runnable... after) {
+        guild.retrieveCommands().queue(cmds -> {
+            for (int i = 0; i < cmds.size(); i++) {
+                try {
+                    guild.deleteCommandById(cmds.get(i).getIdLong()).submit().get();
+                } catch (InterruptedException | ExecutionException e) {
+                    MMDBot.LOGGER.error("Error while trying to clear the commands of the guild {}", guild, e);
+                }
+            }
+            for (var toRun : after) {
+                toRun.run();
+            }
+        });
+    }
+
+    public static void clearGlobalCommands(final Runnable... after) {
+        MMDBot.getInstance().retrieveCommands().queue(cmds -> {
+            for (int i = 0; i < cmds.size(); i++) {
+                try {
+                    MMDBot.getInstance().deleteCommandById(cmds.get(i).getIdLong()).submit().get();
+                } catch (InterruptedException | ExecutionException e) {
+                    MMDBot.LOGGER.error("Error while trying to clear the global commands", e);
+                }
+            }
+            for (var toRun : after) {
+                toRun.run();
+            }
+        });
+    }
 }
diff --git a/src/main/java/com/mcmoddev/mmdbot/utilities/console/ConsoleChannelAppender.java b/src/main/java/com/mcmoddev/mmdbot/utilities/console/ConsoleChannelAppender.java
@@ -26,8 +26,11 @@
 import com.mcmoddev.mmdbot.MMDBot;
 import com.mcmoddev.mmdbot.core.BotConfig;
 import net.dv8tion.jda.api.MessageBuilder;
+import net.dv8tion.jda.api.interactions.components.buttons.Button;
+import net.dv8tion.jda.api.interactions.components.buttons.ButtonStyle;
 
 import java.util.Collections;
+import java.util.UUID;
 
 /**
  * A custom {@link ch.qos.logback.core.Appender} for logging to a Discord channel.
@@ -86,12 +89,26 @@ protected void append(final ILoggingEvent event) {
             if (channel == null) {
                 return;
             }
-            final var builder = new MessageBuilder();
-            builder.append(layout != null ? layout.doLayout(event) : event.getFormattedMessage());
-            if (!allowMentions) {
-                builder.setAllowedMentions(Collections.emptyList());
+            if (event.getMarker() != MMDMarkers.CAUGHT_THREADED_EVENT_EXCEPTIONS) {
+                final var builder = new MessageBuilder();
+                builder.append(layout != null ? layout.doLayout(event) : event.getFormattedMessage());
+                if (!allowMentions) {
+                    builder.setAllowedMentions(Collections.emptyList());
+                }
+                channel.sendMessage(builder.build()).queue();
+            } else {
+                final var builder = new MessageBuilder();
+                final var id = (UUID) event.getArgumentArray()[0];
+                final var exception = event.getThrowableProxy();
+                builder.append(ConsoleChannelLayout.LEVEL_TO_EMOTE.get(event.getLevel()))
+                    .append(" ");
+                builder.append(event.getFormattedMessage());
+                builder.append(exception.getMessage());
+                if (!allowMentions) {
+                    builder.setAllowedMentions(Collections.emptyList());
+                }
+                channel.sendMessage(builder.build()).setActionRow(Button.of(ButtonStyle.PRIMARY,  "show_stacktrace_" + id, "Show Stacktrace")).queue();
             }
-            channel.sendMessage(builder.build()).queue();
         }
     }
 }
diff --git a/src/main/java/com/mcmoddev/mmdbot/utilities/console/ConsoleChannelButtonListener.java b/src/main/java/com/mcmoddev/mmdbot/utilities/console/ConsoleChannelButtonListener.java
diff --git a/src/main/java/com/mcmoddev/mmdbot/utilities/console/ConsoleChannelLayout.java b/src/main/java/com/mcmoddev/mmdbot/utilities/console/ConsoleChannelLayout.java
diff --git a/src/main/java/com/mcmoddev/mmdbot/utilities/console/MMDMarkers.java b/src/main/java/com/mcmoddev/mmdbot/utilities/console/MMDMarkers.java

Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ protected EmbedBuilder getEmbed(int from) {`
`88`	`88`	`public class TrickListListener extends ButtonListener {`
`89`	`89`	`@Override`
`90`	`90`	`public String getButtonID() {`
`91`		`- return "tricklist";`
	`91`	`+ return CmdListTricks.this.getName();`
`92`	`92`	`}`
`93`	`93`	`}`
`94`	`94`