Merge branch 'knub30' into k30_slowmode

This commit is contained in:
Miikka 2020-07-25 12:06:25 +03:00 committed by GitHub
commit 31fdf67947
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
17 changed files with 617 additions and 0 deletions

View file

@ -72,3 +72,13 @@ export function getBaseUrl(pluginData: PluginData<any>) {
const knub = pluginData.getKnubInstance() as TZeppelinKnub;
return knub.getGlobalConfig().url;
}
export function isOwner(pluginData: PluginData<any>, userId: string) {
const knub = pluginData.getKnubInstance() as TZeppelinKnub;
const owners = knub.getGlobalConfig().owners;
if (!owners) {
return false;
}
return owners.includes(userId);
}

View file

@ -0,0 +1,16 @@
import { zeppelinPlugin } from "../ZeppelinPluginBlueprint";
import { ChannelArchiverPluginType } from "./types";
import { ArchiveChannelCmd } from "./commands/ArchiveChannelCmd";
export const ChannelArchiverPlugin = zeppelinPlugin<ChannelArchiverPluginType>()("channel_archiver", {
showInDocs: false,
// prettier-ignore
commands: [
ArchiveChannelCmd,
],
onLoad(pluginData) {
const { state, guild } = pluginData;
},
});

View file

@ -0,0 +1,110 @@
import { commandTypeHelpers as ct } from "../../../commandTypes";
import { channelArchiverCmd } from "../types";
import { isOwner, sendErrorMessage } from "src/pluginUtils";
import { confirm, SECONDS, noop } from "src/utils";
import moment from "moment-timezone";
import { rehostAttachment } from "../rehostAttachment";
const MAX_ARCHIVED_MESSAGES = 5000;
const MAX_MESSAGES_PER_FETCH = 100;
const PROGRESS_UPDATE_INTERVAL = 5 * SECONDS;
export const ArchiveChannelCmd = channelArchiverCmd({
trigger: "archive_channel",
permission: null,
config: {
preFilters: [
(command, context) => {
return isOwner(context.pluginData, context.message.author.id);
},
],
},
signature: {
channel: ct.textChannel(),
"attachment-channel": ct.textChannel({ option: true }),
messages: ct.number({ option: true }),
},
async run({ message: msg, args, pluginData }) {
if (!args["attachment-channel"]) {
const confirmed = await confirm(
pluginData.client,
msg.channel,
msg.author.id,
"No `-attachment-channel` specified. Continue? Attachments will not be available in the log if their message is deleted.",
);
if (!confirmed) {
sendErrorMessage(pluginData, msg.channel, "Canceled");
return;
}
}
const maxMessagesToArchive = args.messages ? Math.min(args.messages, MAX_ARCHIVED_MESSAGES) : MAX_ARCHIVED_MESSAGES;
if (maxMessagesToArchive <= 0) return;
const archiveLines = [];
let archivedMessages = 0;
let previousId;
const startTime = Date.now();
const progressMsg = await msg.channel.createMessage("Creating archive...");
const progressUpdateInterval = setInterval(() => {
const secondsSinceStart = Math.round((Date.now() - startTime) / 1000);
progressMsg
.edit(`Creating archive...\n**Status:** ${archivedMessages} messages archived in ${secondsSinceStart} seconds`)
.catch(() => clearInterval(progressUpdateInterval));
}, PROGRESS_UPDATE_INTERVAL);
while (archivedMessages < maxMessagesToArchive) {
const messagesToFetch = Math.min(MAX_MESSAGES_PER_FETCH, maxMessagesToArchive - archivedMessages);
const messages = await args.channel.getMessages(messagesToFetch, previousId);
if (messages.length === 0) break;
for (const message of messages) {
const ts = moment.utc(message.timestamp).format("YYYY-MM-DD HH:mm:ss");
let content = `[${ts}] [${message.author.id}] [${message.author.username}#${
message.author.discriminator
}]: ${message.content || "<no text content>"}`;
if (message.attachments.length) {
if (args["attachment-channel"]) {
const rehostedAttachmentUrl = await rehostAttachment(message.attachments[0], args["attachment-channel"]);
content += `\n-- Attachment: ${rehostedAttachmentUrl}`;
} else {
content += `\n-- Attachment: ${message.attachments[0].url}`;
}
}
if (message.reactions && Object.keys(message.reactions).length > 0) {
const reactionCounts = [];
for (const [emoji, info] of Object.entries(message.reactions)) {
reactionCounts.push(`${info.count}x ${emoji}`);
}
content += `\n-- Reactions: ${reactionCounts.join(", ")}`;
}
archiveLines.push(content);
previousId = message.id;
archivedMessages++;
}
}
clearInterval(progressUpdateInterval);
archiveLines.reverse();
const nowTs = moment().format("YYYY-MM-DD HH:mm:ss");
let result = `Archived ${archiveLines.length} messages from #${args.channel.name} at ${nowTs}`;
result += `\n\n${archiveLines.join("\n")}\n`;
progressMsg.delete().catch(noop);
msg.channel.createMessage("Archive created!", {
file: Buffer.from(result),
name: `archive-${args.channel.name}-${moment().format("YYYY-MM-DD-HH-mm-ss")}.txt`,
});
},
});

View file

@ -0,0 +1,29 @@
import { Attachment, TextChannel } from "eris";
import { downloadFile } from "src/utils";
import fs from "fs";
const fsp = fs.promises;
const MAX_ATTACHMENT_REHOST_SIZE = 1024 * 1024 * 8;
export async function rehostAttachment(attachment: Attachment, targetChannel: TextChannel): Promise<string> {
if (attachment.size > MAX_ATTACHMENT_REHOST_SIZE) {
return "Attachment too big to rehost";
}
let downloaded;
try {
downloaded = await downloadFile(attachment.url, 3);
} catch (e) {
return "Failed to download attachment after 3 tries";
}
try {
const rehostMessage = await targetChannel.createMessage(`Rehost of attachment ${attachment.id}`, {
name: attachment.filename,
file: await fsp.readFile(downloaded.path),
});
return rehostMessage.attachments[0].url;
} catch (e) {
return "Failed to rehost attachment";
}
}

View file

@ -0,0 +1,7 @@
import { BasePluginType, command } from "knub";
export interface ChannelArchiverPluginType extends BasePluginType {
state: {};
}
export const channelArchiverCmd = command<ChannelArchiverPluginType>();

View file

@ -0,0 +1,118 @@
import { PluginOptions } from "knub";
import { ConfigSchema, StarboardPluginType } from "./types";
import { zeppelinPlugin } from "../ZeppelinPluginBlueprint";
import { trimPluginDescription } from "src/utils";
import { GuildSavedMessages } from "src/data/GuildSavedMessages";
import { GuildStarboardMessages } from "src/data/GuildStarboardMessages";
import { GuildStarboardReactions } from "src/data/GuildStarboardReactions";
import { onMessageDelete } from "./util/onMessageDelete";
import { MigratePinsCmd } from "./commands/MigratePinsCmd";
import { StarboardReactionAddEvt } from "./events/StarboardReactionAddEvt";
import { StarboardReactionRemoveEvt, StarboardReactionRemoveAllEvt } from "./events/StarboardReactionRemoveEvts";
const defaultOptions: PluginOptions<StarboardPluginType> = {
config: {
can_migrate: false,
boards: {},
},
overrides: [
{
level: ">=100",
config: {
can_migrate: true,
},
},
],
};
export const StarboardPlugin = zeppelinPlugin<StarboardPluginType>()("starboard", {
configSchema: ConfigSchema,
defaultOptions,
info: {
prettyName: "Starboard",
description: trimPluginDescription(`
This plugin allows you to set up starboards on your server. Starboards are like user voted pins where messages with enough reactions get immortalized on a "starboard" channel.
`),
configurationGuide: trimPluginDescription(`
### Note on emojis
To specify emoji in the config, you need to use the emoji's "raw form".
To obtain this, post the emoji with a backslash in front of it.
- Example with a default emoji: "\:star:" => "⭐"
- Example with a custom emoji: "\:mrvnSmile:" => "<:mrvnSmile:543000534102310933>"
### Basic starboard
Any message on the server that gets 5 star reactions will be posted into the starboard channel (604342689038729226).
~~~yml
starboard:
config:
boards:
basic:
channel_id: "604342689038729226"
stars_required: 5
~~~
### Custom star emoji
This is identical to the basic starboard above, but accepts two emoji: the regular star and a custom :mrvnSmile: emoji
~~~yml
starboard:
config:
boards:
basic:
channel_id: "604342689038729226"
star_emoji: ["⭐", "<:mrvnSmile:543000534102310933>"]
stars_required: 5
~~~
### Limit starboard to a specific channel
This is identical to the basic starboard above, but only works from a specific channel (473087035574321152).
~~~yml
starboard:
config:
boards:
basic:
enabled: false # The starboard starts disabled and is then enabled in a channel override below
channel_id: "604342689038729226"
stars_required: 5
overrides:
- channel: "473087035574321152"
config:
boards:
basic:
enabled: true
~~~
`),
},
// prettier-ignore
commands: [
MigratePinsCmd,
],
// prettier-ignore
events: [
StarboardReactionAddEvt,
StarboardReactionRemoveEvt,
StarboardReactionRemoveAllEvt,
],
onLoad(pluginData) {
const { state, guild } = pluginData;
state.savedMessages = GuildSavedMessages.getGuildInstance(guild.id);
state.starboardMessages = GuildStarboardMessages.getGuildInstance(guild.id);
state.starboardReactions = GuildStarboardReactions.getGuildInstance(guild.id);
state.onMessageDeleteFn = msg => onMessageDelete(pluginData, msg);
state.savedMessages.events.on("delete", state.onMessageDeleteFn);
},
onUnload(pluginData) {
pluginData.state.savedMessages.events.off("delete", pluginData.state.onMessageDeleteFn);
},
});

View file

@ -0,0 +1,52 @@
import { commandTypeHelpers as ct } from "../../../commandTypes";
import { starboardCmd } from "../types";
import { sendSuccessMessage, sendErrorMessage } from "src/pluginUtils";
import { TextChannel } from "eris";
import { saveMessageToStarboard } from "../util/saveMessageToStarboard";
export const MigratePinsCmd = starboardCmd({
trigger: "starboard migrate_pins",
permission: "can_migrate",
description: "Posts all pins from a channel to the specified starboard. The pins are NOT unpinned automatically.",
signature: {
pinChannel: ct.textChannel(),
starboardName: ct.string(),
},
async run({ message: msg, args, pluginData }) {
const config = await pluginData.config.get();
const starboard = config.boards[args.starboardName];
if (!starboard) {
sendErrorMessage(pluginData, msg.channel, "Unknown starboard specified");
return;
}
const starboardChannel = pluginData.guild.channels.get(starboard.channel_id);
if (!starboardChannel || !(starboardChannel instanceof TextChannel)) {
sendErrorMessage(pluginData, msg.channel, "Starboard has an unknown/invalid channel id");
return;
}
msg.channel.createMessage(`Migrating pins from <#${args.pinChannel.id}> to <#${starboardChannel.id}>...`);
const pins = await args.pinChannel.getPins();
pins.reverse(); // Migrate pins starting from the oldest message
for (const pin of pins) {
const existingStarboardMessage = await pluginData.state.starboardMessages.getMatchingStarboardMessages(
starboardChannel.id,
pin.id,
);
if (existingStarboardMessage.length > 0) continue;
await saveMessageToStarboard(pluginData, pin, starboard);
}
sendSuccessMessage(
pluginData,
msg.channel,
`Pins migrated from <#${args.pinChannel.id}> to <#${starboardChannel.id}>!`,
);
},
});

View file

@ -0,0 +1,74 @@
import { starboardEvt } from "../types";
import { Message } from "eris";
import { UnknownUser, resolveMember, noop } from "src/utils";
import { saveMessageToStarboard } from "../util/saveMessageToStarboard";
export const StarboardReactionAddEvt = starboardEvt({
event: "messageReactionAdd",
async listener(meta) {
const pluginData = meta.pluginData;
let msg = meta.args.message as Message;
const userId = meta.args.userID;
const emoji = meta.args.emoji;
if (!msg.author) {
// Message is not cached, fetch it
try {
msg = await msg.channel.getMessage(msg.id);
} catch (e) {
// Sometimes we get this event for messages we can't fetch with getMessage; ignore silently
return;
}
}
// No self-votes!
if (msg.author.id === userId) return;
const user = await resolveMember(pluginData.client, pluginData.guild, userId);
if (user instanceof UnknownUser) return;
if (user.bot) return;
const config = pluginData.config.getMatchingConfig({ member: user, channelId: msg.channel.id });
const applicableStarboards = Object.values(config.boards)
.filter(board => board.enabled)
// Can't star messages in the starboard channel itself
.filter(board => board.channel_id !== msg.channel.id)
// Matching emoji
.filter(board => {
return board.star_emoji.some((boardEmoji: string) => {
if (emoji.id) {
// Custom emoji
const customEmojiMatch = boardEmoji.match(/^<?:.+?:(\d+)>?$/);
if (customEmojiMatch) {
return customEmojiMatch[1] === emoji.id;
}
return boardEmoji === emoji.id;
} else {
// Unicode emoji
return emoji.name === boardEmoji;
}
});
});
for (const starboard of applicableStarboards) {
// Save reaction into the database
await pluginData.state.starboardReactions.createStarboardReaction(msg.id, userId).catch(noop);
// If the message has already been posted to this starboard, we don't need to do anything else
const starboardMessages = await pluginData.state.starboardMessages.getMatchingStarboardMessages(
starboard.channel_id,
msg.id,
);
if (starboardMessages.length > 0) continue;
const reactions = await pluginData.state.starboardReactions.getAllReactionsForMessageId(msg.id);
const reactionsCount = reactions.length;
if (reactionsCount >= starboard.stars_required) {
await saveMessageToStarboard(pluginData, msg, starboard);
}
}
},
});

View file

@ -0,0 +1,17 @@
import { starboardEvt } from "../types";
export const StarboardReactionRemoveEvt = starboardEvt({
event: "messageReactionRemove",
async listener(meta) {
await meta.pluginData.state.starboardReactions.deleteStarboardReaction(meta.args.message.id, meta.args.userID);
},
});
export const StarboardReactionRemoveAllEvt = starboardEvt({
event: "messageReactionRemoveAll",
async listener(meta) {
await meta.pluginData.state.starboardReactions.deleteAllStarboardReactionsForMessageId(meta.args.message.id);
},
});

View file

@ -0,0 +1,43 @@
import * as t from "io-ts";
import { BasePluginType, command, eventListener } from "knub";
import { tNullable, tDeepPartial } from "src/utils";
import { GuildSavedMessages } from "src/data/GuildSavedMessages";
import { GuildStarboardMessages } from "src/data/GuildStarboardMessages";
import { GuildStarboardReactions } from "src/data/GuildStarboardReactions";
const StarboardOpts = t.type({
channel_id: t.string,
stars_required: t.number,
star_emoji: tNullable(t.array(t.string)),
copy_full_embed: tNullable(t.boolean),
enabled: tNullable(t.boolean),
});
export type TStarboardOpts = t.TypeOf<typeof StarboardOpts>;
export const ConfigSchema = t.type({
boards: t.record(t.string, StarboardOpts),
can_migrate: t.boolean,
});
export type TConfigSchema = t.TypeOf<typeof ConfigSchema>;
export const PartialConfigSchema = tDeepPartial(ConfigSchema);
export const defaultStarboardOpts: Partial<TStarboardOpts> = {
star_emoji: ["⭐"],
enabled: true,
};
export interface StarboardPluginType extends BasePluginType {
config: TConfigSchema;
state: {
savedMessages: GuildSavedMessages;
starboardMessages: GuildStarboardMessages;
starboardReactions: GuildStarboardReactions;
onMessageDeleteFn;
};
}
export const starboardCmd = command<StarboardPluginType>();
export const starboardEvt = eventListener<StarboardPluginType>();

View file

@ -0,0 +1,19 @@
import { TStarboardOpts, StarboardPluginType, defaultStarboardOpts } from "../types";
import { PluginData } from "knub";
export function getStarboardOptsForStarboardChannel(
pluginData: PluginData<StarboardPluginType>,
starboardChannel,
): TStarboardOpts[] {
const config = pluginData.config.getForChannel(starboardChannel);
const configs = Object.values(config.boards).filter(opts => opts.channel_id === starboardChannel.id);
configs.forEach(cfg => {
if (cfg.enabled == null) cfg.enabled = defaultStarboardOpts.enabled;
if (cfg.star_emoji == null) cfg.star_emoji = defaultStarboardOpts.star_emoji;
if (cfg.stars_required == null) cfg.stars_required = defaultStarboardOpts.stars_required;
if (cfg.copy_full_embed == null) cfg.copy_full_embed = false;
});
return configs;
}

View file

@ -0,0 +1,27 @@
import { SavedMessage } from "src/data/entities/SavedMessage";
import { PluginData } from "knub";
import { StarboardPluginType } from "../types";
import { removeMessageFromStarboard } from "./removeMessageFromStarboard";
import { removeMessageFromStarboardMessages } from "./removeMessageFromStarboardMessages";
export async function onMessageDelete(pluginData: PluginData<StarboardPluginType>, msg: SavedMessage) {
// Deleted source message
const starboardMessages = await pluginData.state.starboardMessages.getStarboardMessagesForMessageId(msg.id);
for (const starboardMessage of starboardMessages) {
removeMessageFromStarboard(pluginData, starboardMessage);
}
// Deleted message from the starboard
const deletedStarboardMessages = await pluginData.state.starboardMessages.getStarboardMessagesForStarboardMessageId(
msg.id,
);
if (deletedStarboardMessages.length === 0) return;
for (const starboardMessage of deletedStarboardMessages) {
removeMessageFromStarboardMessages(
pluginData,
starboardMessage.starboard_message_id,
starboardMessage.starboard_channel_id,
);
}
}

View file

@ -0,0 +1,12 @@
import { PartialConfigSchema, defaultStarboardOpts } from "../types";
import * as t from "io-ts";
export function preprocessStaticConfig(config: t.TypeOf<typeof PartialConfigSchema>) {
if (config.boards) {
for (const [name, opts] of Object.entries(config.boards)) {
config.boards[name] = Object.assign({}, defaultStarboardOpts, config.boards[name]);
}
}
return config;
}

View file

@ -0,0 +1,6 @@
import { StarboardMessage } from "src/data/entities/StarboardMessage";
import { noop } from "src/utils";
export async function removeMessageFromStarboard(pluginData, msg: StarboardMessage) {
await pluginData.client.deleteMessage(msg.starboard_channel_id, msg.starboard_message_id).catch(noop);
}

View file

@ -0,0 +1,3 @@
export async function removeMessageFromStarboardMessages(pluginData, starboard_message_id: string, channel_id: string) {
await pluginData.state.starboardMessages.deleteStarboardMessage(starboard_message_id, channel_id);
}

View file

@ -0,0 +1,70 @@
import { PluginData } from "knub";
import { StarboardPluginType, TStarboardOpts } from "../types";
import { Message, GuildChannel, TextChannel, Embed } from "eris";
import moment from "moment-timezone";
import { EMPTY_CHAR, messageLink } from "src/utils";
import path from "path";
export async function saveMessageToStarboard(
pluginData: PluginData<StarboardPluginType>,
msg: Message,
starboard: TStarboardOpts,
) {
const channel = pluginData.guild.channels.get(starboard.channel_id);
if (!channel) return;
const time = moment(msg.timestamp, "x").format("YYYY-MM-DD [at] HH:mm:ss [UTC]");
const embed: Embed = {
footer: {
text: `#${(msg.channel as GuildChannel).name}`,
},
author: {
name: `${msg.author.username}#${msg.author.discriminator}`,
},
fields: [],
timestamp: new Date(msg.timestamp).toISOString(),
type: "rich",
};
if (msg.author.avatarURL) {
embed.author.icon_url = msg.author.avatarURL;
}
if (msg.content) {
embed.description = msg.content;
}
// Merge media and - if copy_full_embed is enabled - fields and title from the first embed in the original message
if (msg.embeds.length > 0) {
if (msg.embeds[0].image) embed.image = msg.embeds[0].image;
if (starboard.copy_full_embed) {
if (msg.embeds[0].title) {
const titleText = msg.embeds[0].url ? `[${msg.embeds[0].title}](${msg.embeds[0].url})` : msg.embeds[0].title;
embed.fields.push({ name: EMPTY_CHAR, value: titleText });
}
if (msg.embeds[0].fields) embed.fields.push(...msg.embeds[0].fields);
}
}
// If there are no embeds, add the first image attachment explicitly
else if (msg.attachments.length) {
for (const attachment of msg.attachments) {
const ext = path
.extname(attachment.filename)
.slice(1)
.toLowerCase();
if (!["jpeg", "jpg", "png", "gif", "webp"].includes(ext)) continue;
embed.image = { url: attachment.url };
break;
}
}
embed.fields.push({ name: EMPTY_CHAR, value: `[Jump to message](${messageLink(msg)})` });
const starboardMessage = await (channel as TextChannel).createMessage({ embed });
await pluginData.state.starboardMessages.createStarboardMessage(channel.id, msg.id, starboardMessage.id);
}

View file

@ -14,10 +14,13 @@ import { CasesPlugin } from "./Cases/CasesPlugin";
import { MutesPlugin } from "./Mutes/MutesPlugin";
import { TagsPlugin } from "./Tags/TagsPlugin";
import { SlowmodePlugin } from "./Slowmode/SlowmodePlugin";
import { StarboardPlugin } from "./Starboard/StarboardPlugin";
import { ChannelArchiverPlugin } from "./ChannelArchiver/ChannelArchiverPlugin";
// prettier-ignore
export const guildPlugins: Array<ZeppelinPluginBlueprint<any>> = [
AutoReactionsPlugin,
ChannelArchiverPlugin,
LocateUserPlugin,
PersistPlugin,
PingableRolesPlugin,
@ -25,6 +28,7 @@ export const guildPlugins: Array<ZeppelinPluginBlueprint<any>> = [
NameHistoryPlugin,
RemindersPlugin,
SlowmodePlugin,
StarboardPlugin,
TagsPlugin,
UsernameSaverPlugin,
UtilityPlugin,