DictionaryBasedLocalizationSource.cs 7.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Collections.Immutable;
  4. using System.Globalization;
  5. using Abp.Configuration.Startup;
  6. using Abp.Dependency;
  7. using Abp.Extensions;
  8. using Castle.Core.Logging;
  9. namespace Abp.Localization.Dictionaries
  10. {
  11. /// <summary>
  12. /// This class is used to build a localization source
  13. /// which works on memory based dictionaries to find strings.
  14. /// </summary>
  15. public class DictionaryBasedLocalizationSource : IDictionaryBasedLocalizationSource
  16. {
  17. /// <summary>
  18. /// Unique Name of the source.
  19. /// </summary>
  20. public string Name { get; }
  21. public ILocalizationDictionaryProvider DictionaryProvider { get; }
  22. protected ILocalizationConfiguration LocalizationConfiguration { get; private set; }
  23. private ILogger _logger;
  24. /// <summary>
  25. ///
  26. /// </summary>
  27. /// <param name="name"></param>
  28. /// <param name="dictionaryProvider"></param>
  29. public DictionaryBasedLocalizationSource(string name, ILocalizationDictionaryProvider dictionaryProvider)
  30. {
  31. Check.NotNullOrEmpty(name, nameof(name));
  32. Check.NotNull(dictionaryProvider, nameof(dictionaryProvider));
  33. Name = name;
  34. DictionaryProvider = dictionaryProvider;
  35. }
  36. /// <inheritdoc/>
  37. public virtual void Initialize(ILocalizationConfiguration configuration, IIocResolver iocResolver)
  38. {
  39. LocalizationConfiguration = configuration;
  40. _logger = iocResolver.IsRegistered(typeof(ILoggerFactory))
  41. ? iocResolver.Resolve<ILoggerFactory>().Create(typeof(DictionaryBasedLocalizationSource))
  42. : NullLogger.Instance;
  43. DictionaryProvider.Initialize(Name);
  44. }
  45. /// <inheritdoc/>
  46. public string GetString(string name)
  47. {
  48. return GetString(name, CultureInfo.CurrentUICulture);
  49. }
  50. /// <inheritdoc/>
  51. public string GetString(string name, CultureInfo culture)
  52. {
  53. var value = GetStringOrNull(name, culture);
  54. if (value == null)
  55. {
  56. return ReturnGivenNameOrThrowException(name, culture);
  57. }
  58. return value;
  59. }
  60. public string GetStringOrNull(string name, bool tryDefaults = true)
  61. {
  62. return GetStringOrNull(name, CultureInfo.CurrentUICulture, tryDefaults);
  63. }
  64. public string GetStringOrNull(string name, CultureInfo culture, bool tryDefaults = true)
  65. {
  66. var cultureName = culture.Name;
  67. var dictionaries = DictionaryProvider.Dictionaries;
  68. //Try to get from original dictionary (with country code)
  69. ILocalizationDictionary originalDictionary;
  70. if (dictionaries.TryGetValue(cultureName, out originalDictionary))
  71. {
  72. var strOriginal = originalDictionary.GetOrNull(name);
  73. if (strOriginal != null)
  74. {
  75. return strOriginal.Value;
  76. }
  77. }
  78. if (!tryDefaults)
  79. {
  80. return null;
  81. }
  82. //Try to get from same language dictionary (without country code)
  83. if (cultureName.Contains("-")) //Example: "tr-TR" (length=5)
  84. {
  85. ILocalizationDictionary langDictionary;
  86. if (dictionaries.TryGetValue(GetBaseCultureName(cultureName), out langDictionary))
  87. {
  88. var strLang = langDictionary.GetOrNull(name);
  89. if (strLang != null)
  90. {
  91. return strLang.Value;
  92. }
  93. }
  94. }
  95. //Try to get from default language
  96. var defaultDictionary = DictionaryProvider.DefaultDictionary;
  97. if (defaultDictionary == null)
  98. {
  99. return null;
  100. }
  101. var strDefault = defaultDictionary.GetOrNull(name);
  102. if (strDefault == null)
  103. {
  104. return null;
  105. }
  106. return strDefault.Value;
  107. }
  108. /// <inheritdoc/>
  109. public IReadOnlyList<LocalizedString> GetAllStrings(bool includeDefaults = true)
  110. {
  111. return GetAllStrings(CultureInfo.CurrentUICulture, includeDefaults);
  112. }
  113. /// <inheritdoc/>
  114. public IReadOnlyList<LocalizedString> GetAllStrings(CultureInfo culture, bool includeDefaults = true)
  115. {
  116. //TODO: Can be optimized (example: if it's already default dictionary, skip overriding)
  117. var dictionaries = DictionaryProvider.Dictionaries;
  118. //Create a temp dictionary to build
  119. var allStrings = new Dictionary<string, LocalizedString>();
  120. if (includeDefaults)
  121. {
  122. //Fill all strings from default dictionary
  123. var defaultDictionary = DictionaryProvider.DefaultDictionary;
  124. if (defaultDictionary != null)
  125. {
  126. foreach (var defaultDictString in defaultDictionary.GetAllStrings())
  127. {
  128. allStrings[defaultDictString.Name] = defaultDictString;
  129. }
  130. }
  131. //Overwrite all strings from the language based on country culture
  132. if (culture.Name.Contains("-"))
  133. {
  134. ILocalizationDictionary langDictionary;
  135. if (dictionaries.TryGetValue(GetBaseCultureName(culture.Name), out langDictionary))
  136. {
  137. foreach (var langString in langDictionary.GetAllStrings())
  138. {
  139. allStrings[langString.Name] = langString;
  140. }
  141. }
  142. }
  143. }
  144. //Overwrite all strings from the original dictionary
  145. ILocalizationDictionary originalDictionary;
  146. if (dictionaries.TryGetValue(culture.Name, out originalDictionary))
  147. {
  148. foreach (var originalLangString in originalDictionary.GetAllStrings())
  149. {
  150. allStrings[originalLangString.Name] = originalLangString;
  151. }
  152. }
  153. return allStrings.Values.ToImmutableList();
  154. }
  155. /// <summary>
  156. /// Extends the source with given dictionary.
  157. /// </summary>
  158. /// <param name="dictionary">Dictionary to extend the source</param>
  159. public virtual void Extend(ILocalizationDictionary dictionary)
  160. {
  161. DictionaryProvider.Extend(dictionary);
  162. }
  163. protected virtual string ReturnGivenNameOrThrowException(string name, CultureInfo culture)
  164. {
  165. return LocalizationSourceHelper.ReturnGivenNameOrThrowException(
  166. LocalizationConfiguration,
  167. Name,
  168. name,
  169. culture,
  170. _logger
  171. );
  172. }
  173. private static string GetBaseCultureName(string cultureName)
  174. {
  175. return cultureName.Contains("-")
  176. ? cultureName.Left(cultureName.IndexOf("-", StringComparison.Ordinal))
  177. : cultureName;
  178. }
  179. }
  180. }