summaryrefslogtreecommitdiff
path: root/ext/js/script/dynamic-loader.js
blob: 8fdb77e92cc9001e850296a3fe37b53875aeb78b (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
/*
 * Copyright (C) 2023  Yomitan Authors
 * Copyright (C) 2020-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 {yomitan} from '../yomitan.js';

export const dynamicLoader = (() => {
    /** @type {Map<string, ?HTMLStyleElement|HTMLLinkElement>} */
    const injectedStylesheets = new Map();
    /** @type {WeakMap<Node, Map<string, ?HTMLStyleElement|HTMLLinkElement>>} */
    const injectedStylesheetsWithParent = new WeakMap();

    /**
     * @param {string} id
     * @param {?Node} parentNode
     * @returns {?HTMLStyleElement|HTMLLinkElement|undefined}
     */
    function getInjectedStylesheet(id, parentNode) {
        if (parentNode === null) {
            return injectedStylesheets.get(id);
        }
        const map = injectedStylesheetsWithParent.get(parentNode);
        return typeof map !== 'undefined' ? map.get(id) : void 0;
    }

    /**
     * @param {string} id
     * @param {?Node} parentNode
     * @param {?HTMLStyleElement|HTMLLinkElement} value
     */
    function setInjectedStylesheet(id, parentNode, value) {
        if (parentNode === null) {
            injectedStylesheets.set(id, value);
            return;
        }
        let map = injectedStylesheetsWithParent.get(parentNode);
        if (typeof map === 'undefined') {
            map = new Map();
            injectedStylesheetsWithParent.set(parentNode, map);
        }
        map.set(id, value);
    }

    /**
     * @param {string} id
     * @param {'code'|'file'|'file-content'} type
     * @param {string} value
     * @param {boolean} [useWebExtensionApi]
     * @param {?Node} [parentNode]
     * @returns {Promise<?HTMLStyleElement|HTMLLinkElement>}
     * @throws {Error}
     */
    async function loadStyle(id, type, value, useWebExtensionApi = false, parentNode = null) {
        if (useWebExtensionApi && yomitan.isExtensionUrl(window.location.href)) {
            // Permissions error will occur if trying to use the WebExtension API to inject into an extension page
            useWebExtensionApi = false;
        }

        let styleNode = getInjectedStylesheet(id, parentNode);
        if (typeof styleNode !== 'undefined') {
            if (styleNode === null) {
                // Previously injected via WebExtension API
                throw new Error(`Stylesheet with id ${id} has already been injected using the WebExtension API`);
            }
        } else {
            styleNode = null;
        }

        if (type === 'file-content') {
            value = await yomitan.api.getStylesheetContent(value);
            type = 'code';
            useWebExtensionApi = false;
        }

        if (useWebExtensionApi) {
            // Inject via WebExtension API
            if (styleNode !== null && styleNode.parentNode !== null) {
                styleNode.parentNode.removeChild(styleNode);
            }

            setInjectedStylesheet(id, parentNode, null);
            await yomitan.api.injectStylesheet(type, value);
            return null;
        }

        // Create node in document
        let parentNode2 = parentNode;
        if (parentNode2 === null) {
            parentNode2 = document.head;
            if (parentNode2 === null) {
                throw new Error('No parent node');
            }
        }

        // Create or reuse node
        const isFile = (type === 'file');
        const tagName = isFile ? 'link' : 'style';
        if (styleNode === null || styleNode.nodeName.toLowerCase() !== tagName) {
            if (styleNode !== null && styleNode.parentNode !== null) {
                styleNode.parentNode.removeChild(styleNode);
            }
            styleNode = document.createElement(tagName);
        }

        // Update node style
        if (isFile) {
            /** @type {HTMLLinkElement} */ (styleNode).rel = 'stylesheet';
            /** @type {HTMLLinkElement} */ (styleNode).href = value;
        } else {
            styleNode.textContent = value;
        }

        // Update parent
        if (styleNode.parentNode !== parentNode2) {
            parentNode2.appendChild(styleNode);
        }

        // Add to map
        setInjectedStylesheet(id, parentNode, styleNode);
        return styleNode;
    }

    /**
     * @param {string[]} urls
     * @returns {Promise<void>}
     */
    function loadScripts(urls) {
        return new Promise((resolve, reject) => {
            const parent = document.body;
            if (parent === null) {
                reject(new Error('Missing body'));
                return;
            }

            for (const url of urls) {
                const node = parent.querySelector(`script[src='${escapeCSSAttribute(url)}']`);
                if (node !== null) { continue; }

                const script = document.createElement('script');
                script.type = 'module';
                script.async = false;
                script.src = url;
                parent.appendChild(script);
            }

            loadScriptSentinel(parent, resolve, reject);
        });
    }

    /**
     * @param {HTMLElement} parent
     * @param {() => void} resolve
     * @param {(reason?: unknown) => void} reject
     */
    function loadScriptSentinel(parent, resolve, reject) {
        const script = document.createElement('script');

        const sentinelEventName = 'dynamicLoaderSentinel';
        /**
         * @param {import('dynamic-loader').DynamicLoaderSentinelDetails} e
         */
        const sentinelEventCallback = (e) => {
            if (e.scriptUrl !== script.src) { return; }
            yomitan.off(sentinelEventName, sentinelEventCallback);
            parent.removeChild(script);
            resolve();
        };
        yomitan.on(sentinelEventName, sentinelEventCallback);

        try {
            script.type = 'module';
            script.async = false;
            script.src = '/js/script/dynamic-loader-sentinel.js';
            parent.appendChild(script);
        } catch (e) {
            yomitan.off(sentinelEventName, sentinelEventCallback);
            reject(e);
        }
    }

    /**
     * @param {string} value
     * @returns {string}
     */
    function escapeCSSAttribute(value) {
        return value.replace(/['\\]/g, (character) => `\\${character}`);
    }


    return {
        loadStyle,
        loadScripts
    };
})();