Issue 2738 - Pass bit masks to matching functions

lib/whitelisting.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
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
  * along with Adblock Plus.  If not, see <http://www.gnu.org/licenses/>.
  */
 
 /** @module whitelisting */
 
 let {defaultMatcher} = require("matcher");
+let {RegExpFilter} = require("filterClasses");
 let {stringifyURL, getDecodedHostname, extractHostFromFrame, isThirdParty} = require("url");
 
 let pagesWithKey = new ext.PageMap();
 
 /**
  * Checks whether a page is whitelisted.
  *
  * @param {Page} page
+ * @param {Number} [typeMask=RegExpFilter.typeMap.DOCUMENT]  Bit mask of request / content types to match
  * @return {WhitelistFilter} The active filter whitelisting this page or null
  */
-exports.isPageWhitelisted = function(page)
+exports.isPageWhitelisted = function(page, typeMask)

[Sebastian Noack, 2015/07/13 16:41:50]

Sorry if my previous comment was misleading. But since isPageWhitelisted() is
never called with an explicit type, there is no point in adding an argument for
that. I were actually only talking about isFrameWhitelisted(), which of course
should pass through the bitmask rather than converting a string into one.

[kzar, 2015/07/14 09:22:24]

Done.

 {
   let url = page.url;
 
   return defaultMatcher.whitelist.matchesAny(
-    stringifyURL(url), "DOCUMENT",
+    stringifyURL(url), typeMask || RegExpFilter.typeMap.DOCUMENT,
     getDecodedHostname(url), false, null
   );
 };
 
 /**
  * Checks whether a frame is whitelisted.
  *
  * @param {Page}   page
  * @param {Frame}  frame
- * @param {string} [type=DOCUMENT]  The request type to check whether
- *                                  the frame is whitelisted for.
+ * @param {Number} [typeMask=RegExpFilter.typeMap.DOCUMENT]  Bit mask of request / content types to match

[Sebastian Noack, 2015/07/13 16:41:50]

Nit: Please use lowercase when referring to primitive types. Otherwise it would
be ambiguous with the Number wrapper object.

[kzar, 2015/07/14 09:22:24]

Done.

  * @return {Boolean}
  */
-exports.isFrameWhitelisted = function(page, frame, type)
+exports.isFrameWhitelisted = function(page, frame, typeMask)
 {
   while (frame)
   {
     let parent = frame.parent;
     let url = frame.url;
     let documentHost = extractHostFromFrame(parent) || getDecodedHostname(url);
 
     let filter = defaultMatcher.whitelist.matchesAny(
-      stringifyURL(url), type || "DOCUMENT",
+      stringifyURL(url), typeMask || RegExpFilter.typeMap.DOCUMENT,
       documentHost, isThirdParty(url, documentHost),
       getKey(page, frame)
     );
 
     if (filter)
       return true;
 
     frame = parent;
   }
 
@@ skipping 63 matching lines @@
 {
   if (token.indexOf("_") < 0)
     return;
 
   let [key, signature] = token.split("_", 2);
   key = key.replace(/=/g, "");
 
   if (verifyKey(key, signature, frame.url))
     recordKey(page, frame.url, key);
 };