Add option to not compress serialized item bytes

Author: maxcom1

paper-api/src/main/java/org/bukkit/UnsafeValues.java

@@ -164,8 +164,12 @@ default com.destroystokyo.paper.util.VersionFetcher getVersionFetcher() {
 
     byte[] serializeItem(ItemStack item);
 
+    byte[] serializeItem(ItemStack item, boolean compressed);
+
     ItemStack deserializeItem(byte[] data);
 
+    ItemStack deserializeItem(byte[] data, boolean compressed);
+
     /**
      * Serializes this itemstack to json format.
      * It is safe for data migrations as it will use the built-in data converter instead of bukkit's

paper-api/src/main/java/org/bukkit/inventory/ItemStack.java

@@ -761,20 +761,48 @@ public ItemStack ensureServerConversions() {
      *
      * This expects that the DataVersion was stored on the root of the Compound, as saved from
      * the {@link #serializeAsBytes()} API returned.
+     *
+     * This goes through mojang's compression stream.
      * @param bytes bytes representing an item in NBT
      * @return ItemStack migrated to this version of Minecraft if needed.
      */
     public static @NotNull ItemStack deserializeBytes(final byte @NotNull [] bytes) {
-        return org.bukkit.Bukkit.getUnsafe().deserializeItem(bytes);
+        return deserializeBytes(bytes, true);
+    }
+
+    /**
+     * Deserializes this itemstack from raw NBT bytes. NBT is safer for data migrations as it will
+     * use the built in data converter instead of bukkits dangerous serialization system.
+     *
+     * This expects that the DataVersion was stored on the root of the Compound, as saved from
+     * the {@link #serializeAsBytes()} API returned.
+     * @param bytes bytes representing an item in NBT
+     * @param compressed whether the data goes through mojang's compression stream. You must use the same value when serializing.
+     * @return ItemStack migrated to this version of Minecraft if needed.
+     */
+    public static @NotNull ItemStack deserializeBytes(final byte @NotNull [] bytes, final boolean compressed) {
+        return org.bukkit.Bukkit.getUnsafe().deserializeItem(bytes, compressed);
     }
 
     /**
      * Serializes this itemstack to raw bytes in NBT. NBT is safer for data migrations as it will
      * use the built in data converter instead of bukkits dangerous serialization system.
+     *
+     * This goes through mojang's compression stream.
      * @return bytes representing this item in NBT.
      */
     public byte @NotNull [] serializeAsBytes() {
-        return org.bukkit.Bukkit.getUnsafe().serializeItem(this);
+        return serializeAsBytes(true);
+    }
+
+    /**
+     * Serializes this itemstack to raw bytes in NBT. NBT is safer for data migrations as it will
+     * use the built in data converter instead of bukkits dangerous serialization system.
+     * @param compressed whether the data goes through mojang's compression stream. You must use the same value when deserializing.
+     * @return bytes representing this item in NBT.
+     */
+    public byte @NotNull [] serializeAsBytes(final boolean compressed) {
+        return org.bukkit.Bukkit.getUnsafe().serializeItem(this, compressed);
     }
 
     /**

paper-server/src/main/java/org/bukkit/craftbukkit/util/CraftMagicNumbers.java

@@ -16,6 +16,9 @@
 import io.papermc.paper.adventure.AdventureCodecs;
 import io.papermc.paper.adventure.PaperAdventure;
 import io.papermc.paper.registry.RegistryKey;
+
+import java.io.DataInputStream;
+import java.io.DataOutputStream;
 import java.io.File;
 import java.io.IOException;
 import java.nio.charset.StandardCharsets;
@@ -492,23 +495,33 @@ public com.destroystokyo.paper.util.VersionFetcher getVersionFetcher() {
 
     @Override
     public byte[] serializeItem(ItemStack item) {
+        return this.serializeItem(item, true);
+    }
+
+    @Override
+    public byte[] serializeItem(ItemStack item, boolean compressed) {
         Preconditions.checkNotNull(item, "null cannot be serialized");
         Preconditions.checkArgument(!item.isEmpty(), "Empty itemstack cannot be serialized");
 
         return serializeNbtToBytes(
             (CompoundTag) net.minecraft.world.item.ItemStack.CODEC.encodeStart(
                 MinecraftServer.getServer().registryAccess().createSerializationContext(NbtOps.INSTANCE),
                 CraftItemStack.unwrap(item)
-            ).getOrThrow()
+            ).getOrThrow(), compressed
         );
     }
 
     @Override
     public ItemStack deserializeItem(byte[] data) {
+        return this.deserializeItem(data, true);
+    }
+
+    @Override
+    public ItemStack deserializeItem(byte[] data, boolean compressed) {
         Preconditions.checkNotNull(data, "null cannot be deserialized");
         Preconditions.checkArgument(data.length > 0, "cannot deserialize nothing");
 
-        CompoundTag compound = deserializeNbtFromBytes(data);
+        CompoundTag compound = deserializeNbtFromBytes(data, compressed);
         return deserializeItem(compound);
     }
 
@@ -706,7 +719,7 @@ public byte[] serializeEntity(org.bukkit.entity.Entity entity, EntitySerializati
                     throw new IllegalArgumentException("Couldn't serialize entity");
                 }
             }
-            return serializeNbtToBytes(output.buildResult());
+            return serializeNbtToBytes(output.buildResult(), true);
         }
     }
 
@@ -715,7 +728,7 @@ public org.bukkit.entity.Entity deserializeEntity(byte[] data, World world, bool
         Preconditions.checkNotNull(data, "null cannot be deserialized");
         Preconditions.checkArgument(data.length > 0, "Cannot deserialize empty data");
 
-        CompoundTag compound = deserializeNbtFromBytes(data);
+        CompoundTag compound = deserializeNbtFromBytes(data, true);
         int dataVersion = compound.getIntOr("DataVersion", 0);
         compound = PlatformHooks.get().convertNBT(References.ENTITY, MinecraftServer.getServer().fixerUpper, compound, dataVersion, this.getDataVersion()); // Paper - possibly use dataconverter
         if (!preservePassengers) {
@@ -754,26 +767,39 @@ private net.minecraft.world.entity.Entity deserializeEntity(CompoundTag compound
         return nmsEntity;
     }
 
-    private byte[] serializeNbtToBytes(CompoundTag compound) {
+    private byte[] serializeNbtToBytes(CompoundTag compound, boolean compressed) {
         compound.putInt("DataVersion", getDataVersion());
         java.io.ByteArrayOutputStream outputStream = new java.io.ByteArrayOutputStream();
         try {
-            net.minecraft.nbt.NbtIo.writeCompressed(
-                compound,
-                outputStream
-            );
+            if (compressed) {
+                net.minecraft.nbt.NbtIo.writeCompressed(
+                        compound,
+                        outputStream
+                );
+            } else {
+                net.minecraft.nbt.NbtIo.write(
+                        compound,
+                        new DataOutputStream(outputStream)
+                );
+            }
         } catch (IOException ex) {
             throw new RuntimeException(ex);
         }
         return outputStream.toByteArray();
     }
 
-    private CompoundTag deserializeNbtFromBytes(byte[] data) {
+    private CompoundTag deserializeNbtFromBytes(byte[] data, boolean compressed) {
         CompoundTag compound;
         try {
-            compound = net.minecraft.nbt.NbtIo.readCompressed(
-                new java.io.ByteArrayInputStream(data), net.minecraft.nbt.NbtAccounter.unlimitedHeap()
-            );
+            if (compressed) {
+                compound = net.minecraft.nbt.NbtIo.readCompressed(
+                        new java.io.ByteArrayInputStream(data), net.minecraft.nbt.NbtAccounter.unlimitedHeap()
+                );
+            } else {
+                compound = net.minecraft.nbt.NbtIo.read(
+                        new DataInputStream(new java.io.ByteArrayInputStream(data)), net.minecraft.nbt.NbtAccounter.unlimitedHeap()
+                );
+            }
         } catch (IOException ex) {
             throw new RuntimeException(ex);
         }