feat: add LuckPerms integration for player permissions handling

Author: TheBjoRedCraft

gradle/libs.versions.toml

@@ -16,7 +16,7 @@ packetevents-plugin = "2.11.2"
 commandapi = "11.2.0"
 
 # LuckPerms
-luckperms = "v5.5.0-bukkit"
+luckperms = "5.4"
 
 # Scoreboard Library
 scoreboard-library = "2.7.3"
@@ -151,6 +151,7 @@ flogger-slf4j-backend = { module = "com.google.flogger:flogger-slf4j-backend", v
 aide-reflection = { module = "tech.hiddenproject:aide-reflection", version.ref = "aide-reflection" }
 glm = { module = "io.github.kotlin-graphics:glm", version.ref = "glm" }
 datafixerupper = { module = "com.mojang:datafixerupper", version.ref = "datafixerupper" }
+luckperms = { module = "net.luckperms:api", version.ref = "luckperms" }
 
 auto-service-annotations = { module = "com.google.auto.service:auto-service-annotations", version.ref = "auto-service" }
 auto-service = { module = "dev.zacsweers.autoservice:auto-service-ksp", version.ref = "auto-service-ksp" }

surf-api-core/surf-api-core/build.gradle.kts

@@ -6,6 +6,7 @@ plugins {
 dependencies {
     api(projects.surfApiShared.surfApiSharedPublic)
     api(libs.adventure.nbt)
+    compileOnlyApi(libs.luckperms)
     compileOnlyApi(libs.packetevents.api)
     compileOnlyApi(libs.dazzleconf)
     compileOnlyApi(libs.spongepowered.math)

surf-api-core/surf-api-core/src/main/kotlin/dev/slne/surf/api/core/luckperms/LuckPermsAccess.kt

@@ -0,0 +1,47 @@
+package dev.slne.surf.api.core.luckperms
+
+import dev.slne.surf.api.core.messages.adventure.uuidOrNull
+import kotlinx.coroutines.future.await
+import net.kyori.adventure.audience.Audience
+import net.luckperms.api.LuckPermsProvider
+import net.luckperms.api.model.user.User
+import net.luckperms.api.node.NodeType
+import java.util.*
+
+object LuckPermsAccess {
+    val luckperms by lazy {
+        LuckPermsProvider.get()
+    }
+
+    fun getUser(uuid: UUID) = luckperms.userManager.getUser(uuid)
+    suspend fun loadUser(uuid: UUID): User = luckperms.userManager.loadUser(uuid).await()
+}
+
+val User.prefix: String
+    get() = this.cachedData.metaData.prefix ?: ""
+val User.suffix: String
+    get() = this.cachedData.metaData.suffix ?: ""
+
+val User.weight
+    get() = LuckPermsAccess.luckperms.groupManager.getGroup(this.primaryGroup)?.weight ?: 0
+
+inline fun <reified T : Any> User.getMeta(key: String): T? {
+    val value = this.resolveInheritedNodes(NodeType.META, this.queryOptions)
+        .find { it.metaKey == key }
+        ?.metaValue
+
+    return value as? T
+}
+
+inline fun <reified T : Any> User.getMeta(key: String, default: T): T {
+    val value = this.resolveInheritedNodes(NodeType.META, this.queryOptions)
+        .find { it.metaKey == key }
+        ?.metaValue
+
+    return value as? T ?: default
+}
+
+
+fun Audience.getLuckPermsUser() = this.uuidOrNull()?.let { LuckPermsAccess.getUser(it) }
+fun Audience.getLuckPermsUserOrNull() = this.uuidOrNull()?.let { LuckPermsAccess.getUser(it) }
+    ?: error("Audience does not have a valid UUID or LuckPerms user could not be found.")

surf-api-paper/surf-api-paper/src/main/kotlin/dev/slne/surf/api/paper/util/bukkit-util.kt

@@ -6,6 +6,7 @@ package dev.slne.surf.api.paper.util
 import com.github.shynixn.mccoroutine.folia.SuspendingPlugin
 import com.github.shynixn.mccoroutine.folia.entityDispatcher
 import com.github.shynixn.mccoroutine.folia.regionDispatcher
+import dev.slne.surf.api.core.luckperms.LuckPermsAccess
 import dev.slne.surf.api.core.util.getCallerClass
 import dev.slne.surf.api.core.util.mutableObjectListOf
 import dev.slne.surf.api.paper.SurfApiPaper
@@ -263,6 +264,17 @@ suspend fun World.getBlockAtAsync(pos: BlockPosition): Block {
     }
 }
 
+
+fun Player.getLuckPermsUser() = LuckPermsAccess.getUser(this.uniqueId)
+    ?: error("LuckPerms user not found for online player ${this.name}")
+
+fun Player.getLuckPermsUserOrNull() = LuckPermsAccess.getUser(this.uniqueId)
+
+suspend fun OfflinePlayer.getLuckPermsUser() = withContext(Dispatchers.IO) {
+    LuckPermsAccess.getUser(this@getLuckPermsUser.uniqueId)
+        ?: LuckPermsAccess.loadUser(this@getLuckPermsUser.uniqueId)
+}
+
 /**
  * Constructs a human-readable string representing the location, including coordinates and optionally
  * rotation data.

surf-api-velocity/surf-api-velocity/src/main/kotlin/dev/slne/surf/api/velocity/util/velocity-util.kt

@@ -1,2 +1,9 @@
 package dev.slne.surf.api.velocity.util
 
+import com.velocitypowered.api.proxy.Player
+import dev.slne.surf.api.core.luckperms.LuckPermsAccess
+
+fun Player.getLuckPermsUser() = LuckPermsAccess.getUser(this.uniqueId)
+    ?: error("LuckPerms user not found for online player ${this.username}")
+
+fun Player.getLuckPermsUserOrNull() = LuckPermsAccess.getUser(this.uniqueId)