fuwafuwa
/
etherpad-lite
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Revert "[feat] Update l10n lib (#3248)" (#3249) 

This reverts commit 6bcaa00a4b.
This commit is contained in:
Luiza Pagliari 2017-08-15 11:09:56 -03:00 committed by GitHub
parent 6bcaa00a4b
commit ed5213c9a2
1 changed files with 86 additions and 133 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

219
src/static/js/html10n.js
View File

@ -21,30 +21,18 @@
* IN THE SOFTWARE. * IN THE SOFTWARE.
*/ */
window.html10n = (function(window, document, undefined) { window.html10n = (function(window, document, undefined) {
// fix console // fix console
var console = window.console (function() {
function interceptConsole(method){ var noop = function() {};
if (!console) return function() {} var names = ["log", "debug", "info", "warn", "error", "assert", "dir", "dirxml", "group", "groupEnd", "time", "timeEnd", "count", "trace", "profile", "profileEnd"];
var console = (window.console = window.console || {});
var original = console[method] for (var i = 0; i < names.length; ++i) {
if (!console[names[i]]) {
// do sneaky stuff console[names[i]] = noop;
if (original.bind){
// Do this for normal browsers
return original.bind(console)
}else{
return function() {
// Do this for IE
var message = Array.prototype.slice.apply(arguments).join(' ')
original(message)
}
} }
} }
var consoleLog = interceptConsole('log') }());
, consoleWarn = interceptConsole('warn')
, consoleError = interceptConsole('warn')
// fix Array#forEach in IE // fix Array#forEach in IE
// taken from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach // taken from https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/forEach
@ -92,7 +80,7 @@ window.html10n = (function(window, document, undefined) {
return -1; return -1;
} }
} }
/** /**
* MicroEvent - to make any js object an event emitter (server or browser) * MicroEvent - to make any js object an event emitter (server or browser)
*/ */
@ -128,7 +116,7 @@ window.html10n = (function(window, document, undefined) {
destObject[props[i]] = MicroEvent.prototype[props[i]]; destObject[props[i]] = MicroEvent.prototype[props[i]];
} }
} }
/** /**
* Loader * Loader
* The loader is responsible for loading * The loader is responsible for loading
@ -139,7 +127,7 @@ window.html10n = (function(window, document, undefined) {
this.cache = {} // file => contents this.cache = {} // file => contents
this.langs = {} // lang => strings this.langs = {} // lang => strings
} }
Loader.prototype.load = function(lang, cb) { Loader.prototype.load = function(lang, cb) {
if(this.langs[lang]) return cb() if(this.langs[lang]) return cb()
@ -148,23 +136,23 @@ window.html10n = (function(window, document, undefined) {
for (var i=0, n=this.resources.length; i < n; i++) { for (var i=0, n=this.resources.length; i < n; i++) {
this.fetch(this.resources[i], lang, function(e) { this.fetch(this.resources[i], lang, function(e) {
reqs++; reqs++;
if(e) consoleWarn(e) if(e) console.warn(e)
if (reqs < n) return;// Call back once all reqs are completed if (reqs < n) return;// Call back once all reqs are completed
cb && cb() cb && cb()
}) })
} }
} }
} }
Loader.prototype.fetch = function(href, lang, cb) { Loader.prototype.fetch = function(href, lang, cb) {
var that = this var that = this
if (this.cache[href]) { if (this.cache[href]) {
this.parse(lang, href, this.cache[href], cb) this.parse(lang, href, this.cache[href], cb)
return; return;
} }
var xhr = new XMLHttpRequest() var xhr = new XMLHttpRequest()
xhr.open('GET', href, /*async: */true) xhr.open('GET', href, /*async: */true)
if (xhr.overrideMimeType) { if (xhr.overrideMimeType) {
@ -184,7 +172,7 @@ window.html10n = (function(window, document, undefined) {
}; };
xhr.send(null); xhr.send(null);
} }
Loader.prototype.parse = function(lang, currHref, data, cb) { Loader.prototype.parse = function(lang, currHref, data, cb) {
if ('object' != typeof data) { if ('object' != typeof data) {
cb(new Error('A file couldn\'t be parsed as json.')) cb(new Error('A file couldn\'t be parsed as json.'))
@ -192,7 +180,7 @@ window.html10n = (function(window, document, undefined) {
} }
// dat alng ain't here, man! // dat alng ain't here, man!
if (!data) { if (!data[lang]) {
var msg = 'Couldn\'t find translations for '+lang var msg = 'Couldn\'t find translations for '+lang
, l , l
if(~lang.indexOf('-')) lang = lang.split('-')[0] // then let's try related langs if(~lang.indexOf('-')) lang = lang.split('-')[0] // then let's try related langs
@ -204,7 +192,7 @@ window.html10n = (function(window, document, undefined) {
} }
if(lang != l) return cb(new Error(msg)) if(lang != l) return cb(new Error(msg))
} }
if ('string' == typeof data[lang]) { if ('string' == typeof data[lang]) {
// Import rule // Import rule
@ -212,7 +200,7 @@ window.html10n = (function(window, document, undefined) {
var importUrl = data[lang] var importUrl = data[lang]
// relative path // relative path
if(data[lang].indexOf("http") != 0 && data[lang].indexOf("/") != 0) { if(data[lang].indexOf("http") != 0 && data[lang].indexOf("/") != 0) {
importUrl = currHref+"/../"+data[lang] importUrl = currHref+"/../"+data[lang]
} }
@ -220,40 +208,29 @@ window.html10n = (function(window, document, undefined) {
return return
} }
if ('object' != typeof data) { if ('object' != typeof data[lang]) {
cb(new Error('Translations should be specified as JSON objects!')) cb(new Error('Translations should be specified as JSON objects!'))
return return
} }
this.langs[lang] = data this.langs[lang] = data[lang]
// TODO: Also store accompanying langs // TODO: Also store accompanying langs
cb() cb()
} }
/** /**
* The html10n object * The html10n object
*/ */
var html10n = var html10n =
{ language : null { language : null
} }
MicroEvent.mixin(html10n) MicroEvent.mixin(html10n)
html10n.macros = {} html10n.macros = {}
html10n.rtl = ["ar","dv","fa","ha","he","ks","ku","ps","ur","yi"] html10n.rtl = ["ar","dv","fa","ha","he","ks","ku","ps","ur","yi"]
/**
* Language-Script fallbacks for Language-Region language tags, for languages that
* varies heavily on writing form and two-part locale expansion is not feasible.
* See also: https://tools.ietf.org/html/rfc4646 (RFC 4646)
*/
html10n.scripts = {
'zh-tw': 'zh-hant',
'zh-hk': 'zh-hant',
'zh-cn': 'zh-hans'
}
/** /**
* Get rules for plural forms (shared with JetPack), see: * Get rules for plural forms (shared with JetPack), see:
* http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html * http://unicode.org/repos/cldr-tmp/trunk/diff/supplemental/language_plural_rules.html
@ -658,7 +635,7 @@ window.html10n = (function(window, document, undefined) {
// return a function that gives the plural form name for a given integer // return a function that gives the plural form name for a given integer
var index = locales2rules[lang.replace(/-.*$/, '')]; var index = locales2rules[lang.replace(/-.*$/, '')];
if (!(index in pluralRules)) { if (!(index in pluralRules)) {
consoleWarn('plural form unknown for [' + lang + ']'); console.warn('plural form unknown for [' + lang + ']');
return function() { return 'other'; }; return function() { return 'other'; };
} }
return pluralRules[index]; return pluralRules[index];
@ -691,44 +668,25 @@ window.html10n = (function(window, document, undefined) {
return str; return str;
}; };
/** Prepare localization context: /**
* * Localize a document
* - Populate translations with strings for the indicated languages * @param langs An array of lang codes defining fallbacks
* - adding in non-qualified versions of language codes immediately
* after any qualified (e.g., "en" for "en-GB")
* - Trigger "localized" event.
*
* @param {array} langs: diminishing-precedence lang codes, or one string.
*/ */
html10n.localize = function(langs) { html10n.localize = function(langs) {
var that = this, var that = this
candidates = []; // if only one string => create an array
// if a single string, bundle it as an array: if ('string' == typeof langs) langs = [langs]
if ('string' == typeof langs) {
langs = [langs];
}
// Determine candidates from langs: // Expand two-part locale specs
// - Omitting empty strings var i=0
// - Adding in non-qualified versions of country-qualified codes.
langs.forEach(function(lang) { langs.forEach(function(lang) {
var splat; if(!lang) return;
if(!lang) { return; } langs[i++] = lang;
(candidates.indexOf(lang) == -1) && candidates.push(lang); if(~lang.indexOf('-')) langs[i++] = lang.substr(0, lang.indexOf('-'));
splat = lang.split('-'); })
if (splat[1]) {
(candidates.indexOf(splat[0]) == -1) && candidates.push(splat[0]);
}
});
// Append script fallbacks for region-specific locales if applicable this.build(langs, function(er, translations) {
for (var lang in html10n.scripts) {
i = candidates.indexOf(lang);
if (~i) candidates.splice(i, 0, html10n.scripts[lang])
}
this.build(candidates, function(er, translations) {
html10n.translations = translations html10n.translations = translations
html10n.translateElement(translations) html10n.translateElement(translations)
that.trigger('localized') that.trigger('localized')
@ -752,18 +710,18 @@ window.html10n = (function(window, document, undefined) {
// translate element itself if necessary // translate element itself if necessary
this.translateNode(translations, element) this.translateNode(translations, element)
} }
function asyncForEach(list, iterator, cb) { function asyncForEach(list, iterator, cb) {
var i = 0 var i = 0
, n = list.length , n = list.length
iterator(list[i], i, function each(err) { iterator(list[i], i, function each(err) {
if(err) consoleLog(err) if(err) console.error(err)
i++ i++
if (i < n) return iterator(list[i],i, each); if (i < n) return iterator(list[i],i, each);
cb() cb()
}) })
} }
function getTranslatableChildren(element) { function getTranslatableChildren(element) {
if(!document.querySelectorAll) { if(!document.querySelectorAll) {
if (!element) return [] if (!element) return []
@ -777,62 +735,55 @@ window.html10n = (function(window, document, undefined) {
} }
return element.querySelectorAll('*[data-l10n-id]') return element.querySelectorAll('*[data-l10n-id]')
} }
html10n.get = function(id, args) { html10n.get = function(id, args) {
var translations = html10n.translations var translations = html10n.translations
if(!translations) { if(!translations) return console.warn('No translations available (yet)')
if (! html10n.quiet) { if(!translations[id]) return console.warn('Could not find string '+id)
consoleWarn('No translations available (yet)');
}
return;
}
if(!translations[id]) return consoleWarn('Could not find string '+id)
// apply macros // apply macros
var str = translations[id] var str = translations[id]
str = substMacros(id, str, args) str = substMacros(id, str, args)
// apply args // apply args
str = substArguments(str, args) str = substArguments(str, args)
return str return str
} }
// replace {{arguments}} with their values or the // replace {{arguments}} with their values or the
// associated translation string (based on its key) // associated translation string (based on its key)
function substArguments(str, args) { function substArguments(str, args) {
var reArgs = /\{\{\s*([a-zA-Z_\-\.]+)\s*\}\}/, var reArgs = /\{\{\s*([a-zA-Z\.]+)\s*\}\}/
translations = html10n.translations, , match
match;
while (match = reArgs.exec(str)) { while (match = reArgs.exec(str)) {
if (!match || match.length < 2) if (!match || match.length < 2)
return str // argument key not found return str // argument key not found
var arg = match[1] var arg = match[1]
, sub = '' , sub = ''
if (args && (arg in args)) { if (arg in args) {
sub = args[arg] sub = args[arg]
} else if (arg in translations) { } else if (arg in translations) {
sub = translations[arg] sub = translations[arg]
} else { } else {
consoleWarn('Could not satisfy argument {{' + arg + '}}' + console.warn('Could not find argument {{' + arg + '}}')
' for string "' + str + '"');
return str return str
} }
str = str.substring(0, match.index) + sub + str.substr(match.index + match[0].length) str = str.substring(0, match.index) + sub + str.substr(match.index + match[0].length)
} }
return str return str
} }
// replace {[macros]} with their values // replace {[macros]} with their values
function substMacros(key, str, args) { function substMacros(key, str, args) {
var regex = /\{\[\s*([a-zA-Z]+)\(([a-zA-Z]+)\)((\s*([a-zA-Z]+)\: ?([^,]+?),?)+)*\s*\]\}/ //.exec('{{n}} {[plural(n) one: Bomba, other: Bombe]} ]}') var regex = /\{\[\s*([a-zA-Z]+)\(([a-zA-Z]+)\)((\s*([a-zA-Z]+)\: ?([ a-zA-Z{}]+),?)+)*\s*\]\}/ //.exec('{[ plural(n) other: are {{n}}, one: is ]}')
, match , match
while(match = regex.exec(str)) { while(match = regex.exec(str)) {
// a macro has been found // a macro has been found
// Note: at the moment, only one parameter is supported // Note: at the moment, only one parameter is supported
@ -840,18 +791,18 @@ window.html10n = (function(window, document, undefined) {
, paramName = match[2] , paramName = match[2]
, optv = match[3] , optv = match[3]
, opts = {} , opts = {}
if (!(macroName in html10n.macros)) continue if (!(macroName in html10n.macros)) continue
if(optv) { if(optv) {
optv.match(/(?=\s*)([a-zA-Z]+)\: ?([^,\]]+)(?=,?)/g).forEach(function(arg) { optv.match(/(?=\s*)([a-zA-Z]+)\: ?([ a-zA-Z{}]+)(?=,?)/g).forEach(function(arg) {
var parts = arg.split(':') var parts = arg.split(':')
, name = parts[0] , name = parts[0]
, value = parts[1].trim() , value = parts[1].trim()
opts[name] = value opts[name] = value
}) })
} }
var param var param
if (args && paramName in args) { if (args && paramName in args) {
param = args[paramName] param = args[paramName]
@ -863,10 +814,10 @@ window.html10n = (function(window, document, undefined) {
var macro = html10n.macros[macroName] var macro = html10n.macros[macroName]
str = str.substr(0, match.index) + macro(key, param, opts) + str.substr(match.index+match[0].length) str = str.substr(0, match.index) + macro(key, param, opts) + str.substr(match.index+match[0].length)
} }
return str return str
} }
/** /**
* Applies translations to a DOM node (recursive) * Applies translations to a DOM node (recursive)
*/ */
@ -877,21 +828,21 @@ window.html10n = (function(window, document, undefined) {
str.id = node.getAttribute('data-l10n-id') str.id = node.getAttribute('data-l10n-id')
if (!str.id) return if (!str.id) return
if(!translations[str.id]) return consoleWarn('Couldn\'t find translation key '+str.id) if(!translations[str.id]) return console.warn('Couldn\'t find translation key '+str.id)
// get args // get args
if(window.JSON) { if(window.JSON) {
str.args = node.getAttribute('data-l10n-args') ? JSON.parse(node.getAttribute('data-l10n-args')) : []; str.args = JSON.parse(node.getAttribute('data-l10n-args'))
}else{ }else{
try{ try{
str.args = eval(node.getAttribute('data-l10n-args')) str.args = eval(node.getAttribute('data-l10n-args'))
}catch(e) { }catch(e) {
consoleWarn('Couldn\'t parse args for '+str.id) console.warn('Couldn\'t parse args for '+str.id)
} }
} }
str.str = html10n.get(str.id, str.args) str.str = html10n.get(str.id, str.args)
// get attribute name to apply str to // get attribute name to apply str to
var prop var prop
, index = str.id.lastIndexOf('.') , index = str.id.lastIndexOf('.')
@ -900,7 +851,6 @@ window.html10n = (function(window, document, undefined) {
, "innerHTML": 1 , "innerHTML": 1
, "alt": 1 , "alt": 1
, "textContent": 1 , "textContent": 1
, "placeholder": 1
, "value": 1 , "value": 1
} }
if (index > 0 && str.id.substr(index + 1) in attrList) { // an attribute has been specified if (index > 0 && str.id.substr(index + 1) in attrList) { // an attribute has been specified
@ -912,6 +862,9 @@ window.html10n = (function(window, document, undefined) {
// Apply translation // Apply translation
if (node.children.length === 0 || prop != 'textContent') { if (node.children.length === 0 || prop != 'textContent') {
node[prop] = str.str node[prop] = str.str
node.setAttribute("aria-label", str.str); // Sets the aria-label
// The idea of the above is that we always have an aria value
// This might be a bit of an abrupt solution but let's see how it goes
} else { } else {
var children = node.childNodes, var children = node.childNodes,
found = false found = false
@ -926,11 +879,11 @@ window.html10n = (function(window, document, undefined) {
} }
} }
if (!found) { if (!found) {
consoleWarn('Unexpected error: could not translate element content for key '+str.id, node) console.warn('Unexpected error: could not translate element content for key '+str.id, node)
} }
} }
} }
/** /**
* Builds a translation object from a list of langs (loads the necessary translations) * Builds a translation object from a list of langs (loads the necessary translations)
* @param langs Array - a list of langs sorted by priority (default langs should go last) * @param langs Array - a list of langs sorted by priority (default langs should go last)
@ -945,11 +898,11 @@ window.html10n = (function(window, document, undefined) {
}, function() { }, function() {
var lang var lang
langs.reverse() langs.reverse()
// loop through the priority array... // loop through the priority array...
for (var i=0, n=langs.length; i < n; i++) { for (var i=0, n=langs.length; i < n; i++) {
lang = langs[i] lang = langs[i]
if(!lang) continue; if(!lang) continue;
if(!(lang in that.loader.langs)) {// uh, we don't have this lang availbable.. if(!(lang in that.loader.langs)) {// uh, we don't have this lang availbable..
// then check for related langs // then check for related langs
@ -962,13 +915,13 @@ window.html10n = (function(window, document, undefined) {
} }
if(lang != l) continue; if(lang != l) continue;
} }
// ... and apply all strings of the current lang in the list // ... and apply all strings of the current lang in the list
// to our build object // to our build object
for (var string in that.loader.langs[lang]) { for (var string in that.loader.langs[lang]) {
build[string] = that.loader.langs[lang][string] build[string] = that.loader.langs[lang][string]
} }
// the last applied lang will be exposed as the // the last applied lang will be exposed as the
// lang the page was translated to // lang the page was translated to
that.language = lang that.language = lang
@ -976,7 +929,7 @@ window.html10n = (function(window, document, undefined) {
cb(null, build) cb(null, build)
}) })
} }
/** /**
* Returns the language that was last applied to the translations hash * Returns the language that was last applied to the translations hash
* thus overriding most of the formerly applied langs * thus overriding most of the formerly applied langs
@ -1009,7 +962,7 @@ window.html10n = (function(window, document, undefined) {
this.loader = new Loader(resources) this.loader = new Loader(resources)
this.trigger('indexed') this.trigger('indexed')
} }
if (document.addEventListener) // modern browsers and IE9+ if (document.addEventListener) // modern browsers and IE9+
document.addEventListener('DOMContentLoaded', function() { document.addEventListener('DOMContentLoaded', function() {
html10n.index() html10n.index()