Added MemberCounter Routine

Author: devloves

application/config.json.template

@@ -110,5 +110,7 @@
         "special": [
         ]
     },
+    "memberCountCategoryName": "Info",
+    "updateMemberCountEveryHour", "12",
     "selectRolesChannelPattern": "select-your-roles"
 }

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

@@ -44,6 +44,8 @@ public final class Config {
     private final HelperPruneConfig helperPruneConfig;
     private final FeatureBlacklistConfig featureBlacklistConfig;
     private final String selectRolesChannelPattern;
+    private final String updateMemberCountEveryHour;
+    private final String memberCountCategoryName;
 
     @SuppressWarnings("ConstructorWithTooManyParameters")
     @JsonCreator(mode = JsonCreator.Mode.PROPERTIES)
@@ -86,6 +88,8 @@ private Config(@JsonProperty(value = "token", required = true) String token,
             @JsonProperty(value = "openaiApiKey", required = true) String openaiApiKey,
             @JsonProperty(value = "sourceCodeBaseUrl", required = true) String sourceCodeBaseUrl,
             @JsonProperty(value = "jshell", required = true) JShellConfig jshell,
+            @JsonProperty(value = "memberCountCategoryName") String memberCountCategoryName,
+            @JsonProperty(value = "updateMemberCountEveryHour") String updateMemberCountEveryHour,
             @JsonProperty(value = "helperPruneConfig",
                     required = true) HelperPruneConfig helperPruneConfig,
             @JsonProperty(value = "featureBlacklist",
@@ -96,6 +100,8 @@ private Config(@JsonProperty(value = "token", required = true) String token,
         this.githubApiKey = Objects.requireNonNull(githubApiKey);
         this.databasePath = Objects.requireNonNull(databasePath);
         this.projectWebsite = Objects.requireNonNull(projectWebsite);
+        this.memberCountCategoryName = memberCountCategoryName;
+        this.updateMemberCountEveryHour = updateMemberCountEveryHour;
         this.discordGuildInvite = Objects.requireNonNull(discordGuildInvite);
         this.modAuditLogChannelPattern = Objects.requireNonNull(modAuditLogChannelPattern);
         this.modMailChannelPattern = Objects.requireNonNull(modMailChannelPattern);
@@ -405,4 +411,17 @@ public FeatureBlacklistConfig getFeatureBlacklistConfig() {
     public String getSelectRolesChannelPattern() {
         return selectRolesChannelPattern;
     }
+
+    /**
+     * Gets the categories by this name to showcase the total member count of the server.
+     *
+     * @return the categories name types
+     */
+    public String getMemberCountCategoryName() {
+        return memberCountCategoryName;
+    }
+
+    public String getupdateMemberCountEveryHour() {
+        return updateMemberCountEveryHour;
+    }
 }

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

@@ -8,10 +8,7 @@
 import org.togetherjava.tjbot.config.FeatureBlacklist;
 import org.togetherjava.tjbot.config.FeatureBlacklistConfig;
 import org.togetherjava.tjbot.db.Database;
-import org.togetherjava.tjbot.features.basic.PingCommand;
-import org.togetherjava.tjbot.features.basic.RoleSelectCommand;
-import org.togetherjava.tjbot.features.basic.SlashCommandEducator;
-import org.togetherjava.tjbot.features.basic.SuggestionsUpDownVoter;
+import org.togetherjava.tjbot.features.basic.*;
 import org.togetherjava.tjbot.features.bookmarks.BookmarksCommand;
 import org.togetherjava.tjbot.features.bookmarks.BookmarksSystem;
 import org.togetherjava.tjbot.features.bookmarks.LeftoverBookmarksCleanupRoutine;
@@ -109,6 +106,7 @@ public static Collection<Feature> createFeatures(JDA jda, Database database, Con
             .add(new AutoPruneHelperRoutine(config, helpSystemHelper, modAuditLogWriter, database));
         features.add(new HelpThreadAutoArchiver(helpSystemHelper));
         features.add(new LeftoverBookmarksCleanupRoutine(bookmarksSystem));
+        features.add(new MemberCountDisplayRoutine(config));
 
         // Message receivers
         features.add(new TopHelpersMessageListener(database, config));

application/src/main/java/org/togetherjava/tjbot/features/basic/MemberCountDisplayRoutine.java

@@ -0,0 +1,42 @@
+package org.togetherjava.tjbot.features.basic;
+
+import net.dv8tion.jda.api.JDA;
+import net.dv8tion.jda.api.entities.Guild;
+import net.dv8tion.jda.api.entities.channel.concrete.Category;
+
+import org.togetherjava.tjbot.config.Config;
+import org.togetherjava.tjbot.features.Routine;
+
+import java.util.List;
+import java.util.concurrent.TimeUnit;
+
+public class MemberCountDisplayRoutine implements Routine {
+    private final String wordsInCategory;
+
+    public MemberCountDisplayRoutine(Config config) {
+        this.wordsInCategory = config.getMemberCountCategoryName();
+    }
+
+    private void updateCategoryName(Category category) {
+        int totalMemberCount = category.getGuild().getMemberCount();
+        String basename = category.getName();
+        category.getManager()
+            .setName("%s - %d Members".formatted(basename, totalMemberCount))
+            .queue();
+    }
+
+    @Override
+    public Schedule createSchedule() {
+        return new Schedule(ScheduleMode.FIXED_RATE, 0, 24, TimeUnit.HOURS);
+    }
+
+    @Override
+    public void runRoutine(JDA jda) {
+        jda.getGuilds()
+            .stream()
+            .map(Guild::getCategories)
+            .flatMap(List::stream)
+            .filter(cat -> cat.getName().equalsIgnoreCase(wordsInCategory))
+            .forEach(this::updateCategoryName);
+    }
+}