XP and DM notification for dormant channels

Author: danthe1st

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

@@ -38,6 +38,18 @@ public class HelpConfig extends GuildConfigItem {
 	 */
 	private String dormantChannelMessageTemplate = "`\uD83D\uDCA4` **Post marked as dormant**\n> This post has been inactive for over %s minutes, thus, it has been **archived**.\n> If your question was not answered yet, feel free to re-open this post or create a new one.";
 
+	/**
+	 * The message that's sent in a post to tell users that it
+	 * is now marked as dormant and no more messages can be sent.
+	 */
+	private String dormantChannelPrivateMessageTemplate = """ 
+			Your post %s in %s has been inactive for over %s minutes, thus, it has been **archived**.
+			If your question was not answered yet, feel free to re-open this post by sending another message in that channel.
+			You can disable notifications like this using the `/preferences` command.
+			[Post link](%s)
+			""";
+	
+	
 	/**
 	 * The message that's sent when a user unreserved a channel where other users
 	 * participated in.

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

@@ -4,7 +4,9 @@
 import lombok.extern.slf4j.Slf4j;
 import net.dv8tion.jda.api.entities.Guild;
 import net.dv8tion.jda.api.entities.Role;
+import net.dv8tion.jda.api.entities.channel.concrete.ThreadChannel;
 import net.javadiscord.javabot.data.config.BotConfig;
+import net.javadiscord.javabot.data.config.guild.HelpConfig;
 import net.javadiscord.javabot.systems.help.dao.HelpAccountRepository;
 import net.javadiscord.javabot.systems.help.dao.HelpTransactionRepository;
 import net.javadiscord.javabot.systems.help.model.HelpAccount;
@@ -18,6 +20,7 @@
 
 import java.util.Collections;
 import java.util.List;
+import java.util.Map;
 import java.util.Optional;
 
 /**
@@ -75,17 +78,19 @@ public List<HelpAccount> getTopAccounts(int amount, int page) {
 	 * @param recipient The recipient's user id.
 	 * @param value     The transaction's value.
 	 * @param guild     The current guild.
+	 * @param channelId The ID of the channel the transaction should be performed in
 	 * @throws DataAccessException If an error occurs.
 	 */
 	@Transactional
-	public void performTransaction(long recipient, double value, Guild guild) throws DataAccessException {
+	public void performTransaction(long recipient, double value, Guild guild, long channelId) throws DataAccessException {
 		if (value == 0) {
 			log.error("Cannot make zero-value transactions");
 			return;
 		}
 		HelpTransaction transaction = new HelpTransaction();
 		transaction.setRecipient(recipient);
 		transaction.setWeight(value);
+		transaction.setChannelId(channelId);
 		HelpAccount account = getOrCreateAccount(recipient);
 		account.updateExperience(value);
 		helpAccountRepository.update(account);
@@ -109,4 +114,24 @@ private void checkExperienceRoles(@NotNull Guild guild, @NotNull HelpAccount acc
 					}
 				}), e -> {});
 	}
+	
+	/**
+	 * add XP to all helpers depending on the messages they sent.
+	 * 
+	 * @param post The {@link ThreadChannel} post
+	 * @param allowIfXPAlreadyGiven {@code true} if XP should be awarded if XP have already been awarded
+	 */
+	public void addMessageBasedHelpXP(ThreadChannel post, boolean allowIfXPAlreadyGiven) {
+		HelpConfig config = botConfig.get(post.getGuild()).getHelpConfig();
+		try {
+			Map<Long, Double> experience = HelpManager.calculateExperience(HelpListener.HELP_POST_MESSAGES.get(post.getIdLong()), post.getOwnerIdLong(), config);
+			for (Map.Entry<Long, Double> entry : experience.entrySet()) {
+				if(entry.getValue()>0 && (allowIfXPAlreadyGiven||!helpTransactionRepository.existsTransactionWithRecipientInChannel(entry.getKey(), post.getIdLong()))) {
+					performTransaction(entry.getKey(), entry.getValue(), config.getGuild(), post.getIdLong());
+				}
+			}
+		} catch (DataAccessException e) {
+			ExceptionLogger.capture(e, getClass().getName());
+		}
+	}
 }

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

@@ -2,13 +2,18 @@
 
 import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
+import net.dv8tion.jda.api.EmbedBuilder;
 import net.dv8tion.jda.api.JDA;
 import net.dv8tion.jda.api.entities.Guild;
 import net.dv8tion.jda.api.entities.Message;
+import net.dv8tion.jda.api.entities.MessageEmbed;
 import net.dv8tion.jda.api.entities.channel.concrete.ForumChannel;
 import net.dv8tion.jda.api.entities.channel.concrete.ThreadChannel;
 import net.javadiscord.javabot.data.config.BotConfig;
 import net.javadiscord.javabot.data.config.guild.HelpConfig;
+import net.javadiscord.javabot.systems.user_preferences.UserPreferenceService;
+import net.javadiscord.javabot.systems.user_preferences.model.Preference;
+
 import org.jetbrains.annotations.NotNull;
 import org.springframework.scheduling.annotation.Scheduled;
 import org.springframework.stereotype.Service;
@@ -24,6 +29,8 @@
 public class HelpForumUpdater {
 	private final JDA jda;
 	private final BotConfig botConfig;
+	private final UserPreferenceService preferenceService;
+	private final HelpExperienceService experienceService;
 
 	/**
 	 * Updates all help channels.
@@ -61,13 +68,42 @@ private void checkForumPost(@NotNull ThreadChannel post, HelpConfig config) {
 				}
 				post.sendMessage(config.getDormantChannelMessageTemplate().formatted(config.getInactivityTimeoutMinutes())).queue(s -> {
 					post.getManager().setArchived(true).queue();
+					sendDMDormantInfoIfEnabled(post, config);
+					experienceService.addMessageBasedHelpXP(post, false);
 					log.info("Archived forum thread '{}' (by {}) for inactivity (last message sent {} minutes ago)",
 							post.getName(), post.getOwnerId(), minutesAgo);
+					
 				});
 			}
 		}, e -> log.error("Could not find latest message in forum thread {}:", post.getId(), e));
 	}
 
+	private void sendDMDormantInfoIfEnabled(ThreadChannel post, HelpConfig config) {
+		if(Boolean.parseBoolean(preferenceService.getOrCreate(post.getOwnerIdLong(), Preference.PRIVATE_DORMANT_NOTIFICATIONS).getState())) {
+			post
+				.getOwner()
+				.getUser()
+				.openPrivateChannel()
+				.flatMap(c -> c.sendMessageEmbeds(createDMDormantInfo(post, config)))
+				.queue();
+		}
+	}
+
+	private MessageEmbed createDMDormantInfo(ThreadChannel post, HelpConfig config) {
+		return new EmbedBuilder()
+				.setTitle("Post marked as dormant")
+				.setDescription(
+						config
+						.getDormantChannelPrivateMessageTemplate()
+						.formatted(
+								post.getAsMention(),
+								post.getParentChannel().getAsMention(),
+								config.getInactivityTimeoutMinutes(),
+								"https://discord.com/channels/" + post.getGuild().getId() + "/" + post.getId()))
+				.build()
+				;
+	}
+
 	private boolean isThanksMessage(@NotNull Message m) {
 		return m.getAuthor().isBot() && !m.getButtons().isEmpty() &&
 				m.getButtons().stream().allMatch(b -> b.getId() != null && b.getId().contains(HelpManager.HELP_THANKS_IDENTIFIER));

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

@@ -22,11 +22,9 @@
 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.util.ExceptionLogger;
 import net.javadiscord.javabot.util.InteractionUtils;
 import net.javadiscord.javabot.util.Responses;
 import org.jetbrains.annotations.NotNull;
-import org.springframework.dao.DataAccessException;
 import xyz.dynxsty.dih4jda.interactions.components.ButtonHandler;
 import xyz.dynxsty.dih4jda.util.ComponentIdBuilder;
 
@@ -48,7 +46,7 @@ public class HelpListener extends ListenerAdapter implements ButtonHandler {
 	/**
 	 * A static Map that holds all messages that was sent in a specific reserved forum channel.
 	 */
-	protected static final Map<Long, List<Message>> HELP_POST_MESSAGES = new HashMap<>();
+	static final Map<Long, List<Message>> HELP_POST_MESSAGES = new HashMap<>();
 	private static final Set<Long> newThreadChannels;
 
 	static {
@@ -58,6 +56,7 @@ public class HelpListener extends ListenerAdapter implements ButtonHandler {
 	private final BotConfig botConfig;
 	private final HelpAccountRepository helpAccountRepository;
 	private final HelpTransactionRepository helpTransactionRepository;
+	private final HelpExperienceService experienceService;
 	private final DbActions dbActions;
 	private final String[][] closeSuggestionDetectors = {
 			{"close", "post"},
@@ -158,7 +157,6 @@ public void onChannelCreate(@NotNull ChannelCreateEvent event) {
 		if (isInvalidForumPost(event.getChannel())) {
 			return;
 		}
-		HelpConfig config = botConfig.get(event.getGuild()).getHelpConfig();
 		ThreadChannel post = event.getChannel().asThreadChannel();
 		if (isInvalidHelpForumChannel(post.getParentChannel().asForumChannel())) {
 			return;
@@ -229,20 +227,11 @@ private void handleThanksCloseButton(@NotNull ButtonInteractionEvent event, Help
 		event.getMessage().delete().queue(s -> {
 			// close post
 			manager.close(event, false, null);
-			// add experience
-			try {
-				HelpExperienceService service = new HelpExperienceService(botConfig, helpAccountRepository, helpTransactionRepository);
-				Map<Long, Double> experience = HelpManager.calculateExperience(HELP_POST_MESSAGES.get(post.getIdLong()), post.getOwnerIdLong(), config);
-				for (Map.Entry<Long, Double> entry : experience.entrySet()) {
-					service.performTransaction(entry.getKey(), entry.getValue(), config.getGuild());
-				}
-			} catch (DataAccessException e) {
-				ExceptionLogger.capture(e, getClass().getName());
-			}
+			experienceService.addMessageBasedHelpXP(post, true);
 			// 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])));
+					.forEach(b -> manager.thankHelper(event.getGuild(), post, Long.parseLong(ComponentIdBuilder.split(b.getId())[2])));
 		});
 	}
 

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

@@ -11,7 +11,6 @@
 import net.dv8tion.jda.api.entities.UserSnowflake;
 import net.dv8tion.jda.api.entities.channel.concrete.ThreadChannel;
 import net.dv8tion.jda.api.entities.emoji.Emoji;
-import net.dv8tion.jda.api.events.interaction.component.ButtonInteractionEvent;
 import net.dv8tion.jda.api.interactions.Interaction;
 import net.dv8tion.jda.api.interactions.callbacks.IReplyCallback;
 import net.dv8tion.jda.api.interactions.components.ActionRow;
@@ -28,6 +27,7 @@
 import net.javadiscord.javabot.util.Responses;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
+
 import xyz.dynxsty.dih4jda.util.ComponentIdBuilder;
 
 import java.sql.SQLException;
@@ -120,16 +120,16 @@ public void close(UserSnowflake closedBy, @Nullable String reason) {
 		postThread.sendMessageEmbeds(buildPostClosedEmbed(closedBy, reason))
 				.queue(s -> postThread.getManager().setArchived(true).queue());
 	}
-
+	
 	/**
 	 * Thanks a single user.
 	 *
-	 * @param event      The {@link ButtonInteractionEvent} that was fired.
+	 * @param guild The {@link Guild} the helper is thanked in
 	 * @param postThread The {@link ThreadChannel} post.
 	 * @param helperId   The helpers' discord id.
 	 */
-	public void thankHelper(@NotNull ButtonInteractionEvent event, ThreadChannel postThread, long helperId) {
-		event.getJDA().retrieveUserById(helperId).queue(helper -> {
+	public void thankHelper(@NotNull Guild guild, ThreadChannel postThread, long helperId) {
+		guild.getJDA().retrieveUserById(helperId).queue(helper -> {
 			// First insert the new thanks data.
 			try {
 				dbActions.update(
@@ -139,13 +139,13 @@ public void thankHelper(@NotNull ButtonInteractionEvent event, ThreadChannel pos
 						postThread.getIdLong(),
 						helper.getIdLong()
 				);
-				HelpConfig config = botConfig.get(event.getGuild()).getHelpConfig();
+				HelpConfig config = botConfig.get(guild).getHelpConfig();
 				HelpExperienceService service = new HelpExperienceService(botConfig, helpAccountRepository, helpTransactionRepository);
 				// Perform experience transactions
-				service.performTransaction(helper.getIdLong(), config.getThankedExperience(), event.getGuild());
+				service.performTransaction(helper.getIdLong(), config.getThankedExperience(), guild, postThread.getIdLong());
 			} catch (SQLException e) {
 				ExceptionLogger.capture(e, getClass().getSimpleName());
-				botConfig.get(event.getGuild()).getModerationConfig().getLogChannel().sendMessageFormat(
+				botConfig.get(guild).getModerationConfig().getLogChannel().sendMessageFormat(
 						"Could not record user %s thanking %s for help in post %s: %s",
 						postThread.getOwner().getUser().getAsTag(),
 						helper.getAsTag(),

src/main/java/net/javadiscord/javabot/systems/help/dao/HelpTransactionRepository.java

@@ -34,12 +34,13 @@ public class HelpTransactionRepository {
 	public HelpTransaction save(HelpTransaction transaction) throws DataAccessException {
 		SimpleJdbcInsert simpleJdbcInsert = new SimpleJdbcInsert(jdbcTemplate)
 		.withTableName("help_transaction")
-		.usingColumns("recipient","weight","messageType")
+		.usingColumns("recipient","weight","messageType", "channel")
 		.usingGeneratedKeyColumns("id");
 		Number key = simpleJdbcInsert.executeAndReturnKey(Map.of(
 					"recipient",transaction.getRecipient(),
 					"weight",transaction.getWeight(),
-					"messageType",transaction.getMessageType())
+					"messageType",transaction.getMessageType(),
+					"channel",transaction.getChannelId())
 				);
 		transaction.setId(key.longValue());
 		log.info("Inserted new Help Transaction: {}", transaction);
@@ -80,6 +81,20 @@ private HelpTransaction read(ResultSet rs) throws SQLException {
 		transaction.setCreatedAt(rs.getTimestamp("created_at").toLocalDateTime());
 		transaction.setWeight(rs.getDouble("weight"));
 		transaction.setMessageType(rs.getInt("messageType"));
+		transaction.setChannelId(rs.getLong("channel"));
 		return transaction;
 	}
+
+	/**
+	 * Checks whether a transaction with a specific recipient exists in a specific channel.
+	 * @param recipient The ID of the recipient
+	 * @param channelId The ID of the channel
+	 * @return {@code true} if it exists, else {@code false}
+	 */
+	public boolean existsTransactionWithRecipientInChannel(long recipient, long channelId) {
+		return jdbcTemplate.queryForObject(
+				"SELECT count(*) FROM help_transaction WHERE recipient=? AND channel = ?",
+				Integer.class,
+				recipient, channelId) > 0;
+	}
 }

src/main/java/net/javadiscord/javabot/systems/help/model/HelpTransaction.java

@@ -14,4 +14,5 @@ public class HelpTransaction {
 	private LocalDateTime createdAt;
 	private double weight;
 	private int messageType;
+	private long channelId = -1;
 }

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

@@ -7,7 +7,11 @@ public enum Preference {
 	/**
 	 * Enables/Disables QOTW reminders.
 	 */
-	QOTW_REMINDER("Question of the Week Reminder", "false", new BooleanPreference());
+	QOTW_REMINDER("Question of the Week Reminder", "false", new BooleanPreference()),
+	/**
+	 * Enables/Disables DM notifications for dormant help post.
+	 */
+	PRIVATE_DORMANT_NOTIFICATIONS("Send notifications about dormant help post via DM", "true", new BooleanPreference());
 
 	private final String name;
 	private final String defaultState;

src/main/resources/database/migrations/07-08-2023_channel_transactions.sql

@@ -0,0 +1 @@
+ALTER TABLE help_transaction ADD COLUMN channel BIGINT DEFAULT -1;