Implement config hot-reloading

kraftwerk28 · kraftwerk28 · commit ee28986cb008 · 2022-02-15T02:00:12.000+02:00
Add `silentMessages` option
Add ability to change bot API endpoint
diff --git a/README.md b/README.md
@@ -24,11 +24,11 @@
 6. Add you bot to chats, where you plan to use it. In each of them, run `/chat_id` command. The bot should respond and give special value - __chat id__. Now, open `config.yml` and paste this ID under `chats` section, so it will look like this:
     ```yaml
     botToken: abcdefghijklmnopq123123123
-    chats:
-      # Note about doubling minus sign. This is not a mistake, first one means list element, the second one - actual minus
-      - -123456789
-      - 987654321
+    chats: [
+      -123456789,
+      987654321,
       # other chat id's...
+    ]
     ```
 
 7. You can extend `config.yml` with more tweaks, which are described in the table below, but it's not nesessary, plugin will use default values instead, if they're missing. Also, check out the [example](src/main/resources/config.yml).
@@ -38,22 +38,25 @@
 
 ## Plugin configuration:
 
-| Field | Description | Type | Required | Default |
-|:-----:|:------------|:----:|:--------:|:-------:|
-| enable | If plugin should be enabled | `boolean` | :x: | `true` |
-| botToken | Telegram bot token ([How to create bot](https://core.telegram.org/bots#3-how-do-i-create-a-bot)) | `string` | :heavy_check_mark: | - |
-| chats | Chats, where bot will work (to prevent using bot by unknown chats) | `number[] or string[]` | :heavy_check_mark: | `[]` |
-| serverStartMessage | What will be sent to chats when server starts | `string` | :x: | `'Server started.'` |
-| serverStopMessage | What will be sent to chats when server stops | `string` | :x: | `'Server stopped.'` |
-| logJoinLeave | If true, plugin will send corresponding messages to chats, when player joins or leaves server | `boolean` | :x: | `true` |
-| logFromMCtoTG | If true, plugin will send messages from players on server, to Telegram chats | `boolean` | :x: | `true` |
-| logFromTGtoMC | If true, plugin will send messages from chats, to Minecraft server | `boolean` | :x: | `true` |
-| logPlayerDeath | If true, plugin will send message to Telegram if player died | `boolean` | :x: | `false` |
-| logPlayerAsleep | If true, plugin will send message to Telegram if player fell asleep | `boolean` | :x: | `false` |
-| strings | Dictionary of tokens - strings for plugin i18n | `Map<string, string>` | :x: | See default config |
-| commands | Dictionary of command text used in Telegram bot | `Map<string, string>` | :heavy_check_mark: | See below |
-| telegramMessageFormat | Format string for TGtoMC chat message | `string` | :x: | See default config |
-| minecraftMessageFormat | Format string for MCtoTG chat message | `string` | :x: | See default config |
+|         Field          | Description                                                                                      |          Type          | Required |         Default          |
+|:----------------------:|:-------------------------------------------------------------------------------------------------|:----------------------:|:--------:|:------------------------:|
+|         enable         | If plugin should be enabled                                                                      |       `boolean`        | :x: |          `true`          |
+|        botToken        | Telegram bot token ([How to create bot](https://core.telegram.org/bots#3-how-do-i-create-a-bot)) |        `string`        | :heavy_check_mark: |            -             |
+|         chats          | Chats, where bot will work (to prevent using bot by unknown chats)                               | `number[] or string[]` | :heavy_check_mark: |           `[]`           |
+|   serverStartMessage   | What will be sent to chats when server starts                                                    |        `string`        | :x: |   `'Server started.'`    |
+|   serverStopMessage    | What will be sent to chats when server stops                                                     |        `string`        | :x: |   `'Server stopped.'`    |
+|      logJoinLeave      | If true, plugin will send corresponding messages to chats, when player joins or leaves server    |       `boolean`        | :x: |          `true`          |
+|     logFromMCtoTG      | If true, plugin will send messages from players on server, to Telegram chats                     |       `boolean`        | :x: |          `true`          |
+|     logFromTGtoMC      | If true, plugin will send messages from chats, to Minecraft server                               |       `boolean`        | :x: |          `true`          |
+|     logPlayerDeath     | If true, plugin will send message to Telegram if player died                                     |       `boolean`        | :x: |         `false`          |
+|    logPlayerAsleep     | If true, plugin will send message to Telegram if player fell asleep                              |       `boolean`        | :x: |         `false`          |
+|        strings         | Dictionary of tokens - strings for plugin i18n                                                   | `Map<string, string>`  | :x: |    See default config    |
+|        commands        | Dictionary of command text used in Telegram bot                                                  | `Map<string, string>`  | :heavy_check_mark: |        See below         |
+| telegramMessageFormat  | Format string for TGtoMC chat message                                                            |        `string`        | :x: |    See default config    |
+| minecraftMessageFormat | Format string for MCtoTG chat message                                                            |        `string`        | :x: |    See default config    |
+|     silentMessages     | Disable notification in Telegram chats                                                           |       `boolean`        | :x: |    See default config    |
+|       apiOrigin        | Use different API endpoint for the bot                                                           |        `string`        | :x: | https://api.telegram.org |
+|   disableConfigWatch   | Do not watch the config for changes                                                              |        `string`        | :x: | https://api.telegram.org |
 
 
 ## Telegram bot commands:
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -16,7 +16,7 @@ buildscript {
 }
 
 plugins {
-    id("org.jetbrains.kotlin.jvm") version "1.4.31"
+    id("org.jetbrains.kotlin.jvm") version "1.6.10"
     id("com.github.johnrengelman.shadow") version "5.2.0"
     id("org.jlleitschuh.gradle.ktlint") version "10.1.0"
 }
@@ -60,8 +60,8 @@ tasks {
     }
     register<Copy>("copyArtifacts") {
         val dest = File(
-            System.getProperty("user.home"),
-            "MinecraftServers/spigot_1.17/plugins/",
+            System.getenv("HOME"),
+            "projects/minecraft/spigot/spigot-1.18.1/plugins",
         )
         from(shadowJar)
         into(dest)
diff --git a/src/main/kotlin/org/kraftwerk28/spigot_tg_bridge/AsyncJavaPlugin.kt b/src/main/kotlin/org/kraftwerk28/spigot_tg_bridge/AsyncJavaPlugin.kt
@@ -2,10 +2,10 @@ package org.kraftwerk28.spigot_tg_bridge
 
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
-import kotlinx.coroutines.launch
-import kotlinx.coroutines.runBlocking
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.cancelAndJoin
+import kotlinx.coroutines.launch
+import kotlinx.coroutines.runBlocking
 import org.bukkit.plugin.java.JavaPlugin
 
 open class AsyncJavaPlugin : JavaPlugin() {
diff --git a/src/main/kotlin/org/kraftwerk28/spigot_tg_bridge/Configuration.kt b/src/main/kotlin/org/kraftwerk28/spigot_tg_bridge/Configuration.kt
@@ -1,9 +1,14 @@
 package org.kraftwerk28.spigot_tg_bridge
 
+import kotlinx.coroutines.CancellationException
+import kotlinx.coroutines.runInterruptible
+import org.bukkit.configuration.file.YamlConfiguration
 import java.io.File
+import java.nio.file.FileSystems
+import java.nio.file.StandardWatchEventKinds
 import org.kraftwerk28.spigot_tg_bridge.Constants as C
 
-class Configuration(plugin: Plugin) {
+class Configuration(plugin: Plugin) : YamlConfiguration() {
     val isEnabled: Boolean
     val logFromMCtoTG: Boolean
     val telegramFormat: String
@@ -18,6 +23,7 @@ class Configuration(plugin: Plugin) {
     val onlineString: String
     val nobodyOnlineString: String
     val enableIgnAuth: Boolean
+    val silentMessages: Boolean?
 
     // Telegram bot stuff
     val botToken: String
@@ -26,6 +32,8 @@ class Configuration(plugin: Plugin) {
     val allowWebhook: Boolean
     val webhookConfig: Map<String, Any>?
     val pollTimeout: Int
+    val apiOrigin: String
+    val debugHttp: Boolean
 
     var commands: BotCommands
 
@@ -37,74 +45,105 @@ class Configuration(plugin: Plugin) {
             // plugin.saveResource(C.configFilename, false);
             throw Exception(C.WARN.noConfigWarning)
         }
-        val pluginConfig = plugin.config
-        pluginConfig.load(cfgFile)
 
-        pluginConfig.getString("minecraftMessageFormat")?.let {
+        load(cfgFile)
+
+        if (!getBoolean("disableConfigWatch", false)) {
+            try {
+                val watchService = FileSystems.getDefault().newWatchService()
+                val cfgPath = cfgFile.parentFile.toPath()
+                val pathKey = cfgPath.register(watchService, StandardWatchEventKinds.ENTRY_MODIFY)
+                plugin.launch {
+                    loop@ while (true) {
+                        try {
+                            val watchKey = runInterruptible { watchService.take() }
+                            val events = watchKey.pollEvents()
+                            events.find {
+                                it.kind() == StandardWatchEventKinds.ENTRY_MODIFY
+                            }?.let {
+                                plugin.reload()
+                            }
+                        } catch (e: Exception) {
+                            when (e) {
+                                is CancellationException -> break@loop
+                                else -> {
+                                    e.printStackTrace()
+                                    continue@loop
+                                }
+                            }
+                        }
+                    }
+                    pathKey.cancel()
+                }
+            } catch (e: Exception) {
+                plugin.logger.info("Failed to set up watch on config file")
+            }
+        }
+
+        getString("minecraftMessageFormat")?.let {
             plugin.logger.warning(
                 """
                 Config option "minecraftMessageFormat" is deprecated.
                 Moved it to new key "telegramFormat"
                 """.trimIndent().replace('\n', ' ')
             )
-            pluginConfig.set("telegramFormat", it)
-            pluginConfig.set("minecraftMessageFormat", null)
+            set("telegramFormat", it)
+            set("minecraftMessageFormat", null)
             plugin.saveConfig()
         }
 
-        pluginConfig.getString("telegramMessageFormat")?.let {
+        getString("telegramMessageFormat")?.let {
             plugin.logger.warning(
                 """
                 Config option "telegramMessageFormat" is deprecated.
                 Moved it to new key "minecraftFormat"
                 """.trimIndent().replace('\n', ' ')
             )
-            pluginConfig.set("minecraftFormat", it)
-            pluginConfig.set("telegramMessageFormat", null)
+            set("minecraftFormat", it)
+            set("telegramMessageFormat", null)
             plugin.saveConfig()
         }
 
-        pluginConfig.run {
-            isEnabled = getBoolean("enable", true)
-            serverStartMessage = getString("serverStartMessage")
-            serverStopMessage = getString("serverStopMessage")
-            logFromTGtoMC = getBoolean("logFromTGtoMC", true)
-            logFromMCtoTG = getBoolean("logFromMCtoTG", true)
-            telegramFormat = getString(
-                "telegramFormat",
-                "<i>%username%</i>: %message%",
-            )!!
-            minecraftFormat = getString(
-                "minecraftFormat",
-                "<%username%>: %message%",
-            )!!
-            // isEnabled = getBoolean("enable", true)
-            allowedChats = getLongList("chats")
-            enableIgnAuth = getBoolean("enableIgnAuth", false)
+        isEnabled = getBoolean("enable", true)
+        serverStartMessage = getString("serverStartMessage")
+        serverStopMessage = getString("serverStopMessage")
+        logFromTGtoMC = getBoolean("logFromTGtoMC", true)
+        logFromMCtoTG = getBoolean("logFromMCtoTG", true)
+        telegramFormat = getString(
+            "telegramFormat",
+            "<i>%username%</i>: %message%",
+        )!!
+        minecraftFormat = getString(
+            "minecraftFormat",
+            "<%username%>: %message%",
+        )!!
+        // isEnabled = getBoolean("enable", true)
+        allowedChats = getLongList("chats")
+        enableIgnAuth = getBoolean("enableIgnAuth", false)
 
-            botToken = getString("botToken") ?: throw Exception(C.WARN.noToken)
-            allowWebhook = getBoolean("useWebhook", false)
-            @Suppress("unchecked_cast")
-            webhookConfig = get("webhookConfig") as Map<String, Any>?
-            pollTimeout = getInt("pollTimeout", 30)
-
-            logJoinLeave = getBoolean("logJoinLeave", false)
-            onlineString = getString("strings.online", "Online")!!
-            nobodyOnlineString = getString(
-                "strings.nobodyOnline",
-                "Nobody online",
-            )!!
-            joinString = getString(
-                "strings.joined",
-                "<i>%username%</i> joined.",
-            )!!
-            leaveString = getString("strings.left", "<i>%username%</i> left.")!!
-            logDeath = getBoolean("logPlayerDeath", false)
-            logPlayerAsleep = getBoolean("logPlayerAsleep", false)
-            commands = BotCommands(this)
-        }
-    }
+        botToken = getString("botToken") ?: throw Exception(C.WARN.noToken)
+        allowWebhook = getBoolean("useWebhook", false)
+        @Suppress("unchecked_cast")
+        webhookConfig = get("webhookConfig") as Map<String, Any>?
+        pollTimeout = getInt("pollTimeout", 30)
 
-    companion object {
+        logJoinLeave = getBoolean("logJoinLeave", false)
+        onlineString = getString("strings.online", "Online")!!
+        nobodyOnlineString = getString(
+            "strings.nobodyOnline",
+            "Nobody online",
+        )!!
+        joinString = getString(
+            "strings.joined",
+            "<i>%username%</i> joined.",
+        )!!
+        leaveString = getString("strings.left", "<i>%username%</i> left.")!!
+        logDeath = getBoolean("logPlayerDeath", false)
+        logPlayerAsleep = getBoolean("logPlayerAsleep", false)
+        commands = BotCommands(this)
+        // NB: Setting to null, if false, because API expects either `true` or absent parameter
+        silentMessages = getBoolean("silentMessages").let { if (!it) null else true }
+        apiOrigin = getString("apiOrigin", "https://api.telegram.org")!!
+        debugHttp = getBoolean("debugHttp", false)
     }
 }
diff --git a/src/main/kotlin/org/kraftwerk28/spigot_tg_bridge/Plugin.kt b/src/main/kotlin/org/kraftwerk28/spigot_tg_bridge/Plugin.kt
@@ -1,9 +1,7 @@
 package org.kraftwerk28.spigot_tg_bridge
 
-import kotlinx.coroutines.delay
 import org.bukkit.event.HandlerList
 import java.lang.Exception
-import kotlin.system.measureTimeMillis
 import org.kraftwerk28.spigot_tg_bridge.Constants as C
 
 class Plugin : AsyncJavaPlugin() {
diff --git a/src/main/kotlin/org/kraftwerk28/spigot_tg_bridge/TgApiService.kt b/src/main/kotlin/org/kraftwerk28/spigot_tg_bridge/TgApiService.kt
@@ -16,6 +16,7 @@ interface TgApiService {
         @Query("chat_id") chatId: Long,
         @Query("text") text: String,
         @Query("reply_to_message_id") replyToMessageId: Long? = null,
+        @Query("disable_notification") disableNotification: Boolean? = null,
     ): TgResponse<Message>
 
     @GET("getUpdates")
diff --git a/src/main/kotlin/org/kraftwerk28/spigot_tg_bridge/TgBot.kt b/src/main/kotlin/org/kraftwerk28/spigot_tg_bridge/TgBot.kt
@@ -6,6 +6,7 @@ import kotlinx.coroutines.cancelAndJoin
 import kotlinx.coroutines.channels.Channel
 import kotlinx.coroutines.channels.consumeEach
 import okhttp3.OkHttpClient
+import okhttp3.logging.HttpLoggingInterceptor
 import retrofit2.Retrofit
 import retrofit2.converter.gson.GsonConverterFactory
 import java.time.Duration
@@ -26,10 +27,18 @@ class TgBot(
 ) {
     private val client: OkHttpClient = OkHttpClient
         .Builder()
+        // Disable timeout to make long-polling possible
         .readTimeout(Duration.ZERO)
+        .addInterceptor(
+            HttpLoggingInterceptor().apply {
+                level =
+                    if (config.debugHttp) HttpLoggingInterceptor.Level.BODY
+                    else HttpLoggingInterceptor.Level.NONE
+            }
+        )
         .build()
     private val api = Retrofit.Builder()
-        .baseUrl("https://api.telegram.org/bot${config.botToken}/")
+        .baseUrl("${config.apiOrigin}/bot${config.botToken}/")
         .client(client)
         .addConverterFactory(GsonConverterFactory.create())
         .build()
@@ -183,11 +192,13 @@ class TgBot(
         val chatId = msg.chat.id
         val text = """
         |Chat ID: <code>$chatId</code>.
-        |Copy this id to <code>chats</code> section in your <b>config.yml</b> file so it will look like this:
-        |
-        |<pre>chats:
-        |  # other ids...
-        |  - $chatId</pre>
+        |Copy this id to <code>chats</code> section in your <b>config.yml</b> file so it looks like this:
+        |<pre>
+        |chats: [
+        |  $chatId,
+        |  # other chat ids...
+        |]
+        |</pre>
         """.trimMargin()
         api.sendMessage(chatId, text, replyToMessageId = msg.messageId)
     }
@@ -247,7 +258,11 @@ class TgBot(
                 .replace(C.MESSAGE_TEXT_PLACEHOLDER, text.escapeHtml())
         } ?: text
         config.allowedChats.forEach { chatId ->
-            api.sendMessage(chatId, formatted)
+            try {
+                api.sendMessage(chatId, formatted, disableNotification = config.silentMessages)
+            } catch (e: Exception) {
+                e.printStackTrace()
+            }
         }
     }
 }
diff --git a/src/main/kotlin/org/kraftwerk28/spigot_tg_bridge/Utils.kt b/src/main/kotlin/org/kraftwerk28/spigot_tg_bridge/Utils.kt
@@ -31,7 +31,7 @@ fun User.rawUserMention(): String =
 
 fun DbLinkedUser.fullName() = tgFirstName + (tgLastName?.let { " $it" } ?: "")
 
-fun Connection.stmt(query: String, vararg args: Any?) =
+fun Connection.stmt(query: String, vararg args: Any?): PreparedStatement =
     prepareStatement(query).apply {
         args.zip(1..args.size).forEach { (arg, i) ->
             when (arg) {
@@ -42,7 +42,7 @@ fun Connection.stmt(query: String, vararg args: Any?) =
         }
     }
 
-suspend fun checkMinecraftLicense(playerUuid: String): Boolean = try {
+fun checkMinecraftLicense(playerUuid: String): Boolean = try {
     val urlString = "https://api.mojang.com/user/profiles/$playerUuid/names"
     val conn = (URL(urlString).openConnection() as HttpURLConnection).apply {
         requestMethod = "GET"
@@ -53,7 +53,7 @@ suspend fun checkMinecraftLicense(playerUuid: String): Boolean = try {
     false
 }
 
-suspend fun getMinecraftUuidByUsername(username: String): String? = try {
+fun getMinecraftUuidByUsername(username: String): String? = try {
     val urlString = "https://api.mojang.com/users/profiles/minecraft/$username"
     val conn = (URL(urlString).openConnection() as HttpURLConnection).apply {
         requestMethod = "GET"
diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml
@@ -1,7 +1,6 @@
 enable: true
 botToken: abcdef123456789
-chats:
-  - -1234567890123
+chats: []
 serverStartMessage: "Server started."
 serverStopMessage: "Server stopped."
 logJoinLeave: true
@@ -11,6 +10,7 @@ logPlayerDeath: true
 logPlayerAsleep: false
 minecraftFormat: "§6§l%username%§r (from §o%chat%§r): §b%message%§r"
 telegramFormat: "<i>%username%</i>: %message%"
+silentMessages: false
 strings:
   online: "<b>Online</b>"
   nobodyOnline: "<b>Nobody online...</b>"
diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml

Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@ buildscript {`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`plugins {`
`19`		`- id("org.jetbrains.kotlin.jvm") version "1.4.31"`
	`19`	`+ id("org.jetbrains.kotlin.jvm") version "1.6.10"`
`20`	`20`	`id("com.github.johnrengelman.shadow") version "5.2.0"`
`21`	`21`	`id("org.jlleitschuh.gradle.ktlint") version "10.1.0"`
`22`	`22`	`}`
`@@ -60,8 +60,8 @@ tasks {`
`60`	`60`	`}`
`61`	`61`	`register<Copy>("copyArtifacts") {`
`62`	`62`	`val dest = File(`
`63`		`- System.getProperty("user.home"),`
`64`		`- "MinecraftServers/spigot_1.17/plugins/",`
	`63`	`+ System.getenv("HOME"),`
	`64`	`+ "projects/minecraft/spigot/spigot-1.18.1/plugins",`
`65`	`65`	`)`
`66`	`66`	`from(shadowJar)`
`67`	`67`	`into(dest)`