Rework on user item restore cache

Rothes · Rothes · commit 742b7ee519ad · 2024-10-05T10:09:46.000+08:00
diff --git a/bukkit/src/main/java/io/github/rothes/protocolstringreplacer/ProtocolStringReplacer.java b/bukkit/src/main/java/io/github/rothes/protocolstringreplacer/ProtocolStringReplacer.java
@@ -18,8 +18,6 @@
 import io.github.rothes.protocolstringreplacer.upgrade.AbstractUpgradeHandler;
 import io.github.rothes.protocolstringreplacer.upgrade.UpgradeEnum;
 import io.github.rothes.protocolstringreplacer.util.FileUtils;
-import kotlin.Unit;
-import kotlin.jvm.functions.Function1;
 import org.apache.commons.lang.Validate;
 import org.bukkit.Bukkit;
 import org.bukkit.configuration.ConfigurationSection;
@@ -43,7 +41,6 @@
 import java.nio.file.StandardCopyOption;
 import java.util.HashMap;
 import java.util.LinkedList;
-import java.util.Locale;
 import java.util.logging.Level;
 import java.util.logging.Logger;
 import java.util.regex.Pattern;
@@ -475,7 +472,7 @@ public void reload(@Nonnull PsrUser user) {
                 packetListenerManager.removeListeners();
                 packetListenerManager.initialize();
                 for (Player player : Bukkit.getOnlinePlayers()) {
-                    userManager.getUser(player).clearUserMetaCache();
+                    userManager.getUser(player).clearUserItemRestoreCache();
                     player.updateInventory();
                 }
                 user.sendFilteredText(PsrLocalization.getPrefixedLocaledMessage("Sender.Commands.Reload.Complete"));
diff --git a/bukkit/src/main/java/io/github/rothes/protocolstringreplacer/api/user/PsrUser.java b/bukkit/src/main/java/io/github/rothes/protocolstringreplacer/api/user/PsrUser.java
@@ -7,7 +7,7 @@
 import com.comphenix.protocol.wrappers.ComponentConverter;
 import com.comphenix.protocol.wrappers.EnumWrappers;
 import com.comphenix.protocol.wrappers.WrappedChatComponent;
-import de.tr7zw.changeme.nbtapi.NBTItem;
+import de.tr7zw.changeme.nbtapi.NBT;
 import io.github.rothes.protocolstringreplacer.ProtocolStringReplacer;
 import io.github.rothes.protocolstringreplacer.api.capture.CaptureInfo;
 import io.github.rothes.protocolstringreplacer.replacer.ListenType;
@@ -23,7 +23,6 @@
 import org.bukkit.command.ConsoleCommandSender;
 import org.bukkit.entity.Player;
 import org.bukkit.inventory.ItemStack;
-import org.bukkit.inventory.meta.ItemMeta;
 import org.bukkit.permissions.Permission;
 
 import javax.annotation.Nonnull;
@@ -40,13 +39,13 @@
 
 public class PsrUser {
 
-    private static Method getLocaleLegacy = getLegacyLocaleMethod();
+    private static final Method getLocaleLegacy = getLegacyLocaleMethod();
 
     private UUID uuid;
     private Player player;
     private CommandSender sender;
 
-    private final HashMap<Short, ItemMeta> metaCache = new HashMap<>();
+    private final HashMap<Short, ItemStack> itemRestoreCache = new HashMap<>();
     private String currentWindowTitle;
     private String clientLocale;
     private boolean inAnvil;
@@ -115,8 +114,8 @@ public Player getPlayer() {
         return player;
     }
 
-    public HashMap<Short, ItemMeta> getMetaCache() {
-        return metaCache;
+    public HashMap<Short, ItemStack> getItemRestoreCache() {
+        return itemRestoreCache;
     }
 
     public Short nextUniqueCacheKey() {
@@ -350,23 +349,20 @@ public void sendMessage(String text) {
     }
 
 
-    public void clearUserMetaCache() {
-        getMetaCache().clear();
+    public void clearUserItemRestoreCache() {
+        getItemRestoreCache().clear();
         uniqueCacheKey = 0;
     }
 
-    public void saveUserMetaCache(ItemStack originalItem, ItemStack replacedItem) {
+    public void saveUserItemRestoreCache(ItemStack originalItem, ItemStack replacedItem) {
         if (this.hasPermission("protocolstringreplacer.feature.usermetacache")) {
             if (ProtocolStringReplacer.getInstance().getConfigManager().removeCacheWhenMerchantTrade && isInMerchant()) {
                 return;
             }
-            ItemMeta originalMeta = originalItem.getItemMeta();
-            if (!originalMeta.equals(replacedItem.getItemMeta())) {
-                NBTItem nbtItem = new NBTItem(replacedItem);
-                nbtItem.addCompound("ProtocolStringReplacer").setShort("UserMetaCacheKey", nextUniqueCacheKey());
-                replacedItem.setItemMeta(nbtItem.getItem().getItemMeta());
-                this.getMetaCache().put(uniqueCacheKey, originalMeta);
-            }
+            NBT.modify(replacedItem, nbt -> {
+                nbt.getOrCreateCompound("ProtocolStringReplacer").setShort("UserMetaCacheKey", nextUniqueCacheKey());
+            });
+            this.getItemRestoreCache().put(uniqueCacheKey, originalItem);
         }
     }
 
@@ -376,7 +372,7 @@ public String toString() {
                 "uuid=" + uuid +
                 ", player=" + player +
                 ", currentWindowTitle='" + currentWindowTitle + '\'' +
-                ", metaCache=" + metaCache +
+                ", metaCache=" + itemRestoreCache +
                 ", uniqueCacheKey=" + uniqueCacheKey +
                 ", editorReplacerConfig=" + editorReplacerConfig +
                 '}';
diff --git a/bukkit/src/main/java/io/github/rothes/protocolstringreplacer/packetlistener/client/itemstack/BaseClientItemPacketListener.java b/bukkit/src/main/java/io/github/rothes/protocolstringreplacer/packetlistener/client/itemstack/BaseClientItemPacketListener.java
@@ -1,12 +1,11 @@
 package io.github.rothes.protocolstringreplacer.packetlistener.client.itemstack;
 
 import com.comphenix.protocol.PacketType;
-import de.tr7zw.changeme.nbtapi.NBTItem;
+import de.tr7zw.changeme.nbtapi.NBT;
 import io.github.rothes.protocolstringreplacer.ProtocolStringReplacer;
 import io.github.rothes.protocolstringreplacer.packetlistener.client.BaseClientPacketListener;
 import io.github.rothes.protocolstringreplacer.api.user.PsrUser;
 import org.bukkit.inventory.ItemStack;
-import org.bukkit.inventory.meta.ItemMeta;
 
 import java.util.HashMap;
 
@@ -16,27 +15,27 @@ protected BaseClientItemPacketListener(PacketType packetType) {
         super(packetType);
     }
 
-    protected void restoreItem(PsrUser user, ItemStack itemStack) {
+    protected ItemStack restoreItem(PsrUser user, ItemStack itemStack) {
         if (!itemStack.hasItemMeta()) {
-            return;
+            return itemStack;
         }
-        NBTItem nbtItem = new NBTItem(itemStack);
-        if (!nbtItem.hasTag("ProtocolStringReplacer")) {
-            return;
-        }
-        Short uniqueCacheKey = nbtItem.getCompound("ProtocolStringReplacer").getShort("UserMetaCacheKey");
-
-        if (uniqueCacheKey != null) {
-            HashMap<Short, ItemMeta> userMetaCache = user.getMetaCache();
-            ItemMeta original = userMetaCache.get(uniqueCacheKey);
-            if (original == null) {
-                ProtocolStringReplacer.warn("Failed to get original ItemMeta by meta-cache key, ignoring.\n" + itemStack);
-                return;
+        return NBT.get(itemStack, nbt -> {
+            if (nbt.hasTag("ProtocolStringReplacer")) {
+                Short uniqueCacheKey = nbt.getCompound("ProtocolStringReplacer").getShort("UserMetaCacheKey");
+                if (uniqueCacheKey != null) {
+                    HashMap<Short, ItemStack> userItemRestoreCache = user.getItemRestoreCache();
+                    ItemStack original = userItemRestoreCache.get(uniqueCacheKey);
+                    if (original == null) {
+                        ProtocolStringReplacer.warn("Failed to get original ItemMeta by meta-cache key, ignoring.\n" + itemStack);
+                        return itemStack;
+                    }
+                    return original;
+                } else {
+                    ProtocolStringReplacer.warn("Failed to get original ItemMeta by meta-cache key due to null, ignoring.\n" + itemStack);
+                }
             }
-            itemStack.setItemMeta(original);
-        } else {
-            ProtocolStringReplacer.warn("Failed to get original ItemMeta by meta-cache key due to null, ignoring.\n" + itemStack);
-        }
+            return itemStack;
+        });
     }
 
 }
diff --git a/bukkit/src/main/java/io/github/rothes/protocolstringreplacer/packetlistener/client/itemstack/SetCreativeSlot.java b/bukkit/src/main/java/io/github/rothes/protocolstringreplacer/packetlistener/client/itemstack/SetCreativeSlot.java
@@ -2,6 +2,7 @@
 
 import com.comphenix.protocol.PacketType;
 import com.comphenix.protocol.events.PacketEvent;
+import com.comphenix.protocol.reflect.StructureModifier;
 import io.github.rothes.protocolstringreplacer.api.user.PsrUser;
 import org.bukkit.inventory.ItemStack;
 
@@ -17,8 +18,9 @@ protected void process(PacketEvent packetEvent) {
             return;
         }
         if (user.hasPermission("protocolstringreplacer.feature.usermetacache")) {
-            ItemStack itemStack = packetEvent.getPacket().getItemModifier().read(0);
-            restoreItem(user, itemStack);
+            StructureModifier<org.bukkit.inventory.ItemStack> itemModifier = packetEvent.getPacket().getItemModifier();
+            ItemStack itemStack = itemModifier.read(0);
+            itemModifier.write(0, restoreItem(user, itemStack));
         }
     }
 
diff --git a/bukkit/src/main/java/io/github/rothes/protocolstringreplacer/packetlistener/client/itemstack/WindowClick.java b/bukkit/src/main/java/io/github/rothes/protocolstringreplacer/packetlistener/client/itemstack/WindowClick.java
@@ -17,8 +17,9 @@ protected void process(PacketEvent packetEvent) {
             return;
         }
         if (user.hasPermission("protocolstringreplacer.feature.usermetacache.noncreative")) {
-            ItemStack itemStack = packetEvent.getPacket().getItemModifier().read(0);
-            restoreItem(user, itemStack);
+            com.comphenix.protocol.reflect.StructureModifier<org.bukkit.inventory.ItemStack> itemModifier = packetEvent.getPacket().getItemModifier();
+            ItemStack itemStack = itemModifier.read(0);
+            itemModifier.write(0, restoreItem(user, itemStack));
         }
     }
 
diff --git a/bukkit/src/main/java/io/github/rothes/protocolstringreplacer/packetlistener/server/BaseServerPacketListener.java b/bukkit/src/main/java/io/github/rothes/protocolstringreplacer/packetlistener/server/BaseServerPacketListener.java
@@ -321,15 +321,15 @@ protected static ItemStack replaceItemStack(@Nonnull PacketEvent packetEvent, @N
 
                 replacerManager.setPapi(user, container.getTexts(), papiIndexes);
             }
-            container.getResult();
+            ItemStack result = container.getResult();
 
-            if (saveCache && !original.isSimilar(itemStack)) {
-                user.saveUserMetaCache(original, itemStack);
+            if (saveCache && !original.equals(result)) {
+                user.saveUserItemRestoreCache(original, result);
             }
             if (user.isCapturing(listenType)) {
                 captureItemStackInfo(user, original, listenType, nbt, lore, entries);
             }
-            return container.getResult();
+            return result;
         } catch (Throwable t) {
             t.printStackTrace();
         }
diff --git a/bukkit/src/main/kotlin/io/github/rothes/protocolstringreplacer/packetlistener/server/itemstack/WindowItems.kt b/bukkit/src/main/kotlin/io/github/rothes/protocolstringreplacer/packetlistener/server/itemstack/WindowItems.kt
@@ -12,7 +12,7 @@ class WindowItems : BaseServerItemPacketListener(PacketType.Play.Server.WINDOW_I
 
     override fun process(packetEvent: PacketEvent) {
         val user = getEventUser(packetEvent) ?: return
-        user.clearUserMetaCache()
+        user.clearUserItemRestoreCache()
         val replacerManager = ProtocolStringReplacer.getInstance().replacerManager
         val nbt = replacerManager.getAcceptedReplacers(user, itemNbtFilter)
         val lore = replacerManager.getAcceptedReplacers(user, itemLoreFilter)
diff --git a/bukkit/src/main/kotlin/io/github/rothes/protocolstringreplacer/packetlistener/server/itemstack/WindowItemsPost11.kt b/bukkit/src/main/kotlin/io/github/rothes/protocolstringreplacer/packetlistener/server/itemstack/WindowItemsPost11.kt
@@ -11,7 +11,7 @@ class WindowItemsPost11 : BaseServerItemPacketListener(PacketType.Play.Server.WI
 
     override fun process(packetEvent: PacketEvent) {
         val user = getEventUser(packetEvent) ?: return
-        user.clearUserMetaCache()
+        user.clearUserItemRestoreCache()
         val replacerManager = ProtocolStringReplacer.getInstance().replacerManager
         val nbt = replacerManager.getAcceptedReplacers(user, itemNbtFilter)
         val lore = replacerManager.getAcceptedReplacers(user, itemLoreFilter)

Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`
`3`	`3`	`import com.comphenix.protocol.PacketType;`
`4`	`4`	`import com.comphenix.protocol.events.PacketEvent;`
	`5`	`+import com.comphenix.protocol.reflect.StructureModifier;`
`5`	`6`	`import io.github.rothes.protocolstringreplacer.api.user.PsrUser;`
`6`	`7`	`import org.bukkit.inventory.ItemStack;`
`7`	`8`
`@@ -17,8 +18,9 @@ protected void process(PacketEvent packetEvent) {`
`17`	`18`	`return;`
`18`	`19`	`}`
`19`	`20`	`if (user.hasPermission("protocolstringreplacer.feature.usermetacache")) {`
`20`		`- ItemStack itemStack = packetEvent.getPacket().getItemModifier().read(0);`
`21`		`- restoreItem(user, itemStack);`
	`21`	`+ StructureModifier<org.bukkit.inventory.ItemStack> itemModifier = packetEvent.getPacket().getItemModifier();`
	`22`	`+ ItemStack itemStack = itemModifier.read(0);`
	`23`	`+ itemModifier.write(0, restoreItem(user, itemStack));`
`22`	`24`	`}`
`23`	`25`	`}`
`24`	`26`
Original file line number	Diff line number	Diff line change
`@@ -17,8 +17,9 @@ protected void process(PacketEvent packetEvent) {`
`17`	`17`	`return;`
`18`	`18`	`}`
`19`	`19`	`if (user.hasPermission("protocolstringreplacer.feature.usermetacache.noncreative")) {`
`20`		`- ItemStack itemStack = packetEvent.getPacket().getItemModifier().read(0);`
`21`		`- restoreItem(user, itemStack);`
	`20`	`+ com.comphenix.protocol.reflect.StructureModifier<org.bukkit.inventory.ItemStack> itemModifier = packetEvent.getPacket().getItemModifier();`
	`21`	`+ ItemStack itemStack = itemModifier.read(0);`
	`22`	`+ itemModifier.write(0, restoreItem(user, itemStack));`
`22`	`23`	`}`
`23`	`24`	`}`
`24`	`25`
Original file line number	Diff line number	Diff line change
`@@ -321,15 +321,15 @@ protected static ItemStack replaceItemStack(@Nonnull PacketEvent packetEvent, @N`
`321`	`321`
`322`	`322`	`replacerManager.setPapi(user, container.getTexts(), papiIndexes);`
`323`	`323`	`}`
`324`		`- container.getResult();`
	`324`	`+ ItemStack result = container.getResult();`
`325`	`325`
`326`		`- if (saveCache && !original.isSimilar(itemStack)) {`
`327`		`- user.saveUserMetaCache(original, itemStack);`
	`326`	`+ if (saveCache && !original.equals(result)) {`
	`327`	`+ user.saveUserItemRestoreCache(original, result);`
`328`	`328`	`}`
`329`	`329`	`if (user.isCapturing(listenType)) {`
`330`	`330`	`captureItemStackInfo(user, original, listenType, nbt, lore, entries);`
`331`	`331`	`}`
`332`		`- return container.getResult();`
	`332`	`+ return result;`
`333`	`333`	`} catch (Throwable t) {`
`334`	`334`	`t.printStackTrace();`
`335`	`335`	`}`