08ada6844a
* Make Frontend use composition instead of inheritance for TextScanner * Use push instead of concat * Update setOptions and setEnabled APIs * Update how onWindowMessage event listener is added/removed * Rename options to _options * Use bind instead of arrow function * Fix selection being cleared due to settings changes
329 lines
11 KiB
JavaScript
329 lines
11 KiB
JavaScript
/*
|
|
* Copyright (C) 2016-2020 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/>.
|
|
*/
|
|
|
|
/* global
|
|
* TextScanner
|
|
* apiBroadcastTab
|
|
* apiGetZoom
|
|
* apiKanjiFind
|
|
* apiOptionsGet
|
|
* apiTermsFind
|
|
* docSentenceExtract
|
|
*/
|
|
|
|
class Frontend {
|
|
constructor(popup, getUrl=null) {
|
|
this._id = yomichan.generateId(16);
|
|
|
|
this.popup = popup;
|
|
|
|
this._getUrl = getUrl;
|
|
|
|
this._disabledOverride = false;
|
|
|
|
this._options = null;
|
|
|
|
this._pageZoomFactor = 1.0;
|
|
this._contentScale = 1.0;
|
|
this._orphaned = false;
|
|
this._lastShowPromise = Promise.resolve();
|
|
|
|
this._enabledEventListeners = new EventListenerCollection();
|
|
this._textScanner = new TextScanner(
|
|
window,
|
|
() => this.popup.isProxy() ? [] : [this.popup.getContainer()],
|
|
[(x, y) => this.popup.containsPoint(x, y)]
|
|
);
|
|
this._textScanner.onSearchSource = this.onSearchSource.bind(this);
|
|
|
|
this._windowMessageHandlers = new Map([
|
|
['popupClose', () => this._textScanner.clearSelection(false)],
|
|
['selectionCopy', () => document.execCommand('copy')]
|
|
]);
|
|
|
|
this._runtimeMessageHandlers = new Map([
|
|
['popupSetVisibleOverride', ({visible}) => { this.popup.setVisibleOverride(visible); }],
|
|
['rootPopupRequestInformationBroadcast', () => { this._broadcastRootPopupInformation(); }],
|
|
['requestDocumentInformationBroadcast', ({uniqueId}) => { this._broadcastDocumentInformation(uniqueId); }]
|
|
]);
|
|
}
|
|
|
|
get canClearSelection() {
|
|
return this._textScanner.canClearSelection;
|
|
}
|
|
|
|
set canClearSelection(value) {
|
|
this._textScanner.canClearSelection = value;
|
|
}
|
|
|
|
async prepare() {
|
|
try {
|
|
await this.updateOptions();
|
|
const {zoomFactor} = await apiGetZoom();
|
|
this._pageZoomFactor = zoomFactor;
|
|
|
|
window.addEventListener('resize', this.onResize.bind(this), false);
|
|
|
|
const visualViewport = window.visualViewport;
|
|
if (visualViewport !== null && typeof visualViewport === 'object') {
|
|
window.visualViewport.addEventListener('scroll', this.onVisualViewportScroll.bind(this));
|
|
window.visualViewport.addEventListener('resize', this.onVisualViewportResize.bind(this));
|
|
}
|
|
|
|
yomichan.on('orphaned', this.onOrphaned.bind(this));
|
|
yomichan.on('optionsUpdated', this.updateOptions.bind(this));
|
|
yomichan.on('zoomChanged', this.onZoomChanged.bind(this));
|
|
chrome.runtime.onMessage.addListener(this.onRuntimeMessage.bind(this));
|
|
|
|
this._textScanner.on('clearSelection', this.onClearSelection.bind(this));
|
|
|
|
this._updateContentScale();
|
|
this._broadcastRootPopupInformation();
|
|
} catch (e) {
|
|
yomichan.logError(e);
|
|
}
|
|
}
|
|
|
|
onResize() {
|
|
this._updatePopupPosition();
|
|
}
|
|
|
|
onWindowMessage(e) {
|
|
const action = e.data;
|
|
const handler = this._windowMessageHandlers.get(action);
|
|
if (typeof handler !== 'function') { return false; }
|
|
|
|
handler();
|
|
}
|
|
|
|
onRuntimeMessage({action, params}, sender, callback) {
|
|
const {targetPopupId} = params || {};
|
|
if (typeof targetPopupId !== 'undefined' && targetPopupId !== this.popup.id) { return; }
|
|
|
|
const handler = this._runtimeMessageHandlers.get(action);
|
|
if (typeof handler !== 'function') { return false; }
|
|
|
|
const result = handler(params, sender);
|
|
callback(result);
|
|
return false;
|
|
}
|
|
|
|
onOrphaned() {
|
|
this._orphaned = true;
|
|
}
|
|
|
|
onZoomChanged({newZoomFactor}) {
|
|
this._pageZoomFactor = newZoomFactor;
|
|
this._updateContentScale();
|
|
}
|
|
|
|
onVisualViewportScroll() {
|
|
this._updatePopupPosition();
|
|
}
|
|
|
|
onVisualViewportResize() {
|
|
this._updateContentScale();
|
|
}
|
|
|
|
setDisabledOverride(disabled) {
|
|
this._disabledOverride = disabled;
|
|
this._updateTextScannerEnabled();
|
|
}
|
|
|
|
async setPopup(popup) {
|
|
this._textScanner.clearSelection(true);
|
|
this.popup = popup;
|
|
await popup.setOptionsContext(await this.getOptionsContext(), this._id);
|
|
}
|
|
|
|
async updateOptions() {
|
|
const optionsContext = await this.getOptionsContext();
|
|
this._options = await apiOptionsGet(optionsContext);
|
|
this._textScanner.setOptions(this._options);
|
|
this._updateTextScannerEnabled();
|
|
|
|
const ignoreNodes = ['.scan-disable', '.scan-disable *'];
|
|
if (!this._options.scanning.enableOnPopupExpressions) {
|
|
ignoreNodes.push('.source-text', '.source-text *');
|
|
}
|
|
this._textScanner.ignoreNodes = ignoreNodes.join(',');
|
|
|
|
await this.popup.setOptionsContext(optionsContext, this._id);
|
|
|
|
this._updateContentScale();
|
|
|
|
const textSourceCurrent = this._textScanner.getCurrentTextSource();
|
|
const causeCurrent = this._textScanner.causeCurrent;
|
|
if (textSourceCurrent !== null && causeCurrent !== null) {
|
|
await this.onSearchSource(textSourceCurrent, causeCurrent);
|
|
}
|
|
}
|
|
|
|
async setTextSource(textSource) {
|
|
await this.onSearchSource(textSource, 'script');
|
|
this._textScanner.setCurrentTextSource(textSource);
|
|
}
|
|
|
|
async onSearchSource(textSource, cause) {
|
|
let results = null;
|
|
|
|
try {
|
|
if (textSource !== null) {
|
|
const optionsContext = await this.getOptionsContext();
|
|
results = (
|
|
await this.findTerms(textSource, optionsContext) ||
|
|
await this.findKanji(textSource, optionsContext)
|
|
);
|
|
if (results !== null) {
|
|
const focus = (cause === 'mouse');
|
|
this.showContent(textSource, focus, results.definitions, results.type, optionsContext);
|
|
}
|
|
}
|
|
} catch (e) {
|
|
if (this._orphaned) {
|
|
if (textSource !== null && this._options.scanning.modifier !== 'none') {
|
|
this._showPopupContent(textSource, await this.getOptionsContext(), 'orphaned');
|
|
}
|
|
} else {
|
|
yomichan.logError(e);
|
|
}
|
|
} finally {
|
|
if (results === null && this._options.scanning.autoHideResults) {
|
|
this._textScanner.clearSelection(false);
|
|
}
|
|
}
|
|
|
|
return results;
|
|
}
|
|
|
|
showContent(textSource, focus, definitions, type, optionsContext) {
|
|
const {url} = optionsContext;
|
|
const sentence = docSentenceExtract(textSource, this._options.anki.sentenceExt);
|
|
this._showPopupContent(
|
|
textSource,
|
|
optionsContext,
|
|
type,
|
|
{definitions, context: {sentence, url, focus, disableHistory: true}}
|
|
);
|
|
}
|
|
|
|
showContentCompleted() {
|
|
return this._lastShowPromise;
|
|
}
|
|
|
|
async findTerms(textSource, optionsContext) {
|
|
this._textScanner.setTextSourceScanLength(textSource, this._options.scanning.length);
|
|
|
|
const searchText = textSource.text();
|
|
if (searchText.length === 0) { return null; }
|
|
|
|
const {definitions, length} = await apiTermsFind(searchText, {}, optionsContext);
|
|
if (definitions.length === 0) { return null; }
|
|
|
|
textSource.setEndOffset(length);
|
|
|
|
return {definitions, type: 'terms'};
|
|
}
|
|
|
|
async findKanji(textSource, optionsContext) {
|
|
this._textScanner.setTextSourceScanLength(textSource, 1);
|
|
|
|
const searchText = textSource.text();
|
|
if (searchText.length === 0) { return null; }
|
|
|
|
const definitions = await apiKanjiFind(searchText, optionsContext);
|
|
if (definitions.length === 0) { return null; }
|
|
|
|
return {definitions, type: 'kanji'};
|
|
}
|
|
|
|
onClearSelection({passive}) {
|
|
this.popup.hide(!passive);
|
|
this.popup.clearAutoPlayTimer();
|
|
}
|
|
|
|
async getOptionsContext() {
|
|
const url = this._getUrl !== null ? await this._getUrl() : window.location.href;
|
|
const depth = this.popup.depth;
|
|
return {depth, url};
|
|
}
|
|
|
|
_showPopupContent(textSource, optionsContext, type=null, details=null) {
|
|
const context = {optionsContext, source: this._id};
|
|
this._lastShowPromise = this.popup.showContent(
|
|
textSource.getRect(),
|
|
textSource.getWritingMode(),
|
|
type,
|
|
details,
|
|
context
|
|
);
|
|
return this._lastShowPromise;
|
|
}
|
|
|
|
_updateTextScannerEnabled() {
|
|
const enabled = (
|
|
this._options.general.enable &&
|
|
this.popup.depth <= this._options.scanning.popupNestingMaxDepth &&
|
|
!this._disabledOverride
|
|
);
|
|
this._enabledEventListeners.removeAllEventListeners();
|
|
this._textScanner.setEnabled(enabled);
|
|
if (enabled) {
|
|
this._enabledEventListeners.addEventListener(window, 'message', this.onWindowMessage.bind(this));
|
|
}
|
|
}
|
|
|
|
_updateContentScale() {
|
|
const {popupScalingFactor, popupScaleRelativeToPageZoom, popupScaleRelativeToVisualViewport} = this._options.general;
|
|
let contentScale = popupScalingFactor;
|
|
if (popupScaleRelativeToPageZoom) {
|
|
contentScale /= this._pageZoomFactor;
|
|
}
|
|
if (popupScaleRelativeToVisualViewport) {
|
|
const visualViewport = window.visualViewport;
|
|
const visualViewportScale = (visualViewport !== null && typeof visualViewport === 'object' ? visualViewport.scale : 1.0);
|
|
contentScale /= visualViewportScale;
|
|
}
|
|
if (contentScale === this._contentScale) { return; }
|
|
|
|
this._contentScale = contentScale;
|
|
this.popup.setContentScale(this._contentScale);
|
|
this._updatePopupPosition();
|
|
}
|
|
|
|
_broadcastRootPopupInformation() {
|
|
if (!this.popup.isProxy() && this.popup.depth === 0 && this.popup.frameId === 0) {
|
|
apiBroadcastTab('rootPopupInformation', {popupId: this.popup.id, frameId: this.popup.frameId});
|
|
}
|
|
}
|
|
|
|
_broadcastDocumentInformation(uniqueId) {
|
|
apiBroadcastTab('documentInformationBroadcast', {
|
|
uniqueId,
|
|
frameId: this.popup.frameId,
|
|
title: document.title
|
|
});
|
|
}
|
|
|
|
async _updatePopupPosition() {
|
|
const textSource = this._textScanner.getCurrentTextSource();
|
|
if (textSource !== null && await this.popup.isVisible()) {
|
|
this._showPopupContent(textSource, await this.getOptionsContext());
|
|
}
|
|
}
|
|
}
|