Added Guilds, a helper with role and channel find methods

Author: Zabuzard

application/src/main/java/org/togetherjava/tjbot/features/filesharing/FileSharingMessageListener.java

@@ -2,7 +2,6 @@
 
 import net.dv8tion.jda.api.entities.Member;
 import net.dv8tion.jda.api.entities.Message;
-import net.dv8tion.jda.api.entities.Role;
 import net.dv8tion.jda.api.entities.User;
 import net.dv8tion.jda.api.entities.channel.ChannelType;
 import net.dv8tion.jda.api.entities.channel.concrete.ThreadChannel;
@@ -21,6 +20,7 @@
 import org.togetherjava.tjbot.features.UserInteractor;
 import org.togetherjava.tjbot.features.componentids.ComponentIdGenerator;
 import org.togetherjava.tjbot.features.componentids.ComponentIdInteractor;
+import org.togetherjava.tjbot.features.utils.Guilds;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -99,8 +99,7 @@ public void onMessageReceived(MessageReceivedEvent event) {
     public void onButtonClick(ButtonInteractionEvent event, List<String> args) {
         Member interactionUser = event.getMember();
         String gistAuthorId = args.getFirst();
-        boolean hasSoftModPermissions =
-                interactionUser.getRoles().stream().map(Role::getName).anyMatch(isSoftModRole);
+        boolean hasSoftModPermissions = Guilds.hasMemberRole(interactionUser, isSoftModRole);
 
         if (!gistAuthorId.equals(interactionUser.getId()) && !hasSoftModPermissions) {
             event.reply("You do not have permission for this action.").setEphemeral(true).queue();

application/src/main/java/org/togetherjava/tjbot/features/help/HelpSystemHelper.java

@@ -27,6 +27,7 @@
 import org.togetherjava.tjbot.features.chatgpt.ChatGptCommand;
 import org.togetherjava.tjbot.features.chatgpt.ChatGptService;
 import org.togetherjava.tjbot.features.componentids.ComponentIdInteractor;
+import org.togetherjava.tjbot.features.utils.Guilds;
 
 import java.awt.Color;
 import java.time.Instant;
@@ -57,7 +58,7 @@ public final class HelpSystemHelper {
 
     static final Color AMBIENT_COLOR = new Color(255, 255, 165);
 
-    private final Predicate<String> hasTagManageRole;
+    private final Predicate<String> isTagManageRole;
     private final Predicate<String> isHelpForumName;
     private final String helpForumPattern;
     /**
@@ -88,7 +89,7 @@ public HelpSystemHelper(Config config, Database database, ChatGptService chatGpt
         this.database = database;
         this.chatGptService = chatGptService;
 
-        hasTagManageRole = Pattern.compile(config.getTagManageRolePattern()).asMatchPredicate();
+        isTagManageRole = Pattern.compile(config.getTagManageRolePattern()).asMatchPredicate();
         helpForumPattern = helpConfig.getHelpForumPattern();
         isHelpForumName = Pattern.compile(helpForumPattern).asMatchPredicate();
 
@@ -344,7 +345,7 @@ private static ForumTag requireTag(String tagName, ForumChannel forumChannel) {
     }
 
     boolean hasTagManageRole(Member member) {
-        return member.getRoles().stream().map(Role::getName).anyMatch(hasTagManageRole);
+        return Guilds.hasMemberRole(member, isTagManageRole);
     }
 
     boolean isHelpForumName(String channelName) {

application/src/main/java/org/togetherjava/tjbot/features/moderation/ModerationUtils.java

@@ -18,6 +18,7 @@
 
 import org.togetherjava.tjbot.config.Config;
 import org.togetherjava.tjbot.features.moderation.modmail.ModMailCommand;
+import org.togetherjava.tjbot.features.utils.Guilds;
 import org.togetherjava.tjbot.features.utils.MessageUtils;
 
 import javax.annotation.Nullable;
@@ -321,7 +322,7 @@ public static Predicate<String> getIsMutedRolePredicate(Config config) {
      */
     public static Optional<Role> getMutedRole(Guild guild, Config config) {
         Predicate<String> isMutedRole = getIsMutedRolePredicate(config);
-        return guild.getRoles().stream().filter(role -> isMutedRole.test(role.getName())).findAny();
+        return Guilds.findRole(guild, isMutedRole);
     }
 
     /**
@@ -343,10 +344,7 @@ public static Predicate<String> getIsQuarantinedRolePredicate(Config config) {
      */
     public static Optional<Role> getQuarantinedRole(Guild guild, Config config) {
         Predicate<String> isQuarantinedRole = getIsQuarantinedRolePredicate(config);
-        return guild.getRoles()
-            .stream()
-            .filter(role -> isQuarantinedRole.test(role.getName()))
-            .findAny();
+        return Guilds.findRole(guild, isQuarantinedRole);
     }
 
     /**

application/src/main/java/org/togetherjava/tjbot/features/moderation/scam/ScamBlocker.java

@@ -6,7 +6,6 @@
 import net.dv8tion.jda.api.entities.Member;
 import net.dv8tion.jda.api.entities.Message;
 import net.dv8tion.jda.api.entities.MessageEmbed;
-import net.dv8tion.jda.api.entities.Role;
 import net.dv8tion.jda.api.entities.SelfUser;
 import net.dv8tion.jda.api.entities.User;
 import net.dv8tion.jda.api.entities.channel.concrete.PrivateChannel;
@@ -34,13 +33,15 @@
 import org.togetherjava.tjbot.features.moderation.ModerationActionsStore;
 import org.togetherjava.tjbot.features.moderation.ModerationUtils;
 import org.togetherjava.tjbot.features.moderation.modmail.ModMailCommand;
+import org.togetherjava.tjbot.features.utils.Guilds;
 import org.togetherjava.tjbot.features.utils.MessageUtils;
 import org.togetherjava.tjbot.logging.LogMarkers;
 
 import java.awt.Color;
 import java.util.Collection;
 import java.util.EnumSet;
 import java.util.List;
+import java.util.Objects;
 import java.util.Optional;
 import java.util.Set;
 import java.util.function.Consumer;
@@ -71,7 +72,7 @@ public final class ScamBlocker extends MessageReceiverAdapter implements UserInt
     private final Config config;
     private final ModerationActionsStore actionsStore;
     private final ScamHistoryStore scamHistoryStore;
-    private final Predicate<String> hasRequiredRole;
+    private final Predicate<String> isRequiredRole;
 
     private final ComponentIdInteractor componentIdInteractor;
 
@@ -100,7 +101,7 @@ public ScamBlocker(ModerationActionsStore actionsStore, ScamHistoryStore scamHis
                 Pattern.compile(botTrapChannelPattern).asMatchPredicate();
         isBotTrapChannel = channel -> isBotTrapChannelName.test(channel.getName());
 
-        hasRequiredRole = Pattern.compile(config.getSoftModerationRolePattern()).asMatchPredicate();
+        isRequiredRole = Pattern.compile(config.getSoftModerationRolePattern()).asMatchPredicate();
 
         componentIdInteractor = new ComponentIdInteractor(getInteractionType(), getName());
     }
@@ -316,7 +317,8 @@ private String generateComponentId(ComponentIdArguments args) {
     @Override
     public void onButtonClick(ButtonInteractionEvent event, List<String> argsRaw) {
         ComponentIdArguments args = ComponentIdArguments.fromList(argsRaw);
-        if (event.getMember().getRoles().stream().map(Role::getName).noneMatch(hasRequiredRole)) {
+        if (Guilds.doesMemberNotHaveRole(Objects.requireNonNull(event.getMember()),
+                isRequiredRole)) {
             event.reply(
                     "You can not handle scam in this guild, since you do not have the required role.")
                 .setEphemeral(true)

application/src/main/java/org/togetherjava/tjbot/features/moderation/scam/ScamDetector.java

@@ -2,10 +2,10 @@
 
 import net.dv8tion.jda.api.entities.Member;
 import net.dv8tion.jda.api.entities.Message;
-import net.dv8tion.jda.api.entities.Role;
 
 import org.togetherjava.tjbot.config.Config;
 import org.togetherjava.tjbot.config.ScamBlockerConfig;
+import org.togetherjava.tjbot.features.utils.Guilds;
 
 import java.util.Collection;
 import java.util.List;
@@ -51,8 +51,7 @@ public ScamDetector(Config config) {
      */
     public boolean isScam(Message message) {
         Member author = message.getMember();
-        boolean isTrustedUser = author != null
-                && author.getRoles().stream().map(Role::getName).anyMatch(hasTrustedRole);
+        boolean isTrustedUser = author != null && Guilds.hasMemberRole(author, hasTrustedRole);
         if (isTrustedUser) {
             return false;
         }

application/src/main/java/org/togetherjava/tjbot/features/tophelper/TopHelpersAssignmentRoutine.java

@@ -25,6 +25,7 @@
 import org.togetherjava.tjbot.features.UserInteractor;
 import org.togetherjava.tjbot.features.componentids.ComponentIdGenerator;
 import org.togetherjava.tjbot.features.componentids.ComponentIdInteractor;
+import org.togetherjava.tjbot.features.utils.Guilds;
 
 import javax.annotation.Nullable;
 
@@ -213,10 +214,7 @@ public void onStringSelectSelection(StringSelectInteractionEvent event, List<Str
             .map(Long::parseLong)
             .collect(Collectors.toSet());
 
-        Optional<Role> topHelperRole = guild.getRoles()
-            .stream()
-            .filter(role -> roleNamePredicate.test(role.getName()))
-            .findAny();
+        Optional<Role> topHelperRole = Guilds.findRole(guild, roleNamePredicate);
         if (topHelperRole.isEmpty()) {
             logger.warn(
                     "Unable to assign Top Helpers, did not find a role matching the configured pattern '{}' for guild '{}'",

application/src/main/java/org/togetherjava/tjbot/features/utils/Guilds.java

@@ -0,0 +1,56 @@
+package org.togetherjava.tjbot.features.utils;
+
+import net.dv8tion.jda.api.entities.Guild;
+import net.dv8tion.jda.api.entities.Member;
+import net.dv8tion.jda.api.entities.Role;
+
+import java.util.Optional;
+import java.util.function.Predicate;
+
+/**
+ * Utility methods for working with {@link Guild}s.
+ * <p>
+ * This class is meant to contain all utility methods for {@link Guild}s that can be used on all
+ * other commands to avoid similar methods appearing everywhere.
+ */
+public final class Guilds {
+    private Guilds() {
+        throw new UnsupportedOperationException("Utility class, construction not supported");
+    }
+
+    /**
+     * Finds any role in the guild whose name matches the given predicate.
+     *
+     * @param guild guild to search the role in
+     * @param isRoleName a predicate matching the name of the role to search
+     * @return the matched role, if any
+     */
+    public static Optional<Role> findRole(Guild guild, Predicate<? super String> isRoleName) {
+        return guild.getRoles().stream().filter(role -> isRoleName.test(role.getName())).findAny();
+    }
+
+    /**
+     * Checks whether a given member has a role whose name matches a given predicate.
+     *
+     * @param member the member to check
+     * @param isRoleName a predicate matching the name of the role to search
+     * @return {@code true} if the member has a matching role, {@code false} otherwise
+     * @see #doesMemberNotHaveRole(Member, Predicate)
+     */
+    public static boolean hasMemberRole(Member member, Predicate<? super String> isRoleName) {
+        return member.getRoles().stream().map(Role::getName).anyMatch(isRoleName);
+    }
+
+    /**
+     * Checks whether a given member does not have a role whose name matches a given predicate.
+     *
+     * @param member the member to check
+     * @param isRoleName a predicate matching the name of the role to search
+     * @return {@code true} if the member does not have any matching role, {@code false} otherwise
+     * @see #hasMemberRole(Member, Predicate)
+     */
+    public static boolean doesMemberNotHaveRole(Member member,
+            Predicate<? super String> isRoleName) {
+        return member.getRoles().stream().map(Role::getName).noneMatch(isRoleName);
+    }
+}

application/src/main/java/org/togetherjava/tjbot/features/utils/MessageUtils.java

@@ -19,7 +19,7 @@
  * This class is meant to contain all utility methods for {@link Message} that can be used on all
  * other commands to avoid similar methods appearing everywhere.
  */
-public class MessageUtils {
+public final class MessageUtils {
     public static final int MAXIMUM_VISIBLE_EMBEDS = 25;
     public static final String ABBREVIATION = "...";
     private static final String CODE_FENCE_SYMBOL = "```";