diff --git a/patches/minecraft/net/minecraft/world/level/storage/LevelStorageSource.java.patch b/patches/minecraft/net/minecraft/world/level/storage/LevelStorageSource.java.patch index 8fa8eaefb3..b5d88618c5 100644 --- a/patches/minecraft/net/minecraft/world/level/storage/LevelStorageSource.java.patch +++ b/patches/minecraft/net/minecraft/world/level/storage/LevelStorageSource.java.patch @@ -23,7 +23,7 @@ + LevelStorageSource.this.m_230817_(this.f_230867_, (path, dataFixer) -> { + try { + CompoundTag compoundTag = NbtIo.m_128937_(path.toFile()); -+ net.minecraftforge.common.ForgeHooks.readAdditionalLevelSaveData(compoundTag); ++ net.minecraftforge.common.ForgeHooks.readAdditionalLevelSaveData(compoundTag, this.f_230867_); + } catch (Exception e) { + f_78191_.error("Exception reading {}", path, e); + } diff --git a/src/main/java/net/minecraftforge/common/ForgeHooks.java b/src/main/java/net/minecraftforge/common/ForgeHooks.java index a868c91f31..72b1e13f8c 100644 --- a/src/main/java/net/minecraftforge/common/ForgeHooks.java +++ b/src/main/java/net/minecraftforge/common/ForgeHooks.java @@ -25,7 +25,6 @@ import com.google.gson.Gson; import com.google.gson.JsonElement; import com.google.gson.JsonObject; import com.google.gson.JsonParseException; -import com.mojang.datafixers.util.Either; import com.mojang.serialization.Codec; import com.mojang.serialization.Lifecycle; @@ -56,6 +55,7 @@ import net.minecraft.world.item.crafting.RecipeType; import net.minecraft.world.level.block.Block; import net.minecraft.world.level.gameevent.GameEvent; import net.minecraft.world.level.material.Fluids; +import net.minecraft.world.level.storage.LevelStorageSource; import net.minecraft.world.level.storage.WorldData; import net.minecraft.world.level.storage.loot.LootContext; import net.minecraft.world.level.storage.loot.LootTable; @@ -108,6 +108,7 @@ import net.minecraftforge.event.AnvilUpdateEvent; import net.minecraftforge.event.DifficultyChangeEvent; import net.minecraftforge.event.ForgeEventFactory; import net.minecraftforge.event.ItemAttributeModifierEvent; +import net.minecraftforge.event.ModMismatchEvent; import net.minecraftforge.event.ServerChatEvent; import net.minecraftforge.event.RegisterStructureConversionsEvent; import net.minecraftforge.event.VanillaGameEvent; @@ -143,7 +144,6 @@ import net.minecraftforge.event.level.BlockEvent; import net.minecraftforge.event.level.NoteBlockEvent; import net.minecraftforge.eventbus.api.Event.Result; import net.minecraftforge.fluids.FluidType; -import net.minecraftforge.fml.ModContainer; import net.minecraftforge.fml.ModList; import net.minecraftforge.fml.ModLoader; import net.minecraftforge.resource.ResourcePackLoader; @@ -151,7 +151,6 @@ import net.minecraftforge.registries.ForgeRegistries; import net.minecraftforge.registries.ForgeRegistry; import net.minecraftforge.registries.GameData; import net.minecraftforge.registries.RegistryManager; -import net.minecraftforge.registries.holdersets.ICustomHolderSet; import net.minecraftforge.server.permission.PermissionAPI; import org.apache.logging.log4j.LogManager; @@ -160,7 +159,6 @@ import org.apache.logging.log4j.Marker; import org.apache.logging.log4j.MarkerManager; import net.minecraft.ChatFormatting; -import net.minecraft.resources.HolderSetCodec; import net.minecraft.resources.ResourceKey; import net.minecraft.resources.ResourceLocation; import net.minecraft.world.damagesource.DamageSource; @@ -170,6 +168,9 @@ import net.minecraft.world.level.LevelAccessor; import net.minecraft.world.level.block.state.pattern.BlockInWorld; import net.minecraft.world.level.dimension.LevelStem; import net.minecraft.world.level.material.Fluid; +import org.apache.maven.artifact.versioning.ArtifactVersion; +import org.apache.maven.artifact.versioning.DefaultArtifactVersion; +import org.jetbrains.annotations.ApiStatus; import org.jetbrains.annotations.NotNull; import org.jetbrains.annotations.Nullable; @@ -1342,12 +1343,28 @@ public class ForgeHooks levelTag.put("fml", fmlData); } - public static void readAdditionalLevelSaveData(CompoundTag rootTag) + /** + * @deprecated To be removed in 1.20. + * Use {@link #readAdditionalLevelSaveData(CompoundTag, LevelStorageSource.LevelDirectory)} instead. + */ + @Deprecated(forRemoval = true, since = "1.19.2") + public static void readAdditionalLevelSaveData(CompoundTag rootTag) { + readAdditionalLevelSaveData(rootTag, null); + } + + /** + * @param rootTag Level data file contents. + * @param levelDirectory Level currently being loaded. TODO 1.20 - Remove nullable annotation + */ + @ApiStatus.Internal + public static void readAdditionalLevelSaveData(CompoundTag rootTag, @Nullable LevelStorageSource.LevelDirectory levelDirectory) { CompoundTag tag = rootTag.getCompound("fml"); if (tag.contains("LoadingModList")) { ListTag modList = tag.getList("LoadingModList", net.minecraft.nbt.Tag.TAG_COMPOUND); + Map mismatchedVersions = new HashMap<>(modList.size()); + Map missingVersions = new HashMap<>(modList.size()); for (int i = 0; i < modList.size(); i++) { CompoundTag mod = modList.getCompound(i); @@ -1356,17 +1373,72 @@ public class ForgeHooks { continue; } + String modVersion = mod.getString("ModVersion"); - Optional container = ModList.get().getModContainerById(modId); - if (container.isEmpty()) + final var previousVersion = new DefaultArtifactVersion(modVersion); + ModList.get().getModContainerById(modId).ifPresentOrElse(container -> { - LOGGER.error(WORLDPERSISTENCE,"This world was saved with mod {} which appears to be missing, things may not work well", modId); - continue; - } - if (!Objects.equals(modVersion, MavenVersionStringHelper.artifactVersionToString(container.get().getModInfo().getVersion()))) + final var loadingVersion = container.getModInfo().getVersion(); + if (!loadingVersion.equals(previousVersion)) + { + // Enqueue mismatched versions for bulk event + mismatchedVersions.put(modId, previousVersion); + } + }, () -> missingVersions.put(modId, previousVersion)); + } + + final var mismatchEvent = new ModMismatchEvent(levelDirectory, mismatchedVersions, missingVersions); + ModLoader.get().postEvent(mismatchEvent); + + StringBuilder resolved = new StringBuilder("The following mods have version differences that were marked resolved:"); + StringBuilder unresolved = new StringBuilder("The following mods have version differences that were not resolved:"); + + // For mods that were marked resolved, log the version resolution and the mod that resolved the mismatch + mismatchEvent.getResolved().forEachOrdered((res) -> + { + final var modid = res.modid(); + final var diff = res.versionDifference(); + if (res.wasSelfResolved()) { - LOGGER.warn(WORLDPERSISTENCE,"This world was saved with mod {} version {} and it is now at version {}, things may not work well", modId, modVersion, MavenVersionStringHelper.artifactVersionToString(container.get().getModInfo().getVersion())); + resolved.append(System.lineSeparator()) + .append(diff.isMissing() + ? "%s (version %s -> MISSING, self-resolved)".formatted(modid, diff.oldVersion()) + : "%s (version %s -> %s, self-resolved)".formatted(modid, diff.oldVersion(), diff.newVersion()) + ); } + else + { + final var resolver = res.resolver().getModId(); + resolved.append(System.lineSeparator()) + .append(diff.isMissing() + ? "%s (version %s -> MISSING, resolved by %s)".formatted(modid, diff.oldVersion(), resolver) + : "%s (version %s -> %s, resolved by %s)".formatted(modid, diff.oldVersion(), diff.newVersion(), resolver) + ); + } + }); + + // For mods that did not specify handling, show a warning to users that errors may occur + mismatchEvent.getUnresolved().forEachOrdered((unres) -> + { + final var modid = unres.modid(); + final var diff = unres.versionDifference(); + unresolved.append(System.lineSeparator()) + .append(diff.isMissing() + ? "%s (version %s -> MISSING)".formatted(modid, diff.oldVersion()) + : "%s (version %s -> %s)".formatted(modid, diff.oldVersion(), diff.newVersion()) + ); + }); + + if (mismatchEvent.anyResolved()) + { + resolved.append(System.lineSeparator()).append("Things may not work well."); + LOGGER.debug(WORLDPERSISTENCE, resolved.toString()); + } + + if (mismatchEvent.anyUnresolved()) + { + unresolved.append(System.lineSeparator()).append("Things may not work well."); + LOGGER.warn(WORLDPERSISTENCE, unresolved.toString()); } } diff --git a/src/main/java/net/minecraftforge/event/ModMismatchEvent.java b/src/main/java/net/minecraftforge/event/ModMismatchEvent.java new file mode 100644 index 0000000000..16bc1eaa45 --- /dev/null +++ b/src/main/java/net/minecraftforge/event/ModMismatchEvent.java @@ -0,0 +1,182 @@ +/* + * Copyright (c) Forge Development LLC and contributors + * SPDX-License-Identifier: LGPL-2.1-only + */ + +package net.minecraftforge.event; + +import net.minecraft.world.level.storage.LevelStorageSource; +import net.minecraftforge.eventbus.api.Cancelable; +import net.minecraftforge.eventbus.api.Event; +import net.minecraftforge.fml.LogicalSide; +import net.minecraftforge.fml.ModContainer; +import net.minecraftforge.fml.ModList; +import net.minecraftforge.fml.ModLoadingContext; +import net.minecraftforge.fml.event.IModBusEvent; +import net.minecraftforge.fml.javafmlmod.FMLJavaModLoadingContext; +import net.minecraftforge.forgespi.language.IModInfo; +import org.apache.maven.artifact.versioning.ArtifactVersion; +import org.jetbrains.annotations.ApiStatus; +import org.jetbrains.annotations.Nullable; + +import java.util.Comparator; +import java.util.HashMap; +import java.util.Map; +import java.util.Optional; +import java.util.stream.Stream; + +/** + * Fires when the mod loader is in the process of loading a world that was last saved + * with mod versions that differ from the currently-loaded versions. This can be used to + * enqueue work to run at a later point, such as multi-file migration of data. + * + *

+ * Note that level and world information has not yet been fully loaded; as such, it is + * unsafe to access server or level information during handling of this event. + *

+ * + *

This event is not {@linkplain Cancelable cancellable}, and does not {@linkplain HasResult have a result}.

+ *

This event is fired on the {@linkplain FMLJavaModLoadingContext#getModEventBus() mod-specific event bus}, + * on both {@linkplain LogicalSide logical sides}.

+ */ +public class ModMismatchEvent extends Event implements IModBusEvent +{ + /** + * The level being loaded. Useful for things like {@link net.minecraft.world.level.storage.DimensionDataStorage} + * to manage multiple files changing between mod versions. + */ + @Nullable + private final LevelStorageSource.LevelDirectory levelDirectory; + + /** + * A set of previously-known versions that have mismatched with the currently loaded versions. + */ + private final HashMap versionDifferences; + + /** + * Which mods have specified that they have handled version mismatches. + */ + private final HashMap resolved; + + @ApiStatus.Internal + public ModMismatchEvent(@Nullable LevelStorageSource.LevelDirectory levelDirectory, Map previousVersions, Map missingVersions) + { + this.levelDirectory = levelDirectory; + this.resolved = new HashMap<>(previousVersions.size()); + this.versionDifferences = new HashMap<>(); + previousVersions.forEach((modId, version) -> versionDifferences.put(modId, new MismatchedVersionInfo(version, ModList.get() + .getModContainerById(modId) + .map(ModContainer::getModInfo) + .map(IModInfo::getVersion) + .orElse(null)))); + + missingVersions.forEach((modId, version) -> versionDifferences.put(modId, new MismatchedVersionInfo(version, null))); + } + + /** + * Gets the current level directory for the world being loaded. + * Can be used for file operations and manual modification of mod files before world load. + */ + @Nullable + public LevelStorageSource.LevelDirectory getLevelDirectory() + { + return this.levelDirectory; + } + + /** + * Fetch a previous version of a given mod, if it has been mismatched. + * @param modId The mod to fetch previous version for. + * @return The previously known mod version, or {@link Optional#empty()} if unknown/not found. + */ + @Nullable + public ArtifactVersion getPreviousVersion(String modId) + { + if (this.versionDifferences.containsKey(modId)) + return this.versionDifferences.get(modId).oldVersion(); + + return null; + } + + @Nullable + public ArtifactVersion getCurrentVersion(String modid) + { + if (this.versionDifferences.containsKey(modid)) + return this.versionDifferences.get(modid).newVersion(); + + return null; + } + + /** + * Marks the mod version mismatch as having been resolved safely by the current mod. + */ + public void markResolved(String modId) + { + final var resolvedBy = ModLoadingContext.get().getActiveContainer(); + resolved.putIfAbsent(modId, resolvedBy); + } + + /** + * Fetches the status of a mod mismatch handling state. + */ + public boolean wasResolved(String modId) + { + return this.resolved.containsKey(modId); + } + + public Optional getVersionDifference(String modid) + { + return Optional.ofNullable(this.versionDifferences.get(modid)); + } + + public Optional getResolver(String modid) + { + return Optional.ofNullable(this.resolved.get(modid)); + } + + public boolean anyUnresolved() + { + return resolved.size() < versionDifferences.size(); + } + + public Stream getUnresolved() + { + return versionDifferences.keySet().stream() + .filter(modid -> !resolved.containsKey(modid)) + .map(unresolved -> new MismatchResolutionResult(unresolved, versionDifferences.get(unresolved), null)) + .sorted(Comparator.comparing(MismatchResolutionResult::modid)); + } + + public boolean anyResolved() + { + return !resolved.isEmpty(); + } + + public Stream getResolved() + { + return resolved.keySet().stream() + .map(modid -> new MismatchResolutionResult(modid, versionDifferences.get(modid), resolved.get(modid))) + .sorted(Comparator.comparing(MismatchResolutionResult::modid)); + } + + public record MismatchResolutionResult(String modid, MismatchedVersionInfo versionDifference, @Nullable ModContainer resolver) + { + public boolean wasSelfResolved() + { + return resolver != null && resolver.getModId().equals(modid); + } + } + + public record MismatchedVersionInfo(ArtifactVersion oldVersion, @Nullable ArtifactVersion newVersion) + { + public boolean isMissing() + { + return newVersion == null; + } + + public boolean wasUpgrade() + { + if (newVersion == null) return false; + return newVersion.compareTo(oldVersion) > 0; + } + } +} \ No newline at end of file