commands/moderation/SoftBanCommand.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 { formatDistanceToNow } from "date-fns";
import { GuildMember, PermissionsBitField, SlashCommandBuilder, User, escapeMarkdown } from "discord.js";
import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
import { stringToTimeInterval } from "../../utils/datetime";
import { logError } from "../../utils/logger";
import { createModerationEmbed } from "../../utils/utils";

export default class SoftBanCommand extends Command {
    public readonly name = "softban";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.User],
            entity: true,
            errors: {
                required: "You must specify a user to ban!",
                "type:invalid": "You have specified an invalid user mention or ID.",
                "entity:null": "The given user does not exist!"
            },
            name: "user"
        },
        {
            types: [ArgumentType.TimeInterval, ArgumentType.StringRest],
            optional: true,
            errors: {
                "type:invalid":
                    "You have specified an invalid argument. The system expected you to provide a ban reason or the message deletion timeframe here.",
                "time:range": "The message deletion range must be a time interval from 0 second to 604800 seconds (7 days)."
            },
            string: {
                maxLength: 3999
            },
            time: {
                min: 0,
                max: 604800
            },
            name: "timeframeOrReason",
            default: 604800
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            errors: {
                "type:invalid": "You have specified an invalid ban reason."
            },
            string: {
                maxLength: 3999
            },
            name: "reason"
        }
    ];
    public readonly permissions = [PermissionsBitField.Flags.BanMembers];

    public readonly description = "Softbans a user.";
    public readonly detailedDescription =
        "This command bans a user, then unbans immediately. This is helpful if you want to remove the recent messages by a user.";
    public readonly argumentSyntaxes = ["<UserID|UserMention> [Reason]", "<UserID|UserMention> [MessageDeletionTime] [Reason]"];

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

    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addUserOption(option => option.setName("user").setDescription("The user").setRequired(true))
        .addStringOption(option => option.setName("reason").setDescription("The reason for softbanning this user"))
        .addStringOption(option =>
            option
                .setName("deletion_timeframe")
                .setDescription("The message deletion timeframe, defaults to 7 days (must be in range 0-7 days)")
        )
        .addBooleanOption(option =>
            option
                .setName("silent")
                .setDescription("Specify if the system should not notify the user about this action. Defaults to false")
        );

    async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
        await this.deferIfInteraction(message);

        const user: User = context.isLegacy ? context.parsedNamedArgs.user : context.options.getUser("user", true);

        let messageDeletionTimeframe = !context.isLegacy
            ? undefined
            : typeof context.parsedNamedArgs.timeframeOrReason === "number"
            ? context.parsedNamedArgs.timeframeOrReason
            : undefined;
        const reason = !context.isLegacy
            ? context.options.getString("reason") ?? undefined
            : typeof context.parsedNamedArgs.timeframeOrReason === "string"
            ? context.parsedNamedArgs.timeframeOrReason
            : context.parsedNamedArgs.reason;

        ifContextIsNotLegacy: if (!context.isLegacy) {
            const input = context.options.getString("deletion_timeframe");

            if (!input) break ifContextIsNotLegacy;

            const { result, error } = stringToTimeInterval(input);

            if (error) {
                await this.deferredReply(message, {
                    content: `${this.emoji("error")} ${error} provided in the \`deletion_timeframe\` option`
                });

                return;
            }

            if (result < 0 || result > 604800) {
                await this.deferredReply(
                    message,
                    `${this.emoji(
                        "error"
                    )} The message deletion range must be a time interval from 0 second to 604800 seconds (7 days).`
                );
                return;
            }

            messageDeletionTimeframe = result;
        }

        messageDeletionTimeframe ??= 604800;

        try {
            const member = message.guild!.members.cache.get(user.id) ?? (await message.guild!.members.fetch(user.id));

            if (!(await this.client.permissionManager.shouldModerate(member, message.member! as GuildMember))) {
                await this.error(message, "You don't have permission to softban this user!");
                return;
            }
        } catch (e) {
            logError(e);
        }

        const id = await this.client.infractionManager.createUserSoftban(user, {
            guild: message.guild!,
            moderator: message.member!.user as User,
            deleteMessageSeconds: messageDeletionTimeframe,
            reason,
            notifyUser: context.isLegacy ? true : !context.options.getBoolean("silent"),
            sendLog: true
        });

        if (!id) {
            await this.error(message);
            return;
        }

        await this.deferredReply(
            message,
            {
                embeds: [
                    await createModerationEmbed({
                        moderator: message.member!.user as User,
                        user,
                        actionDoneName: "softbanned",
                        description: `**${escapeMarkdown(user.tag)}** was softbanned.`,
                        fields: [
                            {
                                name: "Message Deletion",
                                value: messageDeletionTimeframe
                                    ? `Timeframe: ${formatDistanceToNow(
                                          new Date(Date.now() - messageDeletionTimeframe * 1000)
                                      )}\nMessages in this timeframe by this user will be removed.`
                                    : "*No message will be deleted*"
                            }
                        ],
                        id: `${id}`,
                        reason
                    })
                ]
            },
            "auto"
        );
    }
}
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 { formatDistanceToNow } from "date-fns";
21	import { GuildMember, PermissionsBitField, SlashCommandBuilder, User, escapeMarkdown } from "discord.js";
22	import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
23	import { stringToTimeInterval } from "../../utils/datetime";
24	import { logError } from "../../utils/logger";
25	import { createModerationEmbed } from "../../utils/utils";
26
27	export default class SoftBanCommand extends Command {
28	public readonly name = "softban";
29	public readonly validationRules: ValidationRule[] = [
30	{
31	types: [ArgumentType.User],
32	entity: true,
33	errors: {
34	required: "You must specify a user to ban!",
35	"type:invalid": "You have specified an invalid user mention or ID.",
36	"entity:null": "The given user does not exist!"
37	},
38	name: "user"
39	},
40	{
41	types: [ArgumentType.TimeInterval, ArgumentType.StringRest],
42	optional: true,
43	errors: {
44	"type:invalid":
45	"You have specified an invalid argument. The system expected you to provide a ban reason or the message deletion timeframe here.",
46	"time:range": "The message deletion range must be a time interval from 0 second to 604800 seconds (7 days)."
47	},
48	string: {
49	maxLength: 3999
50	},
51	time: {
52	min: 0,
53	max: 604800
54	},
55	name: "timeframeOrReason",
56	default: 604800
57	},
58	{
59	types: [ArgumentType.StringRest],
60	optional: true,
61	errors: {
62	"type:invalid": "You have specified an invalid ban reason."
63	},
64	string: {
65	maxLength: 3999
66	},
67	name: "reason"
68	}
69	];
70	public readonly permissions = [PermissionsBitField.Flags.BanMembers];
71
72	public readonly description = "Softbans a user.";
73	public readonly detailedDescription =
74	"This command bans a user, then unbans immediately. This is helpful if you want to remove the recent messages by a user.";
75	public readonly argumentSyntaxes = ["<UserID\|UserMention> [Reason]", "<UserID\|UserMention> [MessageDeletionTime] [Reason]"];
76
77	public readonly botRequiredPermissions = [PermissionsBitField.Flags.BanMembers];
78
79	public readonly slashCommandBuilder = new SlashCommandBuilder()
80	.addUserOption(option => option.setName("user").setDescription("The user").setRequired(true))
81	.addStringOption(option => option.setName("reason").setDescription("The reason for softbanning this user"))
82	.addStringOption(option =>
83	option
84	.setName("deletion_timeframe")
85	.setDescription("The message deletion timeframe, defaults to 7 days (must be in range 0-7 days)")
86	)
87	.addBooleanOption(option =>
88	option
89	.setName("silent")
90	.setDescription("Specify if the system should not notify the user about this action. Defaults to false")
91	);
92
93	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
94	await this.deferIfInteraction(message);
95
96	const user: User = context.isLegacy ? context.parsedNamedArgs.user : context.options.getUser("user", true);
97
98	let messageDeletionTimeframe = !context.isLegacy
99	? undefined
100	: typeof context.parsedNamedArgs.timeframeOrReason === "number"
101	? context.parsedNamedArgs.timeframeOrReason
102	: undefined;
103	const reason = !context.isLegacy
104	? context.options.getString("reason") ?? undefined
105	: typeof context.parsedNamedArgs.timeframeOrReason === "string"
106	? context.parsedNamedArgs.timeframeOrReason
107	: context.parsedNamedArgs.reason;
108
109	ifContextIsNotLegacy: if (!context.isLegacy) {
110	const input = context.options.getString("deletion_timeframe");
111
112	if (!input) break ifContextIsNotLegacy;
113
114	const { result, error } = stringToTimeInterval(input);
115
116	if (error) {
117	await this.deferredReply(message, {
118	content: `${this.emoji("error")} ${error} provided in the \`deletion_timeframe\` option`
119	});
120
121	return;
122	}
123
124	if (result < 0 \|\| result > 604800) {
125	await this.deferredReply(
126	message,
127	`${this.emoji(
128	"error"
129	)} The message deletion range must be a time interval from 0 second to 604800 seconds (7 days).`
130	);
131	return;
132	}
133
134	messageDeletionTimeframe = result;
135	}
136
137	messageDeletionTimeframe ??= 604800;
138
139	try {
140	const member = message.guild!.members.cache.get(user.id) ?? (await message.guild!.members.fetch(user.id));
141
142	if (!(await this.client.permissionManager.shouldModerate(member, message.member! as GuildMember))) {
143	await this.error(message, "You don't have permission to softban this user!");
144	return;
145	}
146	} catch (e) {
147	logError(e);
148	}
149
150	const id = await this.client.infractionManager.createUserSoftban(user, {
151	guild: message.guild!,
152	moderator: message.member!.user as User,
153	deleteMessageSeconds: messageDeletionTimeframe,
154	reason,
155	notifyUser: context.isLegacy ? true : !context.options.getBoolean("silent"),
156	sendLog: true
157	});
158
159	if (!id) {
160	await this.error(message);
161	return;
162	}
163
164	await this.deferredReply(
165	message,
166	{
167	embeds: [
168	await createModerationEmbed({
169	moderator: message.member!.user as User,
170	user,
171	actionDoneName: "softbanned",
172	description: `${escapeMarkdown(user.tag)} was softbanned.`,
173	fields: [
174	{
175	name: "Message Deletion",
176	value: messageDeletionTimeframe
177	? `Timeframe: ${formatDistanceToNow(
178	new Date(Date.now() - messageDeletionTimeframe * 1000)
179	)}\nMessages in this timeframe by this user will be removed.`
180	: "No message will be deleted"
181	}
182	],
183	id: `${id}`,
184	reason
185	})
186	]
187	},
188	"auto"
189	);
190	}
191	}