Started work on refactoring the NotificationService

Author: jasonlessenich

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

@@ -10,7 +10,7 @@
  * Sends notifications within a single {@link Guild}.
  */
 @Slf4j
-public final class GuildNotificationService extends NotificationService {
+public final class GuildNotificationService extends NotificationServiceDEPRECATED {
 
 	private final Guild guild;
 	private final GuildConfig config;

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

@@ -1,35 +1,99 @@
 package net.javadiscord.javabot.systems.notification;
 
+import lombok.RequiredArgsConstructor;
 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.Bot;
+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() {}
+
+	@Contract("_ -> new")
+	public static @NotNull GuildNotificationService of(Guild guild) {
+		return new GuildNotificationService(guild);
+	}
+
+	@Contract("_ -> new")
+	public static @NotNull UserNotificationService of(User user) {
+		return new UserNotificationService(user);
 	}
 
-	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())
-		);
+	/**
+	 * Handles all sorts of guild notifications.
+	 */
+	@Slf4j
+	@RequiredArgsConstructor
+	public static final class GuildNotificationService extends MessageChannelNotification {
+		private final Guild guild;
+
+		/**
+		 * Sends a notification to the log channel.
+		 *
+		 * @param function The {@link Function} to use which MUST return a {@link MessageAction}.
+		 */
+		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;
+			}
+			send(channel, function);
+		}
+
+		/**
+		 * Sends a notification to the message cache log channel.
+		 *
+		 * @param function The {@link Function} to use which MUST return a {@link MessageAction}.
+		 */
+		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;
+			}
+			send(channel, function);
+		}
 	}
 
-	void sendMessageChannelNotification(MessageChannel channel, MessageEmbed message) {
-		channel.sendMessageEmbeds(message).queue(s -> {}, e -> log.warn("Could not send embed to channel " + channel.getName()));
+	/**
+	 * Handles all sorts of user notifications.
+	 */
+	@Slf4j
+	@RequiredArgsConstructor
+	public static final class UserNotificationService extends MessageChannelNotification {
+		private final User user;
+
+		/**
+		 * Sends a notification to a {@link User}s' {@link net.dv8tion.jda.api.entities.PrivateChannel}.
+		 *
+		 * @param function The {@link Function} to use which MUST return a {@link MessageAction}.
+		 */
+		public void sendDirectMessage(@NotNull Function<MessageChannel, MessageAction> function) {
+			user.openPrivateChannel().queue(
+					channel -> send(channel, function),
+					error -> log.error("Could not open PrivateChannel with user " + user.getAsTag(), error)
+			);
+		}
 	}
 
-	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()));
+	@Slf4j
+	private abstract static class MessageChannelNotification {
+		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);
+			});
+		}
 	}
 }

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

@@ -0,0 +1,35 @@
+package net.javadiscord.javabot.systems.notification;
+
+import lombok.extern.slf4j.Slf4j;
+import net.dv8tion.jda.api.entities.MessageChannel;
+import net.dv8tion.jda.api.entities.MessageEmbed;
+import net.dv8tion.jda.api.entities.User;
+
+
+/**
+ * Abstract class used for sending Notifications to Discord Users and Channels.
+ */
+@Slf4j
+public abstract class NotificationServiceDEPRECATED {
+	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())
+		);
+	}
+
+	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())
+		);
+	}
+
+	void sendMessageChannelNotification(MessageChannel channel, MessageEmbed message) {
+		channel.sendMessageEmbeds(message).queue(s -> {}, e -> log.warn("Could not send embed to channel " + channel.getName()));
+	}
+
+	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()));
+	}
+}

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

@@ -26,7 +26,7 @@
  * Sends Notifications regarding QOTW.
  */
 @Slf4j
-public final class QOTWNotificationService extends NotificationService {
+public final class QOTWNotificationService extends NotificationServiceDEPRECATED {
 
 	@Nullable
 	private final User user;

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

@@ -10,7 +10,7 @@
  */
 @Slf4j
 @RequiredArgsConstructor
-public final class UserNotificationService extends NotificationService {
+public final class UserNotificationService extends NotificationServiceDEPRECATED {
 	private final User user;
 
 	/**