[Feature] Support for the new username system (#2696)

* update a lot of stuff

* update CDN for new avatar calculation

* whoops, forgot to commit

* handle `null` values

* Remove duplicate line

Co-authored-by: Dmitry <[email protected]>

* updates

* Apply suggestions from code review

Co-authored-by: Quin Lynch <[email protected]>

* Apply suggestion

Co-authored-by: Quin Lynch <[email protected]>

* update `SocketThreadUSer`

---------

Co-authored-by: Dmitry <[email protected]>
Co-authored-by: Quin Lynch <[email protected]>

Author: 3 people

src/Discord.Net.Commands/Readers/UserTypeReader.cs

@@ -59,6 +59,17 @@ public override async Task<TypeReaderResult> ReadAsync(ICommandContext context,
                 }
             }
 
+            //By global (display) name
+            {
+                await channelUsers
+                    .Where(x => string.Equals(input, x.GlobalName, StringComparison.OrdinalIgnoreCase))
+                    .ForEachAsync(channelUser => AddResult(results, channelUser as T, channelUser.GlobalName == input ? 0.65f : 0.55f))
+                    .ConfigureAwait(false);
+
+                foreach (var guildUser in guildUsers.Where(x => string.Equals(input, x.GlobalName, StringComparison.OrdinalIgnoreCase)))
+                    AddResult(results, guildUser as T, guildUser.GlobalName == input ? 0.60f : 0.50f);
+            }
+
             //By Username (0.5-0.6)
             {
                 await channelUsers

src/Discord.Net.Core/CDN.cs

@@ -72,6 +72,7 @@ public static string GetUserBannerUrl(ulong userId, string bannerId, ushort size
             string extension = FormatToExtension(format, bannerId);
             return $"{DiscordConfig.CDNUrl}banners/{userId}/{bannerId}.{extension}?size={size}";
         }
+
         /// <summary>
         ///     Returns the default user avatar URL.
         /// </summary>
@@ -83,6 +84,19 @@ public static string GetDefaultUserAvatarUrl(ushort discriminator)
         {
             return $"{DiscordConfig.CDNUrl}embed/avatars/{discriminator % 5}.png";
         }
+
+        /// <summary>
+        ///     Returns the default user avatar URL.
+        /// </summary>
+        /// <param name="userId">The Id of a user.</param>
+        /// <returns>
+        ///     A URL pointing to the user's default avatar when one isn't set.
+        /// </returns>
+        public static string GetDefaultUserAvatarUrl(ulong userId)
+        {
+            return $"{DiscordConfig.CDNUrl}embed/avatars/{(userId >> 22) % 6}.png";
+        }
+
         /// <summary>
         ///     Returns an icon URL.
         /// </summary>

src/Discord.Net.Core/Entities/Users/IUser.cs

@@ -47,11 +47,11 @@ public interface IUser : ISnowflakeEntity, IMentionable, IPresence
         /// </returns>
         string GetDefaultAvatarUrl();
         /// <summary>
-        ///     Gets the per-username unique ID for this user.
+        ///     Gets the per-username unique ID for this user. This will return "0000" for users who have migrated to new username system.
         /// </summary>
         string Discriminator { get; }
         /// <summary>
-        ///     Gets the per-username unique ID for this user.
+        ///     Gets the per-username unique ID for this user. This will return 0 for users who have migrated to new username system.
         /// </summary>
         ushort DiscriminatorValue { get; }
         /// <summary>
@@ -87,6 +87,14 @@ public interface IUser : ISnowflakeEntity, IMentionable, IPresence
         /// </returns>
         UserProperties? PublicFlags { get; }
 
+        /// <summary>
+        ///     Gets the user's display name, if it is set. For bots, this will get the application name.
+        /// </summary>
+        /// <remarks>
+        ///     This property will be <see langword="null"/> if user has no display name set.
+        /// </remarks>
+        string GlobalName { get; }
+
         /// <summary>
         ///     Creates the direct message channel of this user.
         /// </summary>

src/Discord.Net.Core/Extensions/EmbedBuilderExtensions.cs

@@ -27,7 +27,7 @@ public static EmbedBuilder WithColor(this EmbedBuilder builder, float r, float g
 
         /// <summary> Fills the embed author field with the provided user's full username and avatar URL. </summary>
         public static EmbedBuilder WithAuthor(this EmbedBuilder builder, IUser user) =>
-            builder.WithAuthor($"{user.Username}#{user.Discriminator}", user.GetAvatarUrl() ?? user.GetDefaultAvatarUrl());
+            builder.WithAuthor(user.DiscriminatorValue != 0 ? $"{user.Username}#{user.Discriminator}" : user.Username, user.GetAvatarUrl() ?? user.GetDefaultAvatarUrl());
 
         /// <summary> Converts a <see cref="EmbedType.Rich"/> <see cref="IEmbed"/> object to a <see cref="EmbedBuilder"/>. </summary>
         /// <exception cref="InvalidOperationException">The embed type is not <see cref="EmbedType.Rich"/>.</exception>

src/Discord.Net.Core/Format.cs

@@ -108,16 +108,18 @@ public static string StripMarkDown(string text)
         }
 
         /// <summary>
-        ///     Formats a user's username + discriminator.
+        ///     Formats a user's username and optional discriminator.
         /// </summary>
         /// <param name="doBidirectional">To format the string in bidirectional unicode or not</param>
         /// <param name="user">The user whose username and discriminator to format</param>
-        /// <returns>The username + discriminator</returns>
+        /// <returns>The username + optional discriminator.</returns>
         public static string UsernameAndDiscriminator(IUser user, bool doBidirectional)
         {
-            return doBidirectional
-                ? $"\u2066{user.Username}\u2069#{user.Discriminator}"
-                : $"{user.Username}#{user.Discriminator}";
+            if (user.DiscriminatorValue != 0)
+                return doBidirectional
+                    ? $"\u2066{user.Username}\u2069#{user.Discriminator}"
+                    : $"{user.Username}#{user.Discriminator}";
+            return user.Username;
         }
     }
 }

src/Discord.Net.Core/Utils/MentionUtils.cs

@@ -12,14 +12,14 @@ public static class MentionUtils
         private const char SanitizeChar = '\x200b';
 
         //If the system can't be positive a user doesn't have a nickname, assume useNickname = true (source: Jake)
-        internal static string MentionUser(string id, bool useNickname = true) => useNickname ? $"<@!{id}>" : $"<@{id}>";
+        internal static string MentionUser(string id) => $"<@{id}>";
         /// <summary>
         ///     Returns a mention string based on the user ID.
         /// </summary>
         /// <returns>
         ///     A user mention string (e.g. &lt;@80351110224678912&gt;).
         /// </returns>
-        public static string MentionUser(ulong id) => MentionUser(id.ToString(), true);
+        public static string MentionUser(ulong id) => MentionUser(id.ToString());
         internal static string MentionChannel(string id) => $"<#{id}>";
         /// <summary>
         ///     Returns a mention string based on the channel ID.
@@ -192,19 +192,19 @@ internal static string ResolveUserMention(ITag tag, TagHandling mode)
                             return "";
                     case TagHandling.FullName:
                         if (user != null)
-                            return $"@{user.Username}#{user.Discriminator}";
+                            return user.DiscriminatorValue != 0 ? $"@{user.Username}#{user.Discriminator}" : user.Username;
                         else
                             return "";
                     case TagHandling.FullNameNoPrefix:
                         if (user != null)
-                            return $"{user.Username}#{user.Discriminator}";
+                            return user.DiscriminatorValue != 0 ? $"@{user.Username}#{user.Discriminator}" : user.Username;
                         else
                             return "";
                     case TagHandling.Sanitize:
                         if (guildUser != null && guildUser.Nickname == null)
-                            return MentionUser($"{SanitizeChar}{tag.Key}", false);
+                            return MentionUser($"{SanitizeChar}{tag.Key}");
                         else
-                            return MentionUser($"{SanitizeChar}{tag.Key}", true);
+                            return MentionUser($"{SanitizeChar}{tag.Key}");
                 }
             }
             return "";

src/Discord.Net.Rest/API/Common/User.cs

@@ -19,6 +19,9 @@ internal class User
         [JsonProperty("accent_color")]
         public Optional<uint?> AccentColor { get; set; }
 
+        [JsonProperty("global_name")]
+        public Optional<string> GlobalName { get; set; }
+
         //CurrentUser
         [JsonProperty("verified")]
         public Optional<bool> Verified { get; set; }

src/Discord.Net.Rest/Entities/Users/RestGuildUser.cs

@@ -19,8 +19,10 @@ public class RestGuildUser : RestUser, IGuildUser
         private long? _timedOutTicks;
         private long? _joinedAtTicks;
         private ImmutableArray<ulong> _roleIds;
-        /// <inheritdoc />
-        public string DisplayName => Nickname ?? Username;
+
+        /// <inheritdoc cref="IGuildUser.DisplayName"/>
+        public string DisplayName => Nickname ?? GlobalName ?? Username;
+
         /// <inheritdoc />
         public string Nickname { get; private set; }
         /// <inheritdoc/>

src/Discord.Net.Rest/Entities/Users/RestUser.cs

@@ -30,6 +30,8 @@ public class RestUser : RestEntity<ulong>, IUser, IUpdateable
         public Color? AccentColor { get; private set; }
         /// <inheritdoc />
         public UserProperties? PublicFlags { get; private set; }
+        /// <inheritdoc />
+        public string GlobalName { get; internal set; }
 
         /// <inheritdoc />
         public DateTimeOffset CreatedAt => SnowflakeUtils.FromSnowflake(Id);
@@ -85,13 +87,15 @@ internal virtual void Update(Model model)
             if (model.AccentColor.IsSpecified)
                 AccentColor = model.AccentColor.Value;
             if (model.Discriminator.IsSpecified)
-                DiscriminatorValue = ushort.Parse(model.Discriminator.Value, NumberStyles.None, CultureInfo.InvariantCulture);
+                DiscriminatorValue = ushort.Parse(model.Discriminator.GetValueOrDefault(null) ?? "0", NumberStyles.None, CultureInfo.InvariantCulture);
             if (model.Bot.IsSpecified)
                 IsBot = model.Bot.Value;
             if (model.Username.IsSpecified)
                 Username = model.Username.Value;
             if (model.PublicFlags.IsSpecified)
                 PublicFlags = model.PublicFlags.Value;
+            if (model.GlobalName.IsSpecified)
+                GlobalName = model.GlobalName.Value;
         }
 
         /// <inheritdoc />
@@ -121,7 +125,9 @@ public string GetBannerUrl(ImageFormat format = ImageFormat.Auto, ushort size =
 
         /// <inheritdoc />
         public string GetDefaultAvatarUrl()
-            => CDN.GetDefaultUserAvatarUrl(DiscriminatorValue);
+            => DiscriminatorValue != 0
+                ? CDN.GetDefaultUserAvatarUrl(DiscriminatorValue)
+                : CDN.GetDefaultUserAvatarUrl(Id);
 
         /// <summary>
         ///     Gets the Username#Discriminator of the user.

src/Discord.Net.Rest/Extensions/EntityExtensions.cs

@@ -201,9 +201,10 @@ public static API.Message ToMessage(this API.InteractionResponse model, IDiscord
                             Username = command.User.Username,
                             Avatar = command.User.AvatarId,
                             Bot = command.User.IsBot,
-                            Discriminator = command.User.Discriminator,
+                            Discriminator = command.User.Discriminator == "0000" ? Optional<string>.Unspecified : command.User.Discriminator,
                             PublicFlags = command.User.PublicFlags.HasValue ? command.User.PublicFlags.Value : Optional<UserProperties>.Unspecified,
                             Id = command.User.Id,
+                            GlobalName = command.User.GlobalName,
                         }
                     };
                 }