GH-835 Add permission-based access to warps

eternalcore-api/src/main/java/com/eternalcode/core/feature/warp/Warp.java

@@ -2,10 +2,16 @@
 
 import org.bukkit.Location;
 
+import java.util.List;
+
 public interface Warp {
 
     Location getLocation();
 
     String getName();
 
+    List<String> getPermissions();
+
+    boolean hasPermission(String permission);
+
 }

eternalcore-api/src/main/java/com/eternalcode/core/feature/warp/WarpService.java

@@ -4,18 +4,22 @@
 
 import java.util.Collection;
 import java.util.Optional;
+import org.jetbrains.annotations.ApiStatus.Experimental;
 
 public interface WarpService {
 
     Warp createWarp(String name, Location location);
 
     void removeWarp(String warp);
 
-    boolean warpExists(String name);
+    void addPermissions(String warp, String... permissions);
 
-    Optional<Warp> findWarp(String name);
+    @Experimental
+    void removePermission(String warp, String permission);
+
+    boolean isExist(String name);
 
-    Collection<String> getNamesOfWarps();
+    Optional<Warp> findWarp(String name);
 
-    boolean hasWarps();
+    Collection<Warp> getWarps();
 }

eternalcore-core/src/main/java/com/eternalcode/core/configuration/implementation/LocationsConfiguration.java

@@ -1,8 +1,8 @@
 package com.eternalcode.core.configuration.implementation;
 
+import com.eternalcode.commons.bukkit.position.Position;
 import com.eternalcode.core.configuration.ReloadableConfig;
 import com.eternalcode.core.injector.annotations.component.ConfigurationFile;
-import com.eternalcode.commons.bukkit.position.Position;
 import net.dzikoysk.cdn.entity.Description;
 import net.dzikoysk.cdn.entity.Exclude;
 import net.dzikoysk.cdn.source.Resource;
@@ -21,7 +21,8 @@ public class LocationsConfiguration implements ReloadableConfig {
     @Description("# This is spawn location, for your own safety, please don't touch it.")
     public Position spawn = EMPTY_POSITION;
 
-    @Description("# These are warp locations, for your own safety, please don't touch it.")
+    @Description("# Warps now are stored in warps.yml. This is deprecated.")
+    @Deprecated
     public Map<String, Position> warps = new HashMap<>();
 
     @Description("# This is jail location, for your own safety, please don't touch it.")

eternalcore-core/src/main/java/com/eternalcode/core/configuration/implementation/PluginConfiguration.java

@@ -5,15 +5,13 @@
 import com.eternalcode.core.feature.afk.AfkSettings;
 import com.eternalcode.core.feature.automessage.AutoMessageSettings;
 import com.eternalcode.core.feature.chat.ChatSettings;
-import com.eternalcode.core.feature.jail.JailSettings;
 import com.eternalcode.core.feature.helpop.HelpOpSettings;
+import com.eternalcode.core.feature.jail.JailSettings;
 import com.eternalcode.core.feature.randomteleport.RandomTeleportSettingsImpl;
 import com.eternalcode.core.feature.spawn.SpawnSettings;
 import com.eternalcode.core.injector.annotations.Bean;
 import com.eternalcode.core.injector.annotations.component.ConfigurationFile;
 import com.eternalcode.core.feature.teleportrequest.TeleportRequestSettings;
-import java.util.LinkedHashMap;
-import java.util.Set;
 import net.dzikoysk.cdn.entity.Contextual;
 import net.dzikoysk.cdn.entity.Description;
 import net.dzikoysk.cdn.entity.Exclude;
@@ -24,7 +22,9 @@
 
 import java.io.File;
 import java.time.Duration;
+import java.util.LinkedHashMap;
 import java.util.Map;
+import java.util.Set;
 
 @ConfigurationFile
 public class PluginConfiguration implements ReloadableConfig {
@@ -352,7 +352,6 @@ public static class Warp {
 
         @Description("# Texture of the item (only for PLAYER_HEAD material)")
         public String itemTexture = "eyJ0ZXh0dXJlcyI6eyJTS0lOIjp7InVybCI6Imh0dHA6Ly90ZXh0dXJlcy5taW5lY3JhZnQubmV0L3RleHR1cmUvNzk4ODVlODIzZmYxNTkyNjdjYmU4MDkwOTNlMzNhNDc2ZTI3NDliNjU5OGNhNGEyYTgxZWU2OTczODAzZmI2NiJ9fX0=";
-
     }
 
     @Description({ " ", "# Butcher" })

eternalcore-core/src/main/java/com/eternalcode/core/feature/warp/WarpImpl.java

@@ -2,16 +2,23 @@
 
 import com.eternalcode.commons.bukkit.position.Position;
 import com.eternalcode.commons.bukkit.position.PositionAdapter;
+import java.util.ArrayList;
 import org.bukkit.Location;
 
-class WarpImpl implements Warp {
+import java.util.Collections;
+import java.util.List;
+
+@SuppressWarnings("LombokSetterMayBeUsed")
+public class WarpImpl implements Warp {
 
     private final String name;
     private final Position position;
+    private List<String> permissions;
 
-    WarpImpl(String name, Position position) {
+    public WarpImpl(String name, Position position, List<String> permissions) {
         this.name = name;
         this.position = position;
+        this.permissions = new ArrayList<>(permissions);
     }
 
     @Override
@@ -23,4 +30,18 @@ public String getName() {
     public Location getLocation() {
         return PositionAdapter.convert(this.position);
     }
+
+    @Override
+    public List<String> getPermissions() {
+        return Collections.unmodifiableList(this.permissions);
+    }
+
+    @Override
+    public boolean hasPermission(String permission) {
+        return this.permissions.contains(permission);
+    }
+
+    public void setPermissions(List<String> permissions) {
+        this.permissions = permissions;
+    }
 }

eternalcore-core/src/main/java/com/eternalcode/core/feature/warp/WarpInventory.java

@@ -15,15 +15,16 @@
 import dev.triumphteam.gui.builder.item.ItemBuilder;
 import dev.triumphteam.gui.guis.Gui;
 import dev.triumphteam.gui.guis.GuiItem;
-import java.util.Collections;
-import java.util.List;
-import java.util.Optional;
 import net.kyori.adventure.text.Component;
 import net.kyori.adventure.text.minimessage.MiniMessage;
 import org.bukkit.Material;
 import org.bukkit.Server;
 import org.bukkit.entity.Player;
 
+import java.util.Collections;
+import java.util.List;
+import java.util.Optional;
+
 @Service
 public class WarpInventory {
 
@@ -80,7 +81,6 @@ private Gui createInventory(Language language) {
             }
         }
 
-
         Gui gui = Gui.gui()
             .title(this.miniMessage.deserialize(warpSection.title()))
             .rows(rowsCount)
@@ -198,13 +198,11 @@ public void openInventory(Player player, Language language) {
     }
 
     public void addWarp(Warp warp) {
-
-        if (!this.warpManager.warpExists(warp.getName())) {
+        if (!this.warpManager.isExist(warp.getName())) {
             return;
         }
 
         for (Language language : this.translationManager.getAvailableLanguages()) {
-
             AbstractTranslation translation = (AbstractTranslation) this.translationManager.getMessages(language);
             Translation.WarpSection.WarpInventorySection warpSection = translation.warp().warpInventory();
 
@@ -245,7 +243,7 @@ public void addWarp(Warp warp) {
 
     public boolean removeWarp(String warpName) {
 
-        if (!this.warpManager.warpExists(warpName)) {
+        if (!this.warpManager.isExist(warpName)) {
             return false;
         }
 

eternalcore-core/src/main/java/com/eternalcode/core/feature/warp/WarpPermissionController.java

@@ -0,0 +1,63 @@
+package com.eternalcode.core.feature.warp;
+
+import com.eternalcode.annotations.scan.feature.FeatureDocs;
+import com.eternalcode.core.configuration.implementation.PluginConfiguration;
+import com.eternalcode.core.feature.warp.event.PreWarpTeleportEvent;
+import com.eternalcode.core.injector.annotations.Inject;
+import com.eternalcode.core.injector.annotations.component.Controller;
+import com.eternalcode.core.notice.NoticeService;
+import org.bukkit.entity.Player;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.Listener;
+
+import java.util.List;
+import java.util.Optional;
+import java.util.UUID;
+
+@FeatureDocs(
+    description = "Check if a player has permission to use a specific warp",
+    name = "Warp permission"
+)
+@Controller
+public class WarpPermissionController implements Listener {
+
+    private final NoticeService noticeService;
+    private final PluginConfiguration config;
+
+    @Inject
+    public WarpPermissionController(NoticeService noticeService, PluginConfiguration config) {
+        this.noticeService = noticeService;
+        this.config = config;
+    }
+
+    @EventHandler
+    void onWarpPreTeleportation(PreWarpTeleportEvent event) {
+        Player player = event.getPlayer();
+        UUID uniqueId = player.getUniqueId();
+        Warp warp = event.getWarp();
+
+        this.checkWarpPermission(event, warp, player, uniqueId);
+    }
+
+    private void checkWarpPermission(PreWarpTeleportEvent event, Warp warp, Player player, UUID uniqueId) {
+        List<String> permissions = warp.getPermissions();
+        Optional<String> isPlayerAllowedToUseWarp = permissions
+            .stream()
+            .filter(player::hasPermission)
+            .findAny();
+
+        if (isPlayerAllowedToUseWarp.isPresent() || permissions.isEmpty()) {
+            return;
+        }
+
+        event.setCancelled(true);
+
+        this.noticeService.create()
+            .player(uniqueId)
+            .placeholder("{WARP}", warp.getName())
+            .placeholder("{PERMISSIONS}", String.join(this.config.format.separator, permissions))
+            .notice(translation -> translation.warp().noPermission())
+            .send();
+    }
+
+}