Issue 154 - Added devtools panel showing blocked and blockable items

lib/whitelisting.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2016 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 */
 
+"use strict";
+
 let {defaultMatcher} = require("matcher");
 let {RegExpFilter} = require("filterClasses");
 let {stringifyURL, getDecodedHostname, extractHostFromFrame, isThirdParty} = require("url");
+let devtools = require("devtools");
 
 let pagesWithKey = new ext.PageMap();
 
+function match(page, url, typeMask, docDomain, sitekey)
+{
+  let thirdParty = !!docDomain && isThirdParty(url, docDomain);
+  let urlString = stringifyURL(url);
+
+  if (!docDomain)
+    docDomain = getDecodedHostname(url);
+
+  let filter = defaultMatcher.whitelist.matchesAny(
+    urlString, typeMask, docDomain, thirdParty, sitekey
+  );
+
+  if (filter && devtools)
+    devtools.logWhitelistedDocument(
+      page, urlString, typeMask, docDomain, filter
+    );
+
+  return filter;
+}
+
 /**
- * Checks whether a page is whitelisted.
+ * Gets the active whitelisting filter for the document associated
+ * with the given page/frame, or null if it's not whitelisted.
  *
- * @param {Page} page
- * @return {WhitelistFilter} The active filter whitelisting this page or null
+ * @param {Page}   page
+ * @param {Frame}  [frame]
+ * @param {number} [typeMask=RegExpFilter.typeMap.DOCUMENT]
+ * @return {WhitelistFilter?}
  */
-exports.isPageWhitelisted = function(page)
+exports.checkWhitelisted = function(page, frame, typeMask)
 {
-  let url = page.url;
+  if (typeof typeMask == "undefined")
+    typeMask = RegExpFilter.typeMap.DOCUMENT;
 
-  return defaultMatcher.whitelist.matchesAny(
-    stringifyURL(url), RegExpFilter.typeMap.DOCUMENT,
-    getDecodedHostname(url), false, null
-  );
+  if (frame)
+  {
+    let filter = null;
+
+    while (frame && !filter)
+    {
+      let parent = frame.parent;
+      let docDomain = extractHostFromFrame(parent);
+      let sitekey = getKey(page, frame);
+
+      filter = match(page, frame.url, typeMask, docDomain, sitekey);
+      frame = parent;
+    }
+
+    return filter;
+  }
+
+  return match(page, page.url, typeMask);
 };
 
-/**
- * Checks whether a frame is whitelisted.
- *
- * @param {Page}   page
- * @param {Frame}  frame
- * @param {number} [typeMask=RegExpFilter.typeMap.DOCUMENT]  Bit mask of request / content types to match
- * @return {Boolean}
- */
-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), typeMask || RegExpFilter.typeMap.DOCUMENT,
-      documentHost, isThirdParty(url, documentHost),
-      getKey(page, frame)
-    );
-
-    if (filter)
-      return true;
-
-    frame = parent;
-  }
-
-  return false;
-};
+// Compatibility with adblockplusui, to be removed when updating the dependency

[Sebastian Noack, 2016/02/02 10:39:54]

I am going to update adblockplusui and remove that code before landing this
patch.

+exports.isFrameWhitelisted = exports.checkWhitelisted;
 
 let getKey =
 /**
  * Gets the public key, previously recorded for the given page
  * and frame, to be considered for the $sitekey filter option.
  *
  * @param {Page}  page
  * @param {Frame} frame
  * @return {string}
  */
@@ skipping 52 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);
 };