X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fbin%2FCache.java;h=57419085599b17f02204b00561d9f9e93047bad9;hb=d17a8d70dedafa76dd0bb6c7c8a280a516464dac;hp=bb70c406b24e2c9cf663d1f62e752de69c106d37;hpb=1aa7a7bfe46e16a5125192933b8ba6ae4bc6c9bf;p=jalview.git
diff --git a/src/jalview/bin/Cache.java b/src/jalview/bin/Cache.java
index bb70c40..5741908 100755
--- a/src/jalview/bin/Cache.java
+++ b/src/jalview/bin/Cache.java
@@ -24,7 +24,9 @@ import java.awt.Color;
import java.io.BufferedReader;
import java.io.File;
import java.io.FileInputStream;
+import java.io.FileNotFoundException;
import java.io.FileOutputStream;
+import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.PrintWriter;
@@ -34,11 +36,16 @@ import java.net.PasswordAuthentication;
import java.net.URL;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
+import java.util.ArrayList;
import java.util.Arrays;
+import java.util.Collection;
import java.util.Collections;
import java.util.Date;
import java.util.Enumeration;
+import java.util.HashMap;
+import java.util.List;
import java.util.Locale;
+import java.util.Map;
import java.util.Properties;
import java.util.StringTokenizer;
import java.util.TreeSet;
@@ -46,6 +53,7 @@ import java.util.TreeSet;
import javax.swing.LookAndFeel;
import javax.swing.UIManager;
+import jalview.analytics.Plausible;
import jalview.datamodel.PDBEntry;
import jalview.gui.Preferences;
import jalview.gui.UserDefinedColours;
@@ -121,7 +129,7 @@ import jalview.ws.sifts.SiftsSettings;
* service
*
QUESTIONNAIRE last questionnaire:responder id string from questionnaire
* service
- * USAGESTATS (false - user prompted) Enable google analytics tracker for
+ * USAGESTATS (false - user prompted) Enable analytics tracker for
* collecting usage statistics
* SHOW_OVERVIEW boolean for overview window display
* ANTI_ALIAS boolean for smooth fonts
@@ -240,6 +248,9 @@ public class Cache
*/
public static final String JALVIEWLOGLEVEL = "logs.Jalview.level";
+ // for tests
+ public static final String BOOTSTRAP_TEST = "BOOTSTRAP_TEST";
+
/**
* Sifts settings
*/
@@ -303,6 +314,24 @@ public class Cache
// in-memory only storage of proxy password, safer to use char array
public static char[] proxyAuthPassword = null;
+ /**
+ * Session properties, set by command line, try not to affect stored
+ * properties!
+ */
+ private static Map sessionProperties = new HashMap<>();
+
+ private static boolean bypassSessionProperties = false;
+
+ public static void enableSessionProperties()
+ {
+ bypassSessionProperties = false;
+ }
+
+ public static void disableSessionProperties()
+ {
+ bypassSessionProperties = true;
+ }
+
/** Jalview Properties */
public static Properties applicationProperties = new Properties()
{
@@ -320,8 +349,20 @@ public class Cache
/** Default file is ~/.jalview_properties */
static String propertiesFile;
+ private static final String fallbackPropertiesFile = ".jalview_properties";
+
private static boolean propsAreReadOnly = Platform.isJS();
+ public static boolean isPropsAreReadOnly()
+ {
+ return propsAreReadOnly;
+ }
+
+ public static void setPropsAreReadOnly(boolean propsAreReadOnly)
+ {
+ Cache.propsAreReadOnly = propsAreReadOnly;
+ }
+
private final static String JS_PROPERTY_PREFIX = "jalview_";
/**
@@ -337,7 +378,7 @@ public class Cache
{
String channelPrefsFilename = ChannelProperties
.getProperty("preferences.filename");
- String releasePrefsFilename = ".jalview_properties";
+ String releasePrefsFilename = fallbackPropertiesFile;
propertiesFile = System.getProperty("user.home") + File.separatorChar
+ channelPrefsFilename;
releasePropertiesFile = System.getProperty("user.home")
@@ -364,10 +405,13 @@ public class Cache
{
// 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.");
+ if (!Jalview.quiet())
+ {
+ 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)
{
@@ -395,7 +439,8 @@ public class Cache
fis.close();
} catch (Exception ex)
{
- System.out.println("Error reading properties file: " + ex);
+ if (!Jalview.quiet())
+ System.out.println("Error reading properties file: " + ex);
}
}
@@ -451,7 +496,8 @@ public class Cache
}
} catch (Exception ex)
{
- System.out.println("Error reading author details: " + ex);
+ if (!Jalview.quiet())
+ System.out.println("Error reading author details: " + ex);
authorDetails = null;
}
if (authorDetails == null)
@@ -514,8 +560,8 @@ public class Cache
if (orgtimeout == null)
{
orgtimeout = "30";
- System.out.println("# INFO: Setting default net timeout to "
- + orgtimeout + " seconds.");
+ Console.debug("Setting default net timeout to " + orgtimeout
+ + " seconds.");
}
String remoteVersion = null;
if (remoteBuildPropertiesUrl.startsWith("http"))
@@ -535,10 +581,13 @@ public class Cache
remoteVersion = remoteBuildProperties.getProperty("VERSION");
} catch (Exception ex)
{
- System.out.println(
- "Non-fatal exception when checking version at "
- + remoteBuildPropertiesUrl + ":");
- System.out.println(ex);
+ if (!Jalview.quiet())
+ {
+ System.out.println(
+ "Non-fatal exception when checking version at "
+ + remoteBuildPropertiesUrl + ":");
+ System.out.println(ex);
+ }
remoteVersion = getProperty("VERSION");
}
}
@@ -637,7 +686,8 @@ public class Cache
}
} catch (Exception ex)
{
- System.out.println("Error reading build details: " + ex);
+ if (!Jalview.quiet())
+ System.out.println("Error reading build details: " + ex);
applicationProperties.remove("VERSION");
}
String codeVersion = getProperty("VERSION");
@@ -658,7 +708,7 @@ public class Cache
if (printVersion && reportVersion)
{
System.out.println(ChannelProperties.getProperty("app_name")
- + " Version: " + codeVersion + codeInstallation);
+ + " version: " + codeVersion + codeInstallation);
}
}
@@ -684,7 +734,21 @@ public class Cache
*/
public static String getProperty(String key)
{
- String prop = applicationProperties.getProperty(key);
+ return getProperty(key, false);
+ }
+
+ public static String getProperty(String key,
+ boolean skipSessionProperties)
+ {
+ String prop = null;
+ if (!(skipSessionProperties || bypassSessionProperties))
+ {
+ prop = getSessionProperty(key);
+ }
+ if (prop == null)
+ {
+ prop = applicationProperties.getProperty(key);
+ }
if (prop == null && Platform.isJS())
{
prop = applicationProperties.getProperty(Platform.getUniqueAppletID()
@@ -719,8 +783,9 @@ public class Cache
def = Integer.parseInt(string);
} catch (NumberFormatException e)
{
- System.out.println("Error parsing int property '" + property
- + "' with value '" + string + "'");
+ if (!Jalview.quiet())
+ System.out.println("Error parsing int property '" + property
+ + "' with value '" + string + "'");
}
}
@@ -753,16 +818,25 @@ public class Cache
try
{
oldValue = applicationProperties.setProperty(key, obj);
- if (propertiesFile != null && !propsAreReadOnly)
+ if (propertiesFile != null && !propsAreReadOnly
+ // don't rewrite if new value is same as old value
+ && !((obj == null && oldValue == null)
+ || (obj != null && obj.equals(oldValue))))
{
+ // reset the session property too
+ if (sessionProperties.containsKey(key))
+ {
+ sessionProperties.remove(key);
+ }
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);
+ if (!Jalview.quiet())
+ System.out.println(
+ "Error setting property: " + key + " " + obj + "\n" + ex);
}
return oldValue;
}
@@ -792,7 +866,8 @@ public class Cache
out.close();
} catch (Exception ex)
{
- System.out.println("Error saving properties: " + ex);
+ if (!Jalview.quiet())
+ System.out.println("Error saving properties: " + ex);
}
}
}
@@ -880,102 +955,42 @@ public class Cache
}
/**
- * GA tracker object - actually JGoogleAnalyticsTracker null if tracking not
- * enabled.
+ * Initialise the tracker if it is not done already.
*/
- protected static Object tracker = null;
-
- protected static Class trackerfocus = null;
-
- protected static Class jgoogleanalyticstracker = null;
-
- /**
- * Initialise the google tracker if it is not done already.
- */
- public static void initGoogleTracker()
+ public static void initAnalytics()
{
- if (tracker == null)
+ Plausible.setEnabled(true);
+
+ String appName = ChannelProperties.getProperty("app_name") + " Desktop";
+ String version = Cache.getProperty("VERSION") + "_"
+ + Cache.getDefault("BUILD_DATE", "unknown");
+ String path;
+ /* we don't want to encode ':' as "%3A" for backward compatibility with the UA setup
+ try
{
- if (jgoogleanalyticstracker == null)
- {
- // try to get the tracker class
- try
- {
- jgoogleanalyticstracker = Cache.class.getClassLoader().loadClass(
- "com.boxysystems.jgoogleanalytics.JGoogleAnalyticsTracker");
- trackerfocus = Cache.class.getClassLoader()
- .loadClass("com.boxysystems.jgoogleanalytics.FocusPoint");
- } catch (Exception e)
- {
- Console.debug(
- "com.boxysystems.jgoogleanalytics package is not present - tracking not enabled.");
- tracker = null;
- jgoogleanalyticstracker = null;
- trackerfocus = null;
- return;
- }
- }
- // now initialise tracker
- Exception re = null, ex = null;
- Error err = null;
- String vrs = "No Version Accessible";
- try
- {
- // Google analytics tracking code for Library Finder
- tracker = jgoogleanalyticstracker
- .getConstructor(new Class[]
- { String.class, String.class, String.class })
- .newInstance(new Object[]
- { ChannelProperties.getProperty("app_name") + " Desktop",
- (vrs = Cache.getProperty("VERSION") + "_"
- + Cache.getDefault("BUILD_DATE", "unknown")),
- "UA-9060947-1" });
- jgoogleanalyticstracker
- .getMethod("trackAsynchronously", new Class[]
- { trackerfocus })
- .invoke(tracker, new Object[]
- { trackerfocus.getConstructor(new Class[] { String.class })
- .newInstance(new Object[]
- { "Application Started." }) });
- } catch (RuntimeException e)
- {
- re = e;
- } catch (Exception e)
- {
- ex = e;
- } catch (Error e)
- {
- err = e;
- }
- if (re != null || ex != null || err != null)
- {
- if (re != null)
- {
- Console.debug("Caught runtime exception in googletracker init:",
- re);
- }
- if (ex != null)
- {
- Console.warn(
- "Failed to initialise GoogleTracker for Jalview Desktop with version "
- + vrs,
- ex);
- }
- if (err != null)
- {
- Console.error(
- "Whilst initing GoogleTracker for Jalview Desktop version "
- + vrs,
- err);
- }
- }
- else
- {
- Console.debug("Successfully initialised tracker.");
- }
+ path = "/" + String.join("/", URLEncoder.encode(appName, "UTF-8"),
+ URLEncoder.encode(version, "UTF-8"),
+ URLEncoder.encode(APPLICATION_STARTED, "UTF-8"));
+ } catch (UnsupportedEncodingException e)
+ {
+ */
+ List pathParts = new ArrayList<>();
+ pathParts.add(appName);
+ pathParts.add(version);
+ pathParts.add(APPLICATION_STARTED);
+ path = ("/" + String.join("/", pathParts)).replace(' ', '+');
+ /*
}
+ */
+ Plausible plausible = Plausible.getInstance();
+
+ // This will send a new "application_launch" event with parameters
+ // including the old-style "path", the channel name and version
+ plausible.sendEvent("application_launch", path, true);
}
+ private static final String APPLICATION_STARTED = "Application Started";
+
/**
* get the user's default colour if available
*
@@ -1130,7 +1145,8 @@ public class Cache
}
} catch (Exception ex)
{
- System.out.println("Error loading User ColourFile\n" + ex);
+ if (!Jalview.quiet())
+ System.out.println("Error loading User ColourFile\n" + ex);
}
}
if (!files.equals(coloursFound.toString()))
@@ -1604,4 +1620,76 @@ public class Cache
String appbase = getGetdownAppbase();
return appbase + "/" + getdownDistDir + "/build_properties";
}
+
+ private static final Collection bootstrapProperties = new ArrayList<>(
+ Arrays.asList(JALVIEWLOGLEVEL, BOOTSTRAP_TEST));
+
+ public static Properties bootstrapProperties(String filename)
+ {
+ Properties bootstrapProps = new Properties();
+ File file = null;
+ if (filename != null)
+ {
+ file = new File(filename);
+ }
+ if (file == null || !file.exists())
+ {
+ String channelPrefsFilename = ChannelProperties
+ .getProperty("preferences.filename");
+ String propertiesFilename = System.getProperty("user.home")
+ + File.separatorChar + channelPrefsFilename;
+ file = new File(propertiesFilename);
+ }
+ if (file == null || !file.exists())
+ {
+ String releasePrefsFilename = fallbackPropertiesFile;
+ String releasePropertiesFilename = System.getProperty("user.home")
+ + File.separatorChar + releasePrefsFilename;
+ file = new File(releasePropertiesFilename);
+ }
+
+ if (filename == null)
+ return null;
+ if (!file.exists())
+ {
+ System.err.println("Could not load bootstrap preferences file '"
+ + filename + "'");
+ return null;
+ }
+
+ try
+ {
+ FileInputStream in = new FileInputStream(file.getAbsoluteFile());
+ Properties props = new Properties();
+ props.load(in);
+ for (String prop : bootstrapProperties)
+ {
+ if (props.containsKey(prop))
+ bootstrapProps.put(prop, props.getProperty(prop));
+ }
+ } catch (FileNotFoundException e)
+ {
+ System.err.println("Could not find bootstrap preferences file '"
+ + file.getAbsolutePath() + "'");
+ } catch (IOException e)
+ {
+ System.err.println(
+ "IOException when loading bootstrap preferences file '"
+ + file.getAbsolutePath() + "'");
+ }
+ return bootstrapProps;
+ }
+
+ public static void setSessionProperty(String key, String val)
+ {
+ if (key != null)
+ {
+ sessionProperties.put(key, val);
+ }
+ }
+
+ public static String getSessionProperty(String key)
+ {
+ return key == null ? null : sessionProperties.get(key);
+ }
}