From e8fef6a40d15345d09c1a4ae2f497c09b7eec6d4 Mon Sep 17 00:00:00 2001 From: Robbendebiene Date: Sun, 5 Jun 2022 20:59:40 +0200 Subject: [PATCH 01/21] Remove entire exclusion functionality Firefox will provide global user controls for site access per add-on. See: - https://bugzilla.mozilla.org/show_bug.cgi?id=1497075 - https://bugzilla.mozilla.org/show_bug.cgi?id=1711787 Removing this option from Gesturefy reduces the amount of code that needs to be maintained. It's also more performant to exclude the entire content script from running than doing content script side checks. Last but not least exclusions have always been a power feature that never really fit into Gesturefy from a design/UI standpoint. Also resolves #542 --- src/_locales/en/messages.json | 29 ---- src/core/bundle/content.bundle.js | 48 ++---- src/core/content.mjs | 48 ++---- src/resources/json/defaults.json | 3 +- src/views/options/exclusions.mjs | 162 --------------------- src/views/options/fragments/exclusions.inc | 14 -- src/views/options/index.html | 8 - src/views/options/layout.css | 132 ----------------- 8 files changed, 25 insertions(+), 419 deletions(-) delete mode 100644 src/views/options/exclusions.mjs delete mode 100644 src/views/options/fragments/exclusions.inc diff --git a/src/_locales/en/messages.json b/src/_locales/en/messages.json index 28299ecff..e103309d5 100644 --- a/src/_locales/en/messages.json +++ b/src/_locales/en/messages.json @@ -37,10 +37,6 @@ "message": "Extras", "description": "Extras" }, - "navigationExclusions": { - "message": "Exclusions", - "description": "Exclusions" - }, "navigationAbout": { "message": "About", "description": "About" @@ -289,31 +285,6 @@ "description": "The minimal amount the mouse wheel must be scrolled until the gesture is triggered." }, - "exclusionsLabelInformation": { - "message": "Information:", - "description": "Information:" - }, - "exclusionsTextInformation": { - "message": "Add URL match patterns to disable Gesturefy for certain websites. The match pattern allows \"*\" wildcards and must be in the form of ://.", - "description": "Add URL match patterns to disable Gesturefy for certain websites. The match pattern allows \"*\" wildcards and must be in the form of ://." - }, - "exclusionsPlaceholderURL": { - "message": "Enter URL match pattern", - "description": "Enter URL match pattern" - }, - "exclusionsAddButton": { - "message": "Add", - "description": "Add" - }, - "exclusionsNotificationAlreadyExists": { - "message": "URL pattern already exists.", - "description": "URL pattern already exists." - }, - "exclusionsHintNoEntries": { - "message": "No entries available", - "description": "No entries available" - }, - "aboutBackup": { "message": "Backup", "description": "Backup" diff --git a/src/core/bundle/content.bundle.js b/src/core/bundle/content.bundle.js index 1c9ae1a46..fb044b1d7 100644 --- a/src/core/bundle/content.bundle.js +++ b/src/core/bundle/content.bundle.js @@ -2315,46 +2315,22 @@ async function main () { PopupCommandView.theme = Config.get("Settings.General.theme"); - // check if current url is not listed in the exclusions - if (!Config.get("Exclusions").some(matchesCurrentURL)) { - // enable mouse gesture controller - MouseGestureController.enable(); - - // enable/disable rocker gesture - if (Config.get("Settings.Rocker.active")) { - RockerGestureController.enable(); - } - else { - RockerGestureController.disable(); - } + // enable mouse gesture controller + MouseGestureController.enable(); - // enable/disable wheel gesture - if (Config.get("Settings.Wheel.active")) { - WheelGestureController.enable(); - } - else { - WheelGestureController.disable(); - } + // enable/disable rocker gesture + if (Config.get("Settings.Rocker.active")) { + RockerGestureController.enable(); } - // if url is excluded disable everything else { - MouseGestureController.disable(); RockerGestureController.disable(); - WheelGestureController.disable(); } -} - -/** - * checks if the given url is a subset of the current url or equal - * NOTE: window.location.href is returning the frame URL for frames and not the tab URL - **/ -function matchesCurrentURL (urlPattern) { - // match special regex characters - const pattern = urlPattern.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, (match) => { - // replace * with .* -> matches anything 0 or more times, else escape character - return match === '*' ? '.*' : '\\'+match; - }); - // ^ matches beginning of input and $ matches ending of input - return new RegExp('^'+pattern+'$').test(window.location.href); + // enable/disable wheel gesture + if (Config.get("Settings.Wheel.active")) { + WheelGestureController.enable(); + } + else { + WheelGestureController.disable(); + } } diff --git a/src/core/content.mjs b/src/core/content.mjs index 92a4a852b..e17a697a6 100644 --- a/src/core/content.mjs +++ b/src/core/content.mjs @@ -278,46 +278,22 @@ async function main () { PopupCommandView.theme = Config.get("Settings.General.theme"); - // check if current url is not listed in the exclusions - if (!Config.get("Exclusions").some(matchesCurrentURL)) { - // enable mouse gesture controller - MouseGestureController.enable(); - - // enable/disable rocker gesture - if (Config.get("Settings.Rocker.active")) { - RockerGestureController.enable(); - } - else { - RockerGestureController.disable(); - } + // enable mouse gesture controller + MouseGestureController.enable(); - // enable/disable wheel gesture - if (Config.get("Settings.Wheel.active")) { - WheelGestureController.enable(); - } - else { - WheelGestureController.disable(); - } + // enable/disable rocker gesture + if (Config.get("Settings.Rocker.active")) { + RockerGestureController.enable(); } - // if url is excluded disable everything else { - MouseGestureController.disable(); RockerGestureController.disable(); - WheelGestureController.disable(); } -} - -/** - * checks if the given url is a subset of the current url or equal - * NOTE: window.location.href is returning the frame URL for frames and not the tab URL - **/ -function matchesCurrentURL (urlPattern) { - // match special regex characters - const pattern = urlPattern.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, (match) => { - // replace * with .* -> matches anything 0 or more times, else escape character - return match === '*' ? '.*' : '\\'+match; - }); - // ^ matches beginning of input and $ matches ending of input - return new RegExp('^'+pattern+'$').test(window.location.href); + // enable/disable wheel gesture + if (Config.get("Settings.Wheel.active")) { + WheelGestureController.enable(); + } + else { + WheelGestureController.disable(); + } } diff --git a/src/resources/json/defaults.json b/src/resources/json/defaults.json index 9e7aceaa7..88b038513 100644 --- a/src/resources/json/defaults.json +++ b/src/resources/json/defaults.json @@ -298,6 +298,5 @@ } } } - ], - "Exclusions": [] + ] } diff --git a/src/views/options/exclusions.mjs b/src/views/options/exclusions.mjs deleted file mode 100644 index afff2de2d..000000000 --- a/src/views/options/exclusions.mjs +++ /dev/null @@ -1,162 +0,0 @@ -import { ContentLoaded, Config } from "/views/options/main.mjs"; - -ContentLoaded.then(main); - -/** - * main function - * run code that depends on async resources - **/ -function main () { - const exclusionsContainer = document.getElementById('exclusionsContainer'); - exclusionsContainer.dataset.noEntriesHint = browser.i18n.getMessage('exclusionsHintNoEntries'); - const exclusionsForm = document.getElementById('exclusionsForm'); - exclusionsForm.onsubmit = onFormSubmit; - exclusionsForm.elements.urlPattern.placeholder = browser.i18n.getMessage('exclusionsPlaceholderURL'); - exclusionsForm.elements.urlPattern.title = browser.i18n.getMessage('exclusionsPlaceholderURL'); - exclusionsForm.elements.urlPattern.onchange = onInputChange; - // add existing exclusions entries - for (const urlPattern of Config.get("Exclusions")) { - const exclusionsEntry = createExclusionsEntry(urlPattern); - exclusionsContainer.appendChild(exclusionsEntry); - } -} - - -/** - * Creates a exclusions entry html element by a given url pattern and returns it - **/ -function createExclusionsEntry (urlPattern) { - const exclusionsEntry = document.createElement('li'); - exclusionsEntry.classList.add('excl-entry'); - exclusionsEntry.dataset.urlPattern = urlPattern; - exclusionsEntry.onclick = onEntryClick; - const inputURLEntry = document.createElement('div'); - inputURLEntry.classList.add('excl-url-pattern'); - inputURLEntry.textContent = urlPattern; - const deleteButton = document.createElement('button'); - deleteButton.type = "button"; - deleteButton.classList.add('excl-remove-button', 'icon-delete'); - exclusionsEntry.append(inputURLEntry, deleteButton); - return exclusionsEntry; -} - - -/** - * Adds a given exclusions entry element to the exclusions ui - **/ -function addExclusionsEntry (exclusionsEntry) { - const exclusionsContainer = document.getElementById('exclusionsContainer'); - // append entry, hide it and move it out of flow to calculate its dimensions - exclusionsContainer.prepend(exclusionsEntry); - exclusionsEntry.style.setProperty('visibility', 'hidden'); - exclusionsEntry.style.setProperty('position', 'absolute'); - // calculate total entry height - const computedStyle = window.getComputedStyle(exclusionsEntry); - const outerHeight = parseInt(computedStyle.marginTop) + exclusionsEntry.offsetHeight + parseInt(computedStyle.marginBottom); - - // move all entries up by one entry including the new one - for (const node of exclusionsContainer.children) { - node.style.setProperty('transform', `translateY(-${outerHeight}px)`); - // remove ongoing transitions if existing - node.style.removeProperty('transition'); - } - // show new entry and bring it back to flow, which pushes all elements down by the height of one entry - exclusionsEntry.style.removeProperty('visibility', 'hidden'); - exclusionsEntry.style.removeProperty('position', 'absolute'); - - // trigger reflow - exclusionsContainer.offsetHeight; - - exclusionsEntry.addEventListener('animationend', (event) => { - event.currentTarget.classList.remove('excl-entry-animate-add'); - }, {once: true }); - exclusionsEntry.classList.add('excl-entry-animate-add'); - - // move all entries down including the new one - for (const node of exclusionsContainer.children) { - node.addEventListener('transitionend', (event) => event.currentTarget.style.removeProperty('transition'), {once: true }); - node.style.setProperty('transition', 'transform 0.3s'); - node.style.removeProperty('transform'); - } -} - - -/** - * Removes a given exclusions entry element from the exclusions ui - **/ -function removeExclusionsEntry (exclusionsEntry) { - // calculate total entry height - const computedStyle = window.getComputedStyle(exclusionsEntry); - const outerHeight = parseInt(computedStyle.marginTop) + exclusionsEntry.offsetHeight + parseInt(computedStyle.marginBottom); - - let node = exclusionsEntry.nextElementSibling; - while (node) { - node.addEventListener('transitionend', (event) => { - event.currentTarget.style.removeProperty('transition'); - event.currentTarget.style.removeProperty('transform'); - }, {once: true }); - node.style.setProperty('transition', 'transform 0.3s'); - node.style.setProperty('transform', `translateY(-${outerHeight}px)`); - node = node.nextElementSibling; - } - exclusionsEntry.addEventListener('animationend', (event) => event.currentTarget.remove(), {once: true }); - exclusionsEntry.classList.add('excl-entry-animate-remove'); -} - - -/** - * Handles the url pattern submit event - * Adds the new url pattern to the config and calls the exclusions entry create function - **/ -function onFormSubmit (event) { - event.preventDefault(); - // remove spaces and cancel the function if the value is empty - const urlPattern = this.elements.urlPattern.value.trim(); - if (!urlPattern) return; - // create and add entry to the exclusions - const exclusionsEntry = createExclusionsEntry(urlPattern); - addExclusionsEntry(exclusionsEntry); - // add new url pattern to the beginning of the array - const exclusionsArray = Config.get("Exclusions"); - exclusionsArray.unshift(urlPattern); - Config.set("Exclusions", exclusionsArray); - // clear input field - this.elements.urlPattern.value = ''; -} - - -/** - * Handles the url pattern input changes - * Marks the field as invalide if the entry already exists - **/ -function onInputChange () { - if (Config.get("Exclusions").indexOf(this.value.trim()) !== -1) { - this.setCustomValidity(browser.i18n.getMessage('exclusionsNotificationAlreadyExists')); - } - else if (this.validity.customError) this.setCustomValidity(''); -} - - -/** - * Handles the exclusions entry click - * Calls the remove exclusions entry function on remove button click and removes it from the config - **/ -function onEntryClick (event) { - // if delete button received the click - if (event.target.classList.contains('excl-remove-button')) { - removeExclusionsEntry(this); - - const exclusionsForm = document.getElementById('exclusionsForm'); - // remove input field invaldility if it was previously a duplicate - if (this.dataset.urlPattern === exclusionsForm.elements.urlPattern.value.trim()) { - exclusionsForm.elements.urlPattern.setCustomValidity(''); - } - const exclusionsArray = Config.get("Exclusions"); - // remove url pattern from array - const index = exclusionsArray.indexOf(this.dataset.urlPattern); - if (index !== -1) { - exclusionsArray.splice(index, 1); - Config.set("Exclusions", exclusionsArray); - } - } -} diff --git a/src/views/options/fragments/exclusions.inc b/src/views/options/fragments/exclusions.inc deleted file mode 100644 index 3bf1a55aa..000000000 --- a/src/views/options/fragments/exclusions.inc +++ /dev/null @@ -1,14 +0,0 @@ -
-

-
-

- - - -

-
-
- - -
-
    diff --git a/src/views/options/index.html b/src/views/options/index.html index cbd98eead..c8d1d3e99 100644 --- a/src/views/options/index.html +++ b/src/views/options/index.html @@ -14,7 +14,6 @@ - @@ -40,12 +39,6 @@ -
  • - - - - -
  • @@ -65,7 +58,6 @@
    -
    diff --git a/src/views/options/layout.css b/src/views/options/layout.css index 6475a1b5f..494781522 100644 --- a/src/views/options/layout.css +++ b/src/views/options/layout.css @@ -1102,135 +1102,3 @@ label.button > span { #gesturePopupPatternContainer .gl-thumbnail-arrow { --arrowScale: 0.6; } - - -/** - * Exclusions layout - **/ - -.excl-form { - display: flex; - align-items: stretch; -} - -.excl-url-pattern-input { - flex: 1; - box-sizing: border-box; - padding: 8px 10px 6px 10px; - border: 1px solid var(--border-color); - border-right: none; - border-radius: 2px 0 0 2px; - background: var(--base-color); - color: var(--text-color); - text-overflow: ellipsis ellipsis; -} - -.excl-url-pattern-input:invalid { - box-shadow: none; -} - -.excl-add-button { - padding: 0 20px; - border-radius: 0 2px 2px 0; - background: var(--highlighted-color); - color: var(--textSecond-color); - text-align: center; - line-height: 100%; -} - -.exclusions { - padding-top: 20px; -} - -.exclusions::after { - display: block; - visibility: hidden; - opacity: 0; - color: var(--text-color); - content: attr(data-no-entries-hint); - text-align: center; - font-size: 18px; -} - -.exclusions:empty::after { - visibility: visible; - opacity: .5; - transition: opacity .3s; -} - -.excl-entry { - display: flex; - align-items: center; - box-sizing: border-box; - padding-bottom: 10px; - cursor: default; -} - -.excl-entry:not(:last-child) { - margin-bottom: 10px; - border-bottom: 1px dashed var(--borderSecond-color); -} - -.excl-url-pattern { - flex: 1; - padding-right: 10px; - word-break: break-all; -} - -.excl-remove-button { - width: 18px; - height: 18px; - border-radius: 50%; - background-color: var(--border-color); - color: var(--base-color); - text-align: center; - font-size: 6px; - font-family: Icons; - line-height: 6px; -} - -.excl-remove-button:hover { - background-color: var(--warning-color); -} - -.excl-entry-animate-add { - z-index: -1; - animation-name: animateAddEntry; - animation-duration: .3s; - animation-timing-function: ease; -} - -@keyframes animateAddEntry { - from { - opacity: 0; - } - 50% { - opacity: .3; - } - to { - opacity: 1; - } -} - -.excl-entry-animate-remove { - animation-name: animateDeleteEntry; - animation-duration: .3s; - animation-timing-function: ease; -} - -@keyframes animateDeleteEntry { - from { - opacity: 1; - transform: scale(1); - } - 30% { - visibility: hidden; - opacity: 0; - transform: scale(.9); - } - to { - visibility: hidden; - opacity: 0; - transform: scale(.9); - } -} \ No newline at end of file From eccea39358ab6e84801c3068042ee4c5763b12e8 Mon Sep 17 00:00:00 2001 From: Robbendebiene Date: Sun, 5 Jun 2022 21:01:23 +0200 Subject: [PATCH 02/21] Minor code adjustments --- src/core/background.mjs | 2 +- src/views/options/main.mjs | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/src/core/background.mjs b/src/core/background.mjs index 3734ffd15..8031b195e 100644 --- a/src/core/background.mjs +++ b/src/core/background.mjs @@ -36,7 +36,7 @@ function updateVariablesOnConfigChange () { RockerGestureRight = new Command(Config.get("Settings.Rocker.rightMouseClick")); WheelGestureUp = new Command(Config.get("Settings.Wheel.wheelUp")); WheelGestureDown = new Command(Config.get("Settings.Wheel.wheelDown")); - } +} /** diff --git a/src/views/options/main.mjs b/src/views/options/main.mjs index f7562a61e..68eea43a8 100644 --- a/src/views/options/main.mjs +++ b/src/views/options/main.mjs @@ -45,7 +45,7 @@ function main () { input.checked = input.value === value; } else input.value = value; - input.addEventListener('change', onChage); + input.addEventListener('change', onChange); } // toggle collapsables and add their event function @@ -117,7 +117,7 @@ function onThemeButtonChange () { /** * save input value if valid **/ - function onChage () { + function onChange () { // check if valid, if there is no validity property check if value is set if ((this.validity && this.validity.valid) || (!this.validity && this.value)) { let value; From e8ccf64fa83dc489747dd281289327314c58a2dc Mon Sep 17 00:00:00 2001 From: Robbendebiene Date: Wed, 22 Jun 2022 19:38:20 +0200 Subject: [PATCH 03/21] Convert JSON config files to JS modules The reason behind this change is that content scripts no longer get access to extension files unless they are declared as a web_accessible_resource. I'm against doing so for privacy reasons. At least in theory websites could use web_accessible_resource for fingerprinting. Some additional information can be found here: https://bugzilla.mozilla.org/show_bug.cgi?id=1578405 --- src/core/background.mjs | 12 +- src/core/bundle/content.bundle.js | 355 +++++++++- src/core/content.mjs | 12 +- src/core/helpers/config-manager.mjs | 37 +- src/core/utils/commons.mjs | 26 +- .../commands.json => configs/commands.mjs} | 4 +- .../defaults.json => configs/defaults.mjs} | 604 +++++++++--------- .../components/command-multi-select/main.mjs | 21 +- .../components/command-select/main.mjs | 9 +- src/views/options/data-management.mjs | 9 +- src/views/options/main.mjs | 5 +- 11 files changed, 685 insertions(+), 409 deletions(-) rename src/resources/{json/commands.json => configs/commands.mjs} (99%) rename src/resources/{json/defaults.json => configs/defaults.mjs} (93%) diff --git a/src/core/background.mjs b/src/core/background.mjs index 8031b195e..cbc7b174b 100644 --- a/src/core/background.mjs +++ b/src/core/background.mjs @@ -6,6 +6,8 @@ import Gesture from "/core/models/gesture.mjs"; import Command from "/core/models/command.mjs"; +import DefaultConfig from "/resources/configs/defaults.mjs"; + import { getClosestGestureByPattern } from "/core/utils/matching-algorithms.mjs"; import "/core/helpers/message-router.mjs"; @@ -13,10 +15,12 @@ import "/core/helpers/message-router.mjs"; // temporary data migration import "/core/migration.mjs"; -const Config = new ConfigManager("local", browser.runtime.getURL("resources/json/defaults.json")); - Config.autoUpdate = true; - Config.loaded.then(updateVariablesOnConfigChange); - Config.addEventListener("change", updateVariablesOnConfigChange); +const Config = new ConfigManager({ + defaults: DefaultConfig, + autoUpdate: true +}); +Config.loaded.then(updateVariablesOnConfigChange); +Config.addEventListener("change", updateVariablesOnConfigChange); const MouseGestures = new Set(); diff --git a/src/core/bundle/content.bundle.js b/src/core/bundle/content.bundle.js index fb044b1d7..f476a4547 100644 --- a/src/core/bundle/content.bundle.js +++ b/src/core/bundle/content.bundle.js @@ -1,10 +1,9 @@ 'use strict'; /** - * get JSON file as object from url - * returns a promise which is fulfilled with the json object as a parameter + * get HTML file as fragment from url + * returns a promise which is fulfilled with the fragment * otherwise it's rejected - * request url needs permissions in the addon manifest **/ @@ -238,34 +237,27 @@ class ConfigManager { * For the first parameter either "local" or "sync" is allowed. * An URL to a JSON formatted file can be passed optionally. The containing properties will be treated as the defaults. **/ - constructor (storageArea, defaultsURL) { + constructor ({ + storageArea = "local", + defaults = {}, + autoUpdate = false + }) { if (storageArea !== "local" && storageArea !== "sync") { - throw "The first argument must be a storage area in form of a string containing either local or sync."; + throw "storageArea must either \"local\" or \"sync\"."; } - if (typeof defaultsURL !== "string" && defaultsURL !== undefined) { - throw "The second argument must be an URL to a JSON file."; + if (!isObject(defaults)) { + throw "defaults must be an object."; } this._storageArea = storageArea; // empty object as default value so the config doesn't have to be loaded this._storage = {}; - this._defaults = {}; - - const fetchResources = [ browser.storage[this._storageArea].get() ]; - if (typeof defaultsURL === "string") { - const defaultsObject = new Promise((resolve, reject) => { - fetch(defaultsURL, {mode:'same-origin'}) - .then(res => res.json()) - .then(obj => resolve(obj), err => reject(err)); - }); - fetchResources.push( defaultsObject ); - } - // load resources - this._loaded = Promise.all(fetchResources); - // store resources when loaded - this._loaded.then((values) => { - if (values[0]) this._storage = values[0]; - if (values[1]) this._defaults = values[1]; + this._defaults = defaults; + + this._loaded = browser.storage[this._storageArea].get(); + // store config when loaded + this._loaded.then((value) => { + if (value) this._storage = value; }); // holds all custom event callbacks @@ -273,7 +265,7 @@ class ConfigManager { 'change': new Set() }; // defines if the storage should be automatically loaded und updated on storage changes - this._autoUpdate = false; + this._autoUpdate = autoUpdate; // setup on storage change handler browser.storage.onChanged.addListener((changes, areaName) => { if (areaName === this._storageArea) { @@ -475,6 +467,309 @@ class ConfigManager { } } +var DefaultConfig = Object.freeze({ + "Settings": { + "Gesture": { + "mouseButton": 2, + "suppressionKey": "", + "distanceThreshold": 10, + "deviationTolerance": 0.15, + "matchingAlgorithm": "combined", + "Timeout": { + "active": false, + "duration": 1 + }, + "Trace": { + "display": true, + "Style": { + "strokeStyle": "#00aaa0cc", + "lineWidth": 10, + "lineGrowth": true + } + }, + "Command": { + "display": true, + "Style": { + "fontColor": "#ffffffff", + "backgroundColor": "#00000080", + "fontSize": "7vh", + "horizontalPosition": 50, + "verticalPosition": 40 + } + } + }, + "Rocker": { + "active": false, + "leftMouseClick": { + "name": "PageBack" + }, + "rightMouseClick": { + "name": "PageForth" + } + }, + "Wheel": { + "active": false, + "mouseButton": 1, + "wheelSensitivity": 30, + "wheelUp": { + "name": "FocusRightTab", + "settings": { + "cycling": true, + "excludeDiscarded": false + } + }, + "wheelDown": { + "name": "FocusLeftTab", + "settings": { + "cycling": true, + "excludeDiscarded": false + } + } + }, + "General": { + "updateNotification": true, + "theme": "light" + } + }, + "Gestures": [ + { + "pattern": [ + [ + -37, + -25 + ], + [ + -88, + -11 + ], + [ + -50, + 17 + ], + [ + -63, + 62 + ], + [ + -22, + 68 + ], + [ + 4, + 50 + ], + [ + 33, + 49 + ], + [ + 84, + 43 + ], + [ + 105, + -4 + ], + [ + 46, + -24 + ], + [ + 22, + -27 + ], + [ + 8, + -23 + ], + [ + -4, + -44 + ], + [ + -16, + -17 + ], + [ + -56, + -17 + ], + [ + -77, + 8 + ] + ], + "command": { + "name": "OpenAddonSettings" + } + }, + { + "pattern": [ + [ + -1, + -1 + ] + ], + "command": { + "name": "FocusLeftTab", + "settings": { + "cycling": true, + "excludeDiscarded": false + } + } + }, + { + "pattern": [ + [ + 1, + -1 + ] + ], + "command": { + "name": "FocusRightTab", + "settings": { + "cycling": true, + "excludeDiscarded": false + } + } + }, + { + "pattern": [ + [ + 0, + 1 + ] + ], + "command": { + "name": "ScrollBottom", + "settings": { + "duration": 100 + } + } + }, + { + "pattern": [ + [ + 0, + -1 + ] + ], + "command": { + "name": "ScrollTop", + "settings": { + "duration": 100 + } + } + }, + { + "pattern": [ + [ + 1, + 0 + ] + ], + "command": { + "name": "PageForth" + } + }, + { + "pattern": [ + [ + -1, + 0 + ] + ], + "command": { + "name": "PageBack" + } + }, + { + "pattern": [ + [ + -145, + -16 + ], + [ + -82, + 21 + ], + [ + -77, + 67 + ], + [ + -31, + 60 + ], + [ + -2, + 96 + ], + [ + 25, + 55 + ], + [ + 53, + 42 + ], + [ + 192, + 7 + ], + [ + 75, + -14 + ] + ], + "command": { + "name": "ReloadTab", + "settings": { + "cache": true + } + } + }, + { + "pattern": [ + [ + 300, + -10 + ], + [ + -300, + -20 + ] + ], + "command": { + "name": "CloseTab", + "settings": { + "nextFocus": "default", + "closePinned": true + } + } + }, + { + "pattern": [ + [ + 21, + 300 + ], + [ + 17, + -300 + ] + ], + "command": { + "name": "NewTab", + "settings": { + "position": "default", + "focus": true + } + } + } + ] +}); + // global static variables const LEFT_MOUSE_BUTTON$2 = 1; @@ -2067,10 +2362,12 @@ window.getClosestElement = getClosestElement; const IS_EMBEDDED_FRAME = isEmbeddedFrame(); -const Config = new ConfigManager("local", browser.runtime.getURL("resources/json/defaults.json")); - Config.autoUpdate = true; - Config.loaded.then(main); - Config.addEventListener("change", main); +const Config = new ConfigManager({ + defaults: DefaultConfig, + autoUpdate: true +}); +Config.loaded.then(main); +Config.addEventListener("change", main); // re-run main function if event listeners got removed // this is a workaround for https://bugzilla.mozilla.org/show_bug.cgi?id=1726978 diff --git a/src/core/content.mjs b/src/core/content.mjs index e17a697a6..77f4887e2 100644 --- a/src/core/content.mjs +++ b/src/core/content.mjs @@ -2,6 +2,8 @@ import { isEmbeddedFrame, isEditableInput, isScrollableY, scrollToY, getClosestE import ConfigManager from "/core/helpers/config-manager.mjs"; +import DefaultConfig from "/resources/configs/defaults.mjs"; + import MouseGestureController from "/core/controllers/mouse-gesture-controller.mjs"; import RockerGestureController from "/core/controllers/rocker-gesture-controller.mjs"; @@ -30,10 +32,12 @@ window.getClosestElement = getClosestElement; const IS_EMBEDDED_FRAME = isEmbeddedFrame(); -const Config = new ConfigManager("local", browser.runtime.getURL("resources/json/defaults.json")); - Config.autoUpdate = true; - Config.loaded.then(main); - Config.addEventListener("change", main); +const Config = new ConfigManager({ + defaults: DefaultConfig, + autoUpdate: true +}); +Config.loaded.then(main); +Config.addEventListener("change", main); // re-run main function if event listeners got removed // this is a workaround for https://bugzilla.mozilla.org/show_bug.cgi?id=1726978 diff --git a/src/core/helpers/config-manager.mjs b/src/core/helpers/config-manager.mjs index d6dc7a9c3..9e21f227a 100644 --- a/src/core/helpers/config-manager.mjs +++ b/src/core/helpers/config-manager.mjs @@ -13,34 +13,27 @@ export default class ConfigManager { * For the first parameter either "local" or "sync" is allowed. * An URL to a JSON formatted file can be passed optionally. The containing properties will be treated as the defaults. **/ - constructor (storageArea, defaultsURL) { + constructor ({ + storageArea = "local", + defaults = {}, + autoUpdate = false + }) { if (storageArea !== "local" && storageArea !== "sync") { - throw "The first argument must be a storage area in form of a string containing either local or sync."; + throw "storageArea must either \"local\" or \"sync\"."; } - if (typeof defaultsURL !== "string" && defaultsURL !== undefined) { - throw "The second argument must be an URL to a JSON file."; + if (!isObject(defaults)) { + throw "defaults must be an object."; } this._storageArea = storageArea; // empty object as default value so the config doesn't have to be loaded this._storage = {}; - this._defaults = {}; - - const fetchResources = [ browser.storage[this._storageArea].get() ]; - if (typeof defaultsURL === "string") { - const defaultsObject = new Promise((resolve, reject) => { - fetch(defaultsURL, {mode:'same-origin'}) - .then(res => res.json()) - .then(obj => resolve(obj), err => reject(err)); - }); - fetchResources.push( defaultsObject ); - } - // load resources - this._loaded = Promise.all(fetchResources); - // store resources when loaded - this._loaded.then((values) => { - if (values[0]) this._storage = values[0]; - if (values[1]) this._defaults = values[1]; + this._defaults = defaults; + + this._loaded = browser.storage[this._storageArea].get(); + // store config when loaded + this._loaded.then((value) => { + if (value) this._storage = value; }); // holds all custom event callbacks @@ -48,7 +41,7 @@ export default class ConfigManager { 'change': new Set() }; // defines if the storage should be automatically loaded und updated on storage changes - this._autoUpdate = false; + this._autoUpdate = autoUpdate; // setup on storage change handler browser.storage.onChanged.addListener((changes, areaName) => { if (areaName === this._storageArea) { diff --git a/src/core/utils/commons.mjs b/src/core/utils/commons.mjs index dc65b7698..1a18e9a1e 100644 --- a/src/core/utils/commons.mjs +++ b/src/core/utils/commons.mjs @@ -1,29 +1,7 @@ /** - * get JSON file as object from url - * returns a promise which is fulfilled with the json object as a parameter + * get HTML file as fragment from url + * returns a promise which is fulfilled with the fragment * otherwise it's rejected - * request url needs permissions in the addon manifest - **/ -export function fetchJSONAsObject (url) { - return new Promise((resolve, reject) => { - const xhr = new XMLHttpRequest(); - xhr.overrideMimeType("application/json"); - xhr.responseType = "json"; - xhr.timeout = 4000; - xhr.onerror = reject; - xhr.ontimeout = reject; - xhr.onload = () => resolve(xhr.response); - xhr.open('GET', url, true); - xhr.send(); - }); -} - - -/** - * get JSON file as object from url - * returns a promise which is fulfilled with the json object as a parameter - * otherwise it's rejected - * request url needs permissions in the addon manifest **/ export function fetchHTMLAsFragment (url) { return new Promise((resolve, reject) => { diff --git a/src/resources/json/commands.json b/src/resources/configs/commands.mjs similarity index 99% rename from src/resources/json/commands.json rename to src/resources/configs/commands.mjs index de3aa6b40..d6a3707be 100644 --- a/src/resources/json/commands.json +++ b/src/resources/configs/commands.mjs @@ -1,4 +1,4 @@ -[ +export default Object.freeze([ { "command": "DuplicateTab", "settings": { @@ -524,4 +524,4 @@ "permissions": ["browsingData"], "group": "advanced" } -] +]); diff --git a/src/resources/json/defaults.json b/src/resources/configs/defaults.mjs similarity index 93% rename from src/resources/json/defaults.json rename to src/resources/configs/defaults.mjs index 88b038513..cc981cac5 100644 --- a/src/resources/json/defaults.json +++ b/src/resources/configs/defaults.mjs @@ -1,302 +1,302 @@ -{ - "Settings": { - "Gesture": { - "mouseButton": 2, - "suppressionKey": "", - "distanceThreshold": 10, - "deviationTolerance": 0.15, - "matchingAlgorithm": "combined", - "Timeout": { - "active": false, - "duration": 1 - }, - "Trace": { - "display": true, - "Style": { - "strokeStyle": "#00aaa0cc", - "lineWidth": 10, - "lineGrowth": true - } - }, - "Command": { - "display": true, - "Style": { - "fontColor": "#ffffffff", - "backgroundColor": "#00000080", - "fontSize": "7vh", - "horizontalPosition": 50, - "verticalPosition": 40 - } - } - }, - "Rocker": { - "active": false, - "leftMouseClick": { - "name": "PageBack" - }, - "rightMouseClick": { - "name": "PageForth" - } - }, - "Wheel": { - "active": false, - "mouseButton": 1, - "wheelSensitivity": 30, - "wheelUp": { - "name": "FocusRightTab", - "settings": { - "cycling": true, - "excludeDiscarded": false - } - }, - "wheelDown": { - "name": "FocusLeftTab", - "settings": { - "cycling": true, - "excludeDiscarded": false - } - } - }, - "General": { - "updateNotification": true, - "theme": "light" - } - }, - "Gestures": [ - { - "pattern": [ - [ - -37, - -25 - ], - [ - -88, - -11 - ], - [ - -50, - 17 - ], - [ - -63, - 62 - ], - [ - -22, - 68 - ], - [ - 4, - 50 - ], - [ - 33, - 49 - ], - [ - 84, - 43 - ], - [ - 105, - -4 - ], - [ - 46, - -24 - ], - [ - 22, - -27 - ], - [ - 8, - -23 - ], - [ - -4, - -44 - ], - [ - -16, - -17 - ], - [ - -56, - -17 - ], - [ - -77, - 8 - ] - ], - "command": { - "name": "OpenAddonSettings" - } - }, - { - "pattern": [ - [ - -1, - -1 - ] - ], - "command": { - "name": "FocusLeftTab", - "settings": { - "cycling": true, - "excludeDiscarded": false - } - } - }, - { - "pattern": [ - [ - 1, - -1 - ] - ], - "command": { - "name": "FocusRightTab", - "settings": { - "cycling": true, - "excludeDiscarded": false - } - } - }, - { - "pattern": [ - [ - 0, - 1 - ] - ], - "command": { - "name": "ScrollBottom", - "settings": { - "duration": 100 - } - } - }, - { - "pattern": [ - [ - 0, - -1 - ] - ], - "command": { - "name": "ScrollTop", - "settings": { - "duration": 100 - } - } - }, - { - "pattern": [ - [ - 1, - 0 - ] - ], - "command": { - "name": "PageForth" - } - }, - { - "pattern": [ - [ - -1, - 0 - ] - ], - "command": { - "name": "PageBack" - } - }, - { - "pattern": [ - [ - -145, - -16 - ], - [ - -82, - 21 - ], - [ - -77, - 67 - ], - [ - -31, - 60 - ], - [ - -2, - 96 - ], - [ - 25, - 55 - ], - [ - 53, - 42 - ], - [ - 192, - 7 - ], - [ - 75, - -14 - ] - ], - "command": { - "name": "ReloadTab", - "settings": { - "cache": true - } - } - }, - { - "pattern": [ - [ - 300, - -10 - ], - [ - -300, - -20 - ] - ], - "command": { - "name": "CloseTab", - "settings": { - "nextFocus": "default", - "closePinned": true - } - } - }, - { - "pattern": [ - [ - 21, - 300 - ], - [ - 17, - -300 - ] - ], - "command": { - "name": "NewTab", - "settings": { - "position": "default", - "focus": true - } - } - } - ] -} +export default Object.freeze({ + "Settings": { + "Gesture": { + "mouseButton": 2, + "suppressionKey": "", + "distanceThreshold": 10, + "deviationTolerance": 0.15, + "matchingAlgorithm": "combined", + "Timeout": { + "active": false, + "duration": 1 + }, + "Trace": { + "display": true, + "Style": { + "strokeStyle": "#00aaa0cc", + "lineWidth": 10, + "lineGrowth": true + } + }, + "Command": { + "display": true, + "Style": { + "fontColor": "#ffffffff", + "backgroundColor": "#00000080", + "fontSize": "7vh", + "horizontalPosition": 50, + "verticalPosition": 40 + } + } + }, + "Rocker": { + "active": false, + "leftMouseClick": { + "name": "PageBack" + }, + "rightMouseClick": { + "name": "PageForth" + } + }, + "Wheel": { + "active": false, + "mouseButton": 1, + "wheelSensitivity": 30, + "wheelUp": { + "name": "FocusRightTab", + "settings": { + "cycling": true, + "excludeDiscarded": false + } + }, + "wheelDown": { + "name": "FocusLeftTab", + "settings": { + "cycling": true, + "excludeDiscarded": false + } + } + }, + "General": { + "updateNotification": true, + "theme": "light" + } + }, + "Gestures": [ + { + "pattern": [ + [ + -37, + -25 + ], + [ + -88, + -11 + ], + [ + -50, + 17 + ], + [ + -63, + 62 + ], + [ + -22, + 68 + ], + [ + 4, + 50 + ], + [ + 33, + 49 + ], + [ + 84, + 43 + ], + [ + 105, + -4 + ], + [ + 46, + -24 + ], + [ + 22, + -27 + ], + [ + 8, + -23 + ], + [ + -4, + -44 + ], + [ + -16, + -17 + ], + [ + -56, + -17 + ], + [ + -77, + 8 + ] + ], + "command": { + "name": "OpenAddonSettings" + } + }, + { + "pattern": [ + [ + -1, + -1 + ] + ], + "command": { + "name": "FocusLeftTab", + "settings": { + "cycling": true, + "excludeDiscarded": false + } + } + }, + { + "pattern": [ + [ + 1, + -1 + ] + ], + "command": { + "name": "FocusRightTab", + "settings": { + "cycling": true, + "excludeDiscarded": false + } + } + }, + { + "pattern": [ + [ + 0, + 1 + ] + ], + "command": { + "name": "ScrollBottom", + "settings": { + "duration": 100 + } + } + }, + { + "pattern": [ + [ + 0, + -1 + ] + ], + "command": { + "name": "ScrollTop", + "settings": { + "duration": 100 + } + } + }, + { + "pattern": [ + [ + 1, + 0 + ] + ], + "command": { + "name": "PageForth" + } + }, + { + "pattern": [ + [ + -1, + 0 + ] + ], + "command": { + "name": "PageBack" + } + }, + { + "pattern": [ + [ + -145, + -16 + ], + [ + -82, + 21 + ], + [ + -77, + 67 + ], + [ + -31, + 60 + ], + [ + -2, + 96 + ], + [ + 25, + 55 + ], + [ + 53, + 42 + ], + [ + 192, + 7 + ], + [ + 75, + -14 + ] + ], + "command": { + "name": "ReloadTab", + "settings": { + "cache": true + } + } + }, + { + "pattern": [ + [ + 300, + -10 + ], + [ + -300, + -20 + ] + ], + "command": { + "name": "CloseTab", + "settings": { + "nextFocus": "default", + "closePinned": true + } + } + }, + { + "pattern": [ + [ + 21, + 300 + ], + [ + 17, + -300 + ] + ], + "command": { + "name": "NewTab", + "settings": { + "position": "default", + "focus": true + } + } + } + ] +}); diff --git a/src/views/options/components/command-multi-select/main.mjs b/src/views/options/components/command-multi-select/main.mjs index 13d8ebf7b..dce99f4ce 100644 --- a/src/views/options/components/command-multi-select/main.mjs +++ b/src/views/options/components/command-multi-select/main.mjs @@ -1,16 +1,17 @@ import { SortableMultiSelect } from "/views/options/components/sortable-multi-select/main.mjs"; -import { fetchJSONAsObject, fetchHTMLAsFragment } from "/core/utils/commons.mjs"; +import { fetchHTMLAsFragment } from "/core/utils/commons.mjs"; import Command from "/core/models/command.mjs"; +import CommandDefinitions from "/resources/configs/commands.mjs"; + // getter for module path const MODULE_DIR = (() => { const urlPath = new URL(import.meta.url).pathname; return urlPath.slice(0, urlPath.lastIndexOf("/") + 1); })(); -const COMMAND_ITEMS = fetchJSONAsObject(browser.runtime.getURL("/resources/json/commands.json")); const COMMAND_SETTING_TEMPLATES = fetchHTMLAsFragment(browser.runtime.getURL("/views/options/fragments/command-setting-templates.inc")); /** @@ -32,15 +33,13 @@ class CommandMultiSelect extends SortableMultiSelect { this.shadowRoot.append(settingsConainer); // build/fill command selection list - COMMAND_ITEMS.then((commandItems) => { - const commandMultiSelectItems = commandItems.map((commandItem) => { - const commandMultiSelectItem = document.createElement("sortable-multi-select-item"); - commandMultiSelectItem.dataset.command = commandItem.command; - commandMultiSelectItem.textContent = browser.i18n.getMessage(`commandLabel${commandItem.command}`); - return commandMultiSelectItem; - }); - this.append(...commandMultiSelectItems); + const commandMultiSelectItems = CommandDefinitions.map((commandItem) => { + const commandMultiSelectItem = document.createElement("sortable-multi-select-item"); + commandMultiSelectItem.dataset.command = commandItem.command; + commandMultiSelectItem.textContent = browser.i18n.getMessage(`commandLabel${commandItem.command}`); + return commandMultiSelectItem; }); + this.append(...commandMultiSelectItems); this._commandSettingsRelation = new WeakMap(); } @@ -229,7 +228,7 @@ class CommandMultiSelect extends SortableMultiSelect { if (commandSelectItem) { // get command object - const commandObject = (await COMMAND_ITEMS).find((element) => { + const commandObject = CommandDefinitions.find((element) => { return element.command === commandSelectItem.dataset.command; }); diff --git a/src/views/options/components/command-select/main.mjs b/src/views/options/components/command-select/main.mjs index b3e946407..574fc3876 100644 --- a/src/views/options/components/command-select/main.mjs +++ b/src/views/options/components/command-select/main.mjs @@ -1,14 +1,15 @@ -import { fetchJSONAsObject, fetchHTMLAsFragment } from "/core/utils/commons.mjs"; +import { fetchHTMLAsFragment } from "/core/utils/commons.mjs"; import Command from "/core/models/command.mjs"; +import CommandDefinitions from "/resources/configs/commands.mjs"; + // getter for module path const MODULE_DIR = (() => { const urlPath = new URL(import.meta.url).pathname; return urlPath.slice(0, urlPath.lastIndexOf("/") + 1); })(); -const COMMAND_ITEMS = fetchJSONAsObject(browser.runtime.getURL("/resources/json/commands.json")); const COMMAND_SETTING_TEMPLATES = fetchHTMLAsFragment(browser.runtime.getURL("/views/options/fragments/command-setting-templates.inc")); /** @@ -185,7 +186,7 @@ class CommandSelect extends HTMLElement { // build command list const groups = new Map(); - for (let commandItem of await COMMAND_ITEMS) { + for (let commandItem of CommandDefinitions) { const item = document.createElement("li"); item.classList.add("cb-command-item"); item.dataset.command = commandItem.command; @@ -491,7 +492,7 @@ class CommandSelect extends HTMLElement { commandItemInfo.style.removeProperty("height"); // get command item - const commandItem = (await COMMAND_ITEMS).find((element) => { + const commandItem = CommandDefinitions.find((element) => { return element.command === event.currentTarget.dataset.command; }); diff --git a/src/views/options/data-management.mjs b/src/views/options/data-management.mjs index 1ce87a95f..47dc90e7f 100644 --- a/src/views/options/data-management.mjs +++ b/src/views/options/data-management.mjs @@ -1,7 +1,7 @@ -import { fetchJSONAsObject } from "/core/utils/commons.mjs"; - import { ContentLoaded, Config } from "/views/options/main.mjs"; +import CommandDefinitions from "/resources/configs/commands.mjs"; + ContentLoaded.then(main); /** @@ -91,9 +91,6 @@ async function onRestoreButton (event) { reader.readAsText(this.files[0]); }); - // load the commands data in order to request the right permissions - const commands = await fetchJSONAsObject(browser.runtime.getURL("/resources/json/commands.json")); - // get the necessary permissions const requiredPermissions = []; // combine all commands to one array @@ -111,7 +108,7 @@ async function onRestoreButton (event) { } for (let command of usedCommands) { - const commandItem = commands.find((element) => { + const commandItem = CommandDefinitions.find((element) => { return element.command === command.name; }); if (commandItem.permissions) commandItem.permissions.forEach((permission) => { diff --git a/src/views/options/main.mjs b/src/views/options/main.mjs index 68eea43a8..da9205b55 100644 --- a/src/views/options/main.mjs +++ b/src/views/options/main.mjs @@ -2,8 +2,11 @@ import { fetchHTMLAsFragment } from "/core/utils/commons.mjs"; import ConfigManager from "/core/helpers/config-manager.mjs"; -export const Config = new ConfigManager("local", browser.runtime.getURL("/resources/json/defaults.json")); +import DefaultConfig from "/resources/configs/defaults.mjs"; +export const Config = new ConfigManager({ + defaults: DefaultConfig +}); const Resources = [ Config.loaded ]; From 470452e8d88e260ecb5c90631c56261752af7083 Mon Sep 17 00:00:00 2001 From: Robbendebiene Date: Sat, 27 Aug 2022 17:34:16 +0200 Subject: [PATCH 04/21] Allow comma values for command font size --- src/views/options/fragments/settings.inc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/views/options/fragments/settings.inc b/src/views/options/fragments/settings.inc index 282879d94..d7561db51 100644 --- a/src/views/options/fragments/settings.inc +++ b/src/views/options/fragments/settings.inc @@ -170,7 +170,7 @@

    - +
    From 82cbf7879c99e25fc493e3e76f69bf51e4261d56 Mon Sep 17 00:00:00 2001 From: Robbendebiene Date: Sat, 27 Aug 2022 18:33:10 +0200 Subject: [PATCH 05/21] Replace png icons with svg icon --- README.md | 2 +- src/core/utils/commons.mjs | 2 +- src/manifest.json | 12 ++++++------ src/resources/img/icon.svg | 5 +++++ src/resources/img/iconx32.png | Bin 4251 -> 0 bytes src/resources/img/iconx48.png | Bin 5321 -> 0 bytes src/resources/img/iconx96.png | Bin 8061 -> 0 bytes src/views/installation/index.html | 6 +++--- src/views/options/index.html | 4 ++-- 9 files changed, 18 insertions(+), 13 deletions(-) create mode 100644 src/resources/img/icon.svg delete mode 100644 src/resources/img/iconx32.png delete mode 100644 src/resources/img/iconx48.png delete mode 100644 src/resources/img/iconx96.png diff --git a/README.md b/README.md index 22d182aed..fc71cc437 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ [](https://github.com/Robbendebiene/Gesturefy/blob/master/LICENSE) -# esturefy +# esturefy #### [](https://addons.mozilla.org/firefox/addon/gesturefy/) Navigate, operate, and browse faster with mouse gestures! A customizable Firefox mouse gesture add-on with a variety of different commands. diff --git a/src/core/utils/commons.mjs b/src/core/utils/commons.mjs index 1a18e9a1e..ebd6ba56f 100644 --- a/src/core/utils/commons.mjs +++ b/src/core/utils/commons.mjs @@ -184,7 +184,7 @@ export function displayNotification (title, message, link) { // create notification const createNotification = browser.notifications.create({ "type": "basic", - "iconUrl": "../resources/img/iconx48.png", + "iconUrl": "../resources/img/icon.svg", "title": title, "message": message }); diff --git a/src/manifest.json b/src/manifest.json index c00d498cb..61d9206c6 100644 --- a/src/manifest.json +++ b/src/manifest.json @@ -12,9 +12,9 @@ "author": "Robbendebiene", "homepage_url": "https://github.com/Robbendebiene/Gesturefy", "icons": { - "96": "resources/img/iconx96.png", - "48": "resources/img/iconx48.png", - "32": "resources/img/iconx32.png" + "96": "resources/img/icon.svg", + "48": "resources/img/icon.svg", + "32": "resources/img/icon.svg" }, "default_locale": "en", "permissions": [ @@ -56,9 +56,9 @@ }, "browser_action": { "default_icon": { - "96": "resources/img/iconx96.png", - "48": "resources/img/iconx48.png", - "32": "resources/img/iconx32.png" + "96": "resources/img/icon.svg", + "48": "resources/img/icon.svg", + "32": "resources/img/icon.svg" }, "default_title": "__MSG_commandLabelOpenAddonSettings__" }, diff --git a/src/resources/img/icon.svg b/src/resources/img/icon.svg new file mode 100644 index 000000000..55d86e4dd --- /dev/null +++ b/src/resources/img/icon.svg @@ -0,0 +1,5 @@ + + + + + diff --git a/src/resources/img/iconx32.png b/src/resources/img/iconx32.png deleted file mode 100644 index d6587b4e0e959ae889ff9b384cb45abc7a741897..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 4251 zcmV;M5M=L(P)f6Xi@@54ZTQ_E-Enz5K6$1 z03tR-RB%L5k){YTDBysjLy@r}iiH7DvFijGMAUI`6dRUFWUU$Bym{}eS9UO(Z2>7`&z9wUXbV-Il z#&6`Y8GKGQ04S2&F6MJnWNa;Ck|;8QE#r9r;7G||@X{|>%+C|c55>;RS}qbKr-&IQ zTvLXPlM{>K&(BTgi^a?^4mXV>;xX8n8Ce|RasXz}{8imI52H3ZN4bf ze_i~WlJ|C&UW9+{8AKoW!}eExnGFE2re(F+`iE_46#!l90Z_aBhs|Iw0E)7{bq;-T z9=d#9QpDmcXDh4R++0fmpKB>E=%LdZt9g z$j;($`3&Zthxi`{{&gM}5&R^+h%b~yM9Zd3AWW9ETgVfL1(`yIK=_}U_z%PWq}jQa ziQ4!P(3V&Nr6C$XejWfQDiI(Fdt@un?|lo#M+5oIi_w{wo%_#%{(V=tO#a9gB!7-$ zM?^BX5>d|Vn*3S!?g~$*UQipUP zL&zMmg;!4Do9IA%up=Rh?=qPj=x&RGBx1dpI68aT- z2O}^EromdU5o`ssU{5#*j)WJ%$?!5bA1;Eoz?EiTr=n?cd`V|I)p<|3O zju?MT93~aB0<#&j8`F+Cg&D?-VWzQItUA^l>xvDRIYI4MQ`g1<+DyrL=EogS06Xii({|v`U^zjmmKqDIK93(F5q| z^fLNk`gQs{RV`IdRle#b)i%{Ds;|}NsClUI)k@Ub)kf6bsWa4l)YH_rsduU0(?DsM zX@qO!YV6TCtMPOWZH~(v?wpc2hv(eZgf-1HBQ#fN?$aF5oYvCT^3%%Fs?s{6^;Da# z?V+8jy+iwi_M{F~$4y6|vqR^k&SQoO!;_KDsATjprgSxR{dFa}^}2()GkV5)QF?`X z?Rxk03HmJkB>f%wz4}uIItC#I1qQ7Kw+-=zEW;GTU55RJuZ@h2VvIHzbs0S}Rx=JT z&Npr~zH34@aW`3J(qMAU6l2OVO*7qXdf5y%vo}jIt1%lghs_<#1?IcWhb_<+P8LFo z28$a^64R5J!)#@aTGB0pEekEXET35!SjAgyv+B3{Xl-wuZrx~o$A)4PXj5p@WAm%6 znJw40#`fA=@?77!tLJvleQsxN$G6*KchjC~A7a13zSsVPgQJ7Uq0M2^(ZDg$vDWbh zi^d9LZDyT!LOXdmt#&%*^w!zIS?qk+`4<X~g?%562@eae34a)26HyS+zks@6 z$%2*zuOhu7%OdYYnM6sVdZQJi6QY}=U&naIl*dS8tzuWkUW(I*6U24LW8oFzvR(TOpMEs5_rp_~TJ^wNN(wM(bC zZ0;`Z6P^ce2XB(^$}i_nB)KM)Cp}7bP2Qe7nc|*Ok@8f)7E}wKr~0SXrM^xJP1~RL zDLp2=Jp-4Km~m7{5vB?IGPN`FGKaIwvx>8%%bb_(Ts9>N5;bK**^9Ef#WdN^)PTf9 zvR*Qp{o-l7TcBI8wqSIn=gRt3(5j`Y zdRObOE?Pal#&6AmwS={4Ykw%TE-Wv6xh`g1Pmxy9nxe7we(PI{6^cd0H#WFzsN0Cz zDA+i-Y3`<~O&?2mB^OJrODjs>Z{}{k_?699m0x|@lC)*8%%N=0R?Jr6*6Z8cw;d=~ zF3&F?+a9vLa|dHb$&Qyhm+ZVyVOLSNi?B>BD~E ze(8aT1AWbo&CM;EEoH56tE6@EV8X%6-*|u1-NtOIZ>P7H9s-9XhaP{M`0e$>L5F*f zu#U8SXZT%h2eqT56Y5;vIn|ZYCGC#u9zGg)w718lr{jCe@An_mJyvsE<#^c%!il02 zpHAkVoIaIx>gnm^(__6$dheWxJ#(!uyl?Pq(Ao3ne9xWf_v}A;-u3*k3(gmgUSwVD zy5w-FbHIL};|Kd6ItCpEJBJ*Hx-UCj?irppeBz4xmD5+fub#UWaP88_{E^}7QP*$Y zNVp-r$-DXJR{E{yw{vdK+*xxMeYfPE(!GlNn)e%iH2tw%>L5Kn>ODH}V8MesW8ASP zKV|>)e!S=*`C-L`&P4Mg+egPHeJ3wJUif(YN!F8@r^P=j|6Kdbc>FRj6+1Ql zT=e|YubW?}zu5oM?q%#SbPJNw9!?0*odmKs6~>C`WtU@%Luu_ICI73ch4_W@p}?-@KXk-mEF5 zBqq@v8zktHTv@=YfSeHeC7bX_l->o)YH@_OMvi)fXU_1X8Hc2`!L^OzhSR+__@dL#$w{9+ zKM7+~T7jV1sb$E`TT4XaN=d_rWPZ+_Cz>&BpG$P9ZqK_Eh$g(ZIOw+R5{{B&k{!HE zv2`4Lo=nqLV96aOM-+tB`9`FLWmQeoqogHrf^v-Ijv>=L=ggySAZgYthJzMq6m7_; zQdWoB9j5h7PHN-g=qTcBOsQSq3~S_FQGJ7=V2lFUMu?n-rzavR*AYi&nr?8mb`)@2 zi_ZONB{rI7yqn=^@=*``QSPiLy`H+ON~}9}5N)kr3N%22!)5ZV+AHqCzboj_fLX5j-Xox;}2-lLkzTzOrs7SNm62Pl3ZB# z*L?wK!$0F0DKDMH2A{xl0sC{)9+J$@g|8Cr3?Kg;GKc%KDN85BuGlshUK7BRAd8l{ zk7gF){2#dwPcQ%k(1BDic}U7ycVPKRRqj0NJBs(ef-+!H(dah$L1bw*{y+e_00kJg z%GI4Hn_*+!FGKUhqOGL}2Npk&`Sq}^V#^1{{E+aw4mEoMB3o!glptiANBu#$e zPaM3jMzktXw1jmA<>?4-!L$H|Q-OlX+qWoww=iRTbP>_hPjVLEyq)RIjFs@qXaLZE z82~Om{=1P3j)J1XI@F2|m7(1f@3&JvgD8CXzV=;YaW+4y?hS4-jP-bb5g1Yh2m}UX1SRN%j53rrbjMy z@%yZK1>OATO9x1PevW`}4y9+csr5+>dn284vJXS93vgfI0y$&Gp}9 z93ZPV@>P9z(410nI5rEhaU8nxd{aZJE`)3Q?P`PqfouL4Djj`-oRa?{5%pNGyKaU&*{)1Qv?n(_NI|Wu3 zMK_RJX8XfCgIzO}*ndnC_Y{>Uvi~)WOheGPg9b!IhC+$|g;xu#)sOuf6Xi@@54ZTQ_E-Enz5K6$1 z03tR-RB%L5k){YTDBysjLy@r}iiH7DvFijGMAUI`6dRUFWUU$Bym{}eS9UO(Z2>7`&z9wUXbV-Il z#&6`Y8GKGQ04S2&F6MJnWNa;Ck|;8QE#r9r;7G||@X{|>%+C|c55>;RS}qbKr-&IQ zTvLXPlM{>K&(BTgi^a?^4mXV>;xX8n8Ce|RasXz}{8imI52H3ZN4bf ze_i~WlJ|C&UW9+{8AKoW!}eExnGFE2re(F+`iE_46#!l90Z_aBhs|Iw0E)7{bq;-T z9=d#9QpDmcXDh4R++0fmpKB>E=%LdZt9g z$j;($`3&Zthxi`{{&gM}5&R^+h%b~yM9Zd3AWW9ETgVfL1(`yIK=_}U_z%PWq}jQa ziQ4!P(3V&Nr6C$XejWfQDiI(Fdt@un?|lo#M+5oIi_w{wo%_#%{(V=tO#a9gB!7-$ zM?^BX5>d|Vn*3S!?g~$*UQipUP zL&zMmg;!4Do9IA%up=Rh?=qPj=x&RGBx1dpI68aT- z2O}^EromdU5o`ssU{5#*j)WJ%$?!5bA1;Eoz?EiTr=n?cd`V|I)p<|3O zju?MT93~aB0<#&j8`F+Cg&D?-VWzQItUA^l>xvDRIYI4MQ`g1<+DyrL=EogS06Xii({|v`U^zjmmKqDIK93(F5q| z^fLNk`gQs{RV`IdRle#b)i%{Ds;|}NsClUI)k@Ub)kf6bsWa4l)YH_rsduU0(?DsM zX@qO!YV6TCtMPOWZH~(v?wpc2hv(eZgf-1HBQ#fN?$aF5oYvCT^3%%Fs?s{6^;Da# z?V+8jy+iwi_M{F~$4y6|vqR^k&SQoO!;_KDsATjprgSxR{dFa}^}2()GkV5)QF?`X z?Rxk03HmJkB>f%wz4}uIItC#I1qQ7Kw+-=zEW;GTU55RJuZ@h2VvIHzbs0S}Rx=JT z&Npr~zH34@aW`3J(qMAU6l2OVO*7qXdf5y%vo}jIt1%lghs_<#1?IcWhb_<+P8LFo z28$a^64R5J!)#@aTGB0pEekEXET35!SjAgyv+B3{Xl-wuZrx~o$A)4PXj5p@WAm%6 znJw40#`fA=@?77!tLJvleQsxN$G6*KchjC~A7a13zSsVPgQJ7Uq0M2^(ZDg$vDWbh zi^d9LZDyT!LOXdmt#&%*^w!zIS?qk+`4<X~g?%562@eae34a)26HyS+zks@6 z$%2*zuOhu7%OdYYnM6sVdZQJi6QY}=U&naIl*dS8tzuWkUW(I*6U24LW8oFzvR(TOpMEs5_rp_~TJ^wNN(wM(bC zZ0;`Z6P^ce2XB(^$}i_nB)KM)Cp}7bP2Qe7nc|*Ok@8f)7E}wKr~0SXrM^xJP1~RL zDLp2=Jp-4Km~m7{5vB?IGPN`FGKaIwvx>8%%bb_(Ts9>N5;bK**^9Ef#WdN^)PTf9 zvR*Qp{o-l7TcBI8wqSIn=gRt3(5j`Y zdRObOE?Pal#&6AmwS={4Ykw%TE-Wv6xh`g1Pmxy9nxe7we(PI{6^cd0H#WFzsN0Cz zDA+i-Y3`<~O&?2mB^OJrODjs>Z{}{k_?699m0x|@lC)*8%%N=0R?Jr6*6Z8cw;d=~ zF3&F?+a9vLa|dHb$&Qyhm+ZVyVOLSNi?B>BD~E ze(8aT1AWbo&CM;EEoH56tE6@EV8X%6-*|u1-NtOIZ>P7H9s-9XhaP{M`0e$>L5F*f zu#U8SXZT%h2eqT56Y5;vIn|ZYCGC#u9zGg)w718lr{jCe@An_mJyvsE<#^c%!il02 zpHAkVoIaIx>gnm^(__6$dheWxJ#(!uyl?Pq(Ao3ne9xWf_v}A;-u3*k3(gmgUSwVD zy5w-FbHIL};|Kd6ItCpEJBJ*Hx-UCj?irppeBz4xmD5+fub#UWaP88_{E^}7QP*$Y zNVp-r$-DXJR{E{yw{vdK+*xxMeYfPE(!GlNn)e%iH2tw%>L5Kn>ODH}V8MesW8ASP zKV|>)e!S=*`C-L`&P4Mg+egPHeJ3wJUif(YN!F8@r^P=j|6Kdbc>FRj6+1Ql zT=e|YubW?}zu5oM?q%sNqCjy-g~Cs%z51Nz9-au*SY7MnLT@dGqY#U z-g6YrIT^%S8)H0wW}0|b^a5FnLMEQYT`{<2VfiA?Yd1030vuhku;#^y*47FNd&%a@ zmNQndG=X=)%oU4bPWRk(B-uho#abHo5aVq;zhtQcRpJg(Ba=;3#)D)iU-UNN zl$!|51}KcMvN*1pK+=H>)$5odQ4Fn{c1W~-L} zlR7TtP_&pw#UFD(CnIxmfoFJnga0o;F?m9fMmR|Au|S1<8@i>)p#ddk(n zFk9;CB06#M7kqiuqf)cezA^rJnDza(MjxG>sxv1flgbw-?Vi!Q?Dg7A{#5x@qmjgwt#JH1=4A7Sg4b*7!R zWcEp$(BpW_@MN&lItVTEs&LPnVO9~BQ3R1#QcJAJT?$xh!y)|NZLgM|EjLIq+g+bS z(a7VN!Hr(^#$vdFf6Gw#3ufP6d5A7vyc-^ac+Gmoi)Wogv8QmUKwrPsaefEFA9M+> zT5*ytb>40kBobIND~@5Uj1KCd0^ysi1sF%0a8_MCgwB6_+O7>lec!#}X;gqK))f$4 z#5KTdTUVFH=gy6p3M(qwSw$I~W-K}D!t##5pN_vXNVcv3ZcTV9vm`qmi_-2_c=cN8 zf7o}*;uMQ%j_W$uj=q1IS5^-*!8J9Gf&H~vn<~O*!h+VK+OT77sUAHQ<&~AHP0>qh z-QLA$)Y|X{MOm?pAG?+AAu_ZTmze2IvloRM}O)Y*@LGq zcq$NEoywmUUd^Z8-xrx6o3;<8h*ANSkK^@LTwM^mpP0Ih=g(>hZ0ywoQ*cXTErc$G zg*mIzQ9cERHU&f1jQ1i>0`*U)#U2e;lGW894D#rh(feOGh7s6i+E!s}o za1HiV0O3#I<|Q1H#FtPTnNS<|+06ipKoJK5w?)sS8Y5okr$V~ z>(W>>N7(*DvTaMlJV@Wi3rqj*s{q13an*RNWG{kQZw;zf*v`!ZsCP!Dt+eZWrk8Lw ze|{QeDB3F0Jxw9^O`e1!`-du{>#Lnv^pQfz(SNGZGrZ#6GHHIzF3&cz1x<7jAL!o5%IylmA_=QtEbTE_Fn}9X6tOPYP?zz8wN#K zGH_ywSn^RvOXB4#-ezl7eTB}PeOngv>wCspj|oMNY4^dxg)3q=g1K2Evj~`*upWwB zN}gT$Ya+KJXORe_=K2E;?zQ4yn*-!{XjYSKL4|t4TTCekNkRsMUvYu4X6rz^1_Fh< zwc1}1$_k0c$2sT36yDnKI+6-^KoI9<>SaBP=;sjzVpNr*dR8L#0^z2!$xJvrwmoDs z2#8O(6zEDs(A9~@ejb2@36J;cNm2lR0@=@7)*^SW@}9A zt3WEza`hV4+^`5XwShdxLUJCU%j%=NwA8&}846OxMSdiMvW&V$;`tYE1V_s4z#thHWTlm1YMv*Nc=mOz^`4T*5b`hsxcY3=4fP7_qzp5( zEv%5#` z9DC&6()cXE*Z478s0oqf9IxOnEb-~H#Q9~3e%YyDW@tIqbCy?NE}o}7Nv+gOZKtM% ziMOr9)~A|-NIbl@^sP8uDQ za`#0Tzmq+`Y!h9*7R>u0lF+mNA<7*SCfy24F$GKXAk63yABG$(@;i+WQ+~u>sL4X= z_EoyjvB!3#>LhXcDRRa>*pTnYJx`J7^%MZb&OOjyF&z{$AUuIz2e3yf;v~p*dhL>h z)KGA19qHU-d{FbG{{na0an8T@((oXeSR=o~Ehr{x6d&lCu!)rgoK-%69r`t|QxPvR zJF;fgm+8VMd(E?FC-v_0lVI=-7+4kno*zKe+NABo*RMTBy)!-}zwa}QW!4JY)lVNxnSR#g?D+}kz)eBf7O65)udjux2B z4oF3XvrZ#v=}*~de{z3&ve81y9kCEI(gr^~+v||CC&YH|_#)ilcE}u?nwuZSzI30} zwcE39t>Pa2$oEI&al~R#J(iT{AN5R18$Why7OlWMnxWs6Kx6Zh=z}(nXpN)bE51h=^aZ__6_-d0ek`Q z)cG+4rj&ZaIz7n|A2x!|Jw81;LUCT8e?khRP)WTmNUjU{MVUp)G3N6q+*jo=bQMOp z73Nnf)?!Z@hCY=rNLNs|%m^<;l-B`}!XpV!x1ZGbZ~eX? b^@RQhVLTU==!19T00000NkvXXu0mjfHyAQx diff --git a/src/resources/img/iconx96.png b/src/resources/img/iconx96.png deleted file mode 100644 index f469a84e72d8aca6e53135bdb2e0337c26c69fc4..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 8061 zcmV-@AA;bCP)f6Xi@@54ZTQ_E-Enz5K6$1 z03tR-RB%L5k){YTDBysjLy@r}iiH7DvFijGMAUI`6dRUFWUU$Bym{}eS9UO(Z2>7`&z9wUXbV-Il z#&6`Y8GKGQ04S2&F6MJnWNa;Ck|;8QE#r9r;7G||@X{|>%+C|c55>;RS}qbKr-&IQ zTvLXPlM{>K&(BTgi^a?^4mXV>;xX8n8Ce|RasXz}{8imI52H3ZN4bf ze_i~WlJ|C&UW9+{8AKoW!}eExnGFE2re(F+`iE_46#!l90Z_aBhs|Iw0E)7{bq;-T z9=d#9QpDmcXDh4R++0fmpKB>E=%LdZt9g z$j;($`3&Zthxi`{{&gM}5&R^+h%b~yM9Zd3AWW9ETgVfL1(`yIK=_}U_z%PWq}jQa ziQ4!P(3V&Nr6C$XejWfQDiI(Fdt@un?|lo#M+5oIi_w{wo%_#%{(V=tO#a9gB!7-$ zM?^BX5>d|Vn*3S!?g~$*UQipUP zL&zMmg;!4Do9IA%up=Rh?=qPj=x&RGBx1dpI68aT- z2O}^EromdU5o`ssU{5#*j)WJ%$?!5bA1;Eoz?EiTr=n?cd`V|I)p<|3O zju?MT93~aB0<#&j8`F+Cg&D?-VWzQItUA^l>xvDRIYI4MQ`g1<+DyrL=EogS06Xii({|v`U^zjmmKqDIK93(F5q| z^fLNk`gQs{RV`IdRle#b)i%{Ds;|}NsClUI)k@Ub)kf6bsWa4l)YH_rsduU0(?DsM zX@qO!YV6TCtMPOWZH~(v?wpc2hv(eZgf-1HBQ#fN?$aF5oYvCT^3%%Fs?s{6^;Da# z?V+8jy+iwi_M{F~$4y6|vqR^k&SQoO!;_KDsATjprgSxR{dFa}^}2()GkV5)QF?`X z?Rxk03HmJkB>f%wz4}uIItC#I1qQ7Kw+-=zEW;GTU55RJuZ@h2VvIHzbs0S}Rx=JT z&Npr~zH34@aW`3J(qMAU6l2OVO*7qXdf5y%vo}jIt1%lghs_<#1?IcWhb_<+P8LFo z28$a^64R5J!)#@aTGB0pEekEXET35!SjAgyv+B3{Xl-wuZrx~o$A)4PXj5p@WAm%6 znJw40#`fA=@?77!tLJvleQsxN$G6*KchjC~A7a13zSsVPgQJ7Uq0M2^(ZDg$vDWbh zi^d9LZDyT!LOXdmt#&%*^w!zIS?qk+`4<X~g?%562@eae34a)26HyS+zks@6 z$%2*zuOhu7%OdYYnM6sVdZQJi6QY}=U&naIl*dS8tzuWkUW(I*6U24LW8oFzvR(TOpMEs5_rp_~TJ^wNN(wM(bC zZ0;`Z6P^ce2XB(^$}i_nB)KM)Cp}7bP2Qe7nc|*Ok@8f)7E}wKr~0SXrM^xJP1~RL zDLp2=Jp-4Km~m7{5vB?IGPN`FGKaIwvx>8%%bb_(Ts9>N5;bK**^9Ef#WdN^)PTf9 zvR*Qp{o-l7TcBI8wqSIn=gRt3(5j`Y zdRObOE?Pal#&6AmwS={4Ykw%TE-Wv6xh`g1Pmxy9nxe7we(PI{6^cd0H#WFzsN0Cz zDA+i-Y3`<~O&?2mB^OJrODjs>Z{}{k_?699m0x|@lC)*8%%N=0R?Jr6*6Z8cw;d=~ zF3&F?+a9vLa|dHb$&Qyhm+ZVyVOLSNi?B>BD~E ze(8aT1AWbo&CM;EEoH56tE6@EV8X%6-*|u1-NtOIZ>P7H9s-9XhaP{M`0e$>L5F*f zu#U8SXZT%h2eqT56Y5;vIn|ZYCGC#u9zGg)w718lr{jCe@An_mJyvsE<#^c%!il02 zpHAkVoIaIx>gnm^(__6$dheWxJ#(!uyl?Pq(Ao3ne9xWf_v}A;-u3*k3(gmgUSwVD zy5w-FbHIL};|Kd6ItCpEJBJ*Hx-UCj?irppeBz4xmD5+fub#UWaP88_{E^}7QP*$Y zNVp-r$-DXJR{E{yw{vdK+*xxMeYfPE(!GlNn)e%iH2tw%>L5Kn>ODH}V8MesW8ASP zKV|>)e!S=*`C-L`&P4Mg+egPHeJ3wJUif(YN!F8@r^P=j|6Kdbc>FRj6+1Ql zT=e|YubW?}zu5oM?q%{H8Kf4z_E=J=iy*`o%c5O2JF0rAc@NviDNMY`>|lmAskRRLJW4C ztRUDN(s<1w2_H%D?&6o-mlt~%C*EBjF%ayx2Ar7t1_?={>DvGAW7Iv<-Bmr^BP;v8 z*K>4N|Ml1X*I)l%72%viDp*r&4lwvBaJY|GMBgz#i&z3S$F#SZaRc_@J@qFqk21>( z$-vs#^@Mg-=8<@IPwQtJbGR52Nl@Kdme!lm{RjdW#a6#`8PxCRsAl8Q~MF-&V8Elp7St z%$8%KiHebMb7IZ87}5BTGUKM{;YPgXmI8UY)ovnY zdf`4xy38eQSC>q=@-co5a}1EAs6=^1^-Fe-(#x$mb``&R3yE4@3dQifm~Bl;hDop7 z8gn);S!nOtS_0w7M;NZZ-E*U#JcPt=k|E62EiQx;S1zexuw?nf=_m20Epc-Sgv2dX z-nfT#Ew!zrMS$FYA|!6t0cu^YZIib|fY({PzU&sr7T84_k+?>H9FH<{VeW|yBwJBx zN=)N``F%?S`uA+Se(n~DIU+mgP57cEywS_!k4^ZsDK#bf&sF&RX-C3ZN0MhWc{6cy z3X(T*@cjn%8~rQMV zPz$)E(C(2vGZdclM|efm9$^HcmgyV|`xT^?cxnVL#9JVKc`%{vE05mq_S{Ip2W)uC286VpcH+Oc&Pi)3daRi2#oh0rwk~s*);s_*Q zOFR@xofKHX`7Uf1KNUv67XL%19dY>jSLxTNv}ef|8I3c~ic=7ehtuw9#AOf`MqoQB zksK}wQe^;r`-kDuX=}G_Gh7m!hRm)2vDiQ!jh-;y;#hp_7HHQgV9gZWC*SNmFb)5}NEvDi!T*C4B0vQ>nLY8yZ%x zDfl&oH8uPK`;_kpNPh>J`jyi|DY?iESlgb!&*$)GdY>f(e-kb%llZi0=Q537t}8M@ zAHGc^tb3sgs67aU;j@+&qVUnWOd$oi@vJ%a9)8{FnZHbc(iSC1G`BV2ngAq3-DW5d z#Of1ld*y@7TBp~k{Dd_FkkTW8(!$y!I;^k3$|u(z8WQDms!3Q zu8bQvc9LeIe)?b)5nbYN8-!YAnU`YRKw;tMQsD%MAoJT?LtIe?iiohv$}n8t-@OzK zbWK@GGoI=jIB-N&DF3Zn7+zg{Sx88R`7XwT!|<{=C4d@lzAr*~c~{};)jZcQisEUy zB@0XducyhcQvlYqbu_P-o~lf-fUjDYuWH-`vnmyo2tq&!iQv5DNvw;G2>=#(8zg!Q zV?yO6AtFsTYiyW6Yb7p04jAJAEu!4#6beP=bC^)6QByi0VRsQrRc%J{+?XeUZ-k*r zzTdq^V8x;dU>b4L6qhYs&;jl3+MJmhbLqhA`Mjl$-6&3Us*!p3-jVZ1=u0@Mv=COG z^PN~4o~CPj&9hR%SyFS&1o@;Wvv8)Zs$}gZt+f8(QeD_23^NITT*mNyWf&8IHO8t? zXs<`+#eox@1NCJn6?T*2YuV2Fp%4lEuYgpcrNlUY4US!y!spGqDrQ)1oIAi!#mLP# z&e$!?*-yGBRewtHu%`O&(UPGQdB(;;X>n`10>uU)Pa;qP8F!p`xz5P+#nhKjUdl(2 zqs2?C0brY1LE{9eIWfxrtPI0}EsS%tzxtvR$BFie#;0c>ND3uoqgD zSEK|)Nq8;+GgxE&U>ukl@#nqT4P#niDTF?tEv(;!z0E}E6ROu6dIu)LVsEq&X^~CQ2RPThJCnJ#rvzY*KbWG(4hnZ*FV}%G*Lyh1-{s{+ z=>%X-ok8ZW_0F3Yu#u!p!|qdB&njNYdU?x@&@1Ote~fto3ed4>m>K({3QSdtVglR*qSwU15V2ZwAYPlYx3Ti=kNxOrfbPgGL2?^eIXRE**MrO z2hkk7JzgyvWx8%ulY3m}z*g|{&=DV@>pGo7X@l1@`bC|>YW!Mi6Lc@1I^(cx?CB-o zMQDpB%J}4IN2SA?fQ_^UziLq8twD+RalCU35^OS`82zIcIw@u!4ULl8zWsJ9rI`RF zUMh*znZDnpoz|qx3UQ3ELtmup5$Gy`;bk&?{obC$JVDb=Ym@1}5`?{k)y7o~X$Q7? z*}HJ=!q<{FdiU<&tJnAPO2-LW3EVp5HBmrhzMog(><5c3Kue4Dy|%Vow(tqg*Zs`5 zYMr1ZK(yG*x#vb^%e(Pn5`=lx3qdL73E{A({@w{xg=V;h`274-Sz^-6Blx1_GiB+zffC@_m}C@H1TW0P ztv8={wOVs!2>uMMd=9UwQUyNId_Zc(&sHos<$-yCetl_i+u174H8Q*k*aX(p@EW$w z@uCC>g*ttG%+Xxlg5k(~-$2xg8jI5E4CkZ{l6RY6yL;Z zECCKHG2l+eP@3{q+JZ_t5edb0>|igwPzrfs|Fa0`=y6zgP5?j-i^Ym~G-_uS zbZ-?Wl6kZg$}6J{GRzxL6S1y#4V*Z=Bzd#A_yfLdrMp3)c!d-UD|l_CzM^W6aCI>R z^{l?$^Xdv;xSW(%b_y(8ARqfBg3UI5bX6NgnS~AZ1=rX5gf5X8zHUYkIP|vY*drRy zz3fzUnHp49zla3f6F?YVmS8*T`We1WL4hp(Ra0aU$Xmb!Yr{=+4uo*T;$dNnoWhIP zCaS%*2`6C2VP-HHAGUMkjbOfEwUwAS{Uj12z5FyGDQXkV4IAM?d=Q^G^P(`k4KS{i z_$93{ATx;6dv>-G(~&T#S+0{{A&-14Fnk;oK3Vt8c7Nmf=ks82(RS4|!3#Q-FWKF; zx0NW5_E(vbUqj2$z0i&SpW_I>4@Y=1!K6`~){JQ>mO-g|_ihV?m+ST$X>eqayh(L~ z*bE#Spfu^I;uquqUs>%~vhKznRvsOIiP#D<4Le9& z=qS*QOk5#ntwIg^r(#c z90`SzI|8*A@&nCis^D9gzHeehr7`1H2*AHU2N~dgKuQ2ma3Ykr@@CMoT&4(2DIp7e zIc_Z0q8XUcW0E{1*I0tea|>uJz6)vJg(BP&5Gn+d&_IgC*Ky3*3YF9UjVnsG*2t_E zfV%p8%MH`8d-4=4BhiE6kE!6vpj0-^bD%ggZpUGtNFB6P?C1{e~ zcLQi@7*F#V%>3?_ph!9)_4udw>m-gZr01u7N<#R*H~uG$7_GXIPXMin1wYDjz9VRo z@;1|&uKstJ`4Wn*j1k8~?xFcG9KY~}tbK+E>iE<*LOZW~5C4)gx8ufRj^MBk2jb;H z@MDJTb`o1L^Ru8$;h4efSsdKfXR20}ibWeZU(+uYy8ri+_;Vg;z8Q8%V8++M!6Q$h zINIS5#uwae*0ud0Y4O$frU@ooMj88wpcL|%LND;A_3I0Ri_LxggP8dN`k3%HA%3O2 zr>FpW3LJa}f>asuop9jj)NIcv|59PMAIxKz`M&(obnJ&K$~{3k>bZffs~rWM$`7Hv zeI#@y`k)Nd3Aw$FLvBtJ96nylH*M-MTfmrMb$MuNco?M||Cz5qV2iG9P&Yq0)p-b7 zTI`qFTCdWs%{5REsbLEr2e|IK)qK%%PlnUkMwiP*EH)7GnUp1yGf=8g*l=ST?rcHN z_)ny*YYC*}JaxK;tynyZuUOk-X6;=qAYa`z+sEXJpNCd9)QcgMS7em&sknUQI<|I2 z17EzNDmczEhvqV)tqA$?J&0rG56@QS2a@q-B$T0n&i^+E8@qP@ao!G64A z2b{V%DF|9gbY*;?WPKnXSZEbY7_$n;-RF2kbODV4;uB7s@%tdSV(VAUfKz9J%Y4fC zTZU!BJ100Wn2&{!O9kMkxd$`w#^a(rn&nY~BL0nKfsxB97|f&sAfK?z_Eh9N7!T~+ z2{ts z5XYzhK7>pQ0AMujj1q*xjX$+~4XdqP3z7JHQXXfr=-CDFVFVQZYY4GSSNa+BVYBc% z{m{S+psTF!P_5^(Q4pW~31Gx6C!kNCBf${mLof>lW&AqkeFQGWcR*3@2FQ33o7J-C zpWhJF`Yj=A1wnSO9~~SBg9lCF3u^w|4=L4IqqNA6aW1F4kI>Q_PE6?Vo=kT_$cNHm zvX}X;4`ytUwSs7GTa2H+3INkg78358IlE&E<-Mj0YHL{ny$fj3JyRQ>@vNy~mDf#5 zWD$5lgu=cikNO5$el!RPHP69tmV9*1S=QJvFZF~fZ(Ok&ECkOx#dtv=1#wOB@A={t zwVCq3nj6;O=Mr&97tk)4x^IEWSF)-OGw@py2iLf8hlS7_8|n2R1+TCcMCb3|-1)Bw zU+UE>4t^IuY48-J|}Fb9v0gW+WdA?09Dj~Ii6a1nU? zZa-&;$UrX$b(48@3zx6n_84?_jscz+04&r7;qd$T=qG&9a$kE{vYidXAj1Azx4!d( zkJUUj!Ro6@r;63p-3}#%ba<+0Pct|41(tIN3t}%^=y;?%&P36*iyQPS5U|agbD${a z7nu3q4uIUB;N<1oQ>{bNeQoE?ZO5iP6k7t-o)M|fJ>nsCpV_9^4!GD+)sqgVaf6=m zG2}fc1>t@;aO6%q4?cTeVJ+Zo`o@sry%j|uM~$M~$?9$dJU%|#T~nrDObK&Vz?*n^Ri)EYfva#;CDz{EcE?<2h!J|%q;34#nfQLDTag9@wqx56h=ey_8pk4U z!4l_Cfl{IC2^(Tp=Za`EHpv2ggWBNEd!q#BgvV;DQ~W&M*Z>_J8%3Mi`i@pT;VgF! z#`%4qQ_ga-;@IaF?dBg$A)!mBypeXZGx4H@vS@m?(8CQ4i z*N=0h!y4v;KU0`&f>bci!O6?@q!H+j2)oVIR8P<*{ZgSFZp0?wuX6lLd%$*=&oSwZ z_90izpzz&TQI2&}ylLq6-BQfZ6aF*(vOqnjF`WAqER)-COt}&J-!hyNl;RT_TgX+G zBrij#Cl5y2_2djv#lD(-j_(}7cW`V Gesturefy - Welcome - + @@ -15,7 +15,7 @@ -
    -
    -
    -

    -

    -
    -
    -
    - - - -
    -
    - +

    @@ -108,7 +108,7 @@
    - +

    diff --git a/src/views/options/index.html b/src/views/options/index.html index c8d1d3e99..3232c892f 100644 --- a/src/views/options/index.html +++ b/src/views/options/index.html @@ -3,7 +3,7 @@ Gesturefy - + @@ -19,7 +19,7 @@
    +
    +
    +
    +

    +

    +
    +
    +
    + + + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/views/options/layout.css b/src/views/options/layout.css index 40f413f1e..eed954502 100644 --- a/src/views/options/layout.css +++ b/src/views/options/layout.css @@ -355,14 +355,6 @@ h2 { margin-bottom: 20px; } -.align-content-right { - display: flex; - justify-content: flex-end; - flex-wrap: wrap; - row-gap: 15px; - column-gap: 15px; -} - .justify-text { text-align: justify; } From f42af655beaf8c5988ec8bdbaa55d47b4816163c Mon Sep 17 00:00:00 2001 From: Robbendebiene Date: Sat, 2 Sep 2023 17:24:30 +0200 Subject: [PATCH 11/21] Make use of new background scripts module support --- src/core/bundle/background.html | 10 ---------- src/manifest.json | 3 ++- 2 files changed, 2 insertions(+), 11 deletions(-) delete mode 100644 src/core/bundle/background.html diff --git a/src/core/bundle/background.html b/src/core/bundle/background.html deleted file mode 100644 index b72df55e6..000000000 --- a/src/core/bundle/background.html +++ /dev/null @@ -1,10 +0,0 @@ - - - - - Gesturefy - - - - - diff --git a/src/manifest.json b/src/manifest.json index d6b7f8fee..6d1465dbb 100644 --- a/src/manifest.json +++ b/src/manifest.json @@ -51,7 +51,8 @@ } ], "background": { - "page": "core/bundle/background.html" + "scripts": ["core/background.mjs"], + "type": "module" }, "options_ui": { "page": "views/options/index.html", From 31ad7e48ff5eeb304bd69b474e490d341436d68b Mon Sep 17 00:00:00 2001 From: Robbendebiene Date: Thu, 5 Oct 2023 18:10:03 +0200 Subject: [PATCH 12/21] Create separate data tab in options page Also add the ability to backup/restore the config to/from the cloud --- src/_locales/en/messages.json | 116 +++++++++--- src/resources/fonts/icons.woff | Bin 6288 -> 6540 bytes src/views/options/data-management.mjs | 154 ---------------- src/views/options/data.mjs | 246 +++++++++++++++++++++++++ src/views/options/fragments/data.inc | 105 +++++++++++ src/views/options/fragments/extras.inc | 42 ----- src/views/options/index.html | 9 +- src/views/options/layout.css | 12 +- 8 files changed, 459 insertions(+), 225 deletions(-) delete mode 100644 src/views/options/data-management.mjs create mode 100644 src/views/options/data.mjs create mode 100644 src/views/options/fragments/data.inc diff --git a/src/_locales/en/messages.json b/src/_locales/en/messages.json index 659afe1be..e109a7b88 100644 --- a/src/_locales/en/messages.json +++ b/src/_locales/en/messages.json @@ -37,6 +37,10 @@ "message": "Extras", "description": "Extras" }, + "navigationData": { + "message": "Data", + "description": "Data" + }, "navigationAbout": { "message": "About", "description": "About" @@ -285,14 +289,48 @@ "description": "The minimal amount the mouse wheel must be scrolled until the gesture is triggered." }, - "dataManagementLabel": { - "message": "Manage user data", - "description": "Manage user data" + "dataLabelFileBackup": { + "message": "Backup to file", + "description": "Backup to file" + }, + "dataLabelFileRestore": { + "message": "Restore from file", + "description": "Restore from file" + }, + "dataLabelCloudBackup": { + "message": "Backup to cloud", + "description": "Backup to cloud" + }, + "dataLabelCloudRestore": { + "message": "Restore from cloud", + "description": "Restore from cloud" + }, + "dataLabelResetConfig": { + "message": "Reset configuration", + "description": "Reset configuration" + }, + + "dataDescriptionFileBackup": { + "message": "Stores the settings and gestures in a config file.", + "description": "Stores the settings and gestures in a config file." + }, + "dataDescriptionFileRestore": { + "message": "Loads a previously stored config file.", + "description": "Loads a previously stored config file." + }, + "dataDescriptionCloudBackup": { + "message": "Stores the settings and gestures in the cloud of the browser account.", + "description": "Stores the settings and gestures in the cloud of the browser account." + }, + "dataDescriptionCloudRestore": { + "message": "Loads previously uploaded settings and gestures from the cloud of the browser account.", + "description": "Loads previously uploaded settings and gestures from the cloud of the browser account." }, - "dataManagementDescription": { - "message": "These actions affect any mouse gestures and settings.", - "description": "These actions affect any mouse gestures and settings." + "dataDescriptionResetConfig": { + "message": "Resets all settings and gestures to their defaults.", + "description": "Resets all settings and gestures to their defaults." }, + "dataBackup": { "message": "Backup", "description": "Backup" @@ -301,11 +339,56 @@ "message": "Restore", "description": "Restore" }, + "dataCloudUpload": { + "message": "Upload", + "description": "Upload" + }, + "dataCloudDownload": { + "message": "Download", + "description": "Download" + }, "dataReset": { "message": "Reset", "description": "Reset" }, + "dataRestoreNotificationNoConfigFile": { + "message": "The selected file is not a valid Gesturefy config file.", + "description": "The selected file is not a valid Gesturefy config file." + }, + "dataRestoreNotificationWrongFile": { + "message": "The selected file does not match the required file type.", + "description": "The selected file does not match the required file type." + }, + "dataRestoreNotificationConfirm": { + "message": "All settings and gestures will be replaced by the selected config file.", + "description": "All settings and gestures will be replaced by the selected config file." + }, + "dataRestoreNotificationSuccess": { + "message": "The selected configuration has been successfully restored.", + "description": "The selected configuration has been successfully restored." + }, + "dataUploadNotificationConfirm": { + "message": "Your existing configuration in the cloud will be overridden by the current configuration.", + "description": "Your existing configuration in the cloud will be overridden by the current configuration." + }, + "dataUploadNotificationSuccess": { + "message": "The current configuration has been successfully saved to the cloud storage. It will be available to other devices once the data is synced by the browser.", + "description": "The current configuration has been successfully saved to the cloud storage. It will be available to other devices once the data is synced by the browser." + }, + "dataDownloadNotificationConfirm": { + "message": "All settings and gestures will be replaced with the configuration from the cloud.", + "description": "All settings and gestures will be replaced with the configuration from the cloud." + }, + "dataDownloadNotificationSuccess": { + "message": "The configuration from the cloud has been successfully restored.", + "description": "The configuration from the cloud has been successfully restored." + }, + "dataResetNotificationConfirm": { + "message": "All settings and gestures will be reset. This cannot be undone!", + "description": "All settings and gestures will be reset. This cannot be undone!" + }, + "aboutLicense": { "message": "License:", "description": "License:" @@ -327,27 +410,6 @@ "description": "Add-on page" }, - "aboutRestoreNotificationNoConfigFile": { - "message": "The selected file is not a valid Gesturefy config file.", - "description": "The selected file is not a valid Gesturefy config file." - }, - "aboutRestoreNotificationWrongFile": { - "message": "The selected file does not match the required file type.", - "description": "The selected file does not match the required file type." - }, - "aboutRestoreNotificationConfirm": { - "message": "All settings including gestures will be replaced by the selected config file.", - "description": "All settings including gestures will be replaced by the selected config file." - }, - "aboutRestoreNotificationSuccess": { - "message": "The selected config has been successfully restored.", - "description": "The selected config has been successfully restored." - }, - "aboutResetNotificationConfirm": { - "message": "All settings including gestures will be reset. This cannot be undone!", - "description": "All settings including gestures will be reset. This cannot be undone!" - }, - "commandLabelToggleBookmark": { "message": "Toggle bookmark", "description": "Toggle bookmark" diff --git a/src/resources/fonts/icons.woff b/src/resources/fonts/icons.woff index 8ec59ff8d97ea11e84c7b10be3f5de0cfc9dfb48..c156c1e0d43188573aa05ec7718a11ad984548d6 100644 GIT binary patch delta 905 zcmZuwO=uHA6n-iDt%(% z)W`@Bz;AB_JdJz=NL8m|H4!PTBeBk?Qk*Ev%>vK_)@l>JiK%Osk;?!C9!XqZdb%_@ zUbqAx-l3;oBK{(FXc9>PD~NTMg!)nWHCdcrL~aP{^Aab|k>u3OMd`bRbyC8)kxnIw zg+*L!$%EJpgy@;+LUA0q4*+CYqBg4in4OuM$2&}|{=6A|fW|o56>#I#Z0Lrga2!rR z4#wat?kiLul5W=oT!CWsE!nT#+rG1X8(8DoUG+4*-(FH6yS>Jqvo)B3Dm;c)xF_c3 z9R$M+^qN^RNc1d8$s72>W((5^57$b0BqJHo zB1I-LT+8RmNfA{UrA&>AWI2~B_gFU8gdk&EJ>_rib~pO4m$$o^veTt7@<()gcZ+N- zXn8`0F%TtWYqR8wbg06+5gjm$kjDzPv<h5gTxzTdFHi-|YC#>MxCb zG*pUz8N9G(=qq>>d|d$Vk4?X6<*F(cyjjV&P_2lB%}?_u>QybLJ!^}#!L$nl<77c5v57kJ^=E(rXP9TO1g9q!7cej|nE?45 zP%Mz1Q<(-7vteKmUID@?m(zPQQWH}c7(|}{)tG^>6!ZIq89+e>1~C~RUj>9YUaPi07F$YjWwe1lPyamD06jE0-FnU?WvzAEs8xt@)|ltG30G;<6CKZ87jK7&1j zKSMmwG7&aqMI|*`MiVn*MI$j$K>~bM5jJf`hL1o{51 { - if (event.detail) { - const manifest = browser.runtime.getManifest(); - const removePermissions = browser.permissions.remove( - { permissions: manifest.optional_permissions } - ); - removePermissions.then((values) => { - Config.clear(); - // reload option page to update the ui - window.location.reload(); - }); - } - }, { once: true }); - popup.open = true; -} - - -/** - * saves the current config as a json file - **/ -function onBackupButton () { - const manifest = browser.runtime.getManifest(); - const linkElement = document.createElement("a"); - linkElement.download = `${manifest.name} ${manifest.version} ${ new Date().toDateString() }.json`; - // creates a json file with the current config - linkElement.href = URL.createObjectURL( - new Blob([JSON.stringify(Config.get(), null, ' ')], {type: 'application/json'}) - ); - document.body.appendChild(linkElement); - linkElement.click(); - document.body.removeChild(linkElement); -} - - -/** - * overwrites the current config with the selected config - * and resets all optional permissions - * reloads the options page afterwards - **/ -async function onRestoreButton (event) { - if (this.files[0].type !== "application/json") { - const popup = document.getElementById("restoreAlertWrongFile"); - popup.open = true; - // terminate function - return; - } - - // catch rejected promises and errors - try { - // load file data - const file = await new Promise((resolve, reject) => { - const reader = new FileReader(); - reader.onloadend = () => { - try { - const restoredConfig = JSON.parse(reader.result); - resolve(restoredConfig) - } - catch (e) { - reject(); - } - } - reader.onerror = reject; - reader.readAsText(this.files[0]); - }); - - // get the necessary permissions - const requiredPermissions = []; - // combine all commands to one array - const usedCommands = []; - if (file.Gestures && file.Gestures.length > 0) { - file.Gestures.forEach(gesture => usedCommands.push(gesture.command)); - } - if (file.Settings && file.Settings.Rocker) { - if (file.Settings.Rocker.rightMouseClick) usedCommands.push(file.Settings.Rocker.rightMouseClick); - if (file.Settings.Rocker.leftMouseClick) usedCommands.push(file.Settings.Rocker.leftMouseClick); - } - if (file.Settings && file.Settings.Wheel) { - if (file.Settings.Wheel.wheelUp) usedCommands.push(file.Settings.Wheel.wheelUp); - if (file.Settings.Wheel.wheelDown) usedCommands.push(file.Settings.Wheel.wheelDown); - } - - for (let command of usedCommands) { - const commandItem = CommandDefinitions.find((element) => { - return element.command === command.name; - }); - if (commandItem.permissions) commandItem.permissions.forEach((permission) => { - if (!requiredPermissions.includes(permission)) requiredPermissions.push(permission); - }); - } - - // display popup because permission request requires user interaction - // also to ensure that the user really wants to override the current config - const popup = document.getElementById("restoreConfirm"); - popup.addEventListener("close", (event) => { - // if user declined exit function - if (!event.detail) return; - // if optional permissions are required request them - if (requiredPermissions.length > 0) { - const permissionRequest = browser.permissions.request({ - permissions: requiredPermissions, - }); - permissionRequest.then((granted) => { - if (granted) proceed(); - }); - } - else proceed(); - }, { once: true }); - popup.open = true; - - // helper function to finish the process - // reload option page to update the ui - function proceed () { - Config.clear(); - Config.set(file); - const popup = document.getElementById("restoreAlertSuccess"); - popup.addEventListener("close", () => window.location.reload(), { once: true }); - popup.open = true; - } - } - catch (e) { - const popup = document.getElementById("restoreAlertNoConfigFile"); - popup.open = true; - // terminate function - return; - } -} \ No newline at end of file diff --git a/src/views/options/data.mjs b/src/views/options/data.mjs new file mode 100644 index 000000000..486f07a7d --- /dev/null +++ b/src/views/options/data.mjs @@ -0,0 +1,246 @@ +import { ContentLoaded, Config } from "/views/options/main.mjs"; + +import ConfigManager from "/core/helpers/config-manager.mjs"; + +import CommandDefinitions from "/resources/configs/commands.mjs"; + +ContentLoaded.then(main); + + +/** + * main function + * run code that depends on async resources + **/ +function main () { + // data management buttons + document.getElementById("fileBackupButton").onclick = onFileBackupButton; + document.getElementById("fileRestoreButton").onchange = onFileRestoreButton; + document.getElementById("cloudBackupButton").onclick = onCloudBackupButton; + document.getElementById("cloudRestoreButton").onclick = onCloudRestoreButton; + document.getElementById("configResetButton").onclick = onConfigResetButton; + + handleButtonStates(); + browser.storage.sync.onChanged.addListener(handleButtonStates); +} + + +/** + * enabled/disables buttons according to different rules + **/ +async function handleButtonStates() { + // disable download button when sync storage is empty + const bytesInUse = await browser.storage.sync.getBytesInUse(); + const button = document.getElementById("cloudRestoreButton"); + button.disabled = bytesInUse <= 0; +} + + +/** + * saves the current config as a json file + **/ +function onFileBackupButton () { + const manifest = browser.runtime.getManifest(); + const linkElement = document.createElement("a"); + linkElement.download = `${manifest.name} ${manifest.version} ${ new Date().toDateString() }.json`; + // creates a json file with the current config + linkElement.href = URL.createObjectURL( + new Blob([JSON.stringify(Config.get(), null, ' ')], {type: 'application/json'}) + ); + document.body.appendChild(linkElement); + linkElement.click(); + document.body.removeChild(linkElement); +} + + +/** + * overwrites the current config with the selected config + * and resets all optional permissions + * reloads the options page afterwards + **/ +async function onFileRestoreButton (event) { + if (this.files[0].type !== "application/json") { + prompt("restoreAlertWrongFile"); + // terminate function + return; + } + + // catch rejected promises and errors + try { + // load file data + const json = await new Promise((resolve, reject) => { + const reader = new FileReader(); + reader.onloadend = () => { + try { + const restoredConfig = JSON.parse(reader.result); + resolve(restoredConfig) + } + catch (e) { + reject(e); + } + } + reader.onerror = reject; + reader.readAsText(this.files[0]); + }); + + const proceed = await new Promise((resolve) => { + // display popup because permission request requires user interaction + // also to ensure that the user really wants to override the current config + const popup = document.getElementById("restoreConfirm"); + popup.addEventListener("close", async (event) => { + // if user declined exit function + if (!event.detail) return resolve(false); + // if optional permissions are required request them + const permissionsGranted = await requestPermissionsForConfig(json); + resolve(permissionsGranted); + }, { once: true }); + popup.open = true; + }); + + if (proceed) { + Config.clear(); + Config.set(json); + await prompt("restoreAlertSuccess"); + // reload option page to update the ui + window.location.reload(); + } + } + catch (e) { + prompt("restoreAlertNoConfigFile"); + // terminate function + return; + } +} + + +/** + * uploads the current config to the sync storage + **/ +async function onCloudBackupButton () { + const bytesInUse = await browser.storage.sync.getBytesInUse(); + // check whether there is any pre-existing data in the sync storage and warn user + if (bytesInUse > 0) { + const proceed = await prompt("uploadConfirm"); + if (!proceed) return; + } + // create sync config manager and write current config to it + const cloudConfig = new ConfigManager({ + storageArea: 'sync', + }); + await cloudConfig.loaded; + cloudConfig.set( + Config.get(), + ); + prompt("uploadAlertSuccess"); +} + + +/** + * loads and applies the config from the sync storage + * reloads the options page afterwards + **/ +async function onCloudRestoreButton () { + const cloudConfig = new ConfigManager({ + storageArea: 'sync', + }); + await cloudConfig.loaded; + const json = cloudConfig.get(); + + const proceed = await new Promise((resolve) => { + // display popup because permission request requires user interaction + // also to ensure that the user really wants to override the current config + const popup = document.getElementById("downloadConfirm"); + popup.addEventListener("close", async (event) => { + // if user declined exit function + if (!event.detail) return resolve(false); + // if optional permissions are required request them + const permissionsGranted = await requestPermissionsForConfig(json); + resolve(permissionsGranted); + }, { once: true }); + popup.open = true; + }); + + if (proceed) { + Config.clear(); + Config.set(json); + await prompt("downloadAlertSuccess"); + // reload option page to update the ui + window.location.reload(); + } +} + + +/** + * clears the current config so the defaults will be used + * resets all optional permissions + * reloads the options page afterwards + **/ +async function onConfigResetButton () { + const proceed = await prompt("resetConfirm"); + if (proceed) { + const manifest = browser.runtime.getManifest(); + await browser.permissions.remove( + { permissions: manifest.optional_permissions } + ); + Config.clear(); + // reload option page to update the ui + window.location.reload(); + } +} + + +/** + * Collects and requests all permissions that are required for the given config file + * This returns a promise that will either fulfill with true or false + * If no permissions are required this fulfills with true + **/ +function requestPermissionsForConfig (json) { + // get the necessary permissions + const requiredPermissions = []; + // combine all commands to one array + const usedCommands = []; + if (json.Gestures && json.Gestures.length > 0) { + json.Gestures.forEach(gesture => usedCommands.push(gesture.command)); + } + if (json.Settings && json.Settings.Rocker) { + if (json.Settings.Rocker.rightMouseClick) usedCommands.push(json.Settings.Rocker.rightMouseClick); + if (json.Settings.Rocker.leftMouseClick) usedCommands.push(json.Settings.Rocker.leftMouseClick); + } + if (json.Settings && json.Settings.Wheel) { + if (json.Settings.Wheel.wheelUp) usedCommands.push(json.Settings.Wheel.wheelUp); + if (json.Settings.Wheel.wheelDown) usedCommands.push(json.Settings.Wheel.wheelDown); + } + + for (let command of usedCommands) { + const commandItem = CommandDefinitions.find((element) => { + return element.command === command.name; + }); + if (commandItem.permissions) commandItem.permissions.forEach((permission) => { + if (!requiredPermissions.includes(permission)) requiredPermissions.push(permission); + }); + } + + // if optional permissions are required request them + if (requiredPermissions.length > 0) { + return browser.permissions.request({ + permissions: requiredPermissions, + }); + } + // if no permissions are required resolve to true + return Promise.resolve(true); +} + + +/** + * Helper function to open popups by their ids. + * Returns the result of the popup. + **/ +function prompt (popupId) { + return new Promise((resolve) => { + const popup = document.getElementById(popupId); + popup.addEventListener("close", + async (event) => resolve(event.detail), + { once: true }, + ); + popup.open = true; + }); +} diff --git a/src/views/options/fragments/data.inc b/src/views/options/fragments/data.inc new file mode 100644 index 000000000..97a264698 --- /dev/null +++ b/src/views/options/fragments/data.inc @@ -0,0 +1,105 @@ +
    +

    +
    +
    +
    +
    +
    +

    +

    +
    +
    + +
    +
    +
    +
    +

    +

    +
    +
    + +
    +
    +
    +
    +
    +
    +

    +

    +
    +
    + +
    +
    +
    +
    +

    +

    +
    +
    + +
    +
    +
    +
    +
    +
    +

    +

    +
    +
    + +
    +
    +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/src/views/options/fragments/extras.inc b/src/views/options/fragments/extras.inc index 33595b2b1..79ebe30cc 100644 --- a/src/views/options/fragments/extras.inc +++ b/src/views/options/fragments/extras.inc @@ -86,46 +86,4 @@
    - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/src/views/options/index.html b/src/views/options/index.html index 3232c892f..8d491ceac 100644 --- a/src/views/options/index.html +++ b/src/views/options/index.html @@ -14,7 +14,7 @@ - + @@ -39,6 +39,12 @@
    • +
  • + + + + +
  • @@ -58,6 +64,7 @@
    +
    diff --git a/src/views/options/layout.css b/src/views/options/layout.css index eed954502..446c39a37 100644 --- a/src/views/options/layout.css +++ b/src/views/options/layout.css @@ -158,6 +158,11 @@ h2 { font-family: Icons; } +.icon-data:after { + content: "d"; + font-family: Icons; +} + .icon-arrows:after { content: "a"; font-family: Icons; @@ -590,11 +595,16 @@ label.button > span { color: inherit; } -.button:hover { +.button:not(:disabled):hover { box-shadow: 0 0 10px -4px var(--shadow-color); text-decoration: none; } +.button:disabled { + cursor: default; + opacity: 0.5; +} + .button.danger:hover *, .button.danger:hover { border-color: var(--warning-color); From 039ab366d19afc10d781bab0d7b81db98d7b964b Mon Sep 17 00:00:00 2001 From: Robbendebiene Date: Thu, 23 May 2024 23:31:28 +0200 Subject: [PATCH 13/21] Add initial browser action popup implementation --- src/_locales/en/messages.json | 55 ++++++++- src/manifest.json | 4 +- src/resources/configs/defaults.mjs | 3 +- src/views/popup/index.html | 36 ++++++ src/views/popup/layout.css | 192 +++++++++++++++++++++++++++++ src/views/popup/main.mjs | 174 ++++++++++++++++++++++++++ 6 files changed, 461 insertions(+), 3 deletions(-) create mode 100644 src/views/popup/index.html create mode 100644 src/views/popup/layout.css create mode 100644 src/views/popup/main.mjs diff --git a/src/_locales/en/messages.json b/src/_locales/en/messages.json index e109a7b88..a0aff5bdf 100644 --- a/src/_locales/en/messages.json +++ b/src/_locales/en/messages.json @@ -1676,5 +1676,58 @@ "welcomePageLowerSectionLearnMoreLink": { "message": "Learn More", "description": "Learn More" + }, + + "popupProhibitedPageWarning": { + "message": "Add-ons are prohibited on: $URL$", + "description": "Add-ons are prohibited on: $URL$", + "placeholders": { + "url" : { + "content" : "$1", + "example" : "www.example.com" + } + } + }, + "popupMissingPermissionButton": { + "message": "Gesturefy requires additional permissions", + "description": "Gesturefy requires additional permissions" + }, + "popupMissingPermissionButtonTooltip": { + "message": "Click to request necessary permissions and enable Gesturefy.", + "description": "Click to request necessary permissions and enable Gesturefy." + }, + "popupExclusionsToggleButton": { + "message": "Allow gestures on $DOMAIN$", + "description": "Allow gestures on $DOMAIN$", + "placeholders": { + "domain" : { + "content" : "$1", + "example" : "www.example.com" + } + } + }, + "popupExclusionsToggleButtonOffTooltip": { + "message": "Click to enable Gesturefy on $DOMAIN$", + "description": "Click to enable Gesturefy on $DOMAIN$", + "placeholders": { + "domain" : { + "content" : "$1", + "example" : "www.example.com" + } + } + }, + "popupExclusionsToggleButtonOnTooltip": { + "message": "Click to disable Gesturefy on $DOMAIN$", + "description": "Click to disable Gesturefy on $DOMAIN$", + "placeholders": { + "domain" : { + "content" : "$1", + "example" : "www.example.com" + } + } + }, + "popupOpenSettingsButton": { + "message": "Open settings", + "description": "Open settings" } -} +} \ No newline at end of file diff --git a/src/manifest.json b/src/manifest.json index 6d1465dbb..f7f6fc00a 100644 --- a/src/manifest.json +++ b/src/manifest.json @@ -64,7 +64,9 @@ "48": "resources/img/icon.svg", "32": "resources/img/icon.svg" }, - "default_title": "__MSG_commandLabelOpenAddonSettings__" + "default_title": "Gesturefy", + "default_popup": "views/popup/index.html", + "default_area": "navbar" }, "web_accessible_resources": [ { diff --git a/src/resources/configs/defaults.mjs b/src/resources/configs/defaults.mjs index cc981cac5..7e1de0c81 100644 --- a/src/resources/configs/defaults.mjs +++ b/src/resources/configs/defaults.mjs @@ -298,5 +298,6 @@ export default Object.freeze({ } } } - ] + ], + "Exclusions": [] }); diff --git a/src/views/popup/index.html b/src/views/popup/index.html new file mode 100644 index 000000000..cf1c9e854 --- /dev/null +++ b/src/views/popup/index.html @@ -0,0 +1,36 @@ + + + + + + + + +     + + + +
    + + + Mozilla Add-ons + + + + Github + + + \ No newline at end of file diff --git a/src/views/popup/layout.css b/src/views/popup/layout.css new file mode 100644 index 000000000..2791cc976 --- /dev/null +++ b/src/views/popup/layout.css @@ -0,0 +1,192 @@ +@font-face { + font-weight: normal; + font-style: normal; + font-family: "Icons"; + src: url("/resources/fonts/icons.woff"); +} + +@font-face { + font-weight: normal; + font-style: normal; + font-family: "NunitoSans Regular"; + src: url("/resources/fonts/NunitoSans-Regular.woff"); +} + +/* Light Theme */ + +.light-theme:root, :root { + --base-color: #FBFBFB; + --text-color: #555555; + --surface-color: #ddd; + --on-surface-color: var(--text-color); + --shadowSecond-color:rgba(0,0,0,0.15); + --highlighted-color: #00AAA0; + --warning-color: #FF6347; +} + +/* Dark Theme */ + +.dark-theme:root { + --base-color: #252a32; + --text-color: #EBEBEB; + --surface-color: #464e5e; + --on-surface-color: var(--text-color); + --shadowSecond-color: rgba(200,200,200, 0.15); + --highlighted-color: #00AAA0; + --warning-color: #FF6347; +} + +/* High Contrast Theme */ + +.highContrast-theme:root { + --base-color: #000; + --text-color:#FFF; + --surface-color:#FFF; + --on-surface-color: var(--base-color); + --shadowSecond-color: rgba(255,255,255,0.15); + --highlighted-color: #00ff00; + --warning-color: #FF0000; +} + +* { + margin: 0; + padding: 0; + border: none; + outline: none; +} + +html { + font-family: "NunitoSans Regular", "Arial", sans-serif; + color: var(--text-color); +} + +body { + background: var(--base-color); + display: flex; + flex-direction: column; + justify-content: stretch; + padding: 0.5em; +} + +[hidden] { + display: none !important; +} + +/** + * Icons classes + **/ + +.icon-gear::before { + content: "g"; + font-family: Icons; + vertical-align: top; +} + +.icon-info::before { + content: "I"; + font-family: Icons; +} + +.favicon::before { + content: ''; + display: block; + background-image: var(--favicon-url); + width: 1em; + height: 1em; + background-size: contain; +} + +.favicon.favicon-amo::before { + background-image: url('https://addons.mozilla.org/favicon.ico?v=2'); +} + +.favicon.favicon-github::before { + background-image: url('https://github.githubassets.com/favicons/favicon.svg'); +} + +.highContrast-theme:root .favicon.favicon-github::before, +.dark-theme:root .favicon.favicon-github::before { + background-image: url('https://github.githubassets.com/favicons/favicon-dark.svg'); +} + +/** + * Item list + **/ + +hr { + border-bottom: solid 1px var(--surface-color); + margin: 0.5em 0em; +} + +.item { + display: flex; + justify-content: flex-start; + align-items: center; + column-gap: 0.5em; + padding: 0 0.7em; + border-radius: 0.2em; + background: none; + color: var(--text-color); + font-weight: normal; + text-decoration: none; + font-size: 1em; + line-height: 1em; + text-align: left; +} + +.item:hover, +.item:focus-visible { + background: var(--surface-color); + text-decoration: none; + color: var(--on-surface-color); +} + +.item > span:last-of-type { + padding: 0.7em 0; + flex: 1; +} + +a.item::after { + content: "E"; + text-decoration: none; + font-family: Icons; + font-size: 0.75em; +} + +.item.warning { + color: var(--warning-color); +} + +/** + * Toggle button + **/ + +input[type="checkbox"] { + appearance: none; + height: 1rem; + padding: 0.15em; + box-sizing: content-box; + aspect-ratio: 2 / 1; + border-radius: 2rem; + background-color: var(--surface-color); + box-shadow: inset 0px 0px 3px var(--shadowSecond-color); + transition: background-color 0.2s; +} + +input[type="checkbox"]::before { + content: ""; + display: block; + border-radius: 50%; + height: 100%; + aspect-ratio: 1 / 1; + background: var(--base-color); + transition: transform 0.2s ease; +} + +input[type="checkbox"]:checked { + background-color: var(--highlighted-color); +} + +input[type="checkbox"]:checked::before { + transform: translateX(100%) +} \ No newline at end of file diff --git a/src/views/popup/main.mjs b/src/views/popup/main.mjs new file mode 100644 index 000000000..4fdee1769 --- /dev/null +++ b/src/views/popup/main.mjs @@ -0,0 +1,174 @@ +import ConfigManager from "/core/helpers/config-manager.mjs"; + +import DefaultConfig from "/resources/configs/defaults.mjs"; + +const Config = new ConfigManager({ + defaults: DefaultConfig +}); + +Promise.all([ + getActiveTab(), + Config.loaded, +]).then(main); + +let activeTab; + +function main(args) { + [activeTab] = args; + const tabUrl = new URL(activeTab.url); + const shortUrl = toShortURL(tabUrl); + // insert text from language files + for (let element of document.querySelectorAll('[data-i18n]')) { + element.textContent = browser.i18n.getMessage(element.dataset.i18n); + } + // register permission change handler and run it initially + browser.permissions.onRemoved.addListener(onPermissionChange); + browser.permissions.onAdded.addListener(onPermissionChange); + onPermissionChange(); + // apply theme class + const themeValue = Config.get("Settings.General.theme"); + document.documentElement.classList.add(`${themeValue}-theme`); + // register button event listeners + const settingsButton = document.getElementById('settingsButton'); + settingsButton.addEventListener('click', openSettings); + const permissionRequestButton = document.getElementById('permissionRequestButton'); + permissionRequestButton.title = browser.i18n.getMessage('popupMissingPermissionButtonTooltip'); + permissionRequestButton.addEventListener('click', requestGlobalPermissions); + const restrictedPageWarningText = document.getElementById('restrictedPageWarningText'); + restrictedPageWarningText.textContent = browser.i18n.getMessage('popupProhibitedPageWarning', shortUrl); + const domainActivationButton = document.getElementById('domainActivationButton'); + domainActivationButton.style.setProperty('--favicon-url', `url(${activeTab.favIconUrl})`); + const domainActivationButtonText = document.getElementById('domainActivationButtonText'); + domainActivationButtonText.textContent = browser.i18n.getMessage('popupExclusionsToggleButton', shortUrl); + // use click instead of change to prevent default + const domainActivationButtonToggle = document.getElementById('domainActivationButtonToggle'); + domainActivationButtonToggle.addEventListener('click', onDomainToggle); +} + +// handlers \\ + +async function onPermissionChange() { + const tabUrl = new URL(activeTab.url); + const shortUrl = toShortURL(tabUrl); + + const [ + _hasGlobalPermission, + _isRestrictedPage, + ] = await Promise.all([ + hasGlobalPermission(), + isRestrictedPage(activeTab), + ]); + + // warnings: + let hasWarning = false; + + const permissionRequestButton = document.getElementById('permissionRequestButton'); + permissionRequestButton.hidden = _hasGlobalPermission; + hasWarning ||= !permissionRequestButton.hidden; + + const restrictedPageWarning = document.getElementById('restrictedPageWarning'); + restrictedPageWarning.hidden = hasWarning || !_isRestrictedPage; + hasWarning ||= !restrictedPageWarning.hidden; + + // exclusion toggle (only show when no warnings): + const isActive = isActivatedOn(activeTab); + const domainActivationButton = document.getElementById('domainActivationButton'); + domainActivationButton.hidden = hasWarning; + domainActivationButton.title = isActive + ? browser.i18n.getMessage('popupExclusionsToggleButtonOnTooltip', shortUrl) + : browser.i18n.getMessage('popupExclusionsToggleButtonOffTooltip', shortUrl); + const domainActivationButtonToggle = document.getElementById('domainActivationButtonToggle'); + domainActivationButtonToggle.checked = isActive; +} + +function onDomainToggle(event) { + const tabUrl = new URL(activeTab.url); + if (isActivatedOn(activeTab)) { + deactivate(tabUrl.origin); + } + else { + activate(tabUrl.origin); + } + event.preventDefault(); + onPermissionChange(); +} + +// methods \\ + +function openSettings() { + browser.runtime.openOptionsPage(); + window.close(); +} + +async function getActiveTab() { + return (await browser.tabs.query({ + active: true, + currentWindow: true, + }))[0]; +} + +function toShortURL(url) { + if (url.protocol === 'about:') { + return url.protocol + url.pathname; + } + else if (url.protocol === 'moz-extension:') { + return url.protocol; + } + else if (url.protocol === 'chrome:') { + return url.origin; + } + else { + return url.hostname || url.origin; + } +} + +function isActivatedOn(tab) { + return !Config.get('Exclusions').some( + (pattern) => new RegExp(pattern).test(tab.url) + ); +} + +function activate(domain) { + const exclusions = Config.get('Exclusions'); + const index = exclusions.findIndex( + (pattern) => new RegExp(pattern).test(domain) + ); + if (index > -1) { + exclusions.splice(index, 1); + Config.set('Exclusions', exclusions); + } +} + +function deactivate(domain) { + // escape special regex characters + const escapedDomain = domain.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, match => '\\'+match); + // ^ matches beginning of input and $ matches ending of input + const pattern = '^'+escapedDomain+'.*'+'$'; + + const exclusions = Config.get('Exclusions'); + exclusions.push(pattern); + Config.set('Exclusions', exclusions); +} + +function hasGlobalPermission() { + return browser.permissions.contains({ + origins: [''] + }); +} + +function requestGlobalPermissions() { + return browser.permissions.request({ + origins: [''] + }); +} + +async function isRestrictedPage(tab) { + // workaround to find out if the page is restricted + try { + await browser.tabs.sendMessage(tab.id, true); + return false; + } + catch(e) { + return true; + } +} From 9d00bce52a10dff5f7f48b85877ebf0d8b43a54c Mon Sep 17 00:00:00 2001 From: Robbendebiene Date: Tue, 4 Jun 2024 19:03:08 +0200 Subject: [PATCH 14/21] Add separate exclusion service --- src/core/services/exclusion-service.mjs | 143 ++++++++++++++++++++++++ src/views/popup/main.mjs | 42 ++----- 2 files changed, 152 insertions(+), 33 deletions(-) create mode 100644 src/core/services/exclusion-service.mjs diff --git a/src/core/services/exclusion-service.mjs b/src/core/services/exclusion-service.mjs new file mode 100644 index 000000000..f8850354d --- /dev/null +++ b/src/core/services/exclusion-service.mjs @@ -0,0 +1,143 @@ +/** + * Service for adding and removing exclusions + **/ +export default class ExclusionService { + constructor () { + // empty array as default value so the config doesn't have to be loaded + this._exclusions = []; + // holds all custom event callbacks + this._events = { + 'change': new Set() + }; + // setup on storage change handler + this._listener = this._storageChangeHandler.bind(this); + browser.storage.onChanged.addListener(this._listener); + // load initial storage data + this._loaded = browser.storage.local.get('Exclusions'); + // store exclusions when loaded + this._loaded.then((value) => { + const exclusions = value['Exclusions']; + if (Array.isArray(exclusions) && this._exclusions.length === 0) { + this._exclusions = this._fromStorageJSON(exclusions); + } + }); + } + + _storageChangeHandler(changes, areaName) { + if (areaName === 'local' && changes.hasOwnProperty('Exclusions')) { + const newExclusions = changes['Exclusions'].newValue; + const oldExclusions = changes['Exclusions'].oldValue; + // check for any changes + if (newExclusions.length !== oldExclusions.length || + newExclusions.some((val, i) => val !== oldExclusions[i]) + ) { + this._exclusions = this._fromStorageJSON(newExclusions); + // execute event callbacks + this._events["change"].forEach((callback) => callback(newExclusions)); + } + } + } + + _fromStorageJSON(rawExclusions) { + return rawExclusions.map((string) => new RegExp(string)); + } + + _toStorageJSON() { + return this._exclusions.map((pattern) => pattern.source); + } + + get loaded () { + return this._loaded; + } + + isEnabledFor(tab) { + return !this.isDisabledFor(tab); + } + + isDisabledFor(tab) { + return this._exclusions.some( + (pattern) => pattern.test(tab.url) + ); + } + + /** + * Removes the first exclusion that matches the given tab's URL + **/ + enableFor(tab) { + // find first pattern that matches the tab url + const index = this._exclusions.findIndex( + (pattern) => pattern.test(tab.url) + ); + if (index > -1) { + this._exclusions.splice(index, 1); + return browser.storage.local.set({'Exclusions': this._toStorageJSON(this._exclusions)}); + } + } + + /** + * Adds an exclusion for the domain of the given tab if there isn't a matching one already. + **/ + disableFor(tab) { + if (this.isDisabledFor(tab)) { + return; + } + const domain = new URL(tab.url).origin; + // escape special regex characters + const escapedDomain = domain.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, match => '\\'+match); + // ^ matches beginning of input and $ matches ending of input + const pattern = new RegExp('^'+escapedDomain+'.*'+'$'); + this._exclusions.push(pattern); + return browser.storage.local.set({'Exclusions': this._toStorageJSON(this._exclusions)}); + } + + /** + * Adds an event listener + * Requires an event specifier as a string and a callback method + * Current events are: + * "change" - Fires when exclusions have been changed + **/ + addEventListener (event, callback) { + if (!this._events.hasOwnProperty(event)) { + throw "The first argument is not a valid event."; + } + if (typeof callback !== "function") { + throw "The second argument must be a function."; + } + this._events[event].add(callback); + } + + /** + * Checks if an event listener exists + * Requires an event specifier as a string and a callback method + **/ + hasEventListener (event, callback) { + if (!this._events.hasOwnProperty(event)) { + throw "The first argument is not a valid event."; + } + if (typeof callback !== "function") { + throw "The second argument must be a function."; + } + this._events[event].has(callback); + } + + /** + * Removes an event listener + * Requires an event specifier as a string and a callback method + **/ + removeEventListener (event, callback) { + if (!this._events.hasOwnProperty(event)) { + throw "The first argument is not a valid event."; + } + if (typeof callback !== "function") { + throw "The second argument must be a function."; + } + this._events[event].delete(callback); + } + + /** + * Cleanup service resources and dependencies + **/ + dispose() { + browser.storage.onChanged.removeListener(this._listener); + } +} diff --git a/src/views/popup/main.mjs b/src/views/popup/main.mjs index 4fdee1769..781d5018e 100644 --- a/src/views/popup/main.mjs +++ b/src/views/popup/main.mjs @@ -1,3 +1,5 @@ +import ExclusionService from "/core/services/exclusion-service.mjs"; + import ConfigManager from "/core/helpers/config-manager.mjs"; import DefaultConfig from "/resources/configs/defaults.mjs"; @@ -6,9 +8,12 @@ const Config = new ConfigManager({ defaults: DefaultConfig }); +const Exclusions = new ExclusionService(); + Promise.all([ getActiveTab(), Config.loaded, + Exclusions.loaded, ]).then(main); let activeTab; @@ -71,7 +76,7 @@ async function onPermissionChange() { hasWarning ||= !restrictedPageWarning.hidden; // exclusion toggle (only show when no warnings): - const isActive = isActivatedOn(activeTab); + const isActive = Exclusions.isEnabledFor(activeTab); const domainActivationButton = document.getElementById('domainActivationButton'); domainActivationButton.hidden = hasWarning; domainActivationButton.title = isActive @@ -82,12 +87,11 @@ async function onPermissionChange() { } function onDomainToggle(event) { - const tabUrl = new URL(activeTab.url); - if (isActivatedOn(activeTab)) { - deactivate(tabUrl.origin); + if (Exclusions.isEnabledFor(activeTab)) { + Exclusions.disableFor(activeTab); } else { - activate(tabUrl.origin); + Exclusions.enableFor(activeTab); } event.preventDefault(); onPermissionChange(); @@ -122,34 +126,6 @@ function toShortURL(url) { } } -function isActivatedOn(tab) { - return !Config.get('Exclusions').some( - (pattern) => new RegExp(pattern).test(tab.url) - ); -} - -function activate(domain) { - const exclusions = Config.get('Exclusions'); - const index = exclusions.findIndex( - (pattern) => new RegExp(pattern).test(domain) - ); - if (index > -1) { - exclusions.splice(index, 1); - Config.set('Exclusions', exclusions); - } -} - -function deactivate(domain) { - // escape special regex characters - const escapedDomain = domain.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, match => '\\'+match); - // ^ matches beginning of input and $ matches ending of input - const pattern = '^'+escapedDomain+'.*'+'$'; - - const exclusions = Config.get('Exclusions'); - exclusions.push(pattern); - Config.set('Exclusions', exclusions); -} - function hasGlobalPermission() { return browser.permissions.contains({ origins: [''] From b061df45432a353c20ab72b9b786cf7099009684 Mon Sep 17 00:00:00 2001 From: Robbendebiene Date: Tue, 4 Jun 2024 19:04:31 +0200 Subject: [PATCH 15/21] Move config manager to service directory --- src/core/content.mjs | 2 +- src/core/migration.mjs | 2 +- src/core/{helpers => services}/config-manager.mjs | 0 src/views/options/data.mjs | 2 +- src/views/options/main.mjs | 2 +- src/views/popup/main.mjs | 2 +- 6 files changed, 5 insertions(+), 5 deletions(-) rename src/core/{helpers => services}/config-manager.mjs (100%) diff --git a/src/core/content.mjs b/src/core/content.mjs index 77f4887e2..997dcc7d3 100644 --- a/src/core/content.mjs +++ b/src/core/content.mjs @@ -1,6 +1,6 @@ import { isEmbeddedFrame, isEditableInput, isScrollableY, scrollToY, getClosestElement, getTargetData } from "/core/utils/commons.mjs"; -import ConfigManager from "/core/helpers/config-manager.mjs"; +import ConfigManager from "/core/services/config-manager.mjs"; import DefaultConfig from "/resources/configs/defaults.mjs"; diff --git a/src/core/migration.mjs b/src/core/migration.mjs index 6e2027bb7..4184a1649 100644 --- a/src/core/migration.mjs +++ b/src/core/migration.mjs @@ -1,4 +1,4 @@ -import ConfigManager from "/core/helpers/config-manager.mjs"; +import ConfigManager from "/core/services/config-manager.mjs"; browser.runtime.onInstalled.addListener(async (details) => { diff --git a/src/core/helpers/config-manager.mjs b/src/core/services/config-manager.mjs similarity index 100% rename from src/core/helpers/config-manager.mjs rename to src/core/services/config-manager.mjs diff --git a/src/views/options/data.mjs b/src/views/options/data.mjs index 486f07a7d..02ff46830 100644 --- a/src/views/options/data.mjs +++ b/src/views/options/data.mjs @@ -1,6 +1,6 @@ import { ContentLoaded, Config } from "/views/options/main.mjs"; -import ConfigManager from "/core/helpers/config-manager.mjs"; +import ConfigManager from "/core/services/config-manager.mjs"; import CommandDefinitions from "/resources/configs/commands.mjs"; diff --git a/src/views/options/main.mjs b/src/views/options/main.mjs index da9205b55..190702cf5 100644 --- a/src/views/options/main.mjs +++ b/src/views/options/main.mjs @@ -1,6 +1,6 @@ import { fetchHTMLAsFragment } from "/core/utils/commons.mjs"; -import ConfigManager from "/core/helpers/config-manager.mjs"; +import ConfigManager from "/core/services/config-manager.mjs"; import DefaultConfig from "/resources/configs/defaults.mjs"; diff --git a/src/views/popup/main.mjs b/src/views/popup/main.mjs index 781d5018e..55a4b5b88 100644 --- a/src/views/popup/main.mjs +++ b/src/views/popup/main.mjs @@ -1,6 +1,6 @@ import ExclusionService from "/core/services/exclusion-service.mjs"; -import ConfigManager from "/core/helpers/config-manager.mjs"; +import ConfigManager from "/core/services/config-manager.mjs"; import DefaultConfig from "/resources/configs/defaults.mjs"; From 19300a7fe84283909740851b787bfba634ded5b0 Mon Sep 17 00:00:00 2001 From: Robbendebiene Date: Wed, 3 Jul 2024 12:26:56 +0200 Subject: [PATCH 16/21] Add host permission service and introduce base event listener service --- src/core/services/base-event-listener.mjs | 70 +++++++++++++++++++ src/core/services/exclusion-service.mjs | 56 ++------------- src/core/services/host-permission-service.mjs | 67 ++++++++++++++++++ src/core/utils/commons.mjs | 11 +++ src/views/popup/main.mjs | 46 +++--------- 5 files changed, 165 insertions(+), 85 deletions(-) create mode 100644 src/core/services/base-event-listener.mjs create mode 100644 src/core/services/host-permission-service.mjs diff --git a/src/core/services/base-event-listener.mjs b/src/core/services/base-event-listener.mjs new file mode 100644 index 000000000..620a55be8 --- /dev/null +++ b/src/core/services/base-event-listener.mjs @@ -0,0 +1,70 @@ +/** + * Abstract class that can be used to implement basic event listener functionality. + **/ +export default class BaseEventListener { + /** + * Requires an array of event specifiers as strings that can later be used to call and register events. + **/ + constructor (events) { + // holds all custom event callbacks + this._events = new Map( + events.map((e) => [e, new Set()]) + ); + } + + /** + * Adds an event listener. + * Requires an event specifier as a string and a callback method. + **/ + addEventListener (event, callback) { + this._validateEventParameter(event); + this._validateCallbackParameter(callback); + this._events.get(event).add(callback); + } + + /** + * Checks if an event listener exists. + * Requires an event specifier as a string and a callback method. + **/ + hasEventListener (event, callback) { + this._validateEventParameter(event); + this._validateCallbackParameter(callback); + this._events.get(event).has(callback); + } + + /** + * Removes an event listener. + * Requires an event specifier as a string and a callback method. + **/ + removeEventListener (event, callback) { + this._validateEventParameter(event); + this._validateCallbackParameter(callback); + this._events.get(event).delete(callback); + } + + /** + * Remove all event listeners for the given event. + **/ + clearEventListeners(event) { + this._validateEventParameter(event); + this._events.get(event).clear(); + } + + /** + * Validate event parameter. + **/ + _validateEventParameter (event) { + if (!this._events.has(event)) { + throw "The first argument is not a valid event."; + } + } + + /** + * Validate callback parameter. + **/ + _validateCallbackParameter (callback) { + if (typeof callback !== "function") { + throw "The second argument must be a function."; + } + } +} diff --git a/src/core/services/exclusion-service.mjs b/src/core/services/exclusion-service.mjs index f8850354d..c2f6e8690 100644 --- a/src/core/services/exclusion-service.mjs +++ b/src/core/services/exclusion-service.mjs @@ -1,14 +1,14 @@ +import BaseEventListener from "/core/services/base-event-listener.mjs"; + /** * Service for adding and removing exclusions **/ -export default class ExclusionService { +export default class ExclusionService extends BaseEventListener { constructor () { + // set available event specifiers + super(['change']); // empty array as default value so the config doesn't have to be loaded this._exclusions = []; - // holds all custom event callbacks - this._events = { - 'change': new Set() - }; // setup on storage change handler this._listener = this._storageChangeHandler.bind(this); browser.storage.onChanged.addListener(this._listener); @@ -33,7 +33,7 @@ export default class ExclusionService { ) { this._exclusions = this._fromStorageJSON(newExclusions); // execute event callbacks - this._events["change"].forEach((callback) => callback(newExclusions)); + this._events.get('change').forEach((callback) => callback(newExclusions)); } } } @@ -90,50 +90,6 @@ export default class ExclusionService { return browser.storage.local.set({'Exclusions': this._toStorageJSON(this._exclusions)}); } - /** - * Adds an event listener - * Requires an event specifier as a string and a callback method - * Current events are: - * "change" - Fires when exclusions have been changed - **/ - addEventListener (event, callback) { - if (!this._events.hasOwnProperty(event)) { - throw "The first argument is not a valid event."; - } - if (typeof callback !== "function") { - throw "The second argument must be a function."; - } - this._events[event].add(callback); - } - - /** - * Checks if an event listener exists - * Requires an event specifier as a string and a callback method - **/ - hasEventListener (event, callback) { - if (!this._events.hasOwnProperty(event)) { - throw "The first argument is not a valid event."; - } - if (typeof callback !== "function") { - throw "The second argument must be a function."; - } - this._events[event].has(callback); - } - - /** - * Removes an event listener - * Requires an event specifier as a string and a callback method - **/ - removeEventListener (event, callback) { - if (!this._events.hasOwnProperty(event)) { - throw "The first argument is not a valid event."; - } - if (typeof callback !== "function") { - throw "The second argument must be a function."; - } - this._events[event].delete(callback); - } - /** * Cleanup service resources and dependencies **/ diff --git a/src/core/services/host-permission-service.mjs b/src/core/services/host-permission-service.mjs new file mode 100644 index 000000000..857431723 --- /dev/null +++ b/src/core/services/host-permission-service.mjs @@ -0,0 +1,67 @@ +import BaseEventListener from "/core/services/base-event-listener.mjs"; + +/** + * Service for checking and requesting host permissions. + **/ +export default class HostPermissionService extends BaseEventListener { + + constructor () { + // set available event specifiers + super(['change']); + // register change listeners + this._listener = this._permissionChangeHandler.bind(this); + browser.permissions.onAdded.addListener(this._listener); + browser.permissions.onRemoved.addListener(this._listener); + } + + _permissionChangeHandler(permissions) { + if (permissions?.origins.length > 0) { + this._events.get('change').forEach((callback) => callback(permissions.origins)); + } + } + + /** + * Check if add-on was granted global host permissions. + * Returns a Promise with true/false. + **/ + hasGlobalPermission() { + return browser.permissions.contains({ + origins: [''] + }); + } + + /** + * Request global host permissions. + * Returns a Promise with true if the permissions got granted, otherwise false. + **/ + requestGlobalPermission() { + return browser.permissions.request({ + origins: [''] + }); + } + + /** + * Check whether the add-on is allowed to run in the given tab. + * If the add-on is restricted this will return false, otherwise true. + * + * The add-on might be restricted due to missing host permissions or because the tab holds a privileged URL. + **/ + async hasTabPermission(tabId) { + // workaround to find out if the page is restricted + try { + await browser.tabs.sendMessage(tabId, true); + return true; + } + catch(e) { + return false; + } + } + + /** + * Cleanup service resources and dependencies + **/ + dispose() { + browser.permissions.onAdded.removeListener(this._listener); + browser.permissions.onRemoved.removeListener(this._listener); + } +} diff --git a/src/core/utils/commons.mjs b/src/core/utils/commons.mjs index ebd6ba56f..5fb3e7e3f 100644 --- a/src/core/utils/commons.mjs +++ b/src/core/utils/commons.mjs @@ -204,6 +204,17 @@ export function displayNotification (title, message, link) { } +/** + * returns the active tab of the currently active window + **/ +export async function getActiveTab() { + return (await browser.tabs.query({ + active: true, + currentWindow: true, + }))[0]; +} + + /** * returns the selected text, if no text is selected it will return an empty string * inspired by https://stackoverflow.com/a/5379408/3771196 diff --git a/src/views/popup/main.mjs b/src/views/popup/main.mjs index 55a4b5b88..431735824 100644 --- a/src/views/popup/main.mjs +++ b/src/views/popup/main.mjs @@ -1,5 +1,9 @@ +import { getActiveTab } from "/core/utils/commons.mjs"; + import ExclusionService from "/core/services/exclusion-service.mjs"; +import HostPermissionService from "/core/services/host-permission-service.mjs"; + import ConfigManager from "/core/services/config-manager.mjs"; import DefaultConfig from "/resources/configs/defaults.mjs"; @@ -10,6 +14,8 @@ const Config = new ConfigManager({ const Exclusions = new ExclusionService(); +const HostPermissions = new HostPermissionService(); + Promise.all([ getActiveTab(), Config.loaded, @@ -38,7 +44,7 @@ function main(args) { settingsButton.addEventListener('click', openSettings); const permissionRequestButton = document.getElementById('permissionRequestButton'); permissionRequestButton.title = browser.i18n.getMessage('popupMissingPermissionButtonTooltip'); - permissionRequestButton.addEventListener('click', requestGlobalPermissions); + permissionRequestButton.addEventListener('click', HostPermissions.requestGlobalPermission); const restrictedPageWarningText = document.getElementById('restrictedPageWarningText'); restrictedPageWarningText.textContent = browser.i18n.getMessage('popupProhibitedPageWarning', shortUrl); const domainActivationButton = document.getElementById('domainActivationButton'); @@ -58,10 +64,10 @@ async function onPermissionChange() { const [ _hasGlobalPermission, - _isRestrictedPage, + _hasTabPermission, ] = await Promise.all([ - hasGlobalPermission(), - isRestrictedPage(activeTab), + HostPermissions.hasGlobalPermission(), + HostPermissions.hasTabPermission(activeTab.id), ]); // warnings: @@ -72,7 +78,7 @@ async function onPermissionChange() { hasWarning ||= !permissionRequestButton.hidden; const restrictedPageWarning = document.getElementById('restrictedPageWarning'); - restrictedPageWarning.hidden = hasWarning || !_isRestrictedPage; + restrictedPageWarning.hidden = hasWarning || _hasTabPermission; hasWarning ||= !restrictedPageWarning.hidden; // exclusion toggle (only show when no warnings): @@ -104,13 +110,6 @@ function openSettings() { window.close(); } -async function getActiveTab() { - return (await browser.tabs.query({ - active: true, - currentWindow: true, - }))[0]; -} - function toShortURL(url) { if (url.protocol === 'about:') { return url.protocol + url.pathname; @@ -125,26 +124,3 @@ function toShortURL(url) { return url.hostname || url.origin; } } - -function hasGlobalPermission() { - return browser.permissions.contains({ - origins: [''] - }); -} - -function requestGlobalPermissions() { - return browser.permissions.request({ - origins: [''] - }); -} - -async function isRestrictedPage(tab) { - // workaround to find out if the page is restricted - try { - await browser.tabs.sendMessage(tab.id, true); - return false; - } - catch(e) { - return true; - } -} From c1374b8298c4c16ac8e89cc9e109b2b9d848b9f2 Mon Sep 17 00:00:00 2001 From: Robbendebiene Date: Wed, 3 Jul 2024 12:28:07 +0200 Subject: [PATCH 17/21] Display permission state in the browser action icon --- src/core/background.mjs | 42 ++++++++++++++++++++++++++++++++++------- 1 file changed, 35 insertions(+), 7 deletions(-) diff --git a/src/core/background.mjs b/src/core/background.mjs index cbc7b174b..3c91e181f 100644 --- a/src/core/background.mjs +++ b/src/core/background.mjs @@ -1,6 +1,6 @@ -import { displayNotification } from "/core/utils/commons.mjs"; +import { displayNotification, getActiveTab } from "/core/utils/commons.mjs"; -import ConfigManager from "/core/helpers/config-manager.mjs"; +import ConfigManager from "/core/services/config-manager.mjs"; import Gesture from "/core/models/gesture.mjs"; @@ -8,6 +8,10 @@ import Command from "/core/models/command.mjs"; import DefaultConfig from "/resources/configs/defaults.mjs"; +import ExclusionService from "/core/services/exclusion-service.mjs"; + +import HostPermissionService from "/core/services/host-permission-service.mjs"; + import { getClosestGestureByPattern } from "/core/utils/matching-algorithms.mjs"; import "/core/helpers/message-router.mjs"; @@ -22,6 +26,9 @@ const Config = new ConfigManager({ Config.loaded.then(updateVariablesOnConfigChange); Config.addEventListener("change", updateVariablesOnConfigChange); +const Exclusions = new ExclusionService(); +const HostPermissions = new HostPermissionService(); + const MouseGestures = new Set(); let RockerGestureLeft, RockerGestureRight, WheelGestureUp, WheelGestureDown; @@ -154,12 +161,33 @@ browser.runtime.onMessage.addListener((message, sender, sendResponse) => { /** - * Handle browser action click - * Open Gesturefy options page + * Listen for tab, permission and exclusion changes + * Set the browser action icon to enabled or disabled state **/ -browser.browserAction.onClicked.addListener(() => { - browser.runtime.openOptionsPage(); -}); +browser.tabs.onUpdated.addListener((tabId, changeInfo, tab) => { + if (tab.active) { + handleBrowserActionIcon(); + } +}, { properties: ["url", "status"] }); +browser.tabs.onActivated.addListener(handleBrowserActionIcon); +HostPermissions.addEventListener("change", handleBrowserActionIcon); +Exclusions.loaded.then(handleBrowserActionIcon); +Exclusions.addEventListener("change", handleBrowserActionIcon); +// on initial run +handleBrowserActionIcon(); + +async function handleBrowserActionIcon() { + const activeTab = await getActiveTab(); + const hasPermission = + Exclusions.isEnabledFor(activeTab) && + (await HostPermissions.hasTabPermission(activeTab.id)); + + browser.action.setIcon({ + path: hasPermission + ? "/resources/img/icon.svg" + : "/resources/img/icon_deactivated.svg" + }); +} /** From 7b55b050a46dcf18f9054f700917e50d2bdfa3dd Mon Sep 17 00:00:00 2001 From: Robbendebiene Date: Fri, 5 Jul 2024 09:17:51 +0200 Subject: [PATCH 18/21] Update exclusion service It now works with urls instead of tabs and globs instead of regex The latter ensures backwards compatibility and allows a potential change to the dynamic content script API in the future --- src/core/background.mjs | 2 +- src/core/services/exclusion-service.mjs | 87 +++++++++++++++---------- src/views/popup/main.mjs | 20 +++--- 3 files changed, 63 insertions(+), 46 deletions(-) diff --git a/src/core/background.mjs b/src/core/background.mjs index 3c91e181f..7ab8e0869 100644 --- a/src/core/background.mjs +++ b/src/core/background.mjs @@ -179,7 +179,7 @@ handleBrowserActionIcon(); async function handleBrowserActionIcon() { const activeTab = await getActiveTab(); const hasPermission = - Exclusions.isEnabledFor(activeTab) && + Exclusions.isEnabledFor(activeTab.url) && (await HostPermissions.hasTabPermission(activeTab.id)); browser.action.setIcon({ diff --git a/src/core/services/exclusion-service.mjs b/src/core/services/exclusion-service.mjs index c2f6e8690..79336cf3e 100644 --- a/src/core/services/exclusion-service.mjs +++ b/src/core/services/exclusion-service.mjs @@ -1,7 +1,12 @@ +import { isURL } from "/core/utils/commons.mjs"; + import BaseEventListener from "/core/services/base-event-listener.mjs"; /** - * Service for adding and removing exclusions + * Service for adding and removing exclusions. + * + * Provides synchronous methods for adding, removing and checking globs/match patterns. + * This will also automatically update the underlying storage and update itself whenever the underlying storage changes. **/ export default class ExclusionService extends BaseEventListener { constructor () { @@ -18,7 +23,7 @@ export default class ExclusionService extends BaseEventListener { this._loaded.then((value) => { const exclusions = value['Exclusions']; if (Array.isArray(exclusions) && this._exclusions.length === 0) { - this._exclusions = this._fromStorageJSON(exclusions); + this._exclusions = exclusions; } }); } @@ -28,66 +33,66 @@ export default class ExclusionService extends BaseEventListener { const newExclusions = changes['Exclusions'].newValue; const oldExclusions = changes['Exclusions'].oldValue; // check for any changes - if (newExclusions.length !== oldExclusions.length || + if (newExclusions?.length !== oldExclusions?.length || newExclusions.some((val, i) => val !== oldExclusions[i]) ) { - this._exclusions = this._fromStorageJSON(newExclusions); + this._exclusions = newExclusions; // execute event callbacks this._events.get('change').forEach((callback) => callback(newExclusions)); } } } - _fromStorageJSON(rawExclusions) { - return rawExclusions.map((string) => new RegExp(string)); - } - - _toStorageJSON() { - return this._exclusions.map((pattern) => pattern.source); - } - + /** + * Promise that resolves when the initial data from the storage is loaded. + **/ get loaded () { return this._loaded; } - isEnabledFor(tab) { - return !this.isDisabledFor(tab); + isEnabledFor(url) { + return !this.isDisabledFor(url); } - isDisabledFor(tab) { + isDisabledFor(url) { return this._exclusions.some( - (pattern) => pattern.test(tab.url) + (glob) => this._globToRegex(glob).test(url) ); } /** - * Removes the first exclusion that matches the given tab's URL + * Removes all exclusions that match the given URL **/ - enableFor(tab) { - // find first pattern that matches the tab url - const index = this._exclusions.findIndex( - (pattern) => pattern.test(tab.url) + enableFor(url) { + if (!isURL(url)) { + return; + } + const tailoredExclusions = this._exclusions.filter( + (glob) => !this._globToRegex(glob).test(url) ); - if (index > -1) { - this._exclusions.splice(index, 1); - return browser.storage.local.set({'Exclusions': this._toStorageJSON(this._exclusions)}); + if (tailoredExclusions.length < this._exclusions.length) { + this._exclusions = tailoredExclusions; + return browser.storage.local.set({'Exclusions': this._exclusions}); } } /** - * Adds an exclusion for the domain of the given tab if there isn't a matching one already. + * Adds an exclusion for the domain of the given URL if there isn't a matching one already. **/ - disableFor(tab) { - if (this.isDisabledFor(tab)) { + disableFor(url) { + if (!isURL(url) || this.isDisabledFor(url)) { return; } - const domain = new URL(tab.url).origin; - // escape special regex characters - const escapedDomain = domain.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, match => '\\'+match); - // ^ matches beginning of input and $ matches ending of input - const pattern = new RegExp('^'+escapedDomain+'.*'+'$'); - this._exclusions.push(pattern); - return browser.storage.local.set({'Exclusions': this._toStorageJSON(this._exclusions)}); + const urlObj = new URL(url); + let globPattern; + if (urlObj.protocol === 'file:') { + globPattern = urlObj.href; + } + else { + globPattern = `*://${urlObj.hostname}/*` + } + this._exclusions.push(globPattern); + return browser.storage.local.set({'Exclusions': this._exclusions}); } /** @@ -96,4 +101,18 @@ export default class ExclusionService extends BaseEventListener { dispose() { browser.storage.onChanged.removeListener(this._listener); } + + /** + * Converts a glob/url pattern to a RegExp. + **/ + _globToRegex(glob) { + // match special regex characters + const pattern = glob.replace( + /[-[\]{}()*+?.,\\^$|#\s]/g, + // replace * with .* -> matches anything 0 or more times, else escape character + (match) => match === '*' ? '.*' : '\\'+match, + ); + // ^ matches beginning of input and $ matches ending of input + return new RegExp('^'+pattern+'$'); + } } diff --git a/src/views/popup/main.mjs b/src/views/popup/main.mjs index 431735824..0adff533b 100644 --- a/src/views/popup/main.mjs +++ b/src/views/popup/main.mjs @@ -26,15 +26,14 @@ let activeTab; function main(args) { [activeTab] = args; - const tabUrl = new URL(activeTab.url); - const shortUrl = toShortURL(tabUrl); + const shortUrl = toShortURL(activeTab.url); // insert text from language files for (let element of document.querySelectorAll('[data-i18n]')) { element.textContent = browser.i18n.getMessage(element.dataset.i18n); } // register permission change handler and run it initially - browser.permissions.onRemoved.addListener(onPermissionChange); - browser.permissions.onAdded.addListener(onPermissionChange); + HostPermissions.addEventListener('change', onPermissionChange); + Exclusions.addEventListener('change', onPermissionChange); onPermissionChange(); // apply theme class const themeValue = Config.get("Settings.General.theme"); @@ -59,8 +58,7 @@ function main(args) { // handlers \\ async function onPermissionChange() { - const tabUrl = new URL(activeTab.url); - const shortUrl = toShortURL(tabUrl); + const shortUrl = toShortURL(activeTab.url); const [ _hasGlobalPermission, @@ -82,7 +80,7 @@ async function onPermissionChange() { hasWarning ||= !restrictedPageWarning.hidden; // exclusion toggle (only show when no warnings): - const isActive = Exclusions.isEnabledFor(activeTab); + const isActive = Exclusions.isEnabledFor(activeTab.url); const domainActivationButton = document.getElementById('domainActivationButton'); domainActivationButton.hidden = hasWarning; domainActivationButton.title = isActive @@ -93,14 +91,13 @@ async function onPermissionChange() { } function onDomainToggle(event) { - if (Exclusions.isEnabledFor(activeTab)) { - Exclusions.disableFor(activeTab); + if (Exclusions.isEnabledFor(activeTab.url)) { + Exclusions.disableFor(activeTab.url); } else { - Exclusions.enableFor(activeTab); + Exclusions.enableFor(activeTab.url); } event.preventDefault(); - onPermissionChange(); } // methods \\ @@ -111,6 +108,7 @@ function openSettings() { } function toShortURL(url) { + url = new URL(url); if (url.protocol === 'about:') { return url.protocol + url.pathname; } From 27c9cfc9d0c3e31c305994b61b987d2bd2fac1b7 Mon Sep 17 00:00:00 2001 From: Robbendebiene Date: Fri, 5 Jul 2024 09:18:58 +0200 Subject: [PATCH 19/21] Improve host permission test function --- src/core/services/host-permission-service.mjs | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) diff --git a/src/core/services/host-permission-service.mjs b/src/core/services/host-permission-service.mjs index 857431723..7373e17f3 100644 --- a/src/core/services/host-permission-service.mjs +++ b/src/core/services/host-permission-service.mjs @@ -46,13 +46,20 @@ export default class HostPermissionService extends BaseEventListener { * * The add-on might be restricted due to missing host permissions or because the tab holds a privileged URL. **/ - async hasTabPermission(tabId) { - // workaround to find out if the page is restricted + async hasTabPermission(tabOrId) { + // see: https://discourse.mozilla.org/t/detect-whether-extension-has-host-permission-for-active-tab/120501/2 + const tab = Number.isInteger(tabOrId) + ? await browser.tabs.get(tabOrId) + : tabOrId; try { - await browser.tabs.sendMessage(tabId, true); - return true; + return tab.url + ? await browser.permissions.contains({ + origins: [tab.url] + }) + : false; } - catch(e) { + // catch error that occurs for special urls like about: + catch { return false; } } From ac06d0cb37ce288e2f17b73befc6fe79fab6ed9e Mon Sep 17 00:00:00 2001 From: Robbendebiene Date: Fri, 5 Jul 2024 09:23:49 +0200 Subject: [PATCH 20/21] Bring back exclusion functionality to content scripts So far there is now way to do this via browser functionality, or dynamic content script registration. See also https://github.com/w3c/webextensions/issues/653 --- src/core/bundle/content.bundle.js | 255 +++++++++++++++++++++++++++--- src/core/content.mjs | 54 ++++--- 2 files changed, 268 insertions(+), 41 deletions(-) diff --git a/src/core/bundle/content.bundle.js b/src/core/bundle/content.bundle.js index f476a4547..6ef542b79 100644 --- a/src/core/bundle/content.bundle.js +++ b/src/core/bundle/content.bundle.js @@ -45,6 +45,20 @@ function toSingleButton (pressedButton) { } +/** + * check if string is an url + **/ +function isURL (string) { + try { + new URL(string); + } + catch (e) { + return false; + } + return true; +} + + /** * returns the selected text, if no text is selected it will return an empty string * inspired by https://stackoverflow.com/a/5379408/3771196 @@ -767,9 +781,196 @@ var DefaultConfig = Object.freeze({ } } } - ] + ], + "Exclusions": [] }); +/** + * Abstract class that can be used to implement basic event listener functionality. + **/ +class BaseEventListener { + /** + * Requires an array of event specifiers as strings that can later be used to call and register events. + **/ + constructor (events) { + // holds all custom event callbacks + this._events = new Map( + events.map((e) => [e, new Set()]) + ); + } + + /** + * Adds an event listener. + * Requires an event specifier as a string and a callback method. + **/ + addEventListener (event, callback) { + this._validateEventParameter(event); + this._validateCallbackParameter(callback); + this._events.get(event).add(callback); + } + + /** + * Checks if an event listener exists. + * Requires an event specifier as a string and a callback method. + **/ + hasEventListener (event, callback) { + this._validateEventParameter(event); + this._validateCallbackParameter(callback); + this._events.get(event).has(callback); + } + + /** + * Removes an event listener. + * Requires an event specifier as a string and a callback method. + **/ + removeEventListener (event, callback) { + this._validateEventParameter(event); + this._validateCallbackParameter(callback); + this._events.get(event).delete(callback); + } + + /** + * Remove all event listeners for the given event. + **/ + clearEventListeners(event) { + this._validateEventParameter(event); + this._events.get(event).clear(); + } + + /** + * Validate event parameter. + **/ + _validateEventParameter (event) { + if (!this._events.has(event)) { + throw "The first argument is not a valid event."; + } + } + + /** + * Validate callback parameter. + **/ + _validateCallbackParameter (callback) { + if (typeof callback !== "function") { + throw "The second argument must be a function."; + } + } +} + +/** + * Service for adding and removing exclusions. + * + * Provides synchronous methods for adding, removing and checking globs/match patterns. + * This will also automatically update the underlying storage and update itself whenever the underlying storage changes. + **/ +class ExclusionService extends BaseEventListener { + constructor () { + // set available event specifiers + super(['change']); + // empty array as default value so the config doesn't have to be loaded + this._exclusions = []; + // setup on storage change handler + this._listener = this._storageChangeHandler.bind(this); + browser.storage.onChanged.addListener(this._listener); + // load initial storage data + this._loaded = browser.storage.local.get('Exclusions'); + // store exclusions when loaded + this._loaded.then((value) => { + const exclusions = value['Exclusions']; + if (Array.isArray(exclusions) && this._exclusions.length === 0) { + this._exclusions = exclusions; + } + }); + } + + _storageChangeHandler(changes, areaName) { + if (areaName === 'local' && changes.hasOwnProperty('Exclusions')) { + const newExclusions = changes['Exclusions'].newValue; + const oldExclusions = changes['Exclusions'].oldValue; + // check for any changes + if (newExclusions?.length !== oldExclusions?.length || + newExclusions.some((val, i) => val !== oldExclusions[i]) + ) { + this._exclusions = newExclusions; + // execute event callbacks + this._events.get('change').forEach((callback) => callback(newExclusions)); + } + } + } + + /** + * Promise that resolves when the initial data from the storage is loaded. + **/ + get loaded () { + return this._loaded; + } + + isEnabledFor(url) { + return !this.isDisabledFor(url); + } + + isDisabledFor(url) { + return this._exclusions.some( + (glob) => this._globToRegex(glob).test(url) + ); + } + + /** + * Removes all exclusions that match the given URL + **/ + enableFor(url) { + if (!isURL(url)) { + return; + } + const tailoredExclusions = this._exclusions.filter( + (glob) => !this._globToRegex(glob).test(url) + ); + if (tailoredExclusions.length < this._exclusions.length) { + this._exclusions = tailoredExclusions; + return browser.storage.local.set({'Exclusions': this._exclusions}); + } + } + + /** + * Adds an exclusion for the domain of the given URL if there isn't a matching one already. + **/ + disableFor(url) { + if (!isURL(url) || this.isDisabledFor(url)) { + return; + } + const urlObj = new URL(url); + let globPattern; + if (urlObj.protocol === 'file:') { + globPattern = urlObj.href; + } + else { + globPattern = `*://${urlObj.hostname}/*`; + } + this._exclusions.push(globPattern); + return browser.storage.local.set({'Exclusions': this._exclusions}); + } + + /** + * Cleanup service resources and dependencies + **/ + dispose() { + browser.storage.onChanged.removeListener(this._listener); + } + + /** + * Converts a glob/url pattern to a RegExp. + **/ + _globToRegex(glob) { + // match special regex characters + const pattern = glob.replace( + /[-[\]{}()*+?.,\\^$|#\s]/g, + // replace * with .* -> matches anything 0 or more times, else escape character + (match) => match === '*' ? '.*' : '\\'+match, + ); + // ^ matches beginning of input and $ matches ending of input + return new RegExp('^'+pattern+'$'); + } +} + // global static variables const LEFT_MOUSE_BUTTON$2 = 1; @@ -2362,12 +2563,19 @@ window.getClosestElement = getClosestElement; const IS_EMBEDDED_FRAME = isEmbeddedFrame(); +const Exclusions = new ExclusionService(); + Exclusions.addEventListener("change", main); + const Config = new ConfigManager({ - defaults: DefaultConfig, - autoUpdate: true -}); -Config.loaded.then(main); -Config.addEventListener("change", main); + defaults: DefaultConfig, + autoUpdate: true + }); + Config.addEventListener("change", main); + +Promise.all([ + Config.loaded, + Exclusions.loaded +]).then(main); // re-run main function if event listeners got removed // this is a workaround for https://bugzilla.mozilla.org/show_bug.cgi?id=1726978 @@ -2580,9 +2788,7 @@ function handleRockerAndWheelEvents (subject, event) { * Applies the user config to the particular controller or interface * Enables or disables the appropriate controller **/ -async function main () { - await Config.loaded; - +function main () { // apply hidden settings if (Config.has("Settings.Gesture.patternDifferenceThreshold")) { patternConstructor.differenceThreshold = Config.get("Settings.Gesture.patternDifferenceThreshold"); @@ -2612,22 +2818,29 @@ async function main () { PopupCommandView.theme = Config.get("Settings.General.theme"); - // enable mouse gesture controller - MouseGestureController.enable(); + if (Exclusions.isEnabledFor(window.location.href)) { + // enable mouse gesture controller + MouseGestureController.enable(); - // enable/disable rocker gesture - if (Config.get("Settings.Rocker.active")) { - RockerGestureController.enable(); - } - else { - RockerGestureController.disable(); - } + // enable/disable rocker gesture + if (Config.get("Settings.Rocker.active")) { + RockerGestureController.enable(); + } + else { + RockerGestureController.disable(); + } - // enable/disable wheel gesture - if (Config.get("Settings.Wheel.active")) { - WheelGestureController.enable(); + // enable/disable wheel gesture + if (Config.get("Settings.Wheel.active")) { + WheelGestureController.enable(); + } + else { + WheelGestureController.disable(); + } } else { + MouseGestureController.disable(); + RockerGestureController.disable(); WheelGestureController.disable(); } } diff --git a/src/core/content.mjs b/src/core/content.mjs index 997dcc7d3..a97e262af 100644 --- a/src/core/content.mjs +++ b/src/core/content.mjs @@ -4,6 +4,8 @@ import ConfigManager from "/core/services/config-manager.mjs"; import DefaultConfig from "/resources/configs/defaults.mjs"; +import ExclusionService from "/core/services/exclusion-service.mjs"; + import MouseGestureController from "/core/controllers/mouse-gesture-controller.mjs"; import RockerGestureController from "/core/controllers/rocker-gesture-controller.mjs"; @@ -32,12 +34,19 @@ window.getClosestElement = getClosestElement; const IS_EMBEDDED_FRAME = isEmbeddedFrame(); +const Exclusions = new ExclusionService(); + Exclusions.addEventListener("change", main); + const Config = new ConfigManager({ - defaults: DefaultConfig, - autoUpdate: true -}); -Config.loaded.then(main); -Config.addEventListener("change", main); + defaults: DefaultConfig, + autoUpdate: true + }); + Config.addEventListener("change", main); + +Promise.all([ + Config.loaded, + Exclusions.loaded +]).then(main); // re-run main function if event listeners got removed // this is a workaround for https://bugzilla.mozilla.org/show_bug.cgi?id=1726978 @@ -250,9 +259,7 @@ function handleRockerAndWheelEvents (subject, event) { * Applies the user config to the particular controller or interface * Enables or disables the appropriate controller **/ -async function main () { - await Config.loaded; - +function main () { // apply hidden settings if (Config.has("Settings.Gesture.patternDifferenceThreshold")) { patternConstructor.differenceThreshold = Config.get("Settings.Gesture.patternDifferenceThreshold"); @@ -282,22 +289,29 @@ async function main () { PopupCommandView.theme = Config.get("Settings.General.theme"); - // enable mouse gesture controller - MouseGestureController.enable(); + if (Exclusions.isEnabledFor(window.location.href)) { + // enable mouse gesture controller + MouseGestureController.enable(); - // enable/disable rocker gesture - if (Config.get("Settings.Rocker.active")) { - RockerGestureController.enable(); - } - else { - RockerGestureController.disable(); - } + // enable/disable rocker gesture + if (Config.get("Settings.Rocker.active")) { + RockerGestureController.enable(); + } + else { + RockerGestureController.disable(); + } - // enable/disable wheel gesture - if (Config.get("Settings.Wheel.active")) { - WheelGestureController.enable(); + // enable/disable wheel gesture + if (Config.get("Settings.Wheel.active")) { + WheelGestureController.enable(); + } + else { + WheelGestureController.disable(); + } } else { + MouseGestureController.disable(); + RockerGestureController.disable(); WheelGestureController.disable(); } } From 78b2d64cb23279709b10ba0b8f113fee656bfca6 Mon Sep 17 00:00:00 2001 From: Robbendebiene Date: Fri, 5 Jul 2024 11:16:15 +0200 Subject: [PATCH 21/21] Fix restricted page warning --- src/_locales/en/messages.json | 10 ++-------- src/core/background.mjs | 3 ++- src/views/popup/main.mjs | 30 ++++++++++++++++++++---------- 3 files changed, 24 insertions(+), 19 deletions(-) diff --git a/src/_locales/en/messages.json b/src/_locales/en/messages.json index a0aff5bdf..beabea529 100644 --- a/src/_locales/en/messages.json +++ b/src/_locales/en/messages.json @@ -1679,14 +1679,8 @@ }, "popupProhibitedPageWarning": { - "message": "Add-ons are prohibited on: $URL$", - "description": "Add-ons are prohibited on: $URL$", - "placeholders": { - "url" : { - "content" : "$1", - "example" : "www.example.com" - } - } + "message": "Add-ons are prohibited on this page", + "description": "Add-ons are prohibited on this page" }, "popupMissingPermissionButton": { "message": "Gesturefy requires additional permissions", diff --git a/src/core/background.mjs b/src/core/background.mjs index 7ab8e0869..6700794e3 100644 --- a/src/core/background.mjs +++ b/src/core/background.mjs @@ -179,8 +179,9 @@ handleBrowserActionIcon(); async function handleBrowserActionIcon() { const activeTab = await getActiveTab(); const hasPermission = + activeTab.url != null && Exclusions.isEnabledFor(activeTab.url) && - (await HostPermissions.hasTabPermission(activeTab.id)); + (await HostPermissions.hasTabPermission(activeTab)); browser.action.setIcon({ path: hasPermission diff --git a/src/views/popup/main.mjs b/src/views/popup/main.mjs index 0adff533b..4ded958cd 100644 --- a/src/views/popup/main.mjs +++ b/src/views/popup/main.mjs @@ -26,7 +26,6 @@ let activeTab; function main(args) { [activeTab] = args; - const shortUrl = toShortURL(activeTab.url); // insert text from language files for (let element of document.querySelectorAll('[data-i18n]')) { element.textContent = browser.i18n.getMessage(element.dataset.i18n); @@ -45,11 +44,16 @@ function main(args) { permissionRequestButton.title = browser.i18n.getMessage('popupMissingPermissionButtonTooltip'); permissionRequestButton.addEventListener('click', HostPermissions.requestGlobalPermission); const restrictedPageWarningText = document.getElementById('restrictedPageWarningText'); - restrictedPageWarningText.textContent = browser.i18n.getMessage('popupProhibitedPageWarning', shortUrl); + // omit passing the short url here because we only reliably get the url for tabs where the add-on has host permissions + // we never get host permissions for e.g. about: or moz-extension: so we cannot retrieve/show the url + // we would require the "tabs" permission to consistently retrieve all urls + restrictedPageWarningText.textContent = browser.i18n.getMessage('popupProhibitedPageWarning'); const domainActivationButton = document.getElementById('domainActivationButton'); domainActivationButton.style.setProperty('--favicon-url', `url(${activeTab.favIconUrl})`); const domainActivationButtonText = document.getElementById('domainActivationButtonText'); - domainActivationButtonText.textContent = browser.i18n.getMessage('popupExclusionsToggleButton', shortUrl); + domainActivationButtonText.textContent = browser.i18n.getMessage( + 'popupExclusionsToggleButton', toShortURL(activeTab.url) + ); // use click instead of change to prevent default const domainActivationButtonToggle = document.getElementById('domainActivationButtonToggle'); domainActivationButtonToggle.addEventListener('click', onDomainToggle); @@ -58,14 +62,12 @@ function main(args) { // handlers \\ async function onPermissionChange() { - const shortUrl = toShortURL(activeTab.url); - const [ _hasGlobalPermission, _hasTabPermission, ] = await Promise.all([ HostPermissions.hasGlobalPermission(), - HostPermissions.hasTabPermission(activeTab.id), + HostPermissions.hasTabPermission(activeTab), ]); // warnings: @@ -83,9 +85,12 @@ async function onPermissionChange() { const isActive = Exclusions.isEnabledFor(activeTab.url); const domainActivationButton = document.getElementById('domainActivationButton'); domainActivationButton.hidden = hasWarning; - domainActivationButton.title = isActive - ? browser.i18n.getMessage('popupExclusionsToggleButtonOnTooltip', shortUrl) - : browser.i18n.getMessage('popupExclusionsToggleButtonOffTooltip', shortUrl); + domainActivationButton.title = browser.i18n.getMessage( + isActive + ? 'popupExclusionsToggleButtonOnTooltip' + : 'popupExclusionsToggleButtonOffTooltip', + toShortURL(activeTab.url) + ); const domainActivationButtonToggle = document.getElementById('domainActivationButtonToggle'); domainActivationButtonToggle.checked = isActive; } @@ -108,7 +113,12 @@ function openSettings() { } function toShortURL(url) { - url = new URL(url); + try { + url = new URL(url); + } + catch(e) { + return url; + } if (url.protocol === 'about:') { return url.protocol + url.pathname; }