Issue 3251 - Delegate processing of element hiding hits to shouldAllowAsync() so that hits show up

lib/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 15 matching lines @@
 
 let {Utils} = require("utils");
 let {Prefs} = require("prefs");
 let {FilterStorage} = require("filterStorage");
 let {BlockingFilter, WhitelistFilter, RegExpFilter} = require("filterClasses");
 let {defaultMatcher} = require("matcher");
 let {objectMouseEventHander} = require("objectTabs");
 let {ElemHide} = require("elemHide");
 
 /**
- * Randomly generated class name, to be applied to collapsed nodes.
- * @type string
- */
-let collapsedClass = "";
-
-/**
  * Public policy checking functions and auxiliary objects
  * @class
  */
 var Policy = exports.Policy =
 {
   /**
    * Set of explicitly supported content types
    * @type Set.<string>
    */
   contentTypes: new Set([
@@ skipping 20 matching lines @@
   /**
    * Called on module startup, initializes various exported properties.
    */
   init: function()
   {
     // whitelisted URL schemes
     for (let scheme of Prefs.whitelistschemes.toLowerCase().split(" "))
       this.whitelistSchemes.add(scheme);
 
     Utils.addChildMessageListener("AdblockPlus:ShouldAllow", this.shouldAllow.bind(this));
-    Utils.addChildMessageListener("AdblockPlus:GetCollapsedClass", () => collapsedClass);
-
-    // Generate class identifier used to collapse node and register corresponding
-    // stylesheet.
+
+    // Generate class identifier used to collapse nodes and register
+    // corresponding stylesheet.
+    let collapsedClass = "";
     let offset = "a".charCodeAt(0);
     for (let i = 0; i < 20; i++)
       collapsedClass +=  String.fromCharCode(offset + Math.random() * 26);
+    Utils.addChildMessageListener("AdblockPlus:GetCollapsedClass", () => collapsedClass);
 
     let collapseStyle = Services.io.newURI("data:text/css," +
         encodeURIComponent("." + collapsedClass +
         "{-moz-binding: url(chrome://global/content/bindings/general.xml#foobarbazdummy) !important;}"), null, null);
     Utils.styleService.loadAndRegisterSheet(collapseStyle, Ci.nsIStyleSheetService.USER_SHEET);
     onShutdown.add(() =>
     {
       Utils.styleService.unregisterSheet(collapseStyle, Ci.nsIStyleSheetService.USER_SHEET);
     });
   },
 
   /**
    * Checks whether a node should be blocked, hides it if necessary
-   * @param contentType {String}
-   * @param location {String}
-   * @param fremes {Object[]}
-   * @param isPrivate {Boolean}  true if the request belongs to a private browsing window
+   * @param {Object} data  request data
+   * @param {String} data.contentType
+   * @param {String} data.location  location of the request, filter key if contentType is ELEMHIDE
+   * @param {Object[]} data.frames
+   * @param {Boolean} data.isPrivate  true if the request belongs to a private browsing window
    * @return {Object} An object containing properties block, collapse and hits
    *                  indicating how this request should be handled.
    */
   shouldAllow: function({contentType, location, frames, isPrivate})
   {
     let hits = [];
 
     function addHit(frameIndex, contentType, docDomain, thirdParty, location, filter)
     {
       if (filter && !isPrivate)
@@ skipping 55 matching lines @@
               nogenericMatch);
         }
 
         if (frame == testSitekeyFrame)
           [testSitekey, testSitekeyFrame] = getSitekey(frames.slice(i + 1));
       }
     }
 
     if (!match && contentType == "ELEMHIDE")
     {
       match = ElemHide.getFilterByKey(location);

[tschuster, 2015/11/05 15:39:36]

So this is better, but we should still document that we get a key for location
when the contentType is ELEMHIDE.

[Wladimir Palant, 2015/11/06 11:29:00]

Done.

       location = match.text.replace(/^.*?#/, '#');
 
       if (!match.isActiveOnDomain(docDomain))
         return response(true, false);
 
       let exception = ElemHide.getException(match, docDomain);
       if (exception)
       {
         addHit(null, contentType, docDomain, false, location, exception);
         return response(true, false);
@@ skipping 211 matching lines @@
   if (!wnd || wnd.closed)
     return;
 
   if (entry.type == "OBJECT")
   {
     node.removeEventListener("mouseover", objectMouseEventHander, true);
     node.removeEventListener("mouseout", objectMouseEventHander, true);
   }
   Policy.processNode(wnd, node, entry.type, entry.location, true);
 }