DIH4JDA, Sentry & Major Cleanup

.gitignore

@@ -5,6 +5,7 @@ build/
 /config.json
 /config
 /purgeArchives
+/logs
 
 # Eclipse settings
 .classpath

README.md

@@ -1,12 +1,13 @@
-# JavaBot
+# JavaBot — General Utility Bot for the [JavaDiscord Community](https://join.javadiscord.net/)
 
-General utility bot for the [JavaDiscord Community](https://join.javadiscord.net/)
+![Banner](https://user-images.githubusercontent.com/48297101/174893242-c8fc553a-e36b-4c5f-91d3-9c3bc659a7c9.png)
 
 # Usage 
 
 To start up, run the bot once, and it will generate a `config` directory. Stop the bot, and set the up **all of the following values**:
 - in `systems.json`
   - `jdaBotToken` to your bot's token
+  - (some `adminUsers` which, e.g., can manipulate the database)
 - in `{guildId}.json`
   - `moderation.logChannelId` to a channelId
   - `moderation.staffRoleId` to a roleId
@@ -15,65 +16,49 @@ To start up, run the bot once, and it will generate a `config` directory. Stop t
 
 Note that this is just what is required for the bot to start. Certain features may require other values to be set.
 
+# Configuration
 
-# Commands
-Commands are defined in this bot using a `.yaml` configuration file located in `src/main/resources/commands`. The data in this file is transformed at startup time into an array of `net.javadiscord.javabot.command.data.slash_commands.SlashCommandConfig` objects using JSON deserialization.
-
-These commands are then used by `net.javadiscord.javabot.command.InteractionHandler#registerSlashCommands(Guild)` to register the defined commands as Discord slash commands which become available to users in guilds and private messages with the bot.
-
-**Each command MUST define a `handler` property, whose name is the fully-qualified class name of a `SlashCommand`.** When registering commands, the bot will look for such a class, and attempt to create a new instance of it using a no-args constructor. Therefore, make sure that your handler class has a no-args constructor.
-
-### Privileges
-To specify that a command should only be allowed to be executed by certain people, you can specify a list of privileges. For example:
-```yaml
-- name: jam-admin
-  description: Administrator actions for configuring the Java Jam.
-  handler: net.javadiscord.javabot.systems.jam.JamAdminCommandHandler
-  enabledByDefault: false
-  privileges:
-    - type: ROLE
-      id: jam.adminRoleId
-    - type: USER
-      id: 235439851263098880
-```
-In this example, we define that the `jam-admin` command is first of all, *not enabled by default*, and also we say that anyone from the `jam.adminRoleId` role (as found using `Bot.config.getJam().getAdminRoleId()`). Additionally, we also say that the user whose id is `235439851263098880` is allowed to use this command. See `BotConfig#resolve(String)` for more information about how role names are resolved at runtime.
-
-*Context-Commands work in almost the same way, follow the steps above but replace `SlashCommand` with `MessageContextCommand` or `UserContextCommand`.*
+The bot's configuration consists of a collection of simple JSON files:
+- `systems.json` contains global settings for the bot's core systems.
+- For every guild, a `{guildId}.json` file exists, which contains any guild-specific configuration settings.
 
-### Autocomplete
-To enable Autocomplete for a certain Slash Command Option, head to the command's entry in the corresponding 
-YAML-File and set the `autocomplete` value.
+At startup, the bot will initially start by loading just the global settings, and then when the Discord ready event is received, the bot will add configuration for each guild it's in, loading it from the matching JSON file, or creating a new file if needed.
 
-```yaml
-- name: remove
-  description: Removes a question from the queue.
-  options:
-    - name: id
-      description: The id of the question to remove.
-      required: true
-      autocomplete: true
-      type: INTEGER
-```
+# Commands
 
-Now, you just need to implement `Autocompletable` in your handler class.
+We're using [DIH4JDA](https://github.com/DynxstyGIT/DIH4JDA) as our Command/Interaction framework, which makes it quite easy to add new commands.
 
+[PingCommand.java](https://github.com/Java-Discord/JavaBot/blob/main/src/main/java/net/javadiscord/javabot/systems/commands/PingCommand.java)
 ```java
-@Override
-public AutoCompleteCallbackAction handleAutocomplete(CommandAutoCompleteInteractionEvent event) {
-    return switch (event.getSubcommandName()) {
-        case "remove" -> ListQuestionsSubcommand.replyQuestions(event);
-        default -> event.replyChoices();
-    };
+/**
+ * <h3>This class represents the /ping command.</h3>
+ */
+public class PingCommand extends SlashCommand {
+	/**
+	 * The constructor of this class, which sets the corresponding {@link net.dv8tion.jda.api.interactions.commands.build.SlashCommandData}.
+	 */
+	public PingCommand() {
+		setSlashCommandData(Commands.slash("ping", "Shows the bot's gateway ping.")
+				.setGuildOnly(true)
+		);
+	}
+
+	@Override
+	public void execute(@NotNull SlashCommandInteractionEvent event) {
+		event.replyEmbeds(new EmbedBuilder()
+				.setAuthor(event.getJDA().getGatewayPing() + "ms", null, event.getJDA().getSelfUser().getAvatarUrl())
+				.setColor(Responses.Type.DEFAULT.getColor())
+				.build()
+		).queue();
+	}
 }
 ```
 
-The `handleAutocomplete` method of your handler class now gets fired once someone is focusing any Slash Command Option that has the `autocomplete`
-property set to true. 
+For more information on how this works, visit the [DIH4JDA Wiki!](https://github.com/DynxstyGIT/DIH4JDA/wiki)
 
+# Credits
 
-# Configuration
-The bot's configuration consists of a collection of simple JSON files:
-- `systems.json` contains global settings for the bot's core systems.
-- For every guild, a `{guildId}.json` file exists, which contains any guild-specific configuration settings.
+Inspiration we took from other communities:
 
-At startup, the bot will initially start by loading just the global settings, and then when the Discord ready event is received, the bot will add configuration for each guild it's in, loading it from the matching JSON file, or creating a new file if needed.
+- We designed our [Help Channel System](https://github.com/Java-Discord/JavaBot/tree/main/src/main/java/net/javadiscord/javabot/systems/help) similar to the one on the [Python Discord](https://discord.gg/python).
+- [`/move-conversation`](https://github.com/Java-Discord/JavaBot/blob/main/src/main/java/net/javadiscord/javabot/systems/user_commands/MoveConversationCommand.java) is heavily inspired by the [Rust Programming Language Community Server](https://discord.gg/rust-lang-community)

build.gradle.kts

@@ -22,7 +22,9 @@ dependencies {
     testImplementation("org.junit.jupiter:junit-jupiter-api:5.8.2")
     testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.8.2")
 
-    implementation("net.dv8tion:JDA:5.0.0-alpha.12")
+    // DIH4JDA (Interaction Framework) (includes JDA (jda5.0.0-alpha.17))
+    implementation("com.github.DynxstyGIT:DIH4JDA:f87f54eb42")
+
     implementation("com.google.code.gson:gson:2.9.0")
     implementation("org.yaml:snakeyaml:1.30")
     implementation("com.google.re2j:re2j:1.6")
@@ -32,20 +34,23 @@ dependencies {
     implementation("com.mashape.unirest:unirest-java:1.4.9")
 
     // H2 Database
-    implementation("com.h2database:h2:1.4.200")
+    implementation("com.h2database:h2:2.1.212")
     implementation("com.zaxxer:HikariCP:5.0.1")
 
-    // Quartz scheduler
+    // Quartz Scheduler
     implementation("org.quartz-scheduler:quartz:2.3.2")
 
     // Webhooks
-    implementation("club.minnced:discord-webhooks:0.8.0")
+    implementation("com.github.DynxstyGIT:discord-webhooks:74301a46a0")
 
     // Lombok Annotations
     compileOnly("org.projectlombok:lombok:1.18.24")
     annotationProcessor("org.projectlombok:lombok:1.18.24")
     testCompileOnly("org.projectlombok:lombok:1.18.24")
     testAnnotationProcessor("org.projectlombok:lombok:1.18.24")
+
+    // Sentry
+    implementation("io.sentry:sentry:6.3.0")
 }
 
 tasks.withType<Jar> {

src/main/java/net/javadiscord/javabot/Bot.java

@@ -1,6 +1,10 @@
 package net.javadiscord.javabot;
 
+import com.dynxsty.dih4jda.DIH4JDA;
+import com.dynxsty.dih4jda.DIH4JDABuilder;
+import com.dynxsty.dih4jda.interactions.commands.RegistrationType;
 import com.zaxxer.hikari.HikariDataSource;
+import io.sentry.Sentry;
 import lombok.extern.slf4j.Slf4j;
 import net.dv8tion.jda.api.JDA;
 import net.dv8tion.jda.api.JDABuilder;
@@ -11,25 +15,41 @@
 import net.dv8tion.jda.api.utils.ChunkingFilter;
 import net.dv8tion.jda.api.utils.MemberCachePolicy;
 import net.dv8tion.jda.api.utils.cache.CacheFlag;
-import net.javadiscord.javabot.command.InteractionHandler;
 import net.javadiscord.javabot.data.config.BotConfig;
 import net.javadiscord.javabot.data.h2db.DbHelper;
+import net.javadiscord.javabot.data.h2db.commands.QuickMigrateSubcommand;
 import net.javadiscord.javabot.data.h2db.message_cache.MessageCache;
 import net.javadiscord.javabot.data.h2db.message_cache.MessageCacheListener;
 import net.javadiscord.javabot.listener.*;
+import net.javadiscord.javabot.systems.help.HelpChannelInteractionManager;
 import net.javadiscord.javabot.systems.help.HelpChannelListener;
 import net.javadiscord.javabot.systems.moderation.AutoMod;
-import net.javadiscord.javabot.systems.moderation.ServerLock;
+import net.javadiscord.javabot.systems.moderation.report.ReportManager;
+import net.javadiscord.javabot.systems.moderation.server_lock.ServerLockManager;
+import net.javadiscord.javabot.systems.qotw.commands.questions_queue.AddQuestionSubcommand;
+import net.javadiscord.javabot.systems.qotw.submissions.SubmissionInteractionManager;
+import net.javadiscord.javabot.systems.staff_commands.self_roles.SelfRoleInteractionManager;
+import net.javadiscord.javabot.systems.staff_commands.embeds.AddEmbedFieldSubcommand;
+import net.javadiscord.javabot.systems.staff_commands.embeds.CreateEmbedSubcommand;
+import net.javadiscord.javabot.systems.staff_commands.embeds.EditEmbedSubcommand;
 import net.javadiscord.javabot.systems.starboard.StarboardManager;
+import net.javadiscord.javabot.systems.staff_commands.tags.CustomTagManager;
+import net.javadiscord.javabot.systems.staff_commands.tags.commands.CreateCustomTagSubcommand;
+import net.javadiscord.javabot.systems.staff_commands.tags.commands.EditCustomTagSubcommand;
+import net.javadiscord.javabot.systems.user_commands.leaderboard.ExperienceLeaderboardSubcommand;
+import net.javadiscord.javabot.tasks.MetricsUpdater;
 import net.javadiscord.javabot.tasks.PresenceUpdater;
 import net.javadiscord.javabot.tasks.ScheduledTasks;
-import net.javadiscord.javabot.tasks.StatsUpdater;
-import net.javadiscord.javabot.util.ImageCacheUtils;
+import net.javadiscord.javabot.util.ExceptionLogger;
+import net.javadiscord.javabot.util.InteractionUtils;
+import org.jetbrains.annotations.NotNull;
 import org.quartz.SchedulerException;
 
 import java.nio.file.Path;
 import java.time.ZoneOffset;
 import java.util.EnumSet;
+import java.util.List;
+import java.util.Map;
 import java.util.TimeZone;
 import java.util.concurrent.Executors;
 import java.util.concurrent.ScheduledExecutorService;
@@ -44,36 +64,44 @@ public class Bot {
 	 * The set of configuration properties that this bot uses.
 	 */
 	public static BotConfig config;
-	/**
-	 * A reference to the slash command listener that's the main point of
-	 * interaction for users with this bot. It's marked as a publicly accessible
-	 * reference so that {@link InteractionHandler#registerCommands} can
-	 * be called wherever it's needed.
-	 */
-	public static InteractionHandler interactionHandler;
+
 	/**
 	 * An instance of {@link AutoMod}.
-	 * */
+	 */
 	public static AutoMod autoMod;
+
+	/**
+	 * A reference to the Bot's {@link DIH4JDA}.
+	 */
+	public static DIH4JDA dih4jda;
+
 	/**
 	 * The Bots {@link MessageCache}, which handles logging of deleted and edited messages.
 	 */
 	public static MessageCache messageCache;
+
+	/**
+	 * A reference to the Bot's {@link ServerLockManager}.
+	 */
+	public static ServerLockManager serverLockManager;
+
+	/**
+	 * A static reference to the {@link CustomTagManager} which handles and loads all registered Custom Commands.
+	 */
+	public static CustomTagManager customTagManager;
+
 	/**
 	 * A reference to the data source that provides access to the relational
 	 * database that this bot users for certain parts of the application. Use
 	 * this to obtain a connection and perform transactions.
 	 */
 	public static HikariDataSource dataSource;
+
 	/**
 	 * A general-purpose thread pool that can be used by the bot to execute
 	 * tasks outside the main event processing thread.
 	 */
 	public static ScheduledExecutorService asyncPool;
-	/**
-	 * A reference to the Bot's {@link ImageCacheUtils}.
-	 */
-	public static ImageCacheUtils imageCache;
 
 	private Bot() {
 	}
@@ -83,8 +111,8 @@ private Bot() {
 	 * <ol>
 	 *     <li>Setting the time zone to UTC, to keep our sanity when working with times.</li>
 	 *     <li>Loading the configuration JSON file.</li>
-	 *     <li>Initializing the {@link InteractionHandler} listener (which reads command data from a YAML file).</li>
 	 *     <li>Creating and configuring the {@link JDA} instance that enables the bot's Discord connectivity.</li>
+	 *     <li>Initializing the {@link DIH4JDA} instance.</li>
 	 *     <li>Adding event listeners to the bot.</li>
 	 * </ol>
 	 *
@@ -95,56 +123,93 @@ public static void main(String[] args) throws Exception {
 		TimeZone.setDefault(TimeZone.getTimeZone(ZoneOffset.UTC));
 		config = new BotConfig(Path.of("config"));
 		dataSource = DbHelper.initDataSource(config);
-		interactionHandler = new InteractionHandler();
-		messageCache = new MessageCache();
-		autoMod = new AutoMod();
-		imageCache = new ImageCacheUtils();
 		asyncPool = Executors.newScheduledThreadPool(config.getSystems().getAsyncPoolSize());
-		var jda = JDABuilder.createDefault(config.getSystems().getJdaBotToken())
+		autoMod = new AutoMod();
+		JDA jda = JDABuilder.createDefault(config.getSystems().getJdaBotToken())
 				.setStatus(OnlineStatus.DO_NOT_DISTURB)
 				.setChunkingFilter(ChunkingFilter.ALL)
 				.setMemberCachePolicy(MemberCachePolicy.ALL)
 				.enableCache(CacheFlag.ACTIVITY)
-				.enableIntents(GatewayIntent.GUILD_MEMBERS, GatewayIntent.GUILD_PRESENCES)
-				.addEventListeners(interactionHandler, autoMod)
+				.enableIntents(GatewayIntent.GUILD_MEMBERS, GatewayIntent.GUILD_PRESENCES, GatewayIntent.MESSAGE_CONTENT)
+				.addEventListeners(autoMod, new StateListener())
 				.build();
-		AllowedMentions.setDefaultMentions(EnumSet.of(Message.MentionType.ROLE, Message.MentionType.CHANNEL, Message.MentionType.USER, Message.MentionType.EMOTE));
-		addEventListeners(jda);
+		AllowedMentions.setDefaultMentions(EnumSet.of(Message.MentionType.ROLE, Message.MentionType.CHANNEL, Message.MentionType.USER, Message.MentionType.EMOJI));
+		dih4jda = DIH4JDABuilder.setJDA(jda)
+				.setCommandsPackage("net.javadiscord.javabot")
+				.setDefaultCommandType(RegistrationType.GUILD)
+				.build();
+		customTagManager = new CustomTagManager(jda, dataSource);
+		messageCache = new MessageCache();
+		serverLockManager = new ServerLockManager(jda);
+		addEventListeners(jda, dih4jda);
+		addComponentHandler(dih4jda);
+		// initialize Sentry
+		Sentry.init(options -> {
+			options.setDsn(config.getSystems().getSentryDsn());
+			options.setTracesSampleRate(1.0);
+			options.setDebug(false);
+		});
 		try {
 			ScheduledTasks.init(jda);
 			log.info("Initialized scheduled tasks.");
 		} catch (SchedulerException e) {
+			ExceptionLogger.capture(e, Bot.class.getSimpleName());
 			log.error("Could not initialize all scheduled tasks.", e);
 			jda.shutdown();
 		}
 	}
 
 	/**
-	 * Adds all the bot's event listeners to the JDA instance, except for the
-	 * main {@link InteractionHandler} listener and {@link AutoMod}.
+	 * Adds all the bot's event listeners to the JDA instance, except for
+	 * the {@link AutoMod} instance.
 	 *
-	 * @param jda The JDA bot instance to add listeners to.
+	 * @param jda     The JDA bot instance to add listeners to.
+	 * @param dih4jda The {@link DIH4JDA} instance.
 	 */
-	private static void addEventListeners(JDA jda) {
+	private static void addEventListeners(@NotNull JDA jda, @NotNull DIH4JDA dih4jda) {
 		jda.addEventListener(
+				serverLockManager,
+				PresenceUpdater.standardActivities(),
 				new MessageCacheListener(),
 				new GitHubLinkListener(),
 				new MessageLinkListener(),
 				new GuildJoinListener(),
-				new ServerLock(jda),
 				new UserLeaveListener(),
-				new StartupListener(),
-				PresenceUpdater.standardActivities(),
-				new StatsUpdater(),
+				new MetricsUpdater(),
 				new SuggestionListener(),
 				new StarboardManager(),
-				new InteractionListener(),
 				new HelpChannelListener(),
 				new ShareKnowledgeVoteListener(),
 				new JobChannelVoteListener(),
 				new PingableNameListener(),
 				new HugListener()
 		);
+		dih4jda.addListener(new DIH4JDAListener());
+	}
+
+	private static void addComponentHandler(@NotNull DIH4JDA dih4jda) {
+		dih4jda.addButtonHandlers(Map.of(
+				List.of("experience-leaderboard"), new ExperienceLeaderboardSubcommand(),
+				List.of("utils"), new InteractionUtils(),
+				List.of("resolve-report"), new ReportManager(),
+				List.of("self-role"), new SelfRoleInteractionManager(),
+				List.of("qotw-submission"), new SubmissionInteractionManager(),
+				List.of("help-channel", "help-thank"), new HelpChannelInteractionManager()
+		));
+		dih4jda.addModalHandlers(Map.of(
+				List.of("qotw-add-question"), new AddQuestionSubcommand(),
+				List.of("embed-create"), new CreateEmbedSubcommand(),
+				List.of(EditEmbedSubcommand.EDIT_EMBED_ID), new EditEmbedSubcommand(),
+				List.of("embed-addfield"), new AddEmbedFieldSubcommand(),
+				List.of("quick-migrate"), new QuickMigrateSubcommand(),
+				List.of("report"), new ReportManager(),
+				List.of("self-role"), new SelfRoleInteractionManager(),
+				List.of("tag-create"), new CreateCustomTagSubcommand(),
+				List.of("tag-edit"), new EditCustomTagSubcommand()
+		));
+		dih4jda.addSelectMenuHandlers(Map.of(
+				List.of("qotw-submission-select"), new SubmissionInteractionManager()
+		));
 	}
 }