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.Member],
            entity: true,
            errors: {
                required: "You must specify a member to warn!",
                "type:invalid": "You have specified an invalid user mention or ID.",
                "entity:null": "The given member does not exist in the server!"
            },
            name: "member"
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            errors: {
                "string:rest:length:max": "The reason must be less than 4000 characters long."
            },
            string: {
                maxLength: 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 (!(await 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({
                        moderator: message.member!.user as User,
                        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
                    })
                ]
            },
            "auto"
        );
    }
}
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.Member],
36	entity: true,
37	errors: {
38	required: "You must specify a member to warn!",
39	"type:invalid": "You have specified an invalid user mention or ID.",
40	"entity:null": "The given member does not exist in the server!"
41	},
42	name: "member"
43	},
44	{
45	types: [ArgumentType.StringRest],
46	optional: true,
47	errors: {
48	"string:rest:length:max": "The reason must be less than 4000 characters long."
49	},
50	string: {
51	maxLength: 3999
52	},
53	name: "reason"
54	}
55	];
56	public readonly permissions = [PermissionsBitField.Flags.ManageMessages];
57
58	public readonly description = "Warns a server member.";
59	public readonly detailedDescription = "This command warns a server member, by sending a DM to them.";
60	public readonly argumentSyntaxes = ["<UserID\|UserMention> [reason]"];
61
62	public readonly botRequiredPermissions = [PermissionsBitField.Flags.ManageMessages];
63
64	public readonly slashCommandBuilder = new SlashCommandBuilder()
65	.addUserOption(option => option.setName("member").setDescription("The member").setRequired(true))
66	.addStringOption(option => option.setName("reason").setDescription("The reason for warning this user"));
67
68	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
69	const member = context.isLegacy ? context.parsedNamedArgs.member : context.options.getMember("member");
70
71	if (!member) {
72	await message.reply({
73	ephemeral: true,
74	content: "The member is invalid or does not exist."
75	});
76
77	return;
78	}
79
80	if (message instanceof ChatInputCommandInteraction) {
81	await message.deferReply();
82	}
83
84	if (!(await this.client.permissionManager.shouldModerate(member, message.member! as GuildMember))) {
85	await this.error(message, "You don't have permission to warn this user!");
86	return;
87	}
88
89	const reason = (context.isLegacy ? context.parsedNamedArgs.reason : context.options.getString("reason")) ?? undefined;
90
91	const { id, result } = await this.client.infractionManager.createMemberWarn(member, {
92	guild: message.guild!,
93	moderator: message.member!.user as User,
94	notifyUser: true,
95	reason,
96	sendLog: true
97	});
98
99	await this.deferredReply(
100	message,
101	{
102	embeds: [
103	await createModerationEmbed({
104	moderator: message.member!.user as User,
105	user: member.user,
106	description: `${escapeMarkdown(member.user.tag)} has been warned.${
107	result === false
108	? "\nFailed to deliver a DM to the user, and the fallback channel could not be created. The user will not know about this warning."
109	: result === null
110	? "\nCould not deliver a DM since the user is not in the server. They will not know about this warning"
111	: ""
112	}`,
113	actionDoneName: "warned",
114	id,
115	reason
116	})
117	]
118	},
119	"auto"
120	);
121	}
122	}