Add BukkitUtils

Currently it contains NMS ping getter and plugin message wrapper
This commit is contained in:
Mark Vainomaa 2016-09-25 00:46:00 +03:00
parent 9656039ea3
commit 3c06b62c91
5 changed files with 222 additions and 0 deletions

45
BukkitUtils/pom.xml Normal file
View File

@ -0,0 +1,45 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>utils</artifactId>
<groupId>eu.mikroskeem</groupId>
<version>1.0-SNAPSHOT</version>
</parent>
<modelVersion>4.0.0</modelVersion>
<artifactId>bukkitutils</artifactId>
<repositories>
<repository>
<id>spigot-repo</id>
<url>https://hub.spigotmc.org/nexus/content/repositories/snapshots/</url>
</repository>
</repositories>
<dependencies>
<dependency>
<groupId>eu.mikroskeem</groupId>
<artifactId>reflect</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
<dependency>
<groupId>org.bukkit</groupId>
<artifactId>bukkit</artifactId>
<version>1.10.2-R0.1-SNAPSHOT</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.16.10</version>
<scope>provided</scope>
</dependency>
<dependency>
<groupId>org.jetbrains</groupId>
<artifactId>annotations-java5</artifactId>
<version>RELEASE</version>
</dependency>
</dependencies>
</project>

View File

@ -0,0 +1,40 @@
package eu.mikroskeem.utils.bukkit;
import org.bukkit.entity.Player;
import org.bukkit.plugin.Plugin;
import org.jetbrains.annotations.NotNull;
public class MessageUtils {
/**
* Get new PluginMessage instance to be used in try-resource block
*
* @param plugin Plugin that initates plugin message sending
* @param player Player to send message over
* @param channel Channel to send message to
* @return PluginMessage instance
*/
public static PluginMessage newPluginMessage(@NotNull Plugin plugin,
@NotNull Player player,
@NotNull String channel){
return new PluginMessage(plugin, player, channel);
}
/**
* Send plugin message
*
* @param plugin Plugin that initates plugin message sending
* @param player Player to send message over
* @param channel Channel to send message to
* @param contents Message contents
*/
public static void sendPluginMessage(@NotNull Plugin plugin,
@NotNull Player player,
@NotNull String channel,
@NotNull String[] contents){
try(PluginMessage message = newPluginMessage(plugin, player, channel)){
for (String content : contents) {
message.writeUTF(content);
}
}
}
}

View File

@ -0,0 +1,48 @@
package eu.mikroskeem.utils.bukkit;
import eu.mikroskeem.utils.reflect.Reflect;
import org.bukkit.Bukkit;
import org.bukkit.entity.Player;
import org.jetbrains.annotations.NotNull;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
public class PlayerUtils {
/**
* Return player ping (via NMS reflection)
*
* Note: I'm bit disappointed, that Bukkit API doesn't expose method to get player's ping
*
* @param player Player who ping to query
* @return Player's ping (-1 if reflection failed)
*/
public static int getNMSPing(@NotNull Player player){
int ping = -1;
String bukkitPackageName = Bukkit.getServer().getClass().getPackage().getName();
String nmsVer = bukkitPackageName.substring(bukkitPackageName.lastIndexOf(".") + 1);
Class<?> craftPlayerClass = Reflect.getClass(
String.format("org.bukkit.craftbukkit.%s.entity.CraftPlayer", nmsVer));
Class<?> craftEntityPlayerClass = Reflect.getClass(
String.format("net.minecraft.server.%s.EntityPlayer", nmsVer));
if(craftPlayerClass != null && craftEntityPlayerClass != null){
Method getHandle = Reflect.getMethod(craftPlayerClass, "getHandle");
if(getHandle != null){
Object handle = Reflect.invokeMethod(getHandle, player);
if(handle != null){
Field pingField = Reflect.getField(craftEntityPlayerClass, "ping");
if(pingField != null){
Integer nmsPing = (Integer)Reflect.readField(pingField, handle);
if(nmsPing != null){
return nmsPing;
}
}
}
}
}
return ping;
}
}

View File

@ -0,0 +1,88 @@
package eu.mikroskeem.utils.bukkit;
import com.google.common.io.ByteArrayDataOutput;
import com.google.common.io.ByteStreams;
import lombok.Getter;
import org.bukkit.entity.Player;
import org.bukkit.plugin.Plugin;
/**
* PluginMessage class
*
* Checks if plugin message channel is registered and sends message if try-resource block ends.
* You can use this like you would write normal plugin messages.
*/
public class PluginMessage implements AutoCloseable,ByteArrayDataOutput {
@Getter
private ByteArrayDataOutput pluginMessage = ByteStreams.newDataOutput();
private String channel;
private Player player;
private Plugin plugin;
private boolean wasChannelRegistered = false;
public PluginMessage(Plugin plugin, Player player, String channel){
this.channel = channel;
this.player = player;
this.plugin = plugin;
/* Check if channel is registered */
if(plugin.getServer().getMessenger().isOutgoingChannelRegistered(plugin, channel)){
wasChannelRegistered = true;
} else {
plugin.getServer().getMessenger().registerOutgoingPluginChannel(plugin, channel);
}
}
@Override public void write(int b) {
pluginMessage.write(b);
}
@Override public void write(byte[] b) {
pluginMessage.write(b);
}
@Override public void write(byte[] b, int off, int len) {
pluginMessage.write(b, off, len);
}
@Override public void writeBoolean(boolean v) {
pluginMessage.writeBoolean(v);
}
@Override public void writeByte(int v) {
pluginMessage.writeByte(v);
}
@Override public void writeShort(int v) {
pluginMessage.writeShort(v);
}
@Override public void writeChar(int v) {
pluginMessage.writeChar(v);
}
@Override public void writeInt(int v) {
pluginMessage.writeInt(v);
}
@Override public void writeLong(long v) {
pluginMessage.writeLong(v);
}
@Override public void writeFloat(float v) {
pluginMessage.writeFloat(v);
}
@Override public void writeDouble(double v) {
pluginMessage.writeDouble(v);
}
@Override public void writeChars(String s) {
pluginMessage.writeChars(s);
}
@Override public void writeUTF(String s) {
pluginMessage.writeUTF(s);
}
@Override @SuppressWarnings("deprecation")
public void writeBytes(String s) {
pluginMessage.writeBytes(s);
}
@Override public byte[] toByteArray() {
return pluginMessage.toByteArray();
}
@Override public void close() {
player.sendPluginMessage(plugin, channel, pluginMessage.toByteArray());
if(!wasChannelRegistered){
plugin.getServer().getMessenger().unregisterOutgoingPluginChannel(plugin, channel);
}
}
}

View File

@ -15,6 +15,7 @@
<module>Paste</module>
<module>Itemutils</module>
<module>TextUtils</module>
<module>BukkitUtils</module>
</modules>
<!-- Properties -->