feat: allow to include disconnect reason in bridge messages (#1399)

### Motivation
When players are kicked from e.g. a Lobby service, the message the Lobby
kicked them with is lost. This is a problem when having issues with
version mismatches or plugins kicking someone from a fallback as the
kick message is lost there too.

### Modification
When getting kicked from a service and no other fallback is available
the player will be kicked with the kick message of the downstream
service. If there is no kick message, the newly introduced
"server-kick-no-other-hub" message will be used.

### Result
Kick reasons are properly usable in disconnect messages.

---------

Co-authored-by: Pasqual Koschmieder <git@derklaro.dev>

Author: 0utplay

ext/adventure-helper/src/main/java/eu/cloudnetservice/ext/bungee/BungeeComponentUtil.java

@@ -0,0 +1,118 @@
+/*
+ * Copyright 2019-2024 CloudNetService team & contributors
+ *
+ * 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
+ *
+ *     http://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.
+ */
+
+package eu.cloudnetservice.ext.bungee;
+
+import java.util.ArrayList;
+import java.util.regex.Pattern;
+import lombok.NonNull;
+import net.md_5.bungee.api.chat.BaseComponent;
+import net.md_5.bungee.api.chat.TextComponent;
+
+public final class BungeeComponentUtil {
+
+  private BungeeComponentUtil() {
+    throw new UnsupportedOperationException();
+  }
+
+  /**
+   * Replaces all occurrences of the given pattern in the given component and its children with the given replacement.
+   *
+   * @param component   the component to replace the occurrences of the given pattern in.
+   * @param pattern     the pattern to find and replace in the given component.
+   * @param replacement the replacement to use for the pattern in the component.
+   * @return a component with all occurrences of the given pattern replaced.
+   * @throws NullPointerException if the given component, matcher or replacement is null.
+   */
+  public static @NonNull BaseComponent replaceText(
+    @NonNull BaseComponent component,
+    @NonNull Pattern pattern,
+    @NonNull BaseComponent replacement
+  ) {
+    var modifiedComponent = component;
+    var oldExtra = component.getExtra();
+    var newExtra = new ArrayList<BaseComponent>();
+
+    if (component instanceof TextComponent textComponent) {
+      var lastReplacedIndex = 0;
+      var text = textComponent.getText();
+      var matcher = pattern.matcher(text);
+      while (matcher.find()) {
+        if (matcher.start() == 0) {
+          if (matcher.end() == text.length()) {
+            // the component is a full match against the given pattern, we can
+            // just replace the current component with the replacement component
+            modifiedComponent = replacement.duplicate();
+            modifiedComponent.copyFormatting(component);
+
+            var replacementExtra = replacement.getExtra();
+            if (replacementExtra != null && !replacementExtra.isEmpty()) {
+              newExtra.addAll(replacement.getExtra());
+            }
+          } else {
+            // not a full match, but because the match is at the first index, we
+            // just use an empty component as the replacement and add the replacement
+            // component as its first extra component
+            modifiedComponent = new TextComponent();
+            newExtra.add(replacement);
+          }
+        } else {
+          if (modifiedComponent == component) {
+            // first match, initialize the target component & add
+            // the text up until the first match into the component
+            modifiedComponent = component.duplicate();
+            var prefixText = text.substring(0, matcher.start());
+            ((TextComponent) modifiedComponent).setText(prefixText);
+          } else if (lastReplacedIndex < matcher.start()) {
+            // not the first match, add the literal text between the last match
+            // and the current match as an extra of the new component
+            var middleText = text.substring(lastReplacedIndex, matcher.start());
+            newExtra.add(new TextComponent(middleText));
+          }
+
+          // add the replacement for the current matched token as an
+          // extra of the new component we're building
+          newExtra.add(replacement.duplicate());
+        }
+
+        lastReplacedIndex = matcher.end();
+      }
+
+      if (lastReplacedIndex > 0 && lastReplacedIndex < text.length()) {
+        // copy over the trailing text from the original component
+        var trailingText = text.substring(lastReplacedIndex);
+        newExtra.add(new TextComponent(trailingText));
+      }
+    }
+
+    // replace the text in all extra components of the current component
+    if (oldExtra != null && !oldExtra.isEmpty()) {
+      for (var extra : oldExtra) {
+        var replaced = replaceText(extra, pattern, replacement);
+        newExtra.add(replaced);
+      }
+    }
+
+    // only set extra components if we really constructed some, bungee only
+    // checks if extra is null during serialisation, not if the list is empty
+    // which results in a decoding error on the client later on
+    if (!newExtra.isEmpty()) {
+      modifiedComponent.setExtra(newExtra);
+    }
+
+    return modifiedComponent;
+  }
+}

gradle/libs.versions.toml

@@ -59,7 +59,7 @@ logback = "1.5.16"
 
 # platform api versions
 sponge = "9.0.0"
-velocity = "3.3.0-SNAPSHOT"
+velocity = "3.4.0-SNAPSHOT"
 waterdogpe = "1.2.4"
 nukkitX = "1.0-SNAPSHOT"
 minestom = "ccea53ac44"

modules/bridge/api/src/main/java/eu/cloudnetservice/modules/bridge/config/BridgeConfiguration.java

@@ -47,6 +47,7 @@ public final class BridgeConfiguration {
       .put("proxy-join-cancel-because-permission", "§7You do not have the required permissions to join this proxy.")
       .put("proxy-join-cancel-because-maintenance", "§7This proxy is currently in maintenance mode.")
       .put("proxy-join-disconnect-because-no-hub", "§cThere is currently no hub server you can connect to.")
+      .put("server-kick-no-other-hub", "§cThere is currently no hub server you can connect to.")
       .put("command-cloud-sub-command-no-permission", "§7You are not allowed to use §b%command%.")
       .put("already-connected", "§cYou are already connected to this network!")
       .put("error-connecting-to-server", "§cUnable to connect to %server%: %reason%")

modules/bridge/impl/src/main/java/eu/cloudnetservice/modules/bridge/impl/node/CloudNetBridgeModule.java

@@ -200,6 +200,30 @@ public void initModule(
       .build());
   }
 
+  // todo: remove in a release after 4.0.0-RC11
+  @ModuleTask(lifecycle = ModuleLifeCycle.STARTED)
+  public void updateBridgeConfiguration() {
+    var config = DocumentFactory.json().parse(this.configPath());
+    var localizedMessages = config.readMutableDocument("localizedMessages");
+    var defaultMessages = localizedMessages.readMutableDocument("default");
+
+    // if there is no entry in the default messages with the key -> add a new entry
+    // it is important to check on json level here, as we want to distinguish between the key being present
+    // with a null value and the key not being present at all
+    if (!defaultMessages.contains("server-kick-no-other-hub")) {
+      defaultMessages.append(
+        "server-kick-no-other-hub",
+        BridgeConfiguration.DEFAULT_MESSAGES.get("default").get("server-kick-no-other-hub"));
+
+      // we need to update from the inside out
+      localizedMessages.append("default", defaultMessages);
+      config.append("localizedMessages", localizedMessages);
+
+      // write the changes to the configuration
+      this.writeConfig(config);
+    }
+  }
+
   @ModuleTask(lifecycle = ModuleLifeCycle.STARTED)
   public void registerCommand(@NonNull CommandProvider commandProvider) {
     // register the bridge command

modules/bridge/impl/src/main/java/eu/cloudnetservice/modules/bridge/impl/platform/PlatformBridgeManagement.java

@@ -358,6 +358,10 @@ public void postInit() {
     this.selfTask = this.taskProvider.serviceTask(this.wrapperConfig.serviceConfiguration().serviceId().taskName());
   }
 
+  public @Nullable ProxyFallbackConfiguration currentFallbackConfiguration() {
+    return this.currentFallbackConfiguration;
+  }
+
   public @NonNull NetworkServiceInfo ownNetworkServiceInfo() {
     return this.ownNetworkServiceInfo;
   }