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,
            abortOnTemplateNotFound: true,
            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	/*
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, {
22	BasicCommandContext,
23	CommandMessage,
24	CommandReturn,
25	ValidationRule
26	} from "../../core/Command";
27	import { log, logError } from "../../utils/Logger";
28	import { isSnowflake } from "../../utils/utils";
29
30	export default class MassKickCommand extends Command {
31	public readonly name = "masskick";
32	public readonly validationRules: ValidationRule[] = [];
33	public readonly permissions = [PermissionsBitField.Flags.Administrator];
34	public readonly aliases = ["mkick"];
35
36	public readonly description = "Kick multiple users at the same time.";
37	public readonly detailedDescription =
38	"This command can kick multiple users. This is helpful if you want to quickly kick server raiders.";
39	public readonly argumentSyntaxes = ["<...UserIDs\|UserMentions> [Reason]"];
40
41	public readonly botRequiredPermissions = [PermissionsBitField.Flags.Administrator];
42
43	public readonly slashCommandBuilder = new SlashCommandBuilder()
44	.addUserOption(option =>
45	option.setName("users").setDescription("The users to kick").setRequired(true)
46	)
47	.addStringOption(option =>
48	option.setName("reason").setDescription("The reason for taking this action")
49	);
50
51	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
52	if (context.isLegacy && context.args[0] === undefined) {
53	return {
54	__reply: true,
55	content: `${this.emoji("error")} Please specify at least 1 user to kick!`
56	};
57	}
58
59	const args = context.isLegacy
60	? context.args
61	: context.options.getString("users", true).split(/ +/);
62
63	if (args.length > 10) {
64	return {
65	__reply: true,
66	content: `${this.emoji("error")} Cannot masskick more than 10 users at once!`
67	};
68	}
69
70	const members: string[] = [];
71	let position = 0;
72
73	for (const arg of args) {
74	let id: string \| undefined = undefined;
75
76	if (isSnowflake(arg)) {
77	id = arg;
78	} else if (arg.startsWith("<@") && arg.endsWith(">")) {
79	id = arg.substring(arg.includes("!") ? 3 : 2, arg.length - 1);
80	}
81
82	if (id && !isSnowflake(id)) {
83	return {
84	__reply: true,
85	content: `\`${id}\` is not a valid user mention format or the ID is incorrect.`
86	};
87	}
88
89	if (!id) break;
90
91	members.push(id);
92	position++;
93	}
94
95	await this.deferIfInteraction(message);
96
97	let reason = context.isLegacy
98	? undefined
99	: context.options.getString("reason") ?? undefined;
100
101	if (context.isLegacy) {
102	reason = "";
103
104	for (; position < args.length; position++) {
105	reason += args[position] + " ";
106	}
107
108	reason = reason.trimEnd();
109	}
110
111	const reply = await this.deferredReply(message, {
112	content: `${this.emoji("loading")} Preparing to kick ${members.length} users...`
113	});
114
115	await this.client.infractionManager.createMemberMassKick({
116	users: members,
117	moderator: message.member!.user as User,
118	reason: reason?.trim() === "" ? undefined : reason,
119	sendLog: true,
120	guild: message.guild!,
121	callAfterEach: 5,
122	abortOnTemplateNotFound: true,
123	callback: async ({ completedUsers, skippedUsers, users, completedIn }) => {
124	log(
125	`Kicked ${completedUsers.length} out of ${users.length} users (${skippedUsers.length} failed)`
126	);
127
128	await reply
129	.edit({
130	content: `${this.emoji(
131	completedUsers.length === users.length && completedIn
132	? "check"
133	: "loading"
134	)} Kicked ${completedUsers.length} out of ${users.length} users (${
135	completedIn ? `Completed in ${completedIn}s, ` : ""
136	}${skippedUsers.length} failures)`
137	})
138	.catch(logError);
139	}
140	});
141	}
142	}