import org.apache.log4j.Logger;
import org.apache.log4j.SimpleLayout;
+import jalview.bin.ApplicationSingletonProvider.ApplicationSingletonI;
import jalview.datamodel.PDBEntry;
import jalview.gui.Preferences;
import jalview.gui.UserDefinedColours;
* when shading by annotation</li>
* <li>ANNOTATIONCOLOUR_MAX (red) Shade used for maximum value of annotation
* when shading by annotation</li>
- * <li>www.jalview.org (http://www.jalview.org) a property enabling all HTTP
- * requests to be redirected to a mirror of http://www.jalview.org</li>
+ * <li>www.jalview.org (https://www.jalview.org) a property enabling all HTTP
+ * requests to be redirected to a mirror of https://www.jalview.org</li>
* <li>FIGURE_AUTOIDWIDTH (false) Expand the left hand column of an exported
* alignment figure to accommodate even the longest sequence ID or annotation
* label.</li>
* @author $author$
* @version $Revision$
*/
-public class Cache
+public class Cache implements ApplicationSingletonI
{
+
+ private Cache()
+ {
+ // private singleton
+ }
+
+ /**
+ * In Java, this will be a static field instance, which will be
+ * application-specific; in JavaScript it will be an applet-specific instance
+ * tied to the applet's ThreadGroup.
+ *
+ * @return
+ */
+ public static Cache getInstance()
+ {
+ return (Cache) ApplicationSingletonProvider.getInstance(Cache.class);
+ }
+
/**
* property giving log4j level for CASTOR loggers
*/
/**
* Sifts settings
*/
- public static final String DEFAULT_SIFTS_DOWNLOAD_DIR = System
- .getProperty("user.home") + File.separatorChar
- + ".sifts_downloads" + File.separatorChar;
-
+ public static final String DEFAULT_SIFTS_DOWNLOAD_DIR = Platform.getUserPath(".sifts_downloads/");
+
private final static String DEFAULT_CACHE_THRESHOLD_IN_DAYS = "2";
private final static String DEFAULT_FAIL_SAFE_PID_THRESHOLD = "30";
/**
* Identifiers.org download settings
*/
- private static final String ID_ORG_FILE = System.getProperty("user.home")
- + File.separatorChar + ".identifiers.org.ids.json";
+ private static final String ID_ORG_FILE = Platform.getUserPath(".identifiers.org.ids.json");
/**
* Allowed values are PDB or mmCIF
public static char[] proxyAuthPassword = null;
/** Jalview Properties */
- public static Properties applicationProperties = new Properties()
+ private Properties applicationProperties = new Properties()
{
// override results in properties output in alphabetical order
@Override
}
};
+ /* build Properties (not all saved to .jalview_properties) */
+ public static Properties buildProperties = new Properties();
+
/** Default file is ~/.jalview_properties */
static String propertiesFile;
}
/**
- * Loads properties from the given properties file. Any existing properties
- * are first cleared.
+ * Loads properties from the given properties file. Any existing properties are
+ * first cleared.
*/
public static void loadProperties(String propsFile)
{
+
+ getInstance().loadPropertiesImpl(propsFile);
+
+ }
+
+ private void loadPropertiesImpl(String propsFile)
+ {
+
propertiesFile = propsFile;
+ String releasePropertiesFile = null;
+ boolean defaultProperties = false;
if (propsFile == null && !propsAreReadOnly)
{
- propertiesFile = System.getProperty("user.home") + File.separatorChar
- + ".jalview_properties";
+ // TODO: @bsoares - for 2.12 testing: check test,develop,release props are located correctly
+ String channelPrefsFilename = ChannelProperties
+ .getProperty("preferences.filename");
+ String releasePrefsFilename = ".jalview_properties";
+ propertiesFile = Platform.getUserPath(channelPrefsFilename);
+ releasePropertiesFile = Platform.getUserPath(releasePrefsFilename);
+ defaultProperties = true;
}
else
{
InputStream fis;
try
{
+ // props file provided as URL
fis = new URL(propertiesFile).openStream();
System.out.println(
"Loading jalview properties from : " + propertiesFile);
System.out.println(
"Disabling Jalview writing to user's local properties file.");
propsAreReadOnly = true;
-
} catch (Exception ex)
{
fis = null;
}
if (fis == null)
{
- fis = new FileInputStream(propertiesFile);
+ String readPropertiesFile = propertiesFile;
+ // if we're using the usual properties file and the channel properties
+ // file doesn't exist, read .jalview_properties
+ // (but we'll still save to the channel properties file).
+ if (defaultProperties && (!new File(propertiesFile).exists())
+ && (new File(releasePropertiesFile).exists()))
+ {
+ readPropertiesFile = releasePropertiesFile;
+ }
+ fis = new FileInputStream(readPropertiesFile);
}
applicationProperties.clear();
applicationProperties.load(fis);
DEFAULT_CACHE_THRESHOLD_IN_DAYS));
IdOrgSettings.setUrl(getDefault("ID_ORG_HOSTURL",
- "http://www.jalview.org/services/identifiers"));
+ "https://www.jalview.org/services/identifiers"));
IdOrgSettings.setDownloadLocation(ID_ORG_FILE);
StructureImportSettings.setDefaultStructureFileFormat(jalview.bin.Cache
class VersionChecker extends Thread
{
+
@Override
public void run()
{
+ String remoteBuildPropertiesUrl = Cache
+ .getAppbaseBuildProperties();
+
String orgtimeout = System
.getProperty("sun.net.client.defaultConnectTimeout");
if (orgtimeout == null)
{
System.setProperty("sun.net.client.defaultConnectTimeout",
"5000");
- java.net.URL url = new java.net.URL(Cache
- .getDefault("www.jalview.org", "http://www.jalview.org")
- + "/webstart/jalview.jnlp");
+ java.net.URL url = new java.net.URL(remoteBuildPropertiesUrl);
+
BufferedReader in = new BufferedReader(
new InputStreamReader(url.openStream()));
- String line = null;
- while ((line = in.readLine()) != null)
- {
- if (line.indexOf("jalview.version") == -1)
- {
- continue;
- }
- line = line.substring(line.indexOf("value=") + 7);
- line = line.substring(0, line.lastIndexOf("\""));
- remoteVersion = line;
- break;
- }
+ Properties remoteBuildProperties = new Properties();
+ remoteBuildProperties.load(in);
+ remoteVersion = remoteBuildProperties.getProperty("VERSION");
} catch (Exception ex)
{
- System.out.println(
- "Non-fatal exception when checking version at www.jalview.org :");
+ System.out
+ .println("Non-fatal exception when checking version at "
+ + remoteBuildPropertiesUrl + ":");
System.out.println(ex);
remoteVersion = getProperty("VERSION");
}
return url;
}
- public static void loadBuildProperties(boolean reportVersion)
+ public void loadBuildProperties(boolean reportVersion)
{
String codeInstallation = getProperty("INSTALLATION");
boolean printVersion = codeInstallation == null;
String buildDetails = resolveResourceURLFor("/.build_properties");
URL localJarFileURL = new URL(buildDetails);
InputStream in = localJarFileURL.openStream();
- applicationProperties.load(in);
+ buildProperties.load(in);
in.close();
+ if (buildProperties.getProperty("BUILD_DATE", null) != null)
+ {
+ applicationProperties.put("BUILD_DATE",
+ buildProperties.getProperty("BUILD_DATE"));
+ }
+ if (buildProperties.getProperty("INSTALLATION", null) != null)
+ {
+ applicationProperties.put("INSTALLATION",
+ buildProperties.getProperty("INSTALLATION"));
+ }
+ if (buildProperties.getProperty("VERSION", null) != null)
+ {
+ applicationProperties.put("VERSION",
+ buildProperties.getProperty("VERSION"));
+ }
} catch (Exception ex)
{
System.out.println("Error reading build details: " + ex);
}
}
- private static void deleteBuildProperties()
+ private void deleteBuildProperties()
{
applicationProperties.remove("LATEST_VERSION");
applicationProperties.remove("VERSION");
}
/**
- * Gets Jalview application property of given key. Returns null if key not
- * found
+ * Gets Jalview application property of given key. Returns null if key not found
*
* @param key
- * Name of property
+ * Name of property
*
* @return Property value
*/
public static String getProperty(String key)
{
- String prop = applicationProperties.getProperty(key);
- if (prop == null && Platform.isJS())
- {
- prop = applicationProperties.getProperty(Platform.getUniqueAppletID()
- + "_" + JS_PROPERTY_PREFIX + key);
- }
+ String prop = getInstance().applicationProperties.getProperty(key);
+ // if (prop == null && Platform.isJS())
+ // {
+ // prop = applicationProperties.getProperty(Platform.getUniqueAppletID()
+ // + "_" + JS_PROPERTY_PREFIX + key);
+ // }
return prop;
}
/**
- * These methods are used when checking if the saved preference is different
- * to the default setting
+ * These methods are used when checking if the saved preference is different to
+ * the default setting
*/
public static boolean getDefault(String property, boolean def)
}
/**
- * Answers the value of the given property, or the supplied default value if
- * the property is not set
+ * Answers the value of the given property, or the supplied default value if the
+ * property is not set
*/
public static String getDefault(String property, String def)
{
* Stores property in the file "HOME_DIR/.jalview_properties"
*
* @param key
- * Name of object
+ * Name of object
* @param obj
- * String value of property
+ * String value of property
*
* @return previous value of property (or null)
*/
public static Object setProperty(String key, String obj)
{
- Object oldValue = null;
- try
- {
- oldValue = applicationProperties.setProperty(key, obj);
- if (propertiesFile != null && !propsAreReadOnly)
- {
- FileOutputStream out = new FileOutputStream(propertiesFile);
- applicationProperties.store(out, "---JalviewX Properties File---");
- out.close();
- }
- } catch (Exception ex)
- {
- System.out.println(
- "Error setting property: " + key + " " + obj + "\n" + ex);
- }
- return oldValue;
+ return getInstance().setPropertyImpl(key, obj, true);
}
/**
- * remove the specified property from the jalview properties file
+ * Removes the specified property from the jalview properties file
*
- * @param string
+ * @param key
*/
- public static void removeProperty(String string)
+ public static void removeProperty(String key)
{
- applicationProperties.remove(string);
- saveProperties();
+ getInstance().removePropertyImpl(key, true);
+ }
+
+ /**
+ * Removes the named property for the running application, without saving the
+ * properties file
+ *
+ * BH noting that ColourMenuHelper calls this. If the intent is to save, then
+ * simply chanet that call to removeProperty(key).
+ *
+ * @param key
+ */
+ public static void removePropertyNoSave(String key)
+ {
+
+ getInstance().
+
+ removePropertyImpl(key, false);
+ }
+
+ /**
+ * Removes the named property, and optionally saves the current properties to
+ * file
+ *
+ * @param key
+ * @param andSave
+ */
+ private void removePropertyImpl(String key, boolean andSave)
+ {
+ applicationProperties.remove(key);
+ if (andSave)
+ saveProperties();
}
/**
*/
public static void saveProperties()
{
+ getInstance().savePropertiesImpl();
+ }
+
+ /**
+ * save the properties to the jalview properties path
+ */
+ private void savePropertiesImpl()
+
+ {
if (!propsAreReadOnly)
{
try
* @param property
* @param colour
*/
- public static void setColourProperty(String property, Color colour)
+ public static void setColourPropertyNoSave(String property, Color colour)
{
- setProperty(property, jalview.util.Format.getHexString(colour));
+ setPropertyNoSave(property, jalview.util.Format.getHexString(colour));
}
/**
public static Date getDateProperty(String propertyName)
{
String val = getProperty(propertyName);
+
if (val != null)
{
try
{
- return date_format.parse(val);
+ if ((val = val.trim()).indexOf(",") < 0 && val.indexOf("-") >= 0 && val.indexOf(" ") == val.lastIndexOf(" ")) {
+ val = val.replace(" ",", ").replace('-',' ');
+ }
+ Date date = date_format.parse(val);
+ return date;
} catch (Exception ex)
{
System.err.println("Invalid or corrupt date in property '"
}
if (value == null || value.trim().length() < 1)
{
- Cache.applicationProperties.remove(propName);
+ getInstance().applicationProperties.remove(propName);
}
else
{
- Cache.applicationProperties.setProperty(propName, value);
+ getInstance().applicationProperties.setProperty(propName, value);
}
}
* Loads in user colour schemes from files.
*
* @param files
- * a '|'-delimited list of file paths
+ * a '|'-delimited list of file paths
*/
public static void initUserColourSchemes(String files)
{
}
else
{
- applicationProperties
+ getInstance().applicationProperties
.remove(UserDefinedColours.USER_DEFINED_COLOURS);
}
}
.append(" Installation: ");
sb.append(jalview.bin.Cache.getDefault("INSTALLATION", "unknown"));
sb.append("\n");
- sb.append("Build Date: ");
- sb.append(jalview.bin.Cache.getDefault("BUILD_DATE", "unknown"));
+ sb.append("Build Date: "
+ + jalview.bin.Cache.getDefault("BUILD_DATE", "unknown"));
sb.append("\n");
sb.append("Java version: ");
sb.append(System.getProperty("java.version"));
{
appendIfNotNull(sb, "Getdown appdir: ",
System.getProperty("getdownappdir"), "\n", null);
+ appendIfNotNull(sb, "Getdown appbase: ",
+ System.getProperty("getdownappbase"), "\n", null);
appendIfNotNull(sb, "Java home: ", System.getProperty("java.home"),
"\n", "unknown");
}
return jalview.bin.Cache.getDefault("INSTALLATION", "unknown");
}
+ /**
+ *
+ * For AppletParams and Preferences ok_actionPerformed and
+ * startupFileTextfield_mouseClicked
+ *
+ * Sets a property value for the running application, without saving it to the
+ * properties file
+ *
+ * @param key
+ * @param obj
+ */
+ public static void setPropertyNoSave(String key, String obj)
+ {
+ getInstance().setPropertyImpl(key, obj, false);
+ }
+
+ /**
+ * Sets a property value, and optionally also saves the current properties to
+ * file
+ *
+ * @param key
+ * @param obj
+ * @param andSave
+ * @return
+ */
+ private Object setPropertyImpl(
+ String key, String obj, boolean andSave)
+ {
+ Object oldValue = null;
+ try
+ {
+ oldValue = applicationProperties.setProperty(key, obj);
+ if (andSave && !propsAreReadOnly && propertiesFile != null)
+ {
+ FileOutputStream out = new FileOutputStream(propertiesFile);
+ applicationProperties.store(out, "---JalviewX Properties File---");
+ out.close();
+ }
+ } catch (Exception ex)
+ {
+ System.out.println(
+ "Error setting property: " + key + " " + obj + "\n" + ex);
+ }
+ return oldValue;
+ }
+
public static String getStackTraceString(Throwable t)
{
StringWriter sw = new StringWriter();
Arrays.fill(displayHttpPw, '*');
Cache.debug("CACHE Proxy: setting new Authenticator with httpUser='"
+ httpUser + "' httpPassword='" + displayHttpPw + "'");
- Authenticator.setDefault(new Authenticator()
+ if (!Platform.isJS())
+ /* *
+ * java.net.Authenticator not implemented in SwingJS yet
+ *
+ * @j2sIgnore
+ *
+ */
{
- @Override
- protected PasswordAuthentication getPasswordAuthentication()
+ Authenticator.setDefault(new Authenticator()
{
- if (getRequestorType() == RequestorType.PROXY)
+ @Override
+ protected PasswordAuthentication getPasswordAuthentication()
{
- String protocol = getRequestingProtocol();
- boolean needProxyPasswordSet = false;
- if (customProxySet &&
- // we have a username but no password for the scheme being
- // requested
- (protocol.equalsIgnoreCase("http")
- && (httpUser != null && httpUser.length() > 0
- && (httpPassword == null
- || httpPassword.length == 0)))
- || (protocol.equalsIgnoreCase("https")
- && (httpsUser != null
- && httpsUser.length() > 0
- && (httpsPassword == null
- || httpsPassword.length == 0))))
- {
- // open Preferences -> Connections
- String message = MessageManager
- .getString("label.proxy_password_required");
- Preferences.openPreferences(Preferences.CONNECTIONS_TAB,
- message);
- Preferences.getInstance()
- .proxyAuthPasswordCheckHighlight(true, true);
- }
- else
+ if (getRequestorType() == RequestorType.PROXY)
{
- try
+ String protocol = getRequestingProtocol();
+ boolean needProxyPasswordSet = false;
+ if (customProxySet &&
+ // we have a username but no password for the scheme being
+ // requested
+ (protocol.equalsIgnoreCase("http")
+ && (httpUser != null && httpUser.length() > 0
+ && (httpPassword == null
+ || httpPassword.length == 0)))
+ || (protocol.equalsIgnoreCase("https")
+ && (httpsUser != null
+ && httpsUser.length() > 0
+ && (httpsPassword == null
+ || httpsPassword.length == 0))))
{
- if (protocol.equalsIgnoreCase("http")
- && getRequestingHost().equalsIgnoreCase(httpHost)
- && getRequestingPort() == Integer
- .valueOf(httpPort))
+ // open Preferences -> Connections
+ String message = MessageManager
+ .getString("label.proxy_password_required");
+ Preferences.openPreferences(
+ Preferences.TabRef.CONNECTIONS_TAB, message);
+ Preferences.getInstance()
+ .proxyAuthPasswordCheckHighlight(true, true);
+ }
+ else
+ {
+ try
{
- Cache.debug(
- "AUTHENTICATOR returning PasswordAuthentication(\""
- + httpUser + "\", '"
- + new String(displayHttpPw) + "')");
- return new PasswordAuthentication(httpUser,
- httpPassword);
- }
- if (protocol.equalsIgnoreCase("https")
- && getRequestingHost().equalsIgnoreCase(httpsHost)
- && getRequestingPort() == Integer
- .valueOf(httpsPort))
+ if (protocol.equalsIgnoreCase("http")
+ && getRequestingHost()
+ .equalsIgnoreCase(httpHost)
+ && getRequestingPort() == Integer
+ .valueOf(httpPort))
+ {
+ Cache.debug(
+ "AUTHENTICATOR returning PasswordAuthentication(\""
+ + httpUser + "\", '"
+ + new String(displayHttpPw) + "')");
+ return new PasswordAuthentication(httpUser,
+ httpPassword);
+ }
+ if (protocol.equalsIgnoreCase("https")
+ && getRequestingHost()
+ .equalsIgnoreCase(httpsHost)
+ && getRequestingPort() == Integer
+ .valueOf(httpsPort))
+ {
+ char[] displayHttpsPw = new char[httpPassword.length];
+ Arrays.fill(displayHttpsPw, '*');
+ Cache.debug(
+ "AUTHENTICATOR returning PasswordAuthentication(\""
+ + httpsUser + "\", '" + displayHttpsPw
+ + "'");
+ return new PasswordAuthentication(httpsUser,
+ httpsPassword);
+ }
+ } catch (NumberFormatException e)
{
- char[] displayHttpsPw = new char[httpPassword.length];
- Arrays.fill(displayHttpsPw, '*');
- Cache.debug(
- "AUTHENTICATOR returning PasswordAuthentication(\""
- + httpsUser + "\", '" + displayHttpsPw
- + "'");
- return new PasswordAuthentication(httpsUser,
- httpsPassword);
+ Cache.error("Problem with proxy port values [http:"
+ + httpPort + ", https:" + httpsPort + "]");
}
- } catch (NumberFormatException e)
- {
- Cache.error("Problem with proxy port values [http:"
- + httpPort + ", https:" + httpsPort + "]");
+ Cache.debug(
+ "AUTHENTICATOR after trying to get PasswordAuthentication");
}
- Cache.debug(
- "AUTHENTICATOR after trying to get PasswordAuthentication");
}
+ // non proxy request
+ Cache.debug("AUTHENTICATOR returning null");
+ return null;
}
- // non proxy request
- Cache.debug("AUTHENTICATOR returning null");
- return null;
- }
- });
+ });
+ } // end of j2sIgnore for java.net.Authenticator
+
// required to re-enable basic authentication (should be okay for a
// local proxy)
Cache.debug(
/* as noted above, due to bug in java this doesn't work if the sun.net.www.protocol.http.AuthCache
* has working credentials. No workaround for Java 11.
*/
- Cache.debug("AUTHENTICATOR setting default Authenticator to null");
- Authenticator.setDefault(null);
+ if (!Platform.isJS())
+ /* *
+ * java.net.Authenticator not implemented in SwingJS yet
+ *
+ * @j2sIgnore
+ *
+ */
+ {
+ Cache.debug("AUTHENTICATOR setting default Authenticator to null");
+ Authenticator.setDefault(null);
+ }
}
// nonProxyHosts not currently configurable in Preferences
{
println(ERROR, message);
}
-}
\ No newline at end of file
+
+ /**
+ * Getdown appbase methods
+ */
+
+ private static final String releaseAppbase;
+
+ private static String getdownAppbase;
+
+ private static String getdownDistDir;
+
+ static
+ {
+ if (!Platform.isJS())
+ {
+ Float specversion = Float
+ .parseFloat(System.getProperty("java.specification.version"));
+ releaseAppbase = (specversion < 9)
+ ? "https://www.jalview.org/getdown/release/1.8"
+ : "https://www.jalview.org/getdown/release/11";
+ }
+ else
+ {
+ // this value currenly made up, can be changed to URL that will be
+ // "https://www.jalview.org/jalview-js/swingjs/j2s/build_properties"
+ releaseAppbase = "https://www.jalview.org/jalview-js";
+ getdownAppbase = releaseAppbase;
+ getdownDistDir = "/swingjs/j2s";
+ }
+ }
+
+ // look for properties (passed in by getdown) otherwise default to release
+ private static void setGetdownAppbase()
+ {
+ if (getdownAppbase != null)
+ {
+ return;
+ }
+ String appbase = System.getProperty("getdownappbase");
+ String distDir = System.getProperty("getdowndistdir");
+ if (appbase == null)
+ {
+ appbase = buildProperties.getProperty("GETDOWNAPPBASE");
+ distDir = buildProperties.getProperty("GETDOWNAPPDISTDIR");
+ }
+ if (appbase == null)
+ {
+ appbase = releaseAppbase;
+ distDir = "release";
+ }
+ if (appbase.endsWith("/"))
+ {
+ appbase = appbase.substring(0, appbase.length() - 1);
+ }
+ if (distDir == null)
+ {
+ distDir = appbase.equals(releaseAppbase) ? "release" : "alt";
+ }
+ getdownAppbase = appbase;
+ getdownDistDir = distDir;
+ }
+
+ public static String getGetdownAppbase()
+ {
+ setGetdownAppbase();
+ return getdownAppbase;
+ }
+
+ public static String getAppbaseBuildProperties()
+ {
+ String appbase = getGetdownAppbase();
+ return appbase + "/" + getdownDistDir + "/build_properties";
+ }
+}
git://source.jalview.org / jalview.git / blobdiff