Merge pull request #376 from Java-Discord/dynxsty/qotw

Refactor QOTW

Author: jasonlessenich

build.gradle.kts

@@ -30,8 +30,8 @@ dependencies {
     compileOnly("org.jetbrains:annotations:23.0.0")
 
     // DIH4JDA (Command Framework) & JDA
-    implementation("xyz.dynxsty:dih4jda:1.6.1")
-    implementation("net.dv8tion:JDA:5.0.0-beta.1") {
+    implementation("xyz.dynxsty:dih4jda:1.6.2")
+    implementation("net.dv8tion:JDA:5.0.0-beta.2") {
         exclude(module = "opus-java")
     }
 

src/main/java/net/javadiscord/javabot/data/config/guild/QOTWConfig.java

@@ -3,10 +3,14 @@
 import lombok.Data;
 import lombok.EqualsAndHashCode;
 import net.dv8tion.jda.api.entities.Role;
+import net.dv8tion.jda.api.entities.channel.concrete.ForumChannel;
 import net.dv8tion.jda.api.entities.channel.concrete.NewsChannel;
 import net.dv8tion.jda.api.entities.channel.concrete.TextChannel;
+import net.dv8tion.jda.api.entities.channel.forums.ForumTag;
 import net.javadiscord.javabot.data.config.GuildConfigItem;
 
+import java.util.List;
+
 /**
  * Configuration for the guild's qotw system.
  */
@@ -15,8 +19,10 @@
 public class QOTWConfig extends GuildConfigItem {
 	private long questionChannelId;
 	private long submissionChannelId;
+	private long submissionsForumChannelId;
 	private long questionRoleId;
 	private long qotwReviewRoleId;
+	private String submissionForumOngoingReviewTagName = "";
 
 	public NewsChannel getQuestionChannel() {
 		return this.getGuild().getNewsChannelById(this.questionChannelId);
@@ -26,11 +32,27 @@ public TextChannel getSubmissionChannel() {
 		return this.getGuild().getTextChannelById(this.submissionChannelId);
 	}
 
+	public ForumChannel getSubmissionsForumChannel() {
+		return this.getGuild().getForumChannelById(this.submissionsForumChannelId);
+	}
+
 	public Role getQOTWRole() {
 		return this.getGuild().getRoleById(this.questionRoleId);
 	}
 
 	public Role getQOTWReviewRole() {
 		return this.getGuild().getRoleById(this.qotwReviewRoleId);
 	}
+
+	/**
+	 * Gets a {@link ForumTag} based on the specified name.
+	 *
+	 * @return The specified {@link ForumTag} or null if there is no tag matching the specified name.
+	 */
+	public ForumTag getSubmissionsForumOngoingReviewTag() {
+		ForumChannel forumChannel = getSubmissionsForumChannel();
+		if (forumChannel == null) return null;
+		List<ForumTag> tags = forumChannel.getAvailableTagsByName(this.submissionForumOngoingReviewTagName, true);
+		return tags.stream().findFirst().orElse(null);
+	}
 }

src/main/java/net/javadiscord/javabot/data/h2db/commands/ExportTableSubcommand.java

@@ -52,7 +52,6 @@ public ExportTableSubcommand(ExecutorService asyncPool, SystemsConfig systemsCon
 								.addChoice("Message Cache", "MESSAGE_CACHE")
 								.addChoice("Question of the Week Accounts", "QOTW_POINTS")
 								.addChoice("Question of the Week Questions", "QOTW_QUESTION")
-								.addChoice("Question of the Week Submissions", "QOTW_SUBMISSIONS")
 								.addChoice("Reserved Help Channels", "RESERVED_HELP_CHANNELS")
 								.addChoice("Starboard", "STARBOARD")
 								.addChoice("Warns", "WARN")

src/main/java/net/javadiscord/javabot/listener/QOTWSubmissionListener.java

@@ -0,0 +1,42 @@
+package net.javadiscord.javabot.listener;
+
+import lombok.RequiredArgsConstructor;
+import net.dv8tion.jda.api.entities.channel.ChannelType;
+import net.dv8tion.jda.api.entities.channel.concrete.ThreadChannel;
+import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
+import net.dv8tion.jda.api.hooks.ListenerAdapter;
+import net.dv8tion.jda.api.interactions.components.buttons.Button;
+import net.javadiscord.javabot.data.config.BotConfig;
+import net.javadiscord.javabot.data.config.guild.QOTWConfig;
+import net.javadiscord.javabot.util.InteractionUtils;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Listens for new messages inside QOTW submissions and warns the author about the webhook limitations.
+ */
+@RequiredArgsConstructor
+public class QOTWSubmissionListener extends ListenerAdapter {
+	private final BotConfig botConfig;
+
+	@Override
+	public void onMessageReceived(@NotNull MessageReceivedEvent event) {
+		if (!event.isFromGuild() || !event.isFromThread() || event.getChannelType() != ChannelType.GUILD_PRIVATE_THREAD) {
+			return;
+		}
+		QOTWConfig qotwConfig = botConfig.get(event.getGuild()).getQotwConfig();
+		ThreadChannel thread = event.getChannel().asThreadChannel();
+		// TODO: fix check
+		if (thread.getParentChannel().getIdLong() != qotwConfig.getSubmissionChannelId()) {
+			return;
+		}
+		if (event.getMessage().getContentRaw().length() > 2000) {
+			event.getChannel().sendMessageFormat("""
+									Hey %s!
+									Please keep in mind that messages **over 2000 characters** get split in half due to webhook limitations.
+									If you want to make sure that your submission is properly formatted, split your message into smaller chunks instead.""",
+							event.getAuthor().getAsMention())
+					.setActionRow(Button.secondary(InteractionUtils.DELETE_ORIGINAL_TEMPLATE, "\uD83D\uDDD1️"))
+					.queue();
+		}
+	}
+}

src/main/java/net/javadiscord/javabot/systems/help/HelpExperienceJob.java

@@ -28,7 +28,7 @@ public class HelpExperienceJob {
 	/**
 	 * Removes a specified amount of experience from everyone's help account.
 	 */
-	@Scheduled(cron = "0 0 0 * * *")//daily 00:00
+	@Scheduled(cron = "0 0 0 * * *") // Daily, 00:00 UTC
 	public void execute() {
 		asyncPool.execute(() -> {
 			try {

src/main/java/net/javadiscord/javabot/systems/notification/NotificationService.java

@@ -6,14 +6,12 @@
 import net.dv8tion.jda.api.entities.User;
 import net.javadiscord.javabot.data.config.BotConfig;
 import net.javadiscord.javabot.systems.qotw.QOTWPointsService;
-import net.javadiscord.javabot.systems.qotw.submissions.dao.QOTWSubmissionRepository;
 import net.dv8tion.jda.api.entities.channel.middleman.MessageChannel;
 import net.dv8tion.jda.api.requests.restaction.MessageCreateAction;
 import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.NotNull;
 import org.springframework.stereotype.Service;
 
-import java.util.concurrent.ExecutorService;
 import java.util.function.Function;
 
 /**
@@ -24,8 +22,6 @@
 public class NotificationService {
 	private final QOTWPointsService qotwPointsService;
 	private final BotConfig botConfig;
-	private final ExecutorService asyncPool;
-	private final QOTWSubmissionRepository qotwSubmissionRepository;
 
 	@Contract("_ -> new")
 	public @NotNull GuildNotificationService withGuild(Guild guild) {
@@ -38,11 +34,11 @@ public class NotificationService {
 	}
 
 	public @NotNull QOTWGuildNotificationService withQOTW(Guild guild) {
-		return new QOTWGuildNotificationService(this, guild, asyncPool, qotwSubmissionRepository);
+		return new QOTWGuildNotificationService(this, guild);
 	}
 
 	public @NotNull QOTWNotificationService withQOTW(Guild guild, User user) {
-		return new QOTWNotificationService(this, qotwPointsService, user, guild, botConfig.getSystems(), asyncPool, qotwSubmissionRepository);
+		return new QOTWNotificationService(this, qotwPointsService, user, guild, botConfig.getSystems());
 	}
 
 	/**

src/main/java/net/javadiscord/javabot/systems/notification/QOTWGuildNotificationService.java

@@ -8,18 +8,12 @@
 import net.dv8tion.jda.api.entities.MessageEmbed;
 import net.dv8tion.jda.api.entities.User;
 import net.dv8tion.jda.api.entities.channel.concrete.ThreadChannel;
+import net.javadiscord.javabot.systems.qotw.model.QOTWSubmission;
 import net.javadiscord.javabot.systems.qotw.submissions.SubmissionStatus;
-import net.javadiscord.javabot.systems.qotw.submissions.dao.QOTWSubmissionRepository;
-import net.javadiscord.javabot.systems.qotw.submissions.model.QOTWSubmission;
-import net.javadiscord.javabot.util.ExceptionLogger;
 
 import org.jetbrains.annotations.NotNull;
-import org.springframework.dao.DataAccessException;
 
-import javax.annotation.Nullable;
 import java.time.Instant;
-import java.util.Optional;
-import java.util.concurrent.ExecutorService;
 
 /**
  * Handles all sorts of guild qotw notifications.
@@ -32,42 +26,29 @@ public class QOTWGuildNotificationService {
 	 */
 	protected final NotificationService notificationService;
 	private final Guild guild;
-	private final ExecutorService asyncPool;
-	private final QOTWSubmissionRepository qotwSubmissionRepository;
 
 	/**
 	 * Sends the executed action, performed on a QOTW submission thread, to the {@link Guild}s log channel.
 	 *
 	 * @param reviewedBy       The user which reviewed the QOTW submission thread.
-	 * @param submissionThread The submission thread itself.
+	 * @param submission	   The {@link QOTWSubmission}.
 	 * @param status           The {@link SubmissionStatus}.
-	 * @param reasons          The reasons for taking this action.
 	 */
-	public void sendSubmissionActionNotification(User reviewedBy, ThreadChannel submissionThread, SubmissionStatus status, @Nullable String... reasons) {
-		asyncPool.execute(()->{
-			try {
-				Optional<QOTWSubmission> submissionOptional = qotwSubmissionRepository.getSubmissionByThreadId(submissionThread.getIdLong());
-				submissionOptional.ifPresent(submission -> guild.getJDA().retrieveUserById(submission.getAuthorId()).queue(author -> {
-					notificationService.withGuild(guild).sendToModerationLog(c -> c.sendMessageEmbeds(buildSubmissionActionEmbed(author, submissionThread, reviewedBy, status, reasons)));
-					log.info("{} {} {}'s QOTW Submission{}", reviewedBy.getAsTag(), status.name().toLowerCase(), author.getAsTag(), reasons != null ? " for: " + String.join(", ", reasons) : ".");
-				}));
-			}catch (DataAccessException e) {
-				ExceptionLogger.capture(e, QOTWGuildNotificationService.class.getSimpleName());
-			}
+	public void sendSubmissionActionNotification(User reviewedBy, @NotNull QOTWSubmission submission, SubmissionStatus status) {
+		submission.retrieveAuthor(author -> {
+			notificationService.withGuild(guild).sendToModerationLog(c -> c.sendMessageEmbeds(buildSubmissionActionEmbed(author, submission.getThread(), reviewedBy, status)));
+			log.info("{} {} {}'s QOTW Submission", reviewedBy.getAsTag(), status.getVerb(), author.getAsTag());
 		});
 	}
 
-	private @NotNull MessageEmbed buildSubmissionActionEmbed(@NotNull User author, ThreadChannel thread, @NotNull User reviewedBy, @NotNull SubmissionStatus status, String... reasons) {
+	private @NotNull MessageEmbed buildSubmissionActionEmbed(@NotNull User author, ThreadChannel thread, @NotNull User reviewedBy, @NotNull SubmissionStatus status) {
 		EmbedBuilder builder = new EmbedBuilder()
 				.setAuthor(reviewedBy.getAsTag(), null, reviewedBy.getEffectiveAvatarUrl())
-				.setTitle(String.format("%s %s %s's QOTW Submission", reviewedBy.getAsTag(), status.name().toLowerCase(), author.getAsTag()))
+				.setTitle(String.format("%s %s %s's QOTW Submission", reviewedBy.getAsTag(), status.getVerb(), author.getAsTag()))
 				.setTimestamp(Instant.now());
-		if (thread != null && status != SubmissionStatus.DELETED) {
+		if (thread != null) {
 			builder.addField("Thread", thread.getAsMention(), true);
 		}
-		if (reasons != null && reasons.length > 0) {
-			builder.addField("Reason(s)", String.join(", ", reasons), true);
-		}
 		return builder.build();
 	}
 }

src/main/java/net/javadiscord/javabot/systems/notification/QOTWNotificationService.java

@@ -8,14 +8,11 @@
 import net.javadiscord.javabot.data.config.SystemsConfig;
 import net.javadiscord.javabot.systems.qotw.QOTWPointsService;
 import net.javadiscord.javabot.systems.qotw.model.QOTWAccount;
-import net.javadiscord.javabot.systems.qotw.submissions.dao.QOTWSubmissionRepository;
 import net.javadiscord.javabot.util.Responses;
 import org.jetbrains.annotations.NotNull;
 import org.springframework.dao.DataAccessException;
 
-import javax.annotation.Nonnull;
 import java.time.Instant;
-import java.util.concurrent.ExecutorService;
 
 /**
  * An extension of {@link QOTWGuildNotificationService} which also handles user qotw
@@ -28,8 +25,8 @@ public final class QOTWNotificationService extends QOTWGuildNotificationService
 	private final QOTWAccount account;
 	private final SystemsConfig systemsConfig;
 
-	QOTWNotificationService(NotificationService notificationService, QOTWPointsService pointsService,@NotNull User user, Guild guild, SystemsConfig systemsConfig, ExecutorService asyncPool, QOTWSubmissionRepository qotwSubmissionRepository) {
-		super(notificationService, guild, asyncPool, qotwSubmissionRepository);
+	QOTWNotificationService(NotificationService notificationService, QOTWPointsService pointsService,@NotNull User user, Guild guild, SystemsConfig systemsConfig) {
+		super(notificationService, guild);
 		this.user = user;
 		this.guild = guild;
 		QOTWAccount account;
@@ -51,8 +48,8 @@ public void sendAccountIncrementedNotification() {
 		notificationService.withUser(user).sendDirectMessage(c -> c.sendMessageEmbeds(buildAccountIncrementEmbed(account.getPoints())));
 	}
 
-	public void sendSubmissionDeclinedEmbed(@Nonnull String reason) {
-		notificationService.withUser(user).sendDirectMessage(c -> c.sendMessageEmbeds(buildSubmissionDeclinedEmbed(reason)));
+	public void sendSubmissionDeclinedEmbed() {
+		notificationService.withUser(user).sendDirectMessage(c -> c.sendMessageEmbeds(buildSubmissionDeclinedEmbed()));
 	}
 
 	private @NotNull EmbedBuilder buildQOTWNotificationEmbed() {
@@ -83,16 +80,14 @@ public void sendSubmissionDeclinedEmbed(@Nonnull String reason) {
 				.build();
 	}
 
-	private @NotNull MessageEmbed buildSubmissionDeclinedEmbed(String reasons) {
+	private @NotNull MessageEmbed buildSubmissionDeclinedEmbed() {
 		return this.buildQOTWNotificationEmbed()
 				.setColor(Responses.Type.ERROR.getColor())
 				.setDescription(String.format("""
 								Hey %s,
-								Your QOTW-Submission was **declined** for the following reasons:
-								**`%s`**
-
+								Your QOTW-Submission was **declined**.
 								However, you can try your luck again next week!""",
-						user.getAsMention(), reasons))
+						user.getAsMention()))
 				.build();
 	}
 }