From 194ad2568d899bd679bcb0b7840c9a9e1ce97ccc Mon Sep 17 00:00:00 2001 From: Salmonllama Date: Fri, 27 Nov 2020 11:45:40 -0500 Subject: [PATCH] Code cleaning, proper logging, remove useless classes --- src/main/java/dev/salmonllama/fsbot/Main.java | 3 +- .../commands/developer/InviteCommand.java | 2 - .../fsbot/commands/general/OutfitCommand.java | 8 -- .../commands/staff/ForceDeleteCommand.java | 2 +- .../commands/staff/SetStatusCommand.java | 2 - .../controllers/UserBlacklistController.java | 1 - .../database/models/StaticPermission.java | 1 - .../fsbot/database/models/UserBlacklist.java | 1 + .../scapefashion/ScapeFashionConnection.java | 5 +- .../exceptions/FailedUploadException.java | 1 + .../exceptions/UnknownParameterException.java | 1 + .../dev/salmonllama/fsbot/guthix/Guthix.java | 5 ++ .../ForceDeleteAttachedListener.java | 1 + .../fsbot/listeners/ServerJoined.java | 7 -- .../dev/salmonllama/fsbot/logging/Logger.java | 79 ------------------- .../fsbot/logging/ResponseType.java | 21 ----- .../fsbot/logging/StandardEmbed.java | 14 ---- .../fsbot/utilities/DiscordUtilities.java | 1 - .../exceptions/DiscordException.java | 23 ------ .../exceptions/OutfitNotFoundException.java | 1 + .../exceptions/TagNotFoundException.java | 2 + .../fsbot/utilities/warnings/Warning.java | 2 +- 22 files changed, 17 insertions(+), 166 deletions(-) delete mode 100644 src/main/java/dev/salmonllama/fsbot/logging/Logger.java delete mode 100644 src/main/java/dev/salmonllama/fsbot/logging/ResponseType.java delete mode 100644 src/main/java/dev/salmonllama/fsbot/logging/StandardEmbed.java delete mode 100644 src/main/java/dev/salmonllama/fsbot/utilities/exceptions/DiscordException.java diff --git a/src/main/java/dev/salmonllama/fsbot/Main.java b/src/main/java/dev/salmonllama/fsbot/Main.java index 482f7e2..a6a3494 100644 --- a/src/main/java/dev/salmonllama/fsbot/Main.java +++ b/src/main/java/dev/salmonllama/fsbot/Main.java @@ -34,12 +34,13 @@ public class Main { new DiscordApiBuilder().setToken(BotConfig.TOKEN).login().thenAccept(api -> { + @SuppressWarnings("unused") Guthix guthix = new Guthix(api); // Register listeners api.addMessageCreateListener(new ImageListener()); api.addServerMemberJoinListener(new NewMemberListener()); - api.addServerJoinListener(new ServerJoined(api)); + api.addServerJoinListener(new ServerJoined()); api.addMessageCreateListener(new ThumbsListener()); api.addMessageCreateListener(new AchievementListener()); api.addMessageCreateListener(new ReportListener()); diff --git a/src/main/java/dev/salmonllama/fsbot/commands/developer/InviteCommand.java b/src/main/java/dev/salmonllama/fsbot/commands/developer/InviteCommand.java index 01ca801..30946ed 100644 --- a/src/main/java/dev/salmonllama/fsbot/commands/developer/InviteCommand.java +++ b/src/main/java/dev/salmonllama/fsbot/commands/developer/InviteCommand.java @@ -9,9 +9,7 @@ import dev.salmonllama.fsbot.guthix.*; import org.javacord.api.DiscordApi; import org.javacord.api.entity.channel.TextChannel; -import java.util.ArrayList; import java.util.Arrays; -import java.util.Collection; import java.util.List; public class InviteCommand extends Command { diff --git a/src/main/java/dev/salmonllama/fsbot/commands/general/OutfitCommand.java b/src/main/java/dev/salmonllama/fsbot/commands/general/OutfitCommand.java index ce5dc62..e530526 100644 --- a/src/main/java/dev/salmonllama/fsbot/commands/general/OutfitCommand.java +++ b/src/main/java/dev/salmonllama/fsbot/commands/general/OutfitCommand.java @@ -6,9 +6,7 @@ package dev.salmonllama.fsbot.commands.general; import dev.salmonllama.fsbot.database.controllers.OutfitController; -import dev.salmonllama.fsbot.database.models.Outfit; import dev.salmonllama.fsbot.guthix.*; -import org.javacord.api.entity.message.Message; import org.javacord.api.entity.message.embed.EmbedBuilder; import org.javacord.api.util.logging.ExceptionLogger; @@ -16,7 +14,6 @@ import java.util.ArrayList; import java.util.Arrays; import java.util.Collection; import java.util.List; -import java.util.concurrent.CompletableFuture; public class OutfitCommand extends Command { private final int MAX_OUTFITS = 5; @@ -211,9 +208,4 @@ public class OutfitCommand extends Command { } return true; } - - private CompletableFuture sendOutfit(Outfit outfit) { - // TODO: Replace sending with this - return null; - } } diff --git a/src/main/java/dev/salmonllama/fsbot/commands/staff/ForceDeleteCommand.java b/src/main/java/dev/salmonllama/fsbot/commands/staff/ForceDeleteCommand.java index 78e5166..19cfd2d 100644 --- a/src/main/java/dev/salmonllama/fsbot/commands/staff/ForceDeleteCommand.java +++ b/src/main/java/dev/salmonllama/fsbot/commands/staff/ForceDeleteCommand.java @@ -10,7 +10,7 @@ import dev.salmonllama.fsbot.guthix.*; import dev.salmonllama.fsbot.listeners.ForceDeleteAttachedListener; import org.javacord.api.entity.message.MessageBuilder; import org.javacord.api.entity.message.embed.EmbedBuilder; -import org.javacord.api.event.message.MessageCreateEvent; + import java.util.Arrays; import java.util.List; diff --git a/src/main/java/dev/salmonllama/fsbot/commands/staff/SetStatusCommand.java b/src/main/java/dev/salmonllama/fsbot/commands/staff/SetStatusCommand.java index 7199d10..c065247 100644 --- a/src/main/java/dev/salmonllama/fsbot/commands/staff/SetStatusCommand.java +++ b/src/main/java/dev/salmonllama/fsbot/commands/staff/SetStatusCommand.java @@ -10,9 +10,7 @@ import dev.salmonllama.fsbot.guthix.*; import org.javacord.api.entity.message.embed.EmbedBuilder; import java.awt.*; -import java.util.ArrayList; import java.util.Arrays; -import java.util.Collection; import java.util.List; public class SetStatusCommand extends Command { diff --git a/src/main/java/dev/salmonllama/fsbot/database/controllers/UserBlacklistController.java b/src/main/java/dev/salmonllama/fsbot/database/controllers/UserBlacklistController.java index cfc67d2..e19dac0 100644 --- a/src/main/java/dev/salmonllama/fsbot/database/controllers/UserBlacklistController.java +++ b/src/main/java/dev/salmonllama/fsbot/database/controllers/UserBlacklistController.java @@ -6,7 +6,6 @@ package dev.salmonllama.fsbot.database.controllers; import dev.salmonllama.fsbot.database.FSDB; -import dev.salmonllama.fsbot.database.models.ServerBlacklist; import dev.salmonllama.fsbot.database.models.UserBlacklist; import java.sql.ResultSet; diff --git a/src/main/java/dev/salmonllama/fsbot/database/models/StaticPermission.java b/src/main/java/dev/salmonllama/fsbot/database/models/StaticPermission.java index 273f44a..2ece1f1 100644 --- a/src/main/java/dev/salmonllama/fsbot/database/models/StaticPermission.java +++ b/src/main/java/dev/salmonllama/fsbot/database/models/StaticPermission.java @@ -8,7 +8,6 @@ package dev.salmonllama.fsbot.database.models; import dev.salmonllama.fsbot.database.DatabaseModel; import java.sql.Timestamp; -import java.time.Instant; public class StaticPermission extends DatabaseModel { private String userId; diff --git a/src/main/java/dev/salmonllama/fsbot/database/models/UserBlacklist.java b/src/main/java/dev/salmonllama/fsbot/database/models/UserBlacklist.java index 0233fd6..9395424 100644 --- a/src/main/java/dev/salmonllama/fsbot/database/models/UserBlacklist.java +++ b/src/main/java/dev/salmonllama/fsbot/database/models/UserBlacklist.java @@ -17,6 +17,7 @@ public class UserBlacklist extends DatabaseModel { private UserBlacklist(Builder builder) { this.id = builder.id; this.reason = builder.reason; + this.added = builder.added; } public String getId() { diff --git a/src/main/java/dev/salmonllama/fsbot/endpoints/scapefashion/ScapeFashionConnection.java b/src/main/java/dev/salmonllama/fsbot/endpoints/scapefashion/ScapeFashionConnection.java index 19ce43a..fb2bcd6 100644 --- a/src/main/java/dev/salmonllama/fsbot/endpoints/scapefashion/ScapeFashionConnection.java +++ b/src/main/java/dev/salmonllama/fsbot/endpoints/scapefashion/ScapeFashionConnection.java @@ -6,8 +6,6 @@ package dev.salmonllama.fsbot.endpoints.scapefashion; import com.google.gson.Gson; -import org.slf4j.Logger; -import org.slf4j.LoggerFactory; import java.io.UnsupportedEncodingException; import java.net.URI; @@ -18,14 +16,13 @@ import java.net.http.HttpResponse; import java.nio.charset.StandardCharsets; public class ScapeFashionConnection { + // TODO: Refactor this for request-response based interactions private final String RS3_REQUEST_URL = "https://api.rune.scape.fashion"; private final String RS3_LINK_URL = "https://rune.scape.fashion"; private final String OSRS_REQUEST_URL = "https://api.scape.fashion"; private final String OSRS_LINK_URL = "https://scape.fashion"; - private static final Logger logger = LoggerFactory.getLogger(ScapeFashionConnection.class); - public ScapeFashionConnection() {} // Uses the color endpoint to search for items diff --git a/src/main/java/dev/salmonllama/fsbot/exceptions/FailedUploadException.java b/src/main/java/dev/salmonllama/fsbot/exceptions/FailedUploadException.java index b496191..8600cf6 100644 --- a/src/main/java/dev/salmonllama/fsbot/exceptions/FailedUploadException.java +++ b/src/main/java/dev/salmonllama/fsbot/exceptions/FailedUploadException.java @@ -6,6 +6,7 @@ package dev.salmonllama.fsbot.exceptions; public class FailedUploadException extends Exception { + private static final long serialVersionUID = 1L; private String message; public FailedUploadException(String imageLink) { diff --git a/src/main/java/dev/salmonllama/fsbot/exceptions/UnknownParameterException.java b/src/main/java/dev/salmonllama/fsbot/exceptions/UnknownParameterException.java index 9972698..6ebc976 100644 --- a/src/main/java/dev/salmonllama/fsbot/exceptions/UnknownParameterException.java +++ b/src/main/java/dev/salmonllama/fsbot/exceptions/UnknownParameterException.java @@ -8,6 +8,7 @@ package dev.salmonllama.fsbot.exceptions; import java.sql.SQLException; public class UnknownParameterException extends SQLException { + private static final long serialVersionUID = 1L; private String message; public UnknownParameterException(Object param) { diff --git a/src/main/java/dev/salmonllama/fsbot/guthix/Guthix.java b/src/main/java/dev/salmonllama/fsbot/guthix/Guthix.java index 91a2836..835e65d 100644 --- a/src/main/java/dev/salmonllama/fsbot/guthix/Guthix.java +++ b/src/main/java/dev/salmonllama/fsbot/guthix/Guthix.java @@ -45,6 +45,8 @@ public class Guthix implements MessageCreateListener { } public void initCommands() { + logger.info("Initializing commands..."); + // Developer Commands addCommand(new TestCommand()); addCommand(new CreateGalleryCommand()); @@ -98,6 +100,8 @@ public class Guthix implements MessageCreateListener { addCommand(new Rs3MainhandCommand()); addCommand(new Rs3OffhandCommand()); addCommand(new Rs3TwohandedCommand()); + + logger.info("Command initialization complete!"); } public void addCommand(Command cmd) { @@ -159,5 +163,6 @@ public class Guthix implements MessageCreateListener { } cmd.invoke(ctx); + logger.info(String.format("Processed command from %s.", author.getDiscriminatedName())); } } diff --git a/src/main/java/dev/salmonllama/fsbot/listeners/ForceDeleteAttachedListener.java b/src/main/java/dev/salmonllama/fsbot/listeners/ForceDeleteAttachedListener.java index 42d2fe9..e6f50d3 100644 --- a/src/main/java/dev/salmonllama/fsbot/listeners/ForceDeleteAttachedListener.java +++ b/src/main/java/dev/salmonllama/fsbot/listeners/ForceDeleteAttachedListener.java @@ -11,6 +11,7 @@ import org.javacord.api.listener.message.MessageCreateListener; public class ForceDeleteAttachedListener implements MessageCreateListener { + @SuppressWarnings("unused") private CommandContext ctx; public ForceDeleteAttachedListener(CommandContext ctx) { diff --git a/src/main/java/dev/salmonllama/fsbot/listeners/ServerJoined.java b/src/main/java/dev/salmonllama/fsbot/listeners/ServerJoined.java index 5f47903..54efc79 100644 --- a/src/main/java/dev/salmonllama/fsbot/listeners/ServerJoined.java +++ b/src/main/java/dev/salmonllama/fsbot/listeners/ServerJoined.java @@ -5,18 +5,11 @@ package dev.salmonllama.fsbot.listeners; -import org.javacord.api.DiscordApi; import org.javacord.api.event.server.ServerJoinEvent; import org.javacord.api.listener.server.ServerJoinListener; public class ServerJoined implements ServerJoinListener { - private DiscordApi api; - - public ServerJoined(DiscordApi api) { - this.api = api; - } - public void onServerJoin(ServerJoinEvent event) { // TODO: This needs fixing yo // db.newServerProcess(event.getServer()); diff --git a/src/main/java/dev/salmonllama/fsbot/logging/Logger.java b/src/main/java/dev/salmonllama/fsbot/logging/Logger.java deleted file mode 100644 index c48d982..0000000 --- a/src/main/java/dev/salmonllama/fsbot/logging/Logger.java +++ /dev/null @@ -1,79 +0,0 @@ -/* - * Copyright (c) 2020. Aleksei Gryczewski - * All rights reserved. - */ - -package dev.salmonllama.fsbot.logging; - -import dev.salmonllama.fsbot.config.BotConfig; -import org.javacord.api.DiscordApi; -import org.javacord.api.entity.message.embed.EmbedBuilder; - -import java.util.function.Function; - -public class Logger { - - private final DiscordApi api; - - private final String OUTFIT_LOG = BotConfig.OUTFIT_LOG; - private final String REPORT_LOG = BotConfig.REPORT_LOG; - private final String JOIN_LOG = BotConfig.JOIN_LOG; - private final String ACTIVITY_LOG = BotConfig.ACTIVITY_LOG; - private final String SALMONLLAMA = BotConfig.BOT_OWNER; - - private EmbedBuilder reportEmbed; - - private EmbedBuilder errorEmbed; - - public Logger(DiscordApi api) { - this.api = api; - } - - public void logOutfit() { - api.getServerTextChannelById(OUTFIT_LOG).ifPresentOrElse(channel -> { - // Log the thing - channel.sendMessage("outfit"); - }, () -> { - // DM me - api.getUserById(SALMONLLAMA).thenAcceptAsync(user -> { - user.sendMessage("Outfit log failed and was not found"); - }); - }); - } - - public void logReport() { - api.getServerTextChannelById(REPORT_LOG).ifPresentOrElse(channel -> { - // Log the thing - channel.sendMessage("report"); - }, () -> { - // DM me - api.getUserById(SALMONLLAMA).thenAcceptAsync(user -> { - user.sendMessage("Report log failed and was not found"); - }); - }); - } - - public void logError(String errorMsg) { - api.getServerTextChannelById(ACTIVITY_LOG).ifPresentOrElse(channel -> { - // Log the thing - channel.sendMessage("error"); - }, () -> { - // DM me - api.getUserById(SALMONLLAMA).thenAcceptAsync(user -> { - user.sendMessage("Error log failed and was not found"); - }); - }); - } - - public void logMovement() { - api.getServerTextChannelById(JOIN_LOG).ifPresentOrElse(channel -> { - // Log the thing - channel.sendMessage("User joined/Left"); - }, () -> { - // DM me - api.getUserById(SALMONLLAMA).thenAcceptAsync(user -> { - user.sendMessage("Movement log failed and was not found"); - }); - }); - } -} diff --git a/src/main/java/dev/salmonllama/fsbot/logging/ResponseType.java b/src/main/java/dev/salmonllama/fsbot/logging/ResponseType.java deleted file mode 100644 index c5d381f..0000000 --- a/src/main/java/dev/salmonllama/fsbot/logging/ResponseType.java +++ /dev/null @@ -1,21 +0,0 @@ -/* - * Copyright (c) 2020. Aleksei Gryczewski - * All rights reserved. - */ - -package dev.salmonllama.fsbot.logging; - -import java.awt.*; - -public enum ResponseType { - ERROR (Color.RED, "Error"), - WARN (Color.YELLOW, "Warning"), - INFO (Color.BLUE, "Info"), - LOG (Color.GRAY, "Log"); - - private Color color; - private String title; - ResponseType(Color color, String title) { - - } -} diff --git a/src/main/java/dev/salmonllama/fsbot/logging/StandardEmbed.java b/src/main/java/dev/salmonllama/fsbot/logging/StandardEmbed.java deleted file mode 100644 index f15c5a9..0000000 --- a/src/main/java/dev/salmonllama/fsbot/logging/StandardEmbed.java +++ /dev/null @@ -1,14 +0,0 @@ -/* - * Copyright (c) 2020. Aleksei Gryczewski - * All rights reserved. - */ - -package dev.salmonllama.fsbot.logging; - -import org.javacord.api.entity.message.embed.EmbedBuilder; - -public class StandardEmbed extends EmbedBuilder { - public StandardEmbed() { - super(); - } -} diff --git a/src/main/java/dev/salmonllama/fsbot/utilities/DiscordUtilities.java b/src/main/java/dev/salmonllama/fsbot/utilities/DiscordUtilities.java index 770c72b..13c6ebd 100644 --- a/src/main/java/dev/salmonllama/fsbot/utilities/DiscordUtilities.java +++ b/src/main/java/dev/salmonllama/fsbot/utilities/DiscordUtilities.java @@ -10,7 +10,6 @@ import dev.salmonllama.fsbot.guthix.CommandContext; import org.javacord.api.entity.message.embed.EmbedBuilder; import java.awt.*; -import java.util.Arrays; public class DiscordUtilities { public static void handleException(Exception e, CommandContext ctx) { diff --git a/src/main/java/dev/salmonllama/fsbot/utilities/exceptions/DiscordException.java b/src/main/java/dev/salmonllama/fsbot/utilities/exceptions/DiscordException.java deleted file mode 100644 index 745bce3..0000000 --- a/src/main/java/dev/salmonllama/fsbot/utilities/exceptions/DiscordException.java +++ /dev/null @@ -1,23 +0,0 @@ -/* - * Copyright (c) 2020. Aleksei Gryczewski - * All rights reserved. - */ - -package dev.salmonllama.fsbot.utilities.exceptions; - -import java.awt.*; - -public class DiscordException { - - private Color color; - private String message; - private String footer; - private String title; - - DiscordException(String title, String message, String footer, Color color) { - this.title = title; - this.message = message; - this.footer = footer; - this.color = color; - } -} diff --git a/src/main/java/dev/salmonllama/fsbot/utilities/exceptions/OutfitNotFoundException.java b/src/main/java/dev/salmonllama/fsbot/utilities/exceptions/OutfitNotFoundException.java index 7253e95..71375e5 100644 --- a/src/main/java/dev/salmonllama/fsbot/utilities/exceptions/OutfitNotFoundException.java +++ b/src/main/java/dev/salmonllama/fsbot/utilities/exceptions/OutfitNotFoundException.java @@ -6,6 +6,7 @@ package dev.salmonllama.fsbot.utilities.exceptions; public class OutfitNotFoundException extends Exception { + private static final long serialVersionUID = 1L; @Override public String getMessage() { diff --git a/src/main/java/dev/salmonllama/fsbot/utilities/exceptions/TagNotFoundException.java b/src/main/java/dev/salmonllama/fsbot/utilities/exceptions/TagNotFoundException.java index f455c40..5160c5e 100644 --- a/src/main/java/dev/salmonllama/fsbot/utilities/exceptions/TagNotFoundException.java +++ b/src/main/java/dev/salmonllama/fsbot/utilities/exceptions/TagNotFoundException.java @@ -7,6 +7,8 @@ package dev.salmonllama.fsbot.utilities.exceptions; public class TagNotFoundException extends Exception { + private static final long serialVersionUID = 1L; + @Override public String getMessage() { return "That tag was not found, check your spelling and try again."; diff --git a/src/main/java/dev/salmonllama/fsbot/utilities/warnings/Warning.java b/src/main/java/dev/salmonllama/fsbot/utilities/warnings/Warning.java index 6ca4c39..e7a093c 100644 --- a/src/main/java/dev/salmonllama/fsbot/utilities/warnings/Warning.java +++ b/src/main/java/dev/salmonllama/fsbot/utilities/warnings/Warning.java @@ -20,7 +20,7 @@ public class Warning { public EmbedBuilder sendWarning() { EmbedBuilder warning = new EmbedBuilder() - .setColor(Color.YELLOW) + .setColor(embedColor) .setFooter(embedFooter) .addField("WARNING", embedWarning);