GH-930 Msg placeholders & Async placeholder for future

eternalcore-core/src/main/java/com/eternalcode/core/bridge/BridgeManager.java

@@ -2,7 +2,7 @@
 
 import com.eternalcode.core.bridge.dynmap.DynmapBridgeInitializer;
 import com.eternalcode.core.bridge.placeholderapi.PlaceholderApiExtension;
-import com.eternalcode.core.bridge.placeholderapi.PlaceholderApiReplacer;
+import com.eternalcode.core.bridge.placeholderapi.PlaceholderAPIPlaceholder;
 import com.eternalcode.core.feature.vanish.VanishService;
 import com.eternalcode.core.placeholder.PlaceholderRegistry;
 import org.bukkit.Server;
@@ -38,7 +38,7 @@ class BridgeManager {
 
     void init() {
         this.setupBridge("PlaceholderAPI", () -> {
-            this.placeholderRegistry.register(new PlaceholderApiReplacer());
+            this.placeholderRegistry.register(new PlaceholderAPIPlaceholder());
             new PlaceholderApiExtension(this.placeholderRegistry, this.pluginDescriptionFile).initialize();
         });
 

eternalcore-core/src/main/java/com/eternalcode/core/bridge/placeholderapi/PlaceholderApiReplacer.java → eternalcore-core/src/main/java/com/eternalcode/core/bridge/placeholderapi/PlaceholderAPIPlaceholder.java

@@ -1,11 +1,10 @@
 package com.eternalcode.core.bridge.placeholderapi;
 
 
-import com.eternalcode.core.placeholder.Placeholder;
 import me.clip.placeholderapi.PlaceholderAPI;
 import org.bukkit.entity.Player;
 
-public class PlaceholderApiReplacer implements Placeholder {
+public class PlaceholderAPIPlaceholder implements Placeholder {
 
     @Override
     public String apply(String text, Player targetPlayer) {

eternalcore-core/src/main/java/com/eternalcode/core/bridge/placeholderapi/PlaceholderApiExtension.java

@@ -1,7 +1,7 @@
 package com.eternalcode.core.bridge.placeholderapi;
 
 import com.eternalcode.core.bridge.BridgeInitializer;
-import com.eternalcode.core.placeholder.PlaceholderRaw;
+import com.eternalcode.core.placeholder.NamedPlaceholder;
 import com.eternalcode.core.placeholder.PlaceholderRegistry;
 import me.clip.placeholderapi.expansion.PlaceholderExpansion;
 import org.bukkit.entity.Player;
@@ -23,10 +23,10 @@ public PlaceholderApiExtension(PlaceholderRegistry placeholderRegistry, PluginDe
 
     @Override
     public @Nullable String onPlaceholderRequest(Player player, @NotNull String params) {
-        Optional<PlaceholderRaw> optional = this.placeholderRegistry.getRawPlaceholder(params);
+        Optional<NamedPlaceholder> optional = this.placeholderRegistry.getNamedPlaceholder(params);
 
         if (optional.isPresent()) {
-            return optional.get().rawApply(player);
+            return optional.get().provideValue(player);
         }
 
         return "Unknown placeholder!";

eternalcore-core/src/main/java/com/eternalcode/core/feature/afk/placeholder/AfkPlaceholderSetup.java

@@ -8,7 +8,6 @@
 import com.eternalcode.core.injector.annotations.Inject;
 import com.eternalcode.core.injector.annotations.component.Controller;
 import com.eternalcode.core.placeholder.PlaceholderRegistry;
-import com.eternalcode.core.placeholder.Placeholder;
 import com.eternalcode.core.publish.Subscribe;
 import com.eternalcode.core.publish.event.EternalInitializeEvent;
 import com.eternalcode.core.translation.Translation;

eternalcore-core/src/main/java/com/eternalcode/core/feature/home/HomePlaceholderSetup.java

@@ -5,7 +5,6 @@
 import com.eternalcode.core.injector.annotations.Inject;
 import com.eternalcode.core.injector.annotations.component.Controller;
 import com.eternalcode.core.placeholder.PlaceholderRegistry;
-import com.eternalcode.core.placeholder.Placeholder;
 import com.eternalcode.core.publish.Subscribe;
 import com.eternalcode.core.publish.event.EternalInitializeEvent;
 import com.eternalcode.core.translation.Translation;

eternalcore-core/src/main/java/com/eternalcode/core/feature/msg/MsgPlaceholderSetup.java

@@ -0,0 +1,73 @@
+package com.eternalcode.core.feature.msg;
+
+import com.eternalcode.core.feature.msg.toggle.MsgState;
+import com.eternalcode.core.feature.msg.toggle.MsgToggleRepository;
+import com.eternalcode.core.injector.annotations.Inject;
+import com.eternalcode.core.injector.annotations.component.Controller;
+import com.eternalcode.core.placeholder.PlaceholderRegistry;
+import com.eternalcode.core.placeholder.Placeholder;
+import com.eternalcode.core.placeholder.watcher.PlaceholderWatcherKey;
+import com.eternalcode.core.publish.Subscribe;
+import com.eternalcode.core.publish.event.EternalInitializeEvent;
+import com.eternalcode.core.translation.Translation;
+import com.eternalcode.core.translation.TranslationManager;
+import java.util.UUID;
+
+@Controller
+public class MsgPlaceholderSetup {
+
+    public static final PlaceholderWatcherKey<MsgState> MSG_STATE = PlaceholderWatcherKey.of("msg_state", MsgState.class);
+
+    private final MsgService msgService;
+    private final MsgToggleRepository msgToggleRepository;
+    private final TranslationManager translationManager;
+
+    @Inject
+    MsgPlaceholderSetup(
+        MsgService msgService,
+        MsgToggleRepository msgToggleRepository,
+        TranslationManager translationManager
+    ) {
+        this.msgService = msgService;
+        this.msgToggleRepository = msgToggleRepository;
+        this.translationManager = translationManager;
+    }
+
+    @Subscribe(EternalInitializeEvent.class)
+    void setUpPlaceholders(PlaceholderRegistry registry) {
+        Translation translation = this.translationManager.getMessages();
+
+        registry.registerPlaceholder(Placeholder.of(
+            "socialspy_status",
+            player -> String.valueOf(this.msgService.isSpy(player.getUniqueId()))
+        ));
+
+        registry.registerPlaceholder(Placeholder.of(
+            "socialspy_status_formatted",
+            player -> {
+                UUID uuid = player.getUniqueId();
+                return this.msgService.isSpy(uuid)
+                    ? translation.msg().placeholders().socialSpyEnabled()
+                    : translation.msg().placeholders().socialSpyDisabled();
+            }
+        ));
+
+        registry.registerPlaceholder(Placeholder.async(
+            "msg_status",
+            MSG_STATE,
+            player -> msgToggleRepository.getPrivateChatState(player),
+            state -> state.name().toLowerCase()
+        ));
+
+        registry.registerPlaceholder(Placeholder.async(
+            "msg_status_formatted",
+            MSG_STATE,
+            player -> msgToggleRepository.getPrivateChatState(player),
+            state -> state == MsgState.ENABLED
+                ? translation.msg().placeholders().msgEnabled()
+                : translation.msg().placeholders().msgDisabled()
+            )
+        );
+    }
+
+}

eternalcore-core/src/main/java/com/eternalcode/core/feature/msg/messages/ENMsgMessages.java

@@ -38,4 +38,22 @@ public class ENMsgMessages extends OkaeriConfig implements MsgMessages {
     Notice socialSpyEnable = Notice.chat("<color:#9d6eef>► <white>SocialSpy has been {STATE}<white>!");
     Notice socialSpyDisable = Notice.chat("<red>► <white>SocialSpy has been {STATE}<white>!");
 
+    @Comment("# Formatowanie placeholderów")
+    public ENPlaceholders placeholders = new ENPlaceholders();
+
+    @Getter
+    @Accessors(fluent = true)
+    public static class ENPlaceholders extends OkaeriConfig implements MsgMessages.Placeholders {
+        private String loading = "<yellow>Loading...";
+
+        private String msgEnabled = "<green>Enabled";
+        private String msgDisabled = "<red>Disabled";
+        private String socialSpyEnabled = "<green>Enabled";
+        private String socialSpyDisabled = "<red>Disabled";
+    }
+
+    public ENPlaceholders placeholders() {
+        return this.placeholders;
+    }
+
 }

eternalcore-core/src/main/java/com/eternalcode/core/feature/msg/messages/MsgMessages.java

@@ -17,4 +17,16 @@ public interface MsgMessages {
     Notice otherMessagesDisabled();
     Notice otherMessagesEnabled();
 
+    Placeholders placeholders();
+
+    interface Placeholders {
+        String loading();
+
+        String msgEnabled();
+        String msgDisabled();
+
+        String socialSpyEnabled();
+        String socialSpyDisabled();
+    }
+
 }

eternalcore-core/src/main/java/com/eternalcode/core/feature/msg/messages/PLMsgMessages.java

@@ -38,4 +38,21 @@ public class PLMsgMessages extends OkaeriConfig implements MsgMessages {
     Notice otherMessagesEnabled = Notice.chat(
             "<color:#9d6eef>► <white>Wiadomości prywatne zostały <color:#9d6eef>włączone <white>dla gracza <color:#9d6eef>{PLAYER}<white>!");
 
+    @Comment("# Formatowanie placeholderów")
+    public PLPlaceholders placeholders = new PLPlaceholders();
+
+    @Getter
+    @Accessors(fluent = true)
+    public static class PLPlaceholders extends OkaeriConfig implements MsgMessages.Placeholders {
+        private String loading = "<yellow>Ładowanie...";
+
+        private String msgEnabled = "<green>Włączone";
+        private String msgDisabled = "<red>Wyłączone";
+        private String socialSpyEnabled = "<green>Włączony";
+        private String socialSpyDisabled = "<red>Wyłączony";
+    }
+
+    public PLPlaceholders placeholders() {
+        return this.placeholders;
+    }
 }

eternalcore-core/src/main/java/com/eternalcode/core/feature/msg/toggle/MsgToggleRepository.java

@@ -4,10 +4,10 @@
 import java.util.UUID;
 import java.util.concurrent.CompletableFuture;
 
-interface MsgToggleRepository {
+public interface MsgToggleRepository {
 
     CompletableFuture<MsgState> getPrivateChatState(UUID uuid);
 
-    CompletableFuture<Void> setPrivateChatState(UUID uuid, MsgState toggledOff);
+    CompletableFuture<MsgState> setPrivateChatState(UUID uuid, MsgState state);
 
 }

eternalcore-core/src/main/java/com/eternalcode/core/feature/msg/toggle/MsgToggleRepositoryOrmLite.java

@@ -28,8 +28,8 @@ public CompletableFuture<MsgState> getPrivateChatState(UUID uuid) {
     }
 
     @Override
-    public CompletableFuture<Void> setPrivateChatState(UUID uuid, MsgState state) {
+    public CompletableFuture<MsgState> setPrivateChatState(UUID uuid, MsgState state) {
         return this.save(MsgStateTable.class, new MsgStateTable(uuid, state))
-            .thenApply(status -> null);
+            .thenApply(status -> state);
     }
 }

eternalcore-core/src/main/java/com/eternalcode/core/feature/msg/toggle/MsgToggleServiceImpl.java

@@ -1,51 +1,43 @@
 package com.eternalcode.core.feature.msg.toggle;
 
+import com.eternalcode.core.feature.msg.MsgPlaceholderSetup;
 import com.eternalcode.core.injector.annotations.Inject;
 import com.eternalcode.core.injector.annotations.component.Service;
+import com.eternalcode.core.placeholder.PlaceholderRegistry;
+import com.eternalcode.core.placeholder.watcher.PlaceholderWatcher;
 import java.util.UUID;
 import java.util.concurrent.CompletableFuture;
-import java.util.concurrent.ConcurrentHashMap;
 
 @Service
 class MsgToggleServiceImpl implements MsgToggleService {
 
     private final MsgToggleRepository msgToggleRepository;
-    private final ConcurrentHashMap<UUID, MsgState> cachedToggleStates;
+    private final PlaceholderWatcher<MsgState> watcher;
 
     @Inject
-    MsgToggleServiceImpl(MsgToggleRepository msgToggleRepository) {
-        this.cachedToggleStates = new ConcurrentHashMap<>();
+    MsgToggleServiceImpl(MsgToggleRepository msgToggleRepository, PlaceholderRegistry registry) {
         this.msgToggleRepository = msgToggleRepository;
-
+        this.watcher = registry.createWatcher(MsgPlaceholderSetup.MSG_STATE);
     }
 
-
     @Override
-    public CompletableFuture<MsgState> getState(UUID playerUniqueId) {
-        if (this.cachedToggleStates.containsKey(playerUniqueId)) {
-            return CompletableFuture.completedFuture(this.cachedToggleStates.get(playerUniqueId));
-        }
-
-        return this.msgToggleRepository.getPrivateChatState(playerUniqueId);
+    public CompletableFuture<MsgState> getState(UUID player) {
+        return this.watcher.track(player, this.msgToggleRepository.getPrivateChatState(player));
     }
 
     @Override
-    public CompletableFuture<Void> setState(UUID playerUniqueId, MsgState state) {
-        this.cachedToggleStates.put(playerUniqueId, state);
-
-        return this.msgToggleRepository.setPrivateChatState(playerUniqueId, state)
-            .exceptionally(throwable -> {
-                this.cachedToggleStates.remove(playerUniqueId);
-                return null;
-            });
+    public CompletableFuture<Void> setState(UUID player, MsgState state) {
+        return this.watcher.track(player, this.msgToggleRepository.setPrivateChatState(player, state))
+            .thenApply(unused -> null);
     }
 
     @Override
     public CompletableFuture<MsgState> toggleState(UUID playerUniqueId) {
         return this.getState(playerUniqueId).thenCompose(state -> {
             MsgState newState = state.invert();
             return this.setState(playerUniqueId, newState)
-                .thenApply(aVoid -> newState);
+                .thenApply(unused -> newState);
         });
     }
+
 }

eternalcore-core/src/main/java/com/eternalcode/core/placeholder/NamedPlaceholder.java

@@ -0,0 +1,16 @@
+package com.eternalcode.core.placeholder;
+
+import org.bukkit.entity.Player;
+
+public interface NamedPlaceholder extends Placeholder {
+
+    @Override
+    default String apply(String text, Player targetPlayer) {
+        return text.replace("{" + this.getName() + "}", this.provideValue(targetPlayer));
+    }
+
+    String getName();
+
+    String provideValue(Player targetPlayer);
+
+}

eternalcore-core/src/main/java/com/eternalcode/core/placeholder/Placeholder.java

@@ -1,5 +1,8 @@
 package com.eternalcode.core.placeholder;
 
+import com.eternalcode.core.placeholder.watcher.PlaceholderWatcherKey;
+import java.util.UUID;
+import java.util.concurrent.CompletableFuture;
 import org.bukkit.entity.Player;
 
 import java.util.function.Function;
@@ -9,27 +12,36 @@ public interface Placeholder {
     String apply(String text, Player targetPlayer);
 
     static Placeholder of(String target, String replacement) {
-        return new PlaceholderRaw(target, player -> replacement);
+        return new StaticValuePlaceholder(target, player -> replacement);
     }
 
     static Placeholder of(String target, Function<Player, String> replacement) {
-        return new PlaceholderRaw(target, replacement);
+        return new StaticValuePlaceholder(target, replacement);
     }
 
     static Placeholder ofInt(String target, Function<Player, Integer> replacement) {
-        return new PlaceholderRaw(target, player -> String.valueOf(replacement.apply(player)));
+        return new StaticValuePlaceholder(target, player -> String.valueOf(replacement.apply(player)));
     }
 
     static Placeholder ofBoolean(String target, Function<Player, Boolean> replacement) {
-        return new PlaceholderRaw(target, player -> String.valueOf(replacement.apply(player)));
+        return new StaticValuePlaceholder(target, player -> String.valueOf(replacement.apply(player)));
     }
 
     static Placeholder ofLong(String target, Function<Player, Long> replacement) {
-        return new PlaceholderRaw(target, player -> String.valueOf(replacement.apply(player)));
+        return new StaticValuePlaceholder(target, player -> String.valueOf(replacement.apply(player)));
     }
 
     static Placeholder of(String target, Placeholder placeholder) {
-        return new PlaceholderRaw(target, player -> placeholder.apply(target, player));
+        return new StaticValuePlaceholder(target, player -> placeholder.apply(target, player));
+    }
+
+    static <T> Placeholder async(
+        String target,
+        PlaceholderWatcherKey<T> key,
+        Function<UUID, CompletableFuture<T>> loading,
+        Function<T, String> mapper
+    ) {
+        return new PlaceholderAsync<>(target, key, loading, mapper);
     }
 
 }