JAL-3820 JAL-3830 improvements to script launching. Icon on macOS. Fixed CLASSPATH.
[jalview.git] / src / jalview / bin / Launcher.java
index 61b87e3..a87d322 100644 (file)
@@ -26,6 +26,7 @@ import java.lang.management.ManagementFactory;
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Locale;
+import java.util.concurrent.TimeUnit;
 
 import jalview.util.ChannelProperties;
 import jalview.util.LaunchUtils;
@@ -49,8 +50,28 @@ public class Launcher
 {
   private final static String startClass = "jalview.bin.Jalview";
 
-  private final static String dockIconPath = ChannelProperties
-          .getProperty("logo.512");
+  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;
+  }
 
   /**
    * main method for jalview.bin.Launcher. This restarts the same JRE's JVM with
@@ -69,9 +90,22 @@ public class Launcher
               + ") may lead to problems. This installation of Jalview should be used with Java "
               + LaunchUtils.getJavaCompileVersion() + ".");
     }
-
-    final String javaBin = System.getProperty("java.home") + File.separator
-            + "bin" + File.separator + "java";
+    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);
@@ -90,9 +124,46 @@ public class Launcher
 
     String jvmmempc = null;
     String jvmmemmax = null;
+    boolean debug = false;
+    boolean wait = true;
+    boolean quiet = false;
+    // must set --debug before --launcher...
+    boolean launcherstop = false;
+    boolean launcherprint = false;
+    boolean launcherwait = false;
     ArrayList<String> arguments = new ArrayList<>();
     for (String arg : args)
     {
+      if (arg.equals("--debug"))
+      {
+        debug = true;
+      }
+      if (arg.equals("--quiet"))
+      {
+        quiet = true;
+      }
+      if (debug && arg.equals("--launcherprint"))
+      {
+        launcherprint = true;
+      }
+      if (debug && arg.equals("--launcherstop"))
+      {
+        launcherstop = true;
+      }
+      if (debug && arg.equals("--launcherwait"))
+      {
+        launcherwait = true;
+      }
+      // this ends the launcher immediately
+      if (debug && arg.equals("--launchernowait"))
+      {
+        wait = false;
+      }
+      // Don't add the --launcher... args to Jalview launch
+      if (arg.startsWith("--launcher"))
+      {
+        continue;
+      }
       // jvmmempc and jvmmemmax args used to set memory and are not passed on to
       // startClass
       if (arg.startsWith(
@@ -146,7 +217,7 @@ public class Launcher
       }
     }
 
-    // add memory setting if not specified
+    // add these settings if not already specified
     boolean memSet = false;
     boolean dockIcon = false;
     boolean dockName = false;
@@ -188,27 +259,28 @@ public class Launcher
     {
       if (!dockIcon)
       {
+        String dockIconPath = System.getProperty("getdownappdir", ".")
+                + File.separator + "resource/jalview_logo.png";
         command.add("-Xdock:icon=" + dockIconPath);
       }
       if (!dockName)
       {
         // -Xdock:name=... doesn't actually work :(
         // Leaving it in in case it gets fixed
-        command.add(
-                "-Xdock:name=" + ChannelProperties.getProperty("app_name"));
+        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="
-                + ChannelProperties.getProperty("app_name"));
+                + appName);
       }
     }
 
     String scalePropertyArg = HiDPISetting.getScalePropertyArg();
     if (scalePropertyArg != null)
     {
-      System.out.println("Running " + startClass + " with scale setting "
+      sysout(debug, quiet, "Running " + startClass + " with scale setting "
               + scalePropertyArg);
       command.add(scalePropertyArg);
     }
@@ -218,18 +290,21 @@ public class Launcher
 
     final ProcessBuilder builder = new ProcessBuilder(command);
 
-    if (Boolean.parseBoolean(System.getProperty("launcherprint", "false")))
+    if ((Boolean.parseBoolean(System.getProperty("launcherprint", "false"))
+            || launcherprint))
     {
-      System.out.println(
+      sysout(debug, quiet,
               "LAUNCHER COMMAND: " + String.join(" ", builder.command()));
     }
-    System.out.println("Running " + startClass + " with "
-            + (memSetting == null ? "no memory setting"
-                    : ("memory setting " + memSetting)));
+    sysout(debug, quiet,
+            "Running " + startClass + " with "
+                    + (memSetting == null ? "no memory setting"
+                            : ("memory setting " + memSetting)));
 
-    if (Boolean.parseBoolean(System.getProperty("launcherstop", "false")))
+    if (Boolean.parseBoolean(System.getProperty("launcherstop", "false"))
+            || (debug && launcherstop))
     {
-      System.out.println(
+      sysout(debug, quiet,
               "System property 'launcherstop' is set and not 'false'. Exiting.");
       System.exit(0);
     }
@@ -237,12 +312,24 @@ public class Launcher
     {
       builder.inheritIO();
       Process process = builder.start();
-      process.waitFor();
+      if (wait || launcherwait)
+      {
+        sysout(debug, quiet, "Launching application process");
+        process.waitFor();
+      }
+      else
+      {
+        int waitInt = 0;
+        sysout(debug, quiet,
+                "Wait time for application process is " + waitInt + "ms");
+        process.waitFor(waitInt, TimeUnit.MILLISECONDS);
+      }
+      sysout(debug, quiet, "Launcher process ending");
     } catch (IOException e)
     {
       if (e.getMessage().toLowerCase(Locale.ROOT).contains("memory"))
       {
-        System.out.println("Caught a memory exception: " + e.getMessage());
+        System.err.println("Caught a memory exception: " + e.getMessage());
         // Probably the "Cannot allocate memory" error, try without the memory
         // setting
         ArrayList<String> commandNoMem = new ArrayList<>();
@@ -255,7 +342,7 @@ public class Launcher
         }
         final ProcessBuilder builderNoMem = new ProcessBuilder(
                 commandNoMem);
-        System.out.println("Command without memory setting: "
+        System.err.println("Command without memory setting: "
                 + String.join(" ", builderNoMem.command()));
         try
         {
@@ -277,4 +364,12 @@ public class Launcher
     }
   }
 
+  private static void sysout(boolean debug, boolean quiet, String message)
+  {
+    if (debug && !quiet)
+    {
+      System.out.println("LAUNCHERDEBUG - " + message);
+    }
+  }
+
 }