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
|
/*
* Copyright (C) 2023-2024 Yomitan Authors
* Copyright (C) 2021-2022 Yomichan Authors
*
* 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 <https://www.gnu.org/licenses/>.
*/
import {isContentScriptRegistered, registerContentScript, unregisterContentScript} from '../background/script-manager.js';
import {log} from '../core/log.js';
/**
* This class controls the registration of accessibility handlers.
*/
export class AccessibilityController {
constructor() {
/** @type {?import('core').TokenObject} */
this._updateGoogleDocsAccessibilityToken = null;
/** @type {?Promise<void>} */
this._updateGoogleDocsAccessibilityPromise = null;
/** @type {boolean} */
this._forceGoogleDocsHtmlRenderingAny = false;
}
/**
* Updates the accessibility handlers.
* @param {import('settings').Options} fullOptions The full options object from the `Backend` instance.
* The value is treated as read-only and is not modified.
*/
async update(fullOptions) {
let forceGoogleDocsHtmlRenderingAny = false;
for (const {options} of fullOptions.profiles) {
if (options.accessibility.forceGoogleDocsHtmlRendering) {
forceGoogleDocsHtmlRenderingAny = true;
break;
}
}
await this._updateGoogleDocsAccessibility(forceGoogleDocsHtmlRenderingAny);
}
// Private
/**
* @param {boolean} forceGoogleDocsHtmlRenderingAny
*/
async _updateGoogleDocsAccessibility(forceGoogleDocsHtmlRenderingAny) {
// Reentrant token
/** @type {?import('core').TokenObject} */
const token = {};
this._updateGoogleDocsAccessibilityToken = token;
// Wait for previous
let promise = this._updateGoogleDocsAccessibilityPromise;
if (promise !== null) { await promise; }
// Reentrant check
if (this._updateGoogleDocsAccessibilityToken !== token) { return; }
// Update
promise = this._updateGoogleDocsAccessibilityInner(forceGoogleDocsHtmlRenderingAny);
this._updateGoogleDocsAccessibilityPromise = promise;
await promise;
this._updateGoogleDocsAccessibilityPromise = null;
}
/**
* @param {boolean} forceGoogleDocsHtmlRenderingAny
*/
async _updateGoogleDocsAccessibilityInner(forceGoogleDocsHtmlRenderingAny) {
if (this._forceGoogleDocsHtmlRenderingAny === forceGoogleDocsHtmlRenderingAny) { return; }
this._forceGoogleDocsHtmlRenderingAny = forceGoogleDocsHtmlRenderingAny;
const id = 'googleDocsAccessibility';
try {
if (forceGoogleDocsHtmlRenderingAny) {
if (await isContentScriptRegistered(id)) { return; }
try {
await this._registerGoogleDocsContentScript(id, false);
} catch (e) {
// Firefox doesn't support `world` field and will throw an error.
// In this case, use the xray vision version.
await this._registerGoogleDocsContentScript(id, true);
}
} else {
await unregisterContentScript(id);
}
} catch (e) {
log.error(e);
}
}
/**
* @param {string} id
* @param {boolean} xray
* @returns {Promise<void>}
*/
_registerGoogleDocsContentScript(id, xray) {
/** @type {import('script-manager').RegistrationDetails} */
const details = {
allFrames: true,
matches: ['*://docs.google.com/*'],
runAt: 'document_start',
js: [
xray ?
'js/accessibility/google-docs-xray.js' :
'js/accessibility/google-docs.js'
]
};
if (!xray) { details.world = 'MAIN'; }
return registerContentScript(id, details);
}
}
|