Issue 1282 - Don't generate filters conflicting with existing exception rules

lib/filterComposer.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 19 matching lines @@
   // char code as well.
   if (code <= 0x1F || code == 0x7F || /[\d\{\}]/.test(chr))
     return "\\" + code.toString(16) + " ";
 
   return "\\" + chr;
 }
 
 /**
  * Escapes a token (e.g. tag, id, class or attribute) to be used in CSS selectors.
  *
- * @param {string} [s]
+ * @param {string} s
  * @return {string}
  */
 function escapeCSS(s)
 {
   return s.replace(/^[\d\-]|[^\w\-\u0080-\uFFFF]/g, escapeChar);
 }
 exports.escapeCSS = escapeCSS;
 
 /**
  * Quotes a string to be used as attribute value in CSS selectors.
  *
- * @param {string} [value]
+ * @param {string} value
  * @return {string}
  */
 function quoteCSS(value)
 {
   return '"' + value.replace(/["\\\{\}\x00-\x1F\x7F]/g, escapeChar) + '"';
 }
 exports.quoteCSS = quoteCSS;
 
-function canBlockURL(url, type, page, frame)
-{
-  if (url.protocol != "http:" && url.protocol != "https:")
-    return false;
-
-  let docDomain = extractHostFromFrame(frame);
-  let filter = defaultMatcher.matchesAny(
-    stringifyURL(url), type, docDomain,
-    isThirdParty(url, docDomain), getKey(page, frame)
-  );
-
-  return !(filter instanceof WhitelistFilter);
-}
-
 /**
  * Generates filters to block an element.
- *
- * @param {string}   [tagName] The element's tag name
- * @param {string}   [src]     The element's "src" attribute (can be null)
- * @param {string}   [id]      The element's "id" attribute (can be null)
- * @param {string}   [style]   The element's "style" attribute (can be null)
- * @param {string[]} [classes] The classes given by the element's "class" attribute
- * @param {string[]} [urls]    The URLs considered when loading the element
- * @param {string}   [type]    The request type (will be ignored if there are no URLs)
- * @param {string}   [baseURL] The URL of the document containing the element
- * @param {Page}     [page]    The page containing the element
- * @param {Frame}    [frame]   The frame containing the element
+ * @param {Object}   details
+ * @param {string}   details.tagName  The element's tag name
+ * @param {string}   detials.id       The element's "id" attribute
+ * @param {string}   details.src      The element's "src" attribute
+ * @param {string}   details.style    The element's "style" attribute
+ * @param {string[]} details.classes  The classes given by the element's "class" attribute
+ * @param {string[]} details.urls     The URLs considered when loading the element
+ * @param {string}   details.type     The request type (will be ignored if there are no URLs)
+ * @param {string}   details.baseURL  The URL of the document containing the element
+ * @param {Page}     details.page     The page containing the element
+ * @param {Frame}    details.frame    The frame containing the element

[Wladimir Palant, 2015/03/03 19:17:01]

I wonder whether JsDoc Toolkit will actually accept that parameter list if we
ever let it work on this code...

[Sebastian Noack, 2015/03/03 19:18:54]

Why not? This is official JSDoc syntax:
http://usejsdoc.org/tags-param.html#parameters-with-properties

[Wladimir Palant, 2015/03/03 20:11:47]

Yes, seems to be supported by our version as well:
https://code.google.com/p/jsdoc-toolkit/wiki/TagParam

  *
  * @return {object} An object holding the list of generated filters and
  *                  the list of CSS selectors for the included element
  *                  hiding filters: {filters: [...], selectors: [...]}
  */
-function composeFilters(tagName, id, src, style, classes, urls, type, baseURL, page, frame)
+function composeFilters(details)
 {
-  // Add a blocking filter for each URL of the element that can be blocked
   let filters = [];
-  for (let url of urls)
+  let selectors = [];
+
+  let page = details.page;
+  let frame = details.frame;
+
+  if (!isFrameWhitelisted(page, frame, "DOCUMENT"))
   {
-    let urlObj = new URL(url, baseURL);
-    if (canBlockURL(urlObj, type, page, frame))
+    let docDomain = extractHostFromFrame(frame);
+
+    // Add a blocking filter for each URL of the element that can be blocked
+    for (let url of details.urls)
     {
-      let filter = stringifyURL(urlObj).replace(/^[\w\-]+:\/+(?:www\.)?/, "||");
+      let urlObj = new URL(url, details.baseURL);
 
-      if (filters.indexOf(filter) == -1)
-        filters.push(filter);
+      if (urlObj.protocol == "http:" || urlObj.protocol == "https:")
+      {
+        url = stringifyURL(urlObj);
+
+        let filter = defaultMatcher.matchesAny(
+          url, details.type, docDomain,
+          isThirdParty(urlObj, docDomain),
+          getKey(page, frame)
+        );
+
+        if (!(filter instanceof WhitelistFilter))
+        {
+          let filterText = url.replace(/^[\w\-]+:\/+(?:www\.)?/, "||");
+
+          if (filters.indexOf(filterText) == -1)
+            filters.push(filterText);
+        }
+      }
     }
-  }
 
-  let selectors = [];
-  if (!isFrameWhitelisted(page, frame, "ELEMHIDE"))
-  {
-    // Generate CSS selectors based on the element's "id" and "class" attribute
-    if (id)
-      selectors.push("#" + escapeCSS(id));
-    if (classes.length > 0)
-      selectors.push(classes.map(c => "." + escapeCSS(c)).join(""));
+    // If we couldn't generate any blocking filters, fallback to element hiding
+    let selectors = [];
+    if (filters.length == 0 && !isFrameWhitelisted(page, frame, "ELEMHIDE"))
+    {
+      // Generate CSS selectors based on the element's "id" and "class" attribute
+      if (details.id)
+        selectors.push("#" + escapeCSS(details.id));
+      if (details.classes.length > 0)
+        selectors.push(details.classes.map(c => "." + escapeCSS(c)).join(""));
 
-    // If there is a "src" attribute, specifiying a URL that we can't block,
-    // generate a CSS selector matching the "src" attribute
-    if (src && !canBlockURL(new URL(src, baseURL), type, page, frame))
-      selectors.push(escapeCSS(tagName) + "[src=" + quoteCSS(src) + "]");
+      // If there is a "src" attribute, specifiying a URL that we can't block,
+      // generate a CSS selector matching the "src" attribute
+      if (details.src)
+        selectors.push(escapeCSS(details.tagName) + "[src=" + quoteCSS(details.src) + "]");
 
-    // As last resort, if there is a "style" attribute, and we couldn't generate
-    // any filters so far, generate a CSS selector matching the "style" attribute
-    if (style && selectors.length == 0 && filters.length == 0)
-      selectors.push(escapeCSS(tagName) + "[style=" + quoteCSS(style) + "]");
+      // As last resort, if there is a "style" attribute, and we couldn't generate
+      // any filters so far, generate a CSS selector matching the "style" attribute
+      if (details.style && selectors.length == 0 && filters.length == 0)
+        selectors.push(escapeCSS(details.tagName) + "[style=" + quoteCSS(details.style) + "]");
 
-    // Add an element hiding filter for each generated CSS selector
-    if (selectors.length > 0)
-    {
-      let domain = extractHostFromFrame(frame).replace(/^www\./, "");
-
+      // Add an element hiding filter for each generated CSS selector
       for (let selector of selectors)
-        filters.push(domain + "##" + selector);
+        filters.push(docDomain.replace(/^www\./, "") + "##" + selector);
     }
   }
 
   return {filters: filters, selectors: selectors};
 }
 exports.composeFilters = composeFilters;