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 42 matching lines @@
  * @return {string}
  */
 function quoteCSS(value)
 {
   return '"' + value.replace(/["\\\{\}\x00-\x1F\x7F]/g, escapeChar) + '"';
 }
 exports.quoteCSS = quoteCSS;
 
 /**
  * Generates filters to block an element.
- *
- * @param {string}   tagName     The element's tag name
- * @param {Object}   attributes  The element's "id", "src" and "style attreibute
- * @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, attributes, classes, urls, type, baseURL, page, frame)
+function composeFilters(details)
 {
   let filters = [];
   let selectors = [];
+
+  let page = details.page;
+  let frame = details.frame;
 
   if (!isFrameWhitelisted(page, frame, "DOCUMENT"))
   {
     let docDomain = extractHostFromFrame(frame);
 
     // Add a blocking filter for each URL of the element that can be blocked
-    for (let url of urls)
+    for (let url of details.urls)
     {
-      let urlObj = new URL(url, baseURL);
+      let urlObj = new URL(url, details.baseURL);
 
-      if (url.protocol == "http:" || url.protocol == "https:")
+      if (urlObj.protocol == "http:" || urlObj.protocol == "https:")
       {
         url = stringifyURL(urlObj);
 
         let filter = defaultMatcher.matchesAny(
-          url, type, docDomain,
+          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);
         }
       }
     }
 
     // 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 (attributes.id)
-        selectors.push("#" + escapeCSS(attributes.id));
-      if (classes.length > 0)
-        selectors.push(classes.map(c => "." + escapeCSS(c)).join(""));
+      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 (attributes.src)
-        selectors.push(escapeCSS(tagName) + "[src=" + quoteCSS(attributes.src) + "]");
+      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 (attributes.style && selectors.length == 0 && filters.length == 0)
-        selectors.push(escapeCSS(tagName) + "[style=" + quoteCSS(attributes.style) + "]");
+      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
       for (let selector of selectors)
         filters.push(docDomain.replace(/^www\./, "") + "##" + selector);
     }
   }
 
   return {filters: filters, selectors: selectors};
 }
 exports.composeFilters = composeFilters;