Integration of features

- Renamed Commands to Features
- Renamed CommandSystem to BotCore
- Integrated new MessageReceiver and EventReceiver capabilities
- Migrated RejoinMuteListener to new EventReceiver

Author: Zabuzard

application/src/main/java/org/togetherjava/tjbot/Application.java

@@ -5,8 +5,8 @@
 import net.dv8tion.jda.api.requests.GatewayIntent;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
-import org.togetherjava.tjbot.commands.Commands;
-import org.togetherjava.tjbot.commands.system.CommandSystem;
+import org.togetherjava.tjbot.commands.Features;
+import org.togetherjava.tjbot.commands.system.BotCore;
 import org.togetherjava.tjbot.config.Config;
 import org.togetherjava.tjbot.db.Database;
 
@@ -22,7 +22,7 @@
  * New commands can be created by implementing
  * {@link net.dv8tion.jda.api.events.interaction.SlashCommandEvent} or extending
  * {@link org.togetherjava.tjbot.commands.SlashCommandAdapter}. They can then be registered in
- * {@link Commands}.
+ * {@link Features}.
  */
 public enum Application {
     ;
@@ -79,7 +79,7 @@ public static void runBot(String token, Path databasePath) {
             JDA jda = JDABuilder.createDefault(token)
                 .enableIntents(GatewayIntent.GUILD_MEMBERS)
                 .build();
-            jda.addEventListener(new CommandSystem(jda, database));
+            jda.addEventListener(new BotCore(jda, database));
             jda.awaitReady();
             logger.info("Bot is ready");
 

application/src/main/java/org/togetherjava/tjbot/commands/Commands.java

@@ -0,0 +1,82 @@
+package org.togetherjava.tjbot.commands;
+
+import net.dv8tion.jda.api.JDA;
+import org.jetbrains.annotations.NotNull;
+import org.togetherjava.tjbot.commands.basic.PingCommand;
+import org.togetherjava.tjbot.commands.basic.VcActivityCommand;
+import org.togetherjava.tjbot.commands.free.FreeCommand;
+import org.togetherjava.tjbot.commands.mathcommands.TeXCommand;
+import org.togetherjava.tjbot.commands.moderation.*;
+import org.togetherjava.tjbot.commands.moderation.temp.TemporaryModerationRoutine;
+import org.togetherjava.tjbot.commands.system.BotCore;
+import org.togetherjava.tjbot.commands.tags.TagCommand;
+import org.togetherjava.tjbot.commands.tags.TagManageCommand;
+import org.togetherjava.tjbot.commands.tags.TagSystem;
+import org.togetherjava.tjbot.commands.tags.TagsCommand;
+import org.togetherjava.tjbot.db.Database;
+import org.togetherjava.tjbot.routines.ModAuditLogRoutine;
+
+import java.util.ArrayList;
+import java.util.Collection;
+
+/**
+ * Utility class that offers all features that should be registered by the system, such as commands.
+ * New features have to be added here, where {@link BotCore} will then pick it up from and register
+ * it with the system.
+ * <p>
+ * To add a new slash command, extend the commands returned by
+ * {@link #createFeatures(JDA, Database)}.
+ */
+public enum Features {
+    ;
+
+    /**
+     * Creates all features that should be registered with this application.
+     * <p>
+     * Calling this method multiple times will result in multiple features being created, which
+     * generally should be avoided.
+     *
+     * @param jda the JDA instance commands will be registered at
+     * @param database the database of the application, which features can use to persist data
+     * @return a collection of all features
+     */
+    public static @NotNull Collection<Feature> createFeatures(@NotNull JDA jda,
+            @NotNull Database database) {
+        TagSystem tagSystem = new TagSystem(database);
+        ModerationActionsStore actionsStore = new ModerationActionsStore(database);
+
+        // NOTE The system can add special system relevant commands also by itself,
+        // hence this list may not necessarily represent the full list of all commands actually
+        // available.
+        Collection<Feature> features = new ArrayList<>();
+
+        // Routines
+        // TODO This should be moved into some proper command system instead (see GH issue #235
+        // which adds support for routines)
+        new ModAuditLogRoutine(jda, database).start();
+        new TemporaryModerationRoutine(jda, actionsStore).start();
+
+        // Message receivers
+
+        // Event receivers
+        features.add(new RejoinMuteListener(actionsStore));
+
+        // Slash commands
+        features.add(new PingCommand());
+        features.add(new TeXCommand());
+        features.add(new TagCommand(tagSystem));
+        features.add(new TagManageCommand(tagSystem));
+        features.add(new TagsCommand(tagSystem));
+        features.add(new VcActivityCommand());
+        features.add(new WarnCommand(actionsStore));
+        features.add(new KickCommand(actionsStore));
+        features.add(new BanCommand(actionsStore));
+        features.add(new UnbanCommand(actionsStore));
+        features.add(new FreeCommand());
+        features.add(new AuditCommand(actionsStore));
+        features.add(new MuteCommand(actionsStore));
+        features.add(new UnmuteCommand(actionsStore));
+
+        return features;
+    }
+}

application/src/main/java/org/togetherjava/tjbot/commands/Features.java

@@ -21,7 +21,7 @@
  * <p>
  * All slash commands have to implement this interface. For convenience, there is a
  * {@link SlashCommandAdapter} available that implemented most methods already. A new command can
- * then be registered by adding it to {@link Commands}.
+ * then be registered by adding it to {@link Features}.
  * <p>
  * <p>
  * Slash commands can either be visible globally in Discord or just to specific guilds. They can
@@ -36,7 +36,7 @@
  * <p>
  * Some example commands are available in {@link org.togetherjava.tjbot.commands.basic}.
  */
-public interface SlashCommand {
+public interface SlashCommand extends Feature {
 
     /**
      * Gets the name of the command.
@@ -84,16 +84,16 @@ public interface SlashCommand {
      * <p>
      * <p>
      * This method may be called multiple times, implementations must not create new data each time
-     * but instead configure it once beforehand. The command system will automatically call this
-     * method to register the command to Discord.
+     * but instead configure it once beforehand. The core system will automatically call this method
+     * to register the command to Discord.
      *
      * @return the command data of this command
      */
     @NotNull
     CommandData getData();
 
     /**
-     * Triggered by the command system after system startup is complete. This can be used for
+     * Triggered by the core system after system startup is complete. This can be used for
      * initialisation actions that cannot occur during construction.
      * <p>
      * This method may be called multi-threaded. There is no guarantee as to the order that commands
@@ -114,8 +114,8 @@ public interface SlashCommand {
     void onReady(@NotNull ReadyEvent event);
 
     /**
-     * Triggered by the command system when a slash command corresponding to this implementation
-     * (based on {@link #getData()}) has been triggered.
+     * Triggered by the core system when a slash command corresponding to this implementation (based
+     * on {@link #getData()}) has been triggered.
      * <p>
      * This method may be called multi-threaded. In particular, there are no guarantees that it will
      * be executed on the same thread repeatedly or on the same thread that other event methods have
@@ -127,7 +127,7 @@ public interface SlashCommand {
      * Buttons or menus have to be created with a component ID (see
      * {@link ComponentInteraction#getComponentId()},
      * {@link net.dv8tion.jda.api.interactions.components.Button#of(ButtonStyle, String, Emoji)}) in
-     * a very specific format, otherwise the command system will fail to identify the command that
+     * a very specific format, otherwise the core system will fail to identify the command that
      * corresponded to the button or menu click event and is unable to route it back.
      * <p>
      * The component ID has to be a UUID-string (see {@link java.util.UUID}), which is associated to
@@ -154,7 +154,7 @@ public interface SlashCommand {
     void onSlashCommand(@NotNull SlashCommandEvent event);
 
     /**
-     * Triggered by the command system when a button corresponding to this implementation (based on
+     * Triggered by the core system when a button corresponding to this implementation (based on
      * {@link #getData()}) has been clicked.
      * <p>
      * This method may be called multi-threaded. In particular, there are no guarantees that it will
@@ -174,7 +174,7 @@ public interface SlashCommand {
     void onButtonClick(@NotNull ButtonClickEvent event, @NotNull List<String> args);
 
     /**
-     * Triggered by the command system when a selection menu corresponding to this implementation
+     * Triggered by the core system when a selection menu corresponding to this implementation
      * (based on {@link #getData()}) has been clicked.
      * <p>
      * This method may be called multi-threaded. In particular, there are no guarantees that it will
@@ -194,10 +194,10 @@ public interface SlashCommand {
     void onSelectionMenu(@NotNull SelectionMenuEvent event, @NotNull List<String> args);
 
     /**
-     * Triggered by the command system during its setup phase. It will provide the command a
-     * component id generator through this method, which can be used to generate component ids, as
-     * used for button or selection menus. See {@link #onSlashCommand(SlashCommandEvent)} for
-     * details on how to use this.
+     * Triggered by the core system during its setup phase. It will provide the command a component
+     * id generator through this method, which can be used to generate component ids, as used for
+     * button or selection menus. See {@link #onSlashCommand(SlashCommandEvent)} for details on how
+     * to use this.
      *
      * @param generator the provided component id generator
      */

application/src/main/java/org/togetherjava/tjbot/commands/SlashCommand.java

@@ -17,7 +17,7 @@
 /**
  * Adapter implementation of a {@link SlashCommand}. The minimal setup only requires implementation
  * of {@link #onSlashCommand(SlashCommandEvent)}. A new command can then be registered by adding it
- * to {@link Commands}.
+ * to {@link Features}.
  * <p>
  * Further, {@link #onButtonClick(ButtonClickEvent, List)} and
  * {@link #onSelectionMenu(SelectionMenuEvent, List)} can be overridden if desired. The default
@@ -54,7 +54,7 @@
  * }
  * </pre>
  * <p>
- * and registration of an instance of that class in {@link Commands}.
+ * and registration of an instance of that class in {@link Features}.
  */
 public abstract class SlashCommandAdapter implements SlashCommand {
     private final String name;

application/src/main/java/org/togetherjava/tjbot/commands/SlashCommandAdapter.java

@@ -3,15 +3,16 @@
 import net.dv8tion.jda.api.entities.Guild;
 import net.dv8tion.jda.api.entities.IPermissionHolder;
 import net.dv8tion.jda.api.entities.Member;
+import net.dv8tion.jda.api.events.GenericEvent;
 import net.dv8tion.jda.api.events.guild.member.GuildMemberJoinEvent;
-import net.dv8tion.jda.api.hooks.ListenerAdapter;
 import org.jetbrains.annotations.NotNull;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
+import org.togetherjava.tjbot.commands.EventReceiver;
 
-import javax.annotation.Nonnull;
 import java.time.Instant;
-import java.util.*;
+import java.util.Objects;
+import java.util.Optional;
 
 /**
  * Reapplies existing mutes to users who have left and rejoined a guild.
@@ -21,7 +22,7 @@
  * join events and reapplies the mute role in case the user is supposed to be muted still (according
  * to the {@link ModerationActionsStore}).
  */
-public final class RejoinMuteListener extends ListenerAdapter {
+public final class RejoinMuteListener implements EventReceiver {
     private static final Logger logger = LoggerFactory.getLogger(RejoinMuteListener.class);
 
     private final ModerationActionsStore actionsStore;
@@ -52,7 +53,13 @@ private static boolean isActionEffective(@NotNull ActionRecord action) {
     }
 
     @Override
-    public void onGuildMemberJoin(@Nonnull GuildMemberJoinEvent event) {
+    public void onEvent(@NotNull GenericEvent event) {
+        if (event instanceof GuildMemberJoinEvent joinEvent) {
+            onGuildMemberJoin(joinEvent);
+        }
+    }
+
+    private void onGuildMemberJoin(@NotNull GuildMemberJoinEvent event) {
         Member member = event.getMember();
         if (!shouldMemberBeMuted(member)) {
             return;

application/src/main/java/org/togetherjava/tjbot/commands/moderation/RejoinMuteListener.java

@@ -2,8 +2,8 @@
  * This package contains the command system and most commands of the bot. Commands can also be
  * created in different modules, if desired.
  * <p>
- * Commands are registered in {@link org.togetherjava.tjbot.commands.Commands} and then picked up by
- * the {@link org.togetherjava.tjbot.commands.system.CommandSystem}.
+ * Commands are registered in {@link org.togetherjava.tjbot.commands.Features} and then picked up by
+ * the {@link org.togetherjava.tjbot.commands.system.BotCore}.
  * <p>
  * Custom slash commands can be created by implementing
  * {@link org.togetherjava.tjbot.commands.SlashCommand} or using the adapter