Fix: Discriminator Use, replace with a UserNameReference Method for a common format

Author: SimplyJpk

DiscordBot/Extensions/UserExtensions.cs

@@ -17,4 +17,29 @@ public static bool HasRoleGroup(this IUser user, ulong roleId)
     {
         return user is SocketGuildUser guildUser && guildUser.Roles.Any(x => x.Id == roleId);
     }
+    
+    public static bool IsNickAndNameEqual(this IUser user)
+    {
+        return user is SocketGuildUser guildUser && string.Equals(guildUser.Nickname, guildUser.Username, StringComparison.CurrentCultureIgnoreCase);
+    }
+    
+    // Returns a simple string formatted as: "**user.Username** (aka **user.Nickname**)"
+    // Nickname is only included if it's different from the username
+    public static string UserNameReferenceForEmbed(this IUser user)
+    {
+        var reference = $"**{user.Username}**";
+        if (!user.IsNickAndNameEqual())
+            reference += $" (aka **{user}**)";
+        return reference;
+    }
+    
+    // Returns a simple string formatted as: "user.Username (aka user.Nickname)"
+    // Nickname is only included if it's different from the username
+    public static string UserNameReference(this IUser user)
+    {
+        var reference = $"{user.Username}";
+        if (!user.IsNickAndNameEqual())
+            reference += $" (aka {user})";
+        return reference;
+    }
 }

DiscordBot/Modules/UserModule.cs

@@ -131,7 +131,7 @@ public async Task QuoteMessage(ulong messageId, IMessageChannel channel = null)
             .WithFooter(footer =>
             {
                 footer
-                    .WithText($"Quoted by {Context.User.Username}#{Context.User.Discriminator} • From channel {message.Channel.Name}")
+                    .WithText($"Quoted by {Context.User.UserNameReference()} • From channel {message.Channel.Name}")
                     .WithIconUrl(Context.User.GetAvatarUrl());
             })
             .WithAuthor(author =>

DiscordBot/Modules/UserSlashModule.cs

@@ -170,7 +170,7 @@ public async Task ModalResponse(ulong id, ReportMessageModal modal)
         .WithFooter(footer =>
         {
             footer
-                .WithText($"Reported by {Context.User.Username}#{Context.User.Discriminator} • From channel {reportedMessage.Channel.Name}")
+                .WithText($"Reported by {Context.User.UserNameReference()} • From channel {reportedMessage.Channel.Name}")
                 .WithIconUrl(Context.User.GetAvatarUrl());
         })
         .WithAuthor(author =>

DiscordBot/Services/DatabaseService.cs

@@ -134,7 +134,7 @@ public async Task AddNewUser(SocketGuildUser socketUser)
             await Query().InsertUser(user);
 
             await _logging.LogAction(
-                $"User {socketUser.Username}#{socketUser.DiscriminatorValue.ToString()} successfully added to the database.",
+                $"User {socketUser.UserNameReference()} successfully added to the database.",
                 true,
                 false);
         }

DiscordBot/Services/ModerationService.cs

@@ -25,6 +25,7 @@ private async Task MessageDeleted(Cacheable<IMessage, ulong> message, Cacheable<
         if (content.Length > 800)
             content = content.Substring(0, 800);
 
+        var user = message.Value.Author;
         var builder = new EmbedBuilder()
             .WithColor(new Color(200, 128, 128))
             .WithTimestamp(message.Value.Timestamp)
@@ -36,13 +37,13 @@ private async Task MessageDeleted(Cacheable<IMessage, ulong> message, Cacheable<
             .WithAuthor(author =>
             {
                 author
-                    .WithName($"{message.Value.Author.Username}");
+                    .WithName($"{user.Username}");
             })
             .AddField("Deleted message", content);
         var embed = builder.Build();
-
+        
         await _loggingService.LogAction(
-            $"User {message.Value.Author.Username}#{message.Value.Author.DiscriminatorValue} has " +
+            $"User {user.UserNameReference()} has " +
             $"deleted the message\n{content}\n from channel #{(await channel.GetOrDownloadAsync()).Name}", true, false);
         await _loggingService.LogAction(" ", false, true, embed);
     }

DiscordBot/Services/UserService.cs

@@ -165,13 +165,13 @@ private async Task UserLeft(SocketGuild guild, SocketUser user)
             var timeStayed = DateTime.Now - joinDate;
             await _loggingService.LogAction(
                 $"User Left - After {(timeStayed.Days > 1 ? Math.Floor((double)timeStayed.Days) + " days" : " ")}" +
-                $" {Math.Floor((double)timeStayed.Hours).ToString(CultureInfo.InvariantCulture)} hours {user.Mention} - `{user.Username}#{user.DiscriminatorValue}` - ID : `{user.Id}`");
+                $" {Math.Floor((double)timeStayed.Hours).ToString(CultureInfo.InvariantCulture)} hours {user.Mention} - `{guildUser.UserNameReference()}` - ID : `{user.Id}`");
         }
         // If bot is to slow to get user info, we just say they left at current time.
         else
         {
             await _loggingService.LogAction(
-                $"User `{user.Username}#{user.DiscriminatorValue}` - ID : `{user.Id}` - Left at {DateTime.Now}");
+                $"User `{guildUser.UserNameReference()}` - ID : `{user.Id}` - Left at {DateTime.Now}");
         }
     }
 
@@ -336,7 +336,7 @@ public async Task<string> GenerateProfileCard(IUser user)
                 MaxXpShown = maxXpShown,
                 Nickname = ((IGuildUser)user).Nickname,
                 UserId = ulong.Parse(userData.UserID),
-                Username = user.Username,
+                Username = user.UserNameReference(),
                 XpHigh = xpHigh,
                 XpLow = xpLow,
                 XpPercentage = percentage,
@@ -412,9 +412,10 @@ public Embed WelcomeMessage(SocketGuildUser user)
     {
         string icon = user.GetAvatarUrl();
         icon = string.IsNullOrEmpty(icon) ? "https://cdn.discordapp.com/embed/avatars/0.png" : icon;
-
+        
+        string welcomeString = $"Welcome to Unity Developer Community {user.UserNameReferenceForEmbed()}!";
         var builder = new EmbedBuilder()
-            .WithDescription($"Welcome to Unity Developer Community **{user.Username}#{user.Discriminator}**!")
+            .WithDescription(welcomeString)
             .WithColor(_welcomeColour)
             .WithAuthor(author =>
             {
@@ -652,7 +653,7 @@ private async Task UserJoined(SocketGuildUser user)
             {
                 await user.AddRoleAsync(socketTextChannel?.Guild.GetRole(_settings.MutedRoleId));
                 await _loggingService.LogAction(
-                    $"Currently muted user rejoined - {user.Mention} - `{user.Username}#{user.DiscriminatorValue}` - ID : `{user.Id}`");
+                    $"Currently muted user rejoined - {user.Mention} - `{user.UserNameReference()}` - ID : `{user.Id}`");
                 if (socketTextChannel != null)
                     await socketTextChannel.SendMessageAsync(
                         $"{user.Mention} tried to rejoin the server to avoid their mute. Mute time increased by 72 hours.");
@@ -662,7 +663,7 @@ await socketTextChannel.SendMessageAsync(
         }
 
         await _loggingService.LogAction(
-            $"User Joined - {user.Mention} - `{user.Username}#{user.DiscriminatorValue}` - ID : `{user.Id}`");
+            $"User Joined - {user.Mention} - `{user.UserNameReference()}` - ID : `{user.Id}`");
 
         // We check if they're already in the welcome list, if they are we don't add them again to avoid double posts
         if (_welcomeNoticeUsers.Count == 0 || !_welcomeNoticeUsers.Exists(u => u.id == user.Id))
@@ -767,8 +768,8 @@ private async Task UserUpdated(Cacheable<SocketGuildUser, ulong> oldUserCached,
         if (oldUser.Nickname != user.Nickname)
         {
             await _loggingService.LogAction(
-                $"User {oldUser.Nickname ?? oldUser.Username}#{oldUser.DiscriminatorValue} changed his " +
-                $"username to {user.Nickname ?? user.Username}#{user.DiscriminatorValue}");
+                $"User {oldUser.UserNameReference()} changed his " +
+                $"username to {user.UserNameReference()}");
         }
     }