aboutsummaryrefslogtreecommitdiffstats
path: root/js/i18n.js
blob: cf27a69bcfdbdcb7735dfe233711a61a0a35c6ed (plain)
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
/*******************************************************************************

    ηMatrix - a browser extension to black/white list requests.
    Copyright (C) 2014-2019 Raymond Hill
    Copyright (C) 2019-2020 Alessio Vanni

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program.  If not, see {http://www.gnu.org/licenses/}.

    Home: https://gitlab.com/vannilla/ematrix
    uMatrix Home: https://github.com/gorhill/uMatrix
*/

'use strict';

// This file should always be included at the end of the `body` tag, so as
// to ensure all i18n targets are already loaded.

(function() {
    // https://github.com/gorhill/uBlock/issues/2084
    // Anything else than <a>, <b>, <code>, <em>, <i>, <input>, and
    // <span> will be rendered as plain text.  For <input>, only the
    // type attribute is allowed.  For <a>, only href attribute must
    // be present, and it MUST starts with `https://`, and includes no
    // single- or double-quotes.  No HTML entities are allowed, there
    // is code to handle existing HTML entities already present in
    // translation files until they are all gone.
    //
    // ηMatrix:
    // We're not going to remove anything, but rather going to make
    // full use of HTML tags and HTML entities in translations.  Of
    // course, this check for safe tags is going to stay and will be
    // used to check the source text.  The above comment is kept just
    // in case.

    let reSafeTags =
        /^([\s\S]*?)<(b|blockquote|code|em|i|kbd|span|sup)>(.+?)<\/\2>([\s\S]*)$/;
    let reSafeInput = /^([\s\S]*?)<(input type="[^"]+")>(.*?)([\s\S]*)$/;
    let reInput = /^input type=(['"])([a-z]+)\1$/;
    let reSafeLink =
        /^([\s\S]*?)<(a href=['"]https?:\/\/[^'" <>]+['"])>(.+?)<\/a>([\s\S]*)$/;
    let reLink = /^a href=(['"])(https?:\/\/[^'"]+)\1$/;

    let safeTextToTagNode = function (text) {
        let matches;
        let node;

        if (text.lastIndexOf('a ', 0) === 0) {
            matches = reLink.exec(text);
            if (matches === null) {
                return null;
            }
            node = document.createElement('a');
            node.setAttribute('href', matches[2]);
            return node;
        }
        if (text.lastIndexOf('input ', 0) === 0) {
            matches = reInput.exec(text);
            if (matches === null) {
                return null;
            }
            node = document.createElement('input');
            node.setAttribute('type', matches[2]);
            return node;
        }
        // Firefox extension validator warns if using a variable as
        // argument for document.createElement().
        // ηMatrix: is it important for us?
        // ηMatrix (4.4.3 onwards): let's just use the variable and
        // hope for the best, no need to have a redundant switch.
        /*
        switch (text) {
        case 'b':
            return document.createElement('b');
        case 'blockquote':
            return document.createElement('blockquote');
        case 'code':
            return document.createElement('code');
        case 'em':
            return document.createElement('em');
        case 'i':
            return document.createElement('i');
        case 'kbd':
            return document.createElement('kbd');
        case 'span':
            return document.createElement('span');
        case 'sup':
            return document.createElement('sup');
        default:
            break;
        }
        */
        return document.createElement(text);
    };

    let safeTextToTextNode = function (text) {
        if (text.indexOf('&') !== -1) {
            text = text
                .replace(/&ldquo;/g, '“')
                .replace(/&rdquo;/g, '”')
                .replace(/&lsquo;/g, '‘')
                .replace(/&rsquo;/g, '’')
                .replace(/&lt;/g, '<')
                .replace(/&gt;/g, '>')
                .replace(/&apos;/g, '\'');
        }
        return document.createTextNode(text);
    };

    let safeTextToDOM = function (text, parent) {
        if (text === '') {
            return;
        }

        if (text.indexOf('<') === -1) {
            return parent.appendChild(safeTextToTextNode(text));
        }

        // Using the raw <p> element is not allowed for security reason,
        // but it's good for formatting content, so here it's substituted
        // for a safer equivalent (for the extension.)
        text = text
            .replace(/^<p>|<\/p>/g, '')
            .replace(/<p>/g, '\n\n');

        let matches;
        let matches1 = reSafeTags.exec(text);
        let matches2 = reSafeLink.exec(text);
        if (matches1 !== null && matches2 !== null) {
            matches = matches1.index < matches2.index ? matches1 : matches2;
        } else if (matches1 !== null) {
            matches = matches1;
        } else if (matches2 !== null) {
            matches = matches2;
        } else {
            matches = reSafeInput.exec(text);
        }
        if (matches === null) {
            parent.appendChild(safeTextToTextNode(text));
            return;
        }

        safeTextToDOM(matches[1], parent);
        let node = safeTextToTagNode(matches[2]) || parent;
        safeTextToDOM(matches[3], node);
        parent.appendChild(node);
        safeTextToDOM(matches[4], parent);
    };

    // Helper to deal with the i18n'ing of HTML files.
    vAPI.i18n.render = function (context) {
        let docu = document;
        let root = context || docu;
        let i, elem, text;

        let elems = root.querySelectorAll('[data-i18n]');
        let n = elems.length;
        for (i=0; i<n; ++i) {
            elem = elems[i];
            text = vAPI.i18n(elem.getAttribute('data-i18n'));
            if (!text) {
                continue;
            }
            // TODO: remove once it's all replaced with <input type="...">
            if (text.indexOf('{') !== -1) {
                text =
                    text.replace(/\{\{input:([^}]+)\}\}/g, '<input type="$1">');
            }
            safeTextToDOM(text, elem);
        }

        uDom('[title]', context).forEach(function (elem) {
            let title = vAPI.i18n(elem.attr('title'));
            if (title) {
                elem.attr('title', title);
            }
        });

        uDom('[placeholder]', context).forEach(function (elem) {
            elem.attr('placeholder', vAPI.i18n(elem.attr('placeholder')));
        });

        uDom('[data-i18n-tip]', context).forEach(function (elem) {
            elem.attr('data-tip',
                      vAPI.i18n(elem.attr('data-i18n-tip'))
                      .replace(/<br>/g, '\n')
                      .replace(/\n{3,}/g, '\n\n'));
        });
    };

    vAPI.i18n.render();

    vAPI.i18n.renderElapsedTimeToString = function (tstamp) {
        let value = (Date.now() - tstamp) / 60000;
        if (value < 2) {
            return vAPI.i18n('elapsedOneMinuteAgo');
        }
        if (value < 60) {
            return vAPI
                .i18n('elapsedManyMinutesAgo')
                .replace('{{value}}', Math.floor(value).toLocaleString());
        }
        value /= 60;
        if (value < 2) {
            return vAPI.i18n('elapsedOneHourAgo');
        }
        if (value < 24) {
            return vAPI
                .i18n('elapsedManyHoursAgo')
                .replace('{{value}}', Math.floor(value).toLocaleString());
        }
        value /= 24;
        if (value < 2) {
            return vAPI.i18n('elapsedOneDayAgo');
        }
        return vAPI
            .i18n('elapsedManyDaysAgo')
            .replace('{{value}}', Math.floor(value).toLocaleString());
    };
})();