Json schema profile conditions (#758)

* Add clearCache function

* Add upgrade

* Use schema-based profile condition validation

* Update profile conditions settings controller

* Remove unnecessary async

* Remove old

* Remove unused templates

1 files changed, 686 insertions, 0 deletions

diff --git a/ext/bg/js/settings/profile-conditions-ui.js b/ext/bg/js/settings/profile-conditions-ui.js
new file mode 100644
index 00000000..4f206cc1
--- /dev/null
+++ b/ext/bg/js/settings/profile-conditions-ui.js
@@ -0,0 +1,686 @@
+/*
+ * 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 <https://www.gnu.org/licenses/>.
+ */
+
+/* global
+ * DocumentUtil
+ */
+
+class ProfileConditionsUI {
+    constructor(settingsController) {
+        this._settingsController = settingsController;
+        this._keySeparator = '';
+        this._keyNames = new Map();
+        this._conditionGroupsContainer = null;
+        this._addConditionGroupButton = null;
+        this._children = [];
+        this._eventListeners = new EventListenerCollection();
+        this._defaultType = 'popupLevel';
+        this._descriptors = new Map([
+            [
+                'popupLevel',
+                {
+                    displayName: 'Popup Level',
+                    defaultOperator: 'equal',
+                    operators: new Map([
+                        ['equal',              {displayName: '=',      type: 'integer', defaultValue: '0', validate: this._validateInteger.bind(this), normalize: this._normalizeInteger.bind(this)}],
+                        ['notEqual',           {displayName: '\u2260', type: 'integer', defaultValue: '0', validate: this._validateInteger.bind(this), normalize: this._normalizeInteger.bind(this)}],
+                        ['lessThan',           {displayName: '<',      type: 'integer', defaultValue: '0', validate: this._validateInteger.bind(this), normalize: this._normalizeInteger.bind(this)}],
+                        ['greaterThan',        {displayName: '>',      type: 'integer', defaultValue: '0', validate: this._validateInteger.bind(this), normalize: this._normalizeInteger.bind(this)}],
+                        ['lessThanOrEqual',    {displayName: '\u2264', type: 'integer', defaultValue: '0', validate: this._validateInteger.bind(this), normalize: this._normalizeInteger.bind(this)}],
+                        ['greaterThanOrEqual', {displayName: '\u2265', type: 'integer', defaultValue: '0', validate: this._validateInteger.bind(this), normalize: this._normalizeInteger.bind(this)}]
+                    ])
+                }
+            ],
+            [
+                'url',
+                {
+                    displayName: 'URL',
+                    defaultOperator: 'matchDomain',
+                    operators: new Map([
+                        ['matchDomain', {displayName: 'Matches Domain', type: 'string', defaultValue: 'example.com',   resetDefaultOnChange: true, validate: this._validateDomains.bind(this), normalize: this._normalizeDomains.bind(this)}],
+                        ['matchRegExp', {displayName: 'Matches RegExp', type: 'string', defaultValue: 'example\\.com', resetDefaultOnChange: true, validate: this._validateRegExp.bind(this)}]
+                    ])
+                }
+            ],
+            [
+                'modifierKeys',
+                {
+                    displayName: 'Modifier Keys',
+                    defaultOperator: 'are',
+                    operators: new Map([
+                        ['are',        {displayName: 'Are',            type: 'modifierKeys', defaultValue: ''}],
+                        ['areNot',     {displayName: 'Are Not',        type: 'modifierKeys', defaultValue: ''}],
+                        ['include',    {displayName: 'Include',        type: 'modifierKeys', defaultValue: ''}],
+                        ['notInclude', {displayName: 'Don\'t Include', type: 'modifierKeys', defaultValue: ''}]
+                    ])
+                }
+            ]
+        ]);
+    }
+
+    get settingsController() {
+        return this._settingsController;
+    }
+
+    get index() {
+        return this._settingsController.profileIndex;
+    }
+
+    setKeyInfo(separator, keyNames) {
+        this._keySeparator = separator;
+        this._keyNames.clear();
+        for (const {value, name} of keyNames) {
+            this._keyNames.set(value, name);
+        }
+    }
+
+    prepare(conditionGroups) {
+        this._conditionGroupsContainer = document.querySelector('#profile-condition-groups');
+        this._addConditionGroupButton = document.querySelector('#profile-add-condition-group');
+
+        for (let i = 0, ii = conditionGroups.length; i < ii; ++i) {
+            this._addConditionGroup(conditionGroups[i], i);
+        }
+
+        this._eventListeners.addEventListener(this._addConditionGroupButton, 'click', this._onAddConditionGroupButtonClick.bind(this), false);
+    }
+
+    cleanup() {
+        this._eventListeners.removeAllEventListeners();
+
+        for (const child of this._children) {
+            child.cleanup();
+        }
+        this._children = [];
+
+        this._conditionGroupsContainer = null;
+        this._addConditionGroupButton = null;
+    }
+
+    instantiateTemplate(templateSelector) {
+        const template = document.querySelector(templateSelector);
+        const content = document.importNode(template.content, true);
+        return content.firstChild;
+    }
+
+    getDescriptorTypes() {
+        const results = [];
+        for (const [name, {displayName}] of this._descriptors.entries()) {
+            results.push({name, displayName});
+        }
+        return results;
+    }
+
+    getDescriptorOperators(type) {
+        const info = this._descriptors.get(type);
+        const results = [];
+        if (typeof info !== 'undefined') {
+            for (const [name, {displayName}] of info.operators.entries()) {
+                results.push({name, displayName});
+            }
+        }
+        return results;
+    }
+
+    getDefaultType() {
+        return this._defaultType;
+    }
+
+    getDefaultOperator(type) {
+        const info = this._descriptors.get(type);
+        return (typeof info !== 'undefined' ? info.defaultOperator : '');
+    }
+
+    getOperatorDetails(type, operator) {
+        const info = this._getOperatorDetails(type, operator);
+
+        const {
+            displayName=operator,
+            type: type2='string',
+            defaultValue='',
+            resetDefaultOnChange=false,
+            validate=null,
+            normalize=null
+        } = (typeof info === 'undefined' ? {} : info);
+
+        return {
+            displayName,
+            type: type2,
+            defaultValue,
+            resetDefaultOnChange,
+            validate,
+            normalize
+        };
+    }
+
+    getDefaultCondition() {
+        const type = this.getDefaultType();
+        const operator = this.getDefaultOperator(type);
+        const {defaultValue: value} = this.getOperatorDetails(type, operator);
+        return {type, operator, value};
+    }
+
+    removeConditionGroup(child) {
+        const index = child.index;
+        if (index < 0 || index >= this._children.length) { return false; }
+
+        const child2 = this._children[index];
+        if (child !== child2) { return false; }
+
+        this._children.splice(index, 1);
+        child.cleanup();
+
+        for (let i = index, ii = this._children.length; i < ii; ++i) {
+            this._children[i].index = i;
+        }
+
+        this.settingsController.modifyGlobalSettings([{
+            action: 'splice',
+            path: this.getPath('conditionGroups'),
+            start: index,
+            deleteCount: 1,
+            items: []
+        }]);
+
+        return true;
+    }
+
+    splitValue(value) {
+        return value.split(/[,;\s]+/).map((v) => v.trim().toLowerCase()).filter((v) => v.length > 0);
+    }
+
+    getModifierKeyStrings(modifiers) {
+        let value = '';
+        let displayValue = '';
+        let first = true;
+        for (const modifier of modifiers) {
+            let keyName = this._keyNames.get(modifier);
+            if (typeof keyName === 'undefined') { keyName = modifier; }
+
+            if (first) {
+                first = false;
+            } else {
+                value += ', ';
+                displayValue += this._keySeparator;
+            }
+            value += modifier;
+            displayValue += keyName;
+        }
+        return {value, displayValue};
+    }
+
+    sortModifiers(modifiers) {
+        return modifiers.sort();
+    }
+
+    getPath(property) {
+        property = (typeof property === 'string' ? `.${property}` : '');
+        return `profiles[${this.index}]${property}`;
+    }
+
+    // Private
+
+    _onAddConditionGroupButtonClick() {
+        const conditionGroup = {
+            conditions: [this.getDefaultCondition()]
+        };
+        const index = this._children.length;
+
+        this._addConditionGroup(conditionGroup, index);
+
+        this.settingsController.modifyGlobalSettings([{
+            action: 'splice',
+            path: this.getPath('conditionGroups'),
+            start: index,
+            deleteCount: 0,
+            items: [conditionGroup]
+        }]);
+    }
+
+    _addConditionGroup(conditionGroup, index) {
+        const child = new ProfileConditionGroupUI(this, index);
+        child.prepare(conditionGroup);
+        this._children.push(child);
+        this._conditionGroupsContainer.appendChild(child.node);
+        return child;
+    }
+
+    _getOperatorDetails(type, operator) {
+        const info = this._descriptors.get(type);
+        return (typeof info !== 'undefined' ? info.operators.get(operator) : void 0);
+    }
+
+    _validateInteger(value) {
+        const number = Number.parseFloat(value);
+        return Number.isFinite(number) && Math.floor(number) === number;
+    }
+
+    _validateDomains(value) {
+        return this.splitValue(value).length > 0;
+    }
+
+    _validateRegExp(value) {
+        try {
+            new RegExp(value, 'i');
+            return true;
+        } catch (e) {
+            return false;
+        }
+    }
+
+    _normalizeInteger(value) {
+        const number = Number.parseFloat(value);
+        return `${number}`;
+    }
+
+    _normalizeDomains(value) {
+        return this.splitValue(value).join(', ');
+    }
+}
+
+class ProfileConditionGroupUI {
+    constructor(parent, index) {
+        this._parent = parent;
+        this._index = index;
+        this._node = null;
+        this._conditionContainer = null;
+        this._addConditionButton = null;
+        this._children = [];
+        this._eventListeners = new EventListenerCollection();
+    }
+
+    get settingsController() {
+        return this._parent.settingsController;
+    }
+
+    get parent() {
+        return this._parent;
+    }
+
+    get index() {
+        return this._index;
+    }
+
+    set index(value) {
+        this._index = value;
+    }
+
+    get node() {
+        return this._node;
+    }
+
+    prepare(conditionGroup) {
+        this._node = this._parent.instantiateTemplate('#condition-group-template');
+        this._conditionContainer = this._node.querySelector('.condition-list');
+        this._addConditionButton = this._node.querySelector('.condition-add');
+
+        const conditions = conditionGroup.conditions;
+        for (let i = 0, ii = conditions.length; i < ii; ++i) {
+            this._addCondition(conditions[i], i);
+        }
+
+        this._eventListeners.addEventListener(this._addConditionButton, 'click', this._onAddConditionButtonClick.bind(this), false);
+    }
+
+    cleanup() {
+        this._eventListeners.removeAllEventListeners();
+
+        for (const child of this._children) {
+            child.cleanup();
+        }
+        this._children = [];
+
+        if (this._node === null) { return; }
+
+        const node = this._node;
+        this._node = null;
+        this._conditionContainer = null;
+        this._addConditionButton = null;
+
+        if (node.parentNode !== null) {
+            node.parentNode.removeChild(node);
+        }
+    }
+
+    removeCondition(child) {
+        const index = child.index;
+        if (index < 0 || index >= this._children.length) { return false; }
+
+        const child2 = this._children[index];
+        if (child !== child2) { return false; }
+
+        this._children.splice(index, 1);
+        child.cleanup();
+
+        for (let i = index, ii = this._children.length; i < ii; ++i) {
+            this._children[i].index = i;
+        }
+
+        this.settingsController.modifyGlobalSettings([{
+            action: 'splice',
+            path: this.getPath('conditions'),
+            start: index,
+            deleteCount: 1,
+            items: []
+        }]);
+
+        if (this._children.length === 0) {
+            this._parent.removeConditionGroup(this);
+        }
+
+        return true;
+    }
+
+    getPath(property) {
+        property = (typeof property === 'string' ? `.${property}` : '');
+        return this._parent.getPath(`conditionGroups[${this._index}]${property}`);
+    }
+
+    // Private
+
+    _onAddConditionButtonClick() {
+        const condition = this._parent.getDefaultCondition();
+        const index = this._children.length;
+
+        this._addCondition(condition, index);
+
+        this.settingsController.modifyGlobalSettings([{
+            action: 'splice',
+            path: this.getPath('conditions'),
+            start: index,
+            deleteCount: 0,
+            items: [condition]
+        }]);
+    }
+
+    _addCondition(condition, index) {
+        const child = new ProfileConditionUI(this, index);
+        child.prepare(condition);
+        this._children.push(child);
+        this._conditionContainer.appendChild(child.node);
+        return child;
+    }
+}
+
+class ProfileConditionUI {
+    constructor(parent, index) {
+        this._parent = parent;
+        this._index = index;
+        this._node = null;
+        this._typeInput = null;
+        this._operatorInput = null;
+        this._valueInputContainer = null;
+        this._removeButton = null;
+        this._value = '';
+        this._eventListeners = new EventListenerCollection();
+        this._inputEventListeners = new EventListenerCollection();
+    }
+
+    get settingsController() {
+        return this._parent.parent.settingsController;
+    }
+
+    get parent() {
+        return this._parent;
+    }
+
+    get index() {
+        return this._index;
+    }
+
+    set index(value) {
+        this._index = value;
+    }
+
+    get node() {
+        return this._node;
+    }
+
+    prepare(condition) {
+        const {type, operator, value} = condition;
+
+        this._node = this._parent.parent.instantiateTemplate('#condition-template');
+        this._typeInput = this._node.querySelector('.condition-type');
+        this._typeOptionContainer = this._typeInput.querySelector('optgroup');
+        this._operatorInput = this._node.querySelector('.condition-operator');
+        this._operatorOptionContainer = this._operatorInput.querySelector('optgroup');
+        this._valueInput = this._node.querySelector('.condition-input-inner');
+        this._removeButton = this._node.querySelector('.condition-remove');
+
+        const operatorDetails = this._getOperatorDetails(type, operator);
+        this._updateTypes(type);
+        this._updateOperators(type, operator);
+        this._updateValueInput(value, operatorDetails);
+
+        this._eventListeners.addEventListener(this._typeInput, 'change', this._onTypeChange.bind(this), false);
+        this._eventListeners.addEventListener(this._operatorInput, 'change', this._onOperatorChange.bind(this), false);
+        this._eventListeners.addEventListener(this._removeButton, 'click', this._onRemoveButtonClick.bind(this), false);
+    }
+
+    cleanup() {
+        this._eventListeners.removeAllEventListeners();
+        this._value = '';
+
+        if (this._node === null) { return; }
+
+        const node = this._node;
+        this._node = null;
+        this._typeInput = null;
+        this._operatorInput = null;
+        this._valueInputContainer = null;
+        this._removeButton = null;
+
+        if (node.parentNode !== null) {
+            node.parentNode.removeChild(node);
+        }
+    }
+
+    getPath(property) {
+        property = (typeof property === 'string' ? `.${property}` : '');
+        return this._parent.getPath(`conditions[${this._index}]${property}`);
+    }
+
+    // Private
+
+    _onTypeChange(e) {
+        const type = e.currentTarget.value;
+        const operators = this._getDescriptorOperators(type);
+        const operator = operators.length > 0 ? operators[0].name : '';
+        const operatorDetails = this._getOperatorDetails(type, operator);
+        this._updateSelect(this._operatorInput, this._operatorOptionContainer, operators, operator);
+        this._updateValueInput(operatorDetails.defaultValue, operatorDetails);
+        this.settingsController.setGlobalSetting(this.getPath('type'), type);
+    }
+
+    _onOperatorChange(e) {
+        const type = this._typeInput.value;
+        const operator = e.currentTarget.value;
+        const operatorDetails = this._getOperatorDetails(type, operator);
+        if (operatorDetails.resetDefaultOnChange) {
+            const okay = this._updateValueInput(operatorDetails.defaultValue, operatorDetails);
+            if (okay) {
+                this.settingsController.setGlobalSetting(this.getPath('operator'), operator);
+            }
+        }
+    }
+
+    _onValueInputChange({validate, normalize}, e) {
+        const node = e.currentTarget;
+        const value = node.value;
+        const okay = this._validateValue(value, validate);
+        this._value = value;
+        if (okay) {
+            const normalizedValue = this._normalizeValue(value, normalize);
+            node.value = normalizedValue;
+            this.settingsController.setGlobalSetting(this.getPath('value'), normalizedValue);
+        }
+    }
+
+    _onModifierKeyDown({validate, normalize}, e) {
+        e.preventDefault();
+        const node = e.currentTarget;
+
+        let modifiers;
+        const key = DocumentUtil.getKeyFromEvent(e);
+        switch (key) {
+            case 'Escape':
+            case 'Backspace':
+                modifiers = [];
+                break;
+            default:
+                {
+                    modifiers = this._getModifiers(e);
+                    const currentModifier = this._splitValue(this._value);
+                    for (const modifier of currentModifier) {
+                        modifiers.add(modifier);
+                    }
+                    modifiers = [...modifiers];
+                    modifiers = this._sortModifiers(modifiers);
+                }
+                break;
+        }
+
+        const {value, displayValue} = this._getModifierKeyStrings(modifiers);
+        node.value = displayValue;
+        const okay = this._validateValue(value, validate);
+        this._value = value;
+        if (okay) {
+            const normalizedValue = this._normalizeValue(value, normalize);
+            node.value = normalizedValue;
+            this.settingsController.setGlobalSetting(this.getPath('value'), normalizedValue);
+        }
+    }
+
+    _onRemoveButtonClick() {
+        this._parent.removeCondition(this);
+    }
+
+    _getDescriptorTypes() {
+        return this._parent.parent.getDescriptorTypes();
+    }
+
+    _getDescriptorOperators(type) {
+        return this._parent.parent.getDescriptorOperators(type);
+    }
+
+    _getOperatorDetails(type, operator) {
+        return this._parent.parent.getOperatorDetails(type, operator);
+    }
+
+    _getModifierKeyStrings(modifiers) {
+        return this._parent.parent.getModifierKeyStrings(modifiers);
+    }
+
+    _sortModifiers(modifiers) {
+        return this._parent.parent.sortModifiers(modifiers);
+    }
+
+    _splitValue(value) {
+        return this._parent.parent.splitValue(value);
+    }
+
+    _updateTypes(type) {
+        const types = this._getDescriptorTypes();
+        this._updateSelect(this._typeInput, this._typeOptionContainer, types, type);
+    }
+
+    _updateOperators(type, operator) {
+        const operators = this._getDescriptorOperators(type);
+        this._updateSelect(this._operatorInput, this._operatorOptionContainer, operators, operator);
+    }
+
+    _updateSelect(select, optionContainer, values, value) {
+        optionContainer.textContent = '';
+        for (const {name, displayName} of values) {
+            const option = document.createElement('option');
+            option.value = name;
+            option.textContent = displayName;
+            optionContainer.appendChild(option);
+        }
+        select.value = value;
+    }
+
+    _updateValueInput(value, {type, validate, normalize}) {
+        this._inputEventListeners.removeAllEventListeners();
+
+        const inputData = {validate, normalize};
+        const node = this._valueInput;
+        node.classList.remove('is-invalid');
+        this._value = value;
+
+        switch (type) {
+            case 'integer':
+                {
+                    node.type = 'number';
+                    node.step = '1';
+                    node.value = value;
+                    this._inputEventListeners.addEventListener(node, 'change', this._onValueInputChange.bind(this, inputData), false);
+                }
+                break;
+            case 'modifierKeys':
+                {
+                    const modifiers = this._splitValue(value);
+                    const {displayValue} = this._getModifierKeyStrings(modifiers);
+                    node.type = 'text';
+                    node.removeAttribute('step');
+                    node.value = displayValue;
+                    this._inputEventListeners.addEventListener(node, 'keydown', this._onModifierKeyDown.bind(this, inputData), false);
+                }
+                break;
+            default: // 'string'
+                {
+                    node.type = 'text';
+                    node.removeAttribute('step');
+                    node.value = value;
+                    this._inputEventListeners.addEventListener(node, 'change', this._onValueInputChange.bind(this, inputData), false);
+                }
+                break;
+        }
+
+        this._validateValue(value, validate);
+    }
+
+    _validateValue(value, validate) {
+        const okay = (validate === null || validate(value));
+        this._valueInput.classList.toggle('is-invalid', !okay);
+        return okay;
+    }
+
+    _normalizeValue(value, normalize) {
+        return (normalize !== null ? normalize(value) : value);
+    }
+
+    _getModifiers(e) {
+        const modifiers = DocumentUtil.getActiveModifiers(e);
+        // https://developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent/metaKey
+        // https://askubuntu.com/questions/567731/why-is-shift-alt-being-mapped-to-meta
+        // It works with mouse events on some platforms, so try to determine if metaKey is pressed.
+        // This is a hack and only works when both Shift and Alt are not pressed.
+        if (
+            !modifiers.has('meta') &&
+            DocumentUtil.getKeyFromEvent(e) === 'Meta' &&
+            !(
+                modifiers.size === 2 &&
+                modifiers.has('shift') &&
+                modifiers.has('alt')
+            )
+        ) {
+            modifiers.add('meta');
+        }
+        return modifiers;
+    }
+}