aboutsummaryrefslogtreecommitdiff
path: root/ext/js/app/popup-factory.js
blob: 14fc46170ea6efba9f34fd0b4364c32472e957e0 (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
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
/*
 * Copyright (C) 2023-2024  Yomitan Authors
 * Copyright (C) 2019-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 {FrameOffsetForwarder} from '../comm/frame-offset-forwarder.js';
import {generateId} from '../core.js';
import {yomitan} from '../yomitan.js';
import {PopupProxy} from './popup-proxy.js';
import {PopupWindow} from './popup-window.js';
import {Popup} from './popup.js';

/**
 * A class which is used to generate and manage popups.
 */
export class PopupFactory {
    /**
     * Creates a new instance.
     * @param {number} frameId The frame ID of the host frame.
     */
    constructor(frameId) {
        /** @type {number} */
        this._frameId = frameId;
        /** @type {FrameOffsetForwarder} */
        this._frameOffsetForwarder = new FrameOffsetForwarder(frameId);
        /** @type {Map<string, import('popup').PopupAny>} */
        this._popups = new Map();
        /** @type {Map<string, {popup: import('popup').PopupAny, token: string}[]>} */
        this._allPopupVisibilityTokenMap = new Map();
    }

    /**
     * Prepares the instance for use.
     */
    prepare() {
        this._frameOffsetForwarder.prepare();
        /* eslint-disable no-multi-spaces */
        yomitan.crossFrame.registerHandlers([
            ['popupFactoryGetOrCreatePopup',     this._onApiGetOrCreatePopup.bind(this)],
            ['popupFactorySetOptionsContext',    this._onApiSetOptionsContext.bind(this)],
            ['popupFactoryHide',                 this._onApiHide.bind(this)],
            ['popupFactoryIsVisible',            this._onApiIsVisibleAsync.bind(this)],
            ['popupFactorySetVisibleOverride',   this._onApiSetVisibleOverride.bind(this)],
            ['popupFactoryClearVisibleOverride', this._onApiClearVisibleOverride.bind(this)],
            ['popupFactoryContainsPoint',        this._onApiContainsPoint.bind(this)],
            ['popupFactoryShowContent',          this._onApiShowContent.bind(this)],
            ['popupFactorySetCustomCss',         this._onApiSetCustomCss.bind(this)],
            ['popupFactoryClearAutoPlayTimer',   this._onApiClearAutoPlayTimer.bind(this)],
            ['popupFactorySetContentScale',      this._onApiSetContentScale.bind(this)],
            ['popupFactoryUpdateTheme',          this._onApiUpdateTheme.bind(this)],
            ['popupFactorySetCustomOuterCss',    this._onApiSetCustomOuterCss.bind(this)],
            ['popupFactoryGetFrameSize',         this._onApiGetFrameSize.bind(this)],
            ['popupFactorySetFrameSize',         this._onApiSetFrameSize.bind(this)]
        ]);
        /* eslint-enable no-multi-spaces */
    }

    /**
     * Gets or creates a popup based on a set of parameters
     * @param {import('popup-factory').GetOrCreatePopupDetails} details Details about how to acquire the popup.
     * @returns {Promise<import('popup').PopupAny>}
     */
    async getOrCreatePopup({
        frameId = null,
        id = null,
        parentPopupId = null,
        depth = null,
        popupWindow = false,
        childrenSupported = false
    }) {
        // Find by existing id
        if (id !== null) {
            const popup = this._popups.get(id);
            if (typeof popup !== 'undefined') {
                return popup;
            }
        }

        // Find by existing parent id
        let parent = null;
        if (parentPopupId !== null) {
            parent = this._popups.get(parentPopupId);
            if (typeof parent !== 'undefined') {
                const popup = parent.child;
                if (popup !== null) {
                    return popup;
                }
            } else {
                parent = null;
            }
        }

        // Depth
        if (parent !== null) {
            if (depth !== null) {
                throw new Error('Depth cannot be set when parent exists');
            }
            depth = parent.depth + 1;
        } else if (depth === null) {
            depth = 0;
        }

        if (popupWindow) {
            // New unique id
            if (id === null) {
                id = generateId(16);
            }
            const popup = new PopupWindow({
                id,
                depth,
                frameId: this._frameId
            });
            this._popups.set(id, popup);
            return popup;
        } else if (frameId === this._frameId) {
            // New unique id
            if (id === null) {
                id = generateId(16);
            }
            const popup = new Popup({
                id,
                depth,
                frameId: this._frameId,
                childrenSupported
            });
            if (parent !== null) {
                if (parent.child !== null) {
                    throw new Error('Parent popup already has a child');
                }
                popup.parent = /** @type {Popup} */ (parent);
                parent.child = popup;
            }
            this._popups.set(id, popup);
            popup.prepare();
            return popup;
        } else {
            if (frameId === null) {
                throw new Error('Invalid frameId');
            }
            const useFrameOffsetForwarder = (parentPopupId === null);
            /** @type {{id: string, depth: number, frameId: number}} */
            const info = await yomitan.crossFrame.invoke(frameId, 'popupFactoryGetOrCreatePopup', /** @type {import('popup-factory').GetOrCreatePopupDetails} */ ({
                id,
                parentPopupId,
                frameId,
                childrenSupported
            }));
            id = info.id;
            const popup = new PopupProxy({
                id,
                depth: info.depth,
                frameId: info.frameId,
                frameOffsetForwarder: useFrameOffsetForwarder ? this._frameOffsetForwarder : null
            });
            this._popups.set(id, popup);
            return popup;
        }
    }

    /**
     * Force all popups to have a specific visibility value.
     * @param {boolean} value Whether or not the popups should be visible.
     * @param {number} priority The priority of the override.
     * @returns {Promise<import('core').TokenString>} A token which can be passed to clearAllVisibleOverride.
     * @throws An exception is thrown if any popup fails to have its visibiltiy overridden.
     */
    async setAllVisibleOverride(value, priority) {
        const promises = [];
        for (const popup of this._popups.values()) {
            const promise = this._setPopupVisibleOverrideReturnTuple(popup, value, priority);
            promises.push(promise);
        }

        /** @type {undefined|unknown} */
        let error = void 0;
        /** @type {{popup: import('popup').PopupAny, token: string}[]} */
        const results = [];
        for (const promise of promises) {
            try {
                const {popup, token} = await promise;
                if (token !== null) {
                    results.push({popup, token});
                }
            } catch (e) {
                if (typeof error === 'undefined') {
                    error = new Error(`Failed to set popup visibility override: ${e}`);
                }
            }
        }

        if (typeof error === 'undefined') {
            const token = generateId(16);
            this._allPopupVisibilityTokenMap.set(token, results);
            return token;
        }

        // Revert on error
        await this._revertPopupVisibilityOverrides(results);
        throw error;
    }

    /**
     * @param {import('popup').PopupAny} popup
     * @param {boolean} value
     * @param {number} priority
     * @returns {Promise<{popup: import('popup').PopupAny, token: ?string}>}
     */
    async _setPopupVisibleOverrideReturnTuple(popup, value, priority) {
        const token = await popup.setVisibleOverride(value, priority);
        return {popup, token};
    }

    /**
     * Clears a visibility override that was generated by `setAllVisibleOverride`.
     * @param {import('core').TokenString} token The token returned from `setAllVisibleOverride`.
     * @returns {Promise<boolean>} `true` if the override existed and was removed, `false` otherwise.
     */
    async clearAllVisibleOverride(token) {
        const results = this._allPopupVisibilityTokenMap.get(token);
        if (typeof results === 'undefined') { return false; }

        this._allPopupVisibilityTokenMap.delete(token);
        await this._revertPopupVisibilityOverrides(results);
        return true;
    }

    // API message handlers

    /** @type {import('cross-frame-api').ApiHandler<'popupFactoryGetOrCreatePopup'>} */
    async _onApiGetOrCreatePopup(details) {
        const popup = await this.getOrCreatePopup(details);
        return {
            id: popup.id,
            depth: popup.depth,
            frameId: popup.frameId
        };
    }

    /** @type {import('cross-frame-api').ApiHandler<'popupFactorySetOptionsContext'>} */
    async _onApiSetOptionsContext({id, optionsContext}) {
        const popup = this._getPopup(id);
        await popup.setOptionsContext(optionsContext);
    }

    /** @type {import('cross-frame-api').ApiHandler<'popupFactoryHide'>} */
    async _onApiHide({id, changeFocus}) {
        const popup = this._getPopup(id);
        await popup.hide(changeFocus);
    }

    /** @type {import('cross-frame-api').ApiHandler<'popupFactoryIsVisible'>} */
    async _onApiIsVisibleAsync({id}) {
        const popup = this._getPopup(id);
        return await popup.isVisible();
    }

    /** @type {import('cross-frame-api').ApiHandler<'popupFactorySetVisibleOverride'>} */
    async _onApiSetVisibleOverride({id, value, priority}) {
        const popup = this._getPopup(id);
        return await popup.setVisibleOverride(value, priority);
    }

    /** @type {import('cross-frame-api').ApiHandler<'popupFactoryClearVisibleOverride'>} */
    async _onApiClearVisibleOverride({id, token}) {
        const popup = this._getPopup(id);
        return await popup.clearVisibleOverride(token);
    }

    /** @type {import('cross-frame-api').ApiHandler<'popupFactoryContainsPoint'>} */
    async _onApiContainsPoint({id, x, y}) {
        const popup = this._getPopup(id);
        const offset = this._getPopupOffset(popup);
        x += offset.x;
        y += offset.y;
        return await popup.containsPoint(x, y);
    }

    /** @type {import('cross-frame-api').ApiHandler<'popupFactoryShowContent'>} */
    async _onApiShowContent({id, details, displayDetails}) {
        const popup = this._getPopup(id);
        if (!this._popupCanShow(popup)) { return; }

        const offset = this._getPopupOffset(popup);
        const {sourceRects} = details;
        for (const sourceRect of sourceRects) {
            sourceRect.left += offset.x;
            sourceRect.top += offset.y;
            sourceRect.right += offset.x;
            sourceRect.bottom += offset.y;
        }

        return await popup.showContent(details, displayDetails);
    }

    /** @type {import('cross-frame-api').ApiHandler<'popupFactorySetCustomCss'>} */
    async _onApiSetCustomCss({id, css}) {
        const popup = this._getPopup(id);
        await popup.setCustomCss(css);
    }

    /** @type {import('cross-frame-api').ApiHandler<'popupFactoryClearAutoPlayTimer'>} */
    async _onApiClearAutoPlayTimer({id}) {
        const popup = this._getPopup(id);
        await popup.clearAutoPlayTimer();
    }

    /** @type {import('cross-frame-api').ApiHandler<'popupFactorySetContentScale'>} */
    async _onApiSetContentScale({id, scale}) {
        const popup = this._getPopup(id);
        await popup.setContentScale(scale);
    }

    /** @type {import('cross-frame-api').ApiHandler<'popupFactoryUpdateTheme'>} */
    async _onApiUpdateTheme({id}) {
        const popup = this._getPopup(id);
        await popup.updateTheme();
    }

    /** @type {import('cross-frame-api').ApiHandler<'popupFactorySetCustomOuterCss'>} */
    async _onApiSetCustomOuterCss({id, css, useWebExtensionApi}) {
        const popup = this._getPopup(id);
        await popup.setCustomOuterCss(css, useWebExtensionApi);
    }

    /** @type {import('cross-frame-api').ApiHandler<'popupFactoryGetFrameSize'>} */
    async _onApiGetFrameSize({id}) {
        const popup = this._getPopup(id);
        return await popup.getFrameSize();
    }

    /** @type {import('cross-frame-api').ApiHandler<'popupFactorySetFrameSize'>} */
    async _onApiSetFrameSize({id, width, height}) {
        const popup = this._getPopup(id);
        return await popup.setFrameSize(width, height);
    }

    // Private functions

    /**
     * @param {string} id
     * @returns {import('popup').PopupAny}
     * @throws {Error}
     */
    _getPopup(id) {
        const popup = this._popups.get(id);
        if (typeof popup === 'undefined') {
            throw new Error(`Invalid popup ID ${id}`);
        }
        return popup;
    }

    /**
     * @param {import('popup').PopupAny} popup
     * @returns {{x: number, y: number}}
     */
    _getPopupOffset(popup) {
        const {parent} = popup;
        if (parent !== null) {
            const popupRect = parent.getFrameRect();
            if (popupRect.valid) {
                return {x: popupRect.left, y: popupRect.top};
            }
        }
        return {x: 0, y: 0};
    }

    /**
     * @param {import('popup').PopupAny} popup
     * @returns {boolean}
     */
    _popupCanShow(popup) {
        const parent = popup.parent;
        return parent === null || parent.isVisibleSync();
    }

    /**
     * @param {{popup: import('popup').PopupAny, token: string}[]} overrides
     * @returns {Promise<boolean[]>}
     */
    async _revertPopupVisibilityOverrides(overrides) {
        const promises = [];
        for (const value of overrides) {
            if (value === null) { continue; }
            const {popup, token} = value;
            const promise = popup.clearVisibleOverride(token)
                .then(
                    (v) => v,
                    () => false
                );
            promises.push(promise);
        }
        return await Promise.all(promises);
    }
}