Issue 154 - Added devtools panel showing blocked and blockable items

webrequest.js

 /*
- * This file is part of Adblock Plus <http://adblockplus.org/>,
- * Copyright (C) 2006-2014 Eyeo GmbH
+ * 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/>.
  */
 
 var FilterNotifier = require("filterNotifier").FilterNotifier;
+var RegExpFilter = require("filterClasses").RegExpFilter;
 var platform = require("info").platform;
-var logRequest = require("devtools").logRequest;
+var devtools = require("devtools");
 
-var onFilterChangeTimeout = null;
-function onFilterChange()
+ext.webRequest.getIndistinguishableTypes().forEach(function(types)
 {
-  onFilterChangeTimeout = null;
-  ext.webRequest.handlerBehaviorChanged();
-}
+  for (var i = 1; i < types.length; i++)
+    RegExpFilter.typeMap[types[i]] = RegExpFilter.typeMap[types[0]];
+});
 
-var importantNotifications = {
-  'filter.added': true,
-  'filter.removed': true,
-  'filter.disabled': true,
-  'subscription.added': true,
-  'subscription.removed': true,
-  'subscription.disabled': true,
-  'subscription.updated': true,
-  'load': true
-};
-
-FilterNotifier.addListener(function(action)
+FilterNotifier.addListener(function(action, arg)
 {
-  if (action in importantNotifications)
+  switch (action)
   {
-    // Execute delayed to prevent multiple executions in a quick succession
-    if (onFilterChangeTimeout != null)
-      window.clearTimeout(onFilterChangeTimeout);
-    onFilterChangeTimeout = window.setTimeout(onFilterChange, 2000);
+    case "filter.added":
+    case "filter.removed":
+    case "filter.disabled":
+      // Only request blocking/whitelisting filters have
+      // an effect on the webRequest handler behavior.
+      if (!(arg instanceof RegExpFilter))
+        break;
+    case "subscription.added":
+    case "subscription.removed":
+    case "subscription.disabled":
+    case "subscription.updated":
+    case "load":
+      ext.webRequest.handlerBehaviorChanged();
+      break;
   }
 });
 
+function onBeforeRequestAsync(page, url, type, docDomain,
+                              thirdParty, key, specificOnly,
+                              filter)
+{
+  if (filter)
+    FilterNotifier.triggerListeners("filter.hitCount", filter, 0, 0, page);
+
+  if (devtools)
+    devtools.logRequest(
+      page, url, type, docDomain,
+      thirdParty, key, specificOnly,
+      filter
+    );
+}
+
 function onBeforeRequest(url, type, page, frame)
 {
-  if (isFrameWhitelisted(page, frame))
+  if (checkWhitelisted(page, frame))
     return true;
 
-  var reqType = type == "sub_frame" ? "SUBDOCUMENT" : type.toUpperCase();
+  var urlString = stringifyURL(url);
   var docDomain = extractHostFromFrame(frame);
+  var thirdParty = isThirdParty(url, docDomain);
   var key = getKey(page, frame);
-  var filter = defaultMatcher.matchesAny(
-    url,
-    reqType,
-    docDomain,
-    isThirdParty(extractHostFromURL(url), docDomain),
-    key
+
+  var specificOnly = !!checkWhitelisted(
+    page, frame, RegExpFilter.typeMap.GENERICBLOCK
   );
 
-  // We can't listen to onHeadersReceived in Safari so we need to
-  // check for notifications here
-  if (platform != "chromium" && type == "sub_frame")
-  {
-    var notificationToShow = Notification.getNextToShow(url);
-    if (notificationToShow)
-      showNotification(notificationToShow);
-  }
+  var filter = defaultMatcher.matchesAny(
+    urlString, RegExpFilter.typeMap[type],
+    docDomain, thirdParty, key, specificOnly
+  );
 
-  logRequest(page._id, url, reqType, docDomain, key, filter);
-  FilterNotifier.triggerListeners("filter.hitCount", filter, 0, 0, page);
+  setTimeout(onBeforeRequestAsync, 0, page, urlString,
+                                      type, docDomain,
+                                      thirdParty, key,
+                                      specificOnly, filter);
 
   return !(filter instanceof BlockingFilter);
 }
 
 ext.webRequest.onBeforeRequest.addListener(onBeforeRequest);
 
 if (platform == "chromium")
 {
   function onHeadersReceived(details)
   {
-    if (details.tabId == -1)
-      return;
-
-    if (details.type != "main_frame" && details.type != "sub_frame")
-      return;
-
     var page = new ext.Page({id: details.tabId});
     var frame = ext.getFrame(details.tabId, details.frameId);
 
-    if (!frame || frame.url != details.url)
+    if (!frame || frame.url.href != details.url)
       return;
 
     for (var i = 0; i < details.responseHeaders.length; i++)
     {
       var header = details.responseHeaders[i];
       if (header.name.toLowerCase() == "x-adblock-key" && header.value)
         processKey(header.value, page, frame);
     }
-
-    var notificationToShow = Notification.getNextToShow(details.url);
-    if (notificationToShow)
-      showNotification(notificationToShow);
   }
 
-  chrome.webRequest.onHeadersReceived.addListener(onHeadersReceived, {urls: ["http://*/*", "https://*/*"]}, ["responseHeaders"]);
+  chrome.webRequest.onHeadersReceived.addListener(
+    onHeadersReceived,
+    {
+      urls: ["http://*/*", "https://*/*"],
+      types: ["main_frame", "sub_frame"]
+    },
+    ["responseHeaders"]
+  );
 }