added metrics

.idea/misc.xml

@@ -12,7 +12,7 @@
       </list>
     </option>
   </component>
-  <component name="ProjectRootManager" version="2" languageLevel="JDK_1_8" default="true" project-jdk-name="1.8.0_121" project-jdk-type="JavaSDK">
+  <component name="ProjectRootManager" version="2" languageLevel="JDK_1_8" default="true" project-jdk-name="1.8" project-jdk-type="JavaSDK">
     <output url="file://$PROJECT_DIR$/out" />
   </component>
 </project>

src/main/java/net/DeltaWings/Minecraft/BetterTP/Main.java

@@ -31,6 +31,7 @@ public final class Main extends JavaPlugin {
 		getCommand("Delhome").setExecutor(new Delhome());
 		getCommand("Homelist").setExecutor(new Homelist());
 
+		new Metrics(this);
 		try {
 			config();
 		} catch ( IOException e ) {

src/main/java/net/DeltaWings/Minecraft/BetterTP/Metrics.java

@@ -0,0 +1,292 @@
+package net.DeltaWings.Minecraft.BetterTP;
+
+import org.bukkit.Bukkit;
+import org.bukkit.configuration.file.YamlConfiguration;
+import org.bukkit.plugin.ServicePriority;
+import org.bukkit.plugin.java.JavaPlugin;
+import org.json.simple.JSONArray;
+import org.json.simple.JSONObject;
+
+import javax.net.ssl.HttpsURLConnection;
+import java.io.ByteArrayOutputStream;
+import java.io.DataOutputStream;
+import java.io.File;
+import java.io.IOException;
+import java.lang.reflect.InvocationTargetException;
+import java.net.URL;
+import java.util.Timer;
+import java.util.TimerTask;
+import java.util.UUID;
+import java.util.logging.Level;
+import java.util.zip.GZIPOutputStream;
+
+/**
+ * bStats collects some data for plugin authors.
+ *
+ * Check out https://bStats.org/ to learn more about bStats!
+ */
+public class Metrics {
+
+	static {
+		// Maven's Relocate is clever and changes strings, too. So we have to use this little "trick" ... :D
+		final String defaultPackage = new String(new byte[] { 'o', 'r', 'g', '.', 'b', 's', 't', 'a', 't', 's' });
+		final String examplePackage = new String(new byte[] { 'y', 'o', 'u', 'r', '.', 'p', 'a', 'c', 'k', 'a', 'g', 'e' });
+		// We want to make sure nobody just copy & pastes the example and use the wrong package names
+		if (Metrics.class.getPackage().getName().equals(defaultPackage) || Metrics.class.getPackage().getName().equals(examplePackage)) {
+			throw new IllegalStateException("bStats Metrics class has not been relocated correctly!");
+		}
+	}
+
+	// The version of this bStats class
+	public static final int B_STATS_VERSION = 1;
+
+	// The url to which the data is sent
+	private static final String URL = "https://bStats.org/submitData/bukkit";
+
+	// Should failed requests be logged?
+	private static boolean logFailedRequests;
+
+	// The uuid of the server
+	private static String serverUUID;
+
+	// The plugin
+	private final JavaPlugin plugin;
+
+	/**
+	 * Class constructor.
+	 *
+	 * @param plugin The plugin which stats should be submitted.
+	 */
+	public Metrics(JavaPlugin plugin) {
+		if (plugin == null) {
+			throw new IllegalArgumentException("Plugin cannot be null!");
+		}
+		this.plugin = plugin;
+
+		// Get the config file
+		File bStatsFolder = new File(plugin.getDataFolder().getParentFile(), "bStats");
+		File configFile = new File(bStatsFolder, "config.yml");
+		YamlConfiguration config = YamlConfiguration.loadConfiguration(configFile);
+
+		// Check if the config file exists
+		if (!config.isSet("serverUuid")) {
+
+			// Add default values
+			config.addDefault("enabled", true);
+			// Every server gets it's unique random id.
+			config.addDefault("serverUuid", UUID.randomUUID().toString());
+			// Should failed request be logged?
+			config.addDefault("logFailedRequests", false);
+
+			// Inform the server owners about bStats
+			config.options().header(
+					"bStats collects some data for plugin authors like how many servers are using their plugins.\n" +
+							"To honor their work, you should not disable it.\n" +
+							"This has nearly no effect on the server performance!\n" +
+							"Check out https://bStats.org/ to learn more :)"
+			).copyDefaults(true);
+			try {
+				config.save(configFile);
+			} catch (IOException ignored) { }
+		}
+
+		// Load the data
+		serverUUID = config.getString("serverUuid");
+		logFailedRequests = config.getBoolean("logFailedRequests", false);
+		if (config.getBoolean("enabled", true)) {
+			boolean found = false;
+			// Search for all other bStats Metrics classes to see if we are the first one
+			for (Class<?> service : Bukkit.getServicesManager().getKnownServices()) {
+				try {
+					service.getField("B_STATS_VERSION"); // Our identifier :)
+					found = true; // We aren't the first
+					break;
+				} catch (NoSuchFieldException ignored) { }
+			}
+			// Register our service
+			Bukkit.getServicesManager().register(Metrics.class, this, plugin, ServicePriority.Normal);
+			if (!found) {
+				// We are the first!
+				startSubmitting();
+			}
+		}
+	}
+
+	/**
+	 * Starts the Scheduler which submits our data every 30 minutes.
+	 */
+	private void startSubmitting() {
+		final Timer timer = new Timer(true); // We use a timer cause the Bukkit scheduler is affected by server lags
+		timer.scheduleAtFixedRate(new TimerTask() {
+			@Override
+			public void run() {
+				if (!plugin.isEnabled()) { // Plugin was disabled
+					timer.cancel();
+					return;
+				}
+				// Nevertheless we want our code to run in the Bukkit main thread, so we have to use the Bukkit scheduler
+				// Don't be afraid! The connection to the bStats server is still async, only the stats collection is sync ;)
+				Bukkit.getScheduler().runTask(plugin, new Runnable() {
+					@Override
+					public void run() {
+						submitData();
+					}
+				});
+			}
+		}, 1000*60*5, 1000*60*30);
+		// Submit the data every 30 minutes, first time after 5 minutes to give other plugins enough time to start
+		// WARNING: Changing the frequency has no effect but your plugin WILL be blocked/deleted!
+		// WARNING: Just don't do it!
+	}
+
+	/**
+	 * Gets the plugin specific data.
+	 * This method is called using Reflection.
+	 *
+	 * @return The plugin specific data.
+	 */
+	public JSONObject getPluginData() {
+		JSONObject data = new JSONObject();
+
+		String pluginName = plugin.getDescription().getName();
+		String pluginVersion = plugin.getDescription().getVersion();
+
+		data.put("pluginName", pluginName); // Append the name of the plugin
+		data.put("pluginVersion", pluginVersion); // Append the version of the plugin
+		JSONArray customCharts = new JSONArray();
+		data.put("customCharts", customCharts);
+
+		return data;
+	}
+
+	/**
+	 * Gets the server specific data.
+	 *
+	 * @return The server specific data.
+	 */
+	private JSONObject getServerData() {
+		// Minecraft specific data
+		int playerAmount = Bukkit.getOnlinePlayers().size();
+		int onlineMode = Bukkit.getOnlineMode() ? 1 : 0;
+		String bukkitVersion = Bukkit.getVersion();
+		bukkitVersion = bukkitVersion.substring(bukkitVersion.indexOf("MC: ") + 4, bukkitVersion.length() - 1);
+
+		// OS/Java specific data
+		String javaVersion = System.getProperty("java.version");
+		String osName = System.getProperty("os.name");
+		String osArch = System.getProperty("os.arch");
+		String osVersion = System.getProperty("os.version");
+		int coreCount = Runtime.getRuntime().availableProcessors();
+
+		JSONObject data = new JSONObject();
+
+		data.put("serverUUID", serverUUID);
+
+		data.put("playerAmount", playerAmount);
+		data.put("onlineMode", onlineMode);
+		data.put("bukkitVersion", bukkitVersion);
+
+		data.put("javaVersion", javaVersion);
+		data.put("osName", osName);
+		data.put("osArch", osArch);
+		data.put("osVersion", osVersion);
+		data.put("coreCount", coreCount);
+
+		return data;
+	}
+
+	/**
+	 * Collects the data and sends it afterwards.
+	 */
+	private void submitData() {
+		final JSONObject data = getServerData();
+
+		JSONArray pluginData = new JSONArray();
+		// Search for all other bStats Metrics classes to get their plugin data
+		for (Class<?> service : Bukkit.getServicesManager().getKnownServices()) {
+			try {
+				service.getField("B_STATS_VERSION"); // Our identifier :)
+			} catch (NoSuchFieldException ignored) {
+				continue; // Continue "searching"
+			}
+			// Found one!
+			try {
+				pluginData.add(service.getMethod("getPluginData").invoke(Bukkit.getServicesManager().load(service)));
+			} catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException ignored) { }
+		}
+
+		data.put("plugins", pluginData);
+
+		// Create a new thread for the connection to the bStats server
+		new Thread(new Runnable() {
+			@Override
+			public void run() {
+				try {
+					// Send the data
+					sendData(data);
+				} catch (Exception e) {
+					// Something went wrong! :(
+					if (logFailedRequests) {
+						plugin.getLogger().log(Level.WARNING, "Could not submit plugin stats of " + plugin.getName(), e);
+					}
+				}
+			}
+		}).start();
+	}
+
+	/**
+	 * Sends the data to the bStats server.
+	 *
+	 * @param data The data to send.
+	 * @throws Exception If the request failed.
+	 */
+	private static void sendData(JSONObject data) throws Exception {
+		if (data == null) {
+			throw new IllegalArgumentException("Data cannot be null!");
+		}
+		if (Bukkit.isPrimaryThread()) {
+			throw new IllegalAccessException("This method must not be called from the main thread!");
+		}
+		HttpsURLConnection connection = (HttpsURLConnection) new URL(URL).openConnection();
+
+		// Compress the data to save bandwidth
+		byte[] compressedData = compress(data.toString());
+
+		// Add headers
+		connection.setRequestMethod("POST");
+		connection.addRequestProperty("Accept", "application/json");
+		connection.addRequestProperty("Connection", "close");
+		connection.addRequestProperty("Content-Encoding", "gzip"); // We gzip our request
+		connection.addRequestProperty("Content-Length", String.valueOf(compressedData.length));
+		connection.setRequestProperty("Content-Type", "application/json"); // We send our data in JSON format
+		connection.setRequestProperty("User-Agent", "MC-Server/" + B_STATS_VERSION);
+
+		// Send data
+		connection.setDoOutput(true);
+		DataOutputStream outputStream = new DataOutputStream(connection.getOutputStream());
+		outputStream.write(compressedData);
+		outputStream.flush();
+		outputStream.close();
+
+		connection.getInputStream().close(); // We don't care about the response - Just send our data :)
+	}
+
+	/**
+	 * Gzips the given String.
+	 *
+	 * @param str The string to gzip.
+	 * @return The gzipped String.
+	 * @throws IOException If the compression failed.
+	 */
+	private static byte[] compress(final String str) throws IOException {
+		if (str == null) {
+			return null;
+		}
+		ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
+		GZIPOutputStream gzip = new GZIPOutputStream(outputStream);
+		gzip.write(str.getBytes("UTF-8"));
+		gzip.close();
+		return outputStream.toByteArray();
+	}
+
+}