commands/automation/ExpireCommand.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, SlashCommandBuilder, TextBasedChannel } from "discord.js";
import path from "path";
import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
import QueueEntry from "../../utils/QueueEntry";
import { stringToTimeInterval } from "../../utils/datetime";
import { logError } from "../../utils/Logger";
import { getEmojiObject, isTextableChannel } from "../../utils/utils";

export default class ExpireCommand extends Command {
    public readonly name = "expire";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.TimeInterval],
            number: {
                min: 1
            },
            errors: {
                "number:range:min": "Please specify a valid time interval!",
                required: "Please specify after how long the message will expire!",
                "type:invalid": "Please specify a valid time interval!"
            },
            time: {
                unit: "ms"
            },
            name: "time_interval"
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            errors: {
                required: "Please specify a message content!",
                "type:invalid": "Please specify a valid message content!"
            },
            name: "content"
        }
    ];
    public readonly permissions = [PermissionsBitField.Flags.ManageMessages];

    public readonly description = "Sends a message and deletes it after the given timeframe.";
    public readonly argumentSyntaxes = ["<time_interval> [content]"];
    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addStringOption(option => option.setName("content").setDescription("The message content").setRequired(true))
        .addStringOption(option =>
            option
                .setName("time_interval")
                .setDescription("Specify the time after the bot should remove the message")
                .setRequired(true)
        )
        .addChannelOption(option =>
            option
                .setName("channel")
                .setDescription("The channel where the message will be sent, defaults to the current channel")
        );

    async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
        await this.deferIfInteraction(message);

        let timeInterval = context.isLegacy
            ? context.parsedNamedArgs.time_interval
            : context.options.getString("time_interval", true);

        if (!context.isLegacy) {
            const { error, result } = stringToTimeInterval(timeInterval, {
                milliseconds: true
            });

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

            timeInterval = result;
        }

        const content: string | undefined = context.isLegacy
            ? context.parsedNamedArgs.content
            : context.options.getString("content");
        const channel = (
            context.isLegacy ? message.channel! : context.options.getChannel("channel") ?? message.channel!
        ) as TextBasedChannel;

        if (!isTextableChannel(channel)) {
            await this.error(message, "Cannot send messages to a non-text based channel!");
            return;
        }

        try {
            const sentMessage = await message.channel!.send({
                content
            });

            await this.client.queueManager.add(
                new QueueEntry({
                    args: [channel.id, sentMessage.id],
                    client: this.client,
                    createdAt: new Date(),
                    filePath: path.resolve(__dirname, "../../queues/ExpireMessageQueue"),
                    guild: message.guild!,
                    name: "ExpireMessageQueue",
                    userId: message.member!.user.id,
                    willRunAt: new Date(Date.now() + timeInterval)
                })
            );

            if (message instanceof Message) {
                await message.react(getEmojiObject(this.client, "check") ?? "✅").catch(logError);
            } else {
                await this.success(message, "Successfully queued message deletion.");
            }
        } catch (e) {
            logError(e);
            await this.error(message, "Could not send message, make sure I have enough permissions.");
            return;
        }
    }
}
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, SlashCommandBuilder, TextBasedChannel } from "discord.js";
21	import path from "path";
22	import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
23	import QueueEntry from "../../utils/QueueEntry";
24	import { stringToTimeInterval } from "../../utils/datetime";
25	import { logError } from "../../utils/Logger";
26	import { getEmojiObject, isTextableChannel } from "../../utils/utils";
27
28	export default class ExpireCommand extends Command {
29	public readonly name = "expire";
30	public readonly validationRules: ValidationRule[] = [
31	{
32	types: [ArgumentType.TimeInterval],
33	number: {
34	min: 1
35	},
36	errors: {
37	"number:range:min": "Please specify a valid time interval!",
38	required: "Please specify after how long the message will expire!",
39	"type:invalid": "Please specify a valid time interval!"
40	},
41	time: {
42	unit: "ms"
43	},
44	name: "time_interval"
45	},
46	{
47	types: [ArgumentType.StringRest],
48	optional: true,
49	errors: {
50	required: "Please specify a message content!",
51	"type:invalid": "Please specify a valid message content!"
52	},
53	name: "content"
54	}
55	];
56	public readonly permissions = [PermissionsBitField.Flags.ManageMessages];
57
58	public readonly description = "Sends a message and deletes it after the given timeframe.";
59	public readonly argumentSyntaxes = ["<time_interval> [content]"];
60	public readonly slashCommandBuilder = new SlashCommandBuilder()
61	.addStringOption(option => option.setName("content").setDescription("The message content").setRequired(true))
62	.addStringOption(option =>
63	option
64	.setName("time_interval")
65	.setDescription("Specify the time after the bot should remove the message")
66	.setRequired(true)
67	)
68	.addChannelOption(option =>
69	option
70	.setName("channel")
71	.setDescription("The channel where the message will be sent, defaults to the current channel")
72	);
73
74	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
75	await this.deferIfInteraction(message);
76
77	let timeInterval = context.isLegacy
78	? context.parsedNamedArgs.time_interval
79	: context.options.getString("time_interval", true);
80
81	if (!context.isLegacy) {
82	const { error, result } = stringToTimeInterval(timeInterval, {
83	milliseconds: true
84	});
85
86	if (error) {
87	await this.error(message, error);
88	return;
89	}
90
91	timeInterval = result;
92	}
93
94	const content: string \| undefined = context.isLegacy
95	? context.parsedNamedArgs.content
96	: context.options.getString("content");
97	const channel = (
98	context.isLegacy ? message.channel! : context.options.getChannel("channel") ?? message.channel!
99	) as TextBasedChannel;
100
101	if (!isTextableChannel(channel)) {
102	await this.error(message, "Cannot send messages to a non-text based channel!");
103	return;
104	}
105
106	try {
107	const sentMessage = await message.channel!.send({
108	content
109	});
110
111	await this.client.queueManager.add(
112	new QueueEntry({
113	args: [channel.id, sentMessage.id],
114	client: this.client,
115	createdAt: new Date(),
116	filePath: path.resolve(__dirname, "../../queues/ExpireMessageQueue"),
117	guild: message.guild!,
118	name: "ExpireMessageQueue",
119	userId: message.member!.user.id,
120	willRunAt: new Date(Date.now() + timeInterval)
121	})
122	);
123
124	if (message instanceof Message) {
125	await message.react(getEmojiObject(this.client, "check") ?? "✅").catch(logError);
126	} else {
127	await this.success(message, "Successfully queued message deletion.");
128	}
129	} catch (e) {
130	logError(e);
131	await this.error(message, "Could not send message, make sure I have enough permissions.");
132	return;
133	}
134	}
135	}