Merge pull request #364 from Java-Discord/dynxsty/forum-help

Author: jasonlessenich

src/main/java/net/javadiscord/javabot/Bot.java

@@ -27,6 +27,8 @@
 import net.javadiscord.javabot.listener.*;
 import net.javadiscord.javabot.systems.help.HelpChannelInteractionManager;
 import net.javadiscord.javabot.systems.help.HelpChannelListener;
+import net.javadiscord.javabot.systems.help.forum.ForumHelpListener;
+import net.javadiscord.javabot.systems.help.forum.ForumHelpManager;
 import net.javadiscord.javabot.systems.moderation.AutoMod;
 import net.javadiscord.javabot.systems.moderation.report.ReportManager;
 import net.javadiscord.javabot.systems.moderation.server_lock.ServerLockManager;
@@ -192,6 +194,7 @@ private static void addEventListeners(@NotNull JDA jda, @NotNull DIH4JDA dih4jda
 				new MetricsUpdater(),
 				new SuggestionListener(),
 				new StarboardManager(),
+				new ForumHelpListener(),
 				new HelpChannelListener(),
 				new ShareKnowledgeVoteListener(),
 				new JobChannelVoteListener(),
@@ -209,7 +212,8 @@ private static void addComponentHandler(@NotNull DIH4JDA dih4jda) {
 				List.of("self-role"), new SelfRoleInteractionManager(),
 				List.of("qotw-submission"), new SubmissionInteractionManager(),
 				List.of("help-channel", "help-thank"), new HelpChannelInteractionManager(),
-				List.of("qotw-list-questions"), new QOTWQuerySubcommand()
+				List.of("qotw-list-questions"), new QOTWQuerySubcommand(),
+				List.of(ForumHelpManager.HELP_THANKS_IDENTIFIER), new ForumHelpListener()
 		));
 		dih4jda.addModalHandlers(Map.of(
 				List.of("qotw-add-question"), new AddQuestionSubcommand(),

src/main/java/net/javadiscord/javabot/data/config/GuildConfig.java

@@ -31,6 +31,7 @@ public class GuildConfig {
 	private transient Path file;
 
 	private HelpConfig helpConfig;
+	private HelpForumConfig helpForumConfig;
 	private ModerationConfig moderationConfig;
 	private QOTWConfig qotwConfig;
 	private MetricsConfig metricsConfig;
@@ -48,6 +49,7 @@ public GuildConfig(Guild guild, Path file) {
 		this.file = file;
 		// Initialize all config items.
 		this.helpConfig = new HelpConfig();
+		this.helpForumConfig = new HelpForumConfig();
 		this.moderationConfig = new ModerationConfig();
 		this.qotwConfig = new QOTWConfig();
 		this.metricsConfig = new MetricsConfig();
@@ -95,6 +97,8 @@ private void setGuild(Guild guild) {
 		this.guild = guild;
 		if (this.helpConfig == null) this.helpConfig = new HelpConfig();
 		this.helpConfig.setGuildConfig(this);
+		if (this.helpForumConfig == null) this.helpForumConfig = new HelpForumConfig();
+		this.helpForumConfig.setGuildConfig(this);
 		if (this.moderationConfig == null) this.moderationConfig = new ModerationConfig();
 		this.moderationConfig.setGuildConfig(this);
 		if (this.qotwConfig == null) this.qotwConfig = new QOTWConfig();

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

@@ -0,0 +1,20 @@
+package net.javadiscord.javabot.data.config.guild;
+
+import lombok.Data;
+import lombok.EqualsAndHashCode;
+import net.dv8tion.jda.api.entities.channel.concrete.ForumChannel;
+import net.javadiscord.javabot.data.config.GuildConfigItem;
+
+/**
+ * Configuration for the guilds' forum help system, which aims to replace the
+ * 'old' text channel-based one.
+ */
+@Data
+@EqualsAndHashCode(callSuper = true)
+public class HelpForumConfig extends GuildConfigItem {
+	private long helpForumChannelId = 0;
+
+	public ForumChannel getHelpForumChannel() {
+		return getGuild().getForumChannelById(helpForumChannelId);
+	}
+}

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

@@ -4,7 +4,7 @@
 import net.dv8tion.jda.api.entities.*;
 import net.dv8tion.jda.api.entities.channel.ChannelType;
 import net.dv8tion.jda.api.entities.channel.concrete.TextChannel;
-import net.dv8tion.jda.api.entities.channel.middleman.GuildMessageChannel;
+import net.dv8tion.jda.api.entities.channel.middleman.StandardGuildChannel;
 import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
 import net.dv8tion.jda.api.hooks.ListenerAdapter;
 import net.javadiscord.javabot.Bot;
@@ -40,7 +40,7 @@ public void onMessageReceived(@Nonnull MessageReceivedEvent event) {
 			tc = event.getChannel().asTextChannel();
 		}
 		if (event.isFromThread()) {
-			GuildMessageChannel parentChannel = event.getChannel().asThreadChannel().getParentMessageChannel();
+			StandardGuildChannel parentChannel = event.getChannel().asThreadChannel().getParentChannel().asStandardGuildChannel();
 			if (parentChannel instanceof TextChannel textChannel) {
 				tc = textChannel;
 			}

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

@@ -332,7 +332,7 @@ public RestAction<?> unreserveChannel(TextChannel channel) {
 				Optional<ChannelReservation> reservationOptional = this.getReservationForChannel(channel.getIdLong());
 				if (reservationOptional.isPresent()) {
 					ChannelReservation reservation = reservationOptional.get();
-					Map<Long, Double> experience = this.calculateExperience(HelpChannelListener.reservationMessages.get(reservation.getId()), reservation.getUserId());
+					Map<Long, Double> experience = calculateExperience(HelpChannelListener.reservationMessages.get(reservation.getId()), reservation.getUserId(), config);
 					for (Long recipient : experience.keySet()) {
 						service.performTransaction(recipient, experience.get(recipient), HelpTransactionMessage.HELPED, channel.getGuild());
 					}
@@ -527,7 +527,15 @@ public Optional<Long> getReservationId(TextChannel channel) {
 		}
 	}
 
-	private Map<Long, Double> calculateExperience(List<Message> messages, long ownerId) {
+	/**
+	 * Calculates the experience for each user, based on the messages they sent.
+	 *
+	 * @param messages The list of {@link Message}s.
+	 * @param ownerId The owner id.
+	 * @param config The {@link HelpConfig}, containing some static info for the calculation.
+	 * @return A {@link Map}, containing the users' id as the key, and the amount of xp as the value.
+	 */
+	public static Map<Long, Double> calculateExperience(List<Message> messages, long ownerId, HelpConfig config) {
 		Map<Long, Double> experience = new HashMap<>();
 		if (messages == null || messages.isEmpty()) return Map.of();
 		for (User user : messages.stream().map(Message::getAuthor).collect(Collectors.toSet())) {

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

@@ -86,8 +86,7 @@ public List<HelpTransaction> getRecentTransactions(long userId, int count) throw
 		try (Connection con = this.dataSource.getConnection()) {
 			con.setReadOnly(true);
 			HelpTransactionRepository repo = new HelpTransactionRepository(con);
-			List<HelpTransaction> transactions = repo.getTransactions(userId, count);
-			return transactions;
+			return repo.getTransactions(userId, count);
 		}
 	}
 

src/main/java/net/javadiscord/javabot/systems/help/commands/UnreserveCommand.java

@@ -4,13 +4,16 @@
 import net.dv8tion.jda.api.entities.User;
 import net.dv8tion.jda.api.entities.channel.ChannelType;
 import net.dv8tion.jda.api.entities.channel.concrete.TextChannel;
+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.CommandInteraction;
 import net.dv8tion.jda.api.interactions.commands.OptionMapping;
 import net.dv8tion.jda.api.interactions.commands.OptionType;
 import net.dv8tion.jda.api.interactions.commands.build.Commands;
 import net.javadiscord.javabot.Bot;
 import net.javadiscord.javabot.data.config.guild.HelpConfig;
 import net.javadiscord.javabot.systems.help.HelpChannelManager;
+import net.javadiscord.javabot.systems.help.forum.ForumHelpManager;
 import net.javadiscord.javabot.util.Responses;
 import org.jetbrains.annotations.NotNull;
 
@@ -31,15 +34,40 @@ public UnreserveCommand() {
 
 	@Override
 	public void execute(@NotNull SlashCommandInteractionEvent event) {
-		if (event.getChannelType() != ChannelType.TEXT) {
-			Responses.error(event, "This command cannot be used outside of help channels.").queue();
+		// check whether the channel type is either text or thread (possible forum post?)
+		if (event.getChannelType() != ChannelType.TEXT && event.getChannelType() != ChannelType.GUILD_PUBLIC_THREAD) {
+			replyInvalidChannel(event);
 			return;
 		}
-		TextChannel channel = event.getChannel().asTextChannel();
+		// handle forum-based help system
+		if (event.getChannelType() == ChannelType.GUILD_PUBLIC_THREAD) {
+			handleForumBasedHelp(event, event.getChannel().asThreadChannel());
+		}
+		// handle text-based help system
+		if (event.getChannelType() == ChannelType.TEXT) {
+			handleTextBasedHelp(event, event.getChannel().asTextChannel());
+		}
+	}
+
+	private void handleForumBasedHelp(SlashCommandInteractionEvent event, @NotNull ThreadChannel postThread) {
+		if (postThread.getParentChannel().getType() != ChannelType.FORUM) {
+			replyInvalidChannel(event);
+		}
+		ForumHelpManager manager = new ForumHelpManager(postThread);
+		if (isForumEligibleToBeUnreserved(event, postThread)) {
+			manager.close(event, event.getUser().getIdLong() == postThread.getOwnerIdLong(),
+					event.getOption("reason", null, OptionMapping::getAsString)
+			);
+		} else {
+			Responses.warning(event, "Could not close this post", "You're not allowed to close this post.").queue();
+		}
+	}
+
+	private void handleTextBasedHelp(@NotNull SlashCommandInteractionEvent event, TextChannel channel) {
 		HelpConfig config = Bot.getConfig().get(event.getGuild()).getHelpConfig();
 		HelpChannelManager channelManager = new HelpChannelManager(config);
 		User owner = channelManager.getReservedChannelOwner(channel);
-		if (isEligibleToBeUnreserved(event, channel, config, owner)) {
+		if (isTextEligibleToBeUnreserved(event, channel, config, owner)) {
 			String reason = event.getOption("reason", null, OptionMapping::getAsString);
 			event.deferReply(true).queue();
 			channelManager.unreserveChannelByOwner(channel, owner, reason, event);
@@ -48,25 +76,35 @@ public void execute(@NotNull SlashCommandInteractionEvent event) {
 		}
 	}
 
-	private boolean isEligibleToBeUnreserved(SlashCommandInteractionEvent event, TextChannel channel, HelpConfig config, User owner) {
+	private void replyInvalidChannel(CommandInteraction interaction) {
+		Responses.warning(interaction, "Invalid Channel",
+						"This command may only be used in either the text-channel-based help system, or in our new forum help system.")
+				.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));
 	}
 
-	private boolean channelIsInReservedCategory(TextChannel channel, HelpConfig config) {
+	private boolean channelIsInReservedCategory(@NotNull TextChannel channel, @NotNull HelpConfig config) {
 		return config.getReservedChannelCategory().equals(channel.getParentCategory());
 	}
 
 	private boolean isUserWhoReservedChannel(SlashCommandInteractionEvent event, User owner) {
 		return owner != null && event.getUser().equals(owner);
 	}
 
-	private boolean memberHasStaffRole(SlashCommandInteractionEvent event) {
+	private boolean memberHasStaffRole(@NotNull SlashCommandInteractionEvent event) {
 		return event.getMember() != null &&
 				event.getMember().getRoles().contains(Bot.getConfig().get(event.getGuild()).getModerationConfig().getStaffRole());
 	}
 
-	private boolean memberHasHelperRole(SlashCommandInteractionEvent event) {
+	private boolean memberHasHelperRole(@NotNull SlashCommandInteractionEvent event) {
 		return event.getMember() != null &&
 				event.getMember().getRoles().contains(Bot.getConfig().get(event.getGuild()).getHelpConfig().getHelperRole());
 	}

src/main/java/net/javadiscord/javabot/systems/help/forum/ForumHelpListener.java

@@ -0,0 +1,111 @@
+package net.javadiscord.javabot.systems.help.forum;
+
+import com.dynxsty.dih4jda.interactions.ComponentIdBuilder;
+import com.dynxsty.dih4jda.interactions.components.ButtonHandler;
+import net.dv8tion.jda.api.entities.Message;
+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.interaction.component.ButtonInteractionEvent;
+import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
+import net.dv8tion.jda.api.hooks.ListenerAdapter;
+import net.dv8tion.jda.api.interactions.components.ActionComponent;
+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.systems.help.HelpChannelManager;
+import net.javadiscord.javabot.systems.help.HelpExperienceService;
+import net.javadiscord.javabot.systems.help.model.HelpTransactionMessage;
+import net.javadiscord.javabot.util.ExceptionLogger;
+import net.javadiscord.javabot.util.Responses;
+import org.jetbrains.annotations.NotNull;
+
+import java.sql.SQLException;
+import java.util.*;
+
+/**
+ * Listens for all events releated to the forum help channel system.
+ */
+public class ForumHelpListener extends ListenerAdapter implements ButtonHandler {
+
+	/**
+	 * A static Map that holds all messages that was sent in a specific reserved forum channel.
+	 */
+	public static final Map<Long, List<Message>> HELP_POST_MESSAGES = new HashMap<>();
+
+	@Override
+	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) {
+			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()) {
+			return;
+		}
+		// cache messages
+		List<Message> messages = new ArrayList<>();
+		messages.add(event.getMessage());
+		if (HELP_POST_MESSAGES.containsKey(post.getIdLong())) {
+			messages.addAll(HELP_POST_MESSAGES.get(post.getIdLong()));
+		}
+		HELP_POST_MESSAGES.put(post.getIdLong(), messages);
+	}
+
+	@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) {
+			Responses.error(event, "This button may only be used inside help forum threads.").queue();
+			return;
+		}
+		ForumHelpManager manager = new ForumHelpManager(event.getChannel().asThreadChannel());
+		switch (id[0]) {
+			case ForumHelpManager.HELP_THANKS_IDENTIFIER -> handleHelpThanksInteraction(event, manager, id);
+		}
+	}
+
+	private void handleHelpThanksInteraction(@NotNull ButtonInteractionEvent event, @NotNull ForumHelpManager manager, String @NotNull [] id) {
+		ThreadChannel post = manager.postThread();
+		HelpConfig config = Bot.getConfig().get(event.getGuild()).getHelpConfig();
+		switch (id[2]) {
+			case "done" -> {
+				List<Button> buttons = event.getMessage().getButtons();
+				// immediately delete the message
+				event.getMessage().delete().queue(s -> {
+					// close post
+					manager.close(event, false, null);
+					// add experience
+					try {
+						HelpExperienceService service = new HelpExperienceService(Bot.getDataSource());
+						Map<Long, Double> experience = HelpChannelManager.calculateExperience(HELP_POST_MESSAGES.get(post.getIdLong()), post.getOwnerIdLong(), config);
+						for (Map.Entry<Long, Double> entry : experience.entrySet()) {
+							service.performTransaction(entry.getKey(), entry.getValue(), HelpTransactionMessage.HELPED, config.getGuild());
+						}
+					} catch (SQLException e) {
+						ExceptionLogger.capture(e, getClass().getName());
+					}
+					// thank all helpers
+					buttons.stream().filter(ActionComponent::isDisabled)
+							.filter(b -> b.getId() != null)
+							.forEach(b -> manager.thankHelper(event, post, Long.parseLong(ComponentIdBuilder.split(b.getId())[2])));
+				});
+
+			}
+			case "cancel" -> event.getMessage().delete().queue();
+			default -> event.editButton(event.getButton().asDisabled()).queue();
+		}
+	}
+}