Add a new 'mainHeadless' field to the plugin manifest to allow plugins with a UI to provide an alternate implementation that doesn't require JavaFX.

Author: leMaik

chunky/src/java/se/llbit/chunky/plugin/loader/JarPluginLoader.java

@@ -16,8 +16,14 @@
 @PluginApi
 public class JarPluginLoader implements PluginLoader {
   public void load(BiConsumer<Plugin, PluginManifest> onLoad, PluginManifest pluginManifest) {
+    load(onLoad, pluginManifest, null);
+  }
+
+  @Override
+  public void load(BiConsumer<Plugin, PluginManifest> onLoad, PluginManifest pluginManifest, PluginLoaderContext context) {
+    boolean headless = context != null && context.isHeadless();
     try {
-      Class<?> pluginClass = loadPluginClass(pluginManifest.main, pluginManifest.pluginJar);
+      Class<?> pluginClass = loadPluginClass(headless && !pluginManifest.mainHeadless.isEmpty() ? pluginManifest.mainHeadless : pluginManifest.main, pluginManifest.pluginJar);
       Plugin plugin = (Plugin) pluginClass.getDeclaredConstructor().newInstance();
       onLoad.accept(plugin, pluginManifest);
     } catch (IOException | ClassNotFoundException e) {
@@ -33,13 +39,13 @@ public void load(BiConsumer<Plugin, PluginManifest> onLoad, PluginManifest plugi
    * This method is {@link PluginApi} to allow plugins to override only classloading functionality of the default plugin loader.
    *
    * @param pluginMainClass The plugin's main class to load.
-   * @param pluginJarFile The jar file to load classes from.
+   * @param pluginJarFile   The jar file to load classes from.
    * @return The loaded plugin's main class
    * @throws ClassNotFoundException If the main class doesn't exist
-   * @throws MalformedURLException If the jar file cannot be converted to a URL
+   * @throws MalformedURLException  If the jar file cannot be converted to a URL
    */
   @PluginApi
   protected Class<?> loadPluginClass(String pluginMainClass, File pluginJarFile) throws ClassNotFoundException, MalformedURLException {
-    return new URLClassLoader(new URL[] { pluginJarFile.toURI().toURL() }).loadClass(pluginMainClass);
+    return new URLClassLoader(new URL[]{pluginJarFile.toURI().toURL()}).loadClass(pluginMainClass);
   }
 }

chunky/src/java/se/llbit/chunky/plugin/loader/PluginLoader.java

@@ -15,4 +15,9 @@ public interface PluginLoader {
    */
   @PluginApi
   void load(BiConsumer<Plugin, PluginManifest> onLoad, PluginManifest pluginManifest);
+
+  @PluginApi
+  default void load(BiConsumer<Plugin, PluginManifest> onLoad, PluginManifest pluginManifest, PluginLoaderContext context){
+    load(onLoad, pluginManifest);
+  }
 }

chunky/src/java/se/llbit/chunky/plugin/loader/PluginLoaderContext.java

@@ -0,0 +1,22 @@
+package se.llbit.chunky.plugin.loader;
+
+import se.llbit.chunky.plugin.PluginApi;
+
+@PluginApi
+public class PluginLoaderContext {
+  private boolean isHeadless;
+
+  public PluginLoaderContext(boolean isHeadless) {
+    this.isHeadless = isHeadless;
+  }
+
+  /**
+   * Check if Chunky is running in headless mode. If it is, JavaFX might not be available.
+   *
+   * @return True if Chunky is running in headless mode, false otherwise
+   */
+  @PluginApi
+  public boolean isHeadless() {
+    return isHeadless;
+  }
+}

chunky/src/java/se/llbit/chunky/plugin/loader/PluginManager.java

@@ -43,7 +43,7 @@ public PluginManager(PluginLoader pluginLoader) {
     this.pluginLoader = pluginLoader;
   }
 
-  public void load(Set<PluginManifest> pluginManifests, BiConsumer<Plugin, PluginManifest> onLoad) {
+  public void load(Set<PluginManifest> pluginManifests, BiConsumer<Plugin, PluginManifest> onLoad, PluginLoaderContext context) {
     // create plugin objects
     Map<String, List<ResolvedPlugin>> pluginsByName = new HashMap<>();
     pluginManifests.forEach(manifest -> {
@@ -81,7 +81,7 @@ public void load(Set<PluginManifest> pluginManifests, BiConsumer<Plugin, PluginM
             plugin.getManifest().getDependencies().stream().map(PluginDependency::toString).collect(Collectors.joining(", ")),
             plugin.getDependencies().stream().map(ResolvedPlugin::toString).collect(Collectors.joining(", "))
           );
-          pluginLoader.load(onLoad, plugin.getManifest());
+          pluginLoader.load(onLoad, plugin.getManifest(), context);
         }
       });
     }

chunky/src/java/se/llbit/chunky/plugin/manifest/PluginManifest.java

@@ -4,6 +4,7 @@
 import org.apache.maven.artifact.versioning.DefaultArtifactVersion;
 import org.apache.maven.artifact.versioning.InvalidVersionSpecificationException;
 import org.apache.maven.artifact.versioning.VersionRange;
+import se.llbit.chunky.main.Chunky;
 import se.llbit.chunky.main.Version;
 import se.llbit.json.JsonMember;
 import se.llbit.json.JsonObject;
@@ -25,6 +26,7 @@ public class PluginManifest {
   public final ArtifactVersion version;
   public final VersionRange targetVersion;
   public final String main;
+  public final String mainHeadless;
   private final Set<PluginDependency> dependencies;
 
   /**
@@ -38,14 +40,15 @@ public class PluginManifest {
    * @param dependencies The required dependencies of the plugin
    */
   public PluginManifest(File pluginJar, String name, String author, String description, ArtifactVersion version,
-                        VersionRange targetVersion, String main, Set<PluginDependency> dependencies) {
+                        VersionRange targetVersion, String main, String mainHeadless, Set<PluginDependency> dependencies) {
     this.pluginJar = pluginJar;
     this.name = name;
     this.author = author;
     this.description = description;
     this.version = version;
     this.targetVersion = targetVersion;
     this.main = main;
+    this.mainHeadless = mainHeadless;
     this.dependencies = dependencies;
   }
 
@@ -62,6 +65,7 @@ public static Optional<PluginManifest> parse(JsonObject manifest, File pluginJar
     String version = manifest.get("version").stringValue("");
     String targetVersion = manifest.get("targetVersion").stringValue("");
     String main = manifest.get("main").stringValue("");
+    String mainHeadless = manifest.get("mainHeadless").stringValue("");
 
     if (name.isEmpty()) {
       Log.errorf("Plugin %s has no name specified", pluginJar.getName());
@@ -75,6 +79,9 @@ public static Optional<PluginManifest> parse(JsonObject manifest, File pluginJar
       Log.errorf("Plugin %s has no main class specified", name);
       return Optional.empty();
     }
+    if (mainHeadless.isEmpty()) {
+      mainHeadless = main;
+    }
     if (targetVersion.isEmpty()) {
       Log.errorf("Plugin %s has no targetVersion specified", name);
       return Optional.empty();
@@ -111,7 +118,7 @@ public static Optional<PluginManifest> parse(JsonObject manifest, File pluginJar
         Log.error(String.format("Failed to parse plugin %s targetVersion %s into version range.", name, targetVersion), e);
         targetVersionRange = VersionRange.createFromVersion(targetVersion);
     }
-    return Optional.of(new PluginManifest(pluginJar, name, author, description, new DefaultArtifactVersion(version), targetVersionRange, main, dependencies));
+    return Optional.of(new PluginManifest(pluginJar, name, author, description, new DefaultArtifactVersion(version), targetVersionRange, main, mainHeadless, dependencies));
   }
 
   public Set<PluginDependency> getDependencies() {

chunky/src/test/se/llbit/chunky/plugin/PluginManagerTest.java

@@ -5,6 +5,7 @@
 import org.apache.maven.artifact.versioning.VersionRange;
 import org.junit.jupiter.api.Test;
 import se.llbit.chunky.main.Version;
+import se.llbit.chunky.plugin.loader.PluginLoaderContext;
 import se.llbit.chunky.plugin.loader.PluginManager;
 import se.llbit.chunky.plugin.manifest.PluginDependency;
 import se.llbit.chunky.plugin.manifest.PluginManifest;
@@ -26,14 +27,14 @@ public void testSimpleChainOfDependencies() throws InvalidVersionSpecificationEx
     HashSet<PluginManifest> manifests = new HashSet<>();
     for (int i = 1; i < 10; i++) {
       manifests.add(new PluginManifest(null, "test" + i, "author" + i, "desc" + i,
-        new DefaultArtifactVersion(i + ".0"), chunkyVersion, "test1.Main",
+        new DefaultArtifactVersion(i + ".0"), chunkyVersion, "test1.Main", "test1.MainHeadless",
         Set.of(
           new PluginDependency("test" + (i + 1), VersionRange.createFromVersionSpec("[" + (i + 1) + ".0]"))
         )
       ));
     }
     manifests.add(new PluginManifest(null, "test10", "author10", "desc10",
-      new DefaultArtifactVersion("10.0"), chunkyVersion, "test10.Main", Collections.emptySet()
+      new DefaultArtifactVersion("10.0"), chunkyVersion, "test10.Main", "test10.MainHeadless", Collections.emptySet()
     ));
 
     Set<String> expectedLoadedPlugins = Set.of("test1", "test2", "test3", "test4", "test5", "test6", "test7", "test8", "test9", "test10");
@@ -52,15 +53,15 @@ public void testLoopOfDependencies() throws InvalidVersionSpecificationException
     HashSet<PluginManifest> manifests = new HashSet<>();
     for (int i = 1; i < 10; i++) {
       manifests.add(new PluginManifest(null, "test" + i, "author" + i, "desc" + i,
-        new DefaultArtifactVersion(i + ".0"), chunkyVersion, "test1.Main",
+        new DefaultArtifactVersion(i + ".0"), chunkyVersion, "test1.Main", "test1.MainHeadless",
         Set.of(
           new PluginDependency("test" + (i + 1), VersionRange.createFromVersionSpec("[" + (i + 1) + ".0]"))
         )
       ));
     }
     // The last one depends on the first. A loop!
     manifests.add(new PluginManifest(null, "test10", "author10", "desc10",
-      new DefaultArtifactVersion("10.0"), chunkyVersion, "test10.Main",
+      new DefaultArtifactVersion("10.0"), chunkyVersion, "test10.Main", "test10.MainHeadless",
       Set.of(
         new PluginDependency("test1", VersionRange.createFromVersionSpec("[1.0]"))
       )
@@ -83,62 +84,62 @@ public void testNormalCase() throws InvalidVersionSpecificationException {
     */
     Set<PluginManifest> manifests = new HashSet<>();
     manifests.add(new PluginManifest(null, "test10", "author10", "desc10",
-      new DefaultArtifactVersion("10.0"), chunkyVersion, "test10.Main",
+      new DefaultArtifactVersion("10.0"), chunkyVersion, "test10.Main", "test10.MainHeadless",
       Collections.emptySet()
     ));
     manifests.add(new PluginManifest(null, "test9", "author9", "desc9",
-      new DefaultArtifactVersion("9.0"), chunkyVersion, "test9.Main",
+      new DefaultArtifactVersion("9.0"), chunkyVersion, "test9.Main", "test9.MainHeadless",
       Set.of(
         new PluginDependency("test8", VersionRange.createFromVersionSpec("[8.0]")),
         new PluginDependency("test7", VersionRange.createFromVersionSpec("[7.0]"))
       )
     ));
     manifests.add(new PluginManifest(null, "test8", "author8", "desc8",
-      new DefaultArtifactVersion("8.0"), chunkyVersion, "test8.Main",
+      new DefaultArtifactVersion("8.0"), chunkyVersion, "test8.Main", "test8.MainHeadless",
       Set.of(
         new PluginDependency("test5", VersionRange.createFromVersionSpec("[5.0]"))
       )
     ));
     manifests.add(new PluginManifest(null, "test7", "author7", "desc7",
-      new DefaultArtifactVersion("7.0"), chunkyVersion, "test7.Main",
+      new DefaultArtifactVersion("7.0"), chunkyVersion, "test7.Main", "test7.MainHeadless",
       Set.of(
         new PluginDependency("test4", VersionRange.createFromVersionSpec("[4.0]")),
         new PluginDependency("test2", VersionRange.createFromVersionSpec("[2.0]"))
       )
     ));
     manifests.add(new PluginManifest(null, "test6", "author6", "desc6",
-      new DefaultArtifactVersion("6.0"), chunkyVersion, "test6.Main",
+      new DefaultArtifactVersion("6.0"), chunkyVersion, "test6.Main", "test6.MainHeadless",
       Set.of(
         new PluginDependency("test7", VersionRange.createFromVersionSpec("[7.0]")),
         new PluginDependency("test3", VersionRange.createFromVersionSpec("[3.0]"))
       )
     ));
     manifests.add(new PluginManifest(null, "test5", "author5", "desc5",
-      new DefaultArtifactVersion("5.0"), chunkyVersion, "test5.Main",
+      new DefaultArtifactVersion("5.0"), chunkyVersion, "test5.Main", "test5.MainHeadless",
       Set.of(
         new PluginDependency("test4", VersionRange.createFromVersionSpec("[4.0]"))
       )
     ));
     manifests.add(new PluginManifest(null, "test4", "author4", "desc4",
-      new DefaultArtifactVersion("4.0"), chunkyVersion, "test4.Main",
+      new DefaultArtifactVersion("4.0"), chunkyVersion, "test4.Main", "test4.MainHeadless",
       Set.of(
         new PluginDependency("test10", VersionRange.createFromVersionSpec("[10.0]"))
       )
     ));
     manifests.add(new PluginManifest(null, "test3", "author3", "desc3",
-      new DefaultArtifactVersion("3.0"), chunkyVersion, "test3.Main",
+      new DefaultArtifactVersion("3.0"), chunkyVersion, "test3.Main", "test3.MainHeadless",
       Set.of(
         new PluginDependency("test2", VersionRange.createFromVersionSpec("[2.0]"))
       )
     ));
     manifests.add(new PluginManifest(null, "test2", "author2", "desc2",
-      new DefaultArtifactVersion("2.0"), chunkyVersion, "test2.Main",
+      new DefaultArtifactVersion("2.0"), chunkyVersion, "test2.Main", "test2.MainHeadless",
       Set.of(
         new PluginDependency("test10", VersionRange.createFromVersionSpec("[10.0]"))
       )
     ));
     manifests.add(new PluginManifest(null, "test1", "author1", "desc1",
-      new DefaultArtifactVersion("1.0"), chunkyVersion, "test1.Main",
+      new DefaultArtifactVersion("1.0"), chunkyVersion, "test1.Main", "test1.MainHeadless",
       Set.of(
         new PluginDependency("test9", VersionRange.createFromVersionSpec("[9.0]")),
         new PluginDependency("test6", VersionRange.createFromVersionSpec("[6.0]"))
@@ -164,7 +165,7 @@ private static void assertLoadOrder(Set<PluginManifest> manifests, Set<String> e
       loadedPlugins.add(pluginManifest.name);
     });
 
-    pluginLoader.load(manifests, (plugin, manifest) -> {});
+    pluginLoader.load(manifests, (plugin, manifest) -> {}, new PluginLoaderContext(true));
     assertEquals(expectedPlugins, loadedPlugins);
   }
 }