StyAndCo/zappyzep
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Disable mentions in logs, allowing mods to be mentioned (#142)

Browse source 
Optionally you can return to old behavior by setting allow_user_mentions to true
This commit is contained in:
Nils 2021-01-28 00:26:24 +01:00 • committed by GitHub
parent dea3c2516c
commit f762a238de
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 21 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
backend/src/plugins/Logs/LogsPlugin.ts
View file

@ -31,7 +31,8 @@ const defaultOptions: PluginOptions<LogsPluginType> = {
timestamp: FORMAT_NO_TIMESTAMP, // Legacy/deprecated, use timestamp_format below instead timestamp: FORMAT_NO_TIMESTAMP, // Legacy/deprecated, use timestamp_format below instead
...DefaultLogMessages, ...DefaultLogMessages,
}, },
ping_user: true, ping_user: true, // Legacy/deprecated, if below is false mentions wont actually ping. In case you really want the old behavior, set below to true
allow_user_mentions: false,
timestamp_format: "YYYY-MM-DD HH:mm:ss z", timestamp_format: "YYYY-MM-DD HH:mm:ss z",
include_embed_timestamp: true, include_embed_timestamp: true,
}, },
@ -40,7 +41,7 @@ const defaultOptions: PluginOptions<LogsPluginType> = {
{ {
level: ">=50", level: ">=50",
config: { config: {
ping_user: false, ping_user: false, // Legacy/deprecated, read comment on global ping_user option
}, },
}, },
], ],

3
backend/src/plugins/Logs/types.ts
View file

@ -38,7 +38,8 @@ export const ConfigSchema = t.type({
timestamp: t.string, // Legacy/deprecated timestamp: t.string, // Legacy/deprecated
}), }),
]), ]),
ping_user: t.boolean, ping_user: t.boolean, // Legacy/deprecated, if below is false mentions wont actually ping
allow_user_mentions: t.boolean,
timestamp_format: t.string, timestamp_format: t.string,
include_embed_timestamp: t.boolean, include_embed_timestamp: t.boolean,
}); });

7
backend/src/plugins/Logs/util/getLogMessage.ts
View file

@ -61,7 +61,12 @@ export async function getLogMessage(
const memberConfig = pluginData.config.getMatchingConfig({ member, userId: user.id }) || ({} as any); const memberConfig = pluginData.config.getMatchingConfig({ member, userId: user.id }) || ({} as any);
mentions.push(memberConfig.ping_user ? verboseUserMention(user) : verboseUserName(user)); // Revert to old behavior (verbose name w/o ping if allow_user_mentions is enabled (for whatever reason))
if (config.allow_user_mentions) {
mentions.push(memberConfig.ping_user ? verboseUserMention(user) : verboseUserName(user));
} else {
mentions.push(verboseUserMention(user));
}
} }
return mentions.join(", "); return mentions.join(", ");

5
backend/src/plugins/Logs/util/log.ts
View file

@ -103,6 +103,7 @@ export async function log(pluginData: GuildPluginData<LogsPluginType>, type: Log
// Default to batched unless explicitly disabled // Default to batched unless explicitly disabled
const batched = opts.batched ?? true; const batched = opts.batched ?? true;
const batchTime = opts.batch_time ?? 1000; const batchTime = opts.batch_time ?? 1000;
const cfg = pluginData.config.get();
if (batched) { if (batched) {
// If we're batching log messages, gather all log messages within the set batch_time into a single message // If we're batching log messages, gather all log messages within the set batch_time into a single message
@ -111,14 +112,14 @@ export async function log(pluginData: GuildPluginData<LogsPluginType>, type: Log
setTimeout(async () => { setTimeout(async () => {
const batchedMessage = pluginData.state.batches.get(channel.id)!.join("\n"); const batchedMessage = pluginData.state.batches.get(channel.id)!.join("\n");
pluginData.state.batches.delete(channel.id); pluginData.state.batches.delete(channel.id);
createChunkedMessage(channel, batchedMessage).catch(noop); createChunkedMessage(channel, batchedMessage, { users: cfg.allow_user_mentions }).catch(noop);
}, batchTime); }, batchTime);
} }
pluginData.state.batches.get(channel.id)!.push(message); pluginData.state.batches.get(channel.id)!.push(message);
} else { } else {
// If we're not batching log messages, just send them immediately // If we're not batching log messages, just send them immediately
await createChunkedMessage(channel, message).catch(noop); await createChunkedMessage(channel, message, { users: cfg.allow_user_mentions }).catch(noop);
} }
} }
} }

9
backend/src/utils.ts
View file

@ -1,4 +1,5 @@
import { import {
AllowedMentions,
Attachment, Attachment,
Client, Client,
Constants, Constants,
@ -748,10 +749,14 @@ export function chunkMessageLines(str: string, maxChunkLength = 1990): string[]
}); });
} }
export async function createChunkedMessage(channel: TextableChannel, messageText: string) { export async function createChunkedMessage(
channel: TextableChannel,
messageText: string,
allowedMentions?: AllowedMentions,
) {
const chunks = chunkMessageLines(messageText); const chunks = chunkMessageLines(messageText);
for (const chunk of chunks) { for (const chunk of chunks) {
await channel.createMessage(chunk); await channel.createMessage({ content: chunk, allowedMentions });
} }
} }