Refactor data stores, merging the Store classes
This commit is contained in:
@@ -110,10 +110,7 @@ namespace PluralKit.Bot
|
||||
.AddTransient<ProxyCacheService>()
|
||||
.AddSingleton<WebhookCacheService>()
|
||||
|
||||
.AddTransient<SystemStore>()
|
||||
.AddTransient<MemberStore>()
|
||||
.AddTransient<MessageStore>()
|
||||
.AddTransient<SwitchStore>()
|
||||
.AddTransient<IDataStore, PostgresDataStore>()
|
||||
|
||||
.AddSingleton(svc => InitUtils.InitMetrics(svc.GetRequiredService<CoreConfig>()))
|
||||
.AddSingleton<PeriodicStatCollector>()
|
||||
|
||||
@@ -17,8 +17,7 @@ namespace PluralKit.Bot.CommandSystem
|
||||
private readonly SocketUserMessage _message;
|
||||
private readonly Parameters _parameters;
|
||||
|
||||
private readonly SystemStore _systems;
|
||||
private readonly MemberStore _members;
|
||||
private readonly IDataStore _data;
|
||||
private readonly PKSystem _senderSystem;
|
||||
|
||||
private Command _currentCommand;
|
||||
@@ -28,8 +27,7 @@ namespace PluralKit.Bot.CommandSystem
|
||||
{
|
||||
_client = provider.GetRequiredService<IDiscordClient>() as DiscordShardedClient;
|
||||
_message = message;
|
||||
_systems = provider.GetRequiredService<SystemStore>();
|
||||
_members = provider.GetRequiredService<MemberStore>();
|
||||
_data = provider.GetRequiredService<IDataStore>();
|
||||
_senderSystem = senderSystem;
|
||||
_provider = provider;
|
||||
_parameters = new Parameters(message.Content.Substring(commandParseOffset));
|
||||
@@ -86,7 +84,7 @@ namespace PluralKit.Bot.CommandSystem
|
||||
{
|
||||
await Reply($"{Emojis.Error} {e.Message}");
|
||||
}
|
||||
catch (TimeoutException e)
|
||||
catch (TimeoutException)
|
||||
{
|
||||
// Got a complaint the old error was a bit too patronizing. Hopefully this is better?
|
||||
await Reply($"{Emojis.Error} Operation timed out, sorry. Try again, perhaps?");
|
||||
@@ -121,10 +119,10 @@ namespace PluralKit.Bot.CommandSystem
|
||||
|
||||
// Direct IDs and mentions are both handled by the below method:
|
||||
if (input.TryParseMention(out var id))
|
||||
return await _systems.GetByAccount(id);
|
||||
return await _data.GetSystemByAccount(id);
|
||||
|
||||
// Finally, try HID parsing
|
||||
var system = await _systems.GetByHid(input);
|
||||
var system = await _data.GetSystemByHid(input);
|
||||
return system;
|
||||
}
|
||||
|
||||
@@ -138,11 +136,11 @@ namespace PluralKit.Bot.CommandSystem
|
||||
// - A textual name of a member *in your own system*
|
||||
|
||||
// First, try member HID parsing:
|
||||
if (await _members.GetByHid(input) is PKMember memberByHid)
|
||||
if (await _data.GetMemberByHid(input) is PKMember memberByHid)
|
||||
return memberByHid;
|
||||
|
||||
// Then, if we have a system, try finding by member name in system
|
||||
if (_senderSystem != null && await _members.GetByName(_senderSystem, input) is PKMember memberByName)
|
||||
if (_senderSystem != null && await _data.GetMemberByName(_senderSystem, input) is PKMember memberByName)
|
||||
return memberByName;
|
||||
|
||||
// We didn't find anything, so we return null.
|
||||
|
||||
@@ -7,10 +7,10 @@ namespace PluralKit.Bot.Commands
|
||||
{
|
||||
public class APICommands
|
||||
{
|
||||
private SystemStore _systems;
|
||||
public APICommands(SystemStore systems)
|
||||
private IDataStore _data;
|
||||
public APICommands(IDataStore data)
|
||||
{
|
||||
_systems = systems;
|
||||
_data = data;
|
||||
}
|
||||
|
||||
public async Task GetToken(Context ctx)
|
||||
@@ -34,7 +34,7 @@ namespace PluralKit.Bot.Commands
|
||||
private async Task<string> MakeAndSetNewToken(PKSystem system)
|
||||
{
|
||||
system.Token = PluralKit.Utils.GenerateToken();
|
||||
await _systems.Save(system);
|
||||
await _data.SaveSystem(system);
|
||||
return system.Token;
|
||||
}
|
||||
|
||||
|
||||
@@ -8,11 +8,11 @@ namespace PluralKit.Bot.Commands
|
||||
{
|
||||
public class LinkCommands
|
||||
{
|
||||
private SystemStore _systems;
|
||||
private IDataStore _data;
|
||||
|
||||
public LinkCommands(SystemStore systems)
|
||||
public LinkCommands(IDataStore data)
|
||||
{
|
||||
_systems = systems;
|
||||
_data = data;
|
||||
}
|
||||
|
||||
public async Task LinkSystem(Context ctx)
|
||||
@@ -20,15 +20,15 @@ namespace PluralKit.Bot.Commands
|
||||
ctx.CheckSystem();
|
||||
|
||||
var account = await ctx.MatchUser() ?? throw new PKSyntaxError("You must pass an account to link with (either ID or @mention).");
|
||||
var accountIds = await _systems.GetLinkedAccountIds(ctx.System);
|
||||
var accountIds = await _data.GetSystemAccounts(ctx.System);
|
||||
if (accountIds.Contains(account.Id)) throw Errors.AccountAlreadyLinked;
|
||||
|
||||
var existingAccount = await _systems.GetByAccount(account.Id);
|
||||
var existingAccount = await _data.GetSystemByAccount(account.Id);
|
||||
if (existingAccount != null) throw Errors.AccountInOtherSystem(existingAccount);
|
||||
|
||||
var msg = await ctx.Reply($"{account.Mention}, please confirm the link by clicking the {Emojis.Success} reaction on this message.");
|
||||
if (!await ctx.PromptYesNo(msg, user: account)) throw Errors.MemberLinkCancelled;
|
||||
await _systems.Link(ctx.System, account.Id);
|
||||
await _data.AddAccount(ctx.System, account.Id);
|
||||
await ctx.Reply($"{Emojis.Success} Account linked to system.");
|
||||
}
|
||||
|
||||
@@ -42,7 +42,7 @@ namespace PluralKit.Bot.Commands
|
||||
else
|
||||
account = await ctx.MatchUser() ?? throw new PKSyntaxError("You must pass an account to link with (either ID or @mention).");
|
||||
|
||||
var accountIds = (await _systems.GetLinkedAccountIds(ctx.System)).ToList();
|
||||
var accountIds = (await _data.GetSystemAccounts(ctx.System)).ToList();
|
||||
if (!accountIds.Contains(account.Id)) throw Errors.AccountNotLinked;
|
||||
if (accountIds.Count == 1) throw Errors.UnlinkingLastAccount;
|
||||
|
||||
@@ -50,7 +50,7 @@ namespace PluralKit.Bot.Commands
|
||||
$"Are you sure you want to unlink {account.Mention} from your system?");
|
||||
if (!await ctx.PromptYesNo(msg)) throw Errors.MemberUnlinkCancelled;
|
||||
|
||||
await _systems.Unlink(ctx.System, account.Id);
|
||||
await _data.RemoveAccount(ctx.System, account.Id);
|
||||
await ctx.Reply($"{Emojis.Success} Account unlinked.");
|
||||
}
|
||||
}
|
||||
|
||||
@@ -11,16 +11,14 @@ namespace PluralKit.Bot.Commands
|
||||
{
|
||||
public class MemberCommands
|
||||
{
|
||||
private SystemStore _systems;
|
||||
private MemberStore _members;
|
||||
private IDataStore _data;
|
||||
private EmbedService _embeds;
|
||||
|
||||
private ProxyCacheService _proxyCache;
|
||||
|
||||
public MemberCommands(SystemStore systems, MemberStore members, EmbedService embeds, ProxyCacheService proxyCache)
|
||||
public MemberCommands(IDataStore data, EmbedService embeds, ProxyCacheService proxyCache)
|
||||
{
|
||||
_systems = systems;
|
||||
_members = members;
|
||||
_data = data;
|
||||
_embeds = embeds;
|
||||
_proxyCache = proxyCache;
|
||||
}
|
||||
@@ -39,19 +37,19 @@ namespace PluralKit.Bot.Commands
|
||||
}
|
||||
|
||||
// Warn if there's already a member by this name
|
||||
var existingMember = await _members.GetByName(ctx.System, memberName);
|
||||
var existingMember = await _data.GetMemberByName(ctx.System, memberName);
|
||||
if (existingMember != null) {
|
||||
var msg = await ctx.Reply($"{Emojis.Warn} You already have a member in your system with the name \"{existingMember.Name.SanitizeMentions()}\" (with ID `{existingMember.Hid}`). Do you want to create another member with the same name?");
|
||||
if (!await ctx.PromptYesNo(msg)) throw new PKError("Member creation cancelled.");
|
||||
}
|
||||
|
||||
// Enforce per-system member limit
|
||||
var memberCount = await _members.MemberCount(ctx.System);
|
||||
var memberCount = await _data.GetSystemMemberCount(ctx.System);
|
||||
if (memberCount >= Limits.MaxMemberCount)
|
||||
throw Errors.MemberLimitReachedError;
|
||||
|
||||
// Create the member
|
||||
var member = await _members.Create(ctx.System, memberName);
|
||||
var member = await _data.CreateMember(ctx.System, memberName);
|
||||
memberCount++;
|
||||
|
||||
// Send confirmation and space hint
|
||||
@@ -83,7 +81,7 @@ namespace PluralKit.Bot.Commands
|
||||
}
|
||||
|
||||
// Warn if there's already a member by this name
|
||||
var existingMember = await _members.GetByName(ctx.System, newName);
|
||||
var existingMember = await _data.GetMemberByName(ctx.System, newName);
|
||||
if (existingMember != null) {
|
||||
var msg = await ctx.Reply($"{Emojis.Warn} You already have a member in your system with the name \"{existingMember.Name.SanitizeMentions()}\" (`{existingMember.Hid}`). Do you want to rename this member to that name too?");
|
||||
if (!await ctx.PromptYesNo(msg)) throw new PKError("Member renaming cancelled.");
|
||||
@@ -91,7 +89,7 @@ namespace PluralKit.Bot.Commands
|
||||
|
||||
// Rename the member
|
||||
target.Name = newName;
|
||||
await _members.Save(target);
|
||||
await _data.SaveMember(target);
|
||||
|
||||
await ctx.Reply($"{Emojis.Success} Member renamed.");
|
||||
if (newName.Contains(" ")) await ctx.Reply($"{Emojis.Note} Note that this member's name now contains spaces. You will need to surround it with \"double quotes\" when using commands referring to it.");
|
||||
@@ -108,7 +106,7 @@ namespace PluralKit.Bot.Commands
|
||||
if (description.IsLongerThan(Limits.MaxDescriptionLength)) throw Errors.DescriptionTooLongError(description.Length);
|
||||
|
||||
target.Description = description;
|
||||
await _members.Save(target);
|
||||
await _data.SaveMember(target);
|
||||
|
||||
await ctx.Reply($"{Emojis.Success} Member description {(description == null ? "cleared" : "changed")}.");
|
||||
}
|
||||
@@ -121,7 +119,7 @@ namespace PluralKit.Bot.Commands
|
||||
if (pronouns.IsLongerThan(Limits.MaxPronounsLength)) throw Errors.MemberPronounsTooLongError(pronouns.Length);
|
||||
|
||||
target.Pronouns = pronouns;
|
||||
await _members.Save(target);
|
||||
await _data.SaveMember(target);
|
||||
|
||||
await ctx.Reply($"{Emojis.Success} Member pronouns {(pronouns == null ? "cleared" : "changed")}.");
|
||||
}
|
||||
@@ -139,7 +137,7 @@ namespace PluralKit.Bot.Commands
|
||||
}
|
||||
|
||||
target.Color = color;
|
||||
await _members.Save(target);
|
||||
await _data.SaveMember(target);
|
||||
|
||||
await ctx.Reply($"{Emojis.Success} Member color {(color == null ? "cleared" : "changed")}.");
|
||||
}
|
||||
@@ -158,7 +156,7 @@ namespace PluralKit.Bot.Commands
|
||||
}
|
||||
|
||||
target.Birthday = date;
|
||||
await _members.Save(target);
|
||||
await _data.SaveMember(target);
|
||||
|
||||
await ctx.Reply($"{Emojis.Success} Member birthdate {(date == null ? "cleared" : $"changed to {target.BirthdayString}")}.");
|
||||
}
|
||||
@@ -175,7 +173,7 @@ namespace PluralKit.Bot.Commands
|
||||
// Just reset and send OK message
|
||||
target.Prefix = null;
|
||||
target.Suffix = null;
|
||||
await _members.Save(target);
|
||||
await _data.SaveMember(target);
|
||||
await ctx.Reply($"{Emojis.Success} Member proxy tags cleared.");
|
||||
return;
|
||||
}
|
||||
@@ -188,7 +186,7 @@ namespace PluralKit.Bot.Commands
|
||||
// If the prefix/suffix is empty, use "null" instead (for DB)
|
||||
target.Prefix = prefixAndSuffix[0].Length > 0 ? prefixAndSuffix[0] : null;
|
||||
target.Suffix = prefixAndSuffix[1].Length > 0 ? prefixAndSuffix[1] : null;
|
||||
await _members.Save(target);
|
||||
await _data.SaveMember(target);
|
||||
await ctx.Reply($"{Emojis.Success} Member proxy tags changed to `{target.ProxyString.SanitizeMentions()}`. Try proxying now!");
|
||||
|
||||
await _proxyCache.InvalidateResultsForSystem(ctx.System);
|
||||
@@ -201,7 +199,7 @@ namespace PluralKit.Bot.Commands
|
||||
|
||||
await ctx.Reply($"{Emojis.Warn} Are you sure you want to delete \"{target.Name.SanitizeMentions()}\"? If so, reply to this message with the member's ID (`{target.Hid}`). __***This cannot be undone!***__");
|
||||
if (!await ctx.ConfirmWithReply(target.Hid)) throw Errors.MemberDeleteCancelled;
|
||||
await _members.Delete(target);
|
||||
await _data.DeleteMember(target);
|
||||
await ctx.Reply($"{Emojis.Success} Member deleted.");
|
||||
|
||||
await _proxyCache.InvalidateResultsForSystem(ctx.System);
|
||||
@@ -217,7 +215,7 @@ namespace PluralKit.Bot.Commands
|
||||
if (user.AvatarId == null) throw Errors.UserHasNoAvatar;
|
||||
target.AvatarUrl = user.GetAvatarUrl(ImageFormat.Png, size: 256);
|
||||
|
||||
await _members.Save(target);
|
||||
await _data.SaveMember(target);
|
||||
|
||||
var embed = new EmbedBuilder().WithImageUrl(target.AvatarUrl).Build();
|
||||
await ctx.Reply(
|
||||
@@ -228,7 +226,7 @@ namespace PluralKit.Bot.Commands
|
||||
{
|
||||
await Utils.VerifyAvatarOrThrow(url);
|
||||
target.AvatarUrl = url;
|
||||
await _members.Save(target);
|
||||
await _data.SaveMember(target);
|
||||
|
||||
var embed = new EmbedBuilder().WithImageUrl(url).Build();
|
||||
await ctx.Reply($"{Emojis.Success} Member avatar changed.", embed: embed);
|
||||
@@ -237,14 +235,14 @@ namespace PluralKit.Bot.Commands
|
||||
{
|
||||
await Utils.VerifyAvatarOrThrow(attachment.Url);
|
||||
target.AvatarUrl = attachment.Url;
|
||||
await _members.Save(target);
|
||||
await _data.SaveMember(target);
|
||||
|
||||
await ctx.Reply($"{Emojis.Success} Member avatar changed to attached image. Please note that if you delete the message containing the attachment, the avatar will stop working.");
|
||||
}
|
||||
else
|
||||
{
|
||||
target.AvatarUrl = null;
|
||||
await _members.Save(target);
|
||||
await _data.SaveMember(target);
|
||||
await ctx.Reply($"{Emojis.Success} Member avatar cleared.");
|
||||
}
|
||||
|
||||
@@ -262,7 +260,7 @@ namespace PluralKit.Bot.Commands
|
||||
throw Errors.DisplayNameTooLong(newDisplayName, ctx.System.MaxMemberNameLength);
|
||||
|
||||
target.DisplayName = newDisplayName;
|
||||
await _members.Save(target);
|
||||
await _data.SaveMember(target);
|
||||
|
||||
var successStr = $"{Emojis.Success} ";
|
||||
if (newDisplayName != null)
|
||||
@@ -288,7 +286,7 @@ namespace PluralKit.Bot.Commands
|
||||
|
||||
public async Task ViewMember(Context ctx, PKMember target)
|
||||
{
|
||||
var system = await _systems.GetById(target.System);
|
||||
var system = await _data.GetSystemById(target.System);
|
||||
await ctx.Reply(embed: await _embeds.CreateMemberEmbed(system, target));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -9,14 +9,14 @@ namespace PluralKit.Bot.Commands
|
||||
public class ModCommands
|
||||
{
|
||||
private LogChannelService _logChannels;
|
||||
private MessageStore _messages;
|
||||
private IDataStore _data;
|
||||
|
||||
private EmbedService _embeds;
|
||||
|
||||
public ModCommands(LogChannelService logChannels, MessageStore messages, EmbedService embeds)
|
||||
public ModCommands(LogChannelService logChannels, IDataStore data, EmbedService embeds)
|
||||
{
|
||||
_logChannels = logChannels;
|
||||
_messages = messages;
|
||||
_data = data;
|
||||
_embeds = embeds;
|
||||
}
|
||||
|
||||
@@ -47,7 +47,7 @@ namespace PluralKit.Bot.Commands
|
||||
messageId = ulong.Parse(match.Groups[1].Value);
|
||||
else throw new PKSyntaxError($"Could not parse `{word}` as a message ID or link.");
|
||||
|
||||
var message = await _messages.Get(messageId);
|
||||
var message = await _data.GetMessage(messageId);
|
||||
if (message == null) throw Errors.MessageNotFound(messageId);
|
||||
|
||||
await ctx.Reply(embed: await _embeds.CreateMessageInfoEmbed(message));
|
||||
|
||||
@@ -12,11 +12,11 @@ namespace PluralKit.Bot.Commands
|
||||
{
|
||||
public class SwitchCommands
|
||||
{
|
||||
private SwitchStore _switches;
|
||||
private IDataStore _data;
|
||||
|
||||
public SwitchCommands(SwitchStore switches)
|
||||
public SwitchCommands(IDataStore data)
|
||||
{
|
||||
_switches = switches;
|
||||
_data = data;
|
||||
}
|
||||
|
||||
public async Task Switch(Context ctx)
|
||||
@@ -55,16 +55,16 @@ namespace PluralKit.Bot.Commands
|
||||
if (members.Select(m => m.Id).Distinct().Count() != members.Count) throw Errors.DuplicateSwitchMembers;
|
||||
|
||||
// Find the last switch and its members if applicable
|
||||
var lastSwitch = await _switches.GetLatestSwitch(ctx.System);
|
||||
var lastSwitch = await _data.GetLatestSwitch(ctx.System);
|
||||
if (lastSwitch != null)
|
||||
{
|
||||
var lastSwitchMembers = await _switches.GetSwitchMembers(lastSwitch);
|
||||
var lastSwitchMembers = await _data.GetSwitchMembers(lastSwitch);
|
||||
// Make sure the requested switch isn't identical to the last one
|
||||
if (lastSwitchMembers.Select(m => m.Id).SequenceEqual(members.Select(m => m.Id)))
|
||||
throw Errors.SameSwitch(members);
|
||||
}
|
||||
|
||||
await _switches.RegisterSwitch(ctx.System, members);
|
||||
await _data.AddSwitch(ctx.System, members);
|
||||
|
||||
if (members.Count == 0)
|
||||
await ctx.Reply($"{Emojis.Success} Switch-out registered.");
|
||||
@@ -86,7 +86,7 @@ namespace PluralKit.Bot.Commands
|
||||
if (time.ToInstant() > SystemClock.Instance.GetCurrentInstant()) throw Errors.SwitchTimeInFuture;
|
||||
|
||||
// Fetch the last two switches for the system to do bounds checking on
|
||||
var lastTwoSwitches = (await _switches.GetSwitches(ctx.System, 2)).ToArray();
|
||||
var lastTwoSwitches = (await _data.GetSwitches(ctx.System, 2)).ToArray();
|
||||
|
||||
// If we don't have a switch to move, don't bother
|
||||
if (lastTwoSwitches.Length == 0) throw Errors.NoRegisteredSwitches;
|
||||
@@ -100,7 +100,7 @@ namespace PluralKit.Bot.Commands
|
||||
|
||||
// Now we can actually do the move, yay!
|
||||
// But, we do a prompt to confirm.
|
||||
var lastSwitchMembers = await _switches.GetSwitchMembers(lastTwoSwitches[0]);
|
||||
var lastSwitchMembers = await _data.GetSwitchMembers(lastTwoSwitches[0]);
|
||||
var lastSwitchMemberStr = string.Join(", ", lastSwitchMembers.Select(m => m.Name));
|
||||
var lastSwitchTimeStr = Formats.ZonedDateTimeFormat.Format(lastTwoSwitches[0].Timestamp.InZone(ctx.System.Zone));
|
||||
var lastSwitchDeltaStr = Formats.DurationFormat.Format(SystemClock.Instance.GetCurrentInstant() - lastTwoSwitches[0].Timestamp);
|
||||
@@ -112,7 +112,7 @@ namespace PluralKit.Bot.Commands
|
||||
if (!await ctx.PromptYesNo(msg)) throw Errors.SwitchMoveCancelled;
|
||||
|
||||
// aaaand *now* we do the move
|
||||
await _switches.MoveSwitch(lastTwoSwitches[0], time.ToInstant());
|
||||
await _data.MoveSwitch(lastTwoSwitches[0], time.ToInstant());
|
||||
await ctx.Reply($"{Emojis.Success} Switch moved.");
|
||||
}
|
||||
|
||||
@@ -121,10 +121,10 @@ namespace PluralKit.Bot.Commands
|
||||
ctx.CheckSystem();
|
||||
|
||||
// Fetch the last two switches for the system to do bounds checking on
|
||||
var lastTwoSwitches = (await _switches.GetSwitches(ctx.System, 2)).ToArray();
|
||||
var lastTwoSwitches = (await _data.GetSwitches(ctx.System, 2)).ToArray();
|
||||
if (lastTwoSwitches.Length == 0) throw Errors.NoRegisteredSwitches;
|
||||
|
||||
var lastSwitchMembers = await _switches.GetSwitchMembers(lastTwoSwitches[0]);
|
||||
var lastSwitchMembers = await _data.GetSwitchMembers(lastTwoSwitches[0]);
|
||||
var lastSwitchMemberStr = string.Join(", ", lastSwitchMembers.Select(m => m.Name));
|
||||
var lastSwitchDeltaStr = Formats.DurationFormat.Format(SystemClock.Instance.GetCurrentInstant() - lastTwoSwitches[0].Timestamp);
|
||||
|
||||
@@ -136,7 +136,7 @@ namespace PluralKit.Bot.Commands
|
||||
}
|
||||
else
|
||||
{
|
||||
var secondSwitchMembers = await _switches.GetSwitchMembers(lastTwoSwitches[1]);
|
||||
var secondSwitchMembers = await _data.GetSwitchMembers(lastTwoSwitches[1]);
|
||||
var secondSwitchMemberStr = string.Join(", ", secondSwitchMembers.Select(m => m.Name));
|
||||
var secondSwitchDeltaStr = Formats.DurationFormat.Format(SystemClock.Instance.GetCurrentInstant() - lastTwoSwitches[1].Timestamp);
|
||||
msg = await ctx.Reply(
|
||||
@@ -144,7 +144,7 @@ namespace PluralKit.Bot.Commands
|
||||
}
|
||||
|
||||
if (!await ctx.PromptYesNo(msg)) throw Errors.SwitchDeleteCancelled;
|
||||
await _switches.DeleteSwitch(lastTwoSwitches[0]);
|
||||
await _data.DeleteSwitch(lastTwoSwitches[0]);
|
||||
|
||||
await ctx.Reply($"{Emojis.Success} Switch deleted.");
|
||||
}
|
||||
|
||||
@@ -14,21 +14,16 @@ namespace PluralKit.Bot.Commands
|
||||
{
|
||||
public class SystemCommands
|
||||
{
|
||||
private SystemStore _systems;
|
||||
private MemberStore _members;
|
||||
|
||||
private SwitchStore _switches;
|
||||
private IDataStore _data;
|
||||
private EmbedService _embeds;
|
||||
|
||||
private ProxyCacheService _proxyCache;
|
||||
|
||||
public SystemCommands(SystemStore systems, MemberStore members, SwitchStore switches, EmbedService embeds, ProxyCacheService proxyCache)
|
||||
public SystemCommands(EmbedService embeds, ProxyCacheService proxyCache, IDataStore data)
|
||||
{
|
||||
_systems = systems;
|
||||
_members = members;
|
||||
_switches = switches;
|
||||
_embeds = embeds;
|
||||
_proxyCache = proxyCache;
|
||||
_data = data;
|
||||
}
|
||||
|
||||
public async Task Query(Context ctx, PKSystem system) {
|
||||
@@ -41,8 +36,8 @@ namespace PluralKit.Bot.Commands
|
||||
{
|
||||
ctx.CheckNoSystem();
|
||||
|
||||
var system = await _systems.Create(ctx.RemainderOrNull());
|
||||
await _systems.Link(system, ctx.Author.Id);
|
||||
var system = await _data.CreateSystem(ctx.RemainderOrNull());
|
||||
await _data.AddAccount(system, ctx.Author.Id);
|
||||
await ctx.Reply($"{Emojis.Success} Your system has been created. Type `pk;system` to view it, and type `pk;help` for more information about commands you can use now.");
|
||||
}
|
||||
|
||||
@@ -54,7 +49,7 @@ namespace PluralKit.Bot.Commands
|
||||
if (newSystemName != null && newSystemName.Length > Limits.MaxSystemNameLength) throw Errors.SystemNameTooLongError(newSystemName.Length);
|
||||
|
||||
ctx.System.Name = newSystemName;
|
||||
await _systems.Save(ctx.System);
|
||||
await _data.SaveSystem(ctx.System);
|
||||
await ctx.Reply($"{Emojis.Success} System name {(newSystemName != null ? "changed" : "cleared")}.");
|
||||
}
|
||||
|
||||
@@ -65,7 +60,7 @@ namespace PluralKit.Bot.Commands
|
||||
if (newDescription != null && newDescription.Length > Limits.MaxDescriptionLength) throw Errors.DescriptionTooLongError(newDescription.Length);
|
||||
|
||||
ctx.System.Description = newDescription;
|
||||
await _systems.Save(ctx.System);
|
||||
await _data.SaveSystem(ctx.System);
|
||||
await ctx.Reply($"{Emojis.Success} System description {(newDescription != null ? "changed" : "cleared")}.");
|
||||
}
|
||||
|
||||
@@ -80,17 +75,18 @@ namespace PluralKit.Bot.Commands
|
||||
{
|
||||
if (newTag.Length > Limits.MaxSystemTagLength) throw Errors.SystemNameTooLongError(newTag.Length);
|
||||
|
||||
// Check unproxyable messages *after* changing the tag (so it's seen in the method) but *before* we save to DB (so we can cancel)
|
||||
var unproxyableMembers = await _members.GetUnproxyableMembers(ctx.System);
|
||||
if (unproxyableMembers.Count > 0)
|
||||
{
|
||||
var msg = await ctx.Reply(
|
||||
$"{Emojis.Warn} Changing your system tag to '{newTag.SanitizeMentions()}' will result in the following members being unproxyable, since the tag would bring their name over {Limits.MaxProxyNameLength} characters:\n**{string.Join(", ", unproxyableMembers.Select((m) => m.Name.SanitizeMentions()))}**\nDo you want to continue anyway?");
|
||||
if (!await ctx.PromptYesNo(msg)) throw new PKError("Tag change cancelled.");
|
||||
}
|
||||
// TODO: The proxy name limit is long enough now that this probably doesn't matter much.
|
||||
// // Check unproxyable messages *after* changing the tag (so it's seen in the method) but *before* we save to DB (so we can cancel)
|
||||
// var unproxyableMembers = await _data.GetUnproxyableMembers(ctx.System);
|
||||
// if (unproxyableMembers.Count > 0)
|
||||
// {
|
||||
// var msg = await ctx.Reply(
|
||||
// $"{Emojis.Warn} Changing your system tag to '{newTag.SanitizeMentions()}' will result in the following members being unproxyable, since the tag would bring their name over {Limits.MaxProxyNameLength} characters:\n**{string.Join(", ", unproxyableMembers.Select((m) => m.Name.SanitizeMentions()))}**\nDo you want to continue anyway?");
|
||||
// if (!await ctx.PromptYesNo(msg)) throw new PKError("Tag change cancelled.");
|
||||
// }
|
||||
}
|
||||
|
||||
await _systems.Save(ctx.System);
|
||||
await _data.SaveSystem(ctx.System);
|
||||
await ctx.Reply($"{Emojis.Success} System tag {(newTag != null ? "changed" : "cleared")}.");
|
||||
|
||||
await _proxyCache.InvalidateResultsForSystem(ctx.System);
|
||||
@@ -105,7 +101,7 @@ namespace PluralKit.Bot.Commands
|
||||
{
|
||||
if (member.AvatarId == null) throw Errors.UserHasNoAvatar;
|
||||
ctx.System.AvatarUrl = member.GetAvatarUrl(ImageFormat.Png, size: 256);
|
||||
await _systems.Save(ctx.System);
|
||||
await _data.SaveSystem(ctx.System);
|
||||
|
||||
var embed = new EmbedBuilder().WithImageUrl(ctx.System.AvatarUrl).Build();
|
||||
await ctx.Reply(
|
||||
@@ -117,7 +113,7 @@ namespace PluralKit.Bot.Commands
|
||||
if (url != null) await ctx.BusyIndicator(() => Utils.VerifyAvatarOrThrow(url));
|
||||
|
||||
ctx.System.AvatarUrl = url;
|
||||
await _systems.Save(ctx.System);
|
||||
await _data.SaveSystem(ctx.System);
|
||||
|
||||
var embed = url != null ? new EmbedBuilder().WithImageUrl(url).Build() : null;
|
||||
await ctx.Reply($"{Emojis.Success} System avatar {(url == null ? "cleared" : "changed")}.", embed: embed);
|
||||
@@ -133,7 +129,7 @@ namespace PluralKit.Bot.Commands
|
||||
var reply = await ctx.AwaitMessage(ctx.Channel, ctx.Author, timeout: TimeSpan.FromMinutes(1));
|
||||
if (reply.Content != ctx.System.Hid) throw new PKError($"System deletion cancelled. Note that you must reply with your system ID (`{ctx.System.Hid}`) *verbatim*.");
|
||||
|
||||
await _systems.Delete(ctx.System);
|
||||
await _data.DeleteSystem(ctx.System);
|
||||
await ctx.Reply($"{Emojis.Success} System deleted.");
|
||||
|
||||
await _proxyCache.InvalidateResultsForSystem(ctx.System);
|
||||
@@ -142,7 +138,7 @@ namespace PluralKit.Bot.Commands
|
||||
public async Task MemberShortList(Context ctx, PKSystem system) {
|
||||
if (system == null) throw Errors.NoSystemError;
|
||||
|
||||
var members = await _members.GetBySystem(system);
|
||||
var members = await _data.GetSystemMembers(system);
|
||||
var embedTitle = system.Name != null ? $"Members of {system.Name.SanitizeMentions()} (`{system.Hid}`)" : $"Members of `{system.Hid}`";
|
||||
await ctx.Paginate<PKMember>(
|
||||
members.OrderBy(m => m.Name.ToLower()).ToList(),
|
||||
@@ -158,7 +154,7 @@ namespace PluralKit.Bot.Commands
|
||||
public async Task MemberLongList(Context ctx, PKSystem system) {
|
||||
if (system == null) throw Errors.NoSystemError;
|
||||
|
||||
var members = await _members.GetBySystem(system);
|
||||
var members = await _data.GetSystemMembers(system);
|
||||
var embedTitle = system.Name != null ? $"Members of {system.Name} (`{system.Hid}`)" : $"Members of `{system.Hid}`";
|
||||
await ctx.Paginate<PKMember>(
|
||||
members.OrderBy(m => m.Name.ToLower()).ToList(),
|
||||
@@ -181,7 +177,7 @@ namespace PluralKit.Bot.Commands
|
||||
{
|
||||
if (system == null) throw Errors.NoSystemError;
|
||||
|
||||
var sw = await _switches.GetLatestSwitch(system);
|
||||
var sw = await _data.GetLatestSwitch(system);
|
||||
if (sw == null) throw Errors.NoRegisteredSwitches;
|
||||
|
||||
await ctx.Reply(embed: await _embeds.CreateFronterEmbed(sw, system.Zone));
|
||||
@@ -191,7 +187,7 @@ namespace PluralKit.Bot.Commands
|
||||
{
|
||||
if (system == null) throw Errors.NoSystemError;
|
||||
|
||||
var sws = (await _switches.GetSwitches(system, 10)).ToList();
|
||||
var sws = (await _data.GetSwitches(system, 10)).ToList();
|
||||
if (sws.Count == 0) throw Errors.NoRegisteredSwitches;
|
||||
|
||||
await ctx.Reply(embed: await _embeds.CreateFrontHistoryEmbed(sws, system.Zone));
|
||||
@@ -209,7 +205,7 @@ namespace PluralKit.Bot.Commands
|
||||
if (rangeStart == null) throw Errors.InvalidDateTime(durationStr);
|
||||
if (rangeStart.Value.ToInstant() > now) throw Errors.FrontPercentTimeInFuture;
|
||||
|
||||
var frontpercent = await _switches.GetPerMemberSwitchDuration(system, rangeStart.Value.ToInstant(), now);
|
||||
var frontpercent = await _data.GetFrontBreakdown(system, rangeStart.Value.ToInstant(), now);
|
||||
await ctx.Reply(embed: await _embeds.CreateFrontPercentEmbed(frontpercent, system.Zone));
|
||||
}
|
||||
|
||||
@@ -221,7 +217,7 @@ namespace PluralKit.Bot.Commands
|
||||
if (zoneStr == null)
|
||||
{
|
||||
ctx.System.UiTz = "UTC";
|
||||
await _systems.Save(ctx.System);
|
||||
await _data.SaveSystem(ctx.System);
|
||||
await ctx.Reply($"{Emojis.Success} System time zone cleared.");
|
||||
return;
|
||||
}
|
||||
@@ -234,7 +230,7 @@ namespace PluralKit.Bot.Commands
|
||||
$"This will change the system time zone to {zone.Id}. The current time is {Formats.ZonedDateTimeFormat.Format(currentTime)}. Is this correct?");
|
||||
if (!await ctx.PromptYesNo(msg)) throw Errors.TimezoneChangeCancelled;
|
||||
ctx.System.UiTz = zone.Id;
|
||||
await _systems.Save(ctx.System);
|
||||
await _data.SaveSystem(ctx.System);
|
||||
|
||||
await ctx.Reply($"System time zone changed to {zone.Id}.");
|
||||
}
|
||||
|
||||
@@ -9,39 +9,34 @@ using Humanizer;
|
||||
using NodaTime;
|
||||
|
||||
namespace PluralKit.Bot {
|
||||
public class EmbedService {
|
||||
private SystemStore _systems;
|
||||
private MemberStore _members;
|
||||
private SwitchStore _switches;
|
||||
private MessageStore _messages;
|
||||
public class EmbedService
|
||||
{
|
||||
private IDataStore _data;
|
||||
private IDiscordClient _client;
|
||||
|
||||
public EmbedService(SystemStore systems, MemberStore members, IDiscordClient client, SwitchStore switches, MessageStore messages)
|
||||
public EmbedService(IDiscordClient client, IDataStore data)
|
||||
{
|
||||
_systems = systems;
|
||||
_members = members;
|
||||
_client = client;
|
||||
_switches = switches;
|
||||
_messages = messages;
|
||||
_data = data;
|
||||
}
|
||||
|
||||
public async Task<Embed> CreateSystemEmbed(PKSystem system) {
|
||||
var accounts = await _systems.GetLinkedAccountIds(system);
|
||||
var accounts = await _data.GetSystemAccounts(system);
|
||||
|
||||
// Fetch/render info for all accounts simultaneously
|
||||
var users = await Task.WhenAll(accounts.Select(async uid => (await _client.GetUserAsync(uid))?.NameAndMention() ?? $"(deleted account {uid})"));
|
||||
|
||||
var memberCount = await _members.MemberCount(system);
|
||||
var memberCount = await _data.GetSystemMemberCount(system);
|
||||
var eb = new EmbedBuilder()
|
||||
.WithColor(Color.Blue)
|
||||
.WithTitle(system.Name ?? null)
|
||||
.WithThumbnailUrl(system.AvatarUrl ?? null)
|
||||
.WithFooter($"System ID: {system.Hid} | Created on {Formats.ZonedDateTimeFormat.Format(system.Created.InZone(system.Zone))}");
|
||||
|
||||
var latestSwitch = await _switches.GetLatestSwitch(system);
|
||||
var latestSwitch = await _data.GetLatestSwitch(system);
|
||||
if (latestSwitch != null)
|
||||
{
|
||||
var switchMembers = (await _switches.GetSwitchMembers(latestSwitch)).ToList();
|
||||
var switchMembers = (await _data.GetSwitchMembers(latestSwitch)).ToList();
|
||||
if (switchMembers.Count > 0)
|
||||
eb.AddField("Fronter".ToQuantity(switchMembers.Count(), ShowQuantityAs.None),
|
||||
string.Join(", ", switchMembers.Select(m => m.Name)));
|
||||
@@ -85,7 +80,7 @@ namespace PluralKit.Bot {
|
||||
color = Color.Default;
|
||||
}
|
||||
|
||||
var messageCount = await _members.MessageCount(member);
|
||||
var messageCount = await _data.GetMemberMessageCount(member);
|
||||
|
||||
var eb = new EmbedBuilder()
|
||||
// TODO: add URL of website when that's up
|
||||
@@ -108,7 +103,7 @@ namespace PluralKit.Bot {
|
||||
|
||||
public async Task<Embed> CreateFronterEmbed(PKSwitch sw, DateTimeZone zone)
|
||||
{
|
||||
var members = (await _switches.GetSwitchMembers(sw)).ToList();
|
||||
var members = (await _data.GetSwitchMembers(sw)).ToList();
|
||||
var timeSinceSwitch = SystemClock.Instance.GetCurrentInstant() - sw.Timestamp;
|
||||
return new EmbedBuilder()
|
||||
.WithColor(members.FirstOrDefault()?.Color?.ToDiscordColor() ?? Color.Blue)
|
||||
@@ -125,7 +120,7 @@ namespace PluralKit.Bot {
|
||||
foreach (var sw in sws)
|
||||
{
|
||||
// Fetch member list and format
|
||||
var members = (await _switches.GetSwitchMembers(sw)).ToList();
|
||||
var members = (await _data.GetSwitchMembers(sw)).ToList();
|
||||
var membersStr = members.Any() ? string.Join(", ", members.Select(m => m.Name)) : "no fronter";
|
||||
|
||||
var switchSince = SystemClock.Instance.GetCurrentInstant() - sw.Timestamp;
|
||||
@@ -151,7 +146,7 @@ namespace PluralKit.Bot {
|
||||
.Build();
|
||||
}
|
||||
|
||||
public async Task<Embed> CreateMessageInfoEmbed(MessageStore.StoredMessage msg)
|
||||
public async Task<Embed> CreateMessageInfoEmbed(FullMessage msg)
|
||||
{
|
||||
var channel = await _client.GetChannelAsync(msg.Message.Channel) as ITextChannel;
|
||||
var serverMsg = channel != null ? await channel.GetMessageAsync(msg.Message.Mid) : null;
|
||||
@@ -193,20 +188,20 @@ namespace PluralKit.Bot {
|
||||
return eb.Build();
|
||||
}
|
||||
|
||||
public Task<Embed> CreateFrontPercentEmbed(SwitchStore.PerMemberSwitchDuration frontpercent, DateTimeZone tz)
|
||||
public Task<Embed> CreateFrontPercentEmbed(FrontBreakdown breakdown, DateTimeZone tz)
|
||||
{
|
||||
var actualPeriod = frontpercent.RangeEnd - frontpercent.RangeStart;
|
||||
var actualPeriod = breakdown.RangeEnd - breakdown.RangeStart;
|
||||
var eb = new EmbedBuilder()
|
||||
.WithColor(Color.Blue)
|
||||
.WithFooter($"Since {Formats.ZonedDateTimeFormat.Format(frontpercent.RangeStart.InZone(tz))} ({Formats.DurationFormat.Format(actualPeriod)} ago)");
|
||||
.WithFooter($"Since {Formats.ZonedDateTimeFormat.Format(breakdown.RangeStart.InZone(tz))} ({Formats.DurationFormat.Format(actualPeriod)} ago)");
|
||||
|
||||
var maxEntriesToDisplay = 24; // max 25 fields allowed in embed - reserve 1 for "others"
|
||||
|
||||
// We convert to a list of pairs so we can add the no-fronter value
|
||||
// Dictionary doesn't allow for null keys so we instead have a pair with a null key ;)
|
||||
var pairs = frontpercent.MemberSwitchDurations.ToList();
|
||||
if (frontpercent.NoFronterDuration != Duration.Zero)
|
||||
pairs.Add(new KeyValuePair<PKMember, Duration>(null, frontpercent.NoFronterDuration));
|
||||
var pairs = breakdown.MemberSwitchDurations.ToList();
|
||||
if (breakdown.NoFronterDuration != Duration.Zero)
|
||||
pairs.Add(new KeyValuePair<PKMember, Duration>(null, breakdown.NoFronterDuration));
|
||||
|
||||
var membersOrdered = pairs.OrderByDescending(pair => pair.Value).Take(maxEntriesToDisplay).ToList();
|
||||
foreach (var pair in membersOrdered)
|
||||
|
||||
@@ -17,10 +17,7 @@ namespace PluralKit.Bot
|
||||
private DiscordShardedClient _client;
|
||||
private IMetrics _metrics;
|
||||
|
||||
private SystemStore _systems;
|
||||
private MemberStore _members;
|
||||
private SwitchStore _switches;
|
||||
private MessageStore _messages;
|
||||
private IDataStore _data;
|
||||
|
||||
private WebhookCacheService _webhookCache;
|
||||
|
||||
@@ -28,16 +25,13 @@ namespace PluralKit.Bot
|
||||
|
||||
private ILogger _logger;
|
||||
|
||||
public PeriodicStatCollector(IDiscordClient client, IMetrics metrics, SystemStore systems, MemberStore members, SwitchStore switches, MessageStore messages, ILogger logger, WebhookCacheService webhookCache, DbConnectionCountHolder countHolder)
|
||||
public PeriodicStatCollector(IDiscordClient client, IMetrics metrics, ILogger logger, WebhookCacheService webhookCache, DbConnectionCountHolder countHolder, IDataStore data)
|
||||
{
|
||||
_client = (DiscordShardedClient) client;
|
||||
_metrics = metrics;
|
||||
_systems = systems;
|
||||
_members = members;
|
||||
_switches = switches;
|
||||
_messages = messages;
|
||||
_webhookCache = webhookCache;
|
||||
_countHolder = countHolder;
|
||||
_data = data;
|
||||
_logger = logger.ForContext<PeriodicStatCollector>();
|
||||
}
|
||||
|
||||
@@ -65,10 +59,10 @@ namespace PluralKit.Bot
|
||||
_metrics.Measure.Gauge.SetValue(BotMetrics.MembersOnline, usersOnline.Count);
|
||||
|
||||
// Aggregate DB stats
|
||||
_metrics.Measure.Gauge.SetValue(CoreMetrics.SystemCount, await _systems.Count());
|
||||
_metrics.Measure.Gauge.SetValue(CoreMetrics.MemberCount, await _members.Count());
|
||||
_metrics.Measure.Gauge.SetValue(CoreMetrics.SwitchCount, await _switches.Count());
|
||||
_metrics.Measure.Gauge.SetValue(CoreMetrics.MessageCount, await _messages.Count());
|
||||
_metrics.Measure.Gauge.SetValue(CoreMetrics.SystemCount, await _data.GetTotalSystems());
|
||||
_metrics.Measure.Gauge.SetValue(CoreMetrics.MemberCount, await _data.GetTotalMembers());
|
||||
_metrics.Measure.Gauge.SetValue(CoreMetrics.SwitchCount, await _data.GetTotalSwitches());
|
||||
_metrics.Measure.Gauge.SetValue(CoreMetrics.MessageCount, await _data.GetTotalMessages());
|
||||
|
||||
// Process info
|
||||
var process = Process.GetCurrentProcess();
|
||||
|
||||
@@ -23,7 +23,7 @@ namespace PluralKit.Bot
|
||||
class ProxyService: IDisposable {
|
||||
private IDiscordClient _client;
|
||||
private LogChannelService _logChannel;
|
||||
private MessageStore _messageStorage;
|
||||
private IDataStore _data;
|
||||
private EmbedService _embeds;
|
||||
private ILogger _logger;
|
||||
private WebhookExecutorService _webhookExecutor;
|
||||
@@ -31,11 +31,11 @@ namespace PluralKit.Bot
|
||||
|
||||
private HttpClient _httpClient;
|
||||
|
||||
public ProxyService(IDiscordClient client, LogChannelService logChannel, MessageStore messageStorage, EmbedService embeds, ILogger logger, ProxyCacheService cache, WebhookExecutorService webhookExecutor)
|
||||
public ProxyService(IDiscordClient client, LogChannelService logChannel, IDataStore data, EmbedService embeds, ILogger logger, ProxyCacheService cache, WebhookExecutorService webhookExecutor)
|
||||
{
|
||||
_client = client;
|
||||
_logChannel = logChannel;
|
||||
_messageStorage = messageStorage;
|
||||
_data = data;
|
||||
_embeds = embeds;
|
||||
_cache = cache;
|
||||
_webhookExecutor = webhookExecutor;
|
||||
@@ -115,7 +115,7 @@ namespace PluralKit.Bot
|
||||
);
|
||||
|
||||
// Store the message in the database, and log it in the log channel (if applicable)
|
||||
await _messageStorage.Store(message.Author.Id, hookMessageId, message.Channel.Id, message.Id, match.Member);
|
||||
await _data.AddMessage(message.Author.Id, hookMessageId, message.Channel.Id, message.Id, match.Member);
|
||||
await _logChannel.LogMessage(match.System, match.Member, hookMessageId, message.Id, message.Channel as IGuildChannel, message.Author, match.InnerText);
|
||||
|
||||
// Wait a second or so before deleting the original message
|
||||
@@ -184,7 +184,7 @@ namespace PluralKit.Bot
|
||||
if (user == null) return;
|
||||
|
||||
// Find the message in the DB
|
||||
var msg = await _messageStorage.Get(message.Id);
|
||||
var msg = await _data.GetMessage(message.Id);
|
||||
if (msg == null) return;
|
||||
|
||||
// DM them the message card
|
||||
@@ -199,7 +199,7 @@ namespace PluralKit.Bot
|
||||
public async Task HandleMessageDeletionByReaction(Cacheable<IUserMessage, ulong> message, ulong userWhoReacted)
|
||||
{
|
||||
// Find the message in the database
|
||||
var storedMessage = await _messageStorage.Get(message.Id);
|
||||
var storedMessage = await _data.GetMessage(message.Id);
|
||||
if (storedMessage == null) return; // (if we can't, that's ok, no worries)
|
||||
|
||||
// Make sure it's the actual sender of that message deleting the message
|
||||
@@ -215,7 +215,7 @@ namespace PluralKit.Bot
|
||||
}
|
||||
|
||||
// Finally, delete it from our database.
|
||||
await _messageStorage.Delete(message.Id);
|
||||
await _data.DeleteMessage(message.Id);
|
||||
}
|
||||
|
||||
public async Task HandleMessageDeletedAsync(Cacheable<IMessage, ulong> message, ISocketMessageChannel channel)
|
||||
@@ -224,13 +224,13 @@ namespace PluralKit.Bot
|
||||
// Non-webhook messages will never be stored anyway.
|
||||
// If we're not sure (eg. message outside of cache), delete just to be sure.
|
||||
if (message.HasValue && !message.Value.Author.IsWebhook) return;
|
||||
await _messageStorage.Delete(message.Id);
|
||||
await _data.DeleteMessage(message.Id);
|
||||
}
|
||||
|
||||
public async Task HandleMessageBulkDeleteAsync(IReadOnlyCollection<Cacheable<IMessage, ulong>> messages, IMessageChannel channel)
|
||||
{
|
||||
_logger.Information("Bulk deleting {Count} messages in channel {Channel}", messages.Count, channel.Id);
|
||||
await _messageStorage.BulkDelete(messages.Select(m => m.Id).ToList());
|
||||
await _data.DeleteMessagesBulk(messages.Select(m => m.Id).ToList());
|
||||
}
|
||||
|
||||
public void Dispose()
|
||||
|
||||
Reference in New Issue
Block a user