Bug 1876342 - Added Windows native messaging host registration for Chromium r=mhughes,robwu,nalexander

Differential Revision: https://phabricator.services.mozilla.com/D199587

Author: nipunshukla21

browser/components/BrowserGlue.sys.mjs

@@ -2657,7 +2657,8 @@ BrowserGlue.prototype = {
       {
         name: "firefoxBridgeNativeMessaging",
         condition:
-          AppConstants.platform == "macosx" &&
+          (AppConstants.platform == "macosx" ||
+            AppConstants.platform == "win") &&
           Services.prefs.getBoolPref("browser.firefoxbridge.enabled", false),
         task: async () => {
           await lazy.FirefoxBridgeExtensionUtils.ensureRegistered();

browser/modules/FirefoxBridgeExtensionUtils.sys.mjs

@@ -252,7 +252,9 @@ export const FirefoxBridgeExtensionUtils = {
   ) {
     try {
       let binFile = Services.dirsvc.get("XREExeF", Ci.nsIFile).parent;
-      if (AppConstants.platform == "macosx") {
+      if (AppConstants.platform == "win") {
+        binFile.append("nmhproxy.exe");
+      } else if (AppConstants.platform == "macosx") {
         binFile.append("nmhproxy");
       } else {
         throw new Error("Unsupported platform");
@@ -291,7 +293,15 @@ export const FirefoxBridgeExtensionUtils = {
 
   async ensureRegistered() {
     let nmhManifestFolder = null;
-    if (AppConstants.platform == "macosx") {
+    if (AppConstants.platform == "win") {
+      // We don't have permission to write to the application install directory
+      // so instead write to %AppData%\Mozilla\Firefox.
+      nmhManifestFolder = PathUtils.join(
+        Services.dirsvc.get("AppData", Ci.nsIFile).path,
+        "Mozilla",
+        "Firefox"
+      );
+    } else if (AppConstants.platform == "macosx") {
       nmhManifestFolder =
         "~/Library/Application Support/Google/Chrome/NativeMessagingHosts/";
     } else {
@@ -302,5 +312,49 @@ export const FirefoxBridgeExtensionUtils = {
       this.getNativeMessagingHostId(),
       this.getExtensionOrigins()
     );
+    if (AppConstants.platform == "win") {
+      this.maybeWriteNativeMessagingRegKeys(
+        "Software\\Google\\Chrome\\NativeMessagingHosts",
+        nmhManifestFolder,
+        this.getNativeMessagingHostId()
+      );
+    }
+  },
+
+  maybeWriteNativeMessagingRegKeys(
+    regPath,
+    nmhManifestFolder,
+    NATIVE_MESSAGING_HOST_ID
+  ) {
+    let wrk = Cc["@mozilla.org/windows-registry-key;1"].createInstance(
+      Ci.nsIWindowsRegKey
+    );
+    try {
+      let expectedValue = PathUtils.join(
+        nmhManifestFolder,
+        `${NATIVE_MESSAGING_HOST_ID}.json`
+      );
+      try {
+        // If the key already exists it will just be opened
+        wrk.create(
+          wrk.ROOT_KEY_CURRENT_USER,
+          regPath + `\\${NATIVE_MESSAGING_HOST_ID}`,
+          wrk.ACCESS_ALL
+        );
+        if (wrk.readStringValue("") == expectedValue) {
+          return;
+        }
+      } catch (e) {
+        // The key either doesn't have a value or doesn't exist
+        // In either case we need to write it.
+      }
+      wrk.writeStringValue("", expectedValue);
+    } catch (e) {
+      // The method fails if we can't access the key
+      // which means it doesn't exist. That's a normal situation.
+      // We don't need to do anything here.
+    } finally {
+      wrk.close();
+    }
   },
 };

browser/modules/test/unit/test_FirefoxBridgeExtensionUtilsNativeManifest.js

@@ -23,10 +23,16 @@ let userDir = dir.clone();
 userDir.append("user");
 userDir.create(Ci.nsIFile.DIRECTORY_TYPE, FileUtils.PERMS_DIRECTORY);
 
+let appDir = dir.clone();
+appDir.append("app");
+appDir.create(Ci.nsIFile.DIRECTORY_TYPE, FileUtils.PERMS_DIRECTORY);
+
 let dirProvider = {
   getFile(property) {
     if (property == "Home") {
       return userDir.clone();
+    } else if (property == "AppData") {
+      return appDir.clone();
     }
     return null;
   },
@@ -35,6 +41,9 @@ let dirProvider = {
 try {
   Services.dirsvc.undefine("Home");
 } catch (e) {}
+try {
+  Services.dirsvc.undefine("AppData");
+} catch (e) {}
 Services.dirsvc.registerProvider(dirProvider);
 
 registerCleanupFunction(() => {
@@ -47,7 +56,9 @@ const USER_TEST_PATH = PathUtils.join(userDir.path, "manifestDir");
 let binFile = null;
 add_setup(async function () {
   binFile = Services.dirsvc.get("XREExeF", Ci.nsIFile).parent.clone();
-  if (AppConstants.platform == "macosx") {
+  if (AppConstants.platform == "win") {
+    binFile.append("nmhproxy.exe");
+  } else if (AppConstants.platform == "macosx") {
     binFile.append("nmhproxy");
   } else {
     throw new Error("Unsupported platform");
@@ -180,6 +191,11 @@ add_task(async function test_ensureRegistered() {
       userDir.path,
       "Library/Application Support/Google/Chrome/NativeMessagingHosts/"
     );
+  } else if (AppConstants.platform == "win") {
+    expectedJSONDirPath = PathUtils.joinRelative(
+      appDir.path,
+      "Mozilla\\Firefox"
+    );
   } else {
     throw new Error("Unsupported platform");
   }

browser/modules/test/unit/xpcshell.toml

@@ -10,6 +10,7 @@ run-if = ["os == 'win'"] # Test of a Windows-specific feature
 
 ["test_FirefoxBridgeExtensionUtilsNativeManifest.js"]
 run-if = [
+  "os == 'win'",
   "os == 'mac'",
 ]