|
@@ -1,6 +1,35 @@
|
|
package com.gmail.nossr50;
|
|
package com.gmail.nossr50;
|
|
-
|
|
|
|
|
|
+/*
|
|
|
|
+ * 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.configuration.file.YamlConfiguration;
|
|
|
|
+import org.bukkit.configuration.InvalidConfigurationException;
|
|
import org.bukkit.plugin.Plugin;
|
|
import org.bukkit.plugin.Plugin;
|
|
import org.bukkit.plugin.PluginDescriptionFile;
|
|
import org.bukkit.plugin.PluginDescriptionFile;
|
|
|
|
|
|
@@ -15,14 +44,26 @@ import java.net.URL;
|
|
import java.net.URLConnection;
|
|
import java.net.URLConnection;
|
|
import java.net.URLEncoder;
|
|
import java.net.URLEncoder;
|
|
import java.util.Collections;
|
|
import java.util.Collections;
|
|
-import java.util.HashMap;
|
|
|
|
import java.util.HashSet;
|
|
import java.util.HashSet;
|
|
import java.util.Iterator;
|
|
import java.util.Iterator;
|
|
import java.util.LinkedHashSet;
|
|
import java.util.LinkedHashSet;
|
|
-import java.util.Map;
|
|
|
|
import java.util.Set;
|
|
import java.util.Set;
|
|
import java.util.UUID;
|
|
import java.util.UUID;
|
|
-
|
|
|
|
|
|
+import java.util.logging.Level;
|
|
|
|
+
|
|
|
|
+/**
|
|
|
|
+ * <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 {
|
|
public class Metrics {
|
|
|
|
|
|
/**
|
|
/**
|
|
@@ -33,7 +74,7 @@ public class Metrics {
|
|
/**
|
|
/**
|
|
* The base url of the metrics domain
|
|
* The base url of the metrics domain
|
|
*/
|
|
*/
|
|
- private static final String BASE_URL = "http://metrics.griefcraft.com";
|
|
|
|
|
|
+ private static final String BASE_URL = "http://mcstats.org";
|
|
|
|
|
|
/**
|
|
/**
|
|
* The url used to report a server's status
|
|
* The url used to report a server's status
|
|
@@ -43,7 +84,7 @@ public class Metrics {
|
|
/**
|
|
/**
|
|
* The file where guid and opt out is stored in
|
|
* The file where guid and opt out is stored in
|
|
*/
|
|
*/
|
|
- private static final String CONFIG_FILE = "plugins" + File.separator + "PluginMetrics" + File.separator + "config.yml";
|
|
|
|
|
|
+ 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
|
|
* The separator to use for custom data. This MUST NOT change unless you are hosting your own
|
|
@@ -54,32 +95,58 @@ public class Metrics {
|
|
/**
|
|
/**
|
|
* Interval of time to ping (in minutes)
|
|
* Interval of time to ping (in minutes)
|
|
*/
|
|
*/
|
|
- private final static int PING_INTERVAL = 10;
|
|
|
|
|
|
+ private static final int PING_INTERVAL = 10;
|
|
|
|
+
|
|
|
|
+ /**
|
|
|
|
+ * The plugin this metrics submits for
|
|
|
|
+ */
|
|
|
|
+ private final Plugin plugin;
|
|
|
|
|
|
/**
|
|
/**
|
|
- * A map of all of the graphs for each plugin
|
|
|
|
|
|
+ * All of the custom graphs to submit to metrics
|
|
*/
|
|
*/
|
|
- private Map<Plugin, Set<Graph>> graphs = Collections.synchronizedMap(new HashMap<Plugin, Set<Graph>>());
|
|
|
|
|
|
+ private final Set<Graph> graphs = Collections.synchronizedSet(new HashSet<Graph>());
|
|
|
|
|
|
/**
|
|
/**
|
|
- * A convenient map of the default Graph objects (used by addCustomData mainly)
|
|
|
|
|
|
+ * The default graph, used for addCustomData when you don't want a specific graph
|
|
*/
|
|
*/
|
|
- private Map<Plugin, Graph> defaultGraphs = Collections.synchronizedMap(new HashMap<Plugin, Graph>());
|
|
|
|
|
|
+ private final Graph defaultGraph = new Graph("Default");
|
|
|
|
|
|
/**
|
|
/**
|
|
* The plugin configuration file
|
|
* The plugin configuration file
|
|
*/
|
|
*/
|
|
private final YamlConfiguration configuration;
|
|
private final YamlConfiguration configuration;
|
|
|
|
+
|
|
|
|
+ /**
|
|
|
|
+ * The plugin configuration file
|
|
|
|
+ */
|
|
|
|
+ private final File configurationFile;
|
|
|
|
|
|
/**
|
|
/**
|
|
* Unique server id
|
|
* Unique server id
|
|
*/
|
|
*/
|
|
- private String guid;
|
|
|
|
|
|
+ private final String guid;
|
|
|
|
+
|
|
|
|
+ /**
|
|
|
|
+ * Lock for synchronization
|
|
|
|
+ */
|
|
|
|
+ private final Object optOutLock = new Object();
|
|
|
|
+
|
|
|
|
+ /**
|
|
|
|
+ * Id of the scheduled task
|
|
|
|
+ */
|
|
|
|
+ private volatile int taskId = -1;
|
|
|
|
+
|
|
|
|
+ public Metrics(final Plugin plugin) throws IOException {
|
|
|
|
+ if (plugin == null) {
|
|
|
|
+ throw new IllegalArgumentException("Plugin cannot be null");
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ this.plugin = plugin;
|
|
|
|
|
|
- public Metrics() throws IOException {
|
|
|
|
// load the config
|
|
// load the config
|
|
- File file = new File(CONFIG_FILE);
|
|
|
|
- configuration = YamlConfiguration.loadConfiguration(file);
|
|
|
|
|
|
+ configurationFile = new File(CONFIG_FILE);
|
|
|
|
+ configuration = YamlConfiguration.loadConfiguration(configurationFile);
|
|
|
|
|
|
// add some defaults
|
|
// add some defaults
|
|
configuration.addDefault("opt-out", false);
|
|
configuration.addDefault("opt-out", false);
|
|
@@ -87,8 +154,8 @@ public class Metrics {
|
|
|
|
|
|
// Do we need to create the file?
|
|
// Do we need to create the file?
|
|
if (configuration.get("guid", null) == null) {
|
|
if (configuration.get("guid", null) == null) {
|
|
- configuration.options().header("http://metrics.griefcraft.com").copyDefaults(true);
|
|
|
|
- configuration.save(file);
|
|
|
|
|
|
+ configuration.options().header("http://mcstats.org").copyDefaults(true);
|
|
|
|
+ configuration.save(configurationFile);
|
|
}
|
|
}
|
|
|
|
|
|
// Load the guid then
|
|
// Load the guid then
|
|
@@ -99,21 +166,16 @@ public class Metrics {
|
|
* Construct and create a Graph that can be used to separate specific plotters to their own graphs
|
|
* 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.
|
|
* on the metrics website. Plotters can be added to the graph object returned.
|
|
*
|
|
*
|
|
- * @param plugin
|
|
|
|
- * @param type
|
|
|
|
* @param name
|
|
* @param name
|
|
* @return Graph object created. Will never return NULL under normal circumstances unless bad parameters are given
|
|
* @return Graph object created. Will never return NULL under normal circumstances unless bad parameters are given
|
|
*/
|
|
*/
|
|
- public Graph createGraph(Plugin plugin, Graph.Type type, String name) {
|
|
|
|
- if (plugin == null || type == null || name == null) {
|
|
|
|
- throw new IllegalArgumentException("All arguments must not be null");
|
|
|
|
|
|
+ public Graph createGraph(final String name) {
|
|
|
|
+ if (name == null) {
|
|
|
|
+ throw new IllegalArgumentException("Graph name cannot be null");
|
|
}
|
|
}
|
|
|
|
|
|
// Construct the graph object
|
|
// Construct the graph object
|
|
- Graph graph = new Graph(type, name);
|
|
|
|
-
|
|
|
|
- // Get the graphs for the plugin
|
|
|
|
- Set<Graph> graphs = getOrCreateGraphs(plugin);
|
|
|
|
|
|
+ final Graph graph = new Graph(name);
|
|
|
|
|
|
// Now we can add our graph
|
|
// Now we can add our graph
|
|
graphs.add(graph);
|
|
graphs.add(graph);
|
|
@@ -123,101 +185,166 @@ public class Metrics {
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
/**
|
|
- * Adds a custom data plotter for a given plugin
|
|
|
|
|
|
+ * Adds a custom data plotter to the default graph
|
|
*
|
|
*
|
|
- * @param plugin
|
|
|
|
* @param plotter
|
|
* @param plotter
|
|
*/
|
|
*/
|
|
- public void addCustomData(Plugin plugin, Plotter plotter) {
|
|
|
|
- // The default graph for the plugin
|
|
|
|
- Graph graph = getOrCreateDefaultGraph(plugin);
|
|
|
|
|
|
+ public void addCustomData(final Plotter plotter) {
|
|
|
|
+ if (plotter == null) {
|
|
|
|
+ throw new IllegalArgumentException("Plotter cannot be null");
|
|
|
|
+ }
|
|
|
|
|
|
// Add the plotter to the graph o/
|
|
// Add the plotter to the graph o/
|
|
- graph.addPlotter(plotter);
|
|
|
|
|
|
+ defaultGraph.addPlotter(plotter);
|
|
|
|
|
|
// Ensure the default graph is included in the submitted graphs
|
|
// Ensure the default graph is included in the submitted graphs
|
|
- getOrCreateGraphs(plugin).add(graph);
|
|
|
|
|
|
+ graphs.add(defaultGraph);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
/**
|
|
- * Begin measuring a plugin
|
|
|
|
|
|
+ * 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.
|
|
*
|
|
*
|
|
- * @param plugin
|
|
|
|
|
|
+ * @return True if statistics measuring is running, otherwise false.
|
|
*/
|
|
*/
|
|
- public void beginMeasuringPlugin(final Plugin plugin) {
|
|
|
|
- // Did we opt out?
|
|
|
|
- if (configuration.getBoolean("opt-out", false)) {
|
|
|
|
- return;
|
|
|
|
- }
|
|
|
|
|
|
+ public boolean start() {
|
|
|
|
+ synchronized (optOutLock) {
|
|
|
|
+ // Did we opt out?
|
|
|
|
+ if (isOptOut()) {
|
|
|
|
+ return false;
|
|
|
|
+ }
|
|
|
|
|
|
- // 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(plugin, !firstPost);
|
|
|
|
-
|
|
|
|
- // After the first post we set firstPost to false
|
|
|
|
- // Each post thereafter will be a ping
|
|
|
|
- firstPost = false;
|
|
|
|
- } catch (IOException e) {
|
|
|
|
- System.out.println("[Metrics] " + e.getMessage());
|
|
|
|
- }
|
|
|
|
|
|
+ // Is metrics already running?
|
|
|
|
+ if (taskId >= 0) {
|
|
|
|
+ return true;
|
|
}
|
|
}
|
|
- }, 0, PING_INTERVAL * 1200);
|
|
|
|
|
|
+
|
|
|
|
+ // Begin hitting the server with glorious data
|
|
|
|
+ taskId = plugin.getServer().getScheduler().scheduleAsyncRepeatingTask(plugin, new Runnable() {
|
|
|
|
+
|
|
|
|
+ private boolean firstPost = true;
|
|
|
|
+
|
|
|
|
+ public void run() {
|
|
|
|
+ try {
|
|
|
|
+ // 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) {
|
|
|
|
+ plugin.getServer().getScheduler().cancelTask(taskId);
|
|
|
|
+ taskId = -1;
|
|
|
|
+ }
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ // 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) {
|
|
|
|
+ Bukkit.getLogger().log(Level.INFO, "[Metrics] " + e.getMessage());
|
|
|
|
+ }
|
|
|
|
+ }
|
|
|
|
+ }, 0, PING_INTERVAL * 1200);
|
|
|
|
+
|
|
|
|
+ return true;
|
|
|
|
+ }
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
/**
|
|
- * Generic method that posts a plugin to the metrics website
|
|
|
|
|
|
+ * Has the server owner denied plugin metrics?
|
|
*
|
|
*
|
|
- * @param plugin
|
|
|
|
|
|
+ * @return
|
|
*/
|
|
*/
|
|
- private void postPlugin(Plugin plugin, 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();
|
|
|
|
-
|
|
|
|
- // The author string, created with description.getAuthors()
|
|
|
|
- // Authors are separated by a comma
|
|
|
|
- String authors = "";
|
|
|
|
|
|
+ public boolean isOptOut() {
|
|
|
|
+ synchronized(optOutLock) {
|
|
|
|
+ try {
|
|
|
|
+ // Reload the metrics file
|
|
|
|
+ configuration.load(CONFIG_FILE);
|
|
|
|
+ } catch (IOException ex) {
|
|
|
|
+ Bukkit.getLogger().log(Level.INFO, "[Metrics] " + ex.getMessage());
|
|
|
|
+ return true;
|
|
|
|
+ } catch (InvalidConfigurationException ex) {
|
|
|
|
+ Bukkit.getLogger().log(Level.INFO, "[Metrics] " + ex.getMessage());
|
|
|
|
+ return true;
|
|
|
|
+ }
|
|
|
|
+ return configuration.getBoolean("opt-out", false);
|
|
|
|
+ }
|
|
|
|
+ }
|
|
|
|
|
|
- // Add each author to the string
|
|
|
|
- for (String author : description.getAuthors()) {
|
|
|
|
- authors += author + ", ";
|
|
|
|
|
|
+ /**
|
|
|
|
+ * Enables metrics for the server by setting "opt-out" to false in the config file and starting the metrics task.
|
|
|
|
+ *
|
|
|
|
+ * @throws IOException
|
|
|
|
+ */
|
|
|
|
+ public void enable() throws IOException {
|
|
|
|
+ // This has to be synchronized or it can collide with the check in the task.
|
|
|
|
+ synchronized (optOutLock) {
|
|
|
|
+ // Check if the server owner has already set opt-out, if not, set it.
|
|
|
|
+ if (isOptOut()) {
|
|
|
|
+ configuration.set("opt-out", false);
|
|
|
|
+ configuration.save(configurationFile);
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ // Enable Task, if it is not running
|
|
|
|
+ if (taskId < 0) {
|
|
|
|
+ start();
|
|
|
|
+ }
|
|
}
|
|
}
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ /**
|
|
|
|
+ * Disables metrics for the server by setting "opt-out" to true in the config file and canceling the metrics task.
|
|
|
|
+ *
|
|
|
|
+ * @throws IOException
|
|
|
|
+ */
|
|
|
|
+ public void disable() throws IOException {
|
|
|
|
+ // This has to be synchronized or it can collide with the check in the task.
|
|
|
|
+ synchronized (optOutLock) {
|
|
|
|
+ // Check if the server owner has already set opt-out, if not, set it.
|
|
|
|
+ if (!isOptOut()) {
|
|
|
|
+ configuration.set("opt-out", true);
|
|
|
|
+ configuration.save(configurationFile);
|
|
|
|
+ }
|
|
|
|
|
|
- // If there were any authors at all, we need to remove the last 2 characters
|
|
|
|
- // the last 2 characters are the last comma and space
|
|
|
|
- if (!authors.isEmpty()) {
|
|
|
|
- authors = authors.substring(0, authors.length() - 2);
|
|
|
|
|
|
+ // Disable Task, if it is running
|
|
|
|
+ if (taskId > 0) {
|
|
|
|
+ this.plugin.getServer().getScheduler().cancelTask(taskId);
|
|
|
|
+ taskId = -1;
|
|
|
|
+ }
|
|
}
|
|
}
|
|
|
|
+ }
|
|
|
|
+
|
|
|
|
+ /**
|
|
|
|
+ * Generic method that posts a plugin to the metrics website
|
|
|
|
+ */
|
|
|
|
+ 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
|
|
|
|
+ final PluginDescriptionFile description = plugin.getDescription();
|
|
|
|
|
|
// Construct the post data
|
|
// Construct the post data
|
|
- String data = encode("guid") + '=' + encode(guid)
|
|
|
|
- + encodeDataPair("authors", authors)
|
|
|
|
- + encodeDataPair("version", description.getVersion())
|
|
|
|
- + encodeDataPair("server", plugin.getServer().getVersion())
|
|
|
|
- + encodeDataPair("players", Integer.toString(plugin.getServer().getOnlinePlayers().length))
|
|
|
|
- + encodeDataPair("revision", String.valueOf(REVISION));
|
|
|
|
|
|
+ final StringBuilder data = new StringBuilder();
|
|
|
|
+ data.append(encode("guid")).append('=').append(encode(guid));
|
|
|
|
+ encodeDataPair(data, "version", description.getVersion());
|
|
|
|
+ encodeDataPair(data, "server", Bukkit.getVersion());
|
|
|
|
+ encodeDataPair(data, "players", Integer.toString(Bukkit.getServer().getOnlinePlayers().length));
|
|
|
|
+ encodeDataPair(data, "revision", String.valueOf(REVISION));
|
|
|
|
|
|
// If we're pinging, append it
|
|
// If we're pinging, append it
|
|
if (isPing) {
|
|
if (isPing) {
|
|
- data += encodeDataPair("ping", "true");
|
|
|
|
|
|
+ encodeDataPair(data, "ping", "true");
|
|
}
|
|
}
|
|
|
|
|
|
- // Add any custom data available for the plugin
|
|
|
|
- Set<Graph> graphs = getOrCreateGraphs(plugin);
|
|
|
|
-
|
|
|
|
// Acquire a lock on the graphs, which lets us make the assumption we also lock everything
|
|
// Acquire a lock on the graphs, which lets us make the assumption we also lock everything
|
|
// inside of the graph (e.g plotters)
|
|
// inside of the graph (e.g plotters)
|
|
- synchronized(graphs) {
|
|
|
|
- Iterator<Graph> iter = graphs.iterator();
|
|
|
|
|
|
+ synchronized (graphs) {
|
|
|
|
+ final Iterator<Graph> iter = graphs.iterator();
|
|
|
|
|
|
while (iter.hasNext()) {
|
|
while (iter.hasNext()) {
|
|
- Graph graph = iter.next();
|
|
|
|
|
|
+ final Graph graph = iter.next();
|
|
|
|
|
|
// Because we have a lock on the graphs set already, it is reasonable to assume
|
|
// 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.
|
|
// that our lock transcends down to the individual plotters in the graphs also.
|
|
@@ -227,20 +354,20 @@ public class Metrics {
|
|
// The key name to send to the metrics server
|
|
// The key name to send to the metrics server
|
|
// The format is C-GRAPHNAME-PLOTTERNAME where separator - is defined at the top
|
|
// The format is C-GRAPHNAME-PLOTTERNAME where separator - is defined at the top
|
|
// Legacy (R4) submitters use the format Custom%s, or CustomPLOTTERNAME
|
|
// 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());
|
|
|
|
|
|
+ final 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
|
|
// The value to send, which for the foreseeable future is just the string
|
|
// value of plotter.getValue()
|
|
// value of plotter.getValue()
|
|
- String value = Integer.toString(plotter.getValue());
|
|
|
|
|
|
+ final String value = Integer.toString(plotter.getValue());
|
|
|
|
|
|
// Add it to the http post data :)
|
|
// Add it to the http post data :)
|
|
- data += encodeDataPair(key, value);
|
|
|
|
|
|
+ encodeDataPair(data, key, value);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
// Create the url
|
|
// Create the url
|
|
- URL url = new URL(BASE_URL + String.format(REPORT_URL, plugin.getDescription().getName()));
|
|
|
|
|
|
+ URL url = new URL(BASE_URL + String.format(REPORT_URL, encode(plugin.getDescription().getName())));
|
|
|
|
|
|
// Connect to the website
|
|
// Connect to the website
|
|
URLConnection connection;
|
|
URLConnection connection;
|
|
@@ -256,28 +383,28 @@ public class Metrics {
|
|
connection.setDoOutput(true);
|
|
connection.setDoOutput(true);
|
|
|
|
|
|
// Write the data
|
|
// Write the data
|
|
- OutputStreamWriter writer = new OutputStreamWriter(connection.getOutputStream());
|
|
|
|
- writer.write(data);
|
|
|
|
|
|
+ final OutputStreamWriter writer = new OutputStreamWriter(connection.getOutputStream());
|
|
|
|
+ writer.write(data.toString());
|
|
writer.flush();
|
|
writer.flush();
|
|
|
|
|
|
// Now read the response
|
|
// Now read the response
|
|
- BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
|
|
|
|
- String response = reader.readLine();
|
|
|
|
|
|
+ final BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
|
|
|
|
+ final String response = reader.readLine();
|
|
|
|
|
|
// close resources
|
|
// close resources
|
|
writer.close();
|
|
writer.close();
|
|
reader.close();
|
|
reader.close();
|
|
|
|
|
|
- if (response.startsWith("ERR")) {
|
|
|
|
|
|
+ if (response == null || response.startsWith("ERR")) {
|
|
throw new IOException(response); //Throw the exception
|
|
throw new IOException(response); //Throw the exception
|
|
} else {
|
|
} else {
|
|
// Is this the first update this hour?
|
|
// Is this the first update this hour?
|
|
if (response.contains("OK This is your first update this hour")) {
|
|
if (response.contains("OK This is your first update this hour")) {
|
|
synchronized (graphs) {
|
|
synchronized (graphs) {
|
|
- Iterator<Graph> iter = graphs.iterator();
|
|
|
|
|
|
+ final Iterator<Graph> iter = graphs.iterator();
|
|
|
|
|
|
while (iter.hasNext()) {
|
|
while (iter.hasNext()) {
|
|
- Graph graph = iter.next();
|
|
|
|
|
|
+ final Graph graph = iter.next();
|
|
|
|
|
|
for (Plotter plotter : graph.getPlotters()) {
|
|
for (Plotter plotter : graph.getPlotters()) {
|
|
plotter.reset();
|
|
plotter.reset();
|
|
@@ -289,42 +416,6 @@ public class Metrics {
|
|
//if (response.startsWith("OK")) - We should get "OK" followed by an optional description if everything goes right
|
|
//if (response.startsWith("OK")) - We should get "OK" followed by an optional description if everything goes right
|
|
}
|
|
}
|
|
|
|
|
|
- /**
|
|
|
|
- * Get or create the Set of graphs for a specific plugin
|
|
|
|
- *
|
|
|
|
- * @param plugin
|
|
|
|
- * @return
|
|
|
|
- */
|
|
|
|
- private Set<Graph> getOrCreateGraphs(Plugin plugin) {
|
|
|
|
- Set<Graph> theGraphs = graphs.get(plugin);
|
|
|
|
-
|
|
|
|
- // Create the Set if it does not already exist
|
|
|
|
- if (theGraphs == null) {
|
|
|
|
- theGraphs = Collections.synchronizedSet(new HashSet<Graph>());
|
|
|
|
- graphs.put(plugin, theGraphs);
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- return theGraphs;
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- /**
|
|
|
|
- * Get the default graph for a plugin and if it does not exist, create one
|
|
|
|
- *
|
|
|
|
- * @param plugin
|
|
|
|
- * @return
|
|
|
|
- */
|
|
|
|
- private Graph getOrCreateDefaultGraph(Plugin plugin) {
|
|
|
|
- Graph graph = defaultGraphs.get(plugin);
|
|
|
|
-
|
|
|
|
- // Not yet created :(
|
|
|
|
- if (graph == null) {
|
|
|
|
- graph = new Graph(Graph.Type.Line, "Default");
|
|
|
|
- defaultGraphs.put(plugin, graph);
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- return graph;
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
/**
|
|
/**
|
|
* Check if mineshafter is present. If it is, we need to bypass it to send POST requests
|
|
* Check if mineshafter is present. If it is, we need to bypass it to send POST requests
|
|
*
|
|
*
|
|
@@ -340,18 +431,21 @@ public class Metrics {
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
/**
|
|
- * 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>
|
|
|
|
- * String httpData = encode("guid") + "=" + encode("1234") + encodeDataPair("authors") + "..";
|
|
|
|
- * </p>
|
|
|
|
|
|
+ * <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>
|
|
|
|
+ * StringBuffer data = new StringBuffer();
|
|
|
|
+ * data.append(encode("guid")).append('=').append(encode(guid));
|
|
|
|
+ * encodeDataPair(data, "version", description.getVersion());
|
|
|
|
+ * </code>
|
|
*
|
|
*
|
|
|
|
+ * @param buffer
|
|
* @param key
|
|
* @param key
|
|
* @param value
|
|
* @param value
|
|
* @return
|
|
* @return
|
|
*/
|
|
*/
|
|
- private static String encodeDataPair(String key, String value) throws UnsupportedEncodingException {
|
|
|
|
- return "&" + encode(key) + "=" + encode(value);
|
|
|
|
|
|
+ private static void encodeDataPair(final StringBuilder buffer, final String key, final String value) throws UnsupportedEncodingException {
|
|
|
|
+ buffer.append('&').append(encode(key)).append('=').append(encode(value));
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
/**
|
|
@@ -360,7 +454,7 @@ public class Metrics {
|
|
* @param text
|
|
* @param text
|
|
* @return
|
|
* @return
|
|
*/
|
|
*/
|
|
- private static String encode(String text) throws UnsupportedEncodingException {
|
|
|
|
|
|
+ private static String encode(final String text) throws UnsupportedEncodingException {
|
|
return URLEncoder.encode(text, "UTF-8");
|
|
return URLEncoder.encode(text, "UTF-8");
|
|
}
|
|
}
|
|
|
|
|
|
@@ -369,41 +463,6 @@ public class Metrics {
|
|
*/
|
|
*/
|
|
public static class Graph {
|
|
public static class Graph {
|
|
|
|
|
|
- /**
|
|
|
|
- * The graph's type that will be visible on the website
|
|
|
|
- */
|
|
|
|
- public static enum Type {
|
|
|
|
-
|
|
|
|
- /**
|
|
|
|
- * A simple line graph which also includes a scrollable timeline viewer to view
|
|
|
|
- * as little or as much of the data as possible.
|
|
|
|
- */
|
|
|
|
- Line,
|
|
|
|
-
|
|
|
|
- /**
|
|
|
|
- * An area graph. This is the same as a line graph except the area under the curve is shaded
|
|
|
|
- */
|
|
|
|
- Area,
|
|
|
|
-
|
|
|
|
- /**
|
|
|
|
- * A column graph, which is a graph where the data is represented by columns on the vertical axis,
|
|
|
|
- * i.e they go up and down.
|
|
|
|
- */
|
|
|
|
- Column,
|
|
|
|
-
|
|
|
|
- /**
|
|
|
|
- * A pie graph. The graph is generated by taking the data for the last hour and summing it
|
|
|
|
- * together. Then the percentage for each plotter is calculated via round( (plot / total) * 100, 2 )
|
|
|
|
- */
|
|
|
|
- Pie
|
|
|
|
-
|
|
|
|
- }
|
|
|
|
-
|
|
|
|
- /**
|
|
|
|
- * What the graph should be plotted as
|
|
|
|
- */
|
|
|
|
- private final Type type;
|
|
|
|
-
|
|
|
|
/**
|
|
/**
|
|
* The graph's name, alphanumeric and spaces only :)
|
|
* The graph's name, alphanumeric and spaces only :)
|
|
* If it does not comply to the above when submitted, it is rejected
|
|
* If it does not comply to the above when submitted, it is rejected
|
|
@@ -415,8 +474,7 @@ public class Metrics {
|
|
*/
|
|
*/
|
|
private final Set<Plotter> plotters = new LinkedHashSet<Plotter>();
|
|
private final Set<Plotter> plotters = new LinkedHashSet<Plotter>();
|
|
|
|
|
|
- private Graph(Type type, String name) {
|
|
|
|
- this.type = type;
|
|
|
|
|
|
+ private Graph(final String name) {
|
|
this.name = name;
|
|
this.name = name;
|
|
}
|
|
}
|
|
|
|
|
|
@@ -434,7 +492,7 @@ public class Metrics {
|
|
*
|
|
*
|
|
* @param plotter
|
|
* @param plotter
|
|
*/
|
|
*/
|
|
- public void addPlotter(Plotter plotter) {
|
|
|
|
|
|
+ public void addPlotter(final Plotter plotter) {
|
|
plotters.add(plotter);
|
|
plotters.add(plotter);
|
|
}
|
|
}
|
|
|
|
|
|
@@ -443,12 +501,13 @@ public class Metrics {
|
|
*
|
|
*
|
|
* @param plotter
|
|
* @param plotter
|
|
*/
|
|
*/
|
|
- public void removePlotter(Plotter plotter) {
|
|
|
|
|
|
+ public void removePlotter(final Plotter plotter) {
|
|
plotters.remove(plotter);
|
|
plotters.remove(plotter);
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
/**
|
|
* Gets an <b>unmodifiable</b> set of the plotter objects in the graph
|
|
* Gets an <b>unmodifiable</b> set of the plotter objects in the graph
|
|
|
|
+ *
|
|
* @return
|
|
* @return
|
|
*/
|
|
*/
|
|
public Set<Plotter> getPlotters() {
|
|
public Set<Plotter> getPlotters() {
|
|
@@ -457,17 +516,17 @@ public class Metrics {
|
|
|
|
|
|
@Override
|
|
@Override
|
|
public int hashCode() {
|
|
public int hashCode() {
|
|
- return (type.hashCode() * 17) ^ name.hashCode();
|
|
|
|
|
|
+ return name.hashCode();
|
|
}
|
|
}
|
|
|
|
|
|
@Override
|
|
@Override
|
|
- public boolean equals(Object object) {
|
|
|
|
|
|
+ public boolean equals(final Object object) {
|
|
if (!(object instanceof Graph)) {
|
|
if (!(object instanceof Graph)) {
|
|
return false;
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|
|
- Graph graph = (Graph) object;
|
|
|
|
- return graph.type == type && graph.name.equals(name);
|
|
|
|
|
|
+ final Graph graph = (Graph) object;
|
|
|
|
+ return graph.name.equals(name);
|
|
}
|
|
}
|
|
|
|
|
|
}
|
|
}
|
|
@@ -494,7 +553,7 @@ public class Metrics {
|
|
*
|
|
*
|
|
* @param name
|
|
* @param name
|
|
*/
|
|
*/
|
|
- public Plotter(String name) {
|
|
|
|
|
|
+ public Plotter(final String name) {
|
|
this.name = name;
|
|
this.name = name;
|
|
}
|
|
}
|
|
|
|
|
|
@@ -526,12 +585,12 @@ public class Metrics {
|
|
}
|
|
}
|
|
|
|
|
|
@Override
|
|
@Override
|
|
- public boolean equals(Object object) {
|
|
|
|
|
|
+ public boolean equals(final Object object) {
|
|
if (!(object instanceof Plotter)) {
|
|
if (!(object instanceof Plotter)) {
|
|
return false;
|
|
return false;
|
|
}
|
|
}
|
|
|
|
|
|
- Plotter plotter = (Plotter) object;
|
|
|
|
|
|
+ final Plotter plotter = (Plotter) object;
|
|
return plotter.name.equals(name) && plotter.getValue() == getValue();
|
|
return plotter.name.equals(name) && plotter.getValue() == getValue();
|
|
}
|
|
}
|
|
|
|
|