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

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

    public readonly description = "Warns a server member.";
    public readonly detailedDescription = "This command warns a server member, by sending a DM to them.";
    public readonly argumentSyntaxes = ["<UserID|UserMention> [reason]"];

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

    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addUserOption(option => option.setName("member").setDescription("The member").setRequired(true))
        .addStringOption(option => option.setName("reason").setDescription("The reason for warning this user"));

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

        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 warn this user!");
            return;
        }

        const reason = (context.isLegacy ? context.parsedNamedArgs.reason : context.options.getString("reason")) ?? undefined;

        const { id, result } = await this.client.infractionManager.createMemberWarn(member, {
            guild: message.guild!,
            moderator: message.member!.user as User,
            notifyUser: true,
            reason,
            sendLog: true
        });

        await this.deferredReply(message, {
            embeds: [
                await createModerationEmbed({
                    user: member.user,
                    description: `**${escapeMarkdown(member.user.tag)}** has been warned.${
                        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 warning."
                            : result === null
                            ? "\nCould not deliver a DM since the user is not in the server. They will not know about this warning"
                            : ""
                    }`,
                    actionDoneName: "warned",
                    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 {
21	ChatInputCommandInteraction,
22	GuildMember,
23	PermissionsBitField,
24	SlashCommandBuilder,
25	User,
26	escapeMarkdown
27	} from "discord.js";
28	import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
29	import { createModerationEmbed } from "../../utils/utils";
30
31	export default class WarnCommand extends Command {
32	public readonly name = "warn";
33	public readonly validationRules: ValidationRule[] = [
34	{
35	types: [ArgumentType.GuildMember],
36	entityNotNull: true,
37	requiredErrorMessage: "You must specify a member to warn!",
38	typeErrorMessage: "You have specified an invalid user mention or ID.",
39	entityNotNullErrorMessage: "The given member does not exist in the server!",
40	name: "member"
41	},
42	{
43	types: [ArgumentType.StringRest],
44	optional: true,
45	typeErrorMessage: "You have specified an invalid warning reason.",
46	lengthMax: 3999,
47	name: "reason"
48	}
49	];
50	public readonly permissions = [PermissionsBitField.Flags.ManageMessages];
51
52	public readonly description = "Warns a server member.";
53	public readonly detailedDescription = "This command warns a server member, by sending a DM to them.";
54	public readonly argumentSyntaxes = ["<UserID\|UserMention> [reason]"];
55
56	public readonly botRequiredPermissions = [PermissionsBitField.Flags.ManageMessages];
57
58	public readonly slashCommandBuilder = new SlashCommandBuilder()
59	.addUserOption(option => option.setName("member").setDescription("The member").setRequired(true))
60	.addStringOption(option => option.setName("reason").setDescription("The reason for warning this user"));
61
62	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
63	const member = context.isLegacy ? context.parsedNamedArgs.member : context.options.getMember("member");
64
65	if (!member) {
66	await message.reply({
67	ephemeral: true,
68	content: "The member is invalid or does not exist."
69	});
70
71	return;
72	}
73
74	if (message instanceof ChatInputCommandInteraction) {
75	await message.deferReply();
76	}
77
78	if (!this.client.permissionManager.shouldModerate(member, message.member! as GuildMember)) {
79	await this.error(message, "You don't have permission to warn this user!");
80	return;
81	}
82
83	const reason = (context.isLegacy ? context.parsedNamedArgs.reason : context.options.getString("reason")) ?? undefined;
84
85	const { id, result } = await this.client.infractionManager.createMemberWarn(member, {
86	guild: message.guild!,
87	moderator: message.member!.user as User,
88	notifyUser: true,
89	reason,
90	sendLog: true
91	});
92
93	await this.deferredReply(message, {
94	embeds: [
95	await createModerationEmbed({
96	user: member.user,
97	description: `${escapeMarkdown(member.user.tag)} has been warned.${
98	result === false
99	? "\nFailed to deliver a DM to the user, and the fallback channel could not be created. The user will not know about this warning."
100	: result === null
101	? "\nCould not deliver a DM since the user is not in the server. They will not know about this warning"
102	: ""
103	}`,
104	actionDoneName: "warned",
105	id,
106	reason
107	})
108	]
109	});
110	}
111	}