Issue 6034 - :-abp-contains() accept a regular expression

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
@@ skipping 104 matching lines @@
     let priority = rule.style.getPropertyPriority(property);
     styles.push(`${property}: ${value}${priority ? " !" + priority : ""};`);
   }
   styles.sort();
   return {
     style: styles.join(" "),
     subSelectors: splitSelector(rule.selectorText)
   };
 }
 
+/**
+ * Check if a text argument is a regexp.
+ * @param {string} text argument.
+ * @return {string} an unescaped RegExp string. null if it is not a

[kzar, 2018/01/08 15:29:35]

Shouldn't this be `{?string}`?

[hub, 2018/01/08 16:29:51]

The reference I use for JSDoc doesn't mention this syntax.
http://usejsdoc.org/tags-returns.html

Nor have I seen it used.

[kzar, 2018/01/08 16:56:06]

Well the page you linked says this "@returns [{type}] [description]" and the
page which documents the {type} tag[1] mentions a Nullable Type which uses the
"?" prefix syntax. (Check it still lints though.)

[1] - http://usejsdoc.org/tags-type.html

[hub, 2018/01/08 17:53:13]

Done

+ * regexp, ie not surrounded by '/'.
+ */
+function checkRegExpParameter(text)
+{
+  let regexpString = null;
+  if (text.length >= 2 && text[0] == "/" &&
+      text[text.length - 1] == "/")
+  {
+    regexpString = text.slice(1, -1)
+      .replace("\\7B ", "{").replace("\\7D ", "}");
+  }
+  return regexpString;
+}
+
 function* evaluate(chain, index, prefix, subtree, styles)
 {
   if (index >= chain.length)
   {
     yield prefix;
     return;
   }
   for (let [selector, element] of
        chain[index].getSelectors(prefix, subtree, styles))
   {
@@ skipping 82 matching lines @@
           // :scope isn't supported on Edge, ignore error caused by it.
         }
       }
       yield null;
     }
   }
 };
 
 function ContainsSelector(textContent)
 {
-  this._text = textContent;
+  let regexpString = checkRegExpParameter(textContent);
+  if (regexpString)
+    this._regexp = new RegExp(regexpString);

[kzar, 2018/01/08 15:35:01]

Probably a dumb question, but how come with the PropsSelector constructor we use
filterToRegExp to convert the text into a RegExp if it isn't already one, but
with the ContainsSelector we're instead storing the text?

[hub, 2018/01/08 16:29:51]

PropsSelector search for the CSS properties using regexp. So we have to
construct a Regexp from a plain text string if needed.
ContainsSelector doesn't use Regexp if it can avoid it (a simple substring
match), so we take a different approach.

[hub, 2018/01/10 06:05:17]

The newer revision of the patch changed this as regexp are faster than
String.includes(). So yes we use filterToRegexp in both case.

+  else
+    this._text = textContent;
 }
 
 ContainsSelector.prototype = {
   requiresHiding: true,
 
+  match(element)
+  {
+    if (this._regexp)
+      return this._regexp.test(element.textContent);
+
+    return element.textContent.includes(this._text);
+  },
+
   *getSelectors(prefix, subtree, stylesheet)
   {
     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.includes(this._text))
+      if (this.match(element))
         yield element;
       else
         yield null;
     }
   }
 };
 
 function PropsSelector(propertyExpression)
 {
-  let regexpString;
-  if (propertyExpression.length >= 2 && propertyExpression[0] == "/" &&
-      propertyExpression[propertyExpression.length - 1] == "/")
-  {
-    regexpString = propertyExpression.slice(1, -1)
-      .replace("\\7B ", "{").replace("\\7D ", "}");
-  }
-  else
+  let regexpString = checkRegExpParameter(propertyExpression);
+  if (!regexpString)
     regexpString = filterToRegExp(propertyExpression);
 
   this._regexp = new RegExp(regexpString, "i");
 }
 
 PropsSelector.prototype = {
   preferHideWithSelector: true,
   dependsOnStyles: true,
 
   *findPropsSelectors(styles, prefix, regexp)
@@ skipping 329 matching lines @@
           characterData: true,
           subtree: true
         }
       );
       this.document.addEventListener("load", this.onLoad.bind(this), true);
     }
   }
 };
 
 exports.ElemHideEmulation = ElemHideEmulation;