Merge pull request #264 from Java-Discord/dynxsty/improved_qotw_submissions

Improve QOTW Submission Handling & NotificationService

Author: jasonlessenich

src/main/java/net/javadiscord/javabot/command/InteractionHandler.java

@@ -28,6 +28,7 @@
 import net.javadiscord.javabot.command.interfaces.UserContextCommand;
 import net.javadiscord.javabot.systems.staff.custom_commands.dao.CustomCommandRepository;
 import net.javadiscord.javabot.systems.staff.custom_commands.model.CustomCommand;
+import net.javadiscord.javabot.systems.notification.GuildNotificationService;
 import net.javadiscord.javabot.util.GuildUtils;
 import org.jetbrains.annotations.NotNull;
 import org.slf4j.Logger;
@@ -146,13 +147,13 @@ private void handleResponseException(ResponseException e, CommandInteraction int
 			StringWriter sw = new StringWriter();
 			PrintWriter pw = new PrintWriter(sw);
 			e.getCause().printStackTrace(pw);
-			GuildUtils.getLogChannel(interaction.getGuild()).sendMessageFormat(
+			new GuildNotificationService(interaction.getGuild()).sendLogChannelNotification(
 					"An exception occurred when %s issued the **%s** command in %s:\n```%s```\n",
 					interaction.getUser().getAsMention(),
 					interaction.getName(),
 					interaction.getTextChannel().getAsMention(),
 					sw.toString()
-			).queue();
+			);
 		}
 	}
 

src/main/java/net/javadiscord/javabot/data/h2db/message_cache/MessageCache.java

@@ -11,7 +11,6 @@
 import net.javadiscord.javabot.data.h2db.message_cache.dao.MessageCacheRepository;
 import net.javadiscord.javabot.data.h2db.message_cache.model.CachedMessage;
 import net.javadiscord.javabot.systems.commands.IdCalculatorCommand;
-import net.javadiscord.javabot.util.GuildUtils;
 import net.javadiscord.javabot.util.TimeUtils;
 
 import java.io.ByteArrayInputStream;
@@ -90,7 +89,7 @@ public void cache(Message message) {
 	 */
 	public void sendUpdatedMessageToLog(Message updated, CachedMessage before) {
 		if (updated.getContentRaw().trim().equals(before.getMessageContent())) return;
-		MessageAction action = GuildUtils.getCacheLogChannel(updated.getGuild())
+		MessageAction action = Bot.config.get(updated.getGuild()).getMessageCache().getMessageCacheLogChannel()
 				.sendMessageEmbeds(this.buildMessageEditEmbed(updated.getGuild(), updated.getAuthor(), updated.getChannel(), before, updated))
 				.setActionRow(Button.link(updated.getJumpUrl(), "Jump to Message"));
 		if (before.getMessageContent().length() > MessageEmbed.VALUE_MAX_LENGTH || updated.getContentRaw().length() > MessageEmbed.VALUE_MAX_LENGTH) {
@@ -108,7 +107,7 @@ public void sendUpdatedMessageToLog(Message updated, CachedMessage before) {
 	 */
 	public void sendDeletedMessageToLog(Guild guild, MessageChannel channel, CachedMessage message) {
 		guild.getJDA().retrieveUserById(message.getAuthorId()).queue(author -> {
-			MessageAction action = GuildUtils.getCacheLogChannel(guild)
+			MessageAction action = Bot.config.get(guild).getMessageCache().getMessageCacheLogChannel()
 					.sendMessageEmbeds(this.buildMessageDeleteEmbed(guild, author, channel, message));
 			if (message.getMessageContent().length() > MessageEmbed.VALUE_MAX_LENGTH) {
 				action.addFile(this.buildDeletedMessageFile(author, message), message.getMessageId() + ".txt");

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

@@ -9,6 +9,7 @@
 import net.javadiscord.javabot.Constants;
 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.util.GuildUtils;
 
 import java.util.Comparator;
@@ -51,7 +52,7 @@ public void onReady(ReadyEvent event) {
 					helpConfig.getUpdateIntervalSeconds(),
 					TimeUnit.SECONDS
 			);
-			GuildUtils.getLogChannel(guild).sendMessage("I have just been booted up!").queue();
+			new GuildNotificationService(guild).sendLogChannelNotification("I have just been booted up!");
 		}
 	}
 }

src/main/java/net/javadiscord/javabot/systems/commands/LeaderboardCommand.java

@@ -65,7 +65,7 @@ public ReplyCallbackAction handleSlashCommandInteraction(SlashCommandInteraction
 	 * @param guild The current guild.
 	 * @return The QOTW-Rank as an integer.
 	 */
-	public int getQOTWRank(Member member, Guild guild) {
+	public static int getQOTWRank(Member member, Guild guild) {
 		try (var con = Bot.dataSource.getConnection()) {
 			var repo = new QuestionPointsRepository(con);
 			var accounts = repo.getAllAccountsSortedByPoints();

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.util.GuildUtils;
+import net.javadiscord.javabot.systems.notification.GuildNotificationService;
 
 import javax.annotation.Nonnull;
 import javax.net.ssl.HttpsURLConnection;
@@ -125,7 +125,7 @@ private void checkNewMessageAutomod(@Nonnull Message message) {
 	private void checkContentAutomod(@Nonnull Message message) {
 		//Check for Advertising Links
 		if (hasAdvertisingLink(message)) {
-			GuildUtils.getLogChannel(message.getGuild()).sendMessage("Message: `" + message.getContentRaw() + "`").queue();
+			new GuildNotificationService(message.getGuild()).sendLogChannelNotification("Message: `" + message.getContentRaw() + "`");
 			new ModerationService(message.getJDA(), Bot.config.get(message.getGuild()))
 					.warn(
 							message.getMember(),
@@ -143,7 +143,7 @@ private void checkContentAutomod(@Nonnull Message message) {
 
 		//Check for suspicious Links
 		if (hasSuspiciousLink(message)) {
-			GuildUtils.getLogChannel(message.getGuild()).sendMessage(String.format("Suspicious Link sent by: %s (`%s`)", message.getMember().getAsMention(), message)).queue();
+			new GuildNotificationService(message.getGuild()).sendLogChannelNotification("Suspicious Link sent by: %s (`%s`)", message.getMember().getAsMention(), message);
 			new ModerationService(message.getJDA(), Bot.config.get(message.getGuild()))
 					.warn(
 							message.getMember(),

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

@@ -10,7 +10,7 @@
 import net.dv8tion.jda.api.hooks.ListenerAdapter;
 import net.javadiscord.javabot.Bot;
 import net.javadiscord.javabot.Constants;
-import net.javadiscord.javabot.util.GuildUtils;
+import net.javadiscord.javabot.systems.notification.GuildNotificationService;
 import net.javadiscord.javabot.util.TimeUtils;
 import org.jetbrains.annotations.NotNull;
 
@@ -190,7 +190,7 @@ private void rejectUserDuringRaid(GuildMemberJoinEvent event) {
 			});
 		});
 		String diff = new TimeUtils().formatDurationToNow(event.getMember().getTimeCreated());
-		GuildUtils.getLogChannel(event.getGuild()).sendMessageFormat("**%s** (%s old) tried to join this server.", event.getMember().getUser().getAsTag(), diff).queue();
+		new GuildNotificationService(event.getGuild()).sendLogChannelNotification("**%s** (%s old) tried to join this server.", event.getMember().getUser().getAsTag(), diff);
 	}
 
 	/**
@@ -205,9 +205,8 @@ private void lockServer(Guild guild, Collection<Member> potentialRaiders) {
 			member.getUser().openPrivateChannel().queue(c -> {
 				c.sendMessage("https://discord.gg/java").setEmbeds(buildServerLockEmbed(guild)).queue(msg -> {
 					member.kick().queue(
-							success -> {
-							},
-							error -> GuildUtils.getLogChannel(guild).sendMessageFormat("Could not kick member %s%n> `%s`", member.getUser().getAsTag(), error.getMessage()).queue());
+							success -> {},
+							error -> new GuildNotificationService(guild).sendLogChannelNotification("Could not kick member %s%n> `%s`", member.getUser().getAsTag(), error.getMessage()));
 				});
 			});
 		}
@@ -225,15 +224,15 @@ private void lockServer(Guild guild, Collection<Member> potentialRaiders) {
 		var config = Bot.config.get(guild);
 		config.getServerLock().setLocked("true");
 		Bot.config.get(guild).flush();
-		GuildUtils.getLogChannel(guild).sendMessageFormat("""
+		new GuildNotificationService(guild).sendLogChannelNotification("""
 						**Server Locked** %s
 						The automated locking system has detected that the following %d users may be part of a raid:
 						%s
 						""",
 				config.getModeration().getStaffRole().getAsMention(),
 				potentialRaiders.size(),
 				membersString
-		).queue();
+		);
 	}
 
 	/**
@@ -245,6 +244,6 @@ private void unlockServer(Guild guild) {
 		var config = Bot.config.get(guild).getServerLock();
 		config.setLocked("false");
 		Bot.config.get(guild).flush();
-		GuildUtils.getLogChannel(guild).sendMessage("Server unlocked automatically.").queue();
+		new GuildNotificationService(guild).sendLogChannelNotification("Server unlocked automatically.");
 	}
 }

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

@@ -0,0 +1,76 @@
+package net.javadiscord.javabot.systems.notification;
+
+import lombok.extern.slf4j.Slf4j;
+import net.dv8tion.jda.api.entities.Guild;
+import net.dv8tion.jda.api.entities.MessageEmbed;
+import net.javadiscord.javabot.Bot;
+import net.javadiscord.javabot.data.config.GuildConfig;
+
+/**
+ * Sends notifications within a single {@link Guild}.
+ */
+@Slf4j
+public final class GuildNotificationService extends NotificationService {
+
+	private final Guild guild;
+	private final GuildConfig config;
+
+	public GuildNotificationService(Guild guild) {
+		this.guild = guild;
+		this.config = Bot.config.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.getModeration().getLogChannel() == null) {
+			log.warn("Could not find Log Channel for Guild {}", guild.getName());
+			return;
+		}
+		this.sendMessageChannelNotification(config.getModeration().getLogChannel(), embed);
+	}
+
+	/**
+	 * Sends a simple Message to the Guild's log channel.
+	 *
+	 * @param string The message that should be sent.
+	 * @param args Optional args for formatting.
+	 */
+	public void sendLogChannelNotification(String string, Object... args) {
+		if (config.getModeration().getLogChannel() == null) {
+			log.warn("Could not find Log Channel for Guild {}", guild.getName());
+			return;
+		}
+		this.sendMessageChannelNotification(config.getModeration().getLogChannel(), string, args);
+	}
+
+	/**
+	 * Sends a {@link MessageEmbed} to the Guild's message log channel.
+	 *
+	 * @param embed The {@link MessageEmbed} to send.
+	 */
+	public void sendMessageLogChannelNotification(MessageEmbed embed) {
+		if (config.getMessageCache().getMessageCacheLogChannel() == null) {
+			log.warn("Could not find Message Log Channel for Guild {}", guild.getName());
+			return;
+		}
+		this.sendMessageChannelNotification(config.getMessageCache().getMessageCacheLogChannel(), embed);
+	}
+
+	/**
+	 * Sends a simple Message to the Guild's message log channel.
+	 *
+	 * @param string The message that should be sent.
+	 * @param args Optional args for formatting.
+	 */
+	private void sendMessageLogChannelNotification(String string, Object... args) {
+		if (config.getMessageCache().getMessageCacheLogChannel() == null) {
+			log.warn("Could not find Message Log Channel for Guild {}", guild.getName());
+			return;
+		}
+		this.sendMessageChannelNotification(config.getMessageCache().getMessageCacheLogChannel(), string, args);
+	}
+}

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

@@ -0,0 +1,28 @@
+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 NotificationService {
+	void sendDirectMessageNotification(User user, MessageEmbed message) {
+		user.openPrivateChannel().queue(
+				channel -> channel.sendMessageEmbeds(message).queue(),
+				error -> log.warn("Could not send private Notification to User " + user.getAsTag())
+		);
+	}
+
+	void sendMessageChannelNotification(MessageChannel channel, MessageEmbed message) {
+		channel.sendMessageEmbeds(message).queue();
+	}
+
+	void sendMessageChannelNotification(MessageChannel channel, String s, Object... args) {
+		channel.sendMessageFormat(s, args).queue();
+	}
+}