commands/automation/RemindCommand.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 { formatDistanceToNowStrict } from "date-fns";
import { SlashCommandBuilder } 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";

export default class RemindCommand extends Command {
    public readonly name = "remind";
    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 I should remind you!",
                "type:invalid": "Please specify a valid time interval!",
            },
            time: {
                unit: 'ms'
            },
            name: "time_interval"
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            errors: {
                "type:invalid": "Please specify a valid reminder message!",
            },
            name: "message"
        }
    ];
    public readonly permissions = [];
    public readonly description = "Set a reminder.";
    public readonly detailedDescription = "Sets a reminder. The bot will remind you after the specified time interval.";
    public readonly argumentSyntaxes = ["<time_interval> [reason]"];
    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addStringOption(option =>
            option.setName("time_interval").setDescription("Specify the time after the bot should remind you").setRequired(true)
        )
        .addStringOption(option => option.setName("message").setDescription("The reminder message"));

    async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
        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 reminderMessage: string | undefined = context.isLegacy
            ? context.parsedNamedArgs.message
            : context.options.getString("message");

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

        await this.success(
            message,
            `The system will remind you in ${formatDistanceToNowStrict(new Date(Date.now() - timeInterval))}.`
        );
    }
}
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 { formatDistanceToNowStrict } from "date-fns";
21	import { SlashCommandBuilder } from "discord.js";
22	import path from "path";
23	import Command, { ArgumentType, BasicCommandContext, CommandMessage, CommandReturn, ValidationRule } from "../../core/Command";
24	import QueueEntry from "../../utils/QueueEntry";
25	import { stringToTimeInterval } from "../../utils/datetime";
26
27	export default class RemindCommand extends Command {
28	public readonly name = "remind";
29	public readonly validationRules: ValidationRule[] = [
30	{
31	types: [ArgumentType.TimeInterval],
32	number: {
33	min: 1
34	},
35	errors: {
36	"number:range:min": "Please specify a valid time interval!",
37	required: "Please specify after how long I should remind you!",
38	"type:invalid": "Please specify a valid time interval!",
39	},
40	time: {
41	unit: 'ms'
42	},
43	name: "time_interval"
44	},
45	{
46	types: [ArgumentType.StringRest],
47	optional: true,
48	errors: {
49	"type:invalid": "Please specify a valid reminder message!",
50	},
51	name: "message"
52	}
53	];
54	public readonly permissions = [];
55	public readonly description = "Set a reminder.";
56	public readonly detailedDescription = "Sets a reminder. The bot will remind you after the specified time interval.";
57	public readonly argumentSyntaxes = ["<time_interval> [reason]"];
58	public readonly slashCommandBuilder = new SlashCommandBuilder()
59	.addStringOption(option =>
60	option.setName("time_interval").setDescription("Specify the time after the bot should remind you").setRequired(true)
61	)
62	.addStringOption(option => option.setName("message").setDescription("The reminder message"));
63
64	async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
65	let timeInterval = context.isLegacy
66	? context.parsedNamedArgs.time_interval
67	: context.options.getString("time_interval", true);
68
69	if (!context.isLegacy) {
70	const { error, result } = stringToTimeInterval(timeInterval, {
71	milliseconds: true
72	});
73
74	if (error) {
75	await this.error(message, error);
76	return;
77	}
78
79	timeInterval = result;
80	}
81
82	const reminderMessage: string \| undefined = context.isLegacy
83	? context.parsedNamedArgs.message
84	: context.options.getString("message");
85
86	await this.client.queueManager.add(
87	new QueueEntry({
88	args: [message.member!.user.id, reminderMessage ?? ""],
89	client: this.client,
90	createdAt: new Date(),
91	filePath: path.resolve(__dirname, "../../queues/ReminderQueue"),
92	guild: message.guild!,
93	name: "ReminderQueue",
94	userId: message.member!.user.id,
95	willRunAt: new Date(Date.now() + timeInterval)
96	})
97	);
98
99	await this.success(
100	message,
101	`The system will remind you in ${formatDistanceToNowStrict(new Date(Date.now() - timeInterval))}.`
102	);
103	}
104	}