Merge pull request #541 from danthe1st/suggestion-filter

use message filter for suggestions

Author: danthe1st

src/main/java/net/discordjug/javabot/listener/filter/BlacklistedMessageAttachmentFilter.java

@@ -38,4 +38,9 @@ public MessageModificationStatus processMessage(MessageContent content) {
 			return MessageModificationStatus.NOT_MODIFIED;
 		}
 	}
+	
+	@Override
+	public int getOrder() {
+		return -10;//should run earlier than normal because it is automod-related but other automod filters are more important
+	}
 }

src/main/java/net/discordjug/javabot/listener/filter/MessageFilter.java

@@ -1,12 +1,14 @@
 package net.discordjug.javabot.listener.filter;
 
+import org.springframework.core.Ordered;
+
 /**
  * This interface is implemented by all message filters.
  *
  * The {@link MessageContent} is processed by every class implementing {@link MessageFilter}
  * unless one of the filters returns {@link MessageModificationStatus#STOP_PROCESSING} which stops further filters from executing.
  */
-public interface MessageFilter {
+public interface MessageFilter extends Ordered {
 
 	/**
 	 * When a message is received, it is processed by the registered filters.
@@ -20,4 +22,15 @@ public interface MessageFilter {
 	 */
 	MessageModificationStatus processMessage(MessageContent content);
 
+	/**
+	 * {@inheritDoc}
+	 * 
+	 * <p>
+	 * By default, message filters have order 0. A higher order means they are executed afterwards while a lower order results in them being executed before.
+	 * </p>
+	 */
+	@Override
+	default int getOrder() {
+		return 0;
+	}
 }

src/main/java/net/discordjug/javabot/listener/filter/MessageFilterHandler.java

@@ -1,7 +1,6 @@
 package net.discordjug.javabot.listener.filter;
 
 import lombok.RequiredArgsConstructor;
-import net.discordjug.javabot.data.config.BotConfig;
 import net.discordjug.javabot.systems.moderation.AutoMod;
 import net.discordjug.javabot.util.ExceptionLogger;
 import net.discordjug.javabot.util.WebhookUtil;
@@ -29,7 +28,6 @@ public class MessageFilterHandler extends ListenerAdapter {
 
 	private final List<MessageFilter> filters;
 	private final AutoMod autoMod;
-	private final BotConfig botConfig;
 
 	@Override
 	public void onMessageReceived(@NotNull MessageReceivedEvent event) {
@@ -90,11 +88,6 @@ private boolean shouldRunFilters(@NotNull MessageReceivedEvent event) {
 				autoMod.hasAdvertisingLink(event.getMessage())) {
 			return false;
 		}
-		if (event.getChannel().getIdLong() == botConfig.get(event.getGuild())
-				.getModerationConfig()
-				.getSuggestionChannelId()) {
-			return false;
-		}
 		return true;
 	}
 

src/main/java/net/discordjug/javabot/listener/filter/MessageRuleFilter.java

@@ -123,4 +123,9 @@ private String computeSHA(Attachment attachment) {
 			return "";
 		}
 	}
+	
+	@Override
+	public int getOrder() {
+		return -100;//automod should run early
+	}
 }

…javabot/listener/SuggestionListener.java …ot/listener/filter/SuggestionFilter.javasrc/main/java/net/discordjug/javabot/listener/SuggestionListener.java renamed to src/main/java/net/discordjug/javabot/listener/filter/SuggestionFilter.java src/main/java/net/discordjug/javabot/listener/SuggestionListener.java renamed to src/main/java/net/discordjug/javabot/listener/filter/SuggestionFilter.java

@@ -1,54 +1,50 @@
-package net.discordjug.javabot.listener;
+package net.discordjug.javabot.listener.filter;
 
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import net.discordjug.javabot.data.config.BotConfig;
 import net.discordjug.javabot.data.config.SystemsConfig;
-import net.discordjug.javabot.systems.moderation.AutoMod;
 import net.discordjug.javabot.util.MessageActionUtils;
 import net.discordjug.javabot.util.Responses;
 import net.dv8tion.jda.api.EmbedBuilder;
 import net.dv8tion.jda.api.entities.*;
 import net.dv8tion.jda.api.entities.channel.ChannelType;
 import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
-import net.dv8tion.jda.api.hooks.ListenerAdapter;
 import net.dv8tion.jda.api.requests.RestAction;
 
 import org.jetbrains.annotations.NotNull;
+import org.springframework.stereotype.Component;
 
 import java.time.Instant;
 
 /**
- * Listens for {@link MessageReceivedEvent}s in the
- * {@link net.discordjug.javabot.data.config.guild.ModerationConfig#getSuggestionChannel()} channel.
+ * When a message is created in the {@link net.discordjug.javabot.data.config.guild.ModerationConfig#getSuggestionChannel()} channel, it is decorated as a suggestion.
  */
+@Component
 @Slf4j
 @RequiredArgsConstructor
-public class SuggestionListener extends ListenerAdapter {
-	private final AutoMod autoMod;
+public class SuggestionFilter implements MessageFilter {
 	private final BotConfig botConfig;
-
+	
 	@Override
-	public void onMessageReceived(@NotNull MessageReceivedEvent event) {
-		if (!canCreateSuggestion(event)) return;
-		if (autoMod.hasSuspiciousLink(event.getMessage()) || autoMod.hasAdvertisingLink(event.getMessage())) {
-			event.getMessage().delete().queue();
-			return;
-		}
-		MessageEmbed embed = buildSuggestionEmbed(event.getMessage());
-		MessageActionUtils.addAttachmentsAndSend(event.getMessage(), event.getChannel().sendMessageEmbeds(embed)).thenAccept(message -> {
+	public MessageModificationStatus processMessage(MessageContent content) {
+		if (!canCreateSuggestion(content.event())) return MessageModificationStatus.NOT_MODIFIED;
+		MessageEmbed embed = buildSuggestionEmbed(content.messageText().toString(), content.event().getMember());
+		MessageActionUtils.addAttachmentsAndSend(content.attachments(), content.event().getChannel().sendMessageEmbeds(embed))
+			.thenAccept(message -> {
 					addReactions(message).queue();
-					event.getMessage().delete().queue();
-					message.createThreadChannel(String.format("%s — Suggestion", event.getAuthor().getName()))
-							.flatMap(thread -> thread.addThreadMember(event.getAuthor()))
+					content.event().getMessage().delete().queue();
+					message.createThreadChannel(String.format("%s — Suggestion", content.event().getAuthor().getName()))
+							.flatMap(thread -> thread.addThreadMember(content.event().getAuthor()))
 							.queue();
 				}
 		).exceptionally(e -> {
 			log.error("Could not send Submission Embed", e);
 			return null;
 		});
+		return MessageModificationStatus.STOP_PROCESSING;
 	}
-
+	
 	/**
 	 * Decides whether the message author is eligible to create new suggestions.
 	 *
@@ -76,19 +72,21 @@ private RestAction<?> addReactions(Message message) {
 		);
 	}
 
-
-
-	private MessageEmbed buildSuggestionEmbed(Message message) {
-		Member member = message.getMember();
+	private MessageEmbed buildSuggestionEmbed(String messageContent, Member member) {
 		// Note: member will never be null in practice. This is to satisfy code analysis tools.
 		if (member == null) throw new IllegalStateException("Member was null when building suggestion embed.");
 		return new EmbedBuilder()
 				.setTitle("Suggestion")
 				.setAuthor(member.getEffectiveName(), null, member.getEffectiveAvatarUrl())
 				.setColor(Responses.Type.DEFAULT.getColor())
 				.setTimestamp(Instant.now())
-				.setDescription(message.getContentRaw())
-				.setFooter(message.getAuthor().getId())
+				.setDescription(messageContent)
+				.setFooter(member.getId())
 				.build();
 	}
+	
+	@Override
+	public int getOrder() {
+		return LOWEST_PRECEDENCE;
+	}
 }

src/main/java/net/discordjug/javabot/util/MessageActionUtils.java

@@ -17,6 +17,7 @@
 import net.dv8tion.jda.api.components.actionrow.ActionRow;
 import net.dv8tion.jda.api.components.actionrow.ActionRowChildComponent;
 import net.dv8tion.jda.api.entities.Message;
+import net.dv8tion.jda.api.entities.Message.Attachment;
 import net.dv8tion.jda.api.entities.MessageEmbed;
 
 /**
@@ -61,15 +62,15 @@ public static List<MessageTopLevelComponent> disableActionRows(List<MessageTopLe
 	}
 
 	/**
-	 * Adds all Attachments from the initial message to the new message action and sends the message.
+	 * Adds attachments to a new message action and sends the message.
 	 *
-	 * @param message The initial {@link Message} object.
+	 * @param attachments The attachments to add.
 	 * @param action  The new {@link net.dv8tion.jda.api.requests.restaction.MessageCreateAction}.
 	 * @return A {@link CompletableFuture} with the message that is being sent.
 	 */
-	public static CompletableFuture<Message> addAttachmentsAndSend(Message message, MessageCreateAction action) {
+	public static CompletableFuture<Message> addAttachmentsAndSend(List<Attachment> attachments, MessageCreateAction action) {
 		List<CompletableFuture<?>> attachmentFutures = new ArrayList<>();
-		for (Message.Attachment attachment : message.getAttachments()) {
+		for (Message.Attachment attachment : attachments) {
 			attachmentFutures.add(
 					attachment.getProxy().download()
 							.thenApply(is -> action.addFiles(FileUpload.fromData(is, attachment.getFileName())))