Experiment API to set default search engine

ghostery · chrmod · Oct 15, 2020 · Oct 15, 2020 · Oct 15, 2020 · Oct 15, 2020
commit 5b69f2f88670e52fe0c05f19b3d7c00c7ae6bb55
diff --git a/src/experiment_apis/ghostery_parent.js b/src/experiment_apis/ghostery_parent.js
@@ -0,0 +1,24 @@
+const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");
+const { ExtensionError } = ExtensionUtils;
+
+global.ghostery = class extends ExtensionCommon.ExtensionAPI {
+  getAPI(context) {
+    return {
+      ghostery: {
+        async setDefaultSearchEngine(searchEngineName) {
+          if (!Services.search.isInitialized) {
+            await Services.search.init();
+          }
+
+          const searchEngine = Services.search.getEngineByName(searchEngineName);
+
+          if (!searchEngine) {
+            throw new ExtensionError(`No search engine with name "${searchEngineName}"`)
+          }
+
+          Services.search.defaultEngine = searchEngine;
+        },
+      }
+    }
+  }
+};
diff --git a/src/experiment_apis/ghostery_schema.json b/src/experiment_apis/ghostery_schema.json
@@ -0,0 +1,20 @@
+[{
+  "namespace": "ghostery",
+  "description": "API giving overring various low level functionalities",
-  "description": "API giving overring various low level functionalities",
+  "description": "API to change the default search engine",
-  "description": "API giving overring various low level functionalities",
+  "description": "API to change the default search engine",
+  "functions": [
+  {
+    "name": "setDefaultSearchEngine",
+    "type": "function",
+    "description": "Sets a default search engine",
+    "async": true,
+    "parameters": [
+      {
+        "name": "searchEngineName",
+        "type": "string"
+      }
+    ]
+  }
+  ],
+  "events": [
+  ]
+}]
diff --git a/src/manifest.json b/src/manifest.json
@@ -33,5 +33,15 @@
       "favicon_url": "https://ghosterysearch.com/img/favicon-32x32.png",
       "is_default": true
     }
+  },
+  "experiment_apis": {
+    "ghostery": {
+      "schema": "experiment_apis/ghostery_schema.json",
+      "parent": {
+        "scopes": ["addon_parent"],
+        "paths": [["ghostery"]],
+        "script": "experiment_apis/ghostery_parent.js"
+      }
+    }
   }
 }
diff --git a/src/pages/choice-screen.html b/src/pages/choice-screen.html
@@ -3,6 +3,7 @@
   <head>
     <title>Search Engine Choice</title>
     <meta charset="UTF-8" />
+    <script src="common.js"></script>
     <style>
       @font-face {
         font-family: Roboto;
@@ -128,7 +129,7 @@
       <h1>Welcome! Choose you default search</h1>
       <h2>Pick a default search engine for all your searches.</h2>
       <div class="engines">
-        <a class="engine">
+        <a class="engine" data-name="Ghostery Search">
           <div class="radio">
             <img class="radio-off" src="../assets/radio-off.png" />
             <img class="radio-on" src="../assets/radio-on.png" />
@@ -140,7 +141,7 @@ <h2>Pick a default search engine for all your searches.</h2>
           </div>
           <div class="spacer"></div>
         </a>
-        <a class="engine">
+        <a class="engine" data-name="StartPage">
           <div class="radio">
             <img class="radio-off" src="../assets/radio-off.png" />
             <img class="radio-on" src="../assets/radio-on.png" />
@@ -151,7 +152,7 @@ <h2>Pick a default search engine for all your searches.</h2>
           </div>
           <div class="spacer"></div>
         </a>
-        <a class="engine">
+        <a class="engine" data-name="Bing">
           <div class="radio">
             <img class="radio-off" src="../assets/radio-off.png" />
             <img class="radio-on" src="../assets/radio-on.png" />
@@ -162,7 +163,7 @@ <h2>Pick a default search engine for all your searches.</h2>
           </div>
           <div class="spacer"></div>
         </a>
-        <a class="engine">
+        <a class="engine" data-name="Yahoo">
           <div class="radio">
             <img class="radio-off" src="../assets/radio-off.png" />
             <img class="radio-on" src="../assets/radio-on.png" />

diff --git a/src/pages/common.js b/src/pages/common.js
@@ -0,0 +1,13 @@
+document.addEventListener('DOMContentLoaded', () => {
+  const engines = [...document.querySelectorAll('.engine')];
+  engines.forEach(engine => {
+    engine.addEventListener('click', async () => {
+      const name = engine.dataset.name;
+      try {
+        await browser.ghostery.setDefaultSearchEngine(name);
+      } catch(e) {
+        console.error(e);
+      }
+    });
+  });
+});