Skip to content

Commit

Permalink
Implement markdown -> component parsing with commonmark
Browse files Browse the repository at this point in the history
  • Loading branch information
@Erdragh
Erdragh committed Apr 23, 2024
1 parent dcbdc7e commit 598a7fe
Show file tree
Hide file tree
Showing 7 changed files with 387 additions and 98 deletions.
6 changes: 5 additions & 1 deletion build.gradle.kts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ subprojects {
val jdaVersion: String by project
val exposedVersion: String by project
val sqliteJDBCVersion: String by project
val commonmarkVersion: String by project

// This array gets used at multiple places, so it's easier to
// just specify all dependencies at once and re-use them. This
Expand All @@ -85,7 +86,10 @@ subprojects {
// Database driver that allows Exposed to communicate with
// the SQLite database. This will not be in the JAR and needs to be provided
// otherwise (e.g. https://www.curseforge.com/minecraft/mc-mods/sqlite-jdbc)
"org.xerial:sqlite-jdbc:$sqliteJDBCVersion"
"org.xerial:sqlite-jdbc:$sqliteJDBCVersion",

// Markdown parser used for formatting Discord messages in Minecraft
"org.commonmark:commonmark:$commonmarkVersion",
)

dependencies {
Expand Down
7 changes: 7 additions & 0 deletions common/src/main/kotlin/dev/erdragh/astralbot/config/AstralBotTextConfig.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ object AstralBotTextConfig {

val GENERIC_ERROR: ForgeConfigSpec.ConfigValue<String>
val GENERIC_SUCCESS: ForgeConfigSpec.ConfigValue<String>
val GENERIC_BLOCKED: ForgeConfigSpec.ConfigValue<String>

val FAQ_ERROR: ForgeConfigSpec.ConfigValue<String>
val FAQ_NO_REGISTERED: ForgeConfigSpec.ConfigValue<String>
Expand All @@ -17,6 +18,7 @@ object AstralBotTextConfig {

val DISCORD_MESSAGE: ForgeConfigSpec.ConfigValue<String>
val DISCORD_REPLY: ForgeConfigSpec.ConfigValue<String>
val DISCORD_EMBEDS: ForgeConfigSpec.ConfigValue<String>

val RELOAD_ERROR: ForgeConfigSpec.ConfigValue<String>
val RELOAD_SUCCESS: ForgeConfigSpec.ConfigValue<String>
Expand All @@ -41,6 +43,8 @@ object AstralBotTextConfig {
.define("genericError", "Something went wrong!")
GENERIC_SUCCESS = builder.comment("Generic success message sent to Discord")
.define("genericSuccess", "Success!")
GENERIC_BLOCKED = builder.comment("Generic string that replaces blocked URLs/Links")
.define("genericBlocked", "[BLOCKED]")

FAQ_ERROR = builder.comment("Message sent to Discord if an error ocurrs during FAQ loading")
.define(mutableListOf("faq", "error"), "Bot Error (Contact Bot Operator)")
Expand Down Expand Up @@ -76,6 +80,9 @@ object AstralBotTextConfig {
The user the message is in reply to is referenced by {{replied}}
""".replace(whitespaceRegex, "\n"))
.define(mutableListOf("messages", "discord", "reply"), " replying to {{replied}}")
DISCORD_EMBEDS =
builder.comment("Template for the label of embeds of a message.")
.define(mutableListOf("messages", "discord", "embeds"), "Embeds:")

RELOAD_ERROR =
builder.comment("""Template for the error message sent to Discord when reloading fails.
Expand Down
106 changes: 11 additions & 95 deletions common/src/main/kotlin/dev/erdragh/astralbot/handlers/MinecraftHandler.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import com.mojang.authlib.GameProfile
import dev.erdragh.astralbot.*
import dev.erdragh.astralbot.config.AstralBotConfig
import dev.erdragh.astralbot.config.AstralBotTextConfig
import net.dv8tion.jda.api.EmbedBuilder
import dev.erdragh.astralbot.util.*
import net.dv8tion.jda.api.entities.Member
import net.dv8tion.jda.api.entities.Message
import net.dv8tion.jda.api.entities.MessageEmbed
Expand All @@ -17,13 +17,9 @@ import net.minecraft.network.chat.HoverEvent
import net.minecraft.network.chat.MutableComponent
import net.minecraft.server.MinecraftServer
import net.minecraft.server.level.ServerPlayer
import net.minecraft.world.entity.EntityType
import net.minecraft.world.item.ItemStack
import net.minecraft.world.item.TooltipFlag
import java.awt.Color
import java.text.DecimalFormat
import java.util.*
import java.util.regex.Pattern
import kotlin.jvm.optionals.getOrNull
import kotlin.math.min

Expand All @@ -40,15 +36,6 @@ class MinecraftHandler(private val server: MinecraftServer) : ListenerAdapter()

companion object {
private val numberFormat = DecimalFormat("###.##")

// Pattern for recognizing a URL, based off RFC 3986
// Source: https://stackoverflow.com/questions/5713558/detect-and-extract-url-from-a-string
private val urlPattern: Pattern = Pattern.compile(
"(?:^|[\\W])((ht|f)tp(s?):\\/\\/|www\\.)"
+ "(([\\w\\-]+\\.){1,}?([\\w\\-.~]+\\/?)*"
+ "[\\p{Alnum}.,%_=?&#\\-+()\\[\\]\\*$~@!:/{};']*)",
Pattern.CASE_INSENSITIVE or Pattern.MULTILINE or Pattern.DOTALL
)
}

/**
Expand Down Expand Up @@ -133,82 +120,6 @@ class MinecraftHandler(private val server: MinecraftServer) : ListenerAdapter()
return server.profileCache?.get(name)?.getOrNull()
}

private fun formatComponentToMarkdown(comp: Component): String {
return comp.toFlatList()
.map {
var formatted = it.string

if (it.style.isBold) {
formatted = "**$formatted**"
}
if (it.style.isItalic) {
formatted = "_${formatted}_"
}
it.style.clickEvent?.let { clickEvent ->
if (clickEvent.action == ClickEvent.Action.OPEN_URL) {
formatted = "[$formatted](${clickEvent.value})"
}
}

val matcher = urlPattern.matcher(formatted)
val replaced = matcher.replaceAll { match ->
val group = match.group()
if (AstralBotConfig.urlAllowed(group)) {
return@replaceAll group
} else {
return@replaceAll "`URL BLOCKED`"
}
}
formatted = replaced

return@map formatted
}
.joinToString("")
}

private fun formatHoverText(text: Component): MessageEmbed {
return EmbedBuilder()
.setDescription(text.string)
.let { builder: EmbedBuilder ->
text.style.color?.value?.let { color -> builder.setColor(color) }
builder
}
.build()
}

private fun formatHoverItems(stack: ItemStack, knownItems: MutableList<ItemStack>): MessageEmbed? {
if (knownItems.contains(stack)) return null
knownItems.add(stack)
val tooltip = stack.getTooltipLines(notchPlayer, TooltipFlag.NORMAL).map(::formatComponentToMarkdown)
return EmbedBuilder()
.setTitle("${tooltip[0]} ${if (stack.count > 1) "(${stack.count})" else ""}")
.setDescription(tooltip.drop(1).let {
if (stack.hasCustomHoverName()) {
listOf(stack.item.description.string).plus(it)
} else it
}.joinToString("\n"))
.let { builder: EmbedBuilder ->
stack.rarity.color.color?.let { color -> builder.setColor(color) }
builder
}
.build()
}

private fun formatHoverEntity(entity: HoverEvent.EntityTooltipInfo): MessageEmbed? {
if (entity.type == EntityType.PLAYER) return null
return EmbedBuilder()
.setTitle(entity.name?.string)
.setDescription(entity.type.description.string)
.let { builder: EmbedBuilder ->
val mobCategory = entity.type.category
if (mobCategory.isFriendly) {
builder.setColor(Color.GREEN)
}
builder
}
.build()
}

/**
* Sends a message into the configured Discord channel based on
* the Chat [message] the [player] sent.
Expand All @@ -230,7 +141,7 @@ class MinecraftHandler(private val server: MinecraftServer) : ListenerAdapter()
formattedEmbeds.add(formatHoverText(it))
}
attachment.getValue(HoverEvent.Action.SHOW_ITEM)?.itemStack?.let {
formatHoverItems(it, items)?.let(formattedEmbeds::add)
formatHoverItems(it, items, notchPlayer)?.let(formattedEmbeds::add)
}
attachment.getValue(HoverEvent.Action.SHOW_ENTITY)?.let {
formatHoverEntity(it)?.let(formattedEmbeds::add)
Expand Down Expand Up @@ -304,7 +215,7 @@ class MinecraftHandler(private val server: MinecraftServer) : ListenerAdapter()

val messageContents = Component.empty()
// This is the actual message content
val actualMessage = Component.literal(message.contentDisplay)
val actualMessage = formatMarkdownToComponent(message.contentDisplay)
// If it's enabled in the config you can click on a message and get linked to said message
// in the actual Discord client
if (AstralBotConfig.CLICKABLE_MESSAGES.get()) {
Expand Down Expand Up @@ -423,7 +334,7 @@ class MinecraftHandler(private val server: MinecraftServer) : ListenerAdapter()
val comp = Component.empty()
// Adds a newline with space if there are embeds and the message isn't empty
if (message.embeds.size + message.attachments.size + message.stickers.size > 0 && message.contentDisplay.isNotBlank()) comp.append(
"\n "
"\n ${AstralBotTextConfig.DISCORD_EMBEDS.get()} "
)
var i = 0
message.embeds.forEach {
Expand Down Expand Up @@ -469,14 +380,19 @@ class MinecraftHandler(private val server: MinecraftServer) : ListenerAdapter()
if (AstralBotConfig.CLICKABLE_EMBEDS.get()) {
embedComponent.withStyle { style ->
if (url != null && AstralBotConfig.CLICKABLE_EMBEDS.get()) {
style.withColor(ChatFormatting.BLUE).withUnderlined(true)
style.withColor(ChatFormatting.BLUE)
.withUnderlined(true)
.withClickEvent(ClickEvent(ClickEvent.Action.OPEN_URL, url))
.withHoverEvent(HoverEvent(HoverEvent.Action.SHOW_TEXT, Component.nullToEmpty(url)))
} else style
}
}
comp.append(embedComponent)
} else {
comp.append(Component.literal("BLOCKED").withStyle(ChatFormatting.RED))
comp.append(
Component.literal(AstralBotTextConfig.GENERIC_BLOCKED.get())
.withStyle(ChatFormatting.RED, ChatFormatting.UNDERLINE)
)
}
return comp
}
Expand Down
Loading

0 comments on commit 598a7fe

Please sign in to comment.