staff activity

Author: danthe1st

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

@@ -34,6 +34,11 @@ public class ModerationConfig extends GuildConfigItem {
 	 * The threshold for deleting a message in #share-knowledge. Note that this should be strictly < 0.
 	 */
 	private int shareKnowledgeMessageDeleteThreshold;
+	
+	/**
+	 * ID of the channel storing staff activity information.
+	 */
+	private long staffActivityChannelId = 0;
 
 	/**
 	 * The threshold for deleting a message in #looking-for-programmer.
@@ -105,6 +110,10 @@ public ForumChannel getProjectChannel() {
 	public ForumChannel getJobChannel() {
 		return this.getGuild().getForumChannelById(this.jobChannelId);
 	}
+	
+	public TextChannel getStaffActivityChannel() {
+		return this.getGuild().getTextChannelById(this.staffActivityChannelId);
+	}
 
 	public ForumChannel getShareKnowledgeChannel() {
 		return this.getGuild().getForumChannelById(this.shareKnowledgeChannelId);

src/main/java/net/javadiscord/javabot/systems/staff_activity/StaffActivityListener.java

@@ -0,0 +1,74 @@
+package net.javadiscord.javabot.systems.staff_activity;
+
+import lombok.RequiredArgsConstructor;
+import net.dv8tion.jda.api.EmbedBuilder;
+import net.dv8tion.jda.api.entities.Member;
+import net.dv8tion.jda.api.entities.MessageEmbed;
+import net.dv8tion.jda.api.entities.channel.concrete.TextChannel;
+import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
+import net.dv8tion.jda.api.hooks.ListenerAdapter;
+import net.dv8tion.jda.api.utils.TimeFormat;
+import net.javadiscord.javabot.data.config.BotConfig;
+import net.javadiscord.javabot.data.config.guild.ModerationConfig;
+import net.javadiscord.javabot.systems.staff_activity.dao.StaffActivityMessageRepository;
+import net.javadiscord.javabot.systems.staff_activity.model.StaffActivityMessage;
+import net.javadiscord.javabot.util.ExceptionLogger;
+
+/**
+ * Listener for tracking staff activity.
+ * This class maintains a message for each staff member in each channel.
+ * Each time the staff member sends a message, the message associated with the staff member is updated.
+ */
+@RequiredArgsConstructor
+public class StaffActivityListener extends ListenerAdapter {
+	
+	private final BotConfig botConfig;
+	private final StaffActivityMessageRepository repository;
+	
+	@Override
+	public void onMessageReceived(MessageReceivedEvent event) {
+		if (!event.isFromGuild()) {
+			return;
+		}
+		if (event.getAuthor().isBot() || event.getAuthor().isSystem()) {
+			return;
+		}
+		ModerationConfig moderationConfig = botConfig.get(event.getGuild()).getModerationConfig();
+		TextChannel staffActivityChannel = moderationConfig.getStaffActivityChannel();
+		if (staffActivityChannel == null) {
+			return;
+		}
+		Member member = event.getMember();
+		if (!member.getRoles().contains(moderationConfig.getStaffRole())) {
+			return;
+		}
+		
+		sendStaffActivityEmbed(event, staffActivityChannel, member);
+	}
+
+	private void sendStaffActivityEmbed(MessageReceivedEvent event, TextChannel staffActivityChannel, Member member) {
+		MessageEmbed embed = new EmbedBuilder()
+			.setAuthor(member.getEffectiveName(), null, member.getEffectiveAvatarUrl())
+			.setDescription("Last sent message: " + TimeFormat.RELATIVE.format(event.getMessage().getTimeCreated()))
+			.setFooter(member.getId())
+			.build();
+		
+		Long msgId = repository.getMessageId(staffActivityChannel.getGuild().getIdLong(), member.getIdLong());
+		if (msgId != null) {
+			staffActivityChannel
+				.retrieveMessageById(msgId)
+				.queue(
+						activityMessage -> activityMessage.editMessageEmbeds(embed).queue(),
+						notFound -> createNewMessage(staffActivityChannel, embed, member));
+		} else {
+			createNewMessage(staffActivityChannel, embed, member);
+		}
+	}
+
+	private void createNewMessage(TextChannel staffActivityChannel, MessageEmbed embed, Member member) {
+		staffActivityChannel.sendMessageEmbeds(embed).queue(success -> 
+			repository.insertOrReplace(new StaffActivityMessage(member.getGuild().getIdLong(), member.getIdLong(), success.getIdLong())),
+			error -> ExceptionLogger.capture(error, "Cannot create new staff activity message")
+		);
+	}
+}

src/main/java/net/javadiscord/javabot/systems/staff_activity/dao/StaffActivityMessageRepository.java

@@ -0,0 +1,40 @@
+package net.javadiscord.javabot.systems.staff_activity.dao;
+
+import org.springframework.jdbc.core.JdbcTemplate;
+import org.springframework.stereotype.Repository;
+
+import lombok.RequiredArgsConstructor;
+import net.javadiscord.javabot.systems.staff_activity.model.StaffActivityMessage;
+
+/**
+ * Repository for storing staff activity message locations.
+ */
+@RequiredArgsConstructor
+@Repository
+public class StaffActivityMessageRepository {
+	private final JdbcTemplate jdbcTemplate;
+	
+	/**
+	 * Inserts a new {@link StaffActivityMessage} or replaces an old one.
+	 * @param msg the {@link StaffActivityMessage} to store
+	 */
+	public void insertOrReplace(StaffActivityMessage msg) {
+		jdbcTemplate.update("""
+				MERGE INTO staff_activity_messages
+					(guild_id, user_id, message_id)
+				KEY	(guild_id, user_id)
+				VALUES
+					(?,?,?)
+				""", msg.guildId(), msg.userId(), msg.messageId());
+	}
+	
+	/**
+	 * gets the ID of the activity message of a specific staff member.
+	 * @param guildId the ID of the relevant guild
+	 * @param userId the ID of the staff member
+	 * @return the message ID of the activity message
+	 */
+	public Long getMessageId(long guildId, long userId) {
+		return jdbcTemplate.query("SELECT message_id FROM staff_activity_messages WHERE guild_id=? AND user_id=?", rs-> rs.next() ? (Long)rs.getLong(1) : null, guildId, userId);
+	}
+}

src/main/java/net/javadiscord/javabot/systems/staff_activity/model/StaffActivityMessage.java

@@ -0,0 +1,9 @@
+package net.javadiscord.javabot.systems.staff_activity.model;
+
+/**
+ * Represents metadata of a message where activity information of a staff member is stored.
+ * @param guildId the ID of the guild
+ * @param userId the ID of the staff member
+ * @param messageId the ID of the message storing activity information about the staff member
+ */
+public record StaffActivityMessage(long guildId, long userId, long messageId) {}

src/main/resources/database/migrations/08-15-2023_staff_activity.sql

@@ -0,0 +1,6 @@
+CREATE TABLE staff_activity_messages (
+	guild_id	BIGINT NOT NULL,
+	user_id		BIGINT NOT NULL,
+	message_id	BIGINT NOT NULL,
+	PRIMARY KEY(guild_id, user_id)
+)