mirror of
https://github.com/InsanusMokrassar/PlaguBot.git
synced 2026-05-01 14:22:27 +00:00
Compare commits
50 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 |
113
CHANGELOG.md
113
CHANGELOG.md
@@ -1,5 +1,118 @@
|
||||
# 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`:
|
||||
|
||||
15
README.md
15
README.md
@@ -19,6 +19,8 @@ That is a set of libraries for plagubots. Look at the
|
||||
|
||||
### 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:
|
||||
|
||||
```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.startup.launcher
|
||||
|
||||
api libs.ktor.engine.okhttp
|
||||
|
||||
api libs.sqlite
|
||||
|
||||
testImplementation libs.kt.test.junit
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
|
||||
apply plugin: 'maven-publish'
|
||||
|
||||
|
||||
task javadocJar(type: Jar) {
|
||||
from 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 {
|
||||
name = "InmoNexus"
|
||||
url = uri("https://nexus.inmo.dev/repository/maven-releases/")
|
||||
|
||||
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')
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
repositories {
|
||||
if ((project.hasProperty('INMONEXUS_USER') || System.getenv('INMONEXUS_USER') != null) && (project.hasProperty('INMONEXUS_PASSWORD') || System.getenv('INMONEXUS_PASSWORD') != null)) {
|
||||
maven {
|
||||
name = "InmoNexus"
|
||||
url = uri("https://nexus.inmo.dev/repository/maven-releases/")
|
||||
|
||||
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"
|
||||
url = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
|
||||
|
||||
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')
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
if ((project.hasProperty('SONATYPE_USER') || System.getenv('SONATYPE_USER') != null) && (project.hasProperty('SONATYPE_PASSWORD') || System.getenv('SONATYPE_PASSWORD') != null)) {
|
||||
maven {
|
||||
name = "sonatype"
|
||||
url = uri("https://ossrh-staging-api.central.sonatype.com/service/local/staging/deploy/maven2/")
|
||||
|
||||
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")) {
|
||||
apply plugin: 'signing'
|
||||
|
||||
|
||||
signing {
|
||||
useGpgCmd()
|
||||
|
||||
|
||||
sign publishing.publications
|
||||
}
|
||||
|
||||
|
||||
task signAll {
|
||||
tasks.withType(Sign).forEach {
|
||||
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"}
|
||||
@@ -2,7 +2,7 @@ package dev.inmo.plagubot
|
||||
|
||||
import dev.inmo.kslog.common.*
|
||||
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.StatesManager
|
||||
import dev.inmo.micro_utils.fsm.common.managers.*
|
||||
@@ -15,6 +15,10 @@ import dev.inmo.tgbotapi.bot.ktor.telegramBot
|
||||
import dev.inmo.tgbotapi.extensions.api.webhook.deleteWebhook
|
||||
import dev.inmo.tgbotapi.extensions.behaviour_builder.*
|
||||
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.serialization.Serializable
|
||||
import kotlinx.serialization.json.*
|
||||
@@ -23,10 +27,55 @@ import org.koin.core.module.Module
|
||||
import org.koin.core.scope.Scope
|
||||
import java.io.File
|
||||
|
||||
/**
|
||||
* 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)
|
||||
@Serializable
|
||||
object PlaguBot : Plugin {
|
||||
/**
|
||||
* JSON format used for encoding/decoding PlaguBot-related configuration.
|
||||
*
|
||||
* Note:
|
||||
* - This property is not reactive. Set it only before starting the bot to affect configuration parsing/serialization.
|
||||
*/
|
||||
var defaultJsonFormat = dev.inmo.plagubot.config.defaultJsonFormat
|
||||
@Warning("This is not reactive set. Use this only BEFORE starting of bot") set
|
||||
|
||||
/**
|
||||
* 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) {
|
||||
setupBotClient(scope, params)
|
||||
@@ -34,6 +83,19 @@ object PlaguBot : Plugin {
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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) {
|
||||
single { get<Json>().decodeFromJsonElement(Config.serializer(), config) }
|
||||
single { config }
|
||||
@@ -54,15 +116,14 @@ object PlaguBot : Plugin {
|
||||
}
|
||||
|
||||
/**
|
||||
* Getting all [OnStartContextsConflictResolver], [OnUpdateContextsConflictResolver], [StatesManager] and [DefaultStatesManagerRepo]
|
||||
* and pass them into [buildBehaviourWithFSM] on top of [TelegramBot] took from [koin]. In time of
|
||||
* [buildBehaviourWithFSM] configuration will call [setupBotPlugin] and [deleteWebhook].
|
||||
* Builds and starts the bot behaviour and FSM.
|
||||
*
|
||||
* After all preparation, the result of [buildBehaviourWithFSM] will be passed to [startGettingOfUpdatesByLongPolling]
|
||||
* as [CoroutineScope] and [UpdatesFilter].
|
||||
*
|
||||
* The [Job] took from [startGettingOfUpdatesByLongPolling] will be used to prevent app stopping by calling [Job.join]
|
||||
* on it
|
||||
* 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) {
|
||||
super.startPlugin(koin)
|
||||
@@ -85,7 +146,8 @@ object PlaguBot : Plugin {
|
||||
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
|
||||
@@ -100,12 +162,18 @@ object PlaguBot : Plugin {
|
||||
}
|
||||
|
||||
/**
|
||||
* Initializing [Plugin]s from [koin] took by [plugins] extension. [PlaguBot] itself will be filtered out from
|
||||
* list of plugins to be inited
|
||||
* 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) {
|
||||
koin.plugins.filter { it !== this@PlaguBot }.forEach { plugin ->
|
||||
runCatchingSafely {
|
||||
runCatchingLogging(logger = logger) {
|
||||
logger.i("Start loading of $plugin")
|
||||
with(plugin) {
|
||||
setupBotPlugin(koin)
|
||||
@@ -119,23 +187,45 @@ object PlaguBot : Plugin {
|
||||
}
|
||||
|
||||
/**
|
||||
* Starting plugins system using [StartLauncherPlugin.start]. In time of parsing [initialJson] [PlaguBot] may
|
||||
* add itself in its `plugins` section in case of its absence there. So, by launching this [start] it is guaranteed
|
||||
* that [PlaguBot] will be in list of plugins to be loaded by [StartLauncherPlugin]
|
||||
* 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(initialJson: JsonObject): Job {
|
||||
val initialConfig = defaultJsonFormat.decodeFromJsonElement(dev.inmo.micro_utils.startup.launcher.Config.serializer(), initialJson)
|
||||
|
||||
suspend fun start(
|
||||
json: JsonObject,
|
||||
config: dev.inmo.micro_utils.startup.launcher.Config,
|
||||
plaguBotConfig: Config? = null
|
||||
): Job {
|
||||
KSLog.i("Config has been read")
|
||||
|
||||
// Adding of PlaguBot when it absent in config
|
||||
val (resultJson, resultConfig) = if (PlaguBot in initialConfig.plugins) {
|
||||
val (resultJson, resultConfig) = if (PlaguBot in config.plugins) {
|
||||
KSLog.i("Initial config contains PlaguBot, pass config as is to StartLauncherPlugin")
|
||||
initialJson to initialConfig
|
||||
json to config
|
||||
} else {
|
||||
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")
|
||||
|
||||
val encodedPlaguBotConfig = plaguBotConfig ?.let {
|
||||
defaultJsonFormat.encodeToJsonElement(Config.serializer(), it).jsonObject
|
||||
} ?: JsonObject(emptyMap())
|
||||
|
||||
val resultJson = JsonObject(
|
||||
initialJson + Pair("plugins", JsonArray(initialJson["plugins"]!!.jsonArray + JsonPrimitive(PlaguBot::class.qualifiedName!!)))
|
||||
encodedPlaguBotConfig + JsonObject(
|
||||
json + Pair(
|
||||
"plugins",
|
||||
JsonArray(
|
||||
(json["plugins"] as? JsonArray ?: JsonArray(emptyList())) + JsonPrimitive(PlaguBot::class.qualifiedName!!)
|
||||
)
|
||||
)
|
||||
)
|
||||
)
|
||||
val resultConfig = defaultJsonFormat.decodeFromJsonElement(dev.inmo.micro_utils.startup.launcher.Config.serializer(), resultJson)
|
||||
resultJson to resultConfig
|
||||
@@ -149,9 +239,91 @@ object PlaguBot : Plugin {
|
||||
}
|
||||
|
||||
/**
|
||||
* Accepts single argument in [args] which will be interpreted as [File] path with [StartLauncherPlugin]
|
||||
* configuration content. After reading of that file as [JsonObject] will pass it in [start] with [JsonObject] as
|
||||
* argument
|
||||
* 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")
|
||||
|
||||
@@ -14,5 +14,6 @@ data class Config(
|
||||
@SerialName("database")
|
||||
val databaseConfig: DatabaseConfig = DatabaseConfig(),
|
||||
val botApiServer: String = telegramBotAPIDefaultUrl,
|
||||
val testServer: Boolean = false
|
||||
val testServer: Boolean = false,
|
||||
val proxy: ProxyConfig? = null,
|
||||
)
|
||||
|
||||
@@ -5,8 +5,8 @@ import dev.inmo.kslog.common.logger
|
||||
import kotlinx.coroutines.delay
|
||||
import kotlinx.serialization.Serializable
|
||||
import kotlinx.serialization.Transient
|
||||
import org.jetbrains.exposed.sql.Database
|
||||
import org.jetbrains.exposed.sql.transactions.transactionManager
|
||||
import org.jetbrains.exposed.v1.jdbc.Database
|
||||
import org.jetbrains.exposed.v1.jdbc.transactions.transactionManager
|
||||
import org.koin.core.scope.Scope
|
||||
import org.sqlite.JDBC
|
||||
import java.lang.Exception
|
||||
|
||||
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 {
|
||||
repositories {
|
||||
mavenCentral()
|
||||
mavenLocal()
|
||||
maven { url 'https://jitpack.io' }
|
||||
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()
|
||||
}
|
||||
|
||||
if (new File(projectDir, "secret.gradle").exists()) {
|
||||
apply from: './secret.gradle'
|
||||
def githubTokenVariableName = "GITHUB_RELEASE_TOKEN"
|
||||
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"
|
||||
def githubReleaseToken = project.hasProperty(githubTokenVariableName) ? project.property(githubTokenVariableName).toString() : githubTokenVariableFromEnv
|
||||
|
||||
githubRelease {
|
||||
token "${project.property('GITHUB_RELEASE_TOKEN')}"
|
||||
token githubReleaseToken
|
||||
|
||||
releaseAssets.from('bot/build/distributions')
|
||||
|
||||
|
||||
@@ -5,4 +5,4 @@ kotlin.js.generate.externals=true
|
||||
kotlin.incremental=true
|
||||
|
||||
group=dev.inmo
|
||||
version=10.1.1
|
||||
version=11.1.1
|
||||
|
||||
@@ -1,22 +1,25 @@
|
||||
[versions]
|
||||
|
||||
kt = "2.0.21"
|
||||
kt-serialization = "1.7.3"
|
||||
kt-coroutines = "1.9.0"
|
||||
kt = "2.3.10"
|
||||
kt-serialization = "1.10.0"
|
||||
kt-coroutines = "1.10.2"
|
||||
|
||||
microutils = "0.23.0"
|
||||
tgbotapi = "20.0.1"
|
||||
microutils = "0.29.1"
|
||||
tgbotapi = "32.0.0"
|
||||
ktor = "3.4.1"
|
||||
|
||||
ksp = "2.0.21-1.0.26"
|
||||
ksp = "2.3.6"
|
||||
|
||||
jb-exposed = "0.55.0"
|
||||
jb-dokka = "1.9.20"
|
||||
jb-exposed = "1.1.1"
|
||||
jb-dokka = "2.1.0"
|
||||
|
||||
sqlite = "3.47.0.0"
|
||||
sqlite = "3.51.2.0"
|
||||
|
||||
gh-release = "2.5.2"
|
||||
|
||||
koin = "4.0.0"
|
||||
koin = "4.1.1"
|
||||
|
||||
nmcp = "1.4.4"
|
||||
|
||||
[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-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" }
|
||||
|
||||
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-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" }
|
||||
|
||||
[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
|
||||
distributionPath=wrapper/dists
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-8.10.2-bin.zip
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-8.13-bin.zip
|
||||
zipStoreBase=GRADLE_USER_HOME
|
||||
zipStorePath=wrapper/dists
|
||||
|
||||
@@ -1,5 +1,7 @@
|
||||
|
||||
apply plugin: 'maven-publish'
|
||||
|
||||
|
||||
task javadocJar(type: Jar) {
|
||||
from 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 {
|
||||
name = "InmoNexus"
|
||||
url = uri("https://nexus.inmo.dev/repository/maven-releases/")
|
||||
|
||||
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')
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
repositories {
|
||||
if ((project.hasProperty('INMONEXUS_USER') || System.getenv('INMONEXUS_USER') != null) && (project.hasProperty('INMONEXUS_PASSWORD') || System.getenv('INMONEXUS_PASSWORD') != null)) {
|
||||
maven {
|
||||
name = "InmoNexus"
|
||||
url = uri("https://nexus.inmo.dev/repository/maven-releases/")
|
||||
|
||||
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"
|
||||
url = uri("https://oss.sonatype.org/service/local/staging/deploy/maven2/")
|
||||
|
||||
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')
|
||||
}
|
||||
|
||||
}
|
||||
}
|
||||
}
|
||||
if ((project.hasProperty('SONATYPE_USER') || System.getenv('SONATYPE_USER') != null) && (project.hasProperty('SONATYPE_PASSWORD') || System.getenv('SONATYPE_PASSWORD') != null)) {
|
||||
maven {
|
||||
name = "sonatype"
|
||||
url = uri("https://ossrh-staging-api.central.sonatype.com/service/local/staging/deploy/maven2/")
|
||||
|
||||
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")) {
|
||||
apply plugin: 'signing'
|
||||
|
||||
|
||||
signing {
|
||||
useGpgCmd()
|
||||
|
||||
|
||||
sign publishing.publications
|
||||
}
|
||||
|
||||
|
||||
task signAll {
|
||||
tasks.withType(Sign).forEach {
|
||||
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"}
|
||||
@@ -1,6 +1,6 @@
|
||||
package dev.inmo.plagubot
|
||||
|
||||
import org.jetbrains.exposed.sql.Database
|
||||
import org.jetbrains.exposed.v1.jdbc.Database
|
||||
import org.koin.core.Koin
|
||||
import org.koin.core.scope.Scope
|
||||
|
||||
|
||||
@@ -5,7 +5,6 @@ import kotlinx.serialization.KSerializer
|
||||
import kotlinx.serialization.json.Json
|
||||
import kotlinx.serialization.json.JsonObject
|
||||
import kotlinx.serialization.serializer
|
||||
import org.jetbrains.exposed.sql.Database
|
||||
import org.koin.core.Koin
|
||||
import org.koin.core.module.Module
|
||||
import org.koin.core.scope.Scope
|
||||
|
||||
@@ -28,6 +28,7 @@ interface Plugin : StartPlugin {
|
||||
* @param scope The scope of [org.koin.core.module.Module.single] of bot definition
|
||||
* @param params Params (in fact, the whole bot config)
|
||||
*/
|
||||
@Suppress("DEPRECATION")
|
||||
fun KtorRequestsExecutorBuilder.setupBotClient(scope: Scope, params: JsonObject) = setupBotClient()
|
||||
|
||||
/**
|
||||
|
||||
@@ -7,7 +7,6 @@ import kotlinx.serialization.descriptors.SerialDescriptor
|
||||
import kotlinx.serialization.encoding.Decoder
|
||||
import kotlinx.serialization.encoding.Encoder
|
||||
|
||||
@Serializer(Plugin::class)
|
||||
class PluginSerializer : KSerializer<Plugin> {
|
||||
override val descriptor: SerialDescriptor
|
||||
get() = String.serializer().descriptor
|
||||
|
||||
@@ -10,6 +10,13 @@
|
||||
}
|
||||
},
|
||||
"botToken": "1234567890:ABCDEFGHIJKLMNOP_qrstuvwxyz12345678",
|
||||
"proxy": {
|
||||
"host": "127.0.0.1",
|
||||
"port": 1080,
|
||||
"username": "OPTIONAL username",
|
||||
"password": "OPTIONAL password",
|
||||
"_note": "THIS OBJECT IS OPTIONAL"
|
||||
},
|
||||
"plugins": [
|
||||
"dev.inmo.plagubot.HelloPlugin"
|
||||
],
|
||||
|
||||
Reference in New Issue
Block a user