feat: add a placeholder to provide the absolute plot's x/y

Cancelling the ProjectileHitEvent will not cover for thrown eggs spawning chickens due to how Bukkit has these events structured. The provided patch calls the same code used for normal projectiles in the specialized egg event to prevent unwanted chickens from spawning on other plots.

Signed-off-by: FlorianMichael <florian.michael07@gmail.com>

.github/workflows/announce-release-on-discord.yml

@@ -11,7 +11,7 @@ jobs:
           DISCORD_WEBHOOK: ${{ secrets.DISCORD_WEBHOOK }}
           DISCORD_USERNAME: PlotSquared Release
           DISCORD_AVATAR: https://raw.githubusercontent.com/IntellectualSites/Assets/main/plugins/PlotSquared/PlotSquared.png
-        uses: Ilshidur/action-discord@0.3.2
+        uses: Ilshidur/action-discord@0.4.0
         with:
           args: |
             "<@&525015541815967744> <@&679322738552471574> <@&699293353862496266>"

Bukkit/src/main/java/com/plotsquared/bukkit/listener/ProjectileEventListener.java

@@ -47,6 +47,7 @@ import org.bukkit.event.entity.LingeringPotionSplashEvent;
 import org.bukkit.event.entity.PotionSplashEvent;
 import org.bukkit.event.entity.ProjectileHitEvent;
 import org.bukkit.event.entity.ProjectileLaunchEvent;
+import org.bukkit.event.player.PlayerEggThrowEvent;
 import org.bukkit.projectiles.BlockProjectileSource;
 import org.bukkit.projectiles.ProjectileSource;
 import org.checkerframework.checker.nullness.qual.NonNull;
@@ -157,14 +158,26 @@ public class ProjectileEventListener implements Listener {
 
     @EventHandler
     public void onProjectileHit(ProjectileHitEvent event) {
-        Projectile entity = event.getEntity();
+        if (cancelProjectileHit(event.getEntity())) {
+            event.setCancelled(true);
+        }
+    }
+
+    @EventHandler
+    public void onPlayerEggThrow(PlayerEggThrowEvent event) {
+        if (cancelProjectileHit(event.getEgg())) {
+            event.setHatching(false);
+        }
+    }
+
+    private boolean cancelProjectileHit(Projectile entity) {
         Location location = BukkitUtil.adapt(entity.getLocation());
         if (!this.plotAreaManager.hasPlotArea(location.getWorldName())) {
-            return;
+            return false;
         }
         PlotArea area = location.getPlotArea();
         if (area == null) {
-            return;
+            return false;
         }
         Plot plot = area.getPlot(location);
         ProjectileSource shooter = entity.getShooter();
@@ -172,15 +185,14 @@ public class ProjectileEventListener implements Listener {
             if (!((Player) shooter).isOnline()) {
                 if (plot != null) {
                     if (plot.isAdded(((Player) shooter).getUniqueId()) || plot.getFlag(ProjectilesFlag.class)) {
-                        return;
+                        return false;
                     }
                 } else if (PlotFlagUtil.isAreaRoadFlagsAndFlagEquals(area, ProjectilesFlag.class, true)) {
-                    return;
+                    return false;
                 }
 
                 entity.remove();
-                event.setCancelled(true);
-                return;
+                return true;
             }
 
             PlotPlayer<?> pp = BukkitUtil.adapt((Player) shooter);
@@ -189,38 +201,36 @@ public class ProjectileEventListener implements Listener {
                         Permission.PERMISSION_ADMIN_PROJECTILE_UNOWNED
                 )) {
                     entity.remove();
-                    event.setCancelled(true);
+                    return true;
                 }
-                return;
+                return false;
             }
             if (plot.isAdded(pp.getUUID()) || pp.hasPermission(Permission.PERMISSION_ADMIN_PROJECTILE_OTHER) || plot.getFlag(
                     ProjectilesFlag.class) || (entity instanceof FishHook && plot.getFlag(
                     FishingFlag.class))) {
-                return;
+                return false;
             }
             entity.remove();
-            event.setCancelled(true);
-            return;
+            return true;
         }
         if (!(shooter instanceof Entity) && shooter != null) {
             if (plot == null) {
                 entity.remove();
-                event.setCancelled(true);
-                return;
+                return true;
             }
             Location sLoc =
                     BukkitUtil.adapt(((BlockProjectileSource) shooter).getBlock().getLocation());
             if (!area.contains(sLoc.getX(), sLoc.getZ())) {
                 entity.remove();
-                event.setCancelled(true);
-                return;
+                return true;
             }
             Plot sPlot = area.getOwnedPlotAbs(sLoc);
             if (sPlot == null || !PlotHandler.sameOwners(plot, sPlot)) {
                 entity.remove();
-                event.setCancelled(true);
+                return true;
             }
         }
+        return false;
     }
 
 }

Core/src/main/java/com/plotsquared/core/command/Grant.java

@@ -177,8 +177,14 @@ public class Grant extends Command {
                 commands.addAll(TabCompletions.completePlayers(player, args[0], Collections.emptyList()));
             }
             return commands;
+        } else if (args.length == 2) {
+            final String subcommand = args[0].toLowerCase();
+            if ((subcommand.equals("add") && player.hasPermission(Permission.PERMISSION_GRANT_ADD)) ||
+                (subcommand.equals("check") && player.hasPermission(Permission.PERMISSION_GRANT_CHECK))) {
+                return TabCompletions.completePlayers(player, args[1], Collections.emptyList());
+            }
         }
-        return TabCompletions.completePlayers(player, String.join(",", args).trim(), Collections.emptyList());
+        return Collections.emptyList();
     }
 
 }

Core/src/main/java/com/plotsquared/core/command/MainCommand.java

@@ -283,32 +283,41 @@ public class MainCommand extends Command {
         }
     }
 
-    private CompletableFuture<Optional<CommandExecutionData>> preparePlotArgument(@Nullable Plot newPlot,
-                                                                        @Nonnull CommandExecutionData data,
-                                                                                  @Nullable PlotArea area) {
-        if (newPlot != null && (data.player() instanceof ConsolePlayer
-                || (area != null && area.equals(newPlot.getArea()))
-                || data.player().hasPermission(Permission.PERMISSION_ADMIN)
-                || data.player().hasPermission(Permission.PERMISSION_ADMIN_AREA_SUDO))
-                && !newPlot.isDenied(data.player().getUUID())) {
-            return fetchPlotCenterLocation(newPlot)
-                    .thenApply(newLoc -> {
-                        if (!data.player().canTeleport(newLoc)) {
-                            data.player().sendMessage(TranslatableCaption.of("border.denied"));
-                            return Optional.empty();
-                        }
-                        // Save meta
-                        var originalCommandMeta = setCommandScope(data.player(), new TemporaryCommandMeta(newLoc, newPlot));
-                        return Optional.of(new CommandExecutionData(
-                                data.player(),
-                                Arrays.copyOfRange(data.args(), 1, data.args().length), // Trimmed command
-                                data.confirm(),
-                                data.whenDone(),
-                                originalCommandMeta
-                        ));
-                    });
+    private CompletableFuture<Optional<CommandExecutionData>> preparePlotArgument(
+            @Nullable Plot newPlot,
+            @Nonnull CommandExecutionData data,
+            @Nullable PlotArea area
+    ) {
+        if (newPlot == null) {
+            return CompletableFuture.completedFuture(Optional.of(data));
         }
-        return CompletableFuture.completedFuture(Optional.of(data));
+        final PlotPlayer<?> player = data.player();
+        final boolean isAdmin = player instanceof ConsolePlayer || player.hasPermission(Permission.PERMISSION_ADMIN);
+        final boolean isDenied = newPlot.isDenied(player.getUUID());
+        if (!isAdmin) {
+            if (isDenied) {
+                throw new CommandException(TranslatableCaption.of("deny.cannot_interact"));
+            }
+            if (area != null && area.equals(newPlot.getArea()) && !player.hasPermission(Permission.PERMISSION_ADMIN_AREA_SUDO)) {
+                return CompletableFuture.completedFuture(Optional.of(data));
+            }
+        }
+        return fetchPlotCenterLocation(newPlot)
+                .thenApply(newLoc -> {
+                    if (!player.canTeleport(newLoc)) {
+                        player.sendMessage(TranslatableCaption.of("border.denied"));
+                        return Optional.empty();
+                    }
+                    // Save meta
+                    var originalCommandMeta = setCommandScope(player, new TemporaryCommandMeta(newLoc, newPlot));
+                    return Optional.of(new CommandExecutionData(
+                            player,
+                            Arrays.copyOfRange(data.args(), 1, data.args().length), // Trimmed command
+                            data.confirm(),
+                            data.whenDone(),
+                            originalCommandMeta
+                    ));
+                });
     }
 
     private Optional<CommandExecutionData> prepareFlagArgument(@Nonnull CommandExecutionData data, @Nonnull PlotArea area) {

Core/src/main/java/com/plotsquared/core/util/placeholders/PlaceholderRegistry.java

@@ -49,10 +49,12 @@ import java.util.Collection;
 import java.util.Collections;
 import java.util.Locale;
 import java.util.Map;
+import java.util.Set;
 import java.util.TimeZone;
 import java.util.UUID;
 import java.util.concurrent.TimeUnit;
 import java.util.function.BiFunction;
+import java.util.stream.Collectors;
 
 /**
  * Registry that contains {@link Placeholder placeholders}
@@ -127,6 +129,22 @@ public final class PlaceholderRegistry {
             }
             return legacyComponent(TranslatableCaption.of("info.unknown"), player);
         });
+        this.createPlaceholder("currentplot_owners", (player, plot) -> {
+            if (plot.getFlag(ServerPlotFlag.class)) {
+                return legacyComponent(TranslatableCaption.of("info.server"), player);
+            }
+            final Set<UUID> plotOwners = plot.getOwners();
+            if (plotOwners.isEmpty()) {
+                return legacyComponent(TranslatableCaption.of("generic.generic_unowned"), player);
+            }
+            return plotOwners.stream().map(PlotSquared.platform().playerManager()::getUsernameCaption).map(f -> {
+                try {
+                    return f.get(Settings.UUID.BLOCKING_TIMEOUT, TimeUnit.MILLISECONDS).getComponent(player);
+                } catch (final Exception ignored) {
+                    return legacyComponent(TranslatableCaption.of("info.unknown"), player);
+                }
+            }).collect(Collectors.joining(", "));
+        });
         this.createPlaceholder("currentplot_members", (player, plot) -> {
             if (plot.getMembers().isEmpty() && plot.getTrusted().isEmpty()) {
                 return legacyComponent(TranslatableCaption.of("info.none"), player);
@@ -186,6 +204,9 @@ public final class PlaceholderRegistry {
         this.createPlaceholder("currentplot_x", (player, plot) -> Integer.toString(plot.getId().getX()));
         this.createPlaceholder("currentplot_y", (player, plot) -> Integer.toString(plot.getId().getY()));
         this.createPlaceholder("currentplot_xy", (player, plot) -> plot.getId().toString());
+        this.createPlaceholder("currentplot_abs_x", (player, plot) -> Integer.toString(plot.getId().getX()), true);
+        this.createPlaceholder("currentplot_abs_y", (player, plot) -> Integer.toString(plot.getId().getY()), true);
+        this.createPlaceholder("currentplot_abs_xy", (player, plot) -> plot.getId().toString(), true);
         this.createPlaceholder("currentplot_rating", (player, plot) -> {
             if (Double.isNaN(plot.getAverageRating())) {
                 return legacyComponent(TranslatableCaption.of("placeholder.nan"), player);
@@ -235,7 +256,23 @@ public final class PlaceholderRegistry {
             final @NonNull String key,
             final @NonNull BiFunction<PlotPlayer<?>, Plot, String> placeholderFunction
     ) {
-        this.registerPlaceholder(new PlotSpecificPlaceholder(key) {
+        this.createPlaceholder(key, placeholderFunction, false);
+    }
+
+    /**
+     * Create a functional placeholder
+     *
+     * @param key                 Placeholder key
+     * @param placeholderFunction Placeholder generator. Cannot return null
+     * @param requireAbsolute     If the plot given to the placeholder should be the absolute (not base) plot
+     * @since TODO
+     */
+    public void createPlaceholder(
+            final @NonNull String key,
+            final @NonNull BiFunction<PlotPlayer<?>, Plot, String> placeholderFunction,
+            final boolean requireAbsolute
+    ) {
+        this.registerPlaceholder(new PlotSpecificPlaceholder(key, requireAbsolute) {
             @Override
             public @NonNull String getValue(final @NonNull PlotPlayer<?> player, final @NonNull Plot plot) {
                 return placeholderFunction.apply(player, plot);

Core/src/main/java/com/plotsquared/core/util/placeholders/PlotSpecificPlaceholder.java

@@ -27,14 +27,28 @@ import org.checkerframework.checker.nullness.qual.NonNull;
  */
 public abstract class PlotSpecificPlaceholder extends Placeholder {
 
+    private final boolean requireAbsolute;
+
     public PlotSpecificPlaceholder(final @NonNull String key) {
+        this(key, false);
+    }
+
+    /**
+     * Create a functional placeholder
+     *
+     * @param key             Placeholder key
+     * @param requireAbsolute If the plot given to the placeholder should be the absolute (not base) plot
+     * @since TODO
+     */
+    public PlotSpecificPlaceholder(final @NonNull String key, final boolean requireAbsolute) {
         super(key);
+        this.requireAbsolute = requireAbsolute;
     }
 
     @Override
     public @NonNull
     final String getValue(final @NonNull PlotPlayer<?> player) {
-        final Plot plot = player.getCurrentPlot();
+        final Plot plot = requireAbsolute ? player.getLocation().getPlotAbs() : player.getCurrentPlot();
         if (plot == null) {
             return "";
         }

Core/src/main/resources/lang/messages_en.json

@@ -415,6 +415,7 @@
   "deny.denied_added": "<prefix><dark_aqua>You successfully denied the player from this plot.</dark_aqua>",
   "deny.no_enter": "<prefix><red>You are denied from the plot <red><gold><plot></gold><red> and therefore not allowed to enter.</red>",
   "deny.you_got_denied": "<prefix><red>You are denied from the plot you were previously on, and got teleported to spawn.</red>",
+  "deny.cannot_interact": "<prefix><red>You are denied from the plot <red><gold><plot></gold><red> and therefore cannot interact with it.</red>",
   "deny.cant_remove_owner": "<prefix><red>You can't remove the plot owner.</red>",
   "kick.player_not_in_plot": "<prefix><red>The player <gray><player></gray> is not on this plot.</red>",
   "kick.cannot_kick_player": "<prefix><red>You cannot kick the player <gray><player></gray>.</red>",

gradle/libs.versions.toml

@@ -2,21 +2,21 @@
 # Platform expectations
 paper = "1.20.4-R0.1-SNAPSHOT"
 guice = "7.0.0"
-spotbugs = "4.9.3"
+spotbugs = "4.9.4"
 checkerqual = "3.49.5"
 gson = "2.10"
 guava = "31.1-jre"
 snakeyaml = "2.0"
-adventure = "4.23.0"
+adventure = "4.24.0"
 adventure-bukkit = "4.4.1"
 log4j = "2.19.0"
 
 # Plugins
 worldedit = "7.2.20"
-fawe = "2.13.0"
+fawe = "2.13.1"
 placeholderapi = "2.11.6"
 luckperms = "5.5"
-essentialsx = "2.21.1"
+essentialsx = "2.21.2"
 mvdwapi = "3.1.1"
 
 # Third party
@@ -33,7 +33,7 @@ vault = "1.7.1"
 serverlib = "2.3.7"
 
 # Gradle plugins
-shadow = "8.3.8"
+shadow = "8.3.9"
 grgit = "4.1.1"
 spotless = "7.2.1"
 publish = "0.34.0"

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,6 @@
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-9.0.0-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-bin.zip
 networkTimeout=10000
 validateDistributionUrl=true
 zipStoreBase=GRADLE_USER_HOME

gradlew

@@ -1,7 +1,7 @@
 #!/bin/sh
 
 #
-# Copyright © 2015 the original authors.
+# Copyright © 2015-2021 the original authors.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.