Issue 6665 - Optimize element hiding emulation filter lookups

lib/elemHideEmulation.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/>.
  */
 
 "use strict";
 
 /**
  * @fileOverview Element hiding emulation implementation.
  */
 
 const {ElemHide} = require("./elemHide");
-const {Filter} = require("./filterClasses");
+const {filterIt, mapIt, flattenIt, regExpIt} = require("./coreUtils");
 
-let filters = new Set();
+/**
+ * Map of element hiding emulation filters by domain
+ * @type {Map.<string,Set.<ElemHideEmulationFilter>>}
+ */
+let filtersByDomain = new Map();
+
+/**
+ * Set containing known element hiding emulation filters
+ * @type {Set.<ElemHideEmulation>}
+ */
+let knownFilters = new Set();
+
+function* filterDomains(filter)
+{
+  yield* mapIt(filterIt(filter.domains || [], ([domain]) => domain != ""),
+               ([domain, include]) => [domain, include,
+                                       filtersByDomain.get(domain)]);
+}
+
+function* subdomains(domain)
+{
+  yield* mapIt(regExpIt(/([^|]*)\|/g, domain.replace(/([^.]+\.)/g, "$'|")),
+               ([, subdomain]) => subdomain);
+}
+
+function* filtersForDomain(domain)
+{
+  yield* filtersByDomain.get(domain) || [];
+
+  yield* flattenIt(mapIt(subdomains(domain),
+                         subdomain => filtersByDomain.get(subdomain) || []));
+}
 
 /**
  * Container for element hiding emulation filters
  * @class
  */
 let ElemHideEmulation = {
   /**
    * Removes all known filters
    */
   clear()
   {
-    filters.clear();
+    filtersByDomain.clear();
   },
 
   /**
    * Add a new element hiding emulation filter
    * @param {ElemHideEmulationFilter} filter
    */
   add(filter)
   {
-    filters.add(filter.text);
+    if (knownFilters.has(filter))
+      return;
+
+    for (let [domain, include, filters] of filterDomains(filter))
+    {
+      if (filters)
+        filters.set(filter, include);
+      else
+        filtersByDomain.set(domain, new Map([[filter, include]]));
+    }
+
+    knownFilters.add(filter);
   },
 
   /**
    * Removes an element hiding emulation filter
    * @param {ElemHideEmulationFilter} filter
    */
   remove(filter)
   {
-    filters.delete(filter.text);
+    if (!knownFilters.has(filter))
+      return;
+
+    for (let [domain, , filters] of filterDomains(filter))
+    {
+      if (filters)
+      {
+        filters.delete(filter);
+
+        if (filters.size == 0)
+          filtersByDomain.delete(domain);
+      }
+    }
+
+    knownFilters.delete(filter);
   },
 
   /**
    * Returns a list of all rules active on a particular domain
    * @param {string} domain
    * @return {ElemHideEmulationFilter[]}
    */
   getRulesForDomain(domain)
   {
     let result = [];
-    for (let text of filters.values())
+
+    let excludeSet = new Set();

[Manish Jethani, 2018/05/13 20:39:48]

The logic here is similar to lib/elemHide.js

Eventually we can merge the two modules, but that will be more work. The changes
here are relatively simple so we can do this first.

+    for (let [filter, include] of filtersForDomain(domain.toUpperCase()))
     {
-      let filter = Filter.fromText(text);
-      if (filter.isActiveOnDomain(domain) &&
-          !ElemHide.getException(filter, domain))
+      if (!include)
+      {
+        excludeSet.add(filter);
+      }
+      else if ((excludeSet.size == 0 || !excludeSet.has(filter)) &&
+               !ElemHide.getException(filter, domain))
       {
         result.push(filter);
       }
     }
+
     return result;
   }
 };
 exports.ElemHideEmulation = ElemHideEmulation;