From 8cd5a2f75f192417eee49f221029d50d77aef82d Mon Sep 17 00:00:00 2001 From: toasted-nutbread Date: Fri, 4 Sep 2020 17:53:29 -0400 Subject: Profile conditions cleanup (#768) * Remove conditions.js * Rename profile-conditions2.js to profile-conditions.js --- ext/bg/background.html | 2 +- ext/bg/js/conditions.js | 145 -------------------- ext/bg/js/profile-conditions.js | 276 +++++++++++++++++++++++++++++++++++++++ ext/bg/js/profile-conditions2.js | 276 --------------------------------------- test/test-profile-conditions.js | 2 +- 5 files changed, 278 insertions(+), 423 deletions(-) delete mode 100644 ext/bg/js/conditions.js create mode 100644 ext/bg/js/profile-conditions.js delete mode 100644 ext/bg/js/profile-conditions2.js diff --git a/ext/bg/background.html b/ext/bg/background.html index b3067b1e..218e9925 100644 --- a/ext/bg/background.html +++ b/ext/bg/background.html @@ -38,7 +38,7 @@ - + diff --git a/ext/bg/js/conditions.js b/ext/bg/js/conditions.js deleted file mode 100644 index 3f3c0a45..00000000 --- a/ext/bg/js/conditions.js +++ /dev/null @@ -1,145 +0,0 @@ -/* - * Copyright (C) 2019-2020 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 . - */ - - -function conditionsValidateOptionValue(object, value) { - if (hasOwn(object, 'validate') && !object.validate(value)) { - throw new Error('Invalid value for condition'); - } - - if (hasOwn(object, 'transform')) { - value = object.transform(value); - - if (hasOwn(object, 'validateTransformed') && !object.validateTransformed(value)) { - throw new Error('Invalid value for condition'); - } - } - - return value; -} - -function conditionsValidateOptionInputValue(object, value) { - if (hasOwn(object, 'transformInput')) { - return object.transformInput(value); - } - - return null; -} - -function conditionsNormalizeOptionValue(descriptors, type, operator, optionValue, isInput) { - if (!hasOwn(descriptors, type)) { - throw new Error('Invalid type'); - } - - const conditionDescriptor = descriptors[type]; - if (!hasOwn(conditionDescriptor.operators, operator)) { - throw new Error('Invalid operator'); - } - - const operatorDescriptor = conditionDescriptor.operators[operator]; - - const descriptorArray = [conditionDescriptor, operatorDescriptor]; - - let transformedValue = optionValue; - - let inputTransformedValue = null; - if (isInput) { - for (const descriptor of descriptorArray) { - let value = inputTransformedValue !== null ? inputTransformedValue : transformedValue; - value = conditionsValidateOptionInputValue(descriptor, value); - if (value !== null) { - inputTransformedValue = value; - } - } - - if (inputTransformedValue !== null) { - transformedValue = inputTransformedValue; - } - } - - for (const descriptor of descriptorArray) { - transformedValue = conditionsValidateOptionValue(descriptor, transformedValue); - } - - if (hasOwn(operatorDescriptor, 'transformReverse')) { - transformedValue = operatorDescriptor.transformReverse(transformedValue); - } - - return [transformedValue, inputTransformedValue]; -} - -function conditionsTestValueThrowing(descriptors, type, operator, optionValue, value) { - if (!hasOwn(descriptors, type)) { - throw new Error('Invalid type'); - } - - const conditionDescriptor = descriptors[type]; - if (!hasOwn(conditionDescriptor.operators, operator)) { - throw new Error('Invalid operator'); - } - - const operatorDescriptor = conditionDescriptor.operators[operator]; - if (hasOwn(operatorDescriptor, 'transform')) { - if (hasOwn(operatorDescriptor, 'transformCache')) { - const key = `${optionValue}`; - const transformCache = operatorDescriptor.transformCache; - if (hasOwn(transformCache, key)) { - optionValue = transformCache[key]; - } else { - optionValue = operatorDescriptor.transform(optionValue); - transformCache[key] = optionValue; - } - } else { - optionValue = operatorDescriptor.transform(optionValue); - } - } - - return operatorDescriptor.test(value, optionValue); -} - -function conditionsTestValue(descriptors, type, operator, optionValue, value) { - try { - return conditionsTestValueThrowing(descriptors, type, operator, optionValue, value); - } catch (e) { - return false; - } -} - -function conditionsClearCaches(descriptors) { - for (const type in descriptors) { - if (!hasOwn(descriptors, type)) { - continue; - } - - const conditionDescriptor = descriptors[type]; - if (hasOwn(conditionDescriptor, 'transformCache')) { - conditionDescriptor.transformCache = {}; - } - - const operatorDescriptors = conditionDescriptor.operators; - for (const operator in operatorDescriptors) { - if (!hasOwn(operatorDescriptors, operator)) { - continue; - } - - const operatorDescriptor = operatorDescriptors[operator]; - if (hasOwn(operatorDescriptor, 'transformCache')) { - operatorDescriptor.transformCache = {}; - } - } - } -} diff --git a/ext/bg/js/profile-conditions.js b/ext/bg/js/profile-conditions.js new file mode 100644 index 00000000..9f2f6b16 --- /dev/null +++ b/ext/bg/js/profile-conditions.js @@ -0,0 +1,276 @@ +/* + * Copyright (C) 2020 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 . + */ + +/** + * Utility class to help processing profile conditions. + */ +class ProfileConditions { + /** + * Creates a new instance. + */ + constructor() { + this._splitPattern = /[,;\s]+/; + this._descriptors = new Map([ + [ + 'popupLevel', + { + operators: new Map([ + ['equal', this._createSchemaPopupLevelEqual.bind(this)], + ['notEqual', this._createSchemaPopupLevelNotEqual.bind(this)], + ['lessThan', this._createSchemaPopupLevelLessThan.bind(this)], + ['greaterThan', this._createSchemaPopupLevelGreaterThan.bind(this)], + ['lessThanOrEqual', this._createSchemaPopupLevelLessThanOrEqual.bind(this)], + ['greaterThanOrEqual', this._createSchemaPopupLevelGreaterThanOrEqual.bind(this)] + ]) + } + ], + [ + 'url', + { + operators: new Map([ + ['matchDomain', this._createSchemaUrlMatchDomain.bind(this)], + ['matchRegExp', this._createSchemaUrlMatchRegExp.bind(this)] + ]) + } + ], + [ + 'modifierKeys', + { + operators: new Map([ + ['are', this._createSchemaModifierKeysAre.bind(this)], + ['areNot', this._createSchemaModifierKeysAreNot.bind(this)], + ['include', this._createSchemaModifierKeysInclude.bind(this)], + ['notInclude', this._createSchemaModifierKeysNotInclude.bind(this)] + ]) + } + ] + ]); + } + + /** + * Creates a new JSON schema descriptor for the given set of condition groups. + * @param conditionGroups An array of condition groups in the following format: + * conditionGroups = [ + * { + * conditions: [ + * { + * type: (condition type: string), + * operator: (condition sub-type: string), + * value: (value to compare against: string) + * }, + * ... + * ] + * }, + * ... + * ] + */ + createSchema(conditionGroups) { + const anyOf = []; + for (const {conditions} of conditionGroups) { + const allOf = []; + for (const {type, operator, value} of conditions) { + const conditionDescriptor = this._descriptors.get(type); + if (typeof conditionDescriptor === 'undefined') { continue; } + + const createSchema = conditionDescriptor.operators.get(operator); + if (typeof createSchema === 'undefined') { continue; } + + const schema = createSchema(value); + allOf.push(schema); + } + switch (allOf.length) { + case 0: break; + case 1: anyOf.push(allOf[0]); break; + default: anyOf.push({allOf}); break; + } + } + switch (anyOf.length) { + case 0: return {}; + case 1: return anyOf[0]; + default: return {anyOf}; + } + } + + /** + * Creates a normalized version of the context object to test, + * assigning dependent fields as needed. + * @param context A context object which is used during schema validation. + * @returns A normalized context object. + */ + normalizeContext(context) { + const normalizedContext = Object.assign({}, context); + const {url} = normalizedContext; + if (typeof url === 'string') { + try { + normalizedContext.domain = new URL(url).hostname; + } catch (e) { + // NOP + } + } + return normalizedContext; + } + + // Private + + _split(value) { + return value.split(this._splitPattern); + } + + _stringToNumber(value) { + const number = Number.parseFloat(value); + return Number.isFinite(number) ? number : 0; + } + + // popupLevel schema creation functions + + _createSchemaPopupLevelEqual(value) { + value = this._stringToNumber(value); + return { + required: ['depth'], + properties: { + depth: {const: value} + } + }; + } + + _createSchemaPopupLevelNotEqual(value) { + return { + not: [this._createSchemaPopupLevelEqual(value)] + }; + } + + _createSchemaPopupLevelLessThan(value) { + value = this._stringToNumber(value); + return { + required: ['depth'], + properties: { + depth: {type: 'number', exclusiveMaximum: value} + } + }; + } + + _createSchemaPopupLevelGreaterThan(value) { + value = this._stringToNumber(value); + return { + required: ['depth'], + properties: { + depth: {type: 'number', exclusiveMinimum: value} + } + }; + } + + _createSchemaPopupLevelLessThanOrEqual(value) { + value = this._stringToNumber(value); + return { + required: ['depth'], + properties: { + depth: {type: 'number', maximum: value} + } + }; + } + + _createSchemaPopupLevelGreaterThanOrEqual(value) { + value = this._stringToNumber(value); + return { + required: ['depth'], + properties: { + depth: {type: 'number', minimum: value} + } + }; + } + + // url schema creation functions + + _createSchemaUrlMatchDomain(value) { + const oneOf = []; + for (let domain of this._split(value)) { + if (domain.length === 0) { continue; } + domain = domain.toLowerCase(); + oneOf.push({const: domain}); + } + return { + required: ['domain'], + properties: { + domain: {oneOf} + } + }; + } + + _createSchemaUrlMatchRegExp(value) { + return { + required: ['url'], + properties: { + url: {type: 'string', pattern: value, patternFlags: 'i'} + } + }; + } + + // modifierKeys schema creation functions + + _createSchemaModifierKeysAre(value) { + return this._createSchemaModifierKeysGeneric(value, true, false); + } + + _createSchemaModifierKeysAreNot(value) { + return { + not: [this._createSchemaModifierKeysGeneric(value, true, false)] + }; + } + + _createSchemaModifierKeysInclude(value) { + return this._createSchemaModifierKeysGeneric(value, false, false); + } + + _createSchemaModifierKeysNotInclude(value) { + return this._createSchemaModifierKeysGeneric(value, false, true); + } + + _createSchemaModifierKeysGeneric(value, exact, none) { + const containsList = []; + for (const modifierKey of this._split(value)) { + if (modifierKey.length === 0) { continue; } + containsList.push({ + contains: { + const: modifierKey + } + }); + } + const containsListCount = containsList.length; + const modifierKeysSchema = { + type: 'array' + }; + if (exact) { + modifierKeysSchema.maxItems = containsListCount; + } + if (none) { + if (containsListCount > 0) { + modifierKeysSchema.not = containsList; + } + } else { + modifierKeysSchema.minItems = containsListCount; + if (containsListCount > 0) { + modifierKeysSchema.allOf = containsList; + } + } + return { + required: ['modifierKeys'], + properties: { + modifierKeys: modifierKeysSchema + } + }; + } +} diff --git a/ext/bg/js/profile-conditions2.js b/ext/bg/js/profile-conditions2.js deleted file mode 100644 index 9f2f6b16..00000000 --- a/ext/bg/js/profile-conditions2.js +++ /dev/null @@ -1,276 +0,0 @@ -/* - * Copyright (C) 2020 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 . - */ - -/** - * Utility class to help processing profile conditions. - */ -class ProfileConditions { - /** - * Creates a new instance. - */ - constructor() { - this._splitPattern = /[,;\s]+/; - this._descriptors = new Map([ - [ - 'popupLevel', - { - operators: new Map([ - ['equal', this._createSchemaPopupLevelEqual.bind(this)], - ['notEqual', this._createSchemaPopupLevelNotEqual.bind(this)], - ['lessThan', this._createSchemaPopupLevelLessThan.bind(this)], - ['greaterThan', this._createSchemaPopupLevelGreaterThan.bind(this)], - ['lessThanOrEqual', this._createSchemaPopupLevelLessThanOrEqual.bind(this)], - ['greaterThanOrEqual', this._createSchemaPopupLevelGreaterThanOrEqual.bind(this)] - ]) - } - ], - [ - 'url', - { - operators: new Map([ - ['matchDomain', this._createSchemaUrlMatchDomain.bind(this)], - ['matchRegExp', this._createSchemaUrlMatchRegExp.bind(this)] - ]) - } - ], - [ - 'modifierKeys', - { - operators: new Map([ - ['are', this._createSchemaModifierKeysAre.bind(this)], - ['areNot', this._createSchemaModifierKeysAreNot.bind(this)], - ['include', this._createSchemaModifierKeysInclude.bind(this)], - ['notInclude', this._createSchemaModifierKeysNotInclude.bind(this)] - ]) - } - ] - ]); - } - - /** - * Creates a new JSON schema descriptor for the given set of condition groups. - * @param conditionGroups An array of condition groups in the following format: - * conditionGroups = [ - * { - * conditions: [ - * { - * type: (condition type: string), - * operator: (condition sub-type: string), - * value: (value to compare against: string) - * }, - * ... - * ] - * }, - * ... - * ] - */ - createSchema(conditionGroups) { - const anyOf = []; - for (const {conditions} of conditionGroups) { - const allOf = []; - for (const {type, operator, value} of conditions) { - const conditionDescriptor = this._descriptors.get(type); - if (typeof conditionDescriptor === 'undefined') { continue; } - - const createSchema = conditionDescriptor.operators.get(operator); - if (typeof createSchema === 'undefined') { continue; } - - const schema = createSchema(value); - allOf.push(schema); - } - switch (allOf.length) { - case 0: break; - case 1: anyOf.push(allOf[0]); break; - default: anyOf.push({allOf}); break; - } - } - switch (anyOf.length) { - case 0: return {}; - case 1: return anyOf[0]; - default: return {anyOf}; - } - } - - /** - * Creates a normalized version of the context object to test, - * assigning dependent fields as needed. - * @param context A context object which is used during schema validation. - * @returns A normalized context object. - */ - normalizeContext(context) { - const normalizedContext = Object.assign({}, context); - const {url} = normalizedContext; - if (typeof url === 'string') { - try { - normalizedContext.domain = new URL(url).hostname; - } catch (e) { - // NOP - } - } - return normalizedContext; - } - - // Private - - _split(value) { - return value.split(this._splitPattern); - } - - _stringToNumber(value) { - const number = Number.parseFloat(value); - return Number.isFinite(number) ? number : 0; - } - - // popupLevel schema creation functions - - _createSchemaPopupLevelEqual(value) { - value = this._stringToNumber(value); - return { - required: ['depth'], - properties: { - depth: {const: value} - } - }; - } - - _createSchemaPopupLevelNotEqual(value) { - return { - not: [this._createSchemaPopupLevelEqual(value)] - }; - } - - _createSchemaPopupLevelLessThan(value) { - value = this._stringToNumber(value); - return { - required: ['depth'], - properties: { - depth: {type: 'number', exclusiveMaximum: value} - } - }; - } - - _createSchemaPopupLevelGreaterThan(value) { - value = this._stringToNumber(value); - return { - required: ['depth'], - properties: { - depth: {type: 'number', exclusiveMinimum: value} - } - }; - } - - _createSchemaPopupLevelLessThanOrEqual(value) { - value = this._stringToNumber(value); - return { - required: ['depth'], - properties: { - depth: {type: 'number', maximum: value} - } - }; - } - - _createSchemaPopupLevelGreaterThanOrEqual(value) { - value = this._stringToNumber(value); - return { - required: ['depth'], - properties: { - depth: {type: 'number', minimum: value} - } - }; - } - - // url schema creation functions - - _createSchemaUrlMatchDomain(value) { - const oneOf = []; - for (let domain of this._split(value)) { - if (domain.length === 0) { continue; } - domain = domain.toLowerCase(); - oneOf.push({const: domain}); - } - return { - required: ['domain'], - properties: { - domain: {oneOf} - } - }; - } - - _createSchemaUrlMatchRegExp(value) { - return { - required: ['url'], - properties: { - url: {type: 'string', pattern: value, patternFlags: 'i'} - } - }; - } - - // modifierKeys schema creation functions - - _createSchemaModifierKeysAre(value) { - return this._createSchemaModifierKeysGeneric(value, true, false); - } - - _createSchemaModifierKeysAreNot(value) { - return { - not: [this._createSchemaModifierKeysGeneric(value, true, false)] - }; - } - - _createSchemaModifierKeysInclude(value) { - return this._createSchemaModifierKeysGeneric(value, false, false); - } - - _createSchemaModifierKeysNotInclude(value) { - return this._createSchemaModifierKeysGeneric(value, false, true); - } - - _createSchemaModifierKeysGeneric(value, exact, none) { - const containsList = []; - for (const modifierKey of this._split(value)) { - if (modifierKey.length === 0) { continue; } - containsList.push({ - contains: { - const: modifierKey - } - }); - } - const containsListCount = containsList.length; - const modifierKeysSchema = { - type: 'array' - }; - if (exact) { - modifierKeysSchema.maxItems = containsListCount; - } - if (none) { - if (containsListCount > 0) { - modifierKeysSchema.not = containsList; - } - } else { - modifierKeysSchema.minItems = containsListCount; - if (containsListCount > 0) { - modifierKeysSchema.allOf = containsList; - } - } - return { - required: ['modifierKeys'], - properties: { - modifierKeys: modifierKeysSchema - } - }; - } -} diff --git a/test/test-profile-conditions.js b/test/test-profile-conditions.js index d7402acf..23bbdacb 100644 --- a/test/test-profile-conditions.js +++ b/test/test-profile-conditions.js @@ -24,7 +24,7 @@ vm.execute([ 'mixed/js/core.js', 'mixed/js/cache-map.js', 'bg/js/json-schema.js', - 'bg/js/profile-conditions2.js' + 'bg/js/profile-conditions.js' ]); const [JsonSchemaValidator, ProfileConditions] = vm.get(['JsonSchemaValidator', 'ProfileConditions']); -- cgit v1.2.3