Add pagination to /queue embeds

Author: TechnoVisionDev

src/main/java/technobot/commands/music/QueueCommand.java

@@ -5,17 +5,21 @@
 import net.dv8tion.jda.api.EmbedBuilder;
 import net.dv8tion.jda.api.entities.MessageEmbed;
 import net.dv8tion.jda.api.events.interaction.command.SlashCommandInteractionEvent;
+import net.dv8tion.jda.api.requests.restaction.interactions.ReplyCallbackAction;
 import org.jetbrains.annotations.NotNull;
 import technobot.TechnoBot;
 import technobot.commands.Category;
 import technobot.commands.Command;
 import technobot.data.GuildData;
 import technobot.handlers.MusicHandler;
+import technobot.listeners.ButtonListener;
 import technobot.listeners.MusicListener;
 import technobot.util.embeds.EmbedColor;
 import technobot.util.embeds.EmbedUtils;
 
-import java.util.ListIterator;
+import java.util.ArrayList;
+import java.util.LinkedList;
+import java.util.List;
 
 /**
  * Command that displays an embed to showcases the music queue.
@@ -24,6 +28,8 @@
  */
 public class QueueCommand extends Command {
 
+    public static final int SONGS_PER_PAGE = 7;
+
     public QueueCommand(TechnoBot bot) {
         super(bot);
         this.name = "queue";
@@ -41,28 +47,43 @@ public void execute(SlashCommandInteractionEvent event) {
             event.replyEmbeds(EmbedUtils.createDefault(text)).queue();
             return;
         }
-        // Create embed and send to channel
-        MessageEmbed embed = buildQueueEmbed(music.getQueue().listIterator(), music.getQueue().size());
-        event.replyEmbeds(embed).queue();
+        // Create embeds and send to channel
+        List<MessageEmbed> embeds = buildQueueEmbeds(music.getQueue(), music.getQueue().size());
+        ReplyCallbackAction action = event.replyEmbeds(embeds.get(0));
+        if (embeds.size() > 1) {
+            ButtonListener.sendPaginatedMenu(event.getUser().getId(), action, embeds);
+        } else {
+            action.queue();
+        }
     }
 
     /**
-     * Builds a beautiful embed out of a music queue.
+     * Builds a beautiful paginated embed out of the music queue.
      *
      * @param queue     Iterator of the music queue.
      * @param queueSize Number of elements in queue.
      * @return MessageEmbed of the music queue.
      */
-    private @NotNull MessageEmbed buildQueueEmbed(@NotNull ListIterator<AudioTrack> queue, int queueSize) {
+    private @NotNull List<MessageEmbed> buildQueueEmbeds(@NotNull LinkedList<AudioTrack> queue, int queueSize) {
         int count = 0;
-        long queueTime = 0;
         StringBuilder description = new StringBuilder();
+        List<MessageEmbed> embeds = new ArrayList<>();
+        EmbedBuilder embed = new EmbedBuilder()
+                .setColor(EmbedColor.DEFAULT.color)
+                .setTitle("Music Queue :musical_note:");
 
-        while (queue.hasNext()) {
-            AudioTrack track = queue.next();
-            AudioTrackInfo trackInfo = track.getInfo();
-            queueTime += trackInfo.length;
+        // Calculate total playlist length
+        long queueTime = 0;
+        for (AudioTrack track : queue) {
+            queueTime += track.getInfo().length;
+        }
+        String total = MusicListener.formatTrackLength(queueTime);
+        String song = "Song";
+        if (queueSize >= 3) { song += "s";}
+        String footer = queueSize > 1 ? String.format("**%s %s in Queue | %s Total Length**", queueSize - 1, song, total) : "";
 
+        for (AudioTrack track : queue) {
+            AudioTrackInfo trackInfo = track.getInfo();
             if (count == 0) { //Current playing track
                 description.append("__Now Playing:__\n");
                 description.append(String.format("[%s](%s) | ", trackInfo.title, trackInfo.uri));
@@ -75,25 +96,20 @@ public void execute(SlashCommandInteractionEvent event) {
             //Rest of the queue
             description.append(String.format("`%s.` [%s](%s) | ", count, trackInfo.title, trackInfo.uri));
             description.append(String.format("`%s`\n\n", MusicListener.formatTrackLength(trackInfo.length)));
-
-            //Footer information
-            if (count == 10 || count + 1 == queueSize) {
-                String total = MusicListener.formatTrackLength(queueTime);
-                String song = "Song";
-                if (queueSize >= 3) { // Make "Song" plural if necessary
-                    song += "s";
-                }
-                description.append(String.format("**%s %s in Queue | %s Total Length**", queueSize - 1, song, total));
-                break;
-            }
             count++;
+            if (count % SONGS_PER_PAGE == 0) {
+                // Add embed as new page
+                description.append(footer);
+                embed.setDescription(description.toString());
+                embeds.add(embed.build());
+                description = new StringBuilder();
+            }
         }
-
-        //Add to embed and send message
-        EmbedBuilder embed = new EmbedBuilder()
-                .setColor(EmbedColor.DEFAULT.color)
-                .setTitle("Music Queue :musical_note:")
-                .setDescription(description.toString());
-        return embed.build();
+        if (count % SONGS_PER_PAGE != 0) {
+            description.append(footer);
+            embed.setDescription(description.toString());
+            embeds.add(embed.build());
+        }
+        return embeds;
     }
 }