kageru/discord-kagebot
1
0
Fork 0
Code Issues 4 Pull Requests Releases Wiki Activity

Split Globals into Globals and Config

This commit is contained in:
kageru 2019-07-13 15:39:50 +02:00
parent c59c0fdcd6
commit f56df24c4f
Signed by: kageru
GPG Key ID: 8282A2BEA4ADA3D2
15 changed files with 102 additions and 94 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
src/main/kotlin/moe/kageru/kagebot/Globals.kt
View File

@ -1,19 +1,10 @@
package moe.kageru.kagebot
import moe.kageru.kagebot.command.Command
import moe.kageru.kagebot.config.Localization
import moe.kageru.kagebot.config.SystemConfig
import moe.kageru.kagebot.features.Features
import org.javacord.api.DiscordApi
import org.javacord.api.entity.server.Server
import java.util.concurrent.atomic.AtomicInteger
object Globals {
lateinit var server: Server
lateinit var api: DiscordApi
lateinit var commands: List<Command>
lateinit var systemConfig: SystemConfig
lateinit var features: Features
lateinit var localization: Localization
val commandCounter: AtomicInteger = AtomicInteger(0)
}

7
src/main/kotlin/moe/kageru/kagebot/Kagebot.kt
View File

@ -2,6 +2,7 @@ package moe.kageru.kagebot
import moe.kageru.kagebot.Log.log
import moe.kageru.kagebot.Util.checked
import moe.kageru.kagebot.config.Config
import moe.kageru.kagebot.config.ConfigParser
import moe.kageru.kagebot.config.RawConfig
import org.javacord.api.DiscordApiBuilder
@ -22,7 +23,7 @@ object Kagebot {
}
return
}
for (command in Globals.commands) {
for (command in Config.commands) {
if (command.matches(event.readableMessageContent)) {
command.execute(event)
break
@ -31,7 +32,7 @@ object Kagebot {
}
fun welcomeUser(event: ServerMemberJoinEvent) {
Globals.features.welcome!!.let { welcome ->
Config.features.welcome!!.let { welcome ->
val message = event.user.sendMessage(welcome.embed)
// If the user disabled direct messages, try the fallback (if defined)
if (!Util.wasSuccessful(message) &&
@ -64,7 +65,7 @@ object Kagebot {
})
log.info("kagebot Mk II running")
Globals.api.addMessageCreateListener { checked { processMessage(it) } }
Globals.features.welcome?.let {
Config.features.welcome?.let {
Globals.api.addServerMemberJoinListener {
checked { welcomeUser(it) }
}

5
src/main/kotlin/moe/kageru/kagebot/MessageUtil.kt
View File

@ -1,5 +1,6 @@
package moe.kageru.kagebot
import moe.kageru.kagebot.config.Config
import org.javacord.api.entity.message.MessageAuthor
import org.javacord.api.entity.message.embed.EmbedBuilder
import org.javacord.api.entity.user.User
@ -15,8 +16,8 @@ object MessageUtil {
fun getEmbedBuilder(): EmbedBuilder {
val builder = EmbedBuilder()
Globals.server.icon.ifPresent { builder.setThumbnail(it) }
return builder.setColor(Globals.systemConfig.color).setTimestampToNow()
Config.server.icon.ifPresent { builder.setThumbnail(it) }
return builder.setColor(Config.systemConfig.color).setTimestampToNow()
}
/*

10
src/main/kotlin/moe/kageru/kagebot/Util.kt
View File

@ -1,8 +1,8 @@
package moe.kageru.kagebot
import moe.kageru.kagebot.Globals.api
import moe.kageru.kagebot.Globals.server
import moe.kageru.kagebot.Log.log
import moe.kageru.kagebot.config.Config
import moe.kageru.kagebot.config.Config.server
import org.javacord.api.entity.channel.TextChannel
import org.javacord.api.entity.message.MessageAuthor
import org.javacord.api.entity.message.embed.EmbedBuilder
@ -10,7 +10,7 @@ import org.javacord.api.entity.permission.Role
import org.javacord.api.entity.user.User
import org.javacord.api.event.message.MessageCreateEvent
import java.awt.Color
import java.util.Optional
import java.util.*
import java.util.concurrent.CompletableFuture
import java.util.concurrent.CompletionException
@ -69,7 +69,7 @@ object Util {
idOrName.isEntityId() -> server.getTextChannelById(idOrName).ifNotEmpty { it }
?: throw IllegalArgumentException("Channel ID $idOrName not found.")
else -> if (idOrName.startsWith('@')) {
api.getCachedUserByDiscriminatedName(idOrName.removePrefix("@")).ifNotEmpty { user ->
Globals.api.getCachedUserByDiscriminatedName(idOrName.removePrefix("@")).ifNotEmpty { user ->
val channelFuture = user.openPrivateChannel()
val channel = channelFuture.join()
if (channelFuture.isCompletedExceptionally) {
@ -111,7 +111,7 @@ object Util {
fun userFromMessage(message: MessageCreateEvent): User? {
return message.messageAuthor.id.let { id ->
Globals.server.getMemberById(id).orElse(null)
Config.server.getMemberById(id).orElse(null)
}
}
}

7
src/main/kotlin/moe/kageru/kagebot/command/Command.kt
View File

@ -4,6 +4,7 @@ import moe.kageru.kagebot.Globals
import moe.kageru.kagebot.Log.log
import moe.kageru.kagebot.MessageUtil
import moe.kageru.kagebot.Util.doIf
import moe.kageru.kagebot.config.Config
import moe.kageru.kagebot.config.RawCommand
import moe.kageru.kagebot.features.MessageFeature
import org.javacord.api.entity.message.MessageAuthor
@ -33,15 +34,15 @@ class Command(cmd: RawCommand) {
actions = cmd.actions?.let { MessageActions(it) }
regex = if (matchType == MatchType.REGEX) Regex(trigger) else null
embed = cmd.embed?.let(MessageUtil::listToEmbed)
feature = cmd.feature?.let { Globals.features.findByString(it) }
feature = cmd.feature?.let { Config.features.findByString(it) }
}
fun isAllowed(message: MessageCreateEvent) = permissions?.isAllowed(message) ?: true
fun execute(message: MessageCreateEvent) {
if (permissions?.isAllowed(message) == false) {
if (Globals.localization.permissionDenied.isNotBlank()) {
message.channel.sendMessage(Globals.localization.permissionDenied)
if (Config.localization.permissionDenied.isNotBlank()) {
message.channel.sendMessage(Config.localization.permissionDenied)
}
log.info("Denying command ${this.trigger} to user ${message.messageAuthor.discriminatedName} (ID: ${message.messageAuthor.id})")
return

4
src/main/kotlin/moe/kageru/kagebot/command/MessageActions.kt
View File

@ -1,6 +1,6 @@
package moe.kageru.kagebot.command
import moe.kageru.kagebot.Globals
import moe.kageru.kagebot.config.Config
import moe.kageru.kagebot.Log.log
import moe.kageru.kagebot.MessageUtil
import moe.kageru.kagebot.config.RawMessageActions
@ -25,7 +25,7 @@ class MessageActions(rawActions: RawMessageActions) {
message.messageAuthor.asUser().ifPresent { user ->
user.sendMessage(
MessageUtil.getEmbedBuilder()
.addField("Blacklisted", Globals.localization.messageDeleted)
.addField("Blacklisted", Config.localization.messageDeleted)
.addField("Original:", "“${message.readableMessageContent}”")
)
}

4
src/main/kotlin/moe/kageru/kagebot/command/MessageRedirect.kt
View File

@ -1,6 +1,6 @@
package moe.kageru.kagebot.command
import moe.kageru.kagebot.Globals
import moe.kageru.kagebot.config.Config
import moe.kageru.kagebot.Log.log
import moe.kageru.kagebot.MessageUtil
import moe.kageru.kagebot.Util
@ -16,7 +16,7 @@ internal class MessageRedirect(rawRedirect: RawRedirect) {
fun execute(message: MessageCreateEvent, command: Command) {
val embed = MessageUtil.getEmbedBuilder()
.addField(
Globals.localization.redirectedMessage,
Config.localization.redirectedMessage,
message.readableMessageContent.let { content ->
when (command.matchType) {
MatchType.PREFIX -> content.removePrefix(command.trigger).trim()

53
src/main/kotlin/moe/kageru/kagebot/config/Config.kt
View File

@ -1,52 +1,13 @@
package moe.kageru.kagebot.config
import moe.kageru.kagebot.Globals
import moe.kageru.kagebot.Globals.api
import moe.kageru.kagebot.command.Command
import moe.kageru.kagebot.features.Features
import java.awt.Color
import org.javacord.api.entity.server.Server
object ConfigParser {
fun initialLoad(rawConfig: RawConfig) {
val systemConfig = rawConfig.system?.let(::SystemConfig)
?: throw IllegalArgumentException("No [system] block in config.")
Globals.server = api.getServerById(systemConfig.serverId).orElseThrow { IllegalArgumentException("Invalid server configured.") }
Globals.systemConfig = systemConfig
reloadLocalization(rawConfig)
reloadFeatures(rawConfig)
reloadCommands(rawConfig)
}
fun reloadLocalization(rawConfig: RawConfig) {
Globals.localization = rawConfig.localization?.let(::Localization)
?: throw IllegalArgumentException("No [localization] block in config.")
}
fun reloadCommands(rawConfig: RawConfig) {
Globals.commands = rawConfig.commands?.map(::Command)?.toMutableList()
?: throw IllegalArgumentException("No commands found in config.")
}
fun reloadFeatures(rawConfig: RawConfig) {
Globals.features = rawConfig.features?.let(::Features)
?: Features(RawFeatures(null))
}
}
class SystemConfig(val serverId: String, val color: Color) {
constructor(rawSystemConfig: RawSystemConfig) : this(
rawSystemConfig.serverId ?: throw IllegalArgumentException("No [system.server] defined."),
Color.decode(rawSystemConfig.color ?: "#1793d0")
)
}
class Localization(val permissionDenied: String, val redirectedMessage: String, val messageDeleted: String) {
constructor(rawLocalization: RawLocalization) : this(
permissionDenied = rawLocalization.permissionDenied
?: throw IllegalArgumentException("No [localization.permissionDenied] defined"),
redirectedMessage = rawLocalization.redirectedMessage
?: throw IllegalArgumentException("No [localization.redirectMessage] defined"),
messageDeleted = rawLocalization.messageDeleted
?: throw IllegalArgumentException("No [localization.messageDeleted] defined")
)
object Config {
lateinit var server: Server
lateinit var commands: List<Command>
lateinit var systemConfig: SystemConfig
lateinit var features: Features
lateinit var localization: Localization
}

51
src/main/kotlin/moe/kageru/kagebot/config/ConfigParser.kt Normal file
View File

@ -0,0 +1,51 @@
package moe.kageru.kagebot.config
import moe.kageru.kagebot.Globals
import moe.kageru.kagebot.command.Command
import moe.kageru.kagebot.features.Features
import java.awt.Color
object ConfigParser {
fun initialLoad(rawConfig: RawConfig) {
val systemConfig = rawConfig.system?.let(::SystemConfig)
?: throw IllegalArgumentException("No [system] block in config.")
Config.server = Globals.api.getServerById(systemConfig.serverId).orElseThrow { IllegalArgumentException("Invalid server configured.") }
Config.systemConfig = systemConfig
reloadLocalization(rawConfig)
reloadFeatures(rawConfig)
reloadCommands(rawConfig)
}
fun reloadLocalization(rawConfig: RawConfig) {
Config.localization = rawConfig.localization?.let(::Localization)
?: throw IllegalArgumentException("No [localization] block in config.")
}
fun reloadCommands(rawConfig: RawConfig) {
Config.commands = rawConfig.commands?.map(::Command)?.toMutableList()
?: throw IllegalArgumentException("No commands found in config.")
}
fun reloadFeatures(rawConfig: RawConfig) {
Config.features = rawConfig.features?.let(::Features)
?: Features(RawFeatures(null))
}
}
class SystemConfig(val serverId: String, val color: Color) {
constructor(rawSystemConfig: RawSystemConfig) : this(
rawSystemConfig.serverId ?: throw IllegalArgumentException("No [system.server] defined."),
Color.decode(rawSystemConfig.color ?: "#1793d0")
)
}
class Localization(val permissionDenied: String, val redirectedMessage: String, val messageDeleted: String) {
constructor(rawLocalization: RawLocalization) : this(
permissionDenied = rawLocalization.permissionDenied
?: throw IllegalArgumentException("No [localization.permissionDenied] defined"),
redirectedMessage = rawLocalization.redirectedMessage
?: throw IllegalArgumentException("No [localization.redirectMessage] defined"),
messageDeleted = rawLocalization.messageDeleted
?: throw IllegalArgumentException("No [localization.messageDeleted] defined")
)
}

4
src/main/kotlin/moe/kageru/kagebot/features/HelpFeature.kt
View File

@ -1,6 +1,6 @@
package moe.kageru.kagebot.features
import moe.kageru.kagebot.Globals
import moe.kageru.kagebot.config.Config
import moe.kageru.kagebot.MessageUtil
import moe.kageru.kagebot.command.MatchType
import org.javacord.api.event.message.MessageCreateEvent
@ -14,7 +14,7 @@ class HelpFeature : MessageFeature() {
}
}
private fun listCommands(message: MessageCreateEvent) = Globals.commands
private fun listCommands(message: MessageCreateEvent) = Config.commands
.filter { it.matchType == MatchType.PREFIX && it.isAllowed(message) }
.map { it.trigger }
.joinToString("\n")

9
src/test/kotlin/moe/kageru/kagebot/ConfigTest.kt
View File

@ -3,13 +3,14 @@ package moe.kageru.kagebot
import io.kotlintest.shouldBe
import io.kotlintest.shouldNotBe
import io.kotlintest.specs.ShouldSpec
import moe.kageru.kagebot.config.Config
class ConfigTest : ShouldSpec({
TestUtil.prepareTestEnvironment()
"should properly parse test config" {
Globals.systemConfig shouldNotBe null
Globals.localization shouldNotBe null
Globals.features shouldNotBe null
Globals.commands.size shouldBe 2
Config.systemConfig shouldNotBe null
Config.localization shouldNotBe null
Config.features shouldNotBe null
Config.commands.size shouldBe 2
}
})

9
src/test/kotlin/moe/kageru/kagebot/TestUtil.kt
View File

@ -7,6 +7,7 @@ import io.mockk.Runs
import io.mockk.every
import io.mockk.just
import io.mockk.mockk
import moe.kageru.kagebot.config.Config
import moe.kageru.kagebot.config.ConfigParser
import moe.kageru.kagebot.config.RawConfig
import org.javacord.api.DiscordApi
@ -88,19 +89,19 @@ object TestUtil {
}
fun <R> withCommands(config: String, test: (() -> R)) {
val oldCmds = Globals.commands
val oldCmds = Config.commands
val rawConfig = RawConfig.readFromString(config)
ConfigParser.reloadCommands(rawConfig)
test()
Globals.commands = oldCmds
Config.commands = oldCmds
}
fun <R> withLocalization(config: String, test: (() -> R)) {
val oldLoc = Globals.localization
val oldLoc = Config.localization
val rawConfig = RawConfig.readFromString(config)
ConfigParser.reloadLocalization(rawConfig)
test()
Globals.localization = oldLoc
Config.localization = oldLoc
}
fun withReplyContents(

14
src/test/kotlin/moe/kageru/kagebot/command/CommandTest.kt
View File

@ -5,7 +5,7 @@ import io.kotlintest.shouldBe
import io.kotlintest.specs.StringSpec
import io.mockk.every
import io.mockk.mockk
import moe.kageru.kagebot.Globals
import moe.kageru.kagebot.config.Config
import moe.kageru.kagebot.Kagebot
import moe.kageru.kagebot.TestUtil
import moe.kageru.kagebot.TestUtil.embedToString
@ -132,7 +132,7 @@ class CommandTest : StringSpec({
val replies = mutableListOf<String>()
val mockMessage = mockMessage("!restricted", replies = replies)
Kagebot.processMessage(mockMessage)
replies shouldBe mutableListOf(Globals.localization.permissionDenied)
replies shouldBe mutableListOf(Config.localization.permissionDenied)
withLocalization(
"""
[localization]
@ -182,7 +182,7 @@ class CommandTest : StringSpec({
val mockMessage = mockMessage("!restricted", replies = calls)
every { mockMessage.messageAuthor.asUser() } returns Optional.of(mockk {
every { getRoles(any()) } returns listOf(
Globals.server.getRolesByNameIgnoreCase("testrole")[0]
Config.server.getRolesByNameIgnoreCase("testrole")[0]
)
})
Kagebot.processMessage(mockMessage)
@ -205,7 +205,7 @@ class CommandTest : StringSpec({
every { mockMessage.messageAuthor.asUser() } returns mockk {
every { isPresent } returns true
every { get().getRoles(any()) } returns listOf(
Globals.server.getRolesByNameIgnoreCase("testrole")[0]
Config.server.getRolesByNameIgnoreCase("testrole")[0]
)
}
Kagebot.processMessage(mockMessage)
@ -216,7 +216,7 @@ class CommandTest : StringSpec({
every { get().getRoles(any()) } returns emptyList()
}
Kagebot.processMessage(mockMessage)
calls shouldBe mutableListOf(Globals.localization.permissionDenied, "access granted")
calls shouldBe mutableListOf(Config.localization.permissionDenied, "access granted")
}
}
"should refuse DM only message in server channel" {
@ -231,7 +231,7 @@ class CommandTest : StringSpec({
) {
val calls = mutableListOf<String>()
Kagebot.processMessage(mockMessage("!dm", replies = calls))
calls shouldBe listOf(Globals.localization.permissionDenied)
calls shouldBe listOf(Config.localization.permissionDenied)
}
}
/*
@ -270,7 +270,7 @@ class CommandTest : StringSpec({
val user = mockk<User> {
every { addRole(capture(roles), "Requested via command.") } returns mockk()
}
every { Globals.server.getMemberById(1) } returns Optional.of(user)
every { Config.server.getMemberById(1) } returns Optional.of(user)
Kagebot.processMessage(mockMessage("!assign"))
roles shouldBe mutableListOf(Util.findRole("testrole"))
}

4
src/test/kotlin/moe/kageru/kagebot/features/HelpFeatureTest.kt
View File

@ -3,7 +3,7 @@ package moe.kageru.kagebot.features
import io.kotlintest.specs.StringSpec
import io.mockk.every
import io.mockk.mockk
import moe.kageru.kagebot.Globals
import moe.kageru.kagebot.config.Config
import moe.kageru.kagebot.Kagebot
import moe.kageru.kagebot.TestUtil
import moe.kageru.kagebot.TestUtil.mockMessage
@ -48,7 +48,7 @@ class HelpFeatureTest : StringSpec({
val message = mockMessage("!help", replyEmbeds = replies)
every { message.messageAuthor.asUser() } returns Optional.of(mockk {
every { getRoles(any()) } returns listOf(
Globals.server.getRolesByNameIgnoreCase("testrole")[0]
Config.server.getRolesByNameIgnoreCase("testrole")[0]
)
})
Kagebot.processMessage(message)

4
src/test/kotlin/moe/kageru/kagebot/features/WelcomeFeatureTest.kt
View File

@ -4,7 +4,7 @@ import io.kotlintest.shouldBe
import io.kotlintest.specs.StringSpec
import io.mockk.every
import io.mockk.mockk
import moe.kageru.kagebot.Globals
import moe.kageru.kagebot.config.Config
import moe.kageru.kagebot.Kagebot
import moe.kageru.kagebot.TestUtil
import org.javacord.api.entity.message.embed.EmbedBuilder
@ -23,7 +23,7 @@ class WelcomeFeatureTest : StringSpec({
}
}
)
sentMessages shouldBe mutableListOf(Globals.features.welcome!!.embed)
sentMessages shouldBe mutableListOf(Config.features.welcome!!.embed)
}
"should send welcome fallback if DMs are disabled" {
val message = mutableListOf<String>()