[AB-xxx] reworking ban logging to use audit log instead of actively l…

…ogging or using the banned event partially fixing broken infraction handling adding CompletableFutureMap to handle futures easier updating user display object to also hold name replaced some references to UserObjects in models with UserDisplay objects
Sheldan · May 4, 2024 · 234aae3 · 234aae3
1 parent ca45137
commit 234aae3
Show file tree

Hide file tree

Showing 24 changed files with 279 additions and 259 deletions.
diff --git a/...ogging/logging-impl/src/main/java/dev/sheldan/abstracto/logging/listener/LeaveLogger.java b/...ogging/logging-impl/src/main/java/dev/sheldan/abstracto/logging/listener/LeaveLogger.java
@@ -5,13 +5,14 @@
 import dev.sheldan.abstracto.core.listener.async.jda.AsyncLeaveListener;
 import dev.sheldan.abstracto.core.models.ServerUser;
 import dev.sheldan.abstracto.core.models.listener.MemberLeaveModel;
-import dev.sheldan.abstracto.core.service.MemberService;
+import dev.sheldan.abstracto.core.models.template.display.UserDisplay;
 import dev.sheldan.abstracto.core.service.PostTargetService;
 import dev.sheldan.abstracto.core.templating.model.MessageToSend;
 import dev.sheldan.abstracto.core.templating.service.TemplateService;
 import dev.sheldan.abstracto.core.utils.FutureUtils;
 import dev.sheldan.abstracto.logging.config.LoggingFeatureDefinition;
 import dev.sheldan.abstracto.logging.config.LoggingPostTarget;
+import dev.sheldan.abstracto.logging.model.template.MemberLeaveLogModel;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Service;
@@ -40,10 +41,10 @@ public DefaultListenerResult execute(MemberLeaveModel listenerModel) {
                 .userId(listenerModel.getUser().getIdLong())
                 .serverId(listenerModel.getServerId())
                 .build();
-        MemberLeaveModel model = MemberLeaveModel
+        MemberLeaveLogModel model = MemberLeaveLogModel
                 .builder()
                 .leavingUser(leavingUser)
-                .user(listenerModel.getUser())
+                .user(UserDisplay.fromUser(listenerModel.getUser()))
                 .build();
         log.debug("Logging leave event for user {} in server {}.", listenerModel.getUser().getIdLong(), listenerModel.getServerId());
         MessageToSend messageToSend = templateService.renderEmbedTemplate(USER_LEAVE_TEMPLATE, model, listenerModel.getServerId());

diff --git a/...g-int/src/main/java/dev/sheldan/abstracto/logging/model/template/MemberLeaveLogModel.java b/...g-int/src/main/java/dev/sheldan/abstracto/logging/model/template/MemberLeaveLogModel.java
@@ -1,13 +1,15 @@
 package dev.sheldan.abstracto.logging.model.template;
 
+import dev.sheldan.abstracto.core.models.ServerUser;
+import dev.sheldan.abstracto.core.models.template.display.UserDisplay;
 import lombok.Builder;
 import lombok.Getter;
 import lombok.Setter;
-import net.dv8tion.jda.api.entities.Member;
 
 @Getter
 @Setter
 @Builder
 public class MemberLeaveLogModel {
-    private Member member;
+    private ServerUser leavingUser;
+    private UserDisplay user;
 }
diff --git a/...eration/moderation-impl/src/main/java/dev/sheldan/abstracto/moderation/command/UnBan.java b/...eration/moderation-impl/src/main/java/dev/sheldan/abstracto/moderation/command/UnBan.java
@@ -11,7 +11,6 @@
 import dev.sheldan.abstracto.core.interaction.slash.parameter.SlashCommandParameterService;
 import dev.sheldan.abstracto.core.config.FeatureDefinition;
 import dev.sheldan.abstracto.core.interaction.InteractionService;
-import dev.sheldan.abstracto.core.models.ServerUser;
 import dev.sheldan.abstracto.core.service.UserService;
 import dev.sheldan.abstracto.moderation.config.ModerationModuleDefinition;
 import dev.sheldan.abstracto.moderation.config.ModerationSlashCommandNames;
@@ -51,7 +50,7 @@ public CompletableFuture<CommandResult> executeAsync(CommandContext commandConte
         String userIdStr = (String) parameters.get(0);
         Long userId = Long.parseLong(userIdStr);
         return userService.retrieveUserForId(userId)
-                .thenCompose(user -> banService.unBanUserWithNotification(userId, ServerUser.fromMember(commandContext.getAuthor()), commandContext.getGuild()))
+                .thenCompose(user -> banService.unbanUser(commandContext.getGuild(), userId))
                 .thenApply(aVoid -> CommandResult.fromSuccess());
     }
 
@@ -60,7 +59,7 @@ public CompletableFuture<CommandResult> executeSlash(SlashCommandInteractionEven
         String userIdStr = slashCommandParameterService.getCommandOption(USER_PARAMETER, event, String.class);
         Long userId = Long.parseLong(userIdStr);
         return userService.retrieveUserForId(userId)
-                .thenCompose(user -> banService.unBanUserWithNotification(userId, ServerUser.fromMember(event.getMember()), event.getGuild()))
+                .thenCompose(user -> banService.unbanUser(event.getGuild(), userId))
                 .thenCompose(unused -> interactionService.replyEmbed(UN_BAN_RESPONSE, event))
                 .thenApply(interactionHook -> CommandResult.fromSuccess());
     }

diff --git a/...tion-impl/src/main/java/dev/sheldan/abstracto/moderation/listener/UserBannedListener.java b/...tion-impl/src/main/java/dev/sheldan/abstracto/moderation/listener/UserBannedListener.java
@@ -4,23 +4,17 @@
 import dev.sheldan.abstracto.core.listener.DefaultListenerResult;
 import dev.sheldan.abstracto.core.listener.async.jda.AsyncUserBannedListener;
 import dev.sheldan.abstracto.core.models.listener.UserBannedModel;
+import dev.sheldan.abstracto.core.models.template.display.UserDisplay;
 import dev.sheldan.abstracto.core.service.PostTargetService;
 import dev.sheldan.abstracto.core.templating.model.MessageToSend;
 import dev.sheldan.abstracto.core.templating.service.TemplateService;
 import dev.sheldan.abstracto.core.utils.FutureUtils;
 import dev.sheldan.abstracto.moderation.config.feature.ModerationFeatureDefinition;
 import dev.sheldan.abstracto.moderation.config.posttarget.ModerationPostTarget;
-import dev.sheldan.abstracto.moderation.model.template.listener.UserBannedListenerModel;
+import dev.sheldan.abstracto.moderation.model.template.listener.UserBannedListenerLogModel;
 import lombok.extern.slf4j.Slf4j;
-import net.dv8tion.jda.api.audit.ActionType;
-import net.dv8tion.jda.api.audit.AuditLogEntry;
-import net.dv8tion.jda.api.entities.User;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
-import org.springframework.transaction.annotation.Transactional;
-
-import java.util.Optional;
-import java.util.concurrent.CompletableFuture;
 
 @Component
 @Slf4j
@@ -32,53 +26,20 @@ public class UserBannedListener implements AsyncUserBannedListener {
     @Autowired
     private PostTargetService postTargetService;
 
-    @Autowired
-    private UserBannedListener self;
-
-    private static final String USER_BANNED_NOTIFICATION_TEMPLATE = "userBanned_listener_notification";
+    public static final String USER_BANNED_NOTIFICATION_TEMPLATE = "userBanned_listener_notification";
 
     @Override
-    public DefaultListenerResult execute(UserBannedModel model) {
-        model.getGuild()
-                .retrieveAuditLogs()
-                .type(ActionType.BAN)
-                .limit(5)
-                .queue(auditLogEntries -> {
-                    if(auditLogEntries.isEmpty()) {
-                        log.info("Did not find recent bans in guild {}.", model.getServerId());
-                        self.sendBannedNotification(model.getUser(), null, null, model.getServerId());
-                        return;
-                    }
-                    Optional<AuditLogEntry> banEntryOptional = auditLogEntries
-                            .stream()
-                            .filter(auditLogEntry -> auditLogEntry.getTargetIdLong() == model.getBannedUser().getUserId())
-                            .findFirst();
-                    if(banEntryOptional.isPresent()) {
-                        AuditLogEntry auditLogEntry = banEntryOptional.get();
-                        if(!model.getGuild().getJDA().getSelfUser().equals(auditLogEntry.getUser())) {
-                            self.sendBannedNotification(model.getUser(), auditLogEntry.getUser(), auditLogEntry.getReason(), model.getServerId());
-                        }
-                    } else {
-                        log.info("Did not find the banned user in the most recent bans for guild {}. Not adding audit log information.", model.getServerId());
-                        self.sendBannedNotification(model.getUser(), null, null, model.getServerId());
-                    }
-                }, throwable -> {
-                    log.error("Retrieving bans for guild {} failed - logging ban regardless.", model.getServerId());
-                    self.sendBannedNotification(model.getUser(), null, null, model.getServerId());
-                });
-        return DefaultListenerResult.PROCESSED;
-    }
-
-    @Transactional
-    public CompletableFuture<Void> sendBannedNotification(User bannedUser, User banningUser, String reason, Long serverId) {
-        UserBannedListenerModel model = UserBannedListenerModel
+    public DefaultListenerResult execute(UserBannedModel eventModel) {
+        log.info("Notifying about ban of user {} in guild {}.", eventModel.getBannedServerUser().getUserId(), eventModel.getServerId());
+        UserBannedListenerLogModel model = UserBannedListenerLogModel
                 .builder()
-                .bannedUser(bannedUser)
-                .banningUser(banningUser)
-                .reason(reason)
+                .bannedUser(eventModel.getBannedUser() != null ? UserDisplay.fromUser(eventModel.getBannedUser()) : UserDisplay.fromId(eventModel.getBannedServerUser().getUserId()))
+                .banningUser(eventModel.getBanningUser() != null ? UserDisplay.fromUser(eventModel.getBanningUser()) : UserDisplay.fromServerUser(eventModel.getBanningServerUser()))
+                .reason(eventModel.getReason())
                 .build();
-        MessageToSend messageToSend = templateService.renderEmbedTemplate(USER_BANNED_NOTIFICATION_TEMPLATE, model, serverId);
-        return FutureUtils.toSingleFutureGeneric(postTargetService.sendEmbedInPostTarget(messageToSend, ModerationPostTarget.BAN_LOG, serverId));
+        MessageToSend messageToSend = templateService.renderEmbedTemplate(USER_BANNED_NOTIFICATION_TEMPLATE, model, eventModel.getServerId());
+        FutureUtils.toSingleFutureGeneric(postTargetService.sendEmbedInPostTarget(messageToSend, ModerationPostTarget.BAN_LOG, eventModel.getServerId()));
+        return DefaultListenerResult.PROCESSED;
     }
 
     @Override

diff --git a/...on-impl/src/main/java/dev/sheldan/abstracto/moderation/listener/UserUnBannedListener.java b/...on-impl/src/main/java/dev/sheldan/abstracto/moderation/listener/UserUnBannedListener.java
@@ -4,87 +4,42 @@
 import dev.sheldan.abstracto.core.listener.DefaultListenerResult;
 import dev.sheldan.abstracto.core.listener.async.jda.AsyncUserUnBannedListener;
 import dev.sheldan.abstracto.core.models.listener.UserUnBannedModel;
-import dev.sheldan.abstracto.core.service.FeatureModeService;
+import dev.sheldan.abstracto.core.models.template.display.UserDisplay;
 import dev.sheldan.abstracto.core.service.PostTargetService;
 import dev.sheldan.abstracto.core.templating.model.MessageToSend;
 import dev.sheldan.abstracto.core.templating.service.TemplateService;
 import dev.sheldan.abstracto.core.utils.FutureUtils;
 import dev.sheldan.abstracto.moderation.config.feature.ModerationFeatureDefinition;
 import dev.sheldan.abstracto.moderation.config.posttarget.ModerationPostTarget;
-import dev.sheldan.abstracto.moderation.model.template.listener.UserUnBannedListenerModel;
+import dev.sheldan.abstracto.moderation.model.template.listener.UserUnBannedListenerLogModel;
 import lombok.extern.slf4j.Slf4j;
-import net.dv8tion.jda.api.audit.ActionType;
-import net.dv8tion.jda.api.audit.AuditLogEntry;
-import net.dv8tion.jda.api.entities.User;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.stereotype.Component;
-import org.springframework.transaction.annotation.Transactional;
-
-import java.util.Optional;
-import java.util.concurrent.CompletableFuture;
 
 @Component
 @Slf4j
 public class UserUnBannedListener implements AsyncUserUnBannedListener {
-    @Autowired
-    private FeatureModeService featureModeService;
 
     @Autowired
     private TemplateService templateService;
 
     @Autowired
     private PostTargetService postTargetService;
 
-    @Autowired
-    private UserUnBannedListener self;
-
     private static final String USER_UN_BANNED_NOTIFICATION_TEMPLATE = "userUnBanned_listener_notification";
 
     @Override
-    public DefaultListenerResult execute(UserUnBannedModel model) {
-        log.info("Notifying about unban of user {} in guild {}.", model.getUnbannedUser().getUserId(), model.getServerId());
-        model.getGuild()
-                .retrieveAuditLogs()
-                .type(ActionType.UNBAN)
-                .limit(5)
-                .queue(auditLogEntries -> {
-                    try {
-                        if(auditLogEntries.isEmpty()) {
-                            log.info("Did not find recent bans in guild {}.", model.getServerId());
-                            return;
-                        }
-                        Optional<AuditLogEntry> banEntryOptional = auditLogEntries
-                                .stream()
-                                .filter(auditLogEntry -> auditLogEntry.getTargetIdLong() == model.getUnbannedUser().getUserId())
-                                .findFirst();
-                        if(banEntryOptional.isPresent()) {
-                            AuditLogEntry auditLogEntry = banEntryOptional.get();
-                            if(!model.getGuild().getJDA().getSelfUser().equals(auditLogEntry.getUser())) {
-                                self.sendUnBannedNotification(model.getUser(), auditLogEntry.getUser(), model.getServerId());
-                            }
-                        } else {
-                            log.info("Did not find the un-banned user in the most recent un-bans for guild {}. Not adding audit log information.", model.getServerId());
-                            self.sendUnBannedNotification(model.getUser(), null, model.getServerId());
-                        }
-                    } catch (Exception exception) {
-                        log.error("Failed to properly send un ban log with error.", exception);
-                    }
-                }, throwable -> {
-                    log.error("Failed to retrieve audit log entries for unban log.", throwable);
-                    self.sendUnBannedNotification(model.getUser(), null, model.getServerId());
-                });
-        return DefaultListenerResult.PROCESSED;
-    }
-
-    @Transactional
-    public CompletableFuture<Void> sendUnBannedNotification(User unbannedUser, User unbanningUser, Long serverId) {
-        UserUnBannedListenerModel model = UserUnBannedListenerModel
+    public DefaultListenerResult execute(UserUnBannedModel eventModel) {
+        log.info("Notifying about unban of user {} in guild {}.", eventModel.getUnBannedServerUser().getUserId(), eventModel.getServerId());
+        UserUnBannedListenerLogModel model = UserUnBannedListenerLogModel
                 .builder()
-                .unBannedUser(unbannedUser)
-                .unBanningUser(unbanningUser)
+                .unBannedUser(eventModel.getUnBannedUser() != null ? UserDisplay.fromUser(eventModel.getUnBannedUser()) : UserDisplay.fromId(eventModel.getUnBannedServerUser().getUserId()))
+                .unBanningUser(eventModel.getUnBanningUser() != null ? UserDisplay.fromUser(eventModel.getUnBanningUser()) : UserDisplay.fromServerUser(eventModel.getUnBanningServerUser()))
+                .reason(eventModel.getReason())
                 .build();
-        MessageToSend messageToSend = templateService.renderEmbedTemplate(USER_UN_BANNED_NOTIFICATION_TEMPLATE, model, serverId);
-        return FutureUtils.toSingleFutureGeneric(postTargetService.sendEmbedInPostTarget(messageToSend, ModerationPostTarget.BAN_LOG, serverId));
+        MessageToSend messageToSend = templateService.renderEmbedTemplate(USER_UN_BANNED_NOTIFICATION_TEMPLATE, model, eventModel.getServerId());
+        FutureUtils.toSingleFutureGeneric(postTargetService.sendEmbedInPostTarget(messageToSend, ModerationPostTarget.BAN_LOG, eventModel.getServerId()));
+        return DefaultListenerResult.PROCESSED;
     }
 
     @Override