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