using Discord.Audio;
using Discord.Rest;
using System;
using System.Collections.Generic;
using System.Collections.Immutable;
using System.Diagnostics;
using System.Linq;
using System.Threading.Tasks;
using MemberModel = Discord.API.GuildMember;
using PresenceModel = Discord.API.Presence;
using UserModel = Discord.API.User;
namespace Discord.WebSocket
{
///
/// Represents a WebSocket-based guild user.
///
[DebuggerDisplay(@"{DebuggerDisplay,nq}")]
public class SocketGuildUser : SocketUser, IGuildUser
{
#region SocketGuildUser
private long? _premiumSinceTicks;
private long? _timedOutTicks;
private long? _joinedAtTicks;
private ImmutableArray _roleIds;
internal override SocketGlobalUser GlobalUser { get; set; }
///
/// Gets the guild the user is in.
///
public SocketGuild Guild { get; }
///
public string DisplayName => Nickname ?? GlobalName ?? Username;
///
public string Nickname { get; private set; }
///
public string DisplayAvatarId => GuildAvatarId ?? AvatarId;
///
public string GuildAvatarId { get; private set; }
///
public override bool IsBot { get { return GlobalUser.IsBot; } internal set { GlobalUser.IsBot = value; } }
///
public override string Username { get { return GlobalUser.Username; } internal set { GlobalUser.Username = value; } }
///
public override ushort DiscriminatorValue { get { return GlobalUser.DiscriminatorValue; } internal set { GlobalUser.DiscriminatorValue = value; } }
///
public override string AvatarId { get { return GlobalUser.AvatarId; } internal set { GlobalUser.AvatarId = value; } }
///
public override string GlobalName { get { return GlobalUser.GlobalName; } internal set { GlobalUser.GlobalName = value; } }
///
public string GuildBannerHash { get; private set; }
///
public GuildPermissions GuildPermissions => new GuildPermissions(Permissions.ResolveGuild(Guild, this));
internal override SocketPresence Presence { get; set; }
///
public override bool IsWebhook => false;
///
public bool IsSelfDeafened => VoiceState?.IsSelfDeafened ?? false;
///
public bool IsSelfMuted => VoiceState?.IsSelfMuted ?? false;
///
public bool IsSuppressed => VoiceState?.IsSuppressed ?? false;
///
public bool IsDeafened => VoiceState?.IsDeafened ?? false;
///
public bool IsMuted => VoiceState?.IsMuted ?? false;
///
public bool IsStreaming => VoiceState?.IsStreaming ?? false;
///
public bool IsVideoing => VoiceState?.IsVideoing ?? false;
///
public DateTimeOffset? RequestToSpeakTimestamp => VoiceState?.RequestToSpeakTimestamp ?? null;
///
public bool? IsPending { get; private set; }
///
public GuildUserFlags Flags { get; private set; }
///
public DateTimeOffset? JoinedAt => DateTimeUtils.FromTicks(_joinedAtTicks);
///
/// Returns a collection of roles that the user possesses.
///
public IReadOnlyCollection Roles
=> _roleIds.Select(id => Guild.GetRole(id)).Where(x => x != null).ToReadOnlyCollection(() => _roleIds.Length);
///
/// Returns the voice channel the user is in, or if none.
///
public SocketVoiceChannel VoiceChannel => VoiceState?.VoiceChannel;
///
public string VoiceSessionId => VoiceState?.VoiceSessionId ?? "";
///
/// Gets the voice connection status of the user if any.
///
///
/// A representing the user's voice status; if the user is not
/// connected to a voice channel.
///
public SocketVoiceState? VoiceState => Guild.GetVoiceState(Id);
public AudioInStream AudioStream => Guild.GetAudioStream(Id);
///
public DateTimeOffset? PremiumSince => DateTimeUtils.FromTicks(_premiumSinceTicks);
///
public DateTimeOffset? TimedOutUntil
{
get
{
if (!_timedOutTicks.HasValue || _timedOutTicks.Value < 0)
return null;
else
return DateTimeUtils.FromTicks(_timedOutTicks);
}
}
///
/// Returns the position of the user within the role hierarchy.
///
///
/// The returned value equal to the position of the highest role the user has, or
/// if user is the server owner.
///
public int Hierarchy
{
get
{
if (Guild.OwnerId == Id)
return int.MaxValue;
int maxPos = 0;
for (int i = 0; i < _roleIds.Length; i++)
{
var role = Guild.GetRole(_roleIds[i]);
if (role != null && role.Position > maxPos)
maxPos = role.Position;
}
return maxPos;
}
}
internal SocketGuildUser(SocketGuild guild, SocketGlobalUser globalUser)
: base(guild.Discord, globalUser.Id)
{
Guild = guild;
GlobalUser = globalUser;
}
internal static SocketGuildUser Create(SocketGuild guild, ClientState state, UserModel model)
{
var entity = new SocketGuildUser(guild, guild.Discord.GetOrCreateUser(state, model));
entity.Update(state, model);
entity.UpdateRoles([]);
return entity;
}
internal static SocketGuildUser Create(SocketGuild guild, ClientState state, MemberModel model)
{
var entity = new SocketGuildUser(guild, guild.Discord.GetOrCreateUser(state, model.User));
entity.Update(state, model);
if (!model.Roles.IsSpecified)
entity.UpdateRoles([]);
return entity;
}
internal static SocketGuildUser Create(SocketGuild guild, ClientState state, PresenceModel model)
{
var entity = new SocketGuildUser(guild, guild.Discord.GetOrCreateUser(state, model.User));
entity.Update(state, model, false);
if (!model.Roles.IsSpecified)
entity.UpdateRoles([]);
return entity;
}
internal void Update(ClientState state, MemberModel model)
{
base.Update(state, model.User);
if (model.JoinedAt.IsSpecified)
_joinedAtTicks = model.JoinedAt.Value.UtcTicks;
if (model.Nick.IsSpecified)
Nickname = model.Nick.Value;
if (model.Avatar.IsSpecified)
GuildAvatarId = model.Avatar.Value;
if (model.Roles.IsSpecified)
UpdateRoles(model.Roles.Value);
if (model.PremiumSince.IsSpecified)
_premiumSinceTicks = model.PremiumSince.Value?.UtcTicks;
if (model.TimedOutUntil.IsSpecified)
_timedOutTicks = model.TimedOutUntil.Value?.UtcTicks;
if (model.Pending.IsSpecified)
IsPending = model.Pending.Value;
if (model.Banner.IsSpecified)
GuildBannerHash = model.Banner.Value;
Flags = model.Flags;
}
internal void Update(ClientState state, PresenceModel model, bool updatePresence)
{
if (updatePresence)
{
Update(model);
}
if (model.Nick.IsSpecified)
Nickname = model.Nick.Value;
if (model.Roles.IsSpecified)
UpdateRoles(model.Roles.Value);
if (model.PremiumSince.IsSpecified)
_premiumSinceTicks = model.PremiumSince.Value?.UtcTicks;
}
internal override void Update(PresenceModel model)
{
Presence ??= new SocketPresence();
Presence.Update(model);
GlobalUser.Update(model);
}
private void UpdateRoles(ulong[] roleIds)
{
var roles = ImmutableArray.CreateBuilder(roleIds.Length + 1);
roles.Add(Guild.Id);
for (int i = 0; i < roleIds.Length; i++)
roles.Add(roleIds[i]);
_roleIds = roles.ToImmutable();
}
///
public Task ModifyAsync(Action func, RequestOptions options = null)
=> UserHelper.ModifyAsync(this, Discord, func, options);
///
public Task KickAsync(string reason = null, RequestOptions options = null)
=> UserHelper.KickAsync(this, Discord, reason, options);
///
public Task AddRoleAsync(ulong roleId, RequestOptions options = null)
=> AddRolesAsync(new[] { roleId }, options);
///
public Task AddRoleAsync(IRole role, RequestOptions options = null)
=> AddRoleAsync(role.Id, options);
///
public Task AddRolesAsync(IEnumerable roleIds, RequestOptions options = null)
=> UserHelper.AddRolesAsync(this, Discord, roleIds, options);
///
public Task AddRolesAsync(IEnumerable roles, RequestOptions options = null)
=> AddRolesAsync(roles.Select(x => x.Id), options);
///
public Task RemoveRoleAsync(ulong roleId, RequestOptions options = null)
=> RemoveRolesAsync(new[] { roleId }, options);
///
public Task RemoveRoleAsync(IRole role, RequestOptions options = null)
=> RemoveRoleAsync(role.Id, options);
///
public Task RemoveRolesAsync(IEnumerable roleIds, RequestOptions options = null)
=> UserHelper.RemoveRolesAsync(this, Discord, roleIds, options);
///
public Task RemoveRolesAsync(IEnumerable roles, RequestOptions options = null)
=> RemoveRolesAsync(roles.Select(x => x.Id));
///
public Task SetTimeOutAsync(TimeSpan span, RequestOptions options = null)
=> UserHelper.SetTimeoutAsync(this, Discord, span, options);
///
public Task RemoveTimeOutAsync(RequestOptions options = null)
=> UserHelper.RemoveTimeOutAsync(this, Discord, options);
///
public ChannelPermissions GetPermissions(IGuildChannel channel)
=> new ChannelPermissions(Permissions.ResolveChannel(Guild, this, channel, GuildPermissions.RawValue));
///
public string GetGuildAvatarUrl(ImageFormat format = ImageFormat.Auto, ushort size = 128)
=> CDN.GetGuildUserAvatarUrl(Id, Guild.Id, GuildAvatarId, size, format);
///
public string GetGuildBannerUrl(ImageFormat format = ImageFormat.Auto, ushort size = 128)
=> CDN.GetGuildUserBannerUrl(Id, Guild.Id, GuildBannerHash, size, format);
///
public override string GetDisplayAvatarUrl(ImageFormat format = ImageFormat.Auto, ushort size = 128)
=> GetGuildAvatarUrl(format, size) ?? base.GetDisplayAvatarUrl(format, size);
private string DebuggerDisplay => DiscriminatorValue != 0
? $"{Username}#{Discriminator} ({Id}{(IsBot ? ", Bot" : "")}, Guild)"
: $"{Username} ({Id}{(IsBot ? ", Bot" : "")}, Guild)";
internal new SocketGuildUser Clone()
{
var clone = MemberwiseClone() as SocketGuildUser;
clone.GlobalUser = GlobalUser.Clone();
return clone;
}
#endregion
#region IGuildUser
///
IGuild IGuildUser.Guild => Guild;
///
ulong IGuildUser.GuildId => Guild.Id;
///
IReadOnlyCollection IGuildUser.RoleIds => _roleIds;
//IVoiceState
///
IVoiceChannel IVoiceState.VoiceChannel => VoiceChannel;
#endregion
}
}