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 // clear out old lists
101 Console.debug("GoogleAnalytics4 not enabled.");
104 Map<String, String> params = new HashMap<>();
106 // add these to all events from this application instance
107 params.putAll(defaultParams);
109 // add (and overwrite with) the passed in params
110 if (paramsStrings != null && paramsStrings.length > 0)
112 if (paramsStrings.length % 2 != 0)
115 "Cannot addEvent with odd number of paramsStrings. Ignoring the last one.");
117 for (int i = 0; i < paramsStrings.length - 1; i += 2)
119 String key = paramsStrings[i];
120 String value = paramsStrings[i + 1];
121 params.put(key, value);
125 addEvent(eventName, params);
126 addQueryStringValue("measurement_id", MEASUREMENT_ID);
127 addQueryStringValue("api_secret", API_SECRET);
128 addJsonValue("client_id", CLIENT_ID);
129 addJsonValues("events", Event.toObjectList(events));
130 StringBuilder urlSb = new StringBuilder();
131 urlSb.append(BASE_URL);
133 urlSb.append(buildQueryString());
136 URL url = new URL(urlSb.toString());
137 URLConnection urlConnection = url.openConnection();
138 HttpURLConnection httpURLConnection = (HttpURLConnection) urlConnection;
139 httpURLConnection.setRequestMethod("POST");
140 httpURLConnection.setDoOutput(true);
142 String jsonString = buildJson();
144 Console.debug("GA4: HTTP Request is: '" + urlSb.toString() + "'");
145 Console.debug("GA4: POSTed JSON is:\n" + jsonString);
147 byte[] jsonBytes = jsonString.getBytes(StandardCharsets.UTF_8);
148 int jsonLength = jsonBytes.length;
150 httpURLConnection.setFixedLengthStreamingMode(jsonLength);
151 httpURLConnection.setRequestProperty("Content-Type",
152 "application/json; charset=UTF-8");
153 httpURLConnection.connect();
154 try (OutputStream os = httpURLConnection.getOutputStream())
158 int responseCode = httpURLConnection.getResponseCode();
159 String responseMessage = httpURLConnection.getResponseMessage();
160 if (responseCode < 200 || responseCode > 299)
162 Console.warn("GoogleAnalytics4 connection failed: '" + responseCode
163 + " " + responseMessage + "'");
167 Console.debug("GoogleAnalytics4 connection succeeded: '"
168 + responseCode + " " + responseMessage + "'");
170 } catch (MalformedURLException e)
173 "Somehow the GoogleAnalytics4 BASE_URL and queryString is malformed.",
176 } catch (IOException e)
178 Console.debug("Connection to GoogleAnalytics4 BASE_URL '" + BASE_URL
180 } catch (ClassCastException e)
183 "Couldn't cast URLConnection to HttpURLConnection in GoogleAnalytics4.",
188 public void addEvent(String name, Map<String, String> params)
190 Event event = new Event(name);
191 if (params != null && params.size() > 0)
193 for (String key : params.keySet())
195 String value = params.get(key);
196 event.addParam(key, value);
202 private void addJsonObject(String key,
203 List<Map.Entry<String, Object>> object)
205 jsonObject.add(objectEntry(key, object));
208 private void addJsonValues(String key, List<Object> values)
210 jsonObject.add(objectEntry(key, values));
213 private void addJsonValue(String key, String value)
215 jsonObject.add(objectEntry(key, value));
218 private void addJsonValue(String key, int value)
220 jsonObject.add(objectEntry(key, Integer.valueOf(value)));
223 private void addJsonValue(String key, boolean value)
225 jsonObject.add(objectEntry(key, Boolean.valueOf(value)));
228 private void addQueryStringValue(String key, String value)
230 queryStringValues.add(stringEntry(key, value));
233 private void addCookieValue(String key, String value)
235 cookieValues.add(stringEntry(key, value));
238 private void resetLists()
240 jsonObject = new ArrayList<>();
241 events = new ArrayList<Event>();
242 queryStringValues = new ArrayList<>();
243 cookieValues = new ArrayList<>();
246 public static GoogleAnalytics4 getInstance()
248 if (instance == null)
250 instance = new GoogleAnalytics4();
255 public static void reset()
257 getInstance().resetLists();
260 private String buildQueryString()
262 StringBuilder sb = new StringBuilder();
263 for (Map.Entry<String, String> entry : queryStringValues)
269 sb.append(URLEncoder.encode(entry.getKey(), StandardCharsets.UTF_8));
272 URLEncoder.encode(entry.getValue(), StandardCharsets.UTF_8));
274 return sb.toString();
277 private void buildCookieHeaders()
279 // TODO not needed yet
282 private String buildJson()
284 StringBuilder sb = new StringBuilder();
285 addJsonObject(sb, 0, jsonObject);
286 return sb.toString();
289 private void addJsonObject(StringBuilder sb, int indent,
290 List<Map.Entry<String, Object>> entries)
295 Iterator<Map.Entry<String, Object>> entriesI = entries.iterator();
296 while (entriesI.hasNext())
298 Map.Entry<String, Object> entry = entriesI.next();
299 String key = entry.getKey();
300 // TODO sensibly escape " characters in key
301 Object value = entry.getValue();
302 indent(sb, indent + 1);
303 sb.append('"').append(quoteEscape(key)).append('"').append(':');
305 if (value != null && value instanceof List)
309 addJsonValue(sb, indent + 2, value);
310 if (entriesI.hasNext())
320 private void addJsonValue(StringBuilder sb, int indent, Object value)
328 if (value instanceof Map.Entry)
330 Map.Entry<String, Object> entry = (Map.Entry<String, Object>) value;
331 List<Map.Entry<String, Object>> object = new ArrayList<>();
333 addJsonObject(sb, indent, object);
335 else if (value instanceof List)
337 // list of Map.Entries or list of values?
338 List<Object> valueList = (List<Object>) value;
339 if (valueList.size() > 0 && valueList.get(0) instanceof Map.Entry)
342 // indent(sb, indent);
343 List<Map.Entry<String, Object>> entryList = (List<Map.Entry<String, Object>>) value;
344 addJsonObject(sb, indent, entryList);
352 Iterator<Object> valueListI = valueList.iterator();
353 while (valueListI.hasNext())
355 Object v = valueListI.next();
356 addJsonValue(sb, indent + 1, v);
357 if (valueListI.hasNext())
367 else if (value instanceof String)
369 sb.append('"').append(quoteEscape((String) value)).append('"');
371 else if (value instanceof Integer)
373 sb.append(((Integer) value).toString());
375 else if (value instanceof Boolean)
377 sb.append('"').append(((Boolean) value).toString()).append('"');
379 } catch (ClassCastException e)
382 "Could not deal with type of json Object " + value.toString(),
387 private static String quoteEscape(String s)
393 // this escapes quotation marks (") that aren't already escaped (in the
394 // string) ready to go into a quoted JSON string value
395 return s.replaceAll("((?<!\\\\)(?:\\\\{2})*)\"", "$1\\\\\"");
398 private static void prettyWhitespace(StringBuilder sb, String whitespace,
401 // only add whitespace if we're in DEBUG mode
402 if (!Console.getLogger().isDebugEnabled())
406 if (repeat >= 0 && whitespace != null)
408 sb.append(whitespace.repeat(repeat));
412 sb.append(whitespace);
416 private static void indent(StringBuilder sb, int indent)
418 prettyWhitespace(sb, " ", indent);
421 private static void newline(StringBuilder sb)
423 prettyWhitespace(sb, "\n", -1);
426 private static void space(StringBuilder sb)
428 prettyWhitespace(sb, " ", -1);
431 protected static Map.Entry<String, Object> objectEntry(String s, Object o)
433 return new AbstractMap.SimpleEntry<String, Object>(s, o);
436 protected static Map.Entry<String, String> stringEntry(String s, String v)
438 return new AbstractMap.SimpleEntry<String, String>(s, v);
446 private List<Map.Entry<String, String>> params;
449 public Event(String name, Map.Entry<String, String>... paramEntries)
452 this.params = new ArrayList<Map.Entry<String, String>>();
453 for (Map.Entry<String, String> paramEntry : paramEntries)
455 if (paramEntry == null)
459 params.add(paramEntry);
463 public void addParam(String param, String value)
465 params.add(GoogleAnalytics4.stringEntry(param, value));
468 protected List<Map.Entry<String, Object>> toObject()
470 List<Map.Entry<String, Object>> object = new ArrayList<>();
471 object.add(GoogleAnalytics4.objectEntry("name", (Object) name));
472 if (params.size() > 0)
474 object.add(GoogleAnalytics4.objectEntry("params", (Object) params));
479 protected static List<Object> toObjectList(List<Event> events)
481 List<Object> eventObjectList = new ArrayList<>();
482 for (Event event : events)
484 eventObjectList.add((Object) event.toObject());
486 return eventObjectList;