Merge pull request #3 from StopWuyu/update

javadoc: add more descriptions for codes

Author: Mliybs

.gitignore

@@ -1,4 +1,11 @@
 # 项目排除路径
 /.gradle/
 /build/
-/build/classes/kotlin/main/
+/build/classes/kotlin/main/
+/config.json
+/LinkBot-1.0.0.jar
+/data/
+/device.json
+/plugins/
+/cache/
+/logs/

gradle/libs.versions.toml

@@ -1,11 +1,10 @@
 [versions]
 kotlin = "1.8.10"
-ktor = "2.1.2"
 exposed = "0.41.1"
 
 [plugins]
 kotlin-serialization = { id = "org.jetbrains.kotlin.plugin.serialization", version.ref = "kotlin" }
-ktlint = { id = "org.jlleitschuh.gradle.ktlint", version = "11.2.0" }
+ktlint = { id = "org.jlleitschuh.gradle.ktlint", version = "11.4.0" }
 abi-validator = { id = "org.jetbrains.kotlinx.binary-compatibility-validator", version = "0.12.1" }
 spotless = { id = "com.diffplug.spotless", version = "6.15.0" }
 licensee = { id = "app.cash.licensee", version = "1.6.0" }

settings.gradle.kts

@@ -2,9 +2,9 @@ rootProject.name = "LinkBot"
 
 pluginManagement {
     repositories {
-        maven("https://maven.aliyun.com/repository/public/")
-        maven("https://maven.aliyun.com/repository/gradle-plugin/")
         maven(url = "https://plugins.gradle.org/m2/")
+        maven("https://maven.aliyun.com/repository/gradle-plugin/")
+        maven("https://maven.aliyun.com/repository/public/")
         mavenCentral()
     }
 }

src/main/kotlin/tech/egglink/projects/linkbot/bot/Bot.kt

@@ -12,7 +12,10 @@ class Bot {
 
     /**
      * 机器人登录
-     * */
+     *
+     * @param account QQ 号
+     * @param password 密码
+     */
     fun login(account: Long, password: String) {
         bot = Mirai.BotFactory.newBot(
             account,

src/main/kotlin/tech/egglink/projects/linkbot/command/BotCommandSender.kt

@@ -3,6 +3,9 @@ package tech.egglink.projects.linkbot.command
 import net.mamoe.mirai.contact.Contact
 import net.mamoe.mirai.contact.Group
 
+/**
+ * 用于 Bot 的 CommandSender
+ * */
 interface BotCommandSender : CommandSender {
     val sender: Contact
     val group: Group

src/main/kotlin/tech/egglink/projects/linkbot/command/CommandHandler.kt

@@ -1,6 +1,24 @@
 package tech.egglink.projects.linkbot.command
 
+/**
+ * 命令实例
+ *
+ * 所有的命令都应该继承这个类
+ * @param entry 命令信息
+ * */
 abstract class CommandHandler(val entry: Entry) {
+    /**
+     * 命令信息
+     *
+     * @property name 命令名
+     * @property description 命令描述
+     * @property usage 命令用法
+     * @property aliases 命令别名
+     * @property type 命令类型
+     * @property argsType 参数类型
+     * @property defaultArgs 默认参数
+     * @property permission 权限
+     * */
     open class Entry {
         var name: String = ""
         var description: String = ""
@@ -20,5 +38,8 @@ abstract class CommandHandler(val entry: Entry) {
         var permission: String = "true"
     }
 
+    /**
+     * 命令执行
+     * */
     abstract suspend fun execute(sender: CommandSender, args: Array<String>): CommandResult
 }

src/main/kotlin/tech/egglink/projects/linkbot/command/CommandResult.kt

@@ -1,10 +1,20 @@
 package tech.egglink.projects.linkbot.command
 
+/**
+ * 命令结果
+ *
+ * @property SUCCESS 成功
+ * @property FAILURE 失败
+ * @property ERROR 错误
+ * @property NOT_FOUND 未找到
+ * @property NO_PERMISSION 无权限
+ * @property INVALID_USAGE 无效用法
+ * */
 enum class CommandResult {
-    SUCCESS,
-    FAILURE,
-    ERROR,
-    NOT_FOUND,
-    NO_PERMISSION,
-    INVALID_USAGE
+    SUCCESS, // 成功
+    FAILURE, // 失败
+    ERROR, // 错误
+    NOT_FOUND, // 未找到
+    NO_PERMISSION, // 无权限
+    INVALID_USAGE // 无效用法
 }

src/main/kotlin/tech/egglink/projects/linkbot/command/CommandSender.kt

@@ -1,7 +1,20 @@
 package tech.egglink.projects.linkbot.command
 
+/**
+ * 命令发送者实例
+ * */
 interface CommandSender {
+    /**
+     * 发送消息
+     *
+     * @param message 消息
+     * */
     suspend fun sendMessage(message: String)
 
+    /**
+     * 检查是否有权限
+     *
+     * @param permission 权限
+     * */
     fun hasPermission(permission: String): Boolean
 }

src/main/kotlin/tech/egglink/projects/linkbot/command/CommandType.kt

@@ -1,6 +1,12 @@
 package tech.egglink.projects.linkbot.command
 
+/**
+ * 命令类型
+ *
+ * @property Bot 机器人
+ * @property Console 控制台
+ * */
 enum class CommandType {
-    Bot,
-    Console
+    Bot, // 机器人
+    Console // 控制台
 }

src/main/kotlin/tech/egglink/projects/linkbot/command/Commands.kt

@@ -28,6 +28,9 @@ class Commands {
         registerCommand(CommandLogout())
     }
 
+    /**
+     * 注册所有机器人命令
+     * */
     fun registerBotCommands() {
         registerCommand(tech.egglink.projects.linkbot.command.cmd.bot.CommandHelp())
     }

src/main/kotlin/tech/egglink/projects/linkbot/command/ConsoleCommandSender.kt

@@ -2,12 +2,23 @@ package tech.egglink.projects.linkbot.command
 
 import tech.egglink.projects.linkbot.utils.Utils
 
+/**
+ * 用于控制台的 CommandSender
+ * */
 class ConsoleCommandSender : CommandSender {
+    /**
+     * 发送消息
+     *
+     * @param message 消息
+     * */
     override suspend fun sendMessage(message: String) {
         Utils.logger.info(message)
     }
 
-    override fun hasPermission(permission: String): Boolean {
-        return true
-    }
+    /**
+     * 检查是否有权限
+     *
+     * @param permission 权限
+     * */
+    override fun hasPermission(permission: String): Boolean = true
 }

src/main/kotlin/tech/egglink/projects/linkbot/dataprovider/DataProvider.kt

@@ -1,6 +1,15 @@
 package tech.egglink.projects.linkbot.dataprovider
 
+/**
+ * 数据提供器
+ * */
 class DataProvider {
+    /**
+     * 通过 QQ 号新建用户数据
+     *
+     * @param qq QQ 号
+     * */
     fun createUserData(qq: Long) {
+        UserData(qq)
     }
 }

src/main/kotlin/tech/egglink/projects/linkbot/dataprovider/UserData.kt

@@ -1,18 +1,36 @@
 package tech.egglink.projects.linkbot.dataprovider
 
-class UserData {
+data class UserData(
     /**
      * QQ 号 用于核对
      * */
-    var qqId: Long = 0L
+    var qqId: Long = 0L,
 
     /**
      * 被授予 True 权限的权限
      * */
-    val permissionTrue: Array<String> = arrayOf()
+    val permissionTrue: Array<String> = arrayOf(),
 
     /**
      * 被授予 False 权限的权限
      * */
     val permissionFalse: Array<String> = arrayOf()
+) {
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as UserData
+
+        if (qqId != other.qqId) return false
+        if (!permissionTrue.contentEquals(other.permissionTrue)) return false
+        return permissionFalse.contentEquals(other.permissionFalse)
+    }
+
+    override fun hashCode(): Int {
+        var result = qqId.hashCode()
+        result = 31 * result + permissionTrue.contentHashCode()
+        result = 31 * result + permissionFalse.contentHashCode()
+        return result
+    }
 }

src/main/kotlin/tech/egglink/projects/linkbot/event/CommandEvent.kt

@@ -1,5 +1,8 @@
 package tech.egglink.projects.linkbot.event
 
+/**
+ * 不清楚干什么的了
+ */
 class CommandEvent : net.mamoe.mirai.event.Event {
     override val isIntercepted: Boolean = false
 

src/main/kotlin/tech/egglink/projects/linkbot/event/EventListener.kt

@@ -12,6 +12,9 @@ import net.mamoe.mirai.event.events.GroupNameChangeEvent
 import net.mamoe.mirai.event.events.MemberJoinRequestEvent
 import tech.egglink.projects.linkbot.utils.Utils
 
+/**
+ * 事件监听器
+ * */
 object EventListener {
     fun beginListen() {
         Utils.bot.getBot().eventChannel.subscribeAlways<BotEvent> {

src/main/kotlin/tech/egglink/projects/linkbot/event/EventManager.kt

@@ -2,24 +2,50 @@ package tech.egglink.projects.linkbot.event
 
 import tech.egglink.projects.linkbot.utils.Utils
 
+/**
+ * 事件管理器
+ * */
 class EventManager {
 
-    private val events = mutableListOf<Event>()
+    private val events = mutableListOf<Event>() // 事件列表
+
+    /**
+     * 注册事件
+     *
+     * @param events 事件列表
+     * */
     fun registerEvents(vararg events: Event) {
         events.forEach { event ->
             registerEvent(event)
         }
     }
+
+    /**
+     * 注册事件
+     *
+     * @param events 事件列表
+     * */
     fun registerEvents(events: List<Event>) {
         events.forEach { event ->
             registerEvent(event)
         }
     }
 
+    /**
+     * 注册单个事件
+     *
+     * @param event 事件
+     * */
     fun registerEvent(event: Event) {
         events.add(event)
     }
 
+    /**
+     * 广播事件
+     *
+     * @param eventType 事件类型
+     * @param evt 事件
+     * */
     fun broadcastEvent(eventType: EventType, evt: net.mamoe.mirai.event.Event = CommandEvent()) {
         eventType.let {
             Utils.logger.debug("事件广播: ${it.javaClass.simpleName}(${it.hashCode()})")

src/main/kotlin/tech/egglink/projects/linkbot/utils/configurations/Message.kt

@@ -21,8 +21,6 @@ class Message {
         val loginDescription = "登录机器人."
         val logoutUsage = "logout"
         val logoutDescription = "登出机器人."
-        val databaseUsage = "database find <qq>"
-        val databaseDescription = "查看数据库."
     }
     val command = Command()
 
@@ -34,7 +32,6 @@ class Message {
         val unknownCommand = "未知命令!"
         val noPermission = "没有权限!"
         val invalidArgs = "参数错误!"
-        val databaseNotFound = "数据库中未找到!"
     }
     val error = Error()