Add Griefcraft metrics to Essentials

Warns on first start, and first staff join, and 5 minute warning before logging starts.

Essentials/src/com/earth2me/essentials/Essentials.java

@@ -24,6 +24,8 @@ import com.earth2me.essentials.commands.EssentialsCommand;
 import com.earth2me.essentials.commands.IEssentialsCommand;
 import com.earth2me.essentials.commands.NoChargeException;
 import com.earth2me.essentials.commands.NotEnoughArgumentsException;
+import com.earth2me.essentials.metrics.MetricsListener;
+import com.earth2me.essentials.metrics.MetricsStarter;
 import com.earth2me.essentials.perm.PermissionsHandler;
 import com.earth2me.essentials.register.payment.Methods;
 import com.earth2me.essentials.signs.SignBlockListener;
@@ -237,6 +239,18 @@ public class Essentials extends JavaPlugin implements IEssentials
 		getScheduler().scheduleSyncRepeatingTask(this, timer, 1, 100);
 		Economy.setEss(this);
 		execTimer.mark("RegListeners");
+
+		final MetricsStarter metricsStarter = new MetricsStarter(this);
+		if (metricsStarter.getStart())
+		{
+			getScheduler().scheduleAsyncDelayedTask(this, metricsStarter, 1);
+		}
+		else if (metricsStarter.getStart() == false)
+		{
+			final MetricsListener metricsListener = new MetricsListener(this, metricsStarter);
+			pm.registerEvents(metricsListener, this);
+		}
+
 		final String timeroutput = execTimer.end();
 		if (getSettings().isDebug())
 		{
@@ -600,7 +614,9 @@ public class Essentials extends JavaPlugin implements IEssentials
 		return i18n;
 	}
 
-	private static class EssentialsWorldListener implements Listener, Runnable {
+
+	private static class EssentialsWorldListener implements Listener, Runnable
+	{
 		private transient final IEssentials ess;
 
 		public EssentialsWorldListener(final IEssentials ess)
@@ -608,7 +624,6 @@ public class Essentials extends JavaPlugin implements IEssentials
 			this.ess = ess;
 		}
 
-
 		@EventHandler(priority = EventPriority.LOW)
 		public void onWorldLoad(final WorldLoadEvent event)
 		{
@@ -616,7 +631,8 @@ public class Essentials extends JavaPlugin implements IEssentials
 			ess.getWarps().reloadConfig();
 			for (IConf iConf : ((Essentials)ess).confList)
 			{
-				if (iConf instanceof IEssentialsModule) {
+				if (iConf instanceof IEssentialsModule)
+				{
 					iConf.reloadConfig();
 				}
 			}
@@ -629,7 +645,8 @@ public class Essentials extends JavaPlugin implements IEssentials
 			ess.getWarps().reloadConfig();
 			for (IConf iConf : ((Essentials)ess).confList)
 			{
-				if (iConf instanceof IEssentialsModule) {
+				if (iConf instanceof IEssentialsModule)
+				{
 					iConf.reloadConfig();
 				}
 			}

Essentials/src/com/earth2me/essentials/EssentialsUpgrade.java

@@ -778,6 +778,16 @@ public class EssentialsUpgrade
 		doneFile.save();
 	}
 	
+	private void warnMetrics() {
+		if (doneFile.getBoolean("warnMetrics", false))
+		{
+			return;
+		}
+		ess.getSettings().setMetricsEnabled(false);		
+		doneFile.setProperty("warnMetrics", true);
+		doneFile.save();
+	}
+
 	public void beforeSettings()
 	{
 		if (!ess.getDataFolder().exists())
@@ -800,5 +810,6 @@ public class EssentialsUpgrade
 		deleteOldItemsCsv();
 		updateSpawnsToNewSpawnsConfig();
 		updateJailsToNewJailsConfig();
+		warnMetrics();
 	}
 }

Essentials/src/com/earth2me/essentials/ISettings.java

@@ -163,4 +163,8 @@ public interface ISettings extends IConf
 	EventPriority getRespawnPriority();
 
 	long getTpaAcceptCancellation();
+	
+	boolean isMetricsEnabled();
+	
+	void setMetricsEnabled(boolean metricsEnabled);
 }

Essentials/src/com/earth2me/essentials/Settings.java

@@ -23,6 +23,7 @@ public class Settings implements ISettings
 	private final transient EssentialsConf config;
 	private final static Logger logger = Logger.getLogger("Minecraft");
 	private final transient IEssentials ess;
+	private boolean metricsEnabled = true;
 
 	public Settings(IEssentials ess)
 	{
@@ -718,4 +719,16 @@ public class Settings implements ISettings
 	{
 		return config.getLong("tpa-accept-cancellation", 0);
 	}
+
+	@Override
+	public boolean isMetricsEnabled()
+	{
+		return metricsEnabled;
+	}
+
+	@Override
+	public void setMetricsEnabled(boolean metricsEnabled)
+	{
+		this.metricsEnabled = metricsEnabled;
+	}
 }

Essentials/src/com/earth2me/essentials/metrics/Metrics.java

@@ -0,0 +1,529 @@
+package com.earth2me.essentials.metrics;
+
+/*
+ * Copyright 2011 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:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+ * disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
+ * following disclaimer in the documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+ * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+ * THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+ * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+ * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+ * POSSIBILITY OF SUCH DAMAGE.
+ *
+ * The views and conclusions contained in the software and documentation are those of the authors and contributors and
+ * should not be interpreted as representing official policies, either expressed or implied, of anybody else.
+ */
+import org.bukkit.Bukkit;
+import org.bukkit.configuration.file.YamlConfiguration;
+import org.bukkit.plugin.Plugin;
+import org.bukkit.plugin.PluginDescriptionFile;
+
+import java.io.BufferedReader;
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.OutputStreamWriter;
+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;
+
+
+/**
+ * <p> The metrics class obtains data about a plugin and submits statistics about it to the metrics backend. </p> <p>
+ * Public methods provided by this class: </p>
+ * <code>
+ * Graph createGraph(String name); <br/>
+ * void addCustomData(Metrics.Plotter plotter); <br/>
+ * void start(); <br/>
+ * </code>
+ */
+public class Metrics
+{
+	/**
+	 * The current revision number
+	 */
+	private final static int REVISION = 5;
+	/**
+	 * The base url of the metrics domain
+	 */
+	private static final String BASE_URL = "http://metrics.essentials3.net";
+	/**
+	 * The url used to report a server's status
+	 */
+	private static final String REPORT_URL = "/report/%s";
+	/**
+	 * The file where guid and opt out is stored in
+	 */
+	private static final String CONFIG_FILE = "plugins/PluginMetrics/config.yml";
+	/**
+	 * The separator to use for custom data. This MUST NOT change unless you are hosting your own version of metrics and
+	 * want to change it.
+	 */
+	private static final String CUSTOM_DATA_SEPARATOR = "~~";
+	/**
+	 * Interval of time to ping (in minutes)
+	 */
+	private final static int PING_INTERVAL = 10;
+	/**
+	 * 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 default graph, used for addCustomData when you don't want a specific graph
+	 */
+	private final Graph defaultGraph = new Graph("Default");
+	/**
+	 * The plugin configuration file
+	 */
+	private final YamlConfiguration configuration;
+	/**
+	 * Unique server id
+	 */
+	private final String guid;
+
+	public Metrics(Plugin plugin) throws IOException
+	{
+		if (plugin == null)
+		{
+			throw new IllegalArgumentException("Plugin cannot be null");
+		}
+
+		this.plugin = plugin;
+
+		// load the config
+		File file = new File(CONFIG_FILE);
+		configuration = YamlConfiguration.loadConfiguration(file);
+
+		// add some defaults
+		configuration.addDefault("opt-out", false);
+		configuration.addDefault("guid", UUID.randomUUID().toString());
+
+		// Do we need to create the file?
+		if (configuration.get("guid", null) == null)
+		{
+			configuration.options().header("http://metrics.griefcraft.com").copyDefaults(true);
+			configuration.save(file);
+		}
+
+		// Load the guid then
+		guid = configuration.getString("guid");
+	}
+
+	/**
+	 * 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
+	 * @return Graph object created. Will never return NULL under normal circumstances unless bad parameters are given
+	 */
+	public Graph createGraph(String name)
+	{
+		if (name == null)
+		{
+			throw new IllegalArgumentException("Graph name cannot be null");
+		}
+
+		// Construct the graph object
+		Graph graph = new Graph(name);
+
+		// Now we can add our graph
+		graphs.add(graph);
+
+		// and return back
+		return graph;
+	}
+
+	/**
+	 * Adds a custom data plotter to the default graph
+	 *
+	 * @param plotter
+	 */
+	public void addCustomData(Plotter plotter)
+	{
+		if (plotter == null)
+		{
+			throw new IllegalArgumentException("Plotter cannot be null");
+		}
+
+		// Add the plotter to the graph o/
+		defaultGraph.addPlotter(plotter);
+
+		// Ensure the default graph is included in the submitted graphs
+		graphs.add(defaultGraph);
+	}
+
+	public boolean isOptOut()
+	{
+		return configuration.getBoolean("opt-out", false);
+	}
+
+	/**
+	 * 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.
+	 */
+	public void start()
+	{
+		// Did we opt out?
+		if (configuration.getBoolean("opt-out", false))
+		{
+			return;
+		}
+
+		// Begin hitting the server with glorious data
+		plugin.getServer().getScheduler().scheduleAsyncRepeatingTask(plugin, new Runnable()
+		{
+			private boolean firstPost = true;
+
+			public void run()
+			{
+				try
+				{
+					// We use the inverse of firstPost because if it is the first time we are posting,
+					// it is not a interval ping, so it evaluates to FALSE
+					// Each time thereafter it will evaluate to TRUE, i.e PING!
+					postPlugin(!firstPost);
+
+					// After the first post we set firstPost to false
+					// Each post thereafter will be a ping
+					firstPost = false;
+				}
+				catch (IOException e)
+				{
+					System.err.println("[Metrics] " + e.getMessage());
+				}
+			}
+		}, 0, PING_INTERVAL * 1200);
+	}
+
+	/**
+	 * Generic method that posts a plugin to the metrics website
+	 */
+	private void postPlugin(boolean isPing) throws IOException
+	{
+		// The plugin's description file containg all of the plugin data such as name, version, author, etc
+		PluginDescriptionFile description = plugin.getDescription();
+
+		// Construct the post data
+		String data = encode("guid") + '=' + encode(guid)
+					  + encodeDataPair("version", description.getVersion())
+					  + encodeDataPair("server", Bukkit.getVersion())
+					  + encodeDataPair("players", Integer.toString(Bukkit.getServer().getOnlinePlayers().length))
+					  + encodeDataPair("revision", String.valueOf(REVISION));
+
+		// If we're pinging, append it
+		if (isPing)
+		{
+			data += encodeDataPair("ping", "true");
+		}
+
+		// Acquire a lock on the graphs, which lets us make the assumption we also lock everything
+		// inside of the graph (e.g plotters)
+		synchronized (graphs)
+		{
+			Iterator<Graph> iter = graphs.iterator();
+
+			while (iter.hasNext())
+			{
+				Graph graph = iter.next();
+
+				// Because we have a lock on the graphs set already, it is reasonable to assume
+				// that our lock transcends down to the individual plotters in the graphs also.
+				// Because our methods are private, no one but us can reasonably access this list
+				// without reflection so this is a safe assumption without adding more code.
+				for (Plotter plotter : graph.getPlotters())
+				{
+					// The key name to send to the metrics server
+					// The format is C-GRAPHNAME-PLOTTERNAME where separator - is defined at the top
+					// Legacy (R4) submitters use the format Custom%s, or CustomPLOTTERNAME
+					String key = String.format("C%s%s%s%s", CUSTOM_DATA_SEPARATOR, graph.getName(), CUSTOM_DATA_SEPARATOR, plotter.getColumnName());
+
+					// The value to send, which for the foreseeable future is just the string
+					// value of plotter.getValue()
+					String value = Integer.toString(plotter.getValue());
+
+					// Add it to the http post data :)
+					data += encodeDataPair(key, value);
+				}
+			}
+		}
+
+		// Create the url
+		URL url = new URL(BASE_URL + String.format(REPORT_URL, description.getName()));
+
+		// Connect to the website
+		URLConnection connection;
+
+		// Mineshafter creates a socks proxy, so we can safely bypass it
+		// It does not reroute POST requests so we need to go around it
+		if (isMineshafterPresent())
+		{
+			connection = url.openConnection(Proxy.NO_PROXY);
+		}
+		else
+		{
+			connection = url.openConnection();
+		}
+
+		connection.setDoOutput(true);
+
+		// Write the data
+		OutputStreamWriter writer = new OutputStreamWriter(connection.getOutputStream());
+		writer.write(data);
+		writer.flush();
+
+		// Now read the response
+		BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
+		String response = reader.readLine();
+
+		// close resources
+		writer.close();
+		reader.close();
+
+		if (response.startsWith("ERR"))
+		{
+			throw new IOException(response); //Throw the exception
+		}
+		else
+		{
+			// Is this the first update this hour?
+			if (response.contains("OK This is your first update this hour"))
+			{
+				synchronized (graphs)
+				{
+					Iterator<Graph> iter = graphs.iterator();
+
+					while (iter.hasNext())
+					{
+						Graph graph = iter.next();
+
+						for (Plotter plotter : graph.getPlotters())
+						{
+							plotter.reset();
+						}
+					}
+				}
+			}
+		}
+		//if (response.startsWith("OK")) - We should get "OK" followed by an optional description if everything goes right
+	}
+
+	/**
+	 * Check if mineshafter is present. If it is, we need to bypass it to send POST requests
+	 *
+	 * @return
+	 */
+	private boolean isMineshafterPresent()
+	{
+		try
+		{
+			Class.forName("mineshafter.MineServer");
+			return true;
+		}
+		catch (Exception e)
+		{
+			return false;
+		}
+	}
+
+	/**
+	 * <p>Encode a key/value data pair to be used in a HTTP post request. This INCLUDES a & so the first key/value pair
+	 * MUST be included manually, e.g:</p>
+	 * <code>
+	 * String httpData = encode("guid") + '=' + encode("1234") + encodeDataPair("authors") + "..";
+	 * </code>
+	 *
+	 * @param key
+	 * @param value
+	 * @return
+	 */
+	private static String encodeDataPair(String key, String value) throws UnsupportedEncodingException
+	{
+		return '&' + encode(key) + '=' + encode(value);
+	}
+
+	/**
+	 * Encode text as UTF-8
+	 *
+	 * @param text
+	 * @return
+	 */
+	private static String encode(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(String name)
+		{
+			this.name = name;
+		}
+
+		/**
+		 * Gets the graph's name
+		 *
+		 * @return
+		 */
+		public String getName()
+		{
+			return name;
+		}
+
+		/**
+		 * Add a plotter to the graph, which will be used to plot entries
+		 *
+		 * @param plotter
+		 */
+		public void addPlotter(Plotter plotter)
+		{
+			plotters.add(plotter);
+		}
+
+		/**
+		 * Remove a plotter from the graph
+		 *
+		 * @param plotter
+		 */
+		public void removePlotter(Plotter plotter)
+		{
+			plotters.remove(plotter);
+		}
+
+		/**
+		 * Gets an <b>unmodifiable</b> set of the plotter objects in the graph
+		 *
+		 * @return
+		 */
+		public Set<Plotter> getPlotters()
+		{
+			return Collections.unmodifiableSet(plotters);
+		}
+
+		@Override
+		public int hashCode()
+		{
+			return name.hashCode();
+		}
+
+		@Override
+		public boolean equals(Object object)
+		{
+			if (!(object instanceof Graph))
+			{
+				return false;
+			}
+
+			Graph graph = (Graph)object;
+			return graph.name.equals(name);
+		}
+	}
+
+
+	/**
+	 * 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
+		 */
+		public Plotter(String name)
+		{
+			this.name = name;
+		}
+
+		/**
+		 * Get the current value for the plotted point
+		 *
+		 * @return
+		 */
+		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() + getValue();
+		}
+
+		@Override
+		public boolean equals(Object object)
+		{
+			if (!(object instanceof Plotter))
+			{
+				return false;
+			}
+
+			Plotter plotter = (Plotter)object;
+			return plotter.name.equals(name) && plotter.getValue() == getValue();
+		}
+	}
+}

Essentials/src/com/earth2me/essentials/metrics/MetricsListener.java

@@ -0,0 +1,40 @@
+package com.earth2me.essentials.metrics;
+
+import com.earth2me.essentials.IEssentials;
+import com.earth2me.essentials.User;
+import java.util.logging.Level;
+import org.bukkit.Server;
+import org.bukkit.entity.Player;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.EventPriority;
+import org.bukkit.event.Listener;
+import org.bukkit.event.player.PlayerJoinEvent;
+
+
+public class MetricsListener implements Listener
+{
+	private final transient Server server;
+	private final transient IEssentials ess;
+	private final transient MetricsStarter starter;
+
+	public MetricsListener(final IEssentials parent, final MetricsStarter starter)
+	{
+		this.ess = parent;
+		this.server = parent.getServer();
+		this.starter = starter;
+	}
+
+	@EventHandler(priority = EventPriority.MONITOR)
+	public void onPlayerJoin(final PlayerJoinEvent event)
+	{
+		final User player = ess.getUser(event.getPlayer());
+		if (ess.getSettings().isMetricsEnabled() == false && (player.isAuthorized("essentials.essentials") || player.isAuthorized("bukkit.broadcast.admin")))
+		{
+			player.sendMessage("PluginMetrics collects minimal statistic data, starting in about 5 minutes.");
+			player.sendMessage("To opt out, edit plugins/PluginMetrics/config.yml.");
+			ess.getLogger().log(Level.INFO, "[Metrics] Admin join - Starting 5 minute opt-out period.");
+			ess.getSettings().setMetricsEnabled(true);
+			ess.getScheduler().scheduleAsyncDelayedTask(ess, starter, 5 * 1200);
+		}
+	}
+}

Essentials/src/com/earth2me/essentials/metrics/MetricsStarter.java

@@ -0,0 +1,62 @@
+package com.earth2me.essentials.metrics;
+
+
+import com.earth2me.essentials.IEssentials;
+import java.io.IOException;
+import java.util.logging.Level;
+
+
+public class MetricsStarter implements Runnable
+{
+	private final IEssentials ess;
+	private transient Boolean start;
+
+	public MetricsStarter(final IEssentials plugin)
+	{
+		ess = plugin;
+		try
+		{
+			final Metrics metrics = new Metrics(ess);
+
+			if (!metrics.isOptOut())
+			{
+				if (ess.getSettings().isMetricsEnabled())
+				{
+					start = true;
+				}
+				else
+				{
+					ess.getLogger().info("This plugin collects minimal statistic data and sends it to http://metrics.essentials3.net.");
+					ess.getLogger().info("You can opt out by changing plugins/PluginMetrics/config.yml, set opt-out to true.");
+					ess.getLogger().info("This will start 5 minutes after the first admin/op joins.");
+					start = false;
+				}
+				return;
+			}
+		}
+		catch (IOException e)
+		{
+			ess.getLogger().log(Level.WARNING, "[Metrics] " + e.getMessage(), e);
+		}
+	}
+
+	@Override
+	public void run()
+	{
+		try
+		{
+			final Metrics metrics = new Metrics(ess);		
+			metrics.start();
+
+		}
+		catch (IOException e)
+		{
+			ess.getLogger().log(Level.WARNING, "[Metrics] " + e.getMessage(), e);
+		}
+	}
+
+	public Boolean getStart()
+	{
+		return start;
+	}
+}