Fixes some edge-cases in the NBT and RawText APIs.

prokopyl · prokopyl · commit f8fa3bae978e · 2016-05-22T08:37:30.000+02:00
[NBT]
* NEW: NBTCompound and NBTList: toString() now returns the NBT/JSON 
  representation of the tag.
* NEW: When putting a container tag into another, values are now
  properly linked rather than copied over.
* BUG: The NBT API can now handle null CraftItemStack values (i.e.
  invalid item types).
* BUG: NBTCompound and NBTList: Fixed parent tags management.

[ITEM UTILITIES]
* NEW: ItemBuilder.craftItem() is a new methods that returns the 
  built item as a CraftBukkit CraftItemStack instead of the standard 
  Bukkit ItemStack, allowing to assign NBT data directly on it.
* BUG: ItemUtilities can now handle null CraftItemStack values (i.e.
  invalid item types).

[RAW TEXT]
* BUG: Fixed fallback mechanisms for item ids.

[WORLD UTILITIES]
* NEW: WorldUtils.get4thOrientation() is a new method that returns the
  blockFace orientation associated to a specified Location's yaw value.
diff --git a/src/main/java/fr/zcraft/zlib/components/attributes/Attribute.java b/src/main/java/fr/zcraft/zlib/components/attributes/Attribute.java
@@ -155,7 +155,7 @@ public final void setUUID(UUID uuid)
     
     /**
      * Returns the Minecraft NBT/JSON string representation of this attribute.
-     * See {@link fr.zcraft.zlib.tools.nbt.NBT#toNBTJSONString(java.lang.Object) } for more information.
+     * See {@link NBT#toNBTJSONString(java.lang.Object) } for more information.
      * @return the Minecraft NBT/JSON string representation of this attribute.
      */
     @Override
diff --git a/src/main/java/fr/zcraft/zlib/components/nbt/NBT.java b/src/main/java/fr/zcraft/zlib/components/nbt/NBT.java
@@ -190,6 +190,7 @@ static private void init() throws NMSException
     static private Object getMcNBTCompound(ItemStack item) throws NMSException
     {
         Object mcItemStack = ItemUtils.getNMSItemStack(item);
+        if(mcItemStack == null) return null;
         try
         {
             return Reflection.getFieldValue(MC_ITEM_STACK, mcItemStack, "tag");
diff --git a/src/main/java/fr/zcraft/zlib/components/nbt/NBTCompound.java b/src/main/java/fr/zcraft/zlib/components/nbt/NBTCompound.java
@@ -45,7 +45,7 @@
 public class NBTCompound implements Map<String, Object>
 {
     private Object nmsNbtTag;
-    private Map<String, Object> nmsNbtMap;
+    Map<String, Object> nmsNbtMap;
     
     private final Object parent;
     private final Object parentKey;
@@ -66,7 +66,14 @@ public NBTCompound()
     NBTCompound(Object nativeNBTTag)
     {
         this.nmsNbtTag = nativeNBTTag;
-        this.nmsNbtMap = (Map<String, Object>) NBTType.TAG_COMPOUND.getData(nmsNbtTag);
+        if(nativeNBTTag == null)
+        {
+            this.nmsNbtMap = new HashMap<String, Object>();
+        }
+        else
+        {
+            this.nmsNbtMap = (Map<String, Object>) NBTType.TAG_COMPOUND.getData(nmsNbtTag);
+        }
         this.parent = null;
         this.parentKey = null;
     }
@@ -99,6 +106,8 @@ private Map<String, Object> getNbtMap()
             else
             {
                 nmsNbtTag = NBTType.TAG_COMPOUND.newTag(nmsNbtMap);
+                NBTType.TAG_LIST.setData(nmsNbtTag, nmsNbtTag);
+                
                 if(parent != null && parentKey != null)
                 {
                     if(parent instanceof NBTCompound)
@@ -247,6 +256,12 @@ public Collection<Object> values()
         }
         return list;
     }
+    
+    @Override
+    public String toString()
+    {
+        return NBT.toNBTJSONString(this);
+    }
 
     @Override
     public Set<Entry<String, Object>> entrySet()
diff --git a/src/main/java/fr/zcraft/zlib/components/nbt/NBTList.java b/src/main/java/fr/zcraft/zlib/components/nbt/NBTList.java
@@ -45,7 +45,7 @@
 public class NBTList implements List<Object>
 {
     private Object nmsNbtTag;
-    private List<Object> nmsNbtList;
+    List<Object> nmsNbtList;
     
     private final Object parent;
     private final Object parentKey;
@@ -62,7 +62,7 @@ public NBTList()
     
     NBTList(Object nmsListTag)
     {
-        this(nmsListTag, (List<Object>) NBTType.TAG_LIST.getData(nmsListTag));
+        this(null, nmsListTag == null ? new ArrayList<>() : (List<Object>) NBTType.TAG_LIST.getData(nmsListTag));
     }
     
     private NBTList(Object nmsListTag, List<Object> nmsNbtList)
@@ -101,6 +101,8 @@ private List<Object> getNbtList()
             else
             {
                 nmsNbtTag = NBTType.TAG_LIST.newTag(nmsNbtList);
+                NBTType.TAG_LIST.setData(nmsNbtTag, nmsNbtList);
+                
                 if(parent != null && parentKey != null)
                 {
                     if(parent instanceof NBTCompound)
@@ -407,6 +409,12 @@ public <T> ListIterator<T> filter(Class<T> klass, int index)
         return new NBTListFilterIterator<T>(listIterator(index));
     }
     
+    @Override
+    public String toString()
+    {
+        return NBT.toNBTJSONString(this);
+    }
+    
     private class NBTListIterator implements ListIterator<Object>
     {
         private ListIterator<Object> iterator;
diff --git a/src/main/java/fr/zcraft/zlib/components/nbt/NBTType.java b/src/main/java/fr/zcraft/zlib/components/nbt/NBTType.java
@@ -129,11 +129,25 @@ public Object newTag(Object value)
             {
                 case TAG_COMPOUND:
                     tag = Reflection.instantiate(getNMSClass());
-                    new NBTCompound(tag).putAll((Map) value);
+                    if(value instanceof NBTCompound)
+                    {
+                        setData(tag, ((NBTCompound)value).nmsNbtMap);
+                    }
+                    else
+                    {
+                        new NBTCompound(tag).putAll((Map) value);
+                    }
                     break;
                 case TAG_LIST:
                     tag = Reflection.instantiate(getNMSClass());
-                    new NBTList(tag).addAll((List) value);
+                    if(value instanceof NBTList)
+                    {
+                        setData(tag, ((NBTList)value).nmsNbtList);
+                    }
+                    else
+                    {
+                        new NBTList(tag).addAll((List) value);
+                    }
                     break;
                 default:
                     tag = Reflection.findConstructor(getNMSClass(), 1).newInstance(value);
diff --git a/src/main/java/fr/zcraft/zlib/components/rawtext/RawText.java b/src/main/java/fr/zcraft/zlib/components/rawtext/RawText.java
@@ -109,16 +109,19 @@ static public String toJSONString(ItemStack item)
     {
         Map<String, Object> itemData = new HashMap<String, Object>();
         
+        String itemId = null;
         try
         {
-            itemData.put("id", ItemUtils.getMinecraftId(item));
+            itemId = ItemUtils.getMinecraftId(item);
         }
         catch (NMSException ex)
         {
             PluginLogger.warning("NMS Exception while parsing ItemStack to JSON String", ex);
-            itemData.put("id", item.getTypeId());
         }
         
+        if(itemId == null) itemId = String.valueOf(item.getType().getId());
+        itemData.put("id", itemId);
+        
         itemData.put("Damage", item.getDurability());
         try
         {
diff --git a/src/main/java/fr/zcraft/zlib/tools/items/ItemStackBuilder.java b/src/main/java/fr/zcraft/zlib/tools/items/ItemStackBuilder.java
@@ -33,6 +33,8 @@
 import fr.zcraft.zlib.components.gui.GuiUtils;
 import fr.zcraft.zlib.components.rawtext.RawText;
 import fr.zcraft.zlib.components.rawtext.RawTextPart;
+import fr.zcraft.zlib.tools.PluginLogger;
+import fr.zcraft.zlib.tools.reflection.NMSException;
 import org.bukkit.ChatColor;
 import org.bukkit.DyeColor;
 import org.bukkit.Material;
@@ -162,6 +164,33 @@ public ItemStack item()
 
         return newItemStack;
     }
+    
+    /**
+     * Creates (or updates) the ItemStack, with all the previously provided
+     * parameters, and returns it as a CraftItemStack (the Bukkit internal 
+     * ItemStack representation).
+     * 
+     * Unlike ItemStacks, CraftItemStacks are registered into NMS, and therefore
+     * will be able to hold NBT data (such as attributes and such).
+     * 
+     * Note that the returned ItemStack WILL be a copy of the previously 
+     * provided one (if any).
+     * 
+     * @return The new CraftItemStack.
+     */
+    public ItemStack craftItem()
+    {
+        ItemStack bukkitItem = item();
+        try
+        {
+            return (ItemStack) ItemUtils.asCraftCopy(item());
+        }
+        catch(NMSException ex)
+        {
+            PluginLogger.warning("CraftItem failed", ex);
+            return bukkitItem;
+        }
+    }
 
     /**
      * Defines the material of the ItemStack. This can only be defined once,
diff --git a/src/main/java/fr/zcraft/zlib/tools/items/ItemUtils.java b/src/main/java/fr/zcraft/zlib/tools/items/ItemUtils.java
@@ -388,7 +388,8 @@ static private Method getRegistryLookupMethod() throws NMSException
      * </p>
      *
      * @param item An item.
-     * @return The Minecraft name of this item.
+     * @return The Minecraft name of this item, or null if the item's material 
+     * is invalid.
      *
      * @throws NMSException
      */
@@ -397,6 +398,8 @@ static public String getMinecraftId(ItemStack item) throws NMSException
         try
         {
             Object craftItemStack = asNMSCopy(item);
+            if(craftItemStack == null) return null;
+            
             Object minecraftItem = Reflection.getFieldValue(craftItemStack, "item");
             Class<?> MinecraftItem = Reflection.getMinecraftClassByName("Item");
             Object ItemsRegistry = Reflection.getFieldValue(MinecraftItem, null, "REGISTRY");
@@ -449,6 +452,19 @@ static public Object asNMSCopy(ItemStack item) throws NMSException
         }
     }
     
+    static public Object asCraftCopy(ItemStack item) throws NMSException
+    {
+        try
+        {
+            Class CraftItemStack = Reflection.getBukkitClassByName("inventory.CraftItemStack");
+            return CraftItemStack.getMethod("asCraftCopy", ItemStack.class).invoke(null, item);
+        }
+        catch(Exception ex)
+        {
+            throw new NMSException("Unable to retreive Craft copy", ex);
+        }
+    }
+    
     static public Object getNMSItemStack(ItemStack item) throws NMSException
     {
         try
diff --git a/src/main/java/fr/zcraft/zlib/tools/world/WorldUtils.java b/src/main/java/fr/zcraft/zlib/tools/world/WorldUtils.java
@@ -30,6 +30,7 @@
 package fr.zcraft.zlib.tools.world;
 
 import org.bukkit.Location;
+import org.bukkit.block.BlockFace;
 
 /**
  * Utility class for dealing with worlds and locations.
@@ -50,4 +51,30 @@ static public boolean blockEquals(Location loc1, Location loc2)
                 && loc1.getBlockY() == loc2.getBlockY()
                 && loc1.getBlockZ() == loc2.getBlockZ();
     }
+    
+    /**
+     * Returns the orientation of the specified location, as a BlockFace.
+     * The precision of the returned BlockFace is restricted to NORTH, SOUTH,
+     * EAST and WEST only.
+     * @param loc The location.
+     * @return the orientation of the specified location, as a BlockFace.
+     */
+    static public BlockFace get4thOrientation(Location loc)
+    {
+        float yaw = Math.abs(loc.getYaw()) - 180f;
+        
+        if(yaw <= 45 && yaw > -45)
+            return BlockFace.NORTH;
+        
+        if(yaw <= -45 && yaw > -135)
+            return BlockFace.EAST;
+        
+        if(yaw <= -135 || yaw > 135)
+            return BlockFace.SOUTH;
+        
+        if(yaw <= 135 && yaw > 45)
+            return BlockFace.WEST;
+        
+        return BlockFace.SELF;
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -190,6 +190,7 @@ static private void init() throws NMSException`
`190`	`190`	`static private Object getMcNBTCompound(ItemStack item) throws NMSException`
`191`	`191`	`{`
`192`	`192`	`Object mcItemStack = ItemUtils.getNMSItemStack(item);`
	`193`	`+ if(mcItemStack == null) return null;`
`193`	`194`	`try`
`194`	`195`	`{`
`195`	`196`	`return Reflection.getFieldValue(MC_ITEM_STACK, mcItemStack, "tag");`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@`
`45`	`45`	`public class NBTList implements List<Object>`
`46`	`46`	`{`
`47`	`47`	`private Object nmsNbtTag;`
`48`		`- private List<Object> nmsNbtList;`
	`48`	`+ List<Object> nmsNbtList;`
`49`	`49`
`50`	`50`	`private final Object parent;`
`51`	`51`	`private final Object parentKey;`
`@@ -62,7 +62,7 @@ public NBTList()`
`62`	`62`
`63`	`63`	`NBTList(Object nmsListTag)`
`64`	`64`	`{`
`65`		`- this(nmsListTag, (List<Object>) NBTType.TAG_LIST.getData(nmsListTag));`
	`65`	`+ this(null, nmsListTag == null ? new ArrayList<>() : (List<Object>) NBTType.TAG_LIST.getData(nmsListTag));`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`private NBTList(Object nmsListTag, List<Object> nmsNbtList)`
`@@ -101,6 +101,8 @@ private List<Object> getNbtList()`
`101`	`101`	`else`
`102`	`102`	`{`
`103`	`103`	`nmsNbtTag = NBTType.TAG_LIST.newTag(nmsNbtList);`
	`104`	`+ NBTType.TAG_LIST.setData(nmsNbtTag, nmsNbtList);`
	`105`	`+`
`104`	`106`	`if(parent != null && parentKey != null)`
`105`	`107`	`{`
`106`	`108`	`if(parent instanceof NBTCompound)`
`@@ -407,6 +409,12 @@ public <T> ListIterator<T> filter(Class<T> klass, int index)`
`407`	`409`	`return new NBTListFilterIterator<T>(listIterator(index));`
`408`	`410`	`}`
`409`	`411`
	`412`	`+ @Override`
	`413`	`+ public String toString()`
	`414`	`+ {`
	`415`	`+ return NBT.toNBTJSONString(this);`
	`416`	`+ }`
	`417`	`+`
`410`	`418`	`private class NBTListIterator implements ListIterator<Object>`
`411`	`419`	`{`
`412`	`420`	`private ListIterator<Object> iterator;`
Original file line number	Diff line number	Diff line change
`@@ -109,16 +109,19 @@ static public String toJSONString(ItemStack item)`
`109`	`109`	`{`
`110`	`110`	`Map<String, Object> itemData = new HashMap<String, Object>();`
`111`	`111`
	`112`	`+ String itemId = null;`
`112`	`113`	`try`
`113`	`114`	`{`
`114`		`- itemData.put("id", ItemUtils.getMinecraftId(item));`
	`115`	`+ itemId = ItemUtils.getMinecraftId(item);`
`115`	`116`	`}`
`116`	`117`	`catch (NMSException ex)`
`117`	`118`	`{`
`118`	`119`	`PluginLogger.warning("NMS Exception while parsing ItemStack to JSON String", ex);`
`119`		`- itemData.put("id", item.getTypeId());`
`120`	`120`	`}`
`121`	`121`
	`122`	`+ if(itemId == null) itemId = String.valueOf(item.getType().getId());`
	`123`	`+ itemData.put("id", itemId);`
	`124`	`+`
`122`	`125`	`itemData.put("Damage", item.getDurability());`
`123`	`126`	`try`
`124`	`127`	`{`