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.Member],
            entity: true,
            errors: {
                required: "You must specify a member to unmute!",
                "type:invalid": "You have specified an invalid member mention or ID.",
                "entity:null": "The given member does not exist!"
            },
            name: "member"
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            errors: {
                "type:invalid": "You have specified an invalid unmute reason.",
                "string:rest:length:max":
                    "The unmute reason must be less than 4000 characters long."
            },
            string: {
                maxLength: 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 (
            !(await 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, infraction } = 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,
                abortOnTemplateNotFound: true
            })
            .catch(e => {
                logError(e);
                return { id: null, infraction: null };
            });

        if (!id) {
            await this.error(
                message,
                "Failed to unmute this user or I'm missing permissions to mute this user!"
            );
            return;
        }

        await this.deferredReply(
            message,
            {
                embeds: [
                    await createModerationEmbed({
                        moderator: message.member!.user as User,
                        user: member.user,
                        actionDoneName: "unmuted",
                        description: `**${escapeMarkdown(member.user.tag)}** has been unmuted.`,
                        id: `${id}`,
                        reason: infraction?.reason,
                        color: "Green"
                    })
                ]
            },
            "auto"
        );
    }
}
1	rakinar2	577	/**
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 {
21			GuildMember,
22			PermissionsBitField,
23			SlashCommandBuilder,
24			User,
25			escapeMarkdown
26			} from "discord.js";
27			import Command, {
28			ArgumentType,
29			BasicCommandContext,
30			CommandMessage,
31			CommandReturn,
32			ValidationRule
33			} from "../../core/Command";
34			import { logError } from "../../utils/Logger";
35			import { createModerationEmbed } from "../../utils/utils";
36
37			export default class UnmuteCommand extends Command {
38			public readonly name = "unmute";
39			public readonly validationRules: ValidationRule[] = [
40			{
41			types: [ArgumentType.Member],
42			entity: true,
43			errors: {
44			required: "You must specify a member to unmute!",
45			"type:invalid": "You have specified an invalid member mention or ID.",
46			"entity:null": "The given member does not exist!"
47			},
48			name: "member"
49			},
50			{
51			types: [ArgumentType.StringRest],
52			optional: true,
53			errors: {
54			"type:invalid": "You have specified an invalid unmute reason.",
55			"string:rest:length:max":
56			"The unmute reason must be less than 4000 characters long."
57			},
58			string: {
59			maxLength: 3999
60			},
61			name: "reason"
62			}
63			];
64			public readonly permissions = [PermissionsBitField.Flags.ModerateMembers];
65
66			public readonly description = "Unmutes a server member.";
67			public readonly detailedDescription =
68			"This command unmutes a server member. The muted role needs to be configured for this command to work!";
69			public readonly argumentSyntaxes = ["<UserID\|UserMention> [reason]"];
70
71			public readonly botRequiredPermissions = [PermissionsBitField.Flags.ModerateMembers];
72
73			public readonly slashCommandBuilder = new SlashCommandBuilder()
74			.addUserOption(option =>
75			option.setName("member").setDescription("The member").setRequired(true)
76			)
77			.addStringOption(option =>
78			option.setName("reason").setDescription("The reason for unmuting this user")
79			)
80			.addBooleanOption(option =>
81			option
82			.setName("silent")
83			.setDescription(
84			"Specify if the system should not notify the user about this action. Defaults to false"
85			)
86			);
87
88			async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
89			const member: GuildMember = context.isLegacy
90			? context.parsedNamedArgs.member
91			: context.options.getMember("member");
92
93			if (!member) {
94			return {
95			__reply: true,
96			ephemeral: true,
97			content: `${this.emoji("error")} Invalid member specified.`
98			};
99			}
100
101			await this.deferIfInteraction(message);
102			const reason: string \| undefined =
103			(!context.isLegacy
104			? context.options.getString("reason")
105			: context.parsedNamedArgs.reason) ?? undefined;
106
107			if (
108			!(await this.client.permissionManager.shouldModerate(
109			member,
110			message.member! as GuildMember
111			))
112			) {
113			await this.error(message, "You don't have permission to unmute this user!");
114			return;
115			}
116
117			const { id, infraction } = await this.client.infractionManager
118			.removeMemberMute(member, {
119			guild: message.guild!,
120			moderator: message.member!.user as User,
121			notifyUser: !context.isLegacy
122			? !context.options.getBoolean("silent") ?? true
123			: true,
124			reason,
125			sendLog: true,
126			abortOnTemplateNotFound: true
127			})
128			.catch(e => {
129			logError(e);
130			return { id: null, infraction: null };
131			});
132
133			if (!id) {
134			await this.error(
135			message,
136			"Failed to unmute this user or I'm missing permissions to mute this user!"
137			);
138			return;
139			}
140
141			await this.deferredReply(
142			message,
143			{
144			embeds: [
145			await createModerationEmbed({
146			moderator: message.member!.user as User,
147			user: member.user,
148			actionDoneName: "unmuted",
149			description: `${escapeMarkdown(member.user.tag)} has been unmuted.`,
150			id: `${id}`,
151			reason: infraction?.reason,
152			color: "Green"
153			})
154			]
155			},
156			"auto"
157			);
158			}
159			}