From 63015d217d37c5005b62b96eaecee34ac88c2469 Mon Sep 17 00:00:00 2001 From: Paul Sauve Date: Sat, 5 Jun 2021 01:11:28 -0500 Subject: [PATCH] Initial --- .gitignore | 3 + build.gradle | 23 +++ gradlew | 185 ++++++++++++++++++ gradlew.bat | 89 +++++++++ settings.gradle | 2 + .../technove/plugins/ImprovedKeepAlive.java | 45 +++++ .../plugins/KeepAlivePacketAdapter.java | 116 +++++++++++ .../co/technove/plugins/KeepAliveTask.java | 53 +++++ src/main/resources/config.yml | 2 + src/main/resources/plugin.yml | 8 + 10 files changed, 526 insertions(+) create mode 100644 .gitignore create mode 100644 build.gradle create mode 100755 gradlew create mode 100644 gradlew.bat create mode 100644 settings.gradle create mode 100644 src/main/java/co/technove/plugins/ImprovedKeepAlive.java create mode 100644 src/main/java/co/technove/plugins/KeepAlivePacketAdapter.java create mode 100644 src/main/java/co/technove/plugins/KeepAliveTask.java create mode 100644 src/main/resources/config.yml create mode 100644 src/main/resources/plugin.yml diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..14c4660 --- /dev/null +++ b/.gitignore @@ -0,0 +1,3 @@ +run/ +build/ +gradle/ \ No newline at end of file diff --git a/build.gradle b/build.gradle new file mode 100644 index 0000000..c0edde5 --- /dev/null +++ b/build.gradle @@ -0,0 +1,23 @@ +plugins { + id 'java' + id("xyz.jpenilla.run-paper") version "1.0.1" +} + +group 'org.example' +version '1.0-SNAPSHOT' + +repositories { + maven { url "https://repo.dmulloy2.net/repository/public/" } + maven { url "https://papermc.io/repo/repository/maven-public/" } +} + +dependencies { + compileOnly group: "com.comphenix.protocol", name: "ProtocolLib", version: "4.6.0"; + compileOnly group: "com.destroystokyo.paper", name: "paper-api", version: "1.16.5-R0.1-SNAPSHOT" +} + +tasks { + runServer { + minecraftVersion("1.16.5") + } +} diff --git a/gradlew b/gradlew new file mode 100755 index 0000000..4f906e0 --- /dev/null +++ b/gradlew @@ -0,0 +1,185 @@ +#!/usr/bin/env sh + +# +# Copyright 2015 the original author or authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# https://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +############################################################################## +## +## Gradle start up script for UN*X +## +############################################################################## + +# Attempt to set APP_HOME +# Resolve links: $0 may be a link +PRG="$0" +# Need this for relative symlinks. +while [ -h "$PRG" ] ; do + ls=`ls -ld "$PRG"` + link=`expr "$ls" : '.*-> \(.*\)$'` + if expr "$link" : '/.*' > /dev/null; then + PRG="$link" + else + PRG=`dirname "$PRG"`"/$link" + fi +done +SAVED="`pwd`" +cd "`dirname \"$PRG\"`/" >/dev/null +APP_HOME="`pwd -P`" +cd "$SAVED" >/dev/null + +APP_NAME="Gradle" +APP_BASE_NAME=`basename "$0"` + +# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' + +# Use the maximum available, or set MAX_FD != -1 to use that value. +MAX_FD="maximum" + +warn () { + echo "$*" +} + +die () { + echo + echo "$*" + echo + exit 1 +} + +# OS specific support (must be 'true' or 'false'). +cygwin=false +msys=false +darwin=false +nonstop=false +case "`uname`" in + CYGWIN* ) + cygwin=true + ;; + Darwin* ) + darwin=true + ;; + MINGW* ) + msys=true + ;; + NONSTOP* ) + nonstop=true + ;; +esac + +CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar + + +# Determine the Java command to use to start the JVM. +if [ -n "$JAVA_HOME" ] ; then + if [ -x "$JAVA_HOME/jre/sh/java" ] ; then + # IBM's JDK on AIX uses strange locations for the executables + JAVACMD="$JAVA_HOME/jre/sh/java" + else + JAVACMD="$JAVA_HOME/bin/java" + fi + if [ ! -x "$JAVACMD" ] ; then + die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." + fi +else + JAVACMD="java" + which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. + +Please set the JAVA_HOME variable in your environment to match the +location of your Java installation." +fi + +# Increase the maximum file descriptors if we can. +if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then + MAX_FD_LIMIT=`ulimit -H -n` + if [ $? -eq 0 ] ; then + if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then + MAX_FD="$MAX_FD_LIMIT" + fi + ulimit -n $MAX_FD + if [ $? -ne 0 ] ; then + warn "Could not set maximum file descriptor limit: $MAX_FD" + fi + else + warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" + fi +fi + +# For Darwin, add options to specify how the application appears in the dock +if $darwin; then + GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" +fi + +# For Cygwin or MSYS, switch paths to Windows format before running java +if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then + APP_HOME=`cygpath --path --mixed "$APP_HOME"` + CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` + + JAVACMD=`cygpath --unix "$JAVACMD"` + + # We build the pattern for arguments to be converted via cygpath + ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` + SEP="" + for dir in $ROOTDIRSRAW ; do + ROOTDIRS="$ROOTDIRS$SEP$dir" + SEP="|" + done + OURCYGPATTERN="(^($ROOTDIRS))" + # Add a user-defined pattern to the cygpath arguments + if [ "$GRADLE_CYGPATTERN" != "" ] ; then + OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" + fi + # Now convert the arguments - kludge to limit ourselves to /bin/sh + i=0 + for arg in "$@" ; do + CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` + CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option + + if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition + eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` + else + eval `echo args$i`="\"$arg\"" + fi + i=`expr $i + 1` + done + case $i in + 0) set -- ;; + 1) set -- "$args0" ;; + 2) set -- "$args0" "$args1" ;; + 3) set -- "$args0" "$args1" "$args2" ;; + 4) set -- "$args0" "$args1" "$args2" "$args3" ;; + 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; + 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; + 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; + 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; + 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; + esac +fi + +# Escape application args +save () { + for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done + echo " " +} +APP_ARGS=`save "$@"` + +# Collect all arguments for the java command, following the shell quoting and substitution rules +eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" + +exec "$JAVACMD" "$@" diff --git a/gradlew.bat b/gradlew.bat new file mode 100644 index 0000000..ac1b06f --- /dev/null +++ b/gradlew.bat @@ -0,0 +1,89 @@ +@rem +@rem Copyright 2015 the original author or authors. +@rem +@rem Licensed under the Apache License, Version 2.0 (the "License"); +@rem you may not use this file except in compliance with the License. +@rem You may obtain a copy of the License at +@rem +@rem https://www.apache.org/licenses/LICENSE-2.0 +@rem +@rem Unless required by applicable law or agreed to in writing, software +@rem distributed under the License is distributed on an "AS IS" BASIS, +@rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +@rem See the License for the specific language governing permissions and +@rem limitations under the License. +@rem + +@if "%DEBUG%" == "" @echo off +@rem ########################################################################## +@rem +@rem Gradle startup script for Windows +@rem +@rem ########################################################################## + +@rem Set local scope for the variables with windows NT shell +if "%OS%"=="Windows_NT" setlocal + +set DIRNAME=%~dp0 +if "%DIRNAME%" == "" set DIRNAME=. +set APP_BASE_NAME=%~n0 +set APP_HOME=%DIRNAME% + +@rem Resolve any "." and ".." in APP_HOME to make it shorter. +for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi + +@rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. +set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" + +@rem Find java.exe +if defined JAVA_HOME goto findJavaFromJavaHome + +set JAVA_EXE=java.exe +%JAVA_EXE% -version >NUL 2>&1 +if "%ERRORLEVEL%" == "0" goto execute + +echo. +echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:findJavaFromJavaHome +set JAVA_HOME=%JAVA_HOME:"=% +set JAVA_EXE=%JAVA_HOME%/bin/java.exe + +if exist "%JAVA_EXE%" goto execute + +echo. +echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% +echo. +echo Please set the JAVA_HOME variable in your environment to match the +echo location of your Java installation. + +goto fail + +:execute +@rem Setup the command line + +set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar + + +@rem Execute Gradle +"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* + +:end +@rem End local scope for the variables with windows NT shell +if "%ERRORLEVEL%"=="0" goto mainEnd + +:fail +rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of +rem the _cmd.exe /c_ return code! +if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 +exit /b 1 + +:mainEnd +if "%OS%"=="Windows_NT" endlocal + +:omega diff --git a/settings.gradle b/settings.gradle new file mode 100644 index 0000000..4eee4db --- /dev/null +++ b/settings.gradle @@ -0,0 +1,2 @@ +rootProject.name = 'ImprovedKeepAlive' + diff --git a/src/main/java/co/technove/plugins/ImprovedKeepAlive.java b/src/main/java/co/technove/plugins/ImprovedKeepAlive.java new file mode 100644 index 0000000..ccd4feb --- /dev/null +++ b/src/main/java/co/technove/plugins/ImprovedKeepAlive.java @@ -0,0 +1,45 @@ +package co.technove.plugins; + +import com.comphenix.protocol.ProtocolLibrary; +import com.comphenix.protocol.ProtocolManager; +import org.bukkit.plugin.java.JavaPlugin; + +public class ImprovedKeepAlive extends JavaPlugin { + + public static final long KEEPALIVE_LIMIT = Long.getLong("paper.playerconnection.keepalive", 30) * 1000; + public static final long MAX_KEEPALIVE_ID = 2048; + + private KeepAliveTask keepAliveTask; + private KeepAlivePacketAdapter keepAlivePacketAdapter; + private ProtocolManager protocolManager; + private long packetInterval; + + @Override + public void onEnable() { + saveDefaultConfig(); + + this.packetInterval = getConfig().getLong("interval", 5000L); + + this.keepAliveTask = new KeepAliveTask(this); + this.keepAliveTask.runTaskTimerAsynchronously(this, 20L * 5L, 20L * 5); + + this.protocolManager = ProtocolLibrary.getProtocolManager(); + this.keepAlivePacketAdapter = new KeepAlivePacketAdapter(this); + this.protocolManager.addPacketListener(this.keepAlivePacketAdapter); + } + + @Override + public void onDisable() { + this.protocolManager.removePacketListeners(this); + this.keepAliveTask.cancel(); + this.keepAlivePacketAdapter.shutdown(); + } + + public KeepAliveTask getKeepAliveTask() { + return keepAliveTask; + } + + public long getPacketInterval() { + return this.packetInterval; + } +} diff --git a/src/main/java/co/technove/plugins/KeepAlivePacketAdapter.java b/src/main/java/co/technove/plugins/KeepAlivePacketAdapter.java new file mode 100644 index 0000000..2ca273c --- /dev/null +++ b/src/main/java/co/technove/plugins/KeepAlivePacketAdapter.java @@ -0,0 +1,116 @@ +package co.technove.plugins; + +import com.comphenix.protocol.PacketType; +import com.comphenix.protocol.ProtocolLibrary; +import com.comphenix.protocol.ProtocolManager; +import com.comphenix.protocol.events.ListenerPriority; +import com.comphenix.protocol.events.PacketAdapter; +import com.comphenix.protocol.events.PacketContainer; +import com.comphenix.protocol.events.PacketEvent; +import org.bukkit.entity.Player; +import org.bukkit.event.EventHandler; +import org.bukkit.event.EventPriority; +import org.bukkit.event.Listener; +import org.bukkit.event.player.PlayerKickEvent; +import org.bukkit.event.player.PlayerQuitEvent; + +import java.lang.reflect.InvocationTargetException; +import java.util.Map; +import java.util.UUID; +import java.util.concurrent.ConcurrentHashMap; +import java.util.concurrent.Executors; +import java.util.concurrent.ScheduledExecutorService; +import java.util.concurrent.TimeUnit; +import java.util.logging.Level; + +import static net.kyori.adventure.text.Component.translatable; + +public class KeepAlivePacketAdapter extends PacketAdapter implements Listener { + + private final ImprovedKeepAlive plugin; + private final ProtocolManager protocolManager; + private final KeepAliveTask task; + + // admittedly the executor isn't great, but it lets us middleman very efficiently + private final ScheduledExecutorService executorService = Executors.newSingleThreadScheduledExecutor(); + private final Map playerPing = new ConcurrentHashMap<>(); + private final Map lastConfirm = new ConcurrentHashMap<>(); + + public KeepAlivePacketAdapter(ImprovedKeepAlive plugin) { + super(plugin, ListenerPriority.LOWEST, PacketType.Play.Server.KEEP_ALIVE, PacketType.Play.Client.KEEP_ALIVE); + + this.plugin = plugin; + this.protocolManager = ProtocolLibrary.getProtocolManager(); + this.task = plugin.getKeepAliveTask(); + } + + public void shutdown() { + this.executorService.shutdownNow(); + } + + // goal with packet sending: + // - stop packets from the server, then return the server a fake packet at the exact timing of the ping + @Override + public void onPacketSending(PacketEvent event) { + long id = event.getPacket().getLongs().read(0); + if (id > ImprovedKeepAlive.MAX_KEEPALIVE_ID) { + event.setCancelled(true); + + Player player = event.getPlayer(); + if (System.currentTimeMillis() - lastConfirm.getOrDefault(player.getUniqueId(), 0L) < ImprovedKeepAlive.KEEPALIVE_LIMIT) { + long actualPing = playerPing.getOrDefault(player.getUniqueId(), (long) player.getPing()); + executorService.schedule(() -> { + // send ourselves a fake packet to lock in the ping + if (player.isOnline()) { + PacketContainer packet = new PacketContainer(PacketType.Play.Client.KEEP_ALIVE); + packet.getLongs().write(0, id); + try { + this.protocolManager.recieveClientPacket(player, packet); + } catch (IllegalAccessException | InvocationTargetException e) { + this.plugin.getLogger().log(Level.WARNING, "Failed to receive keep alive packet", e); + } + } + }, actualPing, TimeUnit.MILLISECONDS); + } + } + } + + // goals with packet receiving: + // - ignore the fake packet we send above + // - calculate their actual ping based off the id of the packet sent back (kicking if it's timed out, or more likely being faked) + // - mark that they've recently had a successful keepalive + @Override + public void onPacketReceiving(PacketEvent event) { + PacketContainer packet = event.getPacket(); + long id = packet.getLongs().read(0); + + if (id > ImprovedKeepAlive.MAX_KEEPALIVE_ID || id < 0) { + // it's our fake packet, ignore + return; + } + + event.setCancelled(true); + Player player = event.getPlayer(); + + long latestPacket = this.task.getPacketId(); + if (latestPacket < id) { // wraparound + latestPacket += ImprovedKeepAlive.MAX_KEEPALIVE_ID; + } + + long millis = System.currentTimeMillis(); + long ping = (latestPacket - id) * this.plugin.getPacketInterval() + (millis - this.task.getLastPacketSendTime()); + if (ping > ImprovedKeepAlive.KEEPALIVE_LIMIT) { + this.plugin.getLogger().log(Level.INFO, player.getName() + " was kicked due to keepalive timeout."); + player.kick(translatable("disconnect.timeout"), PlayerKickEvent.Cause.TIMEOUT); + return; + } + this.playerPing.put(player.getUniqueId(), ping); + this.lastConfirm.put(player.getUniqueId(), millis); + } + + @EventHandler(priority = EventPriority.MONITOR) + public void onPlayerQuit(PlayerQuitEvent event) { + this.playerPing.remove(event.getPlayer().getUniqueId()); + this.lastConfirm.remove(event.getPlayer().getUniqueId()); + } +} diff --git a/src/main/java/co/technove/plugins/KeepAliveTask.java b/src/main/java/co/technove/plugins/KeepAliveTask.java new file mode 100644 index 0000000..5b4bc71 --- /dev/null +++ b/src/main/java/co/technove/plugins/KeepAliveTask.java @@ -0,0 +1,53 @@ +package co.technove.plugins; + +import com.comphenix.protocol.PacketType; +import com.comphenix.protocol.ProtocolLibrary; +import com.comphenix.protocol.ProtocolManager; +import com.comphenix.protocol.events.PacketContainer; +import org.bukkit.Bukkit; +import org.bukkit.entity.Player; +import org.bukkit.scheduler.BukkitRunnable; + +import java.lang.reflect.InvocationTargetException; +import java.util.logging.Level; + +public class KeepAliveTask extends BukkitRunnable { + + private long lastPacketSendTime; + private long packetId = 0; + private final ImprovedKeepAlive plugin; + private final ProtocolManager protocolManager; + + public KeepAliveTask(ImprovedKeepAlive plugin) { + this.plugin = plugin; + this.protocolManager = ProtocolLibrary.getProtocolManager(); + } + + @Override + public void run() { + if (++this.packetId > ImprovedKeepAlive.MAX_KEEPALIVE_ID) { + this.packetId = 0; + } + + PacketContainer pingPacket = new PacketContainer(PacketType.Play.Server.KEEP_ALIVE); + pingPacket.getLongs().write(0, this.packetId); + this.lastPacketSendTime = System.currentTimeMillis(); + + try { + for (Player player : Bukkit.getOnlinePlayers()) { + this.protocolManager.sendServerPacket(player, pingPacket); + } + } catch (InvocationTargetException e) { + this.plugin.getLogger().log(Level.WARNING, "Failed to write keepalive", e); + } + } + + public long getLastPacketSendTime() { + return lastPacketSendTime; + } + + public long getPacketId() { + return packetId; + } + +} diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml new file mode 100644 index 0000000..8d2f70d --- /dev/null +++ b/src/main/resources/config.yml @@ -0,0 +1,2 @@ +# The interval in milliseconds between sending keepalive packets +interval: 10000 \ No newline at end of file diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml new file mode 100644 index 0000000..a608cfa --- /dev/null +++ b/src/main/resources/plugin.yml @@ -0,0 +1,8 @@ +name: ImprovedKeepAlive +description: Improves the method in which players stay connected to the server +version: 1.0.0 +main: co.technove.plugins.ImprovedKeepAlive +api-version: 1.16 + +depend: + - ProtocolLib