feat: add timeout support

Author: kyranet

scripts/SetMigrations.sql

@@ -101,6 +101,7 @@ VALUES
 	(1707505580449, 'V75SplitModerationType1707505580449'),
 	(1707558132765, 'V76AddOptOutUnknownMessageLogging1707558132765'),
 	(1707605222927, 'V77AddEventsIncludeBots1707605222927'),
-	(1707642380524, 'V78AddVoiceActivityLogging1707642380524');
+	(1707642380524, 'V78AddVoiceActivityLogging1707642380524'),
+	(1708164874479, 'V79AddTimeout1708164874479');
 
 COMMIT;

src/languages/en-US/settings.json

@@ -33,8 +33,9 @@
 	"disabledChannels": "A list of channels for disabled commands, for example, setting up a channel called general will forbid all users from using my commands there. Moderators+ override this purposely to allow them to moderate without switching channels.",
 	"disabledCommands": "The disabled commands, core commands may not be disabled, and moderators will override this. All commands must be in lower case.",
 	"disableNaturalPrefix": "Whether or not I should listen for my natural prefix, `Skyra,`",
-	"eventsBanAdd": "This event posts anonymous moderation logs when a user gets banned. You must set up `channels.moderation-logs`.",
-	"eventsBanRemove": "This event posts anonymous moderation logs when a user gets unbanned. You must set up `channels.moderation-logs`.",
+	"eventsBanAdd": "This event posts non-bot moderation logs when a user gets banned. You must set up `channels.moderation-logs`.",
+	"eventsBanRemove": "This event posts non-bot moderation logs when a user gets unbanned. You must set up `channels.moderation-logs`.",
+	"eventsTimeout": "This event posts non-bot moderation logs when a user's timeout status changes. You must set up `channels.moderation-logs`.",
 	"eventsUnknownMessages": "Whether or not I should post updates on unknown command messages.",
 	"eventsTwemojiReactions": "Whether or not twemoji reactions are posted in the reaction logs channel.",
 	"eventsIncludeBots": "Whether or not I should ignore bots in the server logs.",

src/lib/database/entities/GuildEntity.ts

@@ -180,6 +180,10 @@ export class GuildEntity extends BaseEntity implements IBaseEntity {
 	@Column('boolean', { name: 'events.ban-remove', default: false })
 	public eventsBanRemove = false;
 
+	@ConfigurableKey({ description: LanguageKeys.Settings.EventsTimeout })
+	@Column('boolean', { name: 'events.timeout', default: false })
+	public eventsTimeout = false;
+
 	@ConfigurableKey({ description: LanguageKeys.Settings.EventsUnknownMessages })
 	@Column('boolean', { name: 'events.unknown-messages', default: false })
 	public eventsUnknownMessages = false;

src/lib/database/keys/settings/Events.ts

@@ -1,5 +1,6 @@
 export const BanAdd = 'eventsBanAdd';
 export const BanRemove = 'eventsBanRemove';
+export const Timeout = 'eventsTimeout';
 export const UnknownMessages = 'eventsUnknownMessages';
 export const IncludeTwemoji = 'eventsTwemojiReactions';
 export const IncludeBots = 'eventsIncludeBots';

src/lib/database/migrations/1708164874479-V79_AddTimeout.ts

@@ -0,0 +1,11 @@
+import { TableColumn, type MigrationInterface, type QueryRunner } from 'typeorm';
+
+export class V79AddTimeout1708164874479 implements MigrationInterface {
+	public async up(queryRunner: QueryRunner): Promise<void> {
+		await queryRunner.addColumn('guilds', new TableColumn({ name: 'events.timeout', type: 'boolean', default: false }));
+	}
+
+	public async down(queryRunner: QueryRunner): Promise<void> {
+		await queryRunner.dropColumn('guilds', 'events.timeout');
+	}
+}

src/lib/i18n/languageKeys/keys/Settings.ts

@@ -7,6 +7,7 @@ export const DisableNaturalPrefix = T('settings:disableNaturalPrefix');
 export const DisabledChannels = T('settings:disabledChannels');
 export const EventsBanAdd = T('settings:eventsBanAdd');
 export const EventsBanRemove = T('settings:eventsBanRemove');
+export const EventsTimeout = T('settings:eventsTimeout');
 export const EventsUnknownMessages = T('settings:eventsUnknownMessages');
 export const EventsTwemojiReactions = T('settings:eventsTwemojiReactions');
 export const MessagesIgnoreChannels = T('settings:messagesIgnoreChannels');

src/lib/moderation/managers/LoggerManager.ts

@@ -1,5 +1,5 @@
 import { writeSettings, type GuildSettingsOfType } from '#lib/database';
-import { LoggerTypeManager } from '#lib/moderation/managers/LoggerTypeManager';
+import { LoggerTypeManager, type LoggerTypeContext } from '#lib/moderation/managers/LoggerTypeManager';
 import { toErrorCodeResult } from '#utils/common';
 import { getCodeStyle, getLogPrefix } from '#utils/functions/pieces';
 import { EmbedBuilder } from '@discordjs/builders';
@@ -8,6 +8,7 @@ import { isFunction, isNullish, isNullishOrEmpty, type Awaitable, type Nullish }
 import { PermissionFlagsBits, RESTJSONErrorCodes, type Guild, type GuildBasedChannel, type MessageCreateOptions, type Snowflake } from 'discord.js';
 
 export class LoggerManager {
+	public readonly timeout = new LoggerTypeManager<TimeoutLoggerTypeContext>(this);
 	public readonly prune = new LoggerTypeManager(this);
 
 	#guild: Guild;
@@ -121,3 +122,8 @@ export interface LoggerManagerSendOptions {
 export type LoggerManagerSendMessageOptions = MessageCreateOptions | EmbedBuilder | EmbedBuilder[];
 
 const LogPrefix = getLogPrefix('LoggerManager');
+
+export interface TimeoutLoggerTypeContext extends LoggerTypeContext {
+	oldValue: number | null;
+	newValue: number | null;
+}

src/lib/moderation/managers/LoggerTypeManager.ts

@@ -36,6 +36,15 @@ export class LoggerTypeManager<Entry extends LoggerTypeContext = LoggerTypeConte
 		this.#manager = manager;
 	}
 
+	/**
+	 * Returns whether or not the context data is set, which will always be true
+	 * when an action was taken by Skyra.
+	 * @param id The ID of the context data to check.
+	 */
+	public isSet(id: Snowflake) {
+		return this.#context.has(id);
+	}
+
 	/**
 	 * Wait for the context data to be set.
 	 * @param id The ID of the context data to wait for.
@@ -104,4 +113,5 @@ export class LoggerTypeManager<Entry extends LoggerTypeContext = LoggerTypeConte
 
 export interface LoggerTypeContext {
 	userId: Snowflake;
+	reason?: string;
 }

src/listeners/guilds/members/guildMemberUpdateNicknameNotify.ts

@@ -39,9 +39,7 @@ export class UserListener extends Listener {
 				previousName === null
 					? LanguageKeys.Events.Guilds.Members.NameUpdatePreviousWasNotSet
 					: LanguageKeys.Events.Guilds.Members.NameUpdatePreviousWasSet,
-				{
-					previousName
-				}
+				{ previousName }
 			),
 			t(
 				nextName === null

src/listeners/guilds/members/guildMemberUpdateTimeoutNotify.ts

@@ -0,0 +1,44 @@
+import { GuildSettings, readSettings } from '#lib/database';
+import { Events } from '#lib/types';
+import { getLogger, getModeration } from '#utils/functions';
+import { TypeMetadata, TypeVariation } from '#utils/moderationConstants';
+import { ApplyOptions } from '@sapphire/decorators';
+import { Listener } from '@sapphire/framework';
+import { isNumber } from '@sapphire/utilities';
+import type { GuildMember } from 'discord.js';
+
+@ApplyOptions<Listener.Options>({ event: Events.GuildMemberUpdate })
+export class UserListener extends Listener {
+	public async run(previous: GuildMember, next: GuildMember) {
+		const prevTimeout = this.#getTimeout(previous);
+		const nextTimeout = this.#getTimeout(next);
+		if (prevTimeout === nextTimeout) return;
+
+		const { user, guild } = next;
+		const logger = getLogger(guild);
+		const actionBySkyra = logger.timeout.isSet(guild.id);
+		const contextPromise = logger.timeout.wait(guild.id);
+
+		// If the action was done by Skyra, or external timeout is enabled, create a moderation action:
+		if (actionBySkyra || (await readSettings(next, GuildSettings.Events.Timeout))) {
+			const context = await contextPromise;
+			const moderation = getModeration(guild);
+			await moderation.waitLock();
+			await moderation
+				.create({
+					userId: user.id,
+					moderatorId: context?.userId ?? this.container.client.id!,
+					type: TypeVariation.Timeout,
+					metadata: nextTimeout ? TypeMetadata.Temporary : TypeMetadata.Appeal,
+					duration: nextTimeout,
+					reason: context?.reason
+				})
+				.create();
+		}
+	}
+
+	#getTimeout(member: GuildMember) {
+		const timeout = member.communicationDisabledUntilTimestamp;
+		return isNumber(timeout) && timeout >= Date.now() ? timeout : null;
+	}
+}