yomichan/ext/mixed/js/display.js

423 lines
12 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 = {};
this.responseCache = {};
2017-03-19 00:40:48 +00:00
$(document).keydown(this.onKeyDown.bind(this));
2017-03-05 01:30:10 +00:00
}
definitionAdd(definition, mode) {
throw 'override me';
}
2017-03-05 01:56:10 +00:00
definitionsAddable(definitions, modes) {
2017-03-05 01:30:10 +00:00
throw 'override me';
}
2017-07-02 01:27:49 +00:00
noteView(noteId) {
throw 'override me';
}
2017-03-05 03:16:19 +00:00
templateRender(template, data) {
2017-03-05 01:30:10 +00:00
throw 'override me';
}
kanjiFind(character) {
throw 'override me';
}
handleError(error) {
throw 'override me';
}
2017-03-25 22:59:33 +00:00
clearSearch() {
throw 'override me';
}
2017-03-05 01:30:10 +00:00
showTermDefs(definitions, options, context) {
2017-03-19 00:40:48 +00:00
window.focus();
2017-03-18 16:48:53 +00:00
this.spinner.hide();
this.definitions = definitions;
2017-03-19 22:45:30 +00:00
this.options = options;
2017-03-25 05:49:14 +00:00
this.context = context;
2017-03-18 16:48:53 +00:00
2017-03-05 01:30:10 +00:00
const sequence = ++this.sequence;
const params = {
definitions,
2017-03-05 04:10:49 +00:00
addable: options.anki.enable,
2017-03-05 01:30:10 +00:00
grouped: options.general.groupResults,
2017-05-24 04:27:20 +00:00
playback: options.general.audioSource !== 'disabled',
debug: options.general.debugInfo
2017-03-05 01:30:10 +00:00
};
if (context) {
2017-03-18 16:48:53 +00:00
for (const definition of definitions) {
2017-04-09 18:36:52 +00:00
if (context.sentence) {
2017-07-16 19:48:27 +00:00
definition.cloze = Display.clozeBuild(context.sentence, definition.source);
2017-04-09 18:36:52 +00:00
}
2017-03-29 03:49:26 +00:00
definition.url = context.url;
2017-03-18 16:48:53 +00:00
}
2017-03-05 01:30:10 +00:00
}
2017-03-05 03:16:19 +00:00
this.templateRender('terms.html', params).then(content => {
2017-03-05 01:30:10 +00:00
this.container.html(content);
2017-03-25 05:49:14 +00:00
this.entryScroll(context && context.index || 0);
2017-03-18 16:48:53 +00:00
2017-03-19 22:45:30 +00:00
$('.action-add-note').click(this.onAddNote.bind(this));
2017-07-02 01:27:49 +00:00
$('.action-view-note').click(this.onViewNote.bind(this));
2017-03-19 22:45:30 +00:00
$('.action-play-audio').click(this.onPlayAudio.bind(this));
$('.kanji-link').click(this.onKanjiLookup.bind(this));
2017-03-05 03:27:54 +00:00
2017-03-05 03:53:28 +00:00
return this.adderButtonsUpdate(['term-kanji', 'term-kana'], sequence);
2017-03-05 01:30:10 +00:00
}).catch(this.handleError.bind(this));
}
2017-03-05 02:24:57 +00:00
showKanjiDefs(definitions, options, context) {
2017-03-19 00:40:48 +00:00
window.focus();
2017-03-18 16:48:53 +00:00
this.spinner.hide();
this.definitions = definitions;
2017-03-19 22:45:30 +00:00
this.options = options;
2017-03-25 05:49:14 +00:00
this.context = context;
2017-03-18 16:48:53 +00:00
2017-03-05 01:30:10 +00:00
const sequence = ++this.sequence;
const params = {
definitions,
2017-03-18 04:03:52 +00:00
source: context && context.source,
2017-05-24 04:27:20 +00:00
addable: options.anki.enable,
debug: options.general.debugInfo
2017-03-05 01:30:10 +00:00
};
if (context) {
2017-03-18 16:48:53 +00:00
for (const definition of definitions) {
2017-04-09 18:36:52 +00:00
if (context.sentence) {
2017-07-16 19:48:27 +00:00
definition.cloze = Display.clozeBuild(context.sentence);
2017-04-09 18:36:52 +00:00
}
2017-03-29 03:49:26 +00:00
definition.url = context.url;
2017-03-18 16:48:53 +00:00
}
2017-03-05 01:30:10 +00:00
}
2017-03-05 03:16:19 +00:00
this.templateRender('kanji.html', params).then(content => {
2017-03-05 01:30:10 +00:00
this.container.html(content);
2017-03-25 05:49:14 +00:00
this.entryScroll(context && context.index || 0);
2017-03-16 04:13:58 +00:00
2017-03-19 22:45:30 +00:00
$('.action-add-note').click(this.onAddNote.bind(this));
$('.source-term').click(this.onSourceTerm.bind(this));
2017-03-16 04:13:58 +00:00
2017-03-05 01:30:10 +00:00
return this.adderButtonsUpdate(['kanji'], sequence);
}).catch(this.handleError.bind(this));
}
adderButtonsUpdate(modes, sequence) {
return this.definitionsAddable(this.definitions, modes).then(states => {
2017-07-02 01:27:49 +00:00
if (!states || sequence !== this.sequence) {
2017-03-05 01:30:10 +00:00
return;
}
states.forEach((state, index) => {
for (const mode in state) {
2017-03-18 16:48:53 +00:00
const button = Display.adderButtonFind(index, mode);
2017-03-05 01:30:10 +00:00
if (state[mode]) {
button.removeClass('disabled');
} else {
button.addClass('disabled');
}
button.removeClass('pending');
}
});
});
}
2017-03-19 00:40:48 +00:00
entryScroll(index, smooth) {
2017-03-25 19:21:25 +00:00
index = Math.min(index, this.definitions.length - 1);
index = Math.max(index, 0);
2017-03-19 00:40:48 +00:00
2017-03-19 00:53:21 +00:00
$('.current').hide().eq(index).show();
2017-03-25 23:45:43 +00:00
const container = $('html,body').stop();
2017-03-19 00:40:48 +00:00
const entry = $('.entry').eq(index);
2017-03-19 00:53:21 +00:00
const target = index === 0 ? 0 : entry.offset().top;
2017-03-19 00:40:48 +00:00
if (smooth) {
2017-03-25 23:45:43 +00:00
container.animate({scrollTop: target}, 200);
2017-03-19 00:40:48 +00:00
} else {
2017-03-25 23:45:43 +00:00
container.scrollTop(target);
2017-03-19 00:40:48 +00:00
}
this.index = index;
}
2017-03-19 22:45:30 +00:00
onSourceTerm(e) {
2017-03-05 01:30:10 +00:00
e.preventDefault();
2017-03-26 01:08:42 +00:00
this.sourceBack();
2017-03-19 22:45:30 +00:00
}
2017-03-05 01:30:10 +00:00
2017-03-19 22:45:30 +00:00
onKanjiLookup(e) {
e.preventDefault();
const link = $(e.target);
const context = {
source: {
2017-03-25 05:49:14 +00:00
definitions: this.definitions,
2017-03-19 22:45:30 +00:00
index: Display.entryIndexFind(link)
2017-03-05 01:30:10 +00:00
}
2017-03-19 22:45:30 +00:00
};
if (this.context) {
2017-04-08 04:17:13 +00:00
context.sentence = this.context.sentence;
2017-03-25 05:49:14 +00:00
context.url = this.context.url;
2017-03-19 22:45:30 +00:00
}
this.kanjiFind(link.text()).then(kanjiDefs => {
2017-03-25 05:49:14 +00:00
this.showKanjiDefs(kanjiDefs, this.options, context);
2017-03-19 22:45:30 +00:00
}).catch(this.handleError.bind(this));
}
onPlayAudio(e) {
e.preventDefault();
const index = Display.entryIndexFind($(e.currentTarget));
this.audioPlay(this.definitions[index]);
}
onAddNote(e) {
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-07-02 01:27:49 +00:00
onViewNote(e) {
e.preventDefault();
const link = $(e.currentTarget);
const index = Display.entryIndexFind(link);
this.noteView(link.data('noteId'));
}
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')) {
this.noteView(button.data('noteId'));
}
};
2017-03-19 01:08:09 +00:00
const handlers = {
2017-03-25 22:59:33 +00:00
27: /* escape */ () => {
this.clearSearch();
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.entryScroll(this.index - 3, true);
return true;
}
2017-03-25 19:21:25 +00:00
},
34: /* page down */ () => {
if (e.altKey) {
this.entryScroll(this.index + 3, 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.entryScroll(this.definitions.length - 1, true);
return true;
}
2017-03-25 22:59:33 +00:00
},
36: /* home */ () => {
if (e.altKey) {
this.entryScroll(0, 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.entryScroll(this.index - 1, true);
return true;
}
2017-03-19 01:08:09 +00:00
},
40: /* down */ () => {
if (e.altKey) {
this.entryScroll(this.index + 1, true);
return true;
}
2017-03-19 01:08:09 +00:00
},
2017-03-26 01:08:42 +00:00
66: /* b */ () => {
if (e.altKey) {
this.sourceBack();
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') {
this.audioPlay(this.definitions[this.index]);
}
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();
}
}
2017-03-26 01:08:42 +00:00
sourceBack() {
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,
2017-03-26 01:08:42 +00:00
index: this.context.source.index
};
this.showTermDefs(this.context.source.definitions, this.options, context);
}
}
2017-03-25 05:49:14 +00:00
noteAdd(definition, mode) {
2017-03-19 22:45:30 +00:00
this.spinner.show();
2017-07-02 01:27:49 +00:00
return this.definitionAdd(definition, mode).then(noteId => {
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 {
this.handleError('note could not be added');
2017-03-19 22:45:30 +00:00
}
}).catch(this.handleError.bind(this)).then(() => this.spinner.hide());
}
2017-03-25 05:49:14 +00:00
audioPlay(definition) {
2017-03-23 04:57:16 +00:00
this.spinner.show();
2017-03-23 05:28:22 +00:00
for (const key in this.audioCache) {
2017-03-24 02:54:36 +00:00
this.audioCache[key].pause();
2017-03-05 01:30:10 +00:00
}
audioBuildUrl(definition, this.options.general.audioSource, this.responseCache).then(url => {
2017-03-24 02:54:36 +00:00
if (!url) {
url = '/mixed/mp3/button.mp3';
}
2017-03-05 01:30:10 +00:00
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();
};
}
}).catch(this.handleError.bind(this)).then(() => this.spinner.hide());
2017-03-18 16:48:53 +00:00
}
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');
}
2017-03-05 01:30:10 +00:00
}