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)
94 public void sendAnalytics(String eventName, String... paramsStrings)
96 sendAnalytics(eventName, false, paramsStrings);
100 * The simplest way to send an analytic event.
103 * The event name. To emulate a webpage view use "page_view" and set
104 * a "page_location" parameter. See
105 * https://developers.google.com/analytics/devguides/collection/ga4/events?client_type=gtag
106 * @param sendDefaultParams
107 * Flag whether to add the default params about the application.
108 * @param paramsStrings
109 * Optional multiple Strings in key, value pairs (there should be an
110 * even number of paramsStrings) to be set as parameters of the
111 * event. To emulate a webpage view use "page_location" as the URL in
112 * a "page_view" event.
114 public void sendAnalytics(String eventName, boolean sendDefaultParams,
115 String... paramsStrings)
117 // clear out old lists
122 Console.debug("GoogleAnalytics4 not enabled.");
125 Map<String, String> params = new HashMap<>();
127 // add these to all events from this application instance
128 if (sendDefaultParams)
130 params.putAll(defaultParams);
133 // add (and overwrite with) the passed in params
134 if (paramsStrings != null && paramsStrings.length > 0)
136 if (paramsStrings.length % 2 != 0)
139 "Cannot addEvent with odd number of paramsStrings. Ignoring the last one.");
141 for (int i = 0; i < paramsStrings.length - 1; i += 2)
143 String key = paramsStrings[i];
144 String value = paramsStrings[i + 1];
145 params.put(key, value);
149 addEvent(eventName, params);
150 addQueryStringValue("measurement_id", MEASUREMENT_ID);
151 addQueryStringValue("api_secret", API_SECRET);
152 addJsonValue("client_id", CLIENT_ID);
153 addJsonValues("events", Event.toObjectList(events));
154 StringBuilder urlSb = new StringBuilder();
155 urlSb.append(BASE_URL);
157 urlSb.append(buildQueryString());
160 URL url = new URL(urlSb.toString());
161 URLConnection urlConnection = url.openConnection();
162 HttpURLConnection httpURLConnection = (HttpURLConnection) urlConnection;
163 httpURLConnection.setRequestMethod("POST");
164 httpURLConnection.setDoOutput(true);
166 String jsonString = buildJson();
168 Console.debug("GA4: HTTP Request is: '" + urlSb.toString() + "'");
169 Console.debug("GA4: POSTed JSON is:\n" + jsonString);
171 byte[] jsonBytes = jsonString.getBytes(StandardCharsets.UTF_8);
172 int jsonLength = jsonBytes.length;
174 httpURLConnection.setFixedLengthStreamingMode(jsonLength);
175 httpURLConnection.setRequestProperty("Content-Type",
176 "application/json; charset=UTF-8");
177 httpURLConnection.connect();
178 try (OutputStream os = httpURLConnection.getOutputStream())
182 int responseCode = httpURLConnection.getResponseCode();
183 String responseMessage = httpURLConnection.getResponseMessage();
184 if (responseCode < 200 || responseCode > 299)
186 Console.warn("GoogleAnalytics4 connection failed: '" + responseCode
187 + " " + responseMessage + "'");
191 Console.debug("GoogleAnalytics4 connection succeeded: '"
192 + responseCode + " " + responseMessage + "'");
194 } catch (MalformedURLException e)
197 "Somehow the GoogleAnalytics4 BASE_URL and queryString is malformed.",
200 } catch (IOException e)
202 Console.debug("Connection to GoogleAnalytics4 BASE_URL '" + BASE_URL
204 } catch (ClassCastException e)
207 "Couldn't cast URLConnection to HttpURLConnection in GoogleAnalytics4.",
212 public void addEvent(String name, Map<String, String> params)
214 Event event = new Event(name);
215 if (params != null && params.size() > 0)
217 for (String key : params.keySet())
219 String value = params.get(key);
220 event.addParam(key, value);
226 private void addJsonObject(String key,
227 List<Map.Entry<String, Object>> object)
229 jsonObject.add(objectEntry(key, object));
232 private void addJsonValues(String key, List<Object> values)
234 jsonObject.add(objectEntry(key, values));
237 private void addJsonValue(String key, String value)
239 jsonObject.add(objectEntry(key, value));
242 private void addJsonValue(String key, int value)
244 jsonObject.add(objectEntry(key, Integer.valueOf(value)));
247 private void addJsonValue(String key, boolean value)
249 jsonObject.add(objectEntry(key, Boolean.valueOf(value)));
252 private void addQueryStringValue(String key, String value)
254 queryStringValues.add(stringEntry(key, value));
257 private void addCookieValue(String key, String value)
259 cookieValues.add(stringEntry(key, value));
262 private void resetLists()
264 jsonObject = new ArrayList<>();
265 events = new ArrayList<Event>();
266 queryStringValues = new ArrayList<>();
267 cookieValues = new ArrayList<>();
270 public static GoogleAnalytics4 getInstance()
272 if (instance == null)
274 instance = new GoogleAnalytics4();
279 public static void reset()
281 getInstance().resetLists();
284 private String buildQueryString()
286 StringBuilder sb = new StringBuilder();
287 for (Map.Entry<String, String> entry : queryStringValues)
293 sb.append(URLEncoder.encode(entry.getKey(), StandardCharsets.UTF_8));
296 URLEncoder.encode(entry.getValue(), StandardCharsets.UTF_8));
298 return sb.toString();
301 private void buildCookieHeaders()
303 // TODO not needed yet
306 private String buildJson()
308 StringBuilder sb = new StringBuilder();
309 addJsonObject(sb, 0, jsonObject);
310 return sb.toString();
313 private void addJsonObject(StringBuilder sb, int indent,
314 List<Map.Entry<String, Object>> entries)
319 Iterator<Map.Entry<String, Object>> entriesI = entries.iterator();
320 while (entriesI.hasNext())
322 Map.Entry<String, Object> entry = entriesI.next();
323 String key = entry.getKey();
324 // TODO sensibly escape " characters in key
325 Object value = entry.getValue();
326 indent(sb, indent + 1);
327 sb.append('"').append(quoteEscape(key)).append('"').append(':');
329 if (value != null && value instanceof List)
333 addJsonValue(sb, indent + 2, value);
334 if (entriesI.hasNext())
344 private void addJsonValue(StringBuilder sb, int indent, Object value)
352 if (value instanceof Map.Entry)
354 Map.Entry<String, Object> entry = (Map.Entry<String, Object>) value;
355 List<Map.Entry<String, Object>> object = new ArrayList<>();
357 addJsonObject(sb, indent, object);
359 else if (value instanceof List)
361 // list of Map.Entries or list of values?
362 List<Object> valueList = (List<Object>) value;
363 if (valueList.size() > 0 && valueList.get(0) instanceof Map.Entry)
366 // indent(sb, indent);
367 List<Map.Entry<String, Object>> entryList = (List<Map.Entry<String, Object>>) value;
368 addJsonObject(sb, indent, entryList);
376 Iterator<Object> valueListI = valueList.iterator();
377 while (valueListI.hasNext())
379 Object v = valueListI.next();
380 addJsonValue(sb, indent + 1, v);
381 if (valueListI.hasNext())
391 else if (value instanceof String)
393 sb.append('"').append(quoteEscape((String) value)).append('"');
395 else if (value instanceof Integer)
397 sb.append(((Integer) value).toString());
399 else if (value instanceof Boolean)
401 sb.append('"').append(((Boolean) value).toString()).append('"');
403 } catch (ClassCastException e)
406 "Could not deal with type of json Object " + value.toString(),
411 private static String quoteEscape(String s)
417 // this escapes quotation marks (") that aren't already escaped (in the
418 // string) ready to go into a quoted JSON string value
419 return s.replaceAll("((?<!\\\\)(?:\\\\{2})*)\"", "$1\\\\\"");
422 private static void prettyWhitespace(StringBuilder sb, String whitespace,
425 // only add whitespace if we're in DEBUG mode
426 if (!Console.getLogger().isDebugEnabled())
430 if (repeat >= 0 && whitespace != null)
432 sb.append(whitespace.repeat(repeat));
436 sb.append(whitespace);
440 private static void indent(StringBuilder sb, int indent)
442 prettyWhitespace(sb, " ", indent);
445 private static void newline(StringBuilder sb)
447 prettyWhitespace(sb, "\n", -1);
450 private static void space(StringBuilder sb)
452 prettyWhitespace(sb, " ", -1);
455 protected static Map.Entry<String, Object> objectEntry(String s, Object o)
457 return new AbstractMap.SimpleEntry<String, Object>(s, o);
460 protected static Map.Entry<String, String> stringEntry(String s, String v)
462 return new AbstractMap.SimpleEntry<String, String>(s, v);
470 private List<Map.Entry<String, String>> params;
473 public Event(String name, Map.Entry<String, String>... paramEntries)
476 this.params = new ArrayList<Map.Entry<String, String>>();
477 for (Map.Entry<String, String> paramEntry : paramEntries)
479 if (paramEntry == null)
483 params.add(paramEntry);
487 public void addParam(String param, String value)
489 params.add(GoogleAnalytics4.stringEntry(param, value));
492 protected List<Map.Entry<String, Object>> toObject()
494 List<Map.Entry<String, Object>> object = new ArrayList<>();
495 object.add(GoogleAnalytics4.objectEntry("name", (Object) name));
496 if (params.size() > 0)
498 object.add(GoogleAnalytics4.objectEntry("params", (Object) params));
503 protected static List<Object> toObjectList(List<Event> events)
505 List<Object> eventObjectList = new ArrayList<>();
506 for (Event event : events)
508 eventObjectList.add((Object) event.toObject());
510 return eventObjectList;