JAL-4344 careful application of -Djava.awt.headless=true to avoid Jmol problem. Using...
[jalview.git] / src / jalview / bin / Launcher.java
index ef50c91..507f501 100644 (file)
@@ -50,30 +50,15 @@ public class Launcher
 {
   private final static String startClass = "jalview.bin.Jalview";
 
+  // not setting this yet due to problem with Jmol
   private final static String headlessProperty = "java.awt.headless";
 
-  private static boolean checkJVMSymlink(String testBin)
-  {
-    File testBinFile = new File(testBin);
-    if (!testBinFile.exists())
-    {
-      return false;
-    }
-    File targetFile = null;
-    try
-    {
-      targetFile = testBinFile.getCanonicalFile();
-    } catch (IOException e)
-    {
-      return false;
-    }
-    if (targetFile != null && ("java".equals(targetFile.getName())
-            || "java.exe".equals(targetFile.getName())))
-    {
-      return true;
-    }
-    return false;
-  }
+  // used for headless macOS
+  private final static String macosHeadlessProperty = "apple.awt.UIElement";
+
+  // arguments that assume headless mode
+  private final static String[] assumeHeadlessArgs = { "headless", "output",
+      "image", "structureimage" };
 
   /**
    * main method for jalview.bin.Launcher. This restarts the same JRE's JVM with
@@ -87,42 +72,12 @@ public class Launcher
   {
     if (!LaunchUtils.checkJavaVersion())
     {
-      System.err.println("WARNING - The Java version being used (Java "
-              + LaunchUtils.getJavaVersion()
-              + ") may lead to problems. This installation of Jalview should be used with Java "
-              + LaunchUtils.getJavaCompileVersion() + ".");
-    }
-    final String appName = ChannelProperties.getProperty("app_name");
-    final String javaBinDir = System.getProperty("java.home")
-            + File.separator + "bin" + File.separator;
-    String javaBin = null;
-    if (javaBin == null && checkJVMSymlink(javaBinDir + appName))
-    {
-      javaBin = javaBinDir + appName;
-    }
-    if (javaBin == null && checkJVMSymlink(javaBinDir + "Jalview"))
-    {
-      javaBin = javaBinDir + "Jalview";
-    }
-    if (javaBin == null)
-    {
-      javaBin = "java";
-    }
-
-    List<String> command = new ArrayList<>();
-    command.add(javaBin);
-
-    String memSetting = null;
-
-    boolean isAMac = System.getProperty("os.name").indexOf("Mac") > -1;
-
-    for (String jvmArg : ManagementFactory.getRuntimeMXBean()
-            .getInputArguments())
-    {
-      command.add(jvmArg);
+      jalview.bin.Console
+              .errPrintln("WARNING - The Java version being used (Java "
+                      + LaunchUtils.getJavaVersion()
+                      + ") may lead to problems. This installation of Jalview should be used with Java "
+                      + LaunchUtils.getJavaCompileVersion() + ".");
     }
-    command.add("-cp");
-    command.add(ManagementFactory.getRuntimeMXBean().getClassPath());
 
     String jvmmempc = null;
     String jvmmemmax = null;
@@ -130,47 +85,82 @@ public class Launcher
     boolean wait = true;
     boolean quiet = false;
     boolean headless = false;
+    boolean assumeheadless = false;
     boolean gui = false;
+    boolean help = false;
+    boolean stdout = false;
     // must set --debug before --launcher...
     boolean launcherstop = false;
     boolean launcherprint = false;
     boolean launcherwait = false;
     ArrayList<String> arguments = new ArrayList<>();
+    String previousArg = null;
+    // set debug first
     for (String arg : args)
     {
       if (arg.equals("--debug"))
       {
         debug = true;
       }
+    }
+    for (String arg : args)
+    {
       if (arg.equals("--quiet"))
       {
         quiet = true;
       }
-      if (arg.equals("--headless"))
+      else if (arg.equals("--gui"))
       {
-        headless = true;
+        gui = true;
       }
-      if (arg.equals("--gui"))
+      else if (arg.equals("--help"))
       {
-        gui = true;
+        help = true;
       }
-      if (debug && arg.equals("--launcherprint"))
+      else if (arg.equals("--version"))
       {
-        launcherprint = true;
+        help = true;
       }
-      if (debug && arg.equals("--launcherstop"))
+
+      if (!assumeheadless)
       {
-        launcherstop = true;
+        for (String a : assumeHeadlessArgs)
+        {
+          if (arg.equals("--" + a) || arg.startsWith("--" + a + "="))
+          {
+            assumeheadless = true;
+          }
+        }
       }
-      if (debug && arg.equals("--launcherwait"))
+
+      if (arg.equals("--output=-")
+              || (arg.equals("-") && "--output".equals(previousArg)))
       {
-        launcherwait = true;
+        stdout = true;
       }
-      // this ends the launcher immediately
-      if (debug && arg.equals("--launchernowait"))
+
+      if (debug)
       {
-        wait = false;
+        if (arg.equals("--launcherprint"))
+        {
+          launcherprint = true;
+        }
+        else if (arg.equals("--launcherstop"))
+        {
+          launcherstop = true;
+        }
+        else if (arg.equals("--launcherwait"))
+        {
+          launcherwait = true;
+        }
+        else
+        // this ends the launcher immediately
+        if (arg.equals("--launchernowait"))
+        {
+          wait = false;
+        }
       }
+      previousArg = arg;
       // Don't add the --launcher... args to Jalview launch
       if (arg.startsWith("--launcher"))
       {
@@ -211,11 +201,39 @@ public class Launcher
         arguments.add(arg);
       }
     }
-    if (gui)
+    if (help)
+    {
+      // --help takes precedence over --gui
+      headless = true;
+    }
+    else if (gui)
     {
       // --gui takes precedence over --headless
       headless = false;
     }
+    else
+    {
+      // --output arguments assume headless mode
+      headless = assumeheadless;
+    }
+
+    final String appName = ChannelProperties.getProperty("app_name");
+
+    // if we're using jalview.bin.Launcher we always assume a console is in use
+    final String javaBin = LaunchUtils.findJavaBin(true);
+
+    List<String> command = new ArrayList<>();
+    command.add(javaBin);
+
+    String memSetting = null;
+
+    for (String jvmArg : ManagementFactory.getRuntimeMXBean()
+            .getInputArguments())
+    {
+      command.add(jvmArg);
+    }
+    command.add("-cp");
+    command.add(ManagementFactory.getRuntimeMXBean().getClassPath());
 
     // use saved preferences if no cmdline args
     boolean useCustomisedSettings = LaunchUtils
@@ -239,6 +257,7 @@ public class Launcher
     boolean dockIcon = false;
     boolean dockName = false;
     boolean headlessProp = false;
+    boolean macosHeadlessProp = false;
     for (int i = 0; i < command.size(); i++)
     {
       String arg = command.get(i);
@@ -263,6 +282,10 @@ public class Launcher
       {
         headlessProp = true;
       }
+      else if (arg.startsWith("-D" + macosHeadlessProperty + "="))
+      {
+        macosHeadlessProp = true;
+      }
     }
 
     if (!memSet)
@@ -277,7 +300,7 @@ public class Launcher
       }
     }
 
-    if (isAMac)
+    if (LaunchUtils.isMac)
     {
       if (!dockIcon)
       {
@@ -290,9 +313,6 @@ public class Launcher
         // -Xdock:name=... doesn't actually work :(
         // Leaving it in in case it gets fixed
         command.add("-Xdock:name=" + appName);
-        // this launches WITHOUT an icon in the macOS dock. Could be useful for
-        // getdown?
-        // command.add("-Dapple.awt.UIElement=false");
         // This also does not work for the dock
         command.add("-Dcom.apple.mrj.application.apple.menu.about.name="
                 + appName);
@@ -301,13 +321,22 @@ public class Launcher
     if (headless && !headlessProp)
     {
       System.setProperty(headlessProperty, "true");
-      command.add("-D" + headlessProperty + "=true");
+      /* not setting this in java invocation of running jalview due to problem with Jmol */
+      if (help)
+      {
+        command.add("-D" + headlessProperty + "=true");
+      }
+    }
+    if (headless && LaunchUtils.isMac && !macosHeadlessProp)
+    {
+      System.setProperty(macosHeadlessProperty, "true");
+      command.add("-D" + macosHeadlessProperty + "=true");
     }
 
     String scalePropertyArg = HiDPISetting.getScalePropertyArg();
     if (scalePropertyArg != null)
     {
-      sysout(debug, quiet, "Running " + startClass + " with scale setting "
+      syserr(debug, quiet, "Running " + startClass + " with scale setting "
               + scalePropertyArg);
       command.add(scalePropertyArg);
     }
@@ -320,10 +349,10 @@ public class Launcher
     if ((Boolean.parseBoolean(System.getProperty("launcherprint", "false"))
             || launcherprint))
     {
-      sysout(debug, quiet,
+      syserr(debug, quiet,
               "LAUNCHER COMMAND: " + String.join(" ", builder.command()));
     }
-    sysout(debug, quiet,
+    syserr(debug, quiet,
             "Running " + startClass + " with "
                     + (memSetting == null ? "no memory setting"
                             : ("memory setting " + memSetting)));
@@ -331,7 +360,7 @@ public class Launcher
     if (Boolean.parseBoolean(System.getProperty("launcherstop", "false"))
             || (debug && launcherstop))
     {
-      sysout(debug, quiet,
+      syserr(debug, quiet,
               "System property 'launcherstop' is set and not 'false'. Exiting.");
       System.exit(0);
     }
@@ -341,22 +370,23 @@ public class Launcher
       Process process = builder.start();
       if (wait || launcherwait)
       {
-        sysout(debug, quiet, "Launching application process");
+        syserr(debug, quiet, "Launching application process");
         process.waitFor();
       }
       else
       {
         int waitInt = 0;
-        sysout(debug, quiet,
+        syserr(debug, quiet,
                 "Wait time for application process is " + waitInt + "ms");
         process.waitFor(waitInt, TimeUnit.MILLISECONDS);
       }
-      sysout(debug, quiet, "Launcher process ending");
+      syserr(debug, quiet, "Launcher process ending");
     } catch (IOException e)
     {
       if (e.getMessage().toLowerCase(Locale.ROOT).contains("memory"))
       {
-        System.err.println("Caught a memory exception: " + e.getMessage());
+        jalview.bin.Console
+                .errPrintln("Caught a memory exception: " + e.getMessage());
         // Probably the "Cannot allocate memory" error, try without the memory
         // setting
         ArrayList<String> commandNoMem = new ArrayList<>();
@@ -369,7 +399,7 @@ public class Launcher
         }
         final ProcessBuilder builderNoMem = new ProcessBuilder(
                 commandNoMem);
-        System.err.println("Command without memory setting: "
+        jalview.bin.Console.errPrintln("Command without memory setting: "
                 + String.join(" ", builderNoMem.command()));
         try
         {
@@ -391,11 +421,11 @@ public class Launcher
     }
   }
 
-  private static void sysout(boolean debug, boolean quiet, String message)
+  private static void syserr(boolean debug, boolean quiet, String message)
   {
     if (debug && !quiet)
     {
-      System.out.println("LAUNCHERDEBUG - " + message);
+      jalview.bin.Console.errPrintln("LAUNCHERDEBUG - " + message);
     }
   }