feat: LuckPerms clan contexts (#1)

Author: Riddars

pom.xml

@@ -250,6 +250,12 @@
             <version>1.28.0</version>
             <scope>provided</scope>
         </dependency>
+        <dependency>
+            <groupId>net.luckperms</groupId>
+            <artifactId>api</artifactId>
+            <version>5.4</version>
+            <scope>provided</scope>
+        </dependency>
         <dependency>
             <groupId>biz.princeps</groupId>
             <artifactId>landlord-latest</artifactId>

src/main/java/net/sacredlabyrinth/phaed/simpleclans/Clan.java

@@ -1015,6 +1015,7 @@ public void addPlayerToClan(ClanPlayer cp) {
         if (player != null) {
             SimpleClans.getInstance().getClanManager().updateDisplayName(player);
         }
+        SimpleClans.getInstance().signalContextUpdate(player);
         Bukkit.getPluginManager().callEvent(new PlayerJoinedClanEvent(this, cp));
     }
 
@@ -1054,6 +1055,7 @@ public void removePlayerFromClan(UUID playerUniqueId) {
         if (matched != null) {
             SimpleClans.getInstance().getClanManager().updateDisplayName(matched);
         }
+        SimpleClans.getInstance().signalContextUpdate(matched);
         Bukkit.getPluginManager().callEvent(new PlayerKickedClanEvent(this, cp));
     }
 
@@ -1076,6 +1078,7 @@ public void promote(UUID playerUniqueId) {
 
         // add clan permission
         SimpleClans.getInstance().getPermissionsManager().addClanPermissions(cp);
+        SimpleClans.getInstance().signalContextUpdate(cp.toPlayer());
         Bukkit.getPluginManager().callEvent(new PlayerPromoteEvent(this, cp));
     }
 
@@ -1097,6 +1100,7 @@ public void demote(UUID playerUniqueId) {
 
         // add clan permission
         SimpleClans.getInstance().getPermissionsManager().addClanPermissions(cp);
+        SimpleClans.getInstance().signalContextUpdate(cp.toPlayer());
         Bukkit.getPluginManager().callEvent(new PlayerDemoteEvent(this, cp));
     }
 
@@ -1418,6 +1422,7 @@ public void disband(@Nullable CommandSender sender, boolean announce, boolean fo
                 cp.setLeader(false);
             }
         }
+        SimpleClans.getInstance().signalContextUpdate(this);
 
         Bukkit.getPluginManager().callEvent(new DisbandClanEvent(sender, this));
         clans.remove(this);

src/main/java/net/sacredlabyrinth/phaed/simpleclans/SimpleClans.java

@@ -2,6 +2,7 @@
 
 import co.aikar.commands.BukkitCommandIssuer;
 import net.sacredlabyrinth.phaed.simpleclans.commands.SCCommandManager;
+import net.sacredlabyrinth.phaed.simpleclans.hooks.luckperms.LuckPermsContextHook;
 import net.sacredlabyrinth.phaed.simpleclans.hooks.papi.SimpleClansExpansion;
 import net.sacredlabyrinth.phaed.simpleclans.language.LanguageResource;
 import net.sacredlabyrinth.phaed.simpleclans.listeners.*;
@@ -60,6 +61,7 @@ public class SimpleClans extends JavaPlugin {
     private ProtectionManager protectionManager;
     private ChatManager chatManager;
     private ProxyManager proxyManager;
+    private LuckPermsContextHook luckPermsContextHook;
     private boolean hasUUID;
     private static final Pattern ACF_PLACEHOLDER_PATTERN = Pattern.compile("\\{(?<key>[a-zA-Z]+?)}");
 
@@ -127,6 +129,7 @@ public void onEnable() {
         startTasks();
         startMetrics();
         hookIntoPAPI();
+        hookIntoLuckPerms();
         new UpdateChecker(this).check();
     }
 
@@ -155,6 +158,42 @@ private void hookIntoPAPI() {
         }
     }
 
+    /**
+     * Registers or unregisters the LuckPerms hook, according to the plugin availability
+     * and to the current settings. Can be called at any time, to apply setting changes.
+     */
+    public void hookIntoLuckPerms() {
+        boolean enabled = getPluginManager().isPluginEnabled("LuckPerms")
+                && settingsManager.is(PERMISSIONS_LUCKPERMS_CONTEXTS);
+
+        if (enabled && luckPermsContextHook == null) {
+            getLogger().info("LuckPerms found. Registering contexts...");
+            luckPermsContextHook = new LuckPermsContextHook(this);
+            luckPermsContextHook.register();
+        } else if (!enabled && luckPermsContextHook != null) {
+            luckPermsContextHook.unregister();
+            luckPermsContextHook = null;
+        }
+    }
+
+    /**
+     * Invalidates the LuckPerms contexts of an online player, if the hook is enabled
+     */
+    public void signalContextUpdate(@Nullable Player player) {
+        if (luckPermsContextHook != null && player != null) {
+            luckPermsContextHook.signalContextUpdate(player);
+        }
+    }
+
+    /**
+     * Invalidates the LuckPerms contexts of all online members of a clan, if the hook is enabled
+     */
+    public void signalContextUpdate(@NotNull Clan clan) {
+        if (luckPermsContextHook != null) {
+            luckPermsContextHook.signalContextUpdate(clan);
+        }
+    }
+
     private void startMetrics() {
         Metrics metrics = new Metrics(this, 7131);
         SettingsManager sm = getSettingsManager();
@@ -198,6 +237,9 @@ private void startTasks() {
 
     @Override
     public void onDisable() {
+        if (luckPermsContextHook != null) {
+            luckPermsContextHook.unregister();
+        }
         if (getSettingsManager().is(PERFORMANCE_SAVE_PERIODICALLY)) {
             getStorageManager().saveModified();
         }

src/main/java/net/sacredlabyrinth/phaed/simpleclans/commands/clan/LeaderCommands.java

@@ -163,6 +163,7 @@ public void trust(Player player, Clan clan, @Conditions("same_clan") @Name("memb
                 player.getName()));
         trustedInput.setTrusted(true);
         storage.updateClanPlayer(trustedInput);
+        plugin.signalContextUpdate(trustedInput.toPlayer());
     }
 
     @Subcommand("%untrust")
@@ -188,6 +189,7 @@ public void untrust(Player player, Clan clan, @Conditions("same_clan") @Name("me
                 player.getName()));
         trustedInput.setTrusted(false);
         storage.updateClanPlayer(trustedInput);
+        plugin.signalContextUpdate(trustedInput.toPlayer());
     }
 
     @Subcommand("%rename")

src/main/java/net/sacredlabyrinth/phaed/simpleclans/commands/staff/StaffCommands.java

@@ -119,9 +119,11 @@ public void reload(CommandSender sender) {
         settings.loadAndSave();
         storage.importFromDatabase();
         permissions.loadPermissions();
+        plugin.hookIntoLuckPerms();
 
         for (Clan clan : cm.getClans()) {
             permissions.updateClanPermissions(clan);
+            plugin.signalContextUpdate(clan);
         }
         Bukkit.getPluginManager().callEvent(new ReloadEvent(sender));
 

src/main/java/net/sacredlabyrinth/phaed/simpleclans/hooks/luckperms/ClanContextCalculator.java

@@ -0,0 +1,81 @@
+package net.sacredlabyrinth.phaed.simpleclans.hooks.luckperms;
+
+import net.luckperms.api.context.ContextCalculator;
+import net.luckperms.api.context.ContextConsumer;
+import net.luckperms.api.context.ContextSet;
+import net.luckperms.api.context.ImmutableContextSet;
+import net.sacredlabyrinth.phaed.simpleclans.Clan;
+import net.sacredlabyrinth.phaed.simpleclans.ClanPlayer;
+import net.sacredlabyrinth.phaed.simpleclans.Helper;
+import net.sacredlabyrinth.phaed.simpleclans.managers.ClanManager;
+import org.bukkit.entity.Player;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Exposes clan membership as LuckPerms contexts, allowing permissions to be
+ * granted by clan facts, without SimpleClans creating groups or nodes.
+ * <p>
+ * Provided contexts:
+ * </p>
+ * <ul>
+ *     <li>{@code simpleclans:in-clan} - true/false</li>
+ *     <li>{@code simpleclans:rank} - leader/trusted/member</li>
+ *     <li>{@code simpleclans:tag} - the clan tag, without colors, lowercased</li>
+ * </ul>
+ * Contexts are resolved for online players only.
+ */
+public class ClanContextCalculator implements ContextCalculator<Player> {
+
+    public static final String IN_CLAN_KEY = "simpleclans:in-clan";
+    public static final String RANK_KEY = "simpleclans:rank";
+    public static final String TAG_KEY = "simpleclans:tag";
+
+    private static final String LEADER = "leader";
+    private static final String TRUSTED = "trusted";
+    private static final String MEMBER = "member";
+
+    private final ClanManager clanManager;
+
+    public ClanContextCalculator(@NotNull ClanManager clanManager) {
+        this.clanManager = clanManager;
+    }
+
+    @Override
+    public void calculate(@NotNull Player target, @NotNull ContextConsumer consumer) {
+        ClanPlayer cp = clanManager.getClanPlayer(target.getUniqueId());
+        Clan clan = cp != null ? cp.getClan() : null;
+
+        if (clan == null) {
+            consumer.accept(IN_CLAN_KEY, "false");
+            return;
+        }
+
+        consumer.accept(IN_CLAN_KEY, "true");
+        consumer.accept(RANK_KEY, getRank(cp));
+        consumer.accept(TAG_KEY, Helper.cleanTag(clan.getTag()));
+    }
+
+    @Override
+    public @NotNull ContextSet estimatePotentialContexts() {
+        ImmutableContextSet.Builder builder = ImmutableContextSet.builder();
+        builder.add(IN_CLAN_KEY, "true");
+        builder.add(IN_CLAN_KEY, "false");
+        builder.add(RANK_KEY, LEADER);
+        builder.add(RANK_KEY, TRUSTED);
+        builder.add(RANK_KEY, MEMBER);
+
+        for (Clan clan : clanManager.getClans()) {
+            builder.add(TAG_KEY, Helper.cleanTag(clan.getTag()));
+        }
+
+        return builder.build();
+    }
+
+    @NotNull
+    private String getRank(@NotNull ClanPlayer cp) {
+        if (cp.isLeader()) {
+            return LEADER;
+        }
+        return cp.isTrusted() ? TRUSTED : MEMBER;
+    }
+}

src/main/java/net/sacredlabyrinth/phaed/simpleclans/hooks/luckperms/LuckPermsContextHook.java

@@ -0,0 +1,51 @@
+package net.sacredlabyrinth.phaed.simpleclans.hooks.luckperms;
+
+import net.luckperms.api.LuckPerms;
+import net.luckperms.api.LuckPermsProvider;
+import net.sacredlabyrinth.phaed.simpleclans.Clan;
+import net.sacredlabyrinth.phaed.simpleclans.ClanPlayer;
+import net.sacredlabyrinth.phaed.simpleclans.SimpleClans;
+import org.bukkit.entity.Player;
+import org.jetbrains.annotations.NotNull;
+
+/**
+ * Registers the {@link ClanContextCalculator} in LuckPerms and signals it,
+ * when clan data of an online player changes.
+ */
+public class LuckPermsContextHook {
+
+    private final LuckPerms luckPerms;
+    private final ClanContextCalculator calculator;
+
+    public LuckPermsContextHook(@NotNull SimpleClans plugin) {
+        luckPerms = LuckPermsProvider.get();
+        calculator = new ClanContextCalculator(plugin.getClanManager());
+    }
+
+    public void register() {
+        luckPerms.getContextManager().registerCalculator(calculator);
+    }
+
+    public void unregister() {
+        luckPerms.getContextManager().unregisterCalculator(calculator);
+    }
+
+    /**
+     * Invalidates the cached contexts of a player
+     */
+    public void signalContextUpdate(@NotNull Player player) {
+        luckPerms.getContextManager().signalContextUpdate(player);
+    }
+
+    /**
+     * Invalidates the cached contexts of all online members of a clan
+     */
+    public void signalContextUpdate(@NotNull Clan clan) {
+        for (ClanPlayer cp : clan.getOnlineMembers()) {
+            Player player = cp.toPlayer();
+            if (player != null) {
+                signalContextUpdate(player);
+            }
+        }
+    }
+}

src/main/java/net/sacredlabyrinth/phaed/simpleclans/listeners/SCPlayerListener.java

@@ -96,6 +96,7 @@ public void onPlayerJoin(PlayerJoinEvent event) {
         }
 
         plugin.getPermissionsManager().addClanPermissions(cp);
+        plugin.signalContextUpdate(player);
     }
 
     @EventHandler(priority = EventPriority.HIGHEST)

src/main/java/net/sacredlabyrinth/phaed/simpleclans/managers/ClanManager.java

@@ -152,6 +152,7 @@ public void createClan(Player player, String colorTag, String name) {
 
         plugin.getRequestManager().deny(cp); // denies any previous invitation
         SimpleClans.getInstance().getPermissionsManager().updateClanPermissions(clan);
+        SimpleClans.getInstance().signalContextUpdate(clan);
         SimpleClans.getInstance().getServer().getPluginManager().callEvent(new CreateClanEvent(clan));
     }
 
@@ -493,6 +494,7 @@ public void ban(UUID uuid) {
 
                 plugin.getStorageManager().updateClanPlayer(cp);
                 plugin.getStorageManager().updateClan(clan);
+                plugin.signalContextUpdate(cp.toPlayer());
             }
         }
 

src/main/java/net/sacredlabyrinth/phaed/simpleclans/managers/SettingsManager.java

@@ -584,6 +584,7 @@ public enum ConfigField {
         ================
          */
         PERMISSIONS_AUTO_GROUP_GROUPNAME("permissions.auto-group-groupname", false),
+        PERMISSIONS_LUCKPERMS_CONTEXTS("permissions.luckperms-contexts", false),
         /*
         ================
         > Performance Settings