Add ability to register custom item transformers.

Author: Golfing7

Essentials/src/main/java/com/earth2me/essentials/MetaItemStack.java

@@ -1,5 +1,6 @@
 package com.earth2me.essentials;
 
+import com.earth2me.essentials.items.transform.PluginItemTransformer;
 import com.earth2me.essentials.textreader.BookInput;
 import com.earth2me.essentials.textreader.BookPager;
 import com.earth2me.essentials.textreader.IText;
@@ -10,10 +11,7 @@
 import com.earth2me.essentials.utils.VersionUtil;
 import com.google.common.base.Joiner;
 import net.ess3.api.IEssentials;
-import org.bukkit.Color;
-import org.bukkit.DyeColor;
-import org.bukkit.FireworkEffect;
-import org.bukkit.Material;
+import org.bukkit.*;
 import org.bukkit.block.Banner;
 import org.bukkit.block.banner.PatternType;
 import org.bukkit.enchantments.Enchantment;
@@ -47,6 +45,9 @@
 public class MetaItemStack {
     private static final Map<String, DyeColor> colorMap = new HashMap<>();
     private static final Map<String, FireworkEffect.Type> fireworkShape = new HashMap<>();
+
+    //Contains plugin registered item meta data transformers.
+    private static final transient Map<String, PluginItemTransformer> itemTransformers = new HashMap<>();
     private static boolean useNewSkullMethod = true;
 
     static {
@@ -78,6 +79,32 @@ public MetaItemStack(final ItemStack stack) {
         this.stack = stack.clone();
     }
 
+    /**
+     * Registers an item transformer, belonging to a plugin, that can manipulate certain item metadata.
+     * @param key the key for the transformer.
+     * @param itemTransformer the actual transformer.
+     */
+    public static void registerItemTransformer(String key, PluginItemTransformer itemTransformer){
+        //Warn people if they're trying to register over top of someone else.
+        if(itemTransformers.containsKey(key)){
+            Bukkit.getLogger().warning(String.format("[Essentials] - Plugin transformer registered to \"%s\" attempted to register already existing item transformer \"%s\" belonging to \"%s\"!",
+                    itemTransformer.getPlugin().getName(),
+                    key,
+                    itemTransformers.get(key).getPlugin().getName()));
+            return;
+        }
+
+        itemTransformers.put(key, itemTransformer);
+    }
+
+    /**
+     * Unregisters a certain item transformer under key "key".
+     * @param key the transformer key.
+     */
+    public static void unregisterItemTransformer(String key){
+        itemTransformers.remove(key);
+    }
+
     private static void setSkullOwner(final IEssentials ess, final ItemStack stack, final String owner) {
         if (!(stack.getItemMeta() instanceof SkullMeta)) return;
 
@@ -303,11 +330,28 @@ public void addStringMeta(final CommandSource sender, final boolean allowUnsafe,
             } else {
                 throw new Exception(tl("leatherSyntax"));
             }
+        } else if (split.length > 1 && itemTransformers.containsKey(split[0])) {
+            transformItem(split[0], split[1]);
         } else {
             parseEnchantmentStrings(sender, allowUnsafe, split, ess);
         }
     }
 
+    private void transformItem(String key, String data){
+        PluginItemTransformer transformer = itemTransformers.get(key);
+
+        //Ignore, the plugin is disabled.
+        if(!transformer.getPlugin().isEnabled())
+            return;
+
+        try{
+            stack = transformer.apply(data, stack);
+        }catch(Throwable thr){
+            Bukkit.getLogger().severe(String.format("[Essentials] - Error applying data \"%s\" to itemstack! Plugin: %s, Key: %s", data, transformer.getPlugin().getName(), key));
+            thr.printStackTrace();
+        }
+    }
+
     public void addItemFlags(final String string) throws Exception {
         final String[] separate = splitPattern.split(string, 2);
         if (separate.length != 2) {

Essentials/src/main/java/com/earth2me/essentials/items/transform/PluginItemTransformer.java

@@ -0,0 +1,21 @@
+package com.earth2me.essentials.items.transform;
+
+import org.bukkit.inventory.ItemStack;
+import org.bukkit.plugin.Plugin;
+
+public abstract class PluginItemTransformer {
+    private final Plugin plugin;
+
+    public PluginItemTransformer(Plugin thePlugin){
+        if(thePlugin == null)
+            throw new IllegalArgumentException("Plugin cannot be null!");
+
+        this.plugin = thePlugin;
+    }
+
+    public abstract ItemStack apply(String data, ItemStack original);
+
+    public Plugin getPlugin() {
+        return plugin;
+    }
+}