Issue 6437 - Filter out patterns that do not match DOM mutations

lib/content/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";
 
 const {textToRegExp, filterToRegExp, splitSelector} = require("../common");
+const {indexOf} = require("../coreUtils");
 
 let MIN_INVOCATION_INTERVAL = 3000;
 const MAX_SYNCHRONOUS_PROCESSING_TIME = 50;
 const abpSelectorRegexp = /:-abp-([\w-]+)\(/i;
+
+function getCachedPropertyValue(object, name, defaultValueFunc = () => {})
+{
+  let value = object[name];
+  if (typeof value == "undefined")
+    Object.defineProperty(object, name, {value: value = defaultValueFunc()});
+  return value;
+}
 
 /** Return position of node from parent.
  * @param {Node} node the node to find the position of.
  * @return {number} One-based index like for :nth-child(), or 0 on error.
  */
 function positionInParent(node)
 {
-  let {children} = node.parentNode;
-  for (let i = 0; i < children.length; i++)
-    if (children[i] == node)
-      return i + 1;
-  return 0;
-}
-
-function makeSelector(node, selector)
+  return indexOf(node.parentNode.children, node) + 1;
+}
+
+function makeSelector(node, selector = "")
 {
   if (node == null)
     return null;
   if (!node.parentElement)
   {
     let newSelector = ":root";
     if (selector)
       newSelector += " > " + selector;
     return newSelector;
   }
@@ skipping 162 matching lines @@
   // Just in case the getSelectors() generator above had to run some heavy
   // document.querySelectorAll() call which didn't produce any results, make
   // sure there is at least one point where execution can pause.
   yield null;
 }
 
 function PlainSelector(selector)
 {
   this._selector = selector;
   this.maybeDependsOnAttributes = /[#.]|\[.+\]/.test(selector);
+  this.dependsOnDOM = this.maybeDependsOnAttributes;

[Manish Jethani, 2018/04/24 13:58:32]

OK, since Trac #6618 is rejected we have to process these selectors when there's
a DOM mutation (otherwise the testPlainAttributeOnDomMutation test doesn't
pass).

 }
 
 PlainSelector.prototype = {
   /**
    * Generator function returning a pair of selector
    * string and subtree.
    * @param {string} prefix the prefix for the selector.
    * @param {Node} subtree the subtree we work on.
    * @param {StringifiedStyle[]} styles the stringified style objects.
    */
@@ skipping 29 matching lines @@
   get maybeDependsOnAttributes()
   {
     return this._innerSelectors.some(
       selector => selector.maybeDependsOnAttributes
     );
   },
 
   *getSelectors(prefix, subtree, styles)
   {
     for (let element of this.getElements(prefix, subtree, styles))
-      yield [makeSelector(element, ""), element];
+      yield [makeSelector(element), element];
   },
 
   /**
    * Generator function returning selected elements.
    * @param {string} prefix the prefix for the selector.
    * @param {Node} subtree the subtree we work on.
    * @param {StringifiedStyle[]} styles the stringified style objects.
    */
   *getElements(prefix, subtree, styles)
   {
@@ skipping 24 matching lines @@
 }
 
 ContainsSelector.prototype = {
   requiresHiding: true,
   dependsOnDOM: true,
   dependsOnCharacterData: true,
 
   *getSelectors(prefix, subtree, styles)
   {
     for (let element of this.getElements(prefix, subtree, styles))
-      yield [makeSelector(element, ""), subtree];
+      yield [makeSelector(element), subtree];
   },
 
   *getElements(prefix, subtree, styles)
   {
     let actualPrefix = (!prefix || incompletePrefixRegexp.test(prefix)) ?
         prefix + "*" : prefix;
 
     let elements = scopedQuerySelectorAll(subtree, actualPrefix);
+
     if (elements)
     {
+      let lastRoot = null;
       for (let element of elements)
       {
+        // For a filter like div:-abp-contains(Hello) and a subtree like
+        // <div id="a"><div id="b"><div id="c">Hello</div></div></div>
+        // we're only interested in div#a
+        if (lastRoot && lastRoot.contains(element))
+        {
+          yield null;
+          continue;
+        }
+
+        lastRoot = element;
+
         if (this._regexp && this._regexp.test(element.textContent))
           yield element;
         else
           yield null;
       }
     }
   }
 };
 
 function PropsSelector(propertyExpression)
@@ skipping 33 matching lines @@
         }
   },
 
   *getSelectors(prefix, subtree, styles)
   {
     for (let selector of this.findPropsSelectors(styles, prefix, this._regexp))
       yield [selector, subtree];
   }
 };
 
-function isSelectorHidingOnlyPattern(pattern)
-{
-  return pattern.selectors.some(s => s.preferHideWithSelector) &&
-    !pattern.selectors.some(s => s.requiresHiding);
-}
-
-function patternDependsOnStyles(pattern)
-{
-  return pattern.selectors.some(s => s.dependsOnStyles);
-}
-
-function patternDependsOnDOM(pattern)
-{
-  return pattern.selectors.some(s => s.dependsOnDOM);
-}
-
-function patternDependsOnStylesAndDOM(pattern)
-{
-  return pattern.selectors.some(s => s.dependsOnStyles && s.dependsOnDOM);
-}
-
-function patternMaybeDependsOnAttributes(pattern)
-{
-  // Observe changes to attributes if either there's a plain selector that
-  // looks like an ID selector, class selector, or attribute selector in one of
-  // the patterns (e.g. "a[href='https://example.com/']")
-  // or there's a properties selector nested inside a has selector
-  // (e.g. "div:-abp-has(:-abp-properties(color: blue))")
-  return pattern.selectors.some(

[Manish Jethani, 2018/03/02 13:23:42]

One obvious optimization is that a pattern can remember whether or not it
matches a certain kind of mutation, since patterns are immutable once created
(we can formalize this with a class). Next patch.

-    selector => selector.maybeDependsOnAttributes ||
-                (selector instanceof HasSelector &&
-                 selector.dependsOnStyles)
-  );
-}
-
-function patternDependsOnCharacterData(pattern)
-{
-  // Observe changes to character data only if there's a contains selector in
-  // one of the patterns.
-  return pattern.selectors.some(selector => selector.dependsOnCharacterData);
-}
-
-function patternMatchesMutationTypes(pattern, mutationTypes)
-{
-  return mutationTypes.has("childList") ||
-         (mutationTypes.has("attributes") &&
-          patternMaybeDependsOnAttributes(pattern)) ||
-         (mutationTypes.has("characterData") &&
-          patternDependsOnCharacterData(pattern));
-}
+function Pattern(selectors, text)
+{
+  this.selectors = selectors;
+  this.text = text;
+}
+
+Pattern.prototype = {
+  isSelectorHidingOnlyPattern()
+  {
+    return getCachedPropertyValue(
+      this, "_selectorHidingOnlyPattern",
+      () => this.selectors.some(selector => selector.preferHideWithSelector) &&
+            !this.selectors.some(selector => selector.requiresHiding)
+    );
+  },
+
+  get dependsOnStyles()
+  {
+    return getCachedPropertyValue(
+      this, "_dependsOnStyles",
+      () => this.selectors.some(selector => selector.dependsOnStyles)
+    );
+  },
+
+  get dependsOnDOM()
+  {
+    return getCachedPropertyValue(
+      this, "_dependsOnDOM",
+      () => this.selectors.some(selector => selector.dependsOnDOM)
+    );
+  },
+
+  get dependsOnStylesAndDOM()
+  {
+    return getCachedPropertyValue(
+      this, "_dependsOnStylesAndDOM",
+      () => this.selectors.some(selector => selector.dependsOnStyles &&
+                                            selector.dependsOnDOM)
+    );
+  },
+
+  get maybeDependsOnAttributes()
+  {
+    // Observe changes to attributes if either there's a plain selector that
+    // looks like an ID selector, class selector, or attribute selector in one
+    // of the patterns (e.g. "a[href='https://example.com/']")
+    // or there's a properties selector nested inside a has selector
+    // (e.g. "div:-abp-has(:-abp-properties(color: blue))")
+    return getCachedPropertyValue(
+      this, "_maybeDependsOnAttributes",
+      () => this.selectors.some(
+              selector => selector.maybeDependsOnAttributes ||
+                          (selector instanceof HasSelector &&
+                           selector.dependsOnStyles)
+            )
+    );
+  },
+
+  get dependsOnCharacterData()
+  {
+    // Observe changes to character data only if there's a contains selector in
+    // one of the patterns.
+    return getCachedPropertyValue(
+      this, "_dependsOnCharacterData",
+      () => this.selectors.some(selector => selector.dependsOnCharacterData)
+    );
+  },
+
+  matchesMutationTypes(mutationTypes)
+  {
+    let mutationTypeMatchMap = getCachedPropertyValue(
+      this, "_mutationTypeMatchMap",
+      () => new Map([
+        // All types of DOM-dependent patterns are affected by mutations of
+        // type "childList".
+        ["childList", true],
+        ["attributes", this.maybeDependsOnAttributes],
+        ["characterData", this.dependsOnCharacterData]
+      ])
+    );
+
+    for (let mutationType of mutationTypes)
+    {
+      if (mutationTypeMatchMap.get(mutationType))
+        return true;
+    }
+
+    return false;
+  }
+};
 
 function extractMutationTypes(mutations)
 {
   let types = new Set();
 
   for (let mutation of mutations)
   {
     types.add(mutation.type);
 
     // There are only 3 types of mutations: "attributes", "characterData", and
     // "childList".
     if (types.size == 3)
       break;
   }
 
   return types;
 }
 
 function filterPatterns(patterns, {stylesheets, mutations})
 {
   if (!stylesheets && !mutations)

[Manish Jethani, 2018/03/02 13:23:42]

Do full processing.

     return patterns.slice();
 
   let mutationTypes = mutations ? extractMutationTypes(mutations) : null;
 
-  return patterns.filter(pattern =>
-    (stylesheets && patternDependsOnStyles(pattern)) ||
-    (mutations && patternDependsOnDOM(pattern) &&
-     patternMatchesMutationTypes(pattern, mutationTypes))
+  return patterns.filter(
+    pattern => (stylesheets && pattern.dependsOnStyles) ||
+               (mutations && pattern.dependsOnDOM &&
+                pattern.matchesMutationTypes(mutationTypes))
   );
 }
 
 function shouldObserveAttributes(patterns)
 {
-  return patterns.some(patternMaybeDependsOnAttributes);
+  return patterns.some(pattern => pattern.maybeDependsOnAttributes);
 }
 
 function shouldObserveCharacterData(patterns)
 {
-  return patterns.some(patternDependsOnCharacterData);
+  return patterns.some(pattern => pattern.dependsOnCharacterData);
 }
 
 function ElemHideEmulation(addSelectorsFunc, hideElemsFunc)
 {
   this.document = document;
   this.addSelectorsFunc = addSelectorsFunc;
   this.hideElemsFunc = hideElemsFunc;
   this.observer = new MutationObserver(this.observe.bind(this));
+  this.useInlineStyles = true;
 }
 
 ElemHideEmulation.prototype = {
   isSameOrigin(stylesheet)
   {
     try
     {
       return new URL(stylesheet.href).origin == this.document.location.origin;
     }
     catch (e)
@@ skipping 97 matching lines @@
     // do full processing.
     if (!stylesheets && !mutations)
       stylesheets = this.document.styleSheets;
 
     // If there are any DOM mutations and any of the patterns depends on both
     // style sheets and the DOM (e.g. -abp-has(-abp-properties)), find all the
     // rules in every style sheet in the document, because we need to run
     // querySelectorAll afterwards. On the other hand, if we only have patterns
     // that depend on either styles or DOM both not both
     // (e.g. -abp-properties or -abp-contains), we can skip this part.
-    if (mutations && patterns.some(patternDependsOnStylesAndDOM))
+    if (mutations && patterns.some(pattern => pattern.dependsOnStylesAndDOM))
       stylesheets = this.document.styleSheets;
 
     for (let stylesheet of stylesheets || [])
     {
       // Explicitly ignore third-party stylesheets to ensure consistent behavior
       // between Firefox and Chrome.
       if (!this.isSameOrigin(stylesheet))
         continue;
 
-      let rules = stylesheet.cssRules;
+      let rules;
+      try
+      {
+        rules = stylesheet.cssRules;
+      }
+      catch (e)
+      {
+        // On Firefox, there is a chance that an InvalidAccessError
+        // get thrown when accessing cssRules. Just skip the stylesheet
+        // in that case.
+        // See https://searchfox.org/mozilla-central/rev/f65d7528e34ef1a7665b4a1a7b7cdb1388fcd3aa/layout/style/StyleSheet.cpp#699
+        continue;
+      }
+
       if (!rules)
         continue;
 
       for (let rule of rules)
       {
         if (rule.type != rule.STYLE_RULE)
           continue;
 
         cssStyles.push(stringifyStyle(rule));
       }
     }
 
     let pattern = null;
     let generator = null;
 
     let processPatterns = () =>
     {
       let cycleStart = performance.now();
 
       if (!pattern)
       {
         if (!patterns.length)
         {
-          this.addSelectorsFunc(selectors, selectorFilters);
-          this.hideElemsFunc(elements, elementFilters);
+          if (selectors.length > 0)
+            this.addSelectorsFunc(selectors, selectorFilters);
+          if (elements.length > 0)
+            this.hideElemsFunc(elements, elementFilters);
           if (typeof done == "function")
             done();
           return;
         }
 
         pattern = patterns.shift();
 
         generator = evaluate(pattern.selectors, 0, "",
                              this.document, cssStyles);
       }
       for (let selector of generator)
       {
         if (selector != null)
         {
-          if (isSelectorHidingOnlyPattern(pattern))
+          if (!this.useInlineStyles ||
+              pattern.isSelectorHidingOnlyPattern())
           {
             selectors.push(selector);
             selectorFilters.push(pattern.text);
           }
           else
           {
             for (let element of this.document.querySelectorAll(selector))
             {
               elements.push(element);
               elementFilters.push(pattern.text);
@@ skipping 39 matching lines @@
    *    for full reprocessing.
    */
   queueFiltering(stylesheets, mutations)
   {
     let completion = () =>
     {
       this._lastInvocation = performance.now();
       this._filteringInProgress = false;
       if (this._scheduledProcessing)
       {
-        let {stylesheets, mutations} = this._scheduledProcessing;
+        let params = Object.assign({}, this._scheduledProcessing);
         this._scheduledProcessing = null;
-        this.queueFiltering(stylesheets, mutations);
+        this.queueFiltering(params.stylesheets, params.mutations);
       }
     };
 
     if (this._scheduledProcessing)
     {
       if (!stylesheets && !mutations)
       {
         this._scheduledProcessing = {};
       }
-      else
+      else if (this._scheduledProcessing.stylesheets ||
+               this._scheduledProcessing.mutations)
       {
         if (stylesheets)
         {
           if (!this._scheduledProcessing.stylesheets)
             this._scheduledProcessing.stylesheets = [];
           this._scheduledProcessing.stylesheets.push(...stylesheets);
         }
         if (mutations)
         {
           if (!this._scheduledProcessing.mutations)
             this._scheduledProcessing.mutations = [];
           this._scheduledProcessing.mutations.push(...mutations);
         }
       }
     }
     else if (this._filteringInProgress)
     {
       this._scheduledProcessing = {stylesheets, mutations};
     }
     else if (performance.now() - this._lastInvocation < MIN_INVOCATION_INTERVAL)
     {
       this._scheduledProcessing = {stylesheets, mutations};
       setTimeout(() =>
       {
-        let {stylesheets, mutations} = this._scheduledProcessing;
+        let params = Object.assign({}, this._scheduledProcessing);
         this._filteringInProgress = true;
         this._scheduledProcessing = null;
-        this._addSelectors(stylesheets, mutations, completion);
+        this._addSelectors(params.stylesheets, params.mutations, completion);
       },
       MIN_INVOCATION_INTERVAL - (performance.now() - this._lastInvocation));
     }
     else if (this.document.readyState == "loading")
     {
       this._scheduledProcessing = {stylesheets, mutations};
       let handler = () =>
       {
-        document.removeEventListener("DOMContentLoaded", handler);
-        let {stylesheets, mutations} = this._scheduledProcessing;
+        this.document.removeEventListener("DOMContentLoaded", handler);
+        let params = Object.assign({}, this._scheduledProcessing);
         this._filteringInProgress = true;
         this._scheduledProcessing = null;
-        this._addSelectors(stylesheets, mutations, completion);
+        this._addSelectors(params.stylesheets, params.mutations, completion);
       };
-      document.addEventListener("DOMContentLoaded", handler);
+      this.document.addEventListener("DOMContentLoaded", handler);
     }
     else
     {
       this._filteringInProgress = true;
       this._addSelectors(stylesheets, mutations, completion);
     }
   },
 
   onLoad(event)
   {
     let stylesheet = event.target.sheet;
     if (stylesheet)
       this.queueFiltering([stylesheet]);
   },
 
   observe(mutations)
   {
     this.queueFiltering(null, mutations);
   },
 
   apply(patterns)
   {
     this.patterns = [];
     for (let pattern of patterns)
     {
       let selectors = this.parseSelector(pattern.selector);
       if (selectors != null && selectors.length > 0)
-        this.patterns.push({selectors, text: pattern.text});
+        this.patterns.push(new Pattern(selectors, pattern.text));
     }
 
     if (this.patterns.length > 0)
     {
       this.queueFiltering();
       this.observer.observe(
         this.document,
         {
           childList: true,
           attributes: shouldObserveAttributes(this.patterns),
           characterData: shouldObserveCharacterData(this.patterns),
           subtree: true
         }
       );
       this.document.addEventListener("load", this.onLoad.bind(this), true);
     }
   }
 };
 
 exports.ElemHideEmulation = ElemHideEmulation;