commonMain.event.EventChannelImpl.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of mirai-core-jvm Show documentation
Mirai Protocol implementation for QQ Android
There is a newer version: 2.16.0
/*
 * Copyright 2019-2022 Mamoe Technologies and contributors.
 *
 * 此源代码的使用受 GNU AFFERO GENERAL PUBLIC LICENSE version 3 许可证的约束, 可以在以下链接找到该许可证.
 * Use of this source code is governed by the GNU AGPLv3 license that can be found through the following link.
 *
 * https://github.com/mamoe/mirai/blob/dev/LICENSE
 */

package net.mamoe.mirai.internal.event

import kotlinx.coroutines.Job
import kotlinx.coroutines.channels.BufferOverflow
import kotlinx.coroutines.flow.Flow
import kotlinx.coroutines.flow.MutableSharedFlow
import kotlinx.coroutines.flow.asSharedFlow
import kotlinx.coroutines.flow.filter
import kotlinx.coroutines.sync.withLock
import net.mamoe.mirai.event.*
import net.mamoe.mirai.event.events.BotEvent
import net.mamoe.mirai.event.events.MessageEvent
import net.mamoe.mirai.internal.network.Packet
import net.mamoe.mirai.internal.network.components.EventDispatcher
import net.mamoe.mirai.internal.network.components.SHOW_VERBOSE_EVENT
import net.mamoe.mirai.utils.MiraiLogger
import net.mamoe.mirai.utils.verbose
import kotlin.coroutines.CoroutineContext
import kotlin.coroutines.EmptyCoroutineContext
import kotlin.reflect.KClass

// See docs below
@RequiresOptIn(
    "You must not use this API unless you are writing Event infrastructure.",
    level = RequiresOptIn.Level.ERROR
)
internal annotation class InternalEventMechanism

// Note: You probably should only use EventChannelToEventDispatcherAdapter.instance, or just use EventDispatchers. Event.broadcast is also good to use internally!
/**
 * Implementation of [EventChannel]. Every [EventChannelImpl] holds its own list of listeners, so one [EventChannelImpl] instance, [EventChannelToEventDispatcherAdapter] is shared in mirai.
 *
 * ## Broadcasting an event
 *
 * You should first consider using [EventDispatcher.broadcast] or [EventDispatcher.broadcastAsync].
 * Use [Event.broadcast] if you have no access to [EventDispatcher] (though you should have).
 *
 * Note: using [Event.broadcast] for [BotEvent] is the same as using [EventDispatcher.broadcast] but the former is slower. So it's recommended to use [EventDispatcher].
 *
 * **Never ever** use [EventChannelToEventDispatcherAdapter.instance] directly.
 */
internal sealed class EventChannelImpl constructor(
    baseEventClass: KClass, defaultCoroutineContext: CoroutineContext = EmptyCoroutineContext
) : EventChannel(baseEventClass, defaultCoroutineContext) {
    private val eventListeners = EventListeners()

    // drop any unsubscribed events
    private val flow = MutableSharedFlow(extraBufferCapacity = 1, onBufferOverflow = BufferOverflow.DROP_OLDEST)

    companion object {
        private val logger by lazy { MiraiLogger.Factory.create(EventChannelImpl::class, "EventChannelImpl") }
    }

    /**
     * Basic entrance for broadcasting an event.
     */
    @InternalEventMechanism
    suspend fun  broadcastEventImpl(event: E): E {
        require(event is AbstractEvent) { "Events must extend AbstractEvent" }

        if (event is BroadcastControllable && !event.shouldBroadcast) {
            return event
        }
        event.broadCastLock.withLock {
            event._intercepted = false
            callListeners(event)
        }

        return event
    }

    @InternalEventMechanism
    private suspend fun callListeners(event: Event) {
        event as AbstractEvent
        logEvent(event)
        eventListeners.callListeners(event)
        flow.emit(event)
    }

    override fun asFlow(): Flow {
        @Suppress("UNCHECKED_CAST")
        return flow.asSharedFlow().filter { baseEventClass.isInstance(it) } as Flow
    }

    override fun  registerListener(eventClass: KClass, listener: Listener) {
        eventListeners.addListener(eventClass, listener)
    }

    override fun  createListener(
        coroutineContext: CoroutineContext,
        concurrencyKind: ConcurrencyKind,
        priority: EventPriority,
        listenerBlock: suspend (E) -> ListeningStatus
    ): Listener {
        val context = this.defaultCoroutineContext + coroutineContext
        return SafeListener(
            parentJob = context[Job],
            subscriberContext = context,
            listenerBlock = listenerBlock,
            concurrencyKind = concurrencyKind,
            priority = priority
        )
    }

    private fun isVerboseEvent(event: Event): Boolean {
        if (SHOW_VERBOSE_EVENT) return false
        if (event is VerboseEvent) {
            if (event is BotEvent) {
                return !event.bot.configuration.isShowingVerboseEventLog
            }
            return true
        }
        return false
    }

    private fun logEvent(event: Event) {
        if (event is Packet.NoEventLog) return
        if (event is Packet.NoLog) return
        if (event is MessageEvent) return // specially handled in [LoggingPacketHandlerAdapter]
//        if (this is Packet) return@withLock // all [Packet]s are logged in [LoggingPacketHandlerAdapter]
        if (isVerboseEvent(event)) return

        if (event is BotEvent) {
            event.bot.logger.verbose { "Event: $event" }
        } else {
            logger.verbose { "Event: $event" }
        }
    }

    override fun context(vararg coroutineContexts: CoroutineContext): EventChannel {
        val newDefaultContext = coroutineContexts.fold(defaultCoroutineContext) { acc, coroutineContext ->
            acc + coroutineContext
        }

        @Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
        return object : DelegateEventChannel(this) {
            override fun  createListener(
                coroutineContext: CoroutineContext,
                concurrencyKind: ConcurrencyKind,
                priority: EventPriority,
                listenerBlock: suspend (E) -> ListeningStatus
            ): Listener {
                return super.createListener(
                    newDefaultContext + coroutineContext,
                    concurrencyKind,
                    priority,
                    listenerBlock
                )
            }

            override fun context(vararg coroutineContexts: CoroutineContext): EventChannel {
                return delegate.context(newDefaultContext, *coroutineContexts)
            }
        }
    }
}


internal abstract class DelegateEventChannel(
    protected val delegate: EventChannel,
) : EventChannel(delegate.baseEventClass, delegate.defaultCoroutineContext) {
    override fun asFlow(): Flow = delegate.asFlow()

    @Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
    override fun  registerListener(eventClass: KClass, listener: Listener) {
        delegate.registerListener0(eventClass, listener)
    }

    @Suppress("INVISIBLE_MEMBER", "INVISIBLE_REFERENCE")
    override fun  createListener(
        coroutineContext: CoroutineContext,
        concurrencyKind: ConcurrencyKind,
        priority: EventPriority,
        listenerBlock: suspend (E) -> ListeningStatus
    ): Listener = delegate.createListener0(coroutineContext, concurrencyKind, priority, listenerBlock)

    override fun context(vararg coroutineContexts: CoroutineContext): EventChannel {
        return delegate.context(*coroutineContexts)
    }
}