yomichan/ext/mixed/js/display.js

572 lines
17 KiB
JavaScript
Raw Normal View History

2017-03-05 01:30:10 +00:00
/*
* 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 = [];
2017-03-29 03:49:26 +00:00
this.options = null;
this.context = null;
2017-03-05 01:30:10 +00:00
this.sequence = 0;
2017-03-19 00:40:48 +00:00
this.index = 0;
2017-03-29 03:49:26 +00:00
this.audioCache = {};
2017-03-19 00:40:48 +00:00
2019-08-03 12:06:28 +00:00
this.dependencies = {};
2017-03-19 00:40:48 +00:00
$(document).keydown(this.onKeyDown.bind(this));
$(document).on('wheel', this.onWheel.bind(this));
2017-03-05 01:30:10 +00:00
}
2017-08-13 23:11:51 +00:00
onError(error) {
2017-09-23 02:39:05 +00:00
throw 'Override me';
2017-03-05 01:30:10 +00:00
}
2017-08-13 23:11:51 +00:00
onSearchClear() {
2017-09-23 02:39:05 +00:00
throw 'Override me';
2017-03-25 22:59:33 +00:00
}
2017-08-13 23:11:51 +00:00
onSourceTermView(e) {
2017-03-05 01:30:10 +00:00
e.preventDefault();
2017-08-15 04:43:09 +00:00
this.sourceTermView();
2017-03-19 22:45:30 +00:00
}
2017-03-05 01:30:10 +00:00
2017-08-13 23:11:51 +00:00
async onKanjiLookup(e) {
try {
e.preventDefault();
2017-03-19 22:45:30 +00:00
2017-08-13 23:11:51 +00:00
const link = $(e.target);
const context = {
source: {
definitions: this.definitions,
index: Display.entryIndexFind(link),
scroll: $('html,body').scrollTop()
2017-08-13 23:11:51 +00:00
}
};
if (this.context) {
context.sentence = this.context.sentence;
context.url = this.context.url;
2019-08-03 12:50:49 +00:00
context.source.source = this.context.source;
2017-03-05 01:30:10 +00:00
}
2017-03-19 22:45:30 +00:00
2017-08-13 23:11:51 +00:00
const kanjiDefs = await apiKanjiFind(link.text());
this.kanjiShow(kanjiDefs, this.options, context);
} catch (e) {
this.onError(e);
2017-03-19 22:45:30 +00:00
}
}
2019-08-03 12:06:28 +00:00
async onTermLookup(e) {
try {
e.preventDefault();
const {docRangeFromPoint, docSentenceExtract} = this.dependencies;
const clickedElement = $(e.target);
const textSource = docRangeFromPoint({x: e.clientX, y: e.clientY});
if (textSource === null) {
return false;
}
2019-08-03 12:06:28 +00:00
let definitions, length, sentence;
try {
textSource.setEndOffset(this.options.scanning.length);
2019-08-03 12:06:28 +00:00
({definitions, length} = await apiTermsFind(textSource.text()));
if (definitions.length === 0) {
return false;
}
2019-08-03 12:06:28 +00:00
textSource.setEndOffset(length);
sentence = docSentenceExtract(textSource, this.options.anki.sentenceExt);
} finally {
textSource.cleanup();
}
2019-08-03 12:06:28 +00:00
const context = {
source: {
definitions: this.definitions,
index: Display.entryIndexFind(clickedElement),
scroll: $('html,body').scrollTop()
2019-08-03 12:06:28 +00:00
}
};
if (this.context) {
context.sentence = sentence;
context.url = this.context.url;
2019-08-03 12:50:49 +00:00
context.source.source = this.context.source;
2019-08-03 12:06:28 +00:00
}
this.termsShow(definitions, this.options, context);
} catch (e) {
this.onError(e);
}
}
2017-08-13 23:11:51 +00:00
onAudioPlay(e) {
2017-03-19 22:45:30 +00:00
e.preventDefault();
const link = $(e.currentTarget);
const definitionIndex = Display.entryIndexFind(link);
const expressionIndex = link.closest('.entry').find('.expression .action-play-audio').index(link);
this.audioPlay(this.definitions[definitionIndex], expressionIndex);
2017-03-19 22:45:30 +00:00
}
2017-08-13 23:11:51 +00:00
onNoteAdd(e) {
2017-03-19 22:45:30 +00:00
e.preventDefault();
const link = $(e.currentTarget);
const index = Display.entryIndexFind(link);
2017-03-25 05:49:14 +00:00
this.noteAdd(this.definitions[index], link.data('mode'));
2017-03-05 01:30:10 +00:00
}
2017-08-13 23:11:51 +00:00
onNoteView(e) {
2017-07-02 01:27:49 +00:00
e.preventDefault();
const link = $(e.currentTarget);
const index = Display.entryIndexFind(link);
2017-07-24 05:48:33 +00:00
apiNoteView(link.data('noteId'));
2017-07-02 01:27:49 +00:00
}
2017-03-19 00:40:48 +00:00
onKeyDown(e) {
2017-03-26 00:53:25 +00:00
const noteTryAdd = mode => {
const button = Display.adderButtonFind(this.index, mode);
if (button.length !== 0 && !button.hasClass('disabled')) {
this.noteAdd(this.definitions[this.index], mode);
}
};
2017-07-02 01:27:49 +00:00
const noteTryView = mode => {
const button = Display.viewerButtonFind(this.index);
if (button.length !== 0 && !button.hasClass('disabled')) {
2017-07-24 05:48:33 +00:00
apiNoteView(button.data('noteId'));
2017-07-02 01:27:49 +00:00
}
};
2017-03-19 01:08:09 +00:00
const handlers = {
2017-03-25 22:59:33 +00:00
27: /* escape */ () => {
2017-08-13 23:11:51 +00:00
this.onSearchClear();
return true;
2017-03-19 01:08:09 +00:00
},
2017-03-25 19:21:25 +00:00
33: /* page up */ () => {
if (e.altKey) {
this.entryScrollIntoView(this.index - 3, null, true);
return true;
}
2017-03-25 19:21:25 +00:00
},
34: /* page down */ () => {
if (e.altKey) {
this.entryScrollIntoView(this.index + 3, null, true);
return true;
}
2017-03-25 19:21:25 +00:00
},
2017-03-25 22:59:33 +00:00
35: /* end */ () => {
if (e.altKey) {
this.entryScrollIntoView(this.definitions.length - 1, null, true);
return true;
}
2017-03-25 22:59:33 +00:00
},
36: /* home */ () => {
if (e.altKey) {
this.entryScrollIntoView(0, null, true);
return true;
}
2017-03-25 22:59:33 +00:00
},
2017-03-19 01:08:09 +00:00
38: /* up */ () => {
if (e.altKey) {
this.entryScrollIntoView(this.index - 1, null, true);
return true;
}
2017-03-19 01:08:09 +00:00
},
40: /* down */ () => {
if (e.altKey) {
this.entryScrollIntoView(this.index + 1, null, true);
return true;
}
2017-03-19 01:08:09 +00:00
},
2017-03-26 01:08:42 +00:00
66: /* b */ () => {
if (e.altKey) {
2017-08-15 04:43:09 +00:00
this.sourceTermView();
return true;
}
2017-03-26 01:08:42 +00:00
},
2017-03-26 00:18:55 +00:00
69: /* e */ () => {
if (e.altKey) {
noteTryAdd('term-kanji');
return true;
}
2017-03-19 01:08:09 +00:00
},
2017-03-26 00:18:55 +00:00
75: /* k */ () => {
if (e.altKey) {
noteTryAdd('kanji');
return true;
}
2017-03-26 00:53:25 +00:00
},
82: /* r */ () => {
if (e.altKey) {
noteTryAdd('term-kana');
return true;
}
2017-03-19 01:21:02 +00:00
},
2017-03-26 00:18:55 +00:00
80: /* p */ () => {
if (e.altKey) {
if ($('.entry').eq(this.index).data('type') === 'term') {
2017-12-16 18:56:53 +00:00
this.audioPlay(this.definitions[this.index], this.firstExpressionIndex);
}
return true;
2017-03-26 00:53:25 +00:00
}
2017-07-02 01:27:49 +00:00
},
86: /* v */ () => {
if (e.altKey) {
noteTryView();
}
2017-03-19 01:08:09 +00:00
}
};
const handler = handlers[e.keyCode];
if (handler && handler()) {
2017-03-19 00:40:48 +00:00
e.preventDefault();
}
}
onWheel(e) {
const event = e.originalEvent;
const handler = () => {
if (event.altKey) {
if (event.deltaY < 0) { // scroll up
this.entryScrollIntoView(this.index - 1, null, true);
return true;
} else if (event.deltaY > 0) { // scroll down
this.entryScrollIntoView(this.index + 1, null, true);
return true;
}
}
};
if (handler()) {
event.preventDefault();
}
}
2017-08-13 23:11:51 +00:00
async termsShow(definitions, options, context) {
try {
if (!context || context.focus !== false) {
window.focus();
}
2017-08-13 23:11:51 +00:00
this.definitions = definitions;
this.options = options;
this.context = context;
const sequence = ++this.sequence;
const params = {
definitions,
2019-08-03 16:54:01 +00:00
source: context && context.source,
2017-08-13 23:11:51 +00:00
addable: options.anki.enable,
grouped: options.general.resultOutputMode === 'group',
merged: options.general.resultOutputMode === 'merge',
2017-08-13 23:11:51 +00:00
playback: options.general.audioSource !== 'disabled',
compactGlossaries: options.general.compactGlossaries,
2017-08-13 23:11:51 +00:00
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.html(content);
const {index, scroll} = context || {};
this.entryScrollIntoView(index || 0, scroll);
2017-08-13 23:11:51 +00:00
2017-12-16 18:56:53 +00:00
if (this.options.general.autoPlayAudio && this.options.general.audioSource !== 'disabled') {
this.autoPlayAudio();
}
2017-08-13 23:11:51 +00:00
$('.action-add-note').click(this.onNoteAdd.bind(this));
$('.action-view-note').click(this.onNoteView.bind(this));
$('.action-play-audio').click(this.onAudioPlay.bind(this));
$('.kanji-link').click(this.onKanjiLookup.bind(this));
2019-08-03 16:54:01 +00:00
$('.source-term').click(this.onSourceTermView.bind(this));
$('.glossary-item').click(this.onTermLookup.bind(this));
2017-08-13 23:11:51 +00:00
await this.adderButtonUpdate(['term-kanji', 'term-kana'], sequence);
} catch (e) {
this.onError(e);
}
}
async kanjiShow(definitions, options, context) {
try {
if (!context || context.focus !== false) {
window.focus();
}
2017-08-13 23:11:51 +00:00
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.html(content);
const {index, scroll} = context || {};
this.entryScrollIntoView(index || 0, scroll);
2017-08-13 23:11:51 +00:00
$('.action-add-note').click(this.onNoteAdd.bind(this));
2017-08-15 04:43:09 +00:00
$('.action-view-note').click(this.onNoteView.bind(this));
2017-08-13 23:11:51 +00:00
$('.source-term').click(this.onSourceTermView.bind(this));
await this.adderButtonUpdate(['kanji'], sequence);
} catch (e) {
this.onError(e);
}
}
2017-12-16 18:56:53 +00:00
autoPlayAudio() {
this.audioPlay(this.definitions[0], this.firstExpressionIndex);
}
2017-08-13 23:11:51 +00:00
async adderButtonUpdate(modes, sequence) {
try {
2017-08-15 04:43:09 +00:00
const states = await apiDefinitionsAddable(this.definitions, modes);
2017-08-13 23:11:51 +00:00
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 = Display.adderButtonFind(i, mode);
if (state[mode]) {
button.removeClass('disabled');
} else {
button.addClass('disabled');
}
button.removeClass('pending');
}
}
} catch (e) {
this.onError(e);
}
}
entryScrollIntoView(index, scroll, smooth) {
2017-08-13 23:11:51 +00:00
index = Math.min(index, this.definitions.length - 1);
index = Math.max(index, 0);
$('.current').hide().eq(index).show();
const container = $('html,body').stop();
const entry = $('.entry').eq(index);
let target;
if (scroll) {
target = scroll;
} else {
target = index === 0 ? 0 : entry.offset().top;
}
2017-08-13 23:11:51 +00:00
if (smooth) {
container.animate({scrollTop: target}, 200);
} else {
container.scrollTop(target);
}
this.index = index;
}
2017-08-15 04:43:09 +00:00
sourceTermView() {
2017-03-26 01:08:42 +00:00
if (this.context && this.context.source) {
const context = {
url: this.context.source.url,
2017-04-08 04:17:13 +00:00
sentence: this.context.source.sentence,
2019-08-03 12:50:49 +00:00
index: this.context.source.index,
scroll: this.context.source.scroll,
2019-08-03 12:50:49 +00:00
source: this.context.source.source
2017-03-26 01:08:42 +00:00
};
2017-08-13 23:11:51 +00:00
this.termsShow(this.context.source.definitions, this.options, context);
2017-03-26 01:08:42 +00:00
}
}
2017-08-13 23:11:51 +00:00
async noteAdd(definition, mode) {
try {
this.spinner.show();
const context = {};
if (this.noteUsesScreenshot()) {
const screenshot = await this.getScreenshot();
if (screenshot) {
context.screenshot = screenshot;
}
}
const noteId = await apiDefinitionAdd(definition, mode, context);
2017-07-02 01:27:49 +00:00
if (noteId) {
2017-03-25 17:46:59 +00:00
const index = this.definitions.indexOf(definition);
Display.adderButtonFind(index, mode).addClass('disabled');
2017-07-02 01:27:49 +00:00
Display.viewerButtonFind(index).removeClass('pending disabled').data('noteId', noteId);
2017-03-25 17:46:59 +00:00
} else {
2017-09-23 02:39:05 +00:00
throw 'Note could note 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.spinner.hide();
}
2017-03-19 22:45:30 +00:00
}
async audioPlay(definition, expressionIndex) {
2017-08-13 23:11:51 +00:00
try {
this.spinner.show();
2017-03-05 01:30:10 +00:00
2017-10-28 15:11:33 +00:00
const expression = expressionIndex === -1 ? definition : definition.expressions[expressionIndex];
let url = await apiAudioGetUrl(expression, this.options.general.audioSource);
2017-03-24 02:54:36 +00:00
if (!url) {
url = '/mixed/mp3/button.mp3';
}
2017-03-05 01:30:10 +00:00
2017-08-13 23:11:51 +00:00
for (const key in this.audioCache) {
this.audioCache[key].pause();
}
2017-03-23 05:28:22 +00:00
let audio = this.audioCache[url];
2017-03-23 04:57:16 +00:00
if (audio) {
audio.currentTime = 0;
audio.volume = this.options.general.audioVolume / 100.0;
2017-03-05 01:30:10 +00:00
audio.play();
2017-03-23 04:57:16 +00:00
} else {
audio = new Audio(url);
audio.onloadeddata = () => {
if (audio.duration === 5.694694 || audio.duration === 5.720718) {
audio = new Audio('/mixed/mp3/button.mp3');
}
2017-03-05 01:30:10 +00:00
2017-03-23 05:28:22 +00:00
this.audioCache[url] = audio;
audio.volume = this.options.general.audioVolume / 100.0;
2017-03-23 04:57:16 +00:00
audio.play();
};
}
2017-08-13 23:11:51 +00:00
} catch (e) {
this.onError(e);
} finally {
this.spinner.hide();
}
2017-03-18 16:48:53 +00:00
}
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.setPopupVisible(false);
await Display.delay(1); // Wait for popup to be hidden.
2019-08-15 23:56:14 +00:00
const {format, quality} = this.options.anki.screenshot;
const dataUrl = await apiScreenshotGet({format, quality});
if (!dataUrl || dataUrl.error) { return; }
return {dataUrl, format};
} finally {
await this.setPopupVisible(true);
}
}
2017-12-16 18:56:53 +00:00
get firstExpressionIndex() {
return this.options.general.resultOutputMode === 'merge' ? 0 : -1;
}
setPopupVisible(visible) {
return apiForward('popupSetVisible', {visible});
}
2017-07-16 19:48:27 +00:00
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;
}
2017-03-23 05:28:22 +00:00
static entryIndexFind(element) {
return $('.entry').index(element.closest('.entry'));
}
static adderButtonFind(index, mode) {
return $('.entry').eq(index).find(`.action-add-note[data-mode="${mode}"]`);
}
2017-07-02 01:27:49 +00:00
static viewerButtonFind(index) {
return $('.entry').eq(index).find('.action-view-note');
}
static delay(time) {
return new Promise((resolve) => setTimeout(resolve, time));
}
2017-03-05 01:30:10 +00:00
}