refactor: move message responders to their own namespace
This commit is contained in:
parent
be01fb1d53
commit
633ba8f600
4 changed files with 4 additions and 4 deletions
|
|
@ -0,0 +1,162 @@
|
|||
using System.Text.RegularExpressions;
|
||||
using Catalogger.Backend.Cache.InMemoryCache;
|
||||
using Catalogger.Backend.Database;
|
||||
using Catalogger.Backend.Database.Models;
|
||||
using Catalogger.Backend.Database.Queries;
|
||||
using Catalogger.Backend.Extensions;
|
||||
using Catalogger.Backend.Services;
|
||||
using Humanizer;
|
||||
using Remora.Discord.API.Abstractions.Gateway.Events;
|
||||
using Remora.Discord.Gateway.Responders;
|
||||
using Remora.Results;
|
||||
|
||||
namespace Catalogger.Backend.Bot.Responders.Messages;
|
||||
|
||||
public class MessageCreateResponder(
|
||||
ILogger logger,
|
||||
Config config,
|
||||
DatabaseContext db,
|
||||
MessageRepository messageRepository,
|
||||
UserCache userCache,
|
||||
PkMessageHandler pkMessageHandler)
|
||||
: IResponder<IMessageCreate>
|
||||
{
|
||||
private readonly ILogger _logger = logger.ForContext<MessageCreateResponder>();
|
||||
|
||||
public async Task<Result> RespondAsync(IMessageCreate msg, CancellationToken ct = default)
|
||||
{
|
||||
userCache.UpdateUser(msg.Author);
|
||||
CataloggerMetrics.MessagesReceived.Inc();
|
||||
|
||||
if (!msg.GuildID.IsDefined())
|
||||
{
|
||||
_logger.Debug("Received message create event for message {MessageId} despite it not being in a guild",
|
||||
msg.ID);
|
||||
return Result.Success;
|
||||
}
|
||||
|
||||
var guild = await db.GetGuildAsync(msg.GuildID, ct);
|
||||
// The guild needs to have enabled at least one of the message logging events,
|
||||
// and the channel must not be ignored, to store the message.
|
||||
if (guild.IsMessageIgnored(msg.ChannelID, msg.Author.ID))
|
||||
{
|
||||
db.IgnoredMessages.Add(new IgnoredMessage(msg.ID.ToUlong()));
|
||||
await db.SaveChangesAsync(ct);
|
||||
return Result.Success;
|
||||
}
|
||||
|
||||
if (msg.Author.ID == DiscordUtils.PkUserId)
|
||||
_ = pkMessageHandler.HandlePkMessageAsync(msg);
|
||||
if (msg.ApplicationID.Is(DiscordUtils.PkUserId))
|
||||
_ = pkMessageHandler.HandleProxiedMessageAsync(msg.ID.Value);
|
||||
else if (msg.ApplicationID.HasValue && msg.ApplicationID.Is(config.Discord.ApplicationId))
|
||||
{
|
||||
db.IgnoredMessages.Add(new IgnoredMessage(msg.ID.Value));
|
||||
await db.SaveChangesAsync(ct);
|
||||
return Result.Success;
|
||||
}
|
||||
|
||||
await messageRepository.SaveMessageAsync(msg, ct);
|
||||
return Result.Success;
|
||||
}
|
||||
}
|
||||
|
||||
public partial class PkMessageHandler(ILogger logger, IServiceProvider services)
|
||||
{
|
||||
private readonly ILogger _logger = logger.ForContext<PkMessageHandler>();
|
||||
|
||||
[GeneratedRegex(
|
||||
@"^System ID: (\w{5,6}) \| Member ID: (\w{5,6}) \| Sender: .+ \((\d+)\) \| Message ID: (\d+) \| Original Message ID: (\d+)$")]
|
||||
private static partial Regex FooterRegex();
|
||||
|
||||
[GeneratedRegex(@"^https:\/\/discord.com\/channels\/\d+\/(\d+)\/\d+$")]
|
||||
private static partial Regex LinkRegex();
|
||||
|
||||
public async Task HandlePkMessageAsync(IMessageCreate msg)
|
||||
{
|
||||
_logger.Debug("Received PluralKit message");
|
||||
|
||||
await Task.Delay(500.Milliseconds());
|
||||
|
||||
_logger.Debug("Starting handling PluralKit message");
|
||||
|
||||
// Check if the content matches a Discord link--if not, it's not a log message (we already check if this is a PluralKit message earlier)
|
||||
if (!LinkRegex().IsMatch(msg.Content))
|
||||
{
|
||||
_logger.Debug("PluralKit message is not a log message because content is not a link");
|
||||
return;
|
||||
}
|
||||
|
||||
// The first (only, I think always?) embed's footer must match the expected format
|
||||
var firstEmbed = msg.Embeds.FirstOrDefault();
|
||||
if (firstEmbed == null || !firstEmbed.Footer.TryGet(out var footer) ||
|
||||
!FooterRegex().IsMatch(footer.Text))
|
||||
{
|
||||
_logger.Debug(
|
||||
"PK message is not a log message because there is no first embed or its footer doesn't match the regex");
|
||||
return;
|
||||
}
|
||||
|
||||
var match = FooterRegex().Match(footer.Text);
|
||||
|
||||
if (!ulong.TryParse(match.Groups[3].Value, out var authorId))
|
||||
{
|
||||
_logger.Debug("Author ID in PluralKit log {LogMessageId} was not a valid snowflake", msg.ID);
|
||||
return;
|
||||
}
|
||||
|
||||
if (!ulong.TryParse(match.Groups[4].Value, out var msgId))
|
||||
{
|
||||
_logger.Debug("Message ID in PluralKit log {LogMessageId} was not a valid snowflake", msg.ID);
|
||||
return;
|
||||
}
|
||||
|
||||
if (!ulong.TryParse(match.Groups[5].Value, out var originalId))
|
||||
{
|
||||
_logger.Debug("Original ID in PluralKit log {LogMessageId} was not a valid snowflake", msg.ID);
|
||||
return;
|
||||
}
|
||||
|
||||
await using var scope = services.CreateAsyncScope();
|
||||
await using var db = scope.ServiceProvider.GetRequiredService<DatabaseContext>();
|
||||
var messageRepository = scope.ServiceProvider.GetRequiredService<MessageRepository>();
|
||||
|
||||
await messageRepository.SetProxiedMessageDataAsync(msgId, originalId, authorId,
|
||||
systemId: match.Groups[1].Value, memberId: match.Groups[2].Value);
|
||||
|
||||
db.IgnoredMessages.Add(new IgnoredMessage(originalId));
|
||||
await db.SaveChangesAsync();
|
||||
}
|
||||
|
||||
public async Task HandleProxiedMessageAsync(ulong msgId)
|
||||
{
|
||||
await Task.Delay(3.Seconds());
|
||||
|
||||
await using var scope = services.CreateAsyncScope();
|
||||
await using var db = scope.ServiceProvider.GetRequiredService<DatabaseContext>();
|
||||
var messageRepository = scope.ServiceProvider.GetRequiredService<MessageRepository>();
|
||||
var pluralkitApi = scope.ServiceProvider.GetRequiredService<PluralkitApiService>();
|
||||
|
||||
var (isStored, hasProxyInfo) = await messageRepository.HasProxyInfoAsync(msgId);
|
||||
if (!isStored)
|
||||
{
|
||||
_logger.Debug("Message with ID {MessageId} is not stored in the database", msgId);
|
||||
return;
|
||||
}
|
||||
|
||||
if (hasProxyInfo) return;
|
||||
|
||||
var pkMessage = await pluralkitApi.GetPluralKitMessageAsync(msgId);
|
||||
if (pkMessage == null)
|
||||
{
|
||||
_logger.Debug("Message with ID {MessageId} was proxied by PluralKit, but API returned 404", msgId);
|
||||
return;
|
||||
}
|
||||
|
||||
await messageRepository.SetProxiedMessageDataAsync(msgId, pkMessage.Original, pkMessage.Sender,
|
||||
pkMessage.System?.Id, pkMessage.Member?.Id);
|
||||
|
||||
db.IgnoredMessages.Add(new IgnoredMessage(pkMessage.Original));
|
||||
await db.SaveChangesAsync();
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,128 @@
|
|||
using Catalogger.Backend.Cache.InMemoryCache;
|
||||
using Catalogger.Backend.Database;
|
||||
using Catalogger.Backend.Database.Queries;
|
||||
using Catalogger.Backend.Extensions;
|
||||
using Catalogger.Backend.Services;
|
||||
using Humanizer;
|
||||
using NodaTime;
|
||||
using Remora.Discord.API;
|
||||
using Remora.Discord.API.Abstractions.Gateway.Events;
|
||||
using Remora.Discord.API.Abstractions.Objects;
|
||||
using Remora.Discord.API.Objects;
|
||||
using Remora.Discord.Extensions.Embeds;
|
||||
using Remora.Discord.Gateway.Responders;
|
||||
using Remora.Rest.Core;
|
||||
using Remora.Results;
|
||||
|
||||
namespace Catalogger.Backend.Bot.Responders.Messages;
|
||||
|
||||
public class MessageDeleteResponder(
|
||||
ILogger logger,
|
||||
DatabaseContext db,
|
||||
MessageRepository messageRepository,
|
||||
WebhookExecutorService webhookExecutor,
|
||||
ChannelCache channelCache,
|
||||
UserCache userCache,
|
||||
IClock clock,
|
||||
PluralkitApiService pluralkitApi) : IResponder<IMessageDelete>
|
||||
{
|
||||
private readonly ILogger _logger = logger.ForContext<MessageDeleteResponder>();
|
||||
|
||||
private static bool MaybePkProxyTrigger(Snowflake id) => id.Timestamp > DateTimeOffset.Now - 1.Minutes();
|
||||
|
||||
public async Task<Result> RespondAsync(IMessageDelete ev, CancellationToken ct = default)
|
||||
{
|
||||
if (!ev.GuildID.IsDefined()) return Result.Success;
|
||||
|
||||
if (MaybePkProxyTrigger(ev.ID))
|
||||
{
|
||||
_logger.Debug(
|
||||
"Deleted message {MessageId} is less than 1 minute old, delaying 5 seconds to give PK time to catch up",
|
||||
ev.ID);
|
||||
await Task.Delay(5.Seconds(), ct);
|
||||
}
|
||||
|
||||
if (await messageRepository.IsMessageIgnoredAsync(ev.ID.Value, ct)) return Result.Success;
|
||||
|
||||
var guild = await db.GetGuildAsync(ev.GuildID, ct);
|
||||
if (guild.IsMessageIgnored(ev.ChannelID, ev.ID)) return Result.Success;
|
||||
|
||||
var logChannel = webhookExecutor.GetLogChannel(guild, LogChannelType.MessageDelete, ev.ChannelID);
|
||||
var msg = await messageRepository.GetMessageAsync(ev.ID.Value, ct);
|
||||
// Sometimes a message that *should* be logged isn't stored in the database, notify the user of that
|
||||
if (msg == null)
|
||||
{
|
||||
if (logChannel == null) return Result.Success;
|
||||
await webhookExecutor.QueueLogAsync(logChannel.Value, new Embed(
|
||||
Title: "Message deleted",
|
||||
Description: $"A message not found in the database was deleted in <#{ev.ChannelID}> ({ev.ChannelID}).",
|
||||
Footer: new EmbedFooter(Text: $"ID: {ev.ID}"),
|
||||
Timestamp: clock.GetCurrentInstant().ToDateTimeOffset()
|
||||
));
|
||||
|
||||
return Result.Success;
|
||||
}
|
||||
|
||||
// Check if the message is an edit trigger message.
|
||||
// If it is, the API will return a valid message for its ID, but the ID won't match either `Id` or `Original`.
|
||||
// (We also won't have any system/member information stored for it)
|
||||
if (msg is { System: null, Member: null } && MaybePkProxyTrigger(ev.ID) && false)
|
||||
{
|
||||
// TODO: remove the "false" if/when the API is updated to actually return this :neofox_woozy:
|
||||
var pkMsg = await pluralkitApi.GetPluralKitMessageAsync(ev.ID.Value, ct);
|
||||
if (pkMsg != null && pkMsg.Id != ev.ID.Value && pkMsg.Original != ev.ID.Value)
|
||||
{
|
||||
_logger.Debug("Deleted message {MessageId} is a `pk;edit` message, ignoring", ev.ID);
|
||||
return Result.Success;
|
||||
}
|
||||
}
|
||||
|
||||
logChannel = webhookExecutor.GetLogChannel(guild, LogChannelType.MessageDelete, ev.ChannelID, msg.UserId);
|
||||
if (logChannel == null) return Result.Success;
|
||||
|
||||
var user = await userCache.GetUserAsync(DiscordSnowflake.New(msg.UserId));
|
||||
var builder = new EmbedBuilder()
|
||||
.WithTitle("Message deleted")
|
||||
.WithDescription(msg.Content)
|
||||
.WithColour(DiscordUtils.Red)
|
||||
.WithFooter($"ID: {msg.Id}")
|
||||
.WithTimestamp(ev.ID);
|
||||
|
||||
if (user != null)
|
||||
builder.WithAuthor(user.Tag(), url: null, iconUrl: user.AvatarUrl());
|
||||
if (msg.Member != null) builder.WithTitle($"Message by {msg.Username} deleted");
|
||||
|
||||
string channelMention;
|
||||
if (!channelCache.TryGet(ev.ChannelID, out var channel))
|
||||
channelMention = $"<#{msg.ChannelId}>";
|
||||
else if (channel.Type is ChannelType.AnnouncementThread or ChannelType.PrivateThread
|
||||
or ChannelType.PublicThread)
|
||||
channelMention =
|
||||
$"<#{channel.ParentID.Value}>\nID: {channel.ParentID.Value}\n\nThread: {channel.Name} (<#{channel.ID}>)";
|
||||
else channelMention = $"<#{channel.ID}>\nID: {channel.ID}";
|
||||
|
||||
var userMention = user != null
|
||||
? $"<@{user.ID}>\n{user.Tag()}\nID: {user.ID}"
|
||||
: $"<@{msg.UserId}>\nID: {msg.UserId}";
|
||||
|
||||
builder.AddField("Channel", channelMention, true);
|
||||
builder.AddField(msg.System != null ? "Linked Discord account" : "Sender", userMention, true);
|
||||
if (msg is { System: not null, Member: not null })
|
||||
{
|
||||
builder.AddField("\u200b", "**PluralKit information**", false);
|
||||
builder.AddField("System ID", msg.System, true);
|
||||
builder.AddField("Member ID", msg.Member, true);
|
||||
}
|
||||
|
||||
if (msg.Metadata != null)
|
||||
{
|
||||
var attachmentInfo = string.Join("\n",
|
||||
msg.Metadata.Attachments.Select(a =>
|
||||
$"{a.Filename} ({a.ContentType}, {a.Size.Bytes().Humanize()})"));
|
||||
if (!string.IsNullOrWhiteSpace(attachmentInfo)) builder.AddField("Attachments", attachmentInfo, false);
|
||||
}
|
||||
|
||||
await webhookExecutor.QueueLogAsync(logChannel.Value, builder.Build().GetOrThrow());
|
||||
return Result.Success;
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,151 @@
|
|||
using Catalogger.Backend.Cache.InMemoryCache;
|
||||
using Catalogger.Backend.Database;
|
||||
using Catalogger.Backend.Database.Queries;
|
||||
using Catalogger.Backend.Extensions;
|
||||
using Catalogger.Backend.Services;
|
||||
using Remora.Discord.API;
|
||||
using Remora.Discord.API.Abstractions.Gateway.Events;
|
||||
using Remora.Discord.API.Abstractions.Objects;
|
||||
using Remora.Discord.API.Gateway.Events;
|
||||
using Remora.Discord.API.Objects;
|
||||
using Remora.Discord.Extensions.Embeds;
|
||||
using Remora.Discord.Gateway.Responders;
|
||||
using Remora.Results;
|
||||
|
||||
namespace Catalogger.Backend.Bot.Responders.Messages;
|
||||
|
||||
public class MessageUpdateResponder(
|
||||
ILogger logger,
|
||||
DatabaseContext db,
|
||||
ChannelCache channelCache,
|
||||
UserCache userCache,
|
||||
MessageRepository messageRepository,
|
||||
WebhookExecutorService webhookExecutor,
|
||||
PluralkitApiService pluralkitApi) : IResponder<IMessageUpdate>
|
||||
{
|
||||
private readonly ILogger _logger = logger.ForContext<MessageUpdateResponder>();
|
||||
|
||||
public async Task<Result> RespondAsync(IMessageUpdate evt, CancellationToken ct = default)
|
||||
{
|
||||
// Discord only *very* recently changed message update events to have all fields,
|
||||
// so we convert the event to a MessageCreate to avoid having to unwrap every single field
|
||||
var msg = ConvertToMessageCreate(evt);
|
||||
|
||||
if (!msg.GuildID.IsDefined())
|
||||
{
|
||||
_logger.Debug("Received message create event for message {MessageId} despite it not being in a guild",
|
||||
msg.ID);
|
||||
return Result.Success;
|
||||
}
|
||||
|
||||
var guildConfig = await db.GetGuildAsync(msg.GuildID.Value, ct);
|
||||
|
||||
if (await messageRepository.IsMessageIgnoredAsync(msg.ID.Value, ct))
|
||||
{
|
||||
_logger.Debug("Message {MessageId} should be ignored", msg.ID);
|
||||
return Result.Success;
|
||||
}
|
||||
|
||||
try
|
||||
{
|
||||
var logChannel = webhookExecutor.GetLogChannel(guildConfig, LogChannelType.MessageUpdate, msg.ChannelID,
|
||||
msg.Author.ID.Value);
|
||||
if (logChannel == null) return Result.Success;
|
||||
|
||||
var oldMessage = await messageRepository.GetMessageAsync(msg.ID.Value, ct);
|
||||
if (oldMessage == null)
|
||||
{
|
||||
logger.Debug("Message {Id} was edited and should be logged but is not in the database", msg.ID);
|
||||
return Result.Success;
|
||||
}
|
||||
|
||||
if (oldMessage.Content == msg.Content ||
|
||||
(oldMessage.Content == "None" && string.IsNullOrEmpty(msg.Content))) return Result.Success;
|
||||
|
||||
var user = msg.Author;
|
||||
if (msg.Author.ID != oldMessage.UserId)
|
||||
{
|
||||
var systemAccount = await userCache.GetUserAsync(DiscordSnowflake.New(oldMessage.UserId));
|
||||
if (systemAccount != null) user = systemAccount;
|
||||
}
|
||||
|
||||
var embedBuilder = new EmbedBuilder()
|
||||
.WithAuthor(user.Tag(), null, user.AvatarUrl())
|
||||
.WithTitle("Message edited")
|
||||
.WithDescription(oldMessage.Content)
|
||||
.WithColour(DiscordUtils.Purple)
|
||||
.WithFooter($"ID: {msg.ID}")
|
||||
.WithTimestamp(msg.ID.Timestamp);
|
||||
|
||||
var fields = ChunksUpTo(msg.Content, 1000)
|
||||
.Select<string, IEmbedField>((s, i) =>
|
||||
new EmbedField($"New content{(i != 0 ? " (cont.)" : "")}", s, false))
|
||||
.ToList();
|
||||
embedBuilder.SetFields(fields);
|
||||
|
||||
string channelMention;
|
||||
if (!channelCache.TryGet(msg.ChannelID, out var channel))
|
||||
channelMention = $"<#{msg.ChannelID}>";
|
||||
else if (channel.Type is ChannelType.AnnouncementThread or ChannelType.PrivateThread
|
||||
or ChannelType.PublicThread)
|
||||
channelMention =
|
||||
$"<#{channel.ParentID.Value}>\nID: {channel.ParentID.Value}\n\nThread: {channel.Name} (<#{channel.ID}>)";
|
||||
else channelMention = $"<#{channel.ID}>\nID: {channel.ID}";
|
||||
|
||||
embedBuilder.AddField("Channel", channelMention, true);
|
||||
embedBuilder.AddField("Sender", $"<@{user.ID}>\n{user.Tag()}\nID: {user.ID}", true);
|
||||
|
||||
if (oldMessage is { System: not null, Member: not null })
|
||||
{
|
||||
embedBuilder.WithTitle($"Message by {msg.Author.Username} edited");
|
||||
embedBuilder.AddField("\u200b", "**PluralKit information**", false);
|
||||
embedBuilder.AddField("System ID", oldMessage.System, true);
|
||||
embedBuilder.AddField("Member ID", oldMessage.Member, true);
|
||||
}
|
||||
|
||||
embedBuilder.AddField("Link", $"https://discord.com/channels/{msg.GuildID}/{msg.ChannelID}/{msg.ID}");
|
||||
|
||||
await webhookExecutor.QueueLogAsync(logChannel.Value, embedBuilder.Build().GetOrThrow());
|
||||
return Result.Success;
|
||||
}
|
||||
finally
|
||||
{
|
||||
// Messages should be *saved* if any of the message events are enabled for this channel, but should only
|
||||
// be *logged* if the MessageUpdate event is enabled, so we check if we should save here.
|
||||
// You also can't return early in `finally` blocks, so this has to be nested :(
|
||||
if (webhookExecutor.GetLogChannel(guildConfig, LogChannelType.MessageUpdate, msg.ChannelID,
|
||||
msg.Author.ID.Value) != null || webhookExecutor.GetLogChannel(guildConfig,
|
||||
LogChannelType.MessageDelete, msg.ChannelID,
|
||||
msg.Author.ID.Value) != null || webhookExecutor.GetLogChannel(guildConfig,
|
||||
LogChannelType.MessageDeleteBulk, msg.ChannelID,
|
||||
msg.Author.ID.Value) != null)
|
||||
{
|
||||
if (!await messageRepository.UpdateMessageAsync(msg, ct) && msg.ApplicationID.Is(DiscordUtils.PkUserId))
|
||||
{
|
||||
_logger.Debug(
|
||||
"Message {MessageId} wasn't stored yet and was proxied by PluralKit, fetching proxy information from its API",
|
||||
msg.ID);
|
||||
var pkMsg = await pluralkitApi.GetPluralKitMessageAsync(msg.ID.Value, ct);
|
||||
if (pkMsg != null)
|
||||
await messageRepository.SetProxiedMessageDataAsync(msg.ID.Value, pkMsg.Original, pkMsg.Sender,
|
||||
pkMsg.System?.Id, pkMsg.Member?.Id);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private static MessageCreate ConvertToMessageCreate(IMessageUpdate evt) => new(evt.GuildID, evt.Member,
|
||||
evt.Mentions.GetOrThrow(), evt.ID.GetOrThrow(), evt.ChannelID.GetOrThrow(), evt.Author.GetOrThrow(),
|
||||
evt.Content.GetOrThrow(), evt.Timestamp.GetOrThrow(), evt.EditedTimestamp.GetOrThrow(), IsTTS: false,
|
||||
evt.MentionsEveryone.GetOrThrow(), evt.MentionedRoles.GetOrThrow(), evt.MentionedChannels,
|
||||
evt.Attachments.GetOrThrow(), evt.Embeds.GetOrThrow(), evt.Reactions, evt.Nonce, evt.IsPinned.GetOrThrow(),
|
||||
evt.WebhookID, evt.Type.GetOrThrow(), evt.Activity, evt.Application, evt.ApplicationID, evt.MessageReference,
|
||||
evt.Flags, evt.ReferencedMessage, evt.Interaction, evt.Thread, evt.Components, evt.StickerItems, evt.Position,
|
||||
evt.Resolved, evt.InteractionMetadata, evt.Poll);
|
||||
|
||||
private static IEnumerable<string> ChunksUpTo(string str, int maxChunkSize)
|
||||
{
|
||||
for (var i = 0; i < str.Length; i += maxChunkSize)
|
||||
yield return str.Substring(i, Math.Min(maxChunkSize, str.Length - i));
|
||||
}
|
||||
}
|
||||
Loading…
Add table
Add a link
Reference in a new issue