UI Localization (#166)

src/EvoSC.Commands/Middleware/CommandsMiddleware.cs

@@ -68,6 +68,8 @@ private async Task ExecuteCommandAsync(IChatCommand cmd, object[] args, ChatRout
         };
 
         controller.SetContext(playerInteractionContext);
+        var contextService = context.ServiceScope.GetInstance<IContextService>();
+        contextService.UpdateContext(playerInteractionContext);
 
         var actionChain = _actionPipeline.BuildChain(PipelineType.ControllerAction, _ =>
             (Task?)cmd.HandlerMethod.Invoke(controller, args) ?? Task.CompletedTask

src/EvoSC.Common/Config/Models/IEvoScBaseConfig.cs

@@ -8,4 +8,5 @@ public interface IEvoScBaseConfig
     public IPathConfig Path { get; set; }
     public IThemeConfig Theme { get; set; }
     public IModuleConfig Modules { get; set; }
+    public ILocaleConfig Locale { get; set; }
 }

src/EvoSC.Common/Config/Models/ILocaleConfig.cs

@@ -0,0 +1,11 @@
+using System.ComponentModel;
+using Config.Net;
+
+namespace EvoSC.Common.Config.Models;
+
+public interface ILocaleConfig
+{
+    [Description("The default display language of the controller. Must be a \"language tag\" as found here: https://learn.microsoft.com/en-us/openspecs/windows_protocols/ms-lcid/a9eac961-e77d-41a6-90a5-ce1a8b0cdb9c")]
+    [Option(Alias = "defaultLanguage", DefaultValue = "en")]
+    public string DefaultLanguage { get; }
+}

src/EvoSC.Common/Database/Migrations/202306201107_AddPlayerSettingsTable.cs

@@ -0,0 +1,21 @@
+using FluentMigrator;
+
+namespace EvoSC.Common.Database.Migrations;
+
+[Migration(1687252035)]
+public class AddPlayerSettingsTable : Migration
+{
+    public const string PlayerSettings = "PlayerSettings";
+
+    public override void Up()
+    {
+        Create.Table(PlayerSettings)
+            .WithColumn("PlayerId").AsInt64().Unique()
+            .WithColumn("DisplayLanguage").AsString().WithDefaultValue("en");
+    }
+
+    public override void Down()
+    {
+        Delete.Table(PlayerSettings);
+    }
+}

src/EvoSC.Common/Database/Models/Permissions/DbPermission.cs

@@ -14,7 +14,7 @@ public class DbPermission : IPermission
 
     [Column]
     public string Description { get; set; }
-    
+
     public DbPermission(){}
 
     public DbPermission(IPermission permission)

src/EvoSC.Common/Database/Models/Player/DbPlayer.cs

@@ -41,7 +41,12 @@ public class DbPlayer : IPlayer
 
     [Column]
     public string? Zone { get; set; }
-
+
+    public IPlayerSettings Settings => DbSettings;
+
+    [Association(ThisKey = nameof(Id), OtherKey = nameof(DbPlayerSettings.PlayerId))]
+    public DbPlayerSettings DbSettings { get; set; }
+
     public DbPlayer() {}
 
     public DbPlayer(IPlayer? player)

src/EvoSC.Common/Database/Models/Player/DbPlayerSettings.cs

@@ -0,0 +1,14 @@
+using EvoSC.Common.Interfaces.Models;
+using LinqToDB.Mapping;
+
+namespace EvoSC.Common.Database.Models.Player;
+
+[Table("PlayerSettings")]
+public class DbPlayerSettings : IPlayerSettings
+{
+    [Column]
+    public long PlayerId { get; set; }
+
+    [Column]
+    public string DisplayLanguage { get; set; }
+}

src/EvoSC.Common/Database/Repository/Players/PlayerRepository.cs

@@ -15,6 +15,7 @@ public PlayerRepository(IDbConnectionFactory dbConnFactory) : base(dbConnFactory
     }
 
     public async Task<IPlayer?> GetPlayerByAccountIdAsync(string accountId) => await Table<DbPlayer>()
+        .LoadWith(p => p.DbSettings)
         .SingleOrDefaultAsync(t => t.AccountId == accountId);
 
     public async Task<IPlayer> AddPlayerAsync(string accountId, TmPlayerDetailedInfo playerInfo)
@@ -32,6 +33,15 @@ public async Task<IPlayer> AddPlayerAsync(string accountId, TmPlayerDetailedInfo
         var id = await Database.InsertWithIdentityAsync(player);
         player.Id =  Convert.ToInt64(id);
 
+        var playerSettings = new DbPlayerSettings
+        {
+            PlayerId = player.Id, 
+            DisplayLanguage = "en"
+
+        };
+
+        await Database.InsertAsync(playerSettings);
+
         return player;
     }
 

src/EvoSC.Common/Events/EventManager.cs

@@ -233,6 +233,9 @@ private IController CreateControllerInstance(EventSubscription subscription)
         var (instance, scopeContext) = _controllers.CreateInstance(subscription.InstanceClass);
         var context = new EventControllerContext(scopeContext);
         instance.SetContext(context);
+
+        var contextService = scopeContext.ServiceScope.GetInstance<IContextService>();
+        contextService.UpdateContext(context);
 
         return instance;
     }

src/EvoSC.Common/EvoSC.Common.csproj

@@ -8,6 +8,7 @@
 
     <ItemGroup>
         <InternalsVisibleTo Include="EvoSC.Common.Tests" />
+        <InternalsVisibleTo Include="DynamicProxyGenAssembly2" />
     </ItemGroup>
 
     <ItemGroup>

src/EvoSC.Common/Interfaces/Controllers/IContextService.cs

@@ -12,7 +12,9 @@ public interface IContextService
     /// <param name="controller">The controller to create the context for.</param>
     /// <returns></returns>
     internal IControllerContext CreateContext(Scope scope, IController controller);
-
+
+    public void UpdateContext(IControllerContext context);
+
     /// <summary>
     /// Get the current context in the current scope.
     /// </summary>

src/EvoSC.Common/Interfaces/Localization/ILocalizationManager.cs

@@ -0,0 +1,21 @@
+using System.Globalization;
+using System.Resources;
+
+namespace EvoSC.Common.Interfaces.Localization;
+
+public interface ILocalizationManager
+{
+    /// <summary>
+    /// The resource manager for the resource of the locales.
+    /// </summary>
+    public ResourceManager Manager { get; }
+
+    /// <summary>
+    /// Get the string of a locale key using the provided culture.
+    /// </summary>
+    /// <param name="culture">The culture/language to use.</param>
+    /// <param name="name">Name of the locale.</param>
+    /// <param name="args">Arguments passed to string.Format</param>
+    /// <returns></returns>
+    public string GetString(CultureInfo culture, string name, params object[] args);
+}

src/EvoSC.Common/Interfaces/Localization/Locale.cs

@@ -0,0 +1,34 @@
+using System.Dynamic;
+using System.Resources;
+
+namespace EvoSC.Common.Interfaces.Localization;
+
+public abstract class Locale : DynamicObject
+{
+    /// <summary>
+    /// Get the string of a locale key.
+    /// </summary>
+    /// <param name="name">Name of the locale</param>
+    /// <param name="args">Any formatting arguments to pass to string.Format</param>
+    public abstract string this[string name, params object[] args] { get; }
+
+    /// <summary>
+    /// Use the player's selected language when returning locale strings.
+    /// </summary>
+    public abstract Locale PlayerLanguage { get; }
+
+    /// <summary>
+    /// Get the resource set for the current resource.
+    /// </summary>
+    /// <returns></returns>
+    public abstract ResourceSet? GetResourceSet();
+
+    /// <summary>
+    /// Translate a string pattern containing locale names.
+    /// </summary>
+    /// <param name="pattern">The string to translate. Any locale name in the format
+    /// [LocaleName] will be replaced.</param>
+    /// <param name="args">Any formatting arguments to pass to string.Format</param>
+    /// <returns></returns>
+    public abstract string Translate(string pattern, params object[] args);
+}

src/EvoSC.Common/Interfaces/Models/IPlayer.cs

@@ -37,4 +37,5 @@ public interface IPlayer
     /// </summary>
     public string? Zone { get; }
 
+    public IPlayerSettings Settings { get; }
 }

src/EvoSC.Common/Interfaces/Models/IPlayerSettings.cs

@@ -0,0 +1,6 @@
+namespace EvoSC.Common.Interfaces.Models;
+
+public interface IPlayerSettings
+{
+    public string DisplayLanguage { get; set; }
+}

src/EvoSC.Common/Localization/LocaleResource.cs

@@ -0,0 +1,99 @@
+using System.Dynamic;
+using System.Globalization;
+using System.Resources;
+using System.Text;
+using System.Text.RegularExpressions;
+using EvoSC.Common.Config.Models;
+using EvoSC.Common.Controllers.Context;
+using EvoSC.Common.Interfaces.Controllers;
+using EvoSC.Common.Interfaces.Localization;
+
+namespace EvoSC.Common.Localization;
+
+public class LocaleResource : Locale
+{
+    private readonly ILocalizationManager _localeManager;
+    private readonly IContextService _context;
+    private readonly IEvoScBaseConfig _config;
+
+    private bool _useDefaultCulture = true;
+
+    private static readonly Regex TranslationTag =
+        new(@"\[([\w\d_]+)\]", RegexOptions.Compiled, TimeSpan.FromMilliseconds(50));
+
+    public override string this[string name, params object[] args] => GetString(name, args);
+
+    public override Locale PlayerLanguage => UsePlayerLanguage();
+
+    public LocaleResource(ILocalizationManager localeManager, IContextService context, IEvoScBaseConfig config)
+    {
+        _localeManager = localeManager;
+        _context = context;
+        _config = config;
+    }
+
+    public override ResourceSet? GetResourceSet() =>
+        _localeManager.Manager.GetResourceSet(GetCulture(), true, true);
+
+    public override string Translate(string pattern, params object[] args)
+    {
+        var matches = TranslationTag.Matches(pattern);
+        var sb = new StringBuilder();
+
+        var currIndex = 0;
+        foreach (Match match in matches)
+        {
+            sb.Append(pattern.Substring(currIndex, match.Index - currIndex));
+            var translation = GetString(match.Groups[1].Value, args);
+            currIndex = match.Index + match.Value.Length;
+
+            sb.Append(translation);
+        }
+
+        if (currIndex + 1 < pattern.Length)
+        {
+            sb.Append(pattern.Substring(currIndex));
+        }
+
+        return sb.ToString();
+    }
+
+    private CultureInfo GetCulture()
+    {
+        var context = _context.GetContext() as PlayerInteractionContext;
+
+        if (_useDefaultCulture || context?.Player?.Settings == null)
+        {
+            return CultureInfo.GetCultureInfo(_config.Locale.DefaultLanguage);
+        }
+
+        return CultureInfo.GetCultureInfo(context.Player.Settings.DisplayLanguage);
+    }
+
+    private Locale UsePlayerLanguage()
+    {
+        _useDefaultCulture = false;
+        return this;
+    }
+
+    private string GetString(string name, params object[] args)
+    {
+        var localString = _localeManager.GetString(GetCulture(), name, args);
+        _useDefaultCulture = true;
+        return localString;
+    }
+
+    public override bool TryGetMember(GetMemberBinder binder, out object? result)
+    {
+        var name = binder.Name.Replace("_", ".", StringComparison.Ordinal);
+        result = this[name];
+        return true;
+    }
+
+    public override bool TryInvokeMember(InvokeMemberBinder binder, object?[]? args, out object? result)
+    {
+        var name = binder.Name.Replace("_", ".", StringComparison.Ordinal);
+        result = this[name, args!];
+        return true;
+    }
+}

src/EvoSC.Common/Localization/LocalizationManager.cs

@@ -0,0 +1,33 @@
+using System.Globalization;
+using System.Reflection;
+using System.Resources;
+using EvoSC.Common.Interfaces.Localization;
+
+namespace EvoSC.Common.Localization;
+
+public class LocalizationManager : ILocalizationManager
+{
+    private readonly ResourceManager _resourceManager;
+
+    public LocalizationManager(Assembly assembly, string resource)
+    {
+        _resourceManager = new ResourceManager(resource, assembly);
+
+        // verify resource
+        _resourceManager.GetResourceSet(CultureInfo.InvariantCulture, true, true);
+    }
+
+    public ResourceManager Manager => _resourceManager;
+
+    public string GetString(CultureInfo culture, string name, params object[] args)
+    {
+        var localeString = _resourceManager.GetString(name, culture);
+
+        if (localeString == null)
+        {
+            throw new KeyNotFoundException($"Failed to find locale name {name}.");
+        }
+
+        return string.Format(localeString, args);
+    }
+}

src/EvoSC.Common/Models/Players/OnlinePlayer.cs

@@ -10,6 +10,7 @@ public class OnlinePlayer : IOnlinePlayer
     public string NickName { get; set; }
     public string UbisoftName { get; set; }
     public string Zone { get; set; }
+    public IPlayerSettings Settings { get; set; }
     public required PlayerState State { get; set; }
     public IPlayerFlags Flags { get; set; }
 
@@ -22,5 +23,6 @@ public OnlinePlayer(IPlayer player)
         NickName = player.NickName;
         UbisoftName = player.UbisoftName;
         Zone = player.Zone;
+        Settings = player.Settings;
     }
 }

src/EvoSC.Common/Models/Players/Player.cs

@@ -10,6 +10,7 @@ public class Player : IPlayer
     public string NickName { get; init; }
     public string UbisoftName { get; init; }
     public string? Zone { get; init; }
+    public IPlayerSettings Settings { get; set; }
 
     public Player()
     {
@@ -22,5 +23,6 @@ public Player(DbPlayer dbPlayer) : this()
         NickName = dbPlayer.NickName;
         UbisoftName = dbPlayer.UbisoftName;
         Zone = dbPlayer.Zone;
+        Settings = dbPlayer.Settings;
     }
 }

src/EvoSC.Common/Services/ContextService.cs

@@ -30,6 +30,11 @@ public IControllerContext CreateContext(Scope scope, IController controller)
         return context;
     }
 
+    public void UpdateContext(IControllerContext context)
+    {
+        _context = context;
+    }
+
     public IControllerContext GetContext()
     {
         if (_context == null)