using System; using System.Collections.Generic; using System.Globalization; using System.Linq; using System.Xml.Linq; using System.Xml.XPath; using Microsoft.Extensions.Logging; using Umbraco.Cms.Core.Services; using Umbraco.Extensions; namespace Umbraco.Cms.Infrastructure.Services.Implement { // TODO: Convert all of this over to Niels K's localization framework one day public class LocalizedTextService : ILocalizedTextService { private readonly ILogger _logger; private readonly Lazy _fileSources; private readonly IDictionary>> _dictionarySource; private readonly IDictionary> _xmlSource; /// /// Initializes with a file sources instance /// /// /// public LocalizedTextService(Lazy fileSources, ILogger logger) { if (logger == null) throw new ArgumentNullException("logger"); _logger = logger; if (fileSources == null) throw new ArgumentNullException("fileSources"); _fileSources = fileSources; } /// /// Initializes with an XML source /// /// /// public LocalizedTextService(IDictionary> source, ILogger logger) { if (source == null) throw new ArgumentNullException("source"); if (logger == null) throw new ArgumentNullException("logger"); _xmlSource = source; _logger = logger; } /// /// Initializes with a source of a dictionary of culture -> areas -> sub dictionary of keys/values /// /// /// public LocalizedTextService(IDictionary>> source, ILogger logger) { _dictionarySource = source ?? throw new ArgumentNullException(nameof(source)); _logger = logger ?? throw new ArgumentNullException(nameof(logger)); } public string Localize(string key, CultureInfo culture, IDictionary tokens = null) { if (culture == null) throw new ArgumentNullException(nameof(culture)); // TODO: Hack, see notes on ConvertToSupportedCultureWithRegionCode culture = ConvertToSupportedCultureWithRegionCode(culture); //This is what the legacy ui service did if (string.IsNullOrEmpty(key)) return string.Empty; var keyParts = key.Split(new[] {'/'}, StringSplitOptions.RemoveEmptyEntries); var area = keyParts.Length > 1 ? keyParts[0] : null; var alias = keyParts.Length > 1 ? keyParts[1] : keyParts[0]; var xmlSource = _xmlSource ?? (_fileSources != null ? _fileSources.Value.GetXmlSources() : null); if (xmlSource != null) { return GetFromXmlSource(xmlSource, culture, area, alias, tokens); } else { return GetFromDictionarySource(culture, area, alias, tokens); } } /// /// Returns all key/values in storage for the given culture /// public IDictionary GetAllStoredValues(CultureInfo culture) { if (culture == null) throw new ArgumentNullException("culture"); // TODO: Hack, see notes on ConvertToSupportedCultureWithRegionCode culture = ConvertToSupportedCultureWithRegionCode(culture); var result = new Dictionary(); var xmlSource = _xmlSource ?? (_fileSources != null ? _fileSources.Value.GetXmlSources() : null); if (xmlSource != null) { if (xmlSource.ContainsKey(culture) == false) { _logger.LogWarning("The culture specified {Culture} was not found in any configured sources for this service", culture); return result; } // convert all areas + keys to a single key with a '/' result = GetStoredTranslations(xmlSource, culture); // merge with the English file in case there's keys in there that don't exist in the local file var englishCulture = CultureInfo.GetCultureInfo("en-US"); if (culture.Equals(englishCulture) == false) { var englishResults = GetStoredTranslations(xmlSource, englishCulture); foreach (var englishResult in englishResults.Where(englishResult => result.ContainsKey(englishResult.Key) == false)) { result.Add(englishResult.Key, englishResult.Value); } } } else { if (_dictionarySource.ContainsKey(culture) == false) { _logger.LogWarning("The culture specified {Culture} was not found in any configured sources for this service", culture); return result; } // convert all areas + keys to a single key with a '/' foreach (var area in _dictionarySource[culture]) { foreach (var key in area.Value) { var dictionaryKey = string.Format("{0}/{1}", area.Key, key.Key); // i don't think it's possible to have duplicates because we're dealing with a dictionary in the first place, but we'll double check here just in case. if (result.ContainsKey(dictionaryKey) == false) { result.Add(dictionaryKey, key.Value); } } } } return result; } private Dictionary GetStoredTranslations(IDictionary> xmlSource, CultureInfo cult) { var result = new Dictionary(); var areas = xmlSource[cult].Value.XPathSelectElements("//area"); foreach (var area in areas) { var keys = area.XPathSelectElements("./key"); foreach (var key in keys) { var dictionaryKey = string.Format("{0}/{1}", (string)area.Attribute("alias"), (string)key.Attribute("alias")); //there could be duplicates if the language file isn't formatted nicely - which is probably the case for quite a few lang files if (result.ContainsKey(dictionaryKey) == false) result.Add(dictionaryKey, key.Value); } } return result; } /// /// Returns a list of all currently supported cultures /// /// public IEnumerable GetSupportedCultures() { var xmlSource = _xmlSource ?? (_fileSources != null ? _fileSources.Value.GetXmlSources() : null); return xmlSource != null ? xmlSource.Keys : _dictionarySource.Keys; } /// /// Tries to resolve a full 4 letter culture from a 2 letter culture name /// /// /// The culture to determine if it is only a 2 letter culture, if so we'll try to convert it, otherwise it will just be returned /// /// /// /// TODO: This is just a hack due to the way we store the language files, they should be stored with 4 letters since that /// is what they reference but they are stored with 2, further more our user's languages are stored with 2. So this attempts /// to resolve the full culture if possible. /// /// This only works when this service is constructed with the LocalizedTextServiceFileSources /// public CultureInfo ConvertToSupportedCultureWithRegionCode(CultureInfo currentCulture) { if (currentCulture == null) throw new ArgumentNullException("currentCulture"); if (_fileSources == null) return currentCulture; if (currentCulture.Name.Length > 2) return currentCulture; var attempt = _fileSources.Value.TryConvert2LetterCultureTo4Letter(currentCulture.TwoLetterISOLanguageName); return attempt ? attempt.Result : currentCulture; } private string GetFromDictionarySource(CultureInfo culture, string area, string key, IDictionary tokens) { if (_dictionarySource.ContainsKey(culture) == false) { _logger.LogWarning("The culture specified {Culture} was not found in any configured sources for this service", culture); return "[" + key + "]"; } var cultureSource = _dictionarySource[culture]; string found; if (area.IsNullOrWhiteSpace()) { found = cultureSource .SelectMany(x => x.Value) .Where(keyvals => keyvals.Key.InvariantEquals(key)) .Select(x => x.Value) .FirstOrDefault(); } else { found = cultureSource .Where(areas => areas.Key.InvariantEquals(area)) .SelectMany(a => a.Value) .Where(keyvals => keyvals.Key.InvariantEquals(key)) .Select(x => x.Value) .FirstOrDefault(); } if (found != null) { return ParseTokens(found, tokens); } //NOTE: Based on how legacy works, the default text does not contain the area, just the key return "[" + key + "]"; } private string GetFromXmlSource(IDictionary> xmlSource, CultureInfo culture, string area, string key, IDictionary tokens) { if (xmlSource.ContainsKey(culture) == false) { _logger.LogWarning("The culture specified {Culture} was not found in any configured sources for this service", culture); return "[" + key + "]"; } var found = FindTranslation(xmlSource, culture, area, key); if (found != null) { return ParseTokens(found.Value, tokens); } // Fall back to English by default if we can't find the key found = FindTranslation(xmlSource, new CultureInfo("en-US"), area, key); if (found != null) return ParseTokens(found.Value, tokens); // If it can't be found in either file, fall back to the default, showing just the key in square brackets // NOTE: Based on how legacy works, the default text does not contain the area, just the key return "[" + key + "]"; } private XElement FindTranslation(IDictionary> xmlSource, CultureInfo culture, string area, string key) { var cultureSource = xmlSource[culture].Value; var xpath = area.IsNullOrWhiteSpace() ? string.Format("//key [@alias = '{0}']", key) : string.Format("//area [@alias = '{0}']/key [@alias = '{1}']", area, key); var found = cultureSource.XPathSelectElement(xpath); return found; } /// /// Parses the tokens in the value /// /// /// /// /// /// This is based on how the legacy ui localized text worked, each token was just a sequential value delimited with a % symbol. /// For example: hello %0%, you are %1% ! /// /// Since we're going to continue using the same language files for now, the token system needs to remain the same. With our new service /// we support a dictionary which means in the future we can really have any sort of token system. /// Currently though, the token key's will need to be an integer and sequential - though we aren't going to throw exceptions if that is not the case. /// internal static string ParseTokens(string value, IDictionary tokens) { if (tokens == null || tokens.Any() == false) { return value; } foreach (var token in tokens) { value = value.Replace(string.Format("{0}{1}{0}", "%", token.Key), token.Value); } return value; } } }