From 8f97ca0aacd9a9f36038aa680cc6b9929450fbc5 Mon Sep 17 00:00:00 2001 From: toasted-nutbread Date: Thu, 4 Feb 2021 22:17:42 -0500 Subject: Permissions toggle controller (#1347) * Move file, rename class * Expose required permissions in an attribute * Update selector * Update attribute * Fix global declaration order --- ext/bg/js/settings/clipboard-popups-controller.js | 91 ------------------ ext/bg/js/settings/main.js | 6 +- .../js/settings/permissions-toggle-controller.js | 103 +++++++++++++++++++++ ext/bg/js/settings2/settings-main.js | 6 +- 4 files changed, 109 insertions(+), 97 deletions(-) delete mode 100644 ext/bg/js/settings/clipboard-popups-controller.js create mode 100644 ext/bg/js/settings/permissions-toggle-controller.js (limited to 'ext/bg/js') diff --git a/ext/bg/js/settings/clipboard-popups-controller.js b/ext/bg/js/settings/clipboard-popups-controller.js deleted file mode 100644 index cd1c2057..00000000 --- a/ext/bg/js/settings/clipboard-popups-controller.js +++ /dev/null @@ -1,91 +0,0 @@ -/* - * 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 . - */ - -/* global - * ObjectPropertyAccessor - */ - -class ClipboardPopupsController { - constructor(settingsController) { - this._settingsController = settingsController; - this._toggles = null; - } - - async prepare() { - this._toggles = document.querySelectorAll('.clipboard-toggle'); - - for (const toggle of this._toggles) { - toggle.addEventListener('change', this._onClipboardToggleChange.bind(this), false); - } - this._settingsController.on('optionsChanged', this._onOptionsChanged.bind(this)); - this._settingsController.on('permissionsChanged', this._onPermissionsChanged.bind(this)); - - const options = await this._settingsController.getOptions(); - this._onOptionsChanged({options}); - } - - // Private - - _onOptionsChanged({options}) { - const accessor = new ObjectPropertyAccessor(options); - for (const toggle of this._toggles) { - const path = ObjectPropertyAccessor.getPathArray(toggle.dataset.clipboardSetting); - let value; - try { - value = accessor.get(path, path.length); - } catch (e) { - continue; - } - toggle.checked = !!value; - } - this._updateValidity(); - } - - async _onClipboardToggleChange(e) { - const toggle = e.currentTarget; - let value = toggle.checked; - - if (value) { - toggle.checked = false; - value = await this._settingsController.setPermissionsGranted(['clipboardRead'], true); - toggle.checked = value; - } - - this._setToggleValid(toggle, true); - - await this._settingsController.setProfileSetting(toggle.dataset.clipboardSetting, value); - } - - _onPermissionsChanged({permissions: {permissions}}) { - const permissionsSet = new Set(permissions); - for (const toggle of this._toggles) { - const valid = !toggle.checked || permissionsSet.has('clipboardRead'); - this._setToggleValid(toggle, valid); - } - } - - _setToggleValid(toggle, valid) { - const relative = toggle.closest('.settings-item'); - if (relative === null) { return; } - relative.dataset.invalid = `${!valid}`; - } - - async _updateValidity() { - const permissions = await this._settingsController.getAllPermissions(); - this._onPermissionsChanged({permissions}); - } -} diff --git a/ext/bg/js/settings/main.js b/ext/bg/js/settings/main.js index 0ce0b2db..9786d196 100644 --- a/ext/bg/js/settings/main.js +++ b/ext/bg/js/settings/main.js @@ -20,11 +20,11 @@ * AnkiTemplatesController * AudioController * BackupController - * ClipboardPopupsController * DictionaryController * DictionaryImportController * GenericSettingController * ModalController + * PermissionsToggleController * PopupPreviewController * ProfileController * ScanInputsController @@ -71,8 +71,8 @@ async function setupEnvironmentInfo() { const genericSettingController = new GenericSettingController(settingsController); genericSettingController.prepare(); - const clipboardPopupsController = new ClipboardPopupsController(settingsController); - clipboardPopupsController.prepare(); + const permissionsToggleController = new PermissionsToggleController(settingsController); + permissionsToggleController.prepare(); const popupPreviewController = new PopupPreviewController(settingsController); popupPreviewController.prepare(); diff --git a/ext/bg/js/settings/permissions-toggle-controller.js b/ext/bg/js/settings/permissions-toggle-controller.js new file mode 100644 index 00000000..07db1cf8 --- /dev/null +++ b/ext/bg/js/settings/permissions-toggle-controller.js @@ -0,0 +1,103 @@ +/* + * 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 . + */ + +/* global + * ObjectPropertyAccessor + */ + +class PermissionsToggleController { + constructor(settingsController) { + this._settingsController = settingsController; + this._toggles = null; + } + + async prepare() { + this._toggles = document.querySelectorAll('.permissions-toggle'); + + for (const toggle of this._toggles) { + toggle.addEventListener('change', this._onPermissionsToggleChange.bind(this), false); + } + this._settingsController.on('optionsChanged', this._onOptionsChanged.bind(this)); + this._settingsController.on('permissionsChanged', this._onPermissionsChanged.bind(this)); + + const options = await this._settingsController.getOptions(); + this._onOptionsChanged({options}); + } + + // Private + + _onOptionsChanged({options}) { + const accessor = new ObjectPropertyAccessor(options); + for (const toggle of this._toggles) { + const path = ObjectPropertyAccessor.getPathArray(toggle.dataset.permissionsSetting); + let value; + try { + value = accessor.get(path, path.length); + } catch (e) { + continue; + } + toggle.checked = !!value; + } + this._updateValidity(); + } + + async _onPermissionsToggleChange(e) { + const toggle = e.currentTarget; + let value = toggle.checked; + + if (value) { + toggle.checked = false; + value = await this._settingsController.setPermissionsGranted(this._getRequiredPermissions(toggle), true); + toggle.checked = value; + } + + this._setToggleValid(toggle, true); + + await this._settingsController.setProfileSetting(toggle.dataset.permissionsSetting, value); + } + + _onPermissionsChanged({permissions: {permissions}}) { + const permissionsSet = new Set(permissions); + for (const toggle of this._toggles) { + const valid = !toggle.checked || this._hasAll(permissionsSet, this._getRequiredPermissions(toggle)); + this._setToggleValid(toggle, valid); + } + } + + _setToggleValid(toggle, valid) { + const relative = toggle.closest('.settings-item'); + if (relative === null) { return; } + relative.dataset.invalid = `${!valid}`; + } + + async _updateValidity() { + const permissions = await this._settingsController.getAllPermissions(); + this._onPermissionsChanged({permissions}); + } + + _hasAll(set, values) { + for (const value of values) { + if (!set.has(value)) { return false; } + } + return true; + } + + _getRequiredPermissions(toggle) { + const requiredPermissions = toggle.dataset.requiredPermissions; + return (typeof requiredPermissions === 'string' && requiredPermissions.length > 0 ? requiredPermissions.split(' ') : []); + } +} diff --git a/ext/bg/js/settings2/settings-main.js b/ext/bg/js/settings2/settings-main.js index 31c5b0fa..f4a38d85 100644 --- a/ext/bg/js/settings2/settings-main.js +++ b/ext/bg/js/settings2/settings-main.js @@ -20,7 +20,6 @@ * AnkiTemplatesController * AudioController * BackupController - * ClipboardPopupsController * DictionaryController * DictionaryImportController * DocumentFocusController @@ -29,6 +28,7 @@ * KeyboardShortcutController * ModalController * NestedPopupsController + * PermissionsToggleController * PopupPreviewController * PopupWindowController * ProfileController @@ -119,8 +119,8 @@ async function setupGenericSettingsController(genericSettingController) { const nestedPopupsController = new NestedPopupsController(settingsController); nestedPopupsController.prepare(); - const clipboardPopupsController = new ClipboardPopupsController(settingsController); - clipboardPopupsController.prepare(); + const permissionsToggleController = new PermissionsToggleController(settingsController); + permissionsToggleController.prepare(); const secondarySearchDictionaryController = new SecondarySearchDictionaryController(settingsController); secondarySearchDictionaryController.prepare(); -- cgit v1.2.3