Merge commit 'alpha/update_2_12_for_2_11_2_series_merge^2' into HEAD
[jalview.git] / src / jalview / bin / Jalview.java
index 75504be..290f920 100755 (executable)
@@ -21,6 +21,7 @@
 package jalview.bin;
 
 import java.awt.GraphicsEnvironment;
+
 import java.io.BufferedReader;
 import java.io.File;
 import java.io.FileOutputStream;
@@ -38,11 +39,15 @@ import java.security.PermissionCollection;
 import java.security.Permissions;
 import java.security.Policy;
 import java.util.HashMap;
+import java.util.Locale;
 import java.util.Map;
 import java.util.Vector;
+import java.util.logging.ConsoleHandler;
+import java.util.logging.Level;
+import java.util.logging.Logger;
 
-import javax.swing.LookAndFeel;
 import javax.swing.UIManager;
+import javax.swing.UIManager.LookAndFeelInfo;
 
 import com.threerings.getdown.util.LaunchUtil;
 
@@ -70,6 +75,8 @@ import jalview.io.NewickFile;
 import jalview.io.gff.SequenceOntologyFactory;
 import jalview.schemes.ColourSchemeI;
 import jalview.schemes.ColourSchemeProperty;
+import jalview.util.ChannelProperties;
+import jalview.util.HttpUtils;
 import jalview.util.MessageManager;
 import jalview.util.Platform;
 import jalview.ws.jws2.Jws2Discoverer;
@@ -91,7 +98,6 @@ import jalview.ws.jws2.Jws2Discoverer;
  */
 public class Jalview implements ApplicationSingletonI
 {
-
   // for testing those nasty messages you cannot ever find.
   // static
   // {
@@ -116,9 +122,9 @@ public class Jalview implements ApplicationSingletonI
 
   private Jalview()
   {
+    Platform.getURLCommandArguments();
   }
 
-  private boolean headless;
 
   private Desktop desktop;
 
@@ -154,9 +160,12 @@ public class Jalview implements ApplicationSingletonI
 
   static
   {
-    if (Platform.isJS()) {
-        Platform.getURLCommandArguments();
-    } else /** @j2sIgnore */
+    if (!Platform.isJS())
+    /**
+     * Java only
+     * 
+     * @j2sIgnore
+     */
     {
       // grab all the rights we can for the JVM
       Policy.setPolicy(new Policy()
@@ -186,8 +195,8 @@ public class Jalview implements ApplicationSingletonI
   class FeatureFetcher
   {
     /*
-     * TODO: generalise to track all jalview events to orchestrate batch
-     * processing events.
+     * TODO: generalise to track all jalview events to orchestrate batch processing
+     * events.
      */
 
     private int queued = 0;
@@ -250,8 +259,13 @@ public class Jalview implements ApplicationSingletonI
     {
       Platform.startJavaLogging();
     }
+
     getInstance().doMain(args);
+
   }
+  
+
+  
 
   /**
    * @param args
@@ -291,12 +305,10 @@ public class Jalview implements ApplicationSingletonI
     Cache.getInstance().loadBuildProperties(true);
 
     ArgsParser aparser = new ArgsParser(args);
-    headless = false;
+    boolean headless = false;
 
     String usrPropsFile = aparser.getValue("props");
-
     Cache.loadProperties(usrPropsFile); // must do this before
-
     boolean allowServices = true;
     
     if (isJS)
@@ -308,6 +320,7 @@ public class Jalview implements ApplicationSingletonI
       appletResourcePath = (String) aparser.getAppletValue("resourcepath",
               null, true);
     }
+
     else
     /**
      * Java only
@@ -315,7 +328,6 @@ public class Jalview implements ApplicationSingletonI
      * @j2sIgnore
      */
     {
-
       if (usrPropsFile != null)
       {
         System.out.println(
@@ -338,6 +350,7 @@ public class Jalview implements ApplicationSingletonI
         }
         headless = true;
       }
+      // anything else!
 
       final String jabawsUrl = aparser.getValue(ArgsParser.JABAWS);
       allowServices = !("none".equals(jabawsUrl));
@@ -374,6 +387,11 @@ public class Jalview implements ApplicationSingletonI
       }
       defs = aparser.getValue("setprop");
     }
+    if (System.getProperty("java.awt.headless") != null
+            && System.getProperty("java.awt.headless").equals("true"))
+    {
+      headless = true;
+    }
     System.setProperty("http.agent",
             "Jalview Desktop/" + Cache.getDefault("VERSION", "Unknown"));
     try
@@ -387,56 +405,10 @@ public class Jalview implements ApplicationSingletonI
       System.exit(0);
     }
 
-    if (!isJS)
-    /** @j2sIgnore */
-    {
-      try
-      {
-        UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
-      } catch (Exception ex)
-      {
-        System.err.println("Unexpected Look and Feel Exception");
-        ex.printStackTrace();
-      }
-      if (Platform.isMac())
-      {
+    desktop = null;
+
+    setLookAndFeel();
 
-        LookAndFeel lookAndFeel = ch.randelshofer.quaqua.QuaquaManager
-                .getLookAndFeel();
-        System.setProperty(
-                "com.apple.mrj.application.apple.menu.about.name",
-                "Jalview");
-        System.setProperty("apple.laf.useScreenMenuBar", "true");
-        if (lookAndFeel != null)
-        {
-          try
-          {
-            UIManager.setLookAndFeel(lookAndFeel);
-          } catch (Throwable e)
-          {
-            System.err.println(
-                    "Failed to set QuaQua look and feel: " + e.toString());
-          }
-        }
-        if (lookAndFeel == null
-                || !(lookAndFeel.getClass().isAssignableFrom(
-                        UIManager.getLookAndFeel().getClass()))
-                || !UIManager.getLookAndFeel().getClass().toString()
-                        .toLowerCase().contains("quaqua"))
-        {
-          try
-          {
-            System.err.println(
-                    "Quaqua LaF not available on this plaform. Using VAqua(4).\nSee https://issues.jalview.org/browse/JAL-2976");
-            UIManager.setLookAndFeel("org.violetlib.aqua.AquaLookAndFeel");
-          } catch (Throwable e)
-          {
-            System.err.println(
-                    "Failed to reset look and feel: " + e.toString());
-          }
-        }
-      }
-    }
     /*
      * configure 'full' SO model if preferences say to, else use the default (full SO)
      * - as JS currently doesn't have OBO parsing, it must use 'Lite' version
@@ -444,29 +416,43 @@ public class Jalview implements ApplicationSingletonI
     boolean soDefault = !isJS;
     if (Cache.getDefault("USE_FULL_SO", soDefault))
     {
-      SequenceOntologyFactory.setSequenceOntology(new SequenceOntology());
+      SequenceOntologyFactory.setInstance(new SequenceOntology());
     }
 
-
-    desktop = null;
     if (!headless)
     {
+      Desktop.nosplash = aparser.contains("nosplash");
       desktop = Desktop.getInstance();
       desktop.setInBatchMode(true); // indicate we are starting up
+
       try
       {
         JalviewTaskbar.setTaskbar(this);
+      } catch (Exception e)
+      {
+        Cache.log.info("Cannot set Taskbar");
+        Cache.log.error(e.getMessage());
+        // e.printStackTrace();
       } catch (Throwable t)
       {
-        System.out.println("Error setting Taskbar: " + t.getMessage());
+        Cache.log.info("Cannot set Taskbar");
+        Cache.log.error(t.getMessage());
+        // t.printStackTrace();
       }
+      // set Proxy settings before all the internet calls
+      Cache.setProxyPropertiesFromPreferences();
+
       desktop.setVisible(true);
-      if (Platform.isJS())
+
+      if (isJS)
+      {
         Cache.setProperty("SHOW_JWS2_SERVICES", "false");
-      if (allowServices)
+      }
+      if (allowServices && !aparser.contains("nowebservicediscovery"))
       {
         desktop.startServiceDiscovery();
       }
+
       if (!isJS)
       /**
        * Java only
@@ -504,7 +490,7 @@ public class Jalview implements ApplicationSingletonI
               // String defurl =
               // "http://anaplog.compbio.dundee.ac.uk/cgi-bin/questionnaire.pl";
               // //
-              String defurl = "http://www.jalview.org/cgi-bin/questionnaire.pl";
+              String defurl = "https://www.jalview.org/cgi-bin/questionnaire.pl";
               Cache.log.debug(
                       "Starting questionnaire with default url: " + defurl);
               desktop.checkForQuestionnaire(defurl);
@@ -568,7 +554,6 @@ public class Jalview implements ApplicationSingletonI
       // completed one way or another
       // extract groovy argument and execute if necessary
       groovyscript = aparser.getValue("groovy", true);
-
     }
 
     String file = aparser.getValue("open", true);
@@ -578,11 +563,9 @@ public class Jalview implements ApplicationSingletonI
       System.out.println("No files to open!");
       System.exit(1);
     }
-
     setDisplayParameters(aparser);
     
     // time to open a file.
-
     long progress = -1;
     DataSourceType protocol = null;
     FileLoader fileLoader = new FileLoader(!headless);
@@ -666,8 +649,7 @@ public class Jalview implements ApplicationSingletonI
        * @j2sIgnore
        */
       {
-        if (!file.startsWith("http://") && !file.startsWith("https://"))
-        // BH 2019 added https check for Java
+        if (!HttpUtils.startsWithHttpOrHttps(file))
         {
           if (!(new File(file)).exists())
           {
@@ -679,11 +661,13 @@ public class Jalview implements ApplicationSingletonI
           }
         }
       }
-      
+
+      // JS Only argument to provide a format parameter to specify what format to use
       String fileFormat = (isJS
               ? (String) aparser.getAppletValue("format", null, true)
               : null);
       protocol = AppletFormatAdapter.checkProtocol(file);
+
       try
       {
         format = (fileFormat != null
@@ -706,7 +690,7 @@ public class Jalview implements ApplicationSingletonI
       }
       else
       {
-
+        
         // JalviewLite interface for JavaScript allows second file open
         String file2 = aparser.getValue(ArgsParser.OPEN2, true);
         if (file2 != null)
@@ -735,6 +719,7 @@ public class Jalview implements ApplicationSingletonI
                     "CMD [-open2 " + file2 + "] executed successfully!");
           }
         }
+        // af is loaded - so set it as current frame
         setCurrentAlignFrame(af);
 
         setFrameDependentProperties(aparser, af);
@@ -777,8 +762,12 @@ public class Jalview implements ApplicationSingletonI
     {
       if (Cache.groovyJarsPresent())
       {
+        // TODO: DECIDE IF THIS SECOND PASS AT GROOVY EXECUTION IS STILL REQUIRED !!
         System.out.println("Executing script " + groovyscript);
         executeGroovyScript(groovyscript, af);
+        System.out.println("CMD groovy[" + groovyscript
+                    + "] executed successfully!");
+
       }
       else
       {
@@ -982,13 +971,14 @@ public class Jalview implements ApplicationSingletonI
    */
   private void createOutputFiles(ArgsParser aparser, FileFormatI format)
   {
+    // logic essentially the same as 2.11.2/2.11.3 but uses a switch instead
     AlignFrame af = currentAlignFrame;
     while (aparser.getSize() >= 2)
     {
       String outputFormat = aparser.nextValue();
       File imageFile;
       String fname;
-      switch (outputFormat.toLowerCase())
+      switch (outputFormat.toLowerCase(Locale.ROOT))
       {
       case "png":
         imageFile = new File(aparser.nextValue());
@@ -1083,6 +1073,208 @@ public class Jalview implements ApplicationSingletonI
     }
   }
 
+  private static void setLookAndFeel()
+  {
+    // property laf = "crossplatform", "system", "gtk", "metal", "nimbus" or
+    // "mac"
+    // If not set (or chosen laf fails), use the normal SystemLaF and if on Mac,
+    // try Quaqua/Vaqua.
+    String lafProp = System.getProperty("laf");
+    String lafSetting = Cache.getDefault("PREFERRED_LAF", null);
+    String laf = "none";
+    if (lafProp != null)
+    {
+      laf = lafProp;
+    }
+    else if (lafSetting != null)
+    {
+      laf = lafSetting;
+    }
+    boolean lafSet = false;
+    switch (laf)
+    {
+    case "crossplatform":
+      lafSet = setCrossPlatformLookAndFeel();
+      if (!lafSet)
+      {
+        Cache.log.error("Could not set requested laf=" + laf);
+      }
+      break;
+    case "system":
+      lafSet = setSystemLookAndFeel();
+      if (!lafSet)
+      {
+        Cache.log.error("Could not set requested laf=" + laf);
+      }
+      break;
+    case "gtk":
+      lafSet = setGtkLookAndFeel();
+      if (!lafSet)
+      {
+        Cache.log.error("Could not set requested laf=" + laf);
+      }
+      break;
+    case "metal":
+      lafSet = setMetalLookAndFeel();
+      if (!lafSet)
+      {
+        Cache.log.error("Could not set requested laf=" + laf);
+      }
+      break;
+    case "nimbus":
+      lafSet = setNimbusLookAndFeel();
+      if (!lafSet)
+      {
+        Cache.log.error("Could not set requested laf=" + laf);
+      }
+      break;
+    case "quaqua":
+      lafSet = setQuaquaLookAndFeel();
+      if (!lafSet)
+      {
+        Cache.log.error("Could not set requested laf=" + laf);
+      }
+      break;
+    case "vaqua":
+      lafSet = setVaquaLookAndFeel();
+      if (!lafSet)
+      {
+        Cache.log.error("Could not set requested laf=" + laf);
+      }
+      break;
+    case "mac":
+      lafSet = setMacLookAndFeel();
+      if (!lafSet)
+      {
+        Cache.log.error("Could not set requested laf=" + laf);
+      }
+      break;
+    case "none":
+      break;
+    default:
+      Cache.log.error("Requested laf=" + laf + " not implemented");
+    }
+    if (!lafSet)
+    {
+      setSystemLookAndFeel();
+      if (Platform.isLinux())
+      {
+        setMetalLookAndFeel();
+      }
+      if (Platform.isMac())
+      {
+        setMacLookAndFeel();
+      }
+    }
+  }
+
+  private static boolean setCrossPlatformLookAndFeel()
+  {
+    boolean set = false;
+    try
+    {
+      UIManager.setLookAndFeel(
+              UIManager.getCrossPlatformLookAndFeelClassName());
+      set = true;
+    } catch (Exception ex)
+    {
+      Cache.log.error("Unexpected Look and Feel Exception");
+      Cache.log.error(ex.getMessage());
+      Cache.log.debug(Cache.getStackTraceString(ex));
+    }
+    return set;
+  }
+
+  private static boolean setSystemLookAndFeel()
+  {
+    boolean set = false;
+    try
+    {
+      UIManager.setLookAndFeel(UIManager.getSystemLookAndFeelClassName());
+      set = true;
+    } catch (Exception ex)
+    {
+      Cache.log.error("Unexpected Look and Feel Exception");
+      Cache.log.error(ex.getMessage());
+      Cache.log.debug(Cache.getStackTraceString(ex));
+    }
+    return set;
+  }
+
+  private static boolean setSpecificLookAndFeel(String name,
+          String className, boolean nameStartsWith)
+  {
+    boolean set = false;
+    try
+    {
+      for (LookAndFeelInfo info : UIManager.getInstalledLookAndFeels())
+      {
+        if (info.getName() != null && nameStartsWith
+                ? info.getName().toLowerCase(Locale.ROOT)
+                        .startsWith(name.toLowerCase(Locale.ROOT))
+                : info.getName().toLowerCase(Locale.ROOT).equals(name.toLowerCase(Locale.ROOT)))
+        {
+          className = info.getClassName();
+          break;
+        }
+      }
+      UIManager.setLookAndFeel(className);
+      set = true;
+    } catch (Exception ex)
+    {
+      Cache.log.error("Unexpected Look and Feel Exception");
+      Cache.log.error(ex.getMessage());
+      Cache.log.debug(Cache.getStackTraceString(ex));
+    }
+    return set;
+  }
+
+  private static boolean setGtkLookAndFeel()
+  {
+    return setSpecificLookAndFeel("gtk",
+            "com.sun.java.swing.plaf.gtk.GTKLookAndFeel", true);
+  }
+
+  private static boolean setMetalLookAndFeel()
+  {
+    return setSpecificLookAndFeel("metal",
+            "javax.swing.plaf.metal.MetalLookAndFeel", false);
+  }
+
+  private static boolean setNimbusLookAndFeel()
+  {
+    return setSpecificLookAndFeel("nimbus",
+            "javax.swing.plaf.nimbus.NimbusLookAndFeel", false);
+  }
+
+  private static boolean setQuaquaLookAndFeel()
+  {
+    return setSpecificLookAndFeel("quaqua",
+            ch.randelshofer.quaqua.QuaquaManager.getLookAndFeel().getClass()
+                    .getName(),
+            false);
+  }
+
+  private static boolean setVaquaLookAndFeel()
+  {
+    return setSpecificLookAndFeel("vaqua",
+            "org.violetlib.aqua.AquaLookAndFeel", false);
+  }
+
+  private static boolean setMacLookAndFeel()
+  {
+    boolean set = false;
+    System.setProperty("com.apple.mrj.application.apple.menu.about.name",
+            ChannelProperties.getProperty("app_name"));
+    System.setProperty("apple.laf.useScreenMenuBar", "true");
+    set = setQuaquaLookAndFeel();
+    if ((!set) || !UIManager.getLookAndFeel().getClass().toString()
+            .toLowerCase(Locale.ROOT).contains("quaqua"))
+    {
+      set = setVaquaLookAndFeel();
+    }
+    return set;
+  }
   private static void showUsage()
   {
     System.out.println(
@@ -1121,7 +1313,9 @@ public class Jalview implements ApplicationSingletonI
                     + "-jabaws URL\tSpecify URL for Jabaws services (e.g. for a local installation).\n"
                     + "-fetchfrom nickname\tQuery nickname for features for the alignments and display them.\n"
                     + "-groovy FILE\tExecute groovy script in FILE, after all other arguments have been processed (if FILE is the text 'STDIN' then the file will be read from STDIN)\n"
-                    + "\n~Read documentation in Application or visit http://www.jalview.org for description of Features and Annotations file~\n\n");
+                    + "-jvmmempc=PERCENT\tOnly available with standalone executable jar or jalview.bin.Launcher. Limit maximum heap size (memory) to PERCENT% of total physical memory detected. This defaults to 90 if total physical memory can be detected. See https://www.jalview.org/help/html/memory.html for more details.\n"
+                    + "-jvmmemmax=MAXMEMORY\tOnly available with standalone executable jar or jalview.bin.Launcher. Limit maximum heap size (memory) to MAXMEMORY. MAXMEMORY can be specified in bytes, kilobytes(k), megabytes(m), gigabytes(g) or if you're lucky enough, terabytes(t). This defaults to 32g if total physical memory can be detected, or to 8g if total physical memory cannot be detected. See https://www.jalview.org/help/html/memory.html for more details.\n"
+                    + "\n~Read documentation in Application or visit https://www.jalview.org for description of Features and Annotations file~\n\n");
   }
 
   private static void startUsageStats(final Desktop desktop)
@@ -1291,8 +1485,8 @@ public class Jalview implements ApplicationSingletonI
   }
 
   /**
-   * Quit method delegates to Desktop.quit - unless running in headless mode
-   * when it just ends the JVM
+   * Quit method delegates to Desktop.quit - unless running in headless mode when
+   * it just ends the JVM
    */
   public void quit()
   {
@@ -1315,7 +1509,6 @@ public class Jalview implements ApplicationSingletonI
   {
     Jalview.getInstance().currentAlignFrame = currentAlignFrame;
   }
-
   
   public void notifyWorker(AlignCalcWorkerI worker, String status)
   {
@@ -1335,5 +1528,4 @@ public class Jalview implements ApplicationSingletonI
   {
     isInteractive = tf;
   }
-
 }