Issue 5117 - Identify ElemHideEmulationFilters based on the filter text in the devtools panel

lib/devtools.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2017 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/>.
  */
 
 "use strict";
 
 const {RegExpFilter,
        WhitelistFilter,
-       ElemHideFilter,
-       ElemHideEmulationFilter} = require("filterClasses");
-
+       ElemHideFilter} = require("filterClasses");
 const {SpecialSubscription} = require("subscriptionClasses");
 const {FilterStorage} = require("filterStorage");
 const {defaultMatcher} = require("matcher");
 const {FilterNotifier} = require("filterNotifier");
 const {extractHostFromFrame} = require("url");
 const {port} = require("messaging");
 
 const nonRequestTypes = ["DOCUMENT", "ELEMHIDE", "GENERICBLOCK", "GENERICHIDE"];
 
 // Mapping of inspected tabs to their devpanel page
@@ skipping 108 matching lines @@
   {
     let request = {url, type, docDomain, thirdParty, sitekey, specificOnly};
     addRecord(panel, request, filter);
   }
 };
 
 /**
  * Logs active element hiding filters to the devtools panel.
  *
  * @param {Page}     page       The page the elements were hidden on
- * @param {string[]} selectors  The CSS selectors of active elemhide filters
+ * @param {string[]} selectors  The selectors of applied ElemHideFilters
+ * @param {string[]} filters    The text of applied ElemHideEmulationFilters
  * @param {string}   docDomain  The IDN-decoded hostname of the document
  */
-function logHiddenElements(page, selectors, docDomain)
+function logHiddenElements(page, selectors, filters, docDomain)
 {
   let panel = getActivePanel(page);
   if (panel)
   {
     for (let subscription of FilterStorage.subscriptions)
     {
       if (subscription.disabled)
         continue;
 
       for (let filter of subscription.filters)
       {
-        if (!(filter instanceof ElemHideFilter) &&
-            !(filter instanceof ElemHideEmulationFilter))
-          continue;
-        if (selectors.indexOf(filter.selector) == -1)
-          continue;
-        if (!filter.isActiveOnDomain(docDomain))
-          continue;
+        // We only know the exact filter in case of element hiding emulation.
+        // For regular element hiding filters, the content script only knows
+        // the selector, so we have to find a filter that has an identical
+        // selector and is active on the domain the match was reported from.
+        let isActiveElemHideFilter = filter instanceof ElemHideFilter &&
+                                     selectors.includes(filter.selector) &&
+                                     filter.isActiveOnDomain(docDomain);
 
-        addRecord(panel, {type: "ELEMHIDE", docDomain}, filter);
+        if (isActiveElemHideFilter || filters.includes(filter.text))
+          addRecord(panel, {type: "ELEMHIDE", docDomain}, filter);
       }
     }
   }
 }
 
 /**
  * Logs a whitelisting filter, that disables (some kind of)
  * blocking for a particular document, to the devtools panel.
  *
  * @param {Page}         page      The page the whitelisting is active on
@@ skipping 186 matching lines @@
       FilterNotifier.off("subscription.added", onSubscriptionAdded);
     }
   });
 
   panels[inspectedTabId] = {port: newPort, records: []};
 });
 
 port.on("devtools.traceElemHide", (message, sender) =>
 {
   logHiddenElements(
-    sender.page, message.selectors,
+    sender.page, message.selectors, message.filters,
     extractHostFromFrame(sender.frame)
   );
 });