@ -1,40 +1,5 @@
/ *
* 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 .
* /
package org.dynmap.worldguard ;
import org.bukkit.Bukkit ;
import org.bukkit.configuration.InvalidConfigurationException ;
import org.bukkit.configuration.file.YamlConfiguration ;
import org.bukkit.plugin.Plugin ;
import org.bukkit.plugin.PluginDescriptionFile ;
import org.bukkit.scheduler.BukkitTask ;
import java.io.BufferedReader ;
import java.io.File ;
import java.io.IOException ;
@ -45,314 +10,213 @@ import java.net.Proxy;
import java.net.URL ;
import java.net.URLConnection ;
import java.net.URLEncoder ;
import java.util.Collection ;
import java.util.UUID ;
import java.util.logging.Level ;
import java.util.logging.Logger ;
import org.bukkit.Bukkit ;
import org.bukkit.Server ;
import org.bukkit.configuration.InvalidConfigurationException ;
import org.bukkit.configuration.file.YamlConfiguration ;
import org.bukkit.configuration.file.YamlConfigurationOptions ;
import org.bukkit.plugin.Plugin ;
import org.bukkit.plugin.PluginDescriptionFile ;
import org.bukkit.scheduler.BukkitScheduler ;
import org.bukkit.scheduler.BukkitTask ;
public class MetricsLite {
/ * *
* The current revision number
* /
private final static int REVISION = 5 ;
/ * *
* The base url of the metrics domain
* /
private static final String BASE_URL = "http://mcstats.org" ;
/ * *
* The url used to report a server ' s status
* /
private static final String REPORT_URL = "/report/%s" ;
/ * *
* Interval of time to ping ( in minutes )
* /
private final static int PING_INTERVAL = 10 ;
/ * *
* The plugin this metrics submits for
* /
private final Plugin plugin ;
/ * *
* The plugin configuration file
* /
private final YamlConfiguration configuration ;
/ * *
* The plugin configuration file
* /
private final File configurationFile ;
/ * *
* Unique server id
* /
private final String guid ;
/ * *
* Lock for synchronization
* /
private final Object optOutLock = new Object ( ) ;
/ * *
* Id of the scheduled task
* /
private volatile BukkitTask taskId = null ;
public MetricsLite ( Plugin plugin ) throws IOException {
if ( plugin = = null ) {
throw new IllegalArgumentException ( "Plugin cannot be null" ) ;
}
this . plugin = plugin ;
// load the config
configurationFile = getConfigFile ( ) ;
configuration = YamlConfiguration . loadConfiguration ( configurationFile ) ;
// 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://mcstats.org" ) . copyDefaults ( true ) ;
configuration . save ( configurationFile ) ;
}
// Load the guid then
guid = configuration . getString ( "guid" ) ;
public class MetricsLite
{
private static final int REVISION = 5 ;
private static final String BASE_URL = "http://mcstats.org" ;
private static final String REPORT_URL = "/report/%s" ;
private static final int PING_INTERVAL = 10 ;
private final Plugin plugin ;
private final YamlConfiguration configuration ;
private final File configurationFile ;
private final String guid ;
private final Object optOutLock = new Object ( ) ;
private volatile BukkitTask taskId = null ;
public MetricsLite ( Plugin plugin )
throws IOException
{
if ( plugin = = null ) {
throw new IllegalArgumentException ( "Plugin cannot be null" ) ;
}
/ * *
* 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 .
*
* @return True if statistics measuring is running , otherwise false .
* /
public boolean start ( ) {
synchronized ( optOutLock ) {
// Did we opt out?
if ( isOptOut ( ) ) {
return false ;
}
// Is metrics already running?
if ( taskId ! = null ) {
return true ;
}
// Begin hitting the server with glorious data
taskId = plugin . getServer ( ) . getScheduler ( ) . runTaskTimerAsynchronously ( 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 ! = null ) ) {
taskId . cancel ( ) ;
taskId = null ;
}
}
// 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 ;
}
this . plugin = plugin ;
this . configurationFile = getConfigFile ( ) ;
this . configuration = YamlConfiguration . loadConfiguration ( this . configurationFile ) ;
this . configuration . addDefault ( "opt-out" , Boolean . valueOf ( false ) ) ;
this . configuration . addDefault ( "guid" , UUID . randomUUID ( ) . toString ( ) ) ;
if ( this . configuration . get ( "guid" , null ) = = null )
{
this . configuration . options ( ) . header ( "http://mcstats.org" ) . copyDefaults ( true ) ;
this . configuration . save ( this . configurationFile ) ;
}
/ * *
* Has the server owner denied plugin metrics ?
*
* @return true if metrics should be opted out of it
* /
public boolean isOptOut ( ) {
synchronized ( optOutLock ) {
try {
// Reload the metrics file
configuration . load ( getConfigFile ( ) ) ;
} 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 ;
this . guid = this . configuration . getString ( "guid" ) ;
}
public boolean start ( )
{
synchronized ( this . optOutLock )
{
if ( isOptOut ( ) ) {
return false ;
}
if ( this . taskId ! = null ) {
return true ;
}
this . taskId = this . plugin . getServer ( ) . getScheduler ( ) . runTaskTimerAsynchronously ( this . plugin , new Runnable ( )
{
private boolean firstPost = true ;
public void run ( )
{
try
{
synchronized ( MetricsLite . this . optOutLock )
{
if ( ( MetricsLite . this . isOptOut ( ) ) & & ( MetricsLite . this . taskId ! = null ) )
{
MetricsLite . this . taskId . cancel ( ) ;
MetricsLite . this . taskId = null ;
}
}
return configuration . getBoolean ( "opt-out" , false ) ;
MetricsLite . this . postPlugin ( ! this . firstPost ) ;
this . firstPost = false ;
}
catch ( IOException localIOException ) { }
}
} , 0L , 12000L ) ;
return true ;
}
/ * *
* 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 = = null ) {
start ( ) ;
}
}
}
public boolean isOptOut ( )
{
synchronized ( this . optOutLock )
{
try
{
this . configuration . load ( getConfigFile ( ) ) ;
}
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 this . configuration . getBoolean ( "opt-out" , false ) ;
}
/ * *
* 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 ! = null ) {
taskId . cancel ( ) ;
taskId = null ;
}
}
}
public void enable ( )
throws IOException
{
synchronized ( this . optOutLock )
{
if ( isOptOut ( ) )
{
this . configuration . set ( "opt-out" , Boolean . valueOf ( false ) ) ;
this . configuration . save ( this . configurationFile ) ;
}
if ( this . taskId = = null ) {
start ( ) ;
}
}
/ * *
* Gets the File object of the config file that should be used to store data such as the GUID and opt - out status
*
* @return the File object for the config file
* /
public File getConfigFile ( ) {
// I believe the easiest way to get the base folder (e.g craftbukkit set via -P) for plugins to use
// is to abuse the plugin object we already have
// plugin.getDataFolder() => base/plugins/PluginA/
// pluginsFolder => base/plugins/
// The base is not necessarily relative to the startup directory.
File pluginsFolder = plugin . getDataFolder ( ) . getParentFile ( ) ;
// return => base/plugins/PluginMetrics/config.yml
return new File ( new File ( pluginsFolder , "PluginMetrics" ) , "config.yml" ) ;
}
public void disable ( )
throws IOException
{
synchronized ( this . optOutLock )
{
if ( ! isOptOut ( ) )
{
this . configuration . set ( "opt-out" , Boolean . valueOf ( true ) ) ;
this . configuration . save ( this . configurationFile ) ;
}
if ( this . taskId ! = null )
{
this . taskId . cancel ( ) ;
this . taskId = null ;
}
}
/ * *
* 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 ( ) ;
// Construct the post data
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 ( ) . size ( ) ) ) ;
encodeDataPair ( data , "revision" , String . valueOf ( REVISION ) ) ;
// If we're pinging, append it
if ( isPing ) {
encodeDataPair ( data , "ping" , "true" ) ;
}
// Create the url
URL url = new URL ( BASE_URL + String . format ( REPORT_URL , encode ( plugin . getDescription ( ) . 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
final OutputStreamWriter writer = new OutputStreamWriter ( connection . getOutputStream ( ) ) ;
writer . write ( data . toString ( ) ) ;
writer . flush ( ) ;
// Now read the response
final BufferedReader reader = new BufferedReader ( new InputStreamReader ( connection . getInputStream ( ) ) ) ;
final String response = reader . readLine ( ) ;
// close resources
writer . close ( ) ;
reader . close ( ) ;
if ( response = = null | | response . startsWith ( "ERR" ) ) {
throw new IOException ( response ) ; //Throw the exception
}
//if (response.startsWith("OK")) - We should get "OK" followed by an optional description if everything goes right
}
public File getConfigFile ( )
{
File pluginsFolder = this . plugin . getDataFolder ( ) . getParentFile ( ) ;
return new File ( new File ( pluginsFolder , "PluginMetrics" ) , "config.yml" ) ;
}
private void postPlugin ( boolean isPing )
throws IOException
{
PluginDescriptionFile description = this . plugin . getDescription ( ) ;
StringBuilder data = new StringBuilder ( ) ;
data . append ( encode ( "guid" ) ) . append ( '=' ) . append ( encode ( this . guid ) ) ;
encodeDataPair ( data , "version" , description . getVersion ( ) ) ;
encodeDataPair ( data , "server" , Bukkit . getVersion ( ) ) ;
encodeDataPair ( data , "players" , Integer . toString ( Bukkit . getServer ( ) . getOnlinePlayers ( ) . size ( ) ) ) ;
encodeDataPair ( data , "revision" , String . valueOf ( 5 ) ) ;
if ( isPing ) {
encodeDataPair ( data , "ping" , "true" ) ;
}
/ * *
* Check if mineshafter is present . If it is , we need to bypass it to send POST requests
*
* @return true if mineshafter is installed on the server
* /
private boolean isMineshafterPresent ( ) {
try {
Class . forName ( "mineshafter.MineServer" ) ;
return true ;
} catch ( Exception e ) {
return false ;
}
URL url = new URL ( "http://mcstats.org" + String . format ( "/report/%s" , new Object [ ] { encode ( this . plugin . getDescription ( ) . getName ( ) ) } ) ) ;
URLConnection connection ;
URLConnection connection1 ;
if ( isMineshafterPresent ( ) ) {
connection1 = url . openConnection ( Proxy . NO_PROXY ) ;
} else {
connection1 = url . openConnection ( ) ;
}
/ * *
* < 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 the stringbuilder to append the data pair onto
* @param key the key value
* @param value the 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 ) ) ;
connection1 . setDoOutput ( true ) ;
OutputStreamWriter writer = new OutputStreamWriter ( connection1 . getOutputStream ( ) ) ;
writer . write ( data . toString ( ) ) ;
writer . flush ( ) ;
BufferedReader reader = new BufferedReader ( new InputStreamReader ( connection1 . getInputStream ( ) ) ) ;
String response = reader . readLine ( ) ;
writer . close ( ) ;
reader . close ( ) ;
if ( ( response = = null ) | | ( response . startsWith ( "ERR" ) ) ) {
throw new IOException ( response ) ;
}
/ * *
* Encode text as UTF - 8
*
* @param text the text to encode
* @return the encoded text , as UTF - 8
* /
private static String encode ( final String text ) throws UnsupportedEncodingException {
return URLEncoder . encode ( text , "UTF-8" ) ;
}
private boolean isMineshafterPresent ( )
{
try
{
Class . forName ( "mineshafter.MineServer" ) ;
return true ;
}
}
catch ( Exception e ) { }
return false ;
}
private static void encodeDataPair ( StringBuilder buffer , String key , String value )
throws UnsupportedEncodingException
{
buffer . append ( '&' ) . append ( encode ( key ) ) . append ( '=' ) . append ( encode ( value ) ) ;
}
private static String encode ( String text )
throws UnsupportedEncodingException
{
return URLEncoder . encode ( text , "UTF-8" ) ;
}
}
Davous3k
Davo8888
Mike Primm
mikeprimm
Wizjany
JEFF