Issue 3251 - Add shouldAllowAsync() function for non-urgent policy checks

lib/child/contentPolicy.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2015 Eyeo GmbH
  *
  * Adblock Plus is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License version 3 as
  * published by the Free Software Foundation.
  *
  * Adblock Plus is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
@@ skipping 42 matching lines @@
  * @type Map.<number,string>
  */
 let types = new Map();
 
 /**
  * Checks whether a request should be allowed, hides it if necessary
  * @param wnd {nsIDOMWindow}
  * @param node {nsIDOMElement}
  * @param contentType {String}
  * @param location {String}
+ * @param [callback] {Function} If present, the request will be sent
+ *                              asynchronously and callback called with the
+ *                              response
  * @return {Boolean} false if the request should be blocked
  */
-function shouldAllow(window, node, contentType, location)
+function shouldAllow(window, node, contentType, location, callback)

[tschuster, 2015/11/12 13:38:13]

This should really be two functions. If you reuse processResponse the
duplication should be small.

[Wladimir Palant, 2015/11/12 15:01:13]

Done.

 {
-  let response = sendSyncMessage("AdblockPlus:ShouldAllow", {
+  function processResponse(response)
+  {
+    if (typeof response == "undefined")
+      return true;
+
+    let {allow, collapse, hits} = response;
+    for (let {frameIndex, contentType, docDomain, thirdParty, location, filter} of hits)
+    {
+      let context = node;
+      if (typeof frameIndex == "number")
+      {
+        context = window;
+        for (let i = 0; i < frameIndex; i++)
+          context = context.parent;
+        context = context.document;
+      }
+      RequestNotifier.addNodeData(context, window.top, contentType, docDomain, thirdParty, location, filter);
+    }
+
+    if (node.nodeType == Ci.nsIDOMNode.ELEMENT_NODE)
+    {
+      // Track mouse events for objects
+      if (allow && contentType == "OBJECT")
+      {
+        node.addEventListener("mouseover", objectMouseEventHander, true);
+        node.addEventListener("mouseout", objectMouseEventHander, true);
+      }
+
+      if (collapse)
+        schedulePostProcess(node);
+    }
+    return allow;
+  }

[Wladimir Palant, 2015/11/04 15:05:22]

The diff is messy but all the code above has merely been moved around.

+
+  let data = {
     contentType: contentType,
     location: location,
     frames: getFrames(window),
     isPrivate: isPrivate(window)
-  });
-  if (typeof response == "undefined")
-    return true;
-
-  let {allow, collapse, hits} = response;
-  for (let {frameIndex, contentType, docDomain, thirdParty, location, filter} of hits)
+  };
+  if (typeof callback == "function")
   {
-    let context = node;
-    if (typeof frameIndex == "number")
-    {
-      context = window;
-      for (let i = 0; i < frameIndex; i++)
-        context = context.parent;
-      context = context.document;
-    }
-    RequestNotifier.addNodeData(context, window.top, contentType, docDomain, thirdParty, location, filter);
+    sendAsyncMessage("AdblockPlus:ShouldAllow", data, (data) => {
+      callback(processResponse(data));
+    });
   }
-
-  if (node.nodeType == Ci.nsIDOMNode.ELEMENT_NODE)
-  {
-    // Track mouse events for objects
-    if (allow && contentType == "OBJECT")
-    {
-      node.addEventListener("mouseover", objectMouseEventHander, true);
-      node.addEventListener("mouseout", objectMouseEventHander, true);
-    }
-
-    if (collapse)
-      schedulePostProcess(node);
-  }
-
-  return allow;
+  else
+    return processResponse(sendSyncMessage("AdblockPlus:ShouldAllow", data));
 }
 
 /**
  * Actual nsIContentPolicy and nsIChannelEventSink implementation
  * @class
  */
 var PolicyImplementation =
 {
   classDescription: "Adblock Plus content policy",
   classID: Components.ID("cfeaabe6-1dd1-11b2-a0c6-cb5c268894c9"),
@@ skipping 113 matching lines @@
       }
     }
   },
 
   //
   // nsIChannelEventSink interface implementation
   //
 
   asyncOnChannelRedirect: function(oldChannel, newChannel, flags, callback)
   {
-    let result = Cr.NS_OK;
+    let async = false;
     try
     {
       // nsILoadInfo.contentPolicyType was introduced in Gecko 35, then
       // renamed to nsILoadInfo.externalContentPolicyType in Gecko 44.
       let loadInfo = oldChannel.loadInfo;
       let contentType = ("externalContentPolicyType" in loadInfo ?
           loadInfo.externalContentPolicyType : loadInfo.contentPolicyType);
       if (!contentType)
         return;
 
       let wnd = Utils.getRequestWindow(newChannel);
       if (!wnd)
         return;
 
       if (contentType == Ci.nsIContentPolicy.TYPE_DOCUMENT)
       {
         if (wnd.history.length <= 1 && wnd.opener)
         {
           // Special treatment for pop-up windows. Note that we might not have
           // seen the original channel yet because the redirect happened before
           // the async code in observe() had a chance to run.
           this.observe(wnd, "content-document-global-created", null, oldChannel.URI.spec);
           this.observe(wnd, "content-document-global-created", null, newChannel.URI.spec);
         }
         return;
       }
 
-      if (!shouldAllow(wnd, wnd.document, types.get(contentType), newChannel.URI.spec))
-        result = Cr.NS_BINDING_ABORTED;
+      shouldAllow(wnd, wnd.document, types.get(contentType), newChannel.URI.spec, function(allow)
+      {
+        callback.onRedirectVerifyCallback(allow ? Cr.NS_OK : Cr.NS_BINDING_ABORTED);
+      });
+      async = true;
     }
     catch (e)
     {
       // We shouldn't throw exceptions here - this will prevent the redirect.
       Cu.reportError(e);
     }
     finally
     {
-      callback.onRedirectVerifyCallback(result);
+      if (!async)
+        callback.onRedirectVerifyCallback(Cr.NS_OK);
     }
   },
 
   //
   // nsIFactory interface implementation
   //
 
   createInstance: function(outer, iid)
   {
     if (outer)
@@ skipping 62 matching lines @@
         let property = (hasCols ? "cols" : "rows");
         let weights = parentNode[property].split(",");
         weights[index] = "0";
         parentNode[property] = weights.join(",");
       }
     }
     else
       node.classList.add(collapsedClass);
   }
 }