2
0

LocalizationManager.cs 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449
  1. using System;
  2. using System.Collections.Concurrent;
  3. using System.Collections.Generic;
  4. using System.Globalization;
  5. using System.IO;
  6. using System.Linq;
  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", "nr" };
  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 readonly JsonSerializerOptions _jsonOptions = JsonDefaults.Options;
  36. private List<CultureDto> _cultures = new List<CultureDto>();
  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 stream = _assembly.GetManifestResourceStream(resource);
  65. using var reader = new StreamReader(stream!); // shouldn't be null here, we just got the resource path from Assembly.GetManifestResourceNames()
  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. ?? throw new InvalidOperationException($"Invalid resource path: '{CulturesPath}'");
  101. using var reader = new StreamReader(stream);
  102. await foreach (var line in reader.ReadAllLinesAsync().ConfigureAwait(false))
  103. {
  104. if (string.IsNullOrWhiteSpace(line))
  105. {
  106. continue;
  107. }
  108. var parts = line.Split('|');
  109. if (parts.Length == 5)
  110. {
  111. string name = parts[3];
  112. if (string.IsNullOrWhiteSpace(name))
  113. {
  114. continue;
  115. }
  116. string twoCharName = parts[2];
  117. if (string.IsNullOrWhiteSpace(twoCharName))
  118. {
  119. continue;
  120. }
  121. string[] threeletterNames;
  122. if (string.IsNullOrWhiteSpace(parts[1]))
  123. {
  124. threeletterNames = new[] { parts[0] };
  125. }
  126. else
  127. {
  128. threeletterNames = new[] { parts[0], parts[1] };
  129. }
  130. list.Add(new CultureDto(name, name, twoCharName, threeletterNames));
  131. }
  132. }
  133. _cultures = list;
  134. }
  135. /// <inheritdoc />
  136. public CultureDto? FindLanguageInfo(string language)
  137. {
  138. // TODO language should ideally be a ReadOnlySpan but moq cannot mock ref structs
  139. for (var i = 0; i < _cultures.Count; i++)
  140. {
  141. var culture = _cultures[i];
  142. if (language.Equals(culture.DisplayName, StringComparison.OrdinalIgnoreCase)
  143. || language.Equals(culture.Name, StringComparison.OrdinalIgnoreCase)
  144. || culture.ThreeLetterISOLanguageNames.Contains(language, StringComparison.OrdinalIgnoreCase)
  145. || language.Equals(culture.TwoLetterISOLanguageName, StringComparison.OrdinalIgnoreCase))
  146. {
  147. return culture;
  148. }
  149. }
  150. return default;
  151. }
  152. /// <inheritdoc />
  153. public IEnumerable<CountryInfo> GetCountries()
  154. {
  155. using StreamReader reader = new StreamReader(
  156. _assembly.GetManifestResourceStream(CountriesPath) ?? throw new InvalidOperationException($"Invalid resource path: '{CountriesPath}'"));
  157. return JsonSerializer.Deserialize<IEnumerable<CountryInfo>>(reader.ReadToEnd(), _jsonOptions)
  158. ?? throw new InvalidOperationException($"Resource contains invalid data: '{CountriesPath}'");
  159. }
  160. /// <inheritdoc />
  161. public IEnumerable<ParentalRating> GetParentalRatings()
  162. => GetParentalRatingsDictionary().Values;
  163. /// <summary>
  164. /// Gets the parental ratings dictionary.
  165. /// </summary>
  166. /// <returns><see cref="Dictionary{String, ParentalRating}" />.</returns>
  167. private Dictionary<string, ParentalRating> GetParentalRatingsDictionary()
  168. {
  169. var countryCode = _configurationManager.Configuration.MetadataCountryCode;
  170. // Fall back to US ratings if no country code is specified or country code does not exist.
  171. if (string.IsNullOrEmpty(countryCode))
  172. {
  173. countryCode = "us";
  174. }
  175. return GetRatings(countryCode)
  176. ?? GetRatings("us")
  177. ?? throw new InvalidOperationException($"Invalid resource path: '{CountriesPath}'");
  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. ArgumentException.ThrowIfNullOrEmpty(rating);
  193. // Handle unrated content
  194. if (_unratedValues.Contains(rating.AsSpan(), StringComparison.OrdinalIgnoreCase))
  195. {
  196. return null;
  197. }
  198. // Fairly common for some users to have "Rated R" in their rating field
  199. rating = rating.Replace("Rated :", string.Empty, StringComparison.OrdinalIgnoreCase);
  200. rating = rating.Replace("Rated ", string.Empty, StringComparison.OrdinalIgnoreCase);
  201. var ratingsDictionary = GetParentalRatingsDictionary();
  202. if (ratingsDictionary.TryGetValue(rating, out ParentalRating? value))
  203. {
  204. return value.Value;
  205. }
  206. // If we don't find anything check all ratings systems
  207. foreach (var dictionary in _allParentalRatings.Values)
  208. {
  209. if (dictionary.TryGetValue(rating, out value))
  210. {
  211. return value.Value;
  212. }
  213. }
  214. // Try splitting by : to handle "Germany: FSK 18"
  215. var index = rating.IndexOf(':', StringComparison.Ordinal);
  216. if (index != -1)
  217. {
  218. var trimmedRating = rating.AsSpan(index).TrimStart(':').Trim();
  219. if (!trimmedRating.IsEmpty)
  220. {
  221. return GetRatingLevel(trimmedRating.ToString());
  222. }
  223. }
  224. // Remove prefix country code to handle "DE-18"
  225. index = rating.IndexOf('-', StringComparison.Ordinal);
  226. if (index != -1)
  227. {
  228. var trimmedRating = rating.AsSpan(index).TrimStart('-').Trim();
  229. if (!trimmedRating.IsEmpty)
  230. {
  231. return GetRatingLevel(trimmedRating.ToString());
  232. }
  233. }
  234. // TODO: Further improve when necessary
  235. return null;
  236. }
  237. /// <inheritdoc />
  238. public string GetLocalizedString(string phrase)
  239. {
  240. return GetLocalizedString(phrase, _configurationManager.Configuration.UICulture);
  241. }
  242. /// <inheritdoc />
  243. public string GetLocalizedString(string phrase, string culture)
  244. {
  245. if (string.IsNullOrEmpty(culture))
  246. {
  247. culture = _configurationManager.Configuration.UICulture;
  248. }
  249. if (string.IsNullOrEmpty(culture))
  250. {
  251. culture = DefaultCulture;
  252. }
  253. var dictionary = GetLocalizationDictionary(culture);
  254. if (dictionary.TryGetValue(phrase, out var value))
  255. {
  256. return value;
  257. }
  258. return phrase;
  259. }
  260. private Dictionary<string, string> GetLocalizationDictionary(string culture)
  261. {
  262. ArgumentException.ThrowIfNullOrEmpty(culture);
  263. const string Prefix = "Core";
  264. return _dictionaries.GetOrAdd(
  265. culture,
  266. static (key, localizationManager) => localizationManager.GetDictionary(Prefix, key, DefaultCulture + ".json").GetAwaiter().GetResult(),
  267. this);
  268. }
  269. private async Task<Dictionary<string, string>> GetDictionary(string prefix, string culture, string baseFilename)
  270. {
  271. ArgumentException.ThrowIfNullOrEmpty(culture);
  272. var dictionary = new Dictionary<string, string>(StringComparer.OrdinalIgnoreCase);
  273. var namespaceName = GetType().Namespace + "." + prefix;
  274. await CopyInto(dictionary, namespaceName + "." + baseFilename).ConfigureAwait(false);
  275. await CopyInto(dictionary, namespaceName + "." + GetResourceFilename(culture)).ConfigureAwait(false);
  276. return dictionary;
  277. }
  278. private async Task CopyInto(IDictionary<string, string> dictionary, string resourcePath)
  279. {
  280. await using var stream = _assembly.GetManifestResourceStream(resourcePath);
  281. // If a Culture doesn't have a translation the stream will be null and it defaults to en-us further up the chain
  282. if (stream is null)
  283. {
  284. _logger.LogError("Missing translation/culture resource: {ResourcePath}", resourcePath);
  285. return;
  286. }
  287. var dict = await JsonSerializer.DeserializeAsync<Dictionary<string, string>>(stream, _jsonOptions).ConfigureAwait(false);
  288. if (dict is null)
  289. {
  290. throw new InvalidOperationException($"Resource contains invalid data: '{stream}'");
  291. }
  292. foreach (var key in dict.Keys)
  293. {
  294. dictionary[key] = dict[key];
  295. }
  296. }
  297. private static string GetResourceFilename(string culture)
  298. {
  299. var parts = culture.Split('-');
  300. if (parts.Length == 2)
  301. {
  302. culture = parts[0].ToLowerInvariant() + "-" + parts[1].ToUpperInvariant();
  303. }
  304. else
  305. {
  306. culture = culture.ToLowerInvariant();
  307. }
  308. return culture + ".json";
  309. }
  310. /// <inheritdoc />
  311. public IEnumerable<LocalizationOption> GetLocalizationOptions()
  312. {
  313. yield return new LocalizationOption("Afrikaans", "af");
  314. yield return new LocalizationOption("العربية", "ar");
  315. yield return new LocalizationOption("Беларуская", "be");
  316. yield return new LocalizationOption("Български", "bg-BG");
  317. yield return new LocalizationOption("বাংলা (বাংলাদেশ)", "bn");
  318. yield return new LocalizationOption("Català", "ca");
  319. yield return new LocalizationOption("Čeština", "cs");
  320. yield return new LocalizationOption("Cymraeg", "cy");
  321. yield return new LocalizationOption("Dansk", "da");
  322. yield return new LocalizationOption("Deutsch", "de");
  323. yield return new LocalizationOption("English (United Kingdom)", "en-GB");
  324. yield return new LocalizationOption("English", "en-US");
  325. yield return new LocalizationOption("Ελληνικά", "el");
  326. yield return new LocalizationOption("Esperanto", "eo");
  327. yield return new LocalizationOption("Español", "es");
  328. yield return new LocalizationOption("Español americano", "es_419");
  329. yield return new LocalizationOption("Español (Argentina)", "es-AR");
  330. yield return new LocalizationOption("Español (Dominicana)", "es_DO");
  331. yield return new LocalizationOption("Español (México)", "es-MX");
  332. yield return new LocalizationOption("Eesti", "et");
  333. yield return new LocalizationOption("Basque", "eu");
  334. yield return new LocalizationOption("فارسی", "fa");
  335. yield return new LocalizationOption("Suomi", "fi");
  336. yield return new LocalizationOption("Filipino", "fil");
  337. yield return new LocalizationOption("Français", "fr");
  338. yield return new LocalizationOption("Français (Canada)", "fr-CA");
  339. yield return new LocalizationOption("Galego", "gl");
  340. yield return new LocalizationOption("Schwiizerdütsch", "gsw");
  341. yield return new LocalizationOption("עִבְרִית", "he");
  342. yield return new LocalizationOption("हिन्दी", "hi");
  343. yield return new LocalizationOption("Hrvatski", "hr");
  344. yield return new LocalizationOption("Magyar", "hu");
  345. yield return new LocalizationOption("Bahasa Indonesia", "id");
  346. yield return new LocalizationOption("Íslenska", "is");
  347. yield return new LocalizationOption("Italiano", "it");
  348. yield return new LocalizationOption("日本語", "ja");
  349. yield return new LocalizationOption("Qazaqşa", "kk");
  350. yield return new LocalizationOption("한국어", "ko");
  351. yield return new LocalizationOption("Lietuvių", "lt");
  352. yield return new LocalizationOption("Latviešu", "lv");
  353. yield return new LocalizationOption("Македонски", "mk");
  354. yield return new LocalizationOption("മലയാളം", "ml");
  355. yield return new LocalizationOption("मराठी", "mr");
  356. yield return new LocalizationOption("Bahasa Melayu", "ms");
  357. yield return new LocalizationOption("Norsk bokmål", "nb");
  358. yield return new LocalizationOption("नेपाली", "ne");
  359. yield return new LocalizationOption("Nederlands", "nl");
  360. yield return new LocalizationOption("Norsk nynorsk", "nn");
  361. yield return new LocalizationOption("ਪੰਜਾਬੀ", "pa");
  362. yield return new LocalizationOption("Polski", "pl");
  363. yield return new LocalizationOption("Pirate", "pr");
  364. yield return new LocalizationOption("Português", "pt");
  365. yield return new LocalizationOption("Português (Brasil)", "pt-BR");
  366. yield return new LocalizationOption("Português (Portugal)", "pt-PT");
  367. yield return new LocalizationOption("Românește", "ro");
  368. yield return new LocalizationOption("Русский", "ru");
  369. yield return new LocalizationOption("Slovenčina", "sk");
  370. yield return new LocalizationOption("Slovenščina", "sl-SI");
  371. yield return new LocalizationOption("Shqip", "sq");
  372. yield return new LocalizationOption("Српски", "sr");
  373. yield return new LocalizationOption("Svenska", "sv");
  374. yield return new LocalizationOption("தமிழ்", "ta");
  375. yield return new LocalizationOption("తెలుగు", "te");
  376. yield return new LocalizationOption("ภาษาไทย", "th");
  377. yield return new LocalizationOption("Türkçe", "tr");
  378. yield return new LocalizationOption("Українська", "uk");
  379. yield return new LocalizationOption("اُردُو", "ur_PK");
  380. yield return new LocalizationOption("Tiếng Việt", "vi");
  381. yield return new LocalizationOption("汉语 (简体字)", "zh-CN");
  382. yield return new LocalizationOption("漢語 (繁體字)", "zh-TW");
  383. yield return new LocalizationOption("廣東話 (香港)", "zh-HK");
  384. }
  385. }
  386. }