refactor: remove GroupAdmin/Owner from PermissionLevel

close #11

Author: Aliorpse

saltify-core/src/commonMain/kotlin/org/ntqqrev/saltify/extension/EventExtension.kt

@@ -8,8 +8,6 @@ import org.ntqqrev.saltify.core.sendGroupMessage
 import org.ntqqrev.saltify.core.sendPrivateMessage
 import org.ntqqrev.saltify.core.text
 import org.ntqqrev.saltify.dsl.SaltifyPluginContext
-import org.ntqqrev.saltify.entity.SaltifyBotConfig
-import org.ntqqrev.saltify.model.PermissionLevel
 import org.ntqqrev.saltify.model.milky.SendMessageOutput
 
 /**
@@ -36,17 +34,3 @@ public suspend inline fun Event.MessageReceive.respond(
     client: SaltifyApplication,
     text: String
 ): SendMessageOutput = respond(client) { text(text) }
-
-/**
- * 获取发送者的权限等级。
- */
-public val Event.MessageReceive.senderPermissionLevel: PermissionLevel
-    get() = when (senderId) {
-        in SaltifyBotConfig.superUsers -> PermissionLevel.SuperUser
-        in SaltifyBotConfig.restrictedUsers -> PermissionLevel.Restricted
-        else -> when ((data as? IncomingMessage.Group)?.groupMember?.role) {
-            "owner" -> PermissionLevel.GroupOwner
-            "admin" -> PermissionLevel.GroupAdmin
-            else -> PermissionLevel.Everyone
-        }
-    }

saltify-core/src/commonMain/kotlin/org/ntqqrev/saltify/extension/PermissionLevelExtension.kt

@@ -0,0 +1,13 @@
+package org.ntqqrev.saltify.extension
+
+import org.ntqqrev.saltify.entity.SaltifyBotConfig
+import org.ntqqrev.saltify.model.PermissionLevel
+
+/**
+ * 获取用户的权限等级。
+ */
+public fun permissionLevelOf(targetId: Long): PermissionLevel = when (targetId) {
+    in SaltifyBotConfig.superUsers -> PermissionLevel.SuperUser
+    in SaltifyBotConfig.restrictedUsers -> PermissionLevel.Restricted
+    else -> PermissionLevel.Everyone
+}

saltify-core/src/commonMain/kotlin/org/ntqqrev/saltify/extension/RequirementExtension.kt

@@ -17,5 +17,20 @@ public fun SaltifyCommandRequirementContext.group(vararg targetId: Long): Comman
 
 public fun SaltifyCommandRequirementContext.perm(targetLevel: PermissionLevel): CommandRequirement =
     CommandRequirement {
-        context.event.senderPermissionLevel >= targetLevel
+        permissionLevelOf(context.event.senderId) >= targetLevel
     }
+
+public val SaltifyCommandRequirementContext.isGroupAdmin: CommandRequirement
+    get() = CommandRequirement {
+        val data = context.event.data as? IncomingMessage.Group
+        data?.groupMember?.role == "admin"
+    }
+
+public val SaltifyCommandRequirementContext.isGroupOwner: CommandRequirement
+    get() = CommandRequirement {
+        val data = context.event.data as? IncomingMessage.Group
+        data?.groupMember?.role == "owner"
+    }
+
+public val SaltifyCommandRequirementContext.isGroupAdminOrOwner: CommandRequirement
+    get() = isGroupAdmin or isGroupOwner

saltify-core/src/commonMain/kotlin/org/ntqqrev/saltify/model/PermissionLevel.kt

@@ -16,16 +16,6 @@ public open class PermissionLevel(
      */
     public object Everyone : PermissionLevel(0)
 
-    /**
-     * 群管理
-     */
-    public object GroupAdmin : PermissionLevel(100)
-
-    /**
-     * 群主
-     */
-    public object GroupOwner : PermissionLevel(200)
-
     /**
      * 超级用户
      */

saltify-docs/content/docs-core/permission.md

@@ -4,8 +4,6 @@ Saltify 提供了内置的一套简易权限管理方案。默认支持如下几
 
 - **Restricted** – 受限制 (Int.MIN_VALUE)
 - **Everyone** – 所有人 (0)
-- **GroupAdmin** – 群管理员 (100)
-- **GroupOwner** – 群主 (200)
 - **SuperUser** – 最高权限 (Int.MAX_VALUE)
 
 可以这样使用权限 API:
@@ -21,10 +19,10 @@ client.command("stop") {
 }
 
 client.on<Event.MessageReceive> { event ->
-    if (event.senderPermissionLevel >= PermissionLevel.GroupAdmin) {
+    if (permissionLevelOf(event.senderId) >= PermissionLevel.SuperUser) {
         TODO()
     }
 }
 ```
 
-需要注意的是，requirements 判定失败是默认返回的，所以上例1所示适用范围可能较窄。
+需要注意的是，requirements 判定失败是静默返回的，所以上例1所示适用情况可能较少。