mirror of
https://github.com/PaperMC/Paper.git
synced 2025-04-04 05:21:01 +02:00
Disallow calling JavaPlugin#getCommand during onEnable for Paper plugins (#11914)
Co-authored-by: leguan <longboard.noah@gmail.com>
This commit is contained in:
Noah van der Aa
GitHub
parent
c2f24e1567
commit
ed75b0e54b
1 changed files with 33 additions and 29 deletions
|
|
@ -26,7 +26,6 @@ import org.bukkit.generator.ChunkGenerator;
|
|||
import org.bukkit.plugin.PluginBase;
|
||||
import org.bukkit.plugin.PluginDescriptionFile;
|
||||
import org.bukkit.plugin.PluginLoader;
|
||||
import org.bukkit.plugin.PluginLogger;
|
||||
import org.jetbrains.annotations.NotNull;
|
||||
import org.jetbrains.annotations.Nullable;
|
||||
|
||||
|
|
@ -41,30 +40,27 @@ public abstract class JavaPlugin extends PluginBase {
|
|||
private Server server = null;
|
||||
private File file = null;
|
||||
private PluginDescriptionFile description = null;
|
||||
private io.papermc.paper.plugin.configuration.PluginMeta pluginMeta = null; // Paper
|
||||
private io.papermc.paper.plugin.configuration.PluginMeta pluginMeta = null;
|
||||
private File dataFolder = null;
|
||||
private ClassLoader classLoader = null;
|
||||
private boolean naggable = true;
|
||||
private FileConfiguration newConfig = null;
|
||||
private File configFile = null;
|
||||
private Logger logger = null; // Paper - PluginLogger -> Logger
|
||||
// Paper start - lifecycle events
|
||||
private Logger logger = null;
|
||||
@SuppressWarnings("deprecation")
|
||||
private final io.papermc.paper.plugin.lifecycle.event.LifecycleEventManager<org.bukkit.plugin.Plugin> lifecycleEventManager = org.bukkit.Bukkit.getUnsafe().createPluginLifecycleEventManager(this, () -> this.allowsLifecycleRegistration);
|
||||
private boolean allowsLifecycleRegistration = true;
|
||||
// Paper end
|
||||
private boolean isBeingEnabled = false;
|
||||
|
||||
public JavaPlugin() {
|
||||
// Paper start
|
||||
if (this.getClass().getClassLoader() instanceof io.papermc.paper.plugin.provider.classloader.ConfiguredPluginClassLoader configuredPluginClassLoader) {
|
||||
configuredPluginClassLoader.init(this);
|
||||
} else {
|
||||
throw new IllegalStateException("JavaPlugin requires to be created by a valid classloader.");
|
||||
}
|
||||
// Paper end
|
||||
}
|
||||
|
||||
@Deprecated(forRemoval = true) // Paper
|
||||
@Deprecated(forRemoval = true)
|
||||
protected JavaPlugin(@NotNull final JavaPluginLoader loader, @NotNull final PluginDescriptionFile description, @NotNull final File dataFolder, @NotNull final File file) {
|
||||
final ClassLoader classLoader = this.getClass().getClassLoader();
|
||||
if (classLoader instanceof PluginClassLoader) {
|
||||
|
|
@ -94,7 +90,7 @@ public abstract class JavaPlugin extends PluginBase {
|
|||
*/
|
||||
@NotNull
|
||||
@Override
|
||||
@Deprecated(forRemoval = true) // Paper
|
||||
@Deprecated(forRemoval = true)
|
||||
public final PluginLoader getPluginLoader() {
|
||||
return loader;
|
||||
}
|
||||
|
|
@ -111,8 +107,7 @@ public abstract class JavaPlugin extends PluginBase {
|
|||
}
|
||||
|
||||
/**
|
||||
* Returns a value indicating whether or not this plugin is currently
|
||||
* enabled
|
||||
* Returns a value indicating whether this plugin is currently enabled
|
||||
*
|
||||
* @return true if this plugin is enabled, otherwise false
|
||||
*/
|
||||
|
|
@ -278,22 +273,25 @@ public abstract class JavaPlugin extends PluginBase {
|
|||
*
|
||||
* @param enabled true if enabled, otherwise false
|
||||
*/
|
||||
@org.jetbrains.annotations.ApiStatus.Internal // Paper
|
||||
public final void setEnabled(final boolean enabled) { // Paper
|
||||
@org.jetbrains.annotations.ApiStatus.Internal
|
||||
public final void setEnabled(final boolean enabled) {
|
||||
if (isEnabled != enabled) {
|
||||
isEnabled = enabled;
|
||||
|
||||
if (isEnabled) {
|
||||
try { // Paper - lifecycle events
|
||||
onEnable();
|
||||
} finally { this.allowsLifecycleRegistration = false; } // Paper - lifecycle events
|
||||
this.isBeingEnabled = true;
|
||||
try {
|
||||
onEnable();
|
||||
} finally {
|
||||
this.allowsLifecycleRegistration = false;
|
||||
this.isBeingEnabled = false;
|
||||
}
|
||||
} else {
|
||||
onDisable();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Paper start
|
||||
private static class DummyPluginLoaderImplHolder {
|
||||
private static final PluginLoader INSTANCE = net.kyori.adventure.util.Services.service(PluginLoader.class)
|
||||
.orElseThrow();
|
||||
|
|
@ -303,16 +301,15 @@ public abstract class JavaPlugin extends PluginBase {
|
|||
this.pluginMeta = description;
|
||||
}
|
||||
public final void init(@NotNull Server server, @NotNull PluginDescriptionFile description, @NotNull File dataFolder, @NotNull File file, @NotNull ClassLoader classLoader, @Nullable io.papermc.paper.plugin.configuration.PluginMeta configuration, @NotNull Logger logger) {
|
||||
// Paper end
|
||||
this.loader = DummyPluginLoaderImplHolder.INSTANCE; // Paper
|
||||
this.loader = DummyPluginLoaderImplHolder.INSTANCE;
|
||||
this.server = server;
|
||||
this.file = file;
|
||||
this.description = description;
|
||||
this.dataFolder = dataFolder;
|
||||
this.classLoader = classLoader;
|
||||
this.configFile = new File(dataFolder, "config.yml");
|
||||
this.pluginMeta = configuration; // Paper
|
||||
this.logger = logger; // Paper
|
||||
this.pluginMeta = configuration;
|
||||
this.logger = logger;
|
||||
}
|
||||
|
||||
/**
|
||||
|
|
@ -339,9 +336,18 @@ public abstract class JavaPlugin extends PluginBase {
|
|||
*
|
||||
* @param name name or alias of the command
|
||||
* @return the plugin command if found, otherwise null
|
||||
* @throws UnsupportedOperationException if this plugin is a paper plugin and the method is called in {@link #onEnable()}
|
||||
*/
|
||||
@Nullable
|
||||
public PluginCommand getCommand(@NotNull String name) {
|
||||
if (this.isBeingEnabled && !(pluginMeta instanceof PluginDescriptionFile)) {
|
||||
throw new UnsupportedOperationException("""
|
||||
You are trying to call JavaPlugin#getCommand on a Paper plugin during startup:
|
||||
you are probably trying to get a command you tried to define in paper-plugin.yml.
|
||||
Paper plugins do not support YAML-based command declarations!
|
||||
Please check the documentation for more information on how to define commands in Paper plugins: https://docs.papermc.io/paper/dev/getting-started/paper-plugins#commands
|
||||
""");
|
||||
}
|
||||
String alias = name.toLowerCase(Locale.ROOT);
|
||||
PluginCommand command = getServer().getPluginCommand(alias);
|
||||
|
||||
|
|
@ -429,10 +435,10 @@ public abstract class JavaPlugin extends PluginBase {
|
|||
throw new IllegalArgumentException(clazz + " does not extend " + JavaPlugin.class);
|
||||
}
|
||||
final ClassLoader cl = clazz.getClassLoader();
|
||||
if (!(cl instanceof io.papermc.paper.plugin.provider.classloader.ConfiguredPluginClassLoader configuredPluginClassLoader)) { // Paper
|
||||
throw new IllegalArgumentException(clazz + " is not initialized by a " + io.papermc.paper.plugin.provider.classloader.ConfiguredPluginClassLoader.class); // Paper
|
||||
if (!(cl instanceof io.papermc.paper.plugin.provider.classloader.ConfiguredPluginClassLoader configuredPluginClassLoader)) {
|
||||
throw new IllegalArgumentException(clazz + " is not initialized by a " + io.papermc.paper.plugin.provider.classloader.ConfiguredPluginClassLoader.class);
|
||||
}
|
||||
JavaPlugin plugin = configuredPluginClassLoader.getPlugin(); // Paper
|
||||
JavaPlugin plugin = configuredPluginClassLoader.getPlugin();
|
||||
if (plugin == null) {
|
||||
throw new IllegalStateException("Cannot get plugin for " + clazz + " from a static initializer");
|
||||
}
|
||||
|
|
@ -455,20 +461,18 @@ public abstract class JavaPlugin extends PluginBase {
|
|||
public static JavaPlugin getProvidingPlugin(@NotNull Class<?> clazz) {
|
||||
Preconditions.checkArgument(clazz != null, "Null class cannot have a plugin");
|
||||
final ClassLoader cl = clazz.getClassLoader();
|
||||
if (!(cl instanceof io.papermc.paper.plugin.provider.classloader.ConfiguredPluginClassLoader configuredPluginClassLoader)) { // Paper
|
||||
throw new IllegalArgumentException(clazz + " is not provided by a " + io.papermc.paper.plugin.provider.classloader.ConfiguredPluginClassLoader.class); // Paper
|
||||
if (!(cl instanceof io.papermc.paper.plugin.provider.classloader.ConfiguredPluginClassLoader configuredPluginClassLoader)) {
|
||||
throw new IllegalArgumentException(clazz + " is not provided by a " + io.papermc.paper.plugin.provider.classloader.ConfiguredPluginClassLoader.class);
|
||||
}
|
||||
JavaPlugin plugin = configuredPluginClassLoader.getPlugin(); // Paper
|
||||
JavaPlugin plugin = configuredPluginClassLoader.getPlugin();
|
||||
if (plugin == null) {
|
||||
throw new IllegalStateException("Cannot get plugin for " + clazz + " from a static initializer");
|
||||
}
|
||||
return plugin;
|
||||
}
|
||||
|
||||
// Paper start - lifecycle events
|
||||
@Override
|
||||
public final io.papermc.paper.plugin.lifecycle.event.@NotNull LifecycleEventManager<org.bukkit.plugin.Plugin> getLifecycleManager() {
|
||||
return this.lifecycleEventManager;
|
||||
}
|
||||
// Paper end - lifecycle events
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue