added hook function to appIntegration to handle function-overwrites from other extensions

lib/appIntegration.js

 /* 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/. */
 
-function hook(obj, name, func)

[Wladimir Palant, 2012/09/26 09:27:50]

Any reason why you've put it here? I expected it to be in a separate module -
this is generic functionality that is not application-specific.

+let {hook} = require("hooks");
+let functionHooks = new WeakMap();
+
+exports.removeFromWindow = function(window)
 {
-  var orig = obj[name];
-  var origGet = obj.__lookupGetter__(name);
-  var origSet = obj.__lookupSetter__(name);
-  var dumbOverrideAttempt = false;

[Wladimir Palant, 2012/09/26 09:27:50]

You should use let instead of var in Firefox code - the scope of let variables
is defined in a much cleaner way, unexpected scope issues are unlikely here.

(Note that I fixed that issue in one of my changes already)

-  
-  var newFunc = function()
-  {
-    try
-    {
-      func.apply(this, arguments);
-    }
-    catch(e)
-    {
-      Cu.reportError(e);
-    }
-    orig.apply(this, arguments);
-  }
-  newFunc.toString = function()
-  {
-    dumbOverrideAttempt = true;
-    return orig.toString();
-  }
-  
-  obj.__defineGetter__(name, function()
-    {
-      dumbOverrideAttempt = false;
-      return newFunc;
-    }
-  );
-  
-  obj.__defineSetter__(name, function(value)
-    {
-      if (dumbOverrideAttempt)
-      {
-        orig = value;
-      }
-      else
-      {
-        delete obj[name];
-        obj[name] = value;
-      }
-    }
-  );
-  
-  return function() {
-    delete obj[name];
-    obj[name] = orig;
-    if (origGet) {
-      obj.__defineGetter__(name, origGet);
-    }
-    if (origSet) {
-      obj.__defineSetter__(name, origSet);
-    }
-  }

[Wladimir Palant, 2012/09/26 09:27:50]

Inconsistent style here (brackets) - plus there is a missing semicolon at the
return statement (only mentioning because missing semicolons after function
literals seems to be a recurring issue in your code).

(Note that I fixed this issue in one of my changes already)

-}
-
-let wm = new WeakMap();
-let {Prefs} = require("prefs");

[Wladimir Palant, 2012/09/26 09:27:50]

I would be very worried if our generic app-support code were suddenly dependent
on preferences... This seems unused however, remove?

+  if (functionHooks.has(window))
+  {
+    let unhook = functionHooks.get(window);
+    unhook();
+    functionHooks.delete(window);
+  }
+};
+
 let {application} = require("info");
 switch (application)
 {
   case "firefox":
   {
     // Firefox
     exports.isKnownWindow = function(window) window.document.documentElement.getAttribute("windowtype") == "navigator:browser";
 
     exports.getURLBar = function(window) "gURLBar" in window ? window.gURLBar : null;
 
     exports.getBrowser = function(window) "gBrowser" in window ? window.gBrowser : null;
 
     exports.applyToWindow = function(window, corrector)
     {
       let urlbar = exports.getURLBar(window);
-      if (urlbar && urlbar.handleCommand && !("urlfixerOldHandler" in urlbar.handleCommand))
+      if (urlbar && urlbar.handleCommand && !functionHooks.has(window))
       {
         // Handle new URLs being entered
-        let hooks = [];

[Wladimir Palant, 2012/09/26 09:27:50]

From the look of it, we never hook more than one function (in Fennec native we
hook additional functions only temporarily - that's different). How about
putting a single unhook function into the map instead of an array?

-        if (wm.get(window))

[Wladimir Palant, 2012/09/26 09:27:50]

The window should definitely be unknown here - if we are called twice for the
same window then we have bigger problems than having to merge hooks. Instead of
the check here you probably want to replace the outdated !("urlfixerOldHandler"
in urlbar.handleCommand) check above by !wm.has(window).

-        {
-          hooks = wm.get(window);
-        }
-        hooks.push(hook(urlbar, "handleCommand", function()
-          {
-            try
-            {
-              let correction = corrector(window, urlbar.value);
-              if (correction)
-                urlbar.value = correction;
-            }
-            catch(e)
-            {
-              Cu.reportError(e);
-            }

[Wladimir Palant, 2012/09/26 09:27:50]

The try..catch block here is no longer necessary - the hook() function already
takes care of that.

-          }
-        ));
-        wm.set(window, hooks);
-      }
-    };
-
-    exports.removeFromWindow = function(window)
-    {
-      let urlbar = exports.getURLBar(window);
-      if (urlbar && urlbar.handleCommand && wm.has(window))
-      {
-        let hooks = wm.get(window);
-        for (let i = 0, len = hooks.length; i < len; i++)
-        {
-          hooks[i]();
-        }
-        wm.delete(window);
-      }
-    };
-    
+        let unhook = hook(urlbar, "handleCommand", function()
+        {
+          let correction = corrector(window, urlbar.value);
+          if (correction)
+            urlbar.value = correction;
+        });
+        functionHooks.set(window, unhook);
+      }
+    };
+
     exports.openInfobar = function(window, id, message, buttons, persistence)
     {
       let browser = exports.getBrowser(window);
       let infobar = browser.getNotificationBox();
       let notif = infobar.getNotificationWithValue(id);
-      
+
       if (notif)
       {
         infobar.removeNotification(notif);
       }
-      
+
       notif = infobar.appendNotification(
         message,
         id,
         require("info").addonRoot + "icon64.png",
         infobar.PRIORITY_INFO_HIGH,
         buttons
       );
       notif.persistence = persistence;
     };
-    
-    exports.loadURI = function(uri)
-    {
-      exports.getBrowser(Services.wm.getMostRecentWindow("navigator:browser")).loadURI(uri);
+
+    exports.loadURI = function(window, uri)
+    {
+      exports.getBrowser(window).loadURI(uri);
     };
 
     break;
   }
   case "seamonkey":
   {
+    let eventListeners = new WeakMap();
+
     // SeaMonkey
     exports.isKnownWindow = function(window) window.document.documentElement.getAttribute("windowtype") == "navigator:browser";
 
     exports.getURLBar = function(window) "gURLBar" in window ? window.gURLBar : null;
 
     exports.getBrowser = function(window) "gBrowser" in window ? window.gBrowser : null;
 
     exports.applyToWindow = function(window, corrector)
     {
       let urlbar = exports.getURLBar(window);
-      if (urlbar && urlbar.handleCommand && !("urlfixerOldHandler" in urlbar.handleCommand))

[Wladimir Palant, 2012/09/26 09:27:50]

Replacing SeaMonkey code by Firefox-specific code isn't going to work. The
function to hook is window.handleURLBarCommand in SeaMonkey, please restore the
functionality here.

-      {
-        // Handle new URLs being entered
-        let hooks = [];
-        if (wm.get(window))
-        {
-          hooks = wm.get(window);
-        }
-        hooks.push(hook(urlbar, "handleCommand", function()
+      let goButton = window.document.getElementById("go-button-container");
+
+      if (urlbar && urlbar._fireEvent && !functionHooks.has(window))
+      {
+        function correctURL()
+        {
+          let correction = corrector(window, urlbar.value);
+          if (correction)
+            urlbar.value = correction;
+        }
+
+        let unhook = hook(urlbar, "_fireEvent", function(eventType)
+        {
+          if (eventType == "textentered")
           {
-            try
-            {
-              let correction = corrector(window, urlbar.value);
-              if (correction)
-                urlbar.value = correction;
-            }
-            catch(e)
-            {
-              Cu.reportError(e);
-            }
-            oldHandler.apply(this, arguments);
+            correctURL();
           }
-        ));
-        wm.set(window, hooks);
-      }
-    };
-    

[Wladimir Palant, 2012/09/26 09:27:50]

I suggest the following setting for the Sublime Text editor:

  "trim_trailing_white_space_on_save": true

+        });
+        functionHooks.set(window, unhook);
+
+        if (goButton)
+        {
+          goButton.addEventListener("command", correctURL, true);
+          eventListeners.set(window, {
+            "listener": correctURL,
+            "element": goButton
+          });
+        }
+      }
+    };
+
+    let basicRemove = exports.removeFromWindow;
     exports.removeFromWindow = function(window)
     {
-      let urlbar = exports.getURLBar(window);
-      if (urlbar && urlbar.handleCommand && wm.has(window))
-      {
-        let hooks = wm.get(window);
-        for (let i = 0, len = hooks.length; i < len; i++)
-        {
-          hooks[i]();
-        }
-        wm.delete(window);
-      }
-    };
-    
+      basicRemove(window);
+
+      if (eventListeners.has(window))
+      {
+        let eventListener = eventListeners.get(window);
+        eventListener.element.removeEventListener("command", eventListener.listener, true);
+        eventListeners.delete(window);
+      }
+    };
+
     exports.openInfobar = function(window, id, message, buttons, persistence)
     {
       let browser = exports.getBrowser(window);
       let infobar = browser.getNotificationBox();
       let notif = infobar.getNotificationWithValue(id);
-      
+
       if (notif)
       {
         infobar.removeNotification(notif);
       }
-      
+
       notif = infobar.appendNotification(
         message,
         id,
         require("info").addonRoot + "icon64.png",
         infobar.PRIORITY_INFO_HIGH,
         buttons
       );
       notif.persistence = persistence;
     };
-    
-    exports.loadURI = function(uri)
-    {
-      exports.getBrowser(Services.wm.getMostRecentWindow("navigator:browser")).loadURI(uri);
+
+    exports.loadURI = function(window, uri)
+    {
+      exports.getBrowser(window).loadURI(uri);
     };
 
     break;
   }
   case "fennec":
   {
     // XUL Fennec
     exports.isKnownWindow = function(window) window.document.documentElement.getAttribute("windowtype") == "navigator:browser";
 
     exports.getURLBar = function(window) null;
 
     exports.getBrowser = function(window) null;
 
     exports.applyToWindow = function(window, corrector)
     {
-      if ("BrowserUI" in window && window.BrowserUI.goToURI && !("urlfixerOldHandler" in window.BrowserUI.goToURI))
+      if ("BrowserUI" in window && window.BrowserUI.goToURI && !functionHooks.has(window))
       {
         // Handle new URLs being entered
-        let oldHandler = window.BrowserUI.goToURI;
-        window.BrowserUI.goToURI = function(url)
+        let unhook = hook(window.BrowserUI, "goToURI", function(url)
         {
           url = url || this._edit.value;
-          try
-          {
-            let correction = corrector(window, url);
-            if (correction)
-              url = correction;
-          }
-          catch(e)
-          {
-            Cu.reportError(e);
-          }
-          oldHandler.call(this, url);
-        }
-        window.BrowserUI.goToURI.urlfixerOldHandler = oldHandler;
-        window.BrowserUI.goToURI.toString = doNotRecompile;
-      }
-    };
-
-    exports.removeFromWindow = function(window)
-    {
-      if ("BrowserUI" in window && window.BrowserUI.goToURI && "urlfixerOldHandler" in window.BrowserUI.goToURI)
-        window.BrowserUI.goToURI = window.BrowserUI.goToURI.urlfixerOldHandler;
-    };
-    
-    exports.openInfobar = function()
-    {
-      // TODO: Implement infobar
-    };
-    
-    exports.loadURI = function(window, uri)
-    {
-      // TODO: Implement infobar
+
+          let correction = corrector(window, url);
+          if (correction)
+            url = correction;
+
+          return [url];
+        });
+        functionHooks.set(window, unhook);
+      }
+    };
+
+    exports.openInfobar = function(window, id, message, buttons, persistence)
+    {
+      if ("getNotificationBox" in window)
+      {
+        let infobar = window.getNotificationBox();
+        let notification = infobar.getNotificationWithValue(id);
+
+        if (notification)
+        {
+          infobar.removeNotification(notification);
+        }
+
+        notification = infobar.appendNotification(
+          message,
+          id,
+          require("info").addonRoot + "icon64.png",
+          infobar.PRIORITY_INFO_HIGH,
+          buttons
+        );
+        notification.persistence = persistence;
+      }
+    };
+
+    exports.loadURI = function(window, uri)
+    {
+      if ("BrowserUI" in window && "goToURI" in window.BrowserUI)
+      {
+        window.BrowserUI.goToURI(uri);
+      }
     };
 
     break;
   }
   case "fennec2":
   {
     // Native Fennec
     exports.isKnownWindow = function(window) window.document.documentElement.getAttribute("windowtype") == "navigator:browser";
 
     exports.getURLBar = function(window) null;
 
     exports.getBrowser = function(window) null;
 
     exports.applyToWindow = function(window, corrector)
     {
-      if ("BrowserApp" in window && window.BrowserApp.observe && !("urlfixerOldHandler" in window.BrowserApp.observe))
-      {
-        let oldHandler = window.BrowserApp.observe;
-        let oldFunc = null;
-        let handler = function()
-        {
-          let params = Array.prototype.slice.apply(arguments);
-          try
-          {
-            let correction = corrector(window, params[0]);
-            if (correction)
-              params[0] = correction;
-          }
-          catch(e)
-          {
-            Cu.reportError(e);
-          }
-          return oldFunc.apply(this, params);
-        };
-
-        window.BrowserApp.observe = function(subject, topic, data)
+      if ("BrowserApp" in window && window.BrowserApp.observe && !functionHooks.has(window))
+      {
+        let innerUnhook = null;
+        function cleanup()
+        {
+          if (innerUnhook)
+            innerUnhook();
+
+          innerUnhook = null;
+        }
+
+        let unhook = hook(window.BrowserApp, "observe", function(subject, topic, data)
         {
           // Huge hack: we replace addTab/loadURI when the observer is
           // triggered. This seems to be the only way to know that the calls
           // originate from user input.
           let method = null;
           if (topic == "Tab:Add")
             method = "addTab";
           else if (topic == "Tab:Load")
             method = "loadURI";
 
           if (method)
           {
-            oldFunc = this[method];
-            this[method] = handler;
+            innerUnhook = hook(this, method, function()
+            {
+              let params = Array.prototype.slice.apply(arguments);
+              let correction = corrector(window, params[0]);
+              if (correction)
+                params[0] = correction;
+              return params;
+            });
           }
-
-          try
-          {
-            oldHandler.apply(this, arguments);
-          }
-          finally
-          {
-            if (method)
-              this[method] = oldFunc;
-          }
-        };
-        window.BrowserApp.observe.urlfixerOldHandler = oldHandler;
-        window.BrowserApp.observe.toString = doNotRecompile;
-      }
-    };
-
-    exports.removeFromWindow = function(window)
-    {
-      if ("BrowserApp" in window && window.BrowserApp.observe && "urlfixerOldHandler" in window.BrowserApp.observe)
-        window.BrowserApp.observe = window.BrowserApp.observe.urlfixerOldHandler;
-    };
-    
+        }, cleanup);
+        functionHooks.set(window, unhook);
+      }
+    };
+
     exports.openInfobar = function(window, id, message, buttons, persistence)
     {
       if ("BrowserApp" in window && "selectedTab" in window.BrowserApp)
       {
         window.NativeWindow.doorhanger.show(message, id, buttons, window.BrowserApp.selectedTab.id,
           {
             persistence: persistence
           }
         );
       }
     };
-    
-    exports.loadURI = function(uri)
-    {
-      let window = Services.wm.getMostRecentWindow("navigator:browser");
+
+    exports.loadURI = function(window, uri)
+    {
       if ("BrowserApp" in window && "loadURI" in window.BrowserApp)
         window.BrowserApp.loadURI(uri);
     };
 
     break;
   }
   default:
   {
     exports.isKnownWindow = function(window) false;
     break;
   }
 }