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 static final String DESKTOP_EVENT = "desktop_event";
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 GoogleAnalytics4 instance = null;
54 private static final Map<String, String> defaultParams;
58 defaultParams = new HashMap<>();
59 defaultParams.put("app_name",
60 ChannelProperties.getProperty("app_name") + " Desktop");
61 defaultParams.put("version", Cache.getProperty("VERSION"));
62 defaultParams.put("build_date",
63 Cache.getDefault("BUILD_DATE", "unknown"));
64 defaultParams.put("java_version", System.getProperty("java.version"));
65 String val = System.getProperty("sys.install4jVersion");
68 defaultParams.put("install4j_version", val);
70 val = System.getProperty("installer_template_version");
73 defaultParams.put("install4j_template_version", val);
75 val = System.getProperty("launcher_version");
78 defaultParams.put("launcher_version", val);
80 defaultParams.put("java_arch",
81 System.getProperty("os.arch") + " "
82 + System.getProperty("os.name") + " "
83 + System.getProperty("os.version"));
86 private GoogleAnalytics4()
91 public static void setEnabled(boolean b)
96 public void sendAnalytics(String eventName, String... paramsStrings)
98 sendAnalytics(eventName, false, paramsStrings);
102 * The simplest way to send an analytic event.
105 * The event name. To emulate a webpage view use "page_view" and set
106 * a "page_location" parameter. See
107 * https://developers.google.com/analytics/devguides/collection/ga4/events?client_type=gtag
108 * @param sendDefaultParams
109 * Flag whether to add the default params about the application.
110 * @param paramsStrings
111 * Optional multiple Strings in key, value pairs (there should be an
112 * even number of paramsStrings) to be set as parameters of the
113 * event. To emulate a webpage view use "page_location" as the URL in
114 * a "page_view" event.
116 public void sendAnalytics(String eventName, boolean sendDefaultParams,
117 String... paramsStrings)
119 // clear out old lists
124 Console.debug("GoogleAnalytics4 not enabled.");
127 Map<String, String> params = new HashMap<>();
128 params.put("event_category", DESKTOP_EVENT);
129 params.put("event_label", eventName);
131 // add these to all events from this application instance
132 if (sendDefaultParams)
134 params.putAll(defaultParams);
137 // add (and overwrite with) the passed in params
138 if (paramsStrings != null && paramsStrings.length > 0)
140 if (paramsStrings.length % 2 != 0)
143 "Cannot addEvent with odd number of paramsStrings. Ignoring the last one.");
145 for (int i = 0; i < paramsStrings.length - 1; i += 2)
147 String key = paramsStrings[i];
148 String value = paramsStrings[i + 1];
149 params.put(key, value);
153 addEvent(eventName, params);
154 addQueryStringValue("measurement_id", MEASUREMENT_ID);
155 addQueryStringValue("api_secret", API_SECRET);
156 addJsonValue("client_id", CLIENT_ID);
157 addJsonValues("events", Event.toObjectList(events));
158 StringBuilder urlSb = new StringBuilder();
159 urlSb.append(BASE_URL);
161 urlSb.append(buildQueryString());
164 URL url = new URL(urlSb.toString());
165 URLConnection urlConnection = url.openConnection();
166 HttpURLConnection httpURLConnection = (HttpURLConnection) urlConnection;
167 httpURLConnection.setRequestMethod("POST");
168 httpURLConnection.setDoOutput(true);
170 String jsonString = buildJson();
172 Console.debug("GA4: HTTP Request is: '" + urlSb.toString() + "'");
173 Console.debug("GA4: POSTed JSON is:\n" + jsonString);
175 byte[] jsonBytes = jsonString.getBytes(StandardCharsets.UTF_8);
176 int jsonLength = jsonBytes.length;
178 httpURLConnection.setFixedLengthStreamingMode(jsonLength);
179 httpURLConnection.setRequestProperty("Content-Type",
180 "application/json; charset=UTF-8");
181 httpURLConnection.connect();
182 try (OutputStream os = httpURLConnection.getOutputStream())
186 int responseCode = httpURLConnection.getResponseCode();
187 String responseMessage = httpURLConnection.getResponseMessage();
188 if (responseCode < 200 || responseCode > 299)
190 Console.warn("GoogleAnalytics4 connection failed: '" + responseCode
191 + " " + responseMessage + "'");
195 Console.debug("GoogleAnalytics4 connection succeeded: '"
196 + responseCode + " " + responseMessage + "'");
198 } catch (MalformedURLException e)
201 "Somehow the GoogleAnalytics4 BASE_URL and queryString is malformed.",
204 } catch (IOException e)
206 Console.debug("Connection to GoogleAnalytics4 BASE_URL '" + BASE_URL
208 } catch (ClassCastException e)
211 "Couldn't cast URLConnection to HttpURLConnection in GoogleAnalytics4.",
216 public void addEvent(String name, Map<String, String> params)
218 Event event = new Event(name);
219 if (params != null && params.size() > 0)
221 for (String key : params.keySet())
223 String value = params.get(key);
224 event.addParam(key, value);
230 private void addJsonObject(String key,
231 List<Map.Entry<String, Object>> object)
233 jsonObject.add(objectEntry(key, object));
236 private void addJsonValues(String key, List<Object> values)
238 jsonObject.add(objectEntry(key, values));
241 private void addJsonValue(String key, String value)
243 jsonObject.add(objectEntry(key, value));
246 private void addJsonValue(String key, int value)
248 jsonObject.add(objectEntry(key, Integer.valueOf(value)));
251 private void addJsonValue(String key, boolean value)
253 jsonObject.add(objectEntry(key, Boolean.valueOf(value)));
256 private void addQueryStringValue(String key, String value)
258 queryStringValues.add(stringEntry(key, value));
261 private void addCookieValue(String key, String value)
263 cookieValues.add(stringEntry(key, value));
266 private void resetLists()
268 jsonObject = new ArrayList<>();
269 events = new ArrayList<Event>();
270 queryStringValues = new ArrayList<>();
271 cookieValues = new ArrayList<>();
274 public static GoogleAnalytics4 getInstance()
276 if (instance == null)
278 instance = new GoogleAnalytics4();
283 public static void reset()
285 getInstance().resetLists();
288 private String buildQueryString()
290 StringBuilder sb = new StringBuilder();
291 for (Map.Entry<String, String> entry : queryStringValues)
297 sb.append(URLEncoder.encode(entry.getKey(), StandardCharsets.UTF_8));
300 URLEncoder.encode(entry.getValue(), StandardCharsets.UTF_8));
302 return sb.toString();
305 private void buildCookieHeaders()
307 // TODO not needed yet
310 private String buildJson()
312 StringBuilder sb = new StringBuilder();
313 addJsonObject(sb, 0, jsonObject);
314 return sb.toString();
317 private void addJsonObject(StringBuilder sb, int indent,
318 List<Map.Entry<String, Object>> entries)
323 Iterator<Map.Entry<String, Object>> entriesI = entries.iterator();
324 while (entriesI.hasNext())
326 Map.Entry<String, Object> entry = entriesI.next();
327 String key = entry.getKey();
328 // TODO sensibly escape " characters in key
329 Object value = entry.getValue();
330 indent(sb, indent + 1);
331 sb.append('"').append(quoteEscape(key)).append('"').append(':');
333 if (value != null && value instanceof List)
337 addJsonValue(sb, indent + 2, value);
338 if (entriesI.hasNext())
348 private void addJsonValue(StringBuilder sb, int indent, Object value)
356 if (value instanceof Map.Entry)
358 Map.Entry<String, Object> entry = (Map.Entry<String, Object>) value;
359 List<Map.Entry<String, Object>> object = new ArrayList<>();
361 addJsonObject(sb, indent, object);
363 else if (value instanceof List)
365 // list of Map.Entries or list of values?
366 List<Object> valueList = (List<Object>) value;
367 if (valueList.size() > 0 && valueList.get(0) instanceof Map.Entry)
370 // indent(sb, indent);
371 List<Map.Entry<String, Object>> entryList = (List<Map.Entry<String, Object>>) value;
372 addJsonObject(sb, indent, entryList);
380 Iterator<Object> valueListI = valueList.iterator();
381 while (valueListI.hasNext())
383 Object v = valueListI.next();
384 addJsonValue(sb, indent + 1, v);
385 if (valueListI.hasNext())
395 else if (value instanceof String)
397 sb.append('"').append(quoteEscape((String) value)).append('"');
399 else if (value instanceof Integer)
401 sb.append(((Integer) value).toString());
403 else if (value instanceof Boolean)
405 sb.append('"').append(((Boolean) value).toString()).append('"');
407 } catch (ClassCastException e)
410 "Could not deal with type of json Object " + value.toString(),
415 private static String quoteEscape(String s)
421 // this escapes quotation marks (") that aren't already escaped (in the
422 // string) ready to go into a quoted JSON string value
423 return s.replaceAll("((?<!\\\\)(?:\\\\{2})*)\"", "$1\\\\\"");
426 private static void prettyWhitespace(StringBuilder sb, String whitespace,
429 // only add whitespace if we're in DEBUG mode
430 if (!Console.getLogger().isDebugEnabled())
434 if (repeat >= 0 && whitespace != null)
436 sb.append(whitespace.repeat(repeat));
440 sb.append(whitespace);
444 private static void indent(StringBuilder sb, int indent)
446 prettyWhitespace(sb, " ", indent);
449 private static void newline(StringBuilder sb)
451 prettyWhitespace(sb, "\n", -1);
454 private static void space(StringBuilder sb)
456 prettyWhitespace(sb, " ", -1);
459 protected static Map.Entry<String, Object> objectEntry(String s, Object o)
461 return new AbstractMap.SimpleEntry<String, Object>(s, o);
464 protected static Map.Entry<String, String> stringEntry(String s, String v)
466 return new AbstractMap.SimpleEntry<String, String>(s, v);
474 private List<Map.Entry<String, String>> params;
477 public Event(String name, Map.Entry<String, String>... paramEntries)
480 this.params = new ArrayList<Map.Entry<String, String>>();
481 for (Map.Entry<String, String> paramEntry : paramEntries)
483 if (paramEntry == null)
487 params.add(paramEntry);
491 public void addParam(String param, String value)
493 params.add(GoogleAnalytics4.stringEntry(param, value));
496 protected List<Map.Entry<String, Object>> toObject()
498 List<Map.Entry<String, Object>> object = new ArrayList<>();
499 object.add(GoogleAnalytics4.objectEntry("name", (Object) name));
500 if (params.size() > 0)
502 object.add(GoogleAnalytics4.objectEntry("params", (Object) params));
507 protected static List<Object> toObjectList(List<Event> events)
509 List<Object> eventObjectList = new ArrayList<>();
510 for (Event event : events)
512 eventObjectList.add((Object) event.toObject());
514 return eventObjectList;