From f6fb8204bb314d2b824fbbf1cee0ee260c84b757 Mon Sep 17 00:00:00 2001 From: Ske Date: Wed, 23 Dec 2020 02:19:02 +0100 Subject: [PATCH] Add embed builder, some more ported classes --- Myriad/Builders/EmbedBuilder.cs | 86 +++++++++++ Myriad/Extensions/MessageExtensions.cs | 10 +- Myriad/Rest/DiscordApiClient.cs | 6 +- Myriad/Types/Embed.cs | 4 +- PluralKit.Bot/Bot.cs | 14 +- PluralKit.Bot/CommandSystem/Context.cs | 6 +- PluralKit.Bot/Commands/CommandTree.cs | 10 -- PluralKit.Bot/Handlers/MessageCreated.cs | 5 +- PluralKit.Bot/Handlers/MessageDeleted.cs | 9 +- PluralKit.Bot/Handlers/ReactionAdded.cs | 120 +++++++------- PluralKit.Bot/Services/EmbedService.cs | 146 +++++++++--------- PluralKit.Bot/Services/ErrorMessageService.cs | 42 +++-- PluralKit.Bot/Services/LogChannelService.cs | 36 +++-- 13 files changed, 305 insertions(+), 189 deletions(-) create mode 100644 Myriad/Builders/EmbedBuilder.cs diff --git a/Myriad/Builders/EmbedBuilder.cs b/Myriad/Builders/EmbedBuilder.cs new file mode 100644 index 00000000..ecfc3524 --- /dev/null +++ b/Myriad/Builders/EmbedBuilder.cs @@ -0,0 +1,86 @@ +using System.Collections.Generic; + +using Myriad.Types; + +namespace Myriad.Builders +{ + public class EmbedBuilder + { + private Embed _embed = new(); + private readonly List _fields = new(); + + public EmbedBuilder Title(string? title) + { + _embed = _embed with {Title = title}; + return this; + } + + public EmbedBuilder Description(string? description) + { + _embed = _embed with { Description = description}; + return this; + } + + public EmbedBuilder Url(string? url) + { + _embed = _embed with {Url = url}; + return this; + } + + public EmbedBuilder Color(uint? color) + { + _embed = _embed with {Color = color}; + return this; + } + + public EmbedBuilder Footer(Embed.EmbedFooter? footer) + { + _embed = _embed with { + Footer = footer + }; + return this; + } + + public EmbedBuilder Image(Embed.EmbedImage? image) + { + _embed = _embed with { + Image = image + }; + return this; + } + + + public EmbedBuilder Thumbnail(Embed.EmbedThumbnail? thumbnail) + { + _embed = _embed with { + Thumbnail = thumbnail + }; + return this; + } + + public EmbedBuilder Author(Embed.EmbedAuthor? author) + { + _embed = _embed with { + Author = author + }; + return this; + } + + public EmbedBuilder Timestamp(string? timestamp) + { + _embed = _embed with { + Timestamp = timestamp + }; + return this; + } + + public EmbedBuilder Field(Embed.Field field) + { + _fields.Add(field); + return this; + } + + public Embed Build() => + _embed with { Fields = _fields.ToArray() }; + } +} \ No newline at end of file diff --git a/Myriad/Extensions/MessageExtensions.cs b/Myriad/Extensions/MessageExtensions.cs index 7393a9a2..60adb532 100644 --- a/Myriad/Extensions/MessageExtensions.cs +++ b/Myriad/Extensions/MessageExtensions.cs @@ -1,6 +1,14 @@ -namespace Myriad.Extensions +using Myriad.Gateway; +using Myriad.Types; + +namespace Myriad.Extensions { public static class MessageExtensions { + public static string JumpLink(this Message msg) => + $"https://discord.com/channels/{msg.GuildId}/{msg.ChannelId}/{msg.Id}"; + + public static string JumpLink(this MessageReactionAddEvent msg) => + $"https://discord.com/channels/{msg.GuildId}/{msg.ChannelId}/{msg.MessageId}"; } } \ No newline at end of file diff --git a/Myriad/Rest/DiscordApiClient.cs b/Myriad/Rest/DiscordApiClient.cs index 27588b51..71813481 100644 --- a/Myriad/Rest/DiscordApiClient.cs +++ b/Myriad/Rest/DiscordApiClient.cs @@ -39,6 +39,10 @@ namespace Myriad.Rest public Task GetUser(ulong id) => _client.Get($"/users/{id}", ("GetUser", default)); + public Task GetGuildMember(ulong guildId, ulong userId) => + _client.Get($"/guilds/{guildId}/members/{userId}", + ("GetGuildMember", guildId)); + public Task CreateMessage(ulong channelId, MessageRequest request) => _client.Post($"/channels/{channelId}/messages", ("CreateMessage", channelId), request)!; @@ -110,7 +114,7 @@ namespace Myriad.Rest public Task ExecuteWebhook(ulong webhookId, string webhookToken, ExecuteWebhookRequest request, MultipartFile[]? files = null) => - _client.PostMultipart($"/webhooks/{webhookId}/{webhookToken}", + _client.PostMultipart($"/webhooks/{webhookId}/{webhookToken}?wait=true", ("ExecuteWebhook", webhookId), request, files)!; private static string EncodeEmoji(Emoji emoji) => diff --git a/Myriad/Types/Embed.cs b/Myriad/Types/Embed.cs index 46560cb8..7aa09e17 100644 --- a/Myriad/Types/Embed.cs +++ b/Myriad/Types/Embed.cs @@ -1,6 +1,4 @@ -using System.Collections.Generic; - -namespace Myriad.Types +namespace Myriad.Types { public record Embed { diff --git a/PluralKit.Bot/Bot.cs b/PluralKit.Bot/Bot.cs index b7914d91..b73a6db3 100644 --- a/PluralKit.Bot/Bot.cs +++ b/PluralKit.Bot/Bot.cs @@ -11,6 +11,7 @@ using App.Metrics; using Autofac; using Myriad.Cache; +using Myriad.Extensions; using Myriad.Gateway; using Myriad.Rest; using Myriad.Types; @@ -75,8 +76,19 @@ namespace PluralKit.Bot }, null, timeTillNextWholeMinute, TimeSpan.FromMinutes(1)); } - public GuildMemberPartial? BotMemberIn(ulong guildId) => _guildMembers.GetValueOrDefault(guildId); + public PermissionSet PermissionsIn(ulong channelId) + { + var channel = _cache.GetChannel(channelId); + if (channel.GuildId != null) + { + var member = _guildMembers.GetValueOrDefault(channel.GuildId.Value); + return _cache.PermissionsFor(channelId, _cluster.User?.Id ?? default, member?.Roles); + } + + return PermissionSet.Dm; + } + private async Task OnEventReceived(Shard shard, IGatewayEvent evt) { await _cache.HandleGatewayEvent(evt); diff --git a/PluralKit.Bot/CommandSystem/Context.cs b/PluralKit.Bot/CommandSystem/Context.cs index a5d8c29a..1402705e 100644 --- a/PluralKit.Bot/CommandSystem/Context.cs +++ b/PluralKit.Bot/CommandSystem/Context.cs @@ -37,7 +37,6 @@ namespace PluralKit.Bot private readonly Message _messageNew; private readonly Parameters _parameters; private readonly MessageContext _messageContext; - private readonly GuildMemberPartial? _botMember; private readonly PermissionSet _botPermissions; private readonly PermissionSet _userPermissions; @@ -51,7 +50,7 @@ namespace PluralKit.Bot private Command _currentCommand; public Context(ILifetimeScope provider, Shard shard, Guild? guild, Channel channel, MessageCreateEvent message, int commandParseOffset, - PKSystem senderSystem, MessageContext messageContext, GuildMemberPartial? botMember) + PKSystem senderSystem, MessageContext messageContext, PermissionSet botPermissions) { _rest = provider.Resolve(); _client = provider.Resolve(); @@ -61,7 +60,6 @@ namespace PluralKit.Bot _channel = channel; _senderSystem = senderSystem; _messageContext = messageContext; - _botMember = botMember; _cache = provider.Resolve(); _db = provider.Resolve(); _repo = provider.Resolve(); @@ -71,7 +69,7 @@ namespace PluralKit.Bot _parameters = new Parameters(message.Content.Substring(commandParseOffset)); _newRest = provider.Resolve(); - _botPermissions = _cache.PermissionsFor(message.ChannelId, shard.User!.Id, botMember!); + _botPermissions = botPermissions; _userPermissions = _cache.PermissionsFor(message); } diff --git a/PluralKit.Bot/Commands/CommandTree.cs b/PluralKit.Bot/Commands/CommandTree.cs index b29d3816..a5868184 100644 --- a/PluralKit.Bot/Commands/CommandTree.cs +++ b/PluralKit.Bot/Commands/CommandTree.cs @@ -1,8 +1,6 @@ using System.Linq; using System.Threading.Tasks; -using DSharpPlus; - using Humanizer; using PluralKit.Core; @@ -119,14 +117,6 @@ namespace PluralKit.Bot public static Command[] LogCommands = {LogChannel, LogChannelClear, LogEnable, LogDisable}; public static Command[] BlacklistCommands = {BlacklistAdd, BlacklistRemove, BlacklistShow}; - - private DiscordShardedClient _client; - - public CommandTree(DiscordShardedClient client) - { - - _client = client; - } public Task ExecuteCommand(Context ctx) { diff --git a/PluralKit.Bot/Handlers/MessageCreated.cs b/PluralKit.Bot/Handlers/MessageCreated.cs index 0a72c424..cd5a0f00 100644 --- a/PluralKit.Bot/Handlers/MessageCreated.cs +++ b/PluralKit.Bot/Handlers/MessageCreated.cs @@ -114,7 +114,7 @@ namespace PluralKit.Bot try { var system = ctx.SystemId != null ? await _db.Execute(c => _repo.GetSystem(c, ctx.SystemId.Value)) : null; - await _tree.ExecuteCommand(new Context(_services, shard, guild, channel, evt, cmdStart, system, ctx, _bot.BotMemberIn(channel.GuildId!.Value))); + await _tree.ExecuteCommand(new Context(_services, shard, guild, channel, evt, cmdStart, system, ctx, _bot.PermissionsIn(channel.Id))); } catch (PKError) { @@ -147,8 +147,7 @@ namespace PluralKit.Bot private async ValueTask TryHandleProxy(Shard shard, MessageCreateEvent evt, Guild guild, Channel channel, MessageContext ctx) { - var botMember = _bot.BotMemberIn(channel.GuildId!.Value); - var botPermissions = PermissionExtensions.PermissionsFor(guild, channel, shard.User!.Id, botMember!.Roles); + var botPermissions = _bot.PermissionsIn(channel.Id); try { diff --git a/PluralKit.Bot/Handlers/MessageDeleted.cs b/PluralKit.Bot/Handlers/MessageDeleted.cs index 3d2c236c..084ee861 100644 --- a/PluralKit.Bot/Handlers/MessageDeleted.cs +++ b/PluralKit.Bot/Handlers/MessageDeleted.cs @@ -34,7 +34,7 @@ namespace PluralKit.Bot { await Task.Delay(MessageDeleteDelay); // TODO - // await _db.Execute(c => _repo.DeleteMessage(c, evt.Message.Id)); + await _db.Execute(c => _repo.DeleteMessage(c, evt.Id)); } // Fork a task to delete the message after a short delay @@ -49,9 +49,10 @@ namespace PluralKit.Bot async Task Inner() { await Task.Delay(MessageDeleteDelay); - // TODO - // _logger.Information("Bulk deleting {Count} messages in channel {Channel}", evt.Messages.Count, evt.Channel.Id); - // await _db.Execute(c => _repo.DeleteMessagesBulk(c, evt.Messages.Select(m => m.Id).ToList())); + + _logger.Information("Bulk deleting {Count} messages in channel {Channel}", + evt.Ids.Length, evt.ChannelId); + await _db.Execute(c => _repo.DeleteMessagesBulk(c, evt.Ids)); } _ = Inner(); diff --git a/PluralKit.Bot/Handlers/ReactionAdded.cs b/PluralKit.Bot/Handlers/ReactionAdded.cs index 6d2c2a15..9c20c3b0 100644 --- a/PluralKit.Bot/Handlers/ReactionAdded.cs +++ b/PluralKit.Bot/Handlers/ReactionAdded.cs @@ -1,11 +1,13 @@ using System.Threading.Tasks; -using DSharpPlus; -using DSharpPlus.Entities; -using DSharpPlus.EventArgs; -using DSharpPlus.Exceptions; - +using Myriad.Builders; +using Myriad.Cache; +using Myriad.Extensions; using Myriad.Gateway; +using Myriad.Rest; +using Myriad.Rest.Exceptions; +using Myriad.Rest.Types; +using Myriad.Types; using PluralKit.Core; @@ -18,37 +20,42 @@ namespace PluralKit.Bot private readonly IDatabase _db; private readonly ModelRepository _repo; private readonly CommandMessageService _commandMessageService; - private readonly EmbedService _embeds; private readonly ILogger _logger; + private readonly IDiscordCache _cache; + private readonly Bot _bot; + private readonly DiscordApiClient _rest; - public ReactionAdded(EmbedService embeds, ILogger logger, IDatabase db, ModelRepository repo, CommandMessageService commandMessageService) + public ReactionAdded(ILogger logger, IDatabase db, ModelRepository repo, CommandMessageService commandMessageService, IDiscordCache cache, Bot bot, DiscordApiClient rest) { - _embeds = embeds; _db = db; _repo = repo; _commandMessageService = commandMessageService; + _cache = cache; + _bot = bot; + _rest = rest; _logger = logger.ForContext(); } public async Task Handle(Shard shard, MessageReactionAddEvent evt) { - // await TryHandleProxyMessageReactions(shard, evt); + await TryHandleProxyMessageReactions(evt); } - private async ValueTask TryHandleProxyMessageReactions(DiscordClient shard, MessageReactionAddEventArgs evt) + private async ValueTask TryHandleProxyMessageReactions(MessageReactionAddEvent evt) { - // Sometimes we get events from users that aren't in the user cache - // In that case we get a "broken" user object (where eg. calling IsBot throws an exception) // We just ignore all of those for now, should be quite rare... - if (!shard.TryGetCachedUser(evt.User.Id, out _)) return; + if (!_cache.TryGetUser(evt.UserId, out var user)) + return; + + var channel = _cache.GetChannel(evt.ChannelId); // check if it's a command message first // since this can happen in DMs as well if (evt.Emoji.Name == "\u274c") { await using var conn = await _db.Obtain(); - var commandMsg = await _commandMessageService.GetCommandMessage(conn, evt.Message.Id); + var commandMsg = await _commandMessageService.GetCommandMessage(conn, evt.MessageId); if (commandMsg != null) { await HandleCommandDeleteReaction(evt, commandMsg); @@ -57,10 +64,10 @@ namespace PluralKit.Bot } // Only proxies in guild text channels - if (evt.Channel == null || evt.Channel.Type != ChannelType.Text) return; + if (channel.Type != Channel.ChannelType.GuildText) return; // Ignore reactions from bots (we can't DM them anyway) - if (evt.User.IsBot) return; + if (user.Bot) return; switch (evt.Emoji.Name) { @@ -68,7 +75,7 @@ namespace PluralKit.Bot case "\u274C": // Red X { await using var conn = await _db.Obtain(); - var msg = await _repo.GetMessage(conn, evt.Message.Id); + var msg = await _repo.GetMessage(conn, evt.MessageId); if (msg != null) await HandleProxyDeleteReaction(evt, msg); @@ -78,9 +85,9 @@ namespace PluralKit.Bot case "\u2754": // White question mark { await using var conn = await _db.Obtain(); - var msg = await _repo.GetMessage(conn, evt.Message.Id); + var msg = await _repo.GetMessage(conn, evt.MessageId); if (msg != null) - await HandleQueryReaction(shard, evt, msg); + await HandleQueryReaction(evt, msg); break; } @@ -92,7 +99,7 @@ namespace PluralKit.Bot case "\u2757": // Exclamation mark { await using var conn = await _db.Obtain(); - var msg = await _repo.GetMessage(conn, evt.Message.Id); + var msg = await _repo.GetMessage(conn, evt.MessageId); if (msg != null) await HandlePingReaction(evt, msg); break; @@ -100,37 +107,39 @@ namespace PluralKit.Bot } } - private async ValueTask HandleProxyDeleteReaction(MessageReactionAddEventArgs evt, FullMessage msg) + private async ValueTask HandleProxyDeleteReaction(MessageReactionAddEvent evt, FullMessage msg) { - if (!evt.Channel.BotHasAllPermissions(Permissions.ManageMessages)) return; + if (!_bot.PermissionsIn(evt.ChannelId).HasFlag(PermissionSet.ManageMessages)) + return; // Can only delete your own message - if (msg.Message.Sender != evt.User.Id) return; + if (msg.Message.Sender != evt.UserId) return; try { - await evt.Message.DeleteAsync(); + await _rest.DeleteMessage(evt.ChannelId, evt.MessageId); } catch (NotFoundException) { // Message was deleted by something/someone else before we got to it } - await _db.Execute(c => _repo.DeleteMessage(c, evt.Message.Id)); + await _db.Execute(c => _repo.DeleteMessage(c, evt.MessageId)); } - private async ValueTask HandleCommandDeleteReaction(MessageReactionAddEventArgs evt, CommandMessage msg) + private async ValueTask HandleCommandDeleteReaction(MessageReactionAddEvent evt, CommandMessage msg) { - if (!evt.Channel.BotHasAllPermissions(Permissions.ManageMessages) && evt.Channel.Guild != null) + // TODO: why does the bot need manage messages if it's deleting its own messages?? + if (!_bot.PermissionsIn(evt.ChannelId).HasFlag(PermissionSet.ManageMessages)) return; // Can only delete your own message - if (msg.AuthorId != evt.User.Id) + if (msg.AuthorId != evt.UserId) return; try { - await evt.Message.DeleteAsync(); + await _rest.DeleteMessage(evt.ChannelId, evt.MessageId); } catch (NotFoundException) { @@ -140,44 +149,52 @@ namespace PluralKit.Bot // No need to delete database row here, it'll get deleted by the once-per-minute scheduled task. } - private async ValueTask HandleQueryReaction(DiscordClient shard, MessageReactionAddEventArgs evt, FullMessage msg) + private async ValueTask HandleQueryReaction(MessageReactionAddEvent evt, FullMessage msg) { // Try to DM the user info about the message - var member = await evt.Guild.GetMember(evt.User.Id); + // var member = await evt.Guild.GetMember(evt.User.Id); try { - await member.SendMessageAsync(embed: await _embeds.CreateMemberEmbed(msg.System, msg.Member, evt.Guild, LookupContext.ByNonOwner)); - await member.SendMessageAsync(embed: await _embeds.CreateMessageInfoEmbed(shard, msg)); + // TODO: how to DM? + // await member.SendMessageAsync(embed: await _embeds.CreateMemberEmbed(msg.System, msg.Member, evt.Guild, LookupContext.ByNonOwner)); + // await member.SendMessageAsync(embed: await _embeds.CreateMessageInfoEmbed(shard, msg)); } catch (UnauthorizedException) { } // No permissions to DM, can't check for this :( await TryRemoveOriginalReaction(evt); } - private async ValueTask HandlePingReaction(MessageReactionAddEventArgs evt, FullMessage msg) + private async ValueTask HandlePingReaction(MessageReactionAddEvent evt, FullMessage msg) { - if (!evt.Channel.BotHasAllPermissions(Permissions.SendMessages)) return; + if (!_bot.PermissionsIn(evt.ChannelId).HasFlag(PermissionSet.ManageMessages)) + return; // Check if the "pinger" has permission to send messages in this channel // (if not, PK shouldn't send messages on their behalf) - var guildUser = await evt.Guild.GetMember(evt.User.Id); - var requiredPerms = Permissions.AccessChannels | Permissions.SendMessages; - if (guildUser == null || (guildUser.PermissionsIn(evt.Channel) & requiredPerms) != requiredPerms) return; + var member = await _rest.GetGuildMember(evt.GuildId!.Value, evt.UserId); + var requiredPerms = PermissionSet.ViewChannel | PermissionSet.SendMessages; + if (member == null || !_cache.PermissionsFor(evt.ChannelId, member).HasFlag(requiredPerms)) return; if (msg.System.PingsEnabled) { // If the system has pings enabled, go ahead - var embed = new DiscordEmbedBuilder().WithDescription($"[Jump to pinged message]({evt.Message.JumpLink})"); - await evt.Channel.SendMessageFixedAsync($"Psst, **{msg.Member.DisplayName()}** (<@{msg.Message.Sender}>), you have been pinged by <@{evt.User.Id}>.", embed: embed.Build(), - new IMention[] {new UserMention(msg.Message.Sender) }); + var embed = new EmbedBuilder().Description($"[Jump to pinged message]({evt.JumpLink()})"); + await _rest.CreateMessage(evt.ChannelId, new() + { + Content = + $"Psst, **{msg.Member.DisplayName()}** (<@{msg.Message.Sender}>), you have been pinged by <@{evt.UserId}>.", + Embed = embed.Build(), + AllowedMentions = new AllowedMentions {Users = new[] {msg.Message.Sender}} + }); } else { // If not, tell them in DMs (if we can) try { - await guildUser.SendMessageFixedAsync($"{Emojis.Error} {msg.Member.DisplayName()}'s system has disabled reaction pings. If you want to mention them anyway, you can copy/paste the following message:"); - await guildUser.SendMessageFixedAsync($"<@{msg.Message.Sender}>".AsCode()); + // todo: how to dm + // await guildUser.SendMessageFixedAsync($"{Emojis.Error} {msg.Member.DisplayName()}'s system has disabled reaction pings. If you want to mention them anyway, you can copy/paste the following message:"); + // await guildUser.SendMessageFixedAsync($"<@{msg.Message.Sender}>".AsCode()); } catch (UnauthorizedException) { } } @@ -185,21 +202,10 @@ namespace PluralKit.Bot await TryRemoveOriginalReaction(evt); } - private async Task TryRemoveOriginalReaction(MessageReactionAddEventArgs evt) + private async Task TryRemoveOriginalReaction(MessageReactionAddEvent evt) { - try - { - if (evt.Channel.BotHasAllPermissions(Permissions.ManageMessages)) - await evt.Message.DeleteReactionAsync(evt.Emoji, evt.User); - } - catch (UnauthorizedException) - { - var botPerms = evt.Channel.BotPermissions(); - // So, in some cases (see Sentry issue 11K) the above check somehow doesn't work, and - // Discord returns a 403 Unauthorized. TODO: figure out the root cause here instead of a workaround - _logger.Warning("Attempted to remove reaction {Emoji} from user {User} on message {Channel}/{Message}, but got 403. Bot has permissions {Permissions} according to itself.", - evt.Emoji.Id, evt.User.Id, evt.Channel.Id, evt.Message.Id, botPerms); - } + if (_bot.PermissionsIn(evt.ChannelId).HasFlag(PermissionSet.ManageMessages)) + await _rest.DeleteOwnReaction(evt.ChannelId, evt.MessageId, evt.Emoji); } } } \ No newline at end of file diff --git a/PluralKit.Bot/Services/EmbedService.cs b/PluralKit.Bot/Services/EmbedService.cs index 0631d8b1..da8b7d10 100644 --- a/PluralKit.Bot/Services/EmbedService.cs +++ b/PluralKit.Bot/Services/EmbedService.cs @@ -8,6 +8,7 @@ using DSharpPlus.Entities; using Humanizer; +using Myriad.Builders; using Myriad.Cache; using Myriad.Rest; using Myriad.Types; @@ -62,55 +63,52 @@ namespace PluralKit.Bot { var memberCount = cctx.MatchPrivateFlag(ctx) ? await _repo.GetSystemMemberCount(conn, system.Id, PrivacyLevel.Public) : await _repo.GetSystemMemberCount(conn, system.Id); - var embed = new Embed - { - Title = system.Name, - Thumbnail = new(system.AvatarUrl), - Footer = new($"System ID: {system.Hid} | Created on {system.Created.FormatZoned(system)}"), - Color = (uint?) DiscordUtils.Gray.Value - }; - var fields = new List(); - + var eb = new EmbedBuilder() + .Title(system.Name) + .Thumbnail(new(system.AvatarUrl)) + .Footer(new($"System ID: {system.Hid} | Created on {system.Created.FormatZoned(system)}")) + .Color((uint) DiscordUtils.Gray.Value); + var latestSwitch = await _repo.GetLatestSwitch(conn, system.Id); if (latestSwitch != null && system.FrontPrivacy.CanAccess(ctx)) { var switchMembers = await _repo.GetSwitchMembers(conn, latestSwitch.Id).ToListAsync(); if (switchMembers.Count > 0) - fields.Add(new("Fronter".ToQuantity(switchMembers.Count, ShowQuantityAs.None), string.Join(", ", switchMembers.Select(m => m.NameFor(ctx))))); + eb.Field(new("Fronter".ToQuantity(switchMembers.Count, ShowQuantityAs.None), string.Join(", ", switchMembers.Select(m => m.NameFor(ctx))))); } if (system.Tag != null) - fields.Add(new("Tag", system.Tag.EscapeMarkdown())); - fields.Add(new("Linked accounts", string.Join("\n", users).Truncate(1000), true)); + eb.Field(new("Tag", system.Tag.EscapeMarkdown())); + eb.Field(new("Linked accounts", string.Join("\n", users).Truncate(1000), true)); if (system.MemberListPrivacy.CanAccess(ctx)) { if (memberCount > 0) - fields.Add(new($"Members ({memberCount})", $"(see `pk;system {system.Hid} list` or `pk;system {system.Hid} list full`)", true)); + eb.Field(new($"Members ({memberCount})", $"(see `pk;system {system.Hid} list` or `pk;system {system.Hid} list full`)", true)); else - fields.Add(new($"Members ({memberCount})", "Add one with `pk;member new`!", true)); + eb.Field(new($"Members ({memberCount})", "Add one with `pk;member new`!", true)); } if (system.DescriptionFor(ctx) is { } desc) - fields.Add(new("Description", desc.NormalizeLineEndSpacing().Truncate(1024), false)); + eb.Field(new("Description", desc.NormalizeLineEndSpacing().Truncate(1024), false)); - return embed with { Fields = fields.ToArray() }; + return eb.Build(); } - public DiscordEmbed CreateLoggedMessageEmbed(PKSystem system, PKMember member, ulong messageId, ulong originalMsgId, DiscordUser sender, string content, DiscordChannel channel) { + public Embed CreateLoggedMessageEmbed(PKSystem system, PKMember member, ulong messageId, ulong originalMsgId, User sender, string content, Channel channel) { // TODO: pronouns in ?-reacted response using this card var timestamp = DiscordUtils.SnowflakeToInstant(messageId); var name = member.NameFor(LookupContext.ByNonOwner); - return new DiscordEmbedBuilder() - .WithAuthor($"#{channel.Name}: {name}", iconUrl: DiscordUtils.WorkaroundForUrlBug(member.AvatarFor(LookupContext.ByNonOwner))) - .WithThumbnail(member.AvatarFor(LookupContext.ByNonOwner)) - .WithDescription(content?.NormalizeLineEndSpacing()) - .WithFooter($"System ID: {system.Hid} | Member ID: {member.Hid} | Sender: {sender.Username}#{sender.Discriminator} ({sender.Id}) | Message ID: {messageId} | Original Message ID: {originalMsgId}") - .WithTimestamp(timestamp.ToDateTimeOffset()) + return new EmbedBuilder() + .Author(new($"#{channel.Name}: {name}", IconUrl: DiscordUtils.WorkaroundForUrlBug(member.AvatarFor(LookupContext.ByNonOwner)))) + .Thumbnail(new(member.AvatarFor(LookupContext.ByNonOwner))) + .Description(content?.NormalizeLineEndSpacing()) + .Footer(new($"System ID: {system.Hid} | Member ID: {member.Hid} | Sender: {sender.Username}#{sender.Discriminator} ({sender.Id}) | Message ID: {messageId} | Original Message ID: {originalMsgId}")) + .Timestamp(timestamp.ToDateTimeOffset().ToString("O")) .Build(); } - public async Task CreateMemberEmbed(PKSystem system, PKMember member, DiscordGuild guild, LookupContext ctx) + public async Task CreateMemberEmbed(PKSystem system, PKMember member, DiscordGuild guild, LookupContext ctx) { // string FormatTimestamp(Instant timestamp) => DateTimeFormats.ZonedDateTimeFormat.Format(timestamp.InZone(system.Zone)); @@ -141,13 +139,14 @@ namespace PluralKit.Bot { .Where(g => g.Visibility.CanAccess(ctx)) .OrderBy(g => g.Name, StringComparer.InvariantCultureIgnoreCase) .ToListAsync(); - - var eb = new DiscordEmbedBuilder() + + var eb = new EmbedBuilder() // TODO: add URL of website when that's up - .WithAuthor(name, iconUrl: DiscordUtils.WorkaroundForUrlBug(avatar)) + .Author(new(name, IconUrl: DiscordUtils.WorkaroundForUrlBug(avatar))) // .WithColor(member.ColorPrivacy.CanAccess(ctx) ? color : DiscordUtils.Gray) - .WithColor(color) - .WithFooter($"System ID: {system.Hid} | Member ID: {member.Hid} {(member.MetadataPrivacy.CanAccess(ctx) ? $"| Created on {member.Created.FormatZoned(system)}":"")}"); + .Color((uint?) color.Value) + .Footer(new( + $"System ID: {system.Hid} | Member ID: {member.Hid} {(member.MetadataPrivacy.CanAccess(ctx) ? $"| Created on {member.Created.FormatZoned(system)}" : "")}")); var description = ""; if (member.MemberVisibility == PrivacyLevel.Private) description += "*(this member is hidden)*\n"; @@ -156,21 +155,21 @@ namespace PluralKit.Bot { description += $"*(this member has a server-specific avatar set; [click here]({member.AvatarUrl}) to see the global avatar)*\n"; else description += "*(this member has a server-specific avatar set)*\n"; - if (description != "") eb.WithDescription(description); + if (description != "") eb.Description(description); - if (avatar != null) eb.WithThumbnail(avatar); + if (avatar != null) eb.Thumbnail(new(avatar)); - if (!member.DisplayName.EmptyOrNull() && member.NamePrivacy.CanAccess(ctx)) eb.AddField("Display Name", member.DisplayName.Truncate(1024), true); - if (guild != null && guildDisplayName != null) eb.AddField($"Server Nickname (for {guild.Name})", guildDisplayName.Truncate(1024), true); - if (member.BirthdayFor(ctx) != null) eb.AddField("Birthdate", member.BirthdayString, true); - if (member.PronounsFor(ctx) is {} pronouns && !string.IsNullOrWhiteSpace(pronouns)) eb.AddField("Pronouns", pronouns.Truncate(1024), true); - if (member.MessageCountFor(ctx) is {} count && count > 0) eb.AddField("Message Count", member.MessageCount.ToString(), true); - if (member.HasProxyTags) eb.AddField("Proxy Tags", member.ProxyTagsString("\n").Truncate(1024), true); + if (!member.DisplayName.EmptyOrNull() && member.NamePrivacy.CanAccess(ctx)) eb.Field(new("Display Name", member.DisplayName.Truncate(1024), true)); + if (guild != null && guildDisplayName != null) eb.Field(new($"Server Nickname (for {guild.Name})", guildDisplayName.Truncate(1024), true)); + if (member.BirthdayFor(ctx) != null) eb.Field(new("Birthdate", member.BirthdayString, true)); + if (member.PronounsFor(ctx) is {} pronouns && !string.IsNullOrWhiteSpace(pronouns)) eb.Field(new("Pronouns", pronouns.Truncate(1024), true)); + if (member.MessageCountFor(ctx) is {} count && count > 0) eb.Field(new("Message Count", member.MessageCount.ToString(), true)); + if (member.HasProxyTags) eb.Field(new("Proxy Tags", member.ProxyTagsString("\n").Truncate(1024), true)); // --- For when this gets added to the member object itself or however they get added // if (member.LastMessage != null && member.MetadataPrivacy.CanAccess(ctx)) eb.AddField("Last message:" FormatTimestamp(DiscordUtils.SnowflakeToInstant(m.LastMessage.Value))); // if (member.LastSwitchTime != null && m.MetadataPrivacy.CanAccess(ctx)) eb.AddField("Last switched in:", FormatTimestamp(member.LastSwitchTime.Value)); // if (!member.Color.EmptyOrNull() && member.ColorPrivacy.CanAccess(ctx)) eb.AddField("Color", $"#{member.Color}", true); - if (!member.Color.EmptyOrNull()) eb.AddField("Color", $"#{member.Color}", true); + if (!member.Color.EmptyOrNull()) eb.Field(new("Color", $"#{member.Color}", true)); if (groups.Count > 0) { @@ -178,15 +177,16 @@ namespace PluralKit.Bot { var content = groups.Count > 5 ? string.Join(", ", groups.Select(g => g.DisplayName ?? g.Name)) : string.Join("\n", groups.Select(g => $"[`{g.Hid}`] **{g.DisplayName ?? g.Name}**")); - eb.AddField($"Groups ({groups.Count})", content.Truncate(1000)); + eb.Field(new($"Groups ({groups.Count})", content.Truncate(1000))); } - if (member.DescriptionFor(ctx) is {} desc) eb.AddField("Description", member.Description.NormalizeLineEndSpacing(), false); + if (member.DescriptionFor(ctx) is {} desc) + eb.Field(new("Description", member.Description.NormalizeLineEndSpacing(), false)); return eb.Build(); } - public async Task CreateGroupEmbed(Context ctx, PKSystem system, PKGroup target) + public async Task CreateGroupEmbed(Context ctx, PKSystem system, PKGroup target) { await using var conn = await _db.Obtain(); @@ -197,43 +197,43 @@ namespace PluralKit.Bot { if (system.Name != null) nameField = $"{nameField} ({system.Name})"; - var eb = new DiscordEmbedBuilder() - .WithAuthor(nameField, iconUrl: DiscordUtils.WorkaroundForUrlBug(target.IconFor(pctx))) - .WithFooter($"System ID: {system.Hid} | Group ID: {target.Hid} | Created on {target.Created.FormatZoned(system)}"); + var eb = new EmbedBuilder() + .Author(new(nameField, IconUrl: DiscordUtils.WorkaroundForUrlBug(target.IconFor(pctx)))) + .Footer(new($"System ID: {system.Hid} | Group ID: {target.Hid} | Created on {target.Created.FormatZoned(system)}")); if (target.DisplayName != null) - eb.AddField("Display Name", target.DisplayName); + eb.Field(new("Display Name", target.DisplayName)); if (target.ListPrivacy.CanAccess(pctx)) { if (memberCount == 0 && pctx == LookupContext.ByOwner) // Only suggest the add command if this is actually the owner lol - eb.AddField("Members (0)", $"Add one with `pk;group {target.Reference()} add `!", true); + eb.Field(new("Members (0)", $"Add one with `pk;group {target.Reference()} add `!", true)); else - eb.AddField($"Members ({memberCount})", $"(see `pk;group {target.Reference()} list`)", true); + eb.Field(new($"Members ({memberCount})", $"(see `pk;group {target.Reference()} list`)", true)); } - if (target.DescriptionFor(pctx) is {} desc) - eb.AddField("Description", desc); + if (target.DescriptionFor(pctx) is { } desc) + eb.Field(new("Description", desc)); if (target.IconFor(pctx) is {} icon) - eb.WithThumbnail(icon); + eb.Thumbnail(new(icon)); return eb.Build(); } - public async Task CreateFronterEmbed(PKSwitch sw, DateTimeZone zone, LookupContext ctx) + public async Task CreateFronterEmbed(PKSwitch sw, DateTimeZone zone, LookupContext ctx) { var members = await _db.Execute(c => _repo.GetSwitchMembers(c, sw.Id).ToListAsync().AsTask()); var timeSinceSwitch = SystemClock.Instance.GetCurrentInstant() - sw.Timestamp; - return new DiscordEmbedBuilder() - .WithColor(members.FirstOrDefault()?.Color?.ToDiscordColor() ?? DiscordUtils.Gray) - .AddField($"Current {"fronter".ToQuantity(members.Count, ShowQuantityAs.None)}", members.Count > 0 ? string.Join(", ", members.Select(m => m.NameFor(ctx))) : "*(no fronter)*") - .AddField("Since", $"{sw.Timestamp.FormatZoned(zone)} ({timeSinceSwitch.FormatDuration()} ago)") + return new EmbedBuilder() + .Color((uint?) (members.FirstOrDefault()?.Color?.ToDiscordColor()?.Value ?? DiscordUtils.Gray.Value)) + .Field(new($"Current {"fronter".ToQuantity(members.Count, ShowQuantityAs.None)}", members.Count > 0 ? string.Join(", ", members.Select(m => m.NameFor(ctx))) : "*(no fronter)*")) + .Field(new("Since", $"{sw.Timestamp.FormatZoned(zone)} ({timeSinceSwitch.FormatDuration()} ago)")) .Build(); } - public async Task CreateMessageInfoEmbed(DiscordClient client, FullMessage msg) + public async Task CreateMessageInfoEmbed(DiscordClient client, FullMessage msg) { var ctx = LookupContext.ByNonOwner; var channel = await _client.GetChannel(msg.Message.Channel); @@ -257,32 +257,32 @@ namespace PluralKit.Bot { else userStr = $"*(deleted user {msg.Message.Sender})*"; // Put it all together - var eb = new DiscordEmbedBuilder() - .WithAuthor(msg.Member.NameFor(ctx), iconUrl: DiscordUtils.WorkaroundForUrlBug(msg.Member.AvatarFor(ctx))) - .WithDescription(serverMsg?.Content?.NormalizeLineEndSpacing() ?? "*(message contents deleted or inaccessible)*") - .WithImageUrl(serverMsg?.Attachments?.FirstOrDefault()?.Url) - .AddField("System", - msg.System.Name != null ? $"{msg.System.Name} (`{msg.System.Hid}`)" : $"`{msg.System.Hid}`", true) - .AddField("Member", $"{msg.Member.NameFor(ctx)} (`{msg.Member.Hid}`)", true) - .AddField("Sent by", userStr, inline: true) - .WithTimestamp(DiscordUtils.SnowflakeToInstant(msg.Message.Mid).ToDateTimeOffset()); + var eb = new EmbedBuilder() + .Author(new(msg.Member.NameFor(ctx), IconUrl: DiscordUtils.WorkaroundForUrlBug(msg.Member.AvatarFor(ctx)))) + .Description(serverMsg?.Content?.NormalizeLineEndSpacing() ?? "*(message contents deleted or inaccessible)*") + .Image(new(serverMsg?.Attachments?.FirstOrDefault()?.Url)) + .Field(new("System", + msg.System.Name != null ? $"{msg.System.Name} (`{msg.System.Hid}`)" : $"`{msg.System.Hid}`", true)) + .Field(new("Member", $"{msg.Member.NameFor(ctx)} (`{msg.Member.Hid}`)", true)) + .Field(new("Sent by", userStr, true)) + .Timestamp(DiscordUtils.SnowflakeToInstant(msg.Message.Mid).ToDateTimeOffset().ToString("O")); var roles = memberInfo?.Roles?.ToList(); if (roles != null && roles.Count > 0) { var rolesString = string.Join(", ", roles.Select(role => role.Name)); - eb.AddField($"Account roles ({roles.Count})", rolesString.Truncate(1024)); + eb.Field(new($"Account roles ({roles.Count})", rolesString.Truncate(1024))); } return eb.Build(); } - public Task CreateFrontPercentEmbed(FrontBreakdown breakdown, DateTimeZone tz, LookupContext ctx) + public Task CreateFrontPercentEmbed(FrontBreakdown breakdown, DateTimeZone tz, LookupContext ctx) { var actualPeriod = breakdown.RangeEnd - breakdown.RangeStart; - var eb = new DiscordEmbedBuilder() - .WithColor(DiscordUtils.Gray) - .WithFooter($"Since {breakdown.RangeStart.FormatZoned(tz)} ({actualPeriod.FormatDuration()} ago)"); + var eb = new EmbedBuilder() + .Color((uint?) DiscordUtils.Gray.Value) + .Footer(new($"Since {breakdown.RangeStart.FormatZoned(tz)} ({actualPeriod.FormatDuration()} ago)")); var maxEntriesToDisplay = 24; // max 25 fields allowed in embed - reserve 1 for "others" @@ -296,15 +296,15 @@ namespace PluralKit.Bot { foreach (var pair in membersOrdered) { var frac = pair.Value / actualPeriod; - eb.AddField(pair.Key?.NameFor(ctx) ?? "*(no fronter)*", $"{frac*100:F0}% ({pair.Value.FormatDuration()})"); + eb.Field(new(pair.Key?.NameFor(ctx) ?? "*(no fronter)*", $"{frac*100:F0}% ({pair.Value.FormatDuration()})")); } if (membersOrdered.Count > maxEntriesToDisplay) { - eb.AddField("(others)", + eb.Field(new("(others)", membersOrdered.Skip(maxEntriesToDisplay) .Aggregate(Duration.Zero, (prod, next) => prod + next.Value) - .FormatDuration(), true); + .FormatDuration(), true)); } return Task.FromResult(eb.Build()); diff --git a/PluralKit.Bot/Services/ErrorMessageService.cs b/PluralKit.Bot/Services/ErrorMessageService.cs index 1a22e04b..bd4a6581 100644 --- a/PluralKit.Bot/Services/ErrorMessageService.cs +++ b/PluralKit.Bot/Services/ErrorMessageService.cs @@ -4,7 +4,8 @@ using System.Threading.Tasks; using App.Metrics; -using DSharpPlus.Entities; +using Myriad.Builders; +using Myriad.Rest; using NodaTime; @@ -19,54 +20,61 @@ namespace PluralKit.Bot private readonly IMetrics _metrics; private readonly ILogger _logger; + private readonly DiscordApiClient _rest; - public ErrorMessageService(IMetrics metrics, ILogger logger) + public ErrorMessageService(IMetrics metrics, ILogger logger, DiscordApiClient rest) { _metrics = metrics; _logger = logger; + _rest = rest; } - public async Task SendErrorMessage(DiscordChannel channel, string errorId) + public async Task SendErrorMessage(ulong channelId, string errorId) { var now = SystemClock.Instance.GetCurrentInstant(); - if (!ShouldSendErrorMessage(channel, now)) + if (!ShouldSendErrorMessage(channelId, now)) { - _logger.Warning("Rate limited sending error message to {ChannelId} with error code {ErrorId}", channel.Id, errorId); + _logger.Warning("Rate limited sending error message to {ChannelId} with error code {ErrorId}", channelId, errorId); _metrics.Measure.Meter.Mark(BotMetrics.ErrorMessagesSent, "throttled"); return; } - var embed = new DiscordEmbedBuilder() - .WithColor(new DiscordColor(0xE74C3C)) - .WithTitle("Internal error occurred") - .WithDescription("For support, please send the error code above in **#bug-reports-and-errors** on **[the support server *(click to join)*](https://discord.gg/PczBt78)** with a description of what you were doing at the time.") - .WithFooter(errorId) - .WithTimestamp(now.ToDateTimeOffset()); + var embed = new EmbedBuilder() + .Color(0xE74C3C) + .Title("Internal error occurred") + .Description("For support, please send the error code above in **#bug-reports-and-errors** on **[the support server *(click to join)*](https://discord.gg/PczBt78)** with a description of what you were doing at the time.") + .Footer(new(errorId)) + .Timestamp(now.ToDateTimeOffset().ToString("O")); try { - await channel.SendMessageAsync($"> **Error code:** `{errorId}`", embed: embed.Build()); - _logger.Information("Sent error message to {ChannelId} with error code {ErrorId}", channel.Id, errorId); + await _rest.CreateMessage(channelId, new() + { + Content = $"> **Error code:** `{errorId}`", + Embed = embed.Build() + }); + + _logger.Information("Sent error message to {ChannelId} with error code {ErrorId}", channelId, errorId); _metrics.Measure.Meter.Mark(BotMetrics.ErrorMessagesSent, "sent"); } catch (Exception e) { - _logger.Error(e, "Error sending error message to {ChannelId}", channel.Id); + _logger.Error(e, "Error sending error message to {ChannelId}", channelId); _metrics.Measure.Meter.Mark(BotMetrics.ErrorMessagesSent, "failed"); throw; } } - private bool ShouldSendErrorMessage(DiscordChannel channel, Instant now) + private bool ShouldSendErrorMessage(ulong channelId, Instant now) { - if (_lastErrorInChannel.TryGetValue(channel.Id, out var lastErrorTime)) + if (_lastErrorInChannel.TryGetValue(channelId, out var lastErrorTime)) { var interval = now - lastErrorTime; if (interval < MinErrorInterval) return false; } - _lastErrorInChannel[channel.Id] = now; + _lastErrorInChannel[channelId] = now; return true; } } diff --git a/PluralKit.Bot/Services/LogChannelService.cs b/PluralKit.Bot/Services/LogChannelService.cs index c4bad54a..d08e42a7 100644 --- a/PluralKit.Bot/Services/LogChannelService.cs +++ b/PluralKit.Bot/Services/LogChannelService.cs @@ -3,6 +3,7 @@ using System.Threading.Tasks; using Dapper; using Myriad.Cache; +using Myriad.Extensions; using Myriad.Rest; using Myriad.Types; @@ -18,14 +19,16 @@ namespace PluralKit.Bot { private readonly ILogger _logger; private readonly IDiscordCache _cache; private readonly DiscordApiClient _rest; + private readonly Bot _bot; - public LogChannelService(EmbedService embed, ILogger logger, IDatabase db, ModelRepository repo, IDiscordCache cache, DiscordApiClient rest) + public LogChannelService(EmbedService embed, ILogger logger, IDatabase db, ModelRepository repo, IDiscordCache cache, DiscordApiClient rest, Bot bot) { _embed = embed; _db = db; _repo = repo; _cache = cache; _rest = rest; + _bot = bot; _logger = logger.ForContext(); } @@ -36,25 +39,28 @@ namespace PluralKit.Bot { // Find log channel and check if valid var logChannel = await FindLogChannel(trigger.GuildId!.Value, ctx.LogChannel.Value); if (logChannel == null || logChannel.Type != Channel.ChannelType.GuildText) return; + + var triggerChannel = _cache.GetChannel(trigger.ChannelId); // Check bot permissions - // if (!logChannel.BotHasAllPermissions(Permissions.SendMessages | Permissions.EmbedLinks)) - // { - // _logger.Information( - // "Does not have permission to proxy log, ignoring (channel: {ChannelId}, guild: {GuildId}, bot permissions: {BotPermissions})", - // ctx.LogChannel.Value, trigger.GuildId!.Value, trigger.Channel.BotPermissions()); - // return; - // } - // + var perms = _bot.PermissionsIn(logChannel.Id); + if (!perms.HasFlag(PermissionSet.SendMessages | PermissionSet.EmbedLinks)) + { + _logger.Information( + "Does not have permission to proxy log, ignoring (channel: {ChannelId}, guild: {GuildId}, bot permissions: {BotPermissions})", + ctx.LogChannel.Value, trigger.GuildId!.Value, perms); + return; + } + // Send embed! // TODO: fix? - // await using var conn = await _db.Obtain(); - // var embed = _embed.CreateLoggedMessageEmbed(await _repo.GetSystem(conn, ctx.SystemId.Value), - // await _repo.GetMember(conn, proxy.Member.Id), hookMessage, trigger.Id, trigger.Author, proxy.Content, - // trigger.Channel); - // var url = $"https://discord.com/channels/{trigger.Channel.GuildId}/{trigger.ChannelId}/{hookMessage}"; - // await logChannel.SendMessageFixedAsync(content: url, embed: embed); + await using var conn = await _db.Obtain(); + var embed = _embed.CreateLoggedMessageEmbed(await _repo.GetSystem(conn, ctx.SystemId.Value), + await _repo.GetMember(conn, proxy.Member.Id), hookMessage, trigger.Id, trigger.Author, proxy.Content, + triggerChannel); + var url = $"https://discord.com/channels/{trigger.GuildId}/{trigger.ChannelId}/{hookMessage}"; + await _rest.CreateMessage(logChannel.Id, new() {Content = url, Embed = embed}); } private async Task FindLogChannel(ulong guildId, ulong channelId)