1 package jalview.analytics;
3 import java.io.BufferedReader;
4 import java.io.IOException;
5 import java.io.InputStreamReader;
6 import java.io.OutputStream;
7 import java.io.UnsupportedEncodingException;
8 import java.lang.invoke.MethodHandles;
9 import java.net.HttpURLConnection;
10 import java.net.MalformedURLException;
12 import java.net.URLConnection;
13 import java.net.URLEncoder;
14 import java.nio.charset.StandardCharsets;
15 import java.util.AbstractMap;
16 import java.util.ArrayList;
17 import java.util.Collections;
18 import java.util.HashMap;
19 import java.util.Iterator;
20 import java.util.List;
23 import jalview.bin.Cache;
24 import jalview.bin.Console;
25 import jalview.bin.Jalview;
26 import jalview.util.ChannelProperties;
27 import jalview.util.HttpUtils;
29 public class Plausible
31 private static final String USER_AGENT = HttpUtils.getUserAgent(
32 MethodHandles.lookup().lookupClass().getCanonicalName());
34 private static final String JALVIEW_ID = "Jalview Desktop";
36 private static final String DOMAIN = "jalview.org";
38 private static final String API_BASE_URL = "https://plausible.io/api/event";
40 public static final String APPLICATION_BASE_URL = "desktop://localhost";
42 private List<Map.Entry<String, String>> queryStringValues;
44 private List<Map.Entry<String, Object>> jsonObject;
46 private List<Event> events;
48 private List<Map.Entry<String, String>> cookieValues;
50 private static boolean ENABLED = false;
52 private static boolean DEBUG = true;
54 private static Plausible instance = null;
56 private static final Map<String, String> defaultParams;
60 defaultParams = new HashMap<>();
61 defaultParams.put("app_name",
62 ChannelProperties.getProperty("app_name") + " Desktop");
63 defaultParams.put("version", Cache.getProperty("VERSION"));
64 defaultParams.put("build_date",
65 Cache.getDefault("BUILD_DATE", "unknown"));
66 defaultParams.put("java_version", System.getProperty("java.version"));
67 String val = System.getProperty("sys.install4jVersion");
70 defaultParams.put("install4j_version", val);
72 val = System.getProperty("installer_template_version");
75 defaultParams.put("install4j_template_version", val);
77 val = System.getProperty("launcher_version");
80 defaultParams.put("launcher_version", val);
82 defaultParams.put("java_arch",
83 System.getProperty("os.arch") + " "
84 + System.getProperty("os.name") + " "
85 + System.getProperty("os.version"));
93 public static void setEnabled(boolean b)
98 public void sendEvent(String eventName, String path,
99 String... paramsStrings)
101 sendEvent(eventName, path, false, paramsStrings);
105 * The simplest way to send an analytic event.
108 * The event name. To emulate a webpage view use "page_view" and set
109 * a "page_location" parameter. See
110 * https://developers.google.com/analytics/devguides/collection/ga4/events?client_type=gtag
111 * @param sendDefaultParams
112 * Flag whether to add the default params about the application.
113 * @param paramsStrings
114 * Optional multiple Strings in key, value pairs (there should be an
115 * even number of paramsStrings) to be set as parameters of the
116 * event. To emulate a webpage view use "page_location" as the URL in
117 * a "page_view" event.
119 public void sendEvent(String eventName, String path,
120 boolean sendDefaultParams, String... paramsStrings)
122 // clear out old lists
127 Console.debug("Plausible not enabled.");
130 Map<String, String> params = new HashMap<>();
132 // add these to all events from this application instance
133 if (sendDefaultParams)
135 params.putAll(defaultParams);
136 if (Jalview.isHeadlessMode())
138 params.put("headless", "true");
142 // add (and overwrite with) the passed in params
143 if (paramsStrings != null && paramsStrings.length > 0)
145 if (paramsStrings.length % 2 != 0)
148 "Cannot addEvent with odd number of paramsStrings. Ignoring the last one.");
150 for (int i = 0; i < paramsStrings.length - 1; i += 2)
152 String key = paramsStrings[i];
153 String value = paramsStrings[i + 1];
154 params.put(key, value);
158 addJsonValue("domain", DOMAIN);
159 addJsonValue("name", eventName);
160 StringBuilder recordedUrlSb = new StringBuilder(APPLICATION_BASE_URL);
161 if (!APPLICATION_BASE_URL.endsWith("/") && !path.startsWith("/"))
163 recordedUrlSb.append("/");
165 recordedUrlSb.append(path);
166 addJsonValue("url", recordedUrlSb.toString());
167 addEvent(eventName, params);
168 addJsonObject("props", params);
169 StringBuilder urlSb = new StringBuilder();
170 urlSb.append(API_BASE_URL);
171 String qs = buildQueryString();
172 if (qs != null && qs.length() > 0)
179 URL url = new URL(urlSb.toString());
180 URLConnection urlConnection = url.openConnection();
181 HttpURLConnection httpURLConnection = (HttpURLConnection) urlConnection;
182 httpURLConnection.setRequestMethod("POST");
183 httpURLConnection.setDoOutput(true);
185 String jsonString = buildJson();
188 "Plausible: HTTP Request is: '" + urlSb.toString() + "'");
191 Console.debug("Plausible: User-Agent is: '" + USER_AGENT + "'");
193 Console.debug("Plausible: POSTed JSON is:\n" + jsonString);
195 byte[] jsonBytes = jsonString.getBytes(StandardCharsets.UTF_8);
196 int jsonLength = jsonBytes.length;
198 httpURLConnection.setFixedLengthStreamingMode(jsonLength);
199 httpURLConnection.setRequestProperty("Content-Type",
201 httpURLConnection.setRequestProperty("User-Agent", USER_AGENT);
202 httpURLConnection.connect();
203 try (OutputStream os = httpURLConnection.getOutputStream())
207 int responseCode = httpURLConnection.getResponseCode();
208 String responseMessage = httpURLConnection.getResponseMessage();
210 if (responseCode < 200 || responseCode > 299)
212 Console.warn("Plausible connection failed: '" + responseCode + " "
213 + responseMessage + "'");
217 Console.debug("Plausible connection succeeded: '" + responseCode
218 + " " + responseMessage + "'");
223 BufferedReader br = new BufferedReader(new InputStreamReader(
224 (httpURLConnection.getInputStream())));
225 StringBuilder sb = new StringBuilder();
227 while ((response = br.readLine()) != null)
231 String body = sb.toString();
232 Console.debug("Plausible response content:\n" + body);
234 } catch (MalformedURLException e)
237 "Somehow the Plausible BASE_URL and queryString is malformed: '"
238 + urlSb.toString() + "'",
241 } catch (IOException e)
243 Console.debug("Connection to Plausible BASE_URL '" + API_BASE_URL
245 } catch (ClassCastException e)
248 "Couldn't cast URLConnection to HttpURLConnection in Plausible.",
253 public void addEvent(String name, Map<String, String> params)
255 Event event = new Event(name);
256 if (params != null && params.size() > 0)
258 for (String key : params.keySet())
260 String value = params.get(key);
261 event.addParam(key, value);
267 private void addJsonObject(String key, Map<String, String> map)
269 List<Map.Entry<String, ? extends Object>> list = new ArrayList<>();
270 for (String k : map.keySet())
272 list.add(stringEntry(k, map.get(k)));
274 addJsonObject(key, list);
278 private void addJsonObject(String key,
279 List<Map.Entry<String, ? extends Object>> object)
281 jsonObject.add(objectEntry(key, object));
284 private void addJsonValues(String key, List<Object> values)
286 jsonObject.add(objectEntry(key, values));
289 private void addJsonValue(String key, String value)
291 jsonObject.add(objectEntry(key, value));
294 private void addJsonValue(String key, int value)
296 jsonObject.add(objectEntry(key, Integer.valueOf(value)));
299 private void addJsonValue(String key, boolean value)
301 jsonObject.add(objectEntry(key, Boolean.valueOf(value)));
304 private void addQueryStringValue(String key, String value)
306 queryStringValues.add(stringEntry(key, value));
309 private void addCookieValue(String key, String value)
311 cookieValues.add(stringEntry(key, value));
314 private void resetLists()
316 jsonObject = new ArrayList<>();
317 events = new ArrayList<Event>();
318 queryStringValues = new ArrayList<>();
319 cookieValues = new ArrayList<>();
322 public static Plausible getInstance()
324 if (instance == null)
326 instance = new Plausible();
331 public static void reset()
333 getInstance().resetLists();
336 private String buildQueryString()
338 StringBuilder sb = new StringBuilder();
339 for (Map.Entry<String, String> entry : queryStringValues)
347 sb.append(URLEncoder.encode(entry.getKey(), "UTF-8"));
348 } catch (UnsupportedEncodingException e)
350 sb.append(entry.getKey());
355 sb.append(URLEncoder.encode(entry.getValue(), "UTF-8"));
356 } catch (UnsupportedEncodingException e)
358 sb.append(entry.getValue());
361 return sb.toString();
364 private void buildCookieHeaders()
366 // TODO not needed yet
369 private String buildJson()
371 StringBuilder sb = new StringBuilder();
372 addJsonObject(sb, 0, jsonObject);
373 return sb.toString();
376 private void addJsonObject(StringBuilder sb, int indent,
377 List<Map.Entry<String, Object>> entries)
382 Iterator<Map.Entry<String, Object>> entriesI = entries.iterator();
383 while (entriesI.hasNext())
385 Map.Entry<String, Object> entry = entriesI.next();
386 String key = entry.getKey();
387 // TODO sensibly escape " characters in key
388 Object value = entry.getValue();
389 indent(sb, indent + 1);
390 sb.append('"').append(quoteEscape(key)).append('"').append(':');
392 if (value != null && value instanceof List)
396 addJsonValue(sb, indent + 2, value);
397 if (entriesI.hasNext())
407 private void addJsonValue(StringBuilder sb, int indent, Object value)
415 if (value instanceof Map.Entry)
417 Map.Entry<String, Object> entry = (Map.Entry<String, Object>) value;
418 List<Map.Entry<String, Object>> object = new ArrayList<>();
420 addJsonObject(sb, indent, object);
422 else if (value instanceof List)
424 // list of Map.Entries or list of values?
425 List<Object> valueList = (List<Object>) value;
426 if (valueList.size() > 0 && valueList.get(0) instanceof Map.Entry)
429 // indent(sb, indent);
430 List<Map.Entry<String, Object>> entryList = (List<Map.Entry<String, Object>>) value;
431 addJsonObject(sb, indent, entryList);
439 Iterator<Object> valueListI = valueList.iterator();
440 while (valueListI.hasNext())
442 Object v = valueListI.next();
443 addJsonValue(sb, indent + 1, v);
444 if (valueListI.hasNext())
454 else if (value instanceof String)
456 sb.append('"').append(quoteEscape((String) value)).append('"');
458 else if (value instanceof Integer)
460 sb.append(((Integer) value).toString());
462 else if (value instanceof Boolean)
464 sb.append('"').append(((Boolean) value).toString()).append('"');
466 } catch (ClassCastException e)
469 "Could not deal with type of json Object " + value.toString(),
474 private static String quoteEscape(String s)
480 // this escapes quotation marks (") that aren't already escaped (in the
481 // string) ready to go into a quoted JSON string value
482 return s.replaceAll("((?<!\\\\)(?:\\\\{2})*)\"", "$1\\\\\"");
485 private static void prettyWhitespace(StringBuilder sb, String whitespace,
488 // only add whitespace if we're in DEBUG mode
489 if (!Console.getLogger().isDebugEnabled())
493 if (repeat >= 0 && whitespace != null)
495 // sb.append(whitespace.repeat(repeat));
496 sb.append(String.join("", Collections.nCopies(repeat, whitespace)));
501 sb.append(whitespace);
505 private static void indent(StringBuilder sb, int indent)
507 prettyWhitespace(sb, " ", indent);
510 private static void newline(StringBuilder sb)
512 prettyWhitespace(sb, "\n", -1);
515 private static void space(StringBuilder sb)
517 prettyWhitespace(sb, " ", -1);
520 protected static Map.Entry<String, Object> objectEntry(String s, Object o)
522 return new AbstractMap.SimpleEntry<String, Object>(s, o);
525 protected static Map.Entry<String, String> stringEntry(String s, String v)
527 return new AbstractMap.SimpleEntry<String, String>(s, v);