feat: implement the functionality of cool down

The get command now has a 60s cool down

Author: Samarium150

README.md

@@ -5,7 +5,7 @@
 <br>
 受启发 [ACGPro](https://github.com/ShrBox/ACGPro) 而写
 <br>
-在群内随机发送图片(30s自动撤回)，支持关键词检索
+在群内随机发送图片(30s自动撤回+60s冷却)，支持关键词检索
 <br>
 适配Mirai-console ![GitHub tag (latest by date)](https://img.shields.io/github/v/tag/mamoe/mirai-console)
 <br>
@@ -30,7 +30,7 @@ customAPIKeyGroups: {}
 ## Usage
 ```text
 /lolicon help    # 获取帮助信息
-/lolicon get [keyword]    # 根据关键字发送涩图, 不提供关键字则随机发送一张
+/lolicon get [keyword]    # (冷却时间60s)根据关键字发送涩图, 不提供关键字则随机发送一张
 /lolicon set <property> <value>
     # 设置属性
     # 可选属性:

build.gradle.kts

@@ -7,7 +7,7 @@ plugins {
 }
 
 group = "com.github.samarium150"
-version = "0.1.0"
+version = "1.0"
 
 repositories {
     mavenLocal()

src/main/kotlin/ImageData.kt

@@ -30,7 +30,7 @@ data class ImageData (
     val tags: ArrayList<String>
 ) {
     /**
-     * Returns the string representation
+     * Return the string representation
      *
      * @return [String] Representation of the data class
      */
@@ -44,7 +44,7 @@ data class ImageData (
     }
 
     /**
-     * Returns the readable information
+     * Return the readable information
      *
      * @return [String] Useful and readable information for users
      */

src/main/kotlin/Lolicon.kt

@@ -57,11 +57,15 @@ object Lolicon: CompositeCommand(
      * @param keyword [String]
      */
     @SubCommand("get")
-    @Description("根据关键字发送涩图, 不提供关键字则随机发送一张")
+    @Description("(冷却时间60s)根据关键字发送涩图, 不提供关键字则随机发送一张")
     suspend fun CommandSender.get(keyword: String = "") {
-        val r18 = if (this.subject is User) false else PluginData.r18Groups.contains(this.subject?.id)
+        if (!Timer.getCoolDown(subject)) {
+            sendMessage("你怎么冲得到处都是")
+            return
+        }
+        val r18 = if (subject is User) false else PluginData.r18Groups.contains(subject?.id)
         val key: String
-        val id = this.subject?.id
+        val id = subject?.id
         key = if (id == null) Config.key
         else if (this.subject is User && PluginData.customAPIKeyUsers.contains(id))
             PluginData.customAPIKeyUsers.getValue(id)
@@ -74,14 +78,21 @@ object Lolicon: CompositeCommand(
             val response: Response = RequestHandler.get(request)
             Main.logger.info(response.toReadable())
             for (imageData in response.data) {
-                val receipt = this.subject?.sendImage(RequestHandler.download(imageData.url))
+                val receipt = subject?.sendImage(RequestHandler.download(imageData.url))
                 sendMessage(imageData.toReadable())
                 if (receipt != null) {
+                    Timer.setCoolDown(subject)
                     coroutineScope {
                         val result = recallAsync(receipt).await()
                         withContext(Dispatchers.Default) {
-                            if (!result) Main.logger.warning("撤回失败")
-                            else Main.logger.info("图片已撤回")
+                            if (!result) Main.logger.warning(receipt.target.toString()+"撤回失败")
+                            else Main.logger.info(receipt.target.toString()+"图片已撤回")
+                        }
+                    }
+                    coroutineScope {
+                        Timer.coolingDown(subject)
+                        withContext(Dispatchers.Default) {
+                            Main.logger.info(receipt.target.toString()+"命令已冷却")
                         }
                     }
                 }
@@ -103,25 +114,25 @@ object Lolicon: CompositeCommand(
     suspend fun CommandSender.set(property: String, value: String) {
         when(property) {
             "r18" -> {
-                if (this.subject is Group) {
+                if (subject is Group) {
                     if (value.toBoolean()) {
-                        PluginData.r18Groups.add((this.subject as Group).id)
+                        PluginData.r18Groups.add((subject as Group).id)
                         sendMessage("设置成功")
                     } else {
-                        if (PluginData.r18Groups.remove((this.subject as Group).id))
+                        if (PluginData.r18Groups.remove((subject as Group).id))
                             sendMessage("设置成功")
                     }
                 }
             }
             "apikey" -> {
-                when (this.subject) {
+                when (subject) {
                     is User -> {
-                        val id = (this.subject as User).id
+                        val id = (subject as User).id
                         if (value.toLowerCase() == "default") PluginData.customAPIKeyUsers.remove(id)
                         else PluginData.customAPIKeyUsers[id] = value
                     }
                     is Group -> {
-                        val id = (this.subject as Group).id
+                        val id = (subject as Group).id
                         if (value.toLowerCase() == "default") PluginData.customAPIKeyGroups.remove(id)
                         else PluginData.customAPIKeyGroups[id] = value
                     }

src/main/kotlin/Request.kt

@@ -22,7 +22,7 @@ data class Request(
     val size1200: Boolean = true
 ) {
     /**
-     * Returns the string representation of parameters
+     * Return the string representation of parameters
      * for GET request
      *
      * @return [String] Request parameters
@@ -38,7 +38,7 @@ data class Request(
     }
 
     /**
-     * Returns the readable information
+     * Return the readable information
      *
      * @return [String] Useful and readable information for logging
      */

src/main/kotlin/RequestHandler.kt

@@ -20,7 +20,7 @@ object RequestHandler {
     /**
      * The lambda function for making GET request
      */
-    private val getResponse: (String) -> (ResponseResultOf<String>) = { url -> Fuel.get(url).responseString() }
+    private val getResponse: (String) -> ResponseResultOf<String> = { url -> Fuel.get(url).responseString() }
 
     /**
      * Makes a GET request to Lolicon API

src/main/kotlin/Response.kt

@@ -22,7 +22,7 @@ data class Response(
     val data: ArrayList<ImageData>
 ) {
     /**
-     * Returns the string representation of response body
+     * Return the string representation of response body
      *
      * @return [String] Request parameters
      */
@@ -36,7 +36,7 @@ data class Response(
     }
 
     /**
-     * Returns the readable information
+     * Return the readable information
      *
      * @return [String] Useful and readable information for logging
      */

src/main/kotlin/Timer.kt

@@ -0,0 +1,102 @@
+package com.github.samarium150.mirai.plugin
+
+import kotlinx.coroutines.*
+import net.mamoe.mirai.contact.Contact
+import net.mamoe.mirai.contact.Group
+import net.mamoe.mirai.contact.User
+
+/**
+ * Object for handling cooling down feature
+ */
+object Timer {
+
+    /**
+     * CoolDown map for users
+     */
+    private val userCoolDown = mutableMapOf<Long, Boolean>()
+
+    /**
+     * CoolDown map for groups
+     */
+    private val groupCoolDown = mutableMapOf<Long, Boolean>()
+
+    /**
+     * The lambda function for getting user's cool down status
+     */
+    private val getUserCoolDown: (Long) -> Boolean = { key -> userCoolDown.getOrDefault(key, true) }
+
+    /**
+     * The lambda function for getting group's cool down status
+     */
+    private val getGroupCoolDown: (Long) -> Boolean = { key -> groupCoolDown.getOrDefault(key, true) }
+
+    /**
+     * The lambda function for setting user's cool down status
+     */
+    private val setUserCoolDown: (Long, Boolean) -> Unit = { key, value -> userCoolDown[key] = value }
+
+    /**
+     * The lambda function for setting group's cool down status
+     */
+    private val setGroupCoolDown: (Long, Boolean) -> Unit = { key, value -> groupCoolDown[key] = value }
+
+    /**
+     * Asynchronously cool down for users
+     *
+     * @param key [Long] User's id
+     * @return [Deferred]<[Unit]>
+     */
+    private suspend fun userCoolingDownAsync(key: Long) = GlobalScope.async(start = CoroutineStart.LAZY) {
+        delay(60000L)
+        setUserCoolDown(key, true)
+    }
+
+    /**
+     * Asynchronously cool down for groups
+     *
+     * @param key [Long] Group's id
+     * @return [Deferred]<[Unit]>
+     */
+    private suspend fun groupCoolingDownAsync(key: Long) = GlobalScope.async(start = CoroutineStart.LAZY) {
+        delay(60000L)
+        setGroupCoolDown(key, true)
+    }
+
+    /**
+     * Get [subject]'s cool down status
+     *
+     * @param subject [Contact]?
+     * @return [Boolean]
+     */
+    fun getCoolDown(subject: Contact?): Boolean {
+        return when (subject) {
+            is User -> getUserCoolDown(subject.id)
+            is Group -> getGroupCoolDown(subject.id)
+            else -> true
+        }
+    }
+
+    /**
+     * Set [subject]'s cool down status
+     *
+     * @param subject [Contact]?
+     */
+    fun setCoolDown(subject: Contact?) {
+        when (subject) {
+            is User -> setUserCoolDown(subject.id, false)
+            is Group -> setGroupCoolDown(subject.id, false)
+        }
+    }
+
+    /**
+     * Asynchronously cool down
+     *
+     * @param subject [Contact]?
+     */
+    suspend fun coolingDown(subject: Contact?) {
+        when (subject) {
+            is User -> userCoolingDownAsync(subject.id).await()
+            is Group -> groupCoolingDownAsync(subject.id).await()
+        }
+    }
+}

src/main/resources/help.txt

@@ -6,7 +6,7 @@ apikey可以在<https://api.lolicon.app/#/setu?id=apikey>申请
 
 可用指令:
 /lolicon help    # 获取帮助信息
-/lolicon get [keyword]    # 根据关键字发送涩图, 不提供关键字则随机发送一张
+/lolicon get [keyword]    # (冷却时间60s)根据关键字发送涩图, 不提供关键字则随机发送一张
 /lolicon set <property> <value>
     # 设置属性
     # 可选属性: