Now using the latest version of Metrics to stop a NPE

src/main/java/com/gmail/nossr50/Metrics.java

@@ -1,6 +1,35 @@
 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.InvalidConfigurationException;
 import org.bukkit.plugin.Plugin;
 import org.bukkit.plugin.PluginDescriptionFile;
 
@@ -15,14 +44,26 @@ import java.net.URL;
 import java.net.URLConnection;
 import java.net.URLEncoder;
 import java.util.Collections;
-import java.util.HashMap;
 import java.util.HashSet;
 import java.util.Iterator;
 import java.util.LinkedHashSet;
-import java.util.Map;
 import java.util.Set;
 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 {
 
     /**
@@ -33,7 +74,7 @@ public class Metrics {
     /**
      * 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
@@ -43,7 +84,7 @@ public class Metrics {
     /**
      * 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
@@ -54,32 +95,58 @@ public class Metrics {
     /**
      * Interval of time to ping (in minutes)
      */
-    private final static int PING_INTERVAL = 10;
+    private static final int PING_INTERVAL = 10;
 
     /**
-     * A map of all of the graphs for each plugin
+     * The plugin this metrics submits for
      */
-    private Map<Plugin, Set<Graph>> graphs = Collections.synchronizedMap(new HashMap<Plugin, Set<Graph>>());
+    private final Plugin plugin;
 
     /**
-     * A convenient map of the default Graph objects (used by addCustomData mainly)
+     * All of the custom graphs to submit to metrics
      */
-    private Map<Plugin, Graph> defaultGraphs = Collections.synchronizedMap(new HashMap<Plugin, Graph>());
+    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;
+    
+    /**
+     * The plugin configuration file
+     */
+    private final File configurationFile;
 
     /**
      * 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
-        File file = new File(CONFIG_FILE);
+        configurationFile = new File(CONFIG_FILE);
-        configuration = YamlConfiguration.loadConfiguration(file);
+        configuration = YamlConfiguration.loadConfiguration(configurationFile);
 
         // add some defaults
         configuration.addDefault("opt-out", false);
@@ -87,8 +154,8 @@ public class Metrics {
 
         // Do we need to create the file?
         if (configuration.get("guid", null) == null) {
-            configuration.options().header("http://metrics.griefcraft.com").copyDefaults(true);
+            configuration.options().header("http://mcstats.org").copyDefaults(true);
-            configuration.save(file);
+            configuration.save(configurationFile);
         }
 
         // 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
      * on the metrics website. Plotters can be added to the graph object returned.
      *
-     * @param plugin
-     * @param type
      * @param name
      * @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) {
+    public Graph createGraph(final String name) {
-        if (plugin == null || type == null || name == null) {
+        if (name == null) {
-            throw new IllegalArgumentException("All arguments must not be null");
+            throw new IllegalArgumentException("Graph name cannot be null");
         }
 
         // Construct the graph object
-        Graph graph = new Graph(type, name);
+        final Graph graph = new Graph(name);
-
-        // Get the graphs for the plugin
-        Set<Graph> graphs = getOrCreateGraphs(plugin);
 
         // Now we can add our 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
      */
-    public void addCustomData(Plugin plugin, Plotter plotter) {
+    public void addCustomData(final Plotter plotter) {
-        // The default graph for the plugin
+        if (plotter == null) {
-        Graph graph = getOrCreateDefaultGraph(plugin);
+            throw new IllegalArgumentException("Plotter cannot be null");
+        }
 
         // Add the plotter to the graph o/
-        graph.addPlotter(plotter);
+        defaultGraph.addPlotter(plotter);
 
         // 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) {
+    public boolean start() {
-        // Did we opt out?
+        synchronized (optOutLock) {
-        if (configuration.getBoolean("opt-out", false)) {
+            // Did we opt out?
-            return;
+            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());
-                }
             }
-        }, 0, PING_INTERVAL * 1200);
+
+            // Is metrics already running?
+            if (taskId >= 0) {
+                return true;
+            }
+
+            // 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;
+        }
+    }
+
+    /**
+     * Has the server owner denied plugin metrics?
+     *
+     * @return
+     */
+    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);
+        }
+    }
+
+    /**
+    * 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);
+            }
+
+            // 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
-     *
-     * @param plugin
      */
-    private void postPlugin(Plugin plugin, 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
-        PluginDescriptionFile description = plugin.getDescription();
+        final PluginDescriptionFile description = plugin.getDescription();
-
-        // The author string, created with description.getAuthors()
-        // Authors are separated by a comma
-        String authors = "";
-
-        // Add each author to the string
-        for (String author : description.getAuthors()) {
-            authors += author + ", ";
-        }
-
-        // 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);
-        }
 
         // Construct the post data
-        String data = encode("guid") + '=' + encode(guid)
+        final StringBuilder data = new StringBuilder();
-                + encodeDataPair("authors", authors)
+        data.append(encode("guid")).append('=').append(encode(guid));
-                + encodeDataPair("version", description.getVersion())
+        encodeDataPair(data, "version", description.getVersion());
-                + encodeDataPair("server", plugin.getServer().getVersion())
+        encodeDataPair(data, "server", Bukkit.getVersion());
-                + encodeDataPair("players", Integer.toString(plugin.getServer().getOnlinePlayers().length))
+        encodeDataPair(data, "players", Integer.toString(Bukkit.getServer().getOnlinePlayers().length));
-                + encodeDataPair("revision", String.valueOf(REVISION));
+        encodeDataPair(data, "revision", String.valueOf(REVISION));
 
         // If we're pinging, append it
         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
         // inside of the graph (e.g plotters)
-        synchronized(graphs) {
+        synchronized (graphs) {
-            Iterator<Graph> iter = graphs.iterator();
+            final Iterator<Graph> iter = graphs.iterator();
 
             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
                 // 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 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());
+                    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
                     // value of plotter.getValue()
-                    String value = Integer.toString(plotter.getValue());
+                    final String value = Integer.toString(plotter.getValue());
 
                     // Add it to the http post data :)
-                    data += encodeDataPair(key, value);
+                    encodeDataPair(data, key, value);
                 }
             }
         }
 
         // 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
         URLConnection connection;
@@ -256,28 +383,28 @@ public class Metrics {
         connection.setDoOutput(true);
 
         // Write the data
-        OutputStreamWriter writer = new OutputStreamWriter(connection.getOutputStream());
+        final OutputStreamWriter writer = new OutputStreamWriter(connection.getOutputStream());
-        writer.write(data);
+        writer.write(data.toString());
         writer.flush();
 
         // Now read the response
-        BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
+        final BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
-        String response = reader.readLine();
+        final String response = reader.readLine();
 
         // close resources
         writer.close();
         reader.close();
 
-        if (response.startsWith("ERR")) {
+        if (response == null || 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();
+                    final Iterator<Graph> iter = graphs.iterator();
 
                     while (iter.hasNext()) {
-                        Graph graph = iter.next();
+                        final Graph graph = iter.next();
 
                         for (Plotter plotter : graph.getPlotters()) {
                             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
     }
 
-    /**
-     * 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
      *
@@ -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
+     * <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:
+     * key/value pair MUST be included manually, e.g:</p>
-     * <p>
+     * <code>
-     *     String httpData = encode("guid") + "=" + encode("1234") + encodeDataPair("authors") + "..";
+     * StringBuffer data = new StringBuffer();
-     * </p>
+     * data.append(encode("guid")).append('=').append(encode(guid));
+     * encodeDataPair(data, "version", description.getVersion());
+     * </code>
      *
+     * @param buffer
      * @param key
      * @param value
      * @return
      */
-    private static String encodeDataPair(String key, String value) throws UnsupportedEncodingException {
+    private static void encodeDataPair(final StringBuilder buffer, final String key, final String value) throws UnsupportedEncodingException {
-        return "&" + encode(key) + "=" + encode(value);
+        buffer.append('&').append(encode(key)).append('=').append(encode(value));
     }
 
     /**
@@ -360,7 +454,7 @@ public class Metrics {
      * @param text
      * @return
      */
-    private static String encode(String text) throws UnsupportedEncodingException {
+    private static String encode(final String text) throws UnsupportedEncodingException {
         return URLEncoder.encode(text, "UTF-8");
     }
 
@@ -369,41 +463,6 @@ public class Metrics {
      */
     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 :)
          * 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 Graph(Type type, String name) {
+        private Graph(final String name) {
-            this.type = type;
             this.name = name;
         }
 
@@ -434,7 +492,7 @@ public class Metrics {
          *
          * @param plotter
          */
-        public void addPlotter(Plotter plotter) {
+        public void addPlotter(final Plotter plotter) {
             plotters.add(plotter);
         }
 
@@ -443,12 +501,13 @@ public class Metrics {
          *
          * @param plotter
          */
-        public void removePlotter(Plotter plotter) {
+        public void removePlotter(final Plotter plotter) {
             plotters.remove(plotter);
         }
 
         /**
          * Gets an <b>unmodifiable</b> set of the plotter objects in the graph
+         *
          * @return
          */
         public Set<Plotter> getPlotters() {
@@ -457,17 +516,17 @@ public class Metrics {
 
         @Override
         public int hashCode() {
-            return (type.hashCode() * 17) ^ name.hashCode();
+            return name.hashCode();
         }
 
         @Override
-        public boolean equals(Object object) {
+        public boolean equals(final Object object) {
             if (!(object instanceof Graph)) {
                 return false;
             }
 
-            Graph graph = (Graph) object;
+            final Graph graph = (Graph) object;
-            return graph.type == type && graph.name.equals(name);
+            return graph.name.equals(name);
         }
 
     }
@@ -494,7 +553,7 @@ public class Metrics {
          *
          * @param name
          */
-        public Plotter(String name) {
+        public Plotter(final String name) {
             this.name = name;
         }
 
@@ -526,12 +585,12 @@ public class Metrics {
         }
 
         @Override
-        public boolean equals(Object object) {
+        public boolean equals(final Object object) {
             if (!(object instanceof Plotter)) {
                 return false;
             }
 
-            Plotter plotter = (Plotter) object;
+            final Plotter plotter = (Plotter) object;
             return plotter.name.equals(name) && plotter.getValue() == getValue();
         }
 

src/main/java/com/gmail/nossr50/mcMMO.java

@@ -14,12 +14,7 @@ import com.gmail.nossr50.listeners.PlayerListener;
 import com.gmail.nossr50.locale.mcLocale;
 import com.gmail.nossr50.party.Party;
 
-import java.io.BufferedInputStream;
-import java.io.BufferedWriter;
 import java.io.File;
-import java.io.FileInputStream;
-import java.io.FileNotFoundException;
-import java.io.FileWriter;
 import java.io.IOException;
 import java.io.InputStream;
 import java.util.HashMap;
@@ -123,24 +118,17 @@ public class mcMMO extends JavaPlugin {
         registerCommands();
 
         if (Config.getStatsTrackingEnabled()) {
-            //Plugin Metrics running in a new thread
+            try {
-            new Thread(new Runnable() {
+                    Metrics metrics = new Metrics(this);
-                public void run() {
+                    metrics.start();
-                    try {
-                        // create a new metrics object
-                        Metrics metrics = new Metrics();
-
-                        // 'this' in this context is the Plugin object
-                        metrics.beginMeasuringPlugin(p);
-                    }
-                    catch (IOException e) {
-                        System.out.println("Failed to submit stats.");
-                    }
                 }
-            }).start();
+                catch (IOException e) {
+                System.out.println("Failed to submit stats.");
+            }
         }
     }
 
+
     /**
      * Get profile of the player.
      * </br>