From 45b338fd9b56f035916398e94b382bc9d4390cb2 Mon Sep 17 00:00:00 2001 From: Business Goose Date: Wed, 4 May 2022 17:08:35 +0100 Subject: [PATCH] Make a safe mini message class with a custom tag resolver --- .../java/dev/plex/command/impl/TagCMD.java | 18 +------ .../dev/plex/listener/impl/ChatListener.java | 4 +- .../main/java/dev/plex/rank/RankManager.java | 4 +- .../main/java/dev/plex/util/PlexUtils.java | 20 +++----- .../util/minimessage/SafeMiniMessage.java | 48 +++++++++++++++++++ 5 files changed, 61 insertions(+), 33 deletions(-) create mode 100644 server/src/main/java/dev/plex/util/minimessage/SafeMiniMessage.java diff --git a/server/src/main/java/dev/plex/command/impl/TagCMD.java b/server/src/main/java/dev/plex/command/impl/TagCMD.java index e03658b..5f70123 100644 --- a/server/src/main/java/dev/plex/command/impl/TagCMD.java +++ b/server/src/main/java/dev/plex/command/impl/TagCMD.java @@ -7,10 +7,9 @@ import dev.plex.command.annotation.CommandPermissions; import dev.plex.command.source.RequiredCommandSource; import dev.plex.player.PlexPlayer; import dev.plex.rank.enums.Rank; -import dev.plex.util.PlexUtils; +import dev.plex.util.minimessage.SafeMiniMessage; import net.kyori.adventure.text.Component; import net.kyori.adventure.text.minimessage.MiniMessage; -import net.kyori.adventure.text.minimessage.tag.standard.StandardTags; import net.kyori.adventure.text.serializer.plain.PlainTextComponentSerializer; import org.apache.commons.lang.StringUtils; import org.bukkit.command.CommandSender; @@ -49,7 +48,7 @@ public class TagCMD extends PlexCommand } String prefix = StringUtils.join(args, " ", 1, args.length); - Component convertedComponent = removeEvents(PlexUtils.mmCustomDeserialize(prefix = prefix.replace("", "").replace("
", ""), StandardTags.color(), StandardTags.rainbow(), StandardTags.decorations(), StandardTags.gradient(), StandardTags.transition())); //noColorComponentFromString(prefix) + Component convertedComponent = SafeMiniMessage.mmDeserializeWithoutEvents(prefix); if (PlainTextComponentSerializer.plainText().serialize(convertedComponent).length() > plugin.config.getInt("chat.max-tag-length", 16)) { @@ -90,19 +89,6 @@ public class TagCMD extends PlexCommand } return usage(); } - - private Component removeEvents(Component component) - { - if (component.clickEvent() != null) - { - component = component.clickEvent(null); - } - if (component.hoverEvent() != null) - { - component = component.hoverEvent(null); - } - return component; - } } diff --git a/server/src/main/java/dev/plex/listener/impl/ChatListener.java b/server/src/main/java/dev/plex/listener/impl/ChatListener.java index c600dda..493040b 100644 --- a/server/src/main/java/dev/plex/listener/impl/ChatListener.java +++ b/server/src/main/java/dev/plex/listener/impl/ChatListener.java @@ -5,11 +5,11 @@ import dev.plex.listener.PlexListener; import dev.plex.listener.annotation.Toggleable; import dev.plex.player.PlexPlayer; import dev.plex.util.PlexUtils; +import dev.plex.util.minimessage.SafeMiniMessage; import io.papermc.paper.chat.ChatRenderer; import io.papermc.paper.event.player.AsyncChatEvent; import net.kyori.adventure.audience.Audience; import net.kyori.adventure.text.Component; -import net.kyori.adventure.text.TextComponent; import net.kyori.adventure.text.TextReplacementConfig; import net.kyori.adventure.text.event.ClickEvent; import net.kyori.adventure.text.format.NamedTextColor; @@ -75,7 +75,7 @@ public class ChatListener extends PlexListener .append(Component.space()) .append(Component.text("ยป").color(NamedTextColor.GRAY)) .append(Component.space()) - .append(PlexUtils.mmDeserialize(text)) + .append(SafeMiniMessage.mmDeserializeWithoutEvents(text)) .replaceText(URL_REPLACEMENT_CONFIG); } } diff --git a/server/src/main/java/dev/plex/rank/RankManager.java b/server/src/main/java/dev/plex/rank/RankManager.java index 4b7e984..41c25de 100644 --- a/server/src/main/java/dev/plex/rank/RankManager.java +++ b/server/src/main/java/dev/plex/rank/RankManager.java @@ -5,6 +5,7 @@ import dev.plex.player.PlexPlayer; import dev.plex.rank.enums.Rank; import dev.plex.rank.enums.Title; import dev.plex.util.PlexUtils; +import dev.plex.util.minimessage.SafeMiniMessage; import java.io.File; import java.io.FileInputStream; import java.io.FileWriter; @@ -14,7 +15,6 @@ import java.util.stream.Collectors; import lombok.SneakyThrows; import net.kyori.adventure.text.Component; import net.kyori.adventure.text.format.NamedTextColor; -import net.kyori.adventure.text.minimessage.tag.standard.StandardTags; import org.json.JSONArray; import org.json.JSONObject; import org.json.JSONTokener; @@ -95,7 +95,7 @@ public class RankManager { if (!player.getPrefix().equals("")) { - return PlexUtils.mmCustomDeserialize(player.getPrefix(), StandardTags.color(), StandardTags.rainbow(), StandardTags.decorations(), StandardTags.gradient(), StandardTags.transition()); + return SafeMiniMessage.mmDeserializeWithoutEvents(player.getPrefix()); } if (Plex.get().config.contains("titles.owners") && Plex.get().config.getStringList("titles.owners").contains(player.getName())) { diff --git a/server/src/main/java/dev/plex/util/PlexUtils.java b/server/src/main/java/dev/plex/util/PlexUtils.java index 137dd4a..6be9f53 100644 --- a/server/src/main/java/dev/plex/util/PlexUtils.java +++ b/server/src/main/java/dev/plex/util/PlexUtils.java @@ -30,6 +30,8 @@ import org.bukkit.plugin.Plugin; public class PlexUtils implements PlexBase { + private static final MiniMessage MINI_MESSAGE = MiniMessage.miniMessage(); + public static List DEVELOPERS = Arrays.asList("78408086-1991-4c33-a571-d8fa325465b2", // Telesphoreo "f5cd54c4-3a24-4213-9a56-c06c49594dff", // Taahh @@ -114,14 +116,6 @@ public class PlexUtils implements PlexBase return false; } - private static final MiniMessage safeMessage = MiniMessage.builder().tags(TagResolver.builder().resolvers( - StandardTags.color(), - StandardTags.decorations(), - StandardTags.gradient(), - StandardTags.rainbow(), - StandardTags.reset() - ).build()).build(); - public static String mmStripColor(String input) { return PlainTextComponentSerializer.plainText().serialize(mmDeserialize(input)); @@ -137,10 +131,10 @@ public class PlexUtils implements PlexBase ZonedDateTime date = ZonedDateTime.now(ZoneId.of(TimeUtils.TIMEZONE)); if (aprilFools && date.getMonth() == Month.APRIL && date.getDayOfMonth() == 1) { - Component component = MiniMessage.miniMessage().deserialize(input); // removes existing tags - return MiniMessage.miniMessage().deserialize("" + PlainTextComponentSerializer.plainText().serialize(component)); + Component component = MINI_MESSAGE.deserialize(input); // removes existing tags + return MINI_MESSAGE.deserialize("" + PlainTextComponentSerializer.plainText().serialize(component)); } - return MiniMessage.miniMessage().deserialize(input); + return MINI_MESSAGE.deserialize(input); } public static Component mmCustomDeserialize(String input, TagResolver... resolvers) @@ -150,7 +144,7 @@ public class PlexUtils implements PlexBase public static Component messageComponent(String entry, Object... objects) { - return MiniMessage.miniMessage().deserialize(messageString(entry, objects)); + return MINI_MESSAGE.deserialize(messageString(entry, objects)); } public static String messageString(String entry, Object... objects) @@ -208,7 +202,7 @@ public class PlexUtils implements PlexBase public static void broadcast(String s) { - Bukkit.broadcast(MiniMessage.miniMessage().deserialize(s)); + Bukkit.broadcast(MINI_MESSAGE.deserialize(s)); } public static void broadcast(Component component) diff --git a/server/src/main/java/dev/plex/util/minimessage/SafeMiniMessage.java b/server/src/main/java/dev/plex/util/minimessage/SafeMiniMessage.java new file mode 100644 index 0000000..3a76bac --- /dev/null +++ b/server/src/main/java/dev/plex/util/minimessage/SafeMiniMessage.java @@ -0,0 +1,48 @@ +package dev.plex.util.minimessage; + +import com.google.common.collect.ImmutableList; +import java.util.List; +import net.kyori.adventure.text.Component; +import net.kyori.adventure.text.minimessage.Context; +import net.kyori.adventure.text.minimessage.MiniMessage; +import net.kyori.adventure.text.minimessage.ParsingException; +import net.kyori.adventure.text.minimessage.tag.Tag; +import net.kyori.adventure.text.minimessage.tag.resolver.ArgumentQueue; +import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +public class SafeMiniMessage +{ + public static final MiniMessage MINI_MESSAGE = MiniMessage.builder().tags(new SafeMiniMessageTagResolver()).build(); + + public static Component mmDeserialize(String text) + { + return MINI_MESSAGE.deserialize(text); + } + + public static Component mmDeserializeWithoutEvents(String text) + { + return mmDeserialize(text) + .clickEvent(null) + .hoverEvent(null); + } + + public static class SafeMiniMessageTagResolver implements TagResolver + { + private static final TagResolver STANDARD_RESOLVER = TagResolver.standard(); + private static final List IGNORED_TAGS = ImmutableList.of("obfuscated", "obf", "br", "newline"); + + @Override + public @Nullable Tag resolve(@NotNull String name, @NotNull ArgumentQueue arguments, @NotNull Context ctx) throws ParsingException + { + return IGNORED_TAGS.contains(name.toLowerCase()) ? null : STANDARD_RESOLVER.resolve(name, arguments, ctx); + } + + @Override + public boolean has(@NotNull String name) + { + return STANDARD_RESOLVER.has(name); + } + } +}