Update to latest Metrics revision

src/main/java/de/diddiz/LogBlock/Metrics.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2011 Tyler Blair. All rights reserved.
+ * Copyright 2011-2013 Tyler Blair. All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without modification, are
  * permitted provided that the following conditions are met:
@@ -25,7 +25,6 @@
  * authors and contributors and should not be interpreted as representing official policies,
  * either expressed or implied, of anybody else.
  */
-
 package de.diddiz.LogBlock;
 
 import org.bukkit.Bukkit;
@@ -33,52 +32,60 @@ import org.bukkit.configuration.InvalidConfigurationException;
 import org.bukkit.configuration.file.YamlConfiguration;
 import org.bukkit.plugin.Plugin;
 import org.bukkit.plugin.PluginDescriptionFile;
+import org.bukkit.scheduler.BukkitTask;
 
 import java.io.BufferedReader;
+import java.io.ByteArrayOutputStream;
 import java.io.File;
 import java.io.IOException;
 import java.io.InputStreamReader;
-import java.io.OutputStreamWriter;
+import java.io.OutputStream;
 import java.io.UnsupportedEncodingException;
 import java.net.Proxy;
 import java.net.URL;
 import java.net.URLConnection;
 import java.net.URLEncoder;
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.LinkedHashSet;
+import java.util.Set;
 import java.util.UUID;
 import java.util.logging.Level;
+import java.util.zip.GZIPOutputStream;
 
 public class Metrics {
 
 	/**
 	 * The current revision number
 	 */
-    private final static int REVISION = 5;
+	private final static int REVISION = 7;
 
 	/**
 	 * The base url of the metrics domain
 	 */
-    private static final String BASE_URL = "http://mcstats.org";
+	private static final String BASE_URL = "http://report.mcstats.org";
 
 	/**
 	 * The url used to report a server's status
 	 */
-    private static final String REPORT_URL = "/report/%s";
+	private static final String REPORT_URL = "/plugin/%s";
-
-    /**
-     * The file where guid and opt out is stored in
-     */
-    private static final String CONFIG_FILE = "plugins/PluginMetrics/config.yml";
 
 	/**
 	 * Interval of time to ping (in minutes)
 	 */
-    private final static int PING_INTERVAL = 10;
+	private static final int PING_INTERVAL = 15;
 
 	/**
 	 * The plugin this metrics submits for
 	 */
 	private final Plugin plugin;
 
+	/**
+	 * All of the custom graphs to submit to metrics
+	 */
+	private final Set<Graph> graphs = Collections.synchronizedSet(new HashSet<Graph>());
+
 	/**
 	 * The plugin configuration file
 	 */
@@ -94,17 +101,22 @@ public class Metrics {
 	 */
 	private final String guid;
 
+	/**
+	 * Debug mode
+	 */
+	private final boolean debug;
+
 	/**
 	 * Lock for synchronization
 	 */
 	private final Object optOutLock = new Object();
 
 	/**
-     * Id of the scheduled task
+	 * The scheduled task
 	 */
-    private volatile int taskId = -1;
+	private volatile BukkitTask task = null;
 
-    public Metrics(Plugin plugin) throws IOException {
+	public Metrics(final Plugin plugin) throws IOException {
 		if (plugin == null) {
 			throw new IllegalArgumentException("Plugin cannot be null");
 		}
@@ -112,12 +124,13 @@ public class Metrics {
 		this.plugin = plugin;
 
 		// load the config
-        configurationFile = new File(CONFIG_FILE);
+		configurationFile = getConfigFile();
 		configuration = YamlConfiguration.loadConfiguration(configurationFile);
 
 		// add some defaults
 		configuration.addDefault("opt-out", false);
 		configuration.addDefault("guid", UUID.randomUUID().toString());
+		configuration.addDefault("debug", false);
 
 		// Do we need to create the file?
 		if (configuration.get("guid", null) == null) {
@@ -127,13 +140,48 @@ public class Metrics {
 
 		// Load the guid then
 		guid = configuration.getString("guid");
+		debug = configuration.getBoolean("debug", false);
 	}
 
+	/**
+	 * Construct and create a Graph that can be used to separate specific plotters to their own graphs on the metrics
+	 * website. Plotters can be added to the graph object returned.
+	 *
+	 * @param name The name of the graph
+	 * @return Graph object created. Will never return NULL under normal circumstances unless bad parameters are given
+	 */
+	public Graph createGraph(final String name) {
+		if (name == null) {
+			throw new IllegalArgumentException("Graph name cannot be null");
+		}
+
+		// Construct the graph object
+		final Graph graph = new Graph(name);
+
+		// Now we can add our graph
+		graphs.add(graph);
+
+		// and return back
+		return graph;
+	}
 
 	/**
-     * Start measuring statistics. This will immediately create an async repeating task as the plugin and send
+	 * Add a Graph object to BukkitMetrics that represents data for the plugin that should be sent to the backend
-     * the initial data to the metrics backend, and then after that it will post in increments of
+	 *
-     * PING_INTERVAL * 1200 ticks.
+	 * @param graph The name of the graph
+	 */
+	public void addGraph(final Graph graph) {
+		if (graph == null) {
+			throw new IllegalArgumentException("Graph cannot be null");
+		}
+
+		graphs.add(graph);
+	}
+
+	/**
+	 * Start measuring statistics. This will immediately create an async repeating task as the plugin and send the
+	 * initial data to the metrics backend, and then after that it will post in increments of PING_INTERVAL * 1200
+	 * ticks.
 	 *
 	 * @return True if statistics measuring is running, otherwise false.
 	 */
@@ -145,12 +193,12 @@ public class Metrics {
 			}
 
 			// Is metrics already running?
-            if (taskId >= 0) {
+			if (task != null) {
 				return true;
 			}
 
 			// Begin hitting the server with glorious data
-            taskId = plugin.getServer().getScheduler().scheduleAsyncRepeatingTask(plugin, new Runnable() {
+			task = plugin.getServer().getScheduler().runTaskTimerAsynchronously(plugin, new Runnable() {
 
 				private boolean firstPost = true;
 
@@ -159,9 +207,13 @@ public class Metrics {
 						// This has to be synchronized or it can collide with the disable method.
 						synchronized (optOutLock) {
 							// Disable Task, if it is running and the server owner decided to opt-out
-                            if (isOptOut() && taskId > 0) {
+							if (isOptOut() && task != null) {
-                                plugin.getServer().getScheduler().cancelTask(taskId);
+								task.cancel();
-                                taskId = -1;
+								task = null;
+								// Tell all plotters to stop gathering information.
+								for (Graph graph : graphs) {
+									graph.onOptOut();
+								}
 							}
 						}
 
@@ -174,9 +226,11 @@ public class Metrics {
 						// Each post thereafter will be a ping
 						firstPost = false;
 					} catch (IOException e) {
+						if (debug) {
 							Bukkit.getLogger().log(Level.INFO, "[Metrics] " + e.getMessage());
 						}
 					}
+				}
 			}, 0, PING_INTERVAL * 1200);
 
 			return true;
@@ -186,18 +240,22 @@ public class Metrics {
 	/**
 	 * Has the server owner denied plugin metrics?
 	 *
-     * @return
+	 * @return true if metrics should be opted out of it
 	 */
 	public boolean isOptOut() {
 		synchronized (optOutLock) {
 			try {
 				// Reload the metrics file
-                configuration.load(CONFIG_FILE);
+				configuration.load(getConfigFile());
 			} catch (IOException ex) {
+				if (debug) {
 					Bukkit.getLogger().log(Level.INFO, "[Metrics] " + ex.getMessage());
+				}
 				return true;
 			} catch (InvalidConfigurationException ex) {
+				if (debug) {
 					Bukkit.getLogger().log(Level.INFO, "[Metrics] " + ex.getMessage());
+				}
 				return true;
 			}
 			return configuration.getBoolean("opt-out", false);
@@ -207,7 +265,7 @@ public class Metrics {
 	/**
 	 * Enables metrics for the server by setting "opt-out" to false in the config file and starting the metrics task.
 	 *
-     * @throws IOException
+	 * @throws java.io.IOException
 	 */
 	public void enable() throws IOException {
 		// This has to be synchronized or it can collide with the check in the task.
@@ -219,7 +277,7 @@ public class Metrics {
 			}
 
 			// Enable Task, if it is not running
-            if (taskId < 0) {
+			if (task == null) {
 				start();
 			}
 		}
@@ -228,7 +286,7 @@ public class Metrics {
 	/**
 	 * Disables metrics for the server by setting "opt-out" to true in the config file and canceling the metrics task.
 	 *
-     * @throws IOException
+	 * @throws java.io.IOException
 	 */
 	public void disable() throws IOException {
 		// This has to be synchronized or it can collide with the check in the task.
@@ -240,35 +298,123 @@ public class Metrics {
 			}
 
 			// Disable Task, if it is running
-            if (taskId > 0) {
+			if (task != null) {
-                this.plugin.getServer().getScheduler().cancelTask(taskId);
+				task.cancel();
-                taskId = -1;
+				task = null;
 			}
 		}
 	}
 
+	/**
+	 * Gets the File object of the config file that should be used to store data such as the GUID and opt-out status
+	 *
+	 * @return the File object for the config file
+	 */
+	public File getConfigFile() {
+		// I believe the easiest way to get the base folder (e.g craftbukkit set via -P) for plugins to use
+		// is to abuse the plugin object we already have
+		// plugin.getDataFolder() => base/plugins/PluginA/
+		// pluginsFolder => base/plugins/
+		// The base is not necessarily relative to the startup directory.
+		File pluginsFolder = plugin.getDataFolder().getParentFile();
+
+		// return => base/plugins/PluginMetrics/config.yml
+		return new File(new File(pluginsFolder, "PluginMetrics"), "config.yml");
+	}
+
 	/**
 	 * Generic method that posts a plugin to the metrics website
 	 */
-    private void postPlugin(boolean isPing) throws IOException {
+	private void postPlugin(final boolean isPing) throws IOException {
-        // The plugin's description file containg all of the plugin data such as name, version, author, etc
+		// Server software specific section
-        final PluginDescriptionFile description = plugin.getDescription();
+		PluginDescriptionFile description = plugin.getDescription();
+		String pluginName = description.getName();
+		boolean onlineMode = Bukkit.getServer().getOnlineMode(); // TRUE if online mode is enabled
+		String pluginVersion = description.getVersion();
+		String serverVersion = Bukkit.getVersion();
+		int playersOnline = Bukkit.getServer().getOnlinePlayers().length;
+
+		// END server software specific section -- all code below does not use any code outside of this class / Java
 
 		// Construct the post data
-        final StringBuilder data = new StringBuilder();
+		StringBuilder json = new StringBuilder(1024);
-        data.append(encode("guid")).append('=').append(encode(guid));
+		json.append('{');
-        encodeDataPair(data, "version", description.getVersion());
+
-        encodeDataPair(data, "server", Bukkit.getVersion());
+		// The plugin's description file containg all of the plugin data such as name, version, author, etc
-        encodeDataPair(data, "players", Integer.toString(Bukkit.getServer().getOnlinePlayers().length));
+		appendJSONPair(json, "guid", guid);
-        encodeDataPair(data, "revision", String.valueOf(REVISION));
+		appendJSONPair(json, "plugin_version", pluginVersion);
+		appendJSONPair(json, "server_version", serverVersion);
+		appendJSONPair(json, "players_online", Integer.toString(playersOnline));
+
+		// New data as of R6
+		String osname = System.getProperty("os.name");
+		String osarch = System.getProperty("os.arch");
+		String osversion = System.getProperty("os.version");
+		String java_version = System.getProperty("java.version");
+		int coreCount = Runtime.getRuntime().availableProcessors();
+
+		// normalize os arch .. amd64 -> x86_64
+		if (osarch.equals("amd64")) {
+			osarch = "x86_64";
+		}
+
+		appendJSONPair(json, "osname", osname);
+		appendJSONPair(json, "osarch", osarch);
+		appendJSONPair(json, "osversion", osversion);
+		appendJSONPair(json, "cores", Integer.toString(coreCount));
+		appendJSONPair(json, "auth_mode", onlineMode ? "1" : "0");
+		appendJSONPair(json, "java_version", java_version);
 
 		// If we're pinging, append it
 		if (isPing) {
-            encodeDataPair(data, "ping", "true");
+			appendJSONPair(json, "ping", "1");
 		}
 
+		if (graphs.size() > 0) {
+			synchronized (graphs) {
+				json.append(',');
+				json.append('"');
+				json.append("graphs");
+				json.append('"');
+				json.append(':');
+				json.append('{');
+
+				boolean firstGraph = true;
+
+				final Iterator<Graph> iter = graphs.iterator();
+
+				while (iter.hasNext()) {
+					Graph graph = iter.next();
+
+					StringBuilder graphJson = new StringBuilder();
+					graphJson.append('{');
+
+					for (Plotter plotter : graph.getPlotters()) {
+						appendJSONPair(graphJson, plotter.getColumnName(), Integer.toString(plotter.getValue()));
+					}
+
+					graphJson.append('}');
+
+					if (!firstGraph) {
+						json.append(',');
+					}
+
+					json.append(escapeJSON(graph.getName()));
+					json.append(':');
+					json.append(graphJson);
+
+					firstGraph = false;
+				}
+
+				json.append('}');
+			}
+		}
+
+		// close json
+		json.append('}');
+
 		// Create the url
-        URL url = new URL(BASE_URL + String.format(REPORT_URL, encode(plugin.getDescription().getName())));
+		URL url = new URL(BASE_URL + String.format(REPORT_URL, urlEncode(pluginName)));
 
 		// Connect to the website
 		URLConnection connection;
@@ -281,31 +427,92 @@ public class Metrics {
 			connection = url.openConnection();
 		}
 
+
+		byte[] uncompressed = json.toString().getBytes();
+		byte[] compressed = gzip(json.toString());
+
+		// Headers
+		connection.addRequestProperty("User-Agent", "MCStats/" + REVISION);
+		connection.addRequestProperty("Content-Type", "application/json");
+		connection.addRequestProperty("Content-Encoding", "gzip");
+		connection.addRequestProperty("Content-Length", Integer.toString(compressed.length));
+		connection.addRequestProperty("Accept", "application/json");
+		connection.addRequestProperty("Connection", "close");
+
 		connection.setDoOutput(true);
 
+		if (debug) {
+			System.out.println("[Metrics] Prepared request for " + pluginName + " uncompressed=" + uncompressed.length + " compressed=" + compressed.length);
+		}
+
 		// Write the data
-        final OutputStreamWriter writer = new OutputStreamWriter(connection.getOutputStream());
+		OutputStream os = connection.getOutputStream();
-        writer.write(data.toString());
+		os.write(compressed);
-        writer.flush();
+		os.flush();
 
 		// Now read the response
 		final BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
-        final String response = reader.readLine();
+		String response = reader.readLine();
 
 		// close resources
-        writer.close();
+		os.close();
 		reader.close();
 
-        if (response == null || response.startsWith("ERR")) {
+		if (response == null || response.startsWith("ERR") || response.startsWith("7")) {
-            throw new IOException(response); //Throw the exception
+			if (response == null) {
+				response = "null";
+			} else if (response.startsWith("7")) {
+				response = response.substring(response.startsWith("7,") ? 2 : 1);
 			}
-        //if (response.startsWith("OK")) - We should get "OK" followed by an optional description if everything goes right
+
+			throw new IOException(response);
+		} else {
+			// Is this the first update this hour?
+			if (response.equals("1") || response.contains("This is your first update this hour")) {
+				synchronized (graphs) {
+					final Iterator<Graph> iter = graphs.iterator();
+
+					while (iter.hasNext()) {
+						final Graph graph = iter.next();
+
+						for (Plotter plotter : graph.getPlotters()) {
+							plotter.reset();
+						}
+					}
+				}
+			}
+		}
+	}
+
+	/**
+	 * GZip compress a string of bytes
+	 *
+	 * @param input
+	 * @return
+	 */
+	public static byte[] gzip(String input) {
+		ByteArrayOutputStream baos = new ByteArrayOutputStream();
+		GZIPOutputStream gzos = null;
+
+		try {
+			gzos = new GZIPOutputStream(baos);
+			gzos.write(input.getBytes("UTF-8"));
+		} catch (IOException e) {
+			e.printStackTrace();
+		} finally {
+			if (gzos != null) try {
+				gzos.close();
+			} catch (IOException ignore) {
+			}
+		}
+
+		return baos.toByteArray();
 	}
 
 	/**
 	 * Check if mineshafter is present. If it is, we need to bypass it to send POST requests
 	 *
-     * @return
+	 * @return true if mineshafter is installed on the server
 	 */
 	private boolean isMineshafterPresent() {
 		try {
@@ -317,31 +524,236 @@ public class Metrics {
 	}
 
 	/**
-     * <p>Encode a key/value data pair to be used in a HTTP post request. This INCLUDES a & so the first
+	 * Appends a json encoded key/value pair to the given string builder.
-     * key/value pair MUST be included manually, e.g:</p>
-     * <code>
-     * StringBuffer data = new StringBuffer();
-     * data.append(encode("guid")).append('=').append(encode(guid));
-     * encodeDataPair(data, "version", description.getVersion());
-     * </code>
 	 *
-     * @param buffer
+	 * @param json
 	 * @param key
 	 * @param value
+	 * @throws UnsupportedEncodingException
+	 */
+	private static void appendJSONPair(StringBuilder json, String key, String value) throws UnsupportedEncodingException {
+		boolean isValueNumeric = false;
+
+		try {
+			if (value.equals("0") || !value.endsWith("0")) {
+				Double.parseDouble(value);
+				isValueNumeric = true;
+			}
+		} catch (NumberFormatException e) {
+			isValueNumeric = false;
+		}
+
+		if (json.charAt(json.length() - 1) != '{') {
+			json.append(',');
+		}
+
+		json.append(escapeJSON(key));
+		json.append(':');
+
+		if (isValueNumeric) {
+			json.append(value);
+		} else {
+			json.append(escapeJSON(value));
+		}
+	}
+
+	/**
+	 * Escape a string to create a valid JSON string
+	 *
+	 * @param text
 	 * @return
 	 */
-    private static void encodeDataPair(final StringBuilder buffer, final String key, final String value) throws UnsupportedEncodingException {
+	private static String escapeJSON(String text) {
-        buffer.append('&').append(encode(key)).append('=').append(encode(value));
+		StringBuilder builder = new StringBuilder();
+
+		builder.append('"');
+		for (int index = 0; index < text.length(); index++) {
+			char chr = text.charAt(index);
+
+			switch (chr) {
+				case '"':
+				case '\\':
+					builder.append('\\');
+					builder.append(chr);
+					break;
+				case '\b':
+					builder.append("\\b");
+					break;
+				case '\t':
+					builder.append("\\t");
+					break;
+				case '\n':
+					builder.append("\\n");
+					break;
+				case '\r':
+					builder.append("\\r");
+					break;
+				default:
+					if (chr < ' ') {
+						String t = "000" + Integer.toHexString(chr);
+						builder.append("\\u" + t.substring(t.length() - 4));
+					} else {
+						builder.append(chr);
+					}
+					break;
+			}
+		}
+		builder.append('"');
+
+		return builder.toString();
 	}
 
 	/**
 	 * Encode text as UTF-8
 	 *
-     * @param text
+	 * @param text the text to encode
-     * @return
+	 * @return the encoded text, as UTF-8
 	 */
-    private static String encode(String text) throws UnsupportedEncodingException {
+	private static String urlEncode(final String text) throws UnsupportedEncodingException {
 		return URLEncoder.encode(text, "UTF-8");
 	}
 
+	/**
+	 * Represents a custom graph on the website
+	 */
+	public static class Graph {
+
+		/**
+		 * The graph's name, alphanumeric and spaces only :) If it does not comply to the above when submitted, it is
+		 * rejected
+		 */
+		private final String name;
+
+		/**
+		 * The set of plotters that are contained within this graph
+		 */
+		private final Set<Plotter> plotters = new LinkedHashSet<Plotter>();
+
+		private Graph(final String name) {
+			this.name = name;
+		}
+
+		/**
+		 * Gets the graph's name
+		 *
+		 * @return the Graph's name
+		 */
+		public String getName() {
+			return name;
+		}
+
+		/**
+		 * Add a plotter to the graph, which will be used to plot entries
+		 *
+		 * @param plotter the plotter to add to the graph
+		 */
+		public void addPlotter(final Plotter plotter) {
+			plotters.add(plotter);
+		}
+
+		/**
+		 * Remove a plotter from the graph
+		 *
+		 * @param plotter the plotter to remove from the graph
+		 */
+		public void removePlotter(final Plotter plotter) {
+			plotters.remove(plotter);
+		}
+
+		/**
+		 * Gets an <b>unmodifiable</b> set of the plotter objects in the graph
+		 *
+		 * @return an unmodifiable {@link java.util.Set} of the plotter objects
+		 */
+		public Set<Plotter> getPlotters() {
+			return Collections.unmodifiableSet(plotters);
+		}
+
+		@Override
+		public int hashCode() {
+			return name.hashCode();
+		}
+
+		@Override
+		public boolean equals(final Object object) {
+			if (!(object instanceof Graph)) {
+				return false;
+			}
+
+			final Graph graph = (Graph) object;
+			return graph.name.equals(name);
+		}
+
+		/**
+		 * Called when the server owner decides to opt-out of BukkitMetrics while the server is running.
+		 */
+		protected void onOptOut() {
+		}
+	}
+
+	/**
+	 * Interface used to collect custom data for a plugin
+	 */
+	public static abstract class Plotter {
+
+		/**
+		 * The plot's name
+		 */
+		private final String name;
+
+		/**
+		 * Construct a plotter with the default plot name
+		 */
+		public Plotter() {
+			this("Default");
+		}
+
+		/**
+		 * Construct a plotter with a specific plot name
+		 *
+		 * @param name the name of the plotter to use, which will show up on the website
+		 */
+		public Plotter(final String name) {
+			this.name = name;
+		}
+
+		/**
+		 * Get the current value for the plotted point. Since this function defers to an external function it may or may
+		 * not return immediately thus cannot be guaranteed to be thread friendly or safe. This function can be called
+		 * from any thread so care should be taken when accessing resources that need to be synchronized.
+		 *
+		 * @return the current value for the point to be plotted.
+		 */
+		public abstract int getValue();
+
+		/**
+		 * Get the column name for the plotted point
+		 *
+		 * @return the plotted point's column name
+		 */
+		public String getColumnName() {
+			return name;
+		}
+
+		/**
+		 * Called after the website graphs have been updated
+		 */
+		public void reset() {
+		}
+
+		@Override
+		public int hashCode() {
+			return getColumnName().hashCode();
+		}
+
+		@Override
+		public boolean equals(final Object object) {
+			if (!(object instanceof Plotter)) {
+				return false;
+			}
+
+			final Plotter plotter = (Plotter) object;
+			return plotter.name.equals(name) && plotter.getValue() == getValue();
+		}
+	}
 }