Merge pull request #340 from Java-Discord/dynxsty/better_notifications

Refactored NotificationService

Author: jasonlessenich

src/main/java/net/javadiscord/javabot/listener/PingableNameListener.java

@@ -5,7 +5,7 @@
 import net.dv8tion.jda.api.events.guild.member.GuildMemberJoinEvent;
 import net.dv8tion.jda.api.events.guild.member.update.GuildMemberUpdateNicknameEvent;
 import net.dv8tion.jda.api.hooks.ListenerAdapter;
-import net.javadiscord.javabot.systems.notification.GuildNotificationService;
+import net.javadiscord.javabot.systems.notification.NotificationService;
 import net.javadiscord.javabot.util.ExceptionLogger;
 import net.javadiscord.javabot.util.StringUtils;
 
@@ -71,7 +71,7 @@ private void changeName(Member member) {
 		member.getUser().openPrivateChannel()
 				.flatMap(channel -> channel.sendMessageFormat("Your nickname has been set to `%s` since both your user- and nickname's first three characters were deemed as not-pingable.", newName))
 				.queue();
-		new GuildNotificationService(member.getGuild()).sendLogChannelNotification("Changed %s's nickname from `%s` to `%s`.", member.getAsMention(), oldName, newName);
+		NotificationService.withGuild(member.getGuild()).sendToModerationLog(c -> c.sendMessageFormat("Changed %s's nickname from `%s` to `%s`.", member.getAsMention(), oldName, newName));
 	}
 
 	/**

src/main/java/net/javadiscord/javabot/listener/StateListener.java

@@ -13,7 +13,7 @@
 import net.javadiscord.javabot.data.config.guild.HelpConfig;
 import net.javadiscord.javabot.systems.help.HelpChannelUpdater;
 import net.javadiscord.javabot.systems.help.checks.SimpleGreetingCheck;
-import net.javadiscord.javabot.systems.notification.GuildNotificationService;
+import net.javadiscord.javabot.systems.notification.NotificationService;
 import net.javadiscord.javabot.util.ExceptionLogger;
 import net.javadiscord.javabot.util.StringUtils;
 import org.jetbrains.annotations.NotNull;
@@ -47,7 +47,7 @@ public void onReady(@NotNull ReadyEvent event) {
 					helpConfig.getUpdateIntervalSeconds(),
 					TimeUnit.SECONDS
 			);
-			new GuildNotificationService(guild).sendLogChannelNotification(buildBootedUpEmbed());
+			NotificationService.withGuild(guild).sendToModerationLog(c -> c.sendMessageEmbeds(buildBootedUpEmbed()));
 		}
 		try {
 			Bot.getCustomTagManager().init();

src/main/java/net/javadiscord/javabot/systems/moderation/AutoMod.java

@@ -10,7 +10,7 @@
 import net.dv8tion.jda.api.hooks.ListenerAdapter;
 import net.javadiscord.javabot.Bot;
 import net.javadiscord.javabot.systems.moderation.warn.model.WarnSeverity;
-import net.javadiscord.javabot.systems.notification.GuildNotificationService;
+import net.javadiscord.javabot.systems.notification.NotificationService;
 import net.javadiscord.javabot.util.ExceptionLogger;
 import org.jetbrains.annotations.NotNull;
 
@@ -123,7 +123,7 @@ private void checkNewMessageAutomod(@Nonnull Message message) {
 	private void checkContentAutomod(@Nonnull Message message) {
 		//Check for Advertising Links
 		if (hasAdvertisingLink(message)) {
-			new GuildNotificationService(message.getGuild()).sendLogChannelNotification("Message: `" + message.getContentRaw() + "`");
+			NotificationService.withGuild(message.getGuild()).sendToModerationLog(c -> c.sendMessageFormat("Message: `%s`", message.getContentRaw()));
 			new ModerationService(Bot.getConfig().get(message.getGuild()))
 					.warn(
 							message.getAuthor(),
@@ -141,7 +141,7 @@ private void checkContentAutomod(@Nonnull Message message) {
 
 		//Check for suspicious Links
 		if (hasSuspiciousLink(message)) {
-			new GuildNotificationService(message.getGuild()).sendLogChannelNotification("Suspicious Link sent by: %s (`%s`)", message.getMember().getAsMention(), message);
+			NotificationService.withGuild(message.getGuild()).sendToModerationLog(c -> c.sendMessageFormat("Suspicious Link sent by: %s (`%s`)", message.getAuthor().getAsMention(), message.getContentRaw()));
 			new ModerationService(Bot.getConfig().get(message.getGuild()))
 					.warn(
 							message.getAuthor(),

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

@@ -12,8 +12,7 @@
 import net.javadiscord.javabot.systems.moderation.warn.dao.WarnRepository;
 import net.javadiscord.javabot.systems.moderation.warn.model.Warn;
 import net.javadiscord.javabot.systems.moderation.warn.model.WarnSeverity;
-import net.javadiscord.javabot.systems.notification.GuildNotificationService;
-import net.javadiscord.javabot.systems.notification.UserNotificationService;
+import net.javadiscord.javabot.systems.notification.NotificationService;
 import net.javadiscord.javabot.util.ExceptionLogger;
 import net.javadiscord.javabot.util.Responses;
 import org.jetbrains.annotations.NotNull;
@@ -73,8 +72,8 @@ public void warn(User user, WarnSeverity severity, String reason, Member warnedB
 			dao.insert(new Warn(user.getIdLong(), warnedBy.getIdLong(), severity, reason));
 			int totalSeverity = dao.getTotalSeverityWeight(user.getIdLong(), LocalDateTime.now().minusDays(moderationConfig.getWarnTimeoutDays()));
 			MessageEmbed warnEmbed = buildWarnEmbed(user, warnedBy, severity, totalSeverity, reason);
-			new UserNotificationService(user).sendDirectMessageNotification(warnEmbed);
-			new GuildNotificationService(moderationConfig.getGuild()).sendLogChannelNotification(warnEmbed);
+			NotificationService.withUser(user).sendDirectMessage(c -> c.sendMessageEmbeds(warnEmbed));
+			NotificationService.withGuild(moderationConfig.getGuild()).sendToModerationLog(c -> c.sendMessageEmbeds(warnEmbed));
 			if (!quiet && channel.getIdLong() != moderationConfig.getLogChannelId()) {
 				channel.sendMessageEmbeds(warnEmbed).queue();
 			}
@@ -94,8 +93,8 @@ public void discardAllWarns(User user, User clearedBy) {
 		DbHelper.doDaoAction(WarnRepository::new, dao -> {
 			dao.discardAll(user.getIdLong());
 			MessageEmbed embed = buildClearWarnsEmbed(user, clearedBy);
-			new UserNotificationService(user).sendDirectMessageNotification(embed);
-			new GuildNotificationService(moderationConfig.getGuild()).sendLogChannelNotification(embed);
+			NotificationService.withUser(user).sendDirectMessage(c -> c.sendMessageEmbeds(embed));
+			NotificationService.withGuild(moderationConfig.getGuild()).sendToModerationLog(c -> c.sendMessageEmbeds(embed));
 		});
 	}
 
@@ -113,8 +112,7 @@ public boolean discardWarnById(long id, User clearedBy) {
 			if (warnOptional.isPresent()) {
 				Warn warn = warnOptional.get();
 				repo.discardById(warn.getId());
-				new GuildNotificationService(moderationConfig.getGuild())
-						.sendLogChannelNotification(buildClearWarnsByIdEmbed(warn, clearedBy));
+				NotificationService.withGuild(moderationConfig.getGuild()).sendToModerationLog(c -> c.sendMessageEmbeds(buildClearWarnsByIdEmbed(warn, clearedBy)));
 				return true;
 			}
 		} catch (SQLException e) {
@@ -153,8 +151,8 @@ public List<Warn> getWarns(long userId) {
 	public void timeout(@Nonnull Member member, @Nonnull String reason, @Nonnull Member timedOutBy, @Nonnull Duration duration, @Nonnull MessageChannel channel, boolean quiet) {
 		MessageEmbed timeoutEmbed = buildTimeoutEmbed(member, timedOutBy, reason, duration);
 		member.getGuild().timeoutFor(member, duration).queue(s -> {
-			new UserNotificationService(member.getUser()).sendDirectMessageNotification(timeoutEmbed);
-			new GuildNotificationService(member.getGuild()).sendLogChannelNotification(timeoutEmbed);
+			NotificationService.withUser(member.getUser()).sendDirectMessage(c -> c.sendMessageEmbeds(timeoutEmbed));
+			NotificationService.withGuild(member.getGuild()).sendToModerationLog(c -> c.sendMessageEmbeds(timeoutEmbed));
 			if (!quiet) channel.sendMessageEmbeds(timeoutEmbed).queue();
 		}, ExceptionLogger::capture);
 	}
@@ -171,8 +169,8 @@ public void timeout(@Nonnull Member member, @Nonnull String reason, @Nonnull Mem
 	public void removeTimeout(Member member, String reason, Member removedBy, MessageChannel channel, boolean quiet) {
 		MessageEmbed removeTimeoutEmbed = buildTimeoutRemovedEmbed(member, removedBy, reason);
 		removedBy.getGuild().removeTimeout(member).queue(s -> {
-			new UserNotificationService(member.getUser()).sendDirectMessageNotification(removeTimeoutEmbed);
-			new GuildNotificationService(member.getGuild()).sendLogChannelNotification(removeTimeoutEmbed);
+			NotificationService.withUser(member.getUser()).sendDirectMessage(c -> c.sendMessageEmbeds(removeTimeoutEmbed));
+			NotificationService.withGuild(member.getGuild()).sendToModerationLog(c -> c.sendMessageEmbeds(removeTimeoutEmbed));
 			if (!quiet) channel.sendMessageEmbeds(removeTimeoutEmbed).queue();
 		}, ExceptionLogger::capture);
 	}
@@ -189,8 +187,8 @@ public void removeTimeout(Member member, String reason, Member removedBy, Messag
 	public void ban(User user, String reason, Member bannedBy, MessageChannel channel, boolean quiet) {
 		MessageEmbed banEmbed = buildBanEmbed(user, bannedBy, reason);
 		bannedBy.getGuild().ban(user, BAN_DELETE_DAYS, reason).queue(s -> {
-			new UserNotificationService(user).sendDirectMessageNotification(banEmbed);
-			new GuildNotificationService(bannedBy.getGuild()).sendLogChannelNotification(banEmbed);
+			NotificationService.withUser(user).sendDirectMessage(c -> c.sendMessageEmbeds(banEmbed));
+			NotificationService.withGuild(bannedBy.getGuild()).sendToModerationLog(c -> c.sendMessageEmbeds(banEmbed));
 			if (!quiet) channel.sendMessageEmbeds(banEmbed).queue();
 		}, ExceptionLogger::capture);
 	}
@@ -235,8 +233,8 @@ private boolean isBanned(@NotNull Guild guild, long userId) {
 	public void kick(User user, String reason, Member kickedBy, MessageChannel channel, boolean quiet) {
 		MessageEmbed kickEmbed = buildKickEmbed(user, kickedBy, reason);
 		kickedBy.getGuild().kick(user).queue(s -> {
-			new UserNotificationService(user).sendDirectMessageNotification(kickEmbed);
-			new GuildNotificationService(kickedBy.getGuild()).sendLogChannelNotification(kickEmbed);
+			NotificationService.withUser(user).sendDirectMessage(c -> c.sendMessageEmbeds(kickEmbed));
+			NotificationService.withGuild(kickedBy.getGuild()).sendToModerationLog(c -> c.sendMessageEmbeds(kickEmbed));
 			if (!quiet) channel.sendMessageEmbeds(kickEmbed).queue();
 		}, ExceptionLogger::capture);
 	}

src/main/java/net/javadiscord/javabot/systems/moderation/server_lock/ServerLockManager.java

@@ -10,10 +10,11 @@
 import net.dv8tion.jda.api.events.guild.member.GuildMemberJoinEvent;
 import net.dv8tion.jda.api.hooks.ListenerAdapter;
 import net.javadiscord.javabot.Bot;
+import net.javadiscord.javabot.systems.notification.GuildNotificationService;
+import net.javadiscord.javabot.systems.notification.NotificationService;
 import net.javadiscord.javabot.util.Constants;
 import net.javadiscord.javabot.data.config.GuildConfig;
 import net.javadiscord.javabot.data.config.guild.ServerLockConfig;
-import net.javadiscord.javabot.systems.notification.GuildNotificationService;
 import net.javadiscord.javabot.util.Responses;
 import net.javadiscord.javabot.util.TimeUtils;
 import org.jetbrains.annotations.NotNull;
@@ -193,7 +194,7 @@ private void rejectUserDuringRaid(@NotNull GuildMemberJoinEvent event) {
 				c.sendMessage(Constants.INVITE_URL).setEmbeds(buildServerLockEmbed(event.getGuild())).queue(msg ->
 						event.getMember().kick().queue()));
 		String diff = new TimeUtils().formatDurationToNow(event.getMember().getTimeCreated());
-		new GuildNotificationService(event.getGuild()).sendLogChannelNotification("**%s** (%s old) tried to join this server.", event.getMember().getUser().getAsTag(), diff);
+		NotificationService.withGuild(event.getGuild()).sendToModerationLog(c -> c.sendMessageFormat("**%s** (%s old) tried to join this server.", event.getMember().getUser().getAsTag(), diff));
 	}
 
 	/**
@@ -210,7 +211,7 @@ public void lockServer(Guild guild, @NotNull Collection<Member> potentialRaiders
 				c.sendMessage(Constants.INVITE_URL).setEmbeds(buildServerLockEmbed(guild)).queue(msg -> {
 					member.kick().queue(
 							success -> {},
-							error -> new GuildNotificationService(guild).sendLogChannelNotification("Could not kick member %s%n> `%s`", member.getUser().getAsTag(), error.getMessage()));
+							error -> NotificationService.withGuild(guild).sendToModerationLog(m -> m.sendMessageFormat("Could not kick member %s%n> `%s`", member.getUser().getAsTag(), error.getMessage())));
 				});
 			});
 		}
@@ -228,19 +229,19 @@ public void lockServer(Guild guild, @NotNull Collection<Member> potentialRaiders
 		GuildConfig config = Bot.getConfig().get(guild);
 		config.getServerLockConfig().setLocked("true");
 		Bot.getConfig().get(guild).flush();
-		GuildNotificationService notification = new GuildNotificationService(guild);
+		GuildNotificationService notification = NotificationService.withGuild(guild);
 		if (lockedBy == null) {
-			notification.sendLogChannelNotification("""
+			notification.sendToModerationLog(c -> c.sendMessageFormat("""
 							**Server Locked** %s
 							The automated locking system has detected that the following %d users may be part of a raid:
 							%s
 							""",
 					config.getModerationConfig().getStaffRole().getAsMention(),
 					potentialRaiders.size(),
 					membersString
-			);
+			));
 		} else {
-			notification.sendLogChannelNotification("Server locked by " + lockedBy.getAsMention());
+			notification.sendToModerationLog(c -> c.sendMessage("Server locked by " + lockedBy.getAsMention()));
 		}
 	}
 
@@ -255,11 +256,11 @@ public void unlockServer(Guild guild, @Nullable User unlockedby) {
 		config.setLocked("false");
 		Bot.getConfig().get(guild).flush();
 		guildMemberQueues.clear();
-		GuildNotificationService notification = new GuildNotificationService(guild);
+		GuildNotificationService notification = NotificationService.withGuild(guild);
 		if (unlockedby == null) {
-			notification.sendLogChannelNotification("Server unlocked automatically.");
+			notification.sendToModerationLog(c -> c.sendMessage("Server unlocked automatically."));
 		} else {
-			notification.sendLogChannelNotification("Server unlocked by " + unlockedby.getAsMention());
+			notification.sendToModerationLog(c -> c.sendMessage("Server unlocked by " + unlockedby.getAsMention()));
 		}
 	}
 }

src/main/java/net/javadiscord/javabot/systems/notification/GuildNotificationService.java

@@ -1,62 +1,50 @@
 package net.javadiscord.javabot.systems.notification;
 
+import lombok.AccessLevel;
+import lombok.RequiredArgsConstructor;
 import lombok.extern.slf4j.Slf4j;
 import net.dv8tion.jda.api.entities.Guild;
-import net.dv8tion.jda.api.entities.MessageEmbed;
+import net.dv8tion.jda.api.entities.MessageChannel;
+import net.dv8tion.jda.api.requests.restaction.MessageAction;
 import net.javadiscord.javabot.Bot;
-import net.javadiscord.javabot.data.config.GuildConfig;
+import org.jetbrains.annotations.NotNull;
+
+import java.util.function.Function;
 
 /**
- * Sends notifications within a single {@link Guild}.
+ * Handles all sorts of guild notifications.
  */
 @Slf4j
-public final class GuildNotificationService extends NotificationService {
+@RequiredArgsConstructor(access = AccessLevel.PACKAGE)
+public final class GuildNotificationService extends NotificationService.MessageChannelNotification {
 
 	private final Guild guild;
-	private final GuildConfig config;
-
-	public GuildNotificationService(Guild guild) {
-		this.guild = guild;
-		this.config = Bot.getConfig().get(guild);
-	}
-
-	/**
-	 * Sends a {@link MessageEmbed} to the Guild's log channel.
-	 *
-	 * @param embed The {@link MessageEmbed} to send.
-	 */
-	public void sendLogChannelNotification(MessageEmbed embed) {
-		if (config.getModerationConfig().getLogChannel() == null) {
-			log.warn("Could not find Log Channel for Guild {}", guild.getName());
-			return;
-		}
-		this.sendMessageChannelNotification(config.getModerationConfig().getLogChannel(), embed);
-	}
 
 	/**
-	 * Sends a simple Message to the Guild's log channel.
+	 * Sends a notification to the log channel.
 	 *
-	 * @param string The message that should be sent.
-	 * @param args Optional args for formatting.
+	 * @param function The {@link Function} to use which MUST return a {@link MessageAction}.
 	 */
-	public void sendLogChannelNotification(String string, Object... args) {
-		if (config.getModerationConfig().getLogChannel() == null) {
-			log.warn("Could not find Log Channel for Guild {}", guild.getName());
+	public void sendToModerationLog(@NotNull Function<MessageChannel, MessageAction> function) {
+		MessageChannel channel = Bot.getConfig().get(guild).getModerationConfig().getLogChannel();
+		if (channel == null) {
+			log.error("Could not send message to LogChannel in guild " + guild.getId());
 			return;
 		}
-		this.sendMessageChannelNotification(config.getModerationConfig().getLogChannel(), string, args);
+		send(channel, function);
 	}
 
 	/**
-	 * Sends a {@link MessageEmbed} to the Guild's message log channel.
+	 * Sends a notification to the message cache log channel.
 	 *
-	 * @param embed The {@link MessageEmbed} to send.
+	 * @param function The {@link Function} to use which MUST return a {@link MessageAction}.
 	 */
-	public void sendMessageLogChannelNotification(MessageEmbed embed) {
-		if (config.getMessageCacheConfig().getMessageCacheLogChannel() == null) {
-			log.warn("Could not find Message Log Channel for Guild {}", guild.getName());
+	public void sendToMessageLog(@NotNull Function<MessageChannel, MessageAction> function) {
+		MessageChannel channel = Bot.getConfig().get(guild).getMessageCacheConfig().getMessageCacheLogChannel();
+		if (channel == null) {
+			log.error("Could not find MessageCacheLogChannel in guild " + guild.getId());
 			return;
 		}
-		this.sendMessageChannelNotification(config.getMessageCacheConfig().getMessageCacheLogChannel(), embed);
+		send(channel, function);
 	}
 }

src/main/java/net/javadiscord/javabot/systems/notification/NotificationService.java

@@ -1,35 +1,59 @@
 package net.javadiscord.javabot.systems.notification;
 
 import lombok.extern.slf4j.Slf4j;
+import net.dv8tion.jda.api.entities.Guild;
 import net.dv8tion.jda.api.entities.MessageChannel;
-import net.dv8tion.jda.api.entities.MessageEmbed;
 import net.dv8tion.jda.api.entities.User;
+import net.dv8tion.jda.api.requests.restaction.MessageAction;
+import net.javadiscord.javabot.util.ExceptionLogger;
+import org.jetbrains.annotations.Contract;
+import org.jetbrains.annotations.NotNull;
 
+import java.util.function.Function;
 
 /**
- * Abstract class used for sending Notifications to Discord Users and Channels.
+ * Handles all types of guild & user notifications.
  */
-@Slf4j
-public abstract class NotificationService {
-	void sendDirectMessageNotification(User user, MessageEmbed message) {
-		user.openPrivateChannel().queue(
-				channel -> sendMessageChannelNotification(channel, message),
-				error -> log.warn("Could not send private Notification to User " + user.getAsTag())
-		);
+public final class NotificationService {
+	private NotificationService() {
 	}
 
-	void sendDirectMessageNotification(User user, String s, Object... args) {
-		user.openPrivateChannel().queue(
-				channel -> sendMessageChannelNotification(channel, s, args),
-				error -> log.warn("Could not send private Notification to User " + user.getAsTag())
-		);
+	@Contract("_ -> new")
+	public static @NotNull GuildNotificationService withGuild(Guild guild) {
+		return new GuildNotificationService(guild);
 	}
 
-	void sendMessageChannelNotification(MessageChannel channel, MessageEmbed message) {
-		channel.sendMessageEmbeds(message).queue(s -> {}, e -> log.warn("Could not send embed to channel " + channel.getName()));
+	@Contract("_ -> new")
+	public static @NotNull UserNotificationService withUser(User user) {
+		return new UserNotificationService(user);
 	}
 
-	void sendMessageChannelNotification(MessageChannel channel, String s, Object... args) {
-		channel.sendMessageFormat(s, args).queue(success -> {}, e -> log.warn("Could not send message to channel " + channel.getName()));
+	public static @NotNull QOTWGuildNotificationService withQOTW(Guild guild) {
+		return new QOTWGuildNotificationService(guild);
+	}
+
+	public static @NotNull QOTWNotificationService withQOTW(Guild guild, User user) {
+		return new QOTWNotificationService(user, guild);
+	}
+
+	/**
+	 * Abstract class which streamlines the logic of sending messages to a {@link MessageChannel}.
+	 */
+	@Slf4j
+	abstract static class MessageChannelNotification {
+		/**
+		 * Sends a single message to the specified {@link MessageChannel} using the
+		 * specified {@link Function}.
+		 *
+		 * @param channel  The target {@link MessageChannel}.
+		 * @param function The {@link Function} which is used in order to send the message.
+		 */
+		protected void send(MessageChannel channel, @NotNull Function<MessageChannel, MessageAction> function) {
+			function.apply(channel).queue(s -> {
+			}, err -> {
+				ExceptionLogger.capture(err, getClass().getSimpleName());
+				log.error("Could not send message to channel \" " + channel.getName() + "\": ", err);
+			});
+		}
 	}
 }