Google Analytics tracking backport

diff --git a/lib/JGoogleAnalytics_0.2.jar b/lib/JGoogleAnalytics_0.2.jar
new file mode 100644 (file)
index 0000000..c389e1c
Binary files /dev/null and b/lib/JGoogleAnalytics_0.2.jar differ

diff --git a/src/jalview/bin/Cache.java b/src/jalview/bin/Cache.java
index e5f7f7b..4475bff 100755 (executable)
--- a/src/jalview/bin/Cache.java
+++ b/src/jalview/bin/Cache.java
@@ -23,6 +23,9 @@ import java.util.*;
 
 import org.apache.log4j.*;
 
+import com.boxysystems.jgoogleanalytics.FocusPoint;
+import com.boxysystems.jgoogleanalytics.JGoogleAnalyticsTracker;
+
 /**
  * Stores and retrieves Jalview Application Properties Lists and fields within
  * list entries are separated by '|' symbols unless otherwise stated (|) clauses
@@ -39,71 +42,70 @@ import org.apache.log4j.*;
  * </li>
  * <li>logs.Jalview.Level - Cache.log stringified level. <br>
  * </li>
- * <li>DISCOVERY_START - Boolean - controls if discovery services are queried
- * on startup </li>
- * <li>DISCOVERY_URLS - comma separated list of Discovery Service endpoints.
- * </li>
- * <li>SCREEN_WIDTH </li>
- * <li>SCREEN_HEIGHT </li>
- * <li>SCREEN_Y=285 </li>
- * <li>SCREEN_X=371 </li>
- * <li>SHOW_FULLSCREEN boolean </li>
- * <li>FONT_NAME java font name for alignment text display </li>
- * <li>FONT_SIZE size of displayed alignment text </li>
- * <li>FONT_STYLE style of font displayed (sequence labels are always italic)
- * </li>
- * <li>GAP_SYMBOL character to treat as gap symbol (usually -,.,' ') </li>
- * <li>LAST_DIRECTORY last directory for browsing alignment </li>
- * <li>USER_DEFINED_COLOURS list of user defined colour scheme files </li>
- * <li>SHOW_FULL_ID show id with '/start-end' numbers appended </li>
- * <li>SHOW_IDENTITY show percentage identity annotation </li>
- * <li>SHOW_QUALITY show alignment quality annotation </li>
- * <li>SHOW_ANNOTATIONS show alignment annotation rows </li>
- * <li>SHOW_CONSERVATION show alignment conservation annotation </li>
+ * <li>DISCOVERY_START - Boolean - controls if discovery services are queried on
+ * startup</li>
+ * <li>DISCOVERY_URLS - comma separated list of Discovery Service endpoints.</li>
+ * <li>SCREEN_WIDTH</li>
+ * <li>SCREEN_HEIGHT</li>
+ * <li>SCREEN_Y=285</li>
+ * <li>SCREEN_X=371</li>
+ * <li>SHOW_FULLSCREEN boolean</li>
+ * <li>FONT_NAME java font name for alignment text display</li>
+ * <li>FONT_SIZE size of displayed alignment text</li>
+ * <li>FONT_STYLE style of font displayed (sequence labels are always italic)</li>
+ * <li>GAP_SYMBOL character to treat as gap symbol (usually -,.,' ')</li>
+ * <li>LAST_DIRECTORY last directory for browsing alignment</li>
+ * <li>USER_DEFINED_COLOURS list of user defined colour scheme files</li>
+ * <li>SHOW_FULL_ID show id with '/start-end' numbers appended</li>
+ * <li>SHOW_IDENTITY show percentage identity annotation</li>
+ * <li>SHOW_QUALITY show alignment quality annotation</li>
+ * <li>SHOW_ANNOTATIONS show alignment annotation rows</li>
+ * <li>SHOW_CONSERVATION show alignment conservation annotation</li>
  * <li>CENTRE_COLUMN_LABELS centre the labels at each column in a displayed
- * annotation row </li>
- * <li>DEFAULT_COLOUR default colour scheme to apply for a new alignment </li>
- * <li>DEFAULT_FILE_FORMAT file format used to save </li>
- * <li>STARTUP_FILE file loaded on startup (may be a fully qualified url) </li>
- * <li>SHOW_STARTUP_FILE flag to control loading of startup file </li>
- * <li>VERSION the version of the jalview build </li>
- * <li>BUILD_DATE date of this build </li>
+ * annotation row</li>
+ * <li>DEFAULT_COLOUR default colour scheme to apply for a new alignment</li>
+ * <li>DEFAULT_FILE_FORMAT file format used to save</li>
+ * <li>STARTUP_FILE file loaded on startup (may be a fully qualified url)</li>
+ * <li>SHOW_STARTUP_FILE flag to control loading of startup file</li>
+ * <li>VERSION the version of the jalview build</li>
+ * <li>BUILD_DATE date of this build</li>
  * <li>LATEST_VERSION the latest jalview version advertised on the
- * www.jalview.org </li>
+ * www.jalview.org</li>
  * <li>PIR_MODELLER boolean indicating if PIR files are written with MODELLER
- * descriptions </li>
+ * descriptions</li>
  * <li>(FASTA,MSF,PILEUP,CLUSTAL,BLC,PIR,PFAM)_JVSUFFIX boolean for adding jv
- * suffix to file </li>
- * <li>RECENT_URL list of recently retrieved URLs </li>
- * <li>RECENT_FILE list of recently opened files </li>
- * <li>USE_PROXY flag for whether a http proxy is to be used </li>
- * <li>PROXY_SERVER the proxy </li>
- * <li>PROXY_PORT </li>
+ * suffix to file</li>
+ * <li>RECENT_URL list of recently retrieved URLs</li>
+ * <li>RECENT_FILE list of recently opened files</li>
+ * <li>USE_PROXY flag for whether a http proxy is to be used</li>
+ * <li>PROXY_SERVER the proxy</li>
+ * <li>PROXY_PORT</li>
  * <li>NOQUESTIONNAIRES true to prevent jalview from checking the questionnaire
- * service </li>
+ * service</li>
  * <li>QUESTIONNAIRE last questionnaire:responder id string from questionnaire
- * service </li>
- * <li>DAS_LOCAL_SOURCE list of local das sources </li>
- * <li>SHOW_OVERVIEW boolean for overview window display </li>
- * <li>ANTI_ALIAS boolean for smooth fonts </li>
- * <li>RIGHT_ALIGN_IDS boolean </li>
- * <li>AUTO_CALC_CONSENSUS boolean for automatic recalculation of consensus
- * </li>
- * <li>PAD_GAPS boolean </li>
- * <li>ID_ITALICS boolean </li>
- * <li>SHOW_JV_SUFFIX </li>
- * <li>WRAP_ALIGNMENT </li>
+ * service</li>
+ * <li>USAGESTATS (true) Enable google analytics tracker for collecting usage
+ * statistics</li>
+ * <li>DAS_LOCAL_SOURCE list of local das sources</li>
+ * <li>SHOW_OVERVIEW boolean for overview window display</li>
+ * <li>ANTI_ALIAS boolean for smooth fonts</li>
+ * <li>RIGHT_ALIGN_IDS boolean</li>
+ * <li>AUTO_CALC_CONSENSUS boolean for automatic recalculation of consensus</li>
+ * <li>PAD_GAPS boolean</li>
+ * <li>ID_ITALICS boolean</li>
+ * <li>SHOW_JV_SUFFIX</li>
+ * <li>WRAP_ALIGNMENT</li>
  * <li>EPS_RENDERING (Prompt each time|Lineart|Text) default for EPS rendering
- * style check </li>
- * <li>SORT_ALIGNMENT (No sort|Id|Pairwise Identity) </li>
+ * style check</li>
+ * <li>SORT_ALIGNMENT (No sort|Id|Pairwise Identity)</li>
  * <li>SEQUENCE_LINKS list of name|URL pairs for opening a url with
- * $SEQUENCE_ID$ </li>
- * <li>DAS_REGISTRY_URL the registry to query </li>
- * <li>DEFAULT_BROWSER for unix </li>
- * <li>DAS_ACTIVE_SOURCE list of active sources </li>
+ * $SEQUENCE_ID$</li>
+ * <li>DAS_REGISTRY_URL the registry to query</li>
+ * <li>DEFAULT_BROWSER for unix</li>
+ * <li>DAS_ACTIVE_SOURCE list of active sources</li>
  * <li>SHOW_MEMUSAGE boolean show memory usage and warning indicator on desktop
- * (false) </li>
- * <li> </li>
+ * (false)</li>
+ * <li></li>
  * 
  * </ul>
  * 
@@ -148,7 +150,7 @@ public class Cache
               "System.err");
       ap.setName("JalviewLogger");
       org.apache.log4j.Logger.getRootLogger().addAppender(ap); // catch all for
-                                                                // log output
+      // log output
       Logger laxis = Logger.getLogger("org.apache.axis");
       Logger lcastor = Logger.getLogger("org.exolab.castor");
       jalview.bin.Cache.log = Logger.getLogger("jalview.bin.Jalview");
@@ -326,7 +328,7 @@ public class Cache
    * found
    * 
    * @param key
-   *                Name of property
+   *          Name of property
    * 
    * @return Property value
    */
@@ -370,9 +372,9 @@ public class Cache
    * 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 String value of property
    */
@@ -483,4 +485,52 @@ public class Cache
     return (groovyJarsArePresent > 0);
   }
 
+  /**
+   * GA tracker object - null if tracking not enabled.
+   */
+  public static JGoogleAnalyticsTracker tracker = null;
+
+  /**
+   * Initialise the google tracker if it is not done already.
+   */
+  public static void initGoogleTracker()
+  {
+    if (tracker == null)
+    {
+      String vrs = "No Version Accessible";
+      try
+      {
+        // Google analytics tracking code for Library Finder
+        tracker = new JGoogleAnalyticsTracker("Jalview Desktop",
+                (vrs = jalview.bin.Cache.getProperty("VERSION")
+                        + "_"
+                        + jalview.bin.Cache.getDefault("BUILD_DATE",
+                                "unknown")), "UA-9060947-1");
+        tracker.trackAsynchronously(new FocusPoint("Application Started."));
+      } catch (RuntimeException e)
+      {
+        if (log != null)
+        {
+          log.debug("Caught runtime exception in googletracker init:", e);
+        }
+        // quietly return.
+      } catch (Exception e)
+      {
+        // unexpected error
+        if (log != null)
+        {
+          log.warn(
+                  "Failed to initialise GoogleTracker for Jalview Desktop with version "
+                          + vrs, e);
+        }
+        else
+        {
+          log.warn(
+                  "Failed to initialise GoogleTracker for Jalview Desktop with version "
+                          + vrs, e);
+        }
+      }
+    }
+  }
+
 }

diff --git a/src/jalview/bin/Jalview.java b/src/jalview/bin/Jalview.java
index 36f4ff6..0179023 100755 (executable)
--- a/src/jalview/bin/Jalview.java
+++ b/src/jalview/bin/Jalview.java
@@ -83,6 +83,7 @@ public class Jalview
                       + "-eps FILE\tCreate EPS file FILE from alignment."
                       + "-questionnaire URL\tQueries the given URL for information about any Jalview user questionnaires."
                       + "-noquestionnaire\tTurn off questionnaire check."
+                      + "-nousagestats\tTurn off google analytics tracking for this session.\n"
                       + "-dasserver nickname=URL\tAdd and enable a das server with given nickname (alphanumeric or underscores only) for retrieval of features for all alignments."
                       + "-fetchfrom nickname\tQuery nickname for features for the alignments and display them."
                       + "-groovy FILE\tExecute groovy script in FILE, after all other arguments have been processed (if FILE is the text 'STDIN' then the file will be read from STDIN)"
@@ -135,6 +136,13 @@ public class Jalview
       desktop = new Desktop();
       desktop.setVisible(true);
       desktop.discoverer.start();
+      if (!aparser.contains("nousagestats") && Cache.getDefault("USAGESTATS", true)) {
+        Cache.log.info("Initialising googletracker for usage stats.");
+        Cache.initGoogleTracker();
+        Cache.log.debug("Tracking enabled.");
+      } else {
+        Cache.log.info("Not enabling Google Tracking.");
+      }
       if (!aparser.contains("noquestionnaire"))
       {
         String url = aparser.getValue("questionnaire");