Add support for the legacy ping passthrough options too.

TheMiningTeamYT · TheMiningTeamYT · commit 148c2ca50d83 · 2024-12-31T16:30:18.000-06:00
diff --git a/proxy/src/main/java/com/velocitypowered/proxy/config/LegacyPingPassthroughMode.java b/proxy/src/main/java/com/velocitypowered/proxy/config/LegacyPingPassthroughMode.java
@@ -0,0 +1,28 @@
+/*
+ * Copyright (C) 2018-2023 Velocity Contributors
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <https://www.gnu.org/licenses/>.
+ */
+
+package com.velocitypowered.proxy.config;
+
+/**
+ * Legacy modes for ping passthrough.
+ */
+public enum LegacyPingPassthroughMode {
+  DISABLED,
+  MODS,
+  DESCRIPTION,
+  ALL
+}
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 = new PingPassthroughMode(false, false, false, false, false);
+  @Expose
+  private LegacyPingPassthroughMode legacyPingPassthrough = LegacyPingPassthroughMode.DISABLED;
   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) {
+      LegacyPingPassthroughMode legacyPingPassthrough, 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.legacyPingPassthrough = legacyPingPassthrough;
     this.enablePlayerAddressLogging = enablePlayerAddressLogging;
     this.servers = servers;
     this.forcedHosts = forcedHosts;
@@ -371,6 +375,10 @@ public PingPassthroughMode getPingPassthrough() {
     return pingPassthrough;
   }
 
+  public LegacyPingPassthroughMode getLegacyPingPassthrough() {
+    return legacyPingPassthrough;
+  }
+
   public boolean isPlayerAddressLoggingEnabled() {
     return enablePlayerAddressLogging;
   }
@@ -500,8 +508,8 @@ public static VelocityConfiguration read(Path path) throws IOException {
       final CommentedConfig metricsConfig = config.get("metrics");
       final PlayerInfoForwarding forwardingMode = config.getEnumOrElse(
               "player-info-forwarding-mode", PlayerInfoForwarding.NONE);
-      // final PingPassthroughMode pingPassthroughMode = config.getEnumOrElse("ping-passthrough",
-      //        PingPassthroughMode.DISABLED);
+      final LegacyPingPassthroughMode legacyPingPassthrough = config.getEnumOrElse("ping-passthrough",
+              LegacyPingPassthroughMode.DISABLED);
       final PingPassthroughMode pingPassthrough = new PingPassthroughMode(
               config.getOrElse("ping-passthrough-version", false),
               config.getOrElse("ping-passthrough-players", false),
@@ -538,6 +546,7 @@ public static VelocityConfiguration read(Path path) throws IOException {
               forwardingSecret,
               kickExisting,
               pingPassthrough,
+              legacyPingPassthrough,
               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
@@ -26,6 +26,7 @@
 import com.velocitypowered.api.util.Favicon;
 import com.velocitypowered.api.util.ModInfo;
 import com.velocitypowered.proxy.VelocityServer;
+import com.velocitypowered.proxy.config.LegacyPingPassthroughMode;
 import com.velocitypowered.proxy.config.PingPassthroughMode;
 import com.velocitypowered.proxy.config.VelocityConfiguration;
 import com.velocitypowered.proxy.server.VelocityRegisteredServer;
@@ -64,7 +65,8 @@ private ServerPing constructLocalPing(ProtocolVersion version) {
   }
 
   private CompletableFuture<ServerPing> attemptPingPassthrough(VelocityInboundConnection connection,
-      PingPassthroughMode mode, List<String> servers, ProtocolVersion responseProtocolVersion) {
+      PingPassthroughMode mode, LegacyPingPassthroughMode legacyMode, 
+      List<String> servers, ProtocolVersion responseProtocolVersion) {
     ServerPing fallback = constructLocalPing(connection.getProtocolVersion());
     List<CompletableFuture<ServerPing>> pings = new ArrayList<>();
     for (String s : servers) {
@@ -82,62 +84,117 @@ private CompletableFuture<ServerPing> attemptPingPassthrough(VelocityInboundConn
 
     CompletableFuture<List<ServerPing>> pingResponses = CompletableFutures.successfulAsList(pings,
         (ex) -> fallback);
-    return pingResponses.thenApply(responses -> {
-      // Find the first non-fallback. If it includes a modlist, add it too.
-      for (ServerPing response : responses) {
-        if (response == fallback) {
-          continue;
+    if (mode.enabled()) {
+      return pingResponses.thenApply(responses -> {
+        // Find the first non-fallback. If it includes a modlist, add it too.
+        for (ServerPing response : responses) {
+          if (response == fallback) {
+            continue;
+          }
+
+          if (response.getDescriptionComponent() == null) {
+            continue;
+          }
+
+          ServerPing.Version version;
+          if (mode.version) {
+            version = response.getVersion();
+          } else {
+            version = fallback.getVersion();
+          }
+
+          ServerPing.Players players;
+          if (mode.players) {
+            players = response.getPlayers().orElse(null);
+          } else {
+            players = fallback.getPlayers().orElse(null);
+          }
+
+          net.kyori.adventure.text.Component description;
+          if (mode.description) {
+            description = response.getDescriptionComponent();
+          } else {
+            description = fallback.getDescriptionComponent();
+          }
+
+          Favicon favicon;
+          if (mode.favicon) {
+            favicon = response.getFavicon().orElse(null);
+          } else {
+            favicon = fallback.getFavicon().orElse(null);
+          }
+
+          ModInfo modinfo;
+          if (mode.modinfo) {
+            modinfo = response.getModinfo().orElse(null);
+          } else {
+            modinfo = fallback.getModinfo().orElse(null);
+          }
+          
+          return new ServerPing(
+              version,
+              players,
+              description,
+              favicon,
+              modinfo
+          );
         }
-
-        if (response.getDescriptionComponent() == null) {
-          continue;
-        }
-
-        ServerPing.Version version;
-        if (mode.version) {
-          version = response.getVersion();
-        } else {
-          version = fallback.getVersion();
-        }
-
-        ServerPing.Players players;
-        if (mode.players) {
-          players = response.getPlayers().orElse(null);
-        } else {
-          players = fallback.getPlayers().orElse(null);
-        }
-
-        net.kyori.adventure.text.Component description;
-        if (mode.description) {
-          description = response.getDescriptionComponent();
-        } else {
-          description = fallback.getDescriptionComponent();
-        }
-
-        Favicon favicon;
-        if (mode.favicon) {
-          favicon = response.getFavicon().orElse(null);
-        } else {
-          favicon = fallback.getFavicon().orElse(null);
-        }
-
-        ModInfo modinfo;
-        if (mode.modinfo) {
-          modinfo = response.getModinfo().orElse(null);
-        } else {
-          modinfo = fallback.getModinfo().orElse(null);
-        }
-        
-        return new ServerPing(
-            version,
-            players,
-            description,
-            favicon,
-            modinfo
-        );
+        return fallback;
+      });
+    } else {
+      switch (legacyMode) {
+        case ALL:
+          return pingResponses.thenApply(responses -> {
+            // Find the first non-fallback
+            for (ServerPing response : responses) {
+              if (response == fallback) {
+                continue;
+              }
+              return response;
+            }
+            return fallback;
+          });
+        case MODS:
+          return pingResponses.thenApply(responses -> {
+            // Find the first non-fallback that contains a mod list
+            for (ServerPing response : responses) {
+              if (response == fallback) {
+                continue;
+              }
+              Optional<ModInfo> modInfo = response.getModinfo();
+              if (modInfo.isPresent()) {
+                return fallback.asBuilder().mods(modInfo.get()).build();
+              }
+            }
+            return fallback;
+          });
+        case DESCRIPTION:
+          return pingResponses.thenApply(responses -> {
+            // Find the first non-fallback. If it includes a modlist, add it too.
+            for (ServerPing response : responses) {
+              if (response == fallback) {
+                continue;
+              }
+
+              if (response.getDescriptionComponent() == null) {
+                continue;
+              }
+
+              return new ServerPing(
+                  fallback.getVersion(),
+                  fallback.getPlayers().orElse(null),
+                  response.getDescriptionComponent(),
+                  fallback.getFavicon().orElse(null),
+                  response.getModinfo().orElse(null)
+              );
+            }
+            return fallback;
+          });
+        // Not possible, but covered for completeness.
+        default:
+          return CompletableFuture.completedFuture(fallback);
       }
-      return fallback;
-    });
+    }
   }
 
   /**
@@ -151,16 +208,17 @@ public CompletableFuture<ServerPing> getInitialPing(VelocityInboundConnection co
     ProtocolVersion shownVersion = connection.getProtocolVersion().isSupported()
         ? connection.getProtocolVersion() : ProtocolVersion.MAXIMUM_VERSION;
     PingPassthroughMode passthroughMode = configuration.getPingPassthrough();
+    LegacyPingPassthroughMode legacyPassthroughMode = configuration.getLegacyPingPassthrough();
 
-    if (!passthroughMode.enabled()) {
+    if (!passthroughMode.enabled() && legacyPassthroughMode == LegacyPingPassthroughMode.DISABLED) {
       return CompletableFuture.completedFuture(constructLocalPing(shownVersion));
     } else {
       String virtualHostStr = connection.getVirtualHost().map(InetSocketAddress::getHostString)
           .map(str -> str.toLowerCase(Locale.ROOT))
           .orElse("");
       List<String> serversToTry = server.getConfiguration().getForcedHosts().getOrDefault(
           virtualHostStr, server.getConfiguration().getAttemptConnectionOrder());
-      return attemptPingPassthrough(connection, passthroughMode, serversToTry, shownVersion);
+      return attemptPingPassthrough(connection, passthroughMode, legacyPassthroughMode, serversToTry, shownVersion);
     }
   }
 }
