src/jalview/bin/Launcher.java

   1 /*
   2  * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
   3  * Copyright (C) $$Year-Rel$$ The Jalview Authors
   4  *
   5  * This file is part of Jalview.
   6  *
   7  * Jalview is free software: you can redistribute it and/or
   8  * modify it under the terms of the GNU General Public License
   9  * as published by the Free Software Foundation, either version 3
  10  * of the License, or (at your option) any later version.
  11  *
  12  * Jalview is distributed in the hope that it will be useful, but
  13  * WITHOUT ANY WARRANTY; without even the implied warranty
  14  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  15  * PURPOSE.  See the GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with Jalview.  If not, see <http://www.gnu.org/licenses/>.
  19  * The Jalview Authors are detailed in the 'AUTHORS' file.
  20  */
  21 package jalview.bin;
  22
  23 import java.io.File;
  24 import java.io.IOException;
  25 import java.lang.management.ManagementFactory;
  26 import java.util.ArrayList;
  27 import java.util.List;
  28 import java.util.Locale;
  29 import java.util.concurrent.TimeUnit;
  30
  31 import jalview.util.ChannelProperties;
  32 import jalview.util.LaunchUtils;
  33
  34 /**
  35  * A Launcher class for Jalview. This class is used to launch Jalview from the
  36  * shadowJar when Getdown is not used or available. It attempts to take all the
  37  * command line arguments to pass on to the jalview.bin.Jalview class, but to
  38  * insert a -Xmx memory setting to a sensible default, using the -jvmmempc and
  39  * -jvmmemmax application arguments if specified. If not specified then system
  40  * properties will be looked for by jalview.bin.MemorySetting. If the user has
  41  * provided the JVM with a -Xmx setting directly and not set -jvmmempc or
  42  * -jvmmemmax then this setting will be used and system properties ignored. If
  43  * -Xmx is set as well as -jvmmempc or -jvmmemmax as argument(s) then the -Xmx
  44  * argument will NOT be passed on to the main application launch.
  45  *
  46  * @author bsoares
  47  *
  48  */
  49 public class Launcher
  50 {
  51   private final static String startClass = "jalview.bin.Jalview";
  52
  53   private final static String headlessProperty = "java.awt.headless";
  54
  55   private static boolean checkJVMSymlink(String testBin)
  56   {
  57     File testBinFile = new File(testBin);
  58     if (!testBinFile.exists())
  59     {
  60       return false;
  61     }
  62     File targetFile = null;
  63     try
  64     {
  65       targetFile = testBinFile.getCanonicalFile();
  66     } catch (IOException e)
  67     {
  68       return false;
  69     }
  70     if (targetFile != null && ("java".equals(targetFile.getName())
  71             || "java.exe".equals(targetFile.getName())))
  72     {
  73       return true;
  74     }
  75     return false;
  76   }
  77
  78   /**
  79    * main method for jalview.bin.Launcher. This restarts the same JRE's JVM with
  80    * the same arguments but with memory adjusted based on extracted -jvmmempc
  81    * and -jvmmemmax application arguments. If on a Mac then extra dock:icon and
  82    * dock:name arguments are also set.
  83    *
  84    * @param args
  85    */
  86   public static void main(String[] args)
  87   {
  88     if (!LaunchUtils.checkJavaVersion())
  89     {
  90       System.err.println("WARNING - The Java version being used (Java "
  91               + LaunchUtils.getJavaVersion()
  92               + ") may lead to problems. This installation of Jalview should be used with Java "
  93               + LaunchUtils.getJavaCompileVersion() + ".");
  94     }
  95     final String appName = ChannelProperties.getProperty("app_name");
  96     final String javaBinDir = System.getProperty("java.home")
  97             + File.separator + "bin" + File.separator;
  98     String javaBin = null;
  99     if (javaBin == null && checkJVMSymlink(javaBinDir + appName))
 100     {
 101       javaBin = javaBinDir + appName;
 102     }
 103     if (javaBin == null && checkJVMSymlink(javaBinDir + "Jalview"))
 104     {
 105       javaBin = javaBinDir + "Jalview";
 106     }
 107     if (javaBin == null)
 108     {
 109       javaBin = "java";
 110     }
 111
 112     List<String> command = new ArrayList<>();
 113     command.add(javaBin);
 114
 115     String memSetting = null;
 116
 117     boolean isAMac = System.getProperty("os.name").indexOf("Mac") > -1;
 118
 119     for (String jvmArg : ManagementFactory.getRuntimeMXBean()
 120             .getInputArguments())
 121     {
 122       command.add(jvmArg);
 123     }
 124     command.add("-cp");
 125     command.add(ManagementFactory.getRuntimeMXBean().getClassPath());
 126
 127     String jvmmempc = null;
 128     String jvmmemmax = null;
 129     boolean debug = false;
 130     boolean wait = true;
 131     boolean quiet = false;
 132     boolean headless = false;
 133     // must set --debug before --launcher...
 134     boolean launcherstop = false;
 135     boolean launcherprint = false;
 136     boolean launcherwait = false;
 137     ArrayList<String> arguments = new ArrayList<>();
 138     for (String arg : args)
 139     {
 140       if (arg.equals("--debug"))
 141       {
 142         debug = true;
 143       }
 144       if (arg.equals("--quiet"))
 145       {
 146         quiet = true;
 147       }
 148       if (arg.equals("--headless"))
 149       {
 150         headless = true;
 151       }
 152       if (debug && arg.equals("--launcherprint"))
 153       {
 154         launcherprint = true;
 155       }
 156       if (debug && arg.equals("--launcherstop"))
 157       {
 158         launcherstop = true;
 159       }
 160       if (debug && arg.equals("--launcherwait"))
 161       {
 162         launcherwait = true;
 163       }
 164       // this ends the launcher immediately
 165       if (debug && arg.equals("--launchernowait"))
 166       {
 167         wait = false;
 168       }
 169       // Don't add the --launcher... args to Jalview launch
 170       if (arg.startsWith("--launcher"))
 171       {
 172         continue;
 173       }
 174       // jvmmempc and jvmmemmax args used to set memory and are not passed on to
 175       // startClass
 176       if (arg.startsWith(
 177               "-" + MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME + "="))
 178       {
 179         jvmmempc = arg.substring(
 180                 MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME.length()
 181                         + 2);
 182       }
 183       else if (arg.startsWith(
 184               "-" + MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME + "="))
 185       {
 186         jvmmemmax = arg.substring(
 187                 MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME.length() + 2);
 188       }
 189       // --doubledash versions
 190       else if (arg.startsWith("--"
 191               + MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME + "="))
 192       {
 193         jvmmempc = arg.substring(
 194                 MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME.length()
 195                         + 3);
 196       }
 197       else if (arg.startsWith(
 198               "--" + MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME + "="))
 199       {
 200         jvmmemmax = arg.substring(
 201                 MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME.length() + 3);
 202       }
 203       // retain arg
 204       else
 205       {
 206         arguments.add(arg);
 207       }
 208     }
 209
 210     // use saved preferences if no cmdline args
 211     boolean useCustomisedSettings = LaunchUtils
 212             .getBooleanUserPreference(MemorySetting.CUSTOMISED_SETTINGS);
 213     if (useCustomisedSettings)
 214     {
 215       if (jvmmempc == null)
 216       {
 217         jvmmempc = LaunchUtils
 218                 .getUserPreference(MemorySetting.MEMORY_JVMMEMPC);
 219       }
 220       if (jvmmemmax == null)
 221       {
 222         jvmmemmax = LaunchUtils
 223                 .getUserPreference(MemorySetting.MEMORY_JVMMEMMAX);
 224       }
 225     }
 226
 227     // add these settings if not already specified
 228     boolean memSet = false;
 229     boolean dockIcon = false;
 230     boolean dockName = false;
 231     boolean headlessProp = false;
 232     for (int i = 0; i < command.size(); i++)
 233     {
 234       String arg = command.get(i);
 235       if (arg.startsWith("-Xmx"))
 236       {
 237         // only use -Xmx if jvmmemmax and jvmmempc have not been set
 238         if (jvmmempc == null && jvmmemmax == null)
 239         {
 240           memSetting = arg;
 241           memSet = true;
 242         }
 243       }
 244       else if (arg.startsWith("-Xdock:icon"))
 245       {
 246         dockIcon = true;
 247       }
 248       else if (arg.startsWith("-Xdock:name"))
 249       {
 250         dockName = true;
 251       }
 252       else if (arg.startsWith("-D" + headlessProperty + "="))
 253       {
 254         headlessProp = true;
 255       }
 256     }
 257
 258     if (!memSet)
 259     {
 260       long maxMemLong = MemorySetting.getMemorySetting(jvmmemmax, jvmmempc);
 261
 262       if (maxMemLong > 0)
 263       {
 264         memSetting = "-Xmx" + Long.toString(maxMemLong);
 265         memSet = true;
 266         command.add(memSetting);
 267       }
 268     }
 269
 270     if (isAMac)
 271     {
 272       if (!dockIcon)
 273       {
 274         String dockIconPath = System.getProperty("getdownappdir", ".")
 275                 + File.separator + "resource/jalview_logo.png";
 276         command.add("-Xdock:icon=" + dockIconPath);
 277       }
 278       if (!dockName)
 279       {
 280         // -Xdock:name=... doesn't actually work :(
 281         // Leaving it in in case it gets fixed
 282         command.add("-Xdock:name=" + appName);
 283         // this launches WITHOUT an icon in the macOS dock. Could be useful for
 284         // getdown?
 285         // command.add("-Dapple.awt.UIElement=false");
 286         // This also does not work for the dock
 287         command.add("-Dcom.apple.mrj.application.apple.menu.about.name="
 288                 + appName);
 289       }
 290     }
 291     if (headless && !headlessProp)
 292     {
 293       System.setProperty(headlessProperty, "true");
 294       command.add("-D" + headlessProperty + "=true");
 295     }
 296
 297     String scalePropertyArg = HiDPISetting.getScalePropertyArg();
 298     if (scalePropertyArg != null)
 299     {
 300       sysout(debug, quiet, "Running " + startClass + " with scale setting "
 301               + scalePropertyArg);
 302       command.add(scalePropertyArg);
 303     }
 304
 305     command.add(startClass);
 306     command.addAll(arguments);
 307
 308     final ProcessBuilder builder = new ProcessBuilder(command);
 309
 310     if ((Boolean.parseBoolean(System.getProperty("launcherprint", "false"))
 311             || launcherprint))
 312     {
 313       sysout(debug, quiet,
 314               "LAUNCHER COMMAND: " + String.join(" ", builder.command()));
 315     }
 316     sysout(debug, quiet,
 317             "Running " + startClass + " with "
 318                     + (memSetting == null ? "no memory setting"
 319                             : ("memory setting " + memSetting)));
 320
 321     if (Boolean.parseBoolean(System.getProperty("launcherstop", "false"))
 322             || (debug && launcherstop))
 323     {
 324       sysout(debug, quiet,
 325               "System property 'launcherstop' is set and not 'false'. Exiting.");
 326       System.exit(0);
 327     }
 328     try
 329     {
 330       builder.inheritIO();
 331       Process process = builder.start();
 332       if (wait || launcherwait)
 333       {
 334         sysout(debug, quiet, "Launching application process");
 335         process.waitFor();
 336       }
 337       else
 338       {
 339         int waitInt = 0;
 340         sysout(debug, quiet,
 341                 "Wait time for application process is " + waitInt + "ms");
 342         process.waitFor(waitInt, TimeUnit.MILLISECONDS);
 343       }
 344       sysout(debug, quiet, "Launcher process ending");
 345     } catch (IOException e)
 346     {
 347       if (e.getMessage().toLowerCase(Locale.ROOT).contains("memory"))
 348       {
 349         System.err.println("Caught a memory exception: " + e.getMessage());
 350         // Probably the "Cannot allocate memory" error, try without the memory
 351         // setting
 352         ArrayList<String> commandNoMem = new ArrayList<>();
 353         for (int i = 0; i < command.size(); i++)
 354         {
 355           if (!command.get(i).startsWith("-Xmx"))
 356           {
 357             commandNoMem.add(command.get(i));
 358           }
 359         }
 360         final ProcessBuilder builderNoMem = new ProcessBuilder(
 361                 commandNoMem);
 362         System.err.println("Command without memory setting: "
 363                 + String.join(" ", builderNoMem.command()));
 364         try
 365         {
 366           builderNoMem.inheritIO();
 367           Process processNoMem = builderNoMem.start();
 368           processNoMem.waitFor();
 369         } catch (Exception ex)
 370         {
 371           ex.printStackTrace();
 372         }
 373       }
 374       else
 375       {
 376         e.printStackTrace();
 377       }
 378     } catch (Exception e)
 379     {
 380       e.printStackTrace();
 381     }
 382   }
 383
 384   private static void sysout(boolean debug, boolean quiet, String message)
 385   {
 386     if (debug && !quiet)
 387     {
 388       System.out.println("LAUNCHERDEBUG - " + message);
 389     }
 390   }
 391
 392 }