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

export default class MuteCommand extends Command {
    public readonly name = "mute";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.GuildMember],
            entityNotNull: true,
            requiredErrorMessage: "You must specify a member to mute!",
            typeErrorMessage: "You have specified an invalid user mention or ID.",
            entityNotNullErrorMessage: "The given member does not exist in the server!",
            name: "member"
        },
        {
            types: [ArgumentType.TimeInterval, ArgumentType.StringRest],
            optional: true,
            minMaxErrorMessage: "The mute duration must be a valid time interval.",
            typeErrorMessage:
                "You have specified an invalid argument. The system expected you to provide a mute reason or the mute duration here.",
            lengthMax: 3999,
            name: "durationOrReason"
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            typeErrorMessage: "You have specified an invalid warning reason.",
            lengthMax: 3999,
            name: "reason"
        }
    ];
    public readonly permissions = [PermissionsBitField.Flags.ModerateMembers];

    public readonly description = "Mutes a server member.";
    public readonly detailedDescription =
        "This command mutes a server member. You can specify a duration or make it indefinite. The muted role needs to be configured for this command to work!";
    public readonly argumentSyntaxes = ["<UserID|UserMention> [reason]", "<UserID|UserMention> [duration] [reason]"];

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

    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addUserOption(option => option.setName("member").setDescription("The member").setRequired(true))
        .addStringOption(option => option.setName("reason").setDescription("The reason for muting this user"))
        .addStringOption(option => option.setName("time").setDescription("Mute duration"))
        .addBooleanOption(option =>
            option
                .setName("hardmute")
                .setDescription("Specify if the system should take out all roles of the user during the mute")
        )
        .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> {
        const member = context.isLegacy ? context.parsedNamedArgs.member : context.options.getMember("member");

        if (!member) {
            await message.reply({
                ephemeral: true,
                content: "The member is invalid or does not exist."
            });

            return;
        }
        let duration =
            (!context.isLegacy
                ? context.options.getString("time") ?? undefined
                : typeof context.parsedNamedArgs.durationOrReason === "number"
                ? context.parsedNamedArgs.durationOrReason
                : undefined) ?? undefined;

        if (typeof duration === "string") {
            const { error, result } = stringToTimeInterval(duration);

            if (error) {
                await message.reply({
                    ephemeral: true,
                    content: error
                });

                return;
            }

            duration = result;
        }

        const reason =
            (!context.isLegacy
                ? context.options.getString("reason") ?? undefined
                : typeof context.parsedNamedArgs.durationOrReason === "string"
                ? context.parsedNamedArgs.durationOrReason
                : typeof context.parsedNamedArgs.durationOrReason === "number"
                ? (context.parsedNamedArgs.reason as string | undefined)
                : undefined) ?? undefined;

        if (message instanceof ChatInputCommandInteraction) {
            await message.deferReply();
        }

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

        const { id, result, error } = await this.client.infractionManager.createMemberMute(member, {
            guild: message.guild!,
            moderator: message.member!.user as User,
            notifyUser: !context.isLegacy ? !context.options.getBoolean("silent") ?? true : true,
            reason,
            sendLog: true,
            duration: duration ? duration * 1000 : undefined /* Convert the duration from seconds to milliseconds */,
            autoRemoveQueue: true
        });

        if (error || !id) {
            await this.deferredReply(message, {
                content: error ?? `An error has occurred during role assignment. Please double check the bot permissions.`
            });

            return;
        }

        await this.deferredReply(message, {
            embeds: [
                await createModerationEmbed({
                    user: member.user,
                    description: `**${escapeMarkdown(member.user.tag)}** has been muted.${
                        result === false
                            ? "\nFailed to deliver a DM to the user, and the fallback channel could not be created. The user will not know about this mute."
                            : result === null
                            ? "\nCould not deliver a DM since the user is not in the server. They will not know about this mute"
                            : ""
                    }`,
                    actionDoneName: "muted",
                    id,
                    reason,
                    fields: [
                        {
                            name: "Duration",
                            value: duration
                                ? formatDistanceToNowStrict(new Date(Date.now() - duration * 1000))
                                : "*No duration set*"
                        }
                    ]
                })
            ]
        });
    }
}
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 { formatDistanceToNowStrict } from "date-fns";
21	import {
22	ChatInputCommandInteraction,
23	GuildMember,
24	PermissionsBitField,
25	SlashCommandBuilder,
26	User,
27	escapeMarkdown
28	} from "discord.js";
29	import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
30	import { stringToTimeInterval } from "../../utils/datetime";
31	import { createModerationEmbed } from "../../utils/utils";
32
33	export default class MuteCommand extends Command {
34	public readonly name = "mute";
35	public readonly validationRules: ValidationRule[] = [
36	{
37	types: [ArgumentType.GuildMember],
38	entityNotNull: true,
39	requiredErrorMessage: "You must specify a member to mute!",
40	typeErrorMessage: "You have specified an invalid user mention or ID.",
41	entityNotNullErrorMessage: "The given member does not exist in the server!",
42	name: "member"
43	},
44	{
45	types: [ArgumentType.TimeInterval, ArgumentType.StringRest],
46	optional: true,
47	minMaxErrorMessage: "The mute duration must be a valid time interval.",
48	typeErrorMessage:
49	"You have specified an invalid argument. The system expected you to provide a mute reason or the mute duration here.",
50	lengthMax: 3999,
51	name: "durationOrReason"
52	},
53	{
54	types: [ArgumentType.StringRest],
55	optional: true,
56	typeErrorMessage: "You have specified an invalid warning reason.",
57	lengthMax: 3999,
58	name: "reason"
59	}
60	];
61	public readonly permissions = [PermissionsBitField.Flags.ModerateMembers];
62
63	public readonly description = "Mutes a server member.";
64	public readonly detailedDescription =
65	"This command mutes a server member. You can specify a duration or make it indefinite. The muted role needs to be configured for this command to work!";
66	public readonly argumentSyntaxes = ["<UserID\|UserMention> [reason]", "<UserID\|UserMention> [duration] [reason]"];
67
68	public readonly botRequiredPermissions = [PermissionsBitField.Flags.ModerateMembers];
69
70	public readonly slashCommandBuilder = new SlashCommandBuilder()
71	.addUserOption(option => option.setName("member").setDescription("The member").setRequired(true))
72	.addStringOption(option => option.setName("reason").setDescription("The reason for muting this user"))
73	.addStringOption(option => option.setName("time").setDescription("Mute duration"))
74	.addBooleanOption(option =>
75	option
76	.setName("hardmute")
77	.setDescription("Specify if the system should take out all roles of the user during the mute")
78	)
79	.addBooleanOption(option =>
80	option
81	.setName("silent")
82	.setDescription("Specify if the system should not notify the user about this action. Defaults to false")
83	);
84
85	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
86	const member = context.isLegacy ? context.parsedNamedArgs.member : context.options.getMember("member");
87
88	if (!member) {
89	await message.reply({
90	ephemeral: true,
91	content: "The member is invalid or does not exist."
92	});
93
94	return;
95	}
96	let duration =
97	(!context.isLegacy
98	? context.options.getString("time") ?? undefined
99	: typeof context.parsedNamedArgs.durationOrReason === "number"
100	? context.parsedNamedArgs.durationOrReason
101	: undefined) ?? undefined;
102
103	if (typeof duration === "string") {
104	const { error, result } = stringToTimeInterval(duration);
105
106	if (error) {
107	await message.reply({
108	ephemeral: true,
109	content: error
110	});
111
112	return;
113	}
114
115	duration = result;
116	}
117
118	const reason =
119	(!context.isLegacy
120	? context.options.getString("reason") ?? undefined
121	: typeof context.parsedNamedArgs.durationOrReason === "string"
122	? context.parsedNamedArgs.durationOrReason
123	: typeof context.parsedNamedArgs.durationOrReason === "number"
124	? (context.parsedNamedArgs.reason as string \| undefined)
125	: undefined) ?? undefined;
126
127	if (message instanceof ChatInputCommandInteraction) {
128	await message.deferReply();
129	}
130
131	if (!this.client.permissionManager.shouldModerate(member, message.member! as GuildMember)) {
132	await this.error(message, "You don't have permission to mute this user!");
133	return;
134	}
135
136	const { id, result, error } = await this.client.infractionManager.createMemberMute(member, {
137	guild: message.guild!,
138	moderator: message.member!.user as User,
139	notifyUser: !context.isLegacy ? !context.options.getBoolean("silent") ?? true : true,
140	reason,
141	sendLog: true,
142	duration: duration ? duration * 1000 : undefined /* Convert the duration from seconds to milliseconds */,
143	autoRemoveQueue: true
144	});
145
146	if (error \|\| !id) {
147	await this.deferredReply(message, {
148	content: error ?? `An error has occurred during role assignment. Please double check the bot permissions.`
149	});
150
151	return;
152	}
153
154	await this.deferredReply(message, {
155	embeds: [
156	await createModerationEmbed({
157	user: member.user,
158	description: `${escapeMarkdown(member.user.tag)} has been muted.${
159	result === false
160	? "\nFailed to deliver a DM to the user, and the fallback channel could not be created. The user will not know about this mute."
161	: result === null
162	? "\nCould not deliver a DM since the user is not in the server. They will not know about this mute"
163	: ""
164	}`,
165	actionDoneName: "muted",
166	id,
167	reason,
168	fields: [
169	{
170	name: "Duration",
171	value: duration
172	? formatDistanceToNowStrict(new Date(Date.now() - duration * 1000))
173	: "No duration set"
174	}
175	]
176	})
177	]
178	});
179	}
180	}