Handle item changes in dialog packets

Author: kennytv

api/src/main/java/com/viaversion/viaversion/api/rewriter/RegistryDataRewriter.java

@@ -22,6 +22,8 @@
  */
 package com.viaversion.viaversion.api.rewriter;
 
+import com.viaversion.nbt.tag.CompoundTag;
+import com.viaversion.viaversion.api.connection.UserConnection;
 import com.viaversion.viaversion.util.KeyMappings;
 import org.checkerframework.checker.nullness.qual.Nullable;
 
@@ -31,4 +33,6 @@ public interface RegistryDataRewriter {
     KeyMappings getMappings(String registryKey);
 
     boolean shouldRemoveRegistry(String registryKey);
+
+    void updateDialog(UserConnection connection, CompoundTag tag);
 }

api/src/main/java/com/viaversion/viaversion/api/type/Types.java

@@ -107,6 +107,7 @@
 import com.viaversion.viaversion.api.type.types.math.QuaternionType;
 import com.viaversion.viaversion.api.type.types.math.Vector3fType;
 import com.viaversion.viaversion.api.type.types.math.VectorType;
+import com.viaversion.viaversion.api.type.types.misc.CompoundTagHolderType;
 import com.viaversion.viaversion.api.type.types.misc.CompoundTagType;
 import com.viaversion.viaversion.api.type.types.misc.GameProfileType;
 import com.viaversion.viaversion.api.type.types.misc.HolderSetType;
@@ -207,6 +208,7 @@ public final class Types {
     public static final Type<CompoundTag[]> NAMED_COMPOUND_TAG_ARRAY = new ArrayType<>(Types.NAMED_COMPOUND_TAG);
     public static final Type<CompoundTag> COMPOUND_TAG = new CompoundTagType();
     public static final Type<CompoundTag> OPTIONAL_COMPOUND_TAG = CompoundTagType.OptionalCompoundTagType.type();
+    public static final HolderType<CompoundTag> TRUSTED_COMPOUND_TAG_HOLDER = new CompoundTagHolderType();
 
     public static final Type<Tag> TAG = new TagType();
     public static final Type<Tag[]> TAG_ARRAY = new ArrayType<>(TAG);

api/src/main/java/com/viaversion/viaversion/api/type/types/misc/CompoundTagHolderType.java

@@ -0,0 +1,40 @@
+/*
+ * This file is part of ViaVersion - https://github.com/ViaVersion/ViaVersion
+ * Copyright (C) 2016-2026 ViaVersion and contributors
+ *
+ * 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.
+ */
+package com.viaversion.viaversion.api.type.types.misc;
+
+import com.viaversion.nbt.tag.CompoundTag;
+import com.viaversion.viaversion.api.type.Types;
+import io.netty.buffer.ByteBuf;
+
+public final class CompoundTagHolderType extends HolderType<CompoundTag> {
+
+    @Override
+    public CompoundTag readDirect(final ByteBuf buffer) {
+        return Types.TRUSTED_COMPOUND_TAG.read(buffer);
+    }
+
+    @Override
+    public void writeDirect(final ByteBuf buffer, final CompoundTag value) {
+        Types.TRUSTED_COMPOUND_TAG.write(buffer, value);
+    }
+}

common/src/main/java/com/viaversion/viaversion/protocols/v1_21_11to26_1/rewriter/BlockItemPacketRewriter26_1.java

@@ -43,6 +43,7 @@
 import com.viaversion.viaversion.protocols.v1_21_11to26_1.packet.ServerboundPacket26_1;
 import com.viaversion.viaversion.protocols.v1_21_11to26_1.packet.ServerboundPackets26_1;
 import com.viaversion.viaversion.protocols.v1_21_4to1_21_5.rewriter.RecipeDisplayRewriter1_21_5;
+import com.viaversion.viaversion.protocols.v1_21_7to1_21_9.packet.ClientboundConfigurationPackets1_21_9;
 import com.viaversion.viaversion.protocols.v1_21_9to1_21_11.packet.ClientboundPacket1_21_11;
 import com.viaversion.viaversion.protocols.v1_21_9to1_21_11.packet.ClientboundPackets1_21_11;
 import com.viaversion.viaversion.rewriter.BlockRewriter;
@@ -92,6 +93,8 @@ public void registerPackets() {
         registerMerchantOffers1_20_5(ClientboundPackets1_21_11.MERCHANT_OFFERS);
         registerContainerClick1_21_5(ServerboundPackets26_1.CONTAINER_CLICK);
         registerSetCreativeModeSlot1_21_5(ServerboundPackets26_1.SET_CREATIVE_MODE_SLOT);
+        registerShowDialog(ClientboundPackets1_21_11.SHOW_DIALOG);
+        registerShowDialogDirect(ClientboundConfigurationPackets1_21_9.SHOW_DIALOG);
 
         final RecipeDisplayRewriter<ClientboundPacket1_21_11> recipeRewriter = new RecipeDisplayRewriter1_21_5<>(protocol);
         recipeRewriter.registerUpdateRecipes(ClientboundPackets1_21_11.UPDATE_RECIPES);

common/src/main/java/com/viaversion/viaversion/protocols/v1_21_6to1_21_7/rewriter/BlockItemPacketRewriter1_21_7.java

@@ -19,6 +19,7 @@
 
 import com.viaversion.viaversion.api.type.types.chunk.ChunkType1_21_5;
 import com.viaversion.viaversion.protocols.v1_21_4to1_21_5.rewriter.RecipeDisplayRewriter1_21_5;
+import com.viaversion.viaversion.protocols.v1_21_5to1_21_6.packet.ClientboundConfigurationPackets1_21_6;
 import com.viaversion.viaversion.protocols.v1_21_5to1_21_6.packet.ClientboundPacket1_21_6;
 import com.viaversion.viaversion.protocols.v1_21_5to1_21_6.packet.ClientboundPackets1_21_6;
 import com.viaversion.viaversion.protocols.v1_21_5to1_21_6.packet.ServerboundPacket1_21_6;
@@ -54,6 +55,8 @@ public void registerPackets() {
         registerMerchantOffers1_20_5(ClientboundPackets1_21_6.MERCHANT_OFFERS);
         registerContainerClick1_21_5(ServerboundPackets1_21_6.CONTAINER_CLICK);
         registerSetCreativeModeSlot1_21_5(ServerboundPackets1_21_6.SET_CREATIVE_MODE_SLOT);
+        registerShowDialog(ClientboundPackets1_21_6.SHOW_DIALOG);
+        registerShowDialogDirect(ClientboundConfigurationPackets1_21_6.SHOW_DIALOG);
 
         final RecipeDisplayRewriter<ClientboundPacket1_21_6> recipeRewriter = new RecipeDisplayRewriter1_21_5<>(protocol);
         recipeRewriter.registerUpdateRecipes(ClientboundPackets1_21_6.UPDATE_RECIPES);

common/src/main/java/com/viaversion/viaversion/protocols/v1_21_7to1_21_9/rewriter/BlockItemPacketRewriter1_21_9.java

@@ -31,6 +31,7 @@
 import com.viaversion.viaversion.api.type.Types;
 import com.viaversion.viaversion.api.type.types.chunk.ChunkType1_21_5;
 import com.viaversion.viaversion.protocols.v1_21_4to1_21_5.rewriter.RecipeDisplayRewriter1_21_5;
+import com.viaversion.viaversion.protocols.v1_21_5to1_21_6.packet.ClientboundConfigurationPackets1_21_6;
 import com.viaversion.viaversion.protocols.v1_21_5to1_21_6.packet.ClientboundPacket1_21_6;
 import com.viaversion.viaversion.protocols.v1_21_5to1_21_6.packet.ClientboundPackets1_21_6;
 import com.viaversion.viaversion.protocols.v1_21_5to1_21_6.packet.ServerboundPackets1_21_6;
@@ -68,6 +69,8 @@ public void registerPackets() {
         registerMerchantOffers1_20_5(ClientboundPackets1_21_6.MERCHANT_OFFERS);
         registerContainerClick1_21_5(ServerboundPackets1_21_6.CONTAINER_CLICK);
         registerSetCreativeModeSlot1_21_5(ServerboundPackets1_21_6.SET_CREATIVE_MODE_SLOT);
+        registerShowDialog(ClientboundPackets1_21_6.SHOW_DIALOG);
+        registerShowDialogDirect(ClientboundConfigurationPackets1_21_6.SHOW_DIALOG);
 
         final RecipeDisplayRewriter<ClientboundPacket1_21_6> recipeRewriter = new RecipeDisplayRewriter1_21_5<>(protocol);
         recipeRewriter.registerUpdateRecipes(ClientboundPackets1_21_6.UPDATE_RECIPES);

common/src/main/java/com/viaversion/viaversion/protocols/v1_21_9to1_21_11/rewriter/BlockItemPacketRewriter1_21_11.java

@@ -28,6 +28,7 @@
 import com.viaversion.viaversion.api.type.types.chunk.ChunkType1_21_5;
 import com.viaversion.viaversion.protocols.v1_21_4to1_21_5.rewriter.RecipeDisplayRewriter1_21_5;
 import com.viaversion.viaversion.protocols.v1_21_5to1_21_6.packet.ServerboundPackets1_21_6;
+import com.viaversion.viaversion.protocols.v1_21_7to1_21_9.packet.ClientboundConfigurationPackets1_21_9;
 import com.viaversion.viaversion.protocols.v1_21_7to1_21_9.packet.ClientboundPacket1_21_9;
 import com.viaversion.viaversion.protocols.v1_21_7to1_21_9.packet.ClientboundPackets1_21_9;
 import com.viaversion.viaversion.protocols.v1_21_7to1_21_9.packet.ServerboundPacket1_21_9;
@@ -64,6 +65,8 @@ public void registerPackets() {
         registerMerchantOffers1_20_5(ClientboundPackets1_21_9.MERCHANT_OFFERS);
         registerContainerClick1_21_5(ServerboundPackets1_21_6.CONTAINER_CLICK);
         registerSetCreativeModeSlot1_21_5(ServerboundPackets1_21_6.SET_CREATIVE_MODE_SLOT);
+        registerShowDialog(ClientboundPackets1_21_9.SHOW_DIALOG);
+        registerShowDialogDirect(ClientboundConfigurationPackets1_21_9.SHOW_DIALOG);
 
         final RecipeDisplayRewriter<ClientboundPacket1_21_9> recipeRewriter = new RecipeDisplayRewriter1_21_5<>(protocol);
         recipeRewriter.registerUpdateRecipes(ClientboundPackets1_21_9.UPDATE_RECIPES);

common/src/main/java/com/viaversion/viaversion/rewriter/RegistryDataRewriter.java

@@ -28,6 +28,7 @@
 import com.viaversion.viaversion.api.minecraft.RegistryEntry;
 import com.viaversion.viaversion.api.protocol.Protocol;
 import com.viaversion.viaversion.api.protocol.packet.PacketWrapper;
+import com.viaversion.viaversion.api.rewriter.ComponentRewriter;
 import com.viaversion.viaversion.api.type.Types;
 import com.viaversion.viaversion.data.entity.DimensionDataImpl;
 import com.viaversion.viaversion.util.Key;
@@ -82,6 +83,7 @@ public RegistryEntry[] handle(final UserConnection connection, String key, Regis
             case "trim_material" -> updateTrimMaterials(entries);
             case "jukebox_song" -> updateJukeboxSongs(entries);
             case "worldgen/biome" -> updateBiomes(entries);
+            case "dialog" -> updateDialogs(connection, entries);
         }
 
         final BiConsumer<String, CompoundTag> registryEntryHandler = this.registryEntryHandlers.get(key);
@@ -158,6 +160,54 @@ public void trackDimensionAndBiomes(final UserConnection connection, final Strin
         }
     }
 
+    public void updateDialogs(final UserConnection connection, final RegistryEntry[] entries) {
+        if (protocol.getMappingData() != null && protocol.getMappingData().getFullItemMappings() == null) {
+            return;
+        }
+        for (final RegistryEntry entry : entries) {
+            if (entry.tag() != null) {
+                updateDialog(connection, (CompoundTag) entry.tag());
+            }
+        }
+    }
+
+    @Override
+    public void updateDialog(final UserConnection connection, final CompoundTag tag) {
+        final ListTag<CompoundTag> bodiesTag = tag.getListTag("body", CompoundTag.class);
+        if (bodiesTag == null) {
+            final CompoundTag bodyTag = tag.getCompoundTag("body");
+            if (bodyTag != null) {
+                updateDialogBody(connection, bodyTag); // inlined
+            }
+            return;
+        }
+
+        for (final CompoundTag entry : bodiesTag) {
+            updateDialogBody(connection, entry);
+        }
+    }
+
+    public void updateDialogBody(final UserConnection connection, final CompoundTag tag) {
+        final String type = tag.getString("type");
+        if (!Key.equals(type, "item")) {
+            return;
+        }
+
+        final StringTag itemTag = tag.getStringTag("item");
+        if (itemTag != null) {
+            final String mappedId = protocol.getMappingData().getFullItemMappings().mappedIdentifier(itemTag.getValue());
+            if (mappedId != null) {
+                itemTag.setValue(mappedId);
+            }
+            return;
+        }
+
+        final ComponentRewriter componentRewriter = protocol.getComponentRewriter();
+        if (componentRewriter != null) {
+            componentRewriter.handleShowItem(connection, tag.getCompoundTag("item"));
+        }
+    }
+
     public void updateEnchantments(final UserConnection connection, final RegistryEntry[] entries) {
         final List<String> identifiers = new ArrayList<>(entries.length);
         for (final RegistryEntry entry : entries) {

common/src/main/java/com/viaversion/viaversion/rewriter/StructuredItemRewriter.java

@@ -60,7 +60,7 @@ public StructuredItemRewriter(T protocol) {
      * Rewrites an item to the client, including item hash tracking if necessary.
      *
      * @param connection user connection
-     * @param item item
+     * @param item       item
      * @return the rewritten item, can be the same or a new object
      * @see #handleItemDataComponentsToClient(UserConnection, Item, StructuredDataContainer)
      * @see #handleItemToServer(UserConnection, Item)
@@ -170,8 +170,8 @@ protected void updateItemDataComponentTypeIds(final StructuredDataContainer cont
      * Always remember to call the super method.
      *
      * @param connection user connection
-     * @param item item to update
-     * @param container item data container
+     * @param item       item to update
+     * @param container  item data container
      */
     protected void handleItemDataComponentsToClient(final UserConnection connection, final Item item, final StructuredDataContainer container) {
         if (protocol.getComponentRewriter() != null) {
@@ -289,8 +289,8 @@ protected void restoreBackupData(final Item item) {
     /**
      * Stores inconvertible data in a backup tag. Called before data component modification to the item.
      *
-     * @param connection user connection
-     * @param item item to save data for
+     * @param connection    user connection
+     * @param item          item to save data for
      * @param dataContainer item data container
      */
     protected void backupInconvertibleData(final UserConnection connection, final Item item, final StructuredDataContainer dataContainer, final CompoundTag backupTag) {
@@ -299,8 +299,8 @@ protected void backupInconvertibleData(final UserConnection connection, final It
     /**
      * Restored inconvertible backup data from the item. Called after rewritables and before the remaining data component modification.
      *
-     * @param item item
-     * @param container item data container
+     * @param item       item
+     * @param container  item data container
      * @param customData custom data tag
      */
     protected void restoreBackupData(final Item item, final StructuredDataContainer container, final CompoundTag customData) {
@@ -395,4 +395,20 @@ public void registerSetCreativeModeSlot1_21_5(S packetType) {
             passthroughLengthPrefixedItem(wrapper);
         });
     }
+
+    public void registerShowDialog(C packetType) {
+        protocol.registerClientbound(packetType, wrapper -> {
+            final Holder<CompoundTag> holder = wrapper.passthrough(Types.TRUSTED_COMPOUND_TAG_HOLDER);
+            if (holder.isDirect()) {
+                protocol.getRegistryDataRewriter().updateDialog(wrapper.user(), holder.value());
+            }
+        });
+    }
+
+    public void registerShowDialogDirect(C packetType) {
+        protocol.registerClientbound(packetType, wrapper -> {
+            final CompoundTag dialogTag = wrapper.passthrough(Types.TRUSTED_COMPOUND_TAG);
+            protocol.getRegistryDataRewriter().updateDialog(wrapper.user(), dialogTag);
+        });
+    }
 }