-
-
Notifications
You must be signed in to change notification settings - Fork 475
/
config.js
567 lines (513 loc) · 18.2 KB
/
config.js
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
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
"use strict";
const twpConfig = (function () {
/** @type {function[]} */
const observers = [];
const defaultTargetLanguages = ["en", "es", "de"];
/**
* all configName available
* @typedef {"pageTranslatorService" | "textTranslatorService" | "enabledServices" | "ttsSpeed" | "enableDeepL" | "targetLanguage" | "targetLanguageTextTranslation" | "targetLanguages" | "alwaysTranslateSites" | "neverTranslateSites" | "sitesToTranslateWhenHovering" | "langsToTranslateWhenHovering" | "alwaysTranslateLangs" | "neverTranslateLangs" | "customDictionary" | "showTranslatePageContextMenu" | "showTranslateSelectedContextMenu" | "showButtonInTheAddressBar" | "showOriginalTextWhenHovering" | "showTranslateSelectedButton" | "showPopupMobile" | "useOldPopup" | "darkMode" | "popupBlueWhenSiteIsTranslated" | "popupPanelSection" | "showReleaseNotes" | "dontShowIfPageLangIsTargetLang" | "dontShowIfPageLangIsUnknown" | "dontShowIfSelectedTextIsTargetLang" | "dontShowIfSelectedTextIsUnknown" | "hotkeys" | "expandPanelTranslateSelectedText" | "translateTag_pre" | "dontSortResults" | "translateDynamicallyCreatedContent" | "autoTranslateWhenClickingALink" | "translateSelectedWhenPressTwice" | "translateTextOverMouseWhenPressTwice" | "translateClickingOnce" | "enableDiskCache" | "useAlternativeService" | "customServices"} DefaultConfigNames
*/
const defaultConfig = {
pageTranslatorService: "google", // google yandex bing
textTranslatorService: "google", // google yandex bing deepl
enabledServices: ["google", "bing", "yandex", "deepl"],
ttsSpeed: 1.0,
enableDeepL: "yes",
targetLanguage: null,
targetLanguageTextTranslation: null,
targetLanguages: [], // "en", "es", "de"
alwaysTranslateSites: [],
neverTranslateSites: [],
sitesToTranslateWhenHovering: [],
langsToTranslateWhenHovering: [],
alwaysTranslateLangs: [],
neverTranslateLangs: [],
customDictionary: new Map(),
showTranslatePageContextMenu: "yes",
showTranslateSelectedContextMenu: "yes",
showButtonInTheAddressBar: "yes",
showOriginalTextWhenHovering: "no",
showTranslateSelectedButton: "yes",
showPopupMobile: "yes", // yes no threeFingersOnTheScreen
useOldPopup: "yes",
darkMode: "auto", // auto yes no
popupBlueWhenSiteIsTranslated: "yes",
popupPanelSection: 1,
showReleaseNotes: "yes",
dontShowIfPageLangIsTargetLang: "no",
dontShowIfPageLangIsUnknown: "no",
dontShowIfSelectedTextIsTargetLang: "no",
dontShowIfSelectedTextIsUnknown: "no",
hotkeys: {}, // Hotkeys are obtained from the manifest file
expandPanelTranslateSelectedText: "no",
translateTag_pre: "yes",
dontSortResults: "no",
translateDynamicallyCreatedContent: "yes",
autoTranslateWhenClickingALink: "no",
translateSelectedWhenPressTwice: "no",
translateTextOverMouseWhenPressTwice: "no",
translateClickingOnce: "no",
enableDiskCache: "no",
useAlternativeService: "yes",
customServices: [],
};
const config = structuredClone(defaultConfig);
let onReadyObservers = [];
let configIsReady = false;
let onReadyResolvePromise;
const onReadyPromise = new Promise(
(resolve) => (onReadyResolvePromise = resolve)
);
/**
* this function is executed when de config is ready
*/
function readyConfig() {
configIsReady = true;
onReadyObservers.forEach((callback) => callback());
onReadyObservers = [];
onReadyResolvePromise();
}
const twpConfig = {};
/**
* create a listener to run when the settings are ready
* @param {function} callback
* @returns {Promise}
*/
twpConfig.onReady = function (callback) {
if (callback) {
if (configIsReady) {
callback();
} else {
onReadyObservers.push(callback);
}
}
return onReadyPromise;
};
/**
* get the value of a config
* @example
* twpConfig.get("targetLanguages")
* // returns ["en", "es", "de"]
* @param {DefaultConfigNames} name
* @returns {*} value
*/
twpConfig.get = function (name) {
return config[name];
};
/**
* set the value of a config
* @example
* twpConfig.set("showReleaseNotes", "no")
* @param {DefaultConfigNames} name
* @param {*} value
*/
twpConfig.set = function (name, value) {
// @ts-ignore
config[name] = value;
const obj = {};
obj[name] = toObjectOrArrayIfTypeIsMapOrSet(value);
chrome.storage.local.set(obj);
observers.forEach((callback) => callback(name, value));
};
/**
* export config as JSON string
* @returns {string} configJSON
*/
twpConfig.export = function () {
const r = {
timeStamp: Date.now(),
version: chrome.runtime.getManifest().version,
};
for (const key in defaultConfig) {
//@ts-ignore
r[key] = toObjectOrArrayIfTypeIsMapOrSet(twpConfig.get(key));
}
return JSON.stringify(r, null, 4);
};
/**
* import config and reload the extension
* @param {string} configJSON
*/
twpConfig.import = function (configJSON) {
const newconfig = JSON.parse(configJSON);
for (const key in defaultConfig) {
if (typeof newconfig[key] !== "undefined") {
let value = newconfig[key];
value = fixObjectType(key, value);
//@ts-ignore
twpConfig.set(key, value);
}
}
if (
typeof browser !== "undefined" &&
typeof browser.commands !== "undefined"
) {
for (const name in config.hotkeys) {
browser.commands.update({
name: name,
shortcut: config.hotkeys[name],
});
}
}
chrome.runtime.reload();
};
/**
* restore the config to default and reaload the extension
*/
twpConfig.restoreToDefault = function () {
// try to reset the keyboard shortcuts
if (
typeof browser !== "undefined" &&
typeof browser.commands !== "undefined"
) {
for (const name of Object.keys(
chrome.runtime.getManifest().commands || {}
)) {
const info = chrome.runtime.getManifest().commands[name];
if (info.suggested_key && info.suggested_key.default) {
browser.commands.update({
name: name,
shortcut: info.suggested_key.default,
});
} else {
browser.commands.update({
name: name,
shortcut: "",
});
}
}
}
twpConfig.import(JSON.stringify(defaultConfig));
};
/**
* create a listener to run when a config changes
* @param {function} callback
*/
twpConfig.onChanged = function (callback) {
observers.push(callback);
};
// listen to storage changes
chrome.storage.onChanged.addListener((changes, areaName) => {
twpConfig.onReady(function () {
if (areaName === "local") {
for (const name in changes) {
const newValue = changes[name].newValue;
if (config[name] !== newValue) {
config[name] = fixObjectType(name, newValue);
observers.forEach((callback) => callback(name, newValue));
}
}
}
});
});
// load config
chrome.i18n.getAcceptLanguages((acceptedLanguages) => {
chrome.storage.local.get(null, (onGot) => {
// load config; convert object/array to map/set if necessary
for (const name in onGot) {
config[name] = fixObjectType(name, onGot[name]);
}
// if there are any targetLanguage undefined, replace them
if (config.targetLanguages.some((tl) => !tl)) {
config.targetLanguages = [...defaultTargetLanguages];
chrome.storage.local.set({
targetLanguages: config.targetLanguages,
});
}
// Probably at this point it doesn't have 3 target languages.
// try to get the 3 target languages through the user defined languages in the browser configuration.
for (let lang of acceptedLanguages) {
if (config.targetLanguages.length >= 3) break;
lang = twpLang.fixTLanguageCode(lang);
if (lang && config.targetLanguages.indexOf(lang) === -1) {
config.targetLanguages.push(lang);
}
}
// then try to use de array defaultTargetLanguages ["en", "es", "de"]
for (const lang in defaultTargetLanguages) {
if (config.targetLanguages.length >= 3) break;
if (
config.targetLanguages.indexOf(defaultTargetLanguages[lang]) === -1
) {
config.targetLanguages.push(defaultTargetLanguages[lang]);
}
}
// if targetLanguages is bigger than 3 remove the surplus
while (config.targetLanguages.length > 3) config.targetLanguages.pop();
/*
// remove the duplicates languages
config.targetLanguages = [... new Set(config.targetLanguages)]
//*
// then try to use de array defaultTargetLanguages ["en", "es", "de"]
for (const lang of defaultTargetLanguages) {
if (config.targetLanguages.length >= 3) break;
if (config.targetLanguages.indexOf(lang) === -1) {
config.targetLanguages.push(lang);
}
}
//*/
// if targetLanguage does not exits in targetLanguages, then set it to targetLanguages[0]
if (
!config.targetLanguage ||
config.targetLanguages.indexOf(config.targetLanguage) === -1
) {
config.targetLanguage = config.targetLanguages[0];
}
// if targetLanguageTextTranslation does not exits in targetLanguages, then set it to targetLanguages[0]
if (
!config.targetLanguageTextTranslation ||
config.targetLanguages.indexOf(config.targetLanguageTextTranslation) ===
-1
) {
config.targetLanguageTextTranslation = config.targetLanguages[0];
}
// fix targetLanguages
config.targetLanguages = config.targetLanguages.map((lang) =>
twpLang.fixTLanguageCode(lang)
);
// fix neverTranslateLangs
config.neverTranslateLangs = config.neverTranslateLangs.map((lang) =>
twpLang.fixTLanguageCode(lang)
);
// fix alwaysTranslateLangs
config.alwaysTranslateLangs = config.alwaysTranslateLangs.map((lang) =>
twpLang.fixTLanguageCode(lang)
);
// fix targetLanguage
config.targetLanguage = twpLang.fixTLanguageCode(config.targetLanguage);
// fix targetLanguageTextTranslation
config.targetLanguageTextTranslation = twpLang.fixTLanguageCode(
config.targetLanguageTextTranslation
);
// if targetLanguage does not exits in targetLanguages, then set it to targetLanguages[0]
if (config.targetLanguages.indexOf(config.targetLanguage) === -1) {
config.targetLanguage = config.targetLanguages[0];
}
// if targetLanguageTextTranslation does not exits in targetLanguages, then set it to targetLanguages[0]
if (
config.targetLanguages.indexOf(config.targetLanguageTextTranslation) ===
-1
) {
config.targetLanguageTextTranslation = config.targetLanguages[0];
}
// try to save de keyboard shortcuts in the config
if (typeof chrome.commands !== "undefined") {
chrome.commands.getAll((results) => {
try {
for (const result of results) {
config.hotkeys[result.name] = result.shortcut;
}
twpConfig.set("hotkeys", config.hotkeys);
} catch (e) {
console.error(e);
} finally {
readyConfig();
}
});
} else {
readyConfig();
}
});
});
function addInArray(configName, value) {
const array = twpConfig.get(configName);
if (array.indexOf(value) === -1) {
array.push(value);
twpConfig.set(configName, array);
}
}
function addInMap(configName, key, value) {
let map = twpConfig.get(configName);
if (typeof map.get(key) === "undefined") {
map.set(key, value);
twpConfig.set(configName, map);
}
}
function removeFromArray(configName, value) {
const array = twpConfig.get(configName);
const index = array.indexOf(value);
if (index > -1) {
array.splice(index, 1);
twpConfig.set(configName, array);
}
}
function removeFromMap(configName, key) {
const map = twpConfig.get(configName);
if (typeof map.get(key) !== "undefined") {
map.delete(key);
twpConfig.set(configName, map);
}
}
twpConfig.addSiteToTranslateWhenHovering = function (hostname) {
addInArray("sitesToTranslateWhenHovering", hostname);
};
twpConfig.removeSiteFromTranslateWhenHovering = function (hostname) {
removeFromArray("sitesToTranslateWhenHovering", hostname);
};
twpConfig.addLangToTranslateWhenHovering = function (lang) {
addInArray("langsToTranslateWhenHovering", lang);
};
twpConfig.removeLangFromTranslateWhenHovering = function (lang) {
removeFromArray("langsToTranslateWhenHovering", lang);
};
twpConfig.addSiteToAlwaysTranslate = function (hostname) {
addInArray("alwaysTranslateSites", hostname);
removeFromArray("neverTranslateSites", hostname);
};
twpConfig.removeSiteFromAlwaysTranslate = function (hostname) {
removeFromArray("alwaysTranslateSites", hostname);
};
twpConfig.addSiteToNeverTranslate = function (hostname) {
addInArray("neverTranslateSites", hostname);
removeFromArray("alwaysTranslateSites", hostname);
removeFromArray("sitesToTranslateWhenHovering", hostname);
};
twpConfig.addKeyWordTocustomDictionary = function (key, value) {
addInMap("customDictionary", key, value);
};
twpConfig.removeSiteFromNeverTranslate = function (hostname) {
removeFromArray("neverTranslateSites", hostname);
};
twpConfig.removeKeyWordFromcustomDictionary = function (keyWord) {
removeFromMap("customDictionary", keyWord);
};
twpConfig.addLangToAlwaysTranslate = function (lang, hostname) {
addInArray("alwaysTranslateLangs", lang);
removeFromArray("neverTranslateLangs", lang);
if (hostname) {
removeFromArray("neverTranslateSites", hostname);
}
};
twpConfig.removeLangFromAlwaysTranslate = function (lang) {
removeFromArray("alwaysTranslateLangs", lang);
};
twpConfig.addLangToNeverTranslate = function (lang, hostname) {
addInArray("neverTranslateLangs", lang);
removeFromArray("alwaysTranslateLangs", lang);
removeFromArray("langsToTranslateWhenHovering", lang);
if (hostname) {
removeFromArray("alwaysTranslateSites", hostname);
}
};
twpConfig.removeLangFromNeverTranslate = function (lang) {
removeFromArray("neverTranslateLangs", lang);
};
/**
* Add a new lang to the targetLanguages and remove the last target language. If the language is already in the targetLanguages then move it to the first position
* @example
* addTargetLanguage("de")
* @param {string} lang - langCode
* @returns
*/
function addTargetLanguage(lang) {
const targetLanguages = twpConfig.get("targetLanguages");
lang = twpLang.fixTLanguageCode(lang);
if (!lang) return;
const index = targetLanguages.indexOf(lang);
if (index === -1) {
targetLanguages.unshift(lang);
targetLanguages.pop();
} else {
targetLanguages.splice(index, 1);
targetLanguages.unshift(lang);
}
twpConfig.set("targetLanguages", targetLanguages);
}
/**
* set lang as target language for page translation only (not text translation)
*
* if the lang in not in targetLanguages then call addTargetLanguage
* @example
* twpConfig.setTargetLanguage("de", true)
* @param {string} lang - langCode
* @param {boolean} forTextToo - also call setTargetLanguageTextTranslation
* @returns
*/
twpConfig.setTargetLanguage = function (lang, forTextToo = false) {
const targetLanguages = twpConfig.get("targetLanguages");
lang = twpLang.fixTLanguageCode(lang);
if (!lang) return;
if (targetLanguages.indexOf(lang) === -1 || forTextToo) {
addTargetLanguage(lang);
}
twpConfig.set("targetLanguage", lang);
if (forTextToo) {
twpConfig.setTargetLanguageTextTranslation(lang);
}
};
/**
* set lang as target language for text translation only (not page translation)
* @example
* twpConfig.setTargetLanguage("de")
* @param {string} lang - langCode
* @returns
*/
twpConfig.setTargetLanguageTextTranslation = function (lang) {
lang = twpLang.fixTLanguageCode(lang);
if (!lang) return;
twpConfig.set("targetLanguageTextTranslation", lang);
};
/**
* convert object to map or set if necessary, otherwise return the value itself
* @example
* fixObjectType("customDictionary", {})
* // returns Map
* fixObjectType("targetLanguages", ["en", "es", "de"])
* // return ["en", "es", "de"] -- Array
* @param {string} key
* @param {*} value
* @returns {Map | Set | *}
*/
function fixObjectType(key, value) {
if (defaultConfig[key] instanceof Map) {
return new Map(Object.entries(value));
} else if (defaultConfig[key] instanceof Set) {
return new Set(value);
} else {
return value;
}
}
/**
* convert map and set to object and array respectively, otherwise return the value itself
* @example
* toObjectOrArrayIfTypeIsMapOrSet(new Map())
* // returns {}
* toObjectOrArrayIfTypeIsMapOrSet({})
* // returns {}
* @param {Map | Set | *} value
* @returns {Object | Array | *}
*/
function toObjectOrArrayIfTypeIsMapOrSet(value) {
if (value instanceof Map) {
return Object.fromEntries(value);
} else if (value instanceof Set) {
return Array.from(value);
} else {
return value;
}
}
/**
* Switch between page translation services that are enabled
* @returns {string} newServiceName
*/
twpConfig.swapPageTranslationService = function () {
const pageTranslationServices = ["google", "bing", "yandex"];
const pageEnabledServices = twpConfig
.get("enabledServices")
.filter((svName) => pageTranslationServices.includes(svName));
const index = pageEnabledServices.indexOf(
twpConfig.get("pageTranslatorService")
);
if (index !== -1) {
if (pageEnabledServices[index + 1]) {
twpConfig.set("pageTranslatorService", pageEnabledServices[index + 1]);
} else {
twpConfig.set("pageTranslatorService", pageEnabledServices[0]);
}
} else {
twpConfig.set("pageTranslatorService", pageEnabledServices[0]);
}
return twpConfig.get("pageTranslatorService");
};
return twpConfig;
})();