Java RSS Feed

application/build.gradle

@@ -77,6 +77,9 @@ dependencies {
 
     implementation 'org.kohsuke:github-api:1.321'
 
+    implementation 'org.apache.commons:commons-text:1.11.0'
+    implementation 'com.apptasticsoftware:rssreader:3.6.0'
+
     testImplementation 'org.mockito:mockito-core:5.11.0'
     testImplementation 'org.junit.jupiter:junit-jupiter-api:5.10.0'
     testImplementation 'org.junit.jupiter:junit-jupiter-params:5.10.0'

application/config.json.template

@@ -103,6 +103,17 @@
         "special": [
         ]
     },
-    "memberCountCategoryPattern": "Info",
-    "selectRolesChannelPattern": "select-your-roles"
+    "selectRolesChannelPattern": "select-your-roles",
+    "rssConfig": {
+        "feeds": [
+            {
+                "url": "<rss_feed_url>",
+                "targetChannelPattern": "<target_channel_pattern>",
+                "dateFormatterPattern": "EEE, dd MMM yyyy HH:mm:ss zzz"
+            }
+        ],
+        "fallbackChannelPattern": "<fallback_channel_pattern>",
+        "pollIntervalInMinutes": 10
+    },
+    "memberCountCategoryPattern": "Info"
 }

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

@@ -11,6 +11,7 @@
 import java.util.List;
 import java.util.Objects;
 
+
 /**
  * Configuration of the application. Create instances using {@link #load(Path)}.
  */
@@ -42,6 +43,7 @@ public final class Config {
     private final String sourceCodeBaseUrl;
     private final JShellConfig jshell;
     private final FeatureBlacklistConfig featureBlacklistConfig;
+    private final RSSFeedsConfig rssFeedsConfig;
     private final String selectRolesChannelPattern;
     private final String memberCountCategoryPattern;
 
@@ -90,6 +92,7 @@ private Config(@JsonProperty(value = "token", required = true) String token,
                     required = true) String memberCountCategoryPattern,
             @JsonProperty(value = "featureBlacklist",
                     required = true) FeatureBlacklistConfig featureBlacklistConfig,
+            @JsonProperty(value = "rssConfig", required = true) RSSFeedsConfig rssFeedsConfig,
             @JsonProperty(value = "selectRolesChannelPattern",
                     required = true) String selectRolesChannelPattern) {
         this.token = Objects.requireNonNull(token);
@@ -122,6 +125,7 @@ private Config(@JsonProperty(value = "token", required = true) String token,
         this.sourceCodeBaseUrl = Objects.requireNonNull(sourceCodeBaseUrl);
         this.jshell = Objects.requireNonNull(jshell);
         this.featureBlacklistConfig = Objects.requireNonNull(featureBlacklistConfig);
+        this.rssFeedsConfig = Objects.requireNonNull(rssFeedsConfig);
         this.selectRolesChannelPattern = Objects.requireNonNull(selectRolesChannelPattern);
     }
 
@@ -405,4 +409,13 @@ public String getSelectRolesChannelPattern() {
     public String getMemberCountCategoryPattern() {
         return memberCountCategoryPattern;
     }
+
+    /**
+     * Gets the RSS feeds configuration.
+     *
+     * @return the RSS feeds configuration
+     */
+    public RSSFeedsConfig getRSSFeedsConfig() {
+        return rssFeedsConfig;
+    }
 }

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

@@ -0,0 +1,30 @@
+package org.togetherjava.tjbot.config;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import javax.annotation.Nullable;
+
+import java.util.Objects;
+
+/**
+ * Represents an RSS feed configuration.
+ */
+public record RSSFeed(@JsonProperty(value = "url", required = true) String url,
+        @JsonProperty(value = "targetChannelPattern") @Nullable String targetChannelPattern,
+        @JsonProperty(value = "dateFormatterPattern",
+                required = true) String dateFormatterPattern) {
+
+    /**
+     * Constructs an RSSFeed object.
+     *
+     * @param url the URL of the RSS feed
+     * @param targetChannelPattern the target channel pattern
+     * @param dateFormatterPattern the date formatter pattern
+     * @throws NullPointerException if any of the parameters are null
+     */
+    public RSSFeed {
+        Objects.requireNonNull(url);
+        Objects.requireNonNull(targetChannelPattern);
+        Objects.requireNonNull(dateFormatterPattern);
+    }
+}

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

@@ -0,0 +1,34 @@
+package org.togetherjava.tjbot.config;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+
+import java.util.List;
+import java.util.Objects;
+
+/**
+ * Represents the configuration for an RSS feed, which includes the list of feeds to subscribe to, a
+ * pattern for identifying Java news channels, and the interval (in minutes) for polling the feeds.
+ *
+ * @param feeds The list of RSS feeds to subscribe to.
+ * @param fallbackChannelPattern The pattern used to identify the fallback text channel to use.
+ * @param pollIntervalInMinutes The interval (in minutes) for polling the RSS feeds for updates.
+ */
+public record RSSFeedsConfig(@JsonProperty(value = "feeds", required = true) List<RSSFeed> feeds,
+        @JsonProperty(value = "fallbackChannelPattern",
+                required = true) String fallbackChannelPattern,
+        @JsonProperty(value = "pollIntervalInMinutes", required = true) int pollIntervalInMinutes) {
+
+    /**
+     * Constructs a new {@link RSSFeedsConfig}.
+     *
+     * @param feeds The list of RSS feeds to subscribe to.
+     * @param fallbackChannelPattern The pattern used to identify the fallback text channel to use.
+     * @param pollIntervalInMinutes The interval (in minutes) for polling the RSS feeds for updates.
+     * @throws NullPointerException if any of the parameters (feeds or fallbackChannelPattern) are
+     *         null
+     */
+    public RSSFeedsConfig {
+        Objects.requireNonNull(feeds);
+        Objects.requireNonNull(fallbackChannelPattern);
+    }
+}

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

@@ -24,6 +24,7 @@
 import org.togetherjava.tjbot.features.github.GitHubCommand;
 import org.togetherjava.tjbot.features.github.GitHubReference;
 import org.togetherjava.tjbot.features.help.*;
+import org.togetherjava.tjbot.features.javamail.RSSHandlerRoutine;
 import org.togetherjava.tjbot.features.jshell.JShellCommand;
 import org.togetherjava.tjbot.features.jshell.JShellEval;
 import org.togetherjava.tjbot.features.mathcommands.TeXCommand;
@@ -109,6 +110,7 @@ public static Collection<Feature> createFeatures(JDA jda, Database database, Con
         features.add(new HelpThreadAutoArchiver(helpSystemHelper));
         features.add(new LeftoverBookmarksCleanupRoutine(bookmarksSystem));
         features.add(new MemberCountDisplayRoutine(config));
+        features.add(new RSSHandlerRoutine(config, database));
 
         // Message receivers
         features.add(new TopHelpersMessageListener(database, config));