Drop Spigot Support, cleanup Spigot hacks and add Adventure to worldguard-core

Author: Joo200

buildSrc/src/main/kotlin/Versions.kt

@@ -7,4 +7,5 @@ object Versions {
     const val SQUIRRELID = "0.3.0"
     const val GUAVA = "31.0.1-jre"
     const val FINDBUGS = "3.0.2"
+    const val ADVENTURE = "4.10.1"
 }

config/checkstyle/import-control.xml

@@ -17,6 +17,7 @@
     <allow pkg="org.flywaydb"/>
     <allow pkg="org.yaml"/>
     <allow pkg="org.enginehub.piston"/>
+    <allow pkg="net.kyori.adventure"/>
 
     <subpackage name="util.profile.resolver">
       <allow pkg="org.bukkit"/>
@@ -32,7 +33,6 @@
       <allow pkg="com.destroystokyo.paper"/>
       <allow pkg="co.aikar.timings.lib" />
       <allow pkg="org.spigotmc" />
-      <allow pkg="net.kyori.adventure"/>
     </subpackage>
 
   </subpackage>

worldguard-bukkit/src/main/java/com/sk89q/worldguard/bukkit/BukkitPlayer.java

@@ -25,15 +25,14 @@
 import com.sk89q.worldedit.world.weather.WeatherTypes;
 import com.sk89q.worldguard.LocalPlayer;
 import com.sk89q.worldguard.WorldGuard;
-import com.sk89q.worldguard.bukkit.util.MiniMessageUtil;
-import com.sk89q.worldguard.util.MessagingUtil;
 import io.papermc.lib.PaperLib;
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.title.Title;
 import org.bukkit.BanList.Type;
 import org.bukkit.Bukkit;
 import org.bukkit.entity.Player;
 
-import java.util.Collections;
-import java.util.Map;
+import java.util.concurrent.CompletableFuture;
 
 public class BukkitPlayer extends com.sk89q.worldedit.bukkit.BukkitPlayer implements LocalPlayer {
 
@@ -187,21 +186,13 @@ public void sendTitle(String title, String subtitle) {
     }
 
     @Override
-    public void sendMiniMessage(String message, Map<String, String> replacements) {
-        if (!PaperLib.isPaper()) {
-            plugin.getLogger().warning("Trying to send a minimessage formatted message without minimessage support.");
-            return;
-        }
-        MiniMessageUtil.sendMiniMessage(this, message, replacements);
+    public void sendMessage(Component message) {
+        getPlayer().sendMessage(message);
     }
 
     @Override
-    public void sendMiniMessageTitle(String title, String subtitle, Map<String, String> replacements) {
-        if (!PaperLib.isPaper()) {
-            plugin.getLogger().warning("Trying to send a minimessage formatted title without minimessage support.");
-            return;
-        }
-        MiniMessageUtil.sendMiniMessageTitle(this, title, subtitle, replacements);
+    public void showTitle(Title title) {
+        getPlayer().showTitle(title);
     }
 
     @Override
@@ -210,24 +201,8 @@ public void resetFallDistance() {
     }
 
     @Override
-    public void teleport(Location location, String successMessage, String failMessage) {
-        teleport(location, successMessage, failMessage, Collections.emptyMap());
-    }
-
-    @Override
-    public void teleport(Location location, String successMessage, String failMessage, Map<String, String> replacements) {
-        PaperLib.teleportAsync(getPlayer(), BukkitAdapter.adapt(location))
-                .thenApply(success -> {
-                    if (success) {
-                        // The success message can be cleared via flag
-                        if (!successMessage.isEmpty()) {
-                            MessagingUtil.sendStringToChat(this, successMessage, replacements);
-                        }
-                    } else {
-                        printError(failMessage);
-                    }
-                    return success;
-                });
+    public CompletableFuture<Boolean> teleport(Location location) {
+        return PaperLib.teleportAsync(getPlayer(), BukkitAdapter.adapt(location));
     }
 
     @Override

worldguard-bukkit/src/main/java/com/sk89q/worldguard/bukkit/BukkitStringMatcher.java

@@ -29,6 +29,8 @@
 import com.sk89q.worldguard.LocalPlayer;
 import com.sk89q.worldguard.WorldGuard;
 import com.sk89q.worldguard.internal.platform.StringMatcher;
+import net.kyori.adventure.text.minimessage.tag.resolver.Placeholder;
+import net.kyori.adventure.text.minimessage.tag.resolver.TagResolver;
 import org.bukkit.Bukkit;
 import org.bukkit.entity.Player;
 
@@ -228,31 +230,13 @@ public World getWorldByName(String worldName) {
     }
 
     @Override
-    public String replaceMacros(Actor sender, String message) {
-        return replaceMacros(sender, message, replacements(sender));
-    }
-
-    @Override
-    public String replaceMacros(Actor sender, String message, Map<String, String> replacements) {
-        for (Map.Entry<String, String> entry : replacements.entrySet()) {
-            message = message.replace("%" + entry.getKey() + "%", entry.getValue());
-        }
-        return message;
-    }
-
-    @Override
-    public Map<String, String> replacements(Actor sender) {
-        Collection<? extends Player> online = Bukkit.getServer().getOnlinePlayers();
-
-        Map<String, String> map = new HashMap<>();
-        map.put("name", sender.getName());
-        map.put("id", sender.getUniqueId().toString());
-        map.put("online", String.valueOf(online.size()));
-
-        if (sender instanceof LocalPlayer player) {
-            map.put("world", player.getWorld().getName());
-            map.put("health", String.valueOf(player.getHealth()));
-        }
-        return map;
+    public TagResolver replacements(LocalPlayer sender) {
+        return TagResolver.builder()
+                .resolver(Placeholder.unparsed("name", sender.getName()))
+                .resolver(Placeholder.unparsed("id", sender.getUniqueId().toString()))
+                .resolver(Placeholder.unparsed("online", String.valueOf(Bukkit.getServer().getOnlinePlayers().size())))
+                .resolver(Placeholder.unparsed("world", sender.getWorld().getName()))
+                .resolver(Placeholder.unparsed("health", String.valueOf(sender.getHealth())))
+                .build();
     }
 }

worldguard-bukkit/src/main/java/com/sk89q/worldguard/bukkit/BukkitWorldGuardPlatform.java

@@ -29,7 +29,6 @@
 import com.sk89q.worldedit.world.gamemode.GameModes;
 import com.sk89q.worldguard.LocalPlayer;
 import com.sk89q.worldguard.WorldGuard;
-import com.sk89q.worldguard.bukkit.util.MiniMessageUtil;
 import com.sk89q.worldguard.protection.regions.ProtectedCuboidRegion;
 import com.sk89q.worldguard.protection.regions.ProtectedRegion;
 import com.sk89q.worldguard.util.profile.resolver.PaperPlayerService;
@@ -273,18 +272,4 @@ public ProtectedRegion getSpawnProtection(World world) {
         }
         return null;
     }
-
-    @Override
-    public boolean hasMiniMessage() {
-        return PaperLib.isPaper();
-    }
-
-    @Override
-    public String formatToMiniMessage(String message) {
-        Objects.requireNonNull(message);
-        if (hasMiniMessage()) {
-            return MiniMessageUtil.legacyToMiniMessage(message);
-        }
-        return null;
-    }
 }

worldguard-bukkit/src/main/java/com/sk89q/worldguard/bukkit/WorldGuardPlugin.java

@@ -73,6 +73,7 @@
 import com.sk89q.worldguard.protection.managers.storage.sql.SQLDriver;
 import com.sk89q.worldguard.protection.regions.ProtectedRegion;
 import com.sk89q.worldguard.util.logging.RecordMessagePrefixer;
+import io.papermc.lib.PaperLib;
 import org.bstats.bukkit.Metrics;
 import org.bstats.charts.DrilldownPie;
 import org.bstats.charts.SimplePie;
@@ -140,6 +141,13 @@ public void onEnable() {
         ClassSourceValidator verifier = new ClassSourceValidator(this);
         verifier.reportMismatches(ImmutableList.of(WorldGuard.class, ProtectedRegion.class, Flag.class));
 
+        if (!PaperLib.isPaper()) {
+            // TODO: Tidy up this message
+            getLogger().severe("Unable to start WorldGuard. This version does only support Paper.");
+            getLogger().severe("Update your server or downgrade WorldGuard.");
+            throw new RuntimeException("No capable platform found.");
+        }
+
         configureLogger();
 
         getDataFolder().mkdirs(); // Need to create the plugins/WorldGuard folder

worldguard-bukkit/src/main/java/com/sk89q/worldguard/bukkit/listener/RegionProtectionListener.java

@@ -45,7 +45,7 @@
 import com.sk89q.worldguard.protection.flags.StateFlag;
 import com.sk89q.worldguard.protection.flags.StateFlag.State;
 import com.sk89q.worldguard.protection.regions.RegionQuery;
-import com.sk89q.worldguard.util.MessagingUtil;
+import net.kyori.adventure.text.minimessage.tag.resolver.Placeholder;
 import org.bukkit.ChatColor;
 import org.bukkit.Location;
 import org.bukkit.Material;
@@ -118,7 +118,7 @@ private void tellErrorMessage(DelegateEvent event, Cause cause, Location locatio
 
     static void formatAndSendDenyMessage(String what, LocalPlayer localPlayer, String message) {
         if (message == null || message.isEmpty()) return;
-        MessagingUtil.sendStringToChat(localPlayer, message, Map.of("what", what));
+        localPlayer.sendMessage(WorldGuard.getInstance().getMiniMessage().deserialize(message, Placeholder.unparsed("what", what)));
     }
 
     /**

worldguard-bukkit/src/main/java/com/sk89q/worldguard/bukkit/util/MiniMessageUtil.java

@@ -11,6 +11,10 @@ dependencies {
     "implementation"("org.yaml:snakeyaml:1.30")
     "implementation"("com.google.guava:guava:${Versions.GUAVA}")
 
+    "api"("net.kyori:adventure-api:${Versions.ADVENTURE}")
+    "api"("net.kyori:adventure-text-minimessage:${Versions.ADVENTURE}")
+    "api"("net.kyori:adventure-text-serializer-legacy:${Versions.ADVENTURE}")
+
     "compileOnly"("com.google.code.findbugs:jsr305:${Versions.FINDBUGS}")
     "testImplementation"("org.hamcrest:hamcrest-library:1.2.1")
 }

worldguard-core/build.gradle.kts

@@ -25,9 +25,12 @@
 import com.sk89q.worldguard.domains.Association;
 import com.sk89q.worldguard.protection.association.RegionAssociable;
 import com.sk89q.worldguard.protection.regions.ProtectedRegion;
+import net.kyori.adventure.text.Component;
+import net.kyori.adventure.title.Title;
 
 import java.util.List;
 import java.util.Map;
+import java.util.concurrent.CompletableFuture;
 
 public interface LocalPlayer extends Player, RegionAssociable {
 
@@ -213,37 +216,25 @@ default Association getAssociation(List<ProtectedRegion> regions) {
      * Send the message to the player
      *
      * @param message the message as component
-     * @param replacements the placeholders as map
      */
-    void sendMiniMessage(String message, Map<String, String> replacements);
+    void sendMessage(Component message);
 
     /**
      * Send the message to the player
      *
-     * @param title the title in minimessage format
-     * @param subtitle the subtitle in minimessage format
-     * @param replacements the placeholders as map
+     * @param title the title
      */
-    void sendMiniMessageTitle(String title, String subtitle, Map<String, String> replacements);
+    void showTitle(Title title);
 
     /**
      * Clears fall distance.
      */
     void resetFallDistance();
 
     /**
-     * Teleport the player, potentially async, displaying the message on a success.
-     *  @param location location to teleport to
-     * @param successMessage message to display on success
-     * @param failMessage message to display on failure
+     * Teleport the player, potentially async.
+     * @param location location to teleport to
+     * @return a future object whether the teleport was successful
      */
-    void teleport(Location location, String successMessage, String failMessage);
-
-    /**
-     * Teleport the player, potentially async, displaying the message on a success.
-     *  @param location location to teleport to
-     * @param successMessage message to display on success
-     * @param failMessage message to display on failure
-     */
-    void teleport(Location location, String successMessage, String failMessage, Map<String, String> replacements);
+    CompletableFuture<Boolean> teleport(Location location);
 }