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

export default class UnmuteCommand extends Command {
    public readonly name = "unmute";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.GuildMember],
            entityNotNull: true,
            requiredErrorMessage: "You must specify a member to unmute!",
            typeErrorMessage: "You have specified an invalid member mention or ID.",
            entityNotNullErrorMessage: "The given member does not exist!",
            name: "member"
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            typeErrorMessage: "You have specified an invalid unmute reason.",
            lengthMax: 3999,
            name: "reason"
        }
    ];
    public readonly permissions = [PermissionsBitField.Flags.ModerateMembers];

    public readonly description = "Unmutes a server member.";
    public readonly detailedDescription = "This command unmutes a server member. The muted role needs to be configured for this command to work!";
    public readonly argumentSyntaxes = ["<UserID|UserMention> [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 unmuting this user"))
        .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: GuildMember = context.isLegacy ? context.parsedNamedArgs.member : context.options.getMember("member");

        if (!member) {
            return {
                __reply: true,
                ephemeral: true,
                content: `${this.emoji("error")} Invalid member specified.`
            };
        }

        await this.deferIfInteraction(message);
        const reason: string | undefined = (!context.isLegacy ? context.options.getString("reason") : context.parsedNamedArgs.reason) ?? undefined;

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

        const { id } = <any>await this.client.infractionManager
            .removeMemberMute(member, {
                guild: message.guild!,
                moderator: message.member!.user as User,
                notifyUser: !context.isLegacy ? !context.options.getBoolean("silent") ?? true : true,
                reason,
                sendLog: true
            })
            .catch(logError);

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

        await this.deferredReply(message, {
            embeds: [
                await createModerationEmbed({
                    user: member.user,
                    actionDoneName: "unmuted",
                    description: `**${escapeMarkdown(member.user.tag)}** has been unmuted.`,
                    id: `${id}`,
                    reason,
                    color: "Green"
                })
            ]
        });
    }
}
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 { GuildMember, PermissionsBitField, SlashCommandBuilder, User, escapeMarkdown } from "discord.js";
21	import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
22	import { logError } from "../../utils/logger";
23	import { createModerationEmbed } from "../../utils/utils";
24
25	export default class UnmuteCommand extends Command {
26	public readonly name = "unmute";
27	public readonly validationRules: ValidationRule[] = [
28	{
29	types: [ArgumentType.GuildMember],
30	entityNotNull: true,
31	requiredErrorMessage: "You must specify a member to unmute!",
32	typeErrorMessage: "You have specified an invalid member mention or ID.",
33	entityNotNullErrorMessage: "The given member does not exist!",
34	name: "member"
35	},
36	{
37	types: [ArgumentType.StringRest],
38	optional: true,
39	typeErrorMessage: "You have specified an invalid unmute reason.",
40	lengthMax: 3999,
41	name: "reason"
42	}
43	];
44	public readonly permissions = [PermissionsBitField.Flags.ModerateMembers];
45
46	public readonly description = "Unmutes a server member.";
47	public readonly detailedDescription = "This command unmutes a server member. The muted role needs to be configured for this command to work!";
48	public readonly argumentSyntaxes = ["<UserID\|UserMention> [reason]"];
49
50	public readonly botRequiredPermissions = [PermissionsBitField.Flags.ModerateMembers];
51
52	public readonly slashCommandBuilder = new SlashCommandBuilder()
53	.addUserOption(option => option.setName("member").setDescription("The member").setRequired(true))
54	.addStringOption(option => option.setName("reason").setDescription("The reason for unmuting this user"))
55	.addBooleanOption(option =>
56	option.setName("silent").setDescription("Specify if the system should not notify the user about this action. Defaults to false")
57	);
58
59	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
60	const member: GuildMember = context.isLegacy ? context.parsedNamedArgs.member : context.options.getMember("member");
61
62	if (!member) {
63	return {
64	__reply: true,
65	ephemeral: true,
66	content: `${this.emoji("error")} Invalid member specified.`
67	};
68	}
69
70	await this.deferIfInteraction(message);
71	const reason: string \| undefined = (!context.isLegacy ? context.options.getString("reason") : context.parsedNamedArgs.reason) ?? undefined;
72
73	if (!this.client.permissionManager.shouldModerate(member, message.member! as GuildMember)) {
74	await this.error(message, "You don't have permission to unmute this user!");
75	return;
76	}
77
78	const { id } = <any>await this.client.infractionManager
79	.removeMemberMute(member, {
80	guild: message.guild!,
81	moderator: message.member!.user as User,
82	notifyUser: !context.isLegacy ? !context.options.getBoolean("silent") ?? true : true,
83	reason,
84	sendLog: true
85	})
86	.catch(logError);
87
88	if (!id) {
89	await this.error(message);
90	return;
91	}
92
93	await this.deferredReply(message, {
94	embeds: [
95	await createModerationEmbed({
96	user: member.user,
97	actionDoneName: "unmuted",
98	description: `${escapeMarkdown(member.user.tag)} has been unmuted.`,
99	id: `${id}`,
100	reason,
101	color: "Green"
102	})
103	]
104	});
105	}
106	}