Implement trivia welcome screen with category picker

src/main/java/wtf/beatrice/hidekobot/HidekoBot.java

@@ -11,10 +11,7 @@ import wtf.beatrice.hidekobot.commands.slash.*;
 import wtf.beatrice.hidekobot.datasources.ConfigurationSource;
 import wtf.beatrice.hidekobot.datasources.DatabaseSource;
 import wtf.beatrice.hidekobot.datasources.PropertiesSource;
-import wtf.beatrice.hidekobot.listeners.ButtonInteractionListener;
+import wtf.beatrice.hidekobot.listeners.*;
-import wtf.beatrice.hidekobot.listeners.MessageCommandListener;
-import wtf.beatrice.hidekobot.listeners.SlashCommandCompletionListener;
-import wtf.beatrice.hidekobot.listeners.SlashCommandListener;
 import wtf.beatrice.hidekobot.runnables.ExpiredMessageTask;
 import wtf.beatrice.hidekobot.runnables.HeartBeatTask;
 import wtf.beatrice.hidekobot.runnables.RandomSeedTask;
@@ -154,6 +151,7 @@ public class HidekoBot
         jda.addEventListener(slashCommandListener);
         jda.addEventListener(slashCommandCompletionListener);
         jda.addEventListener(new ButtonInteractionListener());
+        jda.addEventListener(new SelectMenuInteractionListener());
 
         // update slash commands (delayed)
         final boolean finalForceUpdateCommands = forceUpdateCommands;

src/main/java/wtf/beatrice/hidekobot/commands/base/DiceRoll.java

@@ -3,7 +3,7 @@ package wtf.beatrice.hidekobot.commands.base;
 import net.dv8tion.jda.api.EmbedBuilder;
 import net.dv8tion.jda.api.entities.User;
 import wtf.beatrice.hidekobot.Cache;
-import wtf.beatrice.hidekobot.objects.Dice;
+import wtf.beatrice.hidekobot.objects.fun.Dice;
 import wtf.beatrice.hidekobot.objects.MessageResponse;
 
 import java.util.LinkedHashMap;

src/main/java/wtf/beatrice/hidekobot/commands/message/DiceRollCommand.java

@@ -1,13 +1,10 @@
 package wtf.beatrice.hidekobot.commands.message;
 
-import net.dv8tion.jda.api.EmbedBuilder;
 import net.dv8tion.jda.api.Permission;
 import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
-import wtf.beatrice.hidekobot.Cache;
 import wtf.beatrice.hidekobot.commands.base.DiceRoll;
-import wtf.beatrice.hidekobot.objects.Dice;
 import wtf.beatrice.hidekobot.objects.MessageResponse;
 import wtf.beatrice.hidekobot.objects.commands.CommandCategory;
 import wtf.beatrice.hidekobot.objects.commands.MessageCommand;

src/main/java/wtf/beatrice/hidekobot/commands/message/TriviaCommand.java

@@ -1,21 +1,25 @@
 package wtf.beatrice.hidekobot.commands.message;
 
+import net.dv8tion.jda.api.EmbedBuilder;
 import net.dv8tion.jda.api.Permission;
 import net.dv8tion.jda.api.entities.Message;
 import net.dv8tion.jda.api.entities.channel.concrete.TextChannel;
 import net.dv8tion.jda.api.entities.channel.middleman.MessageChannel;
 import net.dv8tion.jda.api.events.message.MessageReceivedEvent;
+import net.dv8tion.jda.api.interactions.components.selections.SelectMenu;
+import net.dv8tion.jda.api.interactions.components.selections.StringSelectMenu;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
+import org.json.JSONObject;
 import wtf.beatrice.hidekobot.Cache;
 import wtf.beatrice.hidekobot.objects.commands.CommandCategory;
 import wtf.beatrice.hidekobot.objects.commands.MessageCommand;
+import wtf.beatrice.hidekobot.objects.comparators.TriviaCategoryComparator;
+import wtf.beatrice.hidekobot.objects.fun.TriviaCategory;
 import wtf.beatrice.hidekobot.runnables.TriviaTask;
 import wtf.beatrice.hidekobot.util.TriviaUtil;
 
-import java.util.Collections;
+import java.util.*;
-import java.util.LinkedList;
-import java.util.List;
 import java.util.concurrent.ScheduledFuture;
 import java.util.concurrent.TimeUnit;
 
@@ -75,21 +79,41 @@ public class TriviaCommand implements MessageCommand
             Message err = event.getMessage().reply("Trivia is already running here!").complete();
             Cache.getTaskScheduler().schedule(() -> err.delete().queue(), 10, TimeUnit.SECONDS);
             return;
-        } else {
-            // todo nicer looking
-            event.getMessage().reply("Starting new Trivia session!").queue();
         }
 
+        // todo null checks
+        JSONObject categoriesJson = TriviaUtil.fetchJson(TriviaUtil.getCategoriesLink());
+        List<TriviaCategory> categories = TriviaUtil.parseCategories(categoriesJson);
+        categories.sort(new TriviaCategoryComparator());
 
-        TriviaTask triviaTask = new TriviaTask(event.getAuthor(), channel);
+        EmbedBuilder embedBuilder = new EmbedBuilder();
-        ScheduledFuture<?> future =
+        embedBuilder.setColor(Cache.getBotColor());
-                Cache.getTaskScheduler().scheduleAtFixedRate(triviaTask,
+        embedBuilder.setTitle("\uD83C\uDFB2 Trivia");
-                        0,
+        embedBuilder.addField("\uD83D\uDCD6 Begin here",
-                        15,
+                "Select a category from the dropdown menu to start a match!",
-                        TimeUnit.SECONDS);
+                false);
-        triviaTask.setScheduledFuture(future);
+        embedBuilder.addField("❓ How to play",
+                "A new question gets posted every few seconds." +
+                        "\nIf you get it right, you earn points!" +
+                        "\nIf you choose a wrong answer, you lose points." +
+                        "\nIf you are unsure, you can wait without answering and your score won't change!",
+                false);
+
+        StringSelectMenu.Builder menuBuilder = StringSelectMenu.create("trivia_categories");
+
+        for(TriviaCategory category : categories)
+        {
+            String name = category.categoryName();
+            int id = category.categoryId();
+            menuBuilder.addOption(name, String.valueOf(id));
+        }
+
+        event.getMessage().replyEmbeds(embedBuilder.build()).addActionRow(menuBuilder.build()).queue(message ->
+        {
+            Cache.getDatabaseSource().trackRanCommandReply(message, event.getAuthor());
+            Cache.getDatabaseSource().queueDisabling(message);
+        });
 
-        TriviaUtil.channelsRunningTrivia.add(channel.getId());
 
     }
 }

src/main/java/wtf/beatrice/hidekobot/listeners/SelectMenuInteractionListener.java

@@ -0,0 +1,21 @@
+package wtf.beatrice.hidekobot.listeners;
+
+import net.dv8tion.jda.api.events.interaction.component.StringSelectInteractionEvent;
+import net.dv8tion.jda.api.hooks.ListenerAdapter;
+import net.dv8tion.jda.api.interactions.components.selections.SelectOption;
+import wtf.beatrice.hidekobot.commands.base.CoinFlip;
+import wtf.beatrice.hidekobot.util.TriviaUtil;
+
+public class SelectMenuInteractionListener extends ListenerAdapter
+{
+
+    @Override
+    public void onStringSelectInteraction(StringSelectInteractionEvent event)
+    {
+        switch (event.getComponentId().toLowerCase()) {
+
+            // trivia
+            case "trivia_categories" -> TriviaUtil.handleMenuSelection(event);
+        }
+    }
+}

src/main/java/wtf/beatrice/hidekobot/objects/comparators/TriviaCategoryComparator.java

@@ -0,0 +1,17 @@
+package wtf.beatrice.hidekobot.objects.comparators;
+
+import wtf.beatrice.hidekobot.objects.fun.TriviaCategory;
+import wtf.beatrice.hidekobot.objects.fun.TriviaScore;
+
+import java.util.Comparator;
+
+/**
+ * This class gets two trivia categories, and compares them by their name.
+ */
+public class TriviaCategoryComparator implements Comparator<TriviaCategory> {
+
+    @Override
+    public int compare(TriviaCategory o1, TriviaCategory o2) {
+        return CharSequence.compare(o1.categoryName(), o2.categoryName());
+    }
+}

src/main/java/wtf/beatrice/hidekobot/objects/comparators/TriviaScoreComparator.java

@@ -1,10 +1,8 @@
 package wtf.beatrice.hidekobot.objects.comparators;
 
-import wtf.beatrice.hidekobot.objects.TriviaScore;
+import wtf.beatrice.hidekobot.objects.fun.TriviaScore;
 
 import java.util.Comparator;
-import java.util.LinkedList;
-import java.util.List;
 
 /**
  * This class gets two trivia scores, and compares their score.

src/main/java/wtf/beatrice/hidekobot/objects/fun/Dice.java

@@ -1,4 +1,4 @@
-package wtf.beatrice.hidekobot.objects;
+package wtf.beatrice.hidekobot.objects.fun;
 
 import wtf.beatrice.hidekobot.util.RandomUtil;
 

src/main/java/wtf/beatrice/hidekobot/objects/fun/TriviaCategory.java

@@ -0,0 +1,5 @@
+package wtf.beatrice.hidekobot.objects.fun;
+
+public record TriviaCategory(String categoryName, int categoryId) {
+
+}

src/main/java/wtf/beatrice/hidekobot/objects/fun/TriviaQuestion.java

@@ -1,4 +1,4 @@
-package wtf.beatrice.hidekobot.objects;
+package wtf.beatrice.hidekobot.objects.fun;
 
 import java.util.List;
 

src/main/java/wtf/beatrice/hidekobot/objects/fun/TriviaScore.java

@@ -1,4 +1,4 @@
-package wtf.beatrice.hidekobot.objects;
+package wtf.beatrice.hidekobot.objects.fun;
 
 import net.dv8tion.jda.api.entities.User;
 

src/main/java/wtf/beatrice/hidekobot/runnables/TriviaTask.java

@@ -8,8 +8,9 @@ import net.dv8tion.jda.api.entities.emoji.Emoji;
 import net.dv8tion.jda.api.interactions.components.buttons.Button;
 import org.json.JSONObject;
 import wtf.beatrice.hidekobot.Cache;
-import wtf.beatrice.hidekobot.objects.TriviaQuestion;
+import wtf.beatrice.hidekobot.objects.fun.TriviaCategory;
-import wtf.beatrice.hidekobot.objects.TriviaScore;
+import wtf.beatrice.hidekobot.objects.fun.TriviaQuestion;
+import wtf.beatrice.hidekobot.objects.fun.TriviaScore;
 import wtf.beatrice.hidekobot.objects.comparators.TriviaScoreComparator;
 import wtf.beatrice.hidekobot.util.CommandUtil;
 import wtf.beatrice.hidekobot.util.TriviaUtil;
@@ -26,18 +27,20 @@ public class TriviaTask implements Runnable
 
     private final JSONObject triviaJson;
     private final List<TriviaQuestion> questions;
+    private final TriviaCategory category;
 
     ScheduledFuture<?> future = null;
 
     private int iteration = 0;
 
-    public TriviaTask(User author, MessageChannel channel)
+    public TriviaTask(User author, MessageChannel channel, TriviaCategory category)
     {
         this.author = author;
         this.channel = channel;
+        this.category = category;
 
-        triviaJson = TriviaUtil.fetchTrivia();
+        triviaJson = TriviaUtil.fetchJson(TriviaUtil.getTriviaLink(category.categoryId()));
-        questions = TriviaUtil.getQuestions(triviaJson); //todo: null check, rate limiting...
+        questions = TriviaUtil.parseQuestions(triviaJson); //todo: null check, rate limiting...
     }
 
     public void setScheduledFuture(ScheduledFuture<?> future)
@@ -50,7 +53,7 @@ public class TriviaTask implements Runnable
     {
         if(previousMessage != null)
         {
-            // todo: we shouldn't use this method, since it messes with the database...
+            // todo: we shouldn't use this method, since it messes with the database... look at coin reflip
             CommandUtil.disableExpired(previousMessage.getId());
 
             String previousCorrectAnswer = questions.get(iteration-1).correctAnswer();
@@ -172,7 +175,8 @@ public class TriviaTask implements Runnable
         EmbedBuilder embedBuilder = new EmbedBuilder();
 
         embedBuilder.setColor(Cache.getBotColor());
-        embedBuilder.setTitle("\uD83C\uDFB2 Trivia (" + (iteration+1) + "/" + questions.size() + ")");
+        embedBuilder.setTitle("\uD83C\uDFB2 Trivia - " + category.categoryName() +
+                " (" + (iteration+1) + "/" + questions.size() + ")");
 
         embedBuilder.addField("❓ Question", currentTriviaQuestion.question(), false);
 

src/main/java/wtf/beatrice/hidekobot/util/TriviaUtil.java

@@ -1,14 +1,19 @@
 package wtf.beatrice.hidekobot.util;
 
+import net.dv8tion.jda.api.entities.Message;
 import net.dv8tion.jda.api.entities.User;
 import net.dv8tion.jda.api.entities.channel.middleman.MessageChannel;
 import net.dv8tion.jda.api.events.interaction.component.ButtonInteractionEvent;
+import net.dv8tion.jda.api.events.interaction.component.StringSelectInteractionEvent;
+import net.dv8tion.jda.api.interactions.components.selections.SelectOption;
 import org.apache.commons.text.StringEscapeUtils;
 import org.json.JSONArray;
 import org.json.JSONObject;
 import wtf.beatrice.hidekobot.Cache;
-import wtf.beatrice.hidekobot.objects.TriviaQuestion;
+import wtf.beatrice.hidekobot.objects.fun.TriviaCategory;
-import wtf.beatrice.hidekobot.objects.TriviaScore;
+import wtf.beatrice.hidekobot.objects.fun.TriviaQuestion;
+import wtf.beatrice.hidekobot.objects.fun.TriviaScore;
+import wtf.beatrice.hidekobot.runnables.TriviaTask;
 
 import java.io.BufferedReader;
 import java.io.IOException;
@@ -18,11 +23,13 @@ import java.net.URLConnection;
 import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
+import java.util.concurrent.ScheduledFuture;
 import java.util.concurrent.TimeUnit;
 
 public class TriviaUtil
 {
-    private final static String link = "https://opentdb.com/api.php?amount=10&type=multiple";
+    private final static String triviaLink = "https://opentdb.com/api.php?amount=10&type=multiple&category=";
+    private final static String categoriesLink = "https://opentdb.com/api_category.php";
 
     public static List<String> channelsRunningTrivia = new ArrayList<>();
 
@@ -32,7 +39,10 @@ public class TriviaUtil
     // first string is the channelId, the list contain all score records for that channel
     public static HashMap<String, List<TriviaScore>> channelAndScores = new HashMap<>();
 
-    public static JSONObject fetchTrivia()
+    public static String getTriviaLink(int categoryId) {return triviaLink + categoryId; }
+    public static String getCategoriesLink() {return categoriesLink; }
+
+    public static JSONObject fetchJson(String link)
     {
         try {
             URL url = new URL(link);
@@ -54,7 +64,7 @@ public class TriviaUtil
         return null;
     }
 
-    public static List<TriviaQuestion> getQuestions(JSONObject jsonObject)
+    public static List<TriviaQuestion> parseQuestions(JSONObject jsonObject)
     {
         List<TriviaQuestion> questions = new ArrayList<>();
 
@@ -82,6 +92,23 @@ public class TriviaUtil
         return questions;
     }
 
+    public static List<TriviaCategory> parseCategories(JSONObject jsonObject)
+    {
+        List<TriviaCategory> categories = new ArrayList<>();
+        JSONArray categoriesArray = jsonObject.getJSONArray("trivia_categories");
+        for(Object categoryObject : categoriesArray)
+        {
+            JSONObject categoryJson = (JSONObject) categoryObject;
+
+            String name = categoryJson.getString("name");
+            int id = categoryJson.getInt("id");
+
+            categories.add(new TriviaCategory(name, id));
+        }
+
+        return categories;
+    }
+
     public static void handleAnswer(ButtonInteractionEvent event, AnswerType answerType)
     {
         User user = event.getUser();
@@ -150,6 +177,59 @@ public class TriviaUtil
         }
     }
 
+    public static void handleMenuSelection(StringSelectInteractionEvent event)
+    {
+        // check if the user interacting is the same one who ran the command
+        if(!(Cache.getDatabaseSource().isUserTrackedFor(event.getUser().getId(), event.getMessageId())))
+        {
+            event.reply("❌ You did not run this command!").setEphemeral(true).queue();
+            return;
+        }
+
+        // todo: we shouldn't use this method, since it messes with the database... look at coin reflip
+        CommandUtil.disableExpired(event.getMessageId());
+
+        SelectOption pickedOption = event.getInteraction().getSelectedOptions().get(0);
+        String categoryName = pickedOption.getLabel();
+        String categoryIdString = pickedOption.getValue();
+        Integer categoryId = Integer.parseInt(categoryIdString);
+
+        TriviaCategory category = new TriviaCategory(categoryName, categoryId);
+
+        startTrivia(event, category);
+    }
+
+    public static void startTrivia(StringSelectInteractionEvent event, TriviaCategory category)
+    {
+        User author = event.getUser();
+        Message message = event.getMessage();
+        MessageChannel channel = message.getChannel();
+
+        if(TriviaUtil.channelsRunningTrivia.contains(channel.getId()))
+        {
+            // todo nicer looking
+            // todo: also what if the bot stops (database...?)
+            // todo: also what if the message is already deleted
+            Message err = event.reply("Trivia is already running here!").complete().retrieveOriginal().complete();
+            Cache.getTaskScheduler().schedule(() -> err.delete().queue(), 10, TimeUnit.SECONDS);
+            return;
+        } else {
+            // todo nicer looking
+            event.reply("Starting new Trivia session!").queue();
+        }
+
+
+        TriviaTask triviaTask = new TriviaTask(author, channel, category);
+        ScheduledFuture<?> future =
+                Cache.getTaskScheduler().scheduleAtFixedRate(triviaTask,
+                        0,
+                        15,
+                        TimeUnit.SECONDS);
+        triviaTask.setScheduledFuture(future);
+
+        TriviaUtil.channelsRunningTrivia.add(channel.getId());
+    }
+
     public enum AnswerType {
         CORRECT, WRONG
     }