Issue 616 - Add $generichide + $genericblock filter options and enforce them.

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 144 matching lines @@
   {
     let topWnd = wnd.top;
     if (!topWnd || !topWnd.location || !topWnd.location.href)
       return true;
 
     let originWindow = Utils.getOriginWindow(wnd);
     let wndLocation = originWindow.location.href;
     let docDomain = getHostname(wndLocation);
     let match = null;
     let [sitekey, sitekeyWnd] = getSitekey(wnd);
-    let genericblock = null;
+    let nogeneric = false;
+
     if (!match && Prefs.enabled)
     {
       let testWnd = wnd;
       let testSitekey = sitekey;
       let testSitekeyWnd = sitekeyWnd;
       let parentWndLocation = getWindowLocation(testWnd);
       while (true)
       {
         let testWndLocation = parentWndLocation;
         parentWndLocation = (testWnd == testWnd.parent ? testWndLocation : getWindowLocation(testWnd.parent));
         match = Policy.isWhitelisted(testWndLocation, parentWndLocation, testSitekey);
 
         if (match instanceof WhitelistFilter)
         {
           FilterStorage.increaseHitCount(match, wnd);
           RequestNotifier.addNodeData(testWnd.document, topWnd, Policy.type.DOCUMENT, getHostname(parentWndLocation), false, testWndLocation, match);
           return true;
         }
-        else if (contentType != Policy.type.ELEMHIDE)
-        {
-          let parentDocDomain = getHostname(parentWndLocation);
-          let genericblockMatch = defaultMatcher.matchesAny(testWndLocation, RegExpFilter.typeMap.GENERICBLOCK, parentDocDomain, false);

[Thomas Greiner, 2015/08/20 11:36:06]

You forgot to pass the sitekey as the last parameter for
`defaultMatcher.matchesAny()`. Not passing the sitekey would cause filters of
the form `@@...$genericblock,sitekey=...` not to match on pages that provide a
correct sitekey.

[kzar, 2015/08/25 17:42:07]

Done.

-          if (genericblockMatch instanceof WhitelistFilter)
-          {
-            genericblock = {
-              match: genericblockMatch,
-              parentDocDomain: parentDocDomain,
-              testWnd: testWnd,
-              testWndLocation: testWndLocation
-            };
-          }
+
+        let genericType = (contentType == Policy.type.ELEMHIDE ?
+                           RegExpFilter.typeMap.GENERICHIDE :
+                           RegExpFilter.typeMap.GENERICBLOCK);
+        let parentDocDomain = getHostname(parentWndLocation);
+        let nogenericMatch = defaultMatcher.matchesAny(
+          testWndLocation, genericType, parentDocDomain, false, testSitekey
+        );
+        if (nogenericMatch instanceof WhitelistFilter)
+        {
+          nogeneric = true;
+
+          FilterStorage.increaseHitCount(nogenericMatch, wnd);
+          RequestNotifier.addNodeData(testWnd.document, topWnd, contentType,
+                                      parentDocDomain, false, testWndLocation,
+                                      nogenericMatch);
         }
 
         if (testWnd.parent == testWnd)
           break;
 
         if (testWnd == testSitekeyWnd)
           [testSitekey, testSitekeyWnd] = getSitekey(testWnd.parent);
         testWnd = testWnd.parent;
       }
     }
 
     // Data loaded by plugins should be attached to the document
     if (contentType == Policy.type.OBJECT_SUBREQUEST && node instanceof Ci.nsIDOMElement)
       node = node.ownerDocument;
 
     // Fix type for objects misrepresented as frames or images
     if (contentType != Policy.type.OBJECT && (node instanceof Ci.nsIDOMHTMLObjectElement || node instanceof Ci.nsIDOMHTMLEmbedElement))
       contentType = Policy.type.OBJECT;
 
     let locationText = location.spec;
     if (!match && contentType == Policy.type.ELEMHIDE)
     {
       let testWnd = wnd;
       let parentWndLocation = getWindowLocation(testWnd);
       while (true)
       {
         let testWndLocation = parentWndLocation;
         parentWndLocation = (testWnd == testWnd.parent ? testWndLocation : getWindowLocation(testWnd.parent));
         let parentDocDomain = getHostname(parentWndLocation);
-
         match = defaultMatcher.matchesAny(testWndLocation, RegExpFilter.typeMap.ELEMHIDE, parentDocDomain, false, sitekey);
-
-        if (!(match instanceof WhitelistFilter) && (!location.domains || location.domains[""]))

[Thomas Greiner, 2015/08/20 11:36:06]

What about filters that don't specify domains but a sitekey instead? This logic
would consider them to be generic even though they aren't.

[Thomas Greiner, 2015/08/20 11:36:06]

I guess you meant to write

(!match.domains || match.domains[""])

because `location` is a `nsIRUI` which doesn't even have a "domains" property.

[kzar, 2015/08/25 17:42:07]

Done.

-          match = defaultMatcher.matchesAny(testWndLocation, RegExpFilter.typeMap.GENERICHIDE, parentDocDomain, false);
-
         if (match instanceof WhitelistFilter)
         {
           FilterStorage.increaseHitCount(match, wnd);
           RequestNotifier.addNodeData(testWnd.document, topWnd, contentType, parentDocDomain, false, testWndLocation, match);
           return true;
         }
 
         if (testWnd.parent == testWnd)
           break;
         else
           testWnd = testWnd.parent;
       }
 
       match = location;
       locationText = match.text.replace(/^.*?#/, '#');
       location = locationText;
 
       if (!match.isActiveOnDomain(docDomain))
         return true;
 
       let exception = ElemHide.getException(match, docDomain);
       if (exception)
       {
         FilterStorage.increaseHitCount(exception, wnd);
         RequestNotifier.addNodeData(node, topWnd, contentType, docDomain, false, locationText, exception);
         return true;
       }
+
+      if (nogeneric && match.isGeneric())
+        return true;
     }
 
     let thirdParty = (contentType == Policy.type.ELEMHIDE ? false : isThirdParty(location, docDomain));
 
     if (!match && Prefs.enabled && contentType in Policy.typeMask)
     {
-      match = defaultMatcher.matchesAny(locationText, Policy.typeMask[contentType], docDomain, thirdParty, sitekey);
-      if (match instanceof BlockingFilter)
-      {
-        if ((!match.domains || match.domains[""]) && genericblock)
-        {
-          FilterStorage.increaseHitCount(genericblock.match, wnd);
-          RequestNotifier.addNodeData(
-            genericblock.testWnd.document,
-            topWnd, contentType,
-            genericblock.parentDocDomain,
-            false, genericblock.testWndLocation,
-            genericblock.match
-          );
-          return true;
-        }
-
-        if (node.ownerDocument && !(contentType in Policy.nonVisual))
-        {
-          let prefCollapse = (match.collapse != null ? match.collapse : !Prefs.fastcollapse);
-          if (collapse || prefCollapse)
-            schedulePostProcess(node);
-        }
+      match = defaultMatcher.matchesAny(locationText, Policy.typeMask[contentType],
+                                        docDomain, thirdParty, sitekey, nogeneric);
+      if (match instanceof BlockingFilter && node.ownerDocument && !(contentType in Policy.nonVisual))
+      {
+        let prefCollapse = (match.collapse != null ? match.collapse : !Prefs.fastcollapse);
+        if (collapse || prefCollapse)
+          schedulePostProcess(node);
       }
 
       // Track mouse events for objects
       if (!match && contentType == Policy.type.OBJECT && node.nodeType == Ci.nsIDOMNode.ELEMENT_NODE)
       {
         node.addEventListener("mouseover", objectMouseEventHander, true);
         node.addEventListener("mouseout", objectMouseEventHander, true);
       }
     }
 
@@ skipping 534 matching lines @@
   if (!wnd || wnd.closed)
     return;
 
   if (entry.type == Policy.type.OBJECT)
   {
     node.removeEventListener("mouseover", objectMouseEventHander, true);
     node.removeEventListener("mouseout", objectMouseEventHander, true);
   }
   Policy.processNode(wnd, node, entry.type, Utils.makeURI(entry.location), true);
 }