Merge pull request #150 from DockyardMC/feature/permission-system

Add permission system

Author: LukynkaCZE

.idea/inspectionProfiles/Project_Default.xml

@@ -38,8 +38,6 @@ fun main() {
 
     Events.on<PlayerJoinEvent> { event ->
         val player = event.player
-        player.permissions.add("dockyard.admin")
-        player.permissions.add("dockyard.*")
         player.gameMode.value = GameMode.CREATIVE
         DebugSidebar.sidebar.viewers.add(player)
         player.canFly.value = true

src/main/kotlin/Main.kt

@@ -273,7 +273,7 @@ abstract class Entity(open var location: Location, open var world: World) : Disp
     }
 
     fun playDeathAnimation() {
-        val packet = ClientboundEntityEventPacket(this, EntityEvent.ENTITY_DIE)
+        val packet = ClientboundEntityEventPacket(this, EntityEvent.LIVING_ENTITY_PLAY_DEATH_SOUND)
         pose.value = EntityPose.DYING
         viewers.sendPacket(packet)
         passengers.clear(false)

src/main/kotlin/io/github/dockyardmc/entity/Entity.kt

@@ -17,6 +17,27 @@ import io.github.dockyardmc.scroll.Component
 import io.github.dockyardmc.scroll.extensions.toComponent
 import java.util.UUID
 
+fun <T> MutableList<T>.addAllNonDuplicates(other: Collection<T>) {
+    val nonDuplicates = other.filter { item -> !this.contains(item) }
+    this.addAll(nonDuplicates)
+}
+
+fun Collection<Player>.filterByPermission(permission: String): Collection<Player> {
+    return this.filter { player -> player.hasPermission(permission) }
+}
+
+fun Collection<Player>.addPermission(permission: String) {
+    this.forEach { player ->
+        player.permissions.add(permission)
+    }
+}
+
+fun Collection<Player>.removePermission(permission: String) {
+    this.forEach { player ->
+        player.permissions.remove(permission)
+    }
+}
+
 fun Collection<Player>.teleport(location: Location) {
     this.forEach { player -> player.teleport(location) }
 }

src/main/kotlin/io/github/dockyardmc/extentions/ExtendedMutableList.kt

@@ -20,6 +20,7 @@ import io.github.dockyardmc.maths.vectors.Vector3d
 import io.github.dockyardmc.maths.vectors.Vector3f
 import io.github.dockyardmc.particles.BlockParticleData
 import io.github.dockyardmc.particles.spawnParticle
+import io.github.dockyardmc.player.permissions.PermissionSystem
 import io.github.dockyardmc.player.systems.*
 import io.github.dockyardmc.protocol.PlayerNetworkManager
 import io.github.dockyardmc.protocol.packets.ClientboundPacket
@@ -116,6 +117,7 @@ class Player(
     val gameModeSystem = GameModeSystem(this)
     val playerInfoSystem = PlayerInfoSystem(this)
     val entityViewSystem = EntityViewSystem(this)
+    val permissionSystem = PermissionSystem(this, permissions)
     val attributes = PlayerAttributes(this)
 
     val decoupledEntityViewSystemTicking = DockyardServer.scheduler.runRepeating(1.ticks) {
@@ -165,9 +167,6 @@ class Player(
 
         fovModifier.valueChanged { this.sendPacket(ClientboundPlayerAbilitiesPacket(isFlying.value, isInvulnerable, canFly.value, flySpeed.value, it.newValue)) }
 
-        permissions.itemAdded { rebuildCommandNodeGraph() }
-        permissions.itemRemoved { rebuildCommandNodeGraph() }
-
         health.valueChanged { sendHealthUpdatePacket() }
         food.valueChanged { sendHealthUpdatePacket() }
         saturation.valueChanged { sendHealthUpdatePacket() }
@@ -363,9 +362,7 @@ class Player(
     }
 
     fun hasPermission(permission: String): Boolean {
-        if (permission.isEmpty()) return true
-        if (permissions.values.contains("dockyard.all") || permissions.values.contains("dockyard.*")) return true
-        return permissions.values.contains(permission)
+        return permissionSystem.hasPermission(permission)
     }
 
     fun sendSelfMetadataPacket() {
@@ -471,7 +468,7 @@ class Player(
             val totem = ItemStack(Items.TOTEM_OF_UNDYING).withCustomModelData(customModelData)
             inventory[heldSlotIndex.value] = totem
         }
-        val packet = ClientboundEntityEventPacket(this, EntityEvent.PLAYER_PLAY_TOTEM_ANIMATION)
+        val packet = ClientboundEntityEventPacket(this, EntityEvent.LIVING_ENTITY_PLAY_TOTEM_UNDYING_ANIMATION)
         sendPacket(packet)
 
         if (customModelData != null) {

src/main/kotlin/io/github/dockyardmc/player/Player.kt

@@ -0,0 +1,25 @@
+package io.github.dockyardmc.player.permissions
+
+data class PermissionGroup(val id: String, private val permissions: List<String>) : PermissionHolder() {
+
+    init {
+        buildPermissionCache(permissions)
+    }
+
+    class Builder {
+        var id: String? = null
+        val permissions: MutableList<String> = mutableListOf()
+
+        fun withId(id: String) {
+            this.id = id.lowercase()
+        }
+
+        fun withPermissions(permissions: List<String>) {
+            this.permissions.addAll(permissions)
+        }
+
+        fun withPermissions(vararg permissions: String) {
+            this.permissions.addAll(permissions.toList())
+        }
+    }
+}

src/main/kotlin/io/github/dockyardmc/player/permissions/PermissionGroup.kt

@@ -0,0 +1,49 @@
+package io.github.dockyardmc.player.permissions
+
+import io.github.dockyardmc.extentions.addAllNonDuplicates
+
+abstract class PermissionHolder {
+
+    protected val cachedPermissions: MutableList<String> = mutableListOf()
+
+    // includes inherited permissions
+    @JvmName("getCachedPermissionsFunction")
+    fun getCachedPermissions(): List<String> {
+        return cachedPermissions
+    }
+
+
+    fun buildPermissionCache(permissions: Collection<String>) {
+        cachedPermissions.clear()
+
+        permissions.forEach { permission ->
+            if (!permission.startsWith("group")) {
+                cachedPermissions.add(permission)
+            } else {
+
+                val inheritedGroupId = permission.split(".").getOrNull(1) ?: throw IllegalArgumentException("Group inheritance permissions string need be in the following format: `group.<group id>`")
+                val inheritedGroup = PermissionManager[inheritedGroupId]
+
+                cachedPermissions.addAllNonDuplicates(inheritedGroup.getCachedPermissions())
+            }
+        }
+    }
+
+    fun hasPermission(permission: String): Boolean {
+        if(permission.isEmpty()) return true
+        if (cachedPermissions.contains(permission)) return true
+
+        cachedPermissions.forEach { loopPermission ->
+            if (loopPermission == "*") return true
+
+            if (loopPermission.endsWith(".*")) {
+                val prefix = loopPermission.removeSuffix(".*")
+                if (permission.startsWith("$prefix.")) {
+                    return true
+                }
+            }
+        }
+
+        return false
+    }
+}

src/main/kotlin/io/github/dockyardmc/player/permissions/PermissionHolder.kt

@@ -0,0 +1,39 @@
+package io.github.dockyardmc.player.permissions
+
+object PermissionManager {
+    private val groups: MutableMap<String, PermissionGroup> = mutableMapOf<String, PermissionGroup>()
+
+    fun getOrNull(id: String): PermissionGroup? {
+        val indexId = if (id.contains("group.")) id.split(".").getOrNull(1)!! else id
+        return groups[indexId]
+    }
+
+    operator fun get(id: String): PermissionGroup {
+        return getOrNull(id) ?: throw IllegalArgumentException("Permissions group with id `$id` is not registered")
+    }
+
+    fun addGroup(group: PermissionGroup.Builder.() -> Unit): PermissionGroup {
+        val builder = PermissionGroup.Builder()
+        group.invoke(builder)
+
+        if (builder.id == null) throw IllegalArgumentException("Id of a permissions group cannot be empty")
+        val lowercaseId = builder.id!!.lowercase()
+
+        if (lowercaseId.contains(".")) throw IllegalArgumentException("Permissions group ids cannot contain dots")
+        if (groups.containsKey(lowercaseId)) throw IllegalArgumentException("Permission group with the id of $lowercaseId already exists")
+
+        builder.id = lowercaseId
+        val newGroup = PermissionGroup(lowercaseId, builder.permissions)
+        groups[lowercaseId] = newGroup
+
+        return newGroup
+    }
+
+    fun removeGroup(group: PermissionGroup) {
+        groups.remove(group.id)
+    }
+
+    fun removeGroup(id: String) {
+        groups.remove(id)
+    }
+}

src/main/kotlin/io/github/dockyardmc/player/permissions/PermissionManager.kt

@@ -0,0 +1,24 @@
+package io.github.dockyardmc.player.permissions
+
+import cz.lukynka.bindables.BindableList
+import io.github.dockyardmc.player.Player
+import io.github.dockyardmc.player.systems.PlayerSystem
+import io.github.dockyardmc.protocol.packets.play.clientbound.ClientboundEntityEventPacket
+import io.github.dockyardmc.protocol.packets.play.clientbound.EntityEvent
+
+class PermissionSystem(val player: Player, val bindable: BindableList<String>): PermissionHolder(), PlayerSystem {
+
+    init {
+        bindable.listUpdated {
+            buildPermissionCache(bindable.values)
+            player.rebuildCommandNodeGraph()
+
+            if(bindable.contains("*")) {
+                player.sendPacket(ClientboundEntityEventPacket(player, EntityEvent.PLAYER_SET_OP_PERMISSION_LEVEL_4))
+            } else {
+                player.sendPacket(ClientboundEntityEventPacket(player, EntityEvent.PLAYER_SET_OP_PERMISSION_LEVEL_0))
+            }
+        }
+    }
+
+}

src/main/kotlin/io/github/dockyardmc/player/permissions/PermissionSystem.kt

@@ -13,19 +13,42 @@ class ClientboundEntityEventPacket(entity: Entity, event: EntityEvent) : Clientb
 }
 
 enum class EntityEvent(val id: Int) {
-    ENTITY_DIE(3),
-    WARDEN_ATTACK(4),
-    RAVAGER_ATTACK_ANIMATION(4),
-    RAVAGER_STUNNED(39),
+    SPAWNS_HONEY_BLOCK_PARTICLES(53),
+
+    ARROW_SPAWN_TIPPED_ARROW_PARTICLE(0),
+
+    LIVING_ENTITY_PLAY_DEATH_SOUND(3),
+    LIVING_ENTITY_SHIELD_BLOCK_SOUND(29),
+    LIVING_ENTITY_SHIELD_BREAK_SOUND(30),
+    LIVING_ENTITY_PLAY_TOTEM_UNDYING_ANIMATION(35),
+    LIVING_ENTITY_SWAP_HAND_ITEMS(55),
+    LIVING_ENTITY_SPAWN_DEATH_SMOKE_PARTICLES(60),
+
     PLAYER_ITEM_USE_FINISHED(9),
-    PLAYER_ENABLE_DEBUG_SCREEN(23),
-    PLAYER_DISABLE_DEBUG_SCREEN(22),
+    PLAYER_ENABLE_DEBUG_SCREEN(22),
+    PLAYER_DISABLE_DEBUG_SCREEN(23),
     PLAYER_SET_OP_PERMISSION_LEVEL_0(24),
     PLAYER_SET_OP_PERMISSION_LEVEL_1(25),
     PLAYER_SET_OP_PERMISSION_LEVEL_2(26),
     PLAYER_SET_OP_PERMISSION_LEVEL_3(27),
     PLAYER_SET_OP_PERMISSION_LEVEL_4(28),
-    PLAYER_PLAY_TOTEM_ANIMATION(35),
+    PLAY_SPAWN_CLOUD_PARTICLES(43),
+
+    ANIMAL_SPAWN_LOVE_MODE_PARTICLES(18),
+
+    OCELOT_SPAWN_SMOKE_PARTICLES(40),
+    OCELOT_SPAWN_HEART_PARTICLE(41),
+
+    RABBIT_JUMP_ANIMATION(1),
+
+    SHEEP_EAT_GRASS(10),
+
+    SNIFFER_PLAY_DIGGING_SOUND(63),
+
+    RAVAGER_ATTACK_ANIMATION(4),
+    RAVAGER_STUNNED(39),
+
+    WARDEN_ATTACK(4),
     WARDEN_TENDRIL_SHAKING(61),
     WARDEN_SONIC_BOOM(62),
 }