Add item ids to Books in more places (#256)

* Add item ids to Books in more places

Add item ids to Enchanted Books in the Bazaar and in the Experimentation
Table.

Add ItemResolutionQuery as a new way to query items and item ids.

Co-authored-by: romangraef <roman.graef@gmail.com>

* Update 2.1.md

* Infer found a bug that already existed before.

* add support for animated crab hats

Co-authored-by: hannibal00212 <24389977+hannibal00212@users.noreply.github.com>
Co-authored-by: nopo <noahogno@gmail.com>

1 files changed, 239 insertions, 0 deletions

diff --git a/src/main/java/io/github/moulberry/notenoughupdates/util/ItemResolutionQuery.java b/src/main/java/io/github/moulberry/notenoughupdates/util/ItemResolutionQuery.java
new file mode 100644
index 00000000..1ff659ac
--- /dev/null
+++ b/src/main/java/io/github/moulberry/notenoughupdates/util/ItemResolutionQuery.java
@@ -0,0 +1,239 @@
+/*
+ * Copyright (C) 2022 NotEnoughUpdates contributors
+ *
+ * This file is part of NotEnoughUpdates.
+ *
+ * NotEnoughUpdates is free software: you can redistribute it
+ * and/or modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation, either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * NotEnoughUpdates is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with NotEnoughUpdates. If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package io.github.moulberry.notenoughupdates.util;
+
+import com.google.common.collect.Iterables;
+import com.google.gson.JsonObject;
+import com.google.gson.JsonParseException;
+import io.github.moulberry.notenoughupdates.NEUManager;
+import net.minecraft.client.Minecraft;
+import net.minecraft.client.gui.Gui;
+import net.minecraft.client.gui.inventory.GuiChest;
+import net.minecraft.init.Items;
+import net.minecraft.inventory.ContainerChest;
+import net.minecraft.inventory.IInventory;
+import net.minecraft.item.Item;
+import net.minecraft.item.ItemStack;
+import net.minecraft.nbt.NBTTagCompound;
+
+import javax.annotation.Nullable;
+import java.util.Arrays;
+import java.util.List;
+import java.util.Locale;
+import java.util.regex.Matcher;
+import java.util.regex.Pattern;
+
+public class ItemResolutionQuery {
+
+	private static final Pattern ENCHANTED_BOOK_NAME_PATTERN = Pattern.compile("^((?:§.)+)([^§]+) ([IVXL]+)$");
+	private static final String EXTRA_ATTRIBUTES = "ExtraAttributes";
+	private static final List<String> PET_RARITIES = Arrays.asList(
+		"COMMON",
+		"UNCOMMON",
+		"RARE",
+		"EPIC",
+		"LEGENDARY",
+		"MYTHIC"
+	);
+	private final NEUManager manager;
+	private NBTTagCompound compound;
+	private Item itemType;
+	private int stackSize = -1;
+	private Gui guiContext;
+	private String knownInternalName;
+
+	public ItemResolutionQuery(NEUManager manager) {
+		this.manager = manager;
+	}
+
+	public ItemResolutionQuery withItemNBT(NBTTagCompound compound) {
+		this.compound = compound;
+		return this;
+	}
+
+	public ItemResolutionQuery withItemStack(ItemStack stack) {
+		if (stack == null) return this;
+		this.itemType = stack.getItem();
+		this.compound = stack.getTagCompound();
+		this.stackSize = stack.stackSize;
+		return this;
+	}
+
+	public ItemResolutionQuery withGuiContext(Gui gui) {
+		this.guiContext = gui;
+		return this;
+	}
+
+	public ItemResolutionQuery withCurrentGuiContext() {
+		this.guiContext = Minecraft.getMinecraft().currentScreen;
+		return this;
+	}
+
+	public ItemResolutionQuery withKnownInternalName(String knownInternalName) {
+		this.knownInternalName = knownInternalName;
+		return this;
+	}
+
+	@Nullable
+	public String resolveInternalName() {
+		if (knownInternalName != null) {
+			return knownInternalName;
+		}
+		String resolvedName = resolveFromSkyblock();
+		if (resolvedName == null) {
+			resolvedName = resolveContextualName();
+		} else {
+			switch (resolvedName.intern()) {
+				case "PET":
+					resolvedName = resolvePetName();
+					break;
+				case "RUNE":
+					resolvedName = resolveRuneName();
+					break;
+				case "ENCHANTED_BOOK":
+					resolvedName = resolveEnchantedBookNameFromNBT();
+					break;
+				case "PARTY_HAT_CRAB":
+				case "PARTY_HAT_CRAB_ANIMATED":
+					resolvedName = resolveCrabHatName();
+					break;
+			}
+		}
+
+		return resolvedName;
+	}
+
+	@Nullable
+	public JsonObject resolveToItemListJson() {
+		String internalName = resolveInternalName();
+		if (internalName == null) {
+			return null;
+		}
+		return manager.getItemInformation().get(internalName);
+	}
+
+	@Nullable
+	public ItemStack resolveToItemStack() {
+		JsonObject jsonObject = resolveToItemListJson();
+		if (jsonObject == null) return null;
+		return manager.jsonToStack(jsonObject);
+	}
+
+	// <editor-fold desc="Resolution Helpers">
+	private boolean isBazaar(IInventory chest) {
+		if (chest.getDisplayName().getFormattedText().startsWith("Bazaar ➜ ")) {
+			return true;
+		}
+		int bazaarSlot = chest.getSizeInventory() - 5;
+		if (bazaarSlot < 0) return false;
+		ItemStack stackInSlot = chest.getStackInSlot(bazaarSlot);
+		if (stackInSlot == null || stackInSlot.stackSize == 0) return false;
+		// NBT lore, we do not care about rendered lore
+		List<String> lore = ItemUtils.getLore(stackInSlot);
+		return lore.contains("§7To Bazaar");
+	}
+
+	private String resolveContextualName() {
+		if (!(guiContext instanceof GuiChest)) {
+			return null;
+		}
+		GuiChest chest = (GuiChest) guiContext;
+		ContainerChest inventorySlots = (ContainerChest) chest.inventorySlots;
+		String guiName = inventorySlots.getLowerChestInventory().getDisplayName().getUnformattedText();
+		boolean isOnBazaar = isBazaar(inventorySlots.getLowerChestInventory());
+		String displayName = ItemUtils.getDisplayName(compound);
+		if (displayName == null) return null;
+		if (itemType == Items.enchanted_book && isOnBazaar && compound != null) {
+			return resolveEnchantmentByName(displayName);
+		}
+		if (displayName.endsWith("Enchanted Book") && guiName.startsWith("Superpairs")) {
+			for (String loreLine : ItemUtils.getLore(compound)) {
+				String enchantmentIdCandidate = resolveEnchantmentByName(loreLine);
+				if (enchantmentIdCandidate != null) return enchantmentIdCandidate;
+			}
+			return null;
+		}
+		return null;
+	}
+
+	private String resolveEnchantmentByName(String name) {
+		Matcher matcher = ENCHANTED_BOOK_NAME_PATTERN.matcher(name);
+		if (!matcher.matches()) return null;
+		String format = matcher.group(1).toLowerCase(Locale.ROOT);
+		String enchantmentName = matcher.group(2).trim();
+		String romanLevel = matcher.group(3);
+		boolean ultimate = (format.contains("§l"));
+
+		return (ultimate ? "ULTIMATE_" : "")
+			+ enchantmentName.replace(" ", "_").toUpperCase(Locale.ROOT)
+			+ ";" + Utils.parseRomanNumeral(romanLevel);
+	}
+
+	private String resolveCrabHatName() {
+		int crabHatYear = getExtraAttributes().getInteger("party_hat_year");
+		String color = getExtraAttributes().getString("party_hat_color");
+		return "PARTY_HAT_CRAB_" + color.toUpperCase(Locale.ROOT) + (crabHatYear == 2022 ? "_ANIMATED" : "");
+	}
+
+	private String resolveEnchantedBookNameFromNBT() {
+		NBTTagCompound enchantments = getExtraAttributes().getCompoundTag("enchantments");
+		String enchantName = Iterables.getOnlyElement(enchantments.getKeySet(), null);
+		if (enchantName == null || enchantName.isEmpty()) return null;
+		return enchantName.toUpperCase(Locale.ROOT) + ";" + enchantments.getInteger(enchantName);
+	}
+
+	private String resolveRuneName() {
+		NBTTagCompound runes = getExtraAttributes().getCompoundTag("runes");
+		String runeName = Iterables.getOnlyElement(runes.getKeySet(), null);
+		if (runeName == null || runeName.isEmpty()) return null;
+		return runeName.toUpperCase(Locale.ROOT) + "_RUNE;" + runes.getInteger(runeName);
+	}
+
+	private String resolvePetName() {
+		String petInfo = getExtraAttributes().getString("petInfo");
+		if (petInfo == null || petInfo.isEmpty()) return null;
+		try {
+			JsonObject petInfoObject = manager.gson.fromJson(petInfo, JsonObject.class);
+			String petId = petInfoObject.get("type").getAsString();
+			String petTier = petInfoObject.get("tier").getAsString();
+			int rarityIndex = PET_RARITIES.indexOf(petTier);
+			return petId.toUpperCase(Locale.ROOT) + ";" + rarityIndex;
+		} catch (JsonParseException | ClassCastException ex) {
+			/* This happens if Hypixel changed the pet json format;
+				 I still log this exception, since this case *is* exceptional and cannot easily be recovered from */
+			ex.printStackTrace();
+			return null;
+		}
+	}
+
+	private NBTTagCompound getExtraAttributes() {
+		if (compound == null) return new NBTTagCompound();
+		return compound.getCompoundTag(EXTRA_ATTRIBUTES);
+	}
+
+	private String resolveFromSkyblock() {
+		String internalName = getExtraAttributes().getString("id");
+		if (internalName == null || internalName.isEmpty()) return null;
+		return internalName.toUpperCase(Locale.ROOT);
+	}
+
+	// </editor-fold>
+
+}