Implement automatic inactivity post closing

Author: jasonlessenich

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

@@ -21,11 +21,6 @@ public class HelpConfig extends GuildConfigItem {
 
 	private long helpForumChannelId = 0;
 
-	/**
-	 * The id of the channel category that contains all open channels.
-	 */
-	private long openCategoryId;
-
 	/**
 	 * The id of the helper role.
 	 */
@@ -40,13 +35,13 @@ public class HelpConfig extends GuildConfigItem {
 	 * The message that's sent as soon as a user asks a question in an open help
 	 * channel. This is only sent if it's not null.
 	 */
-	private String reservedChannelMessageTemplate = "`⌛` **This channel has been reserved for your question.**\n> Please use `/close` when you're finished.";
+	private String reservedChannelMessageTemplate = "`⌛` **This post has been reserved for your question.**\n> Hey %s! Please use `/close` or the 'Close Post' button above when you're finished. Please remember to follow the help guidelines. This post will be automatically closed after %s minutes of inactivity.\n\n**TIP:** Narrow down your issue to __simple__ and __precise__ questions to maximize the chance that others will reply in here.";
 
 	/**
 	 * 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 dormantChannelMessageTemplate = "`\uD83D\uDCA4` **Channel marked as dormant**\n> This post has been inactive for over %s minutes. It is no longer possible to send messages in this channel.\n> If your question was not answered yet, feel free to create a new post.";
+	private String dormantChannelMessageTemplate = "`\uD83D\uDCA4` **Post marked as dormant**\n> This post has been inactive for over %s minutes. It is no longer possible to send messages in this channel.\n> If your question was not answered yet, feel free to create a new post.";
 
 	/**
 	 * The message that's sent when a user unreserved a channel where other users

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

@@ -4,6 +4,7 @@
 import lombok.extern.slf4j.Slf4j;
 import net.dv8tion.jda.api.JDA;
 import net.dv8tion.jda.api.entities.Guild;
+import net.dv8tion.jda.api.entities.UserSnowflake;
 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;
@@ -12,7 +13,7 @@
 import org.springframework.scheduling.annotation.Scheduled;
 import org.springframework.stereotype.Service;
 
-import java.time.OffsetDateTime;
+import java.time.Instant;
 
 /**
  * Loops through all guilds and updates the corresponding help forum channel, closing inactive ones.
@@ -27,27 +28,33 @@ public class HelpForumUpdater {
 	/**
 	 * Updates all help channels.
 	 */
-	@Scheduled(cron = "*/10 * * * *") // Run every 10 minutes
+	@Scheduled(cron = "0 */10 * * * *") // Run every 10 minutes
 	public void execute() {
 		for (Guild guild : jda.getGuilds()) {
-			log.info("Updating help channels in {}", guild.getName());
+			log.info("Checking for inactive forum posts in {}", guild.getName());
 			HelpConfig config = botConfig.get(guild).getHelpConfig();
 			ForumChannel forum = config.getHelpForumChannel();
 			if (forum != null) {
 				for (ThreadChannel post : forum.getThreadChannels()) {
 					if (post.isArchived() || post.isLocked()) continue;
 					checkForumPost(post, config);
 				}
+			} else {
+				log.warn("Could not find forum channel for guild {}", guild.getName());
 			}
 		}
 	}
 
 	private void checkForumPost(@NotNull ThreadChannel post, HelpConfig config) {
 		post.retrieveMessageById(post.getLatestMessageId()).queue(latest -> {
-			if (latest.getTimeCreated().plusMinutes(config.getInactivityTimeoutMinutes()).isBefore(OffsetDateTime.now())) {
-				post.sendMessage(config.getDormantChannelMessageTemplate().formatted(config.getInactivityTimeoutMinutes())).queue(s ->
-						post.getManager().setLocked(true).setArchived(true).queue());
+			long minutesAgo = (Instant.now().getEpochSecond() - latest.getTimeCreated().toEpochSecond()) / 60;
+			if (minutesAgo > config.getInactivityTimeoutMinutes()) {
+				post.sendMessage(config.getDormantChannelMessageTemplate().formatted(config.getInactivityTimeoutMinutes())).queue(s -> {
+					post.getManager().setLocked(true).setArchived(true).queue();
+					log.info("Archived & locked forum thread '{}' (by {}) for inactivity (last message sent {} minutes ago)",
+							post.getName(), post.getOwnerId(), minutesAgo);
+				});
 			}
-		});
+		}, e -> log.error("Could not find message with id {}", post.getLatestMessageId()));
 	}
 }

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

@@ -79,7 +79,7 @@ public void onMessageReceived(@NotNull MessageReceivedEvent event) {
 
 	@Override
 	public void onChannelCreate(@NotNull ChannelCreateEvent event) {
-		if (event.getGuild() == null || isInvalidForumPost(event.getChannel())) {
+		if (isInvalidForumPost(event.getChannel())) {
 			return;
 		}
 		HelpConfig config = botConfig.get(event.getGuild()).getHelpConfig();
@@ -91,13 +91,7 @@ public void onChannelCreate(@NotNull ChannelCreateEvent event) {
 		post.sendMessageComponents(ActionRow.of(
 				Button.primary(ComponentIdBuilder.build(HelpManager.HELP_CLOSE_IDENTIFIER, post.getIdLong()), "Close Post"),
 				Button.secondary(ComponentIdBuilder.build(HelpManager.HELP_GUIDELINES_IDENTIFIER), "View Help Guidelines")
-		)).queue(success -> {
-			// send /close reminder (if enabled)
-			UserPreference preference = userPreferenceService.getOrCreate(post.getOwnerIdLong(), Preference.FORUM_CLOSE_REMINDER);
-			if (Boolean.parseBoolean(preference.getState())) {
-				post.sendMessageFormat(config.getDormantChannelMessageTemplate(), UserSnowflake.fromId(post.getOwnerIdLong()).getAsMention()).queue();
-			}
-		});
+		)).queue(success -> post.sendMessageFormat(config.getReservedChannelMessageTemplate(), UserSnowflake.fromId(post.getOwnerId()).getAsMention(), config.getInactivityTimeoutMinutes()).queue());
 	}
 
 	@Override

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

@@ -7,11 +7,7 @@ public enum Preference {
 	/**
 	 * Enables/Disables QOTW reminders.
 	 */
-	QOTW_REMINDER("Question of the Week Reminder", "false", new BooleanPreference()),
-	/**
-	 * A boolean preference which enables/disables the close reminder in forum help posts.
-	 */
-	FORUM_CLOSE_REMINDER("Help Forum Close Reminder", "true", new BooleanPreference());
+	QOTW_REMINDER("Question of the Week Reminder", "false", new BooleanPreference());
 
 	private final String name;
 	private final String defaultState;