Merge pull request #405 from danthe1st/fix-help-ping

change /help-ping to post message requesting help in dedicated channel

Author: MoonTM-GIT

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

@@ -4,6 +4,7 @@
 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.TextChannel;
 import net.javadiscord.javabot.data.config.GuildConfigItem;
 
 import java.util.Map;
@@ -24,7 +25,7 @@ public class HelpConfig extends GuildConfigItem {
 	/**
 	 * The id of the help-ping role.
 	 */
-	private long helpPingRoleId;
+	private long helpNotificationChannelId;
 
 	/**
 	 * The message that's sent as soon as a user asks a question in an open help
@@ -120,7 +121,7 @@ public Role getHelperRole() {
 		return getGuild().getRoleById(helperRoleId);
 	}
 
-	public Role getHelpPingRole() {
-		return getGuild().getRoleById(helpPingRoleId);
+	public TextChannel getHelpNotificationChannel() {
+		return getGuild().getTextChannelById(helpNotificationChannelId);
 	}
 }

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

@@ -3,35 +3,44 @@
 import net.dv8tion.jda.api.EmbedBuilder;
 import net.dv8tion.jda.api.entities.Guild;
 import net.dv8tion.jda.api.entities.Member;
-import net.dv8tion.jda.api.entities.Message;
-import net.dv8tion.jda.api.entities.MessageEmbed;
 import net.dv8tion.jda.api.entities.Role;
-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.entities.channel.forums.ForumTag;
+import net.dv8tion.jda.api.entities.emoji.EmojiUnion;
 import net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent;
+import net.dv8tion.jda.api.events.interaction.component.ButtonInteractionEvent;
 import net.dv8tion.jda.api.interactions.commands.build.SubcommandData;
+import net.dv8tion.jda.api.interactions.components.buttons.Button;
+import net.dv8tion.jda.api.interactions.components.buttons.ButtonStyle;
+import net.javadiscord.javabot.annotations.AutoDetectableComponentHandler;
 import net.javadiscord.javabot.data.config.BotConfig;
 import net.javadiscord.javabot.data.config.GuildConfig;
 import net.javadiscord.javabot.data.config.guild.HelpConfig;
 import net.javadiscord.javabot.util.Pair;
 import net.javadiscord.javabot.util.Responses;
 import org.jetbrains.annotations.NotNull;
 import xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand;
+import xyz.dynxsty.dih4jda.interactions.components.ButtonHandler;
+import xyz.dynxsty.dih4jda.util.ComponentIdBuilder;
 
-import java.util.EnumSet;
+import java.awt.Color;
+import java.time.OffsetDateTime;
 import java.util.List;
 import java.util.Map;
 import java.util.Set;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.ScheduledExecutorService;
 import java.util.concurrent.TimeUnit;
+import java.util.stream.Collectors;
 
 /**
  * Handler for the /help ping sub-command that allows users to occasionally ping
  * helpers.
  */
-public class HelpPingSubcommand extends SlashCommand.Subcommand {
+@AutoDetectableComponentHandler("help-ping")
+public class HelpPingSubcommand extends SlashCommand.Subcommand implements ButtonHandler {
 	private static final String WRONG_CHANNEL_MSG = "This command can only be used in **help forum posts**";
 	private static final long CACHE_CLEANUP_DELAY = 60L;
 
@@ -74,23 +83,65 @@ public void execute(@NotNull SlashCommandInteractionEvent event) {
 			Responses.warning(event, "Sorry, but only the person who reserved this channel, or staff and helpers, may use this command.").queue();
 			return;
 		}
+		if (post.getTimeCreated().isAfter(OffsetDateTime.now().minusSeconds(config.getHelpConfig().getHelpPingTimeoutSeconds()))) {
+			Responses.warning(event, "Sorry, this command cannot be used directly after a post has been created.").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();
+			TextChannel notifChannel = config.getHelpConfig().getHelpNotificationChannel();
+			notifChannel.sendMessageEmbeds(new EmbedBuilder().setDescription("""
+					%s requested help in %s
+					
+					Tags:
+					%s
+					
+					[Click to view](%s)
+					"""
+					.formatted(
+							event.getUser().getAsMention(),
+							post.getAsMention(),
+							getTagString(post),
+							post.getJumpUrl()
+					))
+					.setAuthor(member.getEffectiveName(), null, member.getEffectiveAvatarUrl())
+					.setFooter(event.getUser().getId())
+					.setColor(Color.YELLOW)
+					.build())
+				.addActionRow(createAcknowledgementButton())
+				.queue();
+			event.reply("""
+					Successfully requested help.
+					
+					Note that this does NOT gurantee that anybody here has the time and knowledge to help you.
+					Abusing this command might result in moderative action taken against you.
+					""")
+			.setEphemeral(true)
+			.queue();
 		} else {
 			Responses.warning(event, "Sorry, but you can only use this command occasionally. Please try again later.").queue();
 		}
 	}
 
-	private @NotNull MessageEmbed buildAuthorEmbed(@NotNull User author) {
-		return new EmbedBuilder()
-				.setTitle("Requested by " + author.getAsTag())
-				.build();
+	private String getTagString(ThreadChannel post) {
+		String text = post
+			.getAppliedTags()
+			.stream()
+			.map(this::getForumTagText)
+			.map(tag -> "- " + tag)
+			.collect(Collectors.joining("\n"));
+		if(text.isEmpty()) {
+			text = "- <no tags>";
+		}
+		return text;
+	}
+
+	private Button createAcknowledgementButton() {
+		return Button.of(ButtonStyle.SECONDARY, ComponentIdBuilder.build("help-ping", "acknowledge"), "Mark as acknowledged");
+	}
+	
+	private Button createUndoAcknowledgementButton() {
+		return Button.of(ButtonStyle.SECONDARY, ComponentIdBuilder.build("help-ping", "unacknowledge"), "Mark as unacknowledged");
 	}
 
 	/**
@@ -142,4 +193,53 @@ private void cleanTimeoutCache() {
 			lastPingTimes.remove(memberId);
 		}
 	}
+
+	@Override
+	public void handleButton(ButtonInteractionEvent event, Button button) {
+		String[] id = ComponentIdBuilder.split(event.getComponentId());
+		switch(id[1]) {
+		case "acknowledge" ->
+			acknowledgeChangeAction(event, true);
+		case "unacknowledge" -> 
+			acknowledgeChangeAction(event, false);
+		default -> event.reply("Unknown button").setEphemeral(true).queue();
+		}
+		
+	}
+
+	private void acknowledgeChangeAction(ButtonInteractionEvent event, boolean acknowledged) {
+		event.editMessageEmbeds(
+			event.getMessage()
+			.getEmbeds()
+			.stream()
+			.map(e->new EmbedBuilder(e)
+					.setColor(acknowledged ? Color.GRAY : Color.YELLOW)
+					.addField("marked as " + (acknowledged?"acknowledged":"needs help") + " by",
+							event.getUser().getAsMention(), false))
+			.map(this::removeOldField)
+			.map(EmbedBuilder::build)
+			.toList())
+		.setActionRow(acknowledged?createUndoAcknowledgementButton():createAcknowledgementButton())
+		.queue();
+	}
+
+	private String getForumTagText(ForumTag tag) {
+		EmojiUnion emoji = tag.getEmoji();
+		StringBuilder sb=new StringBuilder();
+		if(emoji!=null) {
+			sb
+				.append(emoji.getFormatted())
+				.append(" ");
+		}
+		sb.append(tag.getName());
+		
+		return sb.toString();
+	}
+
+	private EmbedBuilder removeOldField(EmbedBuilder eb) {
+		if(eb.getFields().size()>5) {
+			eb.getFields().remove(0);
+		}
+		return eb;
+	}
 }