Rewrite starboard to use a queue on a timer instead

Author: Senither

build.gradle

@@ -1,7 +1,7 @@
 apply plugin: 'java'
 
 group 'com.avairebot'
-version '1.1'
+version '1.2'
 description 'Adds a starboard command to Ava, allowing servers to define a starboard channel'
 
 sourceCompatibility = 1.8

src/main/java/com/avairebot/starboard/EmoteEventListener.java

@@ -3,6 +3,11 @@
 import com.avairebot.Constants;
 import com.avairebot.database.collection.DataRow;
 import com.avairebot.plugin.JavaPlugin;
+import com.avairebot.scheduler.ScheduleHandler;
+import com.avairebot.starboard.command.StarboardCommand;
+import com.avairebot.starboard.handlers.EmoteEventListener;
+import com.avairebot.starboard.job.UpdateStarJob;
+import com.avairebot.starboard.migrations.SetupStarboardTableAndFieldMigration;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -13,8 +18,8 @@
 
 public class Starboard extends JavaPlugin {
 
-    static final Logger LOGGER = LoggerFactory.getLogger(Starboard.class);
-    static final String STARBOARD_TABLE = "starboard";
+    public static final Logger LOGGER = LoggerFactory.getLogger(Starboard.class);
+    public static final String STARBOARD_TABLE = "starboard";
 
     private final Map<String, String> starboardCache = new HashMap<>();
 
@@ -26,17 +31,19 @@ public void onEnable() {
         registerCommand(new StarboardCommand(this));
         registerEventListener(new EmoteEventListener(this));
         registerMigration(new SetupStarboardTableAndFieldMigration());
+
+        ScheduleHandler.registerJob(new UpdateStarJob(this));
     }
 
-    int getReactionRequirement() {
+    public int getReactionRequirement() {
         return getConfig().getInt("reaction-requirement", 3);
     }
 
-    boolean getIgnoreOwnMessages() {
+    public boolean getIgnoreOwnMessages() {
         return getConfig().getBoolean("ignore-own-messages", false);
     }
 
-    Color getColor(float percentage) {
+    public Color getColor(float percentage) {
         percentage = percentage > 1.0F ? 1.0F : percentage;
         percentage = percentage < 0.0F ? 0.05F : percentage;
 
@@ -49,7 +56,7 @@ Color getColor(float percentage) {
         );
     }
 
-    String getStarEmote(int stars) {
+    public String getStarEmote(int stars) {
         if (stars <= 5) {
             return "\u2B50";
         } else if (stars <= 10) {
@@ -60,7 +67,7 @@ String getStarEmote(int stars) {
         return "\u2728";
     }
 
-    String getStarboardValueFromGuild(String guildId) {
+    public String getStarboardValueFromGuild(String guildId) {
         if (starboardCache.containsKey(guildId)) {
             return starboardCache.get(guildId);
         }
@@ -86,7 +93,7 @@ String getStarboardValueFromGuild(String guildId) {
         return null;
     }
 
-    boolean updateStarboardDatabaseValue(String guildId, String value) {
+    public boolean updateStarboardDatabaseValue(String guildId, String value) {
         try {
             getDatabase().newQueryBuilder(Constants.GUILD_TABLE_NAME)
                     .where("id", guildId)

src/main/java/com/avairebot/starboard/Starboard.java

@@ -1,9 +1,10 @@
-package com.avairebot.starboard;
+package com.avairebot.starboard.command;
 
 import com.avairebot.commands.Category;
 import com.avairebot.commands.CategoryHandler;
 import com.avairebot.commands.CommandMessage;
 import com.avairebot.contracts.commands.Command;
+import com.avairebot.starboard.Starboard;
 import com.avairebot.utilities.ComparatorUtil;
 import com.avairebot.utilities.MentionableUtil;
 import net.dv8tion.jda.core.entities.Channel;
@@ -17,7 +18,7 @@ public class StarboardCommand extends Command {
 
     private final Starboard starboard;
 
-    StarboardCommand(Starboard starboard) {
+    public StarboardCommand(Starboard starboard) {
         super(starboard, false);
 
         this.starboard = starboard;
@@ -30,7 +31,7 @@ public String getName() {
 
     @Override
     public String getDescription() {
-        return "Sets test";
+        return "Can be used to see the current starboard channel, if an channel is mentioned, the mentioned channel will be set to the new starboard channel.";
     }
 
     @Override

…vairebot/starboard/StarboardCommand.java …/starboard/command/StarboardCommand.javasrc/main/java/com/avairebot/starboard/StarboardCommand.java renamed to src/main/java/com/avairebot/starboard/command/StarboardCommand.java src/main/java/com/avairebot/starboard/StarboardCommand.java renamed to src/main/java/com/avairebot/starboard/command/StarboardCommand.java

@@ -0,0 +1,65 @@
+package com.avairebot.starboard.handlers;
+
+import com.avairebot.contracts.handlers.EventListener;
+import com.avairebot.starboard.Starboard;
+import com.avairebot.utilities.RestActionUtil;
+import net.dv8tion.jda.core.entities.Member;
+import net.dv8tion.jda.core.entities.MessageReaction;
+import net.dv8tion.jda.core.entities.TextChannel;
+import net.dv8tion.jda.core.events.message.guild.react.GuildMessageReactionAddEvent;
+import net.dv8tion.jda.core.events.message.guild.react.GuildMessageReactionRemoveEvent;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.util.HashMap;
+import java.util.Map;
+
+public class EmoteEventListener extends EventListener {
+
+    public static final Map<Long, StarReaction> queue = new HashMap<>();
+
+    private static final Logger LOGGER = LoggerFactory.getLogger(EmoteEventListener.class);
+
+    private final Starboard starboard;
+
+    public EmoteEventListener(Starboard starboard) {
+        this.starboard = starboard;
+    }
+
+    @Override
+    public void onGuildMessageReactionAdd(GuildMessageReactionAddEvent event) {
+        if (!event.getReactionEmote().getName().equals("\u2B50")) {
+            return;
+        }
+        handleStarEvent(event.getReaction(), event.getMember(), event.getMessageIdLong());
+    }
+
+    @Override
+    public void onGuildMessageReactionRemove(GuildMessageReactionRemoveEvent event) {
+        if (!event.getReactionEmote().getName().equals("\u2B50")) {
+            return;
+        }
+        handleStarEvent(event.getReaction(), event.getMember(), event.getMessageIdLong());
+    }
+
+    private void handleStarEvent(MessageReaction messageReaction, Member member, long messageId) {
+        String starboardChannelId = starboard.getStarboardValueFromGuild(messageReaction.getGuild().getId());
+        if (starboardChannelId == null || starboardChannelId.trim().length() == 0) {
+            return;
+        }
+
+        TextChannel starboardChannel = messageReaction.getGuild().getTextChannelById(starboardChannelId);
+        if (starboardChannel == null) {
+            LOGGER.warn("A starboard channel ID has been not, but no channel was found with the set ID {0}, maybe a mistake?", starboardChannelId);
+            return;
+        }
+
+        messageReaction.getTextChannel().getMessageById(messageId).queue(message -> {
+            if (starboard.getIgnoreOwnMessages() && message.getAuthor().getIdLong() == member.getUser().getIdLong()) {
+                return;
+            }
+
+            queue.put(messageId, new StarReaction(message, starboardChannel));
+        }, RestActionUtil.IGNORE);
+    }
+}

src/main/java/com/avairebot/starboard/handlers/EmoteEventListener.java

@@ -0,0 +1,23 @@
+package com.avairebot.starboard.handlers;
+
+import net.dv8tion.jda.core.entities.Message;
+import net.dv8tion.jda.core.entities.TextChannel;
+
+public class StarReaction {
+
+    private final TextChannel starboardChannel;
+    private final Message message;
+
+    StarReaction(Message message, TextChannel starboardChannel) {
+        this.message = message;
+        this.starboardChannel = starboardChannel;
+    }
+
+    public Message getMessage() {
+        return message;
+    }
+
+    public TextChannel getStarboardChannel() {
+        return starboardChannel;
+    }
+}