19 Commits
Author SHA1 Message Date
oskar3123 9abaf55532 change version number in bungee yml, remove useless unit tests 2018-07-30 13:30:17 +02:00
oskar3123 1136b7e33f forgot to change version in plugin yml 2018-07-30 13:17:29 +02:00
oskar3123 361d302b36 merge 2018-07-30 13:07:01 +02:00
oskar3123 d6551b317f change pom to spigot 1.13 2018-07-30 13:03:08 +02:00
oskar3123andGitHub 5105e76dc5 Add coverage shield to readme 2018-05-16 14:07:27 +02:00
oskar3123 82cfcb4862 add more tests 2018-05-15 01:52:05 +02:00
oskar3123 671bb0d8b2 add sourceencoding to pom 2018-05-15 01:27:11 +02:00
oskar3123 79fb7e84a5 add jacoco test to travis yml 2018-05-15 01:22:19 +02:00
oskar3123 bba628e3f2 add JaCoCo maven plugin 2018-05-15 01:21:13 +02:00
oskar3123 b0951d7427 add sanitize junit test to test coveralls 2018-05-15 01:11:15 +02:00
oskar3123 0e7a6e58e2 test coveralls 2 2018-05-15 00:57:54 +02:00
oskar3123 5850ff2009 test coveralls 2018-05-15 00:53:29 +02:00
oskar3123andGitHub f98a038e38 Change documentation a bit 2018-05-01 04:06:17 +02:00
oskar3123andGitHub e927ca5f3c Add event documentation to the README 2018-05-01 04:05:27 +02:00
oskar3123 abf6f75287 escape backslashes and dollarsigns correctly, fixed #3 and add event to cancel or change the format programmatically 2018-05-01 03:44:50 +02:00
oskar3123andGitHub 76bb40823a Update README.md 2018-01-29 21:32:09 +01:00
oskar3123andGitHub fbf5ca83d6 Update README.md 2018-01-29 21:31:10 +01:00
oskar3123andGitHub 19bacde4fd Update README.md 2018-01-29 21:22:32 +01:00
oskar3123andGitHub dfbac24d3b Update _config.yml 2018-01-04 15:44:24 +01:00
17 changed files with 616 additions and 307 deletions
+1
View File
@@ -0,0 +1 @@
repo_token: $COVERALLS_REPO_TOKEN
+4
View File
@@ -0,0 +1,4 @@
.idea/
out/
target/
StaffChat.iml
+2
View File
@@ -9,3 +9,5 @@ deploy:
skip_cleanup: true skip_cleanup: true
on: on:
tags: true tags: true
after_success:
- mvn clean test jacoco:report coveralls:report
+56 -1
View File
@@ -1,7 +1,62 @@
[![Travis-CI](https://img.shields.io/travis/oskar3123/StaffChat.svg?style=flat)](https://travis-ci.org/oskar3123/StaffChat)
[![All Release](https://img.shields.io/github/downloads/oskar3123/StaffChat/total.svg?style=flat)](https://github.com/oskar3123/StaffChat/releases/latest)
[![Latest Release](https://img.shields.io/github/release/oskar3123/StaffChat.svg?style=flat)](https://github.com/oskar3123/StaffChat/releases/latest)
[![Github commits (since latest release)](https://img.shields.io/github/commits-since/oskar3123/StaffChat/latest.svg?style=flat)](https://github.com/oskar3123/StaffChat/commits/master)
[![Coverage Status](https://coveralls.io/repos/github/oskar3123/StaffChat/badge.svg?branch=master)](https://coveralls.io/github/oskar3123/StaffChat?branch=master)
# [StaffChat](https://oskar3123.github.io/StaffChat) # [StaffChat](https://oskar3123.github.io/StaffChat)
![Build status](https://api.travis-ci.org/oskar3123/StaffChat.svg?branch=master "Build status")
Simple and highly configurable staffchat Simple and highly configurable staffchat
## Download ## Download
You can download the plugin from the [Spigot resource page](https://www.spigotmc.org/resources/37804/) or via the [GitHub releases](https://github.com/oskar3123/StaffChat/releases) You can download the plugin from the [Spigot resource page](https://www.spigotmc.org/resources/37804/) or via the [GitHub releases](https://github.com/oskar3123/StaffChat/releases)
## Event API (For developers)
### Bukkit/Spigot
```java
public class StaffChatListener implements Listener
{
@EventHandler
public void onStaffChat(StaffChatEvent event)
{
// String format = event.getFormat();
// event.setFormat("&b{NAME} >> {MESSAGE}");
// String message = event.getMessage();
// Player player = event.getPlayer();
// event.setCancelled(true);
}
}
```
Register the listener with
```java
getServer().getPluginManager().registerEvents(new StaffChatListener(), this);
```
in your plugin onEnable.
### BungeeCord
```java
public class StaffChatListener implements Listener
{
@EventHandler
public void onStaffChat(BungeeStaffChatEvent event)
{
// String format = event.getFormat();
// event.setFormat("&b{NAME} >> {MESSAGE}");
// String message = event.getMessage();
// Player player = event.getPlayer();
// event.setCancelled(true);
}
}
```
Register the listener with
```java
getProxy().getPluginManager().registerListener(this, new StaffChatListener());
```
in your plugin onEnable.
+1 -1
View File
@@ -1,2 +1,2 @@
theme: jekyll-theme-cayman theme: jekyll-theme-cayman
show_downloads: true show_downloads: false
+8 -4
View File
@@ -7,7 +7,11 @@
<groupId>me.oskar3123</groupId> <groupId>me.oskar3123</groupId>
<artifactId>staffchat</artifactId> <artifactId>staffchat</artifactId>
<version>1.1.2-SNAPSHOT</version> <version>1.1.5-SNAPSHOT</version>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<repositories> <repositories>
<repository> <repository>
@@ -24,17 +28,17 @@
<dependency> <dependency>
<groupId>org.spigotmc</groupId> <groupId>org.spigotmc</groupId>
<artifactId>spigot-api</artifactId> <artifactId>spigot-api</artifactId>
<version>1.11.2-R0.1-SNAPSHOT</version> <version>1.13-R0.1-SNAPSHOT</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>org.bukkit</groupId> <groupId>org.bukkit</groupId>
<artifactId>bukkit</artifactId> <artifactId>bukkit</artifactId>
<version>1.11.2-R0.1-SNAPSHOT</version> <version>1.13-R0.1-SNAPSHOT</version>
</dependency> </dependency>
<dependency> <dependency>
<groupId>net.md-5</groupId> <groupId>net.md-5</groupId>
<artifactId>bungeecord-api</artifactId> <artifactId>bungeecord-api</artifactId>
<version>1.11-SNAPSHOT</version> <version>1.13-SNAPSHOT</version>
</dependency> </dependency>
</dependencies> </dependencies>
@@ -1,7 +1,7 @@
package me.oskar3123.staffchat.bungee; package me.oskar3123.staffchat.bungee;
import me.oskar3123.staffchat.bungee.command.BungeeStaffChatCommand; import me.oskar3123.staffchat.bungee.command.BungeeStaffChatCommand;
import me.oskar3123.staffchat.bungee.event.BungeeChatListener; import me.oskar3123.staffchat.bungee.listener.BungeeChatListener;
import net.md_5.bungee.api.plugin.Plugin; import net.md_5.bungee.api.plugin.Plugin;
import net.md_5.bungee.config.Configuration; import net.md_5.bungee.config.Configuration;
import net.md_5.bungee.config.ConfigurationProvider; import net.md_5.bungee.config.ConfigurationProvider;
@@ -9,96 +9,96 @@ import net.md_5.bungee.config.ConfigurationProvider;
import net.md_5.bungee.config.YamlConfiguration; import net.md_5.bungee.config.YamlConfiguration;
import javax.net.ssl.HttpsURLConnection; import javax.net.ssl.HttpsURLConnection;
import java.io.BufferedReader; import java.io.*;
import java.io.BufferedWriter;
import java.io.ByteArrayOutputStream;
import java.io.DataOutputStream;
import java.io.File;
import java.io.FileReader;
import java.io.FileWriter;
import java.io.IOException;
import java.lang.reflect.InvocationTargetException; import java.lang.reflect.InvocationTargetException;
import java.net.URL; import java.net.URL;
import java.nio.file.Path; import java.nio.file.Path;
import java.util.ArrayList; import java.util.*;
import java.util.List;
import java.util.Timer;
import java.util.TimerTask;
import java.util.UUID;
import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeUnit;
import java.util.logging.Level; import java.util.logging.Level;
import java.util.zip.GZIPOutputStream; import java.util.zip.GZIPOutputStream;
/** /**
* bStats collects some data for plugin authors. * bStats collects some data for plugin authors.
* * <p>
* Check out https://bStats.org/ to learn more about bStats! * Check out https://bStats.org/ to learn more about bStats!
*/ */
@SuppressWarnings("all") @SuppressWarnings("all")
public class MetricsLite { public class MetricsLite
{
static { // 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/bungeecord";
// A list with all known metrics class objects including this one
private static final List<Object> knownMetricsInstances = new ArrayList<>();
static
{
// Maven's Relocate is clever and changes strings, too. So we have to use this little "trick" ... :D // 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 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' }); 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 // We want to make sure nobody just copy & pastes the example and use the wrong package names
if (MetricsLite.class.getPackage().getName().equals(defaultPackage) || MetricsLite.class.getPackage().getName().equals(examplePackage)) { if (MetricsLite.class.getPackage().getName().equals(defaultPackage) || MetricsLite.class.getPackage().getName().equals(examplePackage))
{
throw new IllegalStateException("bStats Metrics class has not been relocated correctly!"); 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/bungeecord";
// The plugin // The plugin
private final Plugin plugin; private final Plugin plugin;
// Is bStats enabled on this server? // Is bStats enabled on this server?
private boolean enabled; private boolean enabled;
// The uuid of the server // The uuid of the server
private String serverUUID; private String serverUUID;
// Should failed requests be logged? // Should failed requests be logged?
private boolean logFailedRequests = false; private boolean logFailedRequests = false;
// A list with all known metrics class objects including this one public MetricsLite(Plugin plugin)
private static final List<Object> knownMetricsInstances = new ArrayList<>(); {
public MetricsLite(Plugin plugin) {
this.plugin = plugin; this.plugin = plugin;
try { try
{
loadConfig(); loadConfig();
} catch (IOException e) { }
catch (IOException e)
{
// Failed to load configuration // Failed to load configuration
plugin.getLogger().log(Level.WARNING, "Failed to load bStats config!", e); plugin.getLogger().log(Level.WARNING, "Failed to load bStats config!", e);
return; return;
} }
// We are not allowed to send data about this server :( // We are not allowed to send data about this server :(
if (!enabled) { if (!enabled)
{
return; return;
} }
Class<?> usedMetricsClass = getFirstBStatsClass(); Class<?> usedMetricsClass = getFirstBStatsClass();
if (usedMetricsClass == null) { if (usedMetricsClass == null)
{
// Failed to get first metrics class // Failed to get first metrics class
return; return;
} }
if (usedMetricsClass == getClass()) { if (usedMetricsClass == getClass())
{
// We are the first! :) // We are the first! :)
linkMetrics(this); linkMetrics(this);
startSubmitting(); startSubmitting();
} else { }
else
{
// We aren't the first so we link to the first metrics class // We aren't the first so we link to the first metrics class
try { try
usedMetricsClass.getMethod("linkMetrics", Object.class).invoke(null,this); {
} catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException e) { usedMetricsClass.getMethod("linkMetrics", Object.class).invoke(null, this);
if (logFailedRequests) { }
catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException e)
{
if (logFailedRequests)
{
plugin.getLogger().log(Level.WARNING, "Failed to link to first metrics class " + usedMetricsClass.getName() + "!", e); plugin.getLogger().log(Level.WARNING, "Failed to link to first metrics class " + usedMetricsClass.getName() + "!", e);
} }
} }
@@ -111,17 +111,76 @@ public class MetricsLite {
* *
* @param metrics An object of the metrics class to link. * @param metrics An object of the metrics class to link.
*/ */
public static void linkMetrics(Object metrics) { public static void linkMetrics(Object metrics)
{
knownMetricsInstances.add(metrics); knownMetricsInstances.add(metrics);
} }
/**
* 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");
}
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();
}
/** /**
* Gets the plugin specific data. * Gets the plugin specific data.
* This method is called using Reflection. * This method is called using Reflection.
* *
* @return The plugin specific data. * @return The plugin specific data.
*/ */
public JsonObject getPluginData() { public JsonObject getPluginData()
{
JsonObject data = new JsonObject(); JsonObject data = new JsonObject();
String pluginName = plugin.getDescription().getName(); String pluginName = plugin.getDescription().getName();
@@ -136,23 +195,28 @@ public class MetricsLite {
return data; return data;
} }
private void startSubmitting() { private void startSubmitting()
{
// We use a timer cause want to be independent from the server tps // We use a timer cause want to be independent from the server tps
final Timer timer = new Timer(true); final Timer timer = new Timer(true);
timer.scheduleAtFixedRate(new TimerTask() { timer.scheduleAtFixedRate(new TimerTask()
{
@Override @Override
public void run() { public void run()
{
// The data collection (e.g. for custom graphs) is done sync // The data collection (e.g. for custom graphs) is done sync
// Don't be afraid! The connection to the bStats server is still async, only the stats collection is sync ;) // Don't be afraid! The connection to the bStats server is still async, only the stats collection is sync ;)
TaskScheduler scheduler = plugin.getProxy().getScheduler(); TaskScheduler scheduler = plugin.getProxy().getScheduler();
scheduler.schedule(plugin, new Runnable() { scheduler.schedule(plugin, new Runnable()
{
@Override @Override
public void run() { public void run()
{
submitData(); submitData();
} }
}, 0L, TimeUnit.SECONDS); }, 0L, TimeUnit.SECONDS);
} }
}, 1000*60*2, 1000*60*30); }, 1000 * 60 * 2, 1000 * 60 * 30);
// Submit the data every 30 minutes, first time after 2 minutes to give other plugins enough time to start // Submit the data every 30 minutes, first time after 2 minutes to give other plugins enough time to start
// WARNING: Changing the frequency has no effect but your plugin WILL be blocked/deleted! // WARNING: Changing the frequency has no effect but your plugin WILL be blocked/deleted!
// WARNING: Just don't do it! // WARNING: Just don't do it!
@@ -163,7 +227,8 @@ public class MetricsLite {
* *
* @return The server specific data. * @return The server specific data.
*/ */
private JsonObject getServerData() { private JsonObject getServerData()
{
// Minecraft specific data // Minecraft specific data
int playerAmount = plugin.getProxy().getOnlineCount(); int playerAmount = plugin.getProxy().getOnlineCount();
playerAmount = playerAmount > 500 ? 500 : playerAmount; playerAmount = playerAmount > 500 ? 500 : playerAmount;
@@ -199,32 +264,45 @@ public class MetricsLite {
/** /**
* Collects the data and sends it afterwards. * Collects the data and sends it afterwards.
*/ */
private void submitData() { private void submitData()
{
final JsonObject data = getServerData(); final JsonObject data = getServerData();
final JsonArray pluginData = new JsonArray(); final JsonArray pluginData = new JsonArray();
// Search for all other bStats Metrics classes to get their plugin data // Search for all other bStats Metrics classes to get their plugin data
for (Object metrics : knownMetricsInstances) { for (Object metrics : knownMetricsInstances)
try { {
try
{
Object plugin = metrics.getClass().getMethod("getPluginData").invoke(metrics); Object plugin = metrics.getClass().getMethod("getPluginData").invoke(metrics);
if (plugin instanceof JsonObject) { if (plugin instanceof JsonObject)
{
pluginData.add((JsonObject) plugin); pluginData.add((JsonObject) plugin);
} }
} catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException ignored) { } }
catch (NoSuchMethodException | IllegalAccessException | InvocationTargetException ignored)
{
}
} }
data.add("plugins", pluginData); data.add("plugins", pluginData);
// Create a new thread for the connection to the bStats server // Create a new thread for the connection to the bStats server
new Thread(new Runnable() { new Thread(new Runnable()
{
@Override @Override
public void run() { public void run()
try { {
try
{
// Send the data // Send the data
sendData(data); sendData(data);
} catch (Exception e) { }
catch (Exception e)
{
// Something went wrong! :( // Something went wrong! :(
if (logFailedRequests) { if (logFailedRequests)
{
plugin.getLogger().log(Level.WARNING, "Could not submit plugin stats!", e); plugin.getLogger().log(Level.WARNING, "Could not submit plugin stats!", e);
} }
} }
@@ -237,11 +315,13 @@ public class MetricsLite {
* *
* @throws IOException If something did not work :( * @throws IOException If something did not work :(
*/ */
private void loadConfig() throws IOException { private void loadConfig() throws IOException
{
Path configPath = plugin.getDataFolder().toPath().getParent().resolve("bStats"); Path configPath = plugin.getDataFolder().toPath().getParent().resolve("bStats");
configPath.toFile().mkdirs(); configPath.toFile().mkdirs();
File configFile = new File(configPath.toFile(), "config.yml"); File configFile = new File(configPath.toFile(), "config.yml");
if (!configFile.exists()) { if (!configFile.exists())
{
writeFile(configFile, writeFile(configFile,
"#bStats collects some data for plugin authors like how many servers are using their plugins.", "#bStats collects some data for plugin authors like how many servers are using their plugins.",
"#To honor their work, you should not disable it.", "#To honor their work, you should not disable it.",
@@ -265,23 +345,33 @@ public class MetricsLite {
* *
* @return The first bStats metrics class. * @return The first bStats metrics class.
*/ */
private Class<?> getFirstBStatsClass() { private Class<?> getFirstBStatsClass()
{
Path configPath = plugin.getDataFolder().toPath().getParent().resolve("bStats"); Path configPath = plugin.getDataFolder().toPath().getParent().resolve("bStats");
configPath.toFile().mkdirs(); configPath.toFile().mkdirs();
File tempFile = new File(configPath.toFile(), "temp.txt"); File tempFile = new File(configPath.toFile(), "temp.txt");
try { try
{
String className = readFile(tempFile); String className = readFile(tempFile);
if (className != null) { if (className != null)
try { {
try
{
// Let's check if a class with the given name exists. // Let's check if a class with the given name exists.
return Class.forName(className); return Class.forName(className);
} catch (ClassNotFoundException ignored) { } }
catch (ClassNotFoundException ignored)
{
}
} }
writeFile(tempFile, getClass().getName()); writeFile(tempFile, getClass().getName());
return getClass(); return getClass();
} catch (IOException e) { }
if (logFailedRequests) { catch (IOException e)
{
if (logFailedRequests)
{
plugin.getLogger().log(Level.WARNING, "Failed to get first bStats class!", e); plugin.getLogger().log(Level.WARNING, "Failed to get first bStats class!", e);
} }
return null; return null;
@@ -295,14 +385,17 @@ public class MetricsLite {
* @return The first line of the file or <code>null</code> if the file does not exist or is empty. * @return The first line of the file or <code>null</code> if the file does not exist or is empty.
* @throws IOException If something did not work :( * @throws IOException If something did not work :(
*/ */
private String readFile(File file) throws IOException { private String readFile(File file) throws IOException
if (!file.exists()) { {
if (!file.exists())
{
return null; return null;
} }
try ( try (
FileReader fileReader = new FileReader(file); FileReader fileReader = new FileReader(file);
BufferedReader bufferedReader = new BufferedReader(fileReader); BufferedReader bufferedReader = new BufferedReader(fileReader);
) { )
{
return bufferedReader.readLine(); return bufferedReader.readLine();
} }
} }
@@ -314,72 +407,23 @@ public class MetricsLite {
* @param lines The lines to write. * @param lines The lines to write.
* @throws IOException If something did not work :( * @throws IOException If something did not work :(
*/ */
private void writeFile(File file, String... lines) throws IOException { private void writeFile(File file, String... lines) throws IOException
if (!file.exists()) { {
if (!file.exists())
{
file.createNewFile(); file.createNewFile();
} }
try ( try (
FileWriter fileWriter = new FileWriter(file); FileWriter fileWriter = new FileWriter(file);
BufferedWriter bufferedWriter = new BufferedWriter(fileWriter) BufferedWriter bufferedWriter = new BufferedWriter(fileWriter)
) { )
for (String line : lines) { {
for (String line : lines)
{
bufferedWriter.write(line); bufferedWriter.write(line);
bufferedWriter.newLine(); bufferedWriter.newLine();
} }
} }
} }
/**
* 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");
}
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();
}
} }
@@ -0,0 +1,54 @@
package me.oskar3123.staffchat.bungee.event;
import net.md_5.bungee.api.connection.ProxiedPlayer;
import net.md_5.bungee.api.plugin.Cancellable;
import net.md_5.bungee.api.plugin.Event;
public class BungeeStaffChatEvent extends Event implements Cancellable
{
private final String message;
private final ProxiedPlayer player;
private boolean cancelled = false;
private String format;
public BungeeStaffChatEvent(ProxiedPlayer player, String format, String message)
{
this.player = player;
this.format = format;
this.message = message;
}
public String getFormat()
{
return format;
}
public void setFormat(String format)
{
this.format = format;
}
public String getMessage()
{
return message;
}
public ProxiedPlayer getPlayer()
{
return player;
}
@Override
public boolean isCancelled()
{
return cancelled;
}
@Override
public void setCancelled(boolean cancelled)
{
this.cancelled = cancelled;
}
}
@@ -1,6 +1,8 @@
package me.oskar3123.staffchat.bungee.event; package me.oskar3123.staffchat.bungee.listener;
import me.oskar3123.staffchat.bungee.BungeeMain; import me.oskar3123.staffchat.bungee.BungeeMain;
import me.oskar3123.staffchat.bungee.event.BungeeStaffChatEvent;
import me.oskar3123.staffchat.util.StringUtils;
import net.md_5.bungee.api.ChatColor; import net.md_5.bungee.api.ChatColor;
import net.md_5.bungee.api.chat.BaseComponent; import net.md_5.bungee.api.chat.BaseComponent;
import net.md_5.bungee.api.chat.TextComponent; import net.md_5.bungee.api.chat.TextComponent;
@@ -42,13 +44,23 @@ public class BungeeChatListener implements Listener
} }
String format = config.getString("settings.format"); String format = config.getString("settings.format");
format = format.replaceAll("\\{NAME\\}", player.getName()); String message = event.getMessage().substring(character.length()).trim();
format = format.replaceAll("\\{MESSAGE\\}", event.getMessage().substring(character.length()).trim());
final BaseComponent[] message = txt(format); BungeeStaffChatEvent chatEvent = new BungeeStaffChatEvent(player, format, message);
plugin.getProxy().getPluginManager().callEvent(chatEvent);
if (chatEvent.isCancelled())
{
return;
}
format = chatEvent.getFormat();
format = format.replaceAll("\\{NAME\\}", StringUtils.sanitize(player.getName()));
format = format.replaceAll("\\{MESSAGE\\}", StringUtils.sanitize(message));
final BaseComponent[] messageComponents = txt(format);
plugin.getProxy().getPlayers().stream() plugin.getProxy().getPlayers().stream()
.filter(p -> p.hasPermission(plugin.seePerm)) .filter(p -> p.hasPermission(plugin.seePerm))
.forEach(p -> p.sendMessage(message)); .forEach(p -> p.sendMessage(messageComponents));
plugin.getLogger().info(ChatColor.stripColor(clr(format))); plugin.getLogger().info(ChatColor.stripColor(clr(format)));
event.setCancelled(true); event.setCancelled(true);
@@ -1,7 +1,7 @@
package me.oskar3123.staffchat.spigot; package me.oskar3123.staffchat.spigot;
import me.oskar3123.staffchat.spigot.command.StaffChatCommand; import me.oskar3123.staffchat.spigot.command.StaffChatCommand;
import me.oskar3123.staffchat.spigot.event.ChatListener; import me.oskar3123.staffchat.spigot.listener.ChatListener;
import org.bukkit.Bukkit; import org.bukkit.Bukkit;
import org.bukkit.plugin.java.JavaPlugin; import org.bukkit.plugin.java.JavaPlugin;
@@ -22,34 +22,34 @@ import java.util.zip.GZIPOutputStream;
/** /**
* bStats collects some data for plugin authors. * bStats collects some data for plugin authors.
* * <p>
* Check out https://bStats.org/ to learn more about bStats! * Check out https://bStats.org/ to learn more about bStats!
*/ */
@SuppressWarnings("all") @SuppressWarnings("all")
public class MetricsLite { public class MetricsLite
{
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 (MetricsLite.class.getPackage().getName().equals(defaultPackage) || MetricsLite.class.getPackage().getName().equals(examplePackage)) {
throw new IllegalStateException("bStats Metrics class has not been relocated correctly!");
}
}
// The version of this bStats class // The version of this bStats class
public static final int B_STATS_VERSION = 1; public static final int B_STATS_VERSION = 1;
// The url to which the data is sent // The url to which the data is sent
private static final String URL = "https://bStats.org/submitData/bukkit"; private static final String URL = "https://bStats.org/submitData/bukkit";
// Should failed requests be logged? // Should failed requests be logged?
private static boolean logFailedRequests; private static boolean logFailedRequests;
// The uuid of the server // The uuid of the server
private static String serverUUID; private static String serverUUID;
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 (MetricsLite.class.getPackage().getName().equals(defaultPackage) || MetricsLite.class.getPackage().getName().equals(examplePackage))
{
throw new IllegalStateException("bStats Metrics class has not been relocated correctly!");
}
}
// The plugin // The plugin
private final JavaPlugin plugin; private final JavaPlugin plugin;
@@ -58,8 +58,10 @@ public class MetricsLite {
* *
* @param plugin The plugin which stats should be submitted. * @param plugin The plugin which stats should be submitted.
*/ */
public MetricsLite(JavaPlugin plugin) { public MetricsLite(JavaPlugin plugin)
if (plugin == null) { {
if (plugin == null)
{
throw new IllegalArgumentException("Plugin cannot be null!"); throw new IllegalArgumentException("Plugin cannot be null!");
} }
this.plugin = plugin; this.plugin = plugin;
@@ -70,7 +72,8 @@ public class MetricsLite {
YamlConfiguration config = YamlConfiguration.loadConfiguration(configFile); YamlConfiguration config = YamlConfiguration.loadConfiguration(configFile);
// Check if the config file exists // Check if the config file exists
if (!config.isSet("serverUuid")) { if (!config.isSet("serverUuid"))
{
// Add default values // Add default values
config.addDefault("enabled", true); config.addDefault("enabled", true);
@@ -86,166 +89,58 @@ public class MetricsLite {
"This has nearly no effect on the server performance!\n" + "This has nearly no effect on the server performance!\n" +
"Check out https://bStats.org/ to learn more :)" "Check out https://bStats.org/ to learn more :)"
).copyDefaults(true); ).copyDefaults(true);
try { try
{
config.save(configFile); config.save(configFile);
} catch (IOException ignored) { } }
catch (IOException ignored)
{
}
} }
// Load the data // Load the data
serverUUID = config.getString("serverUuid"); serverUUID = config.getString("serverUuid");
logFailedRequests = config.getBoolean("logFailedRequests", false); logFailedRequests = config.getBoolean("logFailedRequests", false);
if (config.getBoolean("enabled", true)) { if (config.getBoolean("enabled", true))
{
boolean found = false; boolean found = false;
// Search for all other bStats Metrics classes to see if we are the first one // Search for all other bStats Metrics classes to see if we are the first one
for (Class<?> service : Bukkit.getServicesManager().getKnownServices()) { for (Class<?> service : Bukkit.getServicesManager().getKnownServices())
try { {
try
{
service.getField("B_STATS_VERSION"); // Our identifier :) service.getField("B_STATS_VERSION"); // Our identifier :)
found = true; // We aren't the first found = true; // We aren't the first
break; break;
} catch (NoSuchFieldException ignored) { } }
catch (NoSuchFieldException ignored)
{
}
} }
// Register our service // Register our service
Bukkit.getServicesManager().register(MetricsLite.class, this, plugin, ServicePriority.Normal); Bukkit.getServicesManager().register(MetricsLite.class, this, plugin, ServicePriority.Normal);
if (!found) { if (!found)
{
// We are the first! // We are the first!
startSubmitting(); 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. * Sends the data to the bStats server.
* *
* @param data The data to send. * @param data The data to send.
* @throws Exception If the request failed. * @throws Exception If the request failed.
*/ */
private static void sendData(JSONObject data) throws Exception { private static void sendData(JSONObject data) throws Exception
if (data == null) { {
if (data == null)
{
throw new IllegalArgumentException("Data cannot be null!"); throw new IllegalArgumentException("Data cannot be null!");
} }
if (Bukkit.isPrimaryThread()) { if (Bukkit.isPrimaryThread())
{
throw new IllegalAccessException("This method must not be called from the main thread!"); throw new IllegalAccessException("This method must not be called from the main thread!");
} }
HttpsURLConnection connection = (HttpsURLConnection) new URL(URL).openConnection(); HttpsURLConnection connection = (HttpsURLConnection) new URL(URL).openConnection();
@@ -279,8 +174,10 @@ public class MetricsLite {
* @return The gzipped String. * @return The gzipped String.
* @throws IOException If the compression failed. * @throws IOException If the compression failed.
*/ */
private static byte[] compress(final String str) throws IOException { private static byte[] compress(final String str) throws IOException
if (str == null) { {
if (str == null)
{
return null; return null;
} }
ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
@@ -290,4 +187,149 @@ public class MetricsLite {
return outputStream.toByteArray(); return outputStream.toByteArray();
} }
/**
* 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();
}
} }
@@ -0,0 +1,67 @@
package me.oskar3123.staffchat.spigot.event;
import org.bukkit.entity.Player;
import org.bukkit.event.Cancellable;
import org.bukkit.event.Event;
import org.bukkit.event.HandlerList;
public class StaffChatEvent extends Event implements Cancellable
{
private static HandlerList handlerList = new HandlerList();
private final Player player;
private final String message;
private boolean cancelled = false;
private String format;
public StaffChatEvent(Player player, String format, String message)
{
this.player = player;
this.format = format;
this.message = message;
}
public static HandlerList getHandlerList()
{
return handlerList;
}
public String getFormat()
{
return format;
}
public void setFormat(String format)
{
this.format = format;
}
public Player getPlayer()
{
return player;
}
public String getMessage()
{
return message;
}
@Override
public HandlerList getHandlers()
{
return handlerList;
}
@Override
public boolean isCancelled()
{
return cancelled;
}
@Override
public void setCancelled(boolean cancelled)
{
this.cancelled = cancelled;
}
}
@@ -1,11 +1,12 @@
package me.oskar3123.staffchat.spigot.event; package me.oskar3123.staffchat.spigot.listener;
import me.oskar3123.staffchat.spigot.Main; import me.oskar3123.staffchat.spigot.Main;
import me.oskar3123.staffchat.spigot.event.StaffChatEvent;
import me.oskar3123.staffchat.util.StringUtils;
import org.bukkit.Bukkit; import org.bukkit.Bukkit;
import org.bukkit.ChatColor; import org.bukkit.ChatColor;
import org.bukkit.configuration.file.FileConfiguration; import org.bukkit.configuration.file.FileConfiguration;
import org.bukkit.event.EventHandler; import org.bukkit.event.EventHandler;
import org.bukkit.event.EventPriority;
import org.bukkit.event.Listener; import org.bukkit.event.Listener;
import org.bukkit.event.player.AsyncPlayerChatEvent; import org.bukkit.event.player.AsyncPlayerChatEvent;
@@ -19,7 +20,7 @@ public class ChatListener implements Listener
this.plugin = plugin; this.plugin = plugin;
} }
@EventHandler(priority = EventPriority.HIGHEST, ignoreCancelled = true) @EventHandler
public void chat(AsyncPlayerChatEvent event) public void chat(AsyncPlayerChatEvent event)
{ {
if (!event.getPlayer().hasPermission(plugin.usePerm)) if (!event.getPlayer().hasPermission(plugin.usePerm))
@@ -35,15 +36,25 @@ public class ChatListener implements Listener
} }
String format = config.getString("settings.format"); String format = config.getString("settings.format");
format = format.replaceAll("\\{NAME\\}", event.getPlayer().getName()); String message = event.getMessage().substring(character.length()).trim();
format = format.replaceAll("\\{MESSAGE\\}", event.getMessage().substring(character.length()).trim());
StaffChatEvent chatEvent = new StaffChatEvent(event.getPlayer(), format, message);
Bukkit.getServer().getPluginManager().callEvent(chatEvent);
if (chatEvent.isCancelled())
{
return;
}
format = chatEvent.getFormat();
format = format.replaceAll("\\{NAME\\}", StringUtils.sanitize(event.getPlayer().getName()));
format = format.replaceAll("\\{MESSAGE\\}", StringUtils.sanitize(message));
format = ChatColor.translateAlternateColorCodes('&', format); format = ChatColor.translateAlternateColorCodes('&', format);
final String message = format; final String finalMessage = format;
Bukkit.getOnlinePlayers().stream() Bukkit.getOnlinePlayers().stream()
.filter(p -> p.hasPermission(plugin.seePerm)) .filter(p -> p.hasPermission(plugin.seePerm))
.forEach(p -> p.sendMessage(message)); .forEach(p -> p.sendMessage(finalMessage));
plugin.getLogger().info(ChatColor.stripColor(message)); plugin.getLogger().info(ChatColor.stripColor(finalMessage));
event.setCancelled(true); event.setCancelled(true);
} }
@@ -0,0 +1,13 @@
package me.oskar3123.staffchat.util;
public class StringUtils
{
public static String sanitize(String string)
{
string = string.replaceAll("\\\\", "\\\\\\\\");
string = string.replaceAll("\\$", "\\\\\\$");
return string;
}
}
+1 -1
View File
@@ -1,4 +1,4 @@
name: StaffChat name: StaffChat
authors: [oskar3123] authors: [oskar3123]
main: me.oskar3123.staffchat.bungee.BungeeMain main: me.oskar3123.staffchat.bungee.BungeeMain
version: 1.1.2 version: 1.1.5
+1 -1
View File
@@ -1,7 +1,7 @@
name: StaffChat name: StaffChat
authors: [oskar3123] authors: [oskar3123]
main: me.oskar3123.staffchat.spigot.Main main: me.oskar3123.staffchat.spigot.Main
version: 1.1.2 version: 1.1.5
commands: commands:
staffchat: staffchat: