alex/yomichan
1
Fork 0
Code Releases Activity

Options util (#700)

Browse Source 
* Move options functions into a class

* Rename and privatize

* Organize by public/private

* Refactor to use async function

* Simplify update function signature

* Add comment for update

* Rename

* Copy _applyUpdates into _legacyProfileUpdateUpdateVersion

* Organize

* Move profile options updates

* Refactor update details

* Add async support

* Formatting
This commit is contained in:
toasted-nutbread 2020-08-01 11:46:35 -04:00 committed by GitHub
parent f1e7288c11
commit b52074b3f0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 367 additions and 356 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
ext/bg/js/backend.js
View File

@ -27,13 +27,12 @@
* JsonSchema * JsonSchema
* Mecab * Mecab
* ObjectPropertyAccessor * ObjectPropertyAccessor
* OptionsUtil
* TemplateRenderer * TemplateRenderer
* Translator * Translator
* conditionsTestValue * conditionsTestValue
* dictTermsSort * dictTermsSort
* jp * jp
* optionsLoad
* optionsSave
* profileConditionsDescriptor * profileConditionsDescriptor
* profileConditionsDescriptorPromise * profileConditionsDescriptorPromise
* requestJson * requestJson
@ -202,7 +201,7 @@ class Backend {
this._optionsSchema = await requestJson(chrome.runtime.getURL('/bg/data/options-schema.json'), 'GET'); this._optionsSchema = await requestJson(chrome.runtime.getURL('/bg/data/options-schema.json'), 'GET');
this._defaultAnkiFieldTemplates = (await requestText(chrome.runtime.getURL('/bg/data/default-anki-field-templates.handlebars'), 'GET')).trim(); this._defaultAnkiFieldTemplates = (await requestText(chrome.runtime.getURL('/bg/data/default-anki-field-templates.handlebars'), 'GET')).trim();
this._options = await optionsLoad(); this._options = await OptionsUtil.load();
this._options = JsonSchema.getValidValueOrDefault(this._optionsSchema, this._options); this._options = JsonSchema.getValidValueOrDefault(this._optionsSchema, this._options);
this._applyOptions('background'); this._applyOptions('background');
@ -396,7 +395,7 @@ class Backend {
async _onApiOptionsSave({source}) { async _onApiOptionsSave({source}) {
const options = this.getFullOptions(); const options = this.getFullOptions();
await optionsSave(options); await OptionsUtil.save(options);
this._applyOptions(source); this._applyOptions(source);
} }

709
ext/bg/js/options.js
View File

@ -15,383 +15,396 @@
* along with this program. If not, see <https://www.gnu.org/licenses/>. * along with this program. If not, see <https://www.gnu.org/licenses/>.
*/ */
/* class OptionsUtil {
* Generic options functions static async update(options) {
*/ // Invalid options
if (!isObject(options)) {
options = {};
}
function optionsGetStringHashCode(string) { // Check for legacy options
let hashCode = 0; let defaultProfileOptions = {};
if (!Array.isArray(options.profiles)) {
defaultProfileOptions = options;
options = {};
}
if (typeof string !== 'string') { return hashCode; } // Ensure profiles is an array
if (!Array.isArray(options.profiles)) {
options.profiles = [];
}
for (let i = 0, charCode = string.charCodeAt(i); i < string.length; charCode = string.charCodeAt(++i)) { // Remove invalid profiles
hashCode = ((hashCode << 5) - hashCode) + charCode; const profiles = options.profiles;
hashCode |= 0; for (let i = profiles.length - 1; i >= 0; --i) {
} if (!isObject(profiles[i])) {
profiles.splice(i, 1);
return hashCode;
}
function optionsGenericApplyUpdates(options, updates) {
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; // Require at least one profile
return options; if (profiles.length === 0) {
} profiles.push({
name: 'Default',
options: defaultProfileOptions,
/* conditionGroups: []
* Per-profile options
*/
const profileOptionsVersionUpdates = [
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;
},
(options) => {
if (optionsGetStringHashCode(options.anki.fieldTemplates) === 1285806040) {
options.anki.fieldTemplates = null;
}
},
(options) => {
if (optionsGetStringHashCode(options.anki.fieldTemplates) === -250091611) {
options.anki.fieldTemplates = null;
}
},
(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;
},
(options) => {
// Version 12 changes:
// The preferred default value of options.anki.fieldTemplates has been changed to null.
if (optionsGetStringHashCode(options.anki.fieldTemplates) === 1444379824) {
options.anki.fieldTemplates = null;
}
},
(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 and tags.
let fieldTemplates = options.anki.fieldTemplates;
if (typeof fieldTemplates !== 'string') { return; }
const replacements = [
[
'{{#*inline "audio"}}{{/inline}}',
'{{#*inline "audio"}}\n {{~#if definition.audioFileName~}}\n [sound:{{definition.audioFileName}}]\n {{~/if~}}\n{{/inline}}'
],
[
'{{#*inline "tags"}}\n {{~#each definition.definitionTags}}{{name}}{{#unless @last}}, {{/unless}}{{/each~}}\n{{/inline}}',
'{{#*inline "tags"}}\n {{~#mergeTags definition group merge}}{{this}}{{/mergeTags~}}\n{{/inline}}'
]
];
for (const [pattern, replacement] of replacements) {
let replaced = false;
fieldTemplates = fieldTemplates.replace(new RegExp(escapeRegExp(pattern), 'g'), () => {
replaced = true;
return replacement;
}); });
if (!replaced) {
fieldTemplates += '\n\n' + replacement;
}
} }
options.anki.fieldTemplates = fieldTemplates; // 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;
}
// Version
if (typeof options.version !== 'number') {
options.version = 0;
}
// Generic updates
return await this._applyUpdates(options, this._getVersionUpdates());
} }
];
function profileOptionsCreateDefaults() { static async load() {
return { let options = null;
general: { try {
enable: true, const optionsStr = await new Promise((resolve, reject) => {
enableClipboardPopups: false, chrome.storage.local.get(['options'], (store) => {
resultOutputMode: 'group', const error = chrome.runtime.lastError;
debugInfo: false, if (error) {
maxResults: 32, reject(new Error(error));
showAdvanced: false, } else {
popupDisplayMode: 'default', resolve(store.options);
popupWidth: 400, }
popupHeight: 250, });
popupHorizontalOffset: 0, });
popupVerticalOffset: 10, options = JSON.parse(optionsStr);
popupHorizontalOffset2: 10, } catch (e) {
popupVerticalOffset2: 0, // NOP
popupHorizontalTextPosition: 'below',
popupVerticalTextPosition: 'before',
popupScalingFactor: 1,
popupScaleRelativeToPageZoom: false,
popupScaleRelativeToVisualViewport: true,
showGuide: true,
compactTags: false,
compactGlossaries: false,
mainDictionary: '',
popupTheme: 'default',
popupOuterTheme: 'default',
customPopupCss: '',
customPopupOuterCss: '',
enableWanakana: true,
enableClipboardMonitor: false,
showPitchAccentDownstepNotation: true,
showPitchAccentPositionNotation: true,
showPitchAccentGraph: false,
showIframePopupsInRootFrame: false,
useSecurePopupFrameUrl: true,
usePopupShadowDom: true
},
audio: {
enabled: true,
sources: ['jpod101'],
volume: 100,
autoPlay: false,
customSourceUrl: '',
textToSpeechVoice: ''
},
scanning: {
middleMouse: true,
touchInputEnabled: true,
selectText: true,
alphanumeric: true,
autoHideResults: false,
delay: 20,
length: 10,
modifier: 'shift',
deepDomScan: false,
popupNestingMaxDepth: 0,
enablePopupSearch: false,
enableOnPopupExpressions: false,
enableOnSearchPage: true,
enableSearchTags: false,
layoutAwareScan: false
},
translation: {
convertHalfWidthCharacters: 'false',
convertNumericCharacters: 'false',
convertAlphabeticCharacters: 'false',
convertHiraganaToKatakana: 'false',
convertKatakanaToHiragana: 'variant',
collapseEmphaticSequences: 'false'
},
dictionaries: {},
parsing: {
enableScanningParser: true,
enableMecabParser: false,
selectedParser: null,
termSpacing: true,
readingMode: 'hiragana'
},
anki: {
enable: false,
server: 'http://127.0.0.1:8765',
tags: ['yomichan'],
sentenceExt: 200,
screenshot: {format: 'png', quality: 92},
terms: {deck: '', model: '', fields: {}},
kanji: {deck: '', model: '', fields: {}},
duplicateScope: 'collection',
fieldTemplates: null
} }
};
}
function profileOptionsSetDefaults(options) { return await this.update(options);
const defaults = profileOptionsCreateDefaults(); }
const combine = (target, source) => { static save(options) {
for (const key in source) { return new Promise((resolve, reject) => {
if (!hasOwn(target, key)) { chrome.storage.local.set({options: JSON.stringify(options)}, () => {
target[key] = source[key]; const error = chrome.runtime.lastError;
if (error) {
reject(new Error(error));
} else {
resolve();
}
});
});
}
static async getDefault() {
return await this.update({});
}
// Legacy profile updating
static _legacyProfileUpdateGetUpdates() {
return [
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;
},
(options) => {
if (this._getStringHashCode(options.anki.fieldTemplates) === 1285806040) {
options.anki.fieldTemplates = null;
}
},
(options) => {
if (this._getStringHashCode(options.anki.fieldTemplates) === -250091611) {
options.anki.fieldTemplates = null;
}
},
(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;
},
(options) => {
// Version 12 changes:
// The preferred default value of options.anki.fieldTemplates has been changed to null.
if (this._getStringHashCode(options.anki.fieldTemplates) === 1444379824) {
options.anki.fieldTemplates = null;
}
},
(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 and tags.
let fieldTemplates = options.anki.fieldTemplates;
if (typeof fieldTemplates !== 'string') { return; }
const replacements = [
[
'{{#*inline "audio"}}{{/inline}}',
'{{#*inline "audio"}}\n {{~#if definition.audioFileName~}}\n [sound:{{definition.audioFileName}}]\n {{~/if~}}\n{{/inline}}'
],
[
'{{#*inline "tags"}}\n {{~#each definition.definitionTags}}{{name}}{{#unless @last}}, {{/unless}}{{/each~}}\n{{/inline}}',
'{{#*inline "tags"}}\n {{~#mergeTags definition group merge}}{{this}}{{/mergeTags~}}\n{{/inline}}'
]
];
for (const [pattern, replacement] of replacements) {
let replaced = false;
fieldTemplates = fieldTemplates.replace(new RegExp(escapeRegExp(pattern), 'g'), () => {
replaced = true;
return replacement;
});
if (!replaced) {
fieldTemplates += '\n\n' + replacement;
}
}
options.anki.fieldTemplates = fieldTemplates;
} }
} ];
}; }
combine(options, defaults); static _legacyProfileUpdateGetDefaults() {
combine(options.general, defaults.general); return {
combine(options.scanning, defaults.scanning); general: {
combine(options.anki, defaults.anki); enable: true,
combine(options.anki.terms, defaults.anki.terms); enableClipboardPopups: false,
combine(options.anki.kanji, defaults.anki.kanji); resultOutputMode: 'group',
debugInfo: false,
maxResults: 32,
showAdvanced: false,
popupDisplayMode: 'default',
popupWidth: 400,
popupHeight: 250,
popupHorizontalOffset: 0,
popupVerticalOffset: 10,
popupHorizontalOffset2: 10,
popupVerticalOffset2: 0,
popupHorizontalTextPosition: 'below',
popupVerticalTextPosition: 'before',
popupScalingFactor: 1,
popupScaleRelativeToPageZoom: false,
popupScaleRelativeToVisualViewport: true,
showGuide: true,
compactTags: false,
compactGlossaries: false,
mainDictionary: '',
popupTheme: 'default',
popupOuterTheme: 'default',
customPopupCss: '',
customPopupOuterCss: '',
enableWanakana: true,
enableClipboardMonitor: false,
showPitchAccentDownstepNotation: true,
showPitchAccentPositionNotation: true,
showPitchAccentGraph: false,
showIframePopupsInRootFrame: false,
useSecurePopupFrameUrl: true,
usePopupShadowDom: true
},
return options; audio: {
} enabled: true,
sources: ['jpod101'],
volume: 100,
autoPlay: false,
customSourceUrl: '',
textToSpeechVoice: ''
},
function profileOptionsUpdateVersion(options) { scanning: {
profileOptionsSetDefaults(options); middleMouse: true,
return optionsGenericApplyUpdates(options, profileOptionsVersionUpdates); touchInputEnabled: true,
} selectText: true,
alphanumeric: true,
autoHideResults: false,
delay: 20,
length: 10,
modifier: 'shift',
deepDomScan: false,
popupNestingMaxDepth: 0,
enablePopupSearch: false,
enableOnPopupExpressions: false,
enableOnSearchPage: true,
enableSearchTags: false,
layoutAwareScan: false
},
translation: {
convertHalfWidthCharacters: 'false',
convertNumericCharacters: 'false',
convertAlphabeticCharacters: 'false',
convertHiraganaToKatakana: 'false',
convertKatakanaToHiragana: 'variant',
collapseEmphaticSequences: 'false'
},
/* dictionaries: {},
* 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"
* },
* // ...
* ]
* },
* // ...
* ]
*/
const optionsVersionUpdates = [ parsing: {
(options) => { enableScanningParser: true,
options.global = { enableMecabParser: false,
database: { selectedParser: null,
prefixWildcardsSupported: false termSpacing: true,
readingMode: 'hiragana'
},
anki: {
enable: false,
server: 'http://127.0.0.1:8765',
tags: ['yomichan'],
sentenceExt: 200,
screenshot: {format: 'png', quality: 92},
terms: {deck: '', model: '', fields: {}},
kanji: {deck: '', model: '', fields: {}},
duplicateScope: 'collection',
fieldTemplates: null
} }
}; };
} }
];
function optionsUpdateVersion(options, defaultProfileOptions) { static _legacyProfileUpdateAssignDefaults(options) {
// Ensure profiles is an array const defaults = this._legacyProfileUpdateGetDefaults();
if (!Array.isArray(options.profiles)) {
options.profiles = [];
}
// Remove invalid const combine = (target, source) => {
const profiles = options.profiles; for (const key in source) {
for (let i = profiles.length - 1; i >= 0; --i) { if (!hasOwn(target, key)) {
if (!isObject(profiles[i])) { target[key] = source[key];
profiles.splice(i, 1); }
}
}
// Require at least one profile
if (profiles.length === 0) {
profiles.push({
name: 'Default',
options: defaultProfileOptions,
conditionGroups: []
});
}
// 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 = [];
}
profile.options = profileOptionsUpdateVersion(profile.options);
}
// Version
if (typeof options.version !== 'number') {
options.version = 0;
}
// Generic updates
return optionsGenericApplyUpdates(options, optionsVersionUpdates);
}
function optionsLoad() {
return new Promise((resolve, reject) => {
chrome.storage.local.get(['options'], (store) => {
const error = chrome.runtime.lastError;
if (error) {
reject(new Error(error));
} else {
resolve(store.options);
} }
}); };
}).then((optionsStr) => {
if (typeof optionsStr === 'string') { combine(options, defaults);
const options = JSON.parse(optionsStr); combine(options.general, defaults.general);
if (isObject(options)) { combine(options.scanning, defaults.scanning);
return options; combine(options.anki, defaults.anki);
combine(options.anki.terms, defaults.anki.terms);
combine(options.anki.kanji, defaults.anki.kanji);
return options;
}
static _legacyProfileUpdateUpdateVersion(options) {
const updates = this._legacyProfileUpdateGetUpdates();
this._legacyProfileUpdateAssignDefaults(options);
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);
}
} }
} }
return {};
}).catch(() => {
return {};
}).then((options) => {
return (
Array.isArray(options.profiles) ?
optionsUpdateVersion(options, {}) :
optionsUpdateVersion({}, options)
);
});
}
function optionsSave(options) { options.version = targetVersion;
return new Promise((resolve, reject) => { return options;
chrome.storage.local.set({options: JSON.stringify(options)}, () => { }
const error = chrome.runtime.lastError;
if (error) { // Private
reject(new Error(error));
} else { static _getStringHashCode(string) {
resolve(); 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;
}
static async _applyUpdates(options, updates) {
const targetVersion = updates.length;
let currentVersion = options.version;
if (typeof currentVersion !== 'number' || !Number.isFinite(currentVersion)) {
currentVersion = 0;
}
for (let i = Math.max(0, Math.floor(currentVersion)); i < targetVersion; ++i) {
const {update, async} = updates[i];
const result = update(options);
options = (async ? await result : result);
}
options.version = targetVersion;
return options;
}
static _getVersionUpdates() {
return [
{
async: false,
update: (options) => {
// Version 1 changes:
// Added options.global.database.prefixWildcardsSupported = false
options.global = {
database: {
prefixWildcardsSupported: false
}
};
return options;
}
},
{
async: false,
update: (options) => {
// Version 2 changes:
// Legacy profile update process moved into this upgrade function.
for (const profile of options.profiles) {
if (!Array.isArray(profile.conditionGroups)) {
profile.conditionGroups = [];
}
profile.options = this._legacyProfileUpdateUpdateVersion(profile.options);
}
return options;
}
} }
}); ];
}); }
}
function optionsGetDefault() {
return optionsUpdateVersion({}, {});
} }

7
ext/bg/js/settings/backup.js
View File

@ -16,9 +16,8 @@
*/ */
/* global /* global
* OptionsUtil
* api * api
* optionsGetDefault
* optionsUpdateVersion
*/ */
class SettingsBackup { class SettingsBackup {
@ -323,7 +322,7 @@ class SettingsBackup {
} }
// Upgrade options // Upgrade options
optionsFull = optionsUpdateVersion(optionsFull, {}); optionsFull = await OptionsUtil.update(optionsFull);
// Check for warnings // Check for warnings
const sanitizationWarnings = this._settingsImportSanitizeOptions(optionsFull, true); const sanitizationWarnings = this._settingsImportSanitizeOptions(optionsFull, true);
@ -369,7 +368,7 @@ class SettingsBackup {
$('#settings-reset-modal').modal('hide'); $('#settings-reset-modal').modal('hide');
// Get default options // Get default options
const optionsFull = optionsGetDefault(); const optionsFull = await OptionsUtil.getDefault();
// Assign options // Assign options
await this._settingsImportSetOptionsFull(optionsFull); await this._settingsImportSetOptionsFull(optionsFull);