Fix banner items loosing patterns in inventory (#560)

connector/src/main/java/org/geysermc/connector/network/translators/item/translators/BannerTranslator.java

@@ -0,0 +1,93 @@
+/*
+ * Copyright (c) 2019-2020 GeyserMC. http://geysermc.org
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ * @author GeyserMC
+ * @link https://github.com/GeyserMC/Geyser
+ */
+
+package org.geysermc.connector.network.translators.item.translators;
+
+import com.github.steveice10.mc.protocol.data.game.entity.metadata.ItemStack;
+import com.github.steveice10.opennbt.tag.builtin.CompoundTag;
+import com.github.steveice10.opennbt.tag.builtin.ListTag;
+import com.nukkitx.nbt.CompoundTagBuilder;
+import com.nukkitx.protocol.bedrock.data.ItemData;
+import org.geysermc.connector.network.translators.ItemRemapper;
+import org.geysermc.connector.network.translators.ItemStackTranslator;
+import org.geysermc.connector.network.translators.item.ItemEntry;
+import org.geysermc.connector.utils.ItemUtils;
+import org.geysermc.connector.utils.Toolbox;
+
+import java.util.List;
+import java.util.stream.Collectors;
+
+@ItemRemapper
+public class BannerTranslator extends ItemStackTranslator {
+
+    private List<ItemEntry> appliedItems;
+
+    public BannerTranslator() {
+        appliedItems = Toolbox.ITEM_ENTRIES.values().stream().filter(entry -> entry.getJavaIdentifier().endsWith("banner")).collect(Collectors.toList());
+    }
+
+    @Override
+    public ItemData translateToBedrock(ItemStack itemStack, ItemEntry itemEntry) {
+        if (itemStack.getNbt() == null) return super.translateToBedrock(itemStack, itemEntry);
+
+        ItemData itemData = super.translateToBedrock(itemStack, itemEntry);
+
+        CompoundTag blockEntityTag = itemStack.getNbt().get("BlockEntityTag");
+        if (blockEntityTag.contains("Patterns")) {
+            ListTag patterns = blockEntityTag.get("Patterns");
+
+            CompoundTagBuilder builder = itemData.getTag().toBuilder();
+            builder.tag(ItemUtils.convertBannerPattern(patterns));
+
+            itemData = ItemData.of(itemData.getId(), itemData.getDamage(), itemData.getCount(), builder.buildRootTag());
+        }
+
+        return itemData;
+    }
+
+    @Override
+    public ItemStack translateToJava(ItemData itemData, ItemEntry itemEntry) {
+        if (itemData.getTag() == null) return super.translateToJava(itemData, itemEntry);
+
+        ItemStack itemStack = super.translateToJava(itemData, itemEntry);
+
+        com.nukkitx.nbt.tag.CompoundTag nbtTag = itemData.getTag();
+        if (nbtTag.contains("Patterns")) {
+            com.nukkitx.nbt.tag.ListTag patterns = (com.nukkitx.nbt.tag.ListTag) nbtTag.get("Patterns");
+
+            CompoundTag blockEntityTag = new CompoundTag("BlockEntityTag");
+            blockEntityTag.put(ItemUtils.convertBannerPattern(patterns));
+
+            itemStack.getNbt().put(blockEntityTag);
+        }
+
+        return itemStack;
+    }
+
+    @Override
+    public List<ItemEntry> getAppliedItems() {
+        return appliedItems;
+    }
+}

connector/src/main/java/org/geysermc/connector/network/translators/world/block/entity/BannerBlockEntityTranslator.java

@@ -33,6 +33,7 @@ import com.nukkitx.nbt.tag.IntTag;
 import com.nukkitx.nbt.tag.StringTag;
 import com.nukkitx.nbt.tag.Tag;
 import org.geysermc.connector.network.translators.world.block.BlockStateValues;
+import org.geysermc.connector.utils.ItemUtils;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -48,26 +49,21 @@ public class BannerBlockEntityTranslator extends BlockEntityTranslator implement
     @Override
     public List<Tag<?>> translateTag(CompoundTag tag, BlockState blockState) {
         List<Tag<?>> tags = new ArrayList<>();
+
         int bannerColor = BlockStateValues.getBannerColor(blockState);
         if (bannerColor != -1) {
             tags.add(new IntTag("Base", 15 - bannerColor));
         }
-        ListTag patterns = tag.get("Patterns");
+
-        List<com.nukkitx.nbt.tag.CompoundTag> tagsList = new ArrayList<>();
         if (tag.contains("Patterns")) {
-            for (com.github.steveice10.opennbt.tag.builtin.Tag patternTag : patterns.getValue()) {
+            ListTag patterns = tag.get("Patterns");
-                com.nukkitx.nbt.tag.CompoundTag newPatternTag = getPattern((CompoundTag) patternTag);
+            tags.add(ItemUtils.convertBannerPattern(patterns));
-                if (newPatternTag != null) {
-                    tagsList.add(newPatternTag);
-                }
-            }
-            com.nukkitx.nbt.tag.ListTag<com.nukkitx.nbt.tag.CompoundTag> bedrockPatterns =
-                    new com.nukkitx.nbt.tag.ListTag<>("Patterns", com.nukkitx.nbt.tag.CompoundTag.class, tagsList);
-            tags.add(bedrockPatterns);
         }
+
         if (tag.contains("CustomName")) {
             tags.add(new StringTag("CustomName", (String) tag.get("CustomName").getValue()));
         }
+
         return tags;
     }
 
@@ -84,25 +80,4 @@ public class BannerBlockEntityTranslator extends BlockEntityTranslator implement
         tagBuilder.listTag("Patterns", com.nukkitx.nbt.tag.CompoundTag.class, new ArrayList<>());
         return tagBuilder.buildRootTag();
     }
-
-    /**
-     * Convert the Java edition pattern nbt to Bedrock edition, null if the pattern doesn't exist
-     *
-     * @param pattern Java edition pattern nbt
-     * @return The Bedrock edition format pattern nbt
-     */
-    protected com.nukkitx.nbt.tag.CompoundTag getPattern(CompoundTag pattern) {
-        String patternName = (String) pattern.get("Pattern").getValue();
-
-        // Return null if its the globe pattern as it doesn't exist on bedrock
-        if (patternName.equals("glb")) {
-            return null;
-        }
-
-        return CompoundTagBuilder.builder()
-                .intTag("Color", 15 - (int) pattern.get("Color").getValue())
-                .stringTag("Pattern", (String) pattern.get("Pattern").getValue())
-                .stringTag("Pattern", patternName)
-                .buildRootTag();
-    }
 }

connector/src/main/java/org/geysermc/connector/utils/ItemUtils.java

@@ -26,6 +26,12 @@
 package org.geysermc.connector.utils;
 
 import com.github.steveice10.opennbt.tag.builtin.*;
+import com.nukkitx.nbt.CompoundTagBuilder;
+
+import java.util.ArrayList;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
 
 public class ItemUtils {
 
@@ -44,4 +50,77 @@ public class ItemUtils {
         }
         return 0;
     }
+
+    /**
+     * Convert a list of patterns from Java nbt to Bedrock nbt
+     *
+     * @param patterns The patterns to convert
+     * @return The new converted patterns
+     */
+    public static com.nukkitx.nbt.tag.ListTag convertBannerPattern(ListTag patterns) {
+        List<com.nukkitx.nbt.tag.CompoundTag> tagsList = new ArrayList<>();
+        for (com.github.steveice10.opennbt.tag.builtin.Tag patternTag : patterns.getValue()) {
+            com.nukkitx.nbt.tag.CompoundTag newPatternTag = getBedrockBannerPattern((CompoundTag) patternTag);
+            if (newPatternTag != null) {
+                tagsList.add(newPatternTag);
+            }
+        }
+
+        return new com.nukkitx.nbt.tag.ListTag<>("Patterns", com.nukkitx.nbt.tag.CompoundTag.class, tagsList);
+    }
+
+    /**
+     * Convert the Java edition banner pattern nbt to Bedrock edition, null if the pattern doesn't exist
+     *
+     * @param pattern Java edition pattern nbt
+     * @return The Bedrock edition format pattern nbt
+     */
+    public static com.nukkitx.nbt.tag.CompoundTag getBedrockBannerPattern(CompoundTag pattern) {
+        String patternName = (String) pattern.get("Pattern").getValue();
+
+        // Return null if its the globe pattern as it doesn't exist on bedrock
+        if (patternName.equals("glb")) {
+            return null;
+        }
+
+        return CompoundTagBuilder.builder()
+                .intTag("Color", 15 - (int) pattern.get("Color").getValue())
+                .stringTag("Pattern", (String) pattern.get("Pattern").getValue())
+                .stringTag("Pattern", patternName)
+                .buildRootTag();
+    }
+
+    /**
+     * Convert a list of patterns from Bedrock nbt to Java nbt
+     *
+     * @param patterns The patterns to convert
+     * @return The new converted patterns
+     */
+    public static ListTag convertBannerPattern(com.nukkitx.nbt.tag.ListTag patterns) {
+        List<Tag> tagsList = new ArrayList<>();
+        for (Object patternTag : patterns.getValue()) {
+            CompoundTag newPatternTag = getJavaBannerPattern((com.nukkitx.nbt.tag.CompoundTag) patternTag);
+            if (newPatternTag != null) {
+                tagsList.add(newPatternTag);
+            }
+        }
+
+        return new ListTag("Patterns", tagsList);
+    }
+
+    /**
+     * Convert the Bedrock edition banner pattern nbt to Java edition
+     *
+     * @param pattern Bedorck edition pattern nbt
+     * @return The Java edition format pattern nbt
+     */
+    public static CompoundTag getJavaBannerPattern(com.nukkitx.nbt.tag.CompoundTag pattern) {
+        String patternName = (String) pattern.get("Pattern").getValue();
+
+        Map<String, Tag> tags = new HashMap<>();
+        tags.put("Color", new IntTag("Color", 15 - pattern.getInt("Color")));
+        tags.put("Pattern", new StringTag("Pattern", pattern.getString("Pattern")));
+
+        return new CompoundTag("", tags);
+    }
 }