/* * Copyright (C) 2017 Alex Yatskov <alex@foosoft.net> * Author: Alex Yatskov <alex@foosoft.net> * * 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 <http://www.gnu.org/licenses/>. */ class Display { constructor(spinner, container) { this.spinner = spinner; this.container = container; this.definitions = []; this.options = null; this.context = null; this.sequence = 0; this.index = 0; this.audioCache = {}; this.optionsContext = {}; this.eventListeners = []; this.dependencies = {}; this.windowScroll = new WindowScroll(); document.addEventListener('keydown', this.onKeyDown.bind(this)); document.addEventListener('wheel', this.onWheel.bind(this), {passive: false}); } onError(error) { throw 'Override me'; } onSearchClear() { throw 'Override me'; } onSourceTermView(e) { e.preventDefault(); this.sourceTermView(); } async onKanjiLookup(e) { try { e.preventDefault(); const link = e.target; this.windowScroll.toY(0); const context = { source: { definitions: this.definitions, index: this.entryIndexFind(link), scroll: this.windowScroll.y } }; if (this.context) { context.sentence = this.context.sentence; context.url = this.context.url; context.source.source = this.context.source; } const kanjiDefs = await apiKanjiFind(link.textContent, this.optionsContext); this.kanjiShow(kanjiDefs, this.options, context); } catch (e) { this.onError(e); } } async onTermLookup(e) { try { e.preventDefault(); const {docRangeFromPoint, docSentenceExtract} = this.dependencies; const clickedElement = e.target; const textSource = docRangeFromPoint(e.clientX, e.clientY, this.options); if (textSource === null) { return false; } let definitions, length, sentence; try { textSource.setEndOffset(this.options.scanning.length); ({definitions, length} = await apiTermsFind(textSource.text(), this.optionsContext)); if (definitions.length === 0) { return false; } textSource.setEndOffset(length); sentence = docSentenceExtract(textSource, this.options.anki.sentenceExt); } finally { textSource.cleanup(); } this.windowScroll.toY(0); const context = { source: { definitions: this.definitions, index: this.entryIndexFind(clickedElement), scroll: this.windowScroll.y } }; if (this.context) { context.sentence = sentence; context.url = this.context.url; context.source.source = this.context.source; } this.termsShow(definitions, this.options, context); } catch (e) { this.onError(e); } } onAudioPlay(e) { e.preventDefault(); const link = e.currentTarget; const entry = link.closest('.entry'); const definitionIndex = this.entryIndexFind(entry); const expressionIndex = Display.indexOf(entry.querySelectorAll('.expression .action-play-audio'), link); this.audioPlay(this.definitions[definitionIndex], expressionIndex); } onNoteAdd(e) { e.preventDefault(); const link = e.currentTarget; const index = this.entryIndexFind(link); this.noteAdd(this.definitions[index], link.dataset.mode); } onNoteView(e) { e.preventDefault(); const link = e.currentTarget; apiNoteView(link.dataset.noteId); } onKeyDown(e) { const key = Display.getKeyFromEvent(e); const handlers = Display.onKeyDownHandlers; if (handlers.hasOwnProperty(key)) { const handler = handlers[key]; if (handler(this, e)) { e.preventDefault(); } } } onWheel(e) { if (e.altKey) { const delta = e.deltaY; if (delta !== 0) { this.entryScrollIntoView(this.index + (delta > 0 ? 1 : -1), null, true); e.preventDefault(); } } } async termsShow(definitions, options, context) { try { this.clearEventListeners(); if (!context || context.focus !== false) { window.focus(); } this.definitions = definitions; this.options = options; this.context = context; const sequence = ++this.sequence; const params = { definitions, source: context && context.source, addable: options.anki.enable, grouped: options.general.resultOutputMode === 'group', merged: options.general.resultOutputMode === 'merge', playback: options.general.audioSource !== 'disabled', compactGlossaries: options.general.compactGlossaries, debug: options.general.debugInfo }; if (context) { for (const definition of definitions) { if (context.sentence) { definition.cloze = Display.clozeBuild(context.sentence, definition.source); } definition.url = context.url; } } const content = await apiTemplateRender('terms.html', params); this.container.innerHTML = content; const {index, scroll} = context || {}; this.entryScrollIntoView(index || 0, scroll); if (this.options.general.autoPlayAudio && this.options.general.audioSource !== 'disabled') { this.autoPlayAudio(); } this.addEventListeners('.action-add-note', 'click', this.onNoteAdd.bind(this)); this.addEventListeners('.action-view-note', 'click', this.onNoteView.bind(this)); this.addEventListeners('.action-play-audio', 'click', this.onAudioPlay.bind(this)); this.addEventListeners('.kanji-link', 'click', this.onKanjiLookup.bind(this)); this.addEventListeners('.source-term', 'click', this.onSourceTermView.bind(this)); if (this.options.scanning.enablePopupSearch) { this.addEventListeners('.glossary-item', 'click', this.onTermLookup.bind(this)); } await this.adderButtonUpdate(['term-kanji', 'term-kana'], sequence); } catch (e) { this.onError(e); } } async kanjiShow(definitions, options, context) { try { this.clearEventListeners(); if (!context || context.focus !== false) { window.focus(); } this.definitions = definitions; this.options = options; this.context = context; const sequence = ++this.sequence; const params = { definitions, source: context && context.source, addable: options.anki.enable, debug: options.general.debugInfo }; if (context) { for (const definition of definitions) { if (context.sentence) { definition.cloze = Display.clozeBuild(context.sentence); } definition.url = context.url; } } const content = await apiTemplateRender('kanji.html', params); this.container.innerHTML = content; const {index, scroll} = context || {}; this.entryScrollIntoView(index || 0, scroll); this.addEventListeners('.action-add-note', 'click', this.onNoteAdd.bind(this)); this.addEventListeners('.action-view-note', 'click', this.onNoteView.bind(this)); this.addEventListeners('.source-term', 'click', this.onSourceTermView.bind(this)); await this.adderButtonUpdate(['kanji'], sequence); } catch (e) { this.onError(e); } } autoPlayAudio() { this.audioPlay(this.definitions[0], this.firstExpressionIndex); } async adderButtonUpdate(modes, sequence) { try { const states = await apiDefinitionsAddable(this.definitions, modes, this.optionsContext); if (!states || sequence !== this.sequence) { return; } for (let i = 0; i < states.length; ++i) { const state = states[i]; for (const mode in state) { const button = this.adderButtonFind(i, mode); if (button === null) { continue; } button.classList.toggle('disabled', !state[mode]); button.classList.remove('pending'); } } } catch (e) { this.onError(e); } } entryScrollIntoView(index, scroll, smooth) { index = Math.min(index, this.definitions.length - 1); index = Math.max(index, 0); const entryPre = this.getEntry(this.index); if (entryPre !== null) { entryPre.classList.remove('entry-current'); } const entry = this.getEntry(index); if (entry !== null) { entry.classList.add('entry-current'); } this.windowScroll.stop(); let target; if (scroll) { target = scroll; } else { target = index === 0 || entry === null ? 0 : Display.getElementTop(entry); } if (smooth) { this.windowScroll.animate(this.windowScroll.x, target, 200); } else { this.windowScroll.toY(target); } this.index = index; } sourceTermView() { if (this.context && this.context.source) { const context = { url: this.context.source.url, sentence: this.context.source.sentence, index: this.context.source.index, scroll: this.context.source.scroll, source: this.context.source.source }; this.termsShow(this.context.source.definitions, this.options, context); } } noteTryAdd(mode) { const button = this.adderButtonFind(this.index, mode); if (button !== null && !button.classList.contains('disabled')) { this.noteAdd(this.definitions[this.index], mode); } } noteTryView() { const button = this.viewerButtonFind(this.index); if (button !== null && !button.classList.contains('disabled')) { apiNoteView(button.dataset.noteId); } } async noteAdd(definition, mode) { try { this.setSpinnerVisible(true); const context = {}; if (this.noteUsesScreenshot()) { const screenshot = await this.getScreenshot(); if (screenshot) { context.screenshot = screenshot; } } const noteId = await apiDefinitionAdd(definition, mode, context, this.optionsContext); if (noteId) { const index = this.definitions.indexOf(definition); const adderButton = this.adderButtonFind(index, mode); if (adderButton !== null) { adderButton.classList.add('disabled'); } const viewerButton = this.viewerButtonFind(index); if (viewerButton !== null) { viewerButton.classList.remove('pending', 'disabled'); viewerButton.dataset.noteId = noteId; } } else { throw 'Note could note be added'; } } catch (e) { this.onError(e); } finally { this.setSpinnerVisible(false); } } async audioPlay(definition, expressionIndex) { try { this.setSpinnerVisible(true); const expression = expressionIndex === -1 ? definition : definition.expressions[expressionIndex]; let url = await apiAudioGetUrl(expression, this.options.general.audioSource); if (!url) { url = '/mixed/mp3/button.mp3'; } for (const key in this.audioCache) { this.audioCache[key].pause(); } let audio = this.audioCache[url]; if (audio) { audio.currentTime = 0; audio.volume = this.options.general.audioVolume / 100.0; audio.play(); } else { audio = new Audio(url); audio.onloadeddata = () => { if (audio.duration === 5.694694 || audio.duration === 5.720718) { audio = new Audio('/mixed/mp3/button.mp3'); } this.audioCache[url] = audio; audio.volume = this.options.general.audioVolume / 100.0; audio.play(); }; } } catch (e) { this.onError(e); } finally { this.setSpinnerVisible(false); } } noteUsesScreenshot() { const fields = this.options.anki.terms.fields; for (const name in fields) { if (fields[name].includes('{screenshot}')) { return true; } } return false; } async getScreenshot() { try { await this.setPopupVisibleOverride(false); await Display.delay(1); // Wait for popup to be hidden. const {format, quality} = this.options.anki.screenshot; const dataUrl = await apiScreenshotGet({format, quality}); if (!dataUrl || dataUrl.error) { return; } return {dataUrl, format}; } finally { await this.setPopupVisibleOverride(null); } } get firstExpressionIndex() { return this.options.general.resultOutputMode === 'merge' ? 0 : -1; } setPopupVisibleOverride(visible) { return apiForward('popupSetVisibleOverride', {visible}); } setSpinnerVisible(visible) { this.spinner.style.display = visible ? 'block' : ''; } getEntry(index) { const entries = this.container.querySelectorAll('.entry'); return index >= 0 && index < entries.length ? entries[index] : null; } static clozeBuild(sentence, source) { const result = { sentence: sentence.text.trim() }; if (source) { result.prefix = sentence.text.substring(0, sentence.offset).trim(); result.body = source.trim(); result.suffix = sentence.text.substring(sentence.offset + source.length).trim(); } return result; } entryIndexFind(element) { const entry = element.closest('.entry'); return entry !== null ? Display.indexOf(this.container.querySelectorAll('.entry'), entry) : -1; } adderButtonFind(index, mode) { const entry = this.getEntry(index); return entry !== null ? entry.querySelector(`.action-add-note[data-mode="${mode}"]`) : null; } viewerButtonFind(index) { const entry = this.getEntry(index); return entry !== null ? entry.querySelector('.action-view-note') : null; } static delay(time) { return new Promise((resolve) => setTimeout(resolve, time)); } static indexOf(nodeList, node) { for (let i = 0, ii = nodeList.length; i < ii; ++i) { if (nodeList[i] === node) { return i; } } return -1; } addEventListeners(selector, type, listener, options) { this.container.querySelectorAll(selector).forEach((node) => { node.addEventListener(type, listener, options); this.eventListeners.push([node, type, listener, options]); }); } clearEventListeners() { for (const [node, type, listener, options] of this.eventListeners) { node.removeEventListener(type, listener, options); } this.eventListeners = []; } static getElementTop(element) { const elementRect = element.getBoundingClientRect(); const documentRect = document.documentElement.getBoundingClientRect(); return elementRect.top - documentRect.top; } static getKeyFromEvent(event) { const key = event.key; return key.length === 1 ? key.toUpperCase() : key; } } Display.onKeyDownHandlers = { 'Escape': (self) => { self.onSearchClear(); return true; }, 'PageUp': (self, e) => { if (e.altKey) { self.entryScrollIntoView(self.index - 3, null, true); return true; } return false; }, 'PageDown': (self, e) => { if (e.altKey) { self.entryScrollIntoView(self.index + 3, null, true); return true; } return false; }, 'End': (self, e) => { if (e.altKey) { self.entryScrollIntoView(self.definitions.length - 1, null, true); return true; } return false; }, 'Home': (self, e) => { if (e.altKey) { self.entryScrollIntoView(0, null, true); return true; } return false; }, 'ArrowUp': (self, e) => { if (e.altKey) { self.entryScrollIntoView(self.index - 1, null, true); return true; } return false; }, 'ArrowDown': (self, e) => { if (e.altKey) { self.entryScrollIntoView(self.index + 1, null, true); return true; } return false; }, 'B': (self, e) => { if (e.altKey) { self.sourceTermView(); return true; } return false; }, 'E': (self, e) => { if (e.altKey) { self.noteTryAdd('term-kanji'); return true; } return false; }, 'K': (self, e) => { if (e.altKey) { self.noteTryAdd('kanji'); return true; } return false; }, 'R': (self, e) => { if (e.altKey) { self.noteTryAdd('term-kana'); return true; } return false; }, 'P': (self, e) => { if (e.altKey) { const entry = self.getEntry(self.index); if (entry !== null && entry.dataset.type === 'term') { self.audioPlay(self.definitions[self.index], self.firstExpressionIndex); } return true; } return false; }, 'V': (self, e) => { if (e.altKey) { self.noteTryView(); return true; } return false; } };