Skip to content

Print warning if people try to call JavaPlugin#getCommand with paper plugins #9685

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Leguan16 wants to merge 5 commits into from
Closed

Print warning if people try to call JavaPlugin#getCommand with paper plugins #9685

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7c33e67
Add warning if a commands tag has been found in paper-plugin.yml
Leguan16 Sep 4, 2023
01f87f8
Add warning if a commands tag has been found in paper-plugin.yml
Leguan16 Sep 4, 2023
c815814
fix conficts
Leguan16 Sep 4, 2023
b12cbac
move check to JavaPlugin
Leguan16 Sep 7, 2023
ce8cae5
remove dumb import
Leguan16 Sep 7, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions patches/api/0008-Paper-Plugins.patch
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Subject: [PATCH] Paper Plugins


diff --git a/build.gradle.kts b/build.gradle.kts
index ba6f0a70ba2442dbe60ed6cc92e4fb91a48d9f3b..22b65c3ad4ed6e19b88a51a2e001f0e5846d9ae6 100644
index b6b86e41b42a2e205ce2e74faea3f005529229fe..8c93ff28273ef9ddce2fb7a62ac50701fa3cd9a2 100644
--- a/build.gradle.kts
+++ b/build.gradle.kts
@@ -47,7 +47,7 @@ dependencies {
Expand Down Expand Up @@ -1882,7 +1882,7 @@ index a80251eff75430863b37db1c131e22593f3fcd5e..310c4041963a3f1e0a26e39a6da12a9b
+ // Paper end
}
diff --git a/src/main/java/org/bukkit/plugin/java/JavaPlugin.java b/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
index ee100b7ad89ce1eccef0c3bc55885cd78aadd1ec..f594913e6b94f77b26a4a758c447a42d8a25b6ff 100644
index ee100b7ad89ce1eccef0c3bc55885cd78aadd1ec..b7191597f5d442ebc56c20366fba633fc2541856 100644
--- a/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
+++ b/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
@@ -40,6 +40,7 @@ public abstract class JavaPlugin extends PluginBase {
Expand Down Expand Up @@ -1988,7 +1988,26 @@ index ee100b7ad89ce1eccef0c3bc55885cd78aadd1ec..f594913e6b94f77b26a4a758c447a42d
}

/**
@@ -396,10 +421,10 @@ public abstract class JavaPlugin extends PluginBase {
@@ -309,6 +334,18 @@ public abstract class JavaPlugin extends PluginBase {
*/
@Nullable
public PluginCommand getCommand(@NotNull String name) {
+ // Paper start - print warning if paper plugin
+ if (!(pluginMeta instanceof PluginDescriptionFile)) {
+ this.logger.warning("---------------------------------WARNING--------------------------------");
+ this.logger.warning(" Defining commands in paper-plugin.yml is unsupported! ");
+ this.logger.warning(" Please refer to the docs for proper command initialization! ");
+ this.logger.warning("https://docs.papermc.io/paper/dev/getting-started/paper-plugins#commands");
+ this.logger.warning(" Command will not be initialized! ");
+ this.logger.warning("---------------------------------WARNING--------------------------------");
+ throw new RuntimeException("Defining commands in paper-plugin.yml is unsupported! - Please refer to the warning above for further details.");
+ }
+ // Paper end
+
String alias = name.toLowerCase(java.util.Locale.ENGLISH);
PluginCommand command = getServer().getPluginCommand(alias);

@@ -396,10 +433,10 @@ public abstract class JavaPlugin extends PluginBase {
throw new IllegalArgumentException(clazz + " does not extend " + JavaPlugin.class);
}
final ClassLoader cl = clazz.getClassLoader();
Expand All @@ -2002,7 +2021,7 @@ index ee100b7ad89ce1eccef0c3bc55885cd78aadd1ec..f594913e6b94f77b26a4a758c447a42d
if (plugin == null) {
throw new IllegalStateException("Cannot get plugin for " + clazz + " from a static initializer");
}
@@ -422,10 +447,10 @@ public abstract class JavaPlugin extends PluginBase {
@@ -422,10 +459,10 @@ 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();
Expand Down
2 changes: 1 addition & 1 deletion patches/api/0070-Handle-plugin-prefixes-in-implementation-logging-con.patch
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ The implementation should handle plugin prefixes by displaying
logger names when appropriate.

diff --git a/src/main/java/org/bukkit/plugin/java/JavaPlugin.java b/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
index f594913e6b94f77b26a4a758c447a42d8a25b6ff..7cd9f98c042dc2bb80876af35c755f81bef34651 100644
index b7191597f5d442ebc56c20366fba633fc2541856..d946ad5490d208a83b447f84a6fe6bdfe6913cef 100644
--- a/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
+++ b/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
@@ -46,7 +46,7 @@ public abstract class JavaPlugin extends PluginBase {
Expand Down
2 changes: 1 addition & 1 deletion patches/api/0072-Add-workaround-for-plugins-modifying-the-parent-of-t.patch
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ index 0000000000000000000000000000000000000000..087ee57fe5485bc760fadd45a176d4d9
+
+}
diff --git a/src/main/java/org/bukkit/plugin/java/JavaPlugin.java b/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
index 7cd9f98c042dc2bb80876af35c755f81bef34651..5cd236965de12392d8c7aa81307c0ff1cc8673b1 100644
index d946ad5490d208a83b447f84a6fe6bdfe6913cef..296a319d10e399fa27b8fca7b5c05a7e16aa0b52 100644
--- a/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
+++ b/src/main/java/org/bukkit/plugin/java/JavaPlugin.java
@@ -291,10 +291,10 @@ public abstract class JavaPlugin extends PluginBase {
Expand Down