Configurable @room ping discord roles

src/db/migrations/0041-room-ping-role.sql

@@ -0,0 +1,5 @@
+BEGIN TRANSACTION;
+
+ALTER TABLE channel_room ADD COLUMN ping_role_id TEXT;
+
+COMMIT;

src/db/orm-defs.d.ts

@@ -21,6 +21,7 @@ export type Models = {
 		speedbump_checked: number | null
 		guild_id: string | null
 		custom_topic: number
+		ping_role_id: string | null
 	}
 
 	channel_speedbump: {

src/m2d/converters/event-to-message.js

@@ -460,14 +460,15 @@ async function handleRoomOrMessageLinks(input, di) {
 async function checkWrittenMentions(content, senderMxid, roomID, guild, di) {
 	let writtenMentionMatch = content.match(/(?:^|[^"[<>/A-Za-z0-9])@([A-Za-z][A-Za-z0-9._\[\]\(\)-]+):?/d) // /d flag for indices requires node.js 16+
 	if (writtenMentionMatch) {
-		if (writtenMentionMatch[1] === "room") { // convert @room to @everyone
+		if (writtenMentionMatch[1] === "room") { // convert @room to discord
 			const {powers: {[senderMxid]: userPower}, powerLevels} = await mxUtils.getEffectivePower(roomID, [senderMxid], di.api)
 			if (userPower >= (powerLevels.notifications?.room ?? 50)) {
+				const roleID = select("channel_room", "ping_role_id", {room_id: roomID}).pluck().get()
 				return {
 					// @ts-ignore - typescript doesn't know about indices yet
-					content: content.slice(0, writtenMentionMatch.indices[1][0]-1) + `@everyone` + content.slice(writtenMentionMatch.indices[1][1]),
+					content: content.slice(0, writtenMentionMatch.indices[1][0]-1) + (roleID ? `<@&${roleID}>` : "@everyone") + content.slice(writtenMentionMatch.indices[1][1]),
 					ensureJoined: [],
-					allowedMentionsParse: ["everyone"],
+					allowedMentionsParse: roleID ? [] : ["everyone"],
 					allowedMentionsUsers: []
 				}
 			}

src/m2d/converters/event-to-message.test.js

@@ -4,7 +4,7 @@ const DiscordTypes = require("discord-api-types/v10")
 const {eventToMessage} = require("./event-to-message")
 const data = require("../../../test/data")
 const {MatrixServerError} = require("../../matrix/mreq")
-const {select, discord} = require("../../passthrough")
+const {select, discord, db} = require("../../passthrough")
 
 /**
  * @param {string} roomID

src/web/pug/guild.pug

@@ -188,6 +188,56 @@ block body
               td(colspan="3")
                 .s-empty-state No channels linked between Discord and Matrix yet...
 
+  if space_id && linkedChannelsWithDetails.length
+    - const customPingRooms = linkedChannelsWithDetails.filter(row => row.ping_role_id)
+    - const defaultPingRooms = linkedChannelsWithDetails.filter(row => !row.ping_role_id)
+    - const pingRoles = [...guild.roles].filter(role => role.id !== guild_id).sort((a, b) => b.position - a.position)
+    h3.mt32.fs-category#room-notifications Room notifications
+    .s-card
+      p.s-description.mt0 Choose which Discord role receives Matrix @room notifications
+      each row in customPingRooms
+        .d-flex.ai-center.g16.mb8
+          label.s-label.fl-grow1(for="ping-role-" + row.channel.id)= "#" + row.channel.name
+          form(method="post" action=rel("/api/room-ping-role"))
+            input(type="hidden" name="guild_id" value=guild_id)
+            input(type="hidden" name="channel_id" value=row.channel.id)
+            .s-select
+              select(name="ping_role_id" id="ping-role-" + row.channel.id onchange="this.form.requestSubmit()")
+                if !pingRoles.some(role => role.id === row.ping_role_id)
+                  option(value=row.ping_role_id selected disabled) Deleted role (choose a replacement)
+                each role in pingRoles
+                  option(value=role.id selected=row.ping_role_id === role.id)= "@" + role.name
+            noscript
+              button.s-btn.s-btn__outlined.mt8(type="submit") Save
+          form(method="post" action=rel("/api/room-ping-role"))
+            input(type="hidden" name="guild_id" value=guild_id)
+            input(type="hidden" name="channel_id" value=row.channel.id)
+            input(type="hidden" name="ping_role_id" value="")
+            button.s-btn.s-btn__danger.s-btn__outlined(type="submit" aria-label="Remove custom role for #" + row.channel.name) Remove
+
+      if defaultPingRooms.length && pingRoles.length
+        details.mt16
+          summary.s-label.cursor-pointer Add custom role
+          form.mt12(method="post" action=rel("/api/room-ping-role"))
+            input(type="hidden" name="guild_id" value=guild_id)
+            .d-grid.grid__2.g8(class="sm:grid__1")
+              .wmn0
+                label.s-label(for="ping-role-channel") Channel
+                .s-select
+                  select.w100.box-border#ping-role-channel(name="channel_id" required)
+                    option(value="" selected disabled) Choose a channel
+                    each row in defaultPingRooms
+                      - const parent = discord.channels.get(row.channel.parent_id)
+                      option(value=row.channel.id)= "#" + row.channel.name + (parent ? " - " + parent.name : "")
+              .wmn0
+                label.s-label(for="ping-role-new") Notify role
+                .s-select
+                  select.w100.box-border#ping-role-new(name="ping_role_id" required)
+                    option(value="" selected disabled) Choose a role
+                    each role in pingRoles
+                      option(value=role.id)= "@" + role.name
+            button.s-btn.s-btn__filled.mt8(type="submit") Add
+
   h3.fs-category.mt32 Auto-create
   .s-card.d-grid.px0
     form.d-flex.ai-center.g16

src/web/routes/guild-settings.js

@@ -140,3 +140,22 @@ as.router.post("/api/default-roles", defineEventHandler(async event => {
 		return sendRedirect(event, `/guild?guild_id=${guildID}`, 302)
 	}
 }))
+
+// An empty role restores @everyone
+as.router.post("/api/room-ping-role", defineEventHandler(async event => {
+	const body = await readValidatedBody(event, z.object({
+		guild_id: z.string(),
+		channel_id: z.string(),
+		ping_role_id: z.string().regex(/^(?:[0-9]+)?$/)
+	}).parse)
+	const managed = await auth.getManagedGuilds(event)
+	if (!managed.has(body.guild_id)) throw createError({status: 403, message: "Forbidden", data: "Can't change settings for a guild you don't have Manage Server permissions in"})
+	const room = select("channel_room", "room_id", {channel_id: body.channel_id, guild_id: body.guild_id}).get()
+	if (!room) throw createError({status: 404, message: "Linked channel not found"})
+	const guild = discord.guilds.get(body.guild_id)
+	if (body.ping_role_id && (!guild?.roles.some(role => role.id === body.ping_role_id) || body.ping_role_id === body.guild_id)) {
+		throw createError({status: 400, message: "Choose a role from this server"})
+	}
+	db.prepare("UPDATE channel_room SET ping_role_id = ? WHERE channel_id = ? AND guild_id = ?").run(body.ping_role_id || null, body.channel_id, body.guild_id)
+	return sendRedirect(event, `/guild?guild_id=${body.guild_id}#room-notifications`, 302)
+}))

src/web/routes/guild-settings.test.js

@@ -2,7 +2,7 @@
 
 const {tryToCatch} = require("try-to-catch")
 const {router, test} = require("../../../test/web")
-const {select} = require("../../passthrough")
+const {select, discord} = require("../../passthrough")
 const {MatrixServerError} = require("../../matrix/mreq")
 
 test("web autocreate: checks permissions", async t => {

src/web/routes/guild.js

@@ -99,7 +99,7 @@ function getChannelRoomsLinks(guild, rooms, roles) {
 	let channelIDs = discord.guildChannelMap.get(guild.id)
 	assert(channelIDs)
 
-	let linkedChannels = select("channel_room", ["channel_id", "room_id", "name", "nick"], {channel_id: channelIDs}).all()
+	let linkedChannels = select("channel_room", ["channel_id", "room_id", "name", "nick", "ping_role_id"], {channel_id: channelIDs}).all()
 	let linkedChannelsWithDetails = linkedChannels.map(c => ({
 		// @ts-ignore
 		/** @type {DiscordTypes.APIGuildChannel} */ channel: discord.channels.get(c.channel_id),