Bug 42891: Set the bundled search engine for Tor Browser.

After upstream changes between Firefox 115 and 128, we had to
completely rework the way in which we define our search engines.

This commit replaces the old "Omnibox: Add DDG, Startpage, Disconnect,
Youtube, Twitter; remove Amazon, eBay, bing".

With that commit, we customized a list of addons IDs to ship as
built-in search engines, but then upsteam moved to using only
RemoteSettings.
The configuration has many more fields, and it would be quite long to
include it in the source code. Therefore, we use some local JSON files
and load the settings from them.

browser/components/search/extensions/ddg-onion/manifest.json

+{
+  "name": "DuckDuckGo (.onion)",
+  "description": "Duck Duck Go Onion",
+  "manifest_version": 2,
+  "version": "1.0",
+  "applications": {
+    "gecko": {
+      "id": "ddg-onion@search.mozilla.org"
+    }
+  },
+  "hidden": true,
+  "icons": {
+    "16": "favicon.ico"
+  },
+  "web_accessible_resources": ["favicon.ico"],
+  "chrome_settings_overrides": {
+    "search_provider": {
+      "name": "DuckDuckGo (.onion)",
+      "search_url": "https://duckduckgogg42xjoc72x3sjasowoarfbgcmvfimaftt6twagswzczad.onion",
+      "search_form": "https://duckduckgogg42xjoc72x3sjasowoarfbgcmvfimaftt6twagswzczad.onion/?q={searchTerms}",
+      "search_url_get_params": "q={searchTerms}",
+      "suggest_url": "https://duckduckgogg42xjoc72x3sjasowoarfbgcmvfimaftt6twagswzczad.onion/ac/",
+      "suggest_url_get_params": "q={searchTerms}&type=list"
+    }
+  }
+}

browser/components/search/extensions/ddg/manifest.json

@@ -19,7 +19,7 @@
       "name": "DuckDuckGo",
       "search_url": "https://duckduckgo.com/",
       "search_form": "https://duckduckgo.com/",
-      "search_url_get_params": "t=ffab&q={searchTerms}",
+      "search_url_get_params": "q={searchTerms}",
       "suggest_url": "https://ac.duckduckgo.com/ac/",
       "suggest_url_get_params": "q={searchTerms}&type=list"
     }

browser/components/search/extensions/startpage-onion/manifest.json

+{
+  "name": "Startpage (.onion)",
+  "description": "Startpage Onion",
+  "manifest_version": 2,
+  "version": "1.0",
+  "applications": {
+    "gecko": {
+      "id": "startpage-onion@search.mozilla.org"
+    }
+  },
+  "hidden": true,
+  "icons": {
+    "16": "favicon.png"
+  },
+  "web_accessible_resources": ["favicon.png"],
+  "chrome_settings_overrides": {
+    "search_provider": {
+      "name": "Startpage (.onion)",
+      "search_url": "http://startpagel6srwcjlue4zgq3zevrujfaow726kjytqbbjyrswwmjzcqd.onion/sp/search",
+      "search_form": "http://startpagel6srwcjlue4zgq3zevrujfaow726kjytqbbjyrswwmjzcqd.onion/sp/search/",
+      "search_url_post_params": "q={searchTerms}"
+    }
+  }
+}

browser/components/search/extensions/startpage/manifest.json

+{
+  "name": "Startpage",
+  "description": "Startpage",
+  "manifest_version": 2,
+  "version": "1.0",
+  "applications": {
+    "gecko": {
+      "id": "startpage@search.mozilla.org"
+    }
+  },
+  "hidden": true,
+  "icons": {
+    "16": "favicon.png"
+  },
+  "web_accessible_resources": ["favicon.png"],
+  "chrome_settings_overrides": {
+    "search_provider": {
+      "name": "Startpage",
+      "search_url": "https://www.startpage.com/sp/search",
+      "search_form": "https://www.startpage.com/sp/search/",
+      "search_url_post_params": "q={searchTerms}"
+    }
+  }
+}

toolkit/components/search/AppProvidedSearchEngine.sys.mjs

@@ -84,6 +84,8 @@ class IconHandler {
       await this.#getIconList();
     }
 
+    return this.#iconList.get(engineIdentifier);
+    // eslint-disable-next-line no-unreachable
     let iconRecords = this.#iconList.filter(r =>
       this._identifierMatches(engineIdentifier, r.engineIdentifiers)
     );
@@ -210,12 +212,18 @@ class IconHandler {
    */
   async #getIconList() {
     try {
-      this.#iconList = await this.#iconCollection.get();
+      this.#iconList = new Map(
+        await (
+          await fetch(
+            "chrome://global/content/search/torBrowserSearchEngineIcons.json"
+          )
+        ).json()
+      );
     } catch (ex) {
       console.error(ex);
-      this.#iconList = [];
+      this.#iconList = null;
     }
-    if (!this.#iconList.length) {
+    if (!this.#iconList) {
       console.error("Failed to obtain search engine icon list records");
     }
   }

toolkit/components/search/SearchService.sys.mjs

@@ -81,6 +81,8 @@ export const NON_SPLIT_ENGINE_IDS = [
   "engine-purpose",
   "engine-fr",
   "fixup_search",
+  "ddg-onion",
+  "startpage-onion",
 ];
 
 const TOPIC_LOCALES_CHANGE = "intl:app-locales-changed";
@@ -2598,23 +2600,9 @@ export class SearchService {
   // This is prefixed with _ rather than # because it is
   // called in test_remove_engine_notification_box.js
   async _fetchEngineSelectorEngines() {
-    let searchEngineSelectorProperties = {
-      locale: Services.locale.appLocaleAsBCP47,
-      region: lazy.Region.home || "unknown",
-      channel: lazy.SearchUtils.MODIFIED_APP_CHANNEL,
-      experiment:
-        lazy.NimbusFeatures.searchConfiguration.getVariable("experiment") ?? "",
-      distroID: lazy.SearchUtils.distroID ?? "",
-    };
-
-    for (let [key, value] of Object.entries(searchEngineSelectorProperties)) {
-      this._settings.setMetaDataAttribute(key, value);
-    }
-
-    let { engines, privateDefault } =
-      await this.#engineSelector.fetchEngineConfiguration(
-        searchEngineSelectorProperties
-      );
+    const engines = await (
+      await fetch("chrome://global/content/search/torBrowserSearchEngines.json")
+    ).json();
 
     for (let e of engines) {
       if (!e.webExtension) {
@@ -2647,7 +2635,7 @@ export class SearchService {
       }
     }
 
-    return { engines, privateDefault };
+    return { engines, privateDefault: undefined };
   }
 
   #setDefaultAndOrdersFromSelector(engines, privateDefault) {

toolkit/components/search/content/torBrowserSearchEngineIcons.json

+[
+  ["ddg", "chrome://global/content/search/duckduckgo.ico"],
+  ["ddg-onion", "chrome://global/content/search/duckduckgo.ico"],
+  ["startpage", "chrome://global/content/search/startpage.png"],
+  ["startpage-onion", "chrome://global/content/search/startpage.png"],
+  ["wikipedia", "chrome://global/content/search/wikipedia.ico"]
+]

toolkit/components/search/content/torBrowserSearchEngines.json

+[
+  {
+    "aliases": ["duckduckgo", "ddg"],
+    "name": "DuckDuckGo",
+    "urls": {
+      "search": {
+        "base": "https://duckduckgo.com/",
+        "params": [],
+        "searchTermParamName": "q"
+      }
+    },
+    "id": "04e99a38-13ee-47d8-8aa4-64482b3dea99",
+    "identifier": "ddg",
+    "recordType": "engine",
+    "variants": []
+  },
+  {
+    "aliases": ["ddgonion"],
+    "name": "DuckDuckGo (.onion)",
+    "urls": {
+      "search": {
+        "base": "https://duckduckgogg42xjoc72x3sjasowoarfbgcmvfimaftt6twagswzczad.onion/",
+        "params": [],
+        "searchTermParamName": "q"
+      }
+    },
+    "id": "1e431da4-a60c-4411-9251-a95a841d451f",
+    "identifier": "ddg-onion",
+    "recordType": "engine",
+    "variants": []
+  },
+  {
+    "aliases": ["startpage"],
+    "name": "Startpage",
+    "urls": {
+      "search": {
+        "base": "https://www.startpage.com/sp/search",
+        "params": [],
+        "searchTermParamName": "q"
+      }
+    },
+    "id": "927bbd9f-b2f3-48b4-8974-1c1148028f4d",
+    "identifier": "startpage",
+    "recordType": "engine",
+    "variants": []
+  },
+  {
+    "aliases": ["startpage-onion"],
+    "name": "Startpage (.onion)",
+    "urls": {
+      "search": {
+        "base": "http://startpagel6srwcjlue4zgq3zevrujfaow726kjytqbbjyrswwmjzcqd.onion/sp/search",
+        "params": [],
+        "searchTermParamName": "q"
+      }
+    },
+    "id": "e7eaba8d-6b9e-43fb-a799-b01b096c03ff",
+    "identifier": "startpage-onion",
+    "recordType": "engine",
+    "variants": []
+  },
+  {
+    "aliases": ["wikipedia"],
+    "classification": "unknown",
+    "name": "Wikipedia (en)",
+    "urls": {
+      "search": {
+        "base": "https://en.wikipedia.org/wiki/Special:Search",
+        "params": [],
+        "searchTermParamName": "search"
+      }
+    },
+    "id": "7f6d23c2-191e-483e-af3a-ce6451e3a8dd",
+    "identifier": "wikipedia",
+    "recordType": "engine",
+    "variants": []
+  }
+]

toolkit/components/search/jar.mn

+# This Source Code Form is subject to the terms of the Mozilla Public
+# License, v. 2.0. If a copy of the MPL was not distributed with this
+# file, You can obtain one at http://mozilla.org/MPL/2.0/.
+
+toolkit.jar:
+    content/global/search/    (content/*)

toolkit/components/search/moz.build

@@ -43,5 +43,7 @@ TESTING_JS_MODULES += [
     "tests/SearchTestUtils.sys.mjs",
 ]
 
+JAR_MANIFESTS += ["jar.mn"]
+
 with Files("**"):
     BUG_COMPONENT = ("Firefox", "Search")