38 survey features

Core/src/main/java/net/bteuk/network/core/Constants.java

@@ -7,9 +7,10 @@
 public record Constants(String serverName, ServerType serverType, boolean standalone, boolean regionsEnabled, long regionInactivity, boolean tpllEnabled,
                         boolean tpllRequiresPermission, int maxY, int minY, String earthWorld, boolean staffChat, boolean tips, boolean tutorials, boolean ll, boolean progressMap,
                         boolean progression, boolean announceOveralLevelUps, boolean announceSeasonLevelUps, boolean sidebarEnabled, String sidebarTitle,
-                        List<String> sidebarContent, boolean motdEnabled, String motdContent, String minrankGeneration, String minrankRegionClaim, String minrankZoneJoin, boolean plotSystemEnabled, boolean moderationEnabled, boolean warpsEnabled,
+                        List<String> sidebarContent, boolean motdEnabled, String motdContent, String minrankGeneration, String minrankRegionClaim, String minrankZoneJoin,
+                        boolean plotSystemEnabled, boolean moderationEnabled, boolean warpsEnabled,
                         boolean homesEnabled, boolean announcePromotions, String discordLink, boolean skullsEnabled, String progressMapLink, String chatSocketOutputIP,
                         int chatSocketOutputPort, int chatSocketInputPort, int tipsFrequency, boolean regionStaffRequestAlways, int regionStaffRequestRadius, int progressMapID,
                         String mapHubAPIKey, int navigationRadius, boolean compulsoryTutorial, int afkTime, boolean mapEnabled, String mapServer, NetworkLocation mapLocation,
-                        NetworkLocation spawnLocation) {
+                        NetworkLocation spawnLocation, boolean UKSurvey) {
 }

Plugin/src/main/java/net/bteuk/network/Network.java

@@ -38,6 +38,7 @@
 import net.bteuk.network.commands.Reply;
 import net.bteuk.network.commands.Rules;
 import net.bteuk.network.commands.Speed;
+import net.bteuk.network.commands.Survey;
 import net.bteuk.network.commands.TipsToggle;
 import net.bteuk.network.commands.Where;
 import net.bteuk.network.commands.Zone;
@@ -418,13 +419,16 @@ public void enablePlugin() {
             commandManager.registerCommand(new Homes(this));
         }
 
+        if (constants.UKSurvey()) {
+            commandManager.registerCommand(new Survey(this, globalSQL));
+        }
+
         /*
          * Utility commands.
          */
         commandManager.registerCommand(new Buildings(this, plotSQL, constants));
         commandManager.registerCommand(new Discord(this, roleAPI, constants, messageSender));
         commandManager.registerCommand(new Focus(this, messageSender));
-        commandManager.registerCommand(new Buildings(this, plotSQL, constants));
 
         commandManager.registerCommand(nightvision);
         commandManager.registerCommand(new Speed());

Plugin/src/main/java/net/bteuk/network/commands/Survey.java

@@ -0,0 +1,115 @@
+package net.bteuk.network.commands;
+
+import io.papermc.paper.command.brigadier.CommandSourceStack;
+import lombok.extern.java.Log;
+import net.bteuk.network.CustomChat;
+import net.bteuk.network.Network;
+import net.bteuk.network.core.Time;
+import net.bteuk.network.lib.dto.UserUpdate;
+import net.bteuk.network.lib.utils.ChatUtils;
+import net.bteuk.network.socket.MessageSender;
+import net.bteuk.network.sql.GlobalSQL;
+import net.bteuk.network.survey.SurveyAnswerOption;
+import net.bteuk.network.survey.SurveyBook;
+import net.bteuk.network.utils.NetworkUser;
+import org.bukkit.entity.Player;
+import org.jetbrains.annotations.NotNull;
+import org.jspecify.annotations.NonNull;
+
+import java.util.logging.Level;
+
+@Log
+public class Survey extends AbstractCommand {
+
+    private final Network instance;
+    private final GlobalSQL globalSQL;
+
+    public Survey(Network instance, GlobalSQL globalSQL) {
+        this.instance = instance;
+        this.globalSQL = globalSQL;
+    }
+
+    @Override
+    public void execute(@NotNull CommandSourceStack stack, String @NonNull [] args) {
+
+        // Check if the sender is a player.
+        Player player = getPlayer(stack);
+        if (player == null) {
+            return;
+        }
+
+        NetworkUser user = instance.getUser(player);
+
+        // If u is null, cancel.
+        if (user == null) {
+            log.severe("User " + player.getName() + " can not be found!");
+            player.sendMessage(ChatUtils.error("User can not be found, please relog!"));
+            return;
+        }
+
+        if (args.length == 0) {
+            SurveyBook.openSurvey(user, globalSQL);
+        } else if (args.length == 1 && args[0].equalsIgnoreCase("save")) {
+                SurveyBook surveyBook = SurveyBook.getOpenSurvey(user);
+                if (surveyBook != null) {
+                    surveyBook.saveSurvey();
+                }
+        } else if (args.length == 2) {
+            SurveyBook surveyBook = SurveyBook.getOpenSurvey(user);
+            if (surveyBook == null)
+                return;
+
+            SurveyAnswerOption answerOption;
+
+            try {
+                 answerOption = SurveyAnswerOption.valueOf(args[0].toUpperCase());
+            }
+            catch (IllegalArgumentException e) {
+                log.log(Level.WARNING, "Invalid answer option at command survey: " + args[0], e);
+                return;
+            }
+
+            boolean bYes = args[1].equals("Y");
+            switch (answerOption) {
+                case Q1_BTUK -> surveyBook.getSurvey().setBFoundViaBTUK(bYes);
+                case Q1_BTE -> surveyBook.getSurvey().setBFoundViaBTE(bYes);
+                case Q1_BTUK_EXTERNAL -> surveyBook.getSurvey().setBFoundViaBTUKExternal(bYes);
+                case Q1_BTE_EXTERNAL -> surveyBook.getSurvey().setBFoundViaBTEExternal(bYes);
+                case Q1_FRIEND -> surveyBook.getSurvey().setBFoundViaFriend(bYes);
+                case Q2_TIKTOK -> surveyBook.getSurvey().setBMediumTiktok(bYes);
+                case Q2_YT_SHORT -> surveyBook.getSurvey().setBMediumYoutubeShorts(bYes);
+                case Q2_YT_LONG -> surveyBook.getSurvey().setBMediumYoutubeLongform(bYes);
+                case Q2_INSTAGRAM -> surveyBook.getSurvey().setBMediumInstagram(bYes);
+                case Q2_SEARCH -> surveyBook.getSurvey().setBSearchEngineBrowsing(bYes);
+                case Q2_ONLINE_NEWS -> surveyBook.getSurvey().setBOnlineNews(bYes);
+                case Q2_TV_NEWS -> surveyBook.getSurvey().setBTVNews(bYes);
+                case Q2_NEWSPAPER -> surveyBook.getSurvey().setBPhysicalNewspaper(bYes);
+                case Q3_TIKTOK -> surveyBook.getSurvey().setBSocialsTiktok(bYes);
+                case Q3_YOUTUBE_SHORTS -> surveyBook.getSurvey().setBSocialsYoutubeShorts(bYes);
+                case Q3_YOUTUBE_LONG -> surveyBook.getSurvey().setBSocialsYoutubeLongform(bYes);
+                case Q3_INSTAGRAM -> surveyBook.getSurvey().setBSocialsInstagram(bYes);
+                case CHANGE_PAGE -> {
+                    try {
+                        int toPage = Integer.parseInt(args[1]);
+                        surveyBook.changePage(toPage);
+                    }
+                    catch (NumberFormatException e) {
+                        log.log(Level.WARNING, "Invalid page number: " + args[1], e);
+                    }
+                }
+            }
+            surveyBook.updateSurveyBooks();
+            surveyBook.openCurrentPage();
+        }
+    }
+
+    @Override
+    public String getLabel() {
+        return "survey";
+    }
+
+    @Override
+    public String getDescription() {
+        return "Complete the UK Survey";
+    }
+}

Plugin/src/main/java/net/bteuk/network/gui/NavigatorGui.java

@@ -1,5 +1,6 @@
 package net.bteuk.network.gui;
 
+import net.bteuk.network.Network;
 import net.bteuk.network.api.EventAPI;
 import net.bteuk.network.api.ServerAPI;
 import net.bteuk.network.api.entity.NetworkLocation;
@@ -14,6 +15,7 @@
 import net.bteuk.network.papercore.LocationAdapter;
 import net.bteuk.network.papercore.PlayerAdapter;
 import net.bteuk.network.sql.GlobalSQL;
+import net.bteuk.network.survey.SurveyBook;
 import net.bteuk.network.utils.LightsOut;
 import net.bteuk.network.utils.NetworkUser;
 import net.bteuk.network.utils.Utils;
@@ -104,6 +106,12 @@ public NavigatorGui(GuiProvider provider) {
                 Utils.line("You can also use the command ").append(Component.text("/nightvision", NamedTextColor.GRAY)).append(Utils.line(" or "))
                         .append(Component.text("/nv", NamedTextColor.GRAY))), nightvision::toggleNightvision);
 
+        // Survey
+        if (constants.UKSurvey())
+            setItem(18, Utils.createItem(Material.PAPER, 1, Utils.title("UK Survey"), Utils.line("Assist us with our PR strategy.")), (NetworkUser u) -> {
+                SurveyBook.openSurvey(u, globalSQL);
+            });
+
         setItem(19, Utils.createItem(Material.REDSTONE_LAMP, 1, Utils.title("Lights Out"), Utils.line("Play a game of Lights Out.")), (NetworkUser u) -> {
             if (u.lightsOut == null) {
 

Plugin/src/main/java/net/bteuk/network/sql/GlobalSQL.java

@@ -7,6 +7,7 @@
 import net.bteuk.network.core.Time;
 import net.bteuk.network.core.sql.AbstractSQL;
 import net.bteuk.network.lib.dto.DirectMessage;
+import net.bteuk.network.survey.Survey;
 import net.bteuk.network.utils.Coordinate;
 import net.kyori.adventure.text.serializer.gson.GsonComponentSerializer;
 import org.bukkit.Bukkit;
@@ -19,8 +20,12 @@
 import java.sql.SQLException;
 import java.sql.Statement;
 import java.time.LocalDateTime;
+import java.sql.Timestamp;
+import java.time.Instant;
 import java.util.ArrayList;
 import java.util.List;
+import java.util.UUID;
+import java.util.logging.Level;
 
 @Log
 public class GlobalSQL extends AbstractSQL {
@@ -320,4 +325,82 @@ public boolean createUser(String uuid, String name, String playerSkin) {
         } else
             return true;
     }
+
+    public Survey getSurveyOfUser(UUID uuid) {
+        Survey survey;
+        try (
+                Connection conn = conn();
+                PreparedStatement statement = conn.prepareStatement(
+                        "SELECT survey_completed_at, survey_last_edited, found_via_btuk, found_via_bte, found_via_btuk_external, found_via_bte_external,found_via_friend," +
+                                "medium_tiktok, medium_youtube_shorts, medium_youtube_longform, medium_instagram," +
+                                "medium_search_engine_browsing, medium_online_news, medium_tvnews, medium_physical_newspaper," +
+                                "socials_tiktok, socials_youtube_shorts, socials_youtube_longform, socials_instagram FROM survey WHERE player=?;"
+                )
+        ) {
+            statement.setString(1, uuid.toString());
+            ResultSet results = statement.executeQuery();
+
+            if (results.next()) {
+                survey = new Survey(true, results.getTimestamp(1), results.getTimestamp(2),
+                        results.getBoolean(3), results.getBoolean(4), results.getBoolean(5), results.getBoolean(6), results.getBoolean(7),
+                        results.getBoolean(8), results.getBoolean(9), results.getBoolean(10), results.getBoolean(11),
+                        results.getBoolean(12), results.getBoolean(13), results.getBoolean(14), results.getBoolean(15),
+                        results.getBoolean(16), results.getBoolean(17), results.getBoolean(18), results.getBoolean(19));
+                return survey;
+            } else
+                return null;
+
+        } catch (SQLException e) {
+            log.log(Level.SEVERE, e.getMessage(), e);
+            return null;
+        }
+    }
+
+    public void saveSurveyOfUser(UUID user, Survey survey) {
+        try (
+                Connection conn = conn();
+                PreparedStatement statement = (survey.isExisting()) ?
+                        conn.prepareStatement("UPDATE survey SET survey_last_edited=?, found_via_btuk=?, found_via_bte=?, " +
+                                "found_via_btuk_external=?, found_via_bte_external=?, found_via_friend=?," +
+                                "medium_tiktok=?, medium_youtube_shorts=?, medium_youtube_longform=?, medium_instagram=?," +
+                                "medium_search_engine_browsing=?, medium_online_news=?, medium_tvnews=?, medium_physical_newspaper=?," +
+                                "socials_tiktok=?, socials_youtube_shorts=?, socials_youtube_longform=?, socials_instagram=? WHERE player=?;")
+                        :
+                        conn.prepareStatement("INSERT INTO survey (survey_completed_at, survey_last_edited, found_via_btuk, found_via_bte, " +
+                        "found_via_btuk_external,  found_via_bte_external, found_via_friend, " +
+                        "medium_tiktok, medium_youtube_shorts, medium_youtube_longform, medium_instagram, " +
+                        "medium_search_engine_browsing, medium_online_news, medium_tvnews, medium_physical_newspaper, " +
+                        "socials_tiktok, socials_youtube_shorts, socials_youtube_longform, socials_instagram, player)" +
+                        "VALUES (NOW(), ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?, ?);")
+                ) {
+            statement.setTimestamp(1, Timestamp.from(Instant.now()));
+            statement.setBoolean(2, survey.isBFoundViaBTUK());
+            statement.setBoolean(3, survey.isBFoundViaBTE());
+            statement.setBoolean(4, survey.isBFoundViaBTUKExternal());
+            statement.setBoolean(5, survey.isBFoundViaBTEExternal());
+            statement.setBoolean(6, survey.isBFoundViaFriend());
+
+            statement.setBoolean(7, survey.isBMediumTiktok());
+            statement.setBoolean(8, survey.isBMediumYoutubeShorts());
+            statement.setBoolean(9, survey.isBMediumYoutubeLongform());
+            statement.setBoolean(10, survey.isBMediumInstagram());
+            statement.setBoolean(11, survey.isBSearchEngineBrowsing());
+            statement.setBoolean(12, survey.isBOnlineNews());
+            statement.setBoolean(13, survey.isBTVNews());
+            statement.setBoolean(14, survey.isBPhysicalNewspaper());
+
+            statement.setBoolean(15, survey.isBSocialsTiktok());
+            statement.setBoolean(16, survey.isBSocialsYoutubeShorts());
+            statement.setBoolean(17, survey.isBSocialsYoutubeLongform());
+            statement.setBoolean(18, survey.isBSocialsInstagram());
+
+            statement.setString(19, user.toString());
+
+            if (statement.executeUpdate() == 1)
+                survey.setExisting(true);
+
+        } catch (SQLException sql) {
+            log.log(Level.SEVERE, sql.getMessage(), sql);
+        }
+    }
 }

Plugin/src/main/java/net/bteuk/network/survey/Survey.java

@@ -0,0 +1,41 @@
+package net.bteuk.network.survey;
+
+import lombok.AllArgsConstructor;
+import lombok.Getter;
+import lombok.NoArgsConstructor;
+import lombok.Setter;
+
+import java.sql.Timestamp;
+
+/**
+ * Stores survey answers
+ */
+@AllArgsConstructor
+@NoArgsConstructor
+@Getter
+@Setter
+public class Survey {
+    private boolean isExisting;
+
+    Timestamp SurveyCompleted;
+    Timestamp SurveyLastEdited;
+    boolean bFoundViaBTUK;
+    boolean bFoundViaBTE;
+    boolean bFoundViaBTUKExternal;
+    boolean bFoundViaBTEExternal;
+    boolean bFoundViaFriend;
+
+    boolean bMediumTiktok;
+    boolean bMediumYoutubeShorts;
+    boolean bMediumYoutubeLongform;
+    boolean bMediumInstagram;
+    boolean bSearchEngineBrowsing;
+    boolean bOnlineNews;
+    boolean bTVNews;
+    boolean bPhysicalNewspaper;
+
+    boolean bSocialsTiktok;
+    boolean bSocialsYoutubeShorts;
+    boolean bSocialsYoutubeLongform;
+    boolean bSocialsInstagram;
+}

Plugin/src/main/java/net/bteuk/network/survey/SurveyAnswerOption.java

@@ -0,0 +1,22 @@
+package net.bteuk.network.survey;
+
+public enum SurveyAnswerOption {
+    Q1_BTUK,
+    Q1_BTE,
+    Q1_BTUK_EXTERNAL,
+    Q1_BTE_EXTERNAL,
+    Q1_FRIEND,
+    Q2_TIKTOK,
+    Q2_YT_SHORT,
+    Q2_YT_LONG,
+    Q2_INSTAGRAM,
+    Q2_SEARCH,
+    Q2_ONLINE_NEWS,
+    Q2_TV_NEWS,
+    Q2_NEWSPAPER,
+    Q3_TIKTOK,
+    Q3_YOUTUBE_SHORTS,
+    Q3_YOUTUBE_LONG,
+    Q3_INSTAGRAM,
+    CHANGE_PAGE
+}