1 package jalview.analytics;
3 import java.io.IOException;
4 import java.io.OutputStream;
5 import java.net.HttpURLConnection;
6 import java.net.MalformedURLException;
8 import java.net.URLConnection;
9 import java.net.URLEncoder;
10 import java.nio.charset.StandardCharsets;
11 import java.util.AbstractMap;
12 import java.util.ArrayList;
13 import java.util.HashMap;
14 import java.util.Iterator;
15 import java.util.List;
17 import java.util.Random;
18 import java.util.UUID;
20 import jalview.bin.Cache;
21 import jalview.bin.Console;
22 import jalview.util.ChannelProperties;
24 public class GoogleAnalytics4
26 private static final String JALVIEW_ID = "Jalview Desktop";
28 private static final String SESSION_ID = new Random().toString();
30 private static final String MEASUREMENT_ID = "G-6TMPHMXEQ0";
32 private static final String API_SECRET = "Qb9NSbqkRDqizG6j2BBJ2g";
34 // This will generate a different CLIENT_ID each time the application is
35 // launched. Do we want to store it in .jalview_properties?
36 private static final String CLIENT_ID = UUID.randomUUID().toString();
38 private static final String BASE_URL = "https://www.google-analytics.com/mp/collect";
40 private List<Map.Entry<String, String>> queryStringValues;
42 private List<Map.Entry<String, Object>> jsonObject;
44 private List<Event> events;
46 private List<Map.Entry<String, String>> cookieValues;
48 private static boolean ENABLED = false;
50 private static GoogleAnalytics4 instance = null;
52 private static final Map<String, String> defaultParams;
56 defaultParams = new HashMap<>();
57 defaultParams.put("app_name",
58 ChannelProperties.getProperty("app_name") + " Desktop");
59 defaultParams.put("version", Cache.getProperty("VERSION"));
60 defaultParams.put("build_date",
61 Cache.getDefault("BUILD_DATE", "unknown"));
62 defaultParams.put("java_version", System.getProperty("java.version"));
63 String val = System.getProperty("sys.install4jVersion");
66 defaultParams.put("install4j_version", val);
68 val = System.getProperty("installer_template_version");
71 defaultParams.put("install4j_template_version", val);
73 val = System.getProperty("launcher_version");
76 defaultParams.put("launcher_version", val);
78 defaultParams.put("java_arch",
79 System.getProperty("os.arch") + " "
80 + System.getProperty("os.name") + " "
81 + System.getProperty("os.version"));
84 private GoogleAnalytics4()
89 public static void setEnabled(boolean b)
95 * The simplest way to send an analytic event.
98 * The event name. To emulate a webpage view use "page_view" and set
99 * a "page_location" parameter. See
100 * https://developers.google.com/analytics/devguides/collection/ga4/events?client_type=gtag
101 * @param paramsStrings
102 * Optional multiple Strings in key, value pairs (there should be an
103 * even number of paramsStrings) to be set as parameters of the
104 * event. To emulate a webpage view use "page_location" as the URL in
105 * a "page_view" event.
107 public void sendAnalytics(String eventName, String... paramsStrings)
109 // clear out old lists
114 Console.debug("GoogleAnalytics4 not enabled.");
117 Map<String, String> params = new HashMap<>();
119 // add these to all events from this application instance
120 params.putAll(defaultParams);
122 // add (and overwrite with) the passed in params
123 if (paramsStrings != null && paramsStrings.length > 0)
125 if (paramsStrings.length % 2 != 0)
128 "Cannot addEvent with odd number of paramsStrings. Ignoring the last one.");
130 for (int i = 0; i < paramsStrings.length - 1; i += 2)
132 String key = paramsStrings[i];
133 String value = paramsStrings[i + 1];
134 params.put(key, value);
138 addEvent(eventName, params);
139 addQueryStringValue("measurement_id", MEASUREMENT_ID);
140 addQueryStringValue("api_secret", API_SECRET);
141 addJsonValue("client_id", CLIENT_ID);
142 addJsonValues("events", Event.toObjectList(events));
143 StringBuilder urlSb = new StringBuilder();
144 urlSb.append(BASE_URL);
146 urlSb.append(buildQueryString());
149 URL url = new URL(urlSb.toString());
150 URLConnection urlConnection = url.openConnection();
151 HttpURLConnection httpURLConnection = (HttpURLConnection) urlConnection;
152 httpURLConnection.setRequestMethod("POST");
153 httpURLConnection.setDoOutput(true);
155 String jsonString = buildJson();
157 Console.debug("GA4: HTTP Request is: '" + urlSb.toString() + "'");
158 Console.debug("GA4: POSTed JSON is:\n" + jsonString);
160 byte[] jsonBytes = jsonString.getBytes(StandardCharsets.UTF_8);
161 int jsonLength = jsonBytes.length;
163 httpURLConnection.setFixedLengthStreamingMode(jsonLength);
164 httpURLConnection.setRequestProperty("Content-Type",
165 "application/json; charset=UTF-8");
166 httpURLConnection.connect();
167 try (OutputStream os = httpURLConnection.getOutputStream())
171 int responseCode = httpURLConnection.getResponseCode();
172 String responseMessage = httpURLConnection.getResponseMessage();
173 if (responseCode < 200 || responseCode > 299)
175 Console.warn("GoogleAnalytics4 connection failed: '" + responseCode
176 + " " + responseMessage + "'");
180 Console.debug("GoogleAnalytics4 connection succeeded: '"
181 + responseCode + " " + responseMessage + "'");
183 } catch (MalformedURLException e)
186 "Somehow the GoogleAnalytics4 BASE_URL and queryString is malformed.",
189 } catch (IOException e)
191 Console.debug("Connection to GoogleAnalytics4 BASE_URL '" + BASE_URL
193 } catch (ClassCastException e)
196 "Couldn't cast URLConnection to HttpURLConnection in GoogleAnalytics4.",
201 public void addEvent(String name, Map<String, String> params)
203 Event event = new Event(name);
204 if (params != null && params.size() > 0)
206 for (String key : params.keySet())
208 String value = params.get(key);
209 event.addParam(key, value);
215 private void addJsonObject(String key,
216 List<Map.Entry<String, Object>> object)
218 jsonObject.add(objectEntry(key, object));
221 private void addJsonValues(String key, List<Object> values)
223 jsonObject.add(objectEntry(key, values));
226 private void addJsonValue(String key, String value)
228 jsonObject.add(objectEntry(key, value));
231 private void addJsonValue(String key, int value)
233 jsonObject.add(objectEntry(key, Integer.valueOf(value)));
236 private void addJsonValue(String key, boolean value)
238 jsonObject.add(objectEntry(key, Boolean.valueOf(value)));
241 private void addQueryStringValue(String key, String value)
243 queryStringValues.add(stringEntry(key, value));
246 private void addCookieValue(String key, String value)
248 cookieValues.add(stringEntry(key, value));
251 private void resetLists()
253 jsonObject = new ArrayList<>();
254 events = new ArrayList<Event>();
255 queryStringValues = new ArrayList<>();
256 cookieValues = new ArrayList<>();
259 public static GoogleAnalytics4 getInstance()
261 if (instance == null)
263 instance = new GoogleAnalytics4();
268 public static void reset()
270 getInstance().resetLists();
273 private String buildQueryString()
275 StringBuilder sb = new StringBuilder();
276 for (Map.Entry<String, String> entry : queryStringValues)
282 sb.append(URLEncoder.encode(entry.getKey(), StandardCharsets.UTF_8));
285 URLEncoder.encode(entry.getValue(), StandardCharsets.UTF_8));
287 return sb.toString();
290 private void buildCookieHeaders()
292 // TODO not needed yet
295 private String buildJson()
297 StringBuilder sb = new StringBuilder();
298 addJsonObject(sb, 0, jsonObject);
299 return sb.toString();
302 private void addJsonObject(StringBuilder sb, int indent,
303 List<Map.Entry<String, Object>> entries)
308 Iterator<Map.Entry<String, Object>> entriesI = entries.iterator();
309 while (entriesI.hasNext())
311 Map.Entry<String, Object> entry = entriesI.next();
312 String key = entry.getKey();
313 // TODO sensibly escape " characters in key
314 Object value = entry.getValue();
315 indent(sb, indent + 1);
316 sb.append('"').append(quoteEscape(key)).append('"').append(':');
318 if (value != null && value instanceof List)
322 addJsonValue(sb, indent + 2, value);
323 if (entriesI.hasNext())
333 private void addJsonValue(StringBuilder sb, int indent, Object value)
341 if (value instanceof Map.Entry)
343 Map.Entry<String, Object> entry = (Map.Entry<String, Object>) value;
344 List<Map.Entry<String, Object>> object = new ArrayList<>();
346 addJsonObject(sb, indent, object);
348 else if (value instanceof List)
350 // list of Map.Entries or list of values?
351 List<Object> valueList = (List<Object>) value;
352 if (valueList.size() > 0 && valueList.get(0) instanceof Map.Entry)
355 // indent(sb, indent);
356 List<Map.Entry<String, Object>> entryList = (List<Map.Entry<String, Object>>) value;
357 addJsonObject(sb, indent, entryList);
365 Iterator<Object> valueListI = valueList.iterator();
366 while (valueListI.hasNext())
368 Object v = valueListI.next();
369 addJsonValue(sb, indent + 1, v);
370 if (valueListI.hasNext())
380 else if (value instanceof String)
382 sb.append('"').append(quoteEscape((String) value)).append('"');
384 else if (value instanceof Integer)
386 sb.append(((Integer) value).toString());
388 else if (value instanceof Boolean)
390 sb.append('"').append(((Boolean) value).toString()).append('"');
392 } catch (ClassCastException e)
395 "Could not deal with type of json Object " + value.toString(),
400 private static String quoteEscape(String s)
406 // this escapes quotation marks (") that aren't already escaped (in the
407 // string) ready to go into a quoted JSON string value
408 return s.replaceAll("((?<!\\\\)(?:\\\\{2})*)\"", "$1\\\\\"");
411 private static void prettyWhitespace(StringBuilder sb, String whitespace,
414 // only add whitespace if we're in DEBUG mode
415 if (!Console.getLogger().isDebugEnabled())
419 if (repeat >= 0 && whitespace != null)
421 sb.append(whitespace.repeat(repeat));
425 sb.append(whitespace);
429 private static void indent(StringBuilder sb, int indent)
431 prettyWhitespace(sb, " ", indent);
434 private static void newline(StringBuilder sb)
436 prettyWhitespace(sb, "\n", -1);
439 private static void space(StringBuilder sb)
441 prettyWhitespace(sb, " ", -1);
444 protected static Map.Entry<String, Object> objectEntry(String s, Object o)
446 return new AbstractMap.SimpleEntry<String, Object>(s, o);
449 protected static Map.Entry<String, String> stringEntry(String s, String v)
451 return new AbstractMap.SimpleEntry<String, String>(s, v);
459 private List<Map.Entry<String, String>> params;
462 public Event(String name, Map.Entry<String, String>... paramEntries)
465 this.params = new ArrayList<Map.Entry<String, String>>();
466 for (Map.Entry<String, String> paramEntry : paramEntries)
468 if (paramEntry == null)
472 params.add(paramEntry);
476 public void addParam(String param, String value)
478 params.add(GoogleAnalytics4.stringEntry(param, value));
481 protected List<Map.Entry<String, Object>> toObject()
483 List<Map.Entry<String, Object>> object = new ArrayList<>();
484 object.add(GoogleAnalytics4.objectEntry("name", (Object) name));
485 if (params.size() > 0)
487 object.add(GoogleAnalytics4.objectEntry("params", (Object) params));
492 protected static List<Object> toObjectList(List<Event> events)
494 List<Object> eventObjectList = new ArrayList<>();
495 for (Event event : events)
497 eventObjectList.add((Object) event.toObject());
499 return eventObjectList;