Issue 6402 - Split filter hit / request logging out into own API

lib/whitelisting.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-present 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";
 
-const {defaultMatcher} = require("matcher");
-const {Filter, RegExpFilter} = require("filterClasses");
-const {FilterNotifier} = require("filterNotifier");
-const {FilterStorage} = require("filterStorage");
-const {stringifyURL, getDecodedHostname,
-       extractHostFromFrame, isThirdParty} = require("url");
-const {port} = require("messaging");
-const {logWhitelistedDocument} = require("devLogger");
-const {verifySignature} = require("rsa");
+const {defaultMatcher} = require("../adblockpluscore/lib/matcher");
+const {Filter, RegExpFilter} = require("../adblockpluscore/lib/filterClasses");
+const {FilterNotifier} = require("../adblockpluscore/lib/filterNotifier");
+const {FilterStorage} = require("../adblockpluscore/lib/filterStorage");
+const {extractHostFromFrame, isThirdParty} = require("./url");
+const {port} = require("./messaging");
+const {logWhitelistedDocument} = require("./hitLogger");
+const {verifySignature} = require("../adblockpluscore/lib/rsa");
 
 let sitekeys = 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);
+    docDomain = url.hostname;
 
   let filter = defaultMatcher.whitelist.matchesAny(
-    urlString, typeMask, docDomain, thirdParty, sitekey
+    url.href, typeMask, docDomain, thirdParty, sitekey
   );
 
-  if (filter)
-  {
-    logWhitelistedDocument(
-      page, urlString, typeMask, docDomain, filter
-    );
-  }
+  if (filter && page)
+    logWhitelistedDocument(page.id, url.href, typeMask, docDomain, filter);
 
   return filter;
 }
 
 let checkWhitelisted =
 /**
  * Gets the active whitelisting filter for the document associated
  * with the given page/frame, or null if it's not whitelisted.
  *
- * @param {Page}   page
- * @param {Frame}  [frame]
+ * @param {?Page}   page
+ * @param {?Frame} [frame]
+ * @param {?URL}   [originUrl]
  * @param {number} [typeMask=RegExpFilter.typeMap.DOCUMENT]
  * @return {?WhitelistFilter}
  */
-exports.checkWhitelisted = (page, frame, typeMask) =>
-{
-  if (typeof typeMask == "undefined")
-    typeMask = RegExpFilter.typeMap.DOCUMENT;
-
-  if (frame)
-  {
-    let filter = null;
-
-    while (frame && !filter)
-    {
-      let {parent} = frame;
-      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);
+exports.checkWhitelisted = (page, frame, originUrl,
+                            typeMask = RegExpFilter.typeMap.DOCUMENT) =>
+{
+  if (frame || originUrl)
+  {
+    while (frame)
+    {
+      let parentFrame = frame.parent;
+      let filter = match(page, frame.url, typeMask,
+                         extractHostFromFrame(parentFrame, originUrl),
+                         getKey(page, frame, originUrl));
+
+      if (filter)
+        return filter;
+
+      frame = parentFrame;
+    }
+
+    return originUrl && match(page, originUrl, typeMask, null,
+                              getKey(null, null, originUrl));
+  }
+
+  return page && match(page, page.url, typeMask);
 };
 
 port.on("filters.isWhitelisted", message =>
 {
   return !!checkWhitelisted(new ext.Page(message.tab));
 });
 
 port.on("filters.whitelist", message =>
 {
   let page = new ext.Page(message.tab);
-  let host = getDecodedHostname(page.url).replace(/^www\./, "");
+  let host = page.url.hostname.replace(/^www\./, "");
   let filter = Filter.fromText("@@||" + host + "^$document");
   if (filter.subscriptions.length && filter.disabled)
   {
     filter.disabled = false;
   }
   else
   {
     filter.disabled = false;
     FilterStorage.addFilter(filter);
   }
@@ skipping 30 matching lines @@
   });
 });
 
 ext.pages.onLoading.addListener(revalidateWhitelistingState);
 
 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
+ * @param {?Page}   page
+ * @param {?Frame}  frame
+ * @param {URL}    [originUrl]
  * @return {string}
  */
-exports.getKey = (page, frame) =>
-{
-  let keys = sitekeys.get(page);
-  if (!keys)
-    return null;
-
-  for (; frame != null; frame = frame.parent)
-  {
-    let key = keys.get(stringifyURL(frame.url));
-    if (key)
-      return key;
+exports.getKey = (page, frame, originUrl) =>
+{
+  if (page)
+  {
+    let keys = sitekeys.get(page);
+    if (keys)
+    {
+      for (; frame; frame = frame.parent)
+      {
+        let key = keys.get(frame.url.href);
+        if (key)
+          return key;
+      }
+    }
+  }
+
+  if (originUrl)
+  {
+    for (let keys of sitekeys._map.values())
+    {
+      let key = keys.get(originUrl.href);
+      if (key)
+        return key;
+    }
   }
 
   return null;
 };
 
 function checkKey(token, url)
 {
   let parts = token.split("_");
   if (parts.length < 2)
     return false;
@@ skipping 10 matching lines @@
 }
 
 function recordKey(key, page, url)
 {
   let keys = sitekeys.get(page);
   if (!keys)
   {
     keys = new Map();
     sitekeys.set(page, keys);
   }
-  keys.set(stringifyURL(url), key);
+  keys.set(url.href, key);
 }
 
 port.on("filters.addKey", (message, sender) =>
 {
   let key = checkKey(message.token, sender.frame.url);
   if (key)
     recordKey(key, sender.page, sender.frame.url);
 });
 
 function onHeadersReceived(details)
@@ skipping 19 matching lines @@
 {
   browser.webRequest.onHeadersReceived.addListener(
     onHeadersReceived,
     {
       urls: ["http://*/*", "https://*/*"],
       types: ["main_frame", "sub_frame"]
     },
     ["responseHeaders"]
   );
 }