yomichan/ext/bg/js/options.js

383 lines
11 KiB
JavaScript
Raw Normal View History

2017-07-16 20:14:28 +00:00
/*
* Copyright (C) 2016-2020 Yomichan Authors
2017-07-16 20:14:28 +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-07-16 20:14:28 +00:00
*/
2019-09-07 23:50:58 +00:00
/*
* Generic options functions
*/
function optionsGetStringHashCode(string) {
let hashCode = 0;
if (typeof string !== 'string') { return hashCode; }
for (let i = 0, charCode = string.charCodeAt(i); i < string.length; charCode = string.charCodeAt(++i)) {
hashCode = ((hashCode << 5) - hashCode) + charCode;
hashCode |= 0;
}
return hashCode;
}
2019-09-07 23:50:58 +00:00
function optionsGenericApplyUpdates(options, updates) {
2019-09-06 22:21:20 +00:00
const targetVersion = updates.length;
const currentVersion = options.version;
if (typeof currentVersion === 'number' && Number.isFinite(currentVersion)) {
for (let i = Math.max(0, Math.floor(currentVersion)); i < targetVersion; ++i) {
const update = updates[i];
if (update !== null) {
update(options);
}
}
}
options.version = targetVersion;
return options;
}
2019-09-07 23:50:58 +00:00
/*
* Per-profile options
*/
const profileOptionsVersionUpdates = [
2019-09-06 22:21:20 +00:00
null,
null,
null,
null,
(options) => {
options.general.audioSource = options.general.audioPlayback ? 'jpod101' : 'disabled';
},
(options) => {
options.general.showGuide = false;
},
(options) => {
options.scanning.modifier = options.scanning.requireShift ? 'shift' : 'none';
},
(options) => {
options.general.resultOutputMode = options.general.groupResults ? 'group' : 'split';
options.anki.fieldTemplates = null;
2019-09-06 22:21:20 +00:00
},
(options) => {
if (optionsGetStringHashCode(options.anki.fieldTemplates) === 1285806040) {
options.anki.fieldTemplates = null;
2019-09-06 22:21:20 +00:00
}
},
(options) => {
if (optionsGetStringHashCode(options.anki.fieldTemplates) === -250091611) {
options.anki.fieldTemplates = null;
2019-09-06 22:21:20 +00:00
}
2019-10-10 02:33:35 +00:00
},
(options) => {
const oldAudioSource = options.general.audioSource;
const disabled = oldAudioSource === 'disabled';
options.audio.enabled = !disabled;
options.audio.volume = options.general.audioVolume;
options.audio.autoPlay = options.general.autoPlayAudio;
options.audio.sources = [disabled ? 'jpod101' : oldAudioSource];
delete options.general.audioSource;
delete options.general.audioVolume;
delete options.general.autoPlayAudio;
2019-12-15 05:07:54 +00:00
},
(options) => {
// Version 12 changes:
// The preferred default value of options.anki.fieldTemplates has been changed to null.
if (optionsGetStringHashCode(options.anki.fieldTemplates) === 1444379824) {
2019-12-15 05:07:54 +00:00
options.anki.fieldTemplates = null;
}
2020-03-15 21:32:31 +00:00
},
(options) => {
// Version 13 changes:
// Default anki field tempaltes updated to include {document-title}.
let fieldTemplates = options.anki.fieldTemplates;
if (typeof fieldTemplates === 'string') {
fieldTemplates += '\n\n{{#*inline "document-title"}}\n {{~context.document.title~}}\n{{/inline}}';
options.anki.fieldTemplates = fieldTemplates;
}
},
(options) => {
// Version 14 changes:
// Changed template for Anki audio.
let fieldTemplates = options.anki.fieldTemplates;
if (typeof fieldTemplates !== 'string') { return; }
const replacement = '{{#*inline "audio"}}\n {{~#if definition.audioFileName~}}\n [sound:{{definition.audioFileName}}]\n {{~/if~}}\n{{/inline}}';
let replaced = false;
fieldTemplates = fieldTemplates.replace(/\{\{#\*inline "audio"\}\}\{\{\/inline\}\}/g, () => {
replaced = true;
return replacement;
});
if (!replaced) {
fieldTemplates += '\n\n' + replacement;
}
options.anki.fieldTemplates = fieldTemplates;
2019-09-06 22:21:20 +00:00
}
];
2019-09-07 23:50:58 +00:00
function profileOptionsCreateDefaults() {
2019-09-05 23:56:29 +00:00
return {
2017-07-16 20:14:28 +00:00
general: {
enable: true,
enableClipboardPopups: false,
resultOutputMode: 'group',
2017-07-16 20:14:28 +00:00
debugInfo: false,
maxResults: 32,
showAdvanced: false,
popupDisplayMode: 'default',
2017-07-16 20:14:28 +00:00
popupWidth: 400,
popupHeight: 250,
2018-10-02 14:27:59 +00:00
popupHorizontalOffset: 0,
popupVerticalOffset: 10,
popupHorizontalOffset2: 10,
popupVerticalOffset2: 0,
popupHorizontalTextPosition: 'below',
popupVerticalTextPosition: 'before',
popupScalingFactor: 1,
popupScaleRelativeToPageZoom: false,
popupScaleRelativeToVisualViewport: true,
2017-10-12 06:59:09 +00:00
showGuide: true,
compactTags: false,
compactGlossaries: false,
2019-07-09 21:52:44 +00:00
mainDictionary: '',
2019-10-12 17:48:23 +00:00
popupTheme: 'default',
popupOuterTheme: 'default',
customPopupCss: '',
customPopupOuterCss: '',
enableWanakana: true,
2020-03-01 19:38:16 +00:00
enableClipboardMonitor: false,
showPitchAccentDownstepNotation: true,
showPitchAccentPositionNotation: true,
2020-04-04 22:43:12 +00:00
showPitchAccentGraph: false,
showIframePopupsInRootFrame: false
2017-07-16 20:14:28 +00:00
},
2019-10-10 02:33:35 +00:00
audio: {
enabled: true,
sources: ['jpod101'],
2019-10-10 02:33:35 +00:00
volume: 100,
autoPlay: false,
2019-10-13 02:50:22 +00:00
customSourceUrl: '',
textToSpeechVoice: ''
2019-10-10 02:33:35 +00:00
},
2017-07-16 20:14:28 +00:00
scanning: {
middleMouse: true,
2019-02-11 01:44:16 +00:00
touchInputEnabled: true,
2017-07-16 20:14:28 +00:00
selectText: true,
alphanumeric: true,
autoHideResults: false,
delay: 20,
2017-07-16 20:14:28 +00:00
length: 10,
2019-09-01 02:12:21 +00:00
modifier: 'shift',
deepDomScan: false,
popupNestingMaxDepth: 0,
2019-09-27 04:33:33 +00:00
enablePopupSearch: false,
enableOnPopupExpressions: false,
enableOnSearchPage: true,
enableSearchTags: false
2017-07-16 20:14:28 +00:00
},
2019-12-22 18:50:30 +00:00
translation: {
convertHalfWidthCharacters: 'false',
convertNumericCharacters: 'false',
convertAlphabeticCharacters: 'false',
2020-01-24 01:49:41 +00:00
convertHiraganaToKatakana: 'false',
convertKatakanaToHiragana: 'variant',
collapseEmphaticSequences: 'false'
2019-12-22 18:50:30 +00:00
},
2017-07-16 20:14:28 +00:00
dictionaries: {},
2019-11-05 13:56:45 +00:00
parsing: {
enableScanningParser: true,
2019-11-12 21:57:21 +00:00
enableMecabParser: false,
2019-11-13 18:24:11 +00:00
selectedParser: null,
2020-01-25 16:29:52 +00:00
termSpacing: true,
2019-11-13 18:24:11 +00:00
readingMode: 'hiragana'
2019-11-05 13:56:45 +00:00
},
2017-07-16 20:14:28 +00:00
anki: {
enable: false,
server: 'http://127.0.0.1:8765',
tags: ['yomichan'],
sentenceExt: 200,
2019-08-15 23:56:14 +00:00
screenshot: {format: 'png', quality: 92},
2017-07-16 20:14:28 +00:00
terms: {deck: '', model: '', fields: {}},
2017-09-06 20:18:06 +00:00
kanji: {deck: '', model: '', fields: {}},
duplicateScope: 'collection',
fieldTemplates: null
2017-07-16 20:14:28 +00:00
}
};
2019-09-05 23:56:29 +00:00
}
2019-09-07 23:50:58 +00:00
function profileOptionsSetDefaults(options) {
const defaults = profileOptionsCreateDefaults();
2017-07-16 20:14:28 +00:00
const combine = (target, source) => {
for (const key in source) {
if (!hasOwn(target, key)) {
2017-07-16 20:14:28 +00:00
target[key] = source[key];
}
}
};
combine(options, defaults);
combine(options.general, defaults.general);
combine(options.scanning, defaults.scanning);
combine(options.anki, defaults.anki);
combine(options.anki.terms, defaults.anki.terms);
combine(options.anki.kanji, defaults.anki.kanji);
return options;
}
2019-09-07 23:50:58 +00:00
function profileOptionsUpdateVersion(options) {
profileOptionsSetDefaults(options);
return optionsGenericApplyUpdates(options, profileOptionsVersionUpdates);
}
/*
* Global options
*
* Each profile has an array named "conditionGroups", which is an array of condition groups
* which enable the contextual selection of profiles. The structure of the array is as follows:
* [
* {
* conditions: [
* {
* type: "string",
* operator: "string",
* value: "string"
* },
* // ...
* ]
* },
* // ...
* ]
2019-09-07 23:50:58 +00:00
*/
const optionsVersionUpdates = [
(options) => {
options.global = {
database: {
prefixWildcardsSupported: false
}
};
}
];
2019-09-07 23:50:58 +00:00
function optionsUpdateVersion(options, defaultProfileOptions) {
// Ensure profiles is an array
if (!Array.isArray(options.profiles)) {
options.profiles = [];
}
// Remove invalid
const profiles = options.profiles;
for (let i = profiles.length - 1; i >= 0; --i) {
if (!isObject(profiles[i])) {
2019-09-07 23:50:58 +00:00
profiles.splice(i, 1);
}
}
// Require at least one profile
if (profiles.length === 0) {
profiles.push({
name: 'Default',
options: defaultProfileOptions,
conditionGroups: []
2019-09-07 23:50:58 +00:00
});
}
// Ensure profileCurrent is valid
const profileCurrent = options.profileCurrent;
if (!(
typeof profileCurrent === 'number' &&
Number.isFinite(profileCurrent) &&
Math.floor(profileCurrent) === profileCurrent &&
profileCurrent >= 0 &&
profileCurrent < profiles.length
)) {
options.profileCurrent = 0;
}
// Update profile options
for (const profile of profiles) {
if (!Array.isArray(profile.conditionGroups)) {
profile.conditionGroups = [];
}
2019-09-07 23:50:58 +00:00
profile.options = profileOptionsUpdateVersion(profile.options);
}
// Version
if (typeof options.version !== 'number') {
options.version = 0;
}
2019-09-07 23:50:58 +00:00
// Generic updates
return optionsGenericApplyUpdates(options, optionsVersionUpdates);
2017-07-16 20:14:28 +00:00
}
function optionsLoad() {
return new Promise((resolve, reject) => {
2019-11-27 03:01:54 +00:00
chrome.storage.local.get(['options'], (store) => {
2019-09-06 00:35:04 +00:00
const error = chrome.runtime.lastError;
if (error) {
2019-10-08 01:04:58 +00:00
reject(new Error(error));
2019-09-06 00:35:04 +00:00
} else {
resolve(store.options);
}
});
2019-11-27 03:01:54 +00:00
}).then((optionsStr) => {
2019-09-06 00:35:04 +00:00
if (typeof optionsStr === 'string') {
const options = JSON.parse(optionsStr);
if (isObject(options)) {
2019-09-06 00:35:04 +00:00
return options;
}
}
return {};
}).catch(() => {
2017-07-16 20:14:28 +00:00
return {};
2019-11-27 03:01:54 +00:00
}).then((options) => {
2019-09-07 23:50:58 +00:00
return (
Array.isArray(options.profiles) ?
optionsUpdateVersion(options, {}) :
optionsUpdateVersion({}, options)
);
2017-07-16 20:14:28 +00:00
});
}
function optionsSave(options) {
return new Promise((resolve, reject) => {
chrome.storage.local.set({options: JSON.stringify(options)}, () => {
const error = chrome.runtime.lastError;
if (error) {
2019-10-08 01:04:58 +00:00
reject(new Error(error));
} else {
resolve();
}
});
2017-07-16 20:14:28 +00:00
});
}
2019-12-15 04:06:44 +00:00
function optionsGetDefault() {
return optionsUpdateVersion({}, {});
}