All Downloads are FREE. Search and download functionalities are using the official Maven repository.

bot-connector-slack.19.9.3.source-code.SlackConnector.kt Maven / Gradle / Ivy

There is a newer version: 24.9.4
Show newest version
/*
 * Copyright (C) 2017/2019 e-voyageurs technologies
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package ai.tock.bot.connector.slack

import ai.tock.bot.connector.ConnectorBase
import ai.tock.bot.connector.ConnectorCallback
import ai.tock.bot.connector.ConnectorMessage
import ai.tock.bot.connector.media.MediaCard
import ai.tock.bot.connector.media.MediaMessage
import ai.tock.bot.connector.slack.model.EventApiMessage
import ai.tock.bot.connector.slack.model.SlackConnectorMessage
import ai.tock.bot.connector.slack.model.SlackMessageOut
import ai.tock.bot.connector.slack.model.UrlVerificationEvent
import ai.tock.bot.connector.slack.model.old.SlackMessageIn
import ai.tock.bot.engine.BotBus
import ai.tock.bot.engine.BotRepository.requestTimer
import ai.tock.bot.engine.ConnectorController
import ai.tock.bot.engine.action.Action
import ai.tock.bot.engine.event.Event
import ai.tock.bot.engine.monitoring.logError
import ai.tock.shared.Executor
import ai.tock.shared.booleanProperty
import ai.tock.shared.error
import ai.tock.shared.injector
import ai.tock.shared.jackson.mapper
import ai.tock.shared.vertx.vertx
import com.fasterxml.jackson.module.kotlin.readValue
import com.github.salomonbrys.kodein.instance
import mu.KotlinLogging
import java.net.URLDecoder
import java.time.Duration

class SlackConnector(
    val applicationId: String,
    val path: String,
    val outToken1: String,
    val outToken2: String,
    val outToken3: String,
    val client: SlackClient
) : ConnectorBase(SlackConnectorProvider.connectorType) {

    companion object {
        private val logger = KotlinLogging.logger {}
        private val OLD_SLACK_API = booleanProperty("tock_slack_old_api_style", false)
    }

    private val executor: Executor by injector.instance()

    override fun register(controller: ConnectorController) {
        if (OLD_SLACK_API) {
            oldApi(controller)
        } else {
            eventApi(controller)
        }
    }

    private fun eventApi(controller: ConnectorController) {
        controller.registerServices(path) { router ->
            router.post(path).handler { context ->
                val requestTimerData = requestTimer.start("slack_webhook")
                try {
                    val body = context.bodyAsString.let {
                        if (it.startsWith("payload=")) {
                            URLDecoder.decode(it.substring("payload=".length), "UTF-8")
                        } else {
                            it
                        }
                    }
                    logger.info { "message received from slack: $body" }


                    val message: EventApiMessage = mapper.readValue(body)
                    if (message is UrlVerificationEvent) {
                        context
                            .response()
                            .putHeader("Content-type", "text/plain")
                            .end(message.challenge)
                    } else {
                        //answer to slack immediately
                        context.response().end()
                        val event = SlackRequestConverter.toEvent(message, applicationId)
                        if (event != null) {
                            executor.executeBlocking {
                                controller.handle(event)
                            }
                        } else {
                            logger.debug { "skip message: $body" }
                        }
                    }
                } catch (e: Throwable) {
                    logger.logError(e, requestTimerData)
                    try {
                        context.response().end()
                    } catch (e: Exception) {
                        logger.error(e)
                    }
                } finally {
                    try {
                        requestTimer.end(requestTimerData)
                    } catch (e: Throwable) {
                        logger.error(e)
                    }
                }
            }

        }
    }

    private fun oldApi(controller: ConnectorController) {
        controller.registerServices(path) { router ->
            router.post(path).handler { context ->
                val requestTimerData = requestTimer.start("slack_webhook")
                try {
                    val body = context.convertUrlEncodedStringToJson()
                    logger.info { "message received from slack: $body" }

                    val message = mapper.readValue(body, SlackMessageIn::class.java)
                    if (message.user_id != "USLACKBOT") {
                        vertx.executeBlocking({
                            try {
                                val event = SlackRequestConverter.toEvent(message, applicationId)
                                if (event != null) {
                                    controller.handle(event)
                                } else {
                                    logger.logError("unable to convert $message to event", requestTimerData)
                                }
                            } catch (e: Throwable) {
                                logger.logError(e, requestTimerData)
                            }
                        }, false, {})
                    }
                } catch (e: Throwable) {
                    logger.logError(e, requestTimerData)
                } finally {
                    try {
                        requestTimer.end(requestTimerData)
                        context.response().end()
                    } catch (e: Throwable) {
                        logger.error(e)
                    }
                }
            }

        }
    }

    override fun send(event: Event, callback: ConnectorCallback, delayInMs: Long) {
        logger.debug { "event: $event" }
        if (event is Action) {
            val message = SlackMessageConverter.toMessageOut(event)
            if (message != null) {
                sendMessage(message, delayInMs)
            }
        }
    }


    private fun sendMessage(message: SlackConnectorMessage, delayInMs: Long) {
        executor.executeBlocking(Duration.ofMillis(delayInMs)) {
            client.sendMessage(outToken1, outToken2, outToken3, message)
        }
    }

    override fun addSuggestions(text: CharSequence, suggestions: List): BotBus.() -> ConnectorMessage? = {
        slackMessage(
            text,
            slackAttachment(null, suggestions.map { slackButton(it) })
        )
    }

    override fun addSuggestions(message: ConnectorMessage, suggestions: List): BotBus.() -> ConnectorMessage? = {
        if (message is SlackMessageOut) {
            val attachment = message.attachments.lastOrNull()
            if (attachment == null) {
                message.copy(attachments = listOf(slackAttachment(null, suggestions.map { slackButton(it) })))
            } else if (attachment.actions.isEmpty()) {
                message.copy(attachments =
                message.attachments.take(message.attachments.size - 1) + slackAttachment(null, suggestions.map { slackButton(it) }))
            } else {
                null
            }
        } else {
            null
        }
    }

    override fun toConnectorMessage(message: MediaMessage): BotBus.() -> List = {
        if (message is MediaCard) {
            val title = message.title
            val subTitle = message.subTitle
            listOfNotNull(
                if (title != null && subTitle != null) {
                    textMessage(title)
                } else {
                    null
                },
                slackMessage(
                    subTitle ?: title ?: "",
                    slackAttachment(null, message.actions.filter { it.url == null }.map { slackButton(it.title) }))
            )
        } else {
            emptyList()
        }
    }
}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy