Gesturefy v4 (Port to manifest v3)

README.md

@@ -4,7 +4,7 @@
 [<img align="right" src="https://img.shields.io/github/license/robbendebiene/gesturefy.svg">](https://github.com/Robbendebiene/Gesturefy/blob/master/LICENSE)
 
 
-# <sub><img src="https://github.com/Robbendebiene/Gesturefy/blob/master/src/resources/img/iconx48.png" height="38" width="38"></sub>esturefy
+# <sub><img src="https://github.com/Robbendebiene/Gesturefy/blob/master/src/resources/img/icon.svg" height="38" width="38"></sub>esturefy
 
 #### [<img height="60" align="right" src="https://blog.mozilla.org/addons/files/2020/04/get-the-addon-fx-apr-2020.svg">](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.
 

src/_locales/en/messages.json

@@ -37,9 +37,9 @@
     "message": "Extras",
     "description": "Extras"
   },
-  "navigationExclusions": {
-    "message": "Exclusions",
-    "description": "Exclusions"
+  "navigationData": {
+    "message": "Data",
+    "description": "Data"
   },
   "navigationAbout": {
     "message": "About",
@@ -289,44 +289,106 @@
     "description": "The minimal amount the mouse wheel must be scrolled until the gesture is triggered."
   },
 
-  "exclusionsLabelInformation": {
-    "message": "Information:",
-    "description": "Information:"
+  "dataLabelFileBackup": {
+    "message": "Backup to file",
+    "description": "Backup to file"
   },
-  "exclusionsTextInformation": {
-    "message": "Add URL match patterns to disable Gesturefy for certain websites. The match pattern allows \"*\" wildcards and must be in the form of <scheme>://<host><path>.",
-    "description": "Add URL match patterns to disable Gesturefy for certain websites. The match pattern allows \"*\" wildcards and must be in the form of <scheme>://<host><path>."
+  "dataLabelFileRestore": {
+    "message": "Restore from file",
+    "description": "Restore from file"
   },
-  "exclusionsPlaceholderURL": {
-    "message": "Enter URL match pattern",
-    "description": "Enter URL match pattern"
+  "dataLabelCloudBackup": {
+    "message": "Backup to cloud",
+    "description": "Backup to cloud"
   },
-  "exclusionsAddButton": {
-    "message": "Add",
-    "description": "Add"
+  "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."
   },
-  "exclusionsNotificationAlreadyExists": {
-    "message": "URL pattern already exists.",
-    "description": "URL pattern already exists."
+  "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."
   },
-  "exclusionsHintNoEntries": {
-    "message": "No entries available",
-    "description": "No entries available"
+  "dataDescriptionResetConfig": {
+    "message": "Resets all settings and gestures to their defaults.",
+    "description": "Resets all settings and gestures to their defaults."
   },
 
-  "aboutBackup": {
+  "dataBackup": {
     "message": "Backup",
     "description": "Backup"
   },
-  "aboutRestore": {
+  "dataRestore": {
     "message": "Restore",
     "description": "Restore"
   },
-  "aboutReset": {
+  "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:"
@@ -348,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"
@@ -1699,5 +1740,52 @@
   "welcomePageLowerSectionLearnMoreLink": {
     "message": "Learn More",
     "description": "Learn More"
+  },
+
+  "popupProhibitedPageWarning": {
+    "message": "Add-ons are prohibited on this page",
+    "description": "Add-ons are prohibited on this page"
+  },
+  "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"
   }
-}
+}

src/core/background.mjs

@@ -1,22 +1,33 @@
-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";
 
 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";
 
 // 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 Exclusions = new ExclusionService();
+const HostPermissions = new HostPermissionService();
 
 const MouseGestures = new Set();
 
@@ -36,7 +47,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"));
-  }
+}
 
 
 /**
@@ -147,12 +158,34 @@ 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 =
+    activeTab.url != null &&
+    Exclusions.isEnabledFor(activeTab.url) &&
+    (await HostPermissions.hasTabPermission(activeTab));
+
+  browser.action.setIcon({
+    path: hasPermission
+      ? "/resources/img/icon.svg"
+      : "/resources/img/icon_deactivated.svg"
+  });
+}
 
 
 /**