GH-51 Use modern api. Fix chat formatter <message> placeholder duplicate. Add permissions per tag resolver. (#51)

* Use modern adventure api methods.

* Fix chat formatter <message> placeholder duplicate. Add permissions per tag resolver.

* Update README.md

* Update README.md

* Update permission chat -> chatformatter

* Update readme

Co-authored-by: Martin Sulikowski <[email protected]>

Author: Rollczi

README.md

@@ -19,16 +19,33 @@
 - [MiniMessages Support](https://docs.adventure.kyori.net/minimessage/format.html) with Legacy Colors Support!
 - Template System
 - Custom Placeholders System
+- Per permission miniMessages Tags (check permissions 👇)
 
 ### Useful links:
 - [Web UI](https://webui.adventure.kyori.net)
 - [MiniMessages Format](https://docs.adventure.kyori.net/minimessage/format.html) 
 
 ### Permissions:
-- chatformatter.chat.color - Chat colors for players
-- chatformatter.chat.reload - Reload
-
-
+- chatformatter.color - `<red>`, `<blue>`, etc. tags.
+- chatformatter.legacycolor - Allows the use of legacy color codes, such as `&c`, `&4`, `&l`, etc.
+- chatformatter.decorations.* - `<bold>`, `<italic>`, `<underlined>`, `<strikethrough>`, and `<obfuscated>` tags.
+- chatformatter.decorations.bold - `<bold>`
+- chatformatter.decorations.italic - `<italic>`
+- chatformatter.decorations.underlined - `<underlined>`
+- chatformatter.decorations.strikethrough - `<strikethrough>`
+- chatformatter.decorations.obfuscated - `<obfuscated>`
+- chatformatter.reset - `<reset>`
+- chatformatter.gradient - `<gradient>`
+- chatformatter.hover - `<hover>`
+- chatformatter.click - `<click>`
+- chatformatter.insertion - `<insertion>`
+- chatformatter.font - `<font>`
+- chatformatter.transition - `<transition>`
+- chatformatter.translatable - `<lang>`
+- chatformatter.selector - `<selector>`
+- chatformatter.keybind - `<key>`
+- chatformatter.newline - `<newline>`
+- chatformatter.chat.reload - reload the plugin `/chatformatter reload`
 
 ### config.yml
 ```yaml
@@ -38,7 +55,7 @@
 #  | |___| | | | (_| | |_|  _| (_) | |  | | | | | | (_| | |_| ||  __/ |   
 #   \____|_| |_|\__,_|\__|_|  \___/|_|  |_| |_| |_|\__,_|\__|\__\___|_|   
 
-# Do you want to use pre chat format? (Other plugins could join custom prefixes etc.)
+# Do you want to use pre-chat format? (Other plugins could join custom prefixes etc.)
 # INFO: This option requires to use custom badges like {displayname} and {message} in each message.
 preFormatting: false
 defaultFormat: "{displayname} {arrow_right} {message}"

chat-formatter-test/src/com/eternalcode/formatter/legacy/LegacyTest.java

@@ -14,6 +14,8 @@ void decolor() {
     @Test
     void shadow() {
         assertShadow("&7", "<ampersand>7");
+        assertShadow("&2 siema &l siema", "<ampersand>2 siema <ampersand>l siema");
+        assertShadow("&2 siema &l &5yo&&8", "<ampersand>2 siema <ampersand>l <ampersand>5yo&<ampersand>8");
         assertShadow("&&7", "&<ampersand>7");
         assertShadow("&#c", "<ampersand>#c");
         assertShadow("<ampersand>7", "&7", "<ampersand>7");
@@ -22,16 +24,16 @@ void shadow() {
     }
 
     private void assertShadow(String input, String output, String expectedShadowed) {
-        String shadowed = Legacy.shadow(input);
-        String deshadowed = Legacy.deshadow(shadowed);
+        String shadowed = Legacy.ampersandToPlaceholder(input);
+        String deshadowed = Legacy.placeholderToAmpersand(shadowed);
 
         assertEquals(expectedShadowed, shadowed);
         assertEquals(output, deshadowed);
     }
 
     private void assertShadow(String input, String expectedShadowed) {
-        String shadowed = Legacy.shadow(input);
-        String deshadowed = Legacy.deshadow(shadowed);
+        String shadowed = Legacy.ampersandToPlaceholder(input);
+        String deshadowed = Legacy.placeholderToAmpersand(shadowed);
 
         assertEquals(expectedShadowed, shadowed);
         assertEquals(input, deshadowed);

chat-formatter/src/com/eternalcode/formatter/ChatController.java

@@ -1,29 +1,67 @@
 package com.eternalcode.formatter;
 
 import com.eternalcode.formatter.legacy.Legacy;
+import com.eternalcode.formatter.legacy.LegacyPostMessageProcessor;
+import com.eternalcode.formatter.legacy.LegacyPreProcessor;
 import com.eternalcode.formatter.placeholder.PlaceholderRegistry;
 import com.eternalcode.formatter.preparatory.ChatPreparatoryService;
 import com.eternalcode.formatter.preparatory.ChatPrepareResult;
+import com.eternalcode.formatter.adventure.PlayerSignedMessage;
 import com.eternalcode.formatter.template.TemplateService;
+import com.google.common.collect.ImmutableMap;
 import net.kyori.adventure.audience.Audience;
+import net.kyori.adventure.chat.ChatType;
 import net.kyori.adventure.identity.Identity;
 import net.kyori.adventure.platform.AudienceProvider;
 import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.format.TextDecoration;
 import net.kyori.adventure.text.minimessage.MiniMessage;
 import net.kyori.adventure.text.minimessage.tag.resolver.Placeholder;
 import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
+import net.kyori.adventure.text.minimessage.tag.standard.StandardTags;
 import net.kyori.adventure.text.serializer.gson.GsonComponentSerializer;
 import org.bukkit.entity.Player;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.EventPriority;
 import org.bukkit.event.Listener;
 import org.bukkit.event.player.AsyncPlayerChatEvent;
 
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
 import java.util.Set;
 
 class ChatController implements Listener {
 
+    private static final String PERMISSION_ALL = "chatformatter.*";
+    private static final String PERMISSION_LEGACY = "chatformatter.legacycolor";
+    private static final Map<String, TagResolver> TAG_RESOLVERS_BY_PERMISSION = new ImmutableMap.Builder<String, TagResolver>()
+        .put("chatformatter.color", StandardTags.color())
+        .put("chatformatter.decorations.*", StandardTags.decorations())
+        .put("chatformatter.decorations.bold", StandardTags.decorations(TextDecoration.BOLD))
+        .put("chatformatter.decorations.italic", StandardTags.decorations(TextDecoration.ITALIC))
+        .put("chatformatter.decorations.underlined", StandardTags.decorations(TextDecoration.UNDERLINED))
+        .put("chatformatter.decorations.strikethrough", StandardTags.decorations(TextDecoration.STRIKETHROUGH))
+        .put("chatformatter.decorations.obfuscated", StandardTags.decorations(TextDecoration.OBFUSCATED))
+        .put("chatformatter.reset", StandardTags.reset())
+        .put("chatformatter.gradient", StandardTags.gradient())
+        .put("chatformatter.hover", StandardTags.hoverEvent())
+        .put("chatformatter.click", StandardTags.clickEvent())
+        .put("chatformatter.insertion", StandardTags.insertion())
+        .put("chatformatter.font", StandardTags.font())
+        .put("chatformatter.transition", StandardTags.transition())
+        .put("chatformatter.translatable", StandardTags.translatable())
+        .put("chatformatter.selector", StandardTags.selector())
+        .put("chatformatter.keybind", StandardTags.keybind())
+        .put("chatformatter.newline", StandardTags.newline())
+        .build();
+
     private static final GsonComponentSerializer GSON = GsonComponentSerializer.gson();
+    private static final MiniMessage MESSAGE_DESERIALIZER = MiniMessage.builder()
+        .tags(TagResolver.empty())
+        .preProcessor(new LegacyPreProcessor())
+        .postProcessor(new LegacyPostMessageProcessor())
+        .build();
 
     private final AudienceProvider audienceProvider;
     private final MiniMessage miniMessage;
@@ -71,7 +109,7 @@ void onChat(AsyncPlayerChatEvent event) {
         message = this.templateService.applyTemplates(message);
         message = this.placeholderRegistry.format(message, player);
 
-        Component messageComponent = miniMessage.deserialize(message, this.messageTag(event), this.displaynameTag(event));
+        Component messageComponent = miniMessage.deserialize(message, this.createTagResolvers(event));
 
         Set<Player> recipients = event.getRecipients();
 
@@ -86,27 +124,48 @@ void onChat(AsyncPlayerChatEvent event) {
             recipients = result.getReceivers();
         }
 
+        PlayerSignedMessage signedMessage = new PlayerSignedMessage(messageComponent, identity);
+        ChatType.Bound chatType = ChatType.CHAT.bind(Component.text("chat"));
+
         for (Player recipient : recipients) {
             Audience recipientAudience = this.audienceProvider.player(recipient.getUniqueId());
 
-            recipientAudience.sendMessage(identity, messageComponent);
+            recipientAudience.sendMessage(signedMessage, chatType);
         }
 
-        this.audienceProvider.console().sendMessage(identity, messageComponent);
+        this.audienceProvider.console().sendMessage(signedMessage, chatType);
     }
 
-    private TagResolver.Single messageTag(AsyncPlayerChatEvent event) {
+    private TagResolver createTagResolvers(AsyncPlayerChatEvent event) {
         String message = event.getMessage();
         Player player = event.getPlayer();
 
-        return player.hasPermission("chatformatter.chat.color")
-                ? Placeholder.parsed("message", message)
-                : Placeholder.unparsed("message", Legacy.shadow(message));
+        TagResolver.Single displayNamePlaceholder = Placeholder.parsed("displayname", Legacy.clearSection(event.getPlayer().getDisplayName()));
+
+        String safeMessage = player.hasPermission(PERMISSION_LEGACY)
+            ? message
+            : Legacy.ampersandToPlaceholder(message);
+        Component componentMessage = MESSAGE_DESERIALIZER.deserialize(safeMessage, this.messageResolver(player));
+        TagResolver.Single messagePlaceholder = Placeholder.component("message", componentMessage);
+
+        return TagResolver.resolver(displayNamePlaceholder, messagePlaceholder);
     }
 
+    private TagResolver messageResolver(Player player) {
+        List<TagResolver> tagResolvers = new ArrayList<>();
+
+        if (player.hasPermission(PERMISSION_ALL)) {
+            tagResolvers.addAll(TAG_RESOLVERS_BY_PERMISSION.values());
+            return TagResolver.resolver(tagResolvers);
+        }
+
+        for (Map.Entry<String, TagResolver> entry : TAG_RESOLVERS_BY_PERMISSION.entrySet()) {
+            if (player.hasPermission(entry.getKey())) {
+                tagResolvers.add(entry.getValue());
+            }
+        }
 
-    private TagResolver.Single displaynameTag(AsyncPlayerChatEvent event) {
-        return Placeholder.parsed("displayname", Legacy.clearSection(event.getPlayer().getDisplayName()));
+        return TagResolver.resolver(tagResolvers);
     }
 
 }

chat-formatter/src/com/eternalcode/formatter/ChatFormatterCommand.java

@@ -4,7 +4,7 @@
 import com.google.common.base.Stopwatch;
 import dev.rollczi.litecommands.command.execute.Execute;
 import dev.rollczi.litecommands.command.permission.Permission;
-import dev.rollczi.litecommands.command.section.Section;
+import dev.rollczi.litecommands.command.route.Route;
 import net.kyori.adventure.audience.Audience;
 import net.kyori.adventure.platform.AudienceProvider;
 import net.kyori.adventure.text.Component;
@@ -14,7 +14,7 @@
 
 import java.util.concurrent.TimeUnit;
 
-@Section(route = "chatformatter")
+@Route(name = "chatformatter")
 @Permission("chatformatter.chat.reload")
 class ChatFormatterCommand {
 

chat-formatter/src/com/eternalcode/formatter/adventure/PlayerSignedMessage.java

@@ -0,0 +1,60 @@
+package com.eternalcode.formatter.adventure;
+
+import net.kyori.adventure.chat.SignedMessage;
+import net.kyori.adventure.identity.Identity;
+import net.kyori.adventure.text.Component;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import java.security.SecureRandom;
+import java.time.Instant;
+
+public class PlayerSignedMessage implements SignedMessage {
+
+    private static final SecureRandom RANDOM = new SecureRandom();
+
+    private final Instant instant;
+    private final long salt;
+    private final Component unsignedContent;
+    private final String message;
+    private final Identity identity;
+
+    public PlayerSignedMessage(Component unsignedContent, Identity identity) {
+        this.identity = identity;
+        this.instant = Instant.now();
+        this.salt = RANDOM.nextLong();
+        this.unsignedContent = unsignedContent;
+        this.message = "-";
+    }
+
+    @Override
+    public @NotNull Instant timestamp() {
+        return this.instant;
+    }
+
+    @Override
+    public long salt() {
+        return this.salt;
+    }
+
+    @Override
+    public Signature signature() {
+        return null;
+    }
+
+    @Override
+    public @Nullable Component unsignedContent() {
+        return this.unsignedContent;
+    }
+
+    @Override
+    public @NotNull String message() {
+        return this.message;
+    }
+
+    @Override
+    public @NotNull Identity identity() {
+        return identity;
+    }
+
+}

chat-formatter/src/com/eternalcode/formatter/config/PluginConfig.java

@@ -22,7 +22,7 @@ public class PluginConfig implements ChatSettings, PlaceholderStack, TemplateRep
     @Description("#   \\____|_| |_|\\__,_|\\__|_|  \\___/|_|  |_| |_| |_|\\__,_|\\__|\\__\\___|_|   ")
     @Description({ " " })
 
-    @Description("# Do you want to use pre chat format? (Other plugins could join custom prefixes etc.)")
+    @Description("# Do you want to use pre-chat format? (Other plugins could join custom prefixes etc.)")
     @Description("# INFO: This option requires to use custom badges like {displayname} and {message} in each message.")
     public boolean preFormatting = false;
 

chat-formatter/src/com/eternalcode/formatter/legacy/Legacy.java

@@ -19,7 +19,7 @@ public final class Legacy {
     private Legacy() {
     }
 
-    public static final LegacyComponentSerializer LEGACY_SERIALIZER = LegacyComponentSerializer.builder()
+    public static final LegacyComponentSerializer LEGACY_AMPERSAND_SERIALIZER = LegacyComponentSerializer.builder()
         .hexColors()
         .character('&')
         .hexCharacter('#')
@@ -42,7 +42,7 @@ public static String toAdventureFormat(String text) {
             .replace("%2$s", "<message>");
     }
 
-    public static String shadow(String text) {
+    public static String ampersandToPlaceholder(String text) {
         StringBuilder builder = new StringBuilder(text);
         Matcher colorMatcher = AMPERSAND_PATTERN.matcher(builder.toString());
 
@@ -51,27 +51,28 @@ public static String shadow(String text) {
             String color = colorMatcher.group(0);
 
             builder.replace(colorMatcher.start() + matched, colorMatcher.end() + matched, SHADOW + color.charAt(1));
-            matched++;
+            matched += SHADOW.length() - 1;
         }
 
         return builder.toString();
     }
 
-    static Component deshadow(Component component) {
+    static Component placeholderToAmpersand(Component component) {
         return component.replaceText(shadowBuilder -> shadowBuilder
             .match(ALL_PATTERN)
-            .replacement((matchResult, builder) -> Component.text(Legacy.deshadow(matchResult.group()))));
+            .replacement((matchResult, builder) -> Component.text(Legacy.placeholderToAmpersand(matchResult.group()))));
     }
 
-    static String deshadow(String text) {
+    static String placeholderToAmpersand(String text) {
         Matcher matcher = SHADOW_PATTERN.matcher(text);
         StringBuilder builder = new StringBuilder(text);
 
         int matched = 0;
         while (matcher.find()) {
             int length = (matcher.end() - matcher.start()) - 1;
             builder.replace(matcher.start() + matched, matcher.end() + matched - 1, String.valueOf( AMPERSAND ));
-            matched += length;
+            matched -= length;
+            matched += 1;
         }
 
         return builder.toString();

chat-formatter/src/com/eternalcode/formatter/legacy/LegacyPostMessageProcessor.java

@@ -0,0 +1,44 @@
+package com.eternalcode.formatter.legacy;
+
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.text.ComponentLike;
+import net.kyori.adventure.text.TextComponent;
+import net.kyori.adventure.text.TextReplacementConfig;
+
+import java.util.function.BiFunction;
+import java.util.function.Consumer;
+import java.util.function.UnaryOperator;
+import java.util.regex.MatchResult;
+
+public final class LegacyPostMessageProcessor implements UnaryOperator<Component> {
+
+    private static final Replacer REPLACER = new Replacer();
+
+    @Override
+    public Component apply(Component component) {
+        return component.replaceText(REPLACER);
+    }
+
+    private static final class Replacer implements Consumer<TextReplacementConfig.Builder> {
+
+        private static final Replacement REPLACEMENT = new Replacement();
+
+        @Override
+        public void accept(TextReplacementConfig.Builder builder) {
+            builder
+                .match(Legacy.ALL_PATTERN)
+                .replacement(REPLACEMENT);
+        }
+
+    }
+
+    private static final class Replacement implements BiFunction<MatchResult, TextComponent.Builder, ComponentLike> {
+
+        @Override
+        public ComponentLike apply(MatchResult matchResult, TextComponent.Builder builder) {
+            return Legacy.LEGACY_AMPERSAND_SERIALIZER.deserialize(matchResult.group());
+        }
+
+    }
+
+}