From 937b719e24cdbd7d1e6acd575c9ac03c863fa46c Mon Sep 17 00:00:00 2001 From: LexManos Date: Wed, 13 Oct 2021 12:51:16 -0700 Subject: [PATCH] Skip loading jars with neither a manifest, nore a mods.toml. Deprecate helper functions related to ModFile/Metadata. Mark ModFileFactory as to be removed from our usage. It may be useful for other loaders, but introduces a weird level of indirection that makes things a pain. If there are consumers of this API please leave feedback before the next major mc version so we can be sure to provide something useful. --- .../moddiscovery/AbstractJarFileLocator.java | 4 +++- .../fml/loading/moddiscovery/ModFile.java | 22 ++++++++++++------- .../loading/moddiscovery/ModJarMetadata.java | 8 +++++++ 3 files changed, 25 insertions(+), 9 deletions(-) diff --git a/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/AbstractJarFileLocator.java b/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/AbstractJarFileLocator.java index ab00ba6eb9..af30082cc0 100644 --- a/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/AbstractJarFileLocator.java +++ b/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/AbstractJarFileLocator.java @@ -38,6 +38,7 @@ import java.util.Map; import java.util.Optional; import java.util.function.Consumer; import java.util.function.Function; +import java.util.jar.Manifest; import java.util.stream.Collectors; import java.util.stream.Stream; @@ -78,7 +79,8 @@ public abstract class AbstractJarFileLocator implements IModLocator { private Optional createMod(Path path) { var mjm = new ModJarMetadata(); - var sj = SecureJar.from(() -> ModFile.DEFAULTMANIFEST, + var sj = SecureJar.from( + Manifest::new, jar -> jar.findFile(MODS_TOML).isPresent() ? mjm : JarMetadata.from(jar, path), (root, p) -> true, path diff --git a/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModFile.java b/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModFile.java index 0c9b6af249..01749046fb 100644 --- a/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModFile.java +++ b/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModFile.java @@ -49,6 +49,8 @@ import java.util.jar.Manifest; import static net.minecraftforge.fml.loading.LogMarkers.LOADING; public class ModFile implements IModFile { + // Mods either must have a mods.toml or a manifest. We can no longer just put any jar on the classpath. + @Deprecated(forRemoval = true, since = "1.17.1") public static final Manifest DEFAULTMANIFEST; private static final Logger LOGGER = LogManager.getLogger(); @@ -72,6 +74,7 @@ public class ModFile implements IModFile { private List coreMods; private Path accessTransformer; + //TODO: Make package private in 1.18+ public static final Attributes.Name TYPE = new Attributes.Name("FMLModType"); private SecureJar.Status securityStatus; @@ -139,8 +142,7 @@ public class ModFile implements IModFile { locator.scanFile(this, pathConsumer); } - public void setFutureScanResult(CompletableFuture future) - { + public void setFutureScanResult(CompletableFuture future) { this.futureScanResult = future; } @@ -168,20 +170,17 @@ public class ModFile implements IModFile { StartupMessageManager.modLoaderConsumer().ifPresent(c->c.accept("Completed deep scan of "+this.getFileName())); } - public void setFileProperties(Map fileProperties) - { + public void setFileProperties(Map fileProperties) { this.fileProperties = fileProperties; } @Override - public List getLoaders() - { + public List getLoaders() { return loaders; } @Override - public Path findResource(String... path) - { + public Path findResource(String... path) { if (path.length < 1) { throw new IllegalArgumentException("Missing path"); } @@ -214,17 +213,24 @@ public class ModFile implements IModFile { return modFileInfo; } + // TODO: Remove concept of factory from forgeapi.. Why expose this? + @Deprecated(forRemoval = true, since="1.17.1") public static ModFileFactory buildFactory() { return ModFile::new; } + // TODO: Remove helper functions to cleanup api + @Deprecated(forRemoval = true, since="1.17.1") public static ModFile newFMLInstance(final IModLocator locator, final SecureJar jar) { return (ModFile) ModFileFactory.FACTORY.build(jar, locator, ModFileParser::modsTomlParser); } + // TODO: Remove helper functions to cleanup api + @Deprecated(forRemoval = true, since="1.17.1") public static ModFile newFMLInstance(final IModLocator locator, final Path... paths) { return (ModFile) ModJarMetadata.buildFile(locator, paths); } + @Override public void setSecurityStatus(final SecureJar.Status status) { this.securityStatus = status; diff --git a/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModJarMetadata.java b/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModJarMetadata.java index 6613691223..841b1afad5 100644 --- a/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModJarMetadata.java +++ b/fmlloader/src/main/java/net/minecraftforge/fml/loading/moddiscovery/ModJarMetadata.java @@ -17,18 +17,26 @@ public final class ModJarMetadata implements JarMetadata { private IModFile modFile; private ModuleDescriptor descriptor; + // TODO: Remove helper functions to cleanup api + @Deprecated(forRemoval = true, since="1.17.1") static Optional buildFile(IModLocator locator, Predicate jarTest, Path... files) { return buildFile(locator, jarTest, (a,b) -> true, files); } + // TODO: Remove helper functions to cleanup api + @Deprecated(forRemoval = true, since="1.17.1") static Optional buildFile(IModLocator locator, Predicate jarTest, BiPredicate filter, Path... files) { return buildFile(j->ModFile.newFMLInstance(locator, j), jarTest, filter, files); } + // TODO: Remove helper functions to cleanup api + @Deprecated(forRemoval = true, since="1.17.1") static IModFile buildFile(IModLocator locator, Path... files) { return buildFile(locator, j->true, files).orElseThrow(()->new IllegalArgumentException("Failed to find valid JAR file")); } + // TODO: Remove helper functions to cleanup api + @Deprecated(forRemoval = true, since="1.17.1") static Optional buildFile(Function mfConstructor, Predicate jarTest, BiPredicate filter, Path... files) { var mjm = new ModJarMetadata(); var sj = SecureJar.from(()->ModFile.DEFAULTMANIFEST, j->mjm, filter, files);