diff --git a/Common/Utilities.cs b/Common/Utilities.cs index 4ffe0b9..11eadb4 100644 --- a/Common/Utilities.cs +++ b/Common/Utilities.cs @@ -1,5 +1,7 @@ using Discord; +using RegexBot.Data; using System.Diagnostics.CodeAnalysis; +using System.Net; using System.Text; using System.Text.RegularExpressions; @@ -81,9 +83,41 @@ public static class Utilities { try { var entityTry = new EntityName(input!, EntityType.User); var issueq = bot.EcQueryUser(entityTry.Id!.Value.ToString()); - if (issueq != null) result = $"<@{issueq.UserId}> - {issueq.Username}#{issueq.Discriminator} `{issueq.UserId}`"; + if (issueq != null) result = $"<@{issueq.UserId}> - {issueq.GetDisplayableUsername()} `{issueq.UserId}`"; else result = $"Unknown user with ID `{entityTry.Id!.Value}`"; } catch (Exception) { } return result ?? input; } + + /// + public static string GetDisplayableUsername(this SocketUser user) + => GetDisplayableUsernameCommon(user.Username, user.Discriminator, user.GlobalName); + + /// + public static string GetDisplayableUsername(this CachedUser user) + => GetDisplayableUsernameCommon(user.Username, user.Discriminator, user.GlobalName); + + /// + /// Returns a string representation of the user's username suitable for display purposes. + /// For the sake of consistency, it is preferable using this instead of any other means, including Discord.Net's ToString. + /// + private static string GetDisplayableUsernameCommon(string username, string discriminator, string? global) { + static string escapeFormattingCharacters(string input) { + var result = new StringBuilder(); + foreach (var c in input) { + if (c is '\\' or '_' or '~' or '*' or '@' or '`') { + result.Append('\\'); + } + result.Append(c); + } + return result.ToString(); + } + + if (discriminator == "0000") { + if (global != null) return $"{escapeFormattingCharacters(global)} ({username})"; + return username; + } else { + return $"{escapeFormattingCharacters(username)}#{discriminator}"; + } + } } diff --git a/Data/CachedUser.cs b/Data/CachedUser.cs index 939d27b..ac7ed04 100644 --- a/Data/CachedUser.cs +++ b/Data/CachedUser.cs @@ -25,10 +25,15 @@ public class CachedUser { public string Username { get; set; } = null!; /// - /// Gets the user's discriminator value. + /// Gets the user's discriminator value. A value of "0000" means the user is on the new username system. /// public string Discriminator { get; set; } = null!; - + + /// + /// Gets the user's display name. A user may have a global name if they are on the new username system. + /// + public string? GlobalName { get; set; } = null!; + /// /// Gets the avatar URL, if any, for the associated user. /// diff --git a/Data/Migrations/20231115032040_NewUsernames.Designer.cs b/Data/Migrations/20231115032040_NewUsernames.Designer.cs new file mode 100644 index 0000000..9173923 --- /dev/null +++ b/Data/Migrations/20231115032040_NewUsernames.Designer.cs @@ -0,0 +1,239 @@ +// +using System; +using System.Collections.Generic; +using Microsoft.EntityFrameworkCore; +using Microsoft.EntityFrameworkCore.Infrastructure; +using Microsoft.EntityFrameworkCore.Migrations; +using Microsoft.EntityFrameworkCore.Storage.ValueConversion; +using Npgsql.EntityFrameworkCore.PostgreSQL.Metadata; +using RegexBot.Data; + +#nullable disable + +namespace RegexBot.Data.Migrations +{ + [DbContext(typeof(BotDatabaseContext))] + [Migration("20231115032040_NewUsernames")] + partial class NewUsernames + { + protected override void BuildTargetModel(ModelBuilder modelBuilder) + { +#pragma warning disable 612, 618 + modelBuilder + .HasAnnotation("ProductVersion", "6.0.7") + .HasAnnotation("Relational:MaxIdentifierLength", 63); + + NpgsqlModelBuilderExtensions.HasPostgresEnum(modelBuilder, "mod_log_type", new[] { "other", "note", "warn", "timeout", "kick", "ban" }); + NpgsqlModelBuilderExtensions.UseIdentityByDefaultColumns(modelBuilder); + + modelBuilder.Entity("RegexBot.Data.CachedGuildMessage", b => + { + b.Property("MessageId") + .HasColumnType("bigint") + .HasColumnName("message_id"); + + b.Property>("AttachmentNames") + .IsRequired() + .HasColumnType("text[]") + .HasColumnName("attachment_names"); + + b.Property("AuthorId") + .HasColumnType("bigint") + .HasColumnName("author_id"); + + b.Property("ChannelId") + .HasColumnType("bigint") + .HasColumnName("channel_id"); + + b.Property("Content") + .HasColumnType("text") + .HasColumnName("content"); + + b.Property("CreatedAt") + .ValueGeneratedOnAdd() + .HasColumnType("timestamp with time zone") + .HasColumnName("created_at") + .HasDefaultValueSql("now()"); + + b.Property("EditedAt") + .HasColumnType("timestamp with time zone") + .HasColumnName("edited_at"); + + b.Property("GuildId") + .HasColumnType("bigint") + .HasColumnName("guild_id"); + + b.HasKey("MessageId") + .HasName("pk_cache_guildmessages"); + + b.HasIndex("AuthorId") + .HasDatabaseName("ix_cache_guildmessages_author_id"); + + b.ToTable("cache_guildmessages", (string)null); + }); + + modelBuilder.Entity("RegexBot.Data.CachedGuildUser", b => + { + b.Property("GuildId") + .HasColumnType("bigint") + .HasColumnName("guild_id"); + + b.Property("UserId") + .HasColumnType("bigint") + .HasColumnName("user_id"); + + b.Property("FirstSeenTime") + .ValueGeneratedOnAdd() + .HasColumnType("timestamp with time zone") + .HasColumnName("first_seen_time") + .HasDefaultValueSql("now()"); + + b.Property("GULastUpdateTime") + .HasColumnType("timestamp with time zone") + .HasColumnName("gu_last_update_time"); + + b.Property("Nickname") + .HasColumnType("text") + .HasColumnName("nickname"); + + b.HasKey("GuildId", "UserId") + .HasName("pk_cache_usersinguild"); + + b.HasIndex("UserId") + .HasDatabaseName("ix_cache_usersinguild_user_id"); + + b.ToTable("cache_usersinguild", (string)null); + }); + + modelBuilder.Entity("RegexBot.Data.CachedUser", b => + { + b.Property("UserId") + .HasColumnType("bigint") + .HasColumnName("user_id"); + + b.Property("AvatarUrl") + .HasColumnType("text") + .HasColumnName("avatar_url"); + + b.Property("Discriminator") + .IsRequired() + .HasMaxLength(4) + .HasColumnType("character(4)") + .HasColumnName("discriminator") + .IsFixedLength(); + + b.Property("GlobalName") + .HasColumnType("text") + .HasColumnName("global_name"); + + b.Property("ULastUpdateTime") + .HasColumnType("timestamp with time zone") + .HasColumnName("u_last_update_time"); + + b.Property("Username") + .IsRequired() + .HasColumnType("text") + .HasColumnName("username"); + + b.HasKey("UserId") + .HasName("pk_cache_users"); + + b.ToTable("cache_users", (string)null); + }); + + modelBuilder.Entity("RegexBot.Data.ModLogEntry", b => + { + b.Property("LogId") + .ValueGeneratedOnAdd() + .HasColumnType("integer") + .HasColumnName("log_id"); + + NpgsqlPropertyBuilderExtensions.UseIdentityByDefaultColumn(b.Property("LogId")); + + b.Property("GuildId") + .HasColumnType("bigint") + .HasColumnName("guild_id"); + + b.Property("IssuedBy") + .IsRequired() + .HasColumnType("text") + .HasColumnName("issued_by"); + + b.Property("LogType") + .HasColumnType("integer") + .HasColumnName("log_type"); + + b.Property("Message") + .HasColumnType("text") + .HasColumnName("message"); + + b.Property("Timestamp") + .ValueGeneratedOnAdd() + .HasColumnType("timestamp with time zone") + .HasColumnName("timestamp") + .HasDefaultValueSql("now()"); + + b.Property("UserId") + .HasColumnType("bigint") + .HasColumnName("user_id"); + + b.HasKey("LogId") + .HasName("pk_modlogs"); + + b.HasIndex("GuildId", "UserId") + .HasDatabaseName("ix_modlogs_guild_id_user_id"); + + b.ToTable("modlogs", (string)null); + }); + + modelBuilder.Entity("RegexBot.Data.CachedGuildMessage", b => + { + b.HasOne("RegexBot.Data.CachedUser", "Author") + .WithMany("GuildMessages") + .HasForeignKey("AuthorId") + .OnDelete(DeleteBehavior.Cascade) + .IsRequired() + .HasConstraintName("fk_cache_guildmessages_cache_users_author_id"); + + b.Navigation("Author"); + }); + + modelBuilder.Entity("RegexBot.Data.CachedGuildUser", b => + { + b.HasOne("RegexBot.Data.CachedUser", "User") + .WithMany("Guilds") + .HasForeignKey("UserId") + .OnDelete(DeleteBehavior.Cascade) + .IsRequired() + .HasConstraintName("fk_cache_usersinguild_cache_users_user_id"); + + b.Navigation("User"); + }); + + modelBuilder.Entity("RegexBot.Data.ModLogEntry", b => + { + b.HasOne("RegexBot.Data.CachedGuildUser", "User") + .WithMany("Logs") + .HasForeignKey("GuildId", "UserId") + .OnDelete(DeleteBehavior.Cascade) + .IsRequired() + .HasConstraintName("fk_modlogs_cache_usersinguild_user_temp_id"); + + b.Navigation("User"); + }); + + modelBuilder.Entity("RegexBot.Data.CachedGuildUser", b => + { + b.Navigation("Logs"); + }); + + modelBuilder.Entity("RegexBot.Data.CachedUser", b => + { + b.Navigation("GuildMessages"); + + b.Navigation("Guilds"); + }); +#pragma warning restore 612, 618 + } + } +} diff --git a/Data/Migrations/20231115032040_NewUsernames.cs b/Data/Migrations/20231115032040_NewUsernames.cs new file mode 100644 index 0000000..b213dc3 --- /dev/null +++ b/Data/Migrations/20231115032040_NewUsernames.cs @@ -0,0 +1,25 @@ +using Microsoft.EntityFrameworkCore.Migrations; + +#nullable disable + +namespace RegexBot.Data.Migrations +{ + public partial class NewUsernames : Migration + { + protected override void Up(MigrationBuilder migrationBuilder) + { + migrationBuilder.AddColumn( + name: "global_name", + table: "cache_users", + type: "text", + nullable: true); + } + + protected override void Down(MigrationBuilder migrationBuilder) + { + migrationBuilder.DropColumn( + name: "global_name", + table: "cache_users"); + } + } +} diff --git a/Data/Migrations/BotDatabaseContextModelSnapshot.cs b/Data/Migrations/BotDatabaseContextModelSnapshot.cs index e19c408..59be248 100644 --- a/Data/Migrations/BotDatabaseContextModelSnapshot.cs +++ b/Data/Migrations/BotDatabaseContextModelSnapshot.cs @@ -120,6 +120,10 @@ namespace RegexBot.Data.Migrations .HasColumnName("discriminator") .IsFixedLength(); + b.Property("GlobalName") + .HasColumnType("text") + .HasColumnName("global_name"); + b.Property("ULastUpdateTime") .HasColumnType("timestamp with time zone") .HasColumnName("u_last_update_time"); diff --git a/Modules/EntryRole/EntryRole.cs b/Modules/EntryRole/EntryRole.cs index 74b4440..7c2815f 100644 --- a/Modules/EntryRole/EntryRole.cs +++ b/Modules/EntryRole/EntryRole.cs @@ -1,7 +1,7 @@ -using System.Text; +using RegexBot.Common; +using System.Text; namespace RegexBot.Modules.EntryRole; - /// /// Automatically sets a role onto users entering the guild after a predefined amount of time. /// @@ -138,7 +138,7 @@ internal sealed class EntryRole : RegexbotModule, IDisposable { var failList = new StringBuilder(); var count = 0; foreach (var item in failedUserList) { - failList.Append($", {item.Username}#{item.Discriminator}"); + failList.Append($", {item.GetDisplayableUsername()}"); count++; if (count > 5) { failList.Append($"and {count} other(s)."); diff --git a/Modules/ModCommands/Commands/ShowModLogs.cs b/Modules/ModCommands/Commands/ShowModLogs.cs index 9837bb2..dab9c6f 100644 --- a/Modules/ModCommands/Commands/ShowModLogs.cs +++ b/Modules/ModCommands/Commands/ShowModLogs.cs @@ -58,7 +58,7 @@ class ShowModLogs : CommandConfig { var resultList = new EmbedBuilder() { Author = new EmbedAuthorBuilder() { - Name = $"{query.User.Username}#{query.User.Discriminator}", + Name = $"{query.User.GetDisplayableUsername()}", IconUrl = query.User.AvatarUrl }, Footer = new EmbedFooterBuilder() { diff --git a/Modules/ModCommands/Commands/Unban.cs b/Modules/ModCommands/Commands/Unban.cs index 609ff1d..9013ef4 100644 --- a/Modules/ModCommands/Commands/Unban.cs +++ b/Modules/ModCommands/Commands/Unban.cs @@ -29,13 +29,13 @@ class Unban : CommandConfig { var query = Module.Bot.EcQueryUser(targetstr); if (query != null) { targetId = (ulong)query.UserId; - targetDisplay = $"{query.Username}#{query.Discriminator}"; + targetDisplay = $"**{query.GetDisplayableUsername()}**"; } else { if (!ulong.TryParse(targetstr, out targetId)) { await SendUsageMessageAsync(msg.Channel, TargetNotFound); return; } - targetDisplay = $"with ID {targetId}"; + targetDisplay = $"with ID **{targetId}**"; } // Do the action diff --git a/Modules/ModLogs/ModLogs_Logging.cs b/Modules/ModLogs/ModLogs_Logging.cs index 45add4d..98a2c62 100644 --- a/Modules/ModLogs/ModLogs_Logging.cs +++ b/Modules/ModLogs/ModLogs_Logging.cs @@ -24,7 +24,7 @@ internal partial class ModLogs { var issuedDisplay = Utilities.TryFromEntityNameString(entry.IssuedBy, Bot); string targetDisplay; var targetq = Bot.EcQueryUser(entry.UserId.ToString()); - if (targetq != null) targetDisplay = $"<@{targetq.UserId}> - {targetq.Username}#{targetq.Discriminator} `{targetq.UserId}`"; + if (targetq != null) targetDisplay = $"<@{targetq.UserId}> - {targetq.GetDisplayableUsername()} `{targetq.UserId}`"; else targetDisplay = $"User with ID `{entry.UserId}`"; var logEmbed = new EmbedBuilder() diff --git a/Modules/ModLogs/ModLogs_Messages.cs b/Modules/ModLogs/ModLogs_Messages.cs index 7f1714b..791b439 100644 --- a/Modules/ModLogs/ModLogs_Messages.cs +++ b/Modules/ModLogs/ModLogs_Messages.cs @@ -1,5 +1,6 @@ using Discord; using Microsoft.EntityFrameworkCore; +using RegexBot.Common; using RegexBot.Data; using System.Text; @@ -51,7 +52,7 @@ internal partial class ModLogs { }; } else { reportEmbed.Author = new EmbedAuthorBuilder() { - Name = $"{cachedMsg.Author.Username}#{cachedMsg.Author.Discriminator}", + Name = $"{cachedMsg.Author.GetDisplayableUsername()}", IconUrl = cachedMsg.Author.AvatarUrl ?? GetDefaultAvatarUrl(cachedMsg.Author.Discriminator) }; } @@ -87,7 +88,7 @@ internal partial class ModLogs { .WithFooter($"Message ID: {newMsg.Id}"); reportEmbed.Author = new EmbedAuthorBuilder() { - Name = $"{newMsg.Author.Username}#{newMsg.Author.Discriminator}", + Name = $"{newMsg.Author.GetDisplayableUsername()}", IconUrl = newMsg.Author.GetAvatarUrl() ?? newMsg.Author.GetDefaultAvatarUrl() }; @@ -132,7 +133,7 @@ internal partial class ModLogs { string userDisplay; if (userId.HasValue) { var q = Bot.EcQueryUser(userId.Value.ToString()); - if (q != null) userDisplay = $"<@{q.UserId}> - {q.Username}#{q.Discriminator} `{q.UserId}`"; + if (q != null) userDisplay = $"<@{q.UserId}> - {q.GetDisplayableUsername()} `{q.UserId}`"; else userDisplay = $"Unknown user with ID `{userId}`"; } else { userDisplay = "Unknown"; diff --git a/Modules/RegexModerator/ResponseExecutor.cs b/Modules/RegexModerator/ResponseExecutor.cs index 3124549..083ee0d 100644 --- a/Modules/RegexModerator/ResponseExecutor.cs +++ b/Modules/RegexModerator/ResponseExecutor.cs @@ -113,8 +113,8 @@ class ResponseExecutor { } ) .WithAuthor( - name: $"{_msg.Author.Username}#{_msg.Author.Discriminator} said:", - iconUrl: _msg.Author.GetAvatarUrl(), + name: $"{_user.GetDisplayableUsername()} said:", + iconUrl: _user.GetAvatarUrl(), url: _msg.GetJumpUrl() ) .WithDescription(invokingLine) @@ -127,7 +127,7 @@ class ResponseExecutor { try { await reportTarget.SendMessageAsync(embed: resultEmbed); } catch (Discord.Net.HttpException ex) when (ex.HttpCode == System.Net.HttpStatusCode.Forbidden) { - Log("Encountered 403 error when attempting to send report."); + Log("Encountered error 403 when attempting to send report."); } } } @@ -218,7 +218,7 @@ class ResponseExecutor { if (targetCh == null) return FromError($"Unable to find channel '{name.Name}'."); isUser = false; } else if (name.Type == EntityType.User) { - if (name.Name == "_") targetCh = await _msg.Author.CreateDMChannelAsync(); + if (name.Name == "_") targetCh = await _user.CreateDMChannelAsync(); else { var searchedUser = name.FindUserIn(_guild); if (searchedUser == null) return FromError($"Unable to find user '{name.Name}'."); diff --git a/RegexBot.csproj b/RegexBot.csproj index 095d8f2..e1a4cf4 100644 --- a/RegexBot.csproj +++ b/RegexBot.csproj @@ -13,7 +13,7 @@ - + diff --git a/Services/CommonFunctions/BanKickResult.cs b/Services/CommonFunctions/BanKickResult.cs index ac8d574..0aeee7b 100644 --- a/Services/CommonFunctions/BanKickResult.cs +++ b/Services/CommonFunctions/BanKickResult.cs @@ -98,8 +98,7 @@ public class BanKickResult { if (_rptTargetId != 0) { var user = bot.EcQueryUser(_rptTargetId.ToString()); if (user != null) { - // TODO sanitize possible formatting characters in display name - msg += $" user **{user.Username}#{user.Discriminator}**"; + msg += $" user **{user.GetDisplayableUsername()}**"; } else { msg += $" user with ID **{_rptTargetId}**"; } diff --git a/Services/CommonFunctions/CF_ModLogs.Hooks.cs b/Services/CommonFunctions/CF_ModLogs.Hooks.cs index 5dce387..6e7b74f 100644 --- a/Services/CommonFunctions/CF_ModLogs.Hooks.cs +++ b/Services/CommonFunctions/CF_ModLogs.Hooks.cs @@ -68,7 +68,7 @@ partial class RegexbotClient { // Attempt warning message var userSearch = _svcEntityCache.QueryUserCache(targetUser.ToString()); var userDisp = userSearch != null - ? $"**{userSearch.Username}#{userSearch.Discriminator}**" + ? $"**{userSearch.GetDisplayableUsername()}**" : $"user with ID **{targetUser}**"; var targetGuildUser = guild.GetUser(targetUser); if (targetGuildUser == null) return (entry, new LogAppendResult( diff --git a/Services/CommonFunctions/TimeoutSetResult.cs b/Services/CommonFunctions/TimeoutSetResult.cs index 5274a29..0cc0806 100644 --- a/Services/CommonFunctions/TimeoutSetResult.cs +++ b/Services/CommonFunctions/TimeoutSetResult.cs @@ -15,10 +15,10 @@ public class TimeoutSetResult : IOperationResult { public Exception? Error { get; } /// - public bool ErrorNotFound => (_target == null) || ((Error as HttpException)?.HttpCode == System.Net.HttpStatusCode.NotFound); + public bool ErrorNotFound => (_target == null) || Error is HttpException { HttpCode: System.Net.HttpStatusCode.NotFound }; /// - public bool ErrorForbidden => (Error as HttpException)?.HttpCode == System.Net.HttpStatusCode.Forbidden; + public bool ErrorForbidden => Error is HttpException { HttpCode: System.Net.HttpStatusCode.Forbidden }; /// public bool NotificationSuccess { get; } @@ -32,7 +32,7 @@ public class TimeoutSetResult : IOperationResult { /// public string ToResultString() { if (Success) { - var msg = $":white_check_mark: Timeout set for **{_target!.Username}#{_target.Discriminator}**."; + var msg = $":white_check_mark: Timeout set for **{_target!.GetDisplayableUsername()}**."; if (!NotificationSuccess) msg += "\n(User was unable to receive notification message.)"; return msg; } else { diff --git a/Services/EntityCache/UserCachingSubservice.cs b/Services/EntityCache/UserCachingSubservice.cs index e7c5c2f..e05360b 100644 --- a/Services/EntityCache/UserCachingSubservice.cs +++ b/Services/EntityCache/UserCachingSubservice.cs @@ -60,6 +60,7 @@ class UserCachingSubservice { uinfo.Username = user.Username; uinfo.Discriminator = user.Discriminator; + uinfo.GlobalName = user.GlobalName; uinfo.AvatarUrl = user.GetAvatarUrl(size: 512); uinfo.ULastUpdateTime = DateTimeOffset.UtcNow; }