Refactor Cache (DRAFT)

Peashooter101 · Peashooter101 · commit 97d345e5f9c9 · 2025-11-18T21:55:14.000-06:00
diff --git a/common/pom.xml b/common/pom.xml
@@ -30,6 +30,12 @@
             <artifactId>HikariCP</artifactId>
             <version>6.3.0</version>
         </dependency>
+        <dependency>
+            <groupId>org.jetbrains</groupId>
+            <artifactId>annotations</artifactId>
+            <version>26.0.2</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
     
 </project>
diff --git a/common/src/main/java/com/simplexity/simplepms/common/database/Cache.java b/common/src/main/java/com/simplexity/simplepms/common/database/Cache.java
@@ -1,9 +1,7 @@
-package simplexity.simplepms.paper.saving;
+package com.simplexity.simplepms.common.database;
 
-import org.bukkit.Bukkit;
-import org.bukkit.entity.Player;
-import simplexity.simplepms.paper.SimplePMs;
-import simplexity.simplepms.paper.config.LocaleMessage;
+import com.simplexity.simplepms.common.logic.LocaleKey;
+import com.simplexity.simplepms.common.logic.PlatformBridge;
 import com.simplexity.simplepms.common.database.objects.PlayerBlock;
 import com.simplexity.simplepms.common.database.objects.PlayerSettings;
 
@@ -17,7 +15,7 @@
 public class Cache {
     public static final HashMap<UUID, List<PlayerBlock>> blockList = new HashMap<>();
     public static final HashMap<UUID, PlayerSettings> playerSettings = new HashMap<>();
-    public static final HashSet<Player> spyingPlayers = new HashSet<>();
+    public static final HashSet<UUID> spyingPlayers = new HashSet<>();
 
     public static List<PlayerBlock> getBlockList(UUID uuid) {
         return blockList.get(uuid);
@@ -27,20 +25,16 @@ public static PlayerSettings getPlayerSettings(UUID uuid) {
         return playerSettings.get(uuid);
     }
 
+    public static void populateCache(UUID uuid, boolean hasSpyPerms) {
+        List<PlayerBlock> blocklist = SQLHandler.getInstance().getBlockedPlayers(uuid);
+        blockList.put(uuid, blocklist);
+        populateNullNames(uuid);
 
-    public static void populateCache(UUID uuid, Player player, boolean hasSpyPerms) {
-        Bukkit.getScheduler().runTaskAsynchronously(SimplePMs.getInstance(), () -> {
-            DatabaseHandler.getInstance().getBlockedPlayers(uuid).thenAccept(blocklist -> {
-                blockList.put(uuid, blocklist);
-                populateNullNames(uuid);
-            });
-            DatabaseHandler.getInstance().getSettings(uuid).thenAccept(settings -> {
-                playerSettings.put(uuid, settings);
-                if (hasSpyPerms && settings.isSocialSpyEnabled()) {
-                    spyingPlayers.add(player);
-                }
-            });
-        });
+        PlayerSettings settings = SQLHandler.getInstance().getSettings(uuid);
+        playerSettings.put(uuid, settings);
+        if (hasSpyPerms && settings.isSocialSpyEnabled()) {
+            spyingPlayers.add(uuid);
+        }
     }
 
     /**
@@ -71,7 +65,7 @@ public static void updateSocialSpySettings(UUID uuid, boolean socialSpy) {
         PlayerSettings settings = playerSettings.get(uuid);
         settings.setSocialSpyEnabled(socialSpy);
         playerSettings.put(uuid, settings);
-        DatabaseHandler.getInstance().updateSettings(uuid, settings.isSocialSpyEnabled(), settings.areMessagesDisabled());
+        SQLHandler.getInstance().updateSettings(uuid, settings.isSocialSpyEnabled(), settings.areMessagesDisabled());
     }
 
     /**
@@ -84,7 +78,7 @@ public static void updateMessageSettings(UUID uuid, boolean messageDisabled) {
         PlayerSettings settings = playerSettings.get(uuid);
         settings.setMessagesDisabled(messageDisabled);
         playerSettings.put(uuid, settings);
-        DatabaseHandler.getInstance().updateSettings(uuid, settings.isSocialSpyEnabled(), settings.areMessagesDisabled());
+        SQLHandler.getInstance().updateSettings(uuid, settings.isSocialSpyEnabled(), settings.areMessagesDisabled());
     }
 
     /**
@@ -99,7 +93,7 @@ public static void addBlockedUser(UUID uuid, PlayerBlock playerBlock) {
         List<PlayerBlock> blockedPlayers = blockList.get(uuid);
         blockedPlayers.add(playerBlock);
         blockList.put(uuid, blockedPlayers);
-        DatabaseHandler.getInstance().addBlockedPlayer(uuid, playerBlock.getBlockedPlayerUUID(), playerBlock.getBlockedPlayerName(), playerBlock.getBlockReason());
+        SQLHandler.getInstance().addBlockedPlayer(uuid, playerBlock.getBlockedPlayerUUID(), playerBlock.getBlockedPlayerName(), playerBlock.getBlockReason());
     }
 
     /**
@@ -117,7 +111,7 @@ public static void removeBlockedUser(UUID uuid, UUID blockedPlayerUuid) {
             }
         }
         blockList.put(uuid, userBlockList);
-        DatabaseHandler.getInstance().removeBlockedPlayer(uuid, blockedPlayerUuid);
+        SQLHandler.getInstance().removeBlockedPlayer(uuid, blockedPlayerUuid);
     }
 
     private static void removeCachedDuplicates(UUID blockingUuid, UUID blockedUuid) {
@@ -132,15 +126,15 @@ private static void populateNullNames(UUID uuidToCheck) {
         if (playerBlocks == null || playerBlocks.isEmpty()) return;
         for (PlayerBlock block : playerBlocks) {
             if (block.getBlockedPlayerName() == null || block.getBlockedPlayerName().isEmpty()) {
-                String newName = Bukkit.getOfflinePlayer(block.getBlockedPlayerUUID()).getName();
-                if (newName == null) newName = LocaleMessage.ERROR_NAME_NOT_FOUND.getMessage();
+                String newName = PlatformBridge.getPlatformAdapter().getPlayerName(block.getBlockedPlayerUUID());
+                if (newName == null) newName = PlatformBridge.getPlatformAdapter().getLocaleString(LocaleKey.ERROR_NAME_NOT_FOUND);
                 block.setBlockedPlayerName(newName);
             }
         }
         blockList.put(uuidToCheck, playerBlocks);
     }
 
-    public static Set<Player> getSpyingPlayers() {
+    public static Set<UUID> getSpyingPlayers() {
         return spyingPlayers;
     }
 }
diff --git a/common/src/main/java/com/simplexity/simplepms/common/logic/LocaleKey.java b/common/src/main/java/com/simplexity/simplepms/common/logic/LocaleKey.java
@@ -0,0 +1,7 @@
+package com.simplexity.simplepms.common.logic;
+
+public enum LocaleKey {
+
+    ERROR_NAME_NOT_FOUND
+
+}
diff --git a/common/src/main/java/com/simplexity/simplepms/common/logic/PlatformAdapter.java b/common/src/main/java/com/simplexity/simplepms/common/logic/PlatformAdapter.java
@@ -0,0 +1,23 @@
+package com.simplexity.simplepms.common.logic;
+
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.util.UUID;
+
+public interface PlatformAdapter {
+
+    /**
+     * Retrieve the player name based on the player's UUID.
+     * @param playerUUID Player's UUID
+     * @return Player's name
+     */
+    @Nullable String getPlayerName(@NotNull UUID playerUUID);
+
+    /**
+     * Retrieve a locale String from a given {@link LocaleKey}
+     * @return String defined by the {@link LocaleKey}, null if not found.
+     */
+    @Nullable String getLocaleString(@NotNull LocaleKey key);
+
+}
diff --git a/common/src/main/java/com/simplexity/simplepms/common/logic/PlatformBridge.java b/common/src/main/java/com/simplexity/simplepms/common/logic/PlatformBridge.java
@@ -0,0 +1,33 @@
+package com.simplexity.simplepms.common.logic;
+
+import org.jetbrains.annotations.NotNull;
+
+public class PlatformBridge {
+
+    private static PlatformAdapter adapter;
+
+    /**
+     * Sets the platform adapter.
+     * <br/>
+     * Any platform should implement their own version of {@link PlatformAdapter}
+     * and then call this method.
+     * @param adapter PlatformAdapter implemented by the platform.
+     */
+    public static void setPlatformAdapter(@NotNull PlatformAdapter adapter) {
+        PlatformBridge.adapter = adapter;
+    }
+
+    /**
+     * Retrieves the platform adapter for use in the common module.
+     * <br/>
+     * {@link #setPlatformAdapter(PlatformAdapter)} should be called
+     * in the enable step of whatever platform is being used.
+     * @return PlatformAdapter
+     * @throws IllegalStateException If the platform adapter was never set before calling any PlatformAdapter methods.
+     */
+    public static @NotNull PlatformAdapter getPlatformAdapter() {
+        if (adapter == null) throw new IllegalStateException("PlatformAdapter was not initialized.");
+        return adapter;
+    }
+
+}
diff --git a/paper/pom.xml b/paper/pom.xml
@@ -60,6 +60,7 @@
                                     <artifact>*:*</artifact>
                                     <excludes>
                                         <exclude>META-INF/MANIFEST.MF</exclude>
+                                        <exclude>META-INF/versions/9/module-info.class</exclude>
                                     </excludes>
                                 </filter>
                             </filters>
diff --git a/paper/src/main/java/simplexity/simplepms/paper/SimplePMs.java b/paper/src/main/java/simplexity/simplepms/paper/SimplePMs.java
@@ -1,6 +1,7 @@
 package simplexity.simplepms.paper;
 
 import com.simplexity.simplepms.common.logger.Logger;
+import com.simplexity.simplepms.common.logic.PlatformBridge;
 import io.papermc.paper.plugin.lifecycle.event.types.LifecycleEvents;
 import net.kyori.adventure.text.minimessage.MiniMessage;
 import org.bukkit.command.ConsoleCommandSender;
@@ -19,6 +20,7 @@
 import simplexity.simplepms.paper.listeners.PreCommandListener;
 import simplexity.simplepms.paper.listeners.QuitListener;
 import simplexity.simplepms.paper.logic.Constants;
+import simplexity.simplepms.paper.logic.PaperPlatformAdapter;
 import simplexity.simplepms.paper.saving.DatabaseHandler;
 
 @SuppressWarnings("UnstableApiUsage")
@@ -42,6 +44,7 @@ public void onEnable() {
         registerCommands();
         registerPermissions();
         Logger.setLogger(this.getSLF4JLogger());
+        PlatformBridge.setPlatformAdapter(new PaperPlatformAdapter());
     }
 
     private void registerListeners() {
diff --git a/paper/src/main/java/simplexity/simplepms/paper/commands/Blocklist.java b/paper/src/main/java/simplexity/simplepms/paper/commands/Blocklist.java
@@ -11,7 +11,7 @@
 import simplexity.simplepms.paper.SimplePMs;
 import simplexity.simplepms.paper.config.LocaleMessage;
 import simplexity.simplepms.paper.logic.Constants;
-import simplexity.simplepms.paper.saving.Cache;
+import com.simplexity.simplepms.common.database.Cache;
 import com.simplexity.simplepms.common.database.objects.PlayerBlock;
 
 import java.util.List;
diff --git a/paper/src/main/java/simplexity/simplepms/paper/commands/MessageToggle.java b/paper/src/main/java/simplexity/simplepms/paper/commands/MessageToggle.java
@@ -7,7 +7,7 @@
 import org.bukkit.entity.Player;
 import simplexity.simplepms.paper.config.LocaleMessage;
 import simplexity.simplepms.paper.logic.Constants;
-import simplexity.simplepms.paper.saving.Cache;
+import com.simplexity.simplepms.common.database.Cache;
 import com.simplexity.simplepms.common.database.objects.PlayerSettings;
 
 import java.util.UUID;
diff --git a/paper/src/main/java/simplexity/simplepms/paper/commands/SocialSpy.java b/paper/src/main/java/simplexity/simplepms/paper/commands/SocialSpy.java
@@ -8,7 +8,7 @@
 import org.bukkit.entity.Player;
 import simplexity.simplepms.paper.config.LocaleMessage;
 import simplexity.simplepms.paper.logic.Constants;
-import simplexity.simplepms.paper.saving.Cache;
+import com.simplexity.simplepms.common.database.Cache;
 import com.simplexity.simplepms.common.database.objects.PlayerSettings;
 
 import java.util.UUID;
@@ -40,12 +40,12 @@ private static int execute(CommandContext<CommandSourceStack> ctx) {
         if (settings == null || settings.isSocialSpyEnabled()) {
             Cache.updateSocialSpySettings(uuid, false);
             player.sendRichMessage(LocaleMessage.SOCIAL_SPY_DISABLED.getMessage());
-            Cache.getSpyingPlayers().remove(player);
+            Cache.getSpyingPlayers().remove(player.getUniqueId());
             return Command.SINGLE_SUCCESS;
         }
         Cache.updateSocialSpySettings(uuid, true);
         player.sendRichMessage(LocaleMessage.SOCIAL_SPY_ENABLED.getMessage());
-        Cache.getSpyingPlayers().add(player);
+        Cache.getSpyingPlayers().add(player.getUniqueId());
         return Command.SINGLE_SUCCESS;
     }
 
diff --git a/paper/src/main/java/simplexity/simplepms/paper/commands/Unblock.java b/paper/src/main/java/simplexity/simplepms/paper/commands/Unblock.java
@@ -18,7 +18,7 @@
 import simplexity.simplepms.paper.config.LocaleMessage;
 import simplexity.simplepms.paper.logic.Constants;
 import simplexity.simplepms.paper.logic.UnblockHandler;
-import simplexity.simplepms.paper.saving.Cache;
+import com.simplexity.simplepms.common.database.Cache;
 import com.simplexity.simplepms.common.database.objects.PlayerBlock;
 
 import java.util.List;
diff --git a/paper/src/main/java/simplexity/simplepms/paper/commands/util/MessageChecks.java b/paper/src/main/java/simplexity/simplepms/paper/commands/util/MessageChecks.java
@@ -5,7 +5,7 @@
 import org.bukkit.entity.Player;
 import simplexity.simplepms.paper.config.ConfigHandler;
 import simplexity.simplepms.paper.logic.Constants;
-import simplexity.simplepms.paper.saving.Cache;
+import com.simplexity.simplepms.common.database.Cache;
 import com.simplexity.simplepms.common.database.objects.PlayerBlock;
 import com.simplexity.simplepms.common.database.objects.PlayerSettings;
 
diff --git a/paper/src/main/java/simplexity/simplepms/paper/listeners/JoinListener.java b/paper/src/main/java/simplexity/simplepms/paper/listeners/JoinListener.java
@@ -5,7 +5,7 @@
 import org.bukkit.event.Listener;
 import org.bukkit.event.player.PlayerJoinEvent;
 import simplexity.simplepms.paper.logic.Constants;
-import simplexity.simplepms.paper.saving.Cache;
+import com.simplexity.simplepms.common.database.Cache;
 
 import java.util.UUID;
 
@@ -15,6 +15,6 @@ public class JoinListener implements Listener {
     public void onLogin(PlayerJoinEvent joinEvent) {
         Player player = joinEvent.getPlayer();
         UUID playerUuid = player.getUniqueId();
-        Cache.populateCache(playerUuid, player, player.hasPermission(Constants.ADMIN_SOCIAL_SPY));
+        Cache.populateCache(playerUuid, player.hasPermission(Constants.ADMIN_SOCIAL_SPY));
     }
 }
diff --git a/paper/src/main/java/simplexity/simplepms/paper/listeners/QuitListener.java b/paper/src/main/java/simplexity/simplepms/paper/listeners/QuitListener.java
@@ -3,7 +3,7 @@
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.Listener;
 import org.bukkit.event.player.PlayerQuitEvent;
-import simplexity.simplepms.paper.saving.Cache;
+import com.simplexity.simplepms.common.database.Cache;
 
 public class QuitListener implements Listener {
     @EventHandler
diff --git a/paper/src/main/java/simplexity/simplepms/paper/logic/BlockHandler.java b/paper/src/main/java/simplexity/simplepms/paper/logic/BlockHandler.java
@@ -5,7 +5,7 @@
 import org.jetbrains.annotations.NotNull;
 import simplexity.simplepms.paper.SimplePMs;
 import simplexity.simplepms.paper.events.BlockUserEvent;
-import simplexity.simplepms.paper.saving.Cache;
+import com.simplexity.simplepms.common.database.Cache;
 import com.simplexity.simplepms.common.database.objects.PlayerBlock;
 
 import javax.annotation.Nullable;
diff --git a/paper/src/main/java/simplexity/simplepms/paper/logic/PMHandler.java b/paper/src/main/java/simplexity/simplepms/paper/logic/PMHandler.java
@@ -1,5 +1,6 @@
 package simplexity.simplepms.paper.logic;
 
+import org.bukkit.Bukkit;
 import org.bukkit.Registry;
 import org.bukkit.Sound;
 import org.bukkit.command.CommandSender;
@@ -8,9 +9,11 @@
 import simplexity.simplepms.paper.config.ConfigHandler;
 import simplexity.simplepms.paper.config.LocaleMessage;
 import simplexity.simplepms.paper.events.PrivateMessageEvent;
-import simplexity.simplepms.paper.saving.Cache;
+import com.simplexity.simplepms.common.database.Cache;
 
 import java.util.HashMap;
+import java.util.Set;
+import java.util.stream.Collectors;
 
 public class PMHandler {
     public static final HashMap<CommandSender, CommandSender> lastMessaged = new HashMap<>();
@@ -60,7 +63,8 @@ private static void handleMessageReceive(CommandSender initiator, CommandSender
 
 
     private static PrivateMessageEvent callPMEvent(CommandSender initiator, CommandSender target, String messageContent) {
-        PrivateMessageEvent messageEvent = new PrivateMessageEvent(initiator, target, messageContent, Cache.getSpyingPlayers());
+        Set<Player> spyingPlayers = Cache.getSpyingPlayers().stream().map(Bukkit::getPlayer).collect(Collectors.toSet());
+        PrivateMessageEvent messageEvent = new PrivateMessageEvent(initiator, target, messageContent, spyingPlayers);
         SimplePMs.getInstance().getServer().getPluginManager().callEvent(messageEvent);
         return messageEvent;
     }
diff --git a/paper/src/main/java/simplexity/simplepms/paper/logic/PaperPlatformAdapter.java b/paper/src/main/java/simplexity/simplepms/paper/logic/PaperPlatformAdapter.java
@@ -0,0 +1,27 @@
+package simplexity.simplepms.paper.logic;
+
+import com.simplexity.simplepms.common.logic.LocaleKey;
+import com.simplexity.simplepms.common.logic.PlatformAdapter;
+import org.bukkit.Bukkit;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+import simplexity.simplepms.paper.config.LocaleMessage;
+
+import java.util.UUID;
+
+public class PaperPlatformAdapter implements PlatformAdapter {
+    @Override
+    public String getPlayerName(@NotNull UUID playerUUID) {
+        return Bukkit.getOfflinePlayer(playerUUID).getName();
+    }
+
+    @Override
+    public @Nullable String getLocaleString(@NotNull LocaleKey key) {
+        return switch (key) {
+            case ERROR_NAME_NOT_FOUND -> LocaleMessage.ERROR_NAME_NOT_FOUND.getMessage();
+            default -> null;
+        };
+    }
+
+
+}
diff --git a/paper/src/main/java/simplexity/simplepms/paper/logic/SpyHandler.java b/paper/src/main/java/simplexity/simplepms/paper/logic/SpyHandler.java
diff --git a/paper/src/main/java/simplexity/simplepms/paper/logic/UnblockHandler.java b/paper/src/main/java/simplexity/simplepms/paper/logic/UnblockHandler.java
