commands/moderation/FakeBanCommand.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 { ChatInputCommandInteraction, PermissionsBitField, SlashCommandBuilder, User, escapeMarkdown } from "discord.js";
import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
import { stringToTimeInterval } from "../../utils/datetime";
import { protectSystemAdminsFromCommands } from "../../utils/troll";
import { createModerationEmbed } from "../../utils/utils";

export default class FakeBanCommand extends Command {
    public readonly name = "fakeban";
    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!"
        },
        {
            types: [ArgumentType.TimeInterval, ArgumentType.StringRest],
            optional: true,
            minMaxErrorMessage: "The message deletion range must be a time interval from 0 second to 604800 seconds (7 days).",
            typeErrorMessage:
                "You have specified an invalid argument. The system expected you to provide a ban reason or the message deletion range here.",
            minValue: 0,
            maxValue: 604800,
            lengthMax: 3999,
            timeMilliseconds: false
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            typeErrorMessage: "You have specified an invalid ban reason.",
            lengthMax: 3999
        }
    ];
    public readonly permissions = [PermissionsBitField.Flags.BanMembers];

    public readonly aliases = ["fban"];

    public readonly description = "Fakebans a user.";
    public readonly detailedDescription = "This commands simulates a user ban.";
    public readonly argumentSyntaxes = ["<UserID|UserMention> [Reason]", "<UserID|UserMention> [MessageDeletionTime] [Reason]"];

    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addUserOption(option => option.setName("user").setDescription("The user").setRequired(true))
        .addStringOption(option => option.setName("reason").setDescription("The reason for banning this user"))
        .addStringOption(option =>
            option.setName("deletion_timeframe").setDescription("The message deletion timeframe (must be in range 0-604800s)")
        )
        .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> {
        if (message instanceof ChatInputCommandInteraction) await message.deferReply();

        const user: User = context.isLegacy ? context.parsedArgs[0] : context.options.getUser("user", true);

        if (await protectSystemAdminsFromCommands(this.client, message, user.id)) {
            return;
        }

        let deleteMessageSeconds = !context.isLegacy
            ? undefined
            : typeof context.parsedArgs[1] === "number"
            ? context.parsedArgs[1]
            : undefined;
        const reason = !context.isLegacy
            ? context.options.getString("reason") ?? undefined
            : typeof context.parsedArgs[1] === "string"
            ? context.parsedArgs[1]
            : context.parsedArgs[2];
        let durationMs: undefined | number = undefined;

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

            if (!input) break ifContextIsNotLegacyForDeleteTimeframe;

            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;
            }

            deleteMessageSeconds = result;
        }

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

            if (!input) break ifContextIsNotLegacy;

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

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

                return;
            }

            durationMs = result;
        }

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

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

        await this.deferredReply(message, {
            embeds: [
                await createModerationEmbed({
                    user,
                    actionDoneName: "banned",
                    description: `**${escapeMarkdown(user.tag)}** has been banned from this server.`,
                    fields: [
                        {
                            name: "Message Deletion",
                            value: deleteMessageSeconds
                                ? `Timeframe: ${formatDistanceToNow(
                                      new Date(Date.now() - deleteMessageSeconds * 1000)
                                  )}\nMessages in this timeframe by this user will be removed.`
                                : "*No message will be deleted*"
                        }
                    ],
                    id: `${id}`,
                    reason,
                    color: 0x007bff
                })
            ]
        });
    }
}
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 { ChatInputCommandInteraction, 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 { protectSystemAdminsFromCommands } from "../../utils/troll";
25	import { createModerationEmbed } from "../../utils/utils";
26
27	export default class FakeBanCommand extends Command {
28	public readonly name = "fakeban";
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	},
37	{
38	types: [ArgumentType.TimeInterval, ArgumentType.StringRest],
39	optional: true,
40	minMaxErrorMessage: "The message deletion range must be a time interval from 0 second to 604800 seconds (7 days).",
41	typeErrorMessage:
42	"You have specified an invalid argument. The system expected you to provide a ban reason or the message deletion range here.",
43	minValue: 0,
44	maxValue: 604800,
45	lengthMax: 3999,
46	timeMilliseconds: false
47	},
48	{
49	types: [ArgumentType.StringRest],
50	optional: true,
51	typeErrorMessage: "You have specified an invalid ban reason.",
52	lengthMax: 3999
53	}
54	];
55	public readonly permissions = [PermissionsBitField.Flags.BanMembers];
56
57	public readonly aliases = ["fban"];
58
59	public readonly description = "Fakebans a user.";
60	public readonly detailedDescription = "This commands simulates a user ban.";
61	public readonly argumentSyntaxes = ["<UserID\|UserMention> [Reason]", "<UserID\|UserMention> [MessageDeletionTime] [Reason]"];
62
63	public readonly slashCommandBuilder = new SlashCommandBuilder()
64	.addUserOption(option => option.setName("user").setDescription("The user").setRequired(true))
65	.addStringOption(option => option.setName("reason").setDescription("The reason for banning this user"))
66	.addStringOption(option =>
67	option.setName("deletion_timeframe").setDescription("The message deletion timeframe (must be in range 0-604800s)")
68	)
69	.addBooleanOption(option =>
70	option
71	.setName("silent")
72	.setDescription("Specify if the system should not notify the user about this action. Defaults to false")
73	);
74
75	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
76	if (message instanceof ChatInputCommandInteraction) await message.deferReply();
77
78	const user: User = context.isLegacy ? context.parsedArgs[0] : context.options.getUser("user", true);
79
80	if (await protectSystemAdminsFromCommands(this.client, message, user.id)) {
81	return;
82	}
83
84	let deleteMessageSeconds = !context.isLegacy
85	? undefined
86	: typeof context.parsedArgs[1] === "number"
87	? context.parsedArgs[1]
88	: undefined;
89	const reason = !context.isLegacy
90	? context.options.getString("reason") ?? undefined
91	: typeof context.parsedArgs[1] === "string"
92	? context.parsedArgs[1]
93	: context.parsedArgs[2];
94	let durationMs: undefined \| number = undefined;
95
96	ifContextIsNotLegacyForDeleteTimeframe: if (!context.isLegacy) {
97	const input = context.options.getString("deletion_timeframe");
98
99	if (!input) break ifContextIsNotLegacyForDeleteTimeframe;
100
101	const { result, error } = stringToTimeInterval(input);
102
103	if (error) {
104	await this.deferredReply(message, {
105	content: `${this.emoji("error")} ${error} provided in the \`deletion_timeframe\` option`
106	});
107
108	return;
109	}
110
111	if (result < 0 \|\| result > 604800) {
112	await this.deferredReply(
113	message,
114	`${this.emoji(
115	"error"
116	)} The message deletion range must be a time interval from 0 second to 604800 seconds (7 days).`
117	);
118	return;
119	}
120
121	deleteMessageSeconds = result;
122	}
123
124	ifContextIsNotLegacy: if (!context.isLegacy) {
125	const input = context.options.getString("duration");
126
127	if (!input) break ifContextIsNotLegacy;
128
129	const { result, error } = stringToTimeInterval(input, { milliseconds: true });
130
131	if (error) {
132	await this.deferredReply(message, {
133	content: `${this.emoji("error")} ${error} provided in the \`duration\` option`
134	});
135
136	return;
137	}
138
139	durationMs = result;
140	}
141
142	const id = await this.client.infractionManager.createUserFakeBan(user, {
143	guild: message.guild!,
144	moderator: message.member!.user as User,
145	deleteMessageSeconds,
146	reason,
147	notifyUser: context.isLegacy ? true : !context.options.getBoolean("silent"),
148	sendLog: true,
149	duration: durationMs,
150	autoRemoveQueue: true
151	});
152
153	if (!id) {
154	await this.error(message);
155	return;
156	}
157
158	await this.deferredReply(message, {
159	embeds: [
160	await createModerationEmbed({
161	user,
162	actionDoneName: "banned",
163	description: `${escapeMarkdown(user.tag)} has been banned from this server.`,
164	fields: [
165	{
166	name: "Message Deletion",
167	value: deleteMessageSeconds
168	? `Timeframe: ${formatDistanceToNow(
169	new Date(Date.now() - deleteMessageSeconds * 1000)
170	)}\nMessages in this timeframe by this user will be removed.`
171	: "No message will be deleted"
172	}
173	],
174	id: `${id}`,
175	reason,
176	color: 0x007bff
177	})
178	]
179	});
180	}
181	}