Merge pull request #421 from danthe1st/close-dm-fix-prefs

add DM when post is closed by other user, fix preferences

Author: MoonTM-GIT

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

@@ -16,6 +16,7 @@
 import net.javadiscord.javabot.systems.help.HelpManager;
 import net.javadiscord.javabot.systems.help.dao.HelpAccountRepository;
 import net.javadiscord.javabot.systems.help.dao.HelpTransactionRepository;
+import net.javadiscord.javabot.systems.user_preferences.UserPreferenceService;
 
 import java.util.function.Consumer;
 
@@ -31,6 +32,7 @@ public class UserLeaveListener extends ListenerAdapter {
 	private final BotConfig botConfig;
 	private final HelpAccountRepository helpAccountRepository;
 	private final HelpTransactionRepository helpTransactionRepository;
+	private final UserPreferenceService userPreferenceService;
 
 	@Override
 	public void onGuildMemberRemove(@NotNull GuildMemberRemoveEvent event) {
@@ -84,7 +86,7 @@ private void executeForAllOpenPostsOfUser(Guild guild, User user, ForumChannel f
 	}
 
 	private void unreserveHelpChannel(ThreadChannel post) {
-		HelpManager manager = new HelpManager(post, dbActions, botConfig, helpAccountRepository, helpTransactionRepository);
+		HelpManager manager = new HelpManager(post, dbActions, botConfig, helpAccountRepository, helpTransactionRepository, userPreferenceService);
 		manager.close(UserSnowflake.fromId(post.getGuild().getSelfMember().getIdLong()), "User left the server");
 	}
 }

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

@@ -22,6 +22,7 @@
 import net.javadiscord.javabot.data.h2db.DbActions;
 import net.javadiscord.javabot.systems.help.dao.HelpAccountRepository;
 import net.javadiscord.javabot.systems.help.dao.HelpTransactionRepository;
+import net.javadiscord.javabot.systems.user_preferences.UserPreferenceService;
 import net.javadiscord.javabot.util.InteractionUtils;
 import net.javadiscord.javabot.util.Responses;
 import org.jetbrains.annotations.NotNull;
@@ -73,6 +74,7 @@ protected boolean removeEldestEntry(Map.Entry<Long, Long> eldest) {
 			return System.currentTimeMillis() > eldest.getValue() || size() >= 32;
 		}
 	};
+	private final UserPreferenceService preferenceService;
 
 	@Override
 	public void onMessageReceived(@NotNull MessageReceivedEvent event) {
@@ -176,7 +178,7 @@ public void handleButton(@NotNull ButtonInteractionEvent event, @NotNull Button
 			return;
 		}
 		ThreadChannel post = event.getChannel().asThreadChannel();
-		HelpManager manager = new HelpManager(post, dbActions, botConfig, helpAccountRepository, helpTransactionRepository);
+		HelpManager manager = new HelpManager(post, dbActions, botConfig, helpAccountRepository, helpTransactionRepository, preferenceService);
 		switch (id[0]) {
 			case HelpManager.HELP_THANKS_IDENTIFIER -> handleHelpThanksInteraction(event, manager, id);
 			case HelpManager.HELP_GUIDELINES_IDENTIFIER ->

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

@@ -9,19 +9,23 @@
 import net.dv8tion.jda.api.entities.MessageEmbed;
 import net.dv8tion.jda.api.entities.User;
 import net.dv8tion.jda.api.entities.UserSnowflake;
+import net.dv8tion.jda.api.entities.channel.concrete.PrivateChannel;
 import net.dv8tion.jda.api.entities.channel.concrete.ThreadChannel;
 import net.dv8tion.jda.api.entities.emoji.Emoji;
 import net.dv8tion.jda.api.interactions.Interaction;
 import net.dv8tion.jda.api.interactions.callbacks.IReplyCallback;
 import net.dv8tion.jda.api.interactions.components.ActionRow;
 import net.dv8tion.jda.api.interactions.components.ItemComponent;
 import net.dv8tion.jda.api.interactions.components.buttons.Button;
+import net.dv8tion.jda.api.requests.RestAction;
 import net.dv8tion.jda.api.requests.restaction.interactions.ReplyCallbackAction;
 import net.javadiscord.javabot.data.config.BotConfig;
 import net.javadiscord.javabot.data.config.guild.HelpConfig;
 import net.javadiscord.javabot.data.h2db.DbActions;
 import net.javadiscord.javabot.systems.help.dao.HelpAccountRepository;
 import net.javadiscord.javabot.systems.help.dao.HelpTransactionRepository;
+import net.javadiscord.javabot.systems.user_preferences.UserPreferenceService;
+import net.javadiscord.javabot.systems.user_preferences.model.Preference;
 import net.javadiscord.javabot.util.ExceptionLogger;
 import net.javadiscord.javabot.util.MessageActionUtils;
 import net.javadiscord.javabot.util.Responses;
@@ -64,6 +68,7 @@ public class HelpManager {
 	private final HelpAccountRepository helpAccountRepository;
 
 	private final HelpTransactionRepository helpTransactionRepository;
+	private final UserPreferenceService preferenceService;
 
 	/**
 	 * Builds and replies {@link ActionRow}s with all members which helped the
@@ -108,6 +113,31 @@ public void close(IReplyCallback callback, boolean withHelpers, @Nullable String
 		Responses.info(callback, "Post Closed", "This post has been closed by %s%s", callback.getUser().getAsMention(), reason != null ? " for the following reason:\n> " + reason : ".")
 				.setEphemeral(false)
 				.queue(s -> postThread.getManager().setLocked(true).setArchived(true).queue());
+		if (callback.getMember().getIdLong() != postThread.getOwnerIdLong() &&
+				Boolean.parseBoolean(preferenceService.getOrCreate(postThread.getOwnerIdLong(), Preference.PRIVATE_CLOSE_NOTIFICATIONS).getState())) {
+			postThread.getOwner().getUser().openPrivateChannel()
+					.flatMap(c -> createDMCloseInfoEmbed(callback.getMember(), postThread, reason, c))
+					.queue(success -> {}, failure -> {});
+		}
+	}
+	
+	private RestAction<Message> createDMCloseInfoEmbed(Member closingMember, ThreadChannel postThread, String reason, PrivateChannel c) {
+		EmbedBuilder eb = new EmbedBuilder()
+			.setTitle("Post closed")
+			.setDescription(
+				"""
+				Your post %s has been closed by %s
+				
+				[Post link](%s)
+				"""
+				.formatted(postThread.getAsMention(), closingMember.getAsMention(), postThread.getJumpUrl()))
+			.addField("Deactivate", "You can deactivate notifications like this using the `/preferences` command.", false)
+			.setAuthor(closingMember.getEffectiveName(), null, closingMember.getEffectiveAvatarUrl());
+		if (reason != null) {
+			eb
+				.addField("Reason", reason, false);
+		}
+		return c.sendMessageEmbeds(eb.build());
 	}
 
 	/**

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

@@ -6,6 +6,7 @@
 import net.javadiscord.javabot.data.h2db.DbActions;
 import net.javadiscord.javabot.systems.help.dao.HelpAccountRepository;
 import net.javadiscord.javabot.systems.help.dao.HelpTransactionRepository;
+import net.javadiscord.javabot.systems.user_preferences.UserPreferenceService;
 
 /**
  * A simple command that can be used inside reserved help channels to immediately unreserve them,
@@ -21,9 +22,10 @@ public class CloseCommand extends UnreserveCommand {
 	 * @param dbActions A utility object providing various operations on the main database
 	 * @param helpTransactionRepository Dao object that represents the HELP_TRANSACTION SQL Table.
 	 * @param helpAccountRepository Dao object that represents the HELP_ACCOUNT SQL Table.
+	 * @param preferenceService Service for user preferences
 	 */
-	public CloseCommand(BotConfig botConfig, DbActions dbActions, HelpTransactionRepository helpTransactionRepository, HelpAccountRepository helpAccountRepository) {
-		super(botConfig, dbActions, helpTransactionRepository, helpAccountRepository);
+	public CloseCommand(BotConfig botConfig, DbActions dbActions, HelpTransactionRepository helpTransactionRepository, HelpAccountRepository helpAccountRepository, UserPreferenceService preferenceService) {
+		super(botConfig, dbActions, helpTransactionRepository, helpAccountRepository, preferenceService);
 		setCommandData(
 				Commands.slash("close", "Unreserves this post marking your question/issue as resolved.")
 						.setGuildOnly(true).addOption(OptionType.STRING, "reason",

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

@@ -11,6 +11,7 @@
 import net.javadiscord.javabot.data.h2db.DbActions;
 import net.javadiscord.javabot.systems.help.dao.HelpAccountRepository;
 import net.javadiscord.javabot.systems.help.dao.HelpTransactionRepository;
+import net.javadiscord.javabot.systems.user_preferences.UserPreferenceService;
 import net.javadiscord.javabot.systems.help.HelpManager;
 import net.javadiscord.javabot.util.Responses;
 import org.jetbrains.annotations.NotNull;
@@ -25,19 +26,22 @@ public class UnreserveCommand extends SlashCommand {
 	private final DbActions dbActions;
 	private final HelpAccountRepository helpAccountRepository;
 	private final HelpTransactionRepository helpTransactionRepository;
+	private final UserPreferenceService preferenceService;
 
 	/**
 	 * The constructor of this class, which sets the corresponding {@link net.dv8tion.jda.api.interactions.commands.build.SlashCommandData}.
 	 * @param botConfig The main configuration of the bot
 	 * @param dbActions A utility object providing various operations on the main database
-	 * @param helpTransactionRepository Dao object that represents the HELP_TRANSACTION SQL Table.
-	 * @param helpAccountRepository Dao object that represents the HELP_ACCOUNT SQL Table.
+	 * @param helpTransactionRepository Dao object that represents the HELP_TRANSACTION SQL Table
+	 * @param helpAccountRepository Dao object that represents the HELP_ACCOUNT SQL Table
+	 * @param preferenceService Service for user preferences
 	 */
-	public UnreserveCommand(BotConfig botConfig, DbActions dbActions, HelpTransactionRepository helpTransactionRepository, HelpAccountRepository helpAccountRepository) {
+	public UnreserveCommand(BotConfig botConfig, DbActions dbActions, HelpTransactionRepository helpTransactionRepository, HelpAccountRepository helpAccountRepository, UserPreferenceService preferenceService) {
 		this.botConfig = botConfig;
 		this.dbActions = dbActions;
 		this.helpAccountRepository = helpAccountRepository;
 		this.helpTransactionRepository = helpTransactionRepository;
+		this.preferenceService = preferenceService;
 		setCommandData(Commands.slash("unreserve", "Unreserves this post marking your question/issue as resolved.")
 				.setGuildOnly(true)
 				.addOption(OptionType.STRING, "reason", "The reason why you're unreserving this channel", false)
@@ -55,11 +59,11 @@ public void execute(@NotNull SlashCommandInteractionEvent event) {
 		if (postThread.getParentChannel().getType() != ChannelType.FORUM) {
 			replyInvalidChannel(event);
 		}
-		HelpManager manager = new HelpManager(postThread, dbActions, botConfig, helpAccountRepository, helpTransactionRepository);
+		HelpManager manager = new HelpManager(postThread, dbActions, botConfig, helpAccountRepository, helpTransactionRepository, preferenceService);
 		if (manager.isForumEligibleToBeUnreserved(event.getInteraction())) {
-			manager.close(event, event.getUser().getIdLong() == postThread.getOwnerIdLong(),
-					event.getOption("reason", null, OptionMapping::getAsString)
-			);
+			manager.close(event,
+					event.getUser().getIdLong() == manager.getPostThread().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();
 		}

src/main/java/net/javadiscord/javabot/systems/user_preferences/commands/PreferencesSetSubcommand.java

@@ -17,6 +17,7 @@
 import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 
@@ -58,24 +59,24 @@ public void execute(@NotNull SlashCommandInteractionEvent event) {
 			return;
 		}
 		if (service.setOrCreate(event.getUser().getIdLong(), preference, state)) {
-			Responses.info(event, "Preference Updated", "Successfully set %s to `%s`!", preference, state).queue();
+			Responses.info(event, "Preference Updated", "Successfully set `%s` to `%s`!", preference, state).queue();
 		} else {
 			Responses.error(event, "Could not set %s to `%s`.", preference, state).queue();
 		}
 	}
 
 	@Contract("_ -> new")
 	private Command.@NotNull Choice toChoice(@NotNull Preference preference) {
-		return new Command.Choice(preference.toString(), String.valueOf(preference.ordinal()));
+		return new Command.Choice(preference.toString(), preference.ordinal());
 	}
 
 	@Override
 	public void handleAutoComplete(@NotNull CommandAutoCompleteInteractionEvent event, @NotNull AutoCompleteQuery target) {
-		String preferenceString = event.getOption("preference", OptionMapping::getAsString);
-		if (preferenceString != null && Arrays.stream(Preference.values()).map(Preference::name).anyMatch(c -> c.equals(preferenceString))) {
-			Preference preference = Preference.valueOf(preferenceString);
+		int preferenceInt = event.getOption("preference",-1, OptionMapping::getAsInt);
+		if (preferenceInt > 0 && preferenceInt<Preference.values().length) {
+			Preference preference = Preference.values()[preferenceInt];
 			if (preference.getType().getDefaultChoices() != null && preference.getType().getDefaultChoices().length > 0) {
-				event.replyChoices(AutoCompleteUtils.filterChoices(event, List.of(preference.getType().getDefaultChoices()))).queue();
+				event.replyChoices(AutoCompleteUtils.filterChoices(event, new ArrayList<>(List.of(preference.getType().getDefaultChoices())))).queue();
 			}
 		}
 	}

src/main/java/net/javadiscord/javabot/systems/user_preferences/model/Preference.java

@@ -9,9 +9,14 @@ public enum Preference {
 	 */
 	QOTW_REMINDER("Question of the Week Reminder", "false", new BooleanPreference()),
 	/**
-	 * Enables/Disables DM notifications for dormant help post.
+	 * Enables/Disables DM notifications for dormant help posts.
 	 */
-	PRIVATE_DORMANT_NOTIFICATIONS("Send notifications about dormant help post via DM", "true", new BooleanPreference());
+	PRIVATE_DORMANT_NOTIFICATIONS("Send notifications about dormant help post via DM", "true", new BooleanPreference()),
+	
+	/**
+	 * Enables/Disables DM notifications for closed help posts.
+	 */
+	PRIVATE_CLOSE_NOTIFICATIONS("Send notifications about help posts closed by other users via DM", "true", new BooleanPreference());
 
 	private final String name;
 	private final String defaultState;