/** * Copyright (c) 2014 Vincent Petry * * This file is licensed under the Affero General Public License version 3 * or later. * * See the COPYING-README file. * */ /** * L10N namespace with localization functions. * * @namespace */ OC.L10N = { /** * String bundles with app name as key. * @type {Object.} */ _bundles: {}, /** * Plural functions, key is app name and value is function. * @type {Object.} */ _pluralFunctions: {}, /** * Load an app's translation bundle if not loaded already. * * @param {String} appName name of the app * @param {Function} callback callback to be called when * the translations are loaded * @return {Promise} promise */ load: function(appName, callback) { // already available ? if (this._bundles[appName] || OC.getLocale() === 'en') { var deferred = $.Deferred(); var promise = deferred.promise(); promise.then(callback); deferred.resolve(); return promise; } var self = this; var url = OC.filePath(appName, 'l10n', OC.getLocale() + '.json'); // load JSON translation bundle per AJAX return $.get(url) .then( function(result) { if (result.translations) { self.register(appName, result.translations, result.pluralForm); } }) .then(callback); }, /** * Register an app's translation bundle. * * @param {String} appName name of the app * @param {Object} bundle * @param {Function|String} [pluralForm] optional plural function or plural string */ register: function(appName, bundle, pluralForm) { var self = this; if (_.isUndefined(this._bundles[appName])) { this._bundles[appName] = bundle || {}; // generate plural function based on form this._pluralFunctions[appName] = this._getPlural; } else { // Theme overwriting the default language _.extend(self._bundles[appName], bundle); } }, /** * Translate a string * @param {string} app the id of the app for which to translate the string * @param {string} text the string to translate * @param [vars] map of placeholder key to value * @param {number} [count] number to replace %n with * @param {array} [options] options array * @param {bool} [options.escape=true] enable/disable auto escape of placeholders (by default enabled) * @return {string} */ translate: function(app, text, vars, count, options) { var defaultOptions = { escape: true }, allOptions = options || {}; _.defaults(allOptions, defaultOptions); // TODO: cache this function to avoid inline recreation // of the same function over and over again in case // translate() is used in a loop var _build = function (text, vars, count) { return text.replace(/%n/g, count).replace(/{([^{}]*)}/g, function (a, b) { var r = vars[b]; if(typeof r === 'string' || typeof r === 'number') { if(allOptions.escape) { return DOMPurify.sanitize(escapeHTML(r)); } else { return DOMPurify.sanitize(r); } } else { return DOMPurify.sanitize(a); } } ); }; var translation = text; var bundle = this._bundles[app] || {}; var value = bundle[text]; if( typeof(value) !== 'undefined' ){ translation = value; } if(typeof vars === 'object' || count !== undefined ) { return DOMPurify.sanitize(_build(translation, vars, count)); } else { return DOMPurify.sanitize(translation); } }, /** * Translate a plural string * @param {string} app the id of the app for which to translate the string * @param {string} textSingular the string to translate for exactly one object * @param {string} textPlural the string to translate for n objects * @param {number} count number to determine whether to use singular or plural * @param [vars] map of placeholder key to value * @param {array} [options] options array * @param {bool} [options.escape=true] enable/disable auto escape of placeholders (by default enabled) * @return {string} Translated string */ translatePlural: function(app, textSingular, textPlural, count, vars, options) { var identifier = '_' + textSingular + '_::_' + textPlural + '_'; var bundle = this._bundles[app] || {}; var value = bundle[identifier]; if( typeof(value) !== 'undefined' ){ var translation = value; if ($.isArray(translation)) { var plural = this._pluralFunctions[app](count); return this.translate(app, translation[plural], vars, count, options); } } if(count === 1) { return this.translate(app, textSingular, vars, count, options); } else{ return this.translate(app, textPlural, vars, count, options); } }, /** * The plural function taken from symfony * * @param {number} number * @returns {number} * @private */ _getPlural: function(number) { var locale = OC.getLocale(); if ('pt_BR' === locale) { // temporary set a locale for brazilian locale = 'xbr'; } if (typeof locale === 'undefined') { return (1 == number) ? 0 : 1; } if (locale.length > 3) { locale = locale.substring(0, locale.lastIndexOf('_')); } /* * The plural rules are derived from code of the Zend Framework (2010-09-25), * which is subject to the new BSD license (http://framework.zend.com/license/new-bsd). * Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com) */ switch (locale) { case 'az': case 'bo': case 'dz': case 'id': case 'ja': case 'jv': case 'ka': case 'km': case 'kn': case 'ko': case 'ms': case 'th': case 'tr': case 'vi': case 'zh': return 0; case 'af': case 'bn': case 'bg': case 'ca': case 'da': case 'de': case 'el': case 'en': case 'eo': case 'es': case 'et': case 'eu': case 'fa': case 'fi': case 'fo': case 'fur': case 'fy': case 'gl': case 'gu': case 'ha': case 'he': case 'hu': case 'is': case 'it': case 'ku': case 'lb': case 'ml': case 'mn': case 'mr': case 'nah': case 'nb': case 'ne': case 'nl': case 'nn': case 'no': case 'oc': case 'om': case 'or': case 'pa': case 'pap': case 'ps': case 'pt': case 'so': case 'sq': case 'sv': case 'sw': case 'ta': case 'te': case 'tk': case 'ur': case 'zu': return (1 == number) ? 0 : 1; case 'am': case 'bh': case 'fil': case 'fr': case 'gun': case 'hi': case 'hy': case 'ln': case 'mg': case 'nso': case 'xbr': case 'ti': case 'wa': return ((0 == number) || (1 == number)) ? 0 : 1; case 'be': case 'bs': case 'hr': case 'ru': case 'sh': case 'sr': case 'uk': return ((1 == number % 10) && (11 != number % 100)) ? 0 : (((number % 10 >= 2) && (number % 10 <= 4) && ((number % 100 < 10) || (number % 100 >= 20))) ? 1 : 2); case 'cs': case 'sk': return (1 == number) ? 0 : (((number >= 2) && (number <= 4)) ? 1 : 2); case 'ga': return (1 == number) ? 0 : ((2 == number) ? 1 : 2); case 'lt': return ((1 == number % 10) && (11 != number % 100)) ? 0 : (((number % 10 >= 2) && ((number % 100 < 10) || (number % 100 >= 20))) ? 1 : 2); case 'sl': return (1 == number % 100) ? 0 : ((2 == number % 100) ? 1 : (((3 == number % 100) || (4 == number % 100)) ? 2 : 3)); case 'mk': return (1 == number % 10) ? 0 : 1; case 'mt': return (1 == number) ? 0 : (((0 == number) || ((number % 100 > 1) && (number % 100 < 11))) ? 1 : (((number % 100 > 10) && (number % 100 < 20)) ? 2 : 3)); case 'lv': return (0 == number) ? 0 : (((1 == number % 10) && (11 != number % 100)) ? 1 : 2); case 'pl': return (1 == number) ? 0 : (((number % 10 >= 2) && (number % 10 <= 4) && ((number % 100 < 12) || (number % 100 > 14))) ? 1 : 2); case 'cy': return (1 == number) ? 0 : ((2 == number) ? 1 : (((8 == number) || (11 == number)) ? 2 : 3)); case 'ro': return (1 == number) ? 0 : (((0 == number) || ((number % 100 > 0) && (number % 100 < 20))) ? 1 : 2); case 'ar': return (0 == number) ? 0 : ((1 == number) ? 1 : ((2 == number) ? 2 : (((number % 100 >= 3) && (number % 100 <= 10)) ? 3 : (((number % 100 >= 11) && (number % 100 <= 99)) ? 4 : 5)))); default: return 0; } } }; /** * translate a string * @param {string} app the id of the app for which to translate the string * @param {string} text the string to translate * @param [vars] map of placeholder key to value * @param {number} [count] number to replace %n with * @return {string} */ window.t = _.bind(OC.L10N.translate, OC.L10N); /** * translate a string * @param {string} app the id of the app for which to translate the string * @param {string} text_singular the string to translate for exactly one object * @param {string} text_plural the string to translate for n objects * @param {number} count number to determine whether to use singular or plural * @param [vars] map of placeholder key to value * @return {string} Translated string */ window.n = _.bind(OC.L10N.translatePlural, OC.L10N); Handlebars.registerHelper('t', function(app, text) { return OC.L10N.translate(app, text); });