Add passthrough-default-server-ping

PaperMC · Dec 27, 2024 · 5854a65 · 5854a65
1 parent 1db8c8c
commit 5854a65
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 2 deletions.
diff --git a/proxy/src/main/java/com/velocitypowered/proxy/config/VelocityConfiguration.java b/proxy/src/main/java/com/velocitypowered/proxy/config/VelocityConfiguration.java
@@ -78,6 +78,8 @@ public class VelocityConfiguration implements ProxyConfig {
   private boolean onlineModeKickExistingPlayers = false;
   @Expose
   private PingPassthroughMode pingPassthrough = PingPassthroughMode.DISABLED;
+  @Expose
+  private boolean passthroughDefaultServerPing = true;
   private final Servers servers;
   private final ForcedHosts forcedHosts;
   @Expose
@@ -105,8 +107,9 @@ private VelocityConfiguration(String bind, String motd, int showMaxPlayers, bool
       boolean preventClientProxyConnections, boolean announceForge,
       PlayerInfoForwarding playerInfoForwardingMode, byte[] forwardingSecret,
       boolean onlineModeKickExistingPlayers, PingPassthroughMode pingPassthrough,
-      boolean enablePlayerAddressLogging, Servers servers, ForcedHosts forcedHosts,
-      Advanced advanced, Query query, Metrics metrics, boolean forceKeyAuthentication) {
+      boolean passthroughDefaultServerPing, boolean enablePlayerAddressLogging, Servers servers,
+      ForcedHosts forcedHosts, Advanced advanced, Query query, Metrics metrics,
+      boolean forceKeyAuthentication) {
     this.bind = bind;
     this.motd = motd;
     this.showMaxPlayers = showMaxPlayers;
@@ -117,6 +120,7 @@ private VelocityConfiguration(String bind, String motd, int showMaxPlayers, bool
     this.forwardingSecret = forwardingSecret;
     this.onlineModeKickExistingPlayers = onlineModeKickExistingPlayers;
     this.pingPassthrough = pingPassthrough;
+    this.passthroughDefaultServerPing = passthroughDefaultServerPing;
     this.enablePlayerAddressLogging = enablePlayerAddressLogging;
     this.servers = servers;
     this.forcedHosts = forcedHosts;
@@ -371,6 +375,10 @@ public PingPassthroughMode getPingPassthrough() {
     return pingPassthrough;
   }
 
+  public boolean isPassthroughDefaultServerPing() {
+    return passthroughDefaultServerPing;
+  }
+
   public boolean isPlayerAddressLoggingEnabled() {
     return enablePlayerAddressLogging;
   }
@@ -503,6 +511,8 @@ public static VelocityConfiguration read(Path path) throws IOException {
       final PingPassthroughMode pingPassthroughMode = config.getEnumOrElse("ping-passthrough",
               PingPassthroughMode.DISABLED);
 
+      final boolean passthroughDefaultServerPing = config.getOrElse("passthrough-default-server-ping", true);
+
       final String bind = config.getOrElse("bind", "0.0.0.0:25565");
       final int maxPlayers = config.getIntOrElse("show-max-players", 500);
       final boolean onlineMode = config.getOrElse("online-mode", true);
@@ -533,6 +543,7 @@ public static VelocityConfiguration read(Path path) throws IOException {
               forwardingSecret,
               kickExisting,
               pingPassthroughMode,
+              passthroughDefaultServerPing,
               enablePlayerAddressLogging,
               new Servers(serversConfig),
               new ForcedHosts(forcedHostsConfig),

diff --git a/proxy/src/main/java/com/velocitypowered/proxy/connection/util/ServerListPingHandler.java b/proxy/src/main/java/com/velocitypowered/proxy/connection/util/ServerListPingHandler.java
@@ -153,6 +153,12 @@ public CompletableFuture<ServerPing> getInitialPing(VelocityInboundConnection co
       String virtualHostStr = connection.getVirtualHost().map(InetSocketAddress::getHostString)
           .map(str -> str.toLowerCase(Locale.ROOT))
           .orElse("");
+
+      if (!configuration.isPassthroughDefaultServerPing()
+              && !configuration.getForcedHosts().containsKey(virtualHostStr)) {
+        return CompletableFuture.completedFuture(constructLocalPing(shownVersion));
+      }
+
       List<String> serversToTry = server.getConfiguration().getForcedHosts().getOrDefault(
           virtualHostStr, server.getConfiguration().getAttemptConnectionOrder());
       return attemptPingPassthrough(connection, passthroughMode, serversToTry, shownVersion);

diff --git a/proxy/src/main/resources/default-velocity.toml b/proxy/src/main/resources/default-velocity.toml
@@ -66,6 +66,12 @@ kick-existing-players = false
 #                  configuration is used if no servers could be contacted.
 ping-passthrough = "DISABLED"
 
+# If enabled (default is true), then the proxy will pass all pings, including ones on hosts not
+# listed in forced-hosts, to the default backend server(s).
+# Otherwise, the proxy will use its own MOTD and version to reply to pings on other hosts.
+# Note that this option has no effect if ping-passthrough is set to DISABLED.
+passthrough-default-server-ping = true
+
 # If not enabled (default is true) player IP addresses will be replaced by <ip address withheld> in logs
 enable-player-address-logging = true