io.github.freya022.botcommands.api.pagination.UsedComponentSet.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of BotCommands Show documentation
Show all versions of BotCommands Show documentation
A Kotlin-first (and Java) framework that makes creating Discord bots a piece of cake, using the JDA library.
package io.github.freya022.botcommands.api.pagination
import gnu.trove.set.hash.TIntHashSet
import io.github.freya022.botcommands.api.components.Components
import io.github.freya022.botcommands.api.components.IdentifiableComponent
import io.github.freya022.botcommands.internal.utils.any
import io.github.freya022.botcommands.internal.utils.reference
import io.github.oshai.kotlinlogging.KotlinLogging
import net.dv8tion.jda.api.interactions.components.LayoutComponent
import kotlin.reflect.KProperty
private val logger = KotlinLogging.logger { }
/**
* Utility class to manage component ids in paginators.
*/
class UsedComponentSet(private val componentsService: Components, private val cleanAfterRefresh: Boolean) {
private lateinit var currentIds: TIntHashSet
fun setComponents(components: Iterable) {
val newIds = TIntHashSet().apply {
for (row in components) {
row.actionComponents.forEach { component ->
if (component.id == null) return@forEach
val bcComponent = component as? IdentifiableComponent
?: return@forEach logger.warn { "Attempted to use a non-BC component, id: '${component.id}'" }
add(bcComponent.internalId)
}
}
}
if (::currentIds.isInitialized.not()) {
// If there are no IDs yet, use the new set
currentIds = newIds
} else if (cleanAfterRefresh) {
// If there are IDs and a refresh cleans components, check that none are reused
val isReusingIds = newIds.any { it in currentIds }
if (isReusingIds) {
logger.warn {
val property: KProperty<*> = AbstractPaginationBuilder<*, *>::cleanAfterRefresh
"Paginators cannot reuse components when ${property.reference} is enabled"
}
} else {
componentsService.deleteComponentsByIdsJava(*currentIds.toArray())
currentIds = newIds
}
} else {
// If there are IDs and no clean up is required, add the components
// They will be cleaned up when the pagination expires
currentIds.addAll(newIds)
}
}
suspend fun cleanup() {
componentsService.deleteComponentsByIds(*currentIds.toArray())
}
}