Remove BootstrapLoader API

Use LegacyHelper API and dedicated TbSync API instead

Author: jobisoft

Makebeta

@@ -1,6 +1,6 @@
 # TbSync
 
-[TbSync](https://addons.thunderbird.net/addon/tbsync/) was a central user interface to manage cloud accounts and to synchronize their contact, task and calendar information with [Thunderbird](https://www.thunderbird.net/). Its main objective was to simplify the setup process for such accounts. Thunderbird is working on a new account-hub UI, which will make TbSync obsolete.
+[TbSync](https://addons.thunderbird.net/addon/tbsync/) is a central user interface to manage cloud accounts and to synchronize their contact, task and calendar information with [Thunderbird](https://www.thunderbird.net/). Its main objective is to simplify the setup process for such accounts. Thunderbird is working on a new account-hub UI, which will make TbSync obsolete.
 
 ## Icon sources and attributions
 

Makefile.bat

@@ -0,0 +1,50 @@
+## Objective
+
+This API is a temporary helper while converting legacy extensions to modern WebExtensions. It allows to register `resource://` URLs, which are needed to load custom system modules (*.sys.mjs), and `chrome://` URLs, which are needed to open legacy XUL dialogs.
+
+## Usage
+
+Add the [LegacyHelper API](https://github.com/thunderbird/webext-support/tree/master/experiments/LegacyHelper) to your add-on. Your `manifest.json` needs an entry like this:
+
+```json
+  "experiment_apis": {
+    "LegacyHelper": {
+      "schema": "api/LegacyHelper/schema.json",
+      "parent": {
+        "scopes": ["addon_parent"],
+        "paths": [["LegacyHelper"]],
+        "script": "api/LegacyHelper/implementation.js"
+      }
+    }
+  },
+```
+
+## API Functions
+
+This API provides the following functions:
+
+### async registerGlobalUrls(data)
+
+Register `chrome://*/content/` and `resource://*/` URLs. The function accepts a `data` parameter, which is an array of URL definition items. For example:
+
+```javascript
+await browser.LegacyHelper.registerGlobalUrls([
+  ["content", "myaddon", "chrome/content/"],
+  ["resource", "myaddon", "modules/"],
+]);
+```
+
+This registers the following URLs:
+* `chrome://myaddon/content/` pointing to the `/chrome/content/` folder (the `/content/` part in the URL is fix and does not depend on the name of the folder it is pointing to)
+* `resource://myaddon/` pointing to the `/modules/` folder. To register a `resource://` URL which points to the root folder, use `.` instead".
+
+### async openDialog(name, path)
+
+Open a XUL dialog. The `name` parameter is a unique name identifying the dialog. If the dialog with that name is already open, it will be focused instead of being re-opened. The `path` parameter is a `chrome://*/content/` URL pointing to the XUL dialog file (*.xul or *.xhtml).
+
+```javascript
+browser.LegacyHelper.openDialog(
+  "XulAddonOptions",
+  "chrome://myaddon/content/options.xhtml"
+);
+```

README.md

@@ -0,0 +1,118 @@
+/*
+ * This file is provided by the webext-support repository at
+ * https://github.com/thunderbird/webext-support
+ *
+ * Version 1.1
+ * - registerGlobalUrls() is now async, to be able to properly await registration
+ *
+ * Version 1.0
+ * - initial release
+ *
+ * Author:
+ * - John Bieling ([email protected])
+ *
+ * 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/.
+ */
+
+"use strict";
+
+// Using a closure to not leak anything but the API to the outside world.
+(function (exports) {
+
+  const aomStartup = Cc[
+    "@mozilla.org/addons/addon-manager-startup;1"
+  ].getService(Ci.amIAddonManagerStartup);
+  const resProto = Cc[
+    "@mozilla.org/network/protocol;1?name=resource"
+  ].getService(Ci.nsISubstitutingProtocolHandler);
+
+  const chromeHandlers = [];
+  const resourceUrls = [];
+
+  var LegacyHelper = class extends ExtensionCommon.ExtensionAPI {
+    getAPI(context) {
+      return {
+        LegacyHelper: {
+          registerGlobalUrls(data) {
+            const manifestURI = Services.io.newURI(
+              "manifest.json",
+              null,
+              context.extension.rootURI
+            );
+
+            for (let entry of data) {
+              // [ "resource", "shortname" , "path" ]
+
+              switch (entry[0]) {
+                case "resource":
+                  {
+                    let uri = Services.io.newURI(
+                      entry[2],
+                      null,
+                      context.extension.rootURI
+                    );
+                    resProto.setSubstitutionWithFlags(
+                      entry[1],
+                      uri,
+                      resProto.ALLOW_CONTENT_ACCESS
+                    );
+                    resourceUrls.push(entry[1]);
+                  }
+                  break;
+
+                case "content":
+                case "locale":
+                  {
+                    let handle = aomStartup.registerChrome(
+                      manifestURI,
+                      [entry]
+                    );
+                    chromeHandlers.push(handle);
+                  }
+                  break;
+                
+                default:
+                  console.warn(`LegacyHelper: Unsupported url type: ${entry[0]}`)
+              } 
+            }
+          },
+
+          openDialog(name, path) {
+            let window = Services.wm.getMostRecentWindow("mail:3pane");
+            window.openDialog(
+              path,
+              name,
+              "chrome,resizable,centerscreen"
+            );
+          },
+        },
+      };
+    }
+
+    onShutdown(isAppShutdown) {
+      if (isAppShutdown) {
+        return; // the application gets unloaded anyway
+      }
+
+      for (let chromeHandler of chromeHandlers) {
+        if (chromeHandler) {
+          chromeHandler.destruct();
+          chromeHandler = null;
+        }
+      }
+
+      for (let resourceUrl of resourceUrls) {
+        resProto.setSubstitution(
+          resourceUrl,
+          null
+        );
+      }
+
+      // Flush all caches.
+      Services.obs.notifyObservers(null, "startupcache-invalidate");
+    }
+  };
+  exports.LegacyHelper = LegacyHelper;
+})(this);

UPDATE68.md

@@ -0,0 +1,42 @@
+[
+  {
+    "namespace": "LegacyHelper",
+    "functions": [
+      {
+        "name": "registerGlobalUrls",
+        "type": "function",
+        "async": true,
+        "description": "Register folders which should be available as legacy chrome:// urls or resource:// urls",
+        "parameters": [
+          {
+            "name": "data",
+            "type": "array",
+            "items": {
+              "type": "array",
+              "items": {
+                "type": "string"
+              }
+            },
+            "description": "Array of manifest url definitions (content, locale or resource)"
+          }
+        ]
+      },
+      {
+        "name": "openDialog",
+        "type": "function",
+        "parameters": [
+          {
+            "name": "name",
+            "type": "string",
+            "description": "name of the new dialog"
+          },
+          {
+            "name": "path",
+            "type": "string",
+            "description": "path of the dialog to be opened"
+          }
+        ]
+      }
+    ]
+  }
+]

api/LegacyHelper/README.md

@@ -0,0 +1,46 @@
+/*
+ * 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/.
+ */
+
+"use strict";
+
+// Using a closure to not leak anything but the API to the outside world.
+(function (exports) {
+
+  var { AddonManager } = ChromeUtils.importESModule("resource://gre/modules/AddonManager.sys.mjs");
+  var { TbSync: TbSyncModule } = ChromeUtils.importESModule("chrome://tbsync/content/tbsync.sys.mjs");
+
+  let defaults = Services.prefs.getDefaultBranch("extensions.tbsync.");
+  defaults.setBoolPref("debug.testoptions", false);
+  defaults.setBoolPref("log.toconsole", false);
+  defaults.setIntPref("log.userdatalevel", 0); //0 - off   1 - userdata only on errors   2 - including full userdata,  3 - extra infos
+
+  var TbSync = class extends ExtensionCommon.ExtensionAPI {
+    getAPI(context) {
+      return {
+        TbSync: {
+          async load(windowId) {
+            let { window } = context.extension.windowManager.get(windowId);
+            let { TbSync } = ChromeUtils.importESModule("chrome://tbsync/content/tbsync.sys.mjs");
+            if (!TbSync.enabled) {
+              let addon = await AddonManager.getAddonByID(context.extension.id);
+              TbSync.load(window, addon, context.extension);
+            }
+          },
+          openManagerWindow() {
+            TbSyncModule.manager.openManagerWindow();
+          }
+        },
+      };
+    }
+
+    onShutdown(isAppShutdown) {
+      if (isAppShutdown) {
+        return; // the application gets unloaded anyway
+      }
+    }
+  };
+  exports.TbSync = TbSync;
+})(this);

api/LegacyHelper/implementation.js

@@ -0,0 +1,24 @@
+[
+  {
+    "namespace": "TbSync",
+    "functions": [
+      {
+        "name": "load",
+        "type": "function",
+        "async": true,
+        "parameters": [
+          {
+            "name": "windowId",
+            "type": "integer"
+          }
+        ]
+      },
+      {
+        "name": "openManagerWindow",
+        "type": "function",
+        "async": true,
+        "parameters": []
+      }
+    ]
+  }
+]