Usage data is collected from the logs of various web services
that the Jalview Desktop contacts through its normal operation.
These are described below:
-
-
HTTP logs on the Jalview website We
- record IP addresses of machines which access the web site, either
- via the browser when downloading the application, or when the
- Jalview Desktop user interface is launched.
-
-
The Jalview Getdown Launcher (Since 2.11.0) examines release
- channels every time Jalview launches to determine if a new
- release is available.
-
The questionnaire web service at
- www.jalview.org/cgi-bin/questionnaire.pl is checked and a
- unique cookie for the current questionnaire is stored in the
- Jalview properties file.
-
The Jalview web services stack is contacted to
- retrieve the currently available web services. All
- interactions with the public Jalview web services are
- logged, but we delete all job data (input data and results)
- after about two weeks.
-
-
Google Analytics Since Jalview 2.4.0b2,
- the Jalview Desktop records usage data with Google Analytics via
- the JGoogleAnalytics
- class. The Google Analytics logs for Jalview version 2.4
- only record the fact that the application was started, but in the
- future, we will use this mechanism to improve the Desktop user
- interface, by tracking which parts of the user interface are being
- used most often.
-
-
+
+
HTTP logs on the Jalview website We record
+ IP addresses of machines which access the web site, either via the
+ browser when downloading the application, or when the Jalview Desktop
+ user interface is launched.
+
+
The Jalview Getdown Launcher (Since 2.11.0) examines
+ release channels every time Jalview launches to determine if a new
+ release is available.
+
The questionnaire web service at
+ www.jalview.org/cgi-bin/questionnaire.pl is checked and a unique
+ cookie for the current questionnaire is stored in the Jalview
+ properties file.
+
The Jalview web services stack is contacted to
+ retrieve the currently available web services. All interactions
+ with the public Jalview web services are logged, but we delete all
+ job data (input data and results) after about two weeks.
+
+
Usage Analytics Since Jalview 2.11.2.7, the
+ Jalview Desktop records usage data with a self-hosted instance of the
+ analytics stack Plausible.io via a
+ custom GPLv3 client developed by Ben Soares. Prior to this, Jalview
+ versions as far back as 2.4 recorded application launches via JGoogleAnalytics
+ . Usage logs for Jalview record the fact that the
+ application was started, and details about the OS, installed Jalview
+ launcher (if any) and java version used. In the future, we will use
+ this mechanism to improve the Desktop user interface, by tracking
+ which parts of the user interface are being used most often.
+
Stopping Jalview from calling home If you
run Jalview in 'headless mode' via the command line, then the
diff --git a/help/markdown/releases/release-2_11_2_7.md b/help/markdown/releases/release-2_11_2_7.md
new file mode 100644
index 0000000..361d39a
--- /dev/null
+++ b/help/markdown/releases/release-2_11_2_7.md
@@ -0,0 +1,12 @@
+---
+version: 2.11.2.7
+date: 2023-06-30
+channel: "release"
+---
+
+## New Features
+- Jalview now reports usage statistics via Plausible.io
+
+## Issues Resolved
+- PDB structures slow to view when Jalview Java console is open
+- chains in PDB or mmCIF files with negative RESNUMs not correctly parsed
diff --git a/help/markdown/whatsnew/whatsnew-2_11_2_7.md b/help/markdown/whatsnew/whatsnew-2_11_2_7.md
new file mode 100644
index 0000000..f884134
--- /dev/null
+++ b/help/markdown/whatsnew/whatsnew-2_11_2_7.md
@@ -0,0 +1,5 @@
+Jalview 2.11.2.7 is a minor patch release - it includes patches affecting efficiency when importing structures and a small revision to the import processing of structures with negative residue numbering.
+
+With this release, Jalview usage statistics are now collected by a jalview.org hosted instance of the open source privacy-preserving analytics stack, Plausible.io.
+
+
diff --git a/j11lib/JGoogleAnalytics_0.3.jar b/j11lib/JGoogleAnalytics_0.3.jar
deleted file mode 100644
index 0dbc98c..0000000
Binary files a/j11lib/JGoogleAnalytics_0.3.jar and /dev/null differ
diff --git a/j8lib/JGoogleAnalytics_0.3.jar b/j8lib/JGoogleAnalytics_0.3.jar
deleted file mode 100644
index 0dbc98c..0000000
Binary files a/j8lib/JGoogleAnalytics_0.3.jar and /dev/null differ
diff --git a/resources/lang/Messages.properties b/resources/lang/Messages.properties
index 7f5746e..924b9cb 100644
--- a/resources/lang/Messages.properties
+++ b/resources/lang/Messages.properties
@@ -1452,8 +1452,8 @@ label.choose_tempfac_type = Choose Temperature Factor type
label.interpret_tempfac_as = Interpret Temperature Factor as
label.add_pae_matrix_file = Add PAE matrix file
label.nothing_selected = Nothing selected
-prompt.google_analytics_title = Jalview Usage Statistics
-prompt.google_analytics = Do you want to help make Jalview better by enabling the collection of usage statistics with Google Analytics?\nYou can enable or disable usage tracking in the preferences.
+prompt.analytics_title = Jalview Usage Statistics
+prompt.analytics = Do you want to help make Jalview better by enabling the collection of usage statistics with Plausible analytics?\nYou can enable or disable usage tracking in the preferences.
label.working_ellipsis = Working ...
action.show_groups_on_matrix = Show groups on matrix
action.show_groups_on_matrix_tooltip = When enabled, clusters defined on the matrix's associated tree or below the assigned threshold are shown as different colours on the matrix annotation row
diff --git a/resources/lang/Messages_es.properties b/resources/lang/Messages_es.properties
index a4594dc..150a407 100644
--- a/resources/lang/Messages_es.properties
+++ b/resources/lang/Messages_es.properties
@@ -1434,5 +1434,5 @@ label.tftype_default = Default
label.tftype_plddt = pLDDT
label.add_pae_matrix_file = Añadir un fichero de matriz PAE
label.nothing_selected = Nada seleccionado
-prompt.google_analytics_title = Jalview Estadísticas de Uso
-prompt.google_analytics = ¿Quiere ayudar a mejorar Jalview habilitando la recopilación de estadísticas de uso con Google Analytics?\nPuede habilitar o deshabilitar el seguimiento de uso en las preferencias.
+prompt.analytics_title = Jalview Estadísticas de Uso
+prompt.analytics = ¿Quiere ayudar a mejorar Jalview habilitando la recopilación de estadísticas de uso con análisis Plausible?\nPuede habilitar o deshabilitar el seguimiento de uso en las preferencias.
diff --git a/src/jalview/analysis/AlignmentUtils.java b/src/jalview/analysis/AlignmentUtils.java
index 1158c53..6ab49b2 100644
--- a/src/jalview/analysis/AlignmentUtils.java
+++ b/src/jalview/analysis/AlignmentUtils.java
@@ -1512,7 +1512,7 @@ public class AlignmentUtils
* @param alignment
* the alignment to add them to
* @param selectionGroup
- * current selection group (or null if none)
+ * current selection group - may be null, if provided then any added annotation will be trimmed to just those columns in the selection group
*/
public static void addReferenceAnnotations(
Map> annotations,
@@ -1536,7 +1536,7 @@ public class AlignmentUtils
* @param seq
* @param ann
* @param selectionGroup
- * - may be null
+ * current selection group - may be null, if provided then any added annotation will be trimmed to just those columns in the selection group
* @return annotation added to {@code seq and {@code alignment}
*/
public static AlignmentAnnotation addReferenceAnnotationTo(
diff --git a/src/jalview/analytics/GoogleAnalytics4.java b/src/jalview/analytics/Plausible.java
similarity index 55%
rename from src/jalview/analytics/GoogleAnalytics4.java
rename to src/jalview/analytics/Plausible.java
index ba8a920..ab2de77 100644
--- a/src/jalview/analytics/GoogleAnalytics4.java
+++ b/src/jalview/analytics/Plausible.java
@@ -1,8 +1,31 @@
+/*
+ * Jalview - A Sequence Alignment Editor and Viewer ($$Version-Rel$$)
+ * Copyright (C) $$Year-Rel$$ The Jalview Authors
+ *
+ * This file is part of Jalview.
+ *
+ * Jalview is free software: you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation, either version 3
+ * of the License, or (at your option) any later version.
+ *
+ * Jalview is distributed in the hope that it will be useful, but
+ * WITHOUT ANY WARRANTY; without even the implied warranty
+ * of MERCHANTABILITY or FITNESS FOR A PARTICULAR
+ * PURPOSE. See the GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Jalview. If not, see .
+ * The Jalview Authors are detailed in the 'AUTHORS' file.
+ */
package jalview.analytics;
+import java.io.BufferedReader;
import java.io.IOException;
+import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
+import java.lang.invoke.MethodHandles;
import java.net.HttpURLConnection;
import java.net.MalformedURLException;
import java.net.URL;
@@ -17,75 +40,94 @@ import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.Random;
-import java.util.UUID;
import jalview.bin.Cache;
import jalview.bin.Console;
import jalview.util.ChannelProperties;
+import jalview.util.HttpUtils;
-public class GoogleAnalytics4
+public class Plausible
{
+ private static final String USER_AGENT;
+
private static final String JALVIEW_ID = "Jalview Desktop";
- private static final String SESSION_ID = new Random().toString();
+ private static final String DOMAIN = "jalview.org";
- private static final String MEASUREMENT_ID = "G-6TMPHMXEQ0";
+ private static final String CONFIG_API_BASE_URL = "https://www.jalview.org/services/config/analytics/url";
- private static final String API_SECRET = "Qb9NSbqkRDqizG6j2BBJ2g";
+ private static final String DEFAULT_API_BASE_URL = "https://analytics.jalview.org/api/event";
- // This will generate a different CLIENT_ID each time the application is
- // launched. Do we want to store it in .jalview_properties?
- private static final String CLIENT_ID = UUID.randomUUID().toString();
+ private static final String API_BASE_URL;
- private static final String BASE_URL = "https://www.google-analytics.com/mp/collect";
+ private static final String clientId;
- private static final String DESKTOP_EVENT = "desktop_event";
+ public static final String APPLICATION_BASE_URL = "desktop://localhost";
private List> queryStringValues;
private List> jsonObject;
- private List events;
-
private List> cookieValues;
private static boolean ENABLED = false;
- private static GoogleAnalytics4 instance = null;
+ private static boolean DEBUG = true;
- private static final Map defaultParams;
+ private static Plausible instance = null;
+
+ private static final Map defaultProps;
static
{
- defaultParams = new HashMap<>();
- defaultParams.put("app_name",
+ defaultProps = new HashMap<>();
+ defaultProps.put("app_name",
ChannelProperties.getProperty("app_name") + " Desktop");
- defaultParams.put("version", Cache.getProperty("VERSION"));
- defaultParams.put("build_date",
+ defaultProps.put("version", Cache.getProperty("VERSION"));
+ defaultProps.put("build_date",
Cache.getDefault("BUILD_DATE", "unknown"));
- defaultParams.put("java_version", System.getProperty("java.version"));
+ defaultProps.put("java_version", System.getProperty("java.version"));
String val = System.getProperty("sys.install4jVersion");
if (val != null)
{
- defaultParams.put("install4j_version", val);
+ defaultProps.put("install4j_version", val);
}
val = System.getProperty("installer_template_version");
if (val != null)
{
- defaultParams.put("install4j_template_version", val);
+ defaultProps.put("install4j_template_version", val);
}
val = System.getProperty("launcher_version");
if (val != null)
{
- defaultParams.put("launcher_version", val);
+ defaultProps.put("launcher_version", val);
}
- defaultParams.put("java_arch",
+ defaultProps.put("java_arch",
System.getProperty("os.arch") + " "
+ System.getProperty("os.name") + " "
+ System.getProperty("os.version"));
+ defaultProps.put("os", System.getProperty("os.name"));
+ defaultProps.put("os_version", System.getProperty("os.version"));
+ defaultProps.put("os_arch", System.getProperty("os.arch"));
+ String installation = Cache.applicationProperties
+ .getProperty("INSTALLATION");
+ if (installation != null)
+ {
+ defaultProps.put("installation", installation);
+ }
+
+ // ascertain the API_BASE_URL
+ API_BASE_URL = getAPIBaseURL();
+
+ // random clientId to make User-Agent unique (to register analytic)
+ clientId = String.format("%08x", new Random().nextInt());
+
+ USER_AGENT = HttpUtils.getUserAgent(
+ MethodHandles.lookup().lookupClass().getCanonicalName() + " "
+ + clientId);
}
- private GoogleAnalytics4()
+ private Plausible()
{
this.resetLists();
}
@@ -95,72 +137,79 @@ public class GoogleAnalytics4
ENABLED = b;
}
- public void sendAnalytics(String eventName, String... paramsStrings)
+ public void sendEvent(String eventName, String urlString,
+ String... propsStrings)
{
- sendAnalytics(eventName, false, paramsStrings);
+ sendEvent(eventName, urlString, false, propsStrings);
}
/**
* The simplest way to send an analytic event.
*
* @param eventName
- * The event name. To emulate a webpage view use "page_view" and set
- * a "page_location" parameter. See
- * https://developers.google.com/analytics/devguides/collection/ga4/events?client_type=gtag
- * @param sendDefaultParams
- * Flag whether to add the default params about the application.
- * @param paramsStrings
+ * The event name. To emulate a webpage view use "pageview" and set a
+ * "url" key/value. See https://plausible.io/docs/events-api
+ * @param sendDefaultProps
+ * Flag whether to add the default props about the application.
+ * @param propsStrings
* Optional multiple Strings in key, value pairs (there should be an
- * even number of paramsStrings) to be set as parameters of the
- * event. To emulate a webpage view use "page_location" as the URL in
- * a "page_view" event.
+ * even number of propsStrings) to be set as property of the event.
+ * To emulate a webpage view set "url" as the URL in a "pageview"
+ * event.
*/
- public void sendAnalytics(String eventName, boolean sendDefaultParams,
- String... paramsStrings)
+ public void sendEvent(String eventName, String urlString,
+ boolean sendDefaultProps, String... propsStrings)
{
// clear out old lists
this.resetLists();
if (!ENABLED)
{
- Console.debug("GoogleAnalytics4 not enabled.");
+ Console.debug("Plausible not enabled.");
return;
}
- Map params = new HashMap<>();
- params.put("event_category", DESKTOP_EVENT);
- params.put("event_label", eventName);
+ Map props = new HashMap<>();
// add these to all events from this application instance
- if (sendDefaultParams)
+ if (sendDefaultProps)
{
- params.putAll(defaultParams);
+ props.putAll(defaultProps);
}
- // add (and overwrite with) the passed in params
- if (paramsStrings != null && paramsStrings.length > 0)
+ // add (and overwrite with) the passed in props
+ if (propsStrings != null && propsStrings.length > 0)
{
- if (paramsStrings.length % 2 != 0)
+ if (propsStrings.length % 2 != 0)
{
Console.warn(
- "Cannot addEvent with odd number of paramsStrings. Ignoring the last one.");
+ "Cannot addEvent with odd number of propsStrings. Ignoring the last one.");
}
- for (int i = 0; i < paramsStrings.length - 1; i += 2)
+ for (int i = 0; i < propsStrings.length - 1; i += 2)
{
- String key = paramsStrings[i];
- String value = paramsStrings[i + 1];
- params.put(key, value);
+ String key = propsStrings[i];
+ String value = propsStrings[i + 1];
+ props.put(key, value);
}
}
- addEvent(eventName, params);
- addQueryStringValue("measurement_id", MEASUREMENT_ID);
- addQueryStringValue("api_secret", API_SECRET);
- addJsonValue("client_id", CLIENT_ID);
- addJsonValues("events", Event.toObjectList(events));
+ addJsonValue("domain", DOMAIN);
+ addJsonValue("name", eventName);
+ StringBuilder eventUrlSb = new StringBuilder(APPLICATION_BASE_URL);
+ if (!APPLICATION_BASE_URL.endsWith("/") && !urlString.startsWith("/"))
+ {
+ eventUrlSb.append("/");
+ }
+ eventUrlSb.append(urlString);
+ addJsonValue("url", eventUrlSb.toString());
+ addJsonObject("props", props);
StringBuilder urlSb = new StringBuilder();
- urlSb.append(BASE_URL);
- urlSb.append('?');
- urlSb.append(buildQueryString());
+ urlSb.append(API_BASE_URL);
+ String qs = buildQueryString();
+ if (qs != null && qs.length() > 0)
+ {
+ urlSb.append('?');
+ urlSb.append(qs);
+ }
try
{
URL url = new URL(urlSb.toString());
@@ -171,15 +220,21 @@ public class GoogleAnalytics4
String jsonString = buildJson();
- Console.debug("GA4: HTTP Request is: '" + urlSb.toString() + "'");
- Console.debug("GA4: POSTed JSON is:\n" + jsonString);
+ Console.debug(
+ "Plausible: HTTP Request is: '" + urlSb.toString() + "'");
+ if (DEBUG)
+ {
+ Console.debug("Plausible: User-Agent is: '" + USER_AGENT + "'");
+ }
+ Console.debug("Plausible: POSTed JSON is:\n" + jsonString);
byte[] jsonBytes = jsonString.getBytes(StandardCharsets.UTF_8);
int jsonLength = jsonBytes.length;
httpURLConnection.setFixedLengthStreamingMode(jsonLength);
httpURLConnection.setRequestProperty("Content-Type",
- "application/json; charset=UTF-8");
+ "application/json");
+ httpURLConnection.setRequestProperty("User-Agent", USER_AGENT);
httpURLConnection.connect();
try (OutputStream os = httpURLConnection.getOutputStream())
{
@@ -187,50 +242,63 @@ public class GoogleAnalytics4
}
int responseCode = httpURLConnection.getResponseCode();
String responseMessage = httpURLConnection.getResponseMessage();
+
if (responseCode < 200 || responseCode > 299)
{
- Console.warn("GoogleAnalytics4 connection failed: '" + responseCode
- + " " + responseMessage + "'");
+ Console.warn("Plausible connection failed: '" + responseCode + " "
+ + responseMessage + "'");
}
else
{
- Console.debug("GoogleAnalytics4 connection succeeded: '"
- + responseCode + " " + responseMessage + "'");
+ Console.debug("Plausible connection succeeded: '" + responseCode
+ + " " + responseMessage + "'");
+ }
+
+ if (DEBUG)
+ {
+ BufferedReader br = new BufferedReader(new InputStreamReader(
+ (httpURLConnection.getInputStream())));
+ StringBuilder sb = new StringBuilder();
+ String response;
+ while ((response = br.readLine()) != null)
+ {
+ sb.append(response);
+ }
+ String body = sb.toString();
+ Console.debug("Plausible response content:\n" + body);
}
} catch (MalformedURLException e)
{
Console.debug(
- "Somehow the GoogleAnalytics4 BASE_URL and queryString is malformed.",
+ "Somehow the Plausible BASE_URL and queryString is malformed: '"
+ + urlSb.toString() + "'",
e);
return;
} catch (IOException e)
{
- Console.debug("Connection to GoogleAnalytics4 BASE_URL '" + BASE_URL
+ Console.debug("Connection to Plausible BASE_URL '" + API_BASE_URL
+ "' failed.", e);
} catch (ClassCastException e)
{
Console.debug(
- "Couldn't cast URLConnection to HttpURLConnection in GoogleAnalytics4.",
+ "Couldn't cast URLConnection to HttpURLConnection in Plausible.",
e);
}
}
- public void addEvent(String name, Map params)
+ private void addJsonObject(String key, Map map)
{
- Event event = new Event(name);
- if (params != null && params.size() > 0)
+ List> list = new ArrayList<>();
+ for (String k : map.keySet())
{
- for (String key : params.keySet())
- {
- String value = params.get(key);
- event.addParam(key, value);
- }
+ list.add(stringEntry(k, map.get(k)));
}
- events.add(event);
+ addJsonObject(key, list);
+
}
private void addJsonObject(String key,
- List> object)
+ List> object)
{
jsonObject.add(objectEntry(key, object));
}
@@ -268,16 +336,15 @@ public class GoogleAnalytics4
private void resetLists()
{
jsonObject = new ArrayList<>();
- events = new ArrayList();
queryStringValues = new ArrayList<>();
cookieValues = new ArrayList<>();
}
- public static GoogleAnalytics4 getInstance()
+ public static Plausible getInstance()
{
if (instance == null)
{
- instance = new GoogleAnalytics4();
+ instance = new Plausible();
}
return instance;
}
@@ -480,52 +547,56 @@ public class GoogleAnalytics4
{
return new AbstractMap.SimpleEntry(s, v);
}
-}
-
-class Event
-{
- private String name;
- private List> params;
-
- @SafeVarargs
- public Event(String name, Map.Entry... paramEntries)
+ private static String getAPIBaseURL()
{
- this.name = name;
- this.params = new ArrayList>();
- for (Map.Entry paramEntry : paramEntries)
+ try
{
- if (paramEntry == null)
+ URL url = new URL(CONFIG_API_BASE_URL);
+ URLConnection urlConnection = url.openConnection();
+ HttpURLConnection httpURLConnection = (HttpURLConnection) urlConnection;
+ httpURLConnection.setRequestMethod("GET");
+ httpURLConnection.setRequestProperty("User-Agent", USER_AGENT);
+ httpURLConnection.setConnectTimeout(5000);
+ httpURLConnection.setReadTimeout(3000);
+ httpURLConnection.connect();
+ int responseCode = httpURLConnection.getResponseCode();
+ String responseMessage = httpURLConnection.getResponseMessage();
+
+ if (responseCode < 200 || responseCode > 299)
{
- continue;
+ Console.warn("Config URL connection to '" + CONFIG_API_BASE_URL
+ + "' failed: '" + responseCode + " " + responseMessage
+ + "'");
}
- params.add(paramEntry);
- }
- }
- public void addParam(String param, String value)
- {
- params.add(GoogleAnalytics4.stringEntry(param, value));
- }
+ BufferedReader br = new BufferedReader(
+ new InputStreamReader((httpURLConnection.getInputStream())));
+ StringBuilder sb = new StringBuilder();
+ String response;
+ while ((response = br.readLine()) != null)
+ {
+ sb.append(response);
+ }
+ if (sb.length() > 7 && sb.substring(0, 5).equals("https"))
+ {
+ return sb.toString();
+ }
- protected List> toObject()
- {
- List> object = new ArrayList<>();
- object.add(GoogleAnalytics4.objectEntry("name", (Object) name));
- if (params.size() > 0)
+ } catch (MalformedURLException e)
{
- object.add(GoogleAnalytics4.objectEntry("params", (Object) params));
- }
- return object;
- }
-
- protected static List