Bug 686320 - Allow Mozmill to probe the OS for a free port instead of hardcoded value in JSBridge. r=jhammel

jsbridge/jsbridge/__init__.py

@@ -15,6 +15,16 @@
 extension_path = os.path.join(parent, 'extension')
 wait_to_create_timeout = 60
 
+
+def find_port():
+    free_socket = socket.socket(socket.AF_INET, socket.SOCK_STREAM)
+    free_socket.bind(('127.0.0.1', 0))
+    port = free_socket.getsockname()[1]
+    free_socket.close()
+
+    return port
+
+
 def wait_and_create_network(host, port, timeout=wait_to_create_timeout):
     ttl = 0
     while ttl < timeout:
@@ -28,16 +38,16 @@ def wait_and_create_network(host, port, timeout=wait_to_create_timeout):
         sleep(.25)
         ttl += .25
     if ttl == timeout:
-        raise Exception("Sorry, cannot connect to jsbridge extension, port %s" % port)
-    
+        raise Exception("Cannot connect to jsbridge extension, port %s" % port)
+
     back_channel, bridge = create_network(host, port)
     sleep(.5)
-    
+
     while back_channel.registered is False:
         back_channel.close()
         bridge.close()
         asyncore.socket_map = {}
         sleep(1)
         back_channel, bridge = create_network(host, port)
-    
+
     return back_channel, bridge

jsbridge/jsbridge/extension/chrome.manifest

@@ -1,15 +1,6 @@
 resource jsbridge resource/
 
-content jsbridge chrome/content/
+component {2872d428-14f6-11de-ac86-001f5bd9235c} components/jsbridge.js
+contract @mozilla.org/jsbridge;1 {2872d428-14f6-11de-ac86-001f5bd9235c}
+category profile-after-change JSBridge @mozilla.org/jsbridge;1
 
-overlay chrome://browser/content/browser.xul chrome://jsbridge/content/overlay.xul
-overlay chrome://messenger/content/mailWindowOverlay.xul chrome://jsbridge/content/overlay.xul
-
-overlay chrome://calendar/content/calendar.xul chrome://jsbridge/content/overlay.xul
-
-overlay windowtype:Songbird:Main chrome://jsbridge/content/overlay.xul
-
-component {2872d428-14f6-11de-ac86-001f5bd9235c} components/cmdarg.js
-contract @mozilla.org/commandlinehandler/general-startup;1?type=jsbridge {2872d428-14f6-11de-ac86-001f5bd9235c}
-category profile-after-change jsbridge @mozilla.org/commandlinehandler/general-startup;1?type=jsbridge
-category command-line-handler jsbridge @mozilla.org/commandlinehandler/general-startup;1?type=jsbridge

jsbridge/jsbridge/extension/components/jsbridge.js

@@ -0,0 +1,82 @@
+/* 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/. */
+
+const Cc = Components.classes;
+const Ci = Components.interfaces;
+const Cu = Components.utils;
+
+// Import global modules
+Cu.import("resource://gre/modules/XPCOMUtils.jsm");
+Cu.import("resource://gre/modules/Services.jsm");
+
+// Include local modules
+Cu.import("resource://jsbridge/modules/Log.jsm");
+
+
+// Constants for preferences names
+const PREF_JSBRIDGE_PORT = "extensions.jsbridge.port";
+
+
+/**
+ * XPCOM component to observe different application states and to
+ * handle the JSBridge server.
+ */
+function JSBridge() {
+  this._server = null;
+}
+
+JSBridge.prototype = {
+  classDescription: "JSBridge",
+  classID: Components.ID("{2872d428-14f6-11de-ac86-001f5bd9235c}"),
+  contractID: "@mozilla.org/jsbridge;1",
+  QueryInterface: XPCOMUtils.generateQI([Ci.nsIObserver]),
+
+  _xpcom_categories: [{category: "profile-after-change"}],
+
+  /**
+   * Handler for registered observer notifications.
+   *
+   * @param {String} aSubject
+   *        Subject of the observer message (not used)
+   * @param {String} aTopic
+   *        Topic of the observer message
+   * @param {Object} aData
+   *        Data of the observer message (not used)
+   */
+  observe: function JSB_observe(aSubject, aTopic, aData) {
+    Log.dump("Observer topic", aTopic);
+
+    switch (aTopic) {
+      // The server cannot be started before the ui is shown. That means
+      // we also have to register for the final-ui-startup notification.
+      case "profile-after-change":
+        Services.obs.addObserver(this, "final-ui-startup", false);
+        Services.obs.addObserver(this, "quit-application", false);
+        break;
+
+      case "final-ui-startup":
+        Services.obs.removeObserver(this, "final-ui-startup", false);
+
+        // The port the server has to be started on is set via a preference
+        let port = Services.prefs.getIntPref(PREF_JSBRIDGE_PORT);
+
+        // Start the server
+        Cu.import('resource://jsbridge/modules/Server.jsm');
+        this._server = new Server.Server(port);
+        this._server.start();
+
+        break;
+
+      case "quit-application":
+        Services.obs.removeObserver(this, "quit-application", false);
+
+        // Stop the server
+        this._server.stop();
+        this._server = null;
+        break;
+    }
+  }
+}
+
+const NSGetFactory = XPCOMUtils.generateNSGetFactory([JSBridge]);

jsbridge/jsbridge/extension/resource/modules/bridge.js → jsbridge/jsbridge/extension/resource/modules/Bridge.jsm

@@ -4,16 +4,20 @@
 
 var EXPORTED_SYMBOLS = ["Bridge"];
 
+
 const Cc = Components.classes;
 const Ci = Components.interfaces;
 const Cu = Components.utils;
 
-var events = {}; Cu.import("resource://jsbridge/modules/events.js", events);
 
-var uuidgen = Cc["@mozilla.org/uuid-generator;1"].getService(Ci.nsIUUIDGenerator);
+// Include local modules
+Cu.import("resource://jsbridge/modules/Events.jsm");
+Cu.import("resource://jsbridge/modules/Log.jsm");
 
 
-globalRegistry = {};
+var globalRegistry = {};
+var uuidgen = Cc["@mozilla.org/uuid-generator;1"].getService(Ci.nsIUUIDGenerator);
+
 
 function Bridge(session) {
   this.session = session;
@@ -23,11 +27,13 @@ function Bridge(session) {
 Bridge.prototype._register = function (_type) {
   this.bridgeType = _type;
 
-  if (_type == "backchannel")
-    events.addBackChannel(this);
+  if (_type === "backchannel")
+    Events.addBackChannel(this);
 };
 
 Bridge.prototype.register = function (uuid, _type) {
+  Log.dump("Register", uuid + " (" + _type + ")");
+
   try {
     this._register(_type);
     var passed = true;
@@ -74,6 +80,8 @@ Bridge.prototype._describe = function (obj) {
 };
 
 Bridge.prototype.describe = function (uuid, obj) {
+  Log.dump("Describe", uuid + ", " + obj);
+
   var response = this._describe(obj);
   response.uuid = uuid;
   response.result = true;
@@ -90,6 +98,8 @@ Bridge.prototype._set = function (obj) {
 };
 
 Bridge.prototype.set = function (uuid, obj) {
+  Log.dump("Set", uuid);
+
   var ruuid = this._set(obj);
 
   this.session.encodeOut({'result': true,
@@ -104,7 +114,8 @@ Bridge.prototype._setAttribute = function (obj, name, value) {
 };
 
 Bridge.prototype.setAttribute = function (uuid, obj, name, value) {
-  // log(uuid, String(obj), name, String(value))
+  Log.dump("Set attribute", uuid + " (" + name + "=" + value + ")");
+
   try {
     var result = this._setAttribute(obj, name, value);
   } catch (e) {
@@ -130,6 +141,8 @@ Bridge.prototype._execFunction = function (func, args) {
 };
 
 Bridge.prototype.execFunction = function (uuid, func, args) {
+  Log.dump("Exec function", uuid + " (" + func.name + ")");
+
   try {
     var data = this._execFunction(func, args);
     var result = true;
@@ -155,3 +168,4 @@ Bridge.prototype.execFunction = function (uuid, func, args) {
   else
     throw 'jsbridge could not execute function ' + func;
 };
+