X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=src%2Fjalview%2Fanalytics%2FPlausible.java;fp=src%2Fjalview%2Fanalytics%2FPlausible.java;h=ab2de77c24fcbc4c2aabf026a6633011980530d7;hb=cfd38a33612b73a5b050c9f19d0fb0d81a7b646a;hp=0000000000000000000000000000000000000000;hpb=de9592c0781569ccefd4c115bb36524d6c9deaab;p=jalview.git
diff --git a/src/jalview/analytics/Plausible.java b/src/jalview/analytics/Plausible.java
new file mode 100644
index 0000000..ab2de77
--- /dev/null
+++ b/src/jalview/analytics/Plausible.java
@@ -0,0 +1,602 @@
+/*
+ * 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;
+import java.net.URLConnection;
+import java.net.URLEncoder;
+import java.nio.charset.StandardCharsets;
+import java.util.AbstractMap;
+import java.util.ArrayList;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+import java.util.Random;
+
+import jalview.bin.Cache;
+import jalview.bin.Console;
+import jalview.util.ChannelProperties;
+import jalview.util.HttpUtils;
+
+public class Plausible
+{
+ private static final String USER_AGENT;
+
+ private static final String JALVIEW_ID = "Jalview Desktop";
+
+ private static final String DOMAIN = "jalview.org";
+
+ private static final String CONFIG_API_BASE_URL = "https://www.jalview.org/services/config/analytics/url";
+
+ private static final String DEFAULT_API_BASE_URL = "https://analytics.jalview.org/api/event";
+
+ private static final String API_BASE_URL;
+
+ private static final String clientId;
+
+ public static final String APPLICATION_BASE_URL = "desktop://localhost";
+
+ private List> queryStringValues;
+
+ private List> jsonObject;
+
+ private List> cookieValues;
+
+ private static boolean ENABLED = false;
+
+ private static boolean DEBUG = true;
+
+ private static Plausible instance = null;
+
+ private static final Map defaultProps;
+
+ static
+ {
+ defaultProps = new HashMap<>();
+ defaultProps.put("app_name",
+ ChannelProperties.getProperty("app_name") + " Desktop");
+ defaultProps.put("version", Cache.getProperty("VERSION"));
+ defaultProps.put("build_date",
+ Cache.getDefault("BUILD_DATE", "unknown"));
+ defaultProps.put("java_version", System.getProperty("java.version"));
+ String val = System.getProperty("sys.install4jVersion");
+ if (val != null)
+ {
+ defaultProps.put("install4j_version", val);
+ }
+ val = System.getProperty("installer_template_version");
+ if (val != null)
+ {
+ defaultProps.put("install4j_template_version", val);
+ }
+ val = System.getProperty("launcher_version");
+ if (val != null)
+ {
+ defaultProps.put("launcher_version", val);
+ }
+ 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 Plausible()
+ {
+ this.resetLists();
+ }
+
+ public static void setEnabled(boolean b)
+ {
+ ENABLED = b;
+ }
+
+ public void sendEvent(String eventName, String urlString,
+ String... propsStrings)
+ {
+ sendEvent(eventName, urlString, false, propsStrings);
+ }
+
+ /**
+ * The simplest way to send an analytic event.
+ *
+ * @param eventName
+ * 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 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 sendEvent(String eventName, String urlString,
+ boolean sendDefaultProps, String... propsStrings)
+ {
+ // clear out old lists
+ this.resetLists();
+
+ if (!ENABLED)
+ {
+ Console.debug("Plausible not enabled.");
+ return;
+ }
+ Map props = new HashMap<>();
+
+ // add these to all events from this application instance
+ if (sendDefaultProps)
+ {
+ props.putAll(defaultProps);
+ }
+
+ // add (and overwrite with) the passed in props
+ if (propsStrings != null && propsStrings.length > 0)
+ {
+ if (propsStrings.length % 2 != 0)
+ {
+ Console.warn(
+ "Cannot addEvent with odd number of propsStrings. Ignoring the last one.");
+ }
+ for (int i = 0; i < propsStrings.length - 1; i += 2)
+ {
+ String key = propsStrings[i];
+ String value = propsStrings[i + 1];
+ props.put(key, value);
+ }
+ }
+
+ 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(API_BASE_URL);
+ String qs = buildQueryString();
+ if (qs != null && qs.length() > 0)
+ {
+ urlSb.append('?');
+ urlSb.append(qs);
+ }
+ try
+ {
+ URL url = new URL(urlSb.toString());
+ URLConnection urlConnection = url.openConnection();
+ HttpURLConnection httpURLConnection = (HttpURLConnection) urlConnection;
+ httpURLConnection.setRequestMethod("POST");
+ httpURLConnection.setDoOutput(true);
+
+ String jsonString = buildJson();
+
+ 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");
+ httpURLConnection.setRequestProperty("User-Agent", USER_AGENT);
+ httpURLConnection.connect();
+ try (OutputStream os = httpURLConnection.getOutputStream())
+ {
+ os.write(jsonBytes);
+ }
+ int responseCode = httpURLConnection.getResponseCode();
+ String responseMessage = httpURLConnection.getResponseMessage();
+
+ if (responseCode < 200 || responseCode > 299)
+ {
+ Console.warn("Plausible connection failed: '" + responseCode + " "
+ + responseMessage + "'");
+ }
+ else
+ {
+ 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 Plausible BASE_URL and queryString is malformed: '"
+ + urlSb.toString() + "'",
+ e);
+ return;
+ } catch (IOException e)
+ {
+ Console.debug("Connection to Plausible BASE_URL '" + API_BASE_URL
+ + "' failed.", e);
+ } catch (ClassCastException e)
+ {
+ Console.debug(
+ "Couldn't cast URLConnection to HttpURLConnection in Plausible.",
+ e);
+ }
+ }
+
+ private void addJsonObject(String key, Map map)
+ {
+ List> list = new ArrayList<>();
+ for (String k : map.keySet())
+ {
+ list.add(stringEntry(k, map.get(k)));
+ }
+ addJsonObject(key, list);
+
+ }
+
+ private void addJsonObject(String key,
+ List> object)
+ {
+ jsonObject.add(objectEntry(key, object));
+ }
+
+ private void addJsonValues(String key, List