Add option for ping roles

Tibowl · Tibowl · commit 456f10c2519c · 2022-07-04T22:03:21.000+02:00
diff --git a/src/HuTaoClient.ts b/src/HuTaoClient.ts
@@ -59,6 +59,12 @@ export default class HuTaoClient extends Discord.Client {
                 stickers: filterAll,
                 users: filterAll
             },
+            allowedMentions: {
+                parse: [],
+                repliedUser: false,
+                roles: [],
+                users: []
+            },
             presence: {
                 status: "online",
                 activities: [{
diff --git a/src/commands/news/follow.ts b/src/commands/news/follow.ts
@@ -1,4 +1,5 @@
-import { CommandInteraction, Message } from "discord.js"
+import { APIInteractionDataResolvedGuildMember } from "discord-api-types/v10"
+import { CommandInteraction, Message, MessageMentions } from "discord.js"
 
 import config from "../../data/config.json"
 import client from "../../main"
@@ -38,7 +39,7 @@ export default class Follow extends Command {
         super({
             name,
             category: "News",
-            usage: `follow <list|add|remove> <${Object.keys(descriptions).join("|")}>\` or just \`follow list`,
+            usage: `follow <list|add|remove> <${Object.keys(descriptions).join("|")}> [pingRole, in the case of add]\` or just \`follow list`,
             help: `Follow certain events in a channel
 
 **Possible events**:
@@ -77,6 +78,10 @@ Example of adding news: \`${config.prefix}follow add news\``,
                             value: d
                         }
                     })
+                }, {
+                    name: "pingrole",
+                    description: "Role to ping",
+                    type: "MENTIONABLE"
                 }]
             }, {
                 name: "remove",
@@ -115,7 +120,7 @@ Example of adding news: \`${config.prefix}follow add news\``,
         if (sub == "list") {
             return this.runList(source, options.getString("category") as (FollowCategory | null))
         } else if (sub == "add") {
-            return this.runFollow(source, options.getString("category", true) as FollowCategory)
+            return this.runFollow(source, options.getString("category", true) as FollowCategory, options.getMentionable("pingrole", false))
         } else if (sub == "remove") {
             return this.runUnfollow(source, options.getString("category", true) as FollowCategory)
         }
@@ -132,6 +137,7 @@ Example of adding news: \`${config.prefix}follow add news\``,
         const sub = args[0]?.toLowerCase() ?? "help"
         args.shift()
         const otherArgs = args[0]?.toLowerCase()
+        args.shift()
 
         const category: FollowCategory | undefined = otherArgs ? Object.keys(descriptions).find(r => r.toLowerCase() == otherArgs) as (FollowCategory | undefined) : undefined
         if (!category)
@@ -145,7 +151,7 @@ Example of adding news: \`${config.prefix}follow add news\``,
         if (["list", "l"].includes(sub)) {
             return this.runList(source, category)
         } else if (["add", "a", "follow", "enable", "on"].includes(sub)) {
-            return this.runFollow(source, category)
+            return this.runFollow(source, category, args[0])
         } else if (["remove", "delete", "d", "r", "disable", "off", "unfollow"].includes(sub)) {
             return this.runUnfollow(source, category)
         } else {
@@ -162,14 +168,15 @@ Example of adding news: \`${config.prefix}follow add news\``,
         if (!category) {
             const following = followManager.following(source.guild)
 
-            const channels: {category: string, channelname: string}[] = []
+            const channels: {category: string, channelname: string, pingRole: string}[] = []
             for (const follow of following)
                 try {
                     const channel = await client.channels.fetch(follow.channelID)
                     if (isNewsable(channel))
                         channels.push({
                             channelname: channel.name,
-                            category: follow.category
+                            category: follow.category,
+                            pingRole: follow.pingRole
                         })
                 } catch (error) {
                     followManager.dropChannel(follow.channelID)
@@ -178,9 +185,9 @@ Example of adding news: \`${config.prefix}follow add news\``,
 
             return sendMessage(source, `Following per event: \`\`\`
 ${createTable(
-        ["Event", "|", "Channel"],
+        ["Event", "|", "Channel", "|", "Ping role ID"],
         channels.map(
-            k => [k.category, "|", k.channelname]
+            k => [k.category, "|", k.channelname, "|", k.pingRole]
         ))}\`\`\``, undefined, true)
         }
 
@@ -209,15 +216,33 @@ ${createTable(
 
         return sendMessage(source, `Unfollowed ${category} in <#${channel.id}>`, undefined, true)
     }
-    async runFollow(source: CommandSource, category: FollowCategory): Promise<SendMessage | undefined> {
+    async runFollow(source: CommandSource, category: FollowCategory, pingRole: string | { id: string } | APIInteractionDataResolvedGuildMember | null): Promise<SendMessage | undefined> {
         const channel = await source.channel?.fetch()
         if (!channel || !isNewsable(channel) || source.guild == null)
             return sendMessage(source, "Unable to follow in this channel", undefined, true)
 
+        let pingedRole = ""
+        if (typeof pingRole == "string") {
+            if (pingRole.match(/^\d+$/))
+                pingedRole = pingRole
+            else {
+                const response = MessageMentions.ROLES_PATTERN.exec(pingRole)
+                if (response == null)
+                    return sendMessage(source, "Unable to extract ping role from message", undefined, true)
+                pingedRole = response[1]
+            }
+        } else if ((pingRole as {id: string})?.id) {
+            const role = await source.guild.roles.fetch((pingRole as {id: string}).id)
+            if (!role)
+                return sendMessage(source, "Unable to extract ping role from command", undefined, true)
+            pingedRole = role.id
+        } else if (pingRole)
+            return sendMessage(source, "Unable to extract ping role from command", undefined, true)
+
         const { followManager } = client
 
-        followManager.addFollow(source.guild, channel, category, getUserID(source))
+        followManager.addFollow(source.guild, channel, category, getUserID(source), pingedRole)
 
-        return sendMessage(source, `Now following ${category} in <#${channel.id}>`, undefined, true)
+        return sendMessage(source, `Now following ${category} in <#${channel.id}> (Ping role: ${pingedRole == "" ? "none" : `<@&${pingedRole}> - make sure the bot can ping this role - this might require the @everyone permission!`})`, undefined, true)
     }
 }
diff --git a/src/utils/FollowManager.ts b/src/utils/FollowManager.ts
@@ -19,32 +19,39 @@ export default class FollowManager {
         process.on("SIGINT", () => process.exit(128 + 2))
         process.on("SIGTERM", () => process.exit(128 + 15))
 
-        this.sql.exec("CREATE TABLE IF NOT EXISTS follows (guildID TEXT, channelID TEXT, category TEXT, addedOn BIGINT, addedBy TEXT, PRIMARY KEY (channelID, category))")
+        this.sql.exec("CREATE TABLE IF NOT EXISTS follows (guildID TEXT, channelID TEXT, category TEXT, addedOn BIGINT, addedBy TEXT, pingRole TEXT DEFAULT '', PRIMARY KEY (channelID, category))")
         this.sql.exec("CREATE INDEX IF NOT EXISTS follows_category ON follows (category)")
         this.sql.exec("CREATE INDEX IF NOT EXISTS follows_channelID ON follows (channelID)")
         this.sql.exec("CREATE INDEX IF NOT EXISTS follows_guildID ON follows (guildID)")
+        try {
+            this.sql.exec("ALTER TABLE follows ADD COLUMN pingRole TEXT DEFAULT ''")
+            Logger.debug("Table migrated for ping roles")
+        } catch (error) {
+            void 0
+        }
 
-        this.addFollowStatement = this.sql.prepare("INSERT OR REPLACE INTO follows VALUES (@guildID, @channelID, @category, @addedOn, @addedBy)")
+        this.addFollowStatement = this.sql.prepare("INSERT OR REPLACE INTO follows VALUES (@guildID, @channelID, @category, @addedOn, @addedBy, @pingRole)")
 
         this.getFollowsStatement = this.sql.prepare("SELECT * FROM follows WHERE category = @category AND channelID = @channelID")
         this.getFollowsInChannelStatement = this.sql.prepare("SELECT * FROM follows WHERE channelID = @channelID")
-        this.followingStatement = this.sql.prepare("SELECT category, channelID FROM follows WHERE guildID = @guildID GROUP BY category, channelID")
-        this.getFollowersStatement = this.sql.prepare("SELECT channelID FROM follows WHERE category = @category")
-        this.followsStatement = this.sql.prepare("SELECT channelID FROM follows WHERE category = @category AND channelID = @channelID")
+        this.followingStatement = this.sql.prepare("SELECT category, channelID, pingRole FROM follows WHERE guildID = @guildID GROUP BY category, channelID")
+        this.getFollowersStatement = this.sql.prepare("SELECT channelID, pingRole FROM follows WHERE category = @category")
+        this.followsStatement = this.sql.prepare("SELECT channelID, pingRole FROM follows WHERE category = @category AND channelID = @channelID")
 
         this.unfollowsStatement = this.sql.prepare("DELETE FROM follows WHERE category = @category AND channelID = @channelID")
         this.dropChannelStatement = this.sql.prepare("DELETE FROM follows WHERE channelID = @channelID")
         this.dropGuildStatement = this.sql.prepare("DELETE FROM follows WHERE guildID = @guildID")
     }
 
     private addFollowStatement: SQLite.Statement
-    addFollow(guild: Guild, channel: Channel, category: FollowCategory, addedBy: string): void {
-        Logger.info(`Following in ${category} for ${addedBy} in ${channel.id} in ${guild.name} (${guild.id})`)
+    addFollow(guild: Guild, channel: Channel, category: FollowCategory, addedBy: string, pingRole: string): void {
+        Logger.info(`Following in ${category} for ${addedBy} in ${channel.id} in ${guild.name} (${guild.id}) - PingRole: ${pingRole}`)
         this.addFollowStatement.run({
             guildID: guild.id,
             channelID: channel.id,
             category,
             addedOn: new Date().getTime(),
+            pingRole,
             addedBy
         })
     }
@@ -62,7 +69,7 @@ export default class FollowManager {
     }
 
     private getFollowersStatement: SQLite.Statement
-    getFollowers(category: string): { channelID: Snowflake }[] {
+    getFollowers(category: string): { channelID: Snowflake, pingRole: Snowflake }[] {
         return this.getFollowersStatement.all({
             category
         })
@@ -103,15 +110,15 @@ export default class FollowManager {
     }
 
     private followingStatement: SQLite.Statement
-    following(guild: Guild): { category: FollowCategory, channelID: Snowflake }[] {
+    following(guild: Guild): { category: FollowCategory, channelID: Snowflake, pingRole: Snowflake }[] {
         return this.followingStatement.all({
             guildID: guild.id
         })
     }
 
     async send(category: FollowCategory, content?: string, embed?: MessageEmbed): Promise<(Message | Message[])[]> {
-        let channels = this.getFollowers(category).map(k => k.channelID)
-        channels = channels.filter((val, ind) => channels.indexOf(val) === ind)
+        let channels = this.getFollowers(category)
+        channels = channels.filter((val, ind) => channels.findIndex(v => v.channelID == val.channelID) === ind)
 
         Logger.info(`Sending ${category} to ${channels.length} channels: ${content}`)
         const messages = (await sendToChannels(channels, content, embed)).filter((x): x is PromiseFulfilledResult<Message | Message[]> => x.status == "fulfilled").map(x => x.value).flat()
diff --git a/src/utils/Types.ts b/src/utils/Types.ts
@@ -32,6 +32,7 @@ export interface Follower {
     category: FollowCategory
     addedOn: number
     addedBy: string
+    pingRole: string
 }
 
 // Reminder stuff
diff --git a/src/utils/Utils.ts b/src/utils/Utils.ts
@@ -13,17 +13,21 @@ const Logger = log4js.getLogger("Utils")
  * @param embed Possible embed/attachment to send
  * @returns All the messages send
  */
-export async function sendToChannels(channels: Snowflake[] | undefined, content?: string, embed?: MessageEmbed): Promise<PromiseSettledResult<Message | Message[]>[]> {
+export async function sendToChannels(channels: {channelID: Snowflake, pingRole?: string}[] | undefined, content?: string, embed?: MessageEmbed): Promise<PromiseSettledResult<Message | Message[]>[]> {
     const messages = []
     if (!channels) return Promise.all([])
 
     for (const channel of channels) {
         try {
-            const chanObj = await client.channels.fetch(channel)
+            const chanObj = await client.channels.fetch(channel.channelID)
             if (!(chanObj && chanObj.isText()))
                 continue
-            if (embed && content && content.length > 0)
-                messages.push(chanObj.send({ content, embeds: [embed] }))
+            if (embed && ((content && content.length > 0) || (channel.pingRole && channel.pingRole.length > 0)))
+                messages.push(chanObj.send({
+                    content: `${channel.pingRole && channel.pingRole != "" ? `<@&${channel.pingRole}> ` : ""}${content ?? ""}`.trim(),
+                    embeds: [embed],
+                    allowedMentions: { roles: channel.pingRole ? [channel.pingRole] : [] }
+                }))
             else if (embed)
                 messages.push(chanObj.send({ embeds: [embed] }))
             else if (content)
@@ -44,7 +48,7 @@ export async function sendToChannels(channels: Snowflake[] | undefined, content?
  */
 export async function sendError(content: string, embed?: MessageEmbed): Promise<Message[]> {
     Logger.error(content)
-    return (await sendToChannels(config.errorLog as Snowflake[], content, embed)).filter((x): x is PromiseFulfilledResult<Message | Message[]> => x.status == "fulfilled").map(x => x.value).flat()
+    return (await sendToChannels((config.errorLog as Snowflake[]).map(x => ({ channelID: x })), content, embed)).filter((x): x is PromiseFulfilledResult<Message | Message[]> => x.status == "fulfilled").map(x => x.value).flat()
 }
 
 export const PAD_START = 0

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ export interface Follower {`
`32`	`32`	`category: FollowCategory`
`33`	`33`	`addedOn: number`
`34`	`34`	`addedBy: string`
	`35`	`+ pingRole: string`
`35`	`36`	`}`
`36`	`37`
`37`	`38`	`// Reminder stuff`