Merge pull request #347 from Java-Discord/dynxsty/better-help-overview

Reworked the Help Overview Embed

Author: jasonlessenich

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

@@ -4,7 +4,6 @@
 import lombok.EqualsAndHashCode;
 import net.dv8tion.jda.api.entities.Category;
 import net.dv8tion.jda.api.entities.Role;
-import net.dv8tion.jda.api.entities.TextChannel;
 import net.javadiscord.javabot.data.config.GuildConfigItem;
 import net.javadiscord.javabot.systems.help.naming_strategies.*;
 
@@ -20,7 +19,7 @@ public class HelpConfig extends GuildConfigItem {
 	/**
 	 * The id of the help overview channel.
 	 */
-	private long helpOverviewId;
+	private Map<String, Long> helpOverviewMessageIds = Map.of();
 
 	/**
 	 * The id of the channel category that contains all open channels.
@@ -189,10 +188,6 @@ public Category getDormantChannelCategory() {
 		return getGuild().getCategoryById(this.dormantCategoryId);
 	}
 
-	public TextChannel getHelpOverviewChannel() {
-		return getGuild().getTextChannelById(this.helpOverviewId);
-	}
-
 	public Role getHelperRole() {
 		return this.getGuild().getRoleById(this.helperRoleId);
 	}

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

@@ -5,15 +5,19 @@
 import net.dv8tion.jda.api.JDA;
 import net.dv8tion.jda.api.entities.*;
 import net.dv8tion.jda.api.entities.emoji.Emoji;
+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;
 import net.dv8tion.jda.api.requests.restaction.AuditableRestAction;
 import net.dv8tion.jda.internal.interactions.component.ButtonImpl;
 import net.dv8tion.jda.internal.requests.CompletedRestAction;
+import net.javadiscord.javabot.Bot;
 import net.javadiscord.javabot.data.config.guild.HelpConfig;
 import net.javadiscord.javabot.systems.help.model.ChannelReservation;
 import net.javadiscord.javabot.util.ExceptionLogger;
 import net.javadiscord.javabot.util.Responses;
+import net.javadiscord.javabot.util.StringResourceCache;
+import net.javadiscord.javabot.util.StringUtils;
 import org.jetbrains.annotations.NotNull;
 
 import java.sql.SQLException;
@@ -55,14 +59,15 @@ public HelpChannelUpdater(JDA jda, HelpConfig config, List<ChannelSemanticCheck>
 	@Override
 	public void run() {
 		for (TextChannel channel : config.getReservedChannelCategory().getTextChannels()) {
-			this.checkReservedChannel(channel).queue();
+			checkReservedChannel(channel).queue();
 		}
 		for (TextChannel channel : config.getOpenChannelCategory().getTextChannels()) {
-			this.checkOpenChannel(channel).queue();
+			checkOpenChannel(channel).queue();
 		}
-		this.balanceChannels();
-		if (config.getHelpOverviewChannel() != null) {
-			this.updateHelpOverview();
+		balanceChannels();
+		// periodically update the Help Channel Overview Message
+		if (config.getHelpOverviewMessageIds() != null && !config.getHelpOverviewMessageIds().isEmpty()) {
+			updateHelpOverview();
 		}
 	}
 
@@ -366,49 +371,63 @@ private RestAction<?> semanticMessageCheck(TextChannel channel, User owner, List
 	}
 
 	private void updateHelpOverview() {
-		TextChannel channel = config.getHelpOverviewChannel();
-		MessageHistory history = channel.getHistory();
-		history.retrievePast(100).queue(
-				messages -> {
-					Optional<Message> latestMessage = messages.stream().filter(m -> m.getAuthor().equals(jda.getSelfUser())).findFirst();
-					if (latestMessage.isPresent()) {
-						latestMessage.get().editMessageEmbeds(buildHelpOverviewEmbed()).queue();
-					} else {
-						channel.sendMessageEmbeds(buildHelpOverviewEmbed()).queue();
-					}
-				}
-		);
+		config.getHelpOverviewMessageIds().forEach((channelId, messageId) -> {
+			TextChannel channel = config.getGuild().getTextChannelById(channelId);
+			if (channel == null) {
+				log.error("Could not find Help Overview Channel with id '{}'", channelId);
+				return;
+			}
+			List<TextChannel> availableChannels = config.getOpenChannelCategory().getTextChannels();
+			List<Button> buttons = new ArrayList<>(2);
+			if (!availableChannels.isEmpty()) {
+				buttons.add(Button.link(StringUtils.buildChannelJumpUrl(availableChannels.get(0)), "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(),
+					err -> channel.sendMessageEmbeds(buildHelpOverviewEmbed()).queue(m -> {
+						config.getHelpOverviewMessageIds().put(channelId, m.getIdLong());
+						Bot.getConfig().flush();
+						log.info("Successfully created new Help Overview Message in '{}' on message with id '{}'", channelId, m.getId());
+					})
+			);
+		});
 	}
 
-	private MessageEmbed buildHelpOverviewEmbed() {
+	private @NotNull MessageEmbed buildHelpOverviewEmbed() {
 		String availableHelpChannels = config.getOpenChannelCategory().getTextChannels()
 				.stream()
 				.map(TextChannel::getAsMention)
-				.collect(Collectors.joining("\n"));
+				.collect(Collectors.joining(", "));
 		StringBuilder reservedHelpChannels = new StringBuilder();
 		for (TextChannel channel : config.getReservedChannelCategory().getTextChannels()) {
 			Optional<ChannelReservation> optional = channelManager.getReservationForChannel(channel.getIdLong());
 			if (optional.isEmpty()) continue;
 			ChannelReservation reservation = optional.get();
+			// Attempt to fetch the user. As JDA will cache the user upon retrieval, this may be too 'slow' on the first run (for the appending),
+			// but will automatically fix itself after the embed is updated again.
 			jda.retrieveUserById(reservation.getUserId()).queue(
-					u -> reservedHelpChannels.append(String.format("""
+					user -> reservedHelpChannels.append(String.format("""
 									%s
 									Reserved by %s <t:%s:R>
 																
-									""", channel.getAsMention(), u.getAsMention(),
+									""", channel.getAsMention(), user.getAsMention(),
 							reservation.getReservedAt().toEpochSecond(ZoneOffset.UTC))),
-					e -> {
-					}
+					e -> ExceptionLogger.capture(e, getClass().getSimpleName())
 			);
 		}
-		return new EmbedBuilder()
+		EmbedBuilder builder = new EmbedBuilder()
 				.setTitle("Help Overview")
 				.setColor(Responses.Type.DEFAULT.getColor())
-				.addField("Available Help Channels", availableHelpChannels, false)
-				.addField("Reserved Help Channels", reservedHelpChannels.toString(), false)
-				.addField("Dormant Help Channels", String.format("%s dormant channels", config.getDormantChannelCategory().getTextChannels().size()), false)
-				.setFooter(String.format("Last refreshed: %s", Instant.now()))
-				.setTimestamp(Instant.now())
-				.build();
+				.setDescription(availableHelpChannels + " are __**available**__ to claim!")
+				.setFooter("Last refreshed: ")
+				.setTimestamp(Instant.now());
+		if (!reservedHelpChannels.isEmpty()) {
+			builder.addField("Reserved Help Channels", reservedHelpChannels.toString(), false);
+		}
+		if (!config.getDormantChannelCategory().getTextChannels().isEmpty()) {
+			builder.addField("Dormant Help Channels", String.format("%s dormant channels", config.getDormantChannelCategory().getTextChannels().size()), false);
+		}
+		return builder.build();
 	}
 }

src/main/java/net/javadiscord/javabot/util/StringUtils.java

@@ -1,6 +1,7 @@
 package net.javadiscord.javabot.util;
 
 import lombok.extern.slf4j.Slf4j;
+import net.dv8tion.jda.api.entities.GuildMessageChannel;
 import net.dv8tion.jda.api.entities.Message;
 import net.dv8tion.jda.api.entities.MessageReaction;
 import net.dv8tion.jda.api.entities.emoji.Emoji;
@@ -180,4 +181,8 @@ public static int countReactions(@NotNull Message msg, Emoji emoji) {
 				.filter(user -> !user.isBot() && !user.isSystem())
 				.count();
 	}
+
+	public static String buildChannelJumpUrl(@NotNull GuildMessageChannel channel) {
+		return String.format("https://discord.com/channels/%s/%s", channel.getGuild().getId(), channel.getIdLong());
+	}
 }

src/main/resources/help_guidelines/guidelines_text.txt

@@ -2,7 +2,7 @@
 
 **2.** Only ask questions in open help channels. Asking a question in someone else's reserved help channel is not polite, and your messages may be removed without notice. Doing this often will result in a ban.
 
-**3.** You may use the` /help-ping` command if your question is urgent.
+**3.** You may use the `/help ping` command if your question is urgent.
 *__Abusing this will result in warnings and/or a ban.__*
 
 **4.** Do not ask for help with exams or homework. You may ask for help with understanding individual concepts and parts of a question, but homework and exam questions that show little effort on your part will most likely go unanswered and may be removed.

src/main/resources/help_overview/overview_image_url.txt

@@ -0,0 +1 @@
+https://cdn.discordapp.com/attachments/674585018697515048/1004325439210266624/HelpNew.png