Merge pull request #18 from Java-Discord/andrew/moderation_services

Improved Moderation Service

Author: andrewlalis

.gitignore

@@ -1,4 +1,6 @@
 .idea/
 .gradle/
 build/
-/javabot_config/
+/javabot_config/
+/javabot.mv.db
+/javabot.trace.db

build.gradle

@@ -11,17 +11,20 @@ targetCompatibility = 16
 
 repositories {
     mavenCentral()
+    maven {
+        url "https://oss.sonatype.org/content/repositories/snapshots/"
+    }
 }
 
 dependencies {
-    implementation 'org.javacord:javacord:3.3.2'
+    implementation 'org.javacord:javacord:3.4.0-SNAPSHOT'
 
     implementation 'org.yaml:snakeyaml:1.29'
     implementation 'com.google.code.gson:gson:2.8.9'
 
     // Persistence Dependencies
     implementation 'org.mongodb:mongodb-driver:3.12.10'
-    implementation 'org.postgresql:postgresql:42.3.0'
+    implementation 'com.h2database:h2:1.4.200'
     implementation 'com.zaxxer:HikariCP:5.0.0'
 
     // Lombok annotations

checkstyle/checkstyle.xml

@@ -49,7 +49,6 @@ See https://checkstyle.org/ for more information.
         <module name="IllegalToken"/>
         <module name="IllegalType"/>
         <module name="InnerAssignment"/>
-        <module name="MagicNumber"/>
         <module name="MultipleStringLiterals">
             <property name="allowedDuplicates" value="3"/>
         </module>
@@ -58,8 +57,8 @@ See https://checkstyle.org/ for more information.
         <module name="OneStatementPerLine"/>
         <module name="PackageDeclaration"/>
         <module name="ReturnCount">
-            <property name="max" value="5"/>
-            <property name="maxForVoid" value="8"/>
+            <property name="max" value="8"/>
+            <property name="maxForVoid" value="10"/>
         </module>
         <module name="SimplifyBooleanExpression"/>
         <module name="SimplifyBooleanReturn"/>

docker-compose.yaml

@@ -22,27 +22,3 @@ services:
       ME_CONFIG_MONGODB_ADMINUSERNAME: root
       ME_CONFIG_MONGODB_ADMINPASSWORD: example
       ME_CONFIG_MONGODB_URL: mongodb://root:example@mongo:27017/
-  # Postgresql Relational Database
-  postgres:
-    image: postgres:latest
-    container_name: javabot_postgres
-    restart: unless-stopped
-    environment:
-      POSTGRES_USER: javabot_dev
-      POSTGRES_PASSWORD: javabot_dev_pass
-      POSTGRES_DB: javabot
-    ports:
-      - "27172:5432"
-
-  # Admin site for postgres. Connect via http://localhost:5051
-  pgadmin:
-    image: dpage/pgadmin4
-    container_name: javabot_pgadmin
-    environment:
-      PGADMIN_DEFAULT_EMAIL: pgadmin4@pgadmin.org
-      PGADMIN_DEFAULT_PASSWORD: admin
-      PGADMIN_CONFIG_SERVER_MODE: 'False'
-    depends_on:
-      - postgres
-    ports:
-      - "5051:80"

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

@@ -5,21 +5,27 @@
 import com.mongodb.client.MongoDatabase;
 import com.mongodb.client.model.IndexOptions;
 import com.mongodb.client.model.Indexes;
-import com.zaxxer.hikari.HikariConfig;
 import com.zaxxer.hikari.HikariDataSource;
+import lombok.extern.slf4j.Slf4j;
 import net.javadiscord.javabot2.command.SlashCommandListener;
 import net.javadiscord.javabot2.config.BotConfig;
+import net.javadiscord.javabot2.db.DbHelper;
+import net.javadiscord.javabot2.systems.moderation.ModerationService;
 import org.javacord.api.DiscordApi;
 import org.javacord.api.DiscordApiBuilder;
 import org.javacord.api.entity.intent.Intent;
 
 import java.nio.file.Path;
+import java.time.ZoneOffset;
+import java.util.TimeZone;
 import java.util.concurrent.Executors;
 import java.util.concurrent.ScheduledExecutorService;
+import java.util.concurrent.TimeUnit;
 
 /**
  * The main program entry point.
  */
+@Slf4j
 public class Bot {
 	/**
 	 * A connection pool that can be used to obtain new JDBC connections.
@@ -28,12 +34,18 @@ public class Bot {
 
 	/**
 	 * A thread-safe MongoDB client that can be used to interact with MongoDB.
+	 * @deprecated Use the relational data source for all future persistence
+	 * needs; it promotes more organized code that's less prone to failures.
 	 */
+	@Deprecated
 	public static MongoClient mongoClient;
 
 	/**
 	 * The single Mongo database where all bot data is stored.
+	 * @deprecated Use the relational data source for all future persistence
+	 * needs; it promotes more organized code that's less prone to failures.
 	 */
+	@Deprecated
 	public static MongoDatabase mongoDb;
 
 	/**
@@ -54,6 +66,7 @@ private Bot() {}
 	 * @param args Command-line arguments.
 	 */
 	public static void main(String[] args) {
+		TimeZone.setDefault(TimeZone.getTimeZone(ZoneOffset.UTC));
 		initDataSources();
 		asyncPool = Executors.newScheduledThreadPool(config.getSystems().getAsyncPoolSize());
 		DiscordApi api = new DiscordApiBuilder()
@@ -68,6 +81,7 @@ public static void main(String[] args) {
 				"commands/moderation.yaml"
 		);
 		api.addSlashCommandCreateListener(commandListener);
+		initScheduledTasks(api);
 	}
 
 	/**
@@ -80,14 +94,7 @@ private static void initDataSources() {
 		if (config.getSystems().getDiscordBotToken() == null || config.getSystems().getDiscordBotToken().isBlank()) {
 			throw new IllegalStateException("Missing required Discord bot token! Please edit config/systems.json to add it, then run again.");
 		}
-		var hikariConfig = new HikariConfig();
-		var hikariConfigSource = config.getSystems().getHikariConfig();
-		hikariConfig.setJdbcUrl(hikariConfigSource.getJdbcUrl());
-		hikariConfig.setUsername(hikariConfigSource.getUsername());
-		hikariConfig.setPassword(hikariConfigSource.getPassword());
-		hikariConfig.setMaximumPoolSize(hikariConfigSource.getMaximumPoolSize());
-		hikariConfig.setConnectionInitSql(hikariConfigSource.getConnectionInitSql());
-		hikariDataSource = new HikariDataSource(hikariConfig);
+		hikariDataSource = DbHelper.initDataSource(config);
 		mongoDb = initMongoDatabase();
 	}
 
@@ -99,4 +106,13 @@ private static MongoDatabase initMongoDatabase() {
 		warnCollection.createIndex(Indexes.descending("createdAt"), new IndexOptions().unique(false));
 		return db;
 	}
+
+	private static void initScheduledTasks(DiscordApi api) {
+		// Regularly check for and unmute users whose mutes have expired.
+		asyncPool.scheduleAtFixedRate(() -> {
+			for (var server : api.getServers()) {
+				new ModerationService(api, config.get(server).getModeration()).unmuteExpired();
+			}
+		}, 1L, 1L, TimeUnit.MINUTES);
+	}
 }

src/main/java/net/javadiscord/javabot2/command/ResponseException.java

@@ -45,4 +45,13 @@ public static Supplier<ResponseException> warning(String message) {
 	public static Supplier<ResponseException> error(String message) {
 		return () -> new ResponseException(Responses.deferredErrorBuilder().message(message));
 	}
+
+	/**
+	 * Standard helper method to generate a supplier of a response exception
+	 * with a simple "invalid argument" warning message.
+	 * @return The exception supplier.
+	 */
+	public static Supplier<ResponseException> invalidArgument() {
+		return () -> new ResponseException(Responses.deferredWarningBuilder().message("Invalid argument."));
+	}
 }

src/main/java/net/javadiscord/javabot2/command/Responses.java

@@ -1,9 +1,9 @@
 package net.javadiscord.javabot2.command;
 
-import org.javacord.api.entity.message.MessageFlag;
 import org.javacord.api.entity.message.embed.EmbedBuilder;
 import org.javacord.api.event.interaction.SlashCommandCreateEvent;
 import org.javacord.api.interaction.InteractionBase;
+import org.javacord.api.interaction.callback.InteractionCallbackDataFlag;
 import org.javacord.api.interaction.callback.InteractionImmediateResponseBuilder;
 import org.javacord.api.interaction.callback.InteractionOriginalResponseUpdater;
 
@@ -90,7 +90,7 @@ private static InteractionImmediateResponseBuilder reply(
 					.setTimestampToNow()
 					.setDescription(message));
 		if (ephemeral) {
-			responder.setFlags(MessageFlag.EPHEMERAL);
+			responder.setFlags(InteractionCallbackDataFlag.EPHEMERAL);
 		}
 		return responder;
 	}

src/main/java/net/javadiscord/javabot2/config/SystemsConfig.java

@@ -38,10 +38,7 @@ public class SystemsConfig {
 	@Data
 	public static class HikariConfig {
 		private static final int DEFAULT_POOL_SIZE = 5;
-		private String jdbcUrl = "jdbc:postgresql://localhost:27172/javabot";
-		private String username = "javabot_dev";
-		private String password = "javabot_dev_pass";
+		private String jdbcUrl = "jdbc:h2:tcp://localhost:9123/./javabot";
 		private int maximumPoolSize = DEFAULT_POOL_SIZE;
-		private String connectionInitSql = "SET TIME ZONE 'UTC'";
 	}
 }

src/main/java/net/javadiscord/javabot2/config/guild/ModerationConfig.java

@@ -3,6 +3,7 @@
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import net.javadiscord.javabot2.config.GuildConfigItem;
+import org.javacord.api.entity.channel.ServerTextChannel;
 import org.javacord.api.entity.permission.Role;
 
 /**
@@ -21,15 +22,33 @@ public class ModerationConfig extends GuildConfigItem {
 	 * being removed from the server. Warnings older than this are still kept,
 	 * but ignored.
 	 */
-	private int warnTimeoutDays;
+	private int warnTimeoutDays = 30;
 
 	/**
 	 * The maximum total severity that a user can accrue from warnings before
 	 * being removed from the server.
 	 */
-	private int maxWarnSeverity;
+	private int maxWarnSeverity = 100;
+
+	/**
+	 * The id of the server's mute role.
+	 */
+	private long muteRoleId;
+
+	/**
+	 * The id of the channel where log messages are sent.
+	 */
+	private long logChannelId;
 
 	public Role getStaffRole() {
 		return this.getGuild().getRoleById(staffRoleId).orElseThrow();
 	}
+
+	public Role getMuteRole() {
+		return this.getGuild().getRoleById(muteRoleId).orElseThrow();
+	}
+
+	public ServerTextChannel getLogChannel() {
+		return this.getGuild().getChannelById(logChannelId).orElseThrow().asServerTextChannel().orElseThrow();
+	}
 }

src/main/java/net/javadiscord/javabot2/db/ConnectionConsumer.java

@@ -0,0 +1,12 @@
+package net.javadiscord.javabot2.db;
+
+import java.sql.Connection;
+import java.sql.SQLException;
+
+/**
+ * Functional interface for defining operations that use a Connection.
+ */
+@FunctionalInterface
+public interface ConnectionConsumer {
+	void consume(Connection con) throws SQLException;
+}