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