yomichan/ext/js/pages/settings/dictionary-controller.js

741 lines
27 KiB
JavaScript

/*
* Copyright (C) 2020-2021 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
* DictionaryDatabase
*/
class DictionaryEntry {
constructor(dictionaryController, fragment, index, dictionaryInfo) {
this._dictionaryController = dictionaryController;
this._index = index;
this._dictionaryInfo = dictionaryInfo;
this._eventListeners = new EventListenerCollection();
this._counts = null;
this._nodes = [...fragment.childNodes];
this._enabledCheckbox = fragment.querySelector('.dictionary-enabled');
this._priorityInput = fragment.querySelector('.dictionary-priority');
this._menuButton = fragment.querySelector('.dictionary-menu-button');
this._outdatedButton = fragment.querySelector('.dictionary-outdated-button');
this._integrityButton = fragment.querySelector('.dictionary-integrity-button');
this._titleNode = fragment.querySelector('.dictionary-title');
this._versionNode = fragment.querySelector('.dictionary-version');
this._titleContainer = fragment.querySelector('.dictionary-item-title-container');
}
get dictionaryTitle() {
return this._dictionaryInfo.title;
}
prepare() {
const index = this._index;
const {title, revision, version} = this._dictionaryInfo;
this._titleNode.textContent = title;
this._versionNode.textContent = `rev.${revision}`;
this._outdatedButton.hidden = (version >= 3);
this._priorityInput.dataset.setting = `dictionaries[${index}].priority`;
this._enabledCheckbox.dataset.setting = `dictionaries[${index}].enabled`;
this._eventListeners.addEventListener(this._enabledCheckbox, 'settingChanged', this._onEnabledChanged.bind(this), false);
this._eventListeners.addEventListener(this._menuButton, 'menuOpen', this._onMenuOpen.bind(this), false);
this._eventListeners.addEventListener(this._menuButton, 'menuClose', this._onMenuClose.bind(this), false);
this._eventListeners.addEventListener(this._outdatedButton, 'click', this._onOutdatedButtonClick.bind(this), false);
this._eventListeners.addEventListener(this._integrityButton, 'click', this._onIntegrityButtonClick.bind(this), false);
}
cleanup() {
this._eventListeners.removeAllEventListeners();
for (const node of this._nodes) {
if (node.parentNode !== null) {
node.parentNode.removeChild(node);
}
}
this._nodes = [];
}
setCounts(counts) {
this._counts = counts;
this._integrityButton.hidden = false;
}
setEnabled(value) {
this._enabledCheckbox.checked = value;
}
// Private
_onMenuOpen(e) {
const bodyNode = e.detail.menu.bodyNode;
const count = this._dictionaryController.dictionaryOptionCount;
this._setMenuActionEnabled(bodyNode, 'moveUp', this._index > 0);
this._setMenuActionEnabled(bodyNode, 'moveDown', this._index < count - 1);
this._setMenuActionEnabled(bodyNode, 'moveTo', count > 1);
}
_onMenuClose(e) {
switch (e.detail.action) {
case 'delete':
this._delete();
break;
case 'showDetails':
this._showDetails();
break;
case 'moveUp':
this._move(-1);
break;
case 'moveDown':
this._move(1);
break;
case 'moveTo':
this._showMoveToModal();
break;
}
}
_onEnabledChanged(e) {
const {detail: {value}} = e;
this._titleContainer.dataset.enabled = `${value}`;
this._dictionaryController.updateDictionariesEnabled();
}
_onOutdatedButtonClick() {
this._showDetails();
}
_onIntegrityButtonClick() {
this._showDetails();
}
_showDetails() {
const {title, revision, version, prefixWildcardsSupported} = this._dictionaryInfo;
const modal = this._dictionaryController.modalController.getModal('dictionary-details');
modal.node.querySelector('.dictionary-title').textContent = title;
modal.node.querySelector('.dictionary-version').textContent = `rev.${revision}`;
modal.node.querySelector('.dictionary-outdated-notification').hidden = (version >= 3);
modal.node.querySelector('.dictionary-counts').textContent = this._counts !== null ? JSON.stringify(this._counts, null, 4) : '';
modal.node.querySelector('.dictionary-prefix-wildcard-searches-supported').checked = prefixWildcardsSupported;
this._setupDetails(modal.node.querySelector('.dictionary-details-table'));
modal.setVisible(true);
}
_setupDetails(detailsTable) {
const targets = [
['Author', 'author'],
['URL', 'url'],
['Description', 'description'],
['Attribution', 'attribution']
];
const dictionaryInfo = this._dictionaryInfo;
const fragment = document.createDocumentFragment();
let any = false;
for (const [label, key] of targets) {
const info = dictionaryInfo[key];
if (typeof info !== 'string') { continue; }
const details = this._dictionaryController.instantiateTemplate('dictionary-details-entry');
details.dataset.type = key;
details.querySelector('.dictionary-details-entry-label').textContent = `${label}:`;
details.querySelector('.dictionary-details-entry-info').textContent = info;
fragment.appendChild(details);
any = true;
}
detailsTable.textContent = '';
detailsTable.appendChild(fragment);
return any;
}
_delete() {
this._dictionaryController.deleteDictionary(this.dictionaryTitle);
}
_move(offset) {
this._dictionaryController.moveDictionaryOptions(this._index, this._index + offset);
}
_setMenuActionEnabled(menu, action, enabled) {
const element = menu.querySelector(`[data-menu-action="${action}"]`);
if (element === null) { return; }
element.disabled = !enabled;
}
_showMoveToModal() {
const {title} = this._dictionaryInfo;
const count = this._dictionaryController.dictionaryOptionCount;
const modal = this._dictionaryController.modalController.getModal('dictionary-move-location');
const input = modal.node.querySelector('#dictionary-move-location');
modal.node.dataset.index = `${this._index}`;
modal.node.querySelector('.dictionary-title').textContent = title;
input.value = `${this._index + 1}`;
input.max = `${count}`;
modal.setVisible(true);
}
}
class DictionaryExtraInfo {
constructor(parent, totalCounts, remainders, totalRemainder) {
this._parent = parent;
this._totalCounts = totalCounts;
this._remainders = remainders;
this._totalRemainder = totalRemainder;
this._eventListeners = new EventListenerCollection();
this._nodes = null;
}
prepare(container) {
const fragment = this._parent.instantiateTemplateFragment('dictionary-extra');
this._nodes = [...fragment.childNodes];
this._setTitle(fragment.querySelector('.dictionary-total-count'));
this._eventListeners.addEventListener(fragment.querySelector('.dictionary-integrity-button'), 'click', this._onIntegrityButtonClick.bind(this), false);
container.appendChild(fragment);
}
cleanup() {
this._eventListeners.removeAllEventListeners();
for (const node of this._nodes) {
if (node.parentNode !== null) {
node.parentNode.removeChild(node);
}
}
this._nodes = [];
}
// Private
_onIntegrityButtonClick() {
this._showDetails();
}
_showDetails() {
const modal = this._parent.modalController.getModal('dictionary-extra-data');
const info = {counts: this._totalCounts, remainders: this._remainders};
modal.node.querySelector('.dictionary-counts').textContent = JSON.stringify(info, null, 4);
this._setTitle(modal.node.querySelector('.dictionary-total-count'));
modal.setVisible(true);
}
_setTitle(node) {
node.textContent = `${this._totalRemainder} item${this._totalRemainder !== 1 ? 's' : ''}`;
}
}
class DictionaryController {
constructor(settingsController, modalController, statusFooter) {
this._settingsController = settingsController;
this._modalController = modalController;
this._statusFooter = statusFooter;
this._dictionaries = null;
this._dictionaryEntries = [];
this._databaseStateToken = null;
this._checkingIntegrity = false;
this._checkIntegrityButton = null;
this._dictionaryEntryContainer = null;
this._dictionaryInstallCountNode = null;
this._dictionaryEnabledCountNode = null;
this._noDictionariesInstalledWarnings = null;
this._noDictionariesEnabledWarnings = null;
this._deleteDictionaryModal = null;
this._allCheckbox = null;
this._extraInfo = null;
this._isDeleting = false;
}
get modalController() {
return this._modalController;
}
get dictionaryOptionCount() {
return this._dictionaryEntries.length;
}
async prepare() {
this._checkIntegrityButton = document.querySelector('#dictionary-check-integrity');
this._dictionaryEntryContainer = document.querySelector('#dictionary-list');
this._dictionaryInstallCountNode = document.querySelector('#dictionary-install-count');
this._dictionaryEnabledCountNode = document.querySelector('#dictionary-enabled-count');
this._noDictionariesInstalledWarnings = document.querySelectorAll('.no-dictionaries-installed-warning');
this._noDictionariesEnabledWarnings = document.querySelectorAll('.no-dictionaries-enabled-warning');
this._deleteDictionaryModal = this._modalController.getModal('dictionary-confirm-delete');
this._allCheckbox = document.querySelector('#all-dictionaries-enabled');
yomichan.on('databaseUpdated', this._onDatabaseUpdated.bind(this));
this._settingsController.on('optionsChanged', this._onOptionsChanged.bind(this));
this._allCheckbox.addEventListener('change', this._onAllCheckboxChange.bind(this), false);
document.querySelector('#dictionary-confirm-delete-button').addEventListener('click', this._onDictionaryConfirmDelete.bind(this), false);
document.querySelector('#dictionary-move-button').addEventListener('click', this._onDictionaryMoveButtonClick.bind(this), false);
if (this._checkIntegrityButton !== null) {
this._checkIntegrityButton.addEventListener('click', this._onCheckIntegrityButtonClick.bind(this), false);
}
this._updateDictionaryEntryCount();
await this._onDatabaseUpdated();
}
deleteDictionary(dictionaryTitle) {
if (this._isDeleting) { return; }
const modal = this._deleteDictionaryModal;
modal.node.dataset.dictionaryTitle = dictionaryTitle;
modal.node.querySelector('#dictionary-confirm-delete-name').textContent = dictionaryTitle;
modal.setVisible(true);
}
async moveDictionaryOptions(currentIndex, targetIndex) {
const options = await this._settingsController.getOptions();
const {dictionaries} = options;
if (
currentIndex < 0 || currentIndex >= dictionaries.length ||
targetIndex < 0 || targetIndex >= dictionaries.length ||
currentIndex === targetIndex
) {
return;
}
const item = dictionaries.splice(currentIndex, 1)[0];
dictionaries.splice(targetIndex, 0, item);
await this._settingsController.modifyProfileSettings([{
action: 'set',
path: 'dictionaries',
value: dictionaries
}]);
await this._updateEntries();
}
instantiateTemplate(name) {
return this._settingsController.instantiateTemplate(name);
}
instantiateTemplateFragment(name) {
return this._settingsController.instantiateTemplateFragment(name);
}
async updateDictionariesEnabled() {
const options = await this._settingsController.getOptions();
this._updateDictionariesEnabledWarnings(options);
}
static createDefaultDictionarySettings(name, enabled) {
return {
name,
priority: 0,
enabled,
allowSecondarySearches: false,
definitionsCollapsible: 'not-collapsible'
};
}
static async ensureDictionarySettings(settingsController, dictionaries, optionsFull, modifyGlobalSettings, newDictionariesEnabled) {
if (typeof dictionaries === 'undefined') {
dictionaries = await settingsController.getDictionaryInfo();
}
if (typeof optionsFull === 'undefined') {
optionsFull = await settingsController.getOptionsFull();
}
const installedDictionaries = new Set();
for (const {title} of dictionaries) {
installedDictionaries.add(title);
}
const targets = [];
const {profiles} = optionsFull;
for (let i = 0, ii = profiles.length; i < ii; ++i) {
let modified = false;
const missingDictionaries = new Set([...installedDictionaries]);
const dictionaryOptionsArray = profiles[i].options.dictionaries;
for (let j = dictionaryOptionsArray.length - 1; j >= 0; --j) {
const {name} = dictionaryOptionsArray[j];
if (installedDictionaries.has(name)) {
missingDictionaries.delete(name);
} else {
dictionaryOptionsArray.splice(j, 1);
modified = true;
}
}
for (const name of missingDictionaries) {
const value = DictionaryController.createDefaultDictionarySettings(name, newDictionariesEnabled);
dictionaryOptionsArray.push(value);
modified = true;
}
if (modified) {
targets.push({
action: 'set',
path: `profiles[${i}].options.dictionaries`,
value: dictionaryOptionsArray
});
}
}
if (modifyGlobalSettings && targets.length > 0) {
await settingsController.modifyGlobalSettings(targets);
}
}
// Private
_onOptionsChanged({options}) {
this._updateDictionariesEnabledWarnings(options);
if (this._dictionaries !== null) {
this._updateEntries();
}
}
async _onDatabaseUpdated() {
const token = {};
this._databaseStateToken = token;
this._dictionaries = null;
const dictionaries = await this._settingsController.getDictionaryInfo();
if (this._databaseStateToken !== token) { return; }
this._dictionaries = dictionaries;
await this._updateEntries();
}
_onAllCheckboxChange() {
const value = this._allCheckbox.checked;
this._allCheckbox.checked = !value;
this._setAllDictionariesEnabled(value);
}
async _updateEntries() {
const dictionaries = this._dictionaries;
this._updateMainDictionarySelectOptions(dictionaries);
for (const entry of this._dictionaryEntries) {
entry.cleanup();
}
this._dictionaryEntries = [];
this._updateDictionaryEntryCount();
if (this._dictionaryInstallCountNode !== null) {
this._dictionaryInstallCountNode.textContent = `${dictionaries.length}`;
}
const hasDictionary = (dictionaries.length > 0);
for (const node of this._noDictionariesInstalledWarnings) {
node.hidden = hasDictionary;
}
await DictionaryController.ensureDictionarySettings(this._settingsController, dictionaries, void 0, true, false);
const options = await this._settingsController.getOptions();
this._updateDictionariesEnabledWarnings(options);
const dictionaryInfoMap = new Map();
for (const dictionary of this._dictionaries) {
dictionaryInfoMap.set(dictionary.title, dictionary);
}
const dictionaryOptionsArray = options.dictionaries;
for (let i = 0, ii = dictionaryOptionsArray.length; i < ii; ++i) {
const {name} = dictionaryOptionsArray[i];
const dictionaryInfo = dictionaryInfoMap.get(name);
if (typeof dictionaryInfo === 'undefined') { continue; }
this._createDictionaryEntry(i, dictionaryInfo);
}
}
_updateDictionariesEnabledWarnings(options) {
const {dictionaries} = options;
let enabledDictionaryCountValid = 0;
let enabledDictionaryCount = 0;
const dictionaryCount = dictionaries.length;
if (this._dictionaries !== null) {
const enabledDictionaries = new Set();
for (const {name, enabled} of dictionaries) {
if (enabled) {
++enabledDictionaryCount;
enabledDictionaries.add(name);
}
}
for (const {title} of this._dictionaries) {
if (enabledDictionaries.has(title)) {
++enabledDictionaryCountValid;
}
}
}
const hasEnabledDictionary = (enabledDictionaryCountValid > 0);
for (const node of this._noDictionariesEnabledWarnings) {
node.hidden = hasEnabledDictionary;
}
if (this._dictionaryEnabledCountNode !== null) {
this._dictionaryEnabledCountNode.textContent = `${enabledDictionaryCountValid}`;
}
this._allCheckbox.checked = (enabledDictionaryCount >= dictionaryCount);
const entries = this._dictionaryEntries;
for (let i = 0, ii = Math.min(entries.length, dictionaryCount); i < ii; ++i) {
entries[i].setEnabled(dictionaries[i].enabled);
}
}
_onDictionaryConfirmDelete(e) {
e.preventDefault();
const modal = this._deleteDictionaryModal;
modal.setVisible(false);
const title = modal.node.dataset.dictionaryTitle;
if (typeof title !== 'string') { return; }
delete modal.node.dataset.dictionaryTitle;
this._deleteDictionary(title);
}
_onCheckIntegrityButtonClick(e) {
e.preventDefault();
this._checkIntegrity();
}
_onDictionaryMoveButtonClick() {
const modal = this._modalController.getModal('dictionary-move-location');
let {index} = modal.node.dataset;
index = Number.parseInt(index, 10);
let target = document.querySelector('#dictionary-move-location').value;
target = Number.parseInt(target, 10) - 1;
if (!Number.isFinite(target) || !Number.isFinite(index) || index === target) { return; }
this.moveDictionaryOptions(index, target);
}
_updateMainDictionarySelectOptions(dictionaries) {
for (const select of document.querySelectorAll('[data-setting="general.mainDictionary"]')) {
const fragment = document.createDocumentFragment();
let option = document.createElement('option');
option.className = 'text-muted';
option.value = '';
option.textContent = 'Not selected';
fragment.appendChild(option);
for (const {title, sequenced} of dictionaries) {
if (!sequenced) { continue; }
option = document.createElement('option');
option.value = title;
option.textContent = title;
fragment.appendChild(option);
}
select.textContent = ''; // Empty
select.appendChild(fragment);
}
}
async _checkIntegrity() {
if (this._dictionaries === null || this._checkingIntegrity || this._isDeleting) { return; }
try {
this._checkingIntegrity = true;
this._setButtonsEnabled(false);
const token = this._databaseStateToken;
const dictionaryTitles = this._dictionaries.map(({title}) => title);
const {counts, total} = await yomichan.api.getDictionaryCounts(dictionaryTitles, true);
if (this._databaseStateToken !== token) { return; }
for (let i = 0, ii = Math.min(counts.length, this._dictionaryEntries.length); i < ii; ++i) {
const entry = this._dictionaryEntries[i];
entry.setCounts(counts[i]);
}
this._setCounts(counts, total);
} finally {
this._setButtonsEnabled(true);
this._checkingIntegrity = false;
}
}
_setCounts(dictionaryCounts, totalCounts) {
const remainders = Object.assign({}, totalCounts);
const keys = Object.keys(remainders);
for (const counts of dictionaryCounts) {
for (const key of keys) {
remainders[key] -= counts[key];
}
}
let totalRemainder = 0;
for (const key of keys) {
totalRemainder += remainders[key];
}
if (this._extraInfo !== null) {
this._extraInfo.cleanup();
this._extraInfo = null;
}
if (totalRemainder > 0) {
this._extraInfo = new DictionaryExtraInfo(this, totalCounts, remainders, totalRemainder);
this._extraInfo.prepare(this._dictionaryEntryContainer);
}
}
_createDictionaryEntry(index, dictionaryInfo) {
const fragment = this.instantiateTemplateFragment('dictionary');
const entry = new DictionaryEntry(this, fragment, index, dictionaryInfo);
this._dictionaryEntries.push(entry);
entry.prepare();
const container = this._dictionaryEntryContainer;
const relative = container.querySelector('.dictionary-item-bottom');
container.insertBefore(fragment, relative);
this._updateDictionaryEntryCount();
}
async _deleteDictionary(dictionaryTitle) {
if (this._isDeleting || this._checkingIntegrity) { return; }
const index = this._dictionaryEntries.findIndex((entry) => entry.dictionaryTitle === dictionaryTitle);
if (index < 0) { return; }
const statusFooter = this._statusFooter;
const progressSelector = '.dictionary-delete-progress';
const progressContainers = document.querySelectorAll(`#dictionaries-modal ${progressSelector}`);
const progressBars = document.querySelectorAll(`${progressSelector} .progress-bar`);
const infoLabels = document.querySelectorAll(`${progressSelector} .progress-info`);
const statusLabels = document.querySelectorAll(`${progressSelector} .progress-status`);
const prevention = this._settingsController.preventPageExit();
try {
this._isDeleting = true;
this._setButtonsEnabled(false);
const onProgress = ({processed, count, storeCount, storesProcesed}) => {
const percent = (
(count > 0 && storesProcesed > 0) ?
(processed / count) * (storesProcesed / storeCount) * 100.0 :
0.0
);
const cssString = `${percent}%`;
const statusString = `${percent.toFixed(0)}%`;
for (const progressBar of progressBars) { progressBar.style.width = cssString; }
for (const label of statusLabels) { label.textContent = statusString; }
};
onProgress({processed: 0, count: 1, storeCount: 1, storesProcesed: 0});
for (const progress of progressContainers) { progress.hidden = false; }
for (const label of infoLabels) { label.textContent = 'Deleting dictionary...'; }
if (statusFooter !== null) { statusFooter.setTaskActive(progressSelector, true); }
await this._deleteDictionaryInternal(dictionaryTitle, onProgress);
await this._deleteDictionarySettings(dictionaryTitle);
} catch (e) {
log.error(e);
} finally {
prevention.end();
for (const progress of progressContainers) { progress.hidden = true; }
if (statusFooter !== null) { statusFooter.setTaskActive(progressSelector, false); }
this._setButtonsEnabled(true);
this._isDeleting = false;
this._triggerStorageChanged();
}
}
_setButtonsEnabled(value) {
value = !value;
for (const node of document.querySelectorAll('.dictionary-database-mutating-input')) {
node.disabled = value;
}
}
async _deleteDictionaryInternal(dictionaryTitle, onProgress) {
const dictionaryDatabase = await this._getPreparedDictionaryDatabase();
try {
await dictionaryDatabase.deleteDictionary(dictionaryTitle, {rate: 1000}, onProgress);
yomichan.api.triggerDatabaseUpdated('dictionary', 'delete');
} finally {
dictionaryDatabase.close();
}
}
async _getPreparedDictionaryDatabase() {
const dictionaryDatabase = new DictionaryDatabase();
await dictionaryDatabase.prepare();
return dictionaryDatabase;
}
async _deleteDictionarySettings(dictionaryTitle) {
const optionsFull = await this._settingsController.getOptionsFull();
const {profiles} = optionsFull;
const targets = [];
for (let i = 0, ii = profiles.length; i < ii; ++i) {
const {options: {dictionaries}} = profiles[i];
for (let j = 0, jj = dictionaries.length; j < jj; ++j) {
if (dictionaries[j].name !== dictionaryTitle) { continue; }
const path = `profiles[${i}].options.dictionaries`;
targets.push({
action: 'splice',
path,
start: j,
deleteCount: 1,
items: []
});
}
}
await this._settingsController.modifyGlobalSettings(targets);
}
_triggerStorageChanged() {
yomichan.trigger('storageChanged');
}
_updateDictionaryEntryCount() {
this._dictionaryEntryContainer.dataset.count = `${this._dictionaryEntries.length}`;
}
async _setAllDictionariesEnabled(value) {
const options = await this._settingsController.getOptions();
const {dictionaries} = options;
const targets = [];
for (let i = 0, ii = dictionaries.length; i < ii; ++i) {
targets.push({
action: 'set',
path: `dictionaries[${i}].enabled`,
value
});
}
await this._settingsController.modifyProfileSettings(targets);
await this.updateDictionariesEnabled();
}
}