Merge branch 'develop' into fix/replace-dead-links-in-chatgpt-response

Author: vlaym

.gitattributes

@@ -1,5 +1,7 @@
-# This will do normalization to LF on index (staging area) 
-* text=auto
+# Normalize to LF in the index AND in the working tree on all platforms.
+# Spotless enforces LF, so without eol=lf, Windows/WSL checkouts get CRLF and
+# every spotlessApply rewrites every file.
+* text=auto eol=lf
 
 # Explicit for linux files
 *.sh     text eol=lf

application/build.gradle

@@ -48,8 +48,8 @@ dependencies {
 
     implementation 'net.dv8tion:JDA:5.6.1'
 
-    implementation 'org.apache.logging.log4j:log4j-core:2.25.0'
-    runtimeOnly 'org.apache.logging.log4j:log4j-slf4j2-impl:2.25.0'
+    implementation 'org.apache.logging.log4j:log4j-core:2.26.0'
+    runtimeOnly 'org.apache.logging.log4j:log4j-slf4j2-impl:2.26.0'
 
     implementation 'club.minnced:discord-webhooks:0.8.4'
 
@@ -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.9.0'
+	implementation 'com.github.freva:ascii-table:1.12.1'
 
     implementation 'io.github.url-detector:url-detector:0.1.23'
 

application/config.json.template

@@ -162,6 +162,7 @@
     "logInfoChannelWebhook": "<put_your_webhook_here>",
     "logErrorChannelWebhook": "<put_your_webhook_here>",
     "openaiApiKey": "<check pins in #tjbot_discussion for the key>",
+    "tavilyApiKey": "<create an account on https://www.tavily.com/ to get an API key for free>",
     "sourceCodeBaseUrl": "https://github.com/Together-Java/TJ-Bot/blob/master/application/src/main/java/",
     "jshell": {
         "baseUrl": "<put_jshell_rest_api_url_here>",
@@ -195,9 +196,45 @@
         "pollIntervalInMinutes": 10
     },
     "quoteBoardConfig": {
-        "minimumReactionsToTrigger": 5,
+        "minimumScoreToTrigger": 5.0,
         "channel": "quotes",
-        "reactionEmoji": "⭐"
+        "botEmoji": "⭐",
+        "defaultEmojiScore": 0.5,
+        "emojiScores": {
+            "😬": -0.5,
+            "💔": -0.5,
+            "😐": -0.5,
+            "😊": -0.5,
+            "🖕": -0.5,
+            "👎": -0.5,
+            "💩": -0.5,
+            "🤢": -0.5,
+            "🤮": -0.5,
+            "🤬": -0.5,
+            "😡": -0.5,
+            "😒": -0.5,
+            "🤨": -0.5,
+
+            "🇷🇺": 0.0,
+            "🇵🇸": 0.0,
+            "🇮🇱": 0.0,
+            "🏳️‍🌈": 0.0,
+
+            "⭐": 1.0,
+
+            "youtube:1464573182206804010": 0.0
+        },
+        "allowChannels": [
+            "chit-chat",
+            "career-talk",
+            "geek-speek",
+            "expert-java-talk",
+            "ai-talk"
+        ]
+    },
+    "roleApplicationSystem": {
+        "submissionsChannelPattern": "staff-applications",
+        "defaultQuestion": "What makes you a good addition to the team?"
     },
     "memberCountCategoryPattern": "Info",
     "topHelpers": {

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

@@ -48,9 +48,11 @@ public final class Config {
     private final RSSFeedsConfig rssFeedsConfig;
     private final String selectRolesChannelPattern;
     private final String memberCountCategoryPattern;
+    private final RoleApplicationSystemConfig roleApplicationSystemConfig;
     private final QuoteBoardConfig quoteBoardConfig;
     private final TopHelpersConfig topHelpers;
     private final DynamicVoiceChatConfig dynamicVoiceChatConfig;
+    private final String tavilyApiKey;
 
     @SuppressWarnings("ConstructorWithTooManyParameters")
     @JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
@@ -106,9 +108,12 @@ private Config(@JsonProperty(value = "token", required = true) String token,
                     required = true) String selectRolesChannelPattern,
             @JsonProperty(value = "quoteBoardConfig",
                     required = true) QuoteBoardConfig quoteBoardConfig,
+            @JsonProperty(value = "roleApplicationSystem",
+                    required = true) RoleApplicationSystemConfig roleApplicationSystemConfig,
             @JsonProperty(value = "topHelpers", required = true) TopHelpersConfig topHelpers,
             @JsonProperty(value = "dynamicVoiceChatConfig",
-                    required = true) DynamicVoiceChatConfig dynamicVoiceChatConfig) {
+                    required = true) DynamicVoiceChatConfig dynamicVoiceChatConfig,
+            @JsonProperty(value = "tavilyApiKey", required = true) String tavilyApiKey) {
         this.token = Objects.requireNonNull(token);
         this.githubApiKey = Objects.requireNonNull(githubApiKey);
         this.databasePath = Objects.requireNonNull(databasePath);
@@ -144,8 +149,10 @@ private Config(@JsonProperty(value = "token", required = true) String token,
         this.rssFeedsConfig = Objects.requireNonNull(rssFeedsConfig);
         this.selectRolesChannelPattern = Objects.requireNonNull(selectRolesChannelPattern);
         this.quoteBoardConfig = Objects.requireNonNull(quoteBoardConfig);
+        this.roleApplicationSystemConfig = roleApplicationSystemConfig;
         this.topHelpers = Objects.requireNonNull(topHelpers);
         this.dynamicVoiceChatConfig = Objects.requireNonNull(dynamicVoiceChatConfig);
+        this.tavilyApiKey = Objects.requireNonNull(tavilyApiKey);
     }
 
     /**
@@ -460,6 +467,15 @@ public String getMemberCountCategoryPattern() {
         return memberCountCategoryPattern;
     }
 
+    /**
+     * The configuration related to the application form.
+     *
+     * @return the application form config
+     */
+    public RoleApplicationSystemConfig getRoleApplicationSystemConfig() {
+        return roleApplicationSystemConfig;
+    }
+
     /**
      * Gets the RSS feeds configuration.
      *
@@ -486,4 +502,16 @@ public TopHelpersConfig getTopHelpers() {
     public DynamicVoiceChatConfig getDynamicVoiceChatConfig() {
         return dynamicVoiceChatConfig;
     }
+
+    /**
+     * Gets the API key for Tavily ({@link <a href="https://www.tavily.com">tavily.com</a>}), a
+     * search engine API tailored for LLMs. It is used by the ChatGPT command to power the AI-driven
+     * web search tool, allowing the assistant to fetch up-to-date information from the web when
+     * answering user questions.
+     *
+     * @return the Tavily API key
+     */
+    public String getTavilyApiKey() {
+        return tavilyApiKey;
+    }
 }

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

@@ -6,38 +6,46 @@
 
 import org.togetherjava.tjbot.features.basic.QuoteBoardForwarder;
 
+import java.util.List;
+import java.util.Map;
 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) {
+        @JsonProperty(value = "minimumScoreToTrigger", required = true) float minimumScoreToTrigger,
+        @JsonProperty(value = "channel", required = true) String channel,
+        @JsonProperty(value = "botEmoji", required = true) String botEmoji,
+        @JsonProperty(value = "defaultEmojiScore", required = true) float defaultEmojiScore,
+        @JsonProperty(value = "emojiScores", required = true) Map<String, Float> emojiScores,
+        @JsonProperty(value = "allowChannels", required = true) List<String> allowChannels) {
 
     /**
      * Creates a QuoteBoardConfig.
      *
-     * @param minimumReactions the minimum amount of reactions
+     * @param minimumScoreToTrigger the minimum amount of reaction score for a message to be quoted
      * @param channel the pattern for the board channel
-     * @param reactionEmoji the emoji with which users should react to
+     * @param botEmoji the emoji with which the bot will mark quoted messages
+     * @param defaultEmojiScore the default score of an emoji if it's not in the emojiScores map
+     * @param emojiScores a map of each emoji's custom score
      */
     public QuoteBoardConfig {
-        if (minimumReactions <= 0) {
-            throw new IllegalArgumentException("minimumReactions must be greater than zero");
+        if (minimumScoreToTrigger <= 0) {
+            throw new IllegalArgumentException("minimumScoreToTrigger 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()) {
+        Objects.requireNonNull(botEmoji);
+        if (botEmoji.isBlank()) {
             throw new IllegalArgumentException("reactionEmoji must not be empty or blank");
         }
+        Objects.requireNonNull(emojiScores);
         LogManager.getLogger(QuoteBoardConfig.class)
             .debug("Quote-Board configs loaded: minimumReactions={}, channel='{}', reactionEmoji='{}'",
-                    minimumReactions, channel, reactionEmoji);
+                    minimumScoreToTrigger, channel, botEmoji);
     }
 }

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

@@ -0,0 +1,38 @@
+package org.togetherjava.tjbot.config;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import net.dv8tion.jda.api.interactions.components.text.TextInput;
+
+import java.util.Objects;
+
+/**
+ * Represents the configuration for an application form, including roles and application channel
+ * pattern.
+ *
+ * @param submissionsChannelPattern the pattern used to identify the submissions channel where
+ *        applications are sent
+ * @param defaultQuestion the default question that will be asked in the role application form
+ */
+public record RoleApplicationSystemConfig(
+        @JsonProperty(value = "submissionsChannelPattern",
+                required = true) String submissionsChannelPattern,
+        @JsonProperty(value = "defaultQuestion", required = true) String defaultQuestion) {
+
+    /**
+     * Constructs an instance of {@link RoleApplicationSystemConfig} with the provided parameters.
+     * <p>
+     * This constructor ensures that {@code submissionsChannelPattern} and {@code defaultQuestion}
+     * are not null and that the length of the {@code defaultQuestion} does not exceed the maximum
+     * allowed length.
+     */
+    public RoleApplicationSystemConfig {
+        Objects.requireNonNull(submissionsChannelPattern);
+        Objects.requireNonNull(defaultQuestion);
+
+        if (defaultQuestion.length() > TextInput.MAX_LABEL_LENGTH) {
+            throw new IllegalArgumentException(
+                    "defaultQuestion length is too long! Cannot be greater than %d"
+                        .formatted(TextInput.MAX_LABEL_LENGTH));
+        }
+    }
+}

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

@@ -19,6 +19,8 @@
 import org.togetherjava.tjbot.features.bookmarks.LeftoverBookmarksListener;
 import org.togetherjava.tjbot.features.chatgpt.ChatGptCommand;
 import org.togetherjava.tjbot.features.chatgpt.ChatGptService;
+import org.togetherjava.tjbot.features.chatgpt.tools.web.FetchUrlTool;
+import org.togetherjava.tjbot.features.chatgpt.tools.web.WebSearchTool;
 import org.togetherjava.tjbot.features.code.CodeMessageAutoDetection;
 import org.togetherjava.tjbot.features.code.CodeMessageHandler;
 import org.togetherjava.tjbot.features.code.CodeMessageManualDetection;
@@ -51,6 +53,7 @@
 import org.togetherjava.tjbot.features.moderation.QuarantineCommand;
 import org.togetherjava.tjbot.features.moderation.RejoinModerationRoleListener;
 import org.togetherjava.tjbot.features.moderation.ReportCommand;
+import org.togetherjava.tjbot.features.moderation.ThisIsScamCommand;
 import org.togetherjava.tjbot.features.moderation.TransferQuestionCommand;
 import org.togetherjava.tjbot.features.moderation.UnbanCommand;
 import org.togetherjava.tjbot.features.moderation.UnmuteCommand;
@@ -67,8 +70,11 @@
 import org.togetherjava.tjbot.features.moderation.scam.ScamHistoryStore;
 import org.togetherjava.tjbot.features.moderation.temp.TemporaryModerationRoutine;
 import org.togetherjava.tjbot.features.projects.ProjectsThreadCreatedListener;
+import org.togetherjava.tjbot.features.purge.PurgeCommand;
+import org.togetherjava.tjbot.features.purge.PurgeMessagesByUserCommand;
 import org.togetherjava.tjbot.features.reminder.RemindRoutine;
 import org.togetherjava.tjbot.features.reminder.ReminderCommand;
+import org.togetherjava.tjbot.features.roleapplication.CreateRoleApplicationCommand;
 import org.togetherjava.tjbot.features.rss.RSSHandlerRoutine;
 import org.togetherjava.tjbot.features.system.BotCore;
 import org.togetherjava.tjbot.features.system.LogLevelCommand;
@@ -85,6 +91,7 @@
 
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.List;
 
 /**
  * Utility class that offers all features that should be registered by the system, such as commands.
@@ -185,6 +192,7 @@ public static Collection<Feature> createFeatures(JDA jda, Database database, Con
 
         // Message context commands
         features.add(new TransferQuestionCommand(config, chatGptService));
+        features.add(new ThisIsScamCommand(config, actionsStore));
 
         // User context commands
 
@@ -215,10 +223,16 @@ public static Collection<Feature> createFeatures(JDA jda, Database database, Con
         features.add(new HelpThreadCommand(config, helpSystemHelper, metrics));
         features.add(new ReportCommand(config));
         features.add(new BookmarksCommand(bookmarksSystem));
-        features.add(new ChatGptCommand(chatGptService, helpSystemHelper));
+
+        features.add(new ChatGptCommand(chatGptService, helpSystemHelper,
+                List.of(new WebSearchTool(config.getTavilyApiKey()), new FetchUrlTool())));
+
         features.add(new JShellCommand(jshellEval));
         features.add(new MessageCommand());
         features.add(new RewriteCommand(chatGptService));
+        features.add(new CreateRoleApplicationCommand(config));
+        features.add(new PurgeCommand(modAuditLogWriter));
+        features.add(new PurgeMessagesByUserCommand(modAuditLogWriter));
 
         FeatureBlacklist<Class<?>> blacklist = blacklistConfig.normal();
         return blacklist.filterStream(features.stream(), Object::getClass).toList();