mirror of
https://github.com/PaperMC/Paper.git
synced 2024-12-12 04:06:52 +01:00
8c5b837e05
Firstly, the old methods all routed to the CompletableFuture method. However, the CF method could not guarantee that if the caller was off-main that the future would be "completed" on-main. Since the callback methods used the CF one, this meant that the callback methods did not guarantee that the callbacks were to be called on the main thread. Now, all methods route to getChunkAtAsync(x, z, gen, urgent, cb) so that the methods with the callback are guaranteed to invoke the callback on the main thread. The CF behavior remains unchanged; it may still appear to complete on main if invoked off-main. Secondly, remove the scheduleOnMain invocation in the async chunk completion. This unnecessarily delays the callback by 1 tick. Thirdly, add getChunksAtAsync(minX, minZ, maxX, maxZ, ...) which will load chunks within an area. This method is provided as a helper as keeping all chunks loaded within an area can be complicated to implement for plugins (due to the lacking ticket API), and is already implemented internally anyways. Fourthly, remove the ticket addition that occured with getChunkAt and getChunkAtAsync. The ticket addition may delay the unloading of the chunk unnecessarily. It also fixes a very rare timing bug where the future/callback would be completed after the chunk unloads.
131 lines
7.2 KiB
Diff
131 lines
7.2 KiB
Diff
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
|
From: Jason Penilla <11360596+jpenilla@users.noreply.github.com>
|
|
Date: Tue, 21 May 2024 13:18:15 -0700
|
|
Subject: [PATCH] Allow Bukkit plugin to use Paper PluginLoader API
|
|
|
|
|
|
diff --git a/src/main/java/io/papermc/paper/plugin/loader/PaperClasspathBuilder.java b/src/main/java/io/papermc/paper/plugin/loader/PaperClasspathBuilder.java
|
|
index f871a329eb52da077f58d0ceaaabd3349f84cad0..21a0a4e29c0eb1b4f7dc89ad3df481ca89dbf1a4 100644
|
|
--- a/src/main/java/io/papermc/paper/plugin/loader/PaperClasspathBuilder.java
|
|
+++ b/src/main/java/io/papermc/paper/plugin/loader/PaperClasspathBuilder.java
|
|
@@ -41,15 +41,7 @@ public class PaperClasspathBuilder implements PluginClasspathBuilder {
|
|
}
|
|
|
|
public PaperPluginClassLoader buildClassLoader(Logger logger, Path source, JarFile jarFile, PaperPluginMeta configuration) {
|
|
- PaperLibraryStore paperLibraryStore = new PaperLibraryStore();
|
|
- for (ClassPathLibrary library : this.libraries) {
|
|
- library.register(paperLibraryStore);
|
|
- }
|
|
-
|
|
- List<Path> paths = paperLibraryStore.getPaths();
|
|
- if (PluginInitializerManager.instance().pluginRemapper != null) {
|
|
- paths = PluginInitializerManager.instance().pluginRemapper.remapLibraries(paths);
|
|
- }
|
|
+ List<Path> paths = this.buildLibraryPaths(true);
|
|
URL[] urls = new URL[paths.size()];
|
|
for (int i = 0; i < paths.size(); i++) {
|
|
Path path = paths.get(i);
|
|
@@ -69,4 +61,17 @@ public class PaperClasspathBuilder implements PluginClasspathBuilder {
|
|
throw new RuntimeException(exception);
|
|
}
|
|
}
|
|
+
|
|
+ public List<Path> buildLibraryPaths(final boolean remap) {
|
|
+ PaperLibraryStore paperLibraryStore = new PaperLibraryStore();
|
|
+ for (ClassPathLibrary library : this.libraries) {
|
|
+ library.register(paperLibraryStore);
|
|
+ }
|
|
+
|
|
+ List<Path> paths = paperLibraryStore.getPaths();
|
|
+ if (remap && PluginInitializerManager.instance().pluginRemapper != null) {
|
|
+ paths = PluginInitializerManager.instance().pluginRemapper.remapLibraries(paths);
|
|
+ }
|
|
+ return paths;
|
|
+ }
|
|
}
|
|
diff --git a/src/main/java/io/papermc/paper/plugin/provider/type/spigot/SpigotPluginProvider.java b/src/main/java/io/papermc/paper/plugin/provider/type/spigot/SpigotPluginProvider.java
|
|
index 75a2b687d58d76b94f8bec111df8613f120ff74b..0fd1040ed376f19c6d5326767baaf3048ce1bfb4 100644
|
|
--- a/src/main/java/io/papermc/paper/plugin/provider/type/spigot/SpigotPluginProvider.java
|
|
+++ b/src/main/java/io/papermc/paper/plugin/provider/type/spigot/SpigotPluginProvider.java
|
|
@@ -40,15 +40,17 @@ public class SpigotPluginProvider implements PluginProvider<JavaPlugin>, Provide
|
|
private final PluginDescriptionFile description;
|
|
private final JarFile jarFile;
|
|
private final Logger logger;
|
|
+ private final List<Path> paperLibraryPaths;
|
|
private final ComponentLogger componentLogger;
|
|
private ProviderStatus status;
|
|
private DependencyContext dependencyContext;
|
|
|
|
- SpigotPluginProvider(Path path, JarFile file, PluginDescriptionFile description) {
|
|
+ SpigotPluginProvider(Path path, JarFile file, PluginDescriptionFile description, List<Path> paperLibraryPaths) {
|
|
this.path = path;
|
|
this.jarFile = file;
|
|
this.description = description;
|
|
this.logger = PaperPluginLogger.getLogger(description);
|
|
+ this.paperLibraryPaths = paperLibraryPaths;
|
|
this.componentLogger = ComponentLogger.logger(this.logger.getName());
|
|
}
|
|
|
|
@@ -120,7 +122,7 @@ public class SpigotPluginProvider implements PluginProvider<JavaPlugin>, Provide
|
|
|
|
final PluginClassLoader loader;
|
|
try {
|
|
- loader = new PluginClassLoader(this.getClass().getClassLoader(), this.description, dataFolder, this.path.toFile(), LIBRARY_LOADER.createLoader(this.description), this.jarFile, this.dependencyContext); // Paper
|
|
+ loader = new PluginClassLoader(this.getClass().getClassLoader(), this.description, dataFolder, this.path.toFile(), LIBRARY_LOADER.createLoader(this.description, this.paperLibraryPaths), this.jarFile, this.dependencyContext); // Paper
|
|
} catch (InvalidPluginException ex) {
|
|
throw ex;
|
|
} catch (Throwable ex) {
|
|
diff --git a/src/main/java/io/papermc/paper/plugin/provider/type/spigot/SpigotPluginProviderFactory.java b/src/main/java/io/papermc/paper/plugin/provider/type/spigot/SpigotPluginProviderFactory.java
|
|
index 1bf0fa1530b8e5f94d726d0313b7a00f675b500c..9edf79dffd2836b40d41da4437c18d6145853f89 100644
|
|
--- a/src/main/java/io/papermc/paper/plugin/provider/type/spigot/SpigotPluginProviderFactory.java
|
|
+++ b/src/main/java/io/papermc/paper/plugin/provider/type/spigot/SpigotPluginProviderFactory.java
|
|
@@ -1,9 +1,18 @@
|
|
package io.papermc.paper.plugin.provider.type.spigot;
|
|
|
|
+import com.destroystokyo.paper.utils.PaperPluginLogger;
|
|
+import io.papermc.paper.plugin.bootstrap.PluginProviderContextImpl;
|
|
import io.papermc.paper.plugin.entrypoint.classloader.BytecodeModifyingURLClassLoader;
|
|
+import io.papermc.paper.plugin.entrypoint.classloader.PaperSimplePluginClassLoader;
|
|
+import io.papermc.paper.plugin.loader.PaperClasspathBuilder;
|
|
+import io.papermc.paper.plugin.loader.PluginLoader;
|
|
import io.papermc.paper.plugin.provider.configuration.serializer.constraints.PluginConfigConstraints;
|
|
import io.papermc.paper.plugin.provider.type.PluginTypeFactory;
|
|
+import io.papermc.paper.plugin.provider.util.ProviderUtil;
|
|
import io.papermc.paper.util.MappingEnvironment;
|
|
+import java.util.List;
|
|
+import java.util.logging.Logger;
|
|
+import net.kyori.adventure.text.logger.slf4j.ComponentLogger;
|
|
import org.bukkit.plugin.InvalidDescriptionException;
|
|
import org.bukkit.plugin.PluginDescriptionFile;
|
|
import org.bukkit.plugin.java.LibraryLoader;
|
|
@@ -36,7 +45,28 @@ class SpigotPluginProviderFactory implements PluginTypeFactory<SpigotPluginProvi
|
|
throw new InvalidDescriptionException("Restricted name, cannot use 0x20 (space character) in a plugin name.");
|
|
}
|
|
|
|
- return new SpigotPluginProvider(source, file, configuration);
|
|
+ final List<Path> paperLibraryPaths;
|
|
+ if (configuration.getPaperPluginLoader() != null) {
|
|
+ final Logger logger = PaperPluginLogger.getLogger(configuration);
|
|
+ PaperClasspathBuilder builder = new PaperClasspathBuilder(PluginProviderContextImpl.create(
|
|
+ configuration, ComponentLogger.logger(logger.getName()), source
|
|
+ ));
|
|
+
|
|
+ try (
|
|
+ PaperSimplePluginClassLoader simplePluginClassLoader = new PaperSimplePluginClassLoader(source, file, configuration, this.getClass().getClassLoader())
|
|
+ ) {
|
|
+ PluginLoader loader = ProviderUtil.loadClass(configuration.getPaperPluginLoader(), PluginLoader.class, simplePluginClassLoader);
|
|
+ loader.classloader(builder);
|
|
+ } catch (IOException e) {
|
|
+ throw new RuntimeException(e);
|
|
+ }
|
|
+
|
|
+ paperLibraryPaths = builder.buildLibraryPaths(false);
|
|
+ } else {
|
|
+ paperLibraryPaths = null;
|
|
+ }
|
|
+
|
|
+ return new SpigotPluginProvider(source, file, configuration, paperLibraryPaths);
|
|
}
|
|
|
|
@Override
|