2012-03-01 22:03:59 +01:00
|
|
|
package com.Acrobot.ChestShop;
|
|
|
|
|
2012-01-25 16:32:34 +01:00
|
|
|
import org.bukkit.Bukkit;
|
2012-04-07 12:41:20 +02:00
|
|
|
import org.bukkit.configuration.InvalidConfigurationException;
|
2012-01-25 16:32:34 +01:00
|
|
|
import org.bukkit.configuration.file.YamlConfiguration;
|
|
|
|
import org.bukkit.plugin.Plugin;
|
2012-03-01 22:03:59 +01:00
|
|
|
import org.bukkit.plugin.PluginDescriptionFile;
|
|
|
|
|
2012-04-07 12:41:20 +02:00
|
|
|
import java.io.BufferedReader;
|
|
|
|
import java.io.File;
|
|
|
|
import java.io.IOException;
|
|
|
|
import java.io.InputStreamReader;
|
|
|
|
import java.io.OutputStreamWriter;
|
|
|
|
import java.io.UnsupportedEncodingException;
|
2012-03-01 22:03:59 +01:00
|
|
|
import java.net.Proxy;
|
2012-01-25 16:32:34 +01:00
|
|
|
import java.net.URL;
|
|
|
|
import java.net.URLConnection;
|
|
|
|
import java.net.URLEncoder;
|
2012-04-07 12:41:20 +02:00
|
|
|
import java.util.UUID;
|
|
|
|
import java.util.logging.Level;
|
2012-01-25 16:32:34 +01:00
|
|
|
|
|
|
|
public class Metrics {
|
|
|
|
|
|
|
|
/**
|
2012-03-01 22:03:59 +01:00
|
|
|
* The current revision number
|
2012-01-25 16:32:34 +01:00
|
|
|
*/
|
2012-03-01 22:03:59 +01:00
|
|
|
private final static int REVISION = 5;
|
2012-01-25 16:32:34 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The base url of the metrics domain
|
|
|
|
*/
|
2012-04-16 16:34:00 +02:00
|
|
|
private static final String BASE_URL = "http://mcstats.org";
|
2012-01-25 16:32:34 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* 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";
|
|
|
|
|
2012-03-01 22:03:59 +01:00
|
|
|
/**
|
|
|
|
* Interval of time to ping (in minutes)
|
2012-01-25 16:32:34 +01:00
|
|
|
*/
|
|
|
|
private final static int PING_INTERVAL = 10;
|
|
|
|
|
|
|
|
/**
|
2012-04-07 12:41:20 +02:00
|
|
|
* The plugin this metrics submits for
|
2012-03-01 22:03:59 +01:00
|
|
|
*/
|
2012-04-07 12:41:20 +02:00
|
|
|
private final Plugin plugin;
|
2012-03-01 22:03:59 +01:00
|
|
|
|
|
|
|
/**
|
2012-04-07 12:41:20 +02:00
|
|
|
* The plugin configuration file
|
2012-01-25 16:32:34 +01:00
|
|
|
*/
|
2012-04-07 12:41:20 +02:00
|
|
|
private final YamlConfiguration configuration;
|
2012-01-25 16:32:34 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* The plugin configuration file
|
|
|
|
*/
|
2012-04-07 12:41:20 +02:00
|
|
|
private final File configurationFile;
|
2012-01-25 16:32:34 +01:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Unique server id
|
|
|
|
*/
|
2012-04-07 12:41:20 +02:00
|
|
|
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(Plugin plugin) throws IOException {
|
|
|
|
if (plugin == null) {
|
|
|
|
throw new IllegalArgumentException("Plugin cannot be null");
|
|
|
|
}
|
|
|
|
|
|
|
|
this.plugin = plugin;
|
2012-01-25 16:32:34 +01:00
|
|
|
|
|
|
|
// load the config
|
2012-04-07 12:41:20 +02:00
|
|
|
configurationFile = new File(CONFIG_FILE);
|
|
|
|
configuration = YamlConfiguration.loadConfiguration(configurationFile);
|
2012-01-25 16:32:34 +01:00
|
|
|
|
|
|
|
// 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) {
|
2012-04-16 16:34:00 +02:00
|
|
|
configuration.options().header("http://mcstats.org").copyDefaults(true);
|
2012-04-07 12:41:20 +02:00
|
|
|
configuration.save(configurationFile);
|
2012-01-25 16:32:34 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// Load the guid then
|
|
|
|
guid = configuration.getString("guid");
|
|
|
|
}
|
|
|
|
|
2012-04-07 12:41:20 +02:00
|
|
|
|
2012-03-01 22:03:59 +01:00
|
|
|
/**
|
2012-04-07 12:41:20 +02:00
|
|
|
* 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.
|
2012-03-01 22:03:59 +01:00
|
|
|
*
|
2012-04-07 12:41:20 +02:00
|
|
|
* @return True if statistics measuring is running, otherwise false.
|
2012-03-01 22:03:59 +01:00
|
|
|
*/
|
2012-04-07 12:41:20 +02:00
|
|
|
public boolean start() {
|
|
|
|
synchronized (optOutLock) {
|
|
|
|
// Did we opt out?
|
|
|
|
if (isOptOut()) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Is metrics already running?
|
|
|
|
if (taskId >= 0) {
|
|
|
|
return true;
|
|
|
|
}
|
2012-03-01 22:03:59 +01:00
|
|
|
|
2012-04-07 12:41:20 +02:00
|
|
|
// Begin hitting the server with glorious data
|
|
|
|
taskId = plugin.getServer().getScheduler().scheduleAsyncRepeatingTask(plugin, new Runnable() {
|
2012-03-01 22:03:59 +01:00
|
|
|
|
2012-04-07 12:41:20 +02:00
|
|
|
private boolean firstPost = true;
|
2012-03-01 22:03:59 +01:00
|
|
|
|
2012-04-07 12:41:20 +02:00
|
|
|
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;
|
|
|
|
}
|
|
|
|
}
|
2012-03-01 22:03:59 +01:00
|
|
|
|
2012-04-07 12:41:20 +02:00
|
|
|
// 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] {0}", e.getMessage());
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}, 0, PING_INTERVAL * 1200);
|
|
|
|
|
|
|
|
return true;
|
|
|
|
}
|
2012-03-01 22:03:59 +01:00
|
|
|
}
|
|
|
|
|
2012-01-25 16:32:34 +01:00
|
|
|
/**
|
2012-04-07 12:41:20 +02:00
|
|
|
* Has the server owner denied plugin metrics?
|
2012-01-25 16:32:34 +01:00
|
|
|
*
|
2012-04-07 12:41:20 +02:00
|
|
|
* @return
|
2012-01-25 16:32:34 +01:00
|
|
|
*/
|
2012-04-07 12:41:20 +02:00
|
|
|
public boolean isOptOut() {
|
|
|
|
synchronized(optOutLock) {
|
|
|
|
try {
|
|
|
|
// Reload the metrics file
|
|
|
|
configuration.load(CONFIG_FILE);
|
|
|
|
} catch (IOException ex) {
|
2012-04-19 16:14:12 +02:00
|
|
|
Bukkit.getLogger().log(Level.INFO, "[Metrics] " + ex.getMessage());
|
2012-04-07 12:41:20 +02:00
|
|
|
return true;
|
|
|
|
} catch (InvalidConfigurationException ex) {
|
2012-04-19 16:14:12 +02:00
|
|
|
Bukkit.getLogger().log(Level.INFO, "[Metrics] " + ex.getMessage());
|
2012-04-07 12:41:20 +02:00
|
|
|
return true;
|
|
|
|
}
|
|
|
|
return configuration.getBoolean("opt-out", false);
|
|
|
|
}
|
2012-01-25 16:32:34 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2012-04-07 12:41:20 +02:00
|
|
|
* Enables metrics for the server by setting "opt-out" to false in the config file and starting the metrics task.
|
2012-01-25 16:32:34 +01:00
|
|
|
*
|
2012-04-07 12:41:20 +02:00
|
|
|
* @throws IOException
|
2012-01-25 16:32:34 +01:00
|
|
|
*/
|
2012-04-07 12:41:20 +02:00
|
|
|
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);
|
|
|
|
}
|
2012-01-25 16:32:34 +01:00
|
|
|
|
2012-04-07 12:41:20 +02:00
|
|
|
// Enable Task, if it is not running
|
|
|
|
if (taskId < 0) {
|
|
|
|
start();
|
2012-01-25 16:32:34 +01:00
|
|
|
}
|
2012-04-07 12:41:20 +02:00
|
|
|
}
|
2012-01-25 16:32:34 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2012-04-07 12:41:20 +02:00
|
|
|
* Disables metrics for the server by setting "opt-out" to true in the config file and canceling the metrics task.
|
2012-01-25 16:32:34 +01:00
|
|
|
*
|
2012-04-07 12:41:20 +02:00
|
|
|
* @throws IOException
|
2012-01-25 16:32:34 +01:00
|
|
|
*/
|
2012-04-07 12:41:20 +02:00
|
|
|
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);
|
|
|
|
}
|
2012-03-01 22:03:59 +01:00
|
|
|
|
2012-04-07 12:41:20 +02:00
|
|
|
// Disable Task, if it is running
|
|
|
|
if (taskId > 0) {
|
|
|
|
this.plugin.getServer().getScheduler().cancelTask(taskId);
|
|
|
|
taskId = -1;
|
|
|
|
}
|
2012-03-01 22:03:59 +01:00
|
|
|
}
|
2012-04-07 12:41:20 +02:00
|
|
|
}
|
2012-03-01 22:03:59 +01:00
|
|
|
|
2012-04-07 12:41:20 +02:00
|
|
|
/**
|
|
|
|
* 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
|
|
|
|
final PluginDescriptionFile description = plugin.getDescription();
|
2012-03-01 22:03:59 +01:00
|
|
|
|
2012-01-25 16:32:34 +01:00
|
|
|
// Construct the post data
|
2012-04-16 16:34:00 +02:00
|
|
|
final StringBuilder data = new StringBuilder(100);
|
2012-04-07 12:41:20 +02:00
|
|
|
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));
|
2012-01-25 16:32:34 +01:00
|
|
|
|
|
|
|
// If we're pinging, append it
|
|
|
|
if (isPing) {
|
2012-04-07 12:41:20 +02:00
|
|
|
encodeDataPair(data, "ping", "true");
|
2012-01-25 16:32:34 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// Create the url
|
2012-04-16 16:34:00 +02:00
|
|
|
URL url = new URL(BASE_URL + String.format(REPORT_URL, encode(plugin.getDescription().getName())));
|
2012-01-25 16:32:34 +01:00
|
|
|
|
|
|
|
// Connect to the website
|
2012-03-01 22:03:59 +01:00
|
|
|
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();
|
|
|
|
}
|
|
|
|
|
2012-01-25 16:32:34 +01:00
|
|
|
connection.setDoOutput(true);
|
|
|
|
|
|
|
|
// Write the data
|
2012-04-07 12:41:20 +02:00
|
|
|
final OutputStreamWriter writer = new OutputStreamWriter(connection.getOutputStream());
|
|
|
|
writer.write(data.toString());
|
2012-01-25 16:32:34 +01:00
|
|
|
writer.flush();
|
|
|
|
|
|
|
|
// Now read the response
|
2012-04-07 12:41:20 +02:00
|
|
|
final BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
|
|
|
|
final String response = reader.readLine();
|
2012-01-25 16:32:34 +01:00
|
|
|
|
|
|
|
// close resources
|
|
|
|
writer.close();
|
|
|
|
reader.close();
|
2012-02-16 19:09:37 +01:00
|
|
|
|
2012-04-07 12:41:20 +02:00
|
|
|
if (response == null || response.startsWith("ERR")) {
|
2012-02-16 19:09:37 +01:00
|
|
|
throw new IOException(response); //Throw the exception
|
|
|
|
}
|
|
|
|
//if (response.startsWith("OK")) - We should get "OK" followed by an optional description if everything goes right
|
|
|
|
}
|
|
|
|
|
2012-03-01 22:03:59 +01:00
|
|
|
/**
|
|
|
|
* Check if mineshafter is present. If it is, we need to bypass it to send POST requests
|
|
|
|
*
|
|
|
|
* @return
|
|
|
|
*/
|
2012-04-16 16:34:00 +02:00
|
|
|
private static boolean isMineshafterPresent() {
|
2012-03-01 22:03:59 +01:00
|
|
|
try {
|
|
|
|
Class.forName("mineshafter.MineServer");
|
|
|
|
return true;
|
|
|
|
} catch (Exception e) {
|
|
|
|
return false;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
2012-04-07 12:41:20 +02:00
|
|
|
* <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>
|
2012-03-01 22:03:59 +01:00
|
|
|
*
|
2012-04-07 12:41:20 +02:00
|
|
|
* @param buffer
|
2012-03-01 22:03:59 +01:00
|
|
|
* @param key
|
|
|
|
* @param value
|
|
|
|
* @return
|
2012-02-16 19:09:37 +01:00
|
|
|
*/
|
2012-04-07 12:41:20 +02:00
|
|
|
private static void encodeDataPair(final StringBuilder buffer, final String key, final String value) throws UnsupportedEncodingException {
|
|
|
|
buffer.append('&').append(encode(key)).append('=').append(encode(value));
|
2012-01-25 16:32:34 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Encode text as UTF-8
|
|
|
|
*
|
|
|
|
* @param text
|
|
|
|
* @return
|
|
|
|
*/
|
|
|
|
private static String encode(String text) throws UnsupportedEncodingException {
|
|
|
|
return URLEncoder.encode(text, "UTF-8");
|
|
|
|
}
|
|
|
|
|
|
|
|
}
|