X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=getdown%2Fsrc%2Fgetdown%2Fcore%2Fsrc%2Fmain%2Fjava%2Fcom%2Fthreerings%2Fgetdown%2Fdata%2FApplication.java;h=313a690eece4eb6bf35d495d1f716ad5729ed336;hb=e0fff6b634346ca2d0256d95eacc1b0aae7d3387;hp=501407c0f541a2c639b27303085d5f20d6adeb40;hpb=f517e5ea31f1749617ac191137891cf87111550b;p=jalview.git diff --git a/getdown/src/getdown/core/src/main/java/com/threerings/getdown/data/Application.java b/getdown/src/getdown/core/src/main/java/com/threerings/getdown/data/Application.java index 501407c..313a690 100644 --- a/getdown/src/getdown/core/src/main/java/com/threerings/getdown/data/Application.java +++ b/getdown/src/getdown/core/src/main/java/com/threerings/getdown/data/Application.java @@ -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,14 +26,18 @@ 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+ 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; @@ -42,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"; @@ -65,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 defaultPercents; @@ -99,6 +115,9 @@ public class Application /** The paths (relative to the appdir) of images for the window icon. */ public final List iconImages; + /** The path (relative to the appdir) to a single background image to appear first. */ + public final String instantBackgroundImage; + /** The path (relative to the appdir) to a single background image. */ public final String backgroundImage; @@ -138,6 +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. */ @@ -151,12 +185,14 @@ public class Application @Override public String toString () { - return "[name=" + name + ", bg=" + background + ", bg=" + backgroundImage + + return "[name=" + name + ", bg=" + background + ", bg=" + backgroundImage + ", instant_bg=" + instantBackgroundImage + ", pi=" + progressImage + ", prect=" + progress + ", pt=" + progressText + ", pb=" + progressBar + ", srect=" + status + ", st=" + statusText + ", shadow=" + textShadow + ", err=" + installError + ", nrect=" + patchNotes + ", notes=" + patchNotesUrl + ", stepPercentages=" + stepPercentages + - ", hideProgressText" + hideProgressText + ", minShow=" + minShowSeconds + "]"; + ", hideProgressText=" + hideProgressText + ", keepOnTop=" + keepOnTop + ", progressSync=" + progressSync + + ", progressSyncAfterShown=" + progressSyncAfterShown + ", minShow=" + minShowSeconds + + ", displayAppbase=" + displayAppbase + ", displayVersion=" + displayVersion + "]"; } public UpdateInterface (Config config) @@ -164,7 +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)); @@ -172,6 +213,7 @@ public class Application this.textShadow = config.getColor("ui.text_shadow", Color.CLEAR); this.hideDecorations = config.getBoolean("ui.hide_decorations"); this.backgroundImage = config.getString("ui.background_image"); + this.instantBackgroundImage = config.getString("ui.instant_background_image"); // default to black or white bg color, depending on the brightness of the progressText int defaultBackground = (0.5f < Color.brightness(this.progressText)) ? Color.BLACK : Color.WHITE; @@ -246,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; } /** @@ -263,7 +306,7 @@ public class Application */ public boolean useCodeCache () { - return _useCodeCache; + return _useCodeCache; } /** @@ -272,7 +315,7 @@ public class Application */ public int getCodeCacheRetentionDays () { - return _codeCacheRetentionDays; + return _codeCacheRetentionDays; } /** @@ -280,7 +323,7 @@ public class Application * app files from its hosting server. */ public int maxConcurrentDownloads () { - return _maxConcDownloads; + return _maxConcDownloads; } /** @@ -288,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); + } } /** @@ -300,7 +343,7 @@ public class Application */ public List getCodeResources () { - return _codes; + return _codes; } /** @@ -311,6 +354,11 @@ public class Application return _resources; } + public List getDigestOnly () + { + return _digestonly; + } + /** * Returns the digest of the given {@code resource}. */ @@ -448,7 +496,8 @@ public class Application return null; } - String vmfile = LaunchUtil.LOCAL_JAVA_DIR + ".jar"; + String extension = (_javaLocation.endsWith(".tgz"))?".tgz":".jar"; + String vmfile = LaunchUtil.LOCAL_JAVA_DIR + extension; log.info("vmfile is '"+vmfile+"'"); System.out.println("vmfile is '"+vmfile+"'"); try { @@ -545,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); @@ -564,7 +632,28 @@ 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); + } + 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); + + // 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 @@ -580,6 +669,12 @@ 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"); + + // see if locatorConfig override + if (locatorConfig != null && !StringUtil.isBlank(locatorConfig.getString("appbase"))) { + _appbase = locatorConfig.getString("appbase"); + } + if (_appbase == null) { throw new RuntimeException("m.missing_appbase"); } @@ -682,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(); @@ -702,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 codes = new ArrayList<>(); @@ -724,37 +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) { - final Object o = ManagementFactory.getOperatingSystemMXBean(); - - try { - if (o instanceof OperatingSystemMXBean) { - final OperatingSystemMXBean osb = (OperatingSystemMXBean) o; - long physicalMem = osb.getTotalPhysicalMemorySize(); - long requestedMem = physicalMem*jvmmempc/100; - String[] maxMemHeapArg = new String[]{"-Xmx"+Long.toString(requestedMem)}; - // 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); - - } - } - catch (NoClassDefFoundError e) { - // com.sun.management.OperatingSystemMXBean doesn't exist in this JVM - System.out.println("No com.sun.management.OperatingSystemMXBean. Cannot use 'jvmmempc'."); - } - } 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 @@ -766,7 +840,7 @@ public class Application // add the launch specific application arguments _appargs.addAll(_envc.appArgs); - + // look for custom arguments fillAssignmentListFromPairs("extra.txt", _txtJvmArgs); @@ -789,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; } @@ -1000,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? @@ -1017,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)); @@ -1042,6 +1212,27 @@ public class Application args.add(_class); } + // almost finally check the startup file arguments + for (File f : _startupFiles) { + _appargs.add(f.getAbsolutePath()); + break; // Only add one file to open + } + + // check if one arg with recognised extension + if ( _appargs.size() == 1 && _appargs.get(0) != null ) { + String filename = _appargs.get(0); + String ext = null; + int j = filename.lastIndexOf('.'); + if (j > -1) { + ext = filename.substring(j+1); + } + 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"); + } + } + // finally add the application arguments for (String string : _appargs) { args.add(processArg(string)); @@ -1236,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. " + @@ -1760,8 +1953,105 @@ 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.startsWith("jalview://") || filename.startsWith("jalviews://")) { + setJalviewUri(filename); + } else if (! filename.toLowerCase().endsWith("."+Application.LOCATOR_FILE_EXTENSION)) { + addStartupFile(filename); + } + } + } + } + + public static void setLocatorFile(String filename) { + _locatorFile = new File(filename); + } + + public static void addStartupFile(String filename) { + _startupFiles.add(new File(filename)); + } + + public static void setJalviewUri(String uri) { + _jalviewUri = uri; + } + + private Config createLocatorConfig(Config.ParseOpts opts) { + if (_locatorFile == null) { + return null; + } + + Config locatorConfig = null; + + try { + Config tmpConfig = null; + Map tmpData = new HashMap<>(); + if (_locatorFile.exists()) { + tmpConfig = Config.parseConfig(_locatorFile, opts); + // appbase is sanitised in HostWhitelist + Map tmpConfigData = tmpConfig.getData(); + if (tmpConfig != null) { + for (Map.Entry 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); + } + + locatorConfig = new Config(tmpData); + + } catch (Exception e) { + log.warning("Failure reading locator file", "file", _locatorFile, e); + } + + return locatorConfig; + } + + public String getAppbase() { + return _appbase; + } + protected final EnvConfig _envc; protected File _config; + protected File _backupConfig; protected Digest _digest; protected long _version = -1; @@ -1794,6 +2084,7 @@ public class Application protected List _codes = new ArrayList<>(); protected List _resources = new ArrayList<>(); + protected List _digestonly = new ArrayList<>(); protected boolean _useCodeCache; protected int _codeCacheRetentionDays; @@ -1823,4 +2114,16 @@ public class Application protected static final String ENV_VAR_PREFIX = "%ENV."; protected static final Pattern ENV_VAR_PATTERN = Pattern.compile("%ENV\\.(.*?)%"); + + protected static File _locatorFile; + protected static List _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; }