shane/AutoMod
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

allow /bridge config from revolt

Browse source
This commit is contained in:
Jan 2022-11-07 21:45:00 +01:00
parent 55f5e339e1
commit 603d922a33
No known key found for this signature in database
GPG key ID: 5D5E18ACB990F57A
6 changed files with 280 additions and 145 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

392
bot/src/bot/commands/configuration/bridge.ts
View file

@ -1,210 +1,358 @@
import { Message } from "@janderedev/revolt.js"; import { Message } from "@janderedev/revolt.js";
import { ulid } from "ulid"; import { ulid } from "ulid";
import { SendableEmbed } from "revolt-api"; import { SendableEmbed } from "revolt-api";
import { CONFIG_KEYS } from "automod/dist/misc/bridge_config_keys";
import { dbs } from "../../.."; import { dbs } from "../../..";
import CommandCategory from "../../../struct/commands/CommandCategory"; import CommandCategory from "../../../struct/commands/CommandCategory";
import SimpleCommand from "../../../struct/commands/SimpleCommand"; import SimpleCommand from "../../../struct/commands/SimpleCommand";
import MessageCommandContext from "../../../struct/MessageCommandContext"; import MessageCommandContext from "../../../struct/MessageCommandContext";
import { DEFAULT_PREFIX } from "../../modules/command_handler"; import { DEFAULT_PREFIX } from "../../modules/command_handler";
import { embed, EmbedColor, isBotManager, isModerator, NO_MANAGER_MSG } from "../../util"; import {
embed,
EmbedColor,
isBotManager,
isModerator,
NO_MANAGER_MSG,
} from "../../util";
const DISCORD_INVITE_URL = 'https://discord.com/api/oauth2/authorize?client_id=965692929643524136&permissions=536996864&scope=bot%20applications.commands'; // todo: read this from env or smth const DISCORD_INVITE_URL =
"https://discord.com/api/oauth2/authorize?client_id=965692929643524136&permissions=536996864&scope=bot%20applications.commands"; // todo: read this from env or smth
export default { export default {
name: 'bridge', name: "bridge",
aliases: null, aliases: null,
description: 'Bridge a channel with Discord', description: "Bridge a channel with Discord",
category: CommandCategory.Misc, category: CommandCategory.Misc,
run: async (message: MessageCommandContext, args: string[]) => { run: async (message: MessageCommandContext, args: string[]) => {
switch(args[0]?.toLowerCase()) { switch (args[0]?.toLowerCase()) {
case 'link': { case "link": {
if (!await isBotManager(message)) return message.reply(NO_MANAGER_MSG); if (!(await isBotManager(message)))
return message.reply(NO_MANAGER_MSG);
const count = await dbs.BRIDGE_CONFIG.count({ revolt: message.channel_id }); const count = await dbs.BRIDGE_CONFIG.count({
if (count) return message.reply(`This channel is already bridged.`); revolt: message.channel_id,
});
if (count)
return message.reply(`This channel is already bridged.`);
// Invalidate previous bridge request // Invalidate previous bridge request
await dbs.BRIDGE_REQUESTS.remove({ revolt: message.channel_id }); await dbs.BRIDGE_REQUESTS.remove({
revolt: message.channel_id,
});
const reqId = ulid(); const reqId = ulid();
await dbs.BRIDGE_REQUESTS.insert({ await dbs.BRIDGE_REQUESTS.insert({
id: reqId, id: reqId,
revolt: message.channel_id, revolt: message.channel_id,
expires: Date.now() + (1000 * 60 * 15), expires: Date.now() + 1000 * 60 * 15,
}); });
let text = `### Link request created.\n` + let text =
`### Link request created.\n` +
`Request ID: \`${reqId}\`\n\n` + `Request ID: \`${reqId}\`\n\n` +
`[Invite the bridge bot to your Discord server](<${DISCORD_INVITE_URL}>) ` + `[Invite the bridge bot to your Discord server](<${DISCORD_INVITE_URL}>) ` +
`and run \`/bridge confirm ${reqId}\` in the channel you wish to link.\n` + `and run \`/bridge confirm ${reqId}\` in the channel you wish to link.\n` +
`This request expires in 15 minutes.`; `This request expires in 15 minutes.`;
if (!message.channel!.havePermission('Masquerade') if (
|| !message.channel!.havePermission('SendEmbeds') !message.channel!.havePermission("Masquerade") ||
|| !message.channel!.havePermission('UploadFiles')) { !message.channel!.havePermission("SendEmbeds") ||
text += '\n\n> :warning: I currently don\'t have all required permissions in this ' + !message.channel!.havePermission("UploadFiles")
'channel for the bridge to work. Please make sure to grant the "Masquerade", ' + ) {
'"Upload Files" and "Send Embeds" permission.' text +=
"\n\n> :warning: I currently don't have all required permissions in this " +
'channel for the bridge to work. Please make sure to grant the "Masquerade", ' +
'"Upload Files" and "Send Embeds" permission.';
} }
await message.reply(text, false); await message.reply(text, false);
break; break;
} }
case 'unlink': { case "unlink": {
if (!await isBotManager(message)) return message.reply(NO_MANAGER_MSG); if (!(await isBotManager(message)))
return message.reply(NO_MANAGER_MSG);
const res = await dbs.BRIDGE_CONFIG.remove({ revolt: message.channel_id }); const res = await dbs.BRIDGE_CONFIG.remove({
revolt: message.channel_id,
});
if (res.deletedCount) await message.reply(`Channel unlinked!`); if (res.deletedCount) await message.reply(`Channel unlinked!`);
else await message.reply(`Unable to unlink; no channel linked.`); else
await message.reply(`Unable to unlink; no channel linked.`);
break; break;
} }
case 'unlink_all': { case "unlink_all": {
if (!await isBotManager(message)) return message.reply(NO_MANAGER_MSG); if (!(await isBotManager(message)))
return message.reply(NO_MANAGER_MSG);
const query = { revolt: { $in: message.channel?.server?.channel_ids || [] } }; const query = {
if (args[1] == 'CONFIRM') { revolt: { $in: message.channel?.server?.channel_ids || [] },
};
if (args[1] == "CONFIRM") {
const res = await dbs.BRIDGE_CONFIG.remove(query); const res = await dbs.BRIDGE_CONFIG.remove(query);
if (res.deletedCount) { if (res.deletedCount) {
await message.reply(`All channels have been unlinked. (Count: **${res.deletedCount}**)`); await message.reply(
`All channels have been unlinked. (Count: **${res.deletedCount}**)`
);
} else { } else {
await message.reply(`No bridged channels found; nothing to delete.`); await message.reply(
`No bridged channels found; nothing to delete.`
);
} }
} else { } else {
const res = await dbs.BRIDGE_CONFIG.count(query); const res = await dbs.BRIDGE_CONFIG.count(query);
if (!res) await message.reply(`No bridged channels found; nothing to delete.`); if (!res)
await message.reply(
`No bridged channels found; nothing to delete.`
);
else { else {
await message.reply(`${res} bridged channels found. ` await message.reply(
+ `Run \`${DEFAULT_PREFIX}bridge unlink_all CONFIRM\` to confirm deletion.`); `${res} bridged channels found. ` +
`Run \`${DEFAULT_PREFIX}bridge unlink_all CONFIRM\` to confirm deletion.`
);
} }
} }
break; break;
} }
case 'list': { case "list": {
if (!await isBotManager(message)) return message.reply(NO_MANAGER_MSG); if (!(await isBotManager(message)))
return message.reply(NO_MANAGER_MSG);
const links = await dbs.BRIDGE_CONFIG.find({ revolt: { $in: message.channel?.server?.channel_ids || [] } }); const links = await dbs.BRIDGE_CONFIG.find({
revolt: { $in: message.channel?.server?.channel_ids || [] },
});
await message.reply({ await message.reply({
content: '#', content: "#",
embeds: [ embeds: [
{ {
title: `Bridges in ${message.channel?.server?.name}`, title: `Bridges in ${message.channel?.server?.name}`,
description: `**${links.length}** bridged channels found.\n\n` description:
+ links.map(l => `<#${l.revolt}> **->** ${l.discord}`).join('\n'), `**${links.length}** bridged channels found.\n\n` +
} links
] .map(
(l) =>
`<#${l.revolt}> **->** ${l.discord}`
)
.join("\n"),
},
],
}); });
break; break;
} }
case 'info': { case "info": {
try { try {
if (!message.reply_ids) { if (!message.reply_ids) {
return await message.reply('Please run this command again while replying to a message.');
}
if (message.reply_ids.length > 1 && !await isModerator(message, false)) {
return await message.reply( return await message.reply(
'To avoid spam, only moderators are allowed to query bridge info for more than one message at a time.' "Please run this command again while replying to a message."
); );
} }
const messages = (await Promise.allSettled( if (
message.reply_ids?.map(m => message.channel!.fetchMessage(m)) || [] message.reply_ids.length > 1 &&
)) !(await isModerator(message, false))
.filter(m => m.status == 'fulfilled') ) {
.map(m => (m as PromiseFulfilledResult<Message>).value); return await message.reply(
"To avoid spam, only moderators are allowed to query bridge info for more than one message at a time."
if (!messages.length) { );
return await message.reply('Something went wrong; could not fetch the target message(s).');
} }
const embeds: SendableEmbed[] = await Promise.all(messages.map(async msg => { const messages = (
const bridgeData = await dbs.BRIDGED_MESSAGES.findOne({ await Promise.allSettled(
'revolt.messageId': msg._id, message.reply_ids?.map((m) =>
}); message.channel!.fetchMessage(m)
) || []
)
)
.filter((m) => m.status == "fulfilled")
.map(
(m) => (m as PromiseFulfilledResult<Message>).value
);
const embed: SendableEmbed = bridgeData ? { if (!messages.length) {
url: msg.url, return await message.reply(
title: `Message ${bridgeData?.origin == 'revolt' ? `by ${msg.author?.username}` : 'from Discord'}`, "Something went wrong; could not fetch the target message(s)."
colour: '#7e96ff', );
description: `**Origin:** ${bridgeData.origin == 'revolt' ? 'Revolt' : 'Discord'}\n` + }
`**Bridge Status:** ${
bridgeData.origin == 'revolt'
? (bridgeData.discord.messageId ? 'Bridged' : 'Unbridged')
: (bridgeData.revolt.messageId ? 'Bridged' : (bridgeData.revolt.nonce ? 'ID unknown' : 'Unbridged'))
}\n` +
`### Bridge Data\n` +
`Origin: \`${bridgeData.origin}\`\n` +
`Discord ID: \`${bridgeData.discord.messageId}\`\n` +
`Revolt ID: \`${bridgeData.revolt.messageId}\`\n` +
`Revolt Nonce: \`${bridgeData.revolt.nonce}\`\n` +
`Discord Channel: \`${bridgeData.channels?.discord}\`\n` +
`Revolt Channel: \`${bridgeData.channels?.revolt}\``,
} : {
url: msg.url,
title: `Message by ${msg.author?.username}`,
description: 'This message has not been bridged.',
colour: '#7e96ff',
}
return embed; const embeds: SendableEmbed[] = await Promise.all(
})); messages.map(async (msg) => {
const bridgeData =
await dbs.BRIDGED_MESSAGES.findOne({
"revolt.messageId": msg._id,
});
const embed: SendableEmbed = bridgeData
? {
url: msg.url,
title: `Message ${
bridgeData?.origin == "revolt"
? `by ${msg.author?.username}`
: "from Discord"
}`,
colour: "#7e96ff",
description:
`**Origin:** ${
bridgeData.origin == "revolt"
? "Revolt"
: "Discord"
}\n` +
`**Bridge Status:** ${
bridgeData.origin == "revolt"
? bridgeData.discord.messageId
? "Bridged"
: "Unbridged"
: bridgeData.revolt.messageId
? "Bridged"
: bridgeData.revolt.nonce
? "ID unknown"
: "Unbridged"
}\n` +
`### Bridge Data\n` +
`Origin: \`${bridgeData.origin}\`\n` +
`Discord ID: \`${bridgeData.discord.messageId}\`\n` +
`Revolt ID: \`${bridgeData.revolt.messageId}\`\n` +
`Revolt Nonce: \`${bridgeData.revolt.nonce}\`\n` +
`Discord Channel: \`${bridgeData.channels?.discord}\`\n` +
`Revolt Channel: \`${bridgeData.channels?.revolt}\``,
}
: {
url: msg.url,
title: `Message by ${msg.author?.username}`,
description:
"This message has not been bridged.",
colour: "#7e96ff",
};
return embed;
})
);
await message.reply({ embeds }, false); await message.reply({ embeds }, false);
} catch(e) { } catch (e) {
console.error(e); console.error(e);
message.reply(''+e)?.catch(() => {}); message.reply("" + e)?.catch(() => {});
} }
break; break;
} }
case 'status': { case "status": {
const link = await dbs.BRIDGE_CONFIG.findOne({ revolt: message.channel_id }); const link = await dbs.BRIDGE_CONFIG.findOne({
revolt: message.channel_id,
});
if (!link) return await message.reply({ if (!link)
embeds: [ return await message.reply({
embed( embeds: [
'This channel is **not** bridged, and no message data is being sent to Discord.', embed(
'Bridge status', "This channel is **not** bridged, and no message data is being sent to Discord.",
EmbedColor.Success "Bridge status",
) EmbedColor.Success
] ),
}); ],
else return await message.reply({ });
embeds: [ else
embed( return await message.reply({
'This channel is bridged to Discord. Please refer to the [Privacy Policy](<https://github.com/janderedev/automod/wiki/Privacy-Policy>) for more info.', embeds: [
'Bridge Status', embed(
EmbedColor.Success, "This channel is bridged to Discord. Please refer to the [Privacy Policy](<https://github.com/janderedev/automod/wiki/Privacy-Policy>) for more info.",
) "Bridge Status",
] EmbedColor.Success
}); ),
],
});
} }
case 'help': { case "config": {
const [_, configKey, newVal]: (string | undefined)[] = args;
if (!configKey) {
return await message.reply({
embeds: [
{
title: "Bridge Configuration",
description:
`To modify a configuration option, run ${DEFAULT_PREFIX}bridge config <key> [true|false].\n\n` +
`**Available configuration keys:**` +
Object.keys(CONFIG_KEYS).map(
(key) => `\n- ${key}`
),
},
],
});
}
if (!Object.keys(CONFIG_KEYS).includes(configKey)) {
return await message.reply("Unknown configuration key.");
}
const key = CONFIG_KEYS[configKey as keyof typeof CONFIG_KEYS];
if (!newVal) {
const bridgeConfig = await dbs.BRIDGE_CONFIG.findOne({
revolt: message.channel_id,
});
return await message.reply({
embeds: [
{
title: "Bridge Configuration: " + configKey,
description: `**${key.friendlyName}**\n${
key.description
}\n\nCurrent value: **${
bridgeConfig?.config?.[
configKey as keyof typeof CONFIG_KEYS
]
}**`,
},
],
});
}
if (newVal != "true" && newVal != "false") {
return await message.reply(
"Value needs to be either `true` or `false`."
);
}
await dbs.BRIDGE_CONFIG.update(
{ revolt: message.channel_id },
{
$set: { [`config.${configKey}`]: newVal == "true" },
$setOnInsert: { revolt: message.channel_id },
},
{ upsert: true }
);
return await message.reply(
`Configuration key **${configKey}** has been updated to **${newVal}**.`
);
}
case "help": {
await message.reply({ await message.reply({
content: '#', content: "#",
embeds: [ embeds: [
{ {
title: 'Discord Bridge', title: "Discord Bridge",
description: `Bridges allow you to link your Revolt server to a Discord server ` description:
+ `by relaying all messages.\n\n` `Bridges allow you to link your Revolt server to a Discord server ` +
+ `To link a channel, first run \`${DEFAULT_PREFIX}bridge link\` on Revolt. ` `by relaying all messages.\n\n` +
+ `This will provide you with a link ID.\n` `To link a channel, first run \`${DEFAULT_PREFIX}bridge link\` on Revolt. ` +
+ `On Discord, first [add the Bridge bot to your server](<${DISCORD_INVITE_URL}>), ` `This will provide you with a link ID.\n` +
+ `then run the command: \`/bridge confirm [ID]\`.\n\n` `On Discord, first [add the Bridge bot to your server](<${DISCORD_INVITE_URL}>), ` +
+ `You can list all bridges in a Revolt server by running \`${DEFAULT_PREFIX}bridge list\`\n\n` `then run the command: \`/bridge confirm [ID]\`.\n\n` +
+ `To unlink a channel, run \`/bridge unlink\` from either Discord or Revolt. If you wish to ` `You can list all bridges in a Revolt server by running \`${DEFAULT_PREFIX}bridge list\`\n\n` +
+ `unbridge all channels in a Revolt server, run \`${DEFAULT_PREFIX}bridge unlink_all\`.\n` `To unlink a channel, run \`/bridge unlink\` from either Discord or Revolt. If you wish to ` +
+ `To view bridge info about a particular message, run \`${DEFAULT_PREFIX}bridge info\` ` `unbridge all channels in a Revolt server, run \`${DEFAULT_PREFIX}bridge unlink_all\`.\n` +
+ `while replying to the message.` `To view bridge info about a particular message, run \`${DEFAULT_PREFIX}bridge info\` ` +
} `while replying to the message.\n` +
] `You can customize how the bridge behaves using \`${DEFAULT_PREFIX}bridge config\`.`,
},
],
}); });
break; break;
} }
default: { default: {
await message.reply(`Run \`${DEFAULT_PREFIX}bridge help\` for help.`); await message.reply(
`Run \`${DEFAULT_PREFIX}bridge help\` for help.`
);
} }
} }
} },
} as SimpleCommand; } as SimpleCommand;

2
bridge/src/discord/commands.ts
View file

@ -7,7 +7,7 @@ import { BRIDGED_MESSAGES, BRIDGE_CONFIG, BRIDGE_REQUESTS, BRIDGE_USER_CONFIG, l
import { MessageEmbed, TextChannel } from "discord.js"; import { MessageEmbed, TextChannel } from "discord.js";
import { revoltFetchMessage, revoltFetchUser } from "../util"; import { revoltFetchMessage, revoltFetchUser } from "../util";
import { client as revoltClient } from "../revolt/client"; import { client as revoltClient } from "../revolt/client";
import { CONFIG_KEYS } from "../types/ConfigKeys"; import { CONFIG_KEYS } from "automod/dist/misc/bridge_config_keys";
const PRIVACY_POLICY_URL = const PRIVACY_POLICY_URL =
"https://github.com/janderedev/automod/wiki/Privacy-Policy"; "https://github.com/janderedev/automod/wiki/Privacy-Policy";

2
bridge/src/index.ts
View file

@ -4,7 +4,7 @@ import { getDb } from './db';
import { login as loginRevolt } from './revolt/client'; import { login as loginRevolt } from './revolt/client';
import { login as loginDiscord } from './discord/client'; import { login as loginDiscord } from './discord/client';
import { ICollection } from 'monk'; import { ICollection } from 'monk';
import BridgeConfig from './types/BridgeConfig'; import BridgeConfig from "automod/dist/types/BridgeConfig";
import BridgedMessage from './types/BridgedMessage'; import BridgedMessage from './types/BridgedMessage';
import BridgeRequest from './types/BridgeRequest'; import BridgeRequest from './types/BridgeRequest';
import DiscordBridgedEmoji from './types/DiscordBridgedEmoji'; import DiscordBridgedEmoji from './types/DiscordBridgedEmoji';

20
bridge/src/types/BridgeConfig.ts
View file

@ -1,20 +0,0 @@
import { CONFIG_KEYS } from "./ConfigKeys";
export default class {
// Revolt channel ID
revolt?: string;
// Discord channel ID
discord?: string;
// Discord webhook
discordWebhook?: {
id: string;
token: string;
};
config?: { [key in keyof typeof CONFIG_KEYS]: boolean | undefined };
// If true, messages by users who have opted out of bridging will be deleted.
disallowIfOptedOut?: boolean;
}

0
bridge/src/types/ConfigKeys.ts → lib/src/misc/bridge_config_keys.ts
View file

9
lib/src/types/BridgeConfig.ts
View file

@ -1,3 +1,5 @@
import { CONFIG_KEYS } from "../misc/bridge_config_keys";
export default class { export default class {
// Revolt channel ID // Revolt channel ID
revolt?: string; revolt?: string;
@ -9,5 +11,10 @@ export default class {
discordWebhook?: { discordWebhook?: {
id: string; id: string;
token: string; token: string;
} };
config?: { [key in keyof typeof CONFIG_KEYS]: boolean | undefined };
// If true, messages by users who have opted out of bridging will be deleted.
disallowIfOptedOut?: boolean;
} }