2021-06-11 14:02:28 +02:00
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
From: Aikar <aikar@aikar.co>
Date: Thu, 28 May 2015 23:00:19 -0400
Subject: [PATCH] Handle Item Meta Inconsistencies
First, Enchantment order would blow away seeing 2 items as the same,
however the Client forces enchantment list in a certain order, as well
as does the /enchant command. Anvils can insert it into forced order,
causing 2 same items to be considered different.
This change makes unhandled NBT Tags and Enchantments use a sorted tree map,
so they will always be in a consistent order.
Additionally, the old enchantment API was never updated when ItemMeta
was added, resulting in 2 different ways to modify an items enchantments.
For consistency, the old API methods now forward to use the
ItemMeta API equivalents, and should deprecate the old API's.
2024-04-24 03:25:14 +02:00
diff --git a/src/main/java/net/minecraft/world/item/enchantment/ItemEnchantments.java b/src/main/java/net/minecraft/world/item/enchantment/ItemEnchantments.java
2021-06-11 14:02:28 +02:00
index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
2024-04-24 03:25:14 +02:00
--- a/src/main/java/net/minecraft/world/item/enchantment/ItemEnchantments.java
+++ b/src/main/java/net/minecraft/world/item/enchantment/ItemEnchantments.java
@@ -0,0 +0,0 @@ import net.minecraft.tags.TagKey;
import net.minecraft.world.item.Item;
import net.minecraft.world.item.TooltipFlag;
import net.minecraft.world.item.component.TooltipProvider;
+// Paper start
+import it.unimi.dsi.fastutil.objects.Object2IntAVLTreeMap;
+// Paper end
2021-06-11 14:02:28 +02:00
2024-04-24 03:25:14 +02:00
public class ItemEnchantments implements TooltipProvider {
- public static final ItemEnchantments EMPTY = new ItemEnchantments(new Object2IntOpenHashMap<>(), true);
2021-06-11 14:02:28 +02:00
+ // Paper start
2024-04-24 03:25:14 +02:00
+ private static final java.util.Comparator<Holder<Enchantment>> ENCHANTMENT_ORDER = java.util.Comparator.comparing(Holder::getRegisteredName);
+ public static final ItemEnchantments EMPTY = new ItemEnchantments(new Object2IntAVLTreeMap<>(ENCHANTMENT_ORDER), true);
2021-06-11 14:02:28 +02:00
+ // Paper end
2024-04-24 03:25:14 +02:00
private static final Codec<Integer> LEVEL_CODEC = Codec.intRange(0, 255);
2024-06-13 19:30:39 +02:00
- private static final Codec<Object2IntOpenHashMap<Holder<Enchantment>>> LEVELS_CODEC = Codec.unboundedMap(Enchantment.CODEC, LEVEL_CODEC)
2024-04-24 03:25:14 +02:00
- .xmap(Object2IntOpenHashMap::new, Function.identity());
2024-06-13 19:30:39 +02:00
+ private static final Codec<Object2IntAVLTreeMap<Holder<Enchantment>>> LEVELS_CODEC = Codec.unboundedMap(
+ Enchantment.CODEC, LEVEL_CODEC
+ )// Paper start - sort enchantments
2024-04-27 03:06:35 +02:00
+ .xmap(m -> {
+ final Object2IntAVLTreeMap<Holder<Enchantment>> map = new Object2IntAVLTreeMap<>(ENCHANTMENT_ORDER);
+ map.putAll(m);
+ return map;
+ }, Function.identity());
2024-06-13 19:30:39 +02:00
+ // Paper end - sort enchantments
2024-04-24 03:25:14 +02:00
private static final Codec<ItemEnchantments> FULL_CODEC = RecordCodecBuilder.create(
instance -> instance.group(
LEVELS_CODEC.fieldOf("levels").forGetter(component -> component.enchantments),
@@ -0,0 +0,0 @@ public class ItemEnchantments implements TooltipProvider {
);
public static final Codec<ItemEnchantments> CODEC = Codec.withAlternative(FULL_CODEC, LEVELS_CODEC, map -> new ItemEnchantments(map, true));
public static final StreamCodec<RegistryFriendlyByteBuf, ItemEnchantments> STREAM_CODEC = StreamCodec.composite(
2024-06-13 19:30:39 +02:00
- ByteBufCodecs.map(Object2IntOpenHashMap::new, Enchantment.STREAM_CODEC, ByteBufCodecs.VAR_INT),
+ ByteBufCodecs.map((v) -> new Object2IntAVLTreeMap<>(ENCHANTMENT_ORDER), Enchantment.STREAM_CODEC, ByteBufCodecs.VAR_INT),
2024-04-24 03:25:14 +02:00
component -> component.enchantments,
ByteBufCodecs.BOOL,
component -> component.showInTooltip,
ItemEnchantments::new
);
- final Object2IntOpenHashMap<Holder<Enchantment>> enchantments;
+ final Object2IntAVLTreeMap<Holder<Enchantment>> enchantments; // Paper
public final boolean showInTooltip;
2021-12-06 21:28:36 +01:00
2024-04-24 03:25:14 +02:00
- ItemEnchantments(Object2IntOpenHashMap<Holder<Enchantment>> enchantments, boolean showInTooltip) {
+ ItemEnchantments(Object2IntAVLTreeMap<Holder<Enchantment>> enchantments, boolean showInTooltip) { // Paper
this.enchantments = enchantments;
this.showInTooltip = showInTooltip;
2021-07-07 08:52:40 +02:00
2024-04-24 03:25:14 +02:00
@@ -0,0 +0,0 @@ public class ItemEnchantments implements TooltipProvider {
2021-06-11 14:02:28 +02:00
}
2024-04-24 03:25:14 +02:00
public static class Mutable {
- private final Object2IntOpenHashMap<Holder<Enchantment>> enchantments = new Object2IntOpenHashMap<>();
+ private final Object2IntAVLTreeMap<Holder<Enchantment>> enchantments = new Object2IntAVLTreeMap<>(ENCHANTMENT_ORDER); // Paper
public boolean showInTooltip;
public Mutable(ItemEnchantments enchantmentsComponent) {
2021-06-11 14:02:28 +02:00
diff --git a/src/main/java/org/bukkit/craftbukkit/inventory/CraftItemStack.java b/src/main/java/org/bukkit/craftbukkit/inventory/CraftItemStack.java
index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
--- a/src/main/java/org/bukkit/craftbukkit/inventory/CraftItemStack.java
+++ b/src/main/java/org/bukkit/craftbukkit/inventory/CraftItemStack.java
@@ -0,0 +0,0 @@ public final class CraftItemStack extends ItemStack {
public void addUnsafeEnchantment(Enchantment ench, int level) {
2023-06-13 01:51:45 +02:00
Preconditions.checkArgument(ench != null, "Enchantment cannot be null");
2021-06-11 14:02:28 +02:00
2021-06-12 02:57:04 +02:00
- if (!CraftItemStack.makeTag(this.handle)) {
2021-06-11 14:02:28 +02:00
- return;
- }
2024-04-24 03:25:14 +02:00
- ItemEnchantments list = CraftItemStack.getEnchantmentList(this.handle);
2021-06-11 14:02:28 +02:00
- if (list == null) {
2024-04-24 03:25:14 +02:00
- list = ItemEnchantments.EMPTY;
2024-05-26 00:58:56 +02:00
+ // Paper start - Replace whole method
+ final ItemMeta itemMeta = this.getItemMeta();
+ if (itemMeta != null) {
+ itemMeta.addEnchant(ench, level, true);
+ this.setItemMeta(itemMeta);
}
2024-04-24 03:25:14 +02:00
- ItemEnchantments.Mutable listCopy = new ItemEnchantments.Mutable(list);
2024-06-13 19:30:39 +02:00
- listCopy.set(CraftEnchantment.bukkitToMinecraftHolder(ench), level);
2024-04-24 03:25:14 +02:00
- this.handle.set(DataComponents.ENCHANTMENTS, listCopy.toImmutable());
2021-06-11 14:02:28 +02:00
+ // Paper end
}
static boolean makeTag(net.minecraft.world.item.ItemStack item) {
@@ -0,0 +0,0 @@ public final class CraftItemStack extends ItemStack {
public int removeEnchantment(Enchantment ench) {
2023-06-13 01:51:45 +02:00
Preconditions.checkArgument(ench != null, "Enchantment cannot be null");
2021-06-11 14:02:28 +02:00
2024-04-24 03:25:14 +02:00
- ItemEnchantments list = CraftItemStack.getEnchantmentList(this.handle);
2021-06-11 14:02:28 +02:00
- if (list == null) {
- return 0;
2023-03-23 22:57:03 +01:00
- }
2024-04-24 03:25:14 +02:00
- int level = this.getEnchantmentLevel(ench);
- if (level <= 0) {
2021-06-11 14:02:28 +02:00
- return 0;
- }
2024-04-24 03:25:14 +02:00
- int size = list.size();
-
2021-06-11 14:02:28 +02:00
- if (size == 1) {
2024-04-24 03:25:14 +02:00
- this.handle.remove(DataComponents.ENCHANTMENTS);
2021-06-11 14:02:28 +02:00
- return level;
2023-03-23 22:57:03 +01:00
+ // Paper start - replace entire method
+ int level = getEnchantmentLevel(ench);
+ if (level > 0) {
+ final ItemMeta itemMeta = this.getItemMeta();
+ if (itemMeta == null) return 0;
+ itemMeta.removeEnchant(ench);
+ this.setItemMeta(itemMeta);
}
2024-04-24 03:25:14 +02:00
-
- ItemEnchantments.Mutable listCopy = new ItemEnchantments.Mutable(list);
2024-06-13 19:30:39 +02:00
- listCopy.set(CraftEnchantment.bukkitToMinecraftHolder(ench), -1); // Negative to remove
2024-04-24 03:25:14 +02:00
- this.handle.set(DataComponents.ENCHANTMENTS, listCopy.toImmutable());
2021-06-11 14:02:28 +02:00
+ // Paper end
return level;
}
2024-01-26 20:17:06 +01:00
@@ -0,0 +0,0 @@ public final class CraftItemStack extends ItemStack {
2021-06-11 14:02:28 +02:00
@Override
public Map<Enchantment, Integer> getEnchantments() {
2021-06-12 02:57:04 +02:00
- return CraftItemStack.getEnchantments(this.handle);
+ return this.hasItemMeta() ? this.getItemMeta().getEnchants() : ImmutableMap.<Enchantment, Integer>of(); // Paper - use Item Meta
2021-06-11 14:02:28 +02:00
}
static Map<Enchantment, Integer> getEnchantments(net.minecraft.world.item.ItemStack item) {
diff --git a/src/main/java/org/bukkit/craftbukkit/inventory/CraftMetaItem.java b/src/main/java/org/bukkit/craftbukkit/inventory/CraftMetaItem.java
index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
--- a/src/main/java/org/bukkit/craftbukkit/inventory/CraftMetaItem.java
+++ b/src/main/java/org/bukkit/craftbukkit/inventory/CraftMetaItem.java
@@ -0,0 +0,0 @@ import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableMultimap;
import com.google.common.collect.LinkedHashMultimap;
+import com.google.common.collect.ImmutableSortedMap; // Paper
import com.google.common.collect.Lists;
import com.google.common.collect.Multimap;
import com.google.common.collect.SetMultimap;
2024-04-24 03:25:14 +02:00
@@ -0,0 +0,0 @@ import java.util.Arrays;
2021-11-23 13:15:10 +01:00
import java.util.Base64;
2021-06-11 14:02:28 +02:00
import java.util.Collection;
2024-04-24 03:25:14 +02:00
import java.util.Collections;
2021-06-11 14:02:28 +02:00
+import java.util.Comparator; // Paper
import java.util.EnumSet;
import java.util.HashMap;
import java.util.Iterator;
@@ -0,0 +0,0 @@ class CraftMetaItem implements ItemMeta, Damageable, Repairable, BlockDataMeta {
2024-04-24 03:25:14 +02:00
private List<Component> lore; // null and empty are two different states internally
2021-06-11 14:02:28 +02:00
private Integer customModelData;
2024-04-24 03:25:14 +02:00
private Map<String, String> blockData;
2021-06-11 14:02:28 +02:00
- private Map<Enchantment, Integer> enchantments;
+ private EnchantmentMap enchantments; // Paper
private Multimap<Attribute, AttributeModifier> attributeModifiers;
private int repairCost;
private int hideFlag;
@@ -0,0 +0,0 @@ class CraftMetaItem implements ItemMeta, Damageable, Repairable, BlockDataMeta {
this.blockData = meta.blockData;
2023-12-25 23:51:56 +01:00
if (meta.enchantments != null) {
2021-06-11 14:02:28 +02:00
- this.enchantments = new LinkedHashMap<Enchantment, Integer>(meta.enchantments);
+ this.enchantments = new EnchantmentMap(meta.enchantments); // Paper
}
if (meta.hasAttributeModifiers()) {
@@ -0,0 +0,0 @@ class CraftMetaItem implements ItemMeta, Damageable, Repairable, BlockDataMeta {
}
}
2024-04-24 03:25:14 +02:00
- static Map<Enchantment, Integer> buildEnchantments(ItemEnchantments tag) {
- Map<Enchantment, Integer> enchantments = new LinkedHashMap<Enchantment, Integer>(tag.size());
+ static EnchantmentMap buildEnchantments(ItemEnchantments tag) { // Paper
2021-06-11 14:02:28 +02:00
+ EnchantmentMap enchantments = new EnchantmentMap(); // Paper
2024-04-24 03:25:14 +02:00
tag.entrySet().forEach((entry) -> {
Holder<net.minecraft.world.item.enchantment.Enchantment> id = entry.getKey();
2021-06-11 14:02:28 +02:00
@@ -0,0 +0,0 @@ class CraftMetaItem implements ItemMeta, Damageable, Repairable, BlockDataMeta {
2024-04-24 03:25:14 +02:00
return modifiers;
2021-06-11 14:02:28 +02:00
}
- static Map<Enchantment, Integer> buildEnchantments(Map<String, Object> map, ItemMetaKey key) {
+ static EnchantmentMap buildEnchantments(Map<String, Object> map, ItemMetaKey key) { // Paper
Map<?, ?> ench = SerializableMeta.getObject(Map.class, map, key.BUKKIT, true);
if (ench == null) {
return null;
}
- Map<Enchantment, Integer> enchantments = new LinkedHashMap<Enchantment, Integer>(ench.size());
+ EnchantmentMap enchantments = new EnchantmentMap(); // Paper
for (Map.Entry<?, ?> entry : ench.entrySet()) {
2024-05-11 23:48:37 +02:00
Enchantment enchantment = CraftEnchantment.stringToBukkit(entry.getKey().toString());
if ((enchantment != null) && (entry.getValue() instanceof Integer)) {
2021-06-11 14:02:28 +02:00
@@ -0,0 +0,0 @@ class CraftMetaItem implements ItemMeta, Damageable, Repairable, BlockDataMeta {
@Override
public Map<Enchantment, Integer> getEnchants() {
2023-10-27 01:34:58 +02:00
- return this.hasEnchants() ? ImmutableMap.copyOf(this.enchantments) : ImmutableMap.<Enchantment, Integer>of();
2021-06-12 02:57:04 +02:00
+ return this.hasEnchants() ? ImmutableSortedMap.copyOfSorted(this.enchantments) : ImmutableMap.<Enchantment, Integer>of(); // Paper
2021-06-11 14:02:28 +02:00
}
@Override
public boolean addEnchant(Enchantment ench, int level, boolean ignoreRestrictions) {
2023-06-13 01:51:45 +02:00
Preconditions.checkArgument(ench != null, "Enchantment cannot be null");
2021-06-12 02:57:04 +02:00
if (this.enchantments == null) {
- this.enchantments = new LinkedHashMap<Enchantment, Integer>(4);
+ this.enchantments = new EnchantmentMap(); // Paper
2021-06-11 14:02:28 +02:00
}
if (ignoreRestrictions || level >= ench.getStartLevel() && level <= ench.getMaxLevel()) {
@@ -0,0 +0,0 @@ class CraftMetaItem implements ItemMeta, Damageable, Repairable, BlockDataMeta {
clone.customModelData = this.customModelData;
clone.blockData = this.blockData;
if (this.enchantments != null) {
- clone.enchantments = new LinkedHashMap<Enchantment, Integer>(this.enchantments);
+ clone.enchantments = new EnchantmentMap(this.enchantments); // Paper
}
if (this.hasAttributeModifiers()) {
clone.attributeModifiers = LinkedHashMultimap.create(this.attributeModifiers);
@@ -0,0 +0,0 @@ class CraftMetaItem implements ItemMeta, Damageable, Repairable, BlockDataMeta {
2024-04-24 03:25:14 +02:00
return (result != null) ? result : Optional.empty();
2021-06-11 14:02:28 +02:00
}
+
+ // Paper start
2024-05-11 23:48:37 +02:00
+ private static class EnchantmentMap extends java.util.TreeMap<org.bukkit.enchantments.Enchantment, Integer> {
2021-06-11 14:02:28 +02:00
+ private EnchantmentMap(Map<Enchantment, Integer> enchantments) {
+ this();
+ putAll(enchantments);
+ }
+
+ private EnchantmentMap() {
+ super(Comparator.comparing(o -> o.getKey().toString()));
+ }
+
+ public EnchantmentMap clone() {
+ return (EnchantmentMap) super.clone();
+ }
+ }
+ // Paper end
+
}
2024-05-10 12:52:03 +02:00
diff --git a/src/main/java/org/bukkit/craftbukkit/profile/CraftPlayerProfile.java b/src/main/java/org/bukkit/craftbukkit/profile/CraftPlayerProfile.java
index 0000000000000000000000000000000000000000..0000000000000000000000000000000000000000 100644
--- a/src/main/java/org/bukkit/craftbukkit/profile/CraftPlayerProfile.java
+++ b/src/main/java/org/bukkit/craftbukkit/profile/CraftPlayerProfile.java
@@ -0,0 +0,0 @@ public final class CraftPlayerProfile implements PlayerProfile {
boolean isValidSkullProfile = (gameProfile.getName() != null)
|| gameProfile.getProperties().containsKey(CraftPlayerTextures.PROPERTY_NAME);
Preconditions.checkArgument(isValidSkullProfile, "The skull profile is missing a name or textures!");
+ // Paper start - Validate
+ Preconditions.checkArgument(gameProfile.getName().length() <= 16, "The name of the profile is longer than 16 characters");
2024-05-20 02:45:43 +02:00
+ Preconditions.checkArgument(net.minecraft.util.StringUtil.isValidPlayerName(gameProfile.getName()), "The name of the profile contains invalid characters: %s", gameProfile.getName());
2024-05-10 12:52:03 +02:00
+ final PropertyMap properties = gameProfile.getProperties();
+ Preconditions.checkArgument(properties.size() <= 16, "The profile contains more than 16 properties");
+ for (final Property property : properties.values()) {
+ Preconditions.checkArgument(property.name().length() <= 64, "The name of a property is longer than 64 characters");
+ Preconditions.checkArgument(property.value().length() <= Short.MAX_VALUE, "The value of a property is longer than 32767 characters");
+ Preconditions.checkArgument(property.signature() == null || property.signature().length() <= 1024, "The signature of a property is longer than 1024 characters");
+ }
+ // Paper end - Validate
return gameProfile;
}
@@ -0,0 +0,0 @@ public final class CraftPlayerProfile implements PlayerProfile {
public CraftPlayerProfile(UUID uniqueId, String name) {
Preconditions.checkArgument((uniqueId != null) || !StringUtils.isBlank(name), "uniqueId is null or name is blank");
+ Preconditions.checkArgument(name == null || name.length() <= 16, "The name of the profile is longer than 16 characters"); // Paper - Validate
2024-05-20 02:45:43 +02:00
+ Preconditions.checkArgument(name == null || net.minecraft.util.StringUtil.isValidPlayerName(name), "The name of the profile contains invalid characters: %s", name); // Paper - Validate
2024-05-10 12:52:03 +02:00
this.uniqueId = (uniqueId == null) ? Util.NIL_UUID : uniqueId;
this.name = (name == null) ? "" : name;
}
@@ -0,0 +0,0 @@ public final class CraftPlayerProfile implements PlayerProfile {
// Assert: (property == null) || property.getName().equals(propertyName)
this.removeProperty(propertyName);
if (property != null) {
+ Preconditions.checkArgument(this.properties.size() < 16, "The profile contains more than 16 properties"); // Paper - Validate
this.properties.put(property.name(), property);
}
}