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],
            minValue: 1,
            minMaxErrorMessage: "Please specify a valid time interval!",
            requiredErrorMessage: "Please specify after how long I should remind you!",
            typeErrorMessage: "Please specify a valid time interval!",
            timeMilliseconds: true,
            name: "time_interval"
        },
        {
            types: [ArgumentType.StringRest],
            optional: true,
            typeErrorMessage: "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	rakinar2	577	/**
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			minValue: 1,
33			minMaxErrorMessage: "Please specify a valid time interval!",
34			requiredErrorMessage: "Please specify after how long I should remind you!",
35			typeErrorMessage: "Please specify a valid time interval!",
36			timeMilliseconds: true,
37			name: "time_interval"
38			},
39			{
40			types: [ArgumentType.StringRest],
41			optional: true,
42			typeErrorMessage: "Please specify a valid reminder message!",
43			name: "message"
44			}
45			];
46			public readonly permissions = [];
47			public readonly description = "Set a reminder.";
48			public readonly detailedDescription = "Sets a reminder. The bot will remind you after the specified time interval.";
49			public readonly argumentSyntaxes = ["<time_interval> [reason]"];
50			public readonly slashCommandBuilder = new SlashCommandBuilder()
51			.addStringOption(option =>
52			option.setName("time_interval").setDescription("Specify the time after the bot should remind you").setRequired(true)
53			)
54			.addStringOption(option => option.setName("message").setDescription("The reminder message"));
55
56			async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
57			let timeInterval = context.isLegacy
58			? context.parsedNamedArgs.time_interval
59			: context.options.getString("time_interval", true);
60
61			if (!context.isLegacy) {
62			const { error, result } = stringToTimeInterval(timeInterval, {
63			milliseconds: true
64			});
65
66			if (error) {
67			await this.error(message, error);
68			return;
69			}
70
71			timeInterval = result;
72			}
73
74			const reminderMessage: string \| undefined = context.isLegacy
75			? context.parsedNamedArgs.message
76			: context.options.getString("message");
77
78			await this.client.queueManager.add(
79			new QueueEntry({
80			args: [message.member!.user.id, reminderMessage ?? ""],
81			client: this.client,
82			createdAt: new Date(),
83			filePath: path.resolve(__dirname, "../../queues/ReminderQueue"),
84			guild: message.guild!,
85			name: "ReminderQueue",
86			userId: message.member!.user.id,
87			willRunAt: new Date(Date.now() + timeInterval)
88			})
89			);
90
91			await this.success(
92			message,
93			`The system will remind you in ${formatDistanceToNowStrict(new Date(Date.now() - timeInterval))}.`
94			);
95			}
96			}