Merge remote-tracking branch 'origin/main' into dynxsty/fix-message-cache

Author: jasonlessenich

README.md

@@ -56,6 +56,22 @@ public class PingCommand extends SlashCommand {
 
 For more information on how this works, visit the [DIH4JDA Wiki!](https://github.com/DynxstyGIT/DIH4JDA/wiki)
 
+# API Documentation
+
+#### `GET` `guilds/{guild_id}/metrics` 
+- Responds with guild-specific metrics, such as the member- and (approximate) online count.
+
+#### `GET` `guilds/{guild_id}/users/{user_id}`
+- Responds with the specified users' profile which includes some basic info, such as the users' name and avatar url, but also their recent warns, their current help experience and more!
+
+#### `GET` `guilds/{guild_id}/leaderboard/qotw?page=1`
+- A paginated endpoint which responds with an ordered list of users, based on their QOTW points.
+
+#### `GET` `guilds/{guild_id}/leaderboard/experience?page=1`
+- A paginated endpoint which responds with an ordered list of users, based on their help channel experience.
+
+You can try out the API yourself on `api.javadiscord.net`! 
+
 # Credits
 
 Inspiration we took from other communities:

build.gradle.kts

@@ -1,6 +1,10 @@
+import com.github.jengelman.gradle.plugins.shadow.tasks.ShadowJar
+import com.github.jengelman.gradle.plugins.shadow.transformers.*
+
 plugins {
     java
     id("com.github.johnrengelman.shadow") version "7.1.2"
+    id("io.spring.dependency-management") version "1.0.11.RELEASE"
     checkstyle
 }
 
@@ -19,12 +23,17 @@ repositories {
 }
 
 dependencies {
-    testImplementation("org.junit.jupiter:junit-jupiter-api:5.8.2")
-    testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.8.2")
+    testImplementation("org.junit.jupiter:junit-jupiter-api:5.9.0")
+    testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.9.0")
+
+    // DIH4JDA (Interaction Framework) & JDA
+    implementation("com.github.DynxstyGIT:DIH4JDA:f564af77e9")
+    implementation("net.dv8tion:JDA:5.0.0-alpha.17") {
+        exclude(module = "opus-java")
+    }
 
-    // DIH4JDA (Interaction Framework) (includes JDA (jda5.0.0-alpha.17))
-    implementation("com.github.DenuxPlays:DIH4JDA:7ac2c9c77c")
-    implementation("org.reflections:reflections:0.10.2")
+    // Caffeine (Caching Library)
+    implementation("com.github.ben-manes.caffeine:caffeine:3.1.1")
 
     implementation("com.google.code.gson:gson:2.9.0")
     implementation("org.yaml:snakeyaml:1.30")
@@ -52,6 +61,9 @@ dependencies {
 
     // Sentry
     implementation("io.sentry:sentry:6.3.0")
+
+    // Spring Boot
+    implementation("org.springframework.boot:spring-boot-starter-web:2.7.0")
 }
 
 tasks.withType<Jar> {
@@ -67,6 +79,19 @@ tasks.withType<JavaCompile>().configureEach {
 }
 tasks.withType<Test>{ useJUnitPlatform() }
 
+tasks.withType<ShadowJar> {
+    isZip64 = true
+    // Required for Spring
+    mergeServiceFiles()
+    append("META-INF/spring.handlers")
+    append("META-INF/spring.schemas")
+    append("META-INF/spring.tooling")
+    transform(PropertiesFileTransformer().apply {
+        paths = listOf("META-INF/spring.factories")
+        mergeStrategy = "append"
+    })
+}
+
 checkstyle {
     toolVersion = "9.1"
     configDirectory.set(File("checkstyle"))

checkstyle/checkstyle.xml

@@ -69,7 +69,6 @@ See https://checkstyle.org/ for more information.
         <module name="UnnecessarySemicolonInEnumeration"/>
         <module name="UnnecessarySemicolonInTryWithResources"/>
         <module name="InnerTypeLast"/>
-        <module name="HideUtilityClassConstructor"/>
         <module name="InterfaceIsType"/>
         <module name="MutableException"/>
         <module name="OneTopLevelClass"/>

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

@@ -2,9 +2,13 @@
 
 import com.dynxsty.dih4jda.DIH4JDA;
 import com.dynxsty.dih4jda.DIH4JDABuilder;
+import com.dynxsty.dih4jda.DIH4JDALogger;
+import com.dynxsty.dih4jda.interactions.commands.ContextCommand;
 import com.dynxsty.dih4jda.interactions.commands.RegistrationType;
+import com.dynxsty.dih4jda.interactions.commands.SlashCommand;
 import com.zaxxer.hikari.HikariDataSource;
 import io.sentry.Sentry;
+import lombok.Getter;
 import lombok.extern.slf4j.Slf4j;
 import net.dv8tion.jda.api.JDA;
 import net.dv8tion.jda.api.JDABuilder;
@@ -27,15 +31,16 @@
 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.commands.view.QOTWQuerySubcommand;
 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.self_roles.SelfRoleInteractionManager;
 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.starboard.StarboardManager;
 import net.javadiscord.javabot.systems.user_commands.leaderboard.ExperienceLeaderboardSubcommand;
 import net.javadiscord.javabot.tasks.MetricsUpdater;
 import net.javadiscord.javabot.tasks.PresenceUpdater;
@@ -44,6 +49,11 @@
 import net.javadiscord.javabot.util.InteractionUtils;
 import org.jetbrains.annotations.NotNull;
 import org.quartz.SchedulerException;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.context.annotation.ComponentScan;
+import org.springframework.context.annotation.FilterType;
 
 import java.nio.file.Path;
 import java.time.ZoneOffset;
@@ -58,33 +68,62 @@
  * The main class where the bot is initialized.
  */
 @Slf4j
+@SpringBootApplication
+@ComponentScan(includeFilters = @ComponentScan.Filter(type = FilterType.ASSIGNABLE_TYPE, classes = {SlashCommand.class, ContextCommand.class}))
 public class Bot {
 
+	@Getter
 	private static BotConfig config;
 
+	@Getter
 	private static AutoMod autoMod;
 
+	@Getter
 	private static DIH4JDA dih4jda;
 
+	@Getter
 	private static MessageCache messageCache;
 
+	@Getter
 	private static ServerLockManager serverLockManager;
 
+	@Getter
 	private static CustomTagManager customTagManager;
 
+	@Getter
 	private static HikariDataSource dataSource;
 
+	@Getter
 	private static ScheduledExecutorService asyncPool;
 
-	private Bot() {
+	/**
+	 * The constructor of this class, which also adds all {@link SlashCommand} and
+	 * {@link ContextCommand} to the {@link DIH4JDA} instance.
+	 *
+	 * @param commands The {@link Autowired} list of {@link SlashCommand}s.
+	 * @param contexts The {@link Autowired} list of {@link ContextCommand}s.
+	 */
+	@Autowired
+	public Bot(final List<SlashCommand> commands, final List<ContextCommand> contexts) {
+		if (!commands.isEmpty()) {
+			getDih4jda().addSlashCommands(commands.toArray(SlashCommand[]::new));
+		}
+		if (!contexts.isEmpty()) {
+			getDih4jda().addContextCommands(contexts.toArray(ContextCommand[]::new));
+		}
+		try {
+			getDih4jda().registerInteractions();
+		} catch (ReflectiveOperationException e) {
+			ExceptionLogger.capture(e, getClass().getSimpleName());
+		}
 	}
 
 	/**
 	 * The main method that starts the bot. This involves a few steps:
 	 * <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>Creating and configuring the {@link JDA} instance that enables the bot's Discord connectivity.</li>
+	 *     <li>Creating and configuring the {@link JDA} instance that enables the bots' Discord connectivity.</li>
 	 *     <li>Initializing the {@link DIH4JDA} instance.</li>
 	 *     <li>Adding event listeners to the bot.</li>
 	 * </ol>
@@ -108,8 +147,9 @@ public static void main(String[] args) throws Exception {
 				.build();
 		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)
+				.setDefaultCommandType(RegistrationType.GLOBAL)
+				.disableLogging(DIH4JDALogger.Type.SMART_QUEUE_IGNORED)
+				.disableAutomaticCommandRegistration()
 				.build();
 		customTagManager = new CustomTagManager(jda, dataSource);
 		messageCache = new MessageCache();
@@ -130,10 +170,11 @@ public static void main(String[] args) throws Exception {
 			log.error("Could not initialize all scheduled tasks.", e);
 			jda.shutdown();
 		}
+		SpringApplication.run(Bot.class, args);
 	}
 
 	/**
-	 * Adds all the bot's event listeners to the JDA instance, except for
+	 * Adds all the bots' event listeners to the JDA instance, except for
 	 * the {@link AutoMod} instance.
 	 *
 	 * @param jda     The JDA bot instance to add listeners to.
@@ -157,7 +198,7 @@ private static void addEventListeners(@NotNull JDA jda, @NotNull DIH4JDA dih4jda
 				new PingableNameListener(),
 				new HugListener()
 		);
-		dih4jda.addListener(new DIH4JDAListener());
+		dih4jda.addEventListener(new DIH4JDAListener());
 	}
 
 	private static void addComponentHandler(@NotNull DIH4JDA dih4jda) {
@@ -167,7 +208,8 @@ private static void addComponentHandler(@NotNull DIH4JDA dih4jda) {
 				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()
+				List.of("help-channel", "help-thank"), new HelpChannelInteractionManager(),
+				List.of("qotw-list-questions"), new QOTWQuerySubcommand()
 		));
 		dih4jda.addModalHandlers(Map.of(
 				List.of("qotw-add-question"), new AddQuestionSubcommand(),
@@ -184,80 +226,5 @@ private static void addComponentHandler(@NotNull DIH4JDA dih4jda) {
 				List.of("qotw-submission-select"), new SubmissionInteractionManager()
 		));
 	}
-
-	/**
-	 * The set of configuration properties that this bot uses.
-	 *
-	 * @return The {@link BotConfig} which was set in {@link Bot#main(String[])}.
-	 */
-	public static BotConfig getConfig() {
-		return config;
-	}
-
-	/**
-	 * A static reference to the bots' {@link AutoMod} instance.
-	 *
-	 * @return The {@link AutoMod} instance which was created in {@link Bot#main(String[])}.
-	 */
-	public static AutoMod getAutoMod() {
-		return autoMod;
-	}
-
-	/**
-	 * A static reference to the bots' {@link DIH4JDA} instance.
-	 *
-	 * @return The {@link DIH4JDA} instance which was set in {@link Bot#main(String[])}.
-	 */
-	public static DIH4JDA getDIH4JDA() {
-		return dih4jda;
-	}
-
-	/**
-	 * The bots' {@link MessageCache}, which handles logging of deleted and edited messages.
-	 *
-	 * @return The {@link MessageCache} which was initialized in {@link Bot#main(String[])}.
-	 */
-	public static MessageCache getMessageCache() {
-		return messageCache;
-	}
-
-	/**
-	 * A reference to the bots' {@link ServerLockManager}.
-	 *
-	 * @return The {@link ServerLockManager} which was created in {@link Bot#main(String[])}.
-	 */
-	public static ServerLockManager getServerLockManager() {
-		return serverLockManager;
-	}
-
-	/**
-	 * A static reference to the {@link CustomTagManager} which handles and loads all registered Custom Commands.
-	 *
-	 * @return The {@link CustomTagManager} which was created in {@link Bot#main(String[])}.
-	 */
-	public static CustomTagManager getCustomTagManager() {
-		return 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.
-	 *
-	 * @return The {@link HikariDataSource} which was initialized in {@link Bot#main(String[])}.
-	 */
-	public static HikariDataSource getDataSource() {
-		return dataSource;
-	}
-
-	/**
-	 * A general-purpose thread pool that can be used by the bot to execute
-	 * tasks outside the main event processing thread.
-	 *
-	 * @return The {@link ScheduledExecutorService} which was set in {@link Bot#main(String[])}.
-	 */
-	public static ScheduledExecutorService getAsyncPool() {
-		return asyncPool;
-	}
 }
 

src/main/java/net/javadiscord/javabot/api/SpringConfig.java

@@ -0,0 +1,17 @@
+package net.javadiscord.javabot.api;
+
+import net.dv8tion.jda.api.JDA;
+import net.javadiscord.javabot.Bot;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * This class holds all configuration settings and {@link Bean}s.
+ */
+@Configuration
+public class SpringConfig {
+	@Bean
+	public JDA getJDA() {
+		return Bot.getDih4jda().getJDA();
+	}
+}

src/main/java/net/javadiscord/javabot/api/TomcatConfig.java

@@ -0,0 +1,46 @@
+package net.javadiscord.javabot.api;
+
+import net.javadiscord.javabot.Bot;
+import org.apache.catalina.connector.Connector;
+import org.apache.coyote.ajp.AjpNioProtocol;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.web.embedded.tomcat.TomcatServletWebServerFactory;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * Holds all configuration for the {@link org.springframework.boot.autoconfigure.web.ServerProperties.Tomcat}
+ * web service.
+ */
+@Configuration
+public class TomcatConfig {
+
+	private final int ajpPort;
+
+	private final boolean tomcatAjpEnabled;
+
+	public TomcatConfig(@Value("${tomcat.ajp.port}") int ajpPort, @Value("${tomcat.ajp.enabled}") boolean tomcatAjpEnabled) {
+		this.ajpPort = ajpPort;
+		this.tomcatAjpEnabled = tomcatAjpEnabled;
+	}
+
+	/**
+	 * Sets up the {@link TomcatServletWebServerFactory} using the {@link Value}s defined in the
+	 * application.properties file.
+	 *
+	 * @return The {@link TomcatServletWebServerFactory}.
+	 */
+	@Bean
+	public TomcatServletWebServerFactory servletContainer() {
+		TomcatServletWebServerFactory tomcat = new TomcatServletWebServerFactory();
+		if (tomcatAjpEnabled) {
+			Connector ajpConnector = new Connector("org.apache.coyote.ajp.AjpNioProtocol");
+			AjpNioProtocol protocol= (AjpNioProtocol) ajpConnector.getProtocolHandler();
+			protocol.setSecret(Bot.getConfig().getSystems().getApiConfig().getAjpSecret());
+			ajpConnector.setPort(ajpPort);
+			ajpConnector.setSecure(true);
+			tomcat.addAdditionalTomcatConnectors(ajpConnector);
+		}
+		return tomcat;
+	}
+}