Validate manifest provided mapping namespace (#10612)

With plugins adopting paperweights mapping namespaces in their manifest
file in and after paper 1.20.5, incorrectly spelled namespaces
previously were simply implied as the spigot namespace.

This commit properly ensures plugin authors are using a known mapping
namespace in their manifest, avoiding down the line confusion on
incorrect remapping behaviour.

The commit also fixes two incorrect log parameters.
This commit is contained in:
Bjarne Koll 2024-04-29 05:43:50 +02:00 committed by GitHub
parent f9397e108e
commit 8f7ac62905
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -302,10 +302,10 @@ index 0000000000000000000000000000000000000000..99e658e3a0f08dbd90b3cf48609613e8
+} +}
diff --git a/src/main/java/io/papermc/paper/pluginremap/InsertManifestAttribute.java b/src/main/java/io/papermc/paper/pluginremap/InsertManifestAttribute.java diff --git a/src/main/java/io/papermc/paper/pluginremap/InsertManifestAttribute.java b/src/main/java/io/papermc/paper/pluginremap/InsertManifestAttribute.java
new file mode 100644 new file mode 100644
index 0000000000000000000000000000000000000000..3a5bb5d2a45654385ca0bc15c81ef95315b922b4 index 0000000000000000000000000000000000000000..d738b31f0005aca352a511c1a57e76b627fca2dd
--- /dev/null --- /dev/null
+++ b/src/main/java/io/papermc/paper/pluginremap/InsertManifestAttribute.java +++ b/src/main/java/io/papermc/paper/pluginremap/InsertManifestAttribute.java
@@ -0,0 +1,67 @@ @@ -0,0 +1,69 @@
+package io.papermc.paper.pluginremap; +package io.papermc.paper.pluginremap;
+ +
+import java.io.ByteArrayInputStream; +import java.io.ByteArrayInputStream;
@ -313,6 +313,7 @@ index 0000000000000000000000000000000000000000..3a5bb5d2a45654385ca0bc15c81ef953
+import java.io.IOException; +import java.io.IOException;
+import java.util.Collection; +import java.util.Collection;
+import java.util.List; +import java.util.List;
+import java.util.Set;
+import java.util.jar.Attributes; +import java.util.jar.Attributes;
+import java.util.jar.Manifest; +import java.util.jar.Manifest;
+import net.neoforged.art.api.Transformer; +import net.neoforged.art.api.Transformer;
@ -322,6 +323,7 @@ index 0000000000000000000000000000000000000000..3a5bb5d2a45654385ca0bc15c81ef953
+ static final String MOJANG_NAMESPACE = "mojang"; + static final String MOJANG_NAMESPACE = "mojang";
+ static final String MOJANG_PLUS_YARN_NAMESPACE = "mojang+yarn"; + static final String MOJANG_PLUS_YARN_NAMESPACE = "mojang+yarn";
+ static final String SPIGOT_NAMESPACE = "spigot"; + static final String SPIGOT_NAMESPACE = "spigot";
+ static final Set<String> KNOWN_NAMESPACES = Set.of(MOJANG_NAMESPACE, MOJANG_PLUS_YARN_NAMESPACE, SPIGOT_NAMESPACE);
+ +
+ private final String mainAttributesKey; + private final String mainAttributesKey;
+ private final String namespace; + private final String namespace;
@ -375,10 +377,10 @@ index 0000000000000000000000000000000000000000..3a5bb5d2a45654385ca0bc15c81ef953
+} +}
diff --git a/src/main/java/io/papermc/paper/pluginremap/PluginRemapper.java b/src/main/java/io/papermc/paper/pluginremap/PluginRemapper.java diff --git a/src/main/java/io/papermc/paper/pluginremap/PluginRemapper.java b/src/main/java/io/papermc/paper/pluginremap/PluginRemapper.java
new file mode 100644 new file mode 100644
index 0000000000000000000000000000000000000000..a1ce1307b2834f2415bdddbf42d80e2d69a480e1 index 0000000000000000000000000000000000000000..f3f7849412f4fd762fb044223b9fc25f6a8a0774
--- /dev/null --- /dev/null
+++ b/src/main/java/io/papermc/paper/pluginremap/PluginRemapper.java +++ b/src/main/java/io/papermc/paper/pluginremap/PluginRemapper.java
@@ -0,0 +1,433 @@ @@ -0,0 +1,438 @@
+package io.papermc.paper.pluginremap; +package io.papermc.paper.pluginremap;
+ +
+import com.google.common.util.concurrent.ThreadFactoryBuilder; +import com.google.common.util.concurrent.ThreadFactoryBuilder;
@ -502,7 +504,7 @@ index 0000000000000000000000000000000000000000..a1ce1307b2834f2415bdddbf42d80e2d
+ for (final Path lib : libraries) { + for (final Path lib : libraries) {
+ if (!lib.getFileName().toString().endsWith(".jar")) { + if (!lib.getFileName().toString().endsWith(".jar")) {
+ if (DEBUG_LOGGING) { + if (DEBUG_LOGGING) {
+ LOGGER.info("Library '{}' is not a jar.", libraries); + LOGGER.info("Library '{}' is not a jar.", lib);
+ } + }
+ tasks.add(CompletableFuture.completedFuture(lib)); + tasks.add(CompletableFuture.completedFuture(lib));
+ continue; + continue;
@ -510,7 +512,7 @@ index 0000000000000000000000000000000000000000..a1ce1307b2834f2415bdddbf42d80e2d
+ final @Nullable Path cached = this.libraries.getIfPresent(lib); + final @Nullable Path cached = this.libraries.getIfPresent(lib);
+ if (cached != null) { + if (cached != null) {
+ if (DEBUG_LOGGING) { + if (DEBUG_LOGGING) {
+ LOGGER.info("Library '{}' has not changed since last remap.", libraries); + LOGGER.info("Library '{}' has not changed since last remap.", lib);
+ } + }
+ tasks.add(CompletableFuture.completedFuture(cached)); + tasks.add(CompletableFuture.completedFuture(cached));
+ continue; + continue;
@ -681,6 +683,11 @@ index 0000000000000000000000000000000000000000..a1ce1307b2834f2415bdddbf42d80e2d
+ } else { + } else {
+ ns = null; + ns = null;
+ } + }
+
+ if (ns != null && !InsertManifestAttribute.KNOWN_NAMESPACES.contains(ns)) {
+ throw new RuntimeException("Failed to remap plugin " + inputFile + " with unknown mapping namespace '" + ns + "'");
+ }
+
+ final boolean mojangMappedManifest = ns != null && (ns.equals(InsertManifestAttribute.MOJANG_NAMESPACE) || ns.equals(InsertManifestAttribute.MOJANG_PLUS_YARN_NAMESPACE)); + final boolean mojangMappedManifest = ns != null && (ns.equals(InsertManifestAttribute.MOJANG_NAMESPACE) || ns.equals(InsertManifestAttribute.MOJANG_PLUS_YARN_NAMESPACE));
+ if (library) { + if (library) {
+ if (mojangMappedManifest) { + if (mojangMappedManifest) {