From 0f03523de57dc9c12e1a9f1e7ff69d80b95a8593 Mon Sep 17 00:00:00 2001
From: modmuss50 <modmuss50@gmail.com>
Date: Sat, 21 Nov 2020 18:32:20 +0000
Subject: [PATCH] Fix MC-202036 - Shifting biome IDs (#1168)
* First pass on PersistentDynamicRegistryHandler, not tested
* Extra debugging + fix it not working
* Fix build
* Minor tweaks
* checkstyle ;)
* Improve comments + fix issues with tag reading/writing
* Simplify mixin
---
.../PersistentDynamicRegistryHandler.java | 216 ++++++++++++++++++
.../sync/AccessorLevelStorageSession.java | 30 +++
.../fabric/mixin/registry/sync/MixinMain.java | 55 +++++
.../sync/client/MixinMinecraftClient.java | 25 ++
.../fabric-registry-sync-v0.mixins.json | 2 +
5 files changed, 328 insertions(+)
create mode 100644 fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/impl/registry/sync/PersistentDynamicRegistryHandler.java
create mode 100644 fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/mixin/registry/sync/AccessorLevelStorageSession.java
create mode 100644 fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/mixin/registry/sync/MixinMain.java
diff --git a/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/impl/registry/sync/PersistentDynamicRegistryHandler.java b/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/impl/registry/sync/PersistentDynamicRegistryHandler.java
new file mode 100644
index 000000000..899169b7b
--- /dev/null
+++ b/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/impl/registry/sync/PersistentDynamicRegistryHandler.java
@@ -0,0 +1,216 @@
+/*
+ * Copyright (c) 2016, 2017, 2018, 2019 FabricMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.fabricmc.fabric.impl.registry.sync;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.OutputStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.StandardOpenOption;
+
+import it.unimi.dsi.fastutil.objects.Object2IntMap;
+import it.unimi.dsi.fastutil.objects.Object2IntOpenHashMap;
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+import net.minecraft.nbt.CompoundTag;
+import net.minecraft.nbt.NbtIo;
+import net.minecraft.util.Identifier;
+import net.minecraft.util.registry.DynamicRegistryManager;
+import net.minecraft.util.registry.MutableRegistry;
+import net.minecraft.util.registry.Registry;
+
+/**
+ * This solves a bug in vanilla where datapack added biome IDs are not saved to disk. Thus adding or changing a biome
+ * from a datapack/mod causes the ids to shift. This remaps the IDs in the {@link DynamicRegistryManager} in a similar
+ * manner to the normal registry sync.
+ *
+ * <p>See: https://bugs.mojang.com/browse/MC-202036
+ *
+ * <p>This may cause issues when vanilla adds biomes in the future, this should be fixable by also remapping the static ID
+ * map vanilla keeps.
+ */
+public class PersistentDynamicRegistryHandler {
+ private static final Logger LOGGER = LogManager.getLogger();
+
+ public static void remapDynamicRegistries(DynamicRegistryManager.Impl dynamicRegistryManager, Path saveDir) {
+ LOGGER.debug("Starting registry remap");
+
+ CompoundTag registryData;
+
+ try {
+ registryData = remapDynamicRegistries(dynamicRegistryManager, readCompoundTag(getDataPath(saveDir)));
+ } catch (RemapException | IOException e) {
+ throw new RuntimeException("Failed to read dynamic registry data", e);
+ }
+
+ writeCompoundTag(registryData, getDataPath(saveDir));
+ }
+
+ @NotNull
+ private static CompoundTag remapDynamicRegistries(DynamicRegistryManager.Impl dynamicRegistryManager, @Nullable CompoundTag existingTag) throws RemapException {
+ CompoundTag registries = new CompoundTag();
+
+ // For now we only care about biomes, but lets keep our options open
+ CompoundTag biomeRegistryData = null;
+
+ if (existingTag != null) {
+ biomeRegistryData = existingTag.getCompound(Registry.BIOME_KEY.getValue().toString());
+ }
+
+ MutableRegistry<?> registry = dynamicRegistryManager.get(Registry.BIOME_KEY);
+ CompoundTag biomeIdMap = remapRegistry(Registry.BIOME_KEY.getValue(), registry, biomeRegistryData);
+ registries.put(Registry.BIOME_KEY.getValue().toString(), biomeIdMap);
+
+ return registries;
+ }
+
+ /**
+ * Remaps a registry if existing data is passed in.
+ * Then writes out the ids in the registry (remapped or a new world).
+ * Keeps hold of the orphaned registry entries as to not overwrite them.
+ */
+ private static <T> CompoundTag remapRegistry(Identifier registryId, MutableRegistry<T> registry, @Nullable CompoundTag existingTag) throws RemapException {
+ if (!(registry instanceof RemappableRegistry)) {
+ throw new UnsupportedOperationException("Cannot remap un re-mappable registry: " + registryId.toString());
+ }
+
+ // This includes biomes added via datapacks via the vanilla method, along with mod provided biomes.
+ boolean isModified = registry.getIds().stream().anyMatch(id -> !id.getNamespace().equals("minecraft"));
+
+ // The current registry might not be modified, but we might have previous changed vanilla ids that we should try and remap
+ if (existingTag != null && !isModified) {
+ isModified = existingTag.getKeys().stream()
+ .map(existingTag::getString)
+ .map(Identifier::new)
+ .anyMatch(id -> !id.getNamespace().equals("minecraft"));
+ }
+
+ if (LOGGER.isDebugEnabled()) {
+ if (existingTag == null) {
+ LOGGER.debug("No existing data found, assuming new registry with {} entries. modded = {}", registry.getIds().size(), isModified);
+ } else {
+ LOGGER.debug("Existing registry data found. modded = {}", isModified);
+
+ for (T entry : registry) {
+ //noinspection unchecked
+ Identifier id = registry.getId(entry);
+ int rawId = registry.getRawId(entry);
+
+ if (id == null || rawId < 0) continue;
+
+ if (existingTag.getKeys().contains(id.toString())) {
+ int existingRawId = existingTag.getInt(id.toString());
+
+ if (rawId != existingRawId) {
+ LOGGER.debug("Remapping {} {} -> {}", id.toString(), rawId, existingRawId);
+ } else {
+ LOGGER.debug("Using existing id for {} {}", id.toString(), rawId);
+ }
+ } else {
+ LOGGER.debug("Found new registry entry {}", id.toString());
+ }
+ }
+ }
+ }
+
+ // If we have some existing ids and the registry contains modded/datapack entries we remap the registry with those
+ if (existingTag != null && isModified) {
+ LOGGER.debug("Remapping {} with {} entries", registryId, registry.getIds().size());
+ Object2IntMap<Identifier> idMap = new Object2IntOpenHashMap<>();
+
+ for (String key : existingTag.getKeys()) {
+ idMap.put(new Identifier(key), existingTag.getInt(key));
+ }
+
+ ((RemappableRegistry) registry).remap(registryId.toString(), idMap, RemappableRegistry.RemapMode.AUTHORITATIVE);
+ } else {
+ LOGGER.debug("Skipping remap of {}", registryId);
+ }
+
+ // Now start to build up what we are going to save out
+ CompoundTag registryTag = new CompoundTag();
+
+ // Save all ids as they appear in the remapped, or new registry to disk even if not modded.
+ for (T entry : registry) {
+ //noinspection unchecked
+ Identifier id = registry.getId(entry);
+
+ if (id == null) {
+ continue;
+ }
+
+ int rawId = registry.getRawId(entry);
+ registryTag.putInt(id.toString(), rawId);
+ }
+
+ /*
+ * Look for existing registry key/values that are not in the current registries.
+ * This can happen when registry entries are removed, preventing that ID from being re-used by something else.
+ */
+ if (existingTag != null) {
+ for (String key : existingTag.getKeys()) {
+ if (!registryTag.contains(key)) {
+ LOGGER.debug("Saving orphaned registry entry: " + key);
+ registryTag.putInt(key, registryTag.getInt(key));
+ }
+ }
+ }
+
+ return registryTag;
+ }
+
+ private static Path getDataPath(Path saveDir) {
+ return saveDir.resolve("data").resolve("fabricDynamicRegistry.dat");
+ }
+
+ @Nullable
+ private static CompoundTag readCompoundTag(Path path) throws IOException {
+ if (!Files.exists(path)) {
+ return null;
+ }
+
+ try (InputStream inputStream = Files.newInputStream(path)) {
+ CompoundTag compoundTag = NbtIo.readCompressed(inputStream);
+
+ if (!compoundTag.contains("version") || !compoundTag.contains("registries") || compoundTag.getInt("version") != 1) {
+ throw new UnsupportedOperationException("Unsupported dynamic registry data format. Try updating?");
+ }
+
+ return compoundTag.getCompound("registries");
+ }
+ }
+
+ private static void writeCompoundTag(CompoundTag compoundTag, Path path) {
+ try {
+ Files.createDirectories(path.getParent());
+
+ try (OutputStream outputStream = Files.newOutputStream(path, StandardOpenOption.CREATE)) {
+ CompoundTag outputTag = new CompoundTag();
+ outputTag.putInt("version", 1);
+ outputTag.put("registries", compoundTag);
+
+ NbtIo.writeCompressed(outputTag, outputStream);
+ }
+ } catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+ }
+}
diff --git a/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/mixin/registry/sync/AccessorLevelStorageSession.java b/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/mixin/registry/sync/AccessorLevelStorageSession.java
new file mode 100644
index 000000000..2f4e9a94d
--- /dev/null
+++ b/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/mixin/registry/sync/AccessorLevelStorageSession.java
@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2016, 2017, 2018, 2019 FabricMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.fabricmc.fabric.mixin.registry.sync;
+
+import java.nio.file.Path;
+
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.gen.Accessor;
+
+import net.minecraft.world.level.storage.LevelStorage;
+
+@Mixin(LevelStorage.Session.class)
+public interface AccessorLevelStorageSession {
+ @Accessor("directory")
+ Path getDirectory();
+}
diff --git a/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/mixin/registry/sync/MixinMain.java b/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/mixin/registry/sync/MixinMain.java
new file mode 100644
index 000000000..c48953793
--- /dev/null
+++ b/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/mixin/registry/sync/MixinMain.java
@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) 2016, 2017, 2018, 2019 FabricMC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package net.fabricmc.fabric.mixin.registry.sync;
+
+import java.io.IOException;
+import java.nio.file.Path;
+
+import com.mojang.serialization.DynamicOps;
+import org.spongepowered.asm.mixin.Mixin;
+import org.spongepowered.asm.mixin.Unique;
+import org.spongepowered.asm.mixin.injection.At;
+import org.spongepowered.asm.mixin.injection.Redirect;
+
+import net.minecraft.server.Main;
+import net.minecraft.util.dynamic.RegistryOps;
+import net.minecraft.util.registry.DynamicRegistryManager;
+import net.minecraft.world.level.storage.LevelStorage;
+import net.minecraft.nbt.Tag;
+import net.minecraft.resource.ResourceManager;
+
+import net.fabricmc.fabric.impl.registry.sync.PersistentDynamicRegistryHandler;
+
+@Mixin(Main.class)
+public class MixinMain {
+ @Unique
+ private static Path fabric_saveDir;
+
+ @Redirect(method = "main", at = @At(value = "INVOKE", target = "Lnet/minecraft/world/level/storage/LevelStorage;createSession(Ljava/lang/String;)Lnet/minecraft/world/level/storage/LevelStorage$Session;"))
+ private static LevelStorage.Session levelStorageCreateSession(LevelStorage levelStorage, String levelName) throws IOException {
+ LevelStorage.Session session = levelStorage.createSession(levelName);
+ fabric_saveDir = ((AccessorLevelStorageSession) session).getDirectory();
+ return session;
+ }
+
+ @Redirect(method = "main", at = @At(value = "INVOKE", target = "Lnet/minecraft/util/dynamic/RegistryOps;of(Lcom/mojang/serialization/DynamicOps;Lnet/minecraft/resource/ResourceManager;Lnet/minecraft/util/registry/DynamicRegistryManager$Impl;)Lnet/minecraft/util/dynamic/RegistryOps;"))
+ private static RegistryOps<Tag> ofRegistryOps(DynamicOps<Tag> delegate, ResourceManager resourceManager, DynamicRegistryManager.Impl impl) {
+ RegistryOps<Tag> registryOps = RegistryOps.of(delegate, resourceManager, impl);
+ PersistentDynamicRegistryHandler.remapDynamicRegistries(impl, fabric_saveDir);
+ return registryOps;
+ }
+}
diff --git a/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/mixin/registry/sync/client/MixinMinecraftClient.java b/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/mixin/registry/sync/client/MixinMinecraftClient.java
index f6cf7c241..3a6916b79 100644
--- a/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/mixin/registry/sync/client/MixinMinecraftClient.java
+++ b/fabric-registry-sync-v0/src/main/java/net/fabricmc/fabric/mixin/registry/sync/client/MixinMinecraftClient.java
@@ -16,6 +16,8 @@
package net.fabricmc.fabric.mixin.registry.sync.client;
+import java.nio.file.Path;
+
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.spongepowered.asm.mixin.Mixin;
@@ -23,10 +25,20 @@ import org.spongepowered.asm.mixin.Unique;
import org.spongepowered.asm.mixin.injection.At;
import org.spongepowered.asm.mixin.injection.Inject;
import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
+import org.spongepowered.asm.mixin.injection.callback.CallbackInfoReturnable;
+import net.minecraft.resource.DataPackSettings;
+import net.minecraft.resource.ResourceManager;
+import net.minecraft.util.registry.DynamicRegistryManager;
+import net.minecraft.world.SaveProperties;
+import net.minecraft.world.gen.GeneratorOptions;
+import net.minecraft.world.level.LevelInfo;
+import net.minecraft.world.level.storage.LevelStorage;
import net.minecraft.client.MinecraftClient;
import net.minecraft.client.gui.screen.Screen;
+import net.fabricmc.fabric.impl.registry.sync.PersistentDynamicRegistryHandler;
+import net.fabricmc.fabric.mixin.registry.sync.AccessorLevelStorageSession;
import net.fabricmc.fabric.impl.registry.sync.RegistrySyncManager;
import net.fabricmc.fabric.impl.registry.sync.RemapException;
@@ -44,4 +56,17 @@ public class MixinMinecraftClient {
FABRIC_LOGGER.warn("Failed to unmap Fabric registries!", e);
}
}
+
+ @Inject(method = "createSaveProperties", at = @At(value = "INVOKE_ASSIGN", target = "Lnet/minecraft/util/dynamic/RegistryOps;of(Lcom/mojang/serialization/DynamicOps;Lnet/minecraft/resource/ResourceManager;Lnet/minecraft/util/registry/DynamicRegistryManager$Impl;)Lnet/minecraft/util/dynamic/RegistryOps;"))
+ private static void createSaveProperties(LevelStorage.Session session, DynamicRegistryManager.Impl impl, ResourceManager resourceManager, DataPackSettings dataPackSettings, CallbackInfoReturnable<SaveProperties> cir) {
+ Path saveDir = ((AccessorLevelStorageSession) session).getDirectory();
+ PersistentDynamicRegistryHandler.remapDynamicRegistries(impl, saveDir);
+ }
+
+ // synthetic in method_29607 just after RegistryOps.of
+ @Inject(method = "method_31125", at = @At(value = "INVOKE_ASSIGN", target = "Lnet/minecraft/util/dynamic/RegistryOps;of(Lcom/mojang/serialization/DynamicOps;Lnet/minecraft/resource/ResourceManager;Lnet/minecraft/util/registry/DynamicRegistryManager$Impl;)Lnet/minecraft/util/dynamic/RegistryOps;"))
+ private static void method_31125(DynamicRegistryManager.Impl impl, GeneratorOptions generatorOptions, LevelInfo levelInfo, LevelStorage.Session session, DynamicRegistryManager.Impl impl2, ResourceManager resourceManager, DataPackSettings dataPackSettings, CallbackInfoReturnable<SaveProperties> cir) {
+ Path saveDir = ((AccessorLevelStorageSession) session).getDirectory();
+ PersistentDynamicRegistryHandler.remapDynamicRegistries(impl, saveDir);
+ }
}
diff --git a/fabric-registry-sync-v0/src/main/resources/fabric-registry-sync-v0.mixins.json b/fabric-registry-sync-v0/src/main/resources/fabric-registry-sync-v0.mixins.json
index ce24616b0..96eab9ab2 100644
--- a/fabric-registry-sync-v0/src/main/resources/fabric-registry-sync-v0.mixins.json
+++ b/fabric-registry-sync-v0/src/main/resources/fabric-registry-sync-v0.mixins.json
@@ -3,11 +3,13 @@
"package": "net.fabricmc.fabric.mixin.registry.sync",
"compatibilityLevel": "JAVA_8",
"mixins": [
+ "AccessorLevelStorageSession",
"AccessorRegistry",
"MixinBootstrap",
"MixinDynamicRegistryManager",
"MixinIdList",
"MixinIdRegistry",
+ "MixinMain",
"MixinPlayerManager",
"MixinLevelStorageSession",
"MixinRegistry",