First pass on implementing internal API

Author: jasonlessenich

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
 }
 
@@ -26,6 +30,9 @@ dependencies {
     implementation("com.github.DenuxPlays:DIH4JDA:7ac2c9c77c")
     implementation("org.reflections:reflections:0.10.2")
 
+    // Discord OAuth2
+    implementation("com.github.Mokulu:discord-oauth2-api:1.0.2")
+
     implementation("com.google.code.gson:gson:2.9.0")
     implementation("org.yaml:snakeyaml:1.30")
     implementation("com.google.re2j:re2j:1.6")
@@ -52,6 +59,12 @@ dependencies {
 
     // Sentry
     implementation("io.sentry:sentry:6.3.0")
+
+    // Spring Boot
+    implementation("org.springframework.boot:spring-boot-starter-web:2.7.0")
+
+    // Apache HTTP-Client
+    implementation("org.apache.httpcomponents:httpclient:4.5.13")
 }
 
 tasks.withType<Jar> {
@@ -67,6 +80,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"))

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

@@ -4,7 +4,9 @@
 import com.dynxsty.dih4jda.DIH4JDABuilder;
 import com.dynxsty.dih4jda.interactions.commands.RegistrationType;
 import com.zaxxer.hikari.HikariDataSource;
+import io.mokulu.discord.oauth.DiscordOAuth;
 import io.sentry.Sentry;
+import lombok.Getter;
 import lombok.extern.slf4j.Slf4j;
 import net.dv8tion.jda.api.JDA;
 import net.dv8tion.jda.api.JDABuilder;
@@ -16,6 +18,7 @@
 import net.dv8tion.jda.api.utils.MemberCachePolicy;
 import net.dv8tion.jda.api.utils.cache.CacheFlag;
 import net.javadiscord.javabot.data.config.BotConfig;
+import net.javadiscord.javabot.data.config.SystemsConfig;
 import net.javadiscord.javabot.data.h2db.DbHelper;
 import net.javadiscord.javabot.data.h2db.commands.QuickMigrateSubcommand;
 import net.javadiscord.javabot.data.h2db.message_cache.MessageCache;
@@ -45,6 +48,8 @@
 import net.javadiscord.javabot.util.InteractionUtils;
 import org.jetbrains.annotations.NotNull;
 import org.quartz.SchedulerException;
+import org.springframework.boot.SpringApplication;
+import org.springframework.boot.autoconfigure.SpringBootApplication;
 
 import java.nio.file.Path;
 import java.time.ZoneOffset;
@@ -59,26 +64,37 @@
  * The main class where the bot is initialized.
  */
 @Slf4j
+@SpringBootApplication
 public class Bot {
 
+	@Getter
 	private static BotConfig config;
 
+	@Getter
 	private static AutoMod autoMod;
 
+	@Getter
 	private static DIH4JDA dih4jda;
 
+	@Getter
+	private static DiscordOAuth oAuth;
+
+	@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() {
-	}
+	public Bot() {}
 
 	/**
 	 * The main method that starts the bot. This involves a few steps:
@@ -112,6 +128,8 @@ public static void main(String[] args) throws Exception {
 				.setCommandsPackage("net.javadiscord.javabot")
 				.setDefaultCommandType(RegistrationType.GLOBAL)
 				.build();
+		SystemsConfig.ApiConfig apiConfig = config.getSystems().getApiConfig();
+		oAuth = new DiscordOAuth(jda.getSelfUser().getApplicationId(), apiConfig.getClientSecret(), apiConfig.getRedirectUrl(), apiConfig.getScopes());
 		customTagManager = new CustomTagManager(jda, dataSource);
 		messageCache = new MessageCache();
 		serverLockManager = new ServerLockManager(jda);
@@ -131,6 +149,7 @@ public static void main(String[] args) throws Exception {
 			log.error("Could not initialize all scheduled tasks.", e);
 			jda.shutdown();
 		}
+		SpringApplication.run(Bot.class, args);
 	}
 
 	/**
@@ -186,80 +205,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/model/MetricsData.java

@@ -0,0 +1,10 @@
+package net.javadiscord.javabot.api.model;
+
+import lombok.Data;
+
+@Data
+public class MetricsData {
+	private long memberCount;
+	private long onlineCount;
+
+}

src/main/java/net/javadiscord/javabot/api/model/QOTWLeaderboardData.java

@@ -0,0 +1,11 @@
+package net.javadiscord.javabot.api.model;
+
+import lombok.Data;
+import net.javadiscord.javabot.systems.qotw.model.QOTWAccount;
+
+import java.util.List;
+
+@Data
+public class QOTWLeaderboardData {
+	private List<QOTWAccount> accounts;
+}

src/main/java/net/javadiscord/javabot/api/model/UserProfileData.java

@@ -0,0 +1,19 @@
+package net.javadiscord.javabot.api.model;
+
+import lombok.Data;
+import net.javadiscord.javabot.systems.help.model.HelpAccount;
+import net.javadiscord.javabot.systems.moderation.warn.model.Warn;
+import net.javadiscord.javabot.systems.qotw.model.QOTWAccount;
+import net.javadiscord.javabot.systems.user_preferences.model.UserPreference;
+
+import java.util.List;
+
+@Data
+public class UserProfileData {
+	private long userId;
+	private String avatarUrl;
+	private QOTWAccount qotwAccount;
+	private HelpAccount helpAccount;
+	private List<UserPreference> preferences;
+	private List<Warn> warns;
+}

src/main/java/net/javadiscord/javabot/data/config/SystemsConfig.java

@@ -42,6 +42,11 @@ public class SystemsConfig {
 	 */
 	private HikariConfig hikariConfig = new HikariConfig();
 
+	/**
+	 * Configurations settings for the bots' internal API.
+	 */
+	private ApiConfig apiConfig = new ApiConfig();
+
 	/**
 	 * Configuration settings for certain commands which need an extra layer of
 	 * security.
@@ -53,6 +58,16 @@ public class SystemsConfig {
 	 */
 	private EmojiConfig emojiConfig = new EmojiConfig();
 
+	/**
+	 * Configurations settings for the bots' internal API.
+	 */
+	@Data
+	public static class ApiConfig {
+		private String clientSecret = "";
+		private String redirectUrl = "";
+		private String[] scopes = new String[]{};
+	}
+
 	/**
 	 * Configuration settings for the Hikari connection pool.
 	 */

src/main/java/net/javadiscord/javabot/listener/GuildJoinListener.java

@@ -13,7 +13,7 @@ public class GuildJoinListener extends ListenerAdapter {
 	public void onGuildJoin(GuildJoinEvent event) {
 		Bot.getConfig().addGuild(event.getGuild());
 		try {
-			Bot.getDIH4JDA().registerInteractions();
+			Bot.getDih4jda().registerInteractions();
 		} catch (ReflectiveOperationException e) {
 			ExceptionLogger.capture(e, getClass().getSimpleName());
 		}

src/main/java/net/javadiscord/javabot/systems/moderation/warn/model/Warn.java

@@ -2,6 +2,7 @@
 
 import lombok.Data;
 import lombok.NoArgsConstructor;
+import org.jetbrains.annotations.NotNull;
 
 import java.time.LocalDateTime;
 
@@ -28,7 +29,7 @@ public class Warn {
 	 * @param severity The severity of the warning.
 	 * @param reason   The reason for the warning.
 	 */
-	public Warn(long userId, long warnedBy, WarnSeverity severity, String reason) {
+	public Warn(long userId, long warnedBy, @NotNull WarnSeverity severity, String reason) {
 		this.userId = userId;
 		this.warnedBy = warnedBy;
 		this.severity = severity.name();

src/main/resources/application.properties

@@ -0,0 +1 @@
+server.port=9000