Update for MiniPlaceholders v3 (#690)

Author: jpenilla

common/src/main/java/net/draycia/carbon/common/command/commands/NicknameCommand.java

@@ -177,7 +177,7 @@ private void checkOthersNickname(final Audience sender, final CarbonPlayer targe
 
     private static Component parseNickname(final Commander sender, final String nick) {
         // trim one level of quotes, to allow for nicknames which collide with command literals
-        return TagPermissions.parseTags(TagPermissions.NICKNAME, trimQuotes(nick), sender::hasPermission);
+        return TagPermissions.parseTags(sender, TagPermissions.NICKNAME, trimQuotes(nick), sender::hasPermission);
     }
 
     private static String trimQuotes(final String string) {

common/src/main/java/net/draycia/carbon/common/command/commands/PartyCommands.java

@@ -184,7 +184,7 @@ private void createParty(final CommandContext<PlayerCommander> ctx) {
             return;
         }
         final String name = ctx.getOrDefault("name", player.username() + "'s party");
-        final Component component = TagPermissions.parseTags(TagPermissions.PARTY_NAME, name, player::hasPermission);
+        final Component component = TagPermissions.parseTags(player, TagPermissions.PARTY_NAME, name, player::hasPermission);
         final Party party;
         try {
             party = this.userManager.createParty(component);

common/src/main/java/net/draycia/carbon/common/integration/miniplaceholders/MiniPlaceholdersExpansion.java

@@ -22,8 +22,6 @@
 import com.google.inject.Inject;
 import com.google.inject.Injector;
 import io.github.miniplaceholders.api.Expansion;
-import io.github.miniplaceholders.api.MiniPlaceholders;
-import java.util.Objects;
 import java.util.UUID;
 import net.draycia.carbon.api.channels.ChannelRegistry;
 import net.draycia.carbon.api.channels.ChatChannel;
@@ -44,8 +42,6 @@ public final class MiniPlaceholdersExpansion {
     private final UserManager<?> userManager;
     private final ChannelRegistry channels;
 
-    private static byte miniPlaceholdersLoaded = -1;
-
     @Inject
     private MiniPlaceholdersExpansion(
         final UserManager<?> userManager,
@@ -56,39 +52,45 @@ private MiniPlaceholdersExpansion(
     }
 
     public static void register(final Injector injector) {
-        if (miniPlaceholdersLoaded()) {
+        if (MiniPlaceholdersUtil.miniPlaceholdersLoaded()) {
             injector.getInstance(MiniPlaceholdersExpansion.class).registerExpansion();
         }
     }
 
-    public static boolean miniPlaceholdersLoaded() {
-        if (miniPlaceholdersLoaded == -1) {
-            try {
-                final String name = MiniPlaceholders.class.getName();
-                Objects.requireNonNull(name);
-                miniPlaceholdersLoaded = 1;
-            } catch (final NoClassDefFoundError error) {
-                miniPlaceholdersLoaded = 0;
-            }
-        }
-        return miniPlaceholdersLoaded == 1;
-    }
-
     private void registerExpansion() {
         final Expansion expansion = Expansion.builder("carbonchat")
-            .filter(audience -> audience.get(Identity.UUID).isPresent())
-            .audiencePlaceholder("party", (audience, queue, ctx) ->
-                Tag.selfClosingInserting(this.partyName(id(audience))))
-            .audiencePlaceholder("nickname", (audience, queue, ctx) ->
-                Tag.selfClosingInserting(this.nickname(id(audience))))
-            .audiencePlaceholder("displayname", (audience, queue, ctx) ->
-                Tag.selfClosingInserting(this.displayName(id(audience))))
-            .audiencePlaceholder("channel_key", (audience, queue, ctx) ->
-                Tag.preProcessParsed(this.selectedChannelKey(id(audience))))
+            .audiencePlaceholder("party", (audience, queue, ctx) -> {
+                if (!hasId(audience)) {
+                    return null;
+                }
+                return Tag.selfClosingInserting(this.partyName(id(audience)));
+            })
+            .audiencePlaceholder("nickname", (audience, queue, ctx) -> {
+                if (!hasId(audience)) {
+                    return null;
+                }
+                return Tag.selfClosingInserting(this.nickname(id(audience)));
+            })
+            .audiencePlaceholder("displayname", (audience, queue, ctx) -> {
+                if (!hasId(audience)) {
+                    return null;
+                }
+                return Tag.selfClosingInserting(this.displayName(id(audience)));
+            })
+            .audiencePlaceholder("channel_key", (audience, queue, ctx) -> {
+                if (!hasId(audience)) {
+                    return null;
+                }
+                return Tag.preProcessParsed(this.selectedChannelKey(id(audience)));
+            })
             .build();
         expansion.register();
     }
 
+    private static boolean hasId(final Audience audience) {
+        return audience.get(Identity.UUID).isPresent();
+    }
+
     private static UUID id(final Audience audience) {
         return audience.get(Identity.UUID).orElseThrow();
     }

common/src/main/java/net/draycia/carbon/common/integration/miniplaceholders/MiniPlaceholdersUtil.java

@@ -0,0 +1,61 @@
+/*
+ * CarbonChat
+ *
+ * Copyright (c) 2024 Josua Parks (Vicarious)
+ *                    Contributors
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+package net.draycia.carbon.common.integration.miniplaceholders;
+
+import io.github.miniplaceholders.api.MiniPlaceholders;
+import io.github.miniplaceholders.api.types.RelationalAudience;
+import java.util.Objects;
+import net.kyori.adventure.audience.Audience;
+import org.checkerframework.checker.nullness.qual.Nullable;
+
+public final class MiniPlaceholdersUtil {
+
+    private static byte miniPlaceholdersLoaded = -1;
+
+    private MiniPlaceholdersUtil() {
+    }
+
+    public static boolean miniPlaceholdersLoaded() {
+        if (miniPlaceholdersLoaded == -1) {
+            try {
+                final String name = MiniPlaceholders.class.getName();
+                Objects.requireNonNull(name);
+                miniPlaceholdersLoaded = 1;
+            } catch (final NoClassDefFoundError error) {
+                miniPlaceholdersLoaded = 0;
+            }
+        }
+        return miniPlaceholdersLoaded == 1;
+    }
+
+    public static Audience wrapAudiences(final @Nullable Audience recipient, final Audience sender) {
+        if (!miniPlaceholdersLoaded()) {
+            return sender;
+        }
+        return wrapAudiences_(recipient, sender);
+    }
+
+    private static Audience wrapAudiences_(final @Nullable Audience recipient, final Audience sender) {
+        if (recipient == null) {
+            return sender;
+        }
+        return RelationalAudience.from(recipient, sender);
+    }
+}

common/src/main/java/net/draycia/carbon/common/listeners/ChatListenerInternal.java

@@ -102,7 +102,7 @@ protected ChatListenerInternal(
         if (sender instanceof WrappedCarbonPlayer wrapped) {
             message = wrapped.parseMessageTags(content);
         } else {
-            message = TagPermissions.parseTags(TagPermissions.MESSAGE, content, sender::hasPermission);
+            message = TagPermissions.parseTags(sender, TagPermissions.MESSAGE, content, sender::hasPermission);
         }
         if (probablyBlank(message)) {
             return null;

common/src/main/java/net/draycia/carbon/common/messages/TagPermissions.java

@@ -21,12 +21,14 @@
 
 import java.util.Map;
 import java.util.function.Predicate;
+import net.kyori.adventure.audience.Audience;
 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.TagResolver;
 import net.kyori.adventure.text.minimessage.tag.standard.StandardTags;
 import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.checkerframework.framework.qual.DefaultQualifier;
 
 @DefaultQualifier(NonNull.class)
@@ -56,7 +58,13 @@ public final class TagPermissions {
     private TagPermissions() {
     }
 
-    public static Component parseTags(final String basePermission, final String message, final Predicate<String> permission, final TagResolver.Builder resolver) {
+    public static Component parseTags(
+        final @Nullable Audience audience,
+        final String basePermission,
+        final String message,
+        final Predicate<String> permission,
+        final TagResolver.Builder resolver
+    ) {
         boolean hasAllDecorations = false;
         for (final Map.Entry<String, TagResolver> entry : DEFAULT_TAGS.entrySet()) {
             if (permission.test(basePermission + '.' + entry.getKey())) {
@@ -79,11 +87,19 @@ public static Component parseTags(final String basePermission, final String mess
 
         final MiniMessage miniMessage = MiniMessage.builder().tags(resolver.build()).build();
 
+        if (audience != null) {
+            return miniMessage.deserialize(message, audience);
+        }
         return miniMessage.deserialize(message);
     }
 
-    public static Component parseTags(final String basePermission, final String message, final Predicate<String> permission) {
-        return parseTags(basePermission, message, permission, TagResolver.builder());
+    public static Component parseTags(
+        final @Nullable Audience audience,
+        final String basePermission,
+        final String message,
+        final Predicate<String> permission
+    ) {
+        return parseTags(audience, basePermission, message, permission, TagResolver.builder());
     }
 
 }

common/src/main/java/net/draycia/carbon/common/users/WrappedCarbonPlayer.java

@@ -33,7 +33,7 @@
 import net.draycia.carbon.api.users.Party;
 import net.draycia.carbon.api.util.InventorySlot;
 import net.draycia.carbon.common.config.PrimaryConfig;
-import net.draycia.carbon.common.integration.miniplaceholders.MiniPlaceholdersExpansion;
+import net.draycia.carbon.common.integration.miniplaceholders.MiniPlaceholdersUtil;
 import net.draycia.carbon.common.messages.SourcedAudience;
 import net.draycia.carbon.common.messages.TagPermissions;
 import net.kyori.adventure.identity.Identity;
@@ -73,12 +73,12 @@ public CarbonPlayerCommon carbonPlayerCommon() {
     public Component parseMessageTags(final String message) {
         final TagResolver.Builder resolver = TagResolver.builder();
 
-        if (MiniPlaceholdersExpansion.miniPlaceholdersLoaded() && this.hasPermission("carbon.chatplaceholders")) {
-            resolver.resolver(MiniPlaceholders.getGlobalPlaceholders());
-            resolver.resolver(MiniPlaceholders.getAudiencePlaceholders(this));
+        if (MiniPlaceholdersUtil.miniPlaceholdersLoaded() && this.hasPermission("carbon.chatplaceholders")) {
+            resolver.resolver(MiniPlaceholders.globalPlaceholders());
+            resolver.resolver(MiniPlaceholders.audiencePlaceholders());
         }
 
-        return TagPermissions.parseTags(TagPermissions.MESSAGE, message, this::hasPermission, resolver);
+        return TagPermissions.parseTags(this, TagPermissions.MESSAGE, message, this::hasPermission, resolver);
     }
 
     @Override

fabric/src/main/java/net/draycia/carbon/fabric/FabricMessageRenderer.java

@@ -23,11 +23,10 @@
 import com.google.inject.Singleton;
 import io.github.miniplaceholders.api.MiniPlaceholders;
 import net.draycia.carbon.common.config.ConfigManager;
+import net.draycia.carbon.common.integration.miniplaceholders.MiniPlaceholdersUtil;
 import net.draycia.carbon.common.messages.CarbonMessageRenderer;
 import net.draycia.carbon.common.messages.RenderForTagResolver;
 import net.draycia.carbon.common.messages.SourcedAudience;
-import net.draycia.carbon.common.users.ConsoleCarbonPlayer;
-import net.draycia.carbon.fabric.users.CarbonPlayerFabric;
 import net.fabricmc.loader.api.FabricLoader;
 import net.kyori.adventure.audience.Audience;
 import net.kyori.adventure.text.Component;
@@ -57,22 +56,19 @@ public Component render(
         final String placeholderResolvedMessage = this.configManager.primaryConfig().applyCustomPlaceholders(intermediateMessage);
 
         if (FabricLoader.getInstance().isModLoaded("miniplaceholders")) {
-            tagResolver.resolver(MiniPlaceholders.getGlobalPlaceholders());
+            tagResolver.resolver(MiniPlaceholders.globalPlaceholders());
 
-            if (receiver instanceof SourcedAudience sourced) {
-                if (sourced.sender() instanceof CarbonPlayerFabric sender) {
-                    tagResolver.resolver(MiniPlaceholders.getAudiencePlaceholders(sender));
-                    if (sourced.recipient() instanceof CarbonPlayerFabric recipient && recipient.online()) {
-                        tagResolver.resolver(MiniPlaceholders.getRelationalPlaceholders(recipient, sender));
-                    }
-                } else if (sourced.sender() instanceof ConsoleCarbonPlayer console) {
-                    // I don't know if this will ever actually resolve anything, or if anything supports console audience
-                    tagResolver.resolver(MiniPlaceholders.getAudiencePlaceholders(console));
-                }
+            if (receiver instanceof SourcedAudience) {
+                tagResolver.resolver(MiniPlaceholders.audiencePlaceholders());
+                tagResolver.resolver(MiniPlaceholders.relationalPlaceholders());
             }
         }
 
-        return MiniMessage.miniMessage().deserialize(placeholderResolvedMessage, tagResolver.build());
+        final Audience parseAudience = receiver instanceof SourcedAudience sourced
+            ? MiniPlaceholdersUtil.wrapAudiences(sourced.recipient(), sourced.sender())
+            : receiver;
+
+        return MiniMessage.miniMessage().deserialize(placeholderResolvedMessage, parseAudience, tagResolver.build());
     }
 
 }

gradle/libs.versions.toml

@@ -44,7 +44,7 @@ luckPermsApi = "5.4"
 essentialsx = "2.20.1"
 discordsrv = "1.28.1"
 placeholderapi = "2.11.6"
-miniplaceholders = "2.3.0"
+miniplaceholders = "3.0.1"
 jdbi = "3.49.5"
 hikari = "6.3.0"
 mysql = "9.3.0"

paper/src/main/java/net/draycia/carbon/paper/integration/dsrv/DSRVListener.java

@@ -97,7 +97,7 @@ public void register() {
             if (carbonPlayer instanceof WrappedCarbonPlayer wrapped) {
                 eventMessage = wrapped.parseMessageTags(messageContents);
             } else {
-                eventMessage = TagPermissions.parseTags(TagPermissions.MESSAGE, messageContents, carbonPlayer::hasPermission);
+                eventMessage = TagPermissions.parseTags(carbonPlayer, TagPermissions.MESSAGE, messageContents, carbonPlayer::hasPermission);
             }
 
             DiscordSRV.debug(Debug.MINECRAFT_TO_DISCORD, "Received a CarbonChatEvent (player: " + carbonPlayer.username() + ")");