liz/PluralKit
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

feat(bot): allow separate member avatars for proxied messages (#523)

Browse Source 
This allows for using one avatar for the member card, and a different
avatar for proxied messages - so that users can set the main avatar to
a "full" version of their avatar, and the "proxy" avatar to a cropped
version.
This commit is contained in:
the iris system
2023-03-02 06:11:35 +13:00
committed by GitHub
parent 7fffb7f65a
commit ccb89f50e9
12 changed files with 138 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

122
PluralKit.Bot/Commands/MemberAvatar.cs
View File

@@ -15,10 +15,10 @@ public class MemberAvatar
_client = client;
}
private async Task AvatarClear(AvatarLocation location, Context ctx, PKMember target, MemberGuildSettings? mgs)
private async Task AvatarClear(MemberAvatarLocation location, Context ctx, PKMember target, MemberGuildSettings? mgs)
{
await UpdateAvatar(location, ctx, target, null);
if (location == AvatarLocation.Server)
if (location == MemberAvatarLocation.Server)
{
if (target.AvatarUrl != null)
await ctx.Reply(
@@ -26,6 +26,14 @@ public class MemberAvatar
else
await ctx.Reply($"{Emojis.Success} Member server avatar cleared. This member now has no avatar.");
}
else if (location == MemberAvatarLocation.MemberWebhook)
{
if (mgs?.AvatarUrl != null)
await ctx.Reply(
$"{Emojis.Success} Member proxy avatar cleared. Note that this member has a server-specific avatar set here, type `pk;member {target.Reference(ctx)} serveravatar clear` if you wish to clear that too.");
else
await ctx.Reply($"{Emojis.Success} Member proxy avatar cleared. This member will now use the main avatar for proxied messages.");
}
else
{
if (mgs?.AvatarUrl != null)
@@ -36,18 +44,26 @@ public class MemberAvatar
}
}
private async Task AvatarShow(AvatarLocation location, Context ctx, PKMember target,
private async Task AvatarShow(MemberAvatarLocation location, Context ctx, PKMember target,
MemberGuildSettings? guildData)
{
// todo: this privacy code is really confusing
// for now, we skip privacy flag/config parsing for this, but it would be good to fix that at some point
var currentValue = location == AvatarLocation.Member ? target.AvatarUrl : guildData?.AvatarUrl;
var canAccess = location != AvatarLocation.Member ||
var currentValue = location switch
{
MemberAvatarLocation.Server => guildData?.AvatarUrl,
MemberAvatarLocation.MemberWebhook => target.WebhookAvatarUrl,
MemberAvatarLocation.Member => target.AvatarUrl,
_ => throw new ArgumentOutOfRangeException(nameof(location))
};
var canAccess = location == MemberAvatarLocation.Server ||
target.AvatarPrivacy.CanAccess(ctx.DirectLookupContextFor(target.System));
if (string.IsNullOrEmpty(currentValue) || !canAccess)
{
if (location == AvatarLocation.Member)
if (location == MemberAvatarLocation.Member)
{
if (target.System == ctx.System?.Id)
throw new PKSyntaxError(
@@ -55,19 +71,24 @@ public class MemberAvatar
throw new PKError("This member does not have an avatar set.");
}
if (location == AvatarLocation.Server)
if (location == MemberAvatarLocation.MemberWebhook)
throw new PKError(
$"This member does not have a proxy avatar set. Type `pk;member {target.Reference(ctx)} avatar` to see their global avatar.");
if (location == MemberAvatarLocation.Server)
throw new PKError(
$"This member does not have a server avatar set. Type `pk;member {target.Reference(ctx)} avatar` to see their global avatar.");
}
var field = location == AvatarLocation.Server ? $"server avatar (for {ctx.Guild.Name})" : "avatar";
var cmd = location == AvatarLocation.Server ? "serveravatar" : "avatar";
var field = location.Name();
if (location == MemberAvatarLocation.Server)
field += $" (for {ctx.Guild.Name})";
var eb = new EmbedBuilder()
.Title($"{target.NameFor(ctx)}'s {field}")
.Image(new Embed.EmbedImage(currentValue?.TryGetCleanCdnUrl()));
if (target.System == ctx.System?.Id)
eb.Description($"To clear, use `pk;member {target.Reference(ctx)} {cmd} clear`.");
eb.Description($"To clear, use `pk;member {target.Reference(ctx)} {location.Command()} clear`.");
await ctx.Reply(embed: eb.Build());
}
@@ -75,7 +96,7 @@ public class MemberAvatar
{
ctx.CheckGuildContext();
var guildData = await ctx.Repository.GetMemberGuild(ctx.Guild.Id, target.Id);
await AvatarCommandTree(AvatarLocation.Server, ctx, target, guildData);
await AvatarCommandTree(MemberAvatarLocation.Server, ctx, target, guildData);
}
public async Task Avatar(Context ctx, PKMember target)
@@ -84,16 +105,23 @@ public class MemberAvatar
? await ctx.Repository.GetMemberGuild(ctx.Guild.Id, target.Id)
: null;
await AvatarCommandTree(AvatarLocation.Member, ctx, target, guildData);
await AvatarCommandTree(MemberAvatarLocation.Member, ctx, target, guildData);
}
private async Task AvatarCommandTree(AvatarLocation location, Context ctx, PKMember target,
public async Task WebhookAvatar(Context ctx, PKMember target)
{
var guildData = ctx.Guild != null
? await ctx.Repository.GetMemberGuild(ctx.Guild.Id, target.Id)
: null;
await AvatarCommandTree(MemberAvatarLocation.MemberWebhook, ctx, target, guildData);
}
private async Task AvatarCommandTree(MemberAvatarLocation location, Context ctx, PKMember target,
MemberGuildSettings? guildData)
{
// First, see if we need to *clear*
if (ctx.MatchClear() && await ctx.ConfirmClear(location == AvatarLocation.Server
? "this member's server avatar"
: "this member's avatar"))
if (ctx.MatchClear() && await ctx.ConfirmClear("this member's " + location.Name()))
{
ctx.CheckSystem().CheckOwnMember(target);
await AvatarClear(location, ctx, target, guildData);
@@ -115,33 +143,30 @@ public class MemberAvatar
await PrintResponse(location, ctx, target, avatarArg.Value, guildData);
}
private Task PrintResponse(AvatarLocation location, Context ctx, PKMember target, ParsedImage avatar,
private Task PrintResponse(MemberAvatarLocation location, Context ctx, PKMember target, ParsedImage avatar,
MemberGuildSettings? targetGuildData)
{
var typeFrag = location switch
{
AvatarLocation.Server => "server avatar",
AvatarLocation.Member => "avatar",
_ => throw new ArgumentOutOfRangeException(nameof(location))
};
var serverFrag = location switch
{
AvatarLocation.Server =>
MemberAvatarLocation.Server =>
$" This avatar will now be used when proxying in this server (**{ctx.Guild.Name}**).",
AvatarLocation.Member when targetGuildData?.AvatarUrl != null =>
MemberAvatarLocation.Member when targetGuildData?.AvatarUrl != null =>
$"\n{Emojis.Note} Note that this member *also* has a server-specific avatar set in this server (**{ctx.Guild.Name}**), and thus changing the global avatar will have no effect here.",
MemberAvatarLocation.MemberWebhook when targetGuildData?.AvatarUrl != null =>
$" This avatar will now be used for this member's proxied messages, instead of their main avatar.\n{Emojis.Note} Note that this member *also* has a server-specific avatar set in this server (**{ctx.Guild.Name}**), and thus changing the global avatar will have no effect here.",
MemberAvatarLocation.MemberWebhook =>
$" This avatar will now be used for this member's proxied messages, instead of their main avatar.",
_ => ""
};
var msg = avatar.Source switch
{
AvatarSource.User =>
$"{Emojis.Success} Member {typeFrag} changed to {avatar.SourceUser?.Username}'s avatar!{serverFrag}\n{Emojis.Warn} If {avatar.SourceUser?.Username} changes their avatar, the member's avatar will need to be re-set.",
$"{Emojis.Success} Member {location.Name()} changed to {avatar.SourceUser?.Username}'s avatar!{serverFrag}\n{Emojis.Warn} If {avatar.SourceUser?.Username} changes their avatar, the member's avatar will need to be re-set.",
AvatarSource.Url =>
$"{Emojis.Success} Member {typeFrag} changed to the image at the given URL.{serverFrag}",
$"{Emojis.Success} Member {location.Name()} changed to the image at the given URL.{serverFrag}",
AvatarSource.Attachment =>
$"{Emojis.Success} Member {typeFrag} changed to attached image.{serverFrag}\n{Emojis.Warn} If you delete the message containing the attachment, the avatar will stop working.",
$"{Emojis.Success} Member {location.Name()} changed to attached image.{serverFrag}\n{Emojis.Warn} If you delete the message containing the attachment, the avatar will stop working.",
_ => throw new ArgumentOutOfRangeException()
};
@@ -152,18 +177,49 @@ public class MemberAvatar
: ctx.Reply(msg);
}
private Task UpdateAvatar(AvatarLocation location, Context ctx, PKMember target, string? url)
private Task UpdateAvatar(MemberAvatarLocation location, Context ctx, PKMember target, string? url)
{
switch (location)
{
case AvatarLocation.Server:
case MemberAvatarLocation.Server:
return ctx.Repository.UpdateMemberGuild(target.Id, ctx.Guild.Id, new MemberGuildPatch { AvatarUrl = url });
case AvatarLocation.Member:
case MemberAvatarLocation.Member:
return ctx.Repository.UpdateMember(target.Id, new MemberPatch { AvatarUrl = url });
case MemberAvatarLocation.MemberWebhook:
return ctx.Repository.UpdateMember(target.Id, new MemberPatch { WebhookAvatarUrl = url });
default:
throw new ArgumentOutOfRangeException($"Unknown avatar location {location}");
}
}
}
internal enum MemberAvatarLocation
{
Member,
MemberWebhook,
Server,
}
private enum AvatarLocation { Member, Server }
internal static class MemberAvatarLocationExt
{
public static string Name(this MemberAvatarLocation location)
{
return location switch
{
MemberAvatarLocation.Server => "server avatar",
MemberAvatarLocation.MemberWebhook => "proxy avatar",
MemberAvatarLocation.Member => "avatar",
_ => throw new ArgumentOutOfRangeException(nameof(location))
};
}
public static string Command(this MemberAvatarLocation location)
{
return location switch
{
MemberAvatarLocation.Server => "serveravatar",
MemberAvatarLocation.MemberWebhook => "proxyavatar",
MemberAvatarLocation.Member => "avatar",
_ => throw new ArgumentOutOfRangeException(nameof(location))
};
}
}