Spigot / Bukkit / 9cb65d72a3a

Commits

md_5 authored 9cb65d72a3a 10 Jul 2018

Be more strict about what constitutes a valid NamespacedKey

* Brings us largely in line with what is supported by the implementation
* Adds unit tests

src/main/java/org/bukkit/NamespacedKey.java

Modified

-1
+package org.bukkit;
-2
-3
+import com.google.common.base.Preconditions;
-4
+import java.util.Locale;
-5
+import java.util.UUID;
-+
+import java.util.regex.Pattern;
-7
+import org.bukkit.plugin.Plugin;
-8
-9
+/**
-10
+ * Represents a String based key which consists of two components - a namespace
-11
+ * and a key.
-+
+ *
-+
+ * Namespaces may only contain lowercase alphanumeric characters, periods,
-+
+ * underscores, and hyphens.
-+
+ * <p>
-+
+ * Keys may only contain lowercase alphanumeric characters, periods,
-+
+ * underscores, hyphens, and forward slashes.
-+
+ *
-19
+ */
-20
+public final class NamespacedKey {
-21
-22
+    /**
-23
+     * The namespace representing all inbuilt keys.
-24
+     */
-25
+    public static final String MINECRAFT = "minecraft";
-26
+    /**
-27
+     * The namespace representing all keys generated by Bukkit for backwards
-28
+     * compatibility measures.
-29
+     */
-30
+    public static final String BUKKIT = "bukkit";
-31
+    //
-+
+    private static final Pattern VALID_NAMESPACE = Pattern.compile("[a-z0-9._-]+");
-+
+    private static final Pattern VALID_KEY = Pattern.compile("[a-z0-9/._-]+");
-+
+    //
-35
+    private final String namespace;
-36
+    private final String key;
-37
-38
+    /**
-39
+     * Create a key in a specific namespace.
-40
+     *
-41
+     * @param namespace
-42
+     * @param key
-43
+     * @deprecated should never be used by plugins, for internal use only!!
-44
+     */
-45
+    @Deprecated
-46
+    public NamespacedKey(String namespace, String key) {
--
+        Preconditions.checkArgument(namespace != null && !namespace.isEmpty(), "namespace");
--
+        Preconditions.checkArgument(key != null, "key");
-+
+        Preconditions.checkArgument(namespace != null && VALID_NAMESPACE.matcher(namespace).matches(), "namespace");
-+
+        Preconditions.checkArgument(key != null && VALID_KEY.matcher(key).matches(), "key");
-49
-50
+        this.namespace = namespace;
-51
+        this.key = key;
-52
-53
+        String string = toString();
--
+        Preconditions.checkArgument(string.indexOf(' ') == -1, "NamespacedKey cannot contain spaces (%s)", string);
-54
+        Preconditions.checkArgument(string.length() < 256, "NamespacedKey must be less than 256 characters", string);
-55
+    }
-56
-57
+    /**
-58
+     * Create a key in the plugin's namespace.
-59
+     *
-60
+     * @param plugin the plugin to use for the namespace
-61
+     * @param key the key to create
-62
+     */
-63
+    public NamespacedKey(Plugin plugin, String key) {
-64
+        Preconditions.checkArgument(plugin != null, "plugin");
-65
+        Preconditions.checkArgument(key != null, "key");
-66
--
+        // Plugin names cannot have spaces anymore (SimplePluginManager)
--
+        Preconditions.checkArgument(key.indexOf(' ') == -1, "key cannot contain spaces (%s)", key);
--
-67
+        this.namespace = plugin.getName().toLowerCase(Locale.ROOT);
-68
+        this.key = key.toLowerCase().toLowerCase(Locale.ROOT);
-69
-+
+        // Check validity after normalization
-+
+        Preconditions.checkArgument(VALID_NAMESPACE.matcher(namespace).matches(), "namespace");
-+
+        Preconditions.checkArgument(VALID_KEY.matcher(key).matches(), "key");
-+
-74
+        String string = toString();
-75
+        Preconditions.checkArgument(string.length() < 256, "NamespacedKey must be less than 256 characters (%s)", string);
-76
+    }
-77
-78
+    public String getNamespace() {
-79
+        return namespace;
-80
+    }
-81
-82
+    public String getKey() {
-83
+        return key;

Bukkit

Commits

Jira Issues

Add shortcut