Issue 154 - Added devtools panel showing blocked and blockable items

background.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
@@ skipping 12 matching lines @@
   this.RegExpFilter = RegExpFilter;
 }
 with(require("subscriptionClasses"))
 {
   this.Subscription = Subscription;
   this.DownloadableSubscription = DownloadableSubscription;
   this.SpecialSubscription = SpecialSubscription;
 }
 with(require("whitelisting"))
 {
-  this.isPageWhitelisted = isPageWhitelisted;
-  this.isFrameWhitelisted = isFrameWhitelisted;
+  this.checkWhitelisted = checkWhitelisted;
   this.processKey = processKey;
   this.getKey = getKey;
 }
 with(require("url"))
 {
   this.stringifyURL = stringifyURL;
   this.isThirdParty = isThirdParty;
   this.extractHostFromFrame = extractHostFromFrame;
 }
 var FilterStorage = require("filterStorage").FilterStorage;
 var FilterNotifier = require("filterNotifier").FilterNotifier;
 var ElemHide = require("elemHide").ElemHide;
 var defaultMatcher = require("matcher").defaultMatcher;
 var Prefs = require("prefs").Prefs;
 var Synchronizer = require("synchronizer").Synchronizer;
 var Utils = require("utils").Utils;
 var parseFilters = require("filterValidation").parseFilters;
 var composeFilters = require("filterComposer").composeFilters;
 var updateIcon = require("icon").updateIcon;
 var initNotifications = require("notificationHelper").initNotifications;
 var showNextNotificationForUrl = require("notificationHelper").showNextNotificationForUrl;
+var devtools = require("devtools");
 
 var seenDataCorruption = false;
 var filterlistsReinitialized = false;
 
 function init()
 {
   var filtersLoaded = new Promise(function(resolve)
   {
     function onFilterAction(action)
     {
@@ skipping 53 matching lines @@
   contexts: ["image", "video", "audio"],
   onclick: function(page)
   {
     page.sendMessage({type: "clickhide-new-filter"});
   }
 };
 
 // Adds or removes browser action icon according to options.
 function refreshIconAndContextMenu(page)
 {
-  var whitelisted = isPageWhitelisted(page);
+  var whitelisted = !!checkWhitelisted(page);
   updateIcon(page, whitelisted);
 
   // show or hide the context menu entry dependent on whether
   // adblocking is active on that page
   page.contextMenus.remove(contextMenuItem);
   if (Prefs.shouldShowBlockElementMenu && !whitelisted && htmlPages.has(page))
     page.contextMenus.create(contextMenuItem);
 }
 
 function refreshIconAndContextMenuForAllPages()
@@ skipping 138 matching lines @@
 
   return {filters: filters, exceptions: exceptions};
 }
 
 ext.onMessage.addListener(function (msg, sender, sendResponse)
 {
   switch (msg.type)
   {
     case "get-selectors":
       var selectors = [];
+      var trace = devtools && devtools.hasPanel(sender.page);
 
-      if (!isFrameWhitelisted(sender.page, sender.frame,
-                              RegExpFilter.typeMap.DOCUMENT | RegExpFilter.typeMap.ELEMHIDE))
+      if (!checkWhitelisted(sender.page, sender.frame,
+                            RegExpFilter.typeMap.DOCUMENT |
+                            RegExpFilter.typeMap.ELEMHIDE))
       {
         var noStyleRules = false;
-        var specificOnly = isFrameWhitelisted(sender.page, sender.frame,
-                                              RegExpFilter.typeMap.GENERICHIDE);
+        var specificOnly = checkWhitelisted(sender.page, sender.frame,
+                                            RegExpFilter.typeMap.GENERICHIDE);
         var host = extractHostFromFrame(sender.frame);
 
         for (var i = 0; i < noStyleRulesHosts.length; i++)
         {
           var noStyleHost = noStyleRulesHosts[i];
           if (host == noStyleHost || (host.length > noStyleHost.length &&
                                       host.substr(host.length - noStyleHost.length - 1) == "." + noStyleHost))
           {
             noStyleRules = true;
           }
         }
         selectors = ElemHide.getSelectorsForDomain(host, specificOnly);
         if (noStyleRules)
         {
           selectors = selectors.filter(function(s)
           {
             return !/\[style[\^\$]?=/.test(s);
           });
         }
       }
 
-      sendResponse(selectors);
+      sendResponse({selectors: selectors, trace: trace});
       break;
     case "should-collapse":
-      if (isFrameWhitelisted(sender.page, sender.frame, RegExpFilter.typeMap.DOCUMENT))
+      if (checkWhitelisted(sender.page, sender.frame))
       {
         sendResponse(false);
         break;
       }
 
       var typeMask = RegExpFilter.typeMap[msg.mediatype];
       var documentHost = extractHostFromFrame(sender.frame);
       var sitekey = getKey(sender.page, sender.frame);
       var blocked = false;
 
@@ skipping 17 matching lines @@
         }
       }
 
       sendResponse(blocked && Prefs.hidePlaceholders);
       break;
     case "get-domain-enabled-state":
       // Returns whether this domain is in the exclusion list.
       // The browser action popup asks us this.
       if(sender.page)
       {
-        sendResponse({enabled: !isPageWhitelisted(sender.page)});
+        sendResponse({enabled: !checkWhitelisted(sender.page)});
         return;
       }
       break;
     case "add-filters":
       var result = parseFilters(msg.text);
 
       if (result.errors.length > 0)
       {
         sendResponse({status: "invalid", error: result.errors.join("\n")});
         break;
@@ skipping 18 matching lines @@
         src: msg.src,
         style: msg.style,
         classes: msg.classes,
         urls: msg.urls,
         type: msg.mediatype,
         baseURL: msg.baseURL,
         page: sender.page,
         frame: sender.frame
       }));
       break;
+    case "trace-elemhide":
+      devtools.logHiddenElements(
+        sender.page, msg.selectors,
+        extractHostFromFrame(sender.frame)
+      );
+      break;
     case "forward":
       if (sender.page)
       {
         if (msg.expectsResponse)
         {
           sender.page.sendMessage(msg.payload, sendResponse);
           return true;
         }
 
         sender.page.sendMessage(msg.payload);
       }
       break;
   }
 });
 
 // update icon when page changes location
 ext.pages.onLoading.addListener(function(page)
 {
   page.sendMessage({type: "clickhide-deactivate"});
   refreshIconAndContextMenu(page);
   showNextNotificationForUrl(page.url);
 });