Blame view

bower_components/l20n/dist/bundle/bridge/l20n-client.js 14.6 KB
0e9aeacd   root   localization l20n
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
  (function () { 'use strict';
  
    /* global bridge, BroadcastChannel */
  
    const Client = bridge.client;
    const channel = new BroadcastChannel('l20n-channel');
  
    // match the opening angle bracket (<) in HTML tags, and HTML entities like
    // &amp;, &#0038;, &#x0026;.
    const reOverlay = /<|&#?\w+;/;
  
    const allowed = {
      elements: [
        'a', 'em', 'strong', 'small', 's', 'cite', 'q', 'dfn', 'abbr', 'data',
        'time', 'code', 'var', 'samp', 'kbd', 'sub', 'sup', 'i', 'b', 'u',
        'mark', 'ruby', 'rt', 'rp', 'bdi', 'bdo', 'span', 'br', 'wbr'
      ],
      attributes: {
        global: [ 'title', 'aria-label', 'aria-valuetext', 'aria-moz-hint' ],
        a: [ 'download' ],
        area: [ 'download', 'alt' ],
        // value is special-cased in isAttrAllowed
        input: [ 'alt', 'placeholder' ],
        menuitem: [ 'label' ],
        menu: [ 'label' ],
        optgroup: [ 'label' ],
        option: [ 'label' ],
        track: [ 'label' ],
        img: [ 'alt' ],
        textarea: [ 'placeholder' ],
        th: [ 'abbr']
      }
    };
  
    function overlayElement(element, translation) {
      const value = translation.value;
  
      if (typeof value === 'string') {
        if (!reOverlay.test(value)) {
          element.textContent = value;
        } else {
          // start with an inert template element and move its children into
          // `element` but such that `element`'s own children are not replaced
          const tmpl = element.ownerDocument.createElement('template');
          tmpl.innerHTML = value;
          // overlay the node with the DocumentFragment
          overlay(element, tmpl.content);
        }
      }
  
      for (let key in translation.attrs) {
        const attrName = camelCaseToDashed(key);
        if (isAttrAllowed({ name: attrName }, element)) {
          element.setAttribute(attrName, translation.attrs[key]);
        }
      }
    }
  
    // The goal of overlay is to move the children of `translationElement`
    // into `sourceElement` such that `sourceElement`'s own children are not
    // replaced, but onle have their text nodes and their attributes modified.
    //
    // We want to make it possible for localizers to apply text-level semantics to
    // the translations and make use of HTML entities. At the same time, we
    // don't trust translations so we need to filter unsafe elements and
    // attribtues out and we don't want to break the Web by replacing elements to
    // which third-party code might have created references (e.g. two-way
    // bindings in MVC frameworks).
    function overlay(sourceElement, translationElement) {
      const result = translationElement.ownerDocument.createDocumentFragment();
      let k, attr;
  
      // take one node from translationElement at a time and check it against
      // the allowed list or try to match it with a corresponding element
      // in the source
      let childElement;
      while ((childElement = translationElement.childNodes[0])) {
        translationElement.removeChild(childElement);
  
        if (childElement.nodeType === childElement.TEXT_NODE) {
          result.appendChild(childElement);
          continue;
        }
  
        const index = getIndexOfType(childElement);
        const sourceChild = getNthElementOfType(sourceElement, childElement, index);
        if (sourceChild) {
          // there is a corresponding element in the source, let's use it
          overlay(sourceChild, childElement);
          result.appendChild(sourceChild);
          continue;
        }
  
        if (isElementAllowed(childElement)) {
          const sanitizedChild = childElement.ownerDocument.createElement(
            childElement.nodeName);
          overlay(sanitizedChild, childElement);
          result.appendChild(sanitizedChild);
          continue;
        }
  
        // otherwise just take this child's textContent
        result.appendChild(
          translationElement.ownerDocument.createTextNode(
            childElement.textContent));
      }
  
      // clear `sourceElement` and append `result` which by this time contains
      // `sourceElement`'s original children, overlayed with translation
      sourceElement.textContent = '';
      sourceElement.appendChild(result);
  
      // if we're overlaying a nested element, translate the allowed
      // attributes; top-level attributes are handled in `translateElement`
      // XXX attributes previously set here for another language should be
      // cleared if a new language doesn't use them; https://bugzil.la/922577
      if (translationElement.attributes) {
        for (k = 0, attr; (attr = translationElement.attributes[k]); k++) {
          if (isAttrAllowed(attr, sourceElement)) {
            sourceElement.setAttribute(attr.name, attr.value);
          }
        }
      }
    }
  
    // XXX the allowed list should be amendable; https://bugzil.la/922573
    function isElementAllowed(element) {
      return allowed.elements.indexOf(element.tagName.toLowerCase()) !== -1;
    }
  
    function isAttrAllowed(attr, element) {
      const attrName = attr.name.toLowerCase();
      const tagName = element.tagName.toLowerCase();
      // is it a globally safe attribute?
      if (allowed.attributes.global.indexOf(attrName) !== -1) {
        return true;
      }
      // are there no allowed attributes for this element?
      if (!allowed.attributes[tagName]) {
        return false;
      }
      // is it allowed on this element?
      // XXX the allowed list should be amendable; https://bugzil.la/922573
      if (allowed.attributes[tagName].indexOf(attrName) !== -1) {
        return true;
      }
      // special case for value on inputs with type button, reset, submit
      if (tagName === 'input' && attrName === 'value') {
        const type = element.type.toLowerCase();
        if (type === 'submit' || type === 'button' || type === 'reset') {
          return true;
        }
      }
      return false;
    }
  
    // Get n-th immediate child of context that is of the same type as element.
    // XXX Use querySelector(':scope > ELEMENT:nth-of-type(index)'), when:
    // 1) :scope is widely supported in more browsers and 2) it works with
    // DocumentFragments.
    function getNthElementOfType(context, element, index) {
      /* jshint boss:true */
      let nthOfType = 0;
      for (let i = 0, child; child = context.children[i]; i++) {
        if (child.nodeType === child.ELEMENT_NODE &&
            child.tagName === element.tagName) {
          if (nthOfType === index) {
            return child;
          }
          nthOfType++;
        }
      }
      return null;
    }
  
    // Get the index of the element among siblings of the same type.
    function getIndexOfType(element) {
      let index = 0;
      let child;
      while ((child = element.previousElementSibling)) {
        if (child.tagName === element.tagName) {
          index++;
        }
      }
      return index;
    }
  
    function camelCaseToDashed(string) {
      // XXX workaround for https://bugzil.la/1141934
      if (string === 'ariaValueText') {
        return 'aria-valuetext';
      }
  
      return string
        .replace(/[A-Z]/g, function (match) {
          return '-' + match.toLowerCase();
        })
        .replace(/^-/, '');
    }
  
    const reHtml = /[&<>]/g;
    const htmlEntities = {
      '&': '&amp;',
      '<': '&lt;',
      '>': '&gt;',
    };
  
    function getResourceLinks(head) {
      return Array.prototype.map.call(
        head.querySelectorAll('link[rel="localization"]'),
        el => el.getAttribute('href'));
    }
  
    function setAttributes(element, id, args) {
      element.setAttribute('data-l10n-id', id);
      if (args) {
        element.setAttribute('data-l10n-args', JSON.stringify(args));
      }
    }
  
    function getAttributes(element) {
      return {
        id: element.getAttribute('data-l10n-id'),
        args: JSON.parse(element.getAttribute('data-l10n-args'))
      };
    }
  
    function getTranslatables(element) {
      const nodes = Array.from(element.querySelectorAll('[data-l10n-id]'));
  
      if (typeof element.hasAttribute === 'function' &&
          element.hasAttribute('data-l10n-id')) {
        nodes.push(element);
      }
  
      return nodes;
    }
  
    function translateMutations(view, langs, mutations) {
      const targets = new Set();
  
      for (let mutation of mutations) {
        switch (mutation.type) {
          case 'attributes':
            targets.add(mutation.target);
            break;
          case 'childList':
            for (let addedNode of mutation.addedNodes) {
              if (addedNode.nodeType === addedNode.ELEMENT_NODE) {
                if (addedNode.childElementCount) {
                  getTranslatables(addedNode).forEach(targets.add.bind(targets));
                } else {
                  if (addedNode.hasAttribute('data-l10n-id')) {
                    targets.add(addedNode);
                  }
                }
              }
            }
            break;
        }
      }
  
      if (targets.size === 0) {
        return;
      }
  
      translateElements(view, langs, Array.from(targets));
    }
  
    function translateFragment(view, langs, frag) {
      return translateElements(view, langs, getTranslatables(frag));
    }
  
    function getElementsTranslation(view, langs, elems) {
      const keys = elems.map(elem => {
        const id = elem.getAttribute('data-l10n-id');
        const args = elem.getAttribute('data-l10n-args');
        return args ? [
          id,
          JSON.parse(args.replace(reHtml, match => htmlEntities[match]))
        ] : id;
      });
  
      return view._resolveEntities(langs, keys);
    }
  
    function translateElements(view, langs, elements) {
      return getElementsTranslation(view, langs, elements).then(
        translations => applyTranslations(view, elements, translations));
    }
  
    function applyTranslations(view, elems, translations) {
      view._disconnect();
      for (let i = 0; i < elems.length; i++) {
        overlayElement(elems[i], translations[i]);
      }
      view._observe();
    }
  
    // Polyfill NodeList.prototype[Symbol.iterator] for Chrome.
    // See https://code.google.com/p/chromium/issues/detail?id=401699
    if (typeof NodeList === 'function' && !NodeList.prototype[Symbol.iterator]) {
      NodeList.prototype[Symbol.iterator] = Array.prototype[Symbol.iterator];
    }
  
    // A document.ready shim
    // https://github.com/whatwg/html/issues/127
    function documentReady() {
      if (document.readyState !== 'loading') {
        return Promise.resolve();
      }
  
      return new Promise(resolve => {
        document.addEventListener('readystatechange', function onrsc() {
          document.removeEventListener('readystatechange', onrsc);
          resolve();
        });
      });
    }
  
    // Intl.Locale
    function getDirection(code) {
      const tag = code.split('-')[0];
      return ['ar', 'he', 'fa', 'ps', 'ur'].indexOf(tag) >= 0 ?
        'rtl' : 'ltr';
    }
  
    const observerConfig = {
      attributes: true,
      characterData: false,
      childList: true,
      subtree: true,
      attributeFilter: ['data-l10n-id', 'data-l10n-args']
    };
  
    const readiness = new WeakMap();
  
    class View {
      constructor(client, doc) {
        this._doc = doc;
        this.pseudo = {
          'fr-x-psaccent': createPseudo(this, 'fr-x-psaccent'),
          'ar-x-psbidi': createPseudo(this, 'ar-x-psbidi')
        };
  
        this._interactive = documentReady().then(
          () => init(this, client));
  
        const observer = new MutationObserver(onMutations.bind(this));
        this._observe = () => observer.observe(doc, observerConfig);
        this._disconnect = () => observer.disconnect();
  
        const translateView = langs => translateDocument(this, langs);
        client.on('translateDocument', translateView);
        this.ready = this._interactive.then(
          client => client.method('resolvedLanguages')).then(
          translateView);
      }
  
      requestLanguages(langs, global) {
        return this._interactive.then(
          client => client.method('requestLanguages', langs, global));
      }
  
      _resolveEntities(langs, keys) {
        return this._interactive.then(
          client => client.method('resolveEntities', client.id, langs, keys));
      }
  
      formatValue(id, args) {
        return this._interactive.then(
          client => client.method('formatValues', client.id, [[id, args]])).then(
          values => values[0]);
      }
  
      formatValues(...keys) {
        return this._interactive.then(
          client => client.method('formatValues', client.id, keys));
      }
  
      translateFragment(frag) {
        return this._interactive.then(
          client => client.method('resolvedLanguages')).then(
          langs => translateFragment(this, langs, frag));
      }
    }
  
    View.prototype.setAttributes = setAttributes;
    View.prototype.getAttributes = getAttributes;
  
    function createPseudo(view, code) {
      return {
        getName: () => view._interactive.then(
          client => client.method('getName', code)),
        processString: str => view._interactive.then(
          client => client.method('processString', code, str)),
      };
    }
  
    function init(view, client) {
      view._observe();
      return client.method(
        'registerView', client.id, getResourceLinks(view._doc.head)).then(
          () => client);
    }
  
    function onMutations(mutations) {
      return this._interactive.then(
        client => client.method('resolvedLanguages')).then(
        langs => translateMutations(this, langs, mutations));
    }
  
    function translateDocument(view, langs) {
      const html = view._doc.documentElement;
  
      if (readiness.has(html)) {
        return translateFragment(view, langs, html).then(
          () => setAllAndEmit(html, langs));
      }
  
      const translated =
        // has the document been already pre-translated?
        langs[0].code === html.getAttribute('lang') ?
          Promise.resolve() :
          translateFragment(view, langs, html).then(
            () => setLangDir(html, langs));
  
      return translated.then(() => {
        setLangs(html, langs);
        readiness.set(html, true);
      });
    }
  
    function setLangs(html, langs) {
      const codes = langs.map(lang => lang.code);
      html.setAttribute('langs', codes.join(' '));
    }
  
    function setLangDir(html, langs) {
      const code = langs[0].code;
      html.setAttribute('lang', code);
      html.setAttribute('dir', getDirection(code));
    }
  
    function setAllAndEmit(html, langs) {
      setLangDir(html, langs);
      setLangs(html, langs);
      html.parentNode.dispatchEvent(new CustomEvent('DOMRetranslated', {
        bubbles: false,
        cancelable: false,
      }));
    }
  
    const client = new Client({
      service: 'l20n',
      endpoint: channel,
      timeout: false
    });
  
    window.addEventListener('pageshow', () => client.connect());
    window.addEventListener('pagehide', () => client.disconnect());
  
    document.l10n = new View(client, document);
  
    //Bug 1204660 - Temporary proxy for shared code. Will be removed once
    //              l10n.js migration is completed.
    navigator.mozL10n = {
      setAttributes: document.l10n.setAttributes,
      getAttributes: document.l10n.getAttributes,
      formatValue: (...args) => document.l10n.formatValue(...args),
      translateFragment: (...args) => document.l10n.translateFragment(...args),
      once: cb => document.l10n.ready.then(cb),
      ready: cb => document.l10n.ready.then(() => {
        document.addEventListener('DOMRetranslated', cb);
        cb();
      }),
    };
  
  })();