Merge pull request #365 from Java-Discord/dynxsty/post_forum_cleanup

jasonlessenich · web-flow · commit 775457f8e5d0 · 2022-10-03T11:04:34.000+02:00
Post Help Forum Cleanup
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -25,10 +25,12 @@ repositories {
 dependencies {
     testImplementation("org.junit.jupiter:junit-jupiter-api:5.9.0")
     testRuntimeOnly("org.junit.jupiter:junit-jupiter-engine:5.9.0")
+    compileOnly("com.google.code.findbugs:jsr305:3.0.2")
+    compileOnly("org.jetbrains:annotations:23.0.0")
 
     // DIH4JDA (Interaction Framework) & JDA
     implementation("com.github.DynxstyGIT:DIH4JDA:c8f7928efc")
-    implementation("net.dv8tion:JDA:5.0.0-alpha.20") {
+    implementation("com.github.DV8FromTheWorld:JDA:86af73d377") {
         exclude(module = "opus-java")
     }
 
diff --git a/src/main/java/net/javadiscord/javabot/Bot.java b/src/main/java/net/javadiscord/javabot/Bot.java
@@ -213,7 +213,7 @@ private static void addComponentHandler(@NotNull DIH4JDA dih4jda) {
 				List.of("qotw-submission"), new SubmissionInteractionManager(),
 				List.of("help-channel", "help-thank"), new HelpChannelInteractionManager(),
 				List.of("qotw-list-questions"), new QOTWQuerySubcommand(),
-				List.of(ForumHelpManager.HELP_THANKS_IDENTIFIER), new ForumHelpListener()
+				List.of(ForumHelpManager.HELP_THANKS_IDENTIFIER, ForumHelpManager.HELP_CLOSE_IDENTIFIER, ForumHelpManager.HELP_GUIDELINES_IDENTIFIER), new ForumHelpListener()
 		));
 		dih4jda.addModalHandlers(Map.of(
 				List.of("qotw-add-question"), new AddQuestionSubcommand(),
diff --git a/src/main/java/net/javadiscord/javabot/data/config/guild/HelpForumConfig.java b/src/main/java/net/javadiscord/javabot/data/config/guild/HelpForumConfig.java
@@ -13,6 +13,8 @@
 @EqualsAndHashCode(callSuper = true)
 public class HelpForumConfig extends GuildConfigItem {
 	private long helpForumChannelId = 0;
+	private String closeReminderText = "Hey, %s!\nPlease remember to `/close` this post once your question has been answered!";
+	private String helpThanksText = "Before your post will be closed, would you like to express your gratitude to any of the people who helped you? When you're done, click **I'm done here. Close this post!**.";
 
 	public ForumChannel getHelpForumChannel() {
 		return getGuild().getForumChannelById(helpForumChannelId);
diff --git a/src/main/java/net/javadiscord/javabot/systems/help/HelpChannelManager.java b/src/main/java/net/javadiscord/javabot/systems/help/HelpChannelManager.java
@@ -153,8 +153,6 @@ public void reserve(TextChannel channel, User reservingUser, Message message) th
 				TextChannel targetChannel = dormantChannels.get(0);
 				targetChannel.getManager().setParent(targetCategory).sync(targetCategory).queue();
 				targetChannel.sendMessage(config.getReopenedChannelMessage()).queue();
-			} else {
-				logChannel.sendMessage("Warning: No dormant channels were available to replenish an open channel that was just reserved.").queue();
 			}
 		} else {
 			this.openNew();
diff --git a/src/main/java/net/javadiscord/javabot/systems/help/HelpChannelUpdater.java b/src/main/java/net/javadiscord/javabot/systems/help/HelpChannelUpdater.java
@@ -5,8 +5,10 @@
 import net.dv8tion.jda.api.JDA;
 import net.dv8tion.jda.api.entities.*;
 import net.dv8tion.jda.api.entities.channel.concrete.Category;
+import net.dv8tion.jda.api.entities.channel.concrete.ForumChannel;
 import net.dv8tion.jda.api.entities.channel.concrete.TextChannel;
 import net.dv8tion.jda.api.entities.emoji.Emoji;
+import net.dv8tion.jda.api.interactions.components.ActionRow;
 import net.dv8tion.jda.api.interactions.components.buttons.Button;
 import net.dv8tion.jda.api.interactions.components.buttons.ButtonStyle;
 import net.dv8tion.jda.api.requests.RestAction;
@@ -15,6 +17,7 @@
 import net.dv8tion.jda.internal.requests.CompletedRestAction;
 import net.javadiscord.javabot.Bot;
 import net.javadiscord.javabot.data.config.guild.HelpConfig;
+import net.javadiscord.javabot.data.config.guild.HelpForumConfig;
 import net.javadiscord.javabot.systems.help.model.ChannelReservation;
 import net.javadiscord.javabot.util.ExceptionLogger;
 import net.javadiscord.javabot.util.Responses;
@@ -372,6 +375,7 @@ private RestAction<?> semanticMessageCheck(TextChannel channel, User owner, List
 	}
 
 	private void updateHelpOverview() {
+		HelpForumConfig forumConfig = Bot.getConfig().get(config.getGuild()).getHelpForumConfig();
 		config.getHelpOverviewMessageIds().forEach((channelId, messageId) -> {
 			TextChannel channel = config.getGuild().getTextChannelById(channelId);
 			if (channel == null) {
@@ -381,11 +385,17 @@ private void updateHelpOverview() {
 			List<TextChannel> availableChannels = config.getOpenChannelCategory().getTextChannels();
 			List<Button> buttons = new ArrayList<>(2);
 			if (!availableChannels.isEmpty()) {
-				buttons.add(Button.link(availableChannels.get(0).getJumpUrl(), "Show me an available Help Channel!"));
+				buttons.add(Button.link(availableChannels.get(0).getJumpUrl(), "Show me an Available Help Channel!"));
 			}
 			buttons.add(Button.link(StringResourceCache.load("/help_overview/overview_image_url.txt"), "How does this work?"));
 			channel.retrieveMessageById(messageId).queue(
-					m -> m.editMessageEmbeds(buildHelpOverviewEmbed()).setActionRow(buttons).queue(),
+					m -> m.editMessageEmbeds(buildHelpOverviewEmbed()).setComponents(
+							ActionRow.of(
+									// Temporary Forum Channel Upsell
+									Button.link(forumConfig.getHelpForumChannel().getJumpUrl(), "Try our new Help Forum!"),
+									Button.link("https://discord.com/blog/forum-channels-space-for-organized-conversation", "What are Forums?")
+							),
+							ActionRow.of(buttons)).queue(),
 					err -> channel.sendMessageEmbeds(buildHelpOverviewEmbed()).queue(m -> {
 						config.getHelpOverviewMessageIds().put(channelId, m.getIdLong());
 						Bot.getConfig().flush();
@@ -419,10 +429,14 @@ private void updateHelpOverview() {
 					e -> ExceptionLogger.capture(e, getClass().getSimpleName())
 			);
 		}
+		ForumChannel forum = Bot.getConfig().get(config.getGuild()).getHelpForumConfig().getHelpForumChannel();
 		EmbedBuilder builder = new EmbedBuilder()
 				.setTitle("Help Overview")
 				.setColor(Responses.Type.DEFAULT.getColor())
-				.setDescription(availableHelpChannels + " are __**available**__ to claim!")
+				.setDescription(availableHelpChannels.isEmpty() ?
+						String.format("There are no help channels available to claim.%nHow about using our new **[Help Forum](%s)** (%s) then?",
+								forum.getJumpUrl(), forum.getAsMention()) :
+						availableHelpChannels + " are __**available**__ to claim!")
 				.setFooter("Last refreshed: ")
 				.setTimestamp(Instant.now());
 		if (!reservedHelpChannels.isEmpty()) {
diff --git a/src/main/java/net/javadiscord/javabot/systems/help/commands/HelpPingSubcommand.java b/src/main/java/net/javadiscord/javabot/systems/help/commands/HelpPingSubcommand.java
@@ -3,6 +3,8 @@
 import com.dynxsty.dih4jda.interactions.commands.SlashCommand;
 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.entities.channel.concrete.ThreadChannel;
 import net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent;
 import net.dv8tion.jda.api.interactions.commands.build.SubcommandData;
 import net.javadiscord.javabot.Bot;
@@ -23,7 +25,7 @@
  * helpers.
  */
 public class HelpPingSubcommand extends SlashCommand.Subcommand {
-	private static final String WRONG_CHANNEL_MSG = "This command can only be used in **reserved help channels**.";
+	private static final String WRONG_CHANNEL_MSG = "This command can only be used in **reserved help channels** OR **help forum posts.**.";
 	private static final long CACHE_CLEANUP_DELAY = 60L;
 
 	private final Map<Long, Pair<Long, Guild>> lastPingTimes;
@@ -45,6 +47,43 @@ public void execute(@NotNull SlashCommandInteractionEvent event) {
 			return;
 		}
 		GuildConfig config = Bot.getConfig().get(guild);
+		if (event.getChannelType() == ChannelType.TEXT) {
+			handleTextBasedHelpPing(event, config);
+		} else if (event.getChannelType() == ChannelType.GUILD_PUBLIC_THREAD) {
+			handleForumBasedHelpPing(event, config, event.getChannel().asThreadChannel());
+		}
+	}
+
+	private void handleForumBasedHelpPing(@NotNull SlashCommandInteractionEvent event, @NotNull GuildConfig config, @NotNull ThreadChannel post) {
+		if (post.getParentChannel().getType() != ChannelType.FORUM ||
+				post.getParentChannel().getIdLong() != config.getHelpForumConfig().getHelpForumChannelId()
+		) {
+			Responses.error(event, WRONG_CHANNEL_MSG).queue();
+			return;
+		}
+		Member member = event.getMember();
+		if (member == null) {
+			Responses.warning(event, "No member information was available for this event.").queue();
+			return;
+		}
+		if (isHelpPingForbiddenForMember(post.getOwnerIdLong(), member, config)) {
+			Responses.warning(event, "Sorry, but only the person who reserved this channel, or staff and helpers, may use this command.").queue();
+			return;
+		}
+		if (isHelpPingTimeoutElapsed(member.getIdLong(), config)) {
+			lastPingTimes.put(event.getMember().getIdLong(), new Pair<>(System.currentTimeMillis(), config.getGuild()));
+			Role role = config.getHelpConfig().getHelpPingRole();
+			event.getChannel().sendMessage(role.getAsMention())
+					.setAllowedMentions(EnumSet.of(Message.MentionType.ROLE))
+					.setEmbeds(buildAuthorEmbed(event.getUser()))
+					.queue();
+			event.replyFormat("Successfully pinged " + role.getAsMention()).setEphemeral(true).queue();
+		} else {
+			Responses.warning(event, "Sorry, but you can only use this command occasionally. Please try again later.").queue();
+		}
+	}
+
+	private void handleTextBasedHelpPing(@NotNull SlashCommandInteractionEvent event, @NotNull GuildConfig config) {
 		HelpChannelManager channelManager = new HelpChannelManager(config.getHelpConfig());
 		if (channelManager.isReserved(event.getChannel().asTextChannel())) {
 			Optional<ChannelReservation> optionalReservation = channelManager.getReservationForChannel(event.getChannel().getIdLong());
@@ -63,7 +102,7 @@ public void execute(@NotNull SlashCommandInteractionEvent event) {
 				return;
 			}
 			if (isHelpPingTimeoutElapsed(member.getIdLong(), config)) {
-				lastPingTimes.put(event.getMember().getIdLong(), new Pair<>(System.currentTimeMillis(), guild));
+				lastPingTimes.put(event.getMember().getIdLong(), new Pair<>(System.currentTimeMillis(), config.getGuild()));
 				Role role = channelManager.getConfig().getHelpPingRole();
 				event.getChannel().sendMessage(role.getAsMention())
 						.setAllowedMentions(EnumSet.of(Message.MentionType.ROLE))
@@ -103,6 +142,24 @@ private boolean isHelpPingForbiddenForMember(@NotNull ChannelReservation reserva
 		);
 	}
 
+	/**
+	 * Determines if a user is forbidden from sending a help-ping command due
+	 * to their status in the server.
+	 *
+	 * @param postOwnerId The posts' owner id.
+	 * @param member      The member.
+	 * @param config      The guild config.
+	 * @return True if the user is forbidden from sending the command.
+	 */
+	private boolean isHelpPingForbiddenForMember(long postOwnerId, @NotNull Member member, @NotNull GuildConfig config) {
+		Set<Role> allowedRoles = Set.of(config.getModerationConfig().getStaffRole(), config.getHelpConfig().getHelperRole());
+		return !(
+				postOwnerId == member.getUser().getIdLong() ||
+						member.getRoles().stream().anyMatch(allowedRoles::contains) ||
+						member.isOwner()
+		);
+	}
+
 	/**
 	 * Determines if the user's timeout has elapsed (or doesn't exist), which
 	 * implies that it's fine for the user to send the command.
diff --git a/src/main/java/net/javadiscord/javabot/systems/help/commands/UnreserveCommand.java b/src/main/java/net/javadiscord/javabot/systems/help/commands/UnreserveCommand.java
@@ -54,7 +54,7 @@ private void handleForumBasedHelp(SlashCommandInteractionEvent event, @NotNull T
 			replyInvalidChannel(event);
 		}
 		ForumHelpManager manager = new ForumHelpManager(postThread);
-		if (isForumEligibleToBeUnreserved(event, postThread)) {
+		if (manager.isForumEligibleToBeUnreserved(event)) {
 			manager.close(event, event.getUser().getIdLong() == postThread.getOwnerIdLong(),
 					event.getOption("reason", null, OptionMapping::getAsString)
 			);
@@ -82,10 +82,6 @@ private void replyInvalidChannel(CommandInteraction interaction) {
 				.queue();
 	}
 
-	private boolean isForumEligibleToBeUnreserved(@NotNull SlashCommandInteractionEvent event, @NotNull ThreadChannel postThread) {
-		return event.getUser().getIdLong() == postThread.getOwnerIdLong() || memberHasHelperRole(event) || memberHasStaffRole(event);
-	}
-
 	private boolean isTextEligibleToBeUnreserved(SlashCommandInteractionEvent event, TextChannel channel, HelpConfig config, User owner) {
 		return channelIsInReservedCategory(channel, config) &&
 				(isUserWhoReservedChannel(event, owner) || memberHasHelperRole(event) || memberHasStaffRole(event));
diff --git a/src/main/java/net/javadiscord/javabot/systems/help/forum/ForumHelpListener.java b/src/main/java/net/javadiscord/javabot/systems/help/forum/ForumHelpListener.java
@@ -2,21 +2,30 @@
 
 import com.dynxsty.dih4jda.interactions.ComponentIdBuilder;
 import com.dynxsty.dih4jda.interactions.components.ButtonHandler;
+import net.dv8tion.jda.api.EmbedBuilder;
 import net.dv8tion.jda.api.entities.Message;
+import net.dv8tion.jda.api.entities.UserSnowflake;
+import net.dv8tion.jda.api.entities.channel.Channel;
 import net.dv8tion.jda.api.entities.channel.ChannelType;
 import net.dv8tion.jda.api.entities.channel.concrete.ForumChannel;
 import net.dv8tion.jda.api.entities.channel.concrete.ThreadChannel;
+import net.dv8tion.jda.api.events.channel.ChannelCreateEvent;
 import net.dv8tion.jda.api.events.interaction.component.ButtonInteractionEvent;
 import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
 import net.dv8tion.jda.api.hooks.ListenerAdapter;
+import net.dv8tion.jda.api.interactions.callbacks.IReplyCallback;
 import net.dv8tion.jda.api.interactions.components.ActionComponent;
+import net.dv8tion.jda.api.interactions.components.ActionRow;
 import net.dv8tion.jda.api.interactions.components.buttons.Button;
 import net.javadiscord.javabot.Bot;
-import net.javadiscord.javabot.data.config.GuildConfig;
 import net.javadiscord.javabot.data.config.guild.HelpConfig;
+import net.javadiscord.javabot.data.config.guild.HelpForumConfig;
 import net.javadiscord.javabot.systems.help.HelpChannelManager;
 import net.javadiscord.javabot.systems.help.HelpExperienceService;
 import net.javadiscord.javabot.systems.help.model.HelpTransactionMessage;
+import net.javadiscord.javabot.systems.user_preferences.UserPreferenceService;
+import net.javadiscord.javabot.systems.user_preferences.model.Preference;
+import net.javadiscord.javabot.systems.user_preferences.model.UserPreference;
 import net.javadiscord.javabot.util.ExceptionLogger;
 import net.javadiscord.javabot.util.Responses;
 import org.jetbrains.annotations.NotNull;
@@ -39,19 +48,12 @@ public void onMessageReceived(@NotNull MessageReceivedEvent event) {
 		if (event.getMessage().getAuthor().isSystem() || event.getMessage().getAuthor().isBot()) {
 			return;
 		}
-		// check for guild & channel type
-		if (!event.isFromGuild() || event.getChannelType() != ChannelType.GUILD_PUBLIC_THREAD) {
+		// check for forum post
+		if (isInvalidForumPost(event.getChannel())) {
 			return;
 		}
-		// get post & check parent channel
 		ThreadChannel post = event.getChannel().asThreadChannel();
-		if (post.getParentChannel().getType() != ChannelType.FORUM) {
-			return;
-		}
-		ForumChannel forum = post.getParentChannel().asForumChannel();
-		GuildConfig config = Bot.getConfig().get(event.getGuild());
-		// check for channel id
-		if (forum.getIdLong() != config.getHelpForumConfig().getHelpForumChannelId()) {
+		if (isInvalidHelpForumChannel(post.getParentChannel().asForumChannel())) {
 			return;
 		}
 		// cache messages
@@ -63,20 +65,58 @@ public void onMessageReceived(@NotNull MessageReceivedEvent event) {
 		HELP_POST_MESSAGES.put(post.getIdLong(), messages);
 	}
 
+	@Override
+	public void onChannelCreate(@NotNull ChannelCreateEvent event) {
+		if (event.getGuild() == null || isInvalidForumPost(event.getChannel())) {
+			return;
+		}
+		HelpForumConfig config = Bot.getConfig().get(event.getGuild()).getHelpForumConfig();
+		ThreadChannel post = event.getChannel().asThreadChannel();
+		if (isInvalidHelpForumChannel(post.getParentChannel().asForumChannel())) {
+			return;
+		}
+		// send post buttons
+		post.sendMessageComponents(ActionRow.of(
+				Button.primary(ComponentIdBuilder.build(ForumHelpManager.HELP_CLOSE_IDENTIFIER, post.getIdLong()), "Close Post"),
+				Button.secondary(ComponentIdBuilder.build(ForumHelpManager.HELP_GUIDELINES_IDENTIFIER), "View Help Guidelines")
+		)).queue(success -> {
+			// send /close reminder (if enabled)
+			UserPreferenceService service = new UserPreferenceService(Bot.getDataSource());
+			UserPreference preference = service.getOrCreate(post.getOwnerIdLong(), Preference.FORUM_CLOSE_REMINDER);
+			if (Boolean.parseBoolean(preference.getState())) {
+				post.sendMessageFormat(config.getCloseReminderText(), UserSnowflake.fromId(post.getOwnerIdLong()).getAsMention()).queue();
+			}
+		});
+	}
+
 	@Override
 	public void handleButton(@NotNull ButtonInteractionEvent event, @NotNull Button button) {
 		String[] id = ComponentIdBuilder.split(event.getComponentId());
-		if (event.getChannelType() != ChannelType.GUILD_PUBLIC_THREAD
-				|| event.getChannel().asThreadChannel().getParentChannel().getType() != ChannelType.FORUM) {
+		if (isInvalidForumPost(event.getChannel()) ||
+				isInvalidHelpForumChannel(event.getChannel().asThreadChannel().getParentChannel().asForumChannel())
+		) {
 			Responses.error(event, "This button may only be used inside help forum threads.").queue();
 			return;
 		}
-		ForumHelpManager manager = new ForumHelpManager(event.getChannel().asThreadChannel());
+		ThreadChannel post = event.getChannel().asThreadChannel();
+		ForumHelpManager manager = new ForumHelpManager(post);
 		switch (id[0]) {
 			case ForumHelpManager.HELP_THANKS_IDENTIFIER -> handleHelpThanksInteraction(event, manager, id);
+			case ForumHelpManager.HELP_GUIDELINES_IDENTIFIER -> handleReplyGuidelines(event, post.getParentChannel().asForumChannel());
+			case ForumHelpManager.HELP_CLOSE_IDENTIFIER -> handlePostClose(event, manager);
 		}
 	}
 
+	private boolean isInvalidForumPost(@NotNull Channel channel) {
+		return channel.getType() != ChannelType.GUILD_PUBLIC_THREAD ||
+				((ThreadChannel) channel).getParentChannel().getType() != ChannelType.FORUM;
+	}
+
+	private boolean isInvalidHelpForumChannel(@NotNull ForumChannel forum) {
+		HelpForumConfig config = Bot.getConfig().get(forum.getGuild()).getHelpForumConfig();
+		return config.getHelpForumChannelId() != forum.getIdLong();
+	}
+
 	private void handleHelpThanksInteraction(@NotNull ButtonInteractionEvent event, @NotNull ForumHelpManager manager, String @NotNull [] id) {
 		ThreadChannel post = manager.postThread();
 		HelpConfig config = Bot.getConfig().get(event.getGuild()).getHelpConfig();
@@ -108,4 +148,21 @@ private void handleHelpThanksInteraction(@NotNull ButtonInteractionEvent event,
 			default -> event.editButton(event.getButton().asDisabled()).queue();
 		}
 	}
+
+	private void handleReplyGuidelines(@NotNull IReplyCallback callback, @NotNull ForumChannel channel) {
+		callback.replyEmbeds(new EmbedBuilder()
+						.setTitle("Help Guidelines")
+						.setDescription(channel.getTopic())
+						.build()
+				).setEphemeral(true)
+				.queue();
+	}
+
+	private void handlePostClose(ButtonInteractionEvent event, @NotNull ForumHelpManager manager) {
+		if (manager.isForumEligibleToBeUnreserved(event)) {
+			manager.close(event, event.getUser().getIdLong() == manager.postThread().getOwnerIdLong(), null);
+		} else {
+			Responses.warning(event, "Could not close this post", "You're not allowed to close this post.").queue();
+		}
+	}
 }
diff --git a/src/main/java/net/javadiscord/javabot/systems/help/forum/ForumHelpManager.java b/src/main/java/net/javadiscord/javabot/systems/help/forum/ForumHelpManager.java
diff --git a/src/main/java/net/javadiscord/javabot/systems/user_preferences/model/Preference.java b/src/main/java/net/javadiscord/javabot/systems/user_preferences/model/Preference.java
diff --git a/src/main/resources/application.properties b/src/main/resources/application.properties

Original file line number	Diff line number	Diff line change
`@@ -153,8 +153,6 @@ public void reserve(TextChannel channel, User reservingUser, Message message) th`
`153`	`153`	`TextChannel targetChannel = dormantChannels.get(0);`
`154`	`154`	`targetChannel.getManager().setParent(targetCategory).sync(targetCategory).queue();`
`155`	`155`	`targetChannel.sendMessage(config.getReopenedChannelMessage()).queue();`
`156`		`- } else {`
`157`		`- logChannel.sendMessage("Warning: No dormant channels were available to replenish an open channel that was just reserved.").queue();`
`158`	`156`	`}`
`159`	`157`	`} else {`
`160`	`158`	`this.openNew();`