Fixes #12904 UmbracoHelper.GetDictionaryValue defaults to en-US when …

…used in non-front end code (#12942)

* adding new overload/rename a method

* remove this keyword

* fix comment

* remove space

* commit

* revert

* replace param name

* public backward compatibility

* Minor style tweaks

* Don't change default culture in UmbracoCultureDictionary

---------

Co-authored-by: Nikolaj <nikolajlauridsen@protonmail.ch>

src/Umbraco.Core/Dictionary/ICultureDictionaryFactory.cs

@@ -1,6 +1,10 @@
+using System.Globalization;
+
 namespace Umbraco.Cms.Core.Dictionary;
 
 public interface ICultureDictionaryFactory
 {
     ICultureDictionary CreateDictionary();
+
+    ICultureDictionary CreateDictionary(CultureInfo specificCulture)  => throw new NotImplementedException();
 }

src/Umbraco.Core/Dictionary/UmbracoCultureDictionary.cs

@@ -1,4 +1,5 @@
 using System.Globalization;
+using System.Text.RegularExpressions;
 using Umbraco.Cms.Core.Cache;
 using Umbraco.Cms.Core.Models;
 using Umbraco.Cms.Core.Services;
@@ -47,7 +48,7 @@ public DefaultCultureDictionary(CultureInfo specificCulture, ILocalizationServic
     }
 
     /// <summary>
-    ///     Returns the current culture
+    ///     Returns the defualt umbraco's back office culture
     /// </summary>
     public CultureInfo Culture => _specificCulture ?? Thread.CurrentThread.CurrentUICulture;
 

src/Umbraco.Core/Dictionary/UmbracoCultureDictionaryFactory.cs

@@ -1,3 +1,4 @@
+using System.Globalization;
 using Umbraco.Cms.Core.Cache;
 using Umbraco.Cms.Core.Services;
 
@@ -23,4 +24,7 @@ public DefaultCultureDictionaryFactory(ILocalizationService localizationService,
 
     public ICultureDictionary CreateDictionary() =>
         new DefaultCultureDictionary(_localizationService, _appCaches.RequestCache);
+
+    public ICultureDictionary CreateDictionary(CultureInfo specificCulture) =>
+        new DefaultCultureDictionary(specificCulture, _localizationService, _appCaches.RequestCache);
 }

src/Umbraco.Web.Common/UmbracoHelper.cs

@@ -1,4 +1,6 @@
+using System.Globalization;
 using System.Xml.XPath;
+using Serilog.Events;
 using Umbraco.Cms.Core;
 using Umbraco.Cms.Core.Dictionary;
 using Umbraco.Cms.Core.Models.PublishedContent;
@@ -139,12 +141,43 @@ public async Task<IHtmlEncodedString> RenderMacroAsync(string alias, IDictionary
     /// <returns></returns>
     public string? GetDictionaryValue(string key) => CultureDictionary[key];
 
+
+    /// <summary>
+    ///     Returns the dictionary value for the key specified, and if empty returns the specified default fall back value
+    /// </summary>
+    /// <param name="key">key of dictionary item</param>
+    /// <param name="specificCulture">the specific culture on which the result well be back upon</param>
+    /// <returns></returns>
+    public string? GetDictionaryValue(string key, CultureInfo specificCulture)
+    {
+        _cultureDictionary = _cultureDictionaryFactory.CreateDictionary(specificCulture);
+        return GetDictionaryValue(key);
+    }
+
+    /// <summary>
+    ///     Returns the dictionary value for the key specified, and if empty returns the specified default fall back value
+    /// </summary>
+    /// <param name="key">key of dictionary item</param>
+    /// <param name="defaultValue">fall back text if dictionary item is empty - Name altText to match Umbraco.Field</param>
+    /// <returns></returns>
+    public string GetDictionaryValueOrDefault(string key, string defaultValue)
+    {
+        var dictionaryValue = GetDictionaryValue(key);
+        if (string.IsNullOrWhiteSpace(dictionaryValue))
+        {
+            dictionaryValue = defaultValue;
+        }
+
+        return dictionaryValue;
+    }
+
     /// <summary>
     ///     Returns the dictionary value for the key specified, and if empty returns the specified default fall back value
     /// </summary>
     /// <param name="key">key of dictionary item</param>
     /// <param name="altText">fall back text if dictionary item is empty - Name altText to match Umbraco.Field</param>
     /// <returns></returns>
+    [Obsolete("Use GetDictionaryValueOrDefault instead, scheduled for removal in v14.")]
     public string GetDictionaryValue(string key, string altText)
     {
         var dictionaryValue = GetDictionaryValue(key);
@@ -156,6 +189,25 @@ public string GetDictionaryValue(string key, string altText)
         return dictionaryValue;
     }
 
+        /// <summary>
+        ///     Returns the dictionary value for the key specified, and if empty returns the specified default fall back value
+        /// </summary>
+        /// <param name="key">key of dictionary item</param>
+        /// <param name="specificCulture">the specific culture on which the result well be back upon</param>
+        /// <param name="defaultValue">fall back text if dictionary item is empty - Name altText to match Umbraco.Field</param>
+        /// <returns></returns>
+        public string GetDictionaryValueOrDefault(string key, CultureInfo specificCulture, string defaultValue)
+    {
+        _cultureDictionary = _cultureDictionaryFactory.CreateDictionary(specificCulture);
+        var dictionaryValue = GetDictionaryValue(key);
+        if (string.IsNullOrWhiteSpace(dictionaryValue))
+        {
+            dictionaryValue = defaultValue;
+        }
+        return dictionaryValue;
+    }
+
+
     /// <summary>
     ///     Returns the ICultureDictionary for access to dictionary items
     /// </summary>