Delay registration of ScalaPlugins to Paper's PluginManager until they are enabled for the first time. Fixes #22.

Author: Jannyboy11

JavaExample/src/main/java/xyz/janboerman/scalaloader/example/java/ExamplePlugin.java

@@ -33,7 +33,7 @@ public class ExamplePlugin extends ScalaPlugin {
     private final Random random = new Random();
 
     public ExamplePlugin() {
-        super(new ScalaPluginDescription("JavaExample", "0.18.6-SNAPSHOT").addHardDepend("Scala2Example"));
+        super(new ScalaPluginDescription("JavaExample", "0.18.9-SNAPSHOT").addHardDepend("Scala2Example"));
     }
 
     public static ExamplePlugin getInstance() {

JavaExample/src/main/resources/plugin.yml

@@ -1,6 +1,6 @@
 name: JavaExample                                             #Ignored!
 main: xyz.janboerman.scalaloader.example.java.ExamplePlugin   #Ignored!
-version: 0.18.3-SNAPSHOT                                      #Ignored!
+version: 0.18.9-SNAPSHOT                                      #Ignored!
 api-version: 1.13
 
 commands:

Scala2Example/src/main/scala/xyz/janboerman/scalaloader/example/scala/ExamplePlugin.scala

@@ -4,7 +4,8 @@ import org.bukkit.{ChatColor, Material}
 import org.bukkit.command.{Command, CommandSender}
 import org.bukkit.event.{EventPriority, Listener}
 import org.bukkit.permissions.PermissionDefault
-import xyz.janboerman.scalaloader.example.scala.Permissions.{homePermission, fooPermission}
+import org.bukkit.plugin.PluginLoadOrder
+import xyz.janboerman.scalaloader.example.scala.Permissions.{fooPermission, homePermission}
 import xyz.janboerman.scalaloader.plugin.ScalaPluginDescription.{Command => SPCommand, Permission => SPPermission}
 import xyz.janboerman.scalaloader.plugin.{ScalaPlugin, ScalaPluginDescription}
 import xyz.janboerman.scalaloader.plugin.description.{Api, ApiVersion, Scala, ScalaVersion}
@@ -17,10 +18,11 @@ object Permissions {
 @Scala(version = ScalaVersion.v2_13_10)
 @Api(ApiVersion.v1_19)
 object ExamplePlugin
-    extends ScalaPlugin(new ScalaPluginDescription("Scala2Example", "0.18.6-SNAPSHOT")
+    extends ScalaPlugin(new ScalaPluginDescription("Scala2Example", "0.18.9-SNAPSHOT")
         .addCommand(new SPCommand("foo").permission(fooPermission))
         .addCommand(new SPCommand("home").permission(homePermission).usage("/home set|tp"))
-        .permissions(homePermission)) {
+        .permissions(homePermission)
+        .loadOrder(PluginLoadOrder.STARTUP)) {
 
     getLogger.info("Scala2Example - I am constructed!")
 

ScalaLoader-Paper/src/main/java/xyz/janboerman/scalaloader/paper/ScalaLoader.java

@@ -5,6 +5,7 @@
 import com.google.common.graph.MutableGraph;
 import io.papermc.paper.plugin.bootstrap.PluginBootstrap;
 import io.papermc.paper.plugin.bootstrap.PluginProviderContext;
+import io.papermc.paper.plugin.manager.PaperPluginManagerImpl;
 import org.bukkit.Server;
 import org.bukkit.command.CommandMap;
 import org.bukkit.event.EventHandler;
@@ -276,6 +277,8 @@ private void loadScalaPlugins(File[] files) {
         //perhaps, split this logic? maybe construct the ScalaPlugins from ScalaLoader's constructor
         //and then, call scalaPlugin.onLoad() from ScalaLoader's onLoad() method.
 
+        //idea: create a ScalaPluginProvider? and register it at an EntrypointHandler? The problem in doing that is PluginFileType#guessType cannot guess our type :/
+
         //all ScalaPlugins have been scanned.
         //let's instantiate them!
 
@@ -312,8 +315,6 @@ private void loadScalaPlugins(File[] files) {
             ScalaPlugin plugin = optionalPlugin.get();
 
             addScalaPlugin(plugin);
-            PaperHacks.getPaperPluginManager().loadPlugin(plugin);  //calls PaperPluginInstanceManager#loadPlugin(Plugin provided)
-            //this correctly takes dependencies and softdependencies into account, but not inverse dependencies. should I make the distinction between dependency graph and load graph?
             plugin.onLoad();
         }
 
@@ -358,14 +359,25 @@ private static void bootstrap(PluginBootstrap bootstrapper, ScalaPluginProviderC
     }
 
     private void enableScalaPlugins(PluginLoadOrder loadOrder) {
-        for (ScalaPlugin plugin : getScalaPlugins()) {
-            if (!plugin.isEnabled() && plugin.getPluginMeta().getLoadOrder() == loadOrder) {
-                ScalaPluginEnableEvent event = new ScalaPluginEnableEvent(plugin);
-                getServer().getPluginManager().callEvent(event);
-                if (event.isCancelled())
-                    continue;
+        for (ScalaPlugin scalaPlugin : getScalaPlugins()) {
+            if (scalaPlugin.getPluginMeta().getLoadOrder() == loadOrder) {
+
+                //register the ScalaPlugin with Paper's pluginManager.
+                PaperPluginManagerImpl paperPluginManager = PaperHacks.getPaperPluginManager();
+                if (paperPluginManager.getPlugin(scalaPlugin.getName()) == null) {  //ensure idempotency
+                    paperPluginManager.loadPlugin(scalaPlugin);                     //more like "registerPlugin" since PaperPluginInstanceManager.loadPlugin(Plugin) does not call Plugin.onLoad()!
+                    //note that scalaPlugin.onLoad() has already been called!
+                }
 
-                PaperHacks.getPaperPluginManager().enablePlugin(plugin);
+                //now, enable the scalaPlugin.
+                if (!scalaPlugin.isEnabled()) {
+                    ScalaPluginEnableEvent event = new ScalaPluginEnableEvent(scalaPlugin);
+                    getServer().getPluginManager().callEvent(event);
+                    if (event.isCancelled())
+                        continue;
+
+                    PaperHacks.getPaperPluginManager().enablePlugin(scalaPlugin);
+                }
             }
         }
     }

ScalaLoader-Paper/src/main/java/xyz/janboerman/scalaloader/paper/plugin/ScalaPluginClassLoader.java

@@ -14,21 +14,26 @@
 import java.security.CodeSource;
 import java.util.ArrayList;
 import java.util.Collections;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.function.BiFunction;
 import java.util.jar.JarEntry;
 import java.util.logging.Logger;
 import java.util.jar.JarFile;
+import java.util.stream.Collectors;
 
 import io.papermc.paper.plugin.entrypoint.classloader.ClassloaderBytecodeModifier;
 import io.papermc.paper.plugin.entrypoint.classloader.PaperPluginClassLoader;
 
+import io.papermc.paper.plugin.manager.PaperPluginManagerImpl;
 import org.bukkit.Server;
 import org.bukkit.command.Command;
 import org.bukkit.command.PluginCommand;
 import org.bukkit.configuration.serialization.ConfigurationSerializable;
 import org.bukkit.configuration.serialization.ConfigurationSerialization;
+import org.bukkit.permissions.Permission;
+import org.bukkit.permissions.PermissionDefault;
 import org.bukkit.plugin.Plugin;
 import org.bukkit.plugin.java.JavaPlugin;
 
@@ -44,6 +49,7 @@
 import xyz.janboerman.scalaloader.compat.Compat;
 import xyz.janboerman.scalaloader.compat.IScalaPluginClassLoader;
 import xyz.janboerman.scalaloader.paper.ScalaLoader;
+import xyz.janboerman.scalaloader.plugin.ScalaPluginDescription;
 import xyz.janboerman.scalaloader.plugin.description.ApiVersion;
 import xyz.janboerman.scalaloader.plugin.runtime.ClassDefineResult;
 import xyz.janboerman.scalaloader.plugin.runtime.ClassFile;
@@ -98,7 +104,7 @@ public void init(JavaPlugin plugin) {
         hackDataFolder();
         hackPluginDescriptionFile();
         registerCommandsFromPluginYaml();
-        //TODO maybe in the future I will have to hack the permissions map as well.
+        registerPermissionsFromPluginYaml();    // is it really necessary to register our permissions with the Paper PluginManager though?
 
         this.persistentClasses = new PersistentClasses(getPlugin());
         for (ClassFile classFile : this.persistentClasses.load()) {
@@ -345,6 +351,14 @@ private void registerCommandsFromPluginYaml() {
         getServer().getCommandMap().registerAll(getPlugin().getName(), pluginCommands);
     }
 
+    private void registerPermissionsFromPluginYaml() {
+        ScalaPluginDescription scalaPluginDescription = getConfiguration().description;
+        PermissionDefault defaultPermission = scalaPluginDescription.getPermissionDefault();
+        PaperHacks.getPaperPluginManager().addPermissions(scalaPluginDescription.getPermissions().stream()
+                .map(descriptionPermission -> toBukkitPermission(descriptionPermission, defaultPermission))
+                .toList());
+    }
+
     private static final PluginCommand newPluginCommand(String name, ScalaPlugin plugin) {
         try {
             Constructor<PluginCommand> ctor = PluginCommand.class.getDeclaredConstructor(String.class, Plugin.class);
@@ -355,4 +369,17 @@ private static final PluginCommand newPluginCommand(String name, ScalaPlugin plu
         }
     }
 
+    private static final Permission toBukkitPermission(xyz.janboerman.scalaloader.plugin.ScalaPluginDescription.Permission descriptionPermission, PermissionDefault defaultPermission) {
+        return new Permission(descriptionPermission.getName(), descriptionPermission.getDescription().orElse(null), defaultPermission, toBukkitChildren(descriptionPermission.getChildren()));
+    }
+
+    private static final Map<String, Boolean> toBukkitChildren(Map<xyz.janboerman.scalaloader.plugin.ScalaPluginDescription.Permission, Boolean> children) {
+        if (children == null || children.isEmpty()) return Compat.emptyMap();
+        LinkedHashMap<String, Boolean> result = new LinkedHashMap<>();
+        for (var entry : children.entrySet()) {
+            result.put(entry.getKey().getName(), entry.getValue());
+        }
+        return result;
+    }
+
 }