import java.lang.reflect.Method;
import java.net.MalformedURLException;
import java.net.Proxy;
+import java.net.SocketAddress;
+import java.net.InetSocketAddress;
+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;
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 jalview.util.LaunchUtils;
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;
{
/** 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";
*/
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;
/** The paths (relative to the appdir) of images for the window icon. */
public final List<String> 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;
/** 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. */
@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)
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));
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;
*
*/
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;
}
/**
*/
public boolean useCodeCache ()
{
- return _useCodeCache;
+ return _useCodeCache;
}
/**
*/
public int getCodeCacheRetentionDays ()
{
- return _codeCacheRetentionDays;
+ return _codeCacheRetentionDays;
}
/**
* app files from its hosting server.
*/
public int maxConcurrentDownloads () {
- return _maxConcDownloads;
+ return _maxConcDownloads;
}
/**
*/
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);
+ }
}
/**
*/
public List<Resource> getCodeResources ()
{
- return _codes;
+ return _codes;
}
/**
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);
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
// 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();
+
+ // 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");
}
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
_dockName = config.getString("ui.name");
_dockIconPath = config.getString("ui.mac_dock_icon", "../desktop.icns");
+ _initialised = true;
+ _initialisedConfig = config;
return config;
}
}
// pass along our proxy settings
- String proxyHost;
- if ((proxyHost = System.getProperty("http.proxyHost")) != null) {
+ String proxyHost = System.getProperty("http.proxyHost");
+ String proxyPort = StringUtil.isBlank(System.getProperty("http.proxyPort")) ? "80" : System.getProperty("http.proxyPort");
+ if (StringUtil.isBlank(proxyHost) && ! proxy.equals(Proxy.NO_PROXY)) {
+ try {
+ SocketAddress a = proxy.address();
+ if (a != null && a instanceof InetSocketAddress) {
+ InetSocketAddress ia = (InetSocketAddress)a;
+ proxyHost = ia.getHostString();
+ proxyPort = String.valueOf(ia.getPort());
+ }
+ } catch (Exception e) {
+ log.error("Problem obtaining proxy settings from Proxy object");
+ e.printStackTrace();
+ }
+ }
+ if (proxyHost != null) {
+ log.info("Using proxy settings "+proxyHost+":"+proxyPort);
args.add("-Dhttp.proxyHost=" + proxyHost);
- args.add("-Dhttp.proxyPort=" + System.getProperty("http.proxyPort"));
+ args.add("-Dhttp.proxyPort=" + proxyPort);
args.add("-Dhttps.proxyHost=" + proxyHost);
- args.add("-Dhttps.proxyPort=" + System.getProperty("http.proxyPort"));
- }
+ args.add("-Dhttps.proxyPort=" + proxyPort);
+ } else {
+ log.info("Not setting proxy");
+ }
// 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?
}
}
+ // 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;
+ }
+ }
+
+ // use saved preferences if no cmdline args
+ LaunchUtils.loadChannelProps(getAppDir());
+ if (LaunchUtils.getBooleanUserPreference(MemorySetting.CUSTOMISED_SETTINGS)) {
+ if (jvmmempc == null) {
+ jvmmempc = LaunchUtils.getUserPreference(MemorySetting.MEMORY_JVMMEMPC);
+ }
+ if (jvmmemmax == null) {
+ jvmmemmax = LaunchUtils.getUserPreference(MemorySetting.MEMORY_JVMMEMMAX);
+ }
+ }
+
+ // 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));
}
// 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
}
if (j > -1) {
ext = filename.substring(j+1);
}
- if (locatorFileExtension.equals(ext.toLowerCase())) {
+ if (ext != null && LOCATOR_FILE_EXTENSION.equals(ext.toLowerCase(Locale.ROOT))) {
// this file extension should have been dealt with in Getdown class
} else {
_appargs.add(0, "-open");
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 "));
- return Runtime.getRuntime().exec(sargs, envp, getAppDir());
+ // don't set the working dir, leave it the same as the working dir of the invocation
+ //return Runtime.getRuntime().exec(sargs, envp, getAppDir());
+ return Runtime.getRuntime().exec(sargs, envp);
}
/**
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. " +
{
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(Locale.ROOT).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(Locale.ROOT).endsWith("."+Application.LOCATOR_FILE_EXTENSION)) {
+ addStartupFile(filename);
+ }
+ }
+ }
+ }
- public void addStartupFile (File f) {
- startupFiles.add(f);
- }
-
- public void newAppbase (URL url) {
- if (
- url.getHost().equals(locatorDomain)
- || (allowLocatorSubdomains && url.getHost().endsWith("."+locatorDomain))
- || (allowLocatorFileProtocol && url.getProtocol().equals("file") && url.getHost().equals(""))
- ) {
- newAppbase = url;
- log.info("Appbase set to Java Version Locator url '"+url.toString()+"'");
- return;
+ 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;
}
- log.info("Java Version Locator url '"+url.toString()+"' does not have satisfy domain rules ("
- +(allowLocatorFileProtocol?"file:///|":"")
- +"https://"
- +(allowLocatorSubdomains?"[*.]":locatorDomain)
- +"). Ignoring");
+
+ Config locatorConfig = null;
+
+ 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);
+ }
+
+ 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;
protected List<String> _jvmargs = new ArrayList<>();
protected List<String> _appargs = new ArrayList<>();
- protected List<File> startupFiles = new ArrayList<>();
- protected URL newAppbase;
protected String[] _optimumJvmArgs;
protected static final String ENV_VAR_PREFIX = "%ENV.";
protected static final Pattern ENV_VAR_PATTERN = Pattern.compile("%ENV\\.(.*?)%");
- protected static final String locatorDomain = "jalview.org";
- protected boolean allowLocatorSubdomains = true;
- protected boolean allowLocatorFileProtocol = true;
+
+ 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 final String locatorFileExtension = "jvl";
+ public static String i4jVersion = null;
+ private String jvmmempc = null;
+ private String jvmmemmax = null;
}
git://source.jalview.org / jalview.git / blobdiff