LocalizationManager.cs 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423
  1. #nullable disable
  2. using System;
  3. using System.Collections.Concurrent;
  4. using System.Collections.Generic;
  5. using System.Globalization;
  6. using System.IO;
  7. using System.Reflection;
  8. using System.Text.Json;
  9. using System.Threading.Tasks;
  10. using Jellyfin.Extensions;
  11. using Jellyfin.Extensions.Json;
  12. using MediaBrowser.Controller.Configuration;
  13. using MediaBrowser.Model.Entities;
  14. using MediaBrowser.Model.Globalization;
  15. using Microsoft.Extensions.Logging;
  16. namespace Emby.Server.Implementations.Localization
  17. {
  18. /// <summary>
  19. /// Class LocalizationManager.
  20. /// </summary>
  21. public class LocalizationManager : ILocalizationManager
  22. {
  23. private const string DefaultCulture = "en-US";
  24. private const string RatingsPath = "Emby.Server.Implementations.Localization.Ratings.";
  25. private const string CulturesPath = "Emby.Server.Implementations.Localization.iso6392.txt";
  26. private const string CountriesPath = "Emby.Server.Implementations.Localization.countries.json";
  27. private static readonly Assembly _assembly = typeof(LocalizationManager).Assembly;
  28. private static readonly string[] _unratedValues = { "n/a", "unrated", "not rated" };
  29. private readonly IServerConfigurationManager _configurationManager;
  30. private readonly ILogger<LocalizationManager> _logger;
  31. private readonly Dictionary<string, Dictionary<string, ParentalRating>> _allParentalRatings =
  32. new Dictionary<string, Dictionary<string, ParentalRating>>(StringComparer.OrdinalIgnoreCase);
  33. private readonly ConcurrentDictionary<string, Dictionary<string, string>> _dictionaries =
  34. new ConcurrentDictionary<string, Dictionary<string, string>>(StringComparer.OrdinalIgnoreCase);
  35. private List<CultureDto> _cultures;
  36. private readonly JsonSerializerOptions _jsonOptions = JsonDefaults.Options;
  37. /// <summary>
  38. /// Initializes a new instance of the <see cref="LocalizationManager" /> class.
  39. /// </summary>
  40. /// <param name="configurationManager">The configuration manager.</param>
  41. /// <param name="logger">The logger.</param>
  42. public LocalizationManager(
  43. IServerConfigurationManager configurationManager,
  44. ILogger<LocalizationManager> logger)
  45. {
  46. _configurationManager = configurationManager;
  47. _logger = logger;
  48. }
  49. /// <summary>
  50. /// Loads all resources into memory.
  51. /// </summary>
  52. /// <returns><see cref="Task" />.</returns>
  53. public async Task LoadAll()
  54. {
  55. // Extract from the assembly
  56. foreach (var resource in _assembly.GetManifestResourceNames())
  57. {
  58. if (!resource.StartsWith(RatingsPath, StringComparison.Ordinal))
  59. {
  60. continue;
  61. }
  62. string countryCode = resource.Substring(RatingsPath.Length, 2);
  63. var dict = new Dictionary<string, ParentalRating>(StringComparer.OrdinalIgnoreCase);
  64. await using var str = _assembly.GetManifestResourceStream(resource);
  65. using var reader = new StreamReader(str);
  66. await foreach (var line in reader.ReadAllLinesAsync().ConfigureAwait(false))
  67. {
  68. if (string.IsNullOrWhiteSpace(line))
  69. {
  70. continue;
  71. }
  72. string[] parts = line.Split(',');
  73. if (parts.Length == 2
  74. && int.TryParse(parts[1], NumberStyles.Integer, CultureInfo.InvariantCulture, out var value))
  75. {
  76. var name = parts[0];
  77. dict.Add(name, new ParentalRating(name, value));
  78. }
  79. #if DEBUG
  80. else
  81. {
  82. _logger.LogWarning("Malformed line in ratings file for country {CountryCode}", countryCode);
  83. }
  84. #endif
  85. }
  86. _allParentalRatings[countryCode] = dict;
  87. }
  88. await LoadCultures().ConfigureAwait(false);
  89. }
  90. /// <summary>
  91. /// Gets the cultures.
  92. /// </summary>
  93. /// <returns><see cref="IEnumerable{CultureDto}" />.</returns>
  94. public IEnumerable<CultureDto> GetCultures()
  95. => _cultures;
  96. private async Task LoadCultures()
  97. {
  98. List<CultureDto> list = new List<CultureDto>();
  99. await using var stream = _assembly.GetManifestResourceStream(CulturesPath);
  100. using var reader = new StreamReader(stream);
  101. await foreach (var line in reader.ReadAllLinesAsync().ConfigureAwait(false))
  102. {
  103. if (string.IsNullOrWhiteSpace(line))
  104. {
  105. continue;
  106. }
  107. var parts = line.Split('|');
  108. if (parts.Length == 5)
  109. {
  110. string name = parts[3];
  111. if (string.IsNullOrWhiteSpace(name))
  112. {
  113. continue;
  114. }
  115. string twoCharName = parts[2];
  116. if (string.IsNullOrWhiteSpace(twoCharName))
  117. {
  118. continue;
  119. }
  120. string[] threeletterNames;
  121. if (string.IsNullOrWhiteSpace(parts[1]))
  122. {
  123. threeletterNames = new[] { parts[0] };
  124. }
  125. else
  126. {
  127. threeletterNames = new[] { parts[0], parts[1] };
  128. }
  129. list.Add(new CultureDto
  130. {
  131. DisplayName = name,
  132. Name = name,
  133. ThreeLetterISOLanguageNames = threeletterNames,
  134. TwoLetterISOLanguageName = twoCharName
  135. });
  136. }
  137. }
  138. _cultures = list;
  139. }
  140. /// <inheritdoc />
  141. public CultureDto FindLanguageInfo(string language)
  142. {
  143. // TODO language should ideally be a ReadOnlySpan but moq cannot mock ref structs
  144. for (var i = 0; i < _cultures.Count; i++)
  145. {
  146. var culture = _cultures[i];
  147. if (language.Equals(culture.DisplayName, StringComparison.OrdinalIgnoreCase)
  148. || language.Equals(culture.Name, StringComparison.OrdinalIgnoreCase)
  149. || culture.ThreeLetterISOLanguageNames.Contains(language, StringComparison.OrdinalIgnoreCase)
  150. || language.Equals(culture.TwoLetterISOLanguageName, StringComparison.OrdinalIgnoreCase))
  151. {
  152. return culture;
  153. }
  154. }
  155. return default;
  156. }
  157. /// <inheritdoc />
  158. public IEnumerable<CountryInfo> GetCountries()
  159. {
  160. using StreamReader reader = new StreamReader(_assembly.GetManifestResourceStream(CountriesPath));
  161. return JsonSerializer.Deserialize<IEnumerable<CountryInfo>>(reader.ReadToEnd(), _jsonOptions);
  162. }
  163. /// <inheritdoc />
  164. public IEnumerable<ParentalRating> GetParentalRatings()
  165. => GetParentalRatingsDictionary().Values;
  166. /// <summary>
  167. /// Gets the parental ratings dictionary.
  168. /// </summary>
  169. /// <returns><see cref="Dictionary{String, ParentalRating}" />.</returns>
  170. private Dictionary<string, ParentalRating> GetParentalRatingsDictionary()
  171. {
  172. var countryCode = _configurationManager.Configuration.MetadataCountryCode;
  173. if (string.IsNullOrEmpty(countryCode))
  174. {
  175. countryCode = "us";
  176. }
  177. return GetRatings(countryCode) ?? GetRatings("us");
  178. }
  179. /// <summary>
  180. /// Gets the ratings.
  181. /// </summary>
  182. /// <param name="countryCode">The country code.</param>
  183. /// <returns>The ratings.</returns>
  184. private Dictionary<string, ParentalRating> GetRatings(string countryCode)
  185. {
  186. _allParentalRatings.TryGetValue(countryCode, out var value);
  187. return value;
  188. }
  189. /// <inheritdoc />
  190. public int? GetRatingLevel(string rating)
  191. {
  192. if (string.IsNullOrEmpty(rating))
  193. {
  194. throw new ArgumentNullException(nameof(rating));
  195. }
  196. if (_unratedValues.Contains(rating.AsSpan(), StringComparison.OrdinalIgnoreCase))
  197. {
  198. return null;
  199. }
  200. // Fairly common for some users to have "Rated R" in their rating field
  201. rating = rating.Replace("Rated ", string.Empty, StringComparison.OrdinalIgnoreCase);
  202. var ratingsDictionary = GetParentalRatingsDictionary();
  203. if (ratingsDictionary.TryGetValue(rating, out ParentalRating value))
  204. {
  205. return value.Value;
  206. }
  207. // If we don't find anything check all ratings systems
  208. foreach (var dictionary in _allParentalRatings.Values)
  209. {
  210. if (dictionary.TryGetValue(rating, out value))
  211. {
  212. return value.Value;
  213. }
  214. }
  215. // Try splitting by : to handle "Germany: FSK 18"
  216. var index = rating.IndexOf(':', StringComparison.Ordinal);
  217. if (index != -1)
  218. {
  219. var trimmedRating = rating.AsSpan(index).TrimStart(':').Trim();
  220. if (!trimmedRating.IsEmpty)
  221. {
  222. return GetRatingLevel(trimmedRating.ToString());
  223. }
  224. }
  225. // TODO: Further improve by normalizing out all spaces and dashes
  226. return null;
  227. }
  228. /// <inheritdoc />
  229. public bool HasUnicodeCategory(string value, UnicodeCategory category)
  230. {
  231. foreach (var chr in value)
  232. {
  233. if (char.GetUnicodeCategory(chr) == category)
  234. {
  235. return true;
  236. }
  237. }
  238. return false;
  239. }
  240. /// <inheritdoc />
  241. public string GetLocalizedString(string phrase)
  242. {
  243. return GetLocalizedString(phrase, _configurationManager.Configuration.UICulture);
  244. }
  245. /// <inheritdoc />
  246. public string GetLocalizedString(string phrase, string culture)
  247. {
  248. if (string.IsNullOrEmpty(culture))
  249. {
  250. culture = _configurationManager.Configuration.UICulture;
  251. }
  252. if (string.IsNullOrEmpty(culture))
  253. {
  254. culture = DefaultCulture;
  255. }
  256. var dictionary = GetLocalizationDictionary(culture);
  257. if (dictionary.TryGetValue(phrase, out var value))
  258. {
  259. return value;
  260. }
  261. return phrase;
  262. }
  263. private Dictionary<string, string> GetLocalizationDictionary(string culture)
  264. {
  265. if (string.IsNullOrEmpty(culture))
  266. {
  267. throw new ArgumentNullException(nameof(culture));
  268. }
  269. const string Prefix = "Core";
  270. return _dictionaries.GetOrAdd(
  271. culture,
  272. (key, localizationManager) => localizationManager.GetDictionary(Prefix, key, DefaultCulture + ".json").GetAwaiter().GetResult(),
  273. this);
  274. }
  275. private async Task<Dictionary<string, string>> GetDictionary(string prefix, string culture, string baseFilename)
  276. {
  277. if (string.IsNullOrEmpty(culture))
  278. {
  279. throw new ArgumentNullException(nameof(culture));
  280. }
  281. var dictionary = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
  282. var namespaceName = GetType().Namespace + "." + prefix;
  283. await CopyInto(dictionary, namespaceName + "." + baseFilename).ConfigureAwait(false);
  284. await CopyInto(dictionary, namespaceName + "." + GetResourceFilename(culture)).ConfigureAwait(false);
  285. return dictionary;
  286. }
  287. private async Task CopyInto(IDictionary<string, string> dictionary, string resourcePath)
  288. {
  289. await using var stream = _assembly.GetManifestResourceStream(resourcePath);
  290. // If a Culture doesn't have a translation the stream will be null and it defaults to en-us further up the chain
  291. if (stream != null)
  292. {
  293. var dict = await JsonSerializer.DeserializeAsync<Dictionary<string, string>>(stream, _jsonOptions).ConfigureAwait(false);
  294. foreach (var key in dict.Keys)
  295. {
  296. dictionary[key] = dict[key];
  297. }
  298. }
  299. else
  300. {
  301. _logger.LogError("Missing translation/culture resource: {ResourcePath}", resourcePath);
  302. }
  303. }
  304. private static string GetResourceFilename(string culture)
  305. {
  306. var parts = culture.Split('-');
  307. if (parts.Length == 2)
  308. {
  309. culture = parts[0].ToLowerInvariant() + "-" + parts[1].ToUpperInvariant();
  310. }
  311. else
  312. {
  313. culture = culture.ToLowerInvariant();
  314. }
  315. return culture + ".json";
  316. }
  317. /// <inheritdoc />
  318. public IEnumerable<LocalizationOption> GetLocalizationOptions()
  319. {
  320. yield return new LocalizationOption("Arabic", "ar");
  321. yield return new LocalizationOption("Bulgarian (Bulgaria)", "bg-BG");
  322. yield return new LocalizationOption("Catalan", "ca");
  323. yield return new LocalizationOption("Chinese Simplified", "zh-CN");
  324. yield return new LocalizationOption("Chinese Traditional", "zh-TW");
  325. yield return new LocalizationOption("Croatian", "hr");
  326. yield return new LocalizationOption("Czech", "cs");
  327. yield return new LocalizationOption("Danish", "da");
  328. yield return new LocalizationOption("Dutch", "nl");
  329. yield return new LocalizationOption("English (United Kingdom)", "en-GB");
  330. yield return new LocalizationOption("English (United States)", "en-US");
  331. yield return new LocalizationOption("French", "fr");
  332. yield return new LocalizationOption("French (Canada)", "fr-CA");
  333. yield return new LocalizationOption("German", "de");
  334. yield return new LocalizationOption("Greek", "el");
  335. yield return new LocalizationOption("Hebrew", "he");
  336. yield return new LocalizationOption("Hungarian", "hu");
  337. yield return new LocalizationOption("Italian", "it");
  338. yield return new LocalizationOption("Kazakh", "kk");
  339. yield return new LocalizationOption("Korean", "ko");
  340. yield return new LocalizationOption("Lithuanian", "lt-LT");
  341. yield return new LocalizationOption("Malay", "ms");
  342. yield return new LocalizationOption("Norwegian Bokmål", "nb");
  343. yield return new LocalizationOption("Persian", "fa");
  344. yield return new LocalizationOption("Polish", "pl");
  345. yield return new LocalizationOption("Portuguese (Brazil)", "pt-BR");
  346. yield return new LocalizationOption("Portuguese (Portugal)", "pt-PT");
  347. yield return new LocalizationOption("Russian", "ru");
  348. yield return new LocalizationOption("Slovak", "sk");
  349. yield return new LocalizationOption("Slovenian (Slovenia)", "sl-SI");
  350. yield return new LocalizationOption("Spanish", "es");
  351. yield return new LocalizationOption("Spanish (Argentina)", "es-AR");
  352. yield return new LocalizationOption("Spanish (Mexico)", "es-MX");
  353. yield return new LocalizationOption("Swedish", "sv");
  354. yield return new LocalizationOption("Swiss German", "gsw");
  355. yield return new LocalizationOption("Turkish", "tr");
  356. yield return new LocalizationOption("Tiếng Việt", "vi");
  357. }
  358. }
  359. }