warn decay

Author: danthe1st

src/main/java/net/discordjug/javabot/api/routes/user_profile/UserProfileController.java

@@ -10,6 +10,7 @@
 import net.discordjug.javabot.data.config.BotConfig;
 import net.discordjug.javabot.systems.help.HelpExperienceService;
 import net.discordjug.javabot.systems.help.model.HelpAccount;
+import net.discordjug.javabot.systems.moderation.ModerationService;
 import net.discordjug.javabot.systems.moderation.warn.dao.WarnRepository;
 import net.discordjug.javabot.systems.qotw.QOTWPointsService;
 import net.discordjug.javabot.systems.qotw.model.QOTWAccount;
@@ -29,7 +30,6 @@
 
 import java.sql.Connection;
 import java.sql.SQLException;
-import java.time.LocalDateTime;
 import java.util.concurrent.TimeUnit;
 
 import javax.sql.DataSource;
@@ -108,8 +108,8 @@ public ResponseEntity<UserProfileData> getUserProfile(
 				HelpAccount helpAccount = helpExperienceService.getOrCreateAccount(user.getIdLong());
 				data.setHelpAccount(HelpAccountData.of(botConfig, helpAccount, guild));
 				// User Warns
-				LocalDateTime cutoff = LocalDateTime.now().minusDays(botConfig.get(guild).getModerationConfig().getWarnTimeoutDays());
-				data.setWarns(warnRepository.getActiveWarnsByUserId(user.getIdLong(), cutoff));
+				ModerationService moderationService = new ModerationService(null, botConfig.get(guild), warnRepository, null);
+				data.setWarns(moderationService.getTotalSeverityWeight(user.getIdLong()).contributingWarns());
 				// Insert into cache
 				getCache().put(new Pair<>(guild.getIdLong(), user.getIdLong()), data);
 			}

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

@@ -52,7 +52,17 @@ public class ModerationConfig extends GuildConfigItem {
 	 * being removed from the server. Warnings older than this are still kept,
 	 * but ignored.
 	 */
-	private int warnTimeoutDays = 30;
+	private int maxWarnValidityDays = 30;
+	
+	/**
+	 * The number of days it takes to remove a certain amount of severity weights from the warns of a user.
+	 */
+	private int warnDecayDays = maxWarnValidityDays;
+	
+	/**
+	 * The total severity weight removed from a user after {@link ModerationConfig#warnDecayDays} passed.
+	 */
+	private int warnDecayAmount = 0;
 
 	/**
 	 * The maximum total severity that a user can accrue from warnings before

src/main/java/net/discordjug/javabot/systems/moderation/ModerationService.java

@@ -24,6 +24,7 @@
 import java.time.Instant;
 import java.time.LocalDateTime;
 import java.time.ZoneOffset;
+import java.util.Collections;
 import java.util.List;
 import java.util.Optional;
 import java.util.concurrent.ExecutorService;
@@ -88,7 +89,7 @@ public void warn(User user, WarnSeverity severity, String reason, Member warnedB
 		asyncPool.execute(() -> {
 			try {
 				warnRepository.insert(new Warn(user.getIdLong(), warnedBy.getIdLong(), severity, reason));
-				int totalSeverity = warnRepository.getTotalSeverityWeight(user.getIdLong(), LocalDateTime.now().minusDays(moderationConfig.getWarnTimeoutDays()));
+				long totalSeverity = getTotalSeverityWeight(user.getIdLong()).totalSeverity();
 				MessageEmbed warnEmbed = buildWarnEmbed(user, warnedBy, severity, totalSeverity, reason);
 				notificationService.withUser(user, warnedBy.getGuild()).sendDirectMessage(c -> c.sendMessageEmbeds(warnEmbed));
 				notificationService.withGuild(moderationConfig.getGuild()).sendToModerationLog(c -> c.sendMessageEmbeds(warnEmbed));
@@ -106,7 +107,46 @@ public void warn(User user, WarnSeverity severity, String reason, Member warnedB
 			}
 		});
 	}
-
+	
+	/**
+	 * Gets the total warn severity weight of a given user.
+	 * @implSpec
+	 * 	Only warns from the last {@link ModerationConfig#getMaxWarnValidityDays()} days are checked.
+	 * 	Every {@link ModerationConfig#getWarnDecayDays()} days, {@link ModerationConfig#getWarnDecayAmount()} of severity are subtracted from the total severity of the user.
+	 * 	This method does not allow negative severities at any point in time.
+	 * 	The oldest considered warn decides on the amount of severity to subtract.
+	 * 	Hence, all warns that would (together) not increase the severity due to being too old are ignored.
+	 * @implNote
+	 * 	The total severity is calculated per warn by considering the severity of all warns after the given warn and subtracting the discount subtrahend corresponding to the given (oldest) warn from the severity.
+	 * 	Then, the maximum discounted severity over all warns is chosen.
+	 * @param userId the ID of the user to check
+	 * @return the accumulated warn severity weight of the user along with all warns contributing to it.
+	 * @see SeverityInformation
+	 */
+	public SeverityInformation getTotalSeverityWeight(long userId) {
+		LocalDateTime now = LocalDateTime.now();
+		List<Warn> activeWarns = warnRepository.getActiveWarnsByUserId(userId, now.minusDays(moderationConfig.getMaxWarnValidityDays()));
+		int accumulatedUndiscountedSeverity = 0;
+		long maxSeverity = 0;
+		long usedSeverityDiscount = 0;
+		List<Warn> contributingWarns = Collections.emptyList();
+		
+		for (int i = 0; i < activeWarns.size(); i++) {
+			Warn warn = activeWarns.get(i);
+			accumulatedUndiscountedSeverity += warn.getSeverityWeight();
+			long daysSinceWarn = Duration.between(warn.getCreatedAt(), now).toDays();
+			long discountAmount = moderationConfig.getWarnDecayAmount() * (daysSinceWarn / moderationConfig.getWarnDecayDays());
+			long currentSeverity = accumulatedUndiscountedSeverity - discountAmount;
+			if (currentSeverity > maxSeverity) {
+				maxSeverity = currentSeverity;
+				contributingWarns = activeWarns.subList(0, i + 1);
+				usedSeverityDiscount = discountAmount;
+			}
+		}
+		
+		return new SeverityInformation(maxSeverity, usedSeverityDiscount, Collections.unmodifiableList(contributingWarns));
+	}
+	
 	/**
 	 * Clears warns from the given user by discarding all warns.
 	 *
@@ -157,7 +197,7 @@ public boolean discardWarnById(long id, User clearedBy) {
 	public List<Warn> getWarns(long userId) {
 		try {
 			WarnRepository repo = warnRepository;
-			LocalDateTime cutoff = LocalDateTime.now().minusDays(moderationConfig.getWarnTimeoutDays());
+			LocalDateTime cutoff = LocalDateTime.now().minusDays(moderationConfig.getMaxWarnValidityDays());
 			return repo.getActiveWarnsByUserId(userId, cutoff);
 		} catch (DataAccessException e) {
 			ExceptionLogger.capture(e, getClass().getSimpleName());
@@ -356,7 +396,7 @@ private void sendGuildNotification(Guild guild, MessageEmbed embed) {
 				.build();
 	}
 
-	private @NotNull MessageEmbed buildWarnEmbed(User user, Member warnedBy, @NotNull WarnSeverity severity, int totalSeverity, String reason) {
+	private @NotNull MessageEmbed buildWarnEmbed(User user, Member warnedBy, @NotNull WarnSeverity severity, long totalSeverity, String reason) {
 		return buildModerationEmbed(user, warnedBy, reason)
 				.setTitle(String.format("Warn Added (%d/%d)", totalSeverity, moderationConfig.getMaxWarnSeverity()))
 				.setColor(Responses.Type.WARN.getColor())
@@ -407,4 +447,13 @@ private void sendGuildNotification(Guild guild, MessageEmbed embed) {
 				.setColor(Responses.Type.SUCCESS.getColor())
 				.build();
 	}
+	
+	/**
+	 * Records information about the total severity of a user as well as the warns contributing to it.
+	 * @param totalSeverity the total severity of the user
+	 * @param severityDiscount the amount the severity was reduced due to warn decay
+	 * @param contributingWarns the (active) warns contributing to that severity
+	 * @see ModerationService#getTotalSeverityWeight(long)
+	 */
+	public record SeverityInformation(long totalSeverity, long severityDiscount, List<Warn> contributingWarns) {}
 }

src/main/java/net/discordjug/javabot/systems/moderation/warn/WarnsListCommand.java

@@ -1,7 +1,6 @@
 package net.discordjug.javabot.systems.moderation.warn;
 
 import java.time.Instant;
-import java.time.LocalDateTime;
 import java.time.ZoneOffset;
 import java.util.List;
 import java.util.concurrent.ExecutorService;
@@ -13,8 +12,10 @@
 
 import xyz.dynxsty.dih4jda.interactions.commands.application.SlashCommand;
 import net.discordjug.javabot.data.config.BotConfig;
+import net.discordjug.javabot.systems.moderation.ModerationService;
 import net.discordjug.javabot.systems.moderation.warn.dao.WarnRepository;
 import net.discordjug.javabot.systems.moderation.warn.model.Warn;
+import net.discordjug.javabot.systems.notification.NotificationService;
 import net.discordjug.javabot.util.ExceptionLogger;
 import net.discordjug.javabot.util.Responses;
 import net.discordjug.javabot.util.UserUtils;
@@ -34,17 +35,20 @@ public class WarnsListCommand extends SlashCommand {
 	private final BotConfig botConfig;
 	private final WarnRepository warnRepository;
 	private final ExecutorService asyncPool;
+	private final NotificationService notificationService;
 
 	/**
 	 * 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 asyncPool The main thread pool for asynchronous operations
 	 * @param warnRepository DAO for interacting with the set of {@link Warn} objects.
+	 * @param notificationService service object for notifying users
 	 */
-	public WarnsListCommand(BotConfig botConfig, ExecutorService asyncPool, WarnRepository warnRepository) {
+	public WarnsListCommand(BotConfig botConfig, ExecutorService asyncPool, WarnRepository warnRepository, NotificationService notificationService) {
 		this.botConfig = botConfig;
 		this.warnRepository = warnRepository;
 		this.asyncPool = asyncPool;
+		this.notificationService = notificationService;
 		setCommandData(Commands.slash("warns", "Shows a list of all recent warning.")
 				.addOption(OptionType.USER, "user", "If given, shows the recent warns of the given user instead.", false)
 				.setGuildOnly(true)
@@ -54,22 +58,35 @@ public WarnsListCommand(BotConfig botConfig, ExecutorService asyncPool, WarnRepo
 	/**
 	 * Builds an {@link MessageEmbed} which contains all recents warnings of a user.
 	 *
-	 * @param warns A {@link List} with all {@link Warn}s.
+	 * @param severityInformation object containing information about active warns and their severities
 	 * @param user  The corresponding {@link User}.
 	 * @return The fully-built {@link MessageEmbed}.
 	 */
-	protected static @NotNull MessageEmbed buildWarnsEmbed(@Nonnull List<Warn> warns, @Nonnull User user) {
+	protected static @NotNull MessageEmbed buildWarnsEmbed(@Nonnull ModerationService.SeverityInformation severityInformation, @Nonnull User user) {
+		List<Warn> warns = severityInformation.contributingWarns();
 		EmbedBuilder builder = new EmbedBuilder()
 				.setAuthor(UserUtils.getUserTag(user), null, user.getEffectiveAvatarUrl())
 				.setTitle("Recent Warns")
 				.setDescription(String.format("%s has `%s` active warns with a total of `%s` severity.\n",
-						user.getAsMention(), warns.size(), warns.stream().mapToInt(Warn::getSeverityWeight).sum()))
+						user.getAsMention(), warns.size(), severityInformation.totalSeverity()))
 				.setColor(Responses.Type.WARN.getColor())
 				.setTimestamp(Instant.now());
-		warns.forEach(w -> builder.getDescriptionBuilder().append(
-				String.format("\n`%s` <t:%s>\nWarned by: <@%s>\nSeverity: `%s (%s)`\nReason: %s\n",
-						w.getId(), w.getCreatedAt().toInstant(ZoneOffset.UTC).getEpochSecond(),
-						w.getWarnedBy(), w.getSeverity(), w.getSeverityWeight(), w.getReason())));
+		
+		if (severityInformation.severityDiscount() > 0) {
+			builder.appendDescription("(Due to warn decay, the total severity is `"+severityInformation.severityDiscount()+"` lower than the sum of all warn severities.)\n");
+		}
+		
+		warns.forEach(w -> {
+			String text = String.format("\n`%s` <t:%s>\nWarned by: <@%s>\nSeverity: `%s (%s)`\nReason: %s\n",
+					w.getId(), w.getCreatedAt().toInstant(ZoneOffset.UTC).getEpochSecond(),
+					w.getWarnedBy(), w.getSeverity(), w.getSeverityWeight(), w.getReason());
+			StringBuilder descriptionBuilder = builder.getDescriptionBuilder();
+			if (descriptionBuilder.length() + text.length() < MessageEmbed.DESCRIPTION_MAX_LENGTH) {
+				descriptionBuilder.append(text);
+			} else {
+				builder.setFooter("Some warns have been omitted due to length limitations. Contact staff in case you want to see an exhaustive list of warns.");
+			}
+		});
 		return builder.build();
 	}
 
@@ -81,10 +98,10 @@ public void execute(@NotNull SlashCommandInteractionEvent event) {
 			return;
 		}
 		event.deferReply(false).queue();
-		LocalDateTime cutoff = LocalDateTime.now().minusDays(botConfig.get(event.getGuild()).getModerationConfig().getWarnTimeoutDays());
+		ModerationService moderationService = new ModerationService(notificationService, botConfig, event, warnRepository, asyncPool);
 		asyncPool.execute(() -> {
 			try {
-				event.getHook().sendMessageEmbeds(buildWarnsEmbed(warnRepository.getActiveWarnsByUserId(user.getIdLong(), cutoff), user)).queue();
+				event.getHook().sendMessageEmbeds(buildWarnsEmbed(moderationService.getTotalSeverityWeight(user.getIdLong()), user)).queue();
 			} catch (DataAccessException e) {
 				ExceptionLogger.capture(e, WarnsListCommand.class.getSimpleName());
 			}

src/main/java/net/discordjug/javabot/systems/moderation/warn/WarnsListContext.java

@@ -2,13 +2,14 @@
 
 import xyz.dynxsty.dih4jda.interactions.commands.application.ContextCommand;
 import net.discordjug.javabot.data.config.BotConfig;
+import net.discordjug.javabot.systems.moderation.ModerationService;
 import net.discordjug.javabot.systems.moderation.warn.dao.WarnRepository;
+import net.discordjug.javabot.systems.notification.NotificationService;
 import net.discordjug.javabot.util.ExceptionLogger;
 import net.discordjug.javabot.util.Responses;
 import net.dv8tion.jda.api.events.interaction.command.UserContextInteractionEvent;
 import net.dv8tion.jda.api.interactions.commands.build.Commands;
 
-import java.time.LocalDateTime;
 import java.util.concurrent.ExecutorService;
 
 import org.springframework.dao.DataAccessException;
@@ -21,17 +22,20 @@ public class WarnsListContext extends ContextCommand.User {
 	private final BotConfig botConfig;
 	private final ExecutorService asyncPool;
 	private final WarnRepository warnRepository;
+	private final NotificationService notificationService;
 
 	/**
 	 * The constructor of this class, which sets the corresponding {@link net.dv8tion.jda.api.interactions.commands.build.CommandData}.
 	 * @param botConfig The main configuration of the bot
 	 * @param asyncPool The main thread pool for asynchronous operations
 	 * @param warnRepository DAO for interacting with the set of {@link net.discordjug.javabot.systems.moderation.warn.model.Warn} objects.
+	 * @param notificationService service object for notifying users
 	 */
-	public WarnsListContext(BotConfig botConfig, ExecutorService asyncPool, WarnRepository warnRepository) {
+	public WarnsListContext(BotConfig botConfig, ExecutorService asyncPool, WarnRepository warnRepository, NotificationService notificationService) {
 		this.botConfig = botConfig;
 		this.asyncPool = asyncPool;
 		this.warnRepository = warnRepository;
+		this.notificationService = notificationService;
 		setCommandData(Commands.user("Show Warns")
 				.setGuildOnly(true)
 		);
@@ -44,10 +48,10 @@ public void execute(UserContextInteractionEvent event) {
 			return;
 		}
 		event.deferReply(false).queue();
-		LocalDateTime cutoff = LocalDateTime.now().minusDays(botConfig.get(event.getGuild()).getModerationConfig().getWarnTimeoutDays());
+		ModerationService moderationService = new ModerationService(notificationService, botConfig.get(event.getGuild()), warnRepository, asyncPool);
 		asyncPool.execute(() -> {
 			try {
-				event.getHook().sendMessageEmbeds(WarnsListCommand.buildWarnsEmbed(warnRepository.getActiveWarnsByUserId(event.getTarget().getIdLong(), cutoff), event.getTarget())).queue();
+				event.getHook().sendMessageEmbeds(WarnsListCommand.buildWarnsEmbed(moderationService.getTotalSeverityWeight(event.getTarget().getIdLong()), event.getTarget())).queue();
 			} catch (DataAccessException e) {
 				ExceptionLogger.capture(e, WarnsListContext.class.getSimpleName());
 			}

src/main/java/net/discordjug/javabot/systems/moderation/warn/dao/WarnRepository.java

@@ -61,25 +61,7 @@ public Optional<Warn> findById(long id) throws DataAccessException {
 			return Optional.empty();
 		}
 	}
-
-	/**
-	 * Gets the total severity weight of all warns for the given user, which
-	 * were created after the given cutoff, and haven't been discarded.
-	 *
-	 * @param userId The id of the user.
-	 * @param cutoff The time after which to look for warns.
-	 * @return The total weight of all warn severities.
-	 * @throws SQLException If an error occurs.
-	 */
-	public int getTotalSeverityWeight(long userId, LocalDateTime cutoff) throws DataAccessException {
-		try {
-			return jdbcTemplate.queryForObject("SELECT SUM(severity_weight) FROM warn WHERE user_id = ? AND discarded = FALSE AND created_at > ?", (rs, rows)->rs.getInt(1),
-					userId, Timestamp.valueOf(cutoff));
-		}catch (EmptyResultDataAccessException e) {
-			return 0;
-		}
-	}
-
+	
 	/**
 	 * Discards all warnings that have been issued to a given user.
 	 *
@@ -135,12 +117,12 @@ private Warn read(ResultSet rs) throws SQLException {
 	 * @return A List with all Warns.
 	 */
 	public List<Warn> getActiveWarnsByUserId(long userId, LocalDateTime cutoff) {
-		return jdbcTemplate.query("SELECT * FROM warn WHERE user_id = ? AND discarded = FALSE AND created_at > ?",(rs, row)->this.read(rs),
+		return jdbcTemplate.query("SELECT * FROM warn WHERE user_id = ? AND discarded = FALSE AND created_at > ? ORDER BY created_at DESC",(rs, row)->this.read(rs),
 				userId, Timestamp.valueOf(cutoff));
 	}
 
 	public List<Warn> getAllWarnsByUserId(long userId) {
-		return jdbcTemplate.query("SELECT * FROM warn WHERE user_id = ?",(rs, row)->this.read(rs),
+		return jdbcTemplate.query("SELECT * FROM warn WHERE user_id = ?",(rs, row) -> this.read(rs),
 				userId);
 	}
 }