commands/automation/TempRoleCommand.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 { GuildMember, PermissionsBitField, Role, SlashCommandBuilder, time } 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 TempRoleCommand extends Command {
    public readonly name = "temprole";
    public readonly validationRules: ValidationRule[] = [
        {
            types: [ArgumentType.TimeInterval],
            name: "duration",
            errors: {
                required: "Please provide a duration and a role!",
                "type:invalid": "You've specified an invalid duration."
            },
            time: {
                unit: "ms"
            }
        },
        {
            types: [ArgumentType.Member],
            entity: {
                notNull: true
            },
            name: "member",
            errors: {
                "entity:null": "That member does not exist!",
                required: "Please provide a target member!",
                "type:invalid": "You've specified an invalid member."
            }
        },
        {
            types: [ArgumentType.Role],
            entity: {
                notNull: true
            },
            name: "role",
            errors: {
                "entity:null": "That role does not exist!",
                required: "Please provide a target role!",
                "type:invalid": "You've specified an invalid role."
            }
        },
        {
            types: [ArgumentType.TimeInterval],
            name: "offset",
            errors: {
                required: "Please provide a valid offset duration!",
                "type:invalid": "You've specified an invalid offset duration."
            },
            time: {
                unit: "ms"
            },
            optional: true,
            default: 0
        }
    ];
    public readonly permissions = [PermissionsBitField.Flags.ManageRoles];
    public readonly slashCommandBuilder = new SlashCommandBuilder()
        .addUserOption(option => option.setName("member").setDescription("The target member").setRequired(true))
        .addRoleOption(option => option.setName("role").setDescription("The target role to give").setRequired(true))
        .addStringOption(option =>
            option.setName("duration").setDescription("The duration after the system should revoke the role").setRequired(true)
        )
        .addStringOption(option =>
            option.setName("start_after").setDescription("The offset duration after the system should assign the role")
        );
    public readonly description = "Temporarily give a role to a member";
    public readonly since = "6.25.2";

    async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
        await this.deferIfInteraction(message);
        const member: GuildMember = context.isLegacy ? context.parsedNamedArgs.member : context.options.getMember("member");

        if (!member) {
            await this.error(message, "Invalid member specified!");
            return;
        }

        const role: Role = context.isLegacy ? context.parsedNamedArgs.role : context.options.getRole("role", true);

        let duration: number | ReturnType<typeof stringToTimeInterval> = context.isLegacy
            ? context.parsedNamedArgs.duration ?? 0
            : stringToTimeInterval(context.options.getString("duration", true), {
                  milliseconds: true
              });

        let offset: number | ReturnType<typeof stringToTimeInterval> = context.isLegacy
            ? context.parsedNamedArgs.offset ?? 0
            : stringToTimeInterval(context.options.getString("start_after") ?? "0s", {
                  milliseconds: true
              });

        if (typeof duration === "object") {
            if (duration.error) {
                await this.error(message, `Invalid duration specified!\nDescription: ${duration.error}`);
                return;
            }

            duration = duration.result;
        }

        if (typeof offset === "object") {
            if (offset.error) {
                await this.error(message, `Invalid time offset specified!\nDescription: ${offset.error}`);
                return;
            }

            offset = offset.result;
        }

        const totalDuration = (offset as number) + (duration as number);

        if (offset === 0) {
            await member.roles.add(role, "Adding role to member as the I was commanded to do so");
        } else {
            await this.client.queueManager.add(
                new QueueEntry({
                    args: [message.member!.user.id, role.id],
                    client: this.client,
                    createdAt: new Date(),
                    filePath: path.resolve(__dirname, "../../queues/TempRoleAddQueue"),
                    guild: message.guild!,
                    name: "TempRoleAddQueue",
                    userId: message.member!.user.id,
                    willRunAt: new Date((Date.now() + offset) as number)
                })
            );
        }

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

        await this.success(
            message,
            `Successfully ${
                offset === 0 ? "added the given role to the member" : "queued a job to add the role to the member"
            }. I'll take away the role ${time(new Date(Date.now() + totalDuration), "R")}.`
        );
    }
}
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 { GuildMember, PermissionsBitField, Role, SlashCommandBuilder, time } 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
26			export default class TempRoleCommand extends Command {
27			public readonly name = "temprole";
28			public readonly validationRules: ValidationRule[] = [
29			{
30			types: [ArgumentType.TimeInterval],
31			name: "duration",
32			errors: {
33			required: "Please provide a duration and a role!",
34			"type:invalid": "You've specified an invalid duration."
35			},
36			time: {
37			unit: "ms"
38			}
39			},
40			{
41			types: [ArgumentType.Member],
42			entity: {
43			notNull: true
44			},
45			name: "member",
46			errors: {
47			"entity:null": "That member does not exist!",
48			required: "Please provide a target member!",
49			"type:invalid": "You've specified an invalid member."
50			}
51			},
52			{
53			types: [ArgumentType.Role],
54			entity: {
55			notNull: true
56			},
57			name: "role",
58			errors: {
59			"entity:null": "That role does not exist!",
60			required: "Please provide a target role!",
61			"type:invalid": "You've specified an invalid role."
62			}
63			},
64			{
65			types: [ArgumentType.TimeInterval],
66			name: "offset",
67			errors: {
68			required: "Please provide a valid offset duration!",
69			"type:invalid": "You've specified an invalid offset duration."
70			},
71			time: {
72			unit: "ms"
73			},
74			optional: true,
75			default: 0
76			}
77			];
78			public readonly permissions = [PermissionsBitField.Flags.ManageRoles];
79			public readonly slashCommandBuilder = new SlashCommandBuilder()
80			.addUserOption(option => option.setName("member").setDescription("The target member").setRequired(true))
81			.addRoleOption(option => option.setName("role").setDescription("The target role to give").setRequired(true))
82			.addStringOption(option =>
83			option.setName("duration").setDescription("The duration after the system should revoke the role").setRequired(true)
84			)
85			.addStringOption(option =>
86			option.setName("start_after").setDescription("The offset duration after the system should assign the role")
87			);
88			public readonly description = "Temporarily give a role to a member";
89			public readonly since = "6.25.2";
90
91			async execute(message: CommandMessage, context: BasicCommandContext): Promise<CommandReturn> {
92			await this.deferIfInteraction(message);
93			const member: GuildMember = context.isLegacy ? context.parsedNamedArgs.member : context.options.getMember("member");
94
95			if (!member) {
96			await this.error(message, "Invalid member specified!");
97			return;
98			}
99
100			const role: Role = context.isLegacy ? context.parsedNamedArgs.role : context.options.getRole("role", true);
101
102			let duration: number \| ReturnType<typeof stringToTimeInterval> = context.isLegacy
103			? context.parsedNamedArgs.duration ?? 0
104			: stringToTimeInterval(context.options.getString("duration", true), {
105			milliseconds: true
106			});
107
108			let offset: number \| ReturnType<typeof stringToTimeInterval> = context.isLegacy
109			? context.parsedNamedArgs.offset ?? 0
110			: stringToTimeInterval(context.options.getString("start_after") ?? "0s", {
111			milliseconds: true
112			});
113
114			if (typeof duration === "object") {
115			if (duration.error) {
116			await this.error(message, `Invalid duration specified!\nDescription: ${duration.error}`);
117			return;
118			}
119
120			duration = duration.result;
121			}
122
123			if (typeof offset === "object") {
124			if (offset.error) {
125			await this.error(message, `Invalid time offset specified!\nDescription: ${offset.error}`);
126			return;
127			}
128
129			offset = offset.result;
130			}
131
132			const totalDuration = (offset as number) + (duration as number);
133
134			if (offset === 0) {
135			await member.roles.add(role, "Adding role to member as the I was commanded to do so");
136			} else {
137			await this.client.queueManager.add(
138			new QueueEntry({
139			args: [message.member!.user.id, role.id],
140			client: this.client,
141			createdAt: new Date(),
142			filePath: path.resolve(__dirname, "../../queues/TempRoleAddQueue"),
143			guild: message.guild!,
144			name: "TempRoleAddQueue",
145			userId: message.member!.user.id,
146			willRunAt: new Date((Date.now() + offset) as number)
147			})
148			);
149			}
150
151			await this.client.queueManager.add(
152			new QueueEntry({
153			args: [message.member!.user.id, role.id],
154			client: this.client,
155			createdAt: new Date(),
156			filePath: path.resolve(__dirname, "../../queues/TempRoleRemoveQueue"),
157			guild: message.guild!,
158			name: "TempRoleRemoveQueue",
159			userId: message.member!.user.id,
160			willRunAt: new Date(Date.now() + totalDuration)
161			})
162			);
163
164			await this.success(
165			message,
166			`Successfully ${
167			offset === 0 ? "added the given role to the member" : "queued a job to add the role to the member"
168			}. I'll take away the role ${time(new Date(Date.now() + totalDuration), "R")}.`
169			);
170			}
171			}