feat(cool-messages): add configuration files

Author: christolis

application/config.json.template

@@ -115,5 +115,10 @@
         "fallbackChannelPattern": "java-news-and-changes",
         "pollIntervalInMinutes": 10
     },
+    "coolMessagesConfig": {
+        "minimumReactions": 5,
+        "boardChannelPattern": "quotes",
+        "reactionEmoji": "U+2B50"
+    },
     "memberCountCategoryPattern": "Info"
 }

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

@@ -46,6 +46,7 @@ public final class Config {
     private final RSSFeedsConfig rssFeedsConfig;
     private final String selectRolesChannelPattern;
     private final String memberCountCategoryPattern;
+    private final CoolMessagesBoardConfig coolMessagesConfig;
 
     @SuppressWarnings("ConstructorWithTooManyParameters")
     @JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
@@ -94,7 +95,9 @@ private Config(@JsonProperty(value = "token", required = true) String token,
                     required = true) FeatureBlacklistConfig featureBlacklistConfig,
             @JsonProperty(value = "rssConfig", required = true) RSSFeedsConfig rssFeedsConfig,
             @JsonProperty(value = "selectRolesChannelPattern",
-                    required = true) String selectRolesChannelPattern) {
+                    required = true) String selectRolesChannelPattern,
+            @JsonProperty(value = "coolMessagesConfig",
+                    required = true) CoolMessagesBoardConfig coolMessagesConfig) {
         this.token = Objects.requireNonNull(token);
         this.githubApiKey = Objects.requireNonNull(githubApiKey);
         this.databasePath = Objects.requireNonNull(databasePath);
@@ -127,6 +130,7 @@ 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.coolMessagesConfig = Objects.requireNonNull(coolMessagesConfig);
     }
 
     /**
@@ -401,6 +405,15 @@ public String getSelectRolesChannelPattern() {
         return selectRolesChannelPattern;
     }
 
+    /**
+     * The configuration of the cool messages config.
+     *
+     * @return configuration of cool messages config
+     */
+    public CoolMessagesBoardConfig getCoolMessagesConfig() {
+        return coolMessagesConfig;
+    }
+
     /**
      * Gets the pattern matching the category that is used to display the total member count.
      *

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

@@ -0,0 +1,28 @@
+package org.togetherjava.tjbot.config;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import com.fasterxml.jackson.annotation.JsonRootName;
+
+import java.util.Objects;
+
+/**
+ * Configuration for the cool messages board feature, see
+ * {@link org.togetherjava.tjbot.features.basic.CoolMessagesBoardManager}.
+ */
+@JsonRootName("coolMessagesConfig")
+public record CoolMessagesBoardConfig(
+        @JsonProperty(value = "minimumReactions", required = true) int minimumReactions,
+        @JsonProperty(value = "boardChannelPattern", required = true) String boardChannelPattern,
+        @JsonProperty(value = "reactionEmoji", required = true) String reactionEmoji) {
+
+    /**
+     * Creates a CoolMessagesBoardConfig.
+     *
+     * @param minimumReactions the minimum amount of reactions
+     * @param boardChannelPattern the pattern for the board channel
+     * @param reactionEmoji the emoji with which users should react to
+     */
+    public CoolMessagesBoardConfig {
+        Objects.requireNonNull(boardChannelPattern);
+    }
+}

application/src/main/java/org/togetherjava/tjbot/features/MessageReceiver.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);
 }

application/src/main/java/org/togetherjava/tjbot/features/MessageReceiverAdapter.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;
 
@@ -57,4 +58,10 @@ public void onMessageUpdated(MessageUpdateEvent event) {
     public void onMessageDeleted(MessageDeleteEvent event) {
         // Adapter does not react by default, subclasses may change this behavior
     }
+
+    @SuppressWarnings("NoopMethodInAbstractClass")
+    @Override
+    public void onMessageReactionAdd(MessageReactionAddEvent event) {
+        // Adapter does not react by default, subclasses may change this behavior
+    }
 }

application/src/main/java/org/togetherjava/tjbot/features/system/BotCore.java

@@ -13,6 +13,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 net.dv8tion.jda.api.hooks.ListenerAdapter;
 import net.dv8tion.jda.api.interactions.callbacks.IReplyCallback;
 import net.dv8tion.jda.api.interactions.components.ComponentInteraction;
@@ -238,6 +239,14 @@ public void onMessageDelete(final MessageDeleteEvent event) {
         }
     }
 
+    @Override
+    public void onMessageReactionAdd(final MessageReactionAddEvent event) {
+        if (event.isFromGuild()) {
+            getMessageReceiversSubscribedTo(event.getChannel())
+                .forEach(messageReceiver -> messageReceiver.onMessageReactionAdd(event));
+        }
+    }
+
     private Stream<MessageReceiver> getMessageReceiversSubscribedTo(Channel channel) {
         String channelName = channel.getName();
         return channelNameToMessageReceiver.entrySet()