mpris: Port to Firefox

Make all necessary changes to the MPRIS support to port Streamkeys to
Firefox. The problems found are the following:

* Firefox does not have runtime.onSuspend(). Remove it for now. (Do we
  really need it anyway?)

Author: alextsits

README.md

@@ -126,24 +126,51 @@ installed.
 
 #### Install host script
 
-To install the host script, locate the extension ID from the Chrome extensions page
-and run the following commands:
+###### Chrome
+
+To install the host script for Chrome, locate the extension ID from the Chrome
+extensions page and run the following commands:
 
 ```bash
 $ extension_id="....."
 $ installer=$(find $HOME/.config -name "mpris_host_setup.py" | grep ${extension_id})
 $ python3 ${installer} install ${extension_id}
 ```
 
+###### Firefox
+
+To install the host script for Firefox run the following commands:
+
+```bash
+$ xpi=$(find $HOME/.mozilla -name "streamkeys@streamkeys.com.xpi")
+$ tmpdir=$(mktemp -d streamkeys.XXXXXX --tmpdir)
+$ unzip -d ${tmpdir} ${xpi}
+$ python3 ${tmpdir}/native/mpris_host_setup.py install-ff
+$ rm -r ${tmpdir}
+```
+
 #### Uninstall host script
 
-To uninstall the host script, locate the extension ID from the Chrome extensions page
-and run the following commands:
+###### Chrome
+
+To uninstall the host script for Chrome, locate the extension ID from the
+Chrome extensions page and run the following commands:
 
 ```bash
-$ extension_id="....."
-$ installer=$(find $HOME/.config -name "mpris_host_setup.py" | grep ${extension_id})
-$ python3 ${installer} uninstall
+$ xpi=$(find $HOME/.mozilla -name "streamkeys@streamkeys.com.xpi")
+$ tmpdir=$(mktemp -d streamkeys.XXXXXX --tmpdir)
+$ unzip -d ${tmpdir} ${xpi}
+$ python3 ${tmpdir}/native/mpris_host_setup.py uninstall-ff
+$ rm -r ${tmpdir}
+```
+
+###### Firefox
+
+To uninstall the host script for Firefox run the following commands:
+
+```bash
+$ installer=$(find $HOME/.mozilla -name "mpris_host_setup.py")
+$ python3 ${installer} uninstall-ff
 ```
 
 ## License (MIT)

code/js/background.js

@@ -384,13 +384,6 @@
         console.log("Starting native messaging host");
         mprisPort = chrome.runtime.connectNative("org.mpris.streamkeys_host");
         mprisPort.onMessage.addListener(handleNativeMsg);
-
-        chrome.runtime.onSuspend.addListener(function() {
-          if (!--connections)
-            mprisPort.postMessage({ command: "quit" });
-            mprisPort.onMessage.removeListener(handleNativeMsg);
-            mprisPort.disconnect();
-        });
       }
     }
   });

code/manifest.json

@@ -37,9 +37,8 @@
     "js/inject/seesu_inject.js",
     "js/controllers/*"
   ],
-  "permissions": ["tabs", "storage", "http://*/*", "https://*/*"],
-  "optional_permissions": [ "notifications", "http://*/*", "https://*/*",
-                            "nativeMessaging"],
+  "permissions": ["tabs", "storage", "http://*/*", "https://*/*", "nativeMessaging"],
+  "optional_permissions": [ "notifications", "http://*/*", "https://*/*"],
   "commands": {
     "playPause": {
       "suggested_key": {

code/native/mpris_host_setup.py

@@ -10,13 +10,21 @@
 
 HOST_FILENAME = "streamkeys_mpris.py"
 HOST_MANIFEST_FILENAME = "org.mpris.streamkeys_host.json"
-HOST_MANIFEST = {
+CHROME_HOST_MANIFEST = {
   "name": "org.mpris.streamkeys_host",
   "description": "Streamkeys MPRIS native messaging host",
   "path": None,
   "type": "stdio",
   "allowed_origins": []
 }
+FIREFOX_HOST_MANIFEST = {
+  "name": "org.mpris.streamkeys_host",
+  "description": "Streamkeys MPRIS native messaging host",
+  "path": None,
+  "type": "stdio",
+  "allowed_extensions": []
+}
+FIREFOX_EXT_ID = "streamkeys@streamkeys.com"
 XDG_CONFIG_HOME = os.environ.get("XDG_CONFIG_HOME",
                                  default=os.path.expanduser("~/.config"))
 
@@ -31,20 +39,51 @@ def initialize_parser():
     p = subparsers.add_parser("install",
                               help="Install the native messaging host")
     p.add_argument("id", help="The extension ID")
-    p.set_defaults(func=main_install)
+    p.set_defaults(func=main_install, firefox=False)
 
     p = subparsers.add_parser("uninstall",
                               help="Uninstall the native messaging host")
-    p.set_defaults(func=main_uninstall)
+    p.set_defaults(func=main_uninstall, firefox=False)
+
+    p = subparsers.add_parser("install-ff",
+                              help="Install the native messaging host for"
+                                   " Firefox instead of Chrome")
+    p.add_argument("--id", default=FIREFOX_EXT_ID, help="The extension ID")
+    p.set_defaults(func=main_install, firefox=True)
+
+    p = subparsers.add_parser("uninstall-ff",
+                              help="Uninstall the native messaging host for"
+                                   " Firefox instead of Chrome")
+    p.set_defaults(func=main_uninstall, firefox=True)
     return parser
 
 
-def get_xdg_config_paths():
+def get_chrome_xdg_config_paths():
     return [os.path.join(XDG_CONFIG_HOME, "chromium"),
             os.path.join(XDG_CONFIG_HOME, "google-chrome")]
 
 
-def install_host(ext_id, install_dir):
+def get_chrome_manifest_paths():
+    paths = []
+    xdg_paths = get_chrome_xdg_config_paths()
+    for path in xdg_paths:
+        if not os.path.exists(path):
+            continue
+        message_hosts = os.path.join(path, "NativeMessagingHosts")
+        manifest_path = os.path.join(message_hosts, HOST_MANIFEST_FILENAME)
+        paths.append(manifest_path)
+    return paths
+
+
+def get_firefox_manifest_paths():
+    paths = []
+    message_hosts = os.path.expanduser("~/.mozilla/native-messaging-hosts")
+    manifest_path = os.path.join(message_hosts, HOST_MANIFEST_FILENAME)
+    paths.append(manifest_path)
+    return paths
+
+
+def install_host(ext_id, install_dir, firefox=False):
     # Copy the host script
     host_path = os.path.join(install_dir, HOST_FILENAME)
     os.makedirs(install_dir, exist_ok=True)
@@ -56,37 +95,39 @@ def install_host(ext_id, install_dir):
     os.chmod(host_path, 0o744)
 
     # Create the manifest file
-    xdg_paths = get_xdg_config_paths()
-    manifest = dict(HOST_MANIFEST)
-    manifest["path"] = host_path
-    manifest["allowed_origins"].append("chrome-extension://%s/" % ext_id)
-    for path in xdg_paths:
-        if not os.path.exists(path):
-            continue
-        message_hosts = os.path.join(path, "NativeMessagingHosts")
-        manifest_path = os.path.join(message_hosts, HOST_MANIFEST_FILENAME)
-
-        os.makedirs(message_hosts, exist_ok=True)
-        with open(manifest_path, "w") as f:
+    if firefox:
+        manifest_paths = get_firefox_manifest_paths()
+        manifest = dict(FIREFOX_HOST_MANIFEST)
+        manifest["path"] = host_path
+        manifest["allowed_extensions"].append(ext_id)
+    else:
+        manifest_paths = get_chrome_manifest_paths()
+        manifest = dict(CHROME_HOST_MANIFEST)
+        manifest["path"] = host_path
+        manifest["allowed_origins"].append("chrome-extension://%s/" % ext_id)
+
+    for path in manifest_paths:
+        os.makedirs(os.path.dirname(path), exist_ok=True)
+        with open(path, "w") as f:
             json.dump(manifest, f, indent=2)
-        os.chmod(manifest_path, 0o644)
+        os.chmod(path, 0o644)
 
 
-def uninstall_host(install_dir):
+def uninstall_host(install_dir, firefox=False):
     # Remove host script
     host_path = os.path.join(install_dir, HOST_FILENAME)
     if os.path.isfile(host_path):
         os.remove(host_path)
 
     # Remove manifest file
-    xdg_paths = get_xdg_config_paths()
-    for path in xdg_paths:
-        if not os.path.exists(path):
-            continue
-        message_hosts = os.path.join(path, "NativeMessagingHosts")
-        manifest_path = os.path.join(message_hosts, HOST_MANIFEST_FILENAME)
-        if os.path.isfile(manifest_path):
-            os.remove(manifest_path)
+    if firefox:
+        manifest_paths = get_firefox_manifest_paths()
+    else:
+        manifest_paths = get_chrome_manifest_paths()
+
+    for path in manifest_paths:
+        if os.path.isfile(path):
+            os.remove(path)
 
 
 def setup_logger(level=logging.DEBUG):
@@ -109,11 +150,12 @@ def main():
 
 
 def main_install(args):
-    # Chrome's extension IDs are in hexadecimal but using a-p, referred
-    # internally as "mpdecimal". See https://stackoverflow.com/a/2050916
-    if (len(args.id) != 32
-            or any(ord(c) not in range(97, 113) for c in args.id)):
-        raise RuntimeError("Not valid extension ID: %s" % args.id)
+    if not args.firefox:
+        # Chrome's extension IDs are in hexadecimal but using a-p, referred
+        # internally as "mpdecimal". See https://stackoverflow.com/a/2050916
+        if (len(args.id) != 32
+                or any(ord(c) not in range(97, 113) for c in args.id)):
+            raise RuntimeError("Not valid extension ID: %s" % args.id)
 
     try:
         from gi.repository import GLib, Gio  # noqa: F401
@@ -127,11 +169,11 @@ def main_install(args):
         raise RuntimeError("Required dependency `python3-pydbus' not"
                            " found")
 
-    install_host(args.id, args.install_dir)
+    install_host(args.id, args.install_dir, firefox=args.firefox)
 
 
 def main_uninstall(args):
-    uninstall_host(args.install_dir)
+    uninstall_host(args.install_dir, firefox=args.firefox)
 
 
 if __name__ == "__main__":