yomichan/ext/mixed/js/display.js

948 lines
32 KiB
JavaScript
Raw Normal View History

2017-03-05 01:30:10 +00:00
/*
* Copyright (C) 2017-2020 Yomichan Authors
2017-03-05 01:30:10 +00:00
*
* 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
2020-01-01 17:00:31 +00:00
* along with this program. If not, see <https://www.gnu.org/licenses/>.
2017-03-05 01:30:10 +00:00
*/
2020-03-11 02:30:36 +00:00
/* global
* AudioSystem
* DOM
* DisplayContext
* DisplayGenerator
2020-04-11 18:23:49 +00:00
* MediaLoader
2020-03-11 02:30:36 +00:00
* WindowScroll
* api
2020-03-11 02:30:36 +00:00
* docRangeFromPoint
* docSentenceExtract
*/
2017-03-05 01:30:10 +00:00
class Display {
constructor(spinner, container) {
this._spinner = spinner;
this._container = container;
this._definitions = [];
this._optionsContext = null;
this._options = null;
this._context = null;
this._index = 0;
this._audioPlaying = null;
this._audioFallback = null;
this._audioSystem = new AudioSystem({
audioUriBuilder: {
2020-04-14 22:22:51 +00:00
getUri: async (definition, source, details) => {
return await api.audioGetUri(definition, source, details);
}
},
useCache: true
});
this._styleNode = null;
this._eventListeners = new EventListenerCollection();
this._persistentEventListeners = new EventListenerCollection();
this._interactive = false;
this._eventListenersActive = false;
this._clickScanPrevent = false;
this._setContentToken = null;
this._mediaLoader = new MediaLoader();
this._displayGenerator = new DisplayGenerator({mediaLoader: this._mediaLoader});
this._windowScroll = new WindowScroll();
this._hotkeys = new Map();
this._actions = new Map();
this.registerActions([
['close', () => { this.onEscape(); }],
['next-entry', () => { this._entryScrollIntoView(this._index + 1, null, true); }],
['next-entry-x3', () => { this._entryScrollIntoView(this._index + 3, null, true); }],
['previous-entry', () => { this._entryScrollIntoView(this._index - 1, null, true); }],
['previous-entry-x3', () => { this._entryScrollIntoView(this._index - 3, null, true); }],
['last-entry', () => { this._entryScrollIntoView(this._definitions.length - 1, null, true); }],
['first-entry', () => { this._entryScrollIntoView(0, null, true); }],
['history-backward', () => { this._sourceTermView(); }],
['history-forward', () => { this._nextTermView(); }],
['add-note-kanji', () => { this._noteTryAdd('kanji'); }],
['add-note-term-kanji', () => { this._noteTryAdd('term-kanji'); }],
['add-note-term-kana', () => { this._noteTryAdd('term-kana'); }],
['view-note', () => { this._noteTryView(); }],
['play-audio', () => { this._playAudioCurrent(); }]
]);
this.registerHotkeys([
{key: 'Escape', modifiers: [], action: 'close'},
{key: 'PageUp', modifiers: ['alt'], action: 'previous-entry-x3'},
{key: 'PageDown', modifiers: ['alt'], action: 'next-entry-x3'},
{key: 'End', modifiers: ['alt'], action: 'last-entry'},
{key: 'Home', modifiers: ['alt'], action: 'first-entry'},
{key: 'ArrowUp', modifiers: ['alt'], action: 'previous-entry'},
{key: 'ArrowDown', modifiers: ['alt'], action: 'next-entry'},
{key: 'B', modifiers: ['alt'], action: 'history-backward'},
{key: 'F', modifiers: ['alt'], action: 'history-forward'},
{key: 'K', modifiers: ['alt'], action: 'add-note-kanji'},
{key: 'E', modifiers: ['alt'], action: 'add-note-term-kanji'},
{key: 'R', modifiers: ['alt'], action: 'add-note-term-kana'},
{key: 'P', modifiers: ['alt'], action: 'play-audio'},
{key: 'V', modifiers: ['alt'], action: 'view-note'}
2020-02-27 00:48:30 +00:00
]);
2017-03-05 01:30:10 +00:00
}
2020-03-13 21:23:08 +00:00
async prepare() {
this._setInteractive(true);
await yomichan.ready();
await this._displayGenerator.prepare();
}
onError(error) {
if (yomichan.isExtensionUnloaded) {
this.setContent('extensionUnloaded');
} else {
yomichan.logError(error);
}
2017-03-05 01:30:10 +00:00
}
onEscape() {
2019-10-08 00:46:02 +00:00
throw new Error('Override me');
2017-03-25 22:59:33 +00:00
}
onKeyDown(e) {
const key = DOM.getKeyFromEvent(e);
const handlers = this._hotkeys.get(key);
if (typeof handlers === 'undefined') { return false; }
const eventModifiers = DOM.getActiveModifiers(e);
for (const {modifiers, action} of handlers) {
if (getSetDifference(modifiers, eventModifiers).size !== 0) { continue; }
const actionHandler = this._actions.get(action);
if (typeof actionHandler === 'undefined') { continue; }
const result = actionHandler(e);
if (result !== false) {
e.preventDefault();
return true;
}
}
return false;
}
getOptions() {
return this._options;
}
getOptionsContext() {
return this._optionsContext;
}
setOptionsContext(optionsContext) {
this._optionsContext = optionsContext;
}
async updateOptions() {
this._options = await api.optionsGet(this.getOptionsContext());
this._updateDocumentOptions(this._options);
this._updateTheme(this._options.general.popupTheme);
this.setCustomCss(this._options.general.customPopupCss);
}
addMultipleEventListeners(selector, type, listener, options) {
for (const node of this._container.querySelectorAll(selector)) {
this._eventListeners.addEventListener(node, type, listener, options);
}
}
autoPlayAudio() {
if (this._definitions.length === 0) { return; }
this._audioPlay(this._definitions[0], this._getFirstExpressionIndex(), 0);
}
async setContent(type, details) {
const token = {}; // Unique identifier token
this._setContentToken = token;
try {
this._mediaLoader.unloadAll();
switch (type) {
case 'terms':
await this._setContentTerms(details.definitions, details.context, token);
break;
case 'kanji':
await this._setContentKanji(details.definitions, details.context, token);
break;
case 'extensionUnloaded':
this._setContentExtensionUnloaded();
break;
}
} catch (e) {
this.onError(e);
} finally {
if (this._setContentToken === token) {
this._setContentToken = null;
}
}
}
clearContent() {
this._container.textContent = '';
}
setCustomCss(css) {
if (this._styleNode === null) {
if (css.length === 0) { return; }
this._styleNode = document.createElement('style');
}
this._styleNode.textContent = css;
const parent = document.head;
if (this._styleNode.parentNode !== parent) {
parent.appendChild(this._styleNode);
}
}
async getDocumentTitle() {
return document.title;
}
setSpinnerVisible(visible) {
if (this._spinner !== null) {
this._spinner.hidden = !visible;
}
}
registerActions(actions) {
for (const [name, handler] of actions) {
this._actions.set(name, handler);
}
}
registerHotkeys(hotkeys) {
for (const {key, modifiers, action} of hotkeys) {
let handlers = this._hotkeys.get(key);
if (typeof handlers === 'undefined') {
handlers = [];
this._hotkeys.set(key, handlers);
}
handlers.push({modifiers: new Set(modifiers), action});
}
}
// Private
_onSourceTermView(e) {
2017-03-05 01:30:10 +00:00
e.preventDefault();
this._sourceTermView();
2017-03-19 22:45:30 +00:00
}
2017-03-05 01:30:10 +00:00
_onNextTermView(e) {
e.preventDefault();
this._nextTermView();
}
async _onKanjiLookup(e) {
2017-08-13 23:11:51 +00:00
try {
e.preventDefault();
if (!this._context) { return; }
2017-03-19 22:45:30 +00:00
2019-09-15 18:06:27 +00:00
const link = e.target;
this._context.update({
index: this._entryIndexFind(link),
scroll: this._windowScroll.y
2019-12-01 03:38:23 +00:00
});
2017-08-13 23:11:51 +00:00
const context = {
sentence: this._context.get('sentence'),
url: this._context.get('url')
2017-08-13 23:11:51 +00:00
};
const definitions = await api.kanjiFind(link.textContent, this.getOptionsContext());
2019-12-27 22:42:36 +00:00
this.setContent('kanji', {definitions, context});
} catch (error) {
this.onError(error);
2017-03-19 22:45:30 +00:00
}
}
_onGlossaryMouseDown(e) {
if (DOM.isMouseButtonPressed(e, 'primary')) {
this._clickScanPrevent = false;
}
}
_onGlossaryMouseMove() {
this._clickScanPrevent = true;
}
_onGlossaryMouseUp(e) {
if (!this._clickScanPrevent && DOM.isMouseButtonPressed(e, 'primary')) {
this._onTermLookup(e);
}
}
async _onTermLookup(e, {disableScroll, selectText, disableHistory}={}) {
2019-10-30 01:58:24 +00:00
try {
if (!this._context) { return; }
2019-12-01 03:38:23 +00:00
const termLookupResults = await this._termLookup(e);
2019-11-26 17:29:49 +00:00
if (!termLookupResults) { return; }
2019-10-30 01:58:24 +00:00
const {textSource, definitions} = termLookupResults;
const scannedElement = e.target;
const sentenceExtent = this._options.anki.sentenceExt;
const layoutAwareScan = this._options.scanning.layoutAwareScan;
const sentence = docSentenceExtract(textSource, sentenceExtent, layoutAwareScan);
2019-10-30 01:58:24 +00:00
this._context.update({
index: this._entryIndexFind(scannedElement),
scroll: this._windowScroll.y
});
2019-11-26 17:29:49 +00:00
const context = {
disableScroll,
2019-12-01 03:38:23 +00:00
disableHistory,
2019-11-26 17:29:49 +00:00
sentence,
url: this._context.get('url')
2019-11-26 17:29:49 +00:00
};
2019-12-01 03:38:23 +00:00
if (disableHistory) {
Object.assign(context, {
previous: this._context.previous,
next: this._context.next
2019-12-01 03:38:23 +00:00
});
} else {
Object.assign(context, {
previous: this._context
2019-12-01 03:38:23 +00:00
});
}
2019-10-30 01:58:24 +00:00
2019-12-27 22:42:36 +00:00
this.setContent('terms', {definitions, context});
2019-10-30 01:58:24 +00:00
if (selectText) {
textSource.select();
}
} catch (error) {
this.onError(error);
}
}
async _termLookup(e) {
2019-08-03 12:06:28 +00:00
try {
e.preventDefault();
const {length: scanLength, deepDomScan: deepScan, layoutAwareScan} = this._options.scanning;
const textSource = docRangeFromPoint(e.clientX, e.clientY, deepScan);
if (textSource === null) {
return false;
}
2019-08-03 12:06:28 +00:00
2019-10-30 01:58:24 +00:00
let definitions, length;
try {
textSource.setEndOffset(scanLength, layoutAwareScan);
2019-08-03 12:06:28 +00:00
({definitions, length} = await api.termsFind(textSource.text(), {}, this.getOptionsContext()));
if (definitions.length === 0) {
return false;
}
2019-08-03 12:06:28 +00:00
textSource.setEndOffset(length, layoutAwareScan);
} finally {
textSource.cleanup();
}
2019-08-03 12:06:28 +00:00
2019-10-30 01:58:24 +00:00
return {textSource, definitions};
} catch (error) {
this.onError(error);
2019-08-03 12:06:28 +00:00
}
}
_onAudioPlay(e) {
2017-03-19 22:45:30 +00:00
e.preventDefault();
2019-09-15 18:06:27 +00:00
const link = e.currentTarget;
const entry = link.closest('.entry');
const index = this._entryIndexFind(entry);
if (index < 0 || index >= this._definitions.length) { return; }
const expressionIndex = this._indexOf(entry.querySelectorAll('.term-expression .action-play-audio'), link);
this._audioPlay(
this._definitions[index],
// expressionIndex is used in audioPlay to detect result output mode
Math.max(expressionIndex, this._options.general.resultOutputMode === 'merge' ? 0 : -1),
index
);
2017-03-19 22:45:30 +00:00
}
_onNoteAdd(e) {
2017-03-19 22:45:30 +00:00
e.preventDefault();
2019-09-15 18:06:27 +00:00
const link = e.currentTarget;
const index = this._entryIndexFind(link);
if (index < 0 || index >= this._definitions.length) { return; }
this._noteAdd(this._definitions[index], link.dataset.mode);
2017-03-05 01:30:10 +00:00
}
_onNoteView(e) {
2017-07-02 01:27:49 +00:00
e.preventDefault();
2019-09-15 18:06:27 +00:00
const link = e.currentTarget;
api.noteView(link.dataset.noteId);
2017-07-02 01:27:49 +00:00
}
_onWheel(e) {
2019-10-03 00:57:48 +00:00
if (e.altKey) {
if (e.deltaY !== 0) {
this._entryScrollIntoView(this._index + (e.deltaY > 0 ? 1 : -1), null, true);
2019-10-03 00:57:48 +00:00
e.preventDefault();
}
2019-11-28 13:24:00 +00:00
} else if (e.shiftKey) {
this._onHistoryWheel(e);
}
}
_onHistoryWheel(e) {
if (e.altKey) { return; }
const delta = -e.deltaX || e.deltaY;
if (delta > 0) {
this._sourceTermView();
e.preventDefault();
e.stopPropagation();
} else if (delta < 0) {
this._nextTermView();
e.preventDefault();
e.stopPropagation();
}
}
_updateDocumentOptions(options) {
const data = document.documentElement.dataset;
data.ankiEnabled = `${options.anki.enable}`;
data.audioEnabled = `${options.audio.enabled}`;
data.compactGlossaries = `${options.general.compactGlossaries}`;
data.enableSearchTags = `${options.scanning.enableSearchTags}`;
2020-03-01 19:38:16 +00:00
data.showPitchAccentDownstepNotation = `${options.general.showPitchAccentDownstepNotation}`;
data.showPitchAccentPositionNotation = `${options.general.showPitchAccentPositionNotation}`;
data.showPitchAccentGraph = `${options.general.showPitchAccentGraph}`;
data.debug = `${options.general.debugInfo}`;
}
_updateTheme(themeName) {
2019-10-12 21:06:03 +00:00
document.documentElement.dataset.yomichanTheme = themeName;
2019-10-12 18:20:54 +00:00
}
_setInteractive(interactive) {
interactive = !!interactive;
if (this._interactive === interactive) { return; }
this._interactive = interactive;
if (interactive) {
2020-02-16 21:33:48 +00:00
const actionPrevious = document.querySelector('.action-previous');
const actionNext = document.querySelector('.action-next');
// const navigationHeader = document.querySelector('.navigation-header');
2020-02-16 21:33:48 +00:00
this._persistentEventListeners.addEventListener(document, 'keydown', this.onKeyDown.bind(this), false);
this._persistentEventListeners.addEventListener(document, 'wheel', this._onWheel.bind(this), {passive: false});
2020-02-16 21:33:48 +00:00
if (actionPrevious !== null) {
this._persistentEventListeners.addEventListener(actionPrevious, 'click', this._onSourceTermView.bind(this));
2020-02-16 21:33:48 +00:00
}
if (actionNext !== null) {
this._persistentEventListeners.addEventListener(actionNext, 'click', this._onNextTermView.bind(this));
2020-02-16 21:33:48 +00:00
}
// temporarily disabled
// if (navigationHeader !== null) {
// this.persistentEventListeners.addEventListener(navigationHeader, 'wheel', this.onHistoryWheel.bind(this), {passive: false});
// }
} else {
this._persistentEventListeners.removeAllEventListeners();
}
this._setEventListenersActive(this._eventListenersActive);
}
_setEventListenersActive(active) {
active = !!active && this._interactive;
if (this._eventListenersActive === active) { return; }
this._eventListenersActive = active;
if (active) {
this.addMultipleEventListeners('.action-add-note', 'click', this._onNoteAdd.bind(this));
this.addMultipleEventListeners('.action-view-note', 'click', this._onNoteView.bind(this));
this.addMultipleEventListeners('.action-play-audio', 'click', this._onAudioPlay.bind(this));
this.addMultipleEventListeners('.kanji-link', 'click', this._onKanjiLookup.bind(this));
if (this._options.scanning.enablePopupSearch) {
this.addMultipleEventListeners('.term-glossary-item, .tag', 'mouseup', this._onGlossaryMouseUp.bind(this));
this.addMultipleEventListeners('.term-glossary-item, .tag', 'mousedown', this._onGlossaryMouseDown.bind(this));
this.addMultipleEventListeners('.term-glossary-item, .tag', 'mousemove', this._onGlossaryMouseMove.bind(this));
}
} else {
this._eventListeners.removeAllEventListeners();
}
}
async _setContentTerms(definitions, context, token) {
if (!context) { throw new Error('Context expected'); }
this._setEventListenersActive(false);
2019-09-15 22:52:26 +00:00
if (context.focus !== false) {
window.focus();
}
2017-08-13 23:11:51 +00:00
this._definitions = definitions;
if (context.disableHistory) {
delete context.disableHistory;
this._context = new DisplayContext('terms', definitions, context);
} else {
this._context = DisplayContext.push(this._context, 'terms', definitions, context);
}
2017-08-13 23:11:51 +00:00
for (const definition of definitions) {
definition.cloze = this._clozeBuild(context.sentence, definition.source);
definition.url = context.url;
}
2017-08-13 23:11:51 +00:00
this._updateNavigation(this._context.previous, this._context.next);
this._setNoContentVisible(definitions.length === 0);
2017-08-13 23:11:51 +00:00
const container = this._container;
2019-12-27 23:15:16 +00:00
container.textContent = '';
2019-12-27 23:15:16 +00:00
for (let i = 0, ii = definitions.length; i < ii; ++i) {
if (i > 0) {
await promiseTimeout(1);
if (this._setContentToken !== token) { return; }
2019-12-27 23:15:16 +00:00
}
const entry = this._displayGenerator.createTermEntry(definitions[i]);
2019-12-27 23:15:16 +00:00
container.appendChild(entry);
}
const {index, scroll, disableScroll} = context;
if (!disableScroll) {
this._entryScrollIntoView(index || 0, scroll);
} else {
delete context.disableScroll;
this._entrySetCurrent(index || 0);
}
if (this._options.audio.enabled && this._options.audio.autoPlay) {
this.autoPlayAudio();
}
2017-08-13 23:11:51 +00:00
this._setEventListenersActive(true);
2017-12-16 18:56:53 +00:00
const states = await this._getDefinitionsAddable(definitions, ['term-kanji', 'term-kana']);
if (this._setContentToken !== token) { return; }
2017-08-13 23:11:51 +00:00
this._updateAdderButtons(states);
2017-08-13 23:11:51 +00:00
}
async _setContentKanji(definitions, context, token) {
if (!context) { throw new Error('Context expected'); }
this._setEventListenersActive(false);
2019-09-15 22:52:26 +00:00
if (context.focus !== false) {
window.focus();
}
2017-08-13 23:11:51 +00:00
this._definitions = definitions;
if (context.disableHistory) {
delete context.disableHistory;
this._context = new DisplayContext('kanji', definitions, context);
} else {
this._context = DisplayContext.push(this._context, 'kanji', definitions, context);
}
2017-08-13 23:11:51 +00:00
for (const definition of definitions) {
definition.cloze = this._clozeBuild(context.sentence, definition.character);
definition.url = context.url;
}
2017-08-13 23:11:51 +00:00
this._updateNavigation(this._context.previous, this._context.next);
this._setNoContentVisible(definitions.length === 0);
2017-08-13 23:11:51 +00:00
const container = this._container;
2019-12-27 23:15:16 +00:00
container.textContent = '';
2019-12-27 23:15:16 +00:00
for (let i = 0, ii = definitions.length; i < ii; ++i) {
if (i > 0) {
await promiseTimeout(1);
if (this._setContentToken !== token) { return; }
2019-12-27 23:15:16 +00:00
}
const entry = this._displayGenerator.createKanjiEntry(definitions[i]);
2019-12-27 23:15:16 +00:00
container.appendChild(entry);
}
const {index, scroll} = context;
this._entryScrollIntoView(index || 0, scroll);
this._setEventListenersActive(true);
2017-08-13 23:11:51 +00:00
const states = await this._getDefinitionsAddable(definitions, ['kanji']);
if (this._setContentToken !== token) { return; }
2017-08-13 23:11:51 +00:00
this._updateAdderButtons(states);
2017-08-13 23:11:51 +00:00
}
_setContentExtensionUnloaded() {
const errorExtensionUnloaded = document.querySelector('#error-extension-unloaded');
if (this._container !== null) {
this._container.hidden = true;
}
if (errorExtensionUnloaded !== null) {
errorExtensionUnloaded.hidden = false;
}
this._updateNavigation(null, null);
this._setNoContentVisible(false);
}
_setNoContentVisible(visible) {
const noResults = document.querySelector('#no-results');
if (noResults !== null) {
noResults.hidden = !visible;
}
}
_updateNavigation(previous, next) {
const navigation = document.querySelector('#navigation-header');
if (navigation !== null) {
navigation.hidden = !(previous || next);
navigation.dataset.hasPrevious = `${!!previous}`;
navigation.dataset.hasNext = `${!!next}`;
}
}
_updateAdderButtons(states) {
for (let i = 0; i < states.length; ++i) {
let noteId = null;
2020-02-26 02:22:54 +00:00
for (const [mode, info] of Object.entries(states[i])) {
const button = this._adderButtonFind(i, mode);
if (button === null) {
continue;
2017-08-13 23:11:51 +00:00
}
if (!info.canAdd && noteId === null && info.noteId) {
noteId = info.noteId;
}
button.classList.toggle('disabled', !info.canAdd);
button.classList.remove('pending');
}
if (noteId !== null) {
this._viewerButtonShow(i, noteId);
2017-08-13 23:11:51 +00:00
}
}
}
_entrySetCurrent(index) {
index = Math.min(index, this._definitions.length - 1);
2017-08-13 23:11:51 +00:00
index = Math.max(index, 0);
const entryPre = this._getEntry(this._index);
2019-09-15 22:44:49 +00:00
if (entryPre !== null) {
entryPre.classList.remove('entry-current');
}
const entry = this._getEntry(index);
2019-09-15 22:44:49 +00:00
if (entry !== null) {
entry.classList.add('entry-current');
}
2017-08-13 23:11:51 +00:00
this._index = index;
return entry;
}
_entryScrollIntoView(index, scroll, smooth) {
this._windowScroll.stop();
const entry = this._entrySetCurrent(index);
let target;
if (scroll !== null) {
target = scroll;
} else {
target = this._index === 0 || entry === null ? 0 : this._getElementTop(entry);
const header = document.querySelector('#navigation-header');
if (header !== null) {
target -= header.getBoundingClientRect().height;
}
}
2017-08-13 23:11:51 +00:00
if (smooth) {
this._windowScroll.animate(this._windowScroll.x, target, 200);
2017-08-13 23:11:51 +00:00
} else {
this._windowScroll.toY(target);
2017-08-13 23:11:51 +00:00
}
}
_sourceTermView() {
if (!this._context || !this._context.previous) { return; }
this._context.update({
index: this._index,
scroll: this._windowScroll.y
2019-12-01 03:38:23 +00:00
});
const previousContext = this._context.previous;
2019-12-01 03:38:23 +00:00
previousContext.set('disableHistory', true);
const details = {
definitions: previousContext.definitions,
context: previousContext.context
};
2019-12-01 03:38:23 +00:00
this.setContent(previousContext.type, details);
2017-03-26 01:08:42 +00:00
}
_nextTermView() {
if (!this._context || !this._context.next) { return; }
this._context.update({
index: this._index,
scroll: this._windowScroll.y
2019-12-01 03:38:23 +00:00
});
const nextContext = this._context.next;
2019-12-01 03:38:23 +00:00
nextContext.set('disableHistory', true);
const details = {
definitions: nextContext.definitions,
context: nextContext.context
};
this.setContent(nextContext.type, details);
}
_noteTryAdd(mode) {
const index = this._index;
if (index < 0 || index >= this._definitions.length) { return; }
const button = this._adderButtonFind(index, mode);
if (button !== null && !button.classList.contains('disabled')) {
this._noteAdd(this._definitions[index], mode);
}
}
_noteTryView() {
const button = this._viewerButtonFind(this._index);
if (button !== null && !button.classList.contains('disabled')) {
api.noteView(button.dataset.noteId);
}
}
async _noteAdd(definition, mode) {
2017-08-13 23:11:51 +00:00
try {
this.setSpinnerVisible(true);
2017-08-13 23:11:51 +00:00
2020-03-15 21:02:34 +00:00
const details = {};
if (this._noteUsesScreenshot(mode)) {
const screenshot = await this._getScreenshot();
if (screenshot) {
2020-03-15 21:02:34 +00:00
details.screenshot = screenshot;
}
}
2020-04-06 22:55:45 +00:00
const context = await this._getNoteContext();
const noteId = await api.definitionAdd(definition, mode, context, details, this.getOptionsContext());
2017-07-02 01:27:49 +00:00
if (noteId) {
const index = this._definitions.indexOf(definition);
const adderButton = this._adderButtonFind(index, mode);
if (adderButton !== null) {
adderButton.classList.add('disabled');
}
this._viewerButtonShow(index, noteId);
2017-03-25 17:46:59 +00:00
} else {
2019-10-08 00:46:02 +00:00
throw new Error('Note could not be added');
2017-03-19 22:45:30 +00:00
}
2017-08-13 23:11:51 +00:00
} catch (e) {
this.onError(e);
} finally {
this.setSpinnerVisible(false);
2017-08-13 23:11:51 +00:00
}
2017-03-19 22:45:30 +00:00
}
async _audioPlay(definition, expressionIndex, entryIndex) {
2017-08-13 23:11:51 +00:00
try {
this.setSpinnerVisible(true);
2017-03-05 01:30:10 +00:00
2017-10-28 15:11:33 +00:00
const expression = expressionIndex === -1 ? definition : definition.expressions[expressionIndex];
2017-03-05 01:30:10 +00:00
this._stopPlayingAudio();
2017-08-13 23:11:51 +00:00
let audio, info;
2020-03-07 18:18:48 +00:00
try {
const {sources, textToSpeechVoice, customSourceUrl} = this._options.audio;
let index;
({audio, index} = await this._audioSystem.getDefinitionAudio(expression, sources, {textToSpeechVoice, customSourceUrl}));
info = `From source ${1 + index}: ${sources[index]}`;
2020-03-07 18:18:48 +00:00
} catch (e) {
if (this._audioFallback === null) {
this._audioFallback = new Audio('/mixed/mp3/button.mp3');
2019-10-10 23:58:06 +00:00
}
audio = this._audioFallback;
info = 'Could not find audio';
}
const button = this._audioButtonFindImage(entryIndex, expressionIndex);
if (button !== null) {
let titleDefault = button.dataset.titleDefault;
if (!titleDefault) {
2019-11-25 19:21:19 +00:00
titleDefault = button.title || '';
button.dataset.titleDefault = titleDefault;
}
button.title = `${titleDefault}\n${info}`;
2017-03-23 04:57:16 +00:00
}
2019-10-10 23:58:06 +00:00
this._stopPlayingAudio();
const volume = Math.max(0.0, Math.min(1.0, this._options.audio.volume / 100.0));
this._audioPlaying = audio;
2019-10-10 23:58:06 +00:00
audio.currentTime = 0;
audio.volume = Number.isFinite(volume) ? volume : 1.0;
const playPromise = audio.play();
if (typeof playPromise !== 'undefined') {
try {
await playPromise;
} catch (e2) {
// NOP
}
}
2017-08-13 23:11:51 +00:00
} catch (e) {
this.onError(e);
} finally {
this.setSpinnerVisible(false);
2017-08-13 23:11:51 +00:00
}
2017-03-18 16:48:53 +00:00
}
_stopPlayingAudio() {
if (this._audioPlaying !== null) {
this._audioPlaying.pause();
this._audioPlaying = null;
}
}
_noteUsesScreenshot(mode) {
const optionsAnki = this._options.anki;
const fields = (mode === 'kanji' ? optionsAnki.kanji : optionsAnki.terms).fields;
2020-02-26 02:58:12 +00:00
for (const fieldValue of Object.values(fields)) {
if (fieldValue.includes('{screenshot}')) {
return true;
}
}
return false;
}
async _getScreenshot() {
try {
await this._setPopupVisibleOverride(false);
2020-02-16 01:35:51 +00:00
await promiseTimeout(1); // Wait for popup to be hidden.
const {format, quality} = this._options.anki.screenshot;
const dataUrl = await api.screenshotGet({format, quality});
if (!dataUrl || dataUrl.error) { return; }
return {dataUrl, format};
} finally {
await this._setPopupVisibleOverride(null);
}
}
_getFirstExpressionIndex() {
return this._options.general.resultOutputMode === 'merge' ? 0 : -1;
2017-12-16 18:56:53 +00:00
}
_setPopupVisibleOverride(visible) {
return api.broadcastTab('popupSetVisibleOverride', {visible});
}
_getEntry(index) {
const entries = this._container.querySelectorAll('.entry');
return index >= 0 && index < entries.length ? entries[index] : null;
}
_clozeBuild({text, offset}, source) {
2019-11-26 15:53:21 +00:00
return {
sentence: text.trim(),
prefix: text.substring(0, offset).trim(),
body: text.substring(offset, offset + source.length),
suffix: text.substring(offset + source.length).trim()
2017-07-16 19:48:27 +00:00
};
}
_entryIndexFind(element) {
2019-09-15 18:06:27 +00:00
const entry = element.closest('.entry');
return entry !== null ? this._indexOf(this._container.querySelectorAll('.entry'), entry) : -1;
2017-03-23 05:28:22 +00:00
}
_adderButtonFind(index, mode) {
const entry = this._getEntry(index);
return entry !== null ? entry.querySelector(`.action-add-note[data-mode="${mode}"]`) : null;
2017-03-23 05:28:22 +00:00
}
2017-07-02 01:27:49 +00:00
_viewerButtonFind(index) {
const entry = this._getEntry(index);
return entry !== null ? entry.querySelector('.action-view-note') : null;
2017-07-02 01:27:49 +00:00
}
_viewerButtonShow(index, noteId) {
const viewerButton = this._viewerButtonFind(index);
if (viewerButton === null) {
return;
}
viewerButton.classList.remove('pending', 'disabled');
viewerButton.dataset.noteId = noteId;
}
_audioButtonFindImage(index, expressionIndex) {
const entry = this._getEntry(index);
if (entry === null) { return null; }
const container = (
expressionIndex >= 0 ?
entry.querySelector(`.term-expression:nth-of-type(${expressionIndex + 1})`) :
entry
);
return container !== null ? container.querySelector('.action-play-audio>img') : null;
}
async _getDefinitionsAddable(definitions, modes) {
try {
2020-03-28 02:11:24 +00:00
const context = await this._getNoteContext();
return await api.definitionsAddable(definitions, modes, context, this.getOptionsContext());
} catch (e) {
return [];
}
}
_indexOf(nodeList, node) {
2019-09-15 18:06:27 +00:00
for (let i = 0, ii = nodeList.length; i < ii; ++i) {
if (nodeList[i] === node) {
return i;
}
}
return -1;
}
2019-09-15 18:53:30 +00:00
_getElementTop(element) {
2019-09-15 22:44:49 +00:00
const elementRect = element.getBoundingClientRect();
const documentRect = document.documentElement.getBoundingClientRect();
return elementRect.top - documentRect.top;
}
2020-03-28 02:11:24 +00:00
async _getNoteContext() {
const documentTitle = await this.getDocumentTitle();
2020-03-15 21:32:31 +00:00
return {
document: {
2020-03-28 02:11:24 +00:00
title: documentTitle
2020-03-15 21:32:31 +00:00
}
};
}
_playAudioCurrent() {
const index = this._index;
if (index < 0 || index >= this._definitions.length) { return; }
const entry = this._getEntry(index);
if (entry !== null && entry.dataset.type === 'term') {
this._audioPlay(this._definitions[index], this._getFirstExpressionIndex(), index);
}
}
2017-03-05 01:30:10 +00:00
}