Issue 6592 - Implement $rewrite filter option

lib/filterClasses.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 753 matching lines @@
     text = text.substr(2);
   }
 
   let contentType = null;
   let matchCase = null;
   let domains = null;
   let sitekeys = null;
   let thirdParty = null;
   let collapse = null;
   let csp = null;
+  let rewrite = null;
   let options;
   let match = (text.indexOf("$") >= 0 ? Filter.optionsRegExp.exec(text) : null);
   if (match)
   {
     options = match[1].split(",");
     text = match.input.substr(0, match.index);
     for (let option of options)
     {
       let value = null;
       let separatorIndex = option.indexOf("=");
@@ skipping 27 matching lines @@
       else if (option == "THIRD_PARTY")
         thirdParty = true;
       else if (option == "~THIRD_PARTY")
         thirdParty = false;
       else if (option == "COLLAPSE")
         collapse = true;
       else if (option == "~COLLAPSE")
         collapse = false;
       else if (option == "SITEKEY" && value)
         sitekeys = value.toUpperCase();
+      else if (option == "REWRITE" && value)

[Manish Jethani, 2018/05/03 02:42:36]

Note that for the rewrite option an empty string should also be a valid value.
For example /foo/$rewrite=,domain=example.com should just replace "foo" with "".
So I think the check here should be value != null.

[hub, 2018/05/03 18:40:04]

There can't be an empty string. The `optionsRegExp` will skip the rewrite option
because of `=,`.

[Manish Jethani, 2018/05/04 22:50:48]

Well that's a shame, because otherwise foo$rewrite= would be such a convenient
way to strip out just foo from the URL. Now you could use /foo()/$rewrite=$1 for
this, but that would be a regex filter which is supposedly slow for lookup.

At some point we should reconsider allowing empty values in options. I'll file a
separate issue for that.

[hub, 2018/05/07 20:11:55]

Acknowledged.

+        rewrite = value;
       else
         return new InvalidFilter(origText, "filter_unknown_option");
     }
   }
 
   try
   {
     if (blocking)
     {
       if (csp && Filter.invalidCSPRegExp.test(csp))
         return new InvalidFilter(origText, "filter_invalid_csp");
 
       return new BlockingFilter(origText, text, contentType, matchCase, domains,
-                                thirdParty, sitekeys, collapse, csp);
+                                thirdParty, sitekeys, collapse, csp, rewrite);
     }
     return new WhitelistFilter(origText, text, contentType, matchCase, domains,
                                thirdParty, sitekeys);
   }
   catch (e)
   {
     return new InvalidFilter(origText, "filter_invalid_regexp");
   }
 };
 
@@ skipping 42 matching lines @@
  * @param {string} regexpSource see RegExpFilter()
  * @param {number} contentType see RegExpFilter()
  * @param {boolean} matchCase see RegExpFilter()
  * @param {string} domains see RegExpFilter()
  * @param {boolean} thirdParty see RegExpFilter()
  * @param {string} sitekeys see RegExpFilter()
  * @param {boolean} collapse
  *   defines whether the filter should collapse blocked content, can be null
  * @param {string} [csp]
  *   Content Security Policy to inject when the filter matches
+ * @param {string} [rewrite]
+ *   The rewrite expression
  * @constructor
  * @augments RegExpFilter
  */
 function BlockingFilter(text, regexpSource, contentType, matchCase, domains,
-                        thirdParty, sitekeys, collapse, csp)
+                        thirdParty, sitekeys, collapse, csp, rewrite)
 {
   RegExpFilter.call(this, text, regexpSource, contentType, matchCase, domains,
                     thirdParty, sitekeys);
 
   this.collapse = collapse;
   this.csp = csp;
+  this.rewrite = rewrite;
 }
 exports.BlockingFilter = BlockingFilter;
 
 BlockingFilter.prototype = extend(RegExpFilter, {
   type: "blocking",
 
   /**
    * Defines whether the filter should collapse blocked content.
    * Can be null (use the global preference).
    * @type {boolean}
    */
   collapse: null,
 
   /**
    * Content Security Policy to inject for matching requests.
    * @type {string}
    */
-  csp: null
+  csp: null,
+
+  /**
+   * The rewrite expression
+   * @type {string}
+   */
+  rewrite: null,
+
+  /**
+   * Perform the URL rewrite and check the origin.
+   * @param {string} urlString the string URL to rewrite
+   * @returns {string?} the rewritten URL, or null if it doesn't match.
+   */
+  rewriteUrl(urlString)
+  {
+    let rewritten = urlString.replace(this.regexp, this.rewrite);
+    if (rewritten != urlString)

[Sebastian Noack, 2018/05/02 22:25:03]

Why do we need that check? Seems like a premature optimization.

[hub, 2018/05/03 00:57:58]

I consider new URL() costly (and we do it twice).

[Sebastian Noack, 2018/05/03 01:14:52]

This code path is only hit for $rewrite filters and only if they match, right?

[hub, 2018/05/03 18:40:04]

yup. Will fix it.

+    {
+      try
+      {
+        if (new URL(rewritten).origin != new URL(urlString).origin)
+          rewritten = urlString;

[Manish Jethani, 2018/05/03 02:42:36]

We could return rewritten here and return urlString at the end of the function,
then the catch block can be empty.

[hub, 2018/05/03 18:40:04]

Done.

+      }
+      catch (e)
+      {
+        rewritten = urlString;
+      }
+    }
+
+    return rewritten;
+  }
 });
 
 /**
  * Class for whitelist filters
  * @param {string} text see Filter()
  * @param {string} regexpSource see RegExpFilter()
  * @param {number} contentType see RegExpFilter()
  * @param {boolean} matchCase see RegExpFilter()
  * @param {string} domains see RegExpFilter()
  * @param {boolean} thirdParty see RegExpFilter()
@@ skipping 144 matching lines @@
  */
 function ElemHideEmulationFilter(text, domains, selector)
 {
   ElemHideBase.call(this, text, domains, selector);
 }
 exports.ElemHideEmulationFilter = ElemHideEmulationFilter;
 
 ElemHideEmulationFilter.prototype = extend(ElemHideBase, {
   type: "elemhideemulation"
 });