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
|
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";
const EXPORTED_SYMBOLS = ["l10n"];
/**
* An API which allows Marionette to handle localized content.
*
* The localization (https://mzl.la/2eUMjyF) of UI elements in Gecko
* based applications is done via entities and properties. For static
* values entities are used, which are located in .dtd files. Whereby for
* dynamically updated content the values come from .property files. Both
* types of elements can be identifed via a unique id, and the translated
* content retrieved.
*/
const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");
const { XPCOMUtils } = ChromeUtils.import(
"resource://gre/modules/XPCOMUtils.jsm"
);
XPCOMUtils.defineLazyModuleGetters(this, {
error: "chrome://marionette/content/error.js",
});
XPCOMUtils.defineLazyGlobalGetters(this, ["DOMParser"]);
XPCOMUtils.defineLazyGetter(this, "domParser", () => {
const parser = new DOMParser();
parser.forceEnableDTD();
return parser;
});
/** @namespace */
this.l10n = {};
/**
* Retrieve the localized string for the specified entity id.
*
* Example:
* localizeEntity(["chrome://branding/locale/brand.dtd"], "brandShortName")
*
* @param {Array.<string>} urls
* Array of .dtd URLs.
* @param {string} id
* The ID of the entity to retrieve the localized string for.
*
* @return {string}
* The localized string for the requested entity.
*/
l10n.localizeEntity = function(urls, id) {
// Build a string which contains all possible entity locations
let locations = [];
urls.forEach((url, index) => {
locations.push(`<!ENTITY % dtd_${index} SYSTEM "${url}">%dtd_${index};`);
});
// Use the DOM parser to resolve the entity and extract its real value
let header = `<?xml version="1.0"?><!DOCTYPE elem [${locations.join("")}]>`;
let elem = `<elem id="elementID">&${id};</elem>`;
let doc = domParser.parseFromString(header + elem, "text/xml");
let element = doc.querySelector("elem[id='elementID']");
if (element === null) {
throw new error.NoSuchElementError(
`Entity with id='${id}' hasn't been found`
);
}
return element.textContent;
};
/**
* Retrieve the localized string for the specified property id.
*
* Example:
*
* localizeProperty(
* ["chrome://global/locale/findbar.properties"], "FastFind");
*
* @param {Array.<string>} urls
* Array of .properties URLs.
* @param {string} id
* The ID of the property to retrieve the localized string for.
*
* @return {string}
* The localized string for the requested property.
*/
l10n.localizeProperty = function(urls, id) {
let property = null;
for (let url of urls) {
let bundle = Services.strings.createBundle(url);
try {
property = bundle.GetStringFromName(id);
break;
} catch (e) {}
}
if (property === null) {
throw new error.NoSuchElementError(
`Property with ID '${id}' hasn't been found`
);
}
return property;
};
|
