fr.vsct.tock.bot.engine.action.Action.kt Maven / Gradle / Ivy

Go to download
/*
 * Copyright (C) 2017 VSCT
 *
 * 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 fr.vsct.tock.bot.engine.action

import com.fasterxml.jackson.module.kotlin.readValue
import fr.vsct.tock.bot.definition.ParameterKey
import fr.vsct.tock.bot.engine.dialog.EventState
import fr.vsct.tock.bot.engine.event.Event
import fr.vsct.tock.bot.engine.message.Message
import fr.vsct.tock.bot.engine.user.PlayerId
import fr.vsct.tock.shared.jackson.mapper
import fr.vsct.tock.shared.security.StringObfuscatorMode
import org.litote.kmongo.Id
import java.time.Instant

/**
 * A user (or bot) action.
 */
abstract class Action(
    val playerId: PlayerId,
    val recipientId: PlayerId,
    applicationId: String,
    id: Id,
    date: Instant,
    state: EventState,
    val metadata: ActionMetadata = ActionMetadata()
) : Event(applicationId, id, date, state) {

    abstract fun toMessage(): Message

    override fun obfuscate(mode: StringObfuscatorMode): Event {
        return obfuscate(mode, playerId)
    }

    abstract fun obfuscate(mode: StringObfuscatorMode, playerId: PlayerId): Event

    @Suppress("UNCHECKED_CAST")
    fun toActionId(): Id = id as Id

    /**
     * Returns the value of the specified choice parameter,
     * null if the user action is not a [SendChoice]
     * or if this parameter is not set.
     */
    fun choice(key: ParameterKey): String? =
        (this as? SendChoice)
            ?.parameters
            ?.get(key.keyName)

    /**
     * Returns true if the specified choice as the "true" value, false either.
     */
    fun booleanChoice(key: ParameterKey): Boolean =
        choice(key).equals("true", true)

    /**
     * Returns the value of the specified choice parameter,
     * null if the user action is not a [SendChoice]
     * or if this parameter is not set.
     */
    inline fun  jsonChoice(key: ParameterKey): T? =
        choice(key)?.let { mapper.readValue(it) }
}