JAL-3246 JAL-3247 Reworked JVL files as getdown.txt config with limitations
[jalview.git] / getdown / src / getdown / core / src / main / java / com / threerings / getdown / data / Application.java
index 182b057..17e98f8 100644 (file)
@@ -31,6 +31,9 @@ import com.threerings.getdown.util.*;
 // avoid ambiguity with java.util.Base64 which we can't use as it's 1.8+
 import com.threerings.getdown.util.Base64;
 
+import com.threerings.getdown.data.EnvConfig;
+import com.threerings.getdown.data.EnvConfig.Note;
+
 import static com.threerings.getdown.Log.log;
 import static java.nio.charset.StandardCharsets.UTF_8;
 
@@ -565,7 +568,19 @@ public class Application
                 log.info("Found no getdown.txt file", "appdir", getAppDir());
             }
         } catch (Exception e) {
-            log.warning("Failure reading config file", "file", config, e);
+            log.warning("Failure reading config file", "file", _config, e);
+        }
+        
+        // see if there's an override config from locator file
+        Config locatorConfig = createLocatorConfig(opts);
+        
+        // merge the locator file config into config (or replace config with)
+        if (locatorConfig != null) {
+          if (config == null || locatorConfig.getBoolean(LOCATOR_FILE_EXTENSION+"_replace")) {
+            config = locatorConfig;
+          } else {
+            config.mergeConfig(locatorConfig, locatorConfig.getBoolean(LOCATOR_FILE_EXTENSION+"_merge"));
+          }
         }
 
         // if we failed to read our config file, check for an appbase specified via a system
@@ -581,10 +596,7 @@ public class Application
         // first determine our application base, this way if anything goes wrong later in the
         // process, our caller can use the appbase to download a new configuration file
         _appbase = config.getString("appbase");
-        // override if a Version Locator file has been used
-        if (newAppbase != null) {
-          _appbase = newAppbase.toString();
-        }
+        
         if (_appbase == null) {
             throw new RuntimeException("m.missing_appbase");
         }
@@ -1048,7 +1060,7 @@ public class Application
         }
 
         // almost finally check the startup file arguments
-        for (File f : startupFiles) {
+        for (File f : _startupFiles) {
           _appargs.add(f.getAbsolutePath());
           break; // Only add one file to open
         }
@@ -1061,10 +1073,10 @@ public class Application
           if (j > -1) {
             ext = filename.substring(j+1);
           }
-          if (startupFileExtensions.contains(ext.toLowerCase())) {
+          if (LOCATOR_FILE_EXTENSION.equals(ext.toLowerCase())) {
+            // this file extension should have been dealt with in Getdown class
+          } else {
             _appargs.add(0, "-open");
-          } else if (locatorFileExtension.equals(ext.toLowerCase())) {
-            // deal with this when first encountered in Getdown!
           }
         }
 
@@ -1785,18 +1797,86 @@ public class Application
     {
         return new File(appdir, path);
     }
+
+    public static void setStartupFilesFromParameterString(String p) {
+      // multiple files *might* be passed in as space separated quoted filenames
+      String q = "\"";
+      if (!StringUtil.isBlank(p)) {
+        String[] filenames;
+        // split quoted params or treat as single string array
+        if (p.startsWith(q) && p.endsWith(q)) {
+          // this fails if, e.g.
+          // p=q("stupidfilename\" " "otherfilename")
+          // let's hope no-one ever ends a filename with '" '
+          filenames = p.substring(q.length(),p.length()-q.length()).split(q+" "+q);
+        } else {
+          // single unquoted filename
+          filenames = new String[]{p};
+        }
+
+        // check for locator file.  Only allow one locator file to be double clicked (if multiple files opened, ignore locator files)
+        String locatorFilename = filenames.length >= 1 ? filenames[0] : null;
+        if (
+                !StringUtil.isBlank(locatorFilename)
+                && locatorFilename.toLowerCase().endsWith("."+Application.LOCATOR_FILE_EXTENSION)
+                ) {
+          setLocatorFile(locatorFilename);
+          // remove the locator filename from the filenames array
+          String[] otherFilenames = new String[filenames.length - 1];
+          System.arraycopy(filenames, 1, otherFilenames, 0, otherFilenames.length);
+          filenames = otherFilenames;
+        }
+
+        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)) {
+            addStartupFile(filename);
+          }
+        }
+      }
+    }
+    
+    public static void setLocatorFile(String filename) {
+      _locatorFile = new File(filename);
+    }
     
-    public void addStartupFile (File f) {
-      startupFiles.add(f);
+    public static void addStartupFile(String filename) {
+      _startupFiles.add(new File(filename));
     }
 
-    public void newAppbase (URL url) {
-      if ((url.getHost().endsWith(".jalview.org") || url.equals("jalview.org"))) {
-        newAppbase = url;
+    
+    private Config createLocatorConfig(Config.ParseOpts opts) {
+      if (_locatorFile == null) {
+        return null;
+      }
+      
+      Config locatorConfig = null;
+      
+      try {
+        Config tmpConfig = null;
+        if (_locatorFile.exists()) {
+          tmpConfig = Config.parseConfig(_locatorFile,  opts);
+        } else {
+          log.warning("Given locator file does not exist", "file", _locatorFile);
+        }
+        
+        // appbase is sanitised in HostWhitelist and here!
+        Map<String, Object> tmpdata = new HashMap<>();
+        tmpdata.put("appbase", tmpConfig.getString("appbase"));
+        tmpdata.put("appargs", tmpConfig.getString("appargs"));
+        tmpdata.put("jvmargs", tmpConfig.getString("jvmargs"));
+        tmpdata.put(LOCATOR_FILE_EXTENSION+"replace", tmpConfig.getString(LOCATOR_FILE_EXTENSION+"replace"));
+        tmpdata.put(LOCATOR_FILE_EXTENSION+"merge", tmpConfig.getString(LOCATOR_FILE_EXTENSION+"merge"));
+        locatorConfig = new Config(tmpdata);
+        
+      } catch (Exception e) {
+        log.warning("Failure reading locator file",  "file", _locatorFile, e);
       }
-      log.info("Java Version Locator url '"+url.toString()+"' does not have a jalview.org domain. Ignoring");
+      
+      return locatorConfig;
     }
-
+    
     protected final EnvConfig _envc;
     protected File _config;
     protected Digest _digest;
@@ -1840,8 +1920,6 @@ public class Application
 
     protected List<String> _jvmargs = new ArrayList<>();
     protected List<String> _appargs = new ArrayList<>();
-    protected List<File> startupFiles = new ArrayList<>();
-    protected URL newAppbase;
 
     protected String[] _optimumJvmArgs;
 
@@ -1862,7 +1940,8 @@ public class Application
 
     protected static final String ENV_VAR_PREFIX = "%ENV.";
     protected static final Pattern ENV_VAR_PATTERN = Pattern.compile("%ENV\\.(.*?)%");
-    
-    public static final List<String> startupFileExtensions = Arrays.asList(new String[] { "jvp" });
-    public static final String locatorFileExtension = "jvl";
+    protected static File _locatorFile;
+    protected static List<File> _startupFiles = new ArrayList<>();
+    public static final String LOCATOR_FILE_EXTENSION = "jvl";
 }