Issue 5249 - Implement :-abp-contains()

chrome/content/elemHideEmulation.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/>.
  */
 
 /* globals filterToRegExp */
 
 "use strict";
 
 const abpSelectorRegexp = /:-abp-([\w-]+)\(/i;
 
+let reportError = () => {};
+
 function splitSelector(selector)
 {
   if (selector.indexOf(",") == -1)
     return [selector];
 
   let selectors = [];
   let start = 0;
   let level = 0;
   let sep = "";
 
@@ skipping 87 matching lines @@
       if (parens == 0)
         break;
     }
   }
 
   if (parens > 0)
     return null;
   return {text: content.substring(startIndex, i), end: i};
 }
 
-/** Parse the selector
- * @param {string} selector the selector to parse
- * @return {Object} selectors is an array of objects,
- * or null in case of errors. hide is true if we'll hide
- * elements instead of styles..
- */
-function parseSelector(selector)
-{
-  if (selector.length == 0)
-    return [];
-
-  let match = abpSelectorRegexp.exec(selector);
-  if (!match)
-    return [new PlainSelector(selector)];
-
-  let selectors = [];
-  if (match.index > 0)
-    selectors.push(new PlainSelector(selector.substr(0, match.index)));
-
-  let startIndex = match.index + match[0].length;
-  let content = parseSelectorContent(selector, startIndex);
-  if (content == null)
-  {
-    console.error(new SyntaxError("Failed parsing AdBlock Plus " +
-                                  `selector ${selector}, didn't ` +
-                                  "find closing parenthesis."));
-    return null;
-  }
-  if (match[1] == "properties")
-    selectors.push(new PropsSelector(content.text));
-  else if (match[1] == "has")
-  {
-    let hasSelector = new HasSelector(content.text);
-    if (!hasSelector.valid())
-      return null;
-    selectors.push(hasSelector);
-  }
-  else if (match[1] == "contains")
-    selectors.push(new ContainsSelector(content.text));
-  else
-  {
-    // this is an error, can't parse selector.
-    console.error(new SyntaxError("Failed parsing AdBlock Plus " +
-                                  `selector ${selector}, invalid ` +
-                                  `pseudo-class -abp-${match[1]}().`));
-    return null;
-  }
-
-  let suffix = parseSelector(selector.substr(content.end + 1));
-  if (suffix == null)
-    return null;
-
-  selectors.push(...suffix);
-
-  return selectors;
-}
-
 /** Stringified style objects
  * @typedef {Object} StringifiedStyle
- * @property {string} style CSS style represented a string.
- * @property {string[]} subSelectors selectors for the rule.
+ * @property {string} style CSS style represented by a string.
+ * @property {string[]} subSelectors selectors the CSS properties apply to.
  */
 
 /**
- * Turn a CSSStyleRule into a StringifiedStyle
+ * Produce a string representation of the stylesheet entry.
  * @param {CSSStyleRule} rule the CSS style rule.
  * @return {StringifiedStyle} the stringified style.
  */
 function stringifyStyle(rule)
 {
   let styles = [];
   for (let i = 0; i < rule.style.length; i++)
   {
     let property = rule.style.item(i);
     let value = rule.style.getPropertyValue(property);
     let priority = rule.style.getPropertyPriority(property);
-    styles.push(property + ": " + value + (priority ? " !" + priority : "") +
-                ";");
+    styles.push(`${property}: ${value}${priority ? " !" + priority : ""};`);
   }
   styles.sort();
   return {
     style: styles.join(" "),
     subSelectors: splitSelector(rule.selectorText)
   };
 }
 
 function* evaluate(chain, index, prefix, subtree, styles)
 {
@@ skipping 21 matching lines @@
    * @param {StringifiedStyle[]} styles the stringified style objects.
    */
   *getSelectors(prefix, subtree, styles)
   {
     yield [prefix + this._selector, subtree];
   }
 };
 
 const incompletePrefixRegexp = /[\s>+~]$/;
 
-function HasSelector(selector)
-{
-  this._innerSelectors = parseSelector(selector);
+function HasSelector(selectors)
+{
+  this._innerSelectors = selectors;
 }
 
 HasSelector.prototype = {
   requiresHiding: true,
-
-  valid()
-  {
-    return this._innerSelectors != null;
-  },
 
   *getSelectors(prefix, subtree, styles)
   {
     for (let element of this.getElements(prefix, subtree, styles))
       yield [makeSelector(element, ""), element];
   },
 
   /**
    * Generator function returning selected elements.
    * @param {string} prefix the prefix for the selector.
@@ skipping 32 matching lines @@
     for (let element of this.getElements(prefix, subtree, stylesheet))
       yield [makeSelector(element, ""), subtree];
   },
 
   *getElements(prefix, subtree, stylesheet)
   {
     let actualPrefix = (!prefix || incompletePrefixRegexp.test(prefix)) ?
         prefix + "*" : prefix;
     let elements = subtree.querySelectorAll(actualPrefix);
     for (let element of elements)
-      if (element.textContent == this._text)
+      if (element.textContent.includes(this._text))
         yield element;
   }
 };
 
 function PropsSelector(propertyExpression)
 {
   let regexpString;
   if (propertyExpression.length >= 2 && propertyExpression[0] == "/" &&
       propertyExpression[propertyExpression.length - 1] == "/")
   {
     regexpString = propertyExpression.slice(1, -1)
       .replace("\\x7B ", "{").replace("\\x7D ", "}");
   }
   else
     regexpString = filterToRegExp(propertyExpression);
 
   this._regexp = new RegExp(regexpString, "i");
 }
 
 PropsSelector.prototype = {
+  preferHideWithSelector: true,
+
   *findPropsSelectors(styles, prefix, regexp)
   {
     for (let style of styles)
       if (regexp.test(style.style))
         for (let subSelector of style.subSelectors)
           yield prefix + subSelector;
   },
 
   *getSelectors(prefix, subtree, styles)
   {
@@ skipping 18 matching lines @@
     {
       return new URL(stylesheet.href).origin == this.window.location.origin;
     }
     catch (e)
     {
       // Invalid URL, assume that it is first-party.
       return true;
     }
   },
 
+  /** Parse the selector
+   * @param {string} selector the selector to parse
+   * @return {Array} selectors is an array of objects,
+   * or null in case of errors.
+   */
+  parseSelector(selector)
+  {
+    if (selector.length == 0)
+      return [];
+
+    let match = abpSelectorRegexp.exec(selector);
+    if (!match)
+      return [new PlainSelector(selector)];
+
+    let selectors = [];
+    if (match.index > 0)
+      selectors.push(new PlainSelector(selector.substr(0, match.index)));
+
+    let startIndex = match.index + match[0].length;
+    let content = parseSelectorContent(selector, startIndex);
+    if (!content)
+    {
+      this.window.console.error(
+        new SyntaxError("Failed to parse Adblock Plus " +
+                        `selector ${selector} ` +
+                        "due to unmatched parentheses."));
+      return null;
+    }
+    if (match[1] == "properties")
+      selectors.push(new PropsSelector(content.text));
+    else if (match[1] == "has")
+    {
+      let hasSelectors = this.parseSelector(content.text);
+      if (hasSelectors == null)
+        return null;
+      selectors.push(new HasSelector(hasSelectors));
+    }
+    else if (match[1] == "contains")
+      selectors.push(new ContainsSelector(content.text));
+    else
+    {
+      // this is an error, can't parse selector.
+      this.window.console.error(
+        new SyntaxError("Failed to parse Adblock Plus " +
+                        `selector ${selector}, invalid ` +
+                        `pseudo-class :-abp-${match[1]}().`));
+      return null;
+    }
+
+    let suffix = this.parseSelector(selector.substr(content.end + 1));
+    if (suffix == null)
+      return null;
+
+    selectors.push(...suffix);
+
+    if (selectors.length == 1 && selectors[0] instanceof ContainsSelector)
+    {
+      this.window.console.error(
+        new SyntaxError("Failed to parse Adblock Plus " +
+                        `selector ${selector}, can't ` +
+                        "have a lonely :-abp-contains()."));
+      return null;
+    }
+    return selectors;
+  },
+
   addSelectors(stylesheets)
   {
     let selectors = [];
     let selectorFilters = [];
 
     let elements = [];
     let elementFilters = [];
 
     let cssStyles = [];
 
@@ skipping 10 matching lines @@
 
       for (let rule of rules)
       {
         if (rule.type != rule.STYLE_RULE)
           continue;
 
         cssStyles.push(stringifyStyle(rule));
       }
     }
 
+    let {document} = this.window;
     for (let pattern of this.patterns)
     {
       for (let selector of evaluate(pattern.selectors,
                                     0, "", document, cssStyles))
       {
-        if (!pattern.selectors.some(s => s.requiresHiding))
+        if (pattern.selectors.some(s => s.preferHideWithSelector) &&
+            !pattern.selectors.some(s => s.requiresHiding))
         {
           selectors.push(selector);
           selectorFilters.push(pattern.text);
         }
         else
         {
           for (let element of document.querySelectorAll(selector))
           {
             elements.push(element);
             elementFilters.push(pattern.text);
@@ skipping 13 matching lines @@
       this.addSelectors([stylesheet]);
   },
 
   apply()
   {
     this.getFiltersFunc(patterns =>
     {
       this.patterns = [];
       for (let pattern of patterns)
       {
-        let selectors = parseSelector(pattern.selector);
+        let selectors = this.parseSelector(pattern.selector);
         if (selectors != null && selectors.length > 0)
           this.patterns.push({selectors, text: pattern.text});
       }
 
       if (this.patterns.length > 0)
       {
         let {document} = this.window;
         this.addSelectors(document.styleSheets);
         document.addEventListener("load", this.onLoad.bind(this), true);
       }
     });
   }
 };