Merge develop into feat/help-thread-stats

Author: ankitsmt211

.github/workflows/docker-publish.yaml

@@ -0,0 +1,30 @@
+when:
+  branch:
+    - develop
+    - master
+  event: push
+
+steps:
+  publish:
+    image: eclipse-temurin:25-jdk
+    environment:
+      REGISTRY_USER:
+        from_secret: REGISTRY_USER
+      REGISTRY_PASSWORD:
+        from_secret: REGISTRY_PASSWORD
+      BRANCH_NAME: ${CI_COMMIT_BRANCH}
+    commands:
+      - echo ${CI_COMMIT_BRANCH}
+      - ./gradlew jib
+
+  deploy:
+    image: alpine
+    depends_on:
+      - publish
+    environment:
+      WATCHTOWER_TOKEN:
+        from_secret: WATCHTOWER_TOKEN
+    commands:
+      - apk add --no-cache curl
+      - | 
+        curl -H "Authorization: Bearer $WATCHTOWER_TOKEN" https://togetherjava.org:5003/v1/update

.woodpecker.yml

@@ -115,8 +115,6 @@ IF THE DISCLAIMER AND DAMAGE WAIVER MENTIONED IN SECTION 5. AND SECTION 6. CANNO
 
 ### Us
 
-Name: Daniel Tischner (aka Zabuzard, acting on behalf of Together Java)
-
 Organization: https://github.com/Together-Java
 
 Contact: https://discord.com/invite/XXFUXzK

CLA.md

@@ -57,7 +57,7 @@ dependencies {
 
     implementation 'io.mikael:urlbuilder:2.0.9'
 
-    implementation 'org.jsoup:jsoup:1.21.1'
+    implementation 'org.jsoup:jsoup:1.22.1'
 
     implementation 'org.scilab.forge:jlatexmath:1.0.7'
     implementation 'org.scilab.forge:jlatexmath-font-greek:1.0.7'
@@ -69,7 +69,7 @@ dependencies {
     implementation "com.fasterxml.jackson.core:jackson-databind:$jacksonVersion"
     implementation "com.sigpwned:jackson-modules-java17-sealed-classes:2.19.0.0"
 
-	implementation 'com.github.freva:ascii-table:1.8.0'
+	implementation 'com.github.freva:ascii-table:1.9.0'
 
     implementation 'io.github.url-detector:url-detector:0.1.23'
 
@@ -80,14 +80,13 @@ dependencies {
     implementation 'org.apache.commons:commons-text:1.15.0'
     implementation 'com.apptasticsoftware:rssreader:3.12.0'
 
-    testImplementation 'org.mockito:mockito-core:5.20.0'
+    testImplementation 'org.mockito:mockito-core:5.21.0'
     testImplementation "org.junit.jupiter:junit-jupiter-api:$junitVersion"
     testImplementation "org.junit.jupiter:junit-jupiter-params:$junitVersion"
     testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
     testRuntimeOnly "org.junit.jupiter:junit-jupiter-engine:$junitVersion"
 
-    implementation "com.theokanning.openai-gpt3-java:api:$chatGPTVersion"
-    implementation "com.theokanning.openai-gpt3-java:service:$chatGPTVersion"
+    implementation "com.openai:openai-java:$chatGPTVersion"
 }
 
 application {

application/build.gradle

@@ -194,10 +194,25 @@
         "videoLinkPattern": "http(s)?://www\\.youtube.com.*",
         "pollIntervalInMinutes": 10
     },
+    "quoteBoardConfig": {
+        "minimumReactionsToTrigger": 5,
+        "channel": "quotes",
+        "reactionEmoji": "⭐"
+    },
     "memberCountCategoryPattern": "Info",
     "topHelpers": {
         "rolePattern": "Top Helper.*",
         "assignmentChannelPattern": "community-commands",
         "announcementChannelPattern": "hall-of-fame"
+    },
+    "dynamicVoiceChatConfig": {
+        "dynamicChannelPatterns": [
+            "Gaming",
+            "Support/Studying Room",
+            "Chit Chat"
+        ],
+        "archiveCategoryPattern": "Voice Channel Archives",
+        "cleanChannelsAmount": 20,
+        "minimumChannelsAmount": 40
     }
 }

application/config.json.template

@@ -48,7 +48,9 @@ public final class Config {
     private final RSSFeedsConfig rssFeedsConfig;
     private final String selectRolesChannelPattern;
     private final String memberCountCategoryPattern;
+    private final QuoteBoardConfig quoteBoardConfig;
     private final TopHelpersConfig topHelpers;
+    private final DynamicVoiceChatConfig dynamicVoiceChatConfig;
 
     @SuppressWarnings("ConstructorWithTooManyParameters")
     @JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
@@ -102,7 +104,11 @@ private Config(@JsonProperty(value = "token", required = true) String token,
             @JsonProperty(value = "rssConfig", required = true) RSSFeedsConfig rssFeedsConfig,
             @JsonProperty(value = "selectRolesChannelPattern",
                     required = true) String selectRolesChannelPattern,
-            @JsonProperty(value = "topHelpers", required = true) TopHelpersConfig topHelpers) {
+            @JsonProperty(value = "quoteBoardConfig",
+                    required = true) QuoteBoardConfig quoteBoardConfig,
+            @JsonProperty(value = "topHelpers", required = true) TopHelpersConfig topHelpers,
+            @JsonProperty(value = "dynamicVoiceChatConfig",
+                    required = true) DynamicVoiceChatConfig dynamicVoiceChatConfig) {
         this.token = Objects.requireNonNull(token);
         this.githubApiKey = Objects.requireNonNull(githubApiKey);
         this.databasePath = Objects.requireNonNull(databasePath);
@@ -137,7 +143,9 @@ private Config(@JsonProperty(value = "token", required = true) String token,
         this.featureBlacklistConfig = Objects.requireNonNull(featureBlacklistConfig);
         this.rssFeedsConfig = Objects.requireNonNull(rssFeedsConfig);
         this.selectRolesChannelPattern = Objects.requireNonNull(selectRolesChannelPattern);
+        this.quoteBoardConfig = Objects.requireNonNull(quoteBoardConfig);
         this.topHelpers = Objects.requireNonNull(topHelpers);
+        this.dynamicVoiceChatConfig = Objects.requireNonNull(dynamicVoiceChatConfig);
     }
 
     /**
@@ -431,6 +439,18 @@ public String getSelectRolesChannelPattern() {
         return selectRolesChannelPattern;
     }
 
+    /**
+     * The configuration of the quote messages config.
+     *
+     * <p>
+     * >The configuration of the quote board feature. Quotes user selected messages.
+     *
+     * @return configuration of quote messages config
+     */
+    public QuoteBoardConfig getQuoteBoardConfig() {
+        return quoteBoardConfig;
+    }
+
     /**
      * Gets the pattern matching the category that is used to display the total member count.
      *
@@ -457,4 +477,13 @@ public RSSFeedsConfig getRSSFeedsConfig() {
     public TopHelpersConfig getTopHelpers() {
         return topHelpers;
     }
+
+    /**
+     * Gets the dynamic voice chat configuration
+     *
+     * @return the dynamic voice chat configuration
+     */
+    public DynamicVoiceChatConfig getDynamicVoiceChatConfig() {
+        return dynamicVoiceChatConfig;
+    }
 }

application/src/main/java/org/togetherjava/tjbot/config/Config.java

@@ -0,0 +1,34 @@
+package org.togetherjava.tjbot.config;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.util.List;
+import java.util.Objects;
+import java.util.regex.Pattern;
+
+/**
+ * Configuration for the dynamic voice chat feature.
+ *
+ * @param archiveCategoryPattern the name of the Discord Guild category in which the archived
+ *        channels will go
+ * @param cleanChannelsAmount the amount of channels to clean once a cleanup is triggered
+ * @param minimumChannelsAmount the amount of voice channels for the archive category to have before
+ *        a cleanup triggers
+ */
+public record DynamicVoiceChatConfig(
+        @JsonProperty(value = "dynamicChannelPatterns",
+                required = true) List<Pattern> dynamicChannelPatterns,
+        @JsonProperty(value = "archiveCategoryPattern",
+                required = true) String archiveCategoryPattern,
+        @JsonProperty(value = "cleanChannelsAmount") int cleanChannelsAmount,
+        @JsonProperty(value = "minimumChannelsAmount", required = true) int minimumChannelsAmount) {
+
+    /**
+     * Constructs an instance of {@code DynamicVoiceChatConfig} and throws if
+     * {@code dynamicChannelPatterns} or @{code archiveCategoryPattern} is null.
+     */
+    public DynamicVoiceChatConfig {
+        Objects.requireNonNull(dynamicChannelPatterns);
+        Objects.requireNonNull(archiveCategoryPattern);
+    }
+}

application/src/main/java/org/togetherjava/tjbot/config/DynamicVoiceChatConfig.java

@@ -0,0 +1,43 @@
+package org.togetherjava.tjbot.config;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonRootName;
+import org.apache.logging.log4j.LogManager;
+
+import org.togetherjava.tjbot.features.basic.QuoteBoardForwarder;
+
+import java.util.Objects;
+
+/**
+ * Configuration for the quote board feature, see {@link QuoteBoardForwarder}.
+ */
+@JsonRootName("quoteBoardConfig")
+public record QuoteBoardConfig(
+        @JsonProperty(value = "minimumReactionsToTrigger", required = true) int minimumReactions,
+        @JsonProperty(required = true) String channel,
+        @JsonProperty(value = "reactionEmoji", required = true) String reactionEmoji) {
+
+    /**
+     * Creates a QuoteBoardConfig.
+     *
+     * @param minimumReactions the minimum amount of reactions
+     * @param channel the pattern for the board channel
+     * @param reactionEmoji the emoji with which users should react to
+     */
+    public QuoteBoardConfig {
+        if (minimumReactions <= 0) {
+            throw new IllegalArgumentException("minimumReactions must be greater than zero");
+        }
+        Objects.requireNonNull(channel);
+        if (channel.isBlank()) {
+            throw new IllegalArgumentException("channel must not be empty or blank");
+        }
+        Objects.requireNonNull(reactionEmoji);
+        if (reactionEmoji.isBlank()) {
+            throw new IllegalArgumentException("reactionEmoji must not be empty or blank");
+        }
+        LogManager.getLogger(QuoteBoardConfig.class)
+            .debug("Quote-Board configs loaded: minimumReactions={}, channel='{}', reactionEmoji='{}'",
+                    minimumReactions, channel, reactionEmoji);
+    }
+}

application/src/main/java/org/togetherjava/tjbot/config/QuoteBoardConfig.java

@@ -8,6 +8,7 @@
 import org.togetherjava.tjbot.db.Database;
 import org.togetherjava.tjbot.features.basic.MemberCountDisplayRoutine;
 import org.togetherjava.tjbot.features.basic.PingCommand;
+import org.togetherjava.tjbot.features.basic.QuoteBoardForwarder;
 import org.togetherjava.tjbot.features.basic.RoleSelectCommand;
 import org.togetherjava.tjbot.features.basic.SlashCommandEducator;
 import org.togetherjava.tjbot.features.basic.SuggestionsUpDownVoter;
@@ -40,6 +41,8 @@
 import org.togetherjava.tjbot.features.mathcommands.TeXCommand;
 import org.togetherjava.tjbot.features.mathcommands.wolframalpha.WolframAlphaCommand;
 import org.togetherjava.tjbot.features.mediaonly.MediaOnlyChannelListener;
+import org.togetherjava.tjbot.features.messages.MessageCommand;
+import org.togetherjava.tjbot.features.messages.RewriteCommand;
 import org.togetherjava.tjbot.features.moderation.BanCommand;
 import org.togetherjava.tjbot.features.moderation.KickCommand;
 import org.togetherjava.tjbot.features.moderation.ModerationActionsStore;
@@ -78,6 +81,7 @@
 import org.togetherjava.tjbot.features.tophelper.TopHelpersMessageListener;
 import org.togetherjava.tjbot.features.tophelper.TopHelpersPurgeMessagesRoutine;
 import org.togetherjava.tjbot.features.tophelper.TopHelpersService;
+import org.togetherjava.tjbot.features.voicechat.DynamicVoiceChat;
 
 import java.util.ArrayList;
 import java.util.Collection;
@@ -161,6 +165,10 @@ public static Collection<Feature> createFeatures(JDA jda, Database database, Con
         features.add(new CodeMessageManualDetection(codeMessageHandler));
         features.add(new SlashCommandEducator());
         features.add(new PinnedNotificationRemover(config));
+        features.add(new QuoteBoardForwarder(config));
+
+        // Voice receivers
+        features.add(new DynamicVoiceChat(config));
 
         // Event receivers
         features.add(new RejoinModerationRoleListener(actionsStore, config));
@@ -204,6 +212,8 @@ public static Collection<Feature> createFeatures(JDA jda, Database database, Con
         features.add(new BookmarksCommand(bookmarksSystem));
         features.add(new ChatGptCommand(chatGptService, helpSystemHelper));
         features.add(new JShellCommand(jshellEval));
+        features.add(new MessageCommand());
+        features.add(new RewriteCommand(chatGptService));
         features.add(new HelpThreadStatsCommand(database));
 
         FeatureBlacklist<Class<?>> blacklist = blacklistConfig.normal();

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

@@ -3,6 +3,7 @@
 import net.dv8tion.jda.api.events.message.MessageDeleteEvent;
 import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
 import net.dv8tion.jda.api.events.message.MessageUpdateEvent;
+import net.dv8tion.jda.api.events.message.react.MessageReactionAddEvent;
 
 import java.util.regex.Pattern;
 
@@ -56,4 +57,13 @@ public interface MessageReceiver extends Feature {
      *        message that was deleted
      */
     void onMessageDeleted(MessageDeleteEvent event);
+
+    /**
+     * Triggered by the core system whenever a new reaction was added to a message in a text channel
+     * of a guild the bot has been added to.
+     *
+     * @param event the event that triggered this, containing information about the corresponding
+     *        reaction that was added
+     */
+    void onMessageReactionAdd(MessageReactionAddEvent event);
 }