MapItemSavedData

Requires review on the constructed codec BS.

Author: lynxplay

paper-server/patches/rejected/net/minecraft/world/level/saveddata/maps/MapItemSavedData.java.patch paper-server/patches/sources/net/minecraft/world/level/saveddata/maps/MapItemSavedData.java.patch

@@ -1,22 +1,23 @@
-From 3aeeaf31b7a7f888f54e47826e8ec0ddbe65c4bf Mon Sep 17 00:00:00 2001
-From: File <[email protected]>
-Date: Sun, 20 Apr 1997 14:37:42 +0100
-Subject: [PATCH] paper File Patches
-
-
-diff --git a/net/minecraft/world/level/saveddata/maps/MapItemSavedData.java b/net/minecraft/world/level/saveddata/maps/MapItemSavedData.java
-index 3bfdc4df0db8944db6c671f53499cf07f3a3e7be..3c1c89aade5ff092b880ba1bf1de83f54d3d62cc 100644
 --- a/net/minecraft/world/level/saveddata/maps/MapItemSavedData.java
 +++ b/net/minecraft/world/level/saveddata/maps/MapItemSavedData.java
-@@ -61,6 +61,7 @@ public class MapItemSavedData extends SavedData {
+@@ -50,7 +_,7 @@
+     private static final String FRAME_PREFIX = "frame-";
+     public static final Codec<MapItemSavedData> CODEC = RecordCodecBuilder.create(
+         instance -> instance.group(
+-                Level.RESOURCE_KEY_CODEC.fieldOf("dimension").forGetter(mapItemSavedData -> mapItemSavedData.dimension),
++                createUUIDBackedDimensionKeyCodec().forGetter(MapItemSavedData::packUUIDBackedDimension), // Paper - store target world by uuid in addition to dimension
+                 Codec.INT.fieldOf("xCenter").forGetter(mapItemSavedData -> mapItemSavedData.centerX),
+                 Codec.INT.fieldOf("zCenter").forGetter(mapItemSavedData -> mapItemSavedData.centerZ),
+                 Codec.BYTE.optionalFieldOf("scale", (byte)0).forGetter(mapItemSavedData -> mapItemSavedData.scale),
+@@ -74,6 +_,7 @@
      public byte scale;
      public byte[] colors = new byte[16384];
      public boolean locked;
 +    private final org.bukkit.craftbukkit.map.RenderData vanillaRender = new org.bukkit.craftbukkit.map.RenderData(); // Paper - Use Vanilla map renderer when possible
      public final List<MapItemSavedData.HoldingPlayer> carriedBy = Lists.newArrayList();
      public final Map<Player, MapItemSavedData.HoldingPlayer> carriedByPlayers = Maps.newHashMap();
      private final Map<String, MapBanner> bannerMarkers = Maps.newHashMap();
-@@ -68,6 +69,13 @@ public class MapItemSavedData extends SavedData {
+@@ -81,6 +_,13 @@
      private final Map<String, MapFrame> frameMarkers = Maps.newHashMap();
      private int trackedDecorationCount;
 
@@ -27,120 +28,66 @@ index 3bfdc4df0db8944db6c671f53499cf07f3a3e7be..3c1c89aade5ff092b880ba1bf1de83f5
 +    public MapId id;
 +    // CraftBukkit end
 +
-     public static SavedData.Factory<MapItemSavedData> factory() {
-         return new SavedData.Factory<>(() -> {
+     public static SavedDataType<MapItemSavedData> type(MapId mapId) {
+         return new SavedDataType<>(mapId.key(), () -> {
              throw new IllegalStateException("Should never create an empty map saved data");
-@@ -82,6 +90,11 @@ public class MapItemSavedData extends SavedData {
+@@ -95,7 +_,29 @@
          this.trackingPosition = trackingPosition;
          this.unlimitedTracking = unlimitedTracking;
          this.locked = locked;
+-    }
 +        // CraftBukkit start
 +        this.mapView = new org.bukkit.craftbukkit.map.CraftMapView(this);
 +        this.server = (org.bukkit.craftbukkit.CraftServer) org.bukkit.Bukkit.getServer();
 +        this.vanillaRender.buffer = colors; // Paper - Use Vanilla map renderer when possible
 +        // CraftBukkit end
-     }
- 
-     public static MapItemSavedData createFresh(
-@@ -100,9 +113,47 @@ public class MapItemSavedData extends SavedData {
-     }
++    }
++
++    // Paper start - store target world by uuid in addition to dimension
++    private MapItemSavedData(
++        UUIDBackedDimension dimension,
++        int x,
++        int z,
++        byte scale,
++        ByteBuffer colors,
++        boolean trackingPosition,
++        boolean unlimitedTracking,
++        boolean locked,
++        List<MapBanner> banners,
++        List<MapFrame> frames
++    ) {
++        this(dimension.resolveOrThrow(), x, z, scale, colors, trackingPosition, unlimitedTracking, locked, banners, frames);
++    }
++    // Paper end - store target world by uuid in addition to dimension
 
-     public static MapItemSavedData load(CompoundTag tag, HolderLookup.Provider levelRegistry) {
--        ResourceKey<Level> resourceKey = DimensionType.parseLegacy(new Dynamic<>(NbtOps.INSTANCE, tag.get("dimension")))
--            .resultOrPartial(LOGGER::error)
--            .orElseThrow(() -> new IllegalArgumentException("Invalid map dimension: " + tag.get("dimension")));
-+        // Paper start - fix "Not a string" spam
-+        Tag dimension = tag.get("dimension");
-+        if (dimension instanceof final net.minecraft.nbt.NumericTag numericTag && numericTag.getAsInt() >= org.bukkit.craftbukkit.CraftWorld.CUSTOM_DIMENSION_OFFSET) {
-+            long least = tag.getLong("UUIDLeast");
-+            long most = tag.getLong("UUIDMost");
-+
-+            if (least != 0L && most != 0L) {
-+                java.util.UUID uuid = new java.util.UUID(most, least);
-+                org.bukkit.craftbukkit.CraftWorld world = (org.bukkit.craftbukkit.CraftWorld) org.bukkit.Bukkit.getWorld(uuid);
-+                if (world != null) {
-+                    dimension = net.minecraft.nbt.StringTag.valueOf("minecraft:" + world.getName().toLowerCase(java.util.Locale.ENGLISH));
-+                } else {
-+                    dimension = net.minecraft.nbt.StringTag.valueOf("bukkit:_invalidworld_");
-+                }
-+            } else {
-+                dimension = net.minecraft.nbt.StringTag.valueOf("bukkit:_invalidworld_");
-+            }
-+        }
-+        com.mojang.serialization.DataResult<ResourceKey<Level>> dataresult = DimensionType.parseLegacy(new Dynamic(NbtOps.INSTANCE, dimension)); // CraftBukkit - decompile error
-+        // Paper end - fix "Not a string" spam
-+        // CraftBukkit start
-+        ResourceKey<Level> resourceKey = dataresult.resultOrPartial(LOGGER::error).orElseGet(() -> {
-+            long least = tag.getLong("UUIDLeast");
-+            long most = tag.getLong("UUIDMost");
-+
-+            if (least != 0L && most != 0L) {
-+                java.util.UUID uniqueId = new java.util.UUID(most, least);
-+
-+                org.bukkit.craftbukkit.CraftWorld world = (org.bukkit.craftbukkit.CraftWorld) org.bukkit.Bukkit.getWorld(uniqueId);
-+                // Check if the stored world details are correct.
-+                if (world == null) {
-+                    /* All Maps which do not have their valid world loaded are set to a dimension which hopefully won't be reached.
-+                       This is to prevent them being corrupted with the wrong map data. */
-+                    // PAIL: Use Vanilla exception handling for now
-+                } else {
-+                    return world.getHandle().dimension();
-+                }
-+            }
-+            throw new IllegalArgumentException("Invalid map dimension: " + String.valueOf(tag.get("dimension")));
-+            // CraftBukkit end
-+        });
-         int _int = tag.getInt("xCenter");
-         int _int1 = tag.getInt("zCenter");
-         byte b = (byte)Mth.clamp(tag.getByte("scale"), 0, 4);
-@@ -114,6 +165,7 @@ public class MapItemSavedData extends SavedData {
-         if (byteArray.length == 16384) {
-             mapItemSavedData.colors = byteArray;
+     private MapItemSavedData(
+         ResourceKey<Level> dimension,
+@@ -127,6 +_,8 @@
+                 MapDecorationTypes.FRAME, null, getFrameKey(mapFrame.entityId()), mapFrame.pos().getX(), mapFrame.pos().getZ(), mapFrame.rotation(), null
+             );
          }
-+        mapItemSavedData.vanillaRender.buffer = byteArray; // Paper - Use Vanilla map renderer when possible
- 
-         RegistryOps<Tag> registryOps = levelRegistry.createSerializationContext(NbtOps.INSTANCE);
++
++        this.vanillaRender.buffer = colors.array(); // Paper - Use Vanilla map renderer when possible
+     }
 
-@@ -154,6 +206,25 @@ public class MapItemSavedData extends SavedData {
-             .encodeStart(NbtOps.INSTANCE, this.dimension.location())
-             .resultOrPartial(LOGGER::error)
-             .ifPresent(dimension -> tag.put("dimension", dimension));
-+        // CraftBukkit start
-+        if (true) {
-+            if (this.uniqueId == null) {
-+                for (org.bukkit.World world : this.server.getWorlds()) {
-+                    org.bukkit.craftbukkit.CraftWorld cWorld = (org.bukkit.craftbukkit.CraftWorld) world;
-+                    if (cWorld.getHandle().dimension() == this.dimension) {
-+                        this.uniqueId = cWorld.getUID();
-+                        break;
-+                    }
-+                }
-+            }
-+            /* Perform a second check to see if a matching world was found, this is a necessary
-+               change incase Maps are forcefully unlinked from a World and lack a UID.*/
-+            if (this.uniqueId != null) {
-+                tag.putLong("UUIDLeast", this.uniqueId.getLeastSignificantBits());
-+                tag.putLong("UUIDMost", this.uniqueId.getMostSignificantBits());
-+            }
-+        }
-+        // CraftBukkit end
-         tag.putInt("xCenter", this.centerX);
-         tag.putInt("zCenter", this.centerZ);
-         tag.putByte("scale", this.scale);
-@@ -233,10 +304,12 @@ public class MapItemSavedData extends SavedData {
+     public static MapItemSavedData createFresh(
+@@ -204,6 +_,7 @@
              }
 
              MapFrame mapFrame1 = new MapFrame(pos, frame.getDirection().get2DDataValue() * 90, frame.getId());
 +            if (this.decorations.size() < player.level().paperConfig().maps.itemFrameCursorLimit) { // Paper - Limit item frame cursors on maps
              this.addDecoration(
                  MapDecorationTypes.FRAME, player.level(), getFrameKey(frame.getId()), pos.getX(), pos.getZ(), frame.getDirection().get2DDataValue() * 90, null
              );
-             this.frameMarkers.put(mapFrame1.getId(), mapFrame1);
+@@ -211,6 +_,7 @@
+             if (!mapFrame1.equals(mapFrame2)) {
+                 this.setDirty();
+             }
 +            } // Paper - Limit item frame cursors on maps
          }
 
          MapDecorations mapDecorations = mapStack.getOrDefault(DataComponents.MAP_DECORATIONS, MapDecorations.EMPTY);
-@@ -267,7 +340,7 @@ public class MapItemSavedData extends SavedData {
+@@ -241,7 +_,7 @@
              this.trackedDecorationCount--;
          }
 
@@ -149,16 +96,16 @@ index 3bfdc4df0db8944db6c671f53499cf07f3a3e7be..3c1c89aade5ff092b880ba1bf1de83f5
      }
 
      public static void addTargetDecoration(ItemStack stack, BlockPos pos, String type, Holder<MapDecorationType> mapDecorationType) {
-@@ -421,7 +494,7 @@ public class MapItemSavedData extends SavedData {
+@@ -395,7 +_,7 @@
                  return true;
              }
 
 -            if (!this.isTrackedCountOverLimit(256)) {
 +            if (!this.isTrackedCountOverLimit(((Level) accessor).paperConfig().maps.itemFrameCursorLimit)) { // Paper - Limit item frame cursors on maps
                  this.bannerMarkers.put(mapBanner.getId(), mapBanner);
                  this.addDecoration(mapBanner.getDecoration(), accessor, mapBanner.getId(), d, d1, 180.0, mapBanner.name().orElse(null));
-                 return true;
-@@ -521,7 +594,7 @@ public class MapItemSavedData extends SavedData {
+                 this.setDirty();
+@@ -497,7 +_,7 @@
              this.player = player;
          }
 
@@ -167,7 +114,7 @@ index 3bfdc4df0db8944db6c671f53499cf07f3a3e7be..3c1c89aade5ff092b880ba1bf1de83f5
              int i = this.minDirtyX;
              int i1 = this.minDirtyY;
              int i2 = this.maxDirtyX + 1 - this.minDirtyX;
-@@ -530,7 +603,7 @@ public class MapItemSavedData extends SavedData {
+@@ -506,7 +_,7 @@
 
              for (int i4 = 0; i4 < i2; i4++) {
                  for (int i5 = 0; i5 < i3; i5++) {
@@ -176,7 +123,7 @@ index 3bfdc4df0db8944db6c671f53499cf07f3a3e7be..3c1c89aade5ff092b880ba1bf1de83f5
                  }
              }
 
-@@ -540,17 +613,38 @@ public class MapItemSavedData extends SavedData {
+@@ -516,17 +_,38 @@
          @Nullable
          Packet<?> nextUpdatePacket(MapId mapId) {
              MapItemSavedData.MapPatch mapPatch;
@@ -218,7 +165,7 @@ index 3bfdc4df0db8944db6c671f53499cf07f3a3e7be..3c1c89aade5ff092b880ba1bf1de83f5
              } else {
                  collection = null;
              }
-@@ -578,6 +672,23 @@ public class MapItemSavedData extends SavedData {
+@@ -554,6 +_,23 @@
          private void markDecorationsDirty() {
              this.dirtyDecorations = true;
          }
@@ -242,3 +189,75 @@ index 3bfdc4df0db8944db6c671f53499cf07f3a3e7be..3c1c89aade5ff092b880ba1bf1de83f5
      }
 
      record MapDecorationLocation(Holder<MapDecorationType> type, byte x, byte y, byte rot) {
+@@ -598,4 +_,71 @@
+             }
+         }
+     }
++
++    // Paper start - store target world by uuid in addition to dimension
++    record UUIDAndError(java.util.UUID uuid, String faultyDimension) {
++
++    }
++    record UUIDBackedDimension(@Nullable ResourceKey<Level> resourceKey, @Nullable UUIDAndError uuid) {
++        public UUIDBackedDimension(final @org.jetbrains.annotations.NotNull ResourceKey<Level> resourceKey) {
++            this(resourceKey, null);
++        }
++        public UUIDBackedDimension {
++            com.google.common.base.Preconditions.checkArgument(resourceKey != null || uuid != null, "Created uuid backed dimension with null level and uuid. This is a bug");
++        }
++
++        public @org.jetbrains.annotations.NotNull ResourceKey<Level> resolveOrThrow() {
++            if (resourceKey != null) return resourceKey;
++
++            final org.bukkit.World worldByUUID = org.bukkit.Bukkit.getWorld(uuid.uuid());
++            if (worldByUUID != null) return ((org.bukkit.craftbukkit.CraftWorld) worldByUUID).getHandle().dimension();
++
++            throw new IllegalArgumentException("Invalid dimension " + uuid.faultyDimension() + " and unknown world uuid " + uuid.uuid);
++        }
++    }
++
++    private UUIDBackedDimension packUUIDBackedDimension() {
++        final net.minecraft.server.level.ServerLevel mappedLevel = net.minecraft.server.MinecraftServer.getServer().getLevel(this.dimension);
++        return new UUIDBackedDimension(this.dimension, mappedLevel == null ? null : new UUIDAndError(mappedLevel.uuid, ""));
++    }
++
++    private static com.mojang.serialization.MapCodec<UUIDBackedDimension> createUUIDBackedDimensionKeyCodec() {
++        return new com.mojang.serialization.MapCodec<>() {
++            @Override
++            public <T> java.util.stream.Stream<T> keys(final com.mojang.serialization.DynamicOps<T> ops) {
++                return java.util.stream.Stream.of("dimension", "UUIDLeast", "UUIDMost").map(ops::createString);
++            }
++
++            @Override
++            public <T> com.mojang.serialization.DataResult<UUIDBackedDimension> decode(final com.mojang.serialization.DynamicOps<T> ops,
++                                                                                       final com.mojang.serialization.MapLike<T> input) {
++                final com.mojang.serialization.DataResult<UUIDBackedDimension> foundDimension = Level.RESOURCE_KEY_CODEC.decode(ops, input.get("dimension"))
++                    .map(Pair::getFirst)
++                    .map(UUIDBackedDimension::new); // Do not pack uuid when reading as the level itself might reference an unloaded world. UUID lookup would be faulty + should be re-generated when written.
++                if (foundDimension.isSuccess()) return foundDimension;
++
++                // Fallback attempt at parsing the uuid
++                final com.mojang.serialization.DataResult<UUIDBackedDimension> fromUUID = Codec.LONG.decode(ops, input.get("UUIDMost")).map(Pair::getFirst).apply2(
++                    java.util.UUID::new,
++                    Codec.LONG.decode(ops, input.get("UUIDLeast")).map(Pair::getFirst)
++                ).map(uuid -> new UUIDBackedDimension(null, new UUIDAndError(uuid, String.valueOf(input.get("dimension")))));
++                if (fromUUID.isSuccess()) return fromUUID;
++
++                return foundDimension; // Return the found dimension instead, it's error is more "accurate" over the bukkit added uuids.
++            }
++
++            @Override
++            public <T> com.mojang.serialization.RecordBuilder<T> encode(final UUIDBackedDimension input,
++                                                                        final com.mojang.serialization.DynamicOps<T> ops,
++                                                                        final com.mojang.serialization.RecordBuilder<T> prefix) {
++                prefix.add("dimension", input.resourceKey(), Level.RESOURCE_KEY_CODEC);
++                if (input.uuid != null) {
++                    prefix.add("UUIDMost", input.uuid.uuid().getMostSignificantBits(), Codec.LONG);
++                    prefix.add("UUIDLeast", input.uuid.uuid().getLeastSignificantBits(), Codec.LONG);
++                }
++                return prefix;
++            }
++        };
++    }
++    // Paper end - store target world by uuid in addition to dimension
+ }