smol inventory translator refactor (#5473)

* gah generics

* compiles

* Add getOpenInventory method

* Remove debug, attempt to resolve barrel issues

* Fix some edge-cases related to lecterns

* inventory -> container renames

* Fix component check in JavaOpenBookTranslator, increase open attempts to 5

* Remove session variable used to force-close the player inventory, use confirm variable instead. Also: fix rare issues where server-side requested lectern closing didn't work for real lectern blocks

* Update core/src/main/java/org/geysermc/geyser/translator/inventory/InventoryTranslator.java

* Use closingInventory for lecterns too

* fix debug

Author: onebeastchris

core/src/main/java/org/geysermc/geyser/command/defaults/AdvancedTooltipsCommand.java

@@ -51,6 +51,6 @@ public void execute(CommandContext<GeyserCommandSource> context) {
             + MinecraftLocale.getLocaleString("debug.prefix", session.locale())
             + " " + ChatColor.RESET
             + MinecraftLocale.getLocaleString("debug.advanced_tooltips." + onOrOff, session.locale()));
-        session.getPlayerInventory().updateInventory();
+        session.getPlayerInventoryHolder().updateInventory();
     }
 }

core/src/main/java/org/geysermc/geyser/inventory/AnvilContainer.java

@@ -30,7 +30,6 @@
 import net.kyori.adventure.text.Component;
 import org.checkerframework.checker.nullness.qual.Nullable;
 import org.geysermc.geyser.session.GeyserSession;
-import org.geysermc.geyser.translator.inventory.InventoryTranslator;
 import org.geysermc.geyser.translator.text.MessageTranslator;
 import org.geysermc.mcprotocollib.protocol.data.game.inventory.ContainerType;
 import org.geysermc.mcprotocollib.protocol.data.game.item.component.DataComponentTypes;
@@ -63,8 +62,8 @@ public class AnvilContainer extends Container {
 
     private int lastTargetSlot = -1;
 
-    public AnvilContainer(GeyserSession session, String title, int id, int size, ContainerType containerType, PlayerInventory playerInventory, InventoryTranslator translator) {
-        super(session, title, id, size, containerType, playerInventory, translator);
+    public AnvilContainer(GeyserSession session, String title, int id, int size, ContainerType containerType) {
+        super(session, title, id, size, containerType);
     }
 
     /**

core/src/main/java/org/geysermc/geyser/inventory/BeaconContainer.java

@@ -25,19 +25,18 @@
 
 package org.geysermc.geyser.inventory;
 
-import org.geysermc.geyser.session.GeyserSession;
-import org.geysermc.geyser.translator.inventory.InventoryTranslator;
-import org.geysermc.mcprotocollib.protocol.data.game.inventory.ContainerType;
 import lombok.Getter;
 import lombok.Setter;
+import org.geysermc.geyser.session.GeyserSession;
+import org.geysermc.mcprotocollib.protocol.data.game.inventory.ContainerType;
 
 @Getter
 @Setter
 public class BeaconContainer extends Container {
     private int primaryId;
     private int secondaryId;
 
-    public BeaconContainer(GeyserSession session, String title, int id, int size, ContainerType containerType, PlayerInventory playerInventory, InventoryTranslator translator) {
-        super(session, title, id, size, containerType, playerInventory, translator);
+    public BeaconContainer(GeyserSession session, String title, int id, int size, ContainerType containerType) {
+        super(session, title, id, size, containerType);
     }
 }

core/src/main/java/org/geysermc/geyser/inventory/CartographyContainer.java

@@ -26,11 +26,10 @@
 package org.geysermc.geyser.inventory;
 
 import org.geysermc.geyser.session.GeyserSession;
-import org.geysermc.geyser.translator.inventory.InventoryTranslator;
 import org.geysermc.mcprotocollib.protocol.data.game.inventory.ContainerType;
 
 public class CartographyContainer extends Container {
-    public CartographyContainer(GeyserSession session, String title, int id, int size, ContainerType containerType, PlayerInventory playerInventory, InventoryTranslator translator) {
-        super(session, title, id, size, containerType, playerInventory, translator);
+    public CartographyContainer(GeyserSession session, String title, int id, int size, ContainerType containerType) {
+        super(session, title, id, size, containerType);
     }
 }

core/src/main/java/org/geysermc/geyser/inventory/Container.java

@@ -46,9 +46,9 @@ public class Container extends Inventory {
      */
     private boolean isUsingRealBlock = false;
 
-    public Container(GeyserSession session, String title, int id, int size, ContainerType containerType, PlayerInventory playerInventory, InventoryTranslator translator) {
-        super(session, title, id, size, containerType, translator);
-        this.playerInventory = playerInventory;
+    public Container(GeyserSession session, String title, int id, int size, ContainerType containerType) {
+        super(session, title, id, size, containerType);
+        this.playerInventory = session.getPlayerInventory();
         this.containerSize = this.size + InventoryTranslator.PLAYER_INVENTORY_SIZE;
     }
 

core/src/main/java/org/geysermc/geyser/inventory/CrafterContainer.java

@@ -48,8 +48,8 @@ public class CrafterContainer extends Container {
      */
     private short disabledSlotsMask = 0;
 
-    public CrafterContainer(GeyserSession session, String title, int id, int size, ContainerType containerType, PlayerInventory playerInventory, InventoryTranslator translator) {
-        super(session, title, id, size, containerType, playerInventory, translator);
+    public CrafterContainer(GeyserSession session, String title, int id, int size, ContainerType containerType) {
+        super(session, title, id, size, containerType);
     }
 
     @Override

core/src/main/java/org/geysermc/geyser/inventory/EnchantingContainer.java

@@ -26,7 +26,6 @@
 package org.geysermc.geyser.inventory;
 
 import org.geysermc.geyser.session.GeyserSession;
-import org.geysermc.geyser.translator.inventory.InventoryTranslator;
 import org.geysermc.mcprotocollib.protocol.data.game.inventory.ContainerType;
 import org.cloudburstmc.protocol.bedrock.data.inventory.EnchantOptionData;
 import lombok.Getter;
@@ -42,8 +41,8 @@ public class EnchantingContainer extends Container {
      */
     private final GeyserEnchantOption[] geyserEnchantOptions;
 
-    public EnchantingContainer(GeyserSession session, String title, int id, int size, ContainerType containerType, PlayerInventory playerInventory, InventoryTranslator translator) {
-        super(session, title, id, size, containerType, playerInventory, translator);
+    public EnchantingContainer(GeyserSession session, String title, int id, int size, ContainerType containerType) {
+        super(session, title, id, size, containerType);
 
         enchantOptions = new EnchantOptionData[3];
         geyserEnchantOptions = new GeyserEnchantOption[3];

core/src/main/java/org/geysermc/geyser/inventory/Generic3X3Container.java

@@ -30,20 +30,19 @@
 import org.geysermc.geyser.level.block.type.Block;
 import org.geysermc.geyser.session.GeyserSession;
 import org.geysermc.geyser.translator.inventory.Generic3X3InventoryTranslator;
-import org.geysermc.geyser.translator.inventory.InventoryTranslator;
 import org.geysermc.mcprotocollib.protocol.data.game.inventory.ContainerType;
 
 @Getter
 public class Generic3X3Container extends Container {
     /**
      * Whether we need to set the container type as {@link org.cloudburstmc.protocol.bedrock.data.inventory.ContainerType#DROPPER}.
      * <p>
-     * Used at {@link Generic3X3InventoryTranslator#openInventory(GeyserSession, Inventory)}
+     * Used at {@link Generic3X3InventoryTranslator#openInventory(GeyserSession, Generic3X3Container)}
      */
     private boolean isDropper = false;
 
-    public Generic3X3Container(GeyserSession session, String title, int id, int size, ContainerType containerType, PlayerInventory playerInventory, InventoryTranslator translator) {
-        super(session, title, id, size, containerType, playerInventory, translator);
+    public Generic3X3Container(GeyserSession session, String title, int id, int size, ContainerType containerType) {
+        super(session, title, id, size, containerType);
     }
 
     @Override

core/src/main/java/org/geysermc/geyser/inventory/Generic9X3Container.java

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2025 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.geyser.inventory;
+
+import lombok.Getter;
+import lombok.Setter;
+import org.geysermc.geyser.level.block.Blocks;
+import org.geysermc.geyser.level.block.type.Block;
+import org.geysermc.geyser.session.GeyserSession;
+import org.geysermc.mcprotocollib.protocol.data.game.inventory.ContainerType;
+
+/**
+ * A "hack" to be able to use existing barrels.
+ * The only difference to chests appears to be the different ContainerSlotType - this accounts for it.
+ */
+@Getter @Setter
+public class Generic9X3Container extends Container {
+
+    private boolean isBarrel;
+
+    public Generic9X3Container(GeyserSession session, String title, int id, int size, ContainerType containerType) {
+        super(session, title, id, size, containerType);
+    }
+
+    @Override
+    public void setUsingRealBlock(boolean usingRealBlock, Block block) {
+        super.setUsingRealBlock(usingRealBlock, block);
+        if (usingRealBlock) {
+            isBarrel = block == Blocks.BARREL;
+        }
+    }
+}

core/src/main/java/org/geysermc/geyser/inventory/Inventory.java

@@ -35,7 +35,6 @@
 import org.geysermc.geyser.inventory.click.ClickPlan;
 import org.geysermc.geyser.item.Items;
 import org.geysermc.geyser.session.GeyserSession;
-import org.geysermc.geyser.translator.inventory.InventoryTranslator;
 import org.geysermc.geyser.translator.item.ItemTranslator;
 import org.geysermc.mcprotocollib.protocol.data.game.inventory.ContainerType;
 import org.geysermc.mcprotocollib.protocol.data.game.item.component.DataComponentTypes;
@@ -95,44 +94,24 @@ public abstract class Inventory {
     @Setter
     protected long holderId = -1;
 
-    /**
-     * Whether this inventory is currently pending.
-     * It can be pending if this inventory was opened while another inventory was still open,
-     * or because opening this inventory takes more time (e.g. virtual inventories).
-     */
-    @Getter
-    @Setter
-    private boolean pending = false;
-
     /**
      * Whether this inventory is currently shown to the Bedrock player.
      */
     @Getter
     @Setter
-    private boolean displayed = false;
+    private boolean displayed;
 
-    /**
-     * The translator for this inventory. Stored here to avoid de-syncs of the inventory and current translator.
-     */
-    @Getter
-    private final InventoryTranslator translator;
-
-    @Getter
-    private final GeyserSession session;
-
-    protected Inventory(GeyserSession session, int id, int size, ContainerType containerType, InventoryTranslator translator) {
-        this(session, "Inventory", id, size, containerType, translator);
+    protected Inventory(GeyserSession session, int id, int size, ContainerType containerType) {
+        this(session, "Inventory", id, size, containerType);
     }
 
-    protected Inventory(GeyserSession session, String title, int javaId, int size, ContainerType containerType, InventoryTranslator translator) {
+    protected Inventory(GeyserSession session, String title, int javaId, int size, ContainerType containerType) {
         this.title = title;
         this.javaId = javaId;
         this.size = size;
         this.containerType = containerType;
         this.items = new GeyserItemStack[size];
         Arrays.fill(items, GeyserItemStack.EMPTY);
-        this.translator = translator;
-        this.session = session;
 
         // This is to prevent conflicts with special bedrock inventory IDs.
         // The vanilla java server only sends an ID between 1 and 100 when opening an inventory,
@@ -144,7 +123,7 @@ protected Inventory(GeyserSession session, String title, int javaId, int size, C
         // Java wouldn't - e.g. for virtual chest menus that switch pages.
         // And, well, we want to avoid reusing Bedrock inventory id's that are currently being used in a closing inventory;
         // so to be safe we just deviate in that case as well.
-        if ((session.getOpenInventory() != null && session.getOpenInventory().getBedrockId() == bedrockId) || session.isClosingInventory()) {
+        if ((session.getInventoryHolder() != null && session.getInventoryHolder().bedrockId() == bedrockId) || session.isClosingInventory()) {
             this.bedrockId += 1;
         }
     }
@@ -214,20 +193,4 @@ public void resetNextStateId() {
     public boolean shouldConfirmContainerClose() {
         return true;
     }
-
-    /*
-     * Helper methods to avoid using the wrong translator to update specific inventories.
-     */
-
-    public void updateInventory() {
-        this.translator.updateInventory(session, this);
-    }
-
-    public void updateProperty(int rawProperty, int value) {
-        this.translator.updateProperty(session, this, rawProperty, value);
-    }
-
-    public void updateSlot(int slot) {
-        this.translator.updateSlot(session, this, slot);
-    }
 }