mirror of
https://github.com/ksyasuda/SubMiner.git
synced 2026-02-27 18:22:41 -08:00
1055 lines
36 KiB
JavaScript
1055 lines
36 KiB
JavaScript
/*
|
|
* Copyright (C) 2023-2025 Yomitan Authors
|
|
* Copyright (C) 2016-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 {createApiMap, invokeApiMapHandler} from '../core/api-map.js';
|
|
import {EventListenerCollection} from '../core/event-listener-collection.js';
|
|
import {log} from '../core/log.js';
|
|
import {promiseAnimationFrame} from '../core/promise-animation-frame.js';
|
|
import {safePerformance} from '../core/safe-performance.js';
|
|
import {setProfile} from '../data/profiles-util.js';
|
|
import {addFullscreenChangeEventListener, getFullscreenElement} from '../dom/document-util.js';
|
|
import {TextSourceElement} from '../dom/text-source-element.js';
|
|
import {TextSourceGenerator} from '../dom/text-source-generator.js';
|
|
import {TextSourceRange} from '../dom/text-source-range.js';
|
|
import {TextScanner} from '../language/text-scanner.js';
|
|
|
|
/**
|
|
* This is the main class responsible for scanning and handling webpage content.
|
|
*/
|
|
export class Frontend {
|
|
/**
|
|
* Creates a new instance.
|
|
* @param {import('frontend').ConstructorDetails} details Details about how to set up the instance.
|
|
*/
|
|
constructor({
|
|
application,
|
|
pageType,
|
|
popupFactory,
|
|
depth,
|
|
parentPopupId,
|
|
parentFrameId,
|
|
useProxyPopup,
|
|
canUseWindowPopup = true,
|
|
allowRootFramePopupProxy,
|
|
childrenSupported = true,
|
|
hotkeyHandler,
|
|
}) {
|
|
/** @type {import('../application.js').Application} */
|
|
this._application = application;
|
|
/** @type {import('frontend').PageType} */
|
|
this._pageType = pageType;
|
|
/** @type {import('./popup-factory.js').PopupFactory} */
|
|
this._popupFactory = popupFactory;
|
|
/** @type {number} */
|
|
this._depth = depth;
|
|
/** @type {?string} */
|
|
this._parentPopupId = parentPopupId;
|
|
/** @type {?number} */
|
|
this._parentFrameId = parentFrameId;
|
|
/** @type {boolean} */
|
|
this._useProxyPopup = useProxyPopup;
|
|
/** @type {boolean} */
|
|
this._canUseWindowPopup = canUseWindowPopup;
|
|
/** @type {boolean} */
|
|
this._allowRootFramePopupProxy = allowRootFramePopupProxy;
|
|
/** @type {boolean} */
|
|
this._childrenSupported = childrenSupported;
|
|
/** @type {import('../input/hotkey-handler.js').HotkeyHandler} */
|
|
this._hotkeyHandler = hotkeyHandler;
|
|
/** @type {?import('popup').PopupAny} */
|
|
this._popup = null;
|
|
/** @type {boolean} */
|
|
this._disabledOverride = false;
|
|
/** @type {?import('settings').ProfileOptions} */
|
|
this._options = null;
|
|
/** @type {number} */
|
|
this._pageZoomFactor = 1;
|
|
/** @type {number} */
|
|
this._contentScale = 1;
|
|
/** @type {Promise<void>} */
|
|
this._lastShowPromise = Promise.resolve();
|
|
/** @type {TextSourceGenerator} */
|
|
this._textSourceGenerator = new TextSourceGenerator();
|
|
/** @type {TextScanner} */
|
|
this._textScanner = new TextScanner({
|
|
api: application.api,
|
|
node: window,
|
|
ignoreElements: this._ignoreElements.bind(this),
|
|
ignorePoint: this._ignorePoint.bind(this),
|
|
getSearchContext: this._getSearchContext.bind(this),
|
|
searchTerms: true,
|
|
searchKanji: true,
|
|
textSourceGenerator: this._textSourceGenerator,
|
|
});
|
|
/** @type {boolean} */
|
|
this._textScannerHasBeenEnabled = false;
|
|
/** @type {Map<'default'|'window'|'iframe'|'proxy', Promise<?import('popup').PopupAny>>} */
|
|
this._popupCache = new Map();
|
|
/** @type {EventListenerCollection} */
|
|
this._popupEventListeners = new EventListenerCollection();
|
|
/** @type {?import('core').TokenObject} */
|
|
this._updatePopupToken = null;
|
|
/** @type {?import('core').Timeout} */
|
|
this._clearSelectionTimer = null;
|
|
/** @type {boolean} */
|
|
this._isPointerOverPopup = false;
|
|
/** @type {?import('settings').OptionsContext} */
|
|
this._optionsContextOverride = null;
|
|
|
|
/* eslint-disable @stylistic/no-multi-spaces */
|
|
/** @type {import('application').ApiMap} */
|
|
this._runtimeApiMap = createApiMap([
|
|
['frontendRequestReadyBroadcast', this._onMessageRequestFrontendReadyBroadcast.bind(this)],
|
|
['frontendSetAllVisibleOverride', this._onApiSetAllVisibleOverride.bind(this)],
|
|
['frontendClearAllVisibleOverride', this._onApiClearAllVisibleOverride.bind(this)],
|
|
['frontendScanSelectedText', this._onApiScanSelectedText.bind(this)],
|
|
]);
|
|
|
|
this._hotkeyHandler.registerActions([
|
|
['scanSelectedText', this._onActionScanSelectedText.bind(this)],
|
|
['scanTextAtSelection', this._onActionScanTextAtSelection.bind(this)],
|
|
['scanTextAtCaret', this._onActionScanTextAtCaret.bind(this)],
|
|
['profilePrevious', async () => { await setProfile(-1, this._application); }],
|
|
['profileNext', async () => { await setProfile(1, this._application); }],
|
|
]);
|
|
/* eslint-enable @stylistic/no-multi-spaces */
|
|
}
|
|
|
|
/**
|
|
* Get whether or not the text selection can be cleared.
|
|
* @type {boolean}
|
|
*/
|
|
get canClearSelection() {
|
|
return this._textScanner.canClearSelection;
|
|
}
|
|
|
|
/**
|
|
* Set whether or not the text selection can be cleared.
|
|
* @param {boolean} value The new value to assign.
|
|
*/
|
|
set canClearSelection(value) {
|
|
this._textScanner.canClearSelection = value;
|
|
}
|
|
|
|
/**
|
|
* Gets the popup instance.
|
|
* @type {?import('popup').PopupAny}
|
|
*/
|
|
get popup() {
|
|
return this._popup;
|
|
}
|
|
|
|
/**
|
|
* Prepares the instance for use.
|
|
*/
|
|
async prepare() {
|
|
await this.updateOptions();
|
|
try {
|
|
const {zoomFactor} = await this._application.api.getZoom();
|
|
this._pageZoomFactor = zoomFactor;
|
|
} catch (e) {
|
|
// Ignore exceptions which may occur due to being on an unsupported page (e.g. about:blank)
|
|
}
|
|
|
|
this._textScanner.prepare();
|
|
|
|
window.addEventListener('resize', this._onResize.bind(this), false);
|
|
addFullscreenChangeEventListener(this._updatePopup.bind(this));
|
|
|
|
const {visualViewport} = window;
|
|
if (typeof visualViewport !== 'undefined' && visualViewport !== null) {
|
|
visualViewport.addEventListener('scroll', this._onVisualViewportScroll.bind(this));
|
|
visualViewport.addEventListener('resize', this._onVisualViewportResize.bind(this));
|
|
}
|
|
|
|
this._application.on('optionsUpdated', this.updateOptions.bind(this));
|
|
this._application.on('zoomChanged', this._onZoomChanged.bind(this));
|
|
this._application.on('closePopups', this._onClosePopups.bind(this));
|
|
chrome.runtime.onMessage.addListener(this._onRuntimeMessage.bind(this));
|
|
|
|
this._textScanner.on('clear', this._onTextScannerClear.bind(this));
|
|
this._textScanner.on('searchSuccess', this._onSearchSuccess.bind(this));
|
|
this._textScanner.on('searchEmpty', this._onSearchEmpty.bind(this));
|
|
this._textScanner.on('searchError', this._onSearchError.bind(this));
|
|
|
|
/* eslint-disable @stylistic/no-multi-spaces */
|
|
this._application.crossFrame.registerHandlers([
|
|
['frontendClosePopup', this._onApiClosePopup.bind(this)],
|
|
['frontendCopySelection', this._onApiCopySelection.bind(this)],
|
|
['frontendGetPopupSelectionText', this._onApiGetPopupSelectionText.bind(this)],
|
|
['frontendGetPopupInfo', this._onApiGetPopupInfo.bind(this)],
|
|
['frontendGetPageInfo', this._onApiGetPageInfo.bind(this)],
|
|
]);
|
|
/* eslint-enable @stylistic/no-multi-spaces */
|
|
|
|
this._prepareSiteSpecific();
|
|
this._updateContentScale();
|
|
this._signalFrontendReady(null);
|
|
}
|
|
|
|
/**
|
|
* Set whether or not the instance is disabled.
|
|
* @param {boolean} disabled Whether or not the instance is disabled.
|
|
*/
|
|
setDisabledOverride(disabled) {
|
|
this._disabledOverride = disabled;
|
|
this._updateTextScannerEnabled();
|
|
}
|
|
|
|
/**
|
|
* Set or clear an override options context object.
|
|
* @param {?import('settings').OptionsContext} optionsContext An options context object to use as the override, or `null` to clear the override.
|
|
*/
|
|
setOptionsContextOverride(optionsContext) {
|
|
this._optionsContextOverride = optionsContext;
|
|
}
|
|
|
|
/**
|
|
* Performs a new search on a specific source.
|
|
* @param {import('text-source').TextSource} textSource The text source to search.
|
|
*/
|
|
async setTextSource(textSource) {
|
|
this._textScanner.setCurrentTextSource(null);
|
|
await this._textScanner.search(textSource, null, false, true);
|
|
}
|
|
|
|
/**
|
|
* Updates the internal options representation.
|
|
*/
|
|
async updateOptions() {
|
|
try {
|
|
await this._updateOptionsInternal();
|
|
} catch (e) {
|
|
if (!this._application.webExtension.unloaded) {
|
|
throw e;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Waits for the previous `showContent` call to be completed.
|
|
* @returns {Promise<void>} A promise which is resolved when the previous `showContent` call has completed.
|
|
*/
|
|
showContentCompleted() {
|
|
return this._lastShowPromise;
|
|
}
|
|
|
|
// Message handlers
|
|
|
|
/** @type {import('application').ApiHandler<'frontendRequestReadyBroadcast'>} */
|
|
_onMessageRequestFrontendReadyBroadcast({frameId}) {
|
|
this._signalFrontendReady(frameId);
|
|
}
|
|
|
|
// Action handlers
|
|
|
|
/**
|
|
* @returns {void}
|
|
*/
|
|
_onActionScanSelectedText() {
|
|
void this._scanSelectedText(false, true);
|
|
}
|
|
|
|
/**
|
|
* @returns {void}
|
|
*/
|
|
_onApiScanSelectedText() {
|
|
void this._scanSelectedText(false, true, true);
|
|
}
|
|
|
|
/**
|
|
* @returns {void}
|
|
*/
|
|
_onActionScanTextAtSelection() {
|
|
void this._scanSelectedText(false, false);
|
|
}
|
|
|
|
/**
|
|
* @returns {void}
|
|
*/
|
|
_onActionScanTextAtCaret() {
|
|
void this._scanSelectedText(true, false);
|
|
}
|
|
|
|
// API message handlers
|
|
|
|
/** @type {import('cross-frame-api').ApiHandler<'frontendClosePopup'>} */
|
|
_onApiClosePopup() {
|
|
this._clearSelection(false);
|
|
}
|
|
|
|
/** @type {import('cross-frame-api').ApiHandler<'frontendCopySelection'>} */
|
|
_onApiCopySelection() {
|
|
// This will not work on Firefox if a popup has focus, which is usually the case when this function is called.
|
|
document.execCommand('copy');
|
|
}
|
|
|
|
/** @type {import('cross-frame-api').ApiHandler<'frontendGetPopupSelectionText'>} */
|
|
_onApiGetPopupSelectionText() {
|
|
const selection = document.getSelection();
|
|
return selection !== null ? selection.toString() : '';
|
|
}
|
|
|
|
/** @type {import('cross-frame-api').ApiHandler<'frontendGetPopupInfo'>} */
|
|
_onApiGetPopupInfo() {
|
|
return {
|
|
popupId: (this._popup !== null ? this._popup.id : null),
|
|
};
|
|
}
|
|
|
|
/** @type {import('cross-frame-api').ApiHandler<'frontendGetPageInfo'>} */
|
|
_onApiGetPageInfo() {
|
|
return {
|
|
url: window.location.href,
|
|
documentTitle: document.title,
|
|
};
|
|
}
|
|
|
|
/** @type {import('application').ApiHandler<'frontendSetAllVisibleOverride'>} */
|
|
async _onApiSetAllVisibleOverride({value, priority, awaitFrame}) {
|
|
const result = await this._popupFactory.setAllVisibleOverride(value, priority);
|
|
if (awaitFrame) {
|
|
await promiseAnimationFrame(100);
|
|
}
|
|
return result;
|
|
}
|
|
|
|
/** @type {import('application').ApiHandler<'frontendClearAllVisibleOverride'>} */
|
|
async _onApiClearAllVisibleOverride({token}) {
|
|
return await this._popupFactory.clearAllVisibleOverride(token);
|
|
}
|
|
|
|
// Private
|
|
|
|
/**
|
|
* @returns {void}
|
|
*/
|
|
_onResize() {
|
|
void this._updatePopupPosition();
|
|
}
|
|
|
|
/** @type {import('extension').ChromeRuntimeOnMessageCallback<import('application').ApiMessageAny>} */
|
|
_onRuntimeMessage({action, params}, _sender, callback) {
|
|
return invokeApiMapHandler(this._runtimeApiMap, action, params, [], callback);
|
|
}
|
|
|
|
/**
|
|
* @param {{newZoomFactor: number}} params
|
|
*/
|
|
_onZoomChanged({newZoomFactor}) {
|
|
this._pageZoomFactor = newZoomFactor;
|
|
this._updateContentScale();
|
|
}
|
|
|
|
/**
|
|
* @returns {void}
|
|
*/
|
|
_onClosePopups() {
|
|
this._clearSelection(true);
|
|
this._clearMousePosition();
|
|
}
|
|
|
|
/**
|
|
* @returns {void}
|
|
*/
|
|
_onVisualViewportScroll() {
|
|
void this._updatePopupPosition();
|
|
}
|
|
|
|
/**
|
|
* @returns {void}
|
|
*/
|
|
_onVisualViewportResize() {
|
|
this._updateContentScale();
|
|
}
|
|
|
|
/**
|
|
* @returns {void}
|
|
*/
|
|
_onTextScannerClear() {
|
|
this._clearSelection(false);
|
|
}
|
|
|
|
/**
|
|
* @param {import('text-scanner').EventArgument<'searchSuccess'>} details
|
|
*/
|
|
_onSearchSuccess({type, dictionaryEntries, sentence, inputInfo: {eventType, detail: inputInfoDetail}, textSource, optionsContext, detail, pageTheme}) {
|
|
this._stopClearSelectionDelayed();
|
|
let focus = (eventType === 'mouseMove');
|
|
if (typeof inputInfoDetail === 'object' && inputInfoDetail !== null) {
|
|
const focus2 = inputInfoDetail.focus;
|
|
if (typeof focus2 === 'boolean') { focus = focus2; }
|
|
}
|
|
this._showContent(textSource, focus, dictionaryEntries, type, sentence, detail !== null ? detail.documentTitle : null, optionsContext, pageTheme);
|
|
}
|
|
|
|
/** */
|
|
_onSearchEmpty() {
|
|
const scanningOptions = /** @type {import('settings').ProfileOptions} */ (this._options).scanning;
|
|
if (scanningOptions.autoHideResults) {
|
|
void this._clearSelectionDelayed(scanningOptions.hideDelay, false, false);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param {import('text-scanner').EventArgument<'searchError'>} details
|
|
*/
|
|
_onSearchError({error, textSource, inputInfo: {passive}}) {
|
|
if (this._application.webExtension.unloaded) {
|
|
if (textSource !== null && !passive) {
|
|
this._showExtensionUnloaded(textSource);
|
|
}
|
|
} else {
|
|
log.error(error);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @returns {void}
|
|
*/
|
|
_onPopupFramePointerOver() {
|
|
this._isPointerOverPopup = true;
|
|
}
|
|
|
|
/**
|
|
* @returns {void}
|
|
*/
|
|
_onPopupFramePointerOut() {
|
|
this._isPointerOverPopup = false;
|
|
if (!this._options) { return; }
|
|
const {scanning: {hidePopupOnCursorExit, hidePopupOnCursorExitDelay}} = this._options;
|
|
if (hidePopupOnCursorExit) {
|
|
void this._clearSelectionDelayed(hidePopupOnCursorExitDelay, false, false);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param {boolean} passive
|
|
*/
|
|
_clearSelection(passive) {
|
|
this._stopClearSelectionDelayed();
|
|
if (this._popup !== null) {
|
|
void this._popup.clearAutoPlayTimer();
|
|
void this._popup.hide(!passive);
|
|
this._isPointerOverPopup = false;
|
|
}
|
|
this._textScanner.clearSelection();
|
|
}
|
|
|
|
/** */
|
|
_clearMousePosition() {
|
|
this._textScanner.clearMousePosition();
|
|
}
|
|
|
|
/**
|
|
* Checks if the pointer is over any popup in the hierarchy (parent or child popups).
|
|
* @returns {Promise<boolean>}
|
|
* @private
|
|
*/
|
|
async _isPointerOverAnyPopup() {
|
|
if (this._isPointerOverPopup) {
|
|
return true;
|
|
}
|
|
|
|
let childPopup = this._popup?.child;
|
|
while (typeof childPopup !== 'undefined' && childPopup !== null) {
|
|
try {
|
|
const isOver = childPopup.isPointerOver();
|
|
if (isOver) {
|
|
return true;
|
|
}
|
|
childPopup = childPopup.child;
|
|
} catch (e) {
|
|
log.warn(new Error('Error checking child popup pointer state'));
|
|
}
|
|
}
|
|
|
|
let parentPopup = this._popup?.parent;
|
|
while (typeof parentPopup !== 'undefined' && parentPopup !== null) {
|
|
try {
|
|
const isOver = parentPopup.isPointerOver();
|
|
if (isOver) {
|
|
return true;
|
|
}
|
|
parentPopup = parentPopup.parent;
|
|
} catch (e) {
|
|
log.warn(new Error('Error checking parent popup pointer state'));
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* @param {number} delay
|
|
* @param {boolean} restart
|
|
* @param {boolean} passive
|
|
*/
|
|
async _clearSelectionDelayed(delay, restart, passive) {
|
|
if (!this._textScanner.hasSelection()) { return; }
|
|
|
|
// Add a small delay to allow mouseover events to be processed
|
|
await new Promise((resolve) => {
|
|
setTimeout(resolve, 50);
|
|
});
|
|
|
|
// Always check if pointer is over any popup before clearing
|
|
if (await this._isPointerOverAnyPopup()) { return; }
|
|
|
|
if (delay > 0) {
|
|
if (this._clearSelectionTimer !== null && !restart) { return; } // Already running
|
|
this._stopClearSelectionDelayed();
|
|
this._clearSelectionTimer = setTimeout(async () => {
|
|
this._clearSelectionTimer = null;
|
|
if (await this._isPointerOverAnyPopup()) { return; }
|
|
this._clearSelection(passive);
|
|
}, delay);
|
|
} else {
|
|
this._clearSelection(passive);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @returns {void}
|
|
*/
|
|
_stopClearSelectionDelayed() {
|
|
if (this._clearSelectionTimer !== null) {
|
|
clearTimeout(this._clearSelectionTimer);
|
|
this._clearSelectionTimer = null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @returns {Promise<void>}
|
|
*/
|
|
async _updateOptionsInternal() {
|
|
const optionsContext = await this._getOptionsContext();
|
|
const options = await this._application.api.optionsGet(optionsContext);
|
|
const {scanning: scanningOptions, sentenceParsing: sentenceParsingOptions} = options;
|
|
this._options = options;
|
|
|
|
this._hotkeyHandler.setHotkeys('web', options.inputs.hotkeys);
|
|
|
|
await this._updatePopup();
|
|
|
|
const preventMiddleMouseOnPage = this._getPreventSecondaryMouseValueForPageType(scanningOptions.preventMiddleMouse);
|
|
const preventMiddleMouseOnTextHover = scanningOptions.preventMiddleMouse.onTextHover;
|
|
const preventBackForwardOnPage = this._getPreventSecondaryMouseValueForPageType(scanningOptions.preventBackForward);
|
|
const preventBackForwardOnTextHover = scanningOptions.preventBackForward.onTextHover;
|
|
this._textScanner.language = options.general.language;
|
|
this._textScanner.setOptions({
|
|
inputs: scanningOptions.inputs,
|
|
deepContentScan: scanningOptions.deepDomScan,
|
|
normalizeCssZoom: scanningOptions.normalizeCssZoom,
|
|
selectText: scanningOptions.selectText,
|
|
delay: scanningOptions.delay,
|
|
scanLength: scanningOptions.length,
|
|
layoutAwareScan: scanningOptions.layoutAwareScan,
|
|
preventMiddleMouseOnPage,
|
|
preventMiddleMouseOnTextHover,
|
|
preventBackForwardOnPage,
|
|
preventBackForwardOnTextHover,
|
|
sentenceParsingOptions,
|
|
scanWithoutMousemove: scanningOptions.scanWithoutMousemove,
|
|
scanResolution: scanningOptions.scanResolution,
|
|
});
|
|
this._updateTextScannerEnabled();
|
|
|
|
if (this._pageType !== 'web') {
|
|
const excludeSelectors = ['.scan-disable', '.scan-disable *'];
|
|
if (!scanningOptions.enableOnPopupExpressions) {
|
|
excludeSelectors.push('.source-text', '.source-text *');
|
|
}
|
|
this._textScanner.excludeSelector = excludeSelectors.join(',');
|
|
this._textScanner.touchEventExcludeSelector = '.gloss-link, .gloss-link *, .tag, .tag *, .inflection';
|
|
}
|
|
|
|
this._updateContentScale();
|
|
|
|
await this._textScanner.searchLast();
|
|
}
|
|
|
|
/**
|
|
* @returns {Promise<void>}
|
|
*/
|
|
async _updatePopup() {
|
|
const {usePopupWindow, showIframePopupsInRootFrame} = /** @type {import('settings').ProfileOptions} */ (this._options).general;
|
|
const isIframe = !this._useProxyPopup && (window !== window.parent);
|
|
|
|
const currentPopup = this._popup;
|
|
|
|
/** @type {Promise<?import('popup').PopupAny>|undefined} */
|
|
let popupPromise;
|
|
if (usePopupWindow && this._canUseWindowPopup) {
|
|
popupPromise = this._popupCache.get('window');
|
|
if (typeof popupPromise === 'undefined') {
|
|
popupPromise = this._getPopupWindow();
|
|
this._popupCache.set('window', popupPromise);
|
|
}
|
|
} else if (
|
|
isIframe &&
|
|
showIframePopupsInRootFrame &&
|
|
getFullscreenElement() === null &&
|
|
this._allowRootFramePopupProxy
|
|
) {
|
|
popupPromise = this._popupCache.get('iframe');
|
|
if (typeof popupPromise === 'undefined') {
|
|
popupPromise = this._getIframeProxyPopup();
|
|
this._popupCache.set('iframe', popupPromise);
|
|
}
|
|
} else if (this._useProxyPopup) {
|
|
popupPromise = this._popupCache.get('proxy');
|
|
if (typeof popupPromise === 'undefined') {
|
|
popupPromise = this._getProxyPopup();
|
|
this._popupCache.set('proxy', popupPromise);
|
|
}
|
|
} else {
|
|
popupPromise = this._popupCache.get('default');
|
|
if (typeof popupPromise === 'undefined') {
|
|
popupPromise = this._getDefaultPopup();
|
|
this._popupCache.set('default', popupPromise);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* The token below is used as a unique identifier to ensure that a new _updatePopup call
|
|
* hasn't been started during the await.
|
|
* @type {?import('core').TokenObject}
|
|
*/
|
|
const token = {};
|
|
this._updatePopupToken = token;
|
|
const popup = await popupPromise;
|
|
const optionsContext = await this._getOptionsContext();
|
|
if (this._updatePopupToken !== token) { return; }
|
|
if (popup !== null) {
|
|
await popup.setOptionsContext(optionsContext);
|
|
}
|
|
if (this._updatePopupToken !== token) { return; }
|
|
|
|
if (popup !== currentPopup) {
|
|
this._clearSelection(true);
|
|
}
|
|
|
|
this._popupEventListeners.removeAllEventListeners();
|
|
this._popup = popup;
|
|
if (popup !== null) {
|
|
this._popupEventListeners.on(popup, 'mouseOver', this._onPopupFramePointerOver.bind(this));
|
|
this._popupEventListeners.on(popup, 'mouseOut', this._onPopupFramePointerOut.bind(this));
|
|
}
|
|
this._isPointerOverPopup = false;
|
|
}
|
|
|
|
/**
|
|
* @returns {Promise<?import('popup').PopupAny>}
|
|
*/
|
|
async _getDefaultPopup() {
|
|
const isXmlDocument = (typeof XMLDocument !== 'undefined' && document instanceof XMLDocument);
|
|
if (isXmlDocument) {
|
|
return null;
|
|
}
|
|
|
|
const {frameId} = this._application;
|
|
if (frameId === null) {
|
|
return null;
|
|
}
|
|
|
|
return await this._popupFactory.getOrCreatePopup({
|
|
frameId,
|
|
depth: this._depth,
|
|
childrenSupported: this._childrenSupported,
|
|
});
|
|
}
|
|
|
|
/**
|
|
* @returns {Promise<import('popup').PopupAny>}
|
|
*/
|
|
async _getProxyPopup() {
|
|
return await this._popupFactory.getOrCreatePopup({
|
|
frameId: this._parentFrameId,
|
|
depth: this._depth,
|
|
parentPopupId: this._parentPopupId,
|
|
childrenSupported: this._childrenSupported,
|
|
});
|
|
}
|
|
|
|
/**
|
|
* @returns {Promise<?import('popup').PopupAny>}
|
|
*/
|
|
async _getIframeProxyPopup() {
|
|
const targetFrameId = 0; // Root frameId
|
|
try {
|
|
await this._waitForFrontendReady(targetFrameId, 10000);
|
|
} catch (e) {
|
|
// Root frame not available
|
|
return await this._getDefaultPopup();
|
|
}
|
|
|
|
const {popupId} = await this._application.crossFrame.invoke(targetFrameId, 'frontendGetPopupInfo', void 0);
|
|
if (popupId === null) {
|
|
return null;
|
|
}
|
|
|
|
const popup = await this._popupFactory.getOrCreatePopup({
|
|
frameId: targetFrameId,
|
|
id: popupId,
|
|
childrenSupported: this._childrenSupported,
|
|
});
|
|
popup.on('offsetNotFound', () => {
|
|
this._allowRootFramePopupProxy = false;
|
|
void this._updatePopup();
|
|
});
|
|
return popup;
|
|
}
|
|
|
|
/**
|
|
* @returns {Promise<import('popup').PopupAny>}
|
|
*/
|
|
async _getPopupWindow() {
|
|
return await this._popupFactory.getOrCreatePopup({
|
|
depth: this._depth,
|
|
popupWindow: true,
|
|
childrenSupported: this._childrenSupported,
|
|
});
|
|
}
|
|
|
|
/**
|
|
* @returns {Element[]}
|
|
*/
|
|
_ignoreElements() {
|
|
if (this._popup !== null) {
|
|
const container = this._popup.container;
|
|
if (container !== null) {
|
|
return [container];
|
|
}
|
|
}
|
|
return [];
|
|
}
|
|
|
|
/**
|
|
* @param {number} x
|
|
* @param {number} y
|
|
* @returns {Promise<boolean>}
|
|
*/
|
|
async _ignorePoint(x, y) {
|
|
try {
|
|
return this._popup !== null && await this._popup.containsPoint(x, y);
|
|
} catch (e) {
|
|
if (!this._application.webExtension.unloaded) {
|
|
throw e;
|
|
}
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param {import('text-source').TextSource} textSource
|
|
*/
|
|
_showExtensionUnloaded(textSource) {
|
|
void this._showPopupContent(textSource, null, null);
|
|
}
|
|
|
|
/**
|
|
* @param {import('text-source').TextSource} textSource
|
|
* @param {boolean} focus
|
|
* @param {?import('dictionary').DictionaryEntry[]} dictionaryEntries
|
|
* @param {import('display').PageType} type
|
|
* @param {?import('display').HistoryStateSentence} sentence
|
|
* @param {?string} documentTitle
|
|
* @param {import('settings').OptionsContext} optionsContext
|
|
* @param {'dark' | 'light'} pageTheme
|
|
*/
|
|
_showContent(textSource, focus, dictionaryEntries, type, sentence, documentTitle, optionsContext, pageTheme) {
|
|
const query = textSource.text();
|
|
const {url} = optionsContext;
|
|
/** @type {import('display').HistoryState} */
|
|
const detailsState = {
|
|
focusEntry: 0,
|
|
optionsContext,
|
|
url,
|
|
pageTheme,
|
|
};
|
|
if (sentence !== null) { detailsState.sentence = sentence; }
|
|
if (documentTitle !== null) { detailsState.documentTitle = documentTitle; }
|
|
const {tabId, frameId} = this._application;
|
|
/** @type {import('display').HistoryContent} */
|
|
const detailsContent = {
|
|
contentOrigin: {tabId, frameId},
|
|
};
|
|
if (dictionaryEntries !== null) {
|
|
detailsContent.dictionaryEntries = dictionaryEntries;
|
|
}
|
|
/** @type {import('display').ContentDetails} */
|
|
const details = {
|
|
focus,
|
|
historyMode: 'clear',
|
|
params: {
|
|
type,
|
|
query,
|
|
wildcards: 'off',
|
|
},
|
|
state: detailsState,
|
|
content: detailsContent,
|
|
};
|
|
if (textSource instanceof TextSourceElement && textSource.fullContent !== query) {
|
|
details.params.full = textSource.fullContent;
|
|
details.params['full-visible'] = 'true';
|
|
}
|
|
void this._showPopupContent(textSource, optionsContext, details);
|
|
}
|
|
|
|
/**
|
|
* @param {import('text-source').TextSource} textSource
|
|
* @param {?import('settings').OptionsContext} optionsContext
|
|
* @param {?import('display').ContentDetails} details
|
|
* @returns {Promise<void>}
|
|
*/
|
|
_showPopupContent(textSource, optionsContext, details) {
|
|
const sourceRects = [];
|
|
for (const {left, top, right, bottom} of textSource.getRects()) {
|
|
sourceRects.push({left, top, right, bottom});
|
|
}
|
|
this._lastShowPromise = (
|
|
this._popup !== null ?
|
|
this._popup.showContent(
|
|
{
|
|
optionsContext,
|
|
sourceRects,
|
|
writingMode: textSource.getWritingMode(),
|
|
},
|
|
details,
|
|
) :
|
|
Promise.resolve()
|
|
);
|
|
this._lastShowPromise.catch((error) => {
|
|
if (this._application.webExtension.unloaded) { return; }
|
|
log.error(error);
|
|
});
|
|
return this._lastShowPromise;
|
|
}
|
|
|
|
/**
|
|
* @returns {void}
|
|
*/
|
|
_updateTextScannerEnabled() {
|
|
const enabled = (this._options !== null && this._options.general.enable && !this._disabledOverride);
|
|
if (enabled === this._textScanner.isEnabled()) { return; }
|
|
this._textScanner.setEnabled(enabled);
|
|
if (this._textScannerHasBeenEnabled) {
|
|
this._clearSelection(true);
|
|
}
|
|
if (enabled) {
|
|
this._textScannerHasBeenEnabled = true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @returns {void}
|
|
*/
|
|
_updateContentScale() {
|
|
const {popupScalingFactor, popupScaleRelativeToPageZoom, popupScaleRelativeToVisualViewport} = /** @type {import('settings').ProfileOptions} */ (this._options).general;
|
|
let contentScale = popupScalingFactor;
|
|
if (popupScaleRelativeToPageZoom) {
|
|
contentScale /= this._pageZoomFactor;
|
|
}
|
|
if (popupScaleRelativeToVisualViewport) {
|
|
const {visualViewport} = window;
|
|
const visualViewportScale = (typeof visualViewport !== 'undefined' && visualViewport !== null ? visualViewport.scale : 1);
|
|
contentScale /= visualViewportScale;
|
|
}
|
|
if (contentScale === this._contentScale) { return; }
|
|
|
|
this._contentScale = contentScale;
|
|
if (this._popup !== null) {
|
|
void this._popup.setContentScale(this._contentScale);
|
|
}
|
|
void this._updatePopupPosition();
|
|
}
|
|
|
|
/**
|
|
* @returns {Promise<void>}
|
|
*/
|
|
async _updatePopupPosition() {
|
|
const textSource = this._textScanner.getCurrentTextSource();
|
|
if (
|
|
textSource !== null &&
|
|
this._popup !== null &&
|
|
await this._popup.isVisible()
|
|
) {
|
|
void this._showPopupContent(textSource, null, null);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param {?number} targetFrameId
|
|
*/
|
|
_signalFrontendReady(targetFrameId) {
|
|
/** @type {import('application').ApiMessageNoFrameId<'frontendReady'>} */
|
|
const message = {action: 'frontendReady', params: {frameId: this._application.frameId}};
|
|
if (targetFrameId === null) {
|
|
void this._application.api.broadcastTab(message);
|
|
} else {
|
|
void this._application.api.sendMessageToFrame(targetFrameId, message);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param {number} frameId
|
|
* @param {?number} timeout
|
|
* @returns {Promise<void>}
|
|
*/
|
|
async _waitForFrontendReady(frameId, timeout) {
|
|
return new Promise((resolve, reject) => {
|
|
/** @type {?import('core').Timeout} */
|
|
let timeoutId = null;
|
|
|
|
const cleanup = () => {
|
|
if (timeoutId !== null) {
|
|
clearTimeout(timeoutId);
|
|
timeoutId = null;
|
|
}
|
|
chrome.runtime.onMessage.removeListener(onMessage);
|
|
};
|
|
/** @type {import('extension').ChromeRuntimeOnMessageCallback<import('application').ApiMessageAny>} */
|
|
const onMessage = (message, _sender, sendResponse) => {
|
|
try {
|
|
const {action} = message;
|
|
if (action === 'frontendReady' && message.params.frameId === frameId) {
|
|
cleanup();
|
|
resolve();
|
|
sendResponse();
|
|
}
|
|
} catch (e) {
|
|
// NOP
|
|
}
|
|
};
|
|
|
|
if (timeout !== null) {
|
|
timeoutId = setTimeout(() => {
|
|
timeoutId = null;
|
|
cleanup();
|
|
reject(new Error(`Wait for frontend ready timed out after ${timeout}ms`));
|
|
}, timeout);
|
|
}
|
|
|
|
chrome.runtime.onMessage.addListener(onMessage);
|
|
void this._application.api.broadcastTab({action: 'frontendRequestReadyBroadcast', params: {frameId: this._application.frameId}});
|
|
});
|
|
}
|
|
|
|
/**
|
|
* @param {import('settings').PreventSecondaryMouseOptions} preventSecondaryMouseOptions
|
|
* @returns {boolean}
|
|
*/
|
|
_getPreventSecondaryMouseValueForPageType(preventSecondaryMouseOptions) {
|
|
switch (this._pageType) {
|
|
case 'web': return preventSecondaryMouseOptions.onWebPages;
|
|
case 'popup': return preventSecondaryMouseOptions.onPopupPages;
|
|
case 'search': return preventSecondaryMouseOptions.onSearchPages;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @returns {Promise<import('settings').OptionsContext>}
|
|
*/
|
|
async _getOptionsContext() {
|
|
let optionsContext = this._optionsContextOverride;
|
|
if (optionsContext === null) {
|
|
optionsContext = (await this._getSearchContext()).optionsContext;
|
|
}
|
|
return optionsContext;
|
|
}
|
|
|
|
/**
|
|
* @returns {Promise<import('text-scanner').SearchContext>}
|
|
*/
|
|
async _getSearchContext() {
|
|
let url = window.location.href;
|
|
let documentTitle = document.title;
|
|
if (this._useProxyPopup && this._parentFrameId !== null) {
|
|
try {
|
|
({url, documentTitle} = await this._application.crossFrame.invoke(this._parentFrameId, 'frontendGetPageInfo', void 0));
|
|
} catch (e) {
|
|
// NOP
|
|
}
|
|
}
|
|
|
|
let optionsContext = this._optionsContextOverride;
|
|
if (optionsContext === null) {
|
|
optionsContext = {depth: this._depth, url};
|
|
}
|
|
|
|
return {
|
|
optionsContext,
|
|
detail: {documentTitle},
|
|
};
|
|
}
|
|
|
|
/**
|
|
* @param {boolean} allowEmptyRange
|
|
* @param {boolean} disallowExpandSelection
|
|
* @param {boolean} showEmpty show empty popup if no results are found
|
|
* @returns {Promise<boolean>}
|
|
*/
|
|
async _scanSelectedText(allowEmptyRange, disallowExpandSelection, showEmpty = false) {
|
|
safePerformance.mark('frontend:scanSelectedText:start');
|
|
const range = this._getFirstSelectionRange(allowEmptyRange);
|
|
if (range === null) { return false; }
|
|
const source = disallowExpandSelection ? TextSourceRange.createLazy(range) : TextSourceRange.create(range);
|
|
await this._textScanner.search(source, {focus: true, restoreSelection: true}, showEmpty);
|
|
safePerformance.mark('frontend:scanSelectedText:end');
|
|
safePerformance.measure('frontend:scanSelectedText', 'frontend:scanSelectedText:start', 'frontend:scanSelectedText:end');
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param {boolean} allowEmptyRange
|
|
* @returns {?Range}
|
|
*/
|
|
_getFirstSelectionRange(allowEmptyRange) {
|
|
const selection = window.getSelection();
|
|
if (selection === null) { return null; }
|
|
for (let i = 0, ii = selection.rangeCount; i < ii; ++i) {
|
|
const range = selection.getRangeAt(i);
|
|
if (range.toString().length > 0 || allowEmptyRange) {
|
|
return range;
|
|
}
|
|
}
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* @returns {void}
|
|
*/
|
|
_prepareSiteSpecific() {
|
|
switch (location.hostname.toLowerCase()) {
|
|
case 'docs.google.com':
|
|
void this._prepareGoogleDocs();
|
|
break;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @returns {Promise<void>}
|
|
*/
|
|
async _prepareGoogleDocs() {
|
|
const {GoogleDocsUtil} = await import('../accessibility/google-docs-util.js');
|
|
const googleDocsUtil = new GoogleDocsUtil();
|
|
this._textSourceGenerator.registerGetRangeFromPointHandler(googleDocsUtil.getRangeFromPoint.bind(googleDocsUtil));
|
|
}
|
|
}
|