Spigot / CraftBukkit / ff2b9440f54

Commits

blablubbabc authored and md_5 committed ff2b9440f54 03 Jan 2021

SPIGOT-6304: Removed the detection of legacy text based on color codes

Apparently there are items and plugins out there that still use legacy
color codes within text components, and which thereby break this
heuristic.

Our remaining approach to differentiate between legacy (plain) and
modern (JSON-based) text is to check if a particular text can be parsed
as JSON-based text. This approach is not perfect either as there are
ambiguous cases that it cannot resolve correctly. However, these cases
are hopefully rare enough in practice that this approach remains
suitable.

src/main/java/org/bukkit/craftbukkit/util/CraftChatMessage.java

Modified

-17
+import net.minecraft.server.ChatModifier;
-18
+import net.minecraft.server.EnumChatFormat;
-19
+import net.minecraft.server.IChatBaseComponent;
-20
+import net.minecraft.server.IChatMutableComponent;
-21
+import org.bukkit.ChatColor;
-22
-23
+public final class CraftChatMessage {
-24
-25
+    private static final Pattern LINK_PATTERN = Pattern.compile("((?:(?:https?):\\/\\/)?(?:[-\\w_\\.]{2,}\\.[a-z]{2,4}.*?(?=[\\.\\?!,;:]?(?:[" + String.valueOf(org.bukkit.ChatColor.COLOR_CHAR) + " \\n]|$))))");
-26
+    private static final Map<Character, EnumChatFormat> formatMap;
--
+    private static final String COLOR_CHAR_STRING = String.valueOf(ChatColor.COLOR_CHAR);
-27
-28
+    static {
-29
+        Builder<Character, EnumChatFormat> builder = ImmutableMap.builder();
-30
+        for (EnumChatFormat format : EnumChatFormat.values()) {
-31
+            builder.put(Character.toLowerCase(format.toString().charAt(1)), format);
-32
+        }
-33
+        formatMap = builder.build();
-34
+    }
-35
-36
+    public static EnumChatFormat getColor(ChatColor color) {
-208
+        return fromJSONOrString(message, false);
-209
+    }
-210
-211
+    public static IChatBaseComponent fromJSONOrString(String message, boolean keepNewlines) {
-212
+        return fromJSONOrString(message, false, keepNewlines);
-213
+    }
-214
-215
+    private static IChatBaseComponent fromJSONOrString(String message, boolean nullable, boolean keepNewlines) {
-216
+        if (message == null) message = "";
-217
+        if (nullable && message.isEmpty()) return null;
--
+        if (isLegacy(message)) {
--
+            return fromString(message, keepNewlines)[0];
-+
+        IChatBaseComponent component = fromJSONOrNull(message);
-+
+        if (component != null) {
-+
+            return component;
-221
+        } else {
--
+            IChatBaseComponent component = fromJSONOrNull(message);
--
+            if (component != null) {
--
+                return component;
--
+            } else {
--
+                return fromString(message, keepNewlines)[0];
--
+            }
-+
+            return fromString(message, keepNewlines)[0];
-223
+        }
-224
+    }
-225
-226
+    public static String fromJSONOrStringToJSON(String message) {
-227
+        return fromJSONOrStringToJSON(message, false);
-228
+    }
-229
-230
+    public static String fromJSONOrStringToJSON(String message, boolean keepNewlines) {
-231
+        return fromJSONOrStringToJSON(message, false, keepNewlines, Integer.MAX_VALUE, false);
-232
+    }
-235
+        return fromJSONOrStringOrNullToJSON(message, false);
-236
+    }
-237
-238
+    public static String fromJSONOrStringOrNullToJSON(String message, boolean keepNewlines) {
-239
+        return fromJSONOrStringToJSON(message, true, keepNewlines, Integer.MAX_VALUE, false);
-240
+    }
-241
-242
+    public static String fromJSONOrStringToJSON(String message, boolean nullable, boolean keepNewlines, int maxLength, boolean checkJsonContentLength) {
-243
+        if (message == null) message = "";
-244
+        if (nullable && message.isEmpty()) return null;
--
+        if (isLegacy(message)) {
--
+            message = trimMessage(message, maxLength);
--
+            return fromStringToJSON(message, keepNewlines);
--
+        } else {
--
+            // If the input can be parsed as JSON, we use that:
--
+            IChatBaseComponent component = fromJSONOrNull(message);
--
+            if (component != null) {
--
+                if (checkJsonContentLength) {
--
+                    String content = fromComponent(component);
--
+                    String trimmedContent = trimMessage(content, maxLength);
--
+                    if (content != trimmedContent) { // identity comparison is fine here
--
+                        // Note: The resulting text has all non-plain text features stripped.
--
+                        return fromStringToJSON(trimmedContent, keepNewlines);
--
+                    }
-+
+        // If the input can be parsed as JSON, we use that:
-+
+        IChatBaseComponent component = fromJSONOrNull(message);
-+
+        if (component != null) {
-+
+            if (checkJsonContentLength) {
-+
+                String content = fromComponent(component);
-+
+                String trimmedContent = trimMessage(content, maxLength);
-+
+                if (content != trimmedContent) { // identity comparison is fine here
-+
+                    // Note: The resulting text has all non-plain text features stripped.
-+
+                    return fromStringToJSON(trimmedContent, keepNewlines);
-254
+                }
--
+                return message;
--
+            } else {
--
+                // Else we interpret the input as legacy text:
--
+                message = trimMessage(message, maxLength);
--
+                return fromStringToJSON(message, keepNewlines);
-255
+            }
-+
+            return message;
-+
+        } else {
-+
+            // Else we interpret the input as legacy text:
-+
+            message = trimMessage(message, maxLength);
-+
+            return fromStringToJSON(message, keepNewlines);
-261
+        }
-262
+    }
-263
-264
+    public static String trimMessage(String message, int maxLength) {
-265
+        if (message != null && message.length() > maxLength) {
-266
+            return message.substring(0, maxLength);
-267
+        } else {
-268
+            return message;
-269
+        }
-270
+    }
-271
--
+    // Heuristic detection of legacy (plain) text.
--
+    // May produce false-negatives: I.e. a return value of false does not imply that the text represents modern (JSON-based) text.
--
+    // We also consider empty Strings as legacy. The component deserializer cannot parse them (produces null).
--
+    private static boolean isLegacy(String message) {
--
+        // assert: message != null
--
+        return message.trim().isEmpty() || message.contains(COLOR_CHAR_STRING);
--
+    }
--
-272
+    public static String fromStringToJSON(String message) {
-273
+        return fromStringToJSON(message, false);
-274
+    }
-275
-276
+    public static String fromStringToJSON(String message, boolean keepNewlines) {
-277
+        IChatBaseComponent component = CraftChatMessage.fromString(message, keepNewlines)[0];
-278
+        return CraftChatMessage.toJSON(component);
-279
+    }
-280
-281
+    public static String fromStringOrNullToJSON(String message) {

CraftBukkit

Commits

Jira Issues

Add shortcut