mirror of
https://github.com/InsanusMokrassar/PlaguBot.git
synced 2026-05-01 14:22:27 +00:00
Compare commits
69 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 693d552ad2 | |||
| 247a47909d | |||
| 07fc280c8c | |||
| 7cb5490d68 | |||
| 09dc600b20 | |||
| 57abe2285c | |||
| 167780e847 | |||
| a9c4f789b5 | |||
| 728270cac0 | |||
| 8d5376b613 | |||
| e9ed711724 | |||
| bd26cbd4d8 | |||
| 8b7ca70d5f | |||
| e356abc373 | |||
| fdff6c7178 | |||
| 636614e4e3 | |||
| 9747bcd79d | |||
| f8b7e261f4 | |||
| 0a5272b1c8 | |||
| 214403ee88 | |||
| c19a4bbcf9 | |||
| 58ba7c1e32 | |||
| 431b1bf1f2 | |||
| ad23cc9202 | |||
| e9bf2dfc64 | |||
| 61ea5e93b3 | |||
| ff0d819bd2 | |||
| 1919d8840a | |||
| 98c539b198 | |||
| 7e02bb3583 | |||
| d6e10d1dd1 | |||
| b30aee0109 | |||
| be45f94070 | |||
| 485d0d1fbf | |||
| 69e97223ce | |||
| f067033678 | |||
| 37920521a0 | |||
| d78f8adbea | |||
| 487ce413f1 | |||
| 556ded1e84 | |||
| 605fb956a4 | |||
| b907f8d53b | |||
| 2a0cd5d6a8 | |||
| 00f3485959 | |||
| 856ae65fa8 | |||
| d9488f8ccd | |||
| 2f06a65cc6 | |||
| f3e6b55861 | |||
| 7bdb525f01 | |||
| e6a2add7f8 | |||
| 3d7cb28c92 | |||
| 81a1ed6613 | |||
| b43efb4255 | |||
| 8d3d9f8c6a | |||
| 6cb241642b | |||
| f551f471d9 | |||
| 4342e04e3f | |||
| a7fe1e3d82 | |||
| c2d6afccc2 | |||
| d928db7e74 | |||
| 893f3a95a1 | |||
| f9b7d444a6 | |||
| 47f5086ebd | |||
| bc29d4f83a | |||
| 26b34a470b | |||
| 3b507a5668 | |||
| bb06ba1ca7 | |||
| d772d275b3 | |||
| e1e7c7a547 |
161
CHANGELOG.md
161
CHANGELOG.md
@@ -1,5 +1,166 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 11.1.1
|
||||||
|
|
||||||
|
* `Bot`:
|
||||||
|
* Logic of creating `HttpClient` now works even if proxy is ommited
|
||||||
|
|
||||||
|
## 11.1.0
|
||||||
|
|
||||||
|
* `Bot`:
|
||||||
|
* Add opportunity to setup proxy
|
||||||
|
|
||||||
|
## 11.0.0
|
||||||
|
|
||||||
|
* `Versions`:
|
||||||
|
* `kotlin`: `2.3.10`
|
||||||
|
* `serialization`: `1.10.0`
|
||||||
|
* `microutils`: `0.29.1`
|
||||||
|
* `tgbotapi`: `32.0.0`
|
||||||
|
* `exposed`: `1.1.1`
|
||||||
|
* `sqlite`: `3.51.2.0`
|
||||||
|
|
||||||
|
## 10.10.0
|
||||||
|
|
||||||
|
* `Versions`:
|
||||||
|
* `kotlin`: `2.2.21`
|
||||||
|
* `microutils`: `0.26.8`
|
||||||
|
* `tgbotapi`: `30.0.2`
|
||||||
|
|
||||||
|
## 10.9.0
|
||||||
|
|
||||||
|
* `Versions`:
|
||||||
|
* `kotlin`: `2.2.20`
|
||||||
|
* `microutils`: `0.26.6`
|
||||||
|
* `tgbotapi`: `30.0.0`
|
||||||
|
* `koin`: `4.1.1`
|
||||||
|
|
||||||
|
## 10.8.0
|
||||||
|
|
||||||
|
* `Versions`:
|
||||||
|
* `kotlin`: `2.2.10`
|
||||||
|
* `microutils`: `0.26.3`
|
||||||
|
* `tgbotapi`: `28.0.1`
|
||||||
|
|
||||||
|
## 10.7.0
|
||||||
|
|
||||||
|
* `Versions`:
|
||||||
|
* `kotlin`: `2.2.0`
|
||||||
|
* `serialization`: `1.9.0`
|
||||||
|
* `microutils`: `0.26.2`
|
||||||
|
* `tgbotapi`: `27.1.1`
|
||||||
|
* `koin`: `4.1.0`
|
||||||
|
|
||||||
|
## 10.6.0
|
||||||
|
|
||||||
|
* `Versions`:
|
||||||
|
* `microutils`: `0.25.8`
|
||||||
|
* `tgbotapi`: `26.0.0`
|
||||||
|
* `sqlite`: `3.50.1.0`
|
||||||
|
|
||||||
|
## 10.5.0
|
||||||
|
|
||||||
|
* `Versions`:
|
||||||
|
* `kotlin`: `2.1.20`
|
||||||
|
* `serialization`: `1.8.1`
|
||||||
|
* `coroutines`: `1.10.2`
|
||||||
|
* `microutils`: `0.25.5`
|
||||||
|
* `tgbotapi`: `24.0.2`
|
||||||
|
* `exposed`: `0.61.0`
|
||||||
|
* `sqlite`: `3.49.1.0`
|
||||||
|
* `koin`: `4.0.4`
|
||||||
|
|
||||||
|
## 10.4.0
|
||||||
|
|
||||||
|
* `Versions`:
|
||||||
|
* `microutils`: `0.24.6`
|
||||||
|
* `tgbotapi`: `23.2.0`
|
||||||
|
* `exposed`: `0.59.0`
|
||||||
|
* `sqlite`: `3.49.0.0`
|
||||||
|
|
||||||
|
## 10.3.1
|
||||||
|
|
||||||
|
* `Versions`:
|
||||||
|
* `kotlin`: `2.1.10`
|
||||||
|
* `serialization`: `1.8.0`
|
||||||
|
* `coroutines`: `1.10.1`
|
||||||
|
* `microutils`: `0.24.5`
|
||||||
|
* `tgbotapi`: `23.1.2`
|
||||||
|
* `exposed`: `0.58.0`
|
||||||
|
* `sqlite`: `3.48.0.0`
|
||||||
|
* `koin`: `4.0.2`
|
||||||
|
|
||||||
|
## 10.3.0
|
||||||
|
|
||||||
|
* `Versions`:
|
||||||
|
* `microutils`: `0.23.2`
|
||||||
|
* `tgbotapi`: `22.0.0`
|
||||||
|
* `exposed`: `0.57.0`
|
||||||
|
|
||||||
|
## 10.2.1
|
||||||
|
|
||||||
|
* `Versions`:
|
||||||
|
* `tgbotapi`: `21.0.1`
|
||||||
|
* `Bot`:
|
||||||
|
* Now all `CombinedSubcontextInitialAction.SubItem`s will be taken from `Koin` to setup root `subcontextInitialAction`
|
||||||
|
|
||||||
|
## 10.2.0
|
||||||
|
|
||||||
|
* `Versions`:
|
||||||
|
* `kotlin`: `2.1.0`
|
||||||
|
* `microutils`: `0.23.1`
|
||||||
|
* `tgbotapi`: `21.0.0`
|
||||||
|
* `exposed`: `0.56.0`
|
||||||
|
* `sqlite`: `3.47.1.0`
|
||||||
|
|
||||||
|
## 10.1.1
|
||||||
|
|
||||||
|
* `Versions`:
|
||||||
|
* `tgbotapi`: `20.0.1`
|
||||||
|
|
||||||
|
## 10.1.0
|
||||||
|
|
||||||
|
* `Versions`:
|
||||||
|
* `kotlin`: `2.0.21`
|
||||||
|
* `serialization`: `1.7.3`
|
||||||
|
* `coroutines`: `1.9.0`
|
||||||
|
* `microutils`: `0.23.0`
|
||||||
|
* `tgbotapi`: `20.0.0`
|
||||||
|
* `exposed`: `0.55.0`
|
||||||
|
* `sqlite`: `3.47.0.0`
|
||||||
|
* `koin`: `4.0.0`
|
||||||
|
|
||||||
|
## 10.0.0
|
||||||
|
|
||||||
|
**OVERALL LOGIC OF PLAGUBOT INITIALIZATION AND WORK HAS BEEN CHANGED**
|
||||||
|
|
||||||
|
First of all, since this update `PlaguBot` will use default `StartPlugin` logic and will be built on top of it.
|
||||||
|
All special methods of `Plugin` will be called from one of `PlaguBot` initialization phases:
|
||||||
|
|
||||||
|
* `setupBotClient` will be called from `single` initialization of `telegramBot` (in `setupDI` phase)
|
||||||
|
* `setupBotPlugin` will be called from `startPlugin` method in time of `buildBehaviourWithFSM` initialization
|
||||||
|
|
||||||
|
* `Plugin`:
|
||||||
|
* Extension `Module.setupDI(Database,JsonObject)` has been dropped. Use `database` extension in `Module.setupDI(JsonObject)`
|
||||||
|
* `Bot`:
|
||||||
|
* `dev.inmo.plagubot.config.Config` lost its `plugins` section. Now you may retrieve plugins from `Koin` only
|
||||||
|
* `defaultJsonFormat` became `Warning` feature due to the fact of its fully default nature
|
||||||
|
* `PlaguBot` lost old `start` method and took two new: with `args` as `Array<String>` and `initialConfig` as `JsonObject`
|
||||||
|
|
||||||
|
**Migration:**
|
||||||
|
|
||||||
|
* If you are running bot and doing it using `StartPlugin` launcher, add `dev.inmo.plagubot.PlaguBot` explicitly
|
||||||
|
* In plugins: replace your `setupDI` overrides with `Database` as argument by the same one, but `database` will be
|
||||||
|
available as extension in `single` or `factory` calls (as extension to `Scope` and `Koin`)
|
||||||
|
|
||||||
|
## 9.3.0
|
||||||
|
|
||||||
|
* `Bot`:
|
||||||
|
* Now bot is not built-in into `PlaguBot` and setted up as all other `Koin` dependencies
|
||||||
|
* Now it is possible to use `testServer` parameter for bots out of the box
|
||||||
|
* `Plugin`:
|
||||||
|
* New method `setupBotClient` with arguments to let plugin setup bot more freely
|
||||||
|
|
||||||
## 9.2.0
|
## 9.2.0
|
||||||
|
|
||||||
* `Versions`:
|
* `Versions`:
|
||||||
|
|||||||
15
README.md
15
README.md
@@ -19,6 +19,8 @@ That is a set of libraries for plagubots. Look at the
|
|||||||
|
|
||||||
### Technical help
|
### Technical help
|
||||||
|
|
||||||
|
#### FSM
|
||||||
|
|
||||||
In this bot has been used variant with FSM. That means that you may use all the [Behaviour Builder with FSM](https://bookstack.inmo.dev/books/telegrambotapi/page/behaviour-builder-with-fsm) functionality. In case you wish to setup states repo, you should use the next code in the `setupDI` of your plugin:
|
In this bot has been used variant with FSM. That means that you may use all the [Behaviour Builder with FSM](https://bookstack.inmo.dev/books/telegrambotapi/page/behaviour-builder-with-fsm) functionality. In case you wish to setup states repo, you should use the next code in the `setupDI` of your plugin:
|
||||||
|
|
||||||
```kotlin
|
```kotlin
|
||||||
@@ -41,3 +43,16 @@ single<StateHandlingErrorHandler<State>> {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### Subcontext initial actions
|
||||||
|
|
||||||
|
Bot will take all the `CombinedSubcontextInitialAction.SubItem`s from `Koin` to include it in root of
|
||||||
|
`behaviourBuilder`. To create your own subitem:
|
||||||
|
|
||||||
|
```kotlin
|
||||||
|
singleWithRandomQualifier<CombinedSubcontextInitialAction.SubItem> {
|
||||||
|
CombinedSubcontextInitialAction.SubItem {
|
||||||
|
// do some action or throw error to rerun on next round
|
||||||
|
}
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|||||||
@@ -22,6 +22,8 @@ dependencies {
|
|||||||
api libs.microutils.koin
|
api libs.microutils.koin
|
||||||
api libs.microutils.startup.launcher
|
api libs.microutils.startup.launcher
|
||||||
|
|
||||||
|
api libs.ktor.engine.okhttp
|
||||||
|
|
||||||
api libs.sqlite
|
api libs.sqlite
|
||||||
|
|
||||||
testImplementation libs.kt.test.junit
|
testImplementation libs.kt.test.junit
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
|
|
||||||
apply plugin: 'maven-publish'
|
apply plugin: 'maven-publish'
|
||||||
|
|
||||||
|
|
||||||
task javadocJar(type: Jar) {
|
task javadocJar(type: Jar) {
|
||||||
from javadoc
|
from javadoc
|
||||||
archiveClassifier = 'javadoc'
|
archiveClassifier = 'javadoc'
|
||||||
@@ -48,30 +50,28 @@ publishing {
|
|||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
repositories {
|
}
|
||||||
if ((project.hasProperty('INMONEXUS_USER') || System.getenv('INMONEXUS_USER') != null) && (project.hasProperty('INMONEXUS_PASSWORD') || System.getenv('INMONEXUS_PASSWORD') != null)) {
|
}
|
||||||
maven {
|
repositories {
|
||||||
name = "InmoNexus"
|
if ((project.hasProperty('INMONEXUS_USER') || System.getenv('INMONEXUS_USER') != null) && (project.hasProperty('INMONEXUS_PASSWORD') || System.getenv('INMONEXUS_PASSWORD') != null)) {
|
||||||
url = uri("https://nexus.inmo.dev/repository/maven-releases/")
|
maven {
|
||||||
|
name = "InmoNexus"
|
||||||
credentials {
|
url = uri("https://nexus.inmo.dev/repository/maven-releases/")
|
||||||
username = project.hasProperty('INMONEXUS_USER') ? project.property('INMONEXUS_USER') : System.getenv('INMONEXUS_USER')
|
|
||||||
password = project.hasProperty('INMONEXUS_PASSWORD') ? project.property('INMONEXUS_PASSWORD') : System.getenv('INMONEXUS_PASSWORD')
|
credentials {
|
||||||
}
|
username = project.hasProperty('INMONEXUS_USER') ? project.property('INMONEXUS_USER') : System.getenv('INMONEXUS_USER')
|
||||||
|
password = project.hasProperty('INMONEXUS_PASSWORD') ? project.property('INMONEXUS_PASSWORD') : System.getenv('INMONEXUS_PASSWORD')
|
||||||
}
|
|
||||||
}
|
}
|
||||||
if ((project.hasProperty('SONATYPE_USER') || System.getenv('SONATYPE_USER') != null) && (project.hasProperty('SONATYPE_PASSWORD') || System.getenv('SONATYPE_PASSWORD') != null)) {
|
}
|
||||||
maven {
|
}
|
||||||
name = "sonatype"
|
if ((project.hasProperty('SONATYPE_USER') || System.getenv('SONATYPE_USER') != null) && (project.hasProperty('SONATYPE_PASSWORD') || System.getenv('SONATYPE_PASSWORD') != null)) {
|
||||||
url = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
|
maven {
|
||||||
|
name = "sonatype"
|
||||||
credentials {
|
url = uri("https://ossrh-staging-api.central.sonatype.com/service/local/staging/deploy/maven2/")
|
||||||
username = project.hasProperty('SONATYPE_USER') ? project.property('SONATYPE_USER') : System.getenv('SONATYPE_USER')
|
|
||||||
password = project.hasProperty('SONATYPE_PASSWORD') ? project.property('SONATYPE_PASSWORD') : System.getenv('SONATYPE_PASSWORD')
|
credentials {
|
||||||
}
|
username = project.hasProperty('SONATYPE_USER') ? project.property('SONATYPE_USER') : System.getenv('SONATYPE_USER')
|
||||||
|
password = project.hasProperty('SONATYPE_PASSWORD') ? project.property('SONATYPE_PASSWORD') : System.getenv('SONATYPE_PASSWORD')
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -80,13 +80,13 @@ publishing {
|
|||||||
|
|
||||||
if (project.hasProperty("signing.gnupg.keyName")) {
|
if (project.hasProperty("signing.gnupg.keyName")) {
|
||||||
apply plugin: 'signing'
|
apply plugin: 'signing'
|
||||||
|
|
||||||
signing {
|
signing {
|
||||||
useGpgCmd()
|
useGpgCmd()
|
||||||
|
|
||||||
sign publishing.publications
|
sign publishing.publications
|
||||||
}
|
}
|
||||||
|
|
||||||
task signAll {
|
task signAll {
|
||||||
tasks.withType(Sign).forEach {
|
tasks.withType(Sign).forEach {
|
||||||
dependsOn(it)
|
dependsOn(it)
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
{"licenses":[{"id":"Apache-2.0","title":"Apache Software License 2.0","url":"https://github.com/InsanusMokrassar/PlaguBot/LICENSE"}],"mavenConfig":{"name":"PlaguBot Bot","description":"Base PlaguBot project","url":"https://github.com/InsanusMokrassar/PlaguBot","vcsUrl":"ssh://git@github.com/InsanusMokrassar/PlaguBot.git","developers":[{"id":"InsanusMokrassar","name":"Aleksei Ovsiannikov","eMail":"ovsyannikov.alexey95@gmail.com"}],"repositories":[{"name":"InmoNexus","url":"https://nexus.inmo.dev/repository/maven-releases/"},{"name":"sonatype","url":"https://oss.sonatype.org/service/local/staging/deploy/maven2/"}],"gpgSigning":{"type":"dev.inmo.kmppscriptbuilder.core.models.GpgSigning.Optional"}},"type":"JVM"}
|
{"licenses":[{"id":"Apache-2.0","title":"Apache Software License 2.0","url":"https://github.com/InsanusMokrassar/PlaguBot/LICENSE"}],"mavenConfig":{"name":"PlaguBot Bot","description":"Base PlaguBot project","url":"https://github.com/InsanusMokrassar/PlaguBot","vcsUrl":"ssh://git@github.com/InsanusMokrassar/PlaguBot.git","developers":[{"id":"InsanusMokrassar","name":"Aleksei Ovsiannikov","eMail":"ovsyannikov.alexey95@gmail.com"}],"repositories":[{"name":"InmoNexus","url":"https://nexus.inmo.dev/repository/maven-releases/"},{"name":"sonatype","url":"https://ossrh-staging-api.central.sonatype.com/service/local/staging/deploy/maven2/"}],"gpgSigning":{"type":"dev.inmo.kmppscriptbuilder.core.models.GpgSigning.Optional"}},"type":"JVM"}
|
||||||
@@ -1,25 +1,11 @@
|
|||||||
package dev.inmo.plagubot
|
package dev.inmo.plagubot
|
||||||
|
|
||||||
import dev.inmo.kslog.common.KSLog
|
|
||||||
import dev.inmo.kslog.common.i
|
|
||||||
import dev.inmo.plagubot.config.Config
|
|
||||||
import dev.inmo.plagubot.config.defaultJsonFormat
|
|
||||||
import kotlinx.serialization.InternalSerializationApi
|
import kotlinx.serialization.InternalSerializationApi
|
||||||
import kotlinx.serialization.json.jsonObject
|
|
||||||
import java.io.File
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This method by default expects one argument in [args] field: path to config
|
* This method by default expects one argument in [args] field: path to config
|
||||||
*/
|
*/
|
||||||
@InternalSerializationApi
|
@InternalSerializationApi
|
||||||
suspend fun main(args: Array<String>) {
|
suspend fun main(args: Array<String>) {
|
||||||
KSLog.default = KSLog("PlaguBot")
|
PlaguBot.start(args).join()
|
||||||
val (configPath) = args
|
|
||||||
val file = File(configPath)
|
|
||||||
KSLog.i("Start read config from ${file.absolutePath}")
|
|
||||||
val json = defaultJsonFormat.parseToJsonElement(file.readText()).jsonObject
|
|
||||||
val config = defaultJsonFormat.decodeFromJsonElement(Config.serializer(), json)
|
|
||||||
KSLog.i("Config has been read")
|
|
||||||
|
|
||||||
PlaguBot(json, config).start().join()
|
|
||||||
}
|
}
|
||||||
|
|||||||
28
bot/src/main/kotlin/dev/inmo/plagubot/KoinExtensions.kt
Normal file
28
bot/src/main/kotlin/dev/inmo/plagubot/KoinExtensions.kt
Normal file
@@ -0,0 +1,28 @@
|
|||||||
|
package dev.inmo.plagubot
|
||||||
|
|
||||||
|
import org.koin.core.Koin
|
||||||
|
import org.koin.core.definition.Definition
|
||||||
|
import org.koin.core.module.Module
|
||||||
|
import org.koin.core.qualifier.Qualifier
|
||||||
|
import org.koin.core.qualifier.StringQualifier
|
||||||
|
import org.koin.core.scope.Scope
|
||||||
|
|
||||||
|
|
||||||
|
val Scope.plagubot: PlaguBot
|
||||||
|
get() = get()
|
||||||
|
|
||||||
|
val Koin.plagubot: PlaguBot
|
||||||
|
get() = get()
|
||||||
|
|
||||||
|
private val pluginsQualifier = StringQualifier("plagubotPlugins")
|
||||||
|
internal fun Module.singlePlugins(
|
||||||
|
createdAtStart: Boolean = false,
|
||||||
|
definition: Definition<List<Plugin>>
|
||||||
|
) = single(pluginsQualifier, createdAtStart, definition)
|
||||||
|
val Scope.plugins: List<Plugin>
|
||||||
|
get() = get(pluginsQualifier)
|
||||||
|
|
||||||
|
val Koin.plugins: List<Plugin>
|
||||||
|
get() = get(pluginsQualifier)
|
||||||
|
|
||||||
|
|
||||||
@@ -2,105 +2,178 @@ package dev.inmo.plagubot
|
|||||||
|
|
||||||
import dev.inmo.kslog.common.*
|
import dev.inmo.kslog.common.*
|
||||||
import dev.inmo.micro_utils.common.Warning
|
import dev.inmo.micro_utils.common.Warning
|
||||||
import dev.inmo.micro_utils.coroutines.runCatchingSafely
|
import dev.inmo.micro_utils.coroutines.runCatchingLogging
|
||||||
import dev.inmo.micro_utils.fsm.common.State
|
import dev.inmo.micro_utils.fsm.common.State
|
||||||
import dev.inmo.micro_utils.fsm.common.StatesManager
|
import dev.inmo.micro_utils.fsm.common.StatesManager
|
||||||
import dev.inmo.micro_utils.fsm.common.managers.*
|
import dev.inmo.micro_utils.fsm.common.managers.*
|
||||||
import dev.inmo.micro_utils.koin.getAllDistinct
|
import dev.inmo.micro_utils.koin.getAllDistinct
|
||||||
|
import dev.inmo.micro_utils.startup.launcher.StartLauncherPlugin
|
||||||
import dev.inmo.plagubot.config.*
|
import dev.inmo.plagubot.config.*
|
||||||
|
import dev.inmo.tgbotapi.bot.TelegramBot
|
||||||
import dev.inmo.tgbotapi.bot.ktor.KtorRequestsExecutorBuilder
|
import dev.inmo.tgbotapi.bot.ktor.KtorRequestsExecutorBuilder
|
||||||
import dev.inmo.tgbotapi.bot.ktor.telegramBot
|
import dev.inmo.tgbotapi.bot.ktor.telegramBot
|
||||||
import dev.inmo.tgbotapi.extensions.api.webhook.deleteWebhook
|
import dev.inmo.tgbotapi.extensions.api.webhook.deleteWebhook
|
||||||
import dev.inmo.tgbotapi.extensions.behaviour_builder.*
|
import dev.inmo.tgbotapi.extensions.behaviour_builder.*
|
||||||
import dev.inmo.tgbotapi.extensions.utils.updates.retrieving.startGettingOfUpdatesByLongPolling
|
import dev.inmo.tgbotapi.extensions.utils.updates.retrieving.startGettingOfUpdatesByLongPolling
|
||||||
|
import io.ktor.client.HttpClient
|
||||||
|
import io.ktor.client.engine.HttpClientEngine
|
||||||
|
import io.ktor.client.engine.HttpClientEngineFactory
|
||||||
|
import io.ktor.client.engine.okhttp.OkHttp
|
||||||
import kotlinx.coroutines.*
|
import kotlinx.coroutines.*
|
||||||
import kotlinx.serialization.Serializable
|
import kotlinx.serialization.Serializable
|
||||||
import kotlinx.serialization.Transient
|
import kotlinx.serialization.json.*
|
||||||
import kotlinx.serialization.json.JsonObject
|
|
||||||
import org.jetbrains.exposed.sql.Database
|
|
||||||
import org.koin.core.Koin
|
import org.koin.core.Koin
|
||||||
import org.koin.core.KoinApplication
|
|
||||||
import org.koin.core.context.GlobalContext
|
|
||||||
import org.koin.core.module.Module
|
import org.koin.core.module.Module
|
||||||
import org.koin.core.scope.Scope
|
import org.koin.core.scope.Scope
|
||||||
import org.koin.dsl.module
|
import java.io.File
|
||||||
|
|
||||||
val Scope.plagubot: PlaguBot
|
|
||||||
get() = get()
|
|
||||||
|
|
||||||
val Koin.plagubot: PlaguBot
|
|
||||||
get() = get()
|
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Central plugin-object that:
|
||||||
|
* - Provides DI bindings for the bot, configuration and optional database
|
||||||
|
* - Creates and configures Telegram bot client
|
||||||
|
* - Builds BehaviourBuilder with FSM support and launches long polling
|
||||||
|
* - Loads and initializes other plugins
|
||||||
|
* - Exposes several start(...) overloads to bootstrap the application from JSON or strongly-typed configs
|
||||||
|
*
|
||||||
|
* Typical usage:
|
||||||
|
* - Prepare JSON or typed configs
|
||||||
|
* - Call one of start(...) methods
|
||||||
|
* - The returned Job represents the bot lifecycle; awaiting it keeps the app running
|
||||||
|
*/
|
||||||
@OptIn(Warning::class)
|
@OptIn(Warning::class)
|
||||||
@Serializable
|
@Serializable
|
||||||
data class PlaguBot(
|
object PlaguBot : Plugin {
|
||||||
private val json: JsonObject,
|
/**
|
||||||
private val config: Config
|
* JSON format used for encoding/decoding PlaguBot-related configuration.
|
||||||
) : Plugin {
|
*
|
||||||
@Transient
|
* Note:
|
||||||
private val bot = telegramBot(
|
* - This property is not reactive. Set it only before starting the bot to affect configuration parsing/serialization.
|
||||||
token = config.botToken,
|
*/
|
||||||
apiUrl = config.botApiServer
|
var defaultJsonFormat = dev.inmo.plagubot.config.defaultJsonFormat
|
||||||
) {
|
@Warning("This is not reactive set. Use this only BEFORE starting of bot") set
|
||||||
setupBotClient()
|
|
||||||
}
|
|
||||||
|
|
||||||
override fun KtorRequestsExecutorBuilder.setupBotClient() {
|
/**
|
||||||
config.botPlugins.forEach {
|
* Allows other plugins to customize the [KtorRequestsExecutorBuilder] used by the bot client.
|
||||||
|
*
|
||||||
|
* For each plugin in DI (excluding this object), calls its own setupBotClient, passing the same [scope] and [params].
|
||||||
|
*
|
||||||
|
* @param scope Koin scope where the bot is being created
|
||||||
|
* @param params Raw JSON params of the bot part of the configuration
|
||||||
|
*/
|
||||||
|
override fun KtorRequestsExecutorBuilder.setupBotClient(scope: Scope, params: JsonObject) {
|
||||||
|
val config = scope.get<Config>()
|
||||||
|
val clientFromHttpClientEngine = scope.getOrNull<HttpClientEngine>() ?.let {
|
||||||
|
HttpClient(it)
|
||||||
|
}
|
||||||
|
val clientFromKoin = clientFromHttpClientEngine ?: (scope.getOrNull<HttpClientEngineFactory<*>>() ?: OkHttp).let {
|
||||||
|
HttpClient(it)
|
||||||
|
}
|
||||||
|
this@setupBotClient.client = if (config.proxy != null) {
|
||||||
|
val initialClient = config.proxy.createDefaultClient()
|
||||||
|
initialClient.config {
|
||||||
|
install(clientFromKoin)
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
clientFromKoin
|
||||||
|
}
|
||||||
|
scope.plugins.filter { it !== this@PlaguBot }.forEach {
|
||||||
with(it) {
|
with(it) {
|
||||||
setupBotClient()
|
setupBotClient(scope, params)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Sets up application DI for the bot.
|
||||||
|
*
|
||||||
|
* Registers:
|
||||||
|
* - Decoded typed [Config] from provided [config] JSON
|
||||||
|
* - Raw [JsonObject] config itself for low-level access
|
||||||
|
* - Database-related config and database instance (if present in [Config])
|
||||||
|
* - This [PlaguBot] plugin instance
|
||||||
|
* - All plugins declared in launcher config as DI singletons
|
||||||
|
* - Configured [TelegramBot] built via [telegramBot] and customized by all plugins' setupBotClient
|
||||||
|
*
|
||||||
|
* @param config Raw PlaguBot JSON configuration
|
||||||
|
*/
|
||||||
override fun Module.setupDI(config: JsonObject) {
|
override fun Module.setupDI(config: JsonObject) {
|
||||||
single { this@PlaguBot.config }
|
single { get<Json>().decodeFromJsonElement(Config.serializer(), config) }
|
||||||
single { this@PlaguBot.config.plugins }
|
single { config }
|
||||||
single { this@PlaguBot.config.databaseConfig }
|
single { get<Config>().databaseConfig }
|
||||||
single { this@PlaguBot.config.databaseConfig.database }
|
single { get<Config>().databaseConfig.database }
|
||||||
single { defaultJsonFormat }
|
|
||||||
single { this@PlaguBot }
|
single { this@PlaguBot }
|
||||||
single { bot }
|
singlePlugins { get<dev.inmo.micro_utils.startup.launcher.Config>().plugins.filterIsInstance<Plugin>() }
|
||||||
}
|
single {
|
||||||
|
val config = get<Config>()
|
||||||
override fun Module.setupDI(database: Database, params: JsonObject) {
|
telegramBot(
|
||||||
setupDI(params)
|
token = config.botToken,
|
||||||
|
testServer = config.testServer,
|
||||||
includes(
|
apiUrl = config.botApiServer
|
||||||
config.botPlugins.mapNotNull {
|
) {
|
||||||
runCatching {
|
setupBotClient(this@single, get<JsonObject>())
|
||||||
module {
|
|
||||||
with(it) {
|
|
||||||
setupDI(database, params)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}.onFailure { e ->
|
|
||||||
logger.w(e) { "Unable to load DI part of $it" }
|
|
||||||
}.getOrNull()
|
|
||||||
}
|
}
|
||||||
)
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Builds and starts the bot behaviour and FSM.
|
||||||
|
*
|
||||||
|
* Flow:
|
||||||
|
* - Collects [OnStartContextsConflictResolver], [OnUpdateContextsConflictResolver], [StatesManager] and [DefaultStatesManagerRepo] from DI (or creates defaults)
|
||||||
|
* - Builds BehaviourBuilder with FSM, logs errors, and calls [setupBotPlugin] for all plugins
|
||||||
|
* - Ensures webhook is removed before long polling with [deleteWebhook]
|
||||||
|
* - Starts long polling via [startGettingOfUpdatesByLongPolling] using the created behaviour context as scope and filter
|
||||||
|
* - Awaits the long-polling [Job] to keep the app alive
|
||||||
|
*/
|
||||||
override suspend fun startPlugin(koin: Koin) {
|
override suspend fun startPlugin(koin: Koin) {
|
||||||
super.startPlugin(koin)
|
super.startPlugin(koin)
|
||||||
|
val scope = koin.get<CoroutineScope>()
|
||||||
|
|
||||||
config.plugins.forEach { plugin ->
|
lateinit var behaviourContext: BehaviourContext
|
||||||
runCatchingSafely {
|
val onStartContextsConflictResolver by lazy { koin.getAllDistinct<OnStartContextsConflictResolver>() }
|
||||||
logger.i { "Starting of $plugin common logic" }
|
val onUpdateContextsConflictResolver by lazy { koin.getAllDistinct<OnUpdateContextsConflictResolver>() }
|
||||||
with(plugin) {
|
val bot = koin.get<TelegramBot>()
|
||||||
startPlugin(koin)
|
bot.buildBehaviourWithFSM(
|
||||||
}
|
scope = scope,
|
||||||
}.onFailure { e ->
|
defaultExceptionsHandler = {
|
||||||
logger.w(e) { "Unable to load common logic of $plugin" }
|
logger.e("Something went wrong", it)
|
||||||
}.onSuccess {
|
},
|
||||||
logger.i { "Complete loading of $plugin common logic" }
|
statesManager = koin.getOrNull<StatesManager<State>>() ?: DefaultStatesManager(
|
||||||
}
|
koin.getOrNull<DefaultStatesManagerRepo<State>>() ?: InMemoryDefaultStatesManagerRepo<State>(),
|
||||||
}
|
onStartContextsConflictResolver = { old, new -> onStartContextsConflictResolver.firstNotNullOfOrNull { it(old, new) } ?: false },
|
||||||
|
onUpdateContextsConflictResolver = { old, new, currentNew -> onUpdateContextsConflictResolver.firstNotNullOfOrNull { it(old, new, currentNew) } ?: false }
|
||||||
|
),
|
||||||
|
onStateHandlingErrorHandler = koin.getOrNull<StateHandlingErrorHandler<State>>() ?: { state, e ->
|
||||||
|
logger.eS(e) { "Unable to handle state $state" }
|
||||||
|
null
|
||||||
|
},
|
||||||
|
subcontextInitialAction = CombinedSubcontextInitialAction(koin.getAllDistinct()).subcontextInitialAction
|
||||||
|
) {
|
||||||
|
logger.i("Start setup of bot part")
|
||||||
|
behaviourContext = this
|
||||||
|
setupBotPlugin(koin)
|
||||||
|
deleteWebhook()
|
||||||
|
}.start()
|
||||||
|
logger.i("Behaviour builder has been setup")
|
||||||
|
|
||||||
|
bot.startGettingOfUpdatesByLongPolling(scope = behaviourContext, updatesFilter = behaviourContext).also {
|
||||||
|
logger.i("Long polling has been started")
|
||||||
|
}.join()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Initializes and loads all other [Plugin]s from DI for the bot runtime.
|
||||||
|
*
|
||||||
|
* Each plugin is:
|
||||||
|
* - Logged as loading started
|
||||||
|
* - Executed via plugin.setupBotPlugin(...) inside a safe block
|
||||||
|
* - Logged on failure (as warning) or success (as info)
|
||||||
|
*
|
||||||
|
* [PlaguBot] itself is excluded from this list.
|
||||||
|
*/
|
||||||
override suspend fun BehaviourContextWithFSM<State>.setupBotPlugin(koin: Koin) {
|
override suspend fun BehaviourContextWithFSM<State>.setupBotPlugin(koin: Koin) {
|
||||||
config.botPlugins.forEach { plugin ->
|
koin.plugins.filter { it !== this@PlaguBot }.forEach { plugin ->
|
||||||
runCatchingSafely {
|
runCatchingLogging(logger = logger) {
|
||||||
logger.i("Start loading of $plugin")
|
logger.i("Start loading of $plugin")
|
||||||
with(plugin) {
|
with(plugin) {
|
||||||
setupBotPlugin(koin)
|
setupBotPlugin(koin)
|
||||||
@@ -114,49 +187,151 @@ data class PlaguBot(
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This method will create an [Job] which will be the main [Job] of ran instance
|
* Starts the application using raw JSON and a launcher config, optionally overriding PlaguBot config.
|
||||||
|
*
|
||||||
|
* Behavior:
|
||||||
|
* - If [PlaguBot] is not present in [config.plugins], injects it into the plugins list
|
||||||
|
* - Optionally merges [plaguBotConfig] into [json]
|
||||||
|
* - Delegates to [StartLauncherPlugin.start] and returns the lifecycle [Job]
|
||||||
|
*
|
||||||
|
* @param json Raw JSON that may contain both launcher and PlaguBot configs
|
||||||
|
* @param config Parsed launcher configuration
|
||||||
|
* @param plaguBotConfig Optional typed PlaguBot config to merge/add
|
||||||
|
* @return Job representing the bot lifecycle
|
||||||
*/
|
*/
|
||||||
suspend fun start(
|
suspend fun start(
|
||||||
scope: CoroutineScope = CoroutineScope(Dispatchers.IO)
|
json: JsonObject,
|
||||||
|
config: dev.inmo.micro_utils.startup.launcher.Config,
|
||||||
|
plaguBotConfig: Config? = null
|
||||||
): Job {
|
): Job {
|
||||||
logger.i("Start initialization")
|
KSLog.i("Config has been read")
|
||||||
val koinApp = KoinApplication.init()
|
|
||||||
koinApp.modules(
|
// Adding of PlaguBot when it absent in config
|
||||||
module {
|
val (resultJson, resultConfig) = if (PlaguBot in config.plugins) {
|
||||||
setupDI(config.databaseConfig.database, json)
|
KSLog.i("Initial config contains PlaguBot, pass config as is to StartLauncherPlugin")
|
||||||
}
|
json to config
|
||||||
)
|
} else {
|
||||||
logger.i("Modules loaded. Starting koin")
|
KSLog.i("Start fixing of PlaguBot absence. If PlaguBot has been skipped by some reason, use dev.inmo.micro_utils.startup.launcher.main as startup point or StartLauncherPlugin directly")
|
||||||
GlobalContext.startKoin(koinApp)
|
|
||||||
logger.i("Koin started. Starting plugins common logic")
|
val encodedPlaguBotConfig = plaguBotConfig ?.let {
|
||||||
startPlugin(koinApp.koin)
|
defaultJsonFormat.encodeToJsonElement(Config.serializer(), it).jsonObject
|
||||||
logger.i("Plugins common logic started. Starting setup of bot logic part")
|
} ?: JsonObject(emptyMap())
|
||||||
lateinit var behaviourContext: BehaviourContext
|
|
||||||
val onStartContextsConflictResolver by lazy { koinApp.koin.getAllDistinct<OnStartContextsConflictResolver>() }
|
val resultJson = JsonObject(
|
||||||
val onUpdateContextsConflictResolver by lazy { koinApp.koin.getAllDistinct<OnUpdateContextsConflictResolver>() }
|
encodedPlaguBotConfig + JsonObject(
|
||||||
bot.buildBehaviourWithFSM(
|
json + Pair(
|
||||||
scope = scope,
|
"plugins",
|
||||||
defaultExceptionsHandler = {
|
JsonArray(
|
||||||
logger.e("Something went wrong", it)
|
(json["plugins"] as? JsonArray ?: JsonArray(emptyList())) + JsonPrimitive(PlaguBot::class.qualifiedName!!)
|
||||||
},
|
)
|
||||||
statesManager = koinApp.koin.getOrNull<StatesManager<State>>() ?: DefaultStatesManager(
|
)
|
||||||
koinApp.koin.getOrNull<DefaultStatesManagerRepo<State>>() ?: InMemoryDefaultStatesManagerRepo<State>(),
|
)
|
||||||
onStartContextsConflictResolver = { old, new -> onStartContextsConflictResolver.firstNotNullOfOrNull { it(old, new) } ?: false },
|
)
|
||||||
onUpdateContextsConflictResolver = { old, new, currentNew -> onUpdateContextsConflictResolver.firstNotNullOfOrNull { it(old, new, currentNew) } ?: false }
|
val resultConfig = defaultJsonFormat.decodeFromJsonElement(dev.inmo.micro_utils.startup.launcher.Config.serializer(), resultJson)
|
||||||
),
|
resultJson to resultConfig
|
||||||
onStateHandlingErrorHandler = koinApp.koin.getOrNull<StateHandlingErrorHandler<State>>() ?: { state, e ->
|
|
||||||
logger.eS(e) { "Unable to handle state $state" }
|
|
||||||
null
|
|
||||||
}
|
|
||||||
) {
|
|
||||||
logger.i("Start setup of bot part")
|
|
||||||
behaviourContext = this
|
|
||||||
setupBotPlugin(koinApp.koin)
|
|
||||||
deleteWebhook()
|
|
||||||
}.start()
|
|
||||||
logger.i("Behaviour builder has been setup")
|
|
||||||
return bot.startGettingOfUpdatesByLongPolling(scope = behaviourContext, updatesFilter = behaviourContext).also {
|
|
||||||
logger.i("Long polling has been started")
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
KSLog.i("Config initialization done. Passing config to StartLauncherPlugin")
|
||||||
|
return StartLauncherPlugin.start(
|
||||||
|
resultConfig,
|
||||||
|
resultJson
|
||||||
|
).koin.get<CoroutineScope>().coroutineContext.job
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Starts the application using typed launcher config and typed PlaguBot config.
|
||||||
|
*
|
||||||
|
* Behavior:
|
||||||
|
* - Merges both configs into a single JSON
|
||||||
|
* - Ensures [PlaguBot] is present in plugins list
|
||||||
|
* - Delegates to [start] that accepts JSON and launcher config
|
||||||
|
*
|
||||||
|
* @param pluginsConfig Launcher configuration
|
||||||
|
* @param plaguBotConfig Typed PlaguBot configuration
|
||||||
|
* @return Job representing the bot lifecycle
|
||||||
|
*/
|
||||||
|
suspend fun start(
|
||||||
|
pluginsConfig: dev.inmo.micro_utils.startup.launcher.Config,
|
||||||
|
plaguBotConfig: Config
|
||||||
|
): Job {
|
||||||
|
val json = JsonObject(
|
||||||
|
defaultJsonFormat.encodeToJsonElement(
|
||||||
|
dev.inmo.micro_utils.startup.launcher.Config.serializer(),
|
||||||
|
pluginsConfig
|
||||||
|
).jsonObject + defaultJsonFormat.encodeToJsonElement(
|
||||||
|
Config.serializer(),
|
||||||
|
plaguBotConfig
|
||||||
|
).jsonObject
|
||||||
|
)
|
||||||
|
val pluginsConfig = if (pluginsConfig.plugins.contains(PlaguBot)) {
|
||||||
|
pluginsConfig
|
||||||
|
} else {
|
||||||
|
pluginsConfig.copy(
|
||||||
|
plugins = pluginsConfig.plugins + PlaguBot,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return start(json, pluginsConfig)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Starts the application using raw JSON and a typed PlaguBot config.
|
||||||
|
*
|
||||||
|
* Behavior:
|
||||||
|
* - Encodes [plaguBotConfig] and merges it into [initialJson]
|
||||||
|
* - Delegates to [start] that takes a JSON only
|
||||||
|
*
|
||||||
|
* @param initialJson Initial JSON to start from
|
||||||
|
* @param plaguBotConfig Typed PlaguBot configuration that will be encoded and merged
|
||||||
|
* @return Job representing the bot lifecycle
|
||||||
|
*/
|
||||||
|
suspend fun start(
|
||||||
|
initialJson: JsonObject,
|
||||||
|
plaguBotConfig: Config
|
||||||
|
): Job {
|
||||||
|
val encodedPlaguBotConfig = defaultJsonFormat.encodeToJsonElement(Config.serializer(), plaguBotConfig).jsonObject
|
||||||
|
|
||||||
|
return start(
|
||||||
|
JsonObject(initialJson + encodedPlaguBotConfig)
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Starts the plugins system using [StartLauncherPlugin.start].
|
||||||
|
*
|
||||||
|
* Parsing notes:
|
||||||
|
* - [initialJson] is decoded into launcher config
|
||||||
|
* - If [PlaguBot] is missing from the plugins list, it will be added automatically
|
||||||
|
*
|
||||||
|
* By using this method it is guaranteed that [PlaguBot] will be included into the set of plugins to launch.
|
||||||
|
*
|
||||||
|
* @param initialJson Raw JSON that includes launcher configuration (and optionally PlaguBot config)
|
||||||
|
* @return Job representing the bot lifecycle
|
||||||
|
*/
|
||||||
|
suspend fun start(initialJson: JsonObject): Job {
|
||||||
|
val initialConfig = defaultJsonFormat.decodeFromJsonElement(dev.inmo.micro_utils.startup.launcher.Config.serializer(), initialJson)
|
||||||
|
|
||||||
|
return start(initialJson, initialConfig)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Starts the application from CLI arguments.
|
||||||
|
*
|
||||||
|
* Expects:
|
||||||
|
* - Exactly one argument: path to a file with JSON configuration
|
||||||
|
*
|
||||||
|
* The file is read, parsed as [JsonObject], and passed to [start(JsonObject)].
|
||||||
|
*
|
||||||
|
* @param args Command-line arguments; first element is a path to the config file
|
||||||
|
* @return Job representing the bot lifecycle
|
||||||
|
*/
|
||||||
|
suspend fun start(args: Array<String>): Job {
|
||||||
|
KSLog.default = KSLog("PlaguBot")
|
||||||
|
val (configPath) = args
|
||||||
|
val file = File(configPath)
|
||||||
|
KSLog.i("Start read config from ${file.absolutePath}")
|
||||||
|
|
||||||
|
val initialJson = defaultJsonFormat.parseToJsonElement(file.readText()).jsonObject
|
||||||
|
return start(initialJson)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -11,10 +11,9 @@ import kotlinx.serialization.Serializable
|
|||||||
@Serializable
|
@Serializable
|
||||||
data class Config(
|
data class Config(
|
||||||
val botToken: String,
|
val botToken: String,
|
||||||
val plugins: List<StartPlugin>,
|
|
||||||
@SerialName("database")
|
@SerialName("database")
|
||||||
val databaseConfig: DatabaseConfig = DatabaseConfig(),
|
val databaseConfig: DatabaseConfig = DatabaseConfig(),
|
||||||
val botApiServer: String = telegramBotAPIDefaultUrl
|
val botApiServer: String = telegramBotAPIDefaultUrl,
|
||||||
) {
|
val testServer: Boolean = false,
|
||||||
val botPlugins = plugins.filterIsInstance<Plugin>()
|
val proxy: ProxyConfig? = null,
|
||||||
}
|
)
|
||||||
|
|||||||
@@ -5,8 +5,8 @@ import dev.inmo.kslog.common.logger
|
|||||||
import kotlinx.coroutines.delay
|
import kotlinx.coroutines.delay
|
||||||
import kotlinx.serialization.Serializable
|
import kotlinx.serialization.Serializable
|
||||||
import kotlinx.serialization.Transient
|
import kotlinx.serialization.Transient
|
||||||
import org.jetbrains.exposed.sql.Database
|
import org.jetbrains.exposed.v1.jdbc.Database
|
||||||
import org.jetbrains.exposed.sql.transactions.transactionManager
|
import org.jetbrains.exposed.v1.jdbc.transactions.transactionManager
|
||||||
import org.koin.core.scope.Scope
|
import org.koin.core.scope.Scope
|
||||||
import org.sqlite.JDBC
|
import org.sqlite.JDBC
|
||||||
import java.lang.Exception
|
import java.lang.Exception
|
||||||
|
|||||||
@@ -1,7 +1,9 @@
|
|||||||
package dev.inmo.plagubot.config
|
package dev.inmo.plagubot.config
|
||||||
|
|
||||||
|
import dev.inmo.micro_utils.common.Warning
|
||||||
import kotlinx.serialization.json.Json
|
import kotlinx.serialization.json.Json
|
||||||
|
|
||||||
|
@Warning("This format will not be configured throw StartPlugin system. Use it will caution, it has no any configured things")
|
||||||
val defaultJsonFormat = Json {
|
val defaultJsonFormat = Json {
|
||||||
ignoreUnknownKeys = true
|
ignoreUnknownKeys = true
|
||||||
}
|
}
|
||||||
|
|||||||
47
bot/src/main/kotlin/dev/inmo/plagubot/config/ProxyConfig.kt
Normal file
47
bot/src/main/kotlin/dev/inmo/plagubot/config/ProxyConfig.kt
Normal file
@@ -0,0 +1,47 @@
|
|||||||
|
package dev.inmo.plagubot.config
|
||||||
|
|
||||||
|
import io.ktor.client.*
|
||||||
|
import io.ktor.client.engine.okhttp.OkHttp
|
||||||
|
import io.ktor.client.plugins.*
|
||||||
|
import io.ktor.client.request.*
|
||||||
|
import io.ktor.http.*
|
||||||
|
import kotlinx.serialization.Serializable
|
||||||
|
import kotlinx.serialization.Transient
|
||||||
|
import java.net.Authenticator
|
||||||
|
import java.net.InetSocketAddress
|
||||||
|
import java.net.PasswordAuthentication
|
||||||
|
import java.net.Proxy
|
||||||
|
import kotlin.io.encoding.Base64
|
||||||
|
|
||||||
|
@Serializable
|
||||||
|
data class ProxyConfig(
|
||||||
|
val host: String,
|
||||||
|
val port: Int,
|
||||||
|
val username: String? = null,
|
||||||
|
val password: String? = null
|
||||||
|
) {
|
||||||
|
@Transient
|
||||||
|
private val proxy = Proxy(Proxy.Type.SOCKS, InetSocketAddress(host, port))
|
||||||
|
fun createDefaultClient() = HttpClient(OkHttp) {
|
||||||
|
engine {
|
||||||
|
config {
|
||||||
|
proxy(this@ProxyConfig.proxy)
|
||||||
|
if (username != null && password != null) {
|
||||||
|
val passwordAuthentication = PasswordAuthentication(
|
||||||
|
username,
|
||||||
|
password.toCharArray()
|
||||||
|
)
|
||||||
|
Authenticator.setDefault(object : Authenticator() {
|
||||||
|
override fun getPasswordAuthentication(): PasswordAuthentication? {
|
||||||
|
return if (requestingHost.lowercase() == host.lowercase()) {
|
||||||
|
passwordAuthentication
|
||||||
|
} else {
|
||||||
|
null
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
20
build.gradle
20
build.gradle
@@ -12,12 +12,30 @@ buildscript {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
plugins {
|
||||||
|
alias(libs.plugins.nmcp.aggregation)
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
if ((project.hasProperty('SONATYPE_USER') || System.getenv('SONATYPE_USER') != null) && (project.hasProperty('SONATYPE_PASSWORD') || System.getenv('SONATYPE_PASSWORD') != null)) {
|
||||||
|
nmcpAggregation {
|
||||||
|
centralPortal {
|
||||||
|
username = project.hasProperty('SONATYPE_USER') ? project.property('SONATYPE_USER') : System.getenv('SONATYPE_USER')
|
||||||
|
password = project.hasProperty('SONATYPE_PASSWORD') ? project.property('SONATYPE_PASSWORD') : System.getenv('SONATYPE_PASSWORD')
|
||||||
|
validationTimeout = Duration.ofHours(4)
|
||||||
|
publishingType = System.getenv('PUBLISHING_TYPE') != "" ? System.getenv('PUBLISHING_TYPE') : "USER_MANAGED"
|
||||||
|
}
|
||||||
|
|
||||||
|
publishAllProjectsProbablyBreakingProjectIsolation()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
allprojects {
|
allprojects {
|
||||||
repositories {
|
repositories {
|
||||||
mavenCentral()
|
mavenCentral()
|
||||||
mavenLocal()
|
mavenLocal()
|
||||||
maven { url 'https://jitpack.io' }
|
|
||||||
maven { url "https://nexus.inmo.dev/repository/maven-releases/" }
|
maven { url "https://nexus.inmo.dev/repository/maven-releases/" }
|
||||||
|
maven { url 'https://jitpack.io' }
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
0
changelog_parser.sh
Normal file → Executable file
0
changelog_parser.sh
Normal file → Executable file
@@ -11,12 +11,19 @@ private String getCurrentVersionChangelog() {
|
|||||||
return changelogDataOS.toString().trim()
|
return changelogDataOS.toString().trim()
|
||||||
}
|
}
|
||||||
|
|
||||||
if (new File(projectDir, "secret.gradle").exists()) {
|
def githubTokenVariableName = "GITHUB_RELEASE_TOKEN"
|
||||||
apply from: './secret.gradle'
|
def githubTokenVariableFromEnv = System.getenv(githubTokenVariableName)
|
||||||
|
|
||||||
|
def secretFile = new File(projectDir, "secret.gradle")
|
||||||
|
if (secretFile.exists() || project.hasProperty(githubTokenVariableName) || (githubTokenVariableFromEnv != "" && githubTokenVariableFromEnv != null)) {
|
||||||
|
if (secretFile.exists()) {
|
||||||
|
apply from: './secret.gradle'
|
||||||
|
}
|
||||||
apply plugin: "com.github.breadmoirai.github-release"
|
apply plugin: "com.github.breadmoirai.github-release"
|
||||||
|
def githubReleaseToken = project.hasProperty(githubTokenVariableName) ? project.property(githubTokenVariableName).toString() : githubTokenVariableFromEnv
|
||||||
|
|
||||||
githubRelease {
|
githubRelease {
|
||||||
token "${project.property('GITHUB_RELEASE_TOKEN')}"
|
token githubReleaseToken
|
||||||
|
|
||||||
releaseAssets.from('bot/build/distributions')
|
releaseAssets.from('bot/build/distributions')
|
||||||
|
|
||||||
|
|||||||
@@ -5,4 +5,4 @@ kotlin.js.generate.externals=true
|
|||||||
kotlin.incremental=true
|
kotlin.incremental=true
|
||||||
|
|
||||||
group=dev.inmo
|
group=dev.inmo
|
||||||
version=9.2.0
|
version=11.1.1
|
||||||
|
|||||||
@@ -1,22 +1,25 @@
|
|||||||
[versions]
|
[versions]
|
||||||
|
|
||||||
kt = "2.0.20"
|
kt = "2.3.10"
|
||||||
kt-serialization = "1.7.2"
|
kt-serialization = "1.10.0"
|
||||||
kt-coroutines = "1.8.1"
|
kt-coroutines = "1.10.2"
|
||||||
|
|
||||||
microutils = "0.22.2"
|
microutils = "0.29.1"
|
||||||
tgbotapi = "18.1.0"
|
tgbotapi = "32.0.0"
|
||||||
|
ktor = "3.4.1"
|
||||||
|
|
||||||
ksp = "2.0.20-1.0.24"
|
ksp = "2.3.6"
|
||||||
|
|
||||||
jb-exposed = "0.54.0"
|
jb-exposed = "1.1.1"
|
||||||
jb-dokka = "1.9.20"
|
jb-dokka = "2.1.0"
|
||||||
|
|
||||||
sqlite = "3.46.1.0"
|
sqlite = "3.51.2.0"
|
||||||
|
|
||||||
gh-release = "2.5.2"
|
gh-release = "2.5.2"
|
||||||
|
|
||||||
koin = "3.5.6"
|
koin = "4.1.1"
|
||||||
|
|
||||||
|
nmcp = "1.4.4"
|
||||||
|
|
||||||
[libraries]
|
[libraries]
|
||||||
|
|
||||||
@@ -33,6 +36,8 @@ microutils-koin-generator = { module = "dev.inmo:micro_utils.koin.generator", ve
|
|||||||
microutils-startup-launcher = { module = "dev.inmo:micro_utils.startup.launcher", version.ref = "microutils" }
|
microutils-startup-launcher = { module = "dev.inmo:micro_utils.startup.launcher", version.ref = "microutils" }
|
||||||
microutils-startup-plugin = { module = "dev.inmo:micro_utils.startup.plugin", version.ref = "microutils" }
|
microutils-startup-plugin = { module = "dev.inmo:micro_utils.startup.plugin", version.ref = "microutils" }
|
||||||
|
|
||||||
|
ktor-engine-okhttp = { module = "io.ktor:ktor-client-okhttp", version.ref = "ktor" }
|
||||||
|
|
||||||
koin = { module = "io.insert-koin:koin-core", version.ref = "koin" }
|
koin = { module = "io.insert-koin:koin-core", version.ref = "koin" }
|
||||||
|
|
||||||
jb-exposed-jdbc = { module = "org.jetbrains.exposed:exposed-jdbc", version.ref = "jb-exposed" }
|
jb-exposed-jdbc = { module = "org.jetbrains.exposed:exposed-jdbc", version.ref = "jb-exposed" }
|
||||||
@@ -48,3 +53,7 @@ buildscript-kt-serialization = { module = "org.jetbrains.kotlin:kotlin-serializa
|
|||||||
buildscript-jb-dokka = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version.ref = "jb-dokka" }
|
buildscript-jb-dokka = { module = "org.jetbrains.dokka:dokka-gradle-plugin", version.ref = "jb-dokka" }
|
||||||
buildscript-gh-release = { module = "com.github.breadmoirai:github-release", version.ref = "gh-release" }
|
buildscript-gh-release = { module = "com.github.breadmoirai:github-release", version.ref = "gh-release" }
|
||||||
buildscript-ksp = { module = "com.google.devtools.ksp:symbol-processing-gradle-plugin", version.ref = "ksp" }
|
buildscript-ksp = { module = "com.google.devtools.ksp:symbol-processing-gradle-plugin", version.ref = "ksp" }
|
||||||
|
|
||||||
|
[plugins]
|
||||||
|
|
||||||
|
nmcp-aggregation = { id = "com.gradleup.nmcp.aggregation", version.ref = "nmcp" }
|
||||||
|
|||||||
2
gradle/wrapper/gradle-wrapper.properties
vendored
2
gradle/wrapper/gradle-wrapper.properties
vendored
@@ -1,5 +1,5 @@
|
|||||||
distributionBase=GRADLE_USER_HOME
|
distributionBase=GRADLE_USER_HOME
|
||||||
distributionPath=wrapper/dists
|
distributionPath=wrapper/dists
|
||||||
distributionUrl=https\://services.gradle.org/distributions/gradle-8.9-bin.zip
|
distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip
|
||||||
zipStoreBase=GRADLE_USER_HOME
|
zipStoreBase=GRADLE_USER_HOME
|
||||||
zipStorePath=wrapper/dists
|
zipStorePath=wrapper/dists
|
||||||
|
|||||||
@@ -1,5 +1,7 @@
|
|||||||
|
|
||||||
apply plugin: 'maven-publish'
|
apply plugin: 'maven-publish'
|
||||||
|
|
||||||
|
|
||||||
task javadocJar(type: Jar) {
|
task javadocJar(type: Jar) {
|
||||||
from javadoc
|
from javadoc
|
||||||
archiveClassifier = 'javadoc'
|
archiveClassifier = 'javadoc'
|
||||||
@@ -48,30 +50,28 @@ publishing {
|
|||||||
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
repositories {
|
}
|
||||||
if ((project.hasProperty('INMONEXUS_USER') || System.getenv('INMONEXUS_USER') != null) && (project.hasProperty('INMONEXUS_PASSWORD') || System.getenv('INMONEXUS_PASSWORD') != null)) {
|
}
|
||||||
maven {
|
repositories {
|
||||||
name = "InmoNexus"
|
if ((project.hasProperty('INMONEXUS_USER') || System.getenv('INMONEXUS_USER') != null) && (project.hasProperty('INMONEXUS_PASSWORD') || System.getenv('INMONEXUS_PASSWORD') != null)) {
|
||||||
url = uri("https://nexus.inmo.dev/repository/maven-releases/")
|
maven {
|
||||||
|
name = "InmoNexus"
|
||||||
credentials {
|
url = uri("https://nexus.inmo.dev/repository/maven-releases/")
|
||||||
username = project.hasProperty('INMONEXUS_USER') ? project.property('INMONEXUS_USER') : System.getenv('INMONEXUS_USER')
|
|
||||||
password = project.hasProperty('INMONEXUS_PASSWORD') ? project.property('INMONEXUS_PASSWORD') : System.getenv('INMONEXUS_PASSWORD')
|
credentials {
|
||||||
}
|
username = project.hasProperty('INMONEXUS_USER') ? project.property('INMONEXUS_USER') : System.getenv('INMONEXUS_USER')
|
||||||
|
password = project.hasProperty('INMONEXUS_PASSWORD') ? project.property('INMONEXUS_PASSWORD') : System.getenv('INMONEXUS_PASSWORD')
|
||||||
}
|
|
||||||
}
|
}
|
||||||
if ((project.hasProperty('SONATYPE_USER') || System.getenv('SONATYPE_USER') != null) && (project.hasProperty('SONATYPE_PASSWORD') || System.getenv('SONATYPE_PASSWORD') != null)) {
|
}
|
||||||
maven {
|
}
|
||||||
name = "sonatype"
|
if ((project.hasProperty('SONATYPE_USER') || System.getenv('SONATYPE_USER') != null) && (project.hasProperty('SONATYPE_PASSWORD') || System.getenv('SONATYPE_PASSWORD') != null)) {
|
||||||
url = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
|
maven {
|
||||||
|
name = "sonatype"
|
||||||
credentials {
|
url = uri("https://ossrh-staging-api.central.sonatype.com/service/local/staging/deploy/maven2/")
|
||||||
username = project.hasProperty('SONATYPE_USER') ? project.property('SONATYPE_USER') : System.getenv('SONATYPE_USER')
|
|
||||||
password = project.hasProperty('SONATYPE_PASSWORD') ? project.property('SONATYPE_PASSWORD') : System.getenv('SONATYPE_PASSWORD')
|
credentials {
|
||||||
}
|
username = project.hasProperty('SONATYPE_USER') ? project.property('SONATYPE_USER') : System.getenv('SONATYPE_USER')
|
||||||
|
password = project.hasProperty('SONATYPE_PASSWORD') ? project.property('SONATYPE_PASSWORD') : System.getenv('SONATYPE_PASSWORD')
|
||||||
}
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -80,13 +80,13 @@ publishing {
|
|||||||
|
|
||||||
if (project.hasProperty("signing.gnupg.keyName")) {
|
if (project.hasProperty("signing.gnupg.keyName")) {
|
||||||
apply plugin: 'signing'
|
apply plugin: 'signing'
|
||||||
|
|
||||||
signing {
|
signing {
|
||||||
useGpgCmd()
|
useGpgCmd()
|
||||||
|
|
||||||
sign publishing.publications
|
sign publishing.publications
|
||||||
}
|
}
|
||||||
|
|
||||||
task signAll {
|
task signAll {
|
||||||
tasks.withType(Sign).forEach {
|
tasks.withType(Sign).forEach {
|
||||||
dependsOn(it)
|
dependsOn(it)
|
||||||
|
|||||||
@@ -1 +1 @@
|
|||||||
{"licenses":[{"id":"Apache-2.0","title":"Apache Software License 2.0","url":"https://github.com/InsanusMokrassar/PlaguBot/LICENSE"}],"mavenConfig":{"name":"PlaguBot Plugin","description":"Base dependency for whole PlaguBot project","url":"https://github.com/InsanusMokrassar/PlaguBot","vcsUrl":"ssh://git@github.com/InsanusMokrassar/PlaguBot.git","developers":[{"id":"InsanusMokrassar","name":"Aleksei Ovsiannikov","eMail":"ovsyannikov.alexey95@gmail.com"}],"repositories":[{"name":"InmoNexus","url":"https://nexus.inmo.dev/repository/maven-releases/"},{"name":"sonatype","url":"https://oss.sonatype.org/service/local/staging/deploy/maven2/"}],"gpgSigning":{"type":"dev.inmo.kmppscriptbuilder.core.models.GpgSigning.Optional"}},"type":"JVM"}
|
{"licenses":[{"id":"Apache-2.0","title":"Apache Software License 2.0","url":"https://github.com/InsanusMokrassar/PlaguBot/LICENSE"}],"mavenConfig":{"name":"PlaguBot Plugin","description":"Base dependency for whole PlaguBot project","url":"https://github.com/InsanusMokrassar/PlaguBot","vcsUrl":"ssh://git@github.com/InsanusMokrassar/PlaguBot.git","developers":[{"id":"InsanusMokrassar","name":"Aleksei Ovsiannikov","eMail":"ovsyannikov.alexey95@gmail.com"}],"repositories":[{"name":"InmoNexus","url":"https://nexus.inmo.dev/repository/maven-releases/"},{"name":"sonatype","url":"https://ossrh-staging-api.central.sonatype.com/service/local/staging/deploy/maven2/"}],"gpgSigning":{"type":"dev.inmo.kmppscriptbuilder.core.models.GpgSigning.Optional"}},"type":"JVM"}
|
||||||
@@ -2,22 +2,18 @@ package dev.inmo.plagubot
|
|||||||
|
|
||||||
import dev.inmo.kslog.common.*
|
import dev.inmo.kslog.common.*
|
||||||
import dev.inmo.micro_utils.fsm.common.State
|
import dev.inmo.micro_utils.fsm.common.State
|
||||||
import dev.inmo.plagubot.HelloPlugin.setupBotPlugin
|
|
||||||
import dev.inmo.tgbotapi.extensions.api.bot.getMe
|
import dev.inmo.tgbotapi.extensions.api.bot.getMe
|
||||||
import dev.inmo.tgbotapi.extensions.api.send.reply
|
import dev.inmo.tgbotapi.extensions.api.send.reply
|
||||||
import dev.inmo.tgbotapi.extensions.api.send.sendMessage
|
import dev.inmo.tgbotapi.extensions.api.send.sendMessage
|
||||||
import dev.inmo.tgbotapi.extensions.behaviour_builder.*
|
import dev.inmo.tgbotapi.extensions.behaviour_builder.*
|
||||||
import dev.inmo.tgbotapi.extensions.behaviour_builder.expectations.waitText
|
|
||||||
import dev.inmo.tgbotapi.extensions.behaviour_builder.expectations.waitTextMessage
|
import dev.inmo.tgbotapi.extensions.behaviour_builder.expectations.waitTextMessage
|
||||||
import dev.inmo.tgbotapi.extensions.behaviour_builder.triggers_handling.onCommand
|
import dev.inmo.tgbotapi.extensions.behaviour_builder.triggers_handling.onCommand
|
||||||
import dev.inmo.tgbotapi.extensions.behaviour_builder.triggers_handling.onUnhandledCommand
|
|
||||||
import dev.inmo.tgbotapi.types.IdChatIdentifier
|
import dev.inmo.tgbotapi.types.IdChatIdentifier
|
||||||
import kotlinx.coroutines.flow.first
|
import kotlinx.coroutines.flow.first
|
||||||
import kotlinx.serialization.SerialName
|
import kotlinx.serialization.SerialName
|
||||||
import kotlinx.serialization.Serializable
|
import kotlinx.serialization.Serializable
|
||||||
import kotlinx.serialization.json.Json
|
import kotlinx.serialization.json.Json
|
||||||
import kotlinx.serialization.json.JsonObject
|
import kotlinx.serialization.json.JsonObject
|
||||||
import org.jetbrains.exposed.sql.Database
|
|
||||||
import org.koin.core.Koin
|
import org.koin.core.Koin
|
||||||
import org.koin.core.module.Module
|
import org.koin.core.module.Module
|
||||||
|
|
||||||
@@ -29,10 +25,8 @@ object HelloPlugin : Plugin {
|
|||||||
val print: String
|
val print: String
|
||||||
)
|
)
|
||||||
|
|
||||||
override fun Module.setupDI(database: Database, params: JsonObject) {
|
override fun Module.setupDI(config: JsonObject) {
|
||||||
single {
|
registerConfig<HelloPluginConfig>("helloPlugin") { null }
|
||||||
get<Json>().decodeFromJsonElement(HelloPluginConfig.serializer(), params["helloPlugin"] ?: return@single null)
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
private sealed interface InternalFSMState : State {
|
private sealed interface InternalFSMState : State {
|
||||||
@@ -47,7 +41,7 @@ object HelloPlugin : Plugin {
|
|||||||
}
|
}
|
||||||
|
|
||||||
override suspend fun BehaviourContextWithFSM<State>.setupBotPlugin(koin: Koin) {
|
override suspend fun BehaviourContextWithFSM<State>.setupBotPlugin(koin: Koin) {
|
||||||
val toPrint = koin.getOrNull<HelloPluginConfig>() ?.print ?: "Hello :)"
|
val toPrint = koin.configOrNull<HelloPluginConfig>() ?.print ?: "Hello :)"
|
||||||
logger.d { toPrint }
|
logger.d { toPrint }
|
||||||
logger.dS { getMe().toString() }
|
logger.dS { getMe().toString() }
|
||||||
onCommand("hello_world") {
|
onCommand("hello_world") {
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
package dev.inmo.plagubot
|
||||||
|
|
||||||
|
import org.jetbrains.exposed.v1.jdbc.Database
|
||||||
|
import org.koin.core.Koin
|
||||||
|
import org.koin.core.scope.Scope
|
||||||
|
|
||||||
|
val Scope.database: Database
|
||||||
|
get() = get()
|
||||||
|
|
||||||
|
val Koin.database: Database
|
||||||
|
get() = get()
|
||||||
54
plugin/src/main/kotlin/dev/inmo/plagubot/KoinExtensions.kt
Normal file
54
plugin/src/main/kotlin/dev/inmo/plagubot/KoinExtensions.kt
Normal file
@@ -0,0 +1,54 @@
|
|||||||
|
package dev.inmo.plagubot
|
||||||
|
|
||||||
|
import kotlinx.serialization.InternalSerializationApi
|
||||||
|
import kotlinx.serialization.KSerializer
|
||||||
|
import kotlinx.serialization.json.Json
|
||||||
|
import kotlinx.serialization.json.JsonObject
|
||||||
|
import kotlinx.serialization.serializer
|
||||||
|
import org.koin.core.Koin
|
||||||
|
import org.koin.core.module.Module
|
||||||
|
import org.koin.core.scope.Scope
|
||||||
|
import kotlin.reflect.KClass
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Using [single] to register `T` with serializer [configSerializer]
|
||||||
|
*
|
||||||
|
* @param default Will be used if [field] is absent as an alternative way of config allocation. If null passed, error
|
||||||
|
* will be thrown
|
||||||
|
*/
|
||||||
|
inline fun <reified T> Module.registerConfig(configSerializer: KSerializer<T>, field: String?, noinline default: (Scope.(JsonObject) -> T?)? = null) {
|
||||||
|
single {
|
||||||
|
val fieldValue = get<JsonObject>().let {
|
||||||
|
if (field == null) {
|
||||||
|
it
|
||||||
|
} else {
|
||||||
|
it[field] ?: default ?.let { _ ->
|
||||||
|
return@single default(it)
|
||||||
|
} ?: error("Unable to take field $field from config")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
get<Json>().decodeFromJsonElement(configSerializer, fieldValue)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Using [single] to register config with getting of [serializer] from [kClass]
|
||||||
|
*
|
||||||
|
* @param default Will be used if [field] is absent as an alternative way of config allocation. If null passed, error
|
||||||
|
* will be thrown
|
||||||
|
*/
|
||||||
|
@OptIn(InternalSerializationApi::class)
|
||||||
|
inline fun <reified T : Any> Module.registerConfig(kClass: KClass<T>, field: String?, noinline default: (Scope.(JsonObject) -> T?)? = null) = registerConfig(kClass.serializer(), field, default)
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Using [single] to register config with getting of [serializer] from [kClass]
|
||||||
|
*
|
||||||
|
* @param default Will be used if [field] is absent as an alternative way of config allocation. If null passed, error
|
||||||
|
* will be thrown
|
||||||
|
*/
|
||||||
|
inline fun <reified T : Any> Module.registerConfig(field: String?, noinline default: (Scope.(JsonObject) -> T?)? = null) = registerConfig(T::class, field, default)
|
||||||
|
|
||||||
|
inline fun <reified T : Any> Scope.config() = get<T>()
|
||||||
|
inline fun <reified T : Any> Koin.config() = get<T>()
|
||||||
|
inline fun <reified T : Any> Scope.configOrNull() = getOrNull<T>()
|
||||||
|
inline fun <reified T : Any> Koin.configOrNull() = getOrNull<T>()
|
||||||
@@ -7,9 +7,8 @@ import dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContext
|
|||||||
import dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContextWithFSM
|
import dev.inmo.tgbotapi.extensions.behaviour_builder.BehaviourContextWithFSM
|
||||||
import kotlinx.serialization.Serializable
|
import kotlinx.serialization.Serializable
|
||||||
import kotlinx.serialization.json.JsonObject
|
import kotlinx.serialization.json.JsonObject
|
||||||
import org.jetbrains.exposed.sql.Database
|
|
||||||
import org.koin.core.Koin
|
import org.koin.core.Koin
|
||||||
import org.koin.core.module.Module
|
import org.koin.core.scope.Scope
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* **ANY REALIZATION OF [Plugin] MUST HAVE CONSTRUCTOR WITH ABSENCE OF INCOMING PARAMETERS**
|
* **ANY REALIZATION OF [Plugin] MUST HAVE CONSTRUCTOR WITH ABSENCE OF INCOMING PARAMETERS**
|
||||||
@@ -20,17 +19,17 @@ import org.koin.core.module.Module
|
|||||||
*/
|
*/
|
||||||
@Serializable(PluginSerializer::class)
|
@Serializable(PluginSerializer::class)
|
||||||
interface Plugin : StartPlugin {
|
interface Plugin : StartPlugin {
|
||||||
|
@Deprecated("Deprecated in favor to setupBotClient with arguments")
|
||||||
fun KtorRequestsExecutorBuilder.setupBotClient() {}
|
fun KtorRequestsExecutorBuilder.setupBotClient() {}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* This method will be called when this plugin should configure di module based on the incoming params
|
* Will be called on stage of bot setup
|
||||||
|
*
|
||||||
|
* @param scope The scope of [org.koin.core.module.Module.single] of bot definition
|
||||||
|
* @param params Params (in fact, the whole bot config)
|
||||||
*/
|
*/
|
||||||
fun Module.setupDI(
|
@Suppress("DEPRECATION")
|
||||||
database: Database,
|
fun KtorRequestsExecutorBuilder.setupBotClient(scope: Scope, params: JsonObject) = setupBotClient()
|
||||||
params: JsonObject
|
|
||||||
) {
|
|
||||||
setupDI(params)
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Override this method in cases when you want to declare common bot behaviour. In case you wish to use FSM, you
|
* Override this method in cases when you want to declare common bot behaviour. In case you wish to use FSM, you
|
||||||
|
|||||||
@@ -7,7 +7,6 @@ import kotlinx.serialization.descriptors.SerialDescriptor
|
|||||||
import kotlinx.serialization.encoding.Decoder
|
import kotlinx.serialization.encoding.Decoder
|
||||||
import kotlinx.serialization.encoding.Encoder
|
import kotlinx.serialization.encoding.Encoder
|
||||||
|
|
||||||
@Serializer(Plugin::class)
|
|
||||||
class PluginSerializer : KSerializer<Plugin> {
|
class PluginSerializer : KSerializer<Plugin> {
|
||||||
override val descriptor: SerialDescriptor
|
override val descriptor: SerialDescriptor
|
||||||
get() = String.serializer().descriptor
|
get() = String.serializer().descriptor
|
||||||
|
|||||||
@@ -10,6 +10,13 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"botToken": "1234567890:ABCDEFGHIJKLMNOP_qrstuvwxyz12345678",
|
"botToken": "1234567890:ABCDEFGHIJKLMNOP_qrstuvwxyz12345678",
|
||||||
|
"proxy": {
|
||||||
|
"host": "127.0.0.1",
|
||||||
|
"port": 1080,
|
||||||
|
"username": "OPTIONAL username",
|
||||||
|
"password": "OPTIONAL password",
|
||||||
|
"_note": "THIS OBJECT IS OPTIONAL"
|
||||||
|
},
|
||||||
"plugins": [
|
"plugins": [
|
||||||
"dev.inmo.plagubot.HelloPlugin"
|
"dev.inmo.plagubot.HelloPlugin"
|
||||||
],
|
],
|
||||||
|
|||||||
Reference in New Issue
Block a user