commonMain.entity.channel.TopGuildChannel.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kord-core Show documentation
Idiomatic Kotlin Wrapper for The Discord API
There is a newer version: 0.15.0
package dev.kord.core.entity.channel

import dev.kord.common.entity.*
import dev.kord.common.entity.optional.orEmpty
import dev.kord.common.entity.optional.value
import dev.kord.common.exception.RequestException
import dev.kord.core.behavior.channel.TopGuildChannelBehavior
import dev.kord.core.cache.data.PermissionOverwriteData
import dev.kord.core.entity.PermissionOverwriteEntity
import dev.kord.core.supplier.EntitySupplyStrategy

/**
 * An instance of a Discord channel associated to a [guild].
 */
public interface TopGuildChannel : GuildChannel, TopGuildChannelBehavior {

    override val guildId: Snowflake
        get() = data.guildId.value!!

    /**
     * The raw position of this channel in the guild as displayed by Discord.
     */
    public val rawPosition: Int get() = data.position.value!!

    /**
     * The permission overwrites for this channel.
     */
    public val permissionOverwrites: Set
        get() = data.permissionOverwrites.orEmpty().asSequence()
            .map { PermissionOverwriteData(it.id, it.type, it.allow, it.deny) }
            .map { PermissionOverwriteEntity(guildId, id, it, kord) }
            .toSet()

    /**
     * Calculates the effective permissions of the [memberId] in this channel, applying the overwrite for the member
     * and their roles on top of the base permissions.
     *
     * @throws [RequestException] if something went wrong during the request.
     * @throws IllegalArgumentException if the [memberId] is not part of this guild.
     */
    public suspend fun getEffectivePermissions(memberId: Snowflake): Permissions {
        val member = supplier.getMemberOrNull(guildId, memberId)
        require(member != null) {
            "member $memberId is not in guild $guildId"
        }

        val base = member.getPermissions()

        if (Permission.Administrator in base) return Permissions.ALL

        val everyoneOverwrite = getPermissionOverwritesForRole(guildId)
        val roleOverwrites = member.roleIds.mapNotNull { getPermissionOverwritesForRole(it) }
        val memberOverwrite = getPermissionOverwritesForMember(memberId)

        return Permissions {
            +base
            everyoneOverwrite?.let {
                +it.allowed
                -it.denied
            }
            roleOverwrites.forEach {
                +it.allowed
                -it.denied
            }
            memberOverwrite?.let {
                +it.allowed
                -it.denied
            }
        }

    }

    /**
     * Gets the permission overwrite for the [memberId] in this channel, if present.
     */
    public fun getPermissionOverwritesForMember(memberId: Snowflake): PermissionOverwriteEntity? =
        getPermissionOverwritesForType(memberId, OverwriteType.Member)

    /**
     * Gets the permission overwrite for the [roleId] in this channel, if present.
     */
    public fun getPermissionOverwritesForRole(roleId: Snowflake): PermissionOverwriteEntity? =
        getPermissionOverwritesForType(roleId, OverwriteType.Role)

    private fun getPermissionOverwritesForType(id: Snowflake, type: OverwriteType): PermissionOverwriteEntity? =
        permissionOverwrites.firstOrNull { it.target == id && it.type == type }

    override fun withStrategy(strategy: EntitySupplyStrategy<*>): TopGuildChannel

}