commands/tools/SnippetEditCommand.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 { Message, PermissionsBitField, PermissionsString } from "discord.js";
import Command, { ArgumentType, CommandReturn, ValidationRule } from "../../core/Command";
import { LegacyCommandContext } from "../../services/CommandManager";
import { logError } from "../../utils/logger";

export default class SnippetEditCommand extends Command {
    public readonly name = "snippet__edit";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.String],
            errors: {
                required: "Please specify the name of the snippet/tag to edit!",
                "type:invalid": "Please specify a valid snippet/tag name!"
            },
            name: "name"
        },
        {
            types: [ArgumentType.String],
            errors: {
                required:
                    "Please specify what to edit in the snippet! One of these can be specified: `level`, `permission` (`perm`), `content`",
                "type:invalid":
                    "Please specify a valid attribute of the snippet to edit! One of these can be specified: `level`, `permission` (`perm`), `content`"
            },
            name: "attr"
        }
    ];
    public readonly permissions = [
        PermissionsBitField.Flags.BanMembers,
        PermissionsBitField.Flags.KickMembers,
        PermissionsBitField.Flags.ManageGuild,
        PermissionsBitField.Flags.ModerateMembers,
        PermissionsBitField.Flags.ManageMessages
    ];
    public readonly permissionMode = "or";
    public readonly aliases: string[] = ["editsnippet", "snippetedit", "tagedit", "edittag", "updatetag"];
    public readonly beta: boolean = true;
    public readonly supportsInteractions = false;

    async execute(message: Message, context: LegacyCommandContext): Promise<CommandReturn> {
        if (!this.client.configManager.config[message.guildId!]) return;

        const name: string = context.parsedNamedArgs.name;

        if (!(await this.client.snippetManager.checkPermissionInSnippetCommands(name, message, this))) {
            return;
        }

        const index = name !== context.args[0] ? 1 : 0;

        if (!context.args[index + 1]) {
            await this.error(message, this.validationRules[1].errors?.required!);
            return;
        }

        const attrs = ["level", "permission", "perm", "content"] as const;

        if (!attrs.includes(context.args[index + 1]?.toLowerCase() as (typeof attrs)[number])) {
            await this.error(message, this.validationRules[1].errors?.["type:invalid"]!);
            return;
        }

        const attr = context.args[index + 1]?.toLowerCase() as (typeof attrs)[number];

        switch (attr) {
            case "level": {
                if (this.client.configManager.config[message.guildId!]?.permissions.mode !== "levels") {
                    await this.error(
                        message,
                        "This server does not use the level-based permission system. Please switch to the level-based system to set a permission level for this snippet. Alternatively, if you're using the named permission system, please edit the `permission` (or `perm`) attribute instead."
                    );
                    return;
                }

                if (!context.args[index + 2]) {
                    await this.error(message, "Please specify a permission level to set!");
                    return;
                }

                const level = parseInt(context.args[index + 2]);

                if (isNaN(level) || level < 0 || level > 100) {
                    await this.error(message, "Please specify a valid permission level (0-100) to set!");
                    return;
                }

                const { error } = await this.client.snippetManager.updateSnippet({
                    name,
                    guildId: message.guildId!,
                    level
                });

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

                await this.success(message, "Sucessfully updated snippet permission level.");
                break;
            }

            case "perm":
            case "permission": {
                if (!context.args[index + 2]) {
                    await this.error(message, "Please specify permission name(s) to require!");
                    return;
                }

                const permissionNames = context.args.slice(index + 2) as PermissionsString[];

                for (const name of permissionNames) {
                    try {
                        PermissionsBitField.resolve(name);
                    } catch (error) {
                        logError(error);
                        await this.error(message, `\`${name}\` is not a valid permission name!`);
                        return;
                    }
                }

                const { error } = await this.client.snippetManager.updateSnippet({
                    name,
                    guildId: message.guildId!,
                    permissions: permissionNames
                });

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

                await this.success(message, "Sucessfully updated snippet permissions.");
                break;
            }

            case "content": {
                if (!context.args[index + 2]) {
                    await this.error(message, "Please specify new content for the snippet!");
                    return;
                }

                const content = message.content
                    .slice(this.client.configManager.config[message.guildId!]!.prefix.length)
                    .trimStart()
                    .slice(context.argv[0].length)
                    .trimStart()
                    .slice(context.args[0].length)
                    .trimStart()
                    .slice(context.args[1].length)
                    .trimStart()
                    .slice(index === 1 ? context.args[2].length : 0)
                    .trimStart();

                const { error } = await this.client.snippetManager.updateSnippet({
                    name,
                    guildId: message.guildId!,
                    content
                });

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

                await this.success(message, "Sucessfully updated snippet content.");
                break;
            }
        }
    }
}
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 { Message, PermissionsBitField, PermissionsString } from "discord.js";
21	import Command, { ArgumentType, CommandReturn, ValidationRule } from "../../core/Command";
22	import { LegacyCommandContext } from "../../services/CommandManager";
23	import { logError } from "../../utils/logger";
24
25	export default class SnippetEditCommand extends Command {
26	public readonly name = "snippet__edit";
27	public readonly validationRules: ValidationRule[] = [
28	{
29	types: [ArgumentType.String],
30	errors: {
31	required: "Please specify the name of the snippet/tag to edit!",
32	"type:invalid": "Please specify a valid snippet/tag name!"
33	},
34	name: "name"
35	},
36	{
37	types: [ArgumentType.String],
38	errors: {
39	required:
40	"Please specify what to edit in the snippet! One of these can be specified: `level`, `permission` (`perm`), `content`",
41	"type:invalid":
42	"Please specify a valid attribute of the snippet to edit! One of these can be specified: `level`, `permission` (`perm`), `content`"
43	},
44	name: "attr"
45	}
46	];
47	public readonly permissions = [
48	PermissionsBitField.Flags.BanMembers,
49	PermissionsBitField.Flags.KickMembers,
50	PermissionsBitField.Flags.ManageGuild,
51	PermissionsBitField.Flags.ModerateMembers,
52	PermissionsBitField.Flags.ManageMessages
53	];
54	public readonly permissionMode = "or";
55	public readonly aliases: string[] = ["editsnippet", "snippetedit", "tagedit", "edittag", "updatetag"];
56	public readonly beta: boolean = true;
57	public readonly supportsInteractions = false;
58
59	async execute(message: Message, context: LegacyCommandContext): Promise<CommandReturn> {
60	if (!this.client.configManager.config[message.guildId!]) return;
61
62	const name: string = context.parsedNamedArgs.name;
63
64	if (!(await this.client.snippetManager.checkPermissionInSnippetCommands(name, message, this))) {
65	return;
66	}
67
68	const index = name !== context.args[0] ? 1 : 0;
69
70	if (!context.args[index + 1]) {
71	await this.error(message, this.validationRules[1].errors?.required!);
72	return;
73	}
74
75	const attrs = ["level", "permission", "perm", "content"] as const;
76
77	if (!attrs.includes(context.args[index + 1]?.toLowerCase() as (typeof attrs)[number])) {
78	await this.error(message, this.validationRules[1].errors?.["type:invalid"]!);
79	return;
80	}
81
82	const attr = context.args[index + 1]?.toLowerCase() as (typeof attrs)[number];
83
84	switch (attr) {
85	case "level": {
86	if (this.client.configManager.config[message.guildId!]?.permissions.mode !== "levels") {
87	await this.error(
88	message,
89	"This server does not use the level-based permission system. Please switch to the level-based system to set a permission level for this snippet. Alternatively, if you're using the named permission system, please edit the `permission` (or `perm`) attribute instead."
90	);
91	return;
92	}
93
94	if (!context.args[index + 2]) {
95	await this.error(message, "Please specify a permission level to set!");
96	return;
97	}
98
99	const level = parseInt(context.args[index + 2]);
100
101	if (isNaN(level) \|\| level < 0 \|\| level > 100) {
102	await this.error(message, "Please specify a valid permission level (0-100) to set!");
103	return;
104	}
105
106	const { error } = await this.client.snippetManager.updateSnippet({
107	name,
108	guildId: message.guildId!,
109	level
110	});
111
112	if (error) {
113	await this.error(message, error);
114	return;
115	}
116
117	await this.success(message, "Sucessfully updated snippet permission level.");
118	break;
119	}
120
121	case "perm":
122	case "permission": {
123	if (!context.args[index + 2]) {
124	await this.error(message, "Please specify permission name(s) to require!");
125	return;
126	}
127
128	const permissionNames = context.args.slice(index + 2) as PermissionsString[];
129
130	for (const name of permissionNames) {
131	try {
132	PermissionsBitField.resolve(name);
133	} catch (error) {
134	logError(error);
135	await this.error(message, `\`${name}\` is not a valid permission name!`);
136	return;
137	}
138	}
139
140	const { error } = await this.client.snippetManager.updateSnippet({
141	name,
142	guildId: message.guildId!,
143	permissions: permissionNames
144	});
145
146	if (error) {
147	await this.error(message, error);
148	return;
149	}
150
151	await this.success(message, "Sucessfully updated snippet permissions.");
152	break;
153	}
154
155	case "content": {
156	if (!context.args[index + 2]) {
157	await this.error(message, "Please specify new content for the snippet!");
158	return;
159	}
160
161	const content = message.content
162	.slice(this.client.configManager.config[message.guildId!]!.prefix.length)
163	.trimStart()
164	.slice(context.argv[0].length)
165	.trimStart()
166	.slice(context.args[0].length)
167	.trimStart()
168	.slice(context.args[1].length)
169	.trimStart()
170	.slice(index === 1 ? context.args[2].length : 0)
171	.trimStart();
172
173	const { error } = await this.client.snippetManager.updateSnippet({
174	name,
175	guildId: message.guildId!,
176	content
177	});
178
179	if (error) {
180	await this.error(message, error);
181	return;
182	}
183
184	await this.success(message, "Sucessfully updated snippet content.");
185	break;
186	}
187	}
188	}
189	}