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.List;
15 import java.util.Random;
16 import java.util.UUID;
18 import jalview.bin.Console;
20 public class GoogleAnalytics4
22 private static final String JALVIEW_ID = "Jalview Desktop";
24 private static final String SESSION_ID = new Random().toString();
26 private static final String MEASUREMENT_ID = "G-6TMPHMXEQ0";
28 private static final String API_SECRET = "Qb9NSbqkRDqizG6j2BBJ2g";
30 // This will generate a different CLIENT_ID each time the application is
31 // launched. Do we want to store it in .jalview_properties?
32 private static final String CLIENT_ID = UUID.randomUUID().toString();
34 private static final String BASE_URL = "https://www.google-analytics.com/mp/collect";
36 private List<Map.Entry<String, String>> queryStringValues;
38 private List<Map.Entry<String, Object>> jsonObject;
40 private List<Event> events;
42 private List<Map.Entry<String, String>> cookieValues;
44 private static boolean ENABLED = false;
46 public GoogleAnalytics4()
51 private static void setEnabled(boolean b)
56 public void sendAnalytics()
61 public void sendAnalytics(String path)
65 Console.debug("GoogleAnalytics4 not enabled.");
70 addEvent("page_event", path);
72 addQueryStringValue("measurement_id", MEASUREMENT_ID);
73 addQueryStringValue("api_secret", API_SECRET);
74 addJsonValue("client_id", CLIENT_ID);
75 addJsonValues("events", Event.toObjectList(events));
76 // addJsonValue("events", )
77 StringBuilder sb = new StringBuilder();
80 sb.append(buildQueryString());
83 URL url = new URL(sb.toString());
84 URLConnection urlConnection = url.openConnection();
85 HttpURLConnection httpURLConnection = (HttpURLConnection) urlConnection;
86 httpURLConnection.setRequestMethod("POST");
87 httpURLConnection.setDoOutput(true);
89 byte[] jsonBytes = buildJson().getBytes(StandardCharsets.UTF_8);
90 int jsonLength = jsonBytes.length;
92 httpURLConnection.setFixedLengthStreamingMode(jsonLength);
93 httpURLConnection.setRequestProperty("Content-Type",
94 "application/json; charset=UTF-8");
95 httpURLConnection.connect();
96 try (OutputStream os = httpURLConnection.getOutputStream())
100 int responseCode = httpURLConnection.getResponseCode();
101 String responseMessage = httpURLConnection.getResponseMessage();
102 if (responseCode < 200 || responseCode > 299)
104 Console.warn("GoogleAnalytics4 connection failed: '" + responseCode
105 + " " + responseMessage + "'");
109 Console.debug("GoogleAnalytics4 connection succeeded: '"
110 + responseCode + " " + responseMessage + "'");
112 } catch (MalformedURLException e)
115 "Somehow the GoogleAnalytics4 BASE_URL and queryString is malformed.",
118 } catch (IOException e)
120 Console.debug("Connection to GoogleAnalytics4 BASE_URL '" + BASE_URL
122 } catch (ClassCastException e)
125 "Couldn't cast URLConnection to HttpURLConnection in GoogleAnalytics4.",
130 public void addEvent(String name, String... paramsStrings)
132 if (paramsStrings.length % 2 != 0)
135 "Cannot addEvent with odd number of paramsStrings. Ignoring.");
138 Event event = new Event(name);
139 for (int i = 0; i < paramsStrings.length - 1; i += 2)
141 String key = paramsStrings[i];
142 String value = paramsStrings[i + 1];
143 event.addParam(key, value);
148 private void addJsonObject(String key,
149 List<Map.Entry<String, Object>> object)
151 jsonObject.add(objectEntry(key, object));
154 private void addJsonValues(String key, List<Object> values)
156 jsonObject.add(objectEntry(key, values));
159 private void addJsonValue(String key, String value)
161 jsonObject.add(objectEntry(key, value));
164 private void addJsonValue(String key, int value)
166 jsonObject.add(objectEntry(key, Integer.valueOf(value)));
169 private void addJsonValue(String key, boolean value)
171 jsonObject.add(objectEntry(key, Boolean.valueOf(value)));
174 private void addQueryStringValue(String key, String value)
176 queryStringValues.add(stringEntry(key, value));
179 private void addCookieValue(String key, String value)
181 cookieValues.add(stringEntry(key, value));
186 jsonObject = new ArrayList<>();
187 events = new ArrayList<Event>();
188 queryStringValues = new ArrayList<>();
189 cookieValues = new ArrayList<>();
192 private String buildQueryString()
194 StringBuilder sb = new StringBuilder();
195 for (Map.Entry<String, String> entry : queryStringValues)
201 sb.append(URLEncoder.encode(entry.getKey(), StandardCharsets.UTF_8));
204 URLEncoder.encode(entry.getValue(), StandardCharsets.UTF_8));
206 return sb.toString();
209 private void buildCookieHeaders()
211 // TODO not needed yet
214 private String buildJson()
216 StringBuilder sb = new StringBuilder();
217 addJsonObject(sb, 0, jsonObject);
218 return sb.toString();
221 private void addJsonObject(StringBuilder sb, int indent,
222 List<Map.Entry<String, Object>> entries)
226 for (Map.Entry<String, Object> entry : entries)
228 String key = entry.getKey();
229 // TODO sensibly escape " characters in key
230 Object value = entry.getValue();
232 sb.append('"').append(key).append('"');
234 if (List.class.equals(value.getClass()))
238 addJsonValue(sb, indent + 1, value);
244 private void addJsonValue(StringBuilder sb, int indent, Object value)
252 Class<? extends Object> c = value.getClass();
253 if (Map.Entry.class.equals(c))
255 Map.Entry<String, Object> entry = (Map.Entry<String, Object>) value;
256 List<Map.Entry<String, Object>> object = new ArrayList<>();
258 addJsonObject(sb, indent + 1, object);
260 else if (List.class.equals(c))
262 // list of Map.Entries or list of values?
263 List<Object> valueList = (List<Object>) value;
264 if (valueList.size() > 0
265 && Map.Entry.class.equals(valueList.get(0).getClass()))
269 List<Map.Entry<String, Object>> entryList = (List<Map.Entry<String, Object>>) value;
270 addJsonObject(sb, indent + 1, entryList);
277 for (Object v : valueList)
279 indent(sb, indent + 1);
280 addJsonValue(sb, indent + 1, v);
287 else if (String.class.equals(c))
290 sb.append((String) value);
293 else if (Integer.class.equals(c))
295 sb.append(((Integer) value).toString());
297 else if (Boolean.class.equals(c))
299 sb.append(((Boolean) value).toString());
301 } catch (ClassCastException e)
304 "Could not deal with type of jsonObject " + value.toString(),
309 private void indent(StringBuilder sb, int indent)
311 sb.append(" ".repeat(indent));
314 protected static Map.Entry<String, Object> objectEntry(String s, Object o)
316 return new AbstractMap.SimpleEntry<String, Object>(s, o);
319 protected static Map.Entry<String, String> stringEntry(String s, String v)
321 return new AbstractMap.SimpleEntry<String, String>(s, v);
329 private List<Map.Entry<String, String>> params;
332 public Event(String name, Map.Entry<String, String>... paramEntries)
335 this.params = new ArrayList<Map.Entry<String, String>>();
336 for (Map.Entry<String, String> paramEntry : paramEntries)
338 if (paramEntry == null)
342 params.add(paramEntry);
346 public void addParam(String param, String value)
348 params.add(GoogleAnalytics4.stringEntry(param, value));
351 protected List<Map.Entry<String, Object>> toObject()
353 List<Map.Entry<String, Object>> object = new ArrayList<>();
354 object.add(GoogleAnalytics4.objectEntry("name", (Object) name));
355 if (params.size() > 0)
357 object.add(GoogleAnalytics4.objectEntry("params", (Object) params));
362 protected static List<Object> toObjectList(List<Event> events)
364 List<Object> eventObjectList = new ArrayList<>();
365 for (Event event : events)
367 eventObjectList.add((Object) event.toObject());
369 return eventObjectList;