commands/moderation/MassKickCommand.ts

/*
 * This file is part of SudoBot.
 *
 * Copyright (C) 2021-2023 OSN Developers.
 *
 * SudoBot is free software; you can redistribute it and/or modify it
 * under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * SudoBot is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
 */

import { PermissionsBitField, SlashCommandBuilder, User } from "discord.js";
import Command, { BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
import { log, logError } from "../../utils/logger";
import { isSnowflake } from "../../utils/utils";

export default class MassKickCommand extends Command {
    public readonly name = "masskick";
    public readonly validationRules: ValidationRule[] = [];
    public readonly permissions = [PermissionsBitField.Flags.Administrator];
    public readonly aliases = ["mkick"];

    public readonly description = "Kick multiple users at the same time.";
    public readonly detailedDescription = "This command can kick multiple users. This is helpful if you want to quickly kick server raiders.";
    public readonly argumentSyntaxes = ["<...UserIDs|UserMentions> [Reason]"];

    public readonly botRequiredPermissions = [PermissionsBitField.Flags.Administrator];

    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addUserOption(option => option.setName("users").setDescription("The users to kick").setRequired(true))
        .addStringOption(option => option.setName("reason").setDescription("The reason for taking this action"));

    async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
        if (context.isLegacy && context.args[0] === undefined) {
            return {
                __reply: true,
                content: `${this.emoji("error")} Please specify at least 1 user to kick!`
            };
        }

        const args = context.isLegacy ? context.args : context.options.getString("users", true).split(/ +/);

        if (args.length > 10) {
            return {
                __reply: true,
                content: `${this.emoji("error")} Cannot masskick more than 10 users at once!`
            };
        }

        const members: string[] = [];
        let position = 0;

        for (const arg of args) {
            let id: string | undefined = undefined;

            if (isSnowflake(arg)) {
                id = arg;
            } else if (arg.startsWith("<@") && arg.endsWith(">")) {
                id = arg.substring(arg.includes("!") ? 3 : 2, arg.length - 1);
            }

            if (id && !isSnowflake(id)) {
                return {
                    __reply: true,
                    content: `\`${id}\` is not a valid user mention format or the ID is incorrect.`
                };
            }

            if (!id) break;

            members.push(id);
            position++;
        }

        await this.deferIfInteraction(message);

        let reason = context.isLegacy ? undefined : context.options.getString("reason") ?? undefined;

        if (context.isLegacy) {
            reason = "";

            for (; position < args.length; position++) {
                reason += args[position] + " ";
            }

            reason = reason.trimEnd();
        }

        const reply = await this.deferredReply(message, {
            content: `${this.emoji("loading")} Preparing to kick ${members.length} users...`
        });

        await this.client.infractionManager.createMemberMassKick({
            users: members,
            moderator: message.member!.user as User,
            reason: reason?.trim() === "" ? undefined : reason,
            sendLog: true,
            guild: message.guild!,
            callAfterEach: 5,
            callback: async ({ completedUsers, skippedUsers, users, completedIn }) => {
                log(`Kicked ${completedUsers.length} out of ${users.length} users (${skippedUsers.length} failed)`);

                await reply
                    .edit({
                        content: `${this.emoji(completedUsers.length === users.length && completedIn ? "check" : "loading")} Kicked ${
                            completedUsers.length
                        } out of ${users.length} users (${completedIn ? `Completed in ${completedIn}s, ` : ""}${skippedUsers.length} failures)`
                    })
                    .catch(logError);
            }
        });
    }
}
1	rakinar2	577	/*
2			* This file is part of SudoBot.
3			*
4			* Copyright (C) 2021-2023 OSN Developers.
5			*
6			* SudoBot is free software; you can redistribute it and/or modify it
7			* under the terms of the GNU Affero General Public License as published by
8			* the Free Software Foundation, either version 3 of the License, or
9			* (at your option) any later version.
10			*
11			* SudoBot is distributed in the hope that it will be useful, but
12			* WITHOUT ANY WARRANTY; without even the implied warranty of
13			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14			* GNU Affero General Public License for more details.
15			*
16			* You should have received a copy of the GNU Affero General Public License
17			* along with SudoBot. If not, see <https://www.gnu.org/licenses/>.
18			*/
19
20			import { PermissionsBitField, SlashCommandBuilder, User } from "discord.js";
21			import Command, { BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
22			import { log, logError } from "../../utils/logger";
23			import { isSnowflake } from "../../utils/utils";
24
25			export default class MassKickCommand extends Command {
26			public readonly name = "masskick";
27			public readonly validationRules: ValidationRule[] = [];
28			public readonly permissions = [PermissionsBitField.Flags.Administrator];
29			public readonly aliases = ["mkick"];
30
31			public readonly description = "Kick multiple users at the same time.";
32			public readonly detailedDescription = "This command can kick multiple users. This is helpful if you want to quickly kick server raiders.";
33			public readonly argumentSyntaxes = ["<...UserIDs\|UserMentions> [Reason]"];
34
35			public readonly botRequiredPermissions = [PermissionsBitField.Flags.Administrator];
36
37			public readonly slashCommandBuilder = new SlashCommandBuilder()
38			.addUserOption(option => option.setName("users").setDescription("The users to kick").setRequired(true))
39			.addStringOption(option => option.setName("reason").setDescription("The reason for taking this action"));
40
41			async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
42			if (context.isLegacy && context.args[0] === undefined) {
43			return {
44			__reply: true,
45			content: `${this.emoji("error")} Please specify at least 1 user to kick!`
46			};
47			}
48
49			const args = context.isLegacy ? context.args : context.options.getString("users", true).split(/ +/);
50
51			if (args.length > 10) {
52			return {
53			__reply: true,
54			content: `${this.emoji("error")} Cannot masskick more than 10 users at once!`
55			};
56			}
57
58			const members: string[] = [];
59			let position = 0;
60
61			for (const arg of args) {
62			let id: string \| undefined = undefined;
63
64			if (isSnowflake(arg)) {
65			id = arg;
66			} else if (arg.startsWith("<@") && arg.endsWith(">")) {
67			id = arg.substring(arg.includes("!") ? 3 : 2, arg.length - 1);
68			}
69
70			if (id && !isSnowflake(id)) {
71			return {
72			__reply: true,
73			content: `\`${id}\` is not a valid user mention format or the ID is incorrect.`
74			};
75			}
76
77			if (!id) break;
78
79			members.push(id);
80			position++;
81			}
82
83			await this.deferIfInteraction(message);
84
85			let reason = context.isLegacy ? undefined : context.options.getString("reason") ?? undefined;
86
87			if (context.isLegacy) {
88			reason = "";
89
90			for (; position < args.length; position++) {
91			reason += args[position] + " ";
92			}
93
94			reason = reason.trimEnd();
95			}
96
97			const reply = await this.deferredReply(message, {
98			content: `${this.emoji("loading")} Preparing to kick ${members.length} users...`
99			});
100
101			await this.client.infractionManager.createMemberMassKick({
102			users: members,
103			moderator: message.member!.user as User,
104			reason: reason?.trim() === "" ? undefined : reason,
105			sendLog: true,
106			guild: message.guild!,
107			callAfterEach: 5,
108			callback: async ({ completedUsers, skippedUsers, users, completedIn }) => {
109			log(`Kicked ${completedUsers.length} out of ${users.length} users (${skippedUsers.length} failed)`);
110
111			await reply
112			.edit({
113			content: `${this.emoji(completedUsers.length === users.length && completedIn ? "check" : "loading")} Kicked ${
114			completedUsers.length
115			} out of ${users.length} users (${completedIn ? `Completed in ${completedIn}s, ` : ""}${skippedUsers.length} failures)`
116			})
117			.catch(logError);
118			}
119			});
120			}
121			}