aboutsummaryrefslogtreecommitdiff
path: root/lib/automod/AutomodShared.ts
blob: 5d031d056520df6ac72e0032f83915ccfa0f9f1f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
import {
	ActionRowBuilder,
	ButtonBuilder,
	ButtonInteraction,
	ButtonStyle,
	GuildMember,
	Message,
	PermissionFlagsBits,
	Snowflake
} from 'discord.js';
import UnmuteCommand from '../../src/commands/moderation/unmute.js';
import * as Moderation from '../common/Moderation.js';
import { unmuteResponse } from '../extensions/discord.js/ExtendedGuildMember.js';
import { colors, emojis } from '../utils/BushConstants.js';
import * as Format from '../utils/Format.js';

/**
 * Handles shared auto moderation functionality.
 */
export abstract class Automod {
	/**
	 * Whether or not a punishment has already been given to the user
	 */
	protected punished = false;

	/**
	 * @param member The guild member that the automod is checking
	 */
	protected constructor(protected readonly member: GuildMember) {}

	/**
	 * The user
	 */
	protected get user() {
		return this.member.user;
	}

	/**
	 * The client instance
	 */
	protected get client() {
		return this.member.client;
	}

	/**
	 * The guild member that the automod is checking
	 */
	protected get guild() {
		return this.member.guild;
	}

	/**
	 * Whether or not the member should be immune to auto moderation
	 */
	protected get isImmune() {
		if (this.member.user.isOwner()) return true;
		if (this.member.guild.ownerId === this.member.id) return true;
		if (this.member.permissions.has('Administrator')) return true;

		return false;
	}

	protected buttons(userId: Snowflake, reason: string, undo = true): ActionRowBuilder<ButtonBuilder> {
		const row = new ActionRowBuilder<ButtonBuilder>().addComponents([
			new ButtonBuilder({
				style: ButtonStyle.Danger,
				label: 'Ban User',
				customId: `automod;ban;${userId};${reason}`
			})
		]);

		if (undo) {
			row.addComponents(
				new ButtonBuilder({
					style: ButtonStyle.Success,
					label: 'Unmute User',
					customId: `automod;unmute;${userId}`
				})
			);
		}

		return row;
	}

	protected logColor(severity: Severity) {
		switch (severity) {
			case Severity.DELETE:
				return colors.lightGray;
			case Severity.WARN:
				return colors.yellow;
			case Severity.TEMP_MUTE:
				return colors.orange;
			case Severity.PERM_MUTE:
				return colors.red;
		}
		throw new Error(`Unknown severity: ${severity}`);
	}

	/**
	 * Checks if any of the words provided are in the message
	 * @param words The words to check for
	 * @returns The blacklisted words found in the message
	 */
	protected checkWords(words: BadWordDetails[], str: string): BadWordDetails[] {
		if (words.length === 0) return [];

		const matchedWords: BadWordDetails[] = [];
		for (const word of words) {
			if (word.regex) {
				if (new RegExp(word.match).test(this.format(word.match, word))) {
					matchedWords.push(word);
				}
			} else {
				if (this.format(str, word).includes(this.format(word.match, word))) {
					matchedWords.push(word);
				}
			}
		}
		return matchedWords;
	}

	/**
	 * Format a string according to the word options
	 * @param string The string to format
	 * @param wordOptions The word options to format with
	 * @returns The formatted string
	 */
	protected format(string: string, wordOptions: BadWordDetails) {
		const temp = wordOptions.ignoreCapitalization ? string.toLowerCase() : string;
		return wordOptions.ignoreSpaces ? temp.replace(/ /g, '') : temp;
	}

	/**
	 * Handles the auto moderation
	 */
	protected abstract handle(): Promise<void>;
}

/**
 * Handles the ban button in the automod log.
 * @param interaction The button interaction.
 */
export async function handleAutomodInteraction(interaction: ButtonInteraction) {
	if (!interaction.memberPermissions?.has(PermissionFlagsBits.BanMembers))
		return interaction.reply({
			content: `${emojis.error} You are missing the **Ban Members** permission.`,
			ephemeral: true
		});
	const [action, userId, reason] = interaction.customId.replace('automod;', '').split(';') as ['ban' | 'unmute', string, string];

	if (!(['ban', 'unmute'] as const).includes(action)) throw new TypeError(`Invalid automod button action: ${action}`);

	const victim = await interaction.guild!.members.fetch(userId).catch(() => null);
	const moderator =
		interaction.member instanceof GuildMember ? interaction.member : await interaction.guild!.members.fetch(interaction.user.id);

	switch (action) {
		case 'ban': {
			if (!interaction.guild?.members.me?.permissions.has('BanMembers'))
				return interaction.reply({
					content: `${emojis.error} I do not have permission to ${action} members.`,
					ephemeral: true
				});

			const check = victim ? await Moderation.permissionCheck(moderator, victim, 'ban', true) : true;
			if (check !== true) return interaction.reply({ content: check, ephemeral: true });

			const result = await interaction.guild?.bushBan({
				user: userId,
				reason,
				moderator: interaction.user.id,
				evidence: (interaction.message as Message).url ?? undefined
			});

			const victimUserFormatted = (await interaction.client.utils.resolveNonCachedUser(userId))?.tag ?? userId;

			const content = (() => {
				if (result === unmuteResponse.SUCCESS) {
					return `${emojis.success} Successfully banned ${Format.input(victimUserFormatted)}.`;
				} else if (result === unmuteResponse.DM_ERROR) {
					return `${emojis.warn} Banned ${Format.input(victimUserFormatted)} however I could not send them a dm.`;
				} else {
					return `${emojis.error} Could not ban ${Format.input(victimUserFormatted)}: \`${result}\` .`;
				}
			})();

			return interaction.reply({
				content: content,
				ephemeral: true
			});
		}

		case 'unmute': {
			if (!victim)
				return interaction.reply({
					content: `${emojis.error} Cannot find member, they may have left the server.`,
					ephemeral: true
				});

			if (!interaction.guild)
				return interaction.reply({
					content: `${emojis.error} This is weird, I don't seem to be in the server...`,
					ephemeral: true
				});

			const check = await Moderation.permissionCheck(moderator, victim, 'unmute', true);
			if (check !== true) return interaction.reply({ content: check, ephemeral: true });

			const check2 = await Moderation.checkMutePermissions(interaction.guild);
			if (check2 !== true) return interaction.reply({ content: UnmuteCommand.formatCode('/', victim!, check2), ephemeral: true });

			const result = await victim.bushUnmute({
				reason,
				moderator: interaction.member as GuildMember,
				evidence: (interaction.message as Message).url ?? undefined
			});

			const victimUserFormatted = victim.user.tag;

			const content = (() => {
				if (result === unmuteResponse.SUCCESS) {
					return `${emojis.success} Successfully unmuted ${Format.input(victimUserFormatted)}.`;
				} else if (result === unmuteResponse.DM_ERROR) {
					return `${emojis.warn} Unmuted ${Format.input(victimUserFormatted)} however I could not send them a dm.`;
				} else {
					return `${emojis.error} Could not unmute ${Format.input(victimUserFormatted)}: \`${result}\` .`;
				}
			})();

			return interaction.reply({
				content: content,
				ephemeral: true
			});
		}
	}
}

/**
 * The severity of the blacklisted word
 */
export const enum Severity {
	/**
	 * Delete message
	 */
	DELETE,

	/**
	 * Delete message and warn user
	 */
	WARN,

	/**
	 * Delete message and mute user for 15 minutes
	 */
	TEMP_MUTE,

	/**
	 * Delete message and mute user permanently
	 */
	PERM_MUTE
}

/**
 * Details about a blacklisted word
 */
export interface BadWordDetails {
	/**
	 * The word that is blacklisted
	 */
	match: string;

	/**
	 * The severity of the word
	 */
	severity: Severity | 1 | 2 | 3;

	/**
	 * Whether or not to ignore spaces when checking for the word
	 */
	ignoreSpaces: boolean;

	/**
	 * Whether or not to ignore case when checking for the word
	 */
	ignoreCapitalization: boolean;

	/**
	 * The reason that this word is blacklisted (used for the punishment reason)
	 */
	reason: string;

	/**
	 * Whether or not the word is regex
	 * @default false
	 */
	regex: boolean;

	/**
	 * Whether to also check a user's status and username for the phrase
	 * @default false
	 */
	userInfo: boolean;
}

/**
 * Blacklisted words mapped to their details
 */
export interface BadWords {
	[category: string]: BadWordDetails[];
}