More event logging

.gitignore

@@ -5,6 +5,9 @@ build/
 out/
 classes/
 
+# kotlin
+.kotlin/
+
 # eclipse
 
 *.launch

src/main/kotlin/org/hyacinthbots/lilybot/LilyBot.kt

@@ -36,20 +36,22 @@ import org.hyacinthbots.lilybot.extensions.moderation.commands.LockingCommands
 import org.hyacinthbots.lilybot.extensions.moderation.commands.ModUtilities
 import org.hyacinthbots.lilybot.extensions.moderation.commands.ModerationCommands
 import org.hyacinthbots.lilybot.extensions.moderation.commands.Report
+import org.hyacinthbots.lilybot.extensions.moderation.events.ModerationEvents
 import org.hyacinthbots.lilybot.extensions.threads.AutoThreading
 import org.hyacinthbots.lilybot.extensions.threads.ModThreadInviting
 import org.hyacinthbots.lilybot.extensions.threads.ThreadControl
-import org.hyacinthbots.lilybot.extensions.utils.commands.GalleryChannel
-import org.hyacinthbots.lilybot.extensions.utils.commands.Github
-import org.hyacinthbots.lilybot.extensions.utils.commands.GuildAnnouncements
-import org.hyacinthbots.lilybot.extensions.utils.commands.InfoCommands
-import org.hyacinthbots.lilybot.extensions.utils.commands.NewsChannelPublishing
-import org.hyacinthbots.lilybot.extensions.utils.commands.PublicUtilities
-import org.hyacinthbots.lilybot.extensions.utils.commands.Reminders
-import org.hyacinthbots.lilybot.extensions.utils.commands.RoleMenu
-import org.hyacinthbots.lilybot.extensions.utils.commands.StartupHooks
-import org.hyacinthbots.lilybot.extensions.utils.commands.StatusPing
-import org.hyacinthbots.lilybot.extensions.utils.commands.Tags
+import org.hyacinthbots.lilybot.extensions.utility.commands.GalleryChannel
+import org.hyacinthbots.lilybot.extensions.utility.commands.Github
+import org.hyacinthbots.lilybot.extensions.utility.commands.GuildAnnouncements
+import org.hyacinthbots.lilybot.extensions.utility.commands.InfoCommands
+import org.hyacinthbots.lilybot.extensions.utility.commands.NewsChannelPublishing
+import org.hyacinthbots.lilybot.extensions.utility.commands.PublicUtilities
+import org.hyacinthbots.lilybot.extensions.utility.commands.Reminders
+import org.hyacinthbots.lilybot.extensions.utility.commands.RoleMenu
+import org.hyacinthbots.lilybot.extensions.utility.commands.StartupHooks
+import org.hyacinthbots.lilybot.extensions.utility.commands.StatusPing
+import org.hyacinthbots.lilybot.extensions.utility.commands.Tags
+import org.hyacinthbots.lilybot.extensions.utility.events.UtilityEvents
 import org.hyacinthbots.lilybot.internal.BuildInfo
 import org.hyacinthbots.lilybot.utils.BOT_TOKEN
 import org.hyacinthbots.lilybot.utils.ENVIRONMENT
@@ -177,6 +179,7 @@ suspend fun main() {
 			add(::MemberLogging)
 			add(::MessageDelete)
 			add(::MessageEdit)
+			add(::ModerationEvents)
 			add(::ModThreadInviting)
 			add(::ModUtilities)
 			add(::ModerationCommands)
@@ -189,6 +192,7 @@ suspend fun main() {
 			add(::StatusPing)
 			add(::Tags)
 			add(::ThreadControl)
+			add(::UtilityEvents)
 
 			/*
 			The welcome channel extension allows users to designate a YAML file to create a channel with

src/main/kotlin/org/hyacinthbots/lilybot/database/collections/ModerationActionCollection.kt

@@ -0,0 +1,117 @@
+package org.hyacinthbots.lilybot.database.collections
+
+import dev.kord.common.entity.Snowflake
+import dev.kordex.core.koin.KordExKoinComponent
+import org.hyacinthbots.lilybot.database.Database
+import org.hyacinthbots.lilybot.database.entities.ActionData
+import org.hyacinthbots.lilybot.database.entities.ModerationActionData
+import org.hyacinthbots.lilybot.extensions.moderation.utils.ModerationAction
+import org.koin.core.component.inject
+import org.litote.kmongo.eq
+
+/**
+ * This class contains the function for interacting with the [Moderation Action Database][ModerationActionData]. This
+ * class contains functions for getting, setting, removing and ignoring actions
+ *
+ * @since 5.0.0
+ * @see addAction
+ * @see removeAction
+ * @see getAction
+ * @see declareActionToIgnore
+ * @see shouldIgnoreAction
+ */
+class ModerationActionCollection : KordExKoinComponent {
+	private val db: Database by inject()
+
+	@PublishedApi
+	internal val collection = db.mainDatabase.getCollection<ModerationActionData>()
+
+	/**
+	 * Adds an action that occurred.
+	 *
+	 * @param action The type of action you're adding
+	 * @param guildId The ID of the guild the action occurred in
+	 * @param targetUserId The ID of the user this action happened to
+	 * @param data The [ActionData] for the action
+	 * @param ignore Whether to ignore the action or not. Defaults to false
+	 * @author NoComment1105
+	 * @since 5.0.0
+	 */
+	suspend inline fun addAction(
+		action: ModerationAction,
+		guildId: Snowflake,
+		targetUserId: Snowflake,
+		data: ActionData,
+		ignore: Boolean = false
+	) = collection.insertOne(ModerationActionData(action, guildId, targetUserId, data, ignore))
+
+	/**
+	 * Removes an action that occurred.
+	 *
+	 * @param type The type of action you're removing
+	 * @param guildId The ID of the guild the action occurred in
+	 * @param targetUserId The ID of the user this action happened to
+	 * @author NoComment1105
+	 * @since 5.0.0
+	 */
+	suspend inline fun removeAction(type: ModerationAction, guildId: Snowflake, targetUserId: Snowflake) =
+		collection.deleteOne(
+			ModerationActionData::actionType eq type,
+			ModerationActionData::guildId eq guildId,
+			ModerationActionData::targetUserId eq targetUserId
+		)
+
+	/**
+	 * Gets an action that occurred.
+	 *
+	 * @param type The type of action you're looking for
+	 * @param guildId The ID of the guild the action occurred in
+	 * @param targetUserId The ID of the user this action happened to
+	 * @return The [data][ModerationActionData] for the event. Can be null if there is no action.
+	 * @author NoComment1105
+	 * @since 5.0.0
+	 */
+	suspend inline fun getAction(
+		type: ModerationAction,
+		guildId: Snowflake,
+		targetUserId: Snowflake
+	): ModerationActionData? =
+		collection.findOne(
+			ModerationActionData::actionType eq type,
+			ModerationActionData::guildId eq guildId,
+			ModerationActionData::targetUserId eq targetUserId
+		)
+
+	/**
+	 * Sets an action as ignored. Convenience function more than anything
+	 *
+	 * @param type The type of action you're looking for
+	 * @param guildId The ID of the guild the action occurred in
+	 * @param targetUserId The ID of the user this action happened to
+	 * @author NoComment1105
+	 * @since 5.0.0
+	 */
+	suspend inline fun declareActionToIgnore(type: ModerationAction, guildId: Snowflake, targetUserId: Snowflake) =
+		addAction(type, guildId, targetUserId, ActionData(null, null, null, null, null, null, null), true)
+
+	/**
+	 * Checks if an action should be ignored or not. Convenience function more than anything.
+	 *
+	 * @param type The type of action you're looking for
+	 * @param guildId The ID of the guild the action occurred in
+	 * @param targetUserId The ID of the user this action happened to
+	 * @return True if the action should be ignored, false if otherwise
+	 * @author NoComment1105
+	 * @since 5.0.0
+	 */
+	suspend inline fun shouldIgnoreAction(
+		type: ModerationAction,
+		guildId: Snowflake,
+		targetUserId: Snowflake
+	): Boolean? =
+		collection.findOne(
+			ModerationActionData::actionType eq type,
+			ModerationActionData::guildId eq guildId,
+			ModerationActionData::targetUserId eq targetUserId
+		)?.ignore
+}

src/main/kotlin/org/hyacinthbots/lilybot/database/entities/Config.kt

@@ -70,5 +70,9 @@ data class ModerationConfigData(
 @Serializable
 data class UtilityConfigData(
 	val guildId: Snowflake,
-	val utilityLogChannel: Snowflake?
+	val utilityLogChannel: Snowflake?,
+	val logChannelUpdates: Boolean,
+	val logEventUpdates: Boolean,
+	val logInviteUpdates: Boolean,
+	val logRoleUpdates: Boolean
 )

src/main/kotlin/org/hyacinthbots/lilybot/database/entities/ModerationActionData.kt

@@ -0,0 +1,66 @@
+package org.hyacinthbots.lilybot.database.entities
+
+import dev.kord.common.entity.Snowflake
+import kotlinx.datetime.DateTimePeriod
+import kotlinx.datetime.Instant
+import kotlinx.serialization.Serializable
+import org.hyacinthbots.lilybot.extensions.moderation.utils.ModerationAction
+
+/**
+ * The data for Moderation action.
+ *
+ * @property actionType The type of action you're adding
+ * @property guildId The ID of the guild the action occurred in
+ * @property targetUserId The ID of the user this action happened to
+ * @property data The [ActionData] for the action
+ * @property ignore Whether to ignore the action or not. Defaults to false
+ * @since 5.0.0
+ */
+@Serializable
+data class ModerationActionData(
+	val actionType: ModerationAction,
+	val guildId: Snowflake,
+	val targetUserId: Snowflake,
+	val data: ActionData,
+	val ignore: Boolean = false
+)
+
+/**
+ * Further, more in-depth data about a [moderation action][ModerationActionData].
+ *
+ * @property actioner The ID of the user that requested the action
+ * @property deletedMessages The amount of messages deleted in the action
+ * @property timeData The [TimeData] for the action
+ * @property reason The reason for the action
+ * @property dmOutcome The outcome of trying to send a DM to the user
+ * @property dmOverride Whether the DM sending function was override
+ * @property imageUrl The URL for the image attached to the action
+ * @since 5.0.0
+ */
+@Serializable
+data class ActionData(
+	val actioner: Snowflake?,
+	val deletedMessages: Int?,
+	val timeData: TimeData?,
+	val reason: String?,
+	val dmOutcome: Boolean?,
+	val dmOverride: Boolean?,
+	val imageUrl: String?
+)
+
+/**
+ * Further, more in-depth data about the [time data for actions][ActionData.timeData].
+ *
+ * @property durationDtp The Duration as a [DateTimePeriod]
+ * @property durationInst The Duration as an [Instant]
+ * @property start The start [Instant] of the action
+ * @property end The end [Instant] of the action
+ * @since 5.0.0
+ */
+@Serializable
+data class TimeData(
+	val durationDtp: DateTimePeriod?,
+	val durationInst: Instant?,
+	val start: Instant? = null,
+	val end: Instant? = null,
+)

src/main/kotlin/org/hyacinthbots/lilybot/database/migrations/config/configV7.kt

@@ -1,6 +1,7 @@
 package org.hyacinthbots.lilybot.database.migrations.config
 
 import org.hyacinthbots.lilybot.database.entities.ModerationConfigData
+import org.hyacinthbots.lilybot.database.entities.UtilityConfigData
 import org.litote.kmongo.coroutine.CoroutineDatabase
 import org.litote.kmongo.exists
 import org.litote.kmongo.setValue
@@ -12,4 +13,22 @@ suspend fun configV7(db: CoroutineDatabase) {
 			setValue(ModerationConfigData::autoInviteModeratorRole, null)
 		)
 	}
+	with(db.getCollection<UtilityConfigData>("utilityConfigData")) {
+		updateMany(
+			UtilityConfigData::logChannelUpdates exists false,
+			setValue(UtilityConfigData::logChannelUpdates, false)
+		)
+		updateMany(
+			UtilityConfigData::logEventUpdates exists false,
+			setValue(UtilityConfigData::logEventUpdates, false)
+		)
+		updateMany(
+			UtilityConfigData::logInviteUpdates exists false,
+			setValue(UtilityConfigData::logInviteUpdates, false)
+		)
+		updateMany(
+			UtilityConfigData::logRoleUpdates exists false,
+			setValue(UtilityConfigData::logRoleUpdates, false)
+		)
+	}
 }

src/main/kotlin/org/hyacinthbots/lilybot/database/migrations/main/mainV10.kt

@@ -11,4 +11,5 @@ suspend fun mainV10(db: CoroutineDatabase) {
 	}
 	db.createCollection("lockedChannelData")
 	db.createCollection("temporaryBanData")
+	db.createCollection("moderationActionCacheData")
 }

src/main/kotlin/org/hyacinthbots/lilybot/extensions/config/ConfigExtension.kt

@@ -7,7 +7,7 @@ import org.hyacinthbots.lilybot.extensions.config.commands.configClearCommand
 import org.hyacinthbots.lilybot.extensions.config.commands.configViewCommand
 import org.hyacinthbots.lilybot.extensions.logging.config.loggingCommand
 import org.hyacinthbots.lilybot.extensions.moderation.config.moderationCommand
-import org.hyacinthbots.lilybot.extensions.utils.config.utilityCommand
+import org.hyacinthbots.lilybot.extensions.utility.config.utilityCommand
 
 class ConfigExtension : Extension() {
 	override val name: String = "config"