CultureInfo should independent from local computer settings (Lombiq Technologies: OCORE-86)

src/OrchardCore.Cms.Web/appsettings.json

@@ -223,6 +223,9 @@
     //  "TenantId": "",
     //  "CallbackPath": "/signin-oidc",
     //  "SaveTokens": false
+    //},
+    //"OrchardCore_Localization_CultureOptions": {
+    //  "IgnoreSystemSettings": true
     //}
   }
 }

src/OrchardCore.Modules/OrchardCore.Autoroute/Handlers/AutoroutePartHandler.cs

@@ -397,7 +397,10 @@ private async Task GenerateContainerPathFromPatternAsync(AutoroutePart part)
                 _contentManager ??= _serviceProvider.GetRequiredService<IContentManager>();
 
                 var cultureAspect = await _contentManager.PopulateAspectAsync(part.ContentItem, new CultureAspect());
-                using (CultureScope.Create(cultureAspect.Culture))
+
+                var cultureOptions = _serviceProvider.GetService<IOptions<CultureOptions>>().Value;
+
+                using (CultureScope.Create(cultureAspect.Culture, ignoreSystemSettings: cultureOptions.IgnoreSystemSettings))
                 {
                     part.Path = await _liquidTemplateManager.RenderStringAsync(pattern, NullEncoder.Default, model,
                         new Dictionary<string, FluidValue>() { [nameof(ContentItem)] = new ObjectValue(model.ContentItem) });

src/OrchardCore.Modules/OrchardCore.Localization/Drivers/LocalizationSettingsDisplayDriver.cs

@@ -6,6 +6,7 @@
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Mvc.Localization;
 using Microsoft.Extensions.Localization;
+using Microsoft.Extensions.Options;
 using Newtonsoft.Json;
 using OrchardCore.DisplayManagement.Entities;
 using OrchardCore.DisplayManagement.Handlers;
@@ -24,11 +25,12 @@ namespace OrchardCore.Localization.Drivers
     public class LocalizationSettingsDisplayDriver : SectionDisplayDriver<ISite, LocalizationSettings>
     {
         public const string GroupId = "localization";
-        private readonly IHttpContextAccessor _httpContextAccessor;
-        private readonly IAuthorizationService _authorizationService;
         private readonly INotifier _notifier;
         private readonly IShellHost _shellHost;
         private readonly ShellSettings _shellSettings;
+        private readonly IHttpContextAccessor _httpContextAccessor;
+        private readonly IAuthorizationService _authorizationService;
+        private readonly CultureOptions _cultureOptions;
         private readonly IHtmlLocalizer H;
         private readonly IStringLocalizer S;
 
@@ -38,6 +40,7 @@ public LocalizationSettingsDisplayDriver(
             ShellSettings shellSettings,
             IHttpContextAccessor httpContextAccessor,
             IAuthorizationService authorizationService,
+            IOptions<CultureOptions> cultureOptions,
             IHtmlLocalizer<LocalizationSettingsDisplayDriver> h,
             IStringLocalizer<LocalizationSettingsDisplayDriver> s
         )
@@ -47,6 +50,7 @@ IStringLocalizer<LocalizationSettingsDisplayDriver> s
             _shellSettings = shellSettings;
             _httpContextAccessor = httpContextAccessor;
             _authorizationService = authorizationService;
+            _cultureOptions = cultureOptions.Value;
             H = h;
             S = s;
         }
@@ -119,7 +123,7 @@ public override async Task<IDisplayResult> UpdateAsync(LocalizationSettings sect
                     await _shellHost.ReleaseShellContextAsync(_shellSettings);
 
                     // We create a transient scope with the newly selected culture to create a notification that will use it instead of the previous culture
-                    using (CultureScope.Create(section.DefaultCulture))
+                    using (CultureScope.Create(section.DefaultCulture, ignoreSystemSettings: _cultureOptions.IgnoreSystemSettings))
                     {
                         await _notifier.WarningAsync(H["The site has been restarted for the settings to take effect."]);
                     }

src/OrchardCore.Modules/OrchardCore.Localization/Startup.cs

@@ -45,14 +45,14 @@ public override void Configure(IApplicationBuilder app, IEndpointRouteBuilder ro
             var defaultCulture = localizationService.GetDefaultCultureAsync().GetAwaiter().GetResult();
             var supportedCultures = localizationService.GetSupportedCulturesAsync().GetAwaiter().GetResult();
 
-            var options = serviceProvider.GetService<IOptions<RequestLocalizationOptions>>().Value;
-            options.SetDefaultCulture(defaultCulture);
-            options
+            var cultureOptions = serviceProvider.GetService<IOptions<CultureOptions>>().Value;
+
+            var requestLocalizationOptions = new OrchardCoreRequestLocalizationOptions(ignoreSystemSettings: cultureOptions.IgnoreSystemSettings)
+                .SetDefaultCulture(defaultCulture)
                 .AddSupportedCultures(supportedCultures)
-                .AddSupportedUICultures(supportedCultures)
-                ;
+                .AddSupportedUICultures(supportedCultures);
 
-            app.UseRequestLocalization(options);
+            app.UseRequestLocalization(requestLocalizationOptions);
         }
     }
 

src/OrchardCore.Modules/OrchardCore.Settings/Controllers/AdminController.cs

@@ -2,6 +2,7 @@
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Localization;
+using Microsoft.Extensions.Options;
 using OrchardCore.DisplayManagement;
 using OrchardCore.DisplayManagement.ModelBinding;
 using OrchardCore.DisplayManagement.Notify;
@@ -17,6 +18,7 @@ public class AdminController : Controller
         private readonly INotifier _notifier;
         private readonly IAuthorizationService _authorizationService;
         private readonly IUpdateModelAccessor _updateModelAccessor;
+        private readonly CultureOptions _cultureOptions;
         private readonly IHtmlLocalizer H;
 
         public AdminController(
@@ -25,13 +27,15 @@ public AdminController(
             IAuthorizationService authorizationService,
             INotifier notifier,
             IHtmlLocalizer<AdminController> h,
+            IOptions<CultureOptions> cultureOptions,
             IUpdateModelAccessor updateModelAccessor)
         {
             _siteSettingsDisplayManager = siteSettingsDisplayManager;
             _siteService = siteService;
             _notifier = notifier;
             _authorizationService = authorizationService;
             _updateModelAccessor = updateModelAccessor;
+            _cultureOptions = cultureOptions.Value;
             H = h;
         }
 
@@ -79,9 +83,8 @@ public async Task<IActionResult> IndexPost(string groupId)
                 {
                     culture = settings.Value<string>("DefaultCulture");
                 }
-
                 // We create a transient scope with the newly selected culture to create a notification that will use it instead of the previous culture
-                using (culture != null ? CultureScope.Create(culture) : null)
+                using (culture != null ? CultureScope.Create(culture, ignoreSystemSettings: _cultureOptions.IgnoreSystemSettings) : null)
                 {
                     await _notifier.SuccessAsync(H["Site settings updated successfully."]);
                 }

src/OrchardCore/OrchardCore.Abstractions/Localization/CultureOptions.cs

@@ -0,0 +1,12 @@
+namespace OrchardCore.Localization;
+
+/// <summary>
+/// Represents a programmable options for localization culture.
+/// </summary>
+public class CultureOptions
+{
+    /// <summary>
+    /// Gets or sets whether to ignore the system culture settings or not.
+    /// </summary>
+    public bool IgnoreSystemSettings { get; set; }
+}

src/OrchardCore/OrchardCore.Abstractions/Localization/CultureScope.cs

@@ -3,34 +3,70 @@
 
 namespace OrchardCore.Localization
 {
+    /// <summary>
+    /// Represents a scope that you can change the current culture within.
+    /// </summary>
     public sealed class CultureScope : IDisposable
     {
         private readonly CultureInfo _originalCulture;
         private readonly CultureInfo _originalUICulture;
 
-        private CultureScope(CultureInfo culture, CultureInfo uiCulture)
+        private CultureScope(string culture, string uiCulture, bool ignoreSystemSettings)
         {
-            Culture = culture;
-            UICulture = uiCulture;
+            var useUserOverride = !ignoreSystemSettings;
+            Culture = new CultureInfo(culture, useUserOverride);
+            UICulture = new CultureInfo(uiCulture, useUserOverride);
             _originalCulture = CultureInfo.CurrentCulture;
             _originalUICulture = CultureInfo.CurrentUICulture;
 
-            SetCultures(culture, uiCulture);
+            SetCultures(Culture, UICulture);
         }
 
+        /// <summary>
+        /// Gets the current culture.
+        /// </summary>
         public CultureInfo Culture { get; }
 
+        /// <summary>
+        /// Get the current UI culture.
+        /// </summary>
         public CultureInfo UICulture { get; }
 
-        public static CultureScope Create(string culture) => Create(culture, culture);
+        /// <summary>
+        /// Creates a scope with a given culture.
+        /// </summary>
+        /// <param name="culture">The culture that will be used within the scope.</param>
+        /// <param name="ignoreSystemSettings">Whether to ignore the system culture settings or not. Defaults to <c>false</c>.</param>
+        public static CultureScope Create(string culture, bool ignoreSystemSettings = false)
+            => Create(culture, culture, ignoreSystemSettings);
 
-        public static CultureScope Create(string culture, string uiCulture)
-            => Create(CultureInfo.GetCultureInfo(culture), CultureInfo.GetCultureInfo(uiCulture));
+        /// <summary>
+        /// Creates a scope with a given culture.
+        /// </summary>
+        /// <param name="culture">The culture that will be used within the scope.</param>
+        /// <param name="uiCulture">The UI culture that will be used within the scope.</param>
+        /// <param name="ignoreSystemSettings">Whether to ignore the system culture settings or not. Defaults to <c>false</c>.</param>
+        public static CultureScope Create(string culture, string uiCulture, bool ignoreSystemSettings = false)
+            => new(culture, uiCulture, ignoreSystemSettings);
 
-        public static CultureScope Create(CultureInfo culture) => Create(culture, culture);
+        /// <summary>
+        /// Creates a scope with a given culture.
+        /// </summary>
+        /// <param name="culture">The culture that will be used within the scope.</param>
+        /// <param name="ignoreSystemSettings">Whether to ignore the system culture settings or not. Defaults to <c>false</c>.</param>
+        public static CultureScope Create(CultureInfo culture, bool ignoreSystemSettings = false)
+            => Create(culture, culture, ignoreSystemSettings);
 
-        public static CultureScope Create(CultureInfo culture, CultureInfo uiCulture) => new CultureScope(culture, uiCulture);
+        /// <summary>
+        /// Creates a scope with a given culture.
+        /// </summary>
+        /// <param name="culture">The culture that will be used within the scope.</param>
+        /// <param name="uiCulture">The UI culture that will be used within the scope.</param>
+        /// <param name="ignoreSystemSettings">Whether to ignore the system culture settings or not. Defaults to <c>false</c>.</param>
+        public static CultureScope Create(CultureInfo culture, CultureInfo uiCulture, bool ignoreSystemSettings = false)
+            => new(culture.Name, uiCulture.Name, ignoreSystemSettings);
 
+        /// <inheritdoc/>
         public void Dispose()
         {
             SetCultures(_originalCulture, _originalUICulture);

src/OrchardCore/OrchardCore.Localization.Abstractions/OrchardCore.Localization.Abstractions.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <RootNamespace>OrchardCore.Localization</RootNamespace>

src/OrchardCore/OrchardCore.Localization.Abstractions/OrchardCoreRequestLocalizationOptions.cs

@@ -0,0 +1,68 @@
+using Microsoft.AspNetCore.Builder;
+using Microsoft.AspNetCore.Localization;
+using System.Collections.Generic;
+using System.Globalization;
+
+namespace OrchardCore.Localization;
+
+/// <summary>
+/// Represents an options for the <see cref="RequestLocalizationMiddleware"/> that extends <see cref="RequestLocalizationOptions"/>.
+/// </summary>
+public class OrchardCoreRequestLocalizationOptions : RequestLocalizationOptions
+{
+    private readonly bool _useUserOverride;
+
+    /// <summary>
+    /// Creates a new <see cref="OrchardCoreRequestLocalizationOptions"/> with adefault values.
+    /// </summary>
+    public OrchardCoreRequestLocalizationOptions() : this(ignoreSystemSettings: false)
+    {
+
+    }
+
+    /// <summary>
+    /// Creates a new <see cref="OrchardCoreRequestLocalizationOptions"/> with adefault values and ability to ignore system settings.
+    /// <param name="ignoreSystemSettings">Whether to ignore the system culture settings or not.</param>
+    /// </summary>
+    public OrchardCoreRequestLocalizationOptions(bool ignoreSystemSettings) : base()
+    {
+        _useUserOverride = !ignoreSystemSettings;
+    }
+
+    /// <inheritdoc/>
+    public new RequestLocalizationOptions AddSupportedCultures(params string[] cultures)
+    {
+        var supportedCultures = new List<CultureInfo>();
+
+        foreach (var culture in cultures)
+        {
+            supportedCultures.Add(new CultureInfo(culture, _useUserOverride));
+        }
+
+        SupportedCultures = supportedCultures;
+
+        return this;
+    }
+
+    /// <inheritdoc/>
+    public new RequestLocalizationOptions AddSupportedUICultures(params string[] uiCultures)
+    {
+        var supportedUICultures = new List<CultureInfo>();
+        foreach (var culture in uiCultures)
+        {
+            supportedUICultures.Add(new CultureInfo(culture, _useUserOverride));
+        }
+
+        SupportedUICultures = supportedUICultures;
+
+        return this;
+    }
+
+    /// <inheritdoc/>
+    public new RequestLocalizationOptions SetDefaultCulture(string defaultCulture)
+    {
+        DefaultRequestCulture = new RequestCulture(new CultureInfo(defaultCulture, _useUserOverride));
+
+        return this;
+    } 
+}

src/OrchardCore/OrchardCore/Modules/Extensions/ServiceCollectionExtensions.cs

@@ -121,11 +121,15 @@ private static void AddDefaultServices(OrchardCoreBuilder builder)
 
             services.AddScoped<IOrchardHelper, DefaultOrchardHelper>();
 
-            builder.ConfigureServices(s =>
+            builder.ConfigureServices((services, serviceProvider) =>
             {
-                s.AddSingleton<LocalLock>();
-                s.AddSingleton<ILocalLock>(sp => sp.GetRequiredService<LocalLock>());
-                s.AddSingleton<IDistributedLock>(sp => sp.GetRequiredService<LocalLock>());
+                services.AddSingleton<LocalLock>();
+                services.AddSingleton<ILocalLock>(sp => sp.GetRequiredService<LocalLock>());
+                services.AddSingleton<IDistributedLock>(sp => sp.GetRequiredService<LocalLock>());
+
+                var configuration = serviceProvider.GetService<IShellConfiguration>();
+
+                services.Configure<CultureOptions>(configuration.GetSection("OrchardCore_Localization_CultureOptions"));
             });
         }
 

test/OrchardCore.Tests/Localization/CultureScopeTests.cs

@@ -72,6 +72,7 @@ await Assert.ThrowsAsync<Exception>(() =>
                     throw new Exception("Something goes wrong!!");
                 }
             });
+
             Assert.Equal(culture, CultureInfo.CurrentCulture);
             Assert.Equal(uiCulture, CultureInfo.CurrentUICulture);
         }