Merge pull request #120 from BentoBoxWorld/develop

Version 1.13.0
BentoBoxWorld · Apr 16, 2023 · 4ae619c · 4ae619c
2 parents 076b71c + 9e57851
commit 4ae619c
Show file tree

Hide file tree

Showing 14 changed files with 332 additions and 81 deletions.
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -14,11 +14,11 @@ jobs:
       - uses: actions/checkout@v2
         with:
           fetch-depth: 0  # Shallow clones should be disabled for a better relevancy of analysis
-      - name: Set up JDK 16
+      - name: Set up JDK 17
         uses: actions/setup-java@v2
         with:
           distribution: 'adopt'
-          java-version: '16'
+          java-version: '17'
       - name: Cache SonarCloud packages
         uses: actions/cache@v2
         with:

diff --git a/pom.xml b/pom.xml
@@ -54,19 +54,19 @@
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-        <java.version>16</java.version>
+        <java.version>17</java.version>
         <!-- Non-minecraft related dependencies -->
         <powermock.version>2.0.9</powermock.version>
         <!-- More visible way how to change dependency versions -->
-        <spigot.version>1.17-R0.1-SNAPSHOT</spigot.version>
-        <bentobox.version>1.18.0-SNAPSHOT</bentobox.version>
+        <spigot.version>1.19.4-R0.1-SNAPSHOT</spigot.version>
+        <bentobox.version>1.23.0</bentobox.version>
         <level.version>2.7.0-SNAPSHOT</level.version>
         <!-- Revision variable removes warning about dynamic version -->
         <revision>${build.version}-SNAPSHOT</revision>
         <!-- Do not change unless you want different name for local builds. -->
         <build.number>-LOCAL</build.number>
         <!-- This allows to change between versions. -->
-        <build.version>1.12.0</build.version>
+        <build.version>1.13.0</build.version>
         <!-- Sonar Cloud -->
         <sonar.projectKey>BentoBoxWorld_Warps</sonar.projectKey>
         <sonar.organization>bentobox-world</sonar.organization>
@@ -138,11 +138,6 @@
             <version>${spigot.version}</version>
             <scope>provided</scope>
         </dependency>
-        <dependency>
-            <groupId>org.spigotmc</groupId>
-            <artifactId>plugin-annotations</artifactId>
-            <version>1.2.3-SNAPSHOT</version>
-        </dependency>
         <!-- Mockito (Unit testing) -->
         <dependency>
             <groupId>org.mockito</groupId>
@@ -234,6 +229,7 @@
                 <version>3.0.0-M5</version>
                 <configuration>
                     <argLine>
+                        ${argLine}
                         --add-opens java.base/java.lang=ALL-UNNAMED
                         --add-opens java.base/java.math=ALL-UNNAMED
                         --add-opens java.base/java.io=ALL-UNNAMED
@@ -316,7 +312,7 @@
             <plugin>
                 <groupId>org.jacoco</groupId>
                 <artifactId>jacoco-maven-plugin</artifactId>
-                <version>0.8.3</version>
+                <version>0.8.7</version>
                 <configuration>
                     <append>true</append>
                     <excludes>
@@ -327,16 +323,21 @@
                 </configuration>
                 <executions>
                     <execution>
-                        <id>pre-unit-test</id>
+                        <id>prepare-agent</id>
                         <goals>
                             <goal>prepare-agent</goal>
                         </goals>
                     </execution>
                     <execution>
-                        <id>post-unit-test</id>
+                        <id>report</id>
                         <goals>
                             <goal>report</goal>
                         </goals>
+                        <configuration>
+                            <formats>
+                                <format>XML</format>
+                            </formats>
+                        </configuration>
                     </execution>
                 </executions>
             </plugin>

diff --git a/src/main/java/world/bentobox/warps/Warp.java b/src/main/java/world/bentobox/warps/Warp.java
@@ -7,10 +7,14 @@
 import java.util.UUID;
 
 import org.bukkit.Bukkit;
+import org.bukkit.Material;
 import org.bukkit.World;
 
 import world.bentobox.bentobox.api.addons.Addon;
 import world.bentobox.bentobox.api.configuration.Config;
+import world.bentobox.bentobox.api.flags.Flag;
+import world.bentobox.bentobox.api.flags.clicklisteners.CycleClick;
+import world.bentobox.bentobox.managers.RanksManager;
 import world.bentobox.bentobox.util.Util;
 import world.bentobox.level.Level;
 import world.bentobox.warps.commands.WarpCommand;
@@ -71,6 +75,11 @@ public class Warp extends Addon {
      */
     private Config<Settings> settingsConfig;
 
+    /**
+     * Create Warp Flag
+     */
+    private Flag createWarpFlag;
+
     // ---------------------------------------------------------------------
     // Section: Methods
     // ---------------------------------------------------------------------
@@ -146,6 +155,18 @@ public void onEnable() {
             logWarning("Addon did not hook into anything and is not running stand-alone");
             this.setState(State.DISABLED);
         }
+
+        this.createWarpFlag = new Flag.Builder("PLACE_WARP", Material.OAK_SIGN)
+                .addon(this)
+                .defaultRank(RanksManager.MEMBER_RANK)
+                .clickHandler(new CycleClick("PLACE_WARP",
+                    RanksManager.MEMBER_RANK,
+                    RanksManager.OWNER_RANK))
+                .defaultSetting(false)
+                .mode(Flag.Mode.EXPERT)
+                .build();
+
+        getPlugin().getFlagsManager().registerFlag(this, this.createWarpFlag);
     }
 
 
@@ -213,6 +234,13 @@ public Settings getSettings() {
         return settings;
     }
 
+    /**
+     * @return the createWarpFlag
+     */
+    public Flag getCreateWarpFlag() {
+        return createWarpFlag;
+    }
+
     /**
      * Get the island level
      * @param world - world
@@ -224,8 +252,11 @@ public Long getLevel(World world, UUID uniqueId) {
         String name = this.getPlugin().getIWM().getAddon(world).map(g -> g.getDescription().getName()).orElse("");
         return this.getPlugin().getAddonsManager().getAddonByName(LEVEL_ADDON_NAME)
                 .map(l -> {
-                    if (!name.isEmpty() && ((Level) l).getSettings().getGameModes().contains(name)) {
-                        return ((Level) l).getIslandLevel(world, uniqueId);
+                    final Level addon = (Level) l;
+                    //getGameModes is a list of gamemodes that Level is DISABLED in,
+                    //so we need the opposite of the contains.
+                    if (!name.isEmpty() && !addon.getSettings().getGameModes().contains(name)) {
+                        return addon.getIslandLevel(world, uniqueId);
                     }
                     return null;
                 }).orElse(null);

diff --git a/src/main/java/world/bentobox/warps/WarpsPladdon.java b/src/main/java/world/bentobox/warps/WarpsPladdon.java
@@ -1,15 +1,10 @@
 package world.bentobox.warps;
 
-import org.bukkit.plugin.java.annotation.dependency.Dependency;
-import org.bukkit.plugin.java.annotation.plugin.ApiVersion;
-import org.bukkit.plugin.java.annotation.plugin.Plugin;
 
 import world.bentobox.bentobox.api.addons.Addon;
 import world.bentobox.bentobox.api.addons.Pladdon;
 
-@Plugin(name="Pladdon", version="1.0")
-@ApiVersion(ApiVersion.Target.v1_16)
-@Dependency(value = "BentoBox")
+
 public class WarpsPladdon extends Pladdon {
 
     @Override

diff --git a/src/main/java/world/bentobox/warps/config/Settings.java b/src/main/java/world/bentobox/warps/config/Settings.java
@@ -23,6 +23,13 @@ public class Settings implements ConfigObject
     @ConfigEntry(path = "warplevelrestriction")
     private int warpLevelRestriction = 10;
 
+    @ConfigComment("")
+    @ConfigComment("Should warps be removed when the island protection settings")
+    @ConfigComment("change, and the owner of the warp does no longer have")
+    @ConfigComment("the correct rank")
+    @ConfigEntry(path = "removeExistingWarpsWhenFlagChanges")
+    private boolean removeExistingWarpsWhenFlagChanges = false;
+
     @ConfigComment("")
     @ConfigComment("Text that player must put on sign to make it a warp sign")
     @ConfigComment("Not case sensitive!")
@@ -55,7 +62,6 @@ public class Settings implements ConfigObject
     @ConfigEntry(path = "warps-command")
     String warpsCommand = "warps";
 
-
     // ---------------------------------------------------------------------
     // Section: Constructor
     // ---------------------------------------------------------------------
@@ -198,4 +204,18 @@ public String getWarpsCommand() {
     public void setWarpsCommand(String warpsCommand) {
         this.warpsCommand = warpsCommand;
     }
+
+    /**
+     * @return the removeExistingWarpsWhenFlagChanges
+     */
+    public boolean getRemoveExistingWarpsWhenFlagChanges() {
+        return removeExistingWarpsWhenFlagChanges;
+    }
+
+    /**
+     * @param removeExistingWarpsWhenFlagChanges the removeExistingWarpsWhenFlagChanges to set
+     */
+    public void setRemoveExistingWarpsWhenFlagChanges(boolean removeExistingWarpsWhenFlagChanges) {
+        this.removeExistingWarpsWhenFlagChanges = removeExistingWarpsWhenFlagChanges;
+    }
 }
diff --git a/src/main/java/world/bentobox/warps/listeners/WarpSignsListener.java b/src/main/java/world/bentobox/warps/listeners/WarpSignsListener.java
@@ -1,10 +1,7 @@
 package world.bentobox.warps.listeners;
 
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.Map;
-import java.util.Objects;
-import java.util.UUID;
+import java.util.*;
+import java.util.stream.Collectors;
 
 import org.bukkit.Bukkit;
 import org.bukkit.ChatColor;
@@ -25,9 +22,11 @@
 
 import world.bentobox.bentobox.BentoBox;
 import world.bentobox.bentobox.api.events.addon.AddonEvent;
+import world.bentobox.bentobox.api.events.flags.FlagProtectionChangeEvent;
 import world.bentobox.bentobox.api.events.team.TeamKickEvent;
 import world.bentobox.bentobox.api.events.team.TeamLeaveEvent;
 import world.bentobox.bentobox.api.user.User;
+import world.bentobox.bentobox.database.objects.Island;
 import world.bentobox.bentobox.util.Util;
 import world.bentobox.warps.Warp;
 import world.bentobox.warps.event.WarpRemoveEvent;
@@ -114,7 +113,6 @@ public void onSignBreak(BlockBreakEvent e) {
             return;
         }
         User user = User.getInstance(e.getPlayer());
-        if (user == null) return;
         UUID owner = addon.getWarpSignsManager().getWarpOwnerUUID(b.getLocation()).orElse(null);
         if (isPlayersSign(e.getPlayer(), b, inWorld)) {
             addon.getWarpSignsManager().removeWarp(b.getLocation());
@@ -164,6 +162,13 @@ public void onSignWarpCreate(SignChangeEvent e) {
                 e.setLine(0, ChatColor.RED + addon.getSettings().getWelcomeLine());
                 return;
             }
+
+            if(!hasCorrectIslandRank(b, user)) {
+                e.setLine(0, ChatColor.RED + addon.getSettings().getWelcomeLine());
+                user.sendMessage("warps.error.not-correct-rank");
+                return;
+            }
+
             // Check if the player already has a sign
             final Location oldSignLoc = addon.getWarpSignsManager().getWarp(b.getWorld(), user.getUniqueId());
             if (oldSignLoc != null) {
@@ -192,6 +197,46 @@ public void onSignWarpCreate(SignChangeEvent e) {
 
     }
 
+    private boolean hasCorrectIslandRank(Block b, User user) {
+        final Optional<Island> islandOpt = plugin.getIslands().getIslandAt(b.getLocation());
+
+        if(islandOpt.isEmpty()) return false;
+
+        final Island island = islandOpt.get();
+
+        final int userRank = island.getRank(user);
+
+        return userRank >= island.getFlag(addon.getCreateWarpFlag());
+    }
+
+    @EventHandler
+    public void onFlagChange(FlagProtectionChangeEvent e) {
+        if(!e.getEditedFlag().equals(addon.getCreateWarpFlag())) return;
+        if(!addon.getSettings().getRemoveExistingWarpsWhenFlagChanges()) return;
+
+        final Island island = e.getIsland();
+
+        final Map<UUID, Location> islandWarps = addon
+                .getWarpSignsManager()
+                .getWarpMap(island.getWorld())
+                .entrySet()
+                .stream()
+                .filter(x -> island.inIslandSpace(x.getValue()))
+                .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
+
+        for(Map.Entry<UUID, Location> entry : islandWarps.entrySet()) {
+            if(island.getRank(entry.getKey()) >= e.getSetTo()) continue;
+
+            //The user has a lower rank than the new set value.
+            //We need to remove the warp.
+            addon.getWarpSignsManager().removeWarp(island.getWorld(), entry.getKey());
+
+            if(Bukkit.getPlayer(entry.getKey()) != null) {
+                Objects.requireNonNull(User.getInstance(entry.getKey())).sendMessage(WARPS_DEACTIVATE);
+            }
+        }
+    }
+
     private boolean noLevelOrIsland(User user, World world) {
         // Get level if level addon is available
         Long level = addon.getLevel(Util.getWorld(world), user.getUniqueId());

diff --git a/src/main/java/world/bentobox/warps/managers/WarpSignsManager.java b/src/main/java/world/bentobox/warps/managers/WarpSignsManager.java
@@ -27,7 +27,6 @@
 import org.bukkit.block.Sign;
 import org.bukkit.entity.Player;
 import org.bukkit.event.player.PlayerTeleportEvent.TeleportCause;
-import org.bukkit.permissions.PermissionAttachmentInfo;
 import org.eclipse.jdt.annotation.NonNull;
 import org.eclipse.jdt.annotation.Nullable;
 
@@ -246,8 +245,8 @@ public void removeWarp(Location loc) {
             if (en.getValue().equals(loc)) {
                 // Inform player
                 Optional.ofNullable(addon.getServer().getPlayer(en.getKey()))
-                        .map(User::getInstance)
-                        .ifPresent(user -> user.sendMessage("warps.sign-removed"));
+                .map(User::getInstance)
+                .ifPresent(user -> user.sendMessage("warps.sign-removed"));
                 // Remove sign from warp panel cache
                 addon.getSignCacheManager().removeWarp(loc.getWorld(), en.getKey());
                 it.remove();
@@ -321,8 +320,8 @@ public SignCacheItem getSignInfo(@NonNull World world, @NonNull UUID uuid) {
         if (!prefix.isEmpty())
         {
             icon = Material.matchMaterial(
-                Utils.getPermissionValue(User.getInstance(uuid), prefix + "island.warp",
-                    Material.OAK_SIGN.name()));
+                    Utils.getPermissionValue(User.getInstance(uuid), prefix + "island.warp",
+                            Material.OAK_SIGN.name()));
         }
         else
         {
@@ -351,21 +350,33 @@ private void warpPlayer(@NonNull User user, @NonNull Location inFront, @NonNull
         float yaw = Util.blockFaceToFloat(directionFacing);
         final Location actualWarp = new Location(inFront.getWorld(), inFront.getBlockX() + 0.5D, inFront.getBlockY(),
                 inFront.getBlockZ() + 0.5D, yaw, 30F);
-        Util.teleportAsync(user.getPlayer(), actualWarp, TeleportCause.COMMAND);
-        User warpOwner = Objects.requireNonNull(User.getInstance(signOwner));
-        // Hide invisible players
-        if (warpOwner.isOnline() && !warpOwner.getPlayer().canSee(user.getPlayer())) {
-            return;
-        }
-        if (pvp) {
-            user.sendMessage("protection.flags.PVP_OVERWORLD.enabled");
-            user.getWorld().playSound(Objects.requireNonNull(user.getLocation()), Sound.ENTITY_ARROW_HIT, 1F, 1F);
-        } else {
-            user.getWorld().playSound(Objects.requireNonNull(user.getLocation()), Sound.ENTITY_BAT_TAKEOFF, 1F, 1F);
-        }
-        if (!warpOwner.equals(user)) {
-            warpOwner.sendMessage("warps.player-warped", "[name]", user.getName());
-        }
+        //BentoBox prevents people from teleporting to an island when
+        //the user is banned from the island for example.
+        //By checking if the teleport succeeded before sending the messages,
+        //we prevent issues where no one teleported, but people still
+        //get messages about it.
+        Util.teleportAsync(user.getPlayer(), actualWarp, TeleportCause.COMMAND).thenAccept(tpResult -> {
+            if(Boolean.FALSE.equals(tpResult)) return;
+
+            User warpOwner = Objects.requireNonNull(User.getInstance(signOwner));
+            // Hide invisible players
+            if (warpOwner.isOnline() && !warpOwner.getPlayer().canSee(user.getPlayer())) {
+                return;
+            }
+            if (pvp) {
+                user.sendMessage("protection.flags.PVP_OVERWORLD.enabled");
+                user.getWorld().playSound(Objects.requireNonNull(user.getLocation()), Sound.ENTITY_ARROW_HIT, 1F, 1F);
+            } else {
+                user.getWorld().playSound(Objects.requireNonNull(user.getLocation()), Sound.ENTITY_BAT_TAKEOFF, 1F, 1F);
+            }
+            if (!warpOwner.equals(user)) {
+                final String gameMode = BentoBox
+                        .getInstance()
+                        .getIWM()
+                        .getFriendlyName(actualWarp.getWorld());
+                warpOwner.sendMessage("warps.player-warped", "[name]", user.getName(), "[gamemode]", gameMode);
+            }
+        });
     }
 
     /**