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
  * 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 {filterToRegExp, splitSelector} = require("../common");
+const {escapeRegExp, filterToRegExp, splitSelector} = require("../common");
 
 let MIN_INVOCATION_INTERVAL = 3000;
 const MAX_SYNCHRONOUS_PROCESSING_TIME = 50;
 const abpSelectorRegexp = /:-abp-([\w-]+)\(/i;
 
 /** 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)
@@ skipping 133 matching lines @@
   }
   return all ? subtree.querySelectorAll(selector) :
     subtree.querySelector(selector);
 }
 
 function scopedQuerySelectorAll(subtree, selector)
 {
   return scopedQuerySelector(subtree, selector, true);
 }
 
+const regexpRegexp = /^\/(.*)\/([im]*)$/;
+
+/**
+ * Make a regular expression from a text argument. If it can be parsed as a
+ * regular expression, parse it and the flags.
+ * @param {string} text the text argument.
+ * it overrides flags passed in the text argument.

[Manish Jethani, 2018/02/21 14:41:59]

This line got left out.

[hub, 2018/02/21 21:38:01]

Done.

+ * @return {?RegExp} a RegExp object or null in case of error.
+ */
+function makeRegExpParameter(text)
+{
+  let flags;
+  let regexpString = null;
+  let match = regexpRegexp.exec(text);
+  if (match)

[Manish Jethani, 2018/02/21 14:41:59]

So we're having a discussion on #eyeo-js about modernizing our use of JS a
little. This could be written as:

  let [, regexpString, flags] = regexpRegexp.exec(text) || [,
escapeRegExp(text)];

That's 10 lines of code reduced to one.

[Manish Jethani, 2018/02/21 14:46:38]

That spills over the 80 character line length, but we can just rename it to
"pattern" which is what the RegExp documentation calls it anyway.

So:

  let [, pattern, flags] = regexpRegexp.exec(text) || [, escapeRegExp(text)];
  try
  {
    return new RegExp(pattern, flags);
  }
  catch (e)
  {
  }
  return null;

[hub, 2018/02/21 21:38:00]

Done.

+  {
+    regexpString = match[1];
+    flags = match[2];
+  }
+  else
+    regexpString = escapeRegExp(text);
+
+  try
+  {
+    return new RegExp(regexpString, flags);
+  }
+  catch (e)
+  {
+  }
+  return null;
+}
+
 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 72 matching lines @@
             yield element;
         }
         yield null;
       }
     }
   }
 };
 
 function ContainsSelector(textContent)
 {
-  this._text = textContent;
+  this._regexp = makeRegExpParameter(textContent);
 }
 
 ContainsSelector.prototype = {
   requiresHiding: true,
 
   *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 = scopedQuerySelectorAll(subtree, actualPrefix);
     if (elements)
     {
       for (let element of elements)
       {
-        if (element.textContent.includes(this._text))
+        if (this._regexp && this._regexp.test(element.textContent))
           yield element;
         else
           yield null;
       }
     }
   }
 };
 
 function PropsSelector(propertyExpression)
 {
@@ skipping 10 matching lines @@
   this._regexp = new RegExp(regexpString, "i");
 }
 
 PropsSelector.prototype = {
   preferHideWithSelector: true,
   dependsOnStyles: true,
 
   *findPropsSelectors(styles, prefix, regexp)
   {
     for (let style of styles)
-      if (regexp.test(style.style))
+      if (regexp && regexp.test(style.style))

[Manish Jethani, 2018/02/21 14:41:59]

This check is no longer necessary? (i.e. this._regexp is always non-null)

[hub, 2018/02/21 21:38:00]

Done.

         for (let subSelector of style.subSelectors)
         {
           if (subSelector.startsWith("*") &&
               !incompletePrefixRegexp.test(prefix))
           {
             subSelector = subSelector.substr(1);
           }
           let idx = subSelector.lastIndexOf("::");
           if (idx != -1)
             subSelector = subSelector.substr(0, idx);
@@ skipping 316 matching lines @@
           characterData: true,
           subtree: true
         }
       );
       this.document.addEventListener("load", this.onLoad.bind(this), true);
     }
   }
 };
 
 exports.ElemHideEmulation = ElemHideEmulation;