JAL-3718 force re-initialise of getdown.txt file when new getdown.txt downloaded...
[jalview.git] / getdown / src / getdown / core / src / main / java / com / threerings / getdown / data / Application.java
index 3497b21..313a690 100644 (file)
@@ -9,9 +9,12 @@ import java.io.*;
 import java.lang.reflect.Method;
 import java.net.MalformedURLException;
 import java.net.Proxy;
+import java.net.URI;
+import java.net.URISyntaxException;
 import java.net.URL;
 import java.net.URLClassLoader;
 import java.net.URLConnection;
+import java.net.URLDecoder;
 import java.net.URLEncoder;
 import java.nio.channels.FileChannel;
 import java.nio.channels.FileLock;
@@ -23,10 +26,10 @@ import java.util.concurrent.*;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 import java.util.zip.GZIPInputStream;
-import com.sun.management.OperatingSystemMXBean;
-import java.lang.management.ManagementFactory;
 
+import jalview.bin.HiDPISetting;
 import jalview.bin.MemorySetting;
+//import com.install4j.api.launcher.Variables;
 
 import com.threerings.getdown.util.*;
 // avoid ambiguity with java.util.Base64 which we can't use as it's 1.8+
@@ -46,6 +49,9 @@ public class Application
 {
     /** The name of our configuration file. */
     public static final String CONFIG_FILE = "getdown.txt";
+    
+    /** Dir where a backup config file might reside */ 
+    public static final String BACKUP_CONFIG_DIR = "install";
 
     /** The name of our target version file. */
     public static final String VERSION_FILE = "version.txt";
@@ -69,14 +75,20 @@ public class Application
          */
         public enum Step
         {
-            UPDATE_JAVA(10),
-            VERIFY_METADATA(15, 65, 95),
-            DOWNLOAD(40),
+            //UPDATE_JAVA(10),
+            UPDATE_JAVA(20),
+            //VERIFY_METADATA(15, 65, 95),
+            VERIFY_METADATA(15, 45, 90),
+            DOWNLOAD(60),
             PATCH(60),
-            VERIFY_RESOURCES(70, 97),
-            REDOWNLOAD_RESOURCES(90),
-            UNPACK(98),
-            LAUNCH(99);
+            //VERIFY_RESOURCES(70, 97),
+            VERIFY_RESOURCES(40, 90),
+            //REDOWNLOAD_RESOURCES(90),
+            REDOWNLOAD_RESOURCES(80),
+            //UNPACK(98),
+            UNPACK(95),
+            //LAUNCH(99);
+            LAUNCH(100);
 
             /** What is the final percent value for this step? */
             public final List<Integer> defaultPercents;
@@ -145,12 +157,21 @@ public class Application
         /** Whether progress text should be hidden or not. */
         public final boolean hideProgressText;
 
+        /** Whether the splash screen should update non-asynchronously before being shown. */
+        public final boolean progressSync;
+
+        /** Whether the splash screen should update non-asynchronously after being shown. */
+        public final boolean progressSyncAfterShown;
+
         /** Whether the splash screen should retain focus. */
         public final boolean keepOnTop;
 
         /** Whether to display the appbase. */
         public final boolean displayAppbase;
 
+        /** Whether to display the version. */
+        public final boolean displayVersion;
+
         /** The minimum number of seconds to display the GUI. This is to prevent the GUI from
           * flashing up on the screen and immediately disappearing, which can be confusing to the
           * user. */
@@ -169,7 +190,9 @@ public class Application
                 ", pb=" + progressBar + ", srect=" + status + ", st=" + statusText +
                 ", shadow=" + textShadow + ", err=" + installError + ", nrect=" + patchNotes +
                 ", notes=" + patchNotesUrl + ", stepPercentages=" + stepPercentages +
-                ", hideProgressText=" + hideProgressText + ", keepOnTop=" + keepOnTop + ", minShow=" + minShowSeconds + "]";
+                ", hideProgressText=" + hideProgressText + ", keepOnTop=" + keepOnTop + ", progressSync=" + progressSync +
+                ", progressSyncAfterShown=" + progressSyncAfterShown + ", minShow=" + minShowSeconds +
+                ", displayAppbase=" + displayAppbase + ", displayVersion=" + displayVersion + "]";
         }
 
         public UpdateInterface (Config config)
@@ -177,9 +200,12 @@ public class Application
             this.name = config.getString("ui.name");
             this.progress = config.getRect("ui.progress", new Rectangle(5, 5, 300, 15));
             this.progressText = config.getColor("ui.progress_text", Color.BLACK);
-            this.hideProgressText =  config.getBoolean("ui.hide_progress_text");
+            this.hideProgressText = config.getBoolean("ui.hide_progress_text");
+            this.progressSync = config.getBoolean("ui.progress_sync_before_shown");
+            this.progressSyncAfterShown = config.getBoolean("ui.progress_sync_after_shown");
             this.keepOnTop =  config.getBoolean("ui.keep_on_top");
             this.displayAppbase =  config.getBoolean("ui.display_appbase");
+            this.displayVersion =  config.getBoolean("ui.display_version");
             this.minShowSeconds = config.getInt("ui.min_show_seconds", 5);
             this.progressBar = config.getColor("ui.progress_bar", 0x6699CC);
             this.status = config.getRect("ui.status", new Rectangle(5, 25, 500, 100));
@@ -262,15 +288,16 @@ public class Application
      *
      */
     public Application (EnvConfig envc) {
-        _envc = envc;
-        _config = getLocalPath(envc.appDir, CONFIG_FILE);
+       _envc = envc;
+       _config = getLocalPath(envc.appDir, CONFIG_FILE);
+       _backupConfig = getLocalPath(envc.appDir, BACKUP_CONFIG_DIR+File.separator+CONFIG_FILE);
     }
 
     /**
      * Returns the configured application directory.
      */
     public File getAppDir () {
-        return _envc.appDir;
+       return _envc.appDir;
     }
 
     /**
@@ -279,7 +306,7 @@ public class Application
      */
     public boolean useCodeCache ()
     {
-        return _useCodeCache;
+       return _useCodeCache;
     }
 
     /**
@@ -288,7 +315,7 @@ public class Application
      */
     public int getCodeCacheRetentionDays ()
     {
-        return _codeCacheRetentionDays;
+       return _codeCacheRetentionDays;
     }
 
     /**
@@ -296,7 +323,7 @@ public class Application
      * app files from its hosting server.
      */
     public int maxConcurrentDownloads () {
-        return _maxConcDownloads;
+       return _maxConcDownloads;
     }
 
     /**
@@ -304,11 +331,11 @@ public class Application
      */
     public Resource getConfigResource ()
     {
-        try {
-            return createResource(CONFIG_FILE, Resource.NORMAL);
-        } catch (Exception e) {
-            throw new RuntimeException("Invalid appbase '" + _vappbase + "'.", e);
-        }
+       try {
+               return createResource(CONFIG_FILE, Resource.NORMAL);
+       } catch (Exception e) {
+               throw new RuntimeException("Invalid appbase '" + _vappbase + "'.", e);
+       }
     }
 
     /**
@@ -316,7 +343,7 @@ public class Application
      */
     public List<Resource> getCodeResources ()
     {
-        return _codes;
+       return _codes;
     }
 
     /**
@@ -327,6 +354,11 @@ public class Application
         return _resources;
     }
 
+    public List<Resource> getDigestOnly ()
+    {
+        return _digestonly;
+    }
+
     /**
      * Returns the digest of the given {@code resource}.
      */
@@ -562,6 +594,25 @@ public class Application
     public Config init (boolean checkPlatform)
         throws IOException
     {
+       if (_initialised && _initialisedConfig != null)
+       {
+               return _initialisedConfig;
+       }
+       
+        try {
+          Application.i4jVersion = com.install4j.api.launcher.Variables.getCompilerVariable("sys.install4jVersion");
+        } catch (IOException e)
+        {
+          System.err.println("install4j version not available");
+        } catch (NoClassDefFoundError e)
+        {
+          log.warning("Starting without install4j classes");
+        } catch (Throwable t)
+        {
+          System.err.println("install4j not available");
+          t.printStackTrace();
+        }
+
         Config config = null;
         File cfgfile = _config;
         Config.ParseOpts opts = Config.createOpts(checkPlatform);
@@ -583,6 +634,15 @@ public class Application
         } catch (Exception e) {
             log.warning("Failure reading config file", "file", _config, e);
         }
+        if (config == null || config.getString("appbase") == null || config.getString("appbase").isEmpty()) {
+               try {
+                       Config backupConfig = Config.parseConfig(_backupConfig, opts);
+                       config = backupConfig;
+                       log.warning("Using backup config file", "appdir", getAppDir(), "backupConfig", _backupConfig.getAbsoluteFile());
+               } catch (Exception e) {
+                       log.warning("Failure reading backup config file", "file", _backupConfig, e);
+               }
+        }
         
         // see if there's an override config from locator file
         Config locatorConfig = createLocatorConfig(opts);
@@ -717,6 +777,7 @@ public class Application
         // clear our arrays as we may be reinitializing
         _codes.clear();
         _resources.clear();
+        _digestonly.clear();
         _auxgroups.clear();
         _jvmargs.clear();
         _appargs.clear();
@@ -737,6 +798,8 @@ public class Application
         parseResources(config, "presource", Resource.PRELOAD, _resources);
         parseResources(config, "nresource", Resource.NATIVE, _resources);
 
+        parseResources(config, "digestonly", Resource.NORMAL, _digestonly);
+        
         // parse our auxiliary resource groups
         for (String auxgroup : config.getList("auxgroups")) {
             ArrayList<Resource> codes = new ArrayList<>();
@@ -759,43 +822,13 @@ public class Application
             addAll(jvmargs, _jvmargs);
         }
 
-        // see if a percentage of physical memory option exists
-        int jvmmempc = config.getInt("jvmmempc", -1);
+        // see if a percentage of physical memory, or max heap size options exist
+        jvmmempc = config.getString("jvmmempc", null);
+        jvmmemmax = config.getString("jvmmemmax", null);
         // app_id prefixed setting overrides
         if (appPrefix.length() > 0) {
-            jvmmempc = config.getInt(appPrefix + "jvmmempc", jvmmempc);
-        }
-        if (0 <= jvmmempc && jvmmempc <= 100) {
-          
-          long maxMemLong = -1;
-
-          try
-          {
-            maxMemLong = MemorySetting.memPercent(jvmmempc);
-          } catch (Exception e)
-          {
-            e.printStackTrace();
-          } catch (Throwable t)
-          {
-            t.printStackTrace();
-          }
-
-          if (maxMemLong > 0)
-          {
-            
-            String[] maxMemHeapArg = new String[]{"-Xmx"+Long.toString(maxMemLong)};
-            // remove other max heap size arg
-            ARG: for (int i = 0; i < _jvmargs.size(); i++) {
-              if (_jvmargs.get(i) instanceof java.lang.String && _jvmargs.get(i).startsWith("-Xmx")) {
-                _jvmargs.remove(i);
-              }
-            }
-            addAll(maxMemHeapArg, _jvmargs);
-            
-          }
-
-        } else if (jvmmempc != -1) {
-          System.out.println("'jvmmempc' value must be in range 0 to 100 (read as '"+Integer.toString(jvmmempc)+"')");
+            jvmmempc = config.getString(appPrefix + "jvmmempc", jvmmempc);
+            jvmmemmax = config.getString(appPrefix + "jvmmemmax", jvmmemmax);
         }
 
         // get the set of optimum JVM arguments
@@ -830,6 +863,8 @@ public class Application
         _dockName = config.getString("ui.name");
         _dockIconPath = config.getString("ui.mac_dock_icon", "../desktop.icns");
 
+        _initialised = true;
+        _initialisedConfig = config;
         return config;
     }
 
@@ -1041,6 +1076,16 @@ public class Application
 
         // add the marker indicating the app is running in getdown
         args.add("-D" + Properties.GETDOWN + "=true");
+        args.add("-Dsys.install4jVersion=" + Application.i4jVersion);
+        args.add("-Dinstaller_template_version=" + System.getProperty("installer_template_version"));
+        args.add("-Dlauncher_version=" + Build.version());
+
+        // set HiDPI property if wanted
+        String scalePropertyArg = HiDPISetting.getScalePropertyArg();
+        if (scalePropertyArg != null)
+        {
+          args.add(scalePropertyArg);
+        }
 
         // set the native library path if we have native resources
         // @TODO optional getdown.txt parameter to set addCurrentLibraryPath to true or false?
@@ -1058,6 +1103,90 @@ public class Application
             }
         }
 
+        // test for jalview/s URL. Insert startupNotification URI into start of _appargs
+        if (! StringUtil.isBlank(_jalviewUri)) {
+          _appargs.add(0, _jalviewUri);
+        }
+        if (_appargs.size() > 0) {
+          String uri = _appargs.get(0);
+          try {
+            log.info("TRYING TO PARSE URL '"+uri+"'");
+            URI jalviewUri = new URI(uri);
+            if (jalviewUri != null) {
+              String scheme = jalviewUri.getScheme();
+              if (scheme != null && (scheme.equals("jalview") || scheme.equals("jalviews"))) {
+                boolean https = jalviewUri.getScheme().equals("jalviews");
+                String host = jalviewUri.getHost();
+                int port = jalviewUri.getPort();
+                String file = jalviewUri.getPath();
+                String ref = jalviewUri.getFragment();
+                String query = jalviewUri.getQuery();
+                
+                _appargs.clear();
+                _appargs.add("-open");
+                if (host != null && host.length() > 0) {
+                  URL newUrl = new URL(
+                          (https?"https":"http")
+                          + "://"
+                          + host
+                          + (port > -1? String.valueOf(port) : "")
+                          + jalviewUri.getRawPath()
+                          + (query != null && query.length() > 0 ? "?" + jalviewUri.getRawQuery() : "")
+                          );
+                  _appargs.add(newUrl.toString());
+                } else {
+                  _appargs.add(file);
+                }
+                
+                if (ref != null && ref.length() > 0) {
+                  String[] refArgs = ref.split("&");
+                  for (String refArg : refArgs) {
+                    if (refArg.startsWith("jvmmempc=")) {
+                      jvmmempc = refArg.substring(9);
+                      continue;
+                    }
+                    if (refArg.startsWith("jvmmemmax=")) {
+                      jvmmemmax = refArg.substring(10);
+                      continue;
+                    }
+                    _appargs.add(URLDecoder.decode(refArg, "UTF-8"));
+                  }
+                }
+                
+              }
+            }
+          } catch (URISyntaxException e) {
+            log.error("Malformed jalview URI", uri);
+          }
+        }
+        
+        for (String argString: _appargs) {
+          if (argString.startsWith("-jvmmempc=")) {
+            jvmmempc = argString.substring(10);
+            continue;
+          }
+          if (argString.startsWith("-jvmmemmax=")) {
+            jvmmemmax = argString.substring(11);
+            continue;
+          }
+        }
+        
+        // add the memory setting from jvmmempc and jvmmemmax
+        long maxMemLong = -1;
+        maxMemLong = MemorySetting.getMemorySetting(jvmmemmax, jvmmempc);
+        if (maxMemLong > 0)
+        {
+          String[] maxMemHeapArg = new String[]{"-Xmx"+Long.toString(maxMemLong)};
+          // remove other max heap size arg
+          ARG: for (int i = 0; i < _jvmargs.size(); i++) {
+            if (_jvmargs.get(i) instanceof java.lang.String && _jvmargs.get(i).startsWith("-Xmx")) {
+              _jvmargs.remove(i);
+              break ARG;
+            }
+          }
+          addAll(maxMemHeapArg, _jvmargs);
+        }
         // add the JVM arguments
         for (String string : _jvmargs) {
             args.add(processArg(string));
@@ -1097,7 +1226,7 @@ public class Application
           if (j > -1) {
             ext = filename.substring(j+1);
           }
-          if (LOCATOR_FILE_EXTENSION.equals(ext.toLowerCase())) {
+          if (ext != null && LOCATOR_FILE_EXTENSION.equals(ext.toLowerCase())) {
             // this file extension should have been dealt with in Getdown class
           } else {
             _appargs.add(0, "-open");
@@ -1108,7 +1237,7 @@ public class Application
         for (String string : _appargs) {
             args.add(processArg(string));
         }
-        
+
         String[] envp = createEnvironment();
         String[] sargs = args.toArray(new String[args.size()]);
         log.info("Running " + StringUtil.join(sargs, "\n  "));
@@ -1298,6 +1427,8 @@ public class Application
             clearValidationMarkers();
             // if the new copy validates, reinitialize ourselves; otherwise report baffling hoseage
             if (_digest.validateResource(crsrc, null)) {
+                // unset _initialisedConfig so new file is initialised
+                _initialisedConfig = null;
                 init(true);
             } else {
                 log.warning(CONFIG_FILE + " failed to validate even after redownloading. " +
@@ -1854,7 +1985,9 @@ public class Application
         for (int i = 0; i < filenames.length; i++) {
           String filename = filenames[i];
           // skip any other locator files in a multiple file list
-          if (! filename.toLowerCase().endsWith("."+Application.LOCATOR_FILE_EXTENSION)) {
+          if (filename.startsWith("jalview://") || filename.startsWith("jalviews://")) {
+            setJalviewUri(filename);
+          } else if (! filename.toLowerCase().endsWith("."+Application.LOCATOR_FILE_EXTENSION)) {
             addStartupFile(filename);
           }
         }
@@ -1869,6 +2002,10 @@ public class Application
       _startupFiles.add(new File(filename));
     }
     
+    public static void setJalviewUri(String uri) {
+      _jalviewUri = uri;
+    }
+    
     private Config createLocatorConfig(Config.ParseOpts opts) {
       if (_locatorFile == null) {
         return null;
@@ -1878,30 +2015,33 @@ public class Application
       
       try {
         Config tmpConfig = null;
+        Map<String, Object> tmpData = new HashMap<>();
         if (_locatorFile.exists()) {
           tmpConfig = Config.parseConfig(_locatorFile,  opts);
+          // appbase is sanitised in HostWhitelist
+          Map<String, Object> tmpConfigData = tmpConfig.getData();
+          if (tmpConfig != null) {
+            for (Map.Entry<String, Object> entry : tmpConfigData.entrySet()) {
+              String key = entry.getKey();
+              Object value = entry.getValue();
+              String mkey = key.indexOf('.') > -1 ? key.substring(key.indexOf('.') + 1) : key;
+              if (Config.allowedReplaceKeys.contains(mkey) || Config.allowedMergeKeys.contains(mkey)) {
+                tmpData.put(key, value);
+              }
+            }
+          } else {
+            log.warning("Error occurred reading config file", "file", _locatorFile);
+          }
         } else {
           log.warning("Given locator file does not exist", "file", _locatorFile);
         }
         
-        // appbase is sanitised in HostWhitelist
-        Map<String, Object> tmpData = new HashMap<>();
-        for (Map.Entry<String, Object> entry : tmpConfig.getData().entrySet()) {
-          String key = entry.getKey();
-          Object value = entry.getValue();
-          String mkey = key.indexOf('.') > -1 ? key.substring(key.indexOf('.') + 1) : key;
-          if (Config.allowedReplaceKeys.contains(mkey) || Config.allowedMergeKeys.contains(mkey)) {
-            tmpData.put(key, value);
-          }
-        }
         locatorConfig = new Config(tmpData);
         
       } catch (Exception e) {
         log.warning("Failure reading locator file",  "file", _locatorFile, e);
       }
       
-      log.info("Returning locatorConfig", locatorConfig);
-      
       return locatorConfig;
     }
     
@@ -1911,6 +2051,7 @@ public class Application
     
     protected final EnvConfig _envc;
     protected File _config;
+    protected File _backupConfig;
     protected Digest _digest;
 
     protected long _version = -1;
@@ -1943,6 +2084,7 @@ public class Application
 
     protected List<Resource> _codes = new ArrayList<>();
     protected List<Resource> _resources = new ArrayList<>();
+    protected List<Resource> _digestonly = new ArrayList<>();
 
     protected boolean _useCodeCache;
     protected int _codeCacheRetentionDays;
@@ -1975,5 +2117,13 @@ public class Application
  
     protected static File _locatorFile;
     protected static List<File> _startupFiles = new ArrayList<>();
+    protected static String _jalviewUri;
     public static final String LOCATOR_FILE_EXTENSION = "jvl";
+
+    private boolean _initialised = false;
+    private Config _initialisedConfig = null;
+    
+    public static String i4jVersion = null;
+    private String jvmmempc = null;
+    private String jvmmemmax = null;
 }