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 static boolean checkJVMSymlink(String testBin)
  54   {
  55     File testBinFile = new File(testBin);
  56     if (!testBinFile.exists())
  57     {
  58       return false;
  59     }
  60     File targetFile = null;
  61     try
  62     {
  63       targetFile = testBinFile.getCanonicalFile();
  64     } catch (IOException e)
  65     {
  66       return false;
  67     }
  68     if (targetFile != null && ("java".equals(targetFile.getName())
  69             || "java.exe".equals(targetFile.getName())))
  70     {
  71       return true;
  72     }
  73     return false;
  74   }
  75
  76   /**
  77    * main method for jalview.bin.Launcher. This restarts the same JRE's JVM with
  78    * the same arguments but with memory adjusted based on extracted -jvmmempc
  79    * and -jvmmemmax application arguments. If on a Mac then extra dock:icon and
  80    * dock:name arguments are also set.
  81    *
  82    * @param args
  83    */
  84   public static void main(String[] args)
  85   {
  86     if (!LaunchUtils.checkJavaVersion())
  87     {
  88       System.err.println("WARNING - The Java version being used (Java "
  89               + LaunchUtils.getJavaVersion()
  90               + ") may lead to problems. This installation of Jalview should be used with Java "
  91               + LaunchUtils.getJavaCompileVersion() + ".");
  92     }
  93     final String appName = ChannelProperties.getProperty("app_name");
  94     final String javaBinDir = System.getProperty("java.home")
  95             + File.separator + "bin" + File.separator;
  96     String javaBin = null;
  97     if (javaBin == null && checkJVMSymlink(javaBinDir + appName))
  98     {
  99       javaBin = javaBinDir + appName;
 100     }
 101     if (javaBin == null && checkJVMSymlink(javaBinDir + "Jalview"))
 102     {
 103       javaBin = javaBinDir + "Jalview";
 104     }
 105     if (javaBin == null)
 106     {
 107       javaBin = "java";
 108     }
 109
 110     List<String> command = new ArrayList<>();
 111     command.add(javaBin);
 112
 113     String memSetting = null;
 114
 115     boolean isAMac = System.getProperty("os.name").indexOf("Mac") > -1;
 116
 117     for (String jvmArg : ManagementFactory.getRuntimeMXBean()
 118             .getInputArguments())
 119     {
 120       command.add(jvmArg);
 121     }
 122     command.add("-cp");
 123     command.add(ManagementFactory.getRuntimeMXBean().getClassPath());
 124
 125     String jvmmempc = null;
 126     String jvmmemmax = null;
 127     boolean debug = false;
 128     boolean wait = true;
 129     boolean quiet = false;
 130     // must set --debug before --launcher...
 131     boolean launcherstop = false;
 132     boolean launcherprint = false;
 133     boolean launcherwait = false;
 134     ArrayList<String> arguments = new ArrayList<>();
 135     for (String arg : args)
 136     {
 137       if (arg.equals("--debug"))
 138       {
 139         debug = true;
 140       }
 141       if (arg.equals("--quiet"))
 142       {
 143         quiet = true;
 144       }
 145       if (debug && arg.equals("--launcherprint"))
 146       {
 147         launcherprint = true;
 148       }
 149       if (debug && arg.equals("--launcherstop"))
 150       {
 151         launcherstop = true;
 152       }
 153       if (debug && arg.equals("--launcherwait"))
 154       {
 155         launcherwait = true;
 156       }
 157       // this ends the launcher immediately
 158       if (debug && arg.equals("--launchernowait"))
 159       {
 160         wait = false;
 161       }
 162       // Don't add the --launcher... args to Jalview launch
 163       if (arg.startsWith("--launcher"))
 164       {
 165         continue;
 166       }
 167       // jvmmempc and jvmmemmax args used to set memory and are not passed on to
 168       // startClass
 169       if (arg.startsWith(
 170               "-" + MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME + "="))
 171       {
 172         jvmmempc = arg.substring(
 173                 MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME.length()
 174                         + 2);
 175       }
 176       else if (arg.startsWith(
 177               "-" + MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME + "="))
 178       {
 179         jvmmemmax = arg.substring(
 180                 MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME.length() + 2);
 181       }
 182       // --doubledash versions
 183       else if (arg.startsWith("--"
 184               + MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME + "="))
 185       {
 186         jvmmempc = arg.substring(
 187                 MemorySetting.MAX_HEAPSIZE_PERCENT_PROPERTY_NAME.length()
 188                         + 3);
 189       }
 190       else if (arg.startsWith(
 191               "--" + MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME + "="))
 192       {
 193         jvmmemmax = arg.substring(
 194                 MemorySetting.MAX_HEAPSIZE_PROPERTY_NAME.length() + 3);
 195       }
 196       // retain arg
 197       else
 198       {
 199         arguments.add(arg);
 200       }
 201     }
 202
 203     // use saved preferences if no cmdline args
 204     boolean useCustomisedSettings = LaunchUtils
 205             .getBooleanUserPreference(MemorySetting.CUSTOMISED_SETTINGS);
 206     if (useCustomisedSettings)
 207     {
 208       if (jvmmempc == null)
 209       {
 210         jvmmempc = LaunchUtils
 211                 .getUserPreference(MemorySetting.MEMORY_JVMMEMPC);
 212       }
 213       if (jvmmemmax == null)
 214       {
 215         jvmmemmax = LaunchUtils
 216                 .getUserPreference(MemorySetting.MEMORY_JVMMEMMAX);
 217       }
 218     }
 219
 220     // add these settings if not already specified
 221     boolean memSet = false;
 222     boolean dockIcon = false;
 223     boolean dockName = false;
 224     for (int i = 0; i < command.size(); i++)
 225     {
 226       String arg = command.get(i);
 227       if (arg.startsWith("-Xmx"))
 228       {
 229         // only use -Xmx if jvmmemmax and jvmmempc have not been set
 230         if (jvmmempc == null && jvmmemmax == null)
 231         {
 232           memSetting = arg;
 233           memSet = true;
 234         }
 235       }
 236       else if (arg.startsWith("-Xdock:icon"))
 237       {
 238         dockIcon = true;
 239       }
 240       else if (arg.startsWith("-Xdock:name"))
 241       {
 242         dockName = true;
 243       }
 244     }
 245
 246     if (!memSet)
 247     {
 248       long maxMemLong = MemorySetting.getMemorySetting(jvmmemmax, jvmmempc);
 249
 250       if (maxMemLong > 0)
 251       {
 252         memSetting = "-Xmx" + Long.toString(maxMemLong);
 253         memSet = true;
 254         command.add(memSetting);
 255       }
 256     }
 257
 258     if (isAMac)
 259     {
 260       if (!dockIcon)
 261       {
 262         String dockIconPath = System.getProperty("getdownappdir", ".")
 263                 + File.separator + "resource/jalview_logo.png";
 264         command.add("-Xdock:icon=" + dockIconPath);
 265       }
 266       if (!dockName)
 267       {
 268         // -Xdock:name=... doesn't actually work :(
 269         // Leaving it in in case it gets fixed
 270         command.add("-Xdock:name=" + appName);
 271         // this launches WITHOUT an icon in the macOS dock. Could be useful for
 272         // getdown?
 273         // command.add("-Dapple.awt.UIElement=false");
 274         // This also does not work for the dock
 275         command.add("-Dcom.apple.mrj.application.apple.menu.about.name="
 276                 + appName);
 277       }
 278     }
 279
 280     String scalePropertyArg = HiDPISetting.getScalePropertyArg();
 281     if (scalePropertyArg != null)
 282     {
 283       sysout(debug, quiet, "Running " + startClass + " with scale setting "
 284               + scalePropertyArg);
 285       command.add(scalePropertyArg);
 286     }
 287
 288     command.add(startClass);
 289     command.addAll(arguments);
 290
 291     final ProcessBuilder builder = new ProcessBuilder(command);
 292
 293     if ((Boolean.parseBoolean(System.getProperty("launcherprint", "false"))
 294             || launcherprint))
 295     {
 296       sysout(debug, quiet,
 297               "LAUNCHER COMMAND: " + String.join(" ", builder.command()));
 298     }
 299     sysout(debug, quiet,
 300             "Running " + startClass + " with "
 301                     + (memSetting == null ? "no memory setting"
 302                             : ("memory setting " + memSetting)));
 303
 304     if (Boolean.parseBoolean(System.getProperty("launcherstop", "false"))
 305             || (debug && launcherstop))
 306     {
 307       sysout(debug, quiet,
 308               "System property 'launcherstop' is set and not 'false'. Exiting.");
 309       System.exit(0);
 310     }
 311     try
 312     {
 313       builder.inheritIO();
 314       Process process = builder.start();
 315       if (wait || launcherwait)
 316       {
 317         sysout(debug, quiet, "Launching application process");
 318         process.waitFor();
 319       }
 320       else
 321       {
 322         int waitInt = 0;
 323         sysout(debug, quiet,
 324                 "Wait time for application process is " + waitInt + "ms");
 325         process.waitFor(waitInt, TimeUnit.MILLISECONDS);
 326       }
 327       sysout(debug, quiet, "Launcher process ending");
 328     } catch (IOException e)
 329     {
 330       if (e.getMessage().toLowerCase(Locale.ROOT).contains("memory"))
 331       {
 332         System.err.println("Caught a memory exception: " + e.getMessage());
 333         // Probably the "Cannot allocate memory" error, try without the memory
 334         // setting
 335         ArrayList<String> commandNoMem = new ArrayList<>();
 336         for (int i = 0; i < command.size(); i++)
 337         {
 338           if (!command.get(i).startsWith("-Xmx"))
 339           {
 340             commandNoMem.add(command.get(i));
 341           }
 342         }
 343         final ProcessBuilder builderNoMem = new ProcessBuilder(
 344                 commandNoMem);
 345         System.err.println("Command without memory setting: "
 346                 + String.join(" ", builderNoMem.command()));
 347         try
 348         {
 349           builderNoMem.inheritIO();
 350           Process processNoMem = builderNoMem.start();
 351           processNoMem.waitFor();
 352         } catch (Exception ex)
 353         {
 354           ex.printStackTrace();
 355         }
 356       }
 357       else
 358       {
 359         e.printStackTrace();
 360       }
 361     } catch (Exception e)
 362     {
 363       e.printStackTrace();
 364     }
 365   }
 366
 367   private static void sysout(boolean debug, boolean quiet, String message)
 368   {
 369     if (debug && !quiet)
 370     {
 371       System.out.println("LAUNCHERDEBUG - " + message);
 372     }
 373   }
 374
 375 }