Issue 6592 - Implement $rewrite filter option

test/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 76 matching lines @@
 
       let sitekeys = filter.sitekeys || [];
       result.push("sitekeys=" + sitekeys.slice().sort().join("|"));
 
       result.push("thirdParty=" + filter.thirdParty);
       if (filter instanceof BlockingFilter)
       {
         result.push("type=filterlist");
         result.push("collapse=" + filter.collapse);
         result.push("csp=" + filter.csp);
+        result.push("rewrite=" + filter.rewrite);
       }
       else if (filter instanceof WhitelistFilter)
         result.push("type=whitelist");
     }
     else if (filter instanceof ElemHideBase)
     {
       if (filter instanceof ElemHideFilter)
         result.push("type=elemhide");
       else if (filter instanceof ElemHideException)
         result.push("type=elemhideexception");
@@ skipping 39 matching lines @@
     ));
     addProperty("matchCase", "false");
     addProperty("thirdParty", "null");
     addProperty("domains", "");
     addProperty("sitekeys", "");
   }
   if (type == "filterlist")
   {
     addProperty("collapse", "null");
     addProperty("csp", "null");
+    addProperty("rewrite", "null");
   }
   if (type == "elemhide" || type == "elemhideexception" ||
       type == "elemhideemulation")
   {
     addProperty("selectorDomains", "");
     addProperty("domains", "");
   }
 }
 
 function compareFilter(test, text, expected, postInit)
@@ skipping 117 matching lines @@
 
   test.done();
 };
 
 exports.testFilterOptions = function(test)
 {
   compareFilter(test, "bla$match-case,csp=first csp,script,other,third-party,domain=foo.com,sitekey=foo", ["type=filterlist", "text=bla$match-case,csp=first csp,script,other,third-party,domain=foo.com,sitekey=foo", "regexp=bla", "matchCase=true", "contentType=" + (t.SCRIPT | t.OTHER | t.CSP), "thirdParty=true", "domains=FOO.COM", "sitekeys=FOO", "csp=first csp"]);
   compareFilter(test, "bla$~match-case,~csp=csp,~script,~other,~third-party,domain=~bar.com", ["type=filterlist", "text=bla$~match-case,~csp=csp,~script,~other,~third-party,domain=~bar.com", "regexp=bla", "contentType=" + (defaultTypes & ~(t.SCRIPT | t.OTHER)), "thirdParty=false", "domains=~BAR.COM"]);
   compareFilter(test, "@@bla$match-case,script,other,third-party,domain=foo.com|bar.com|~bar.foo.com|~foo.bar.com,csp=c s p,sitekey=foo|bar", ["type=whitelist", "text=@@bla$match-case,script,other,third-party,domain=foo.com|bar.com|~bar.foo.com|~foo.bar.com,csp=c s p,sitekey=foo|bar", "regexp=bla", "matchCase=true", "contentType=" + (t.SCRIPT | t.OTHER | t.CSP), "thirdParty=true", "domains=BAR.COM|FOO.COM|~BAR.FOO.COM|~FOO.BAR.COM", "sitekeys=BAR|FOO"]);
   compareFilter(test, "@@bla$match-case,script,other,third-party,domain=foo.com|bar.com|~bar.foo.com|~foo.bar.com,sitekey=foo|bar", ["type=whitelist", "text=@@bla$match-case,script,other,third-party,domain=foo.com|bar.com|~bar.foo.com|~foo.bar.com,sitekey=foo|bar", "regexp=bla", "matchCase=true", "contentType=" + (t.SCRIPT | t.OTHER), "thirdParty=true", "domains=BAR.COM|FOO.COM|~BAR.FOO.COM|~FOO.BAR.COM", "sitekeys=BAR|FOO"]);
+  compareFilter(test, "||content.server.com/files/*.php$rewrite=$1", ["type=filterlist", "text=||content.server.com/files/*.php$rewrite=$1", "regexp=^[\\w\\-]+:\\/+(?!\\/)(?:[^\\/]+\\.)?content\\.server\\.com\\/files\\/.*\\.php", "matchCase=false", "rewrite=$1"]);
 
   // background and image should be the same for backwards compatibility
   compareFilter(test, "bla$image", ["type=filterlist", "text=bla$image", "regexp=bla", "contentType=" + (t.IMAGE)]);
   compareFilter(test, "bla$background", ["type=filterlist", "text=bla$background", "regexp=bla", "contentType=" + (t.IMAGE)]);
   compareFilter(test, "bla$~image", ["type=filterlist", "text=bla$~image", "regexp=bla", "contentType=" + (defaultTypes & ~t.IMAGE)]);
   compareFilter(test, "bla$~background", ["type=filterlist", "text=bla$~background", "regexp=bla", "contentType=" + (defaultTypes & ~t.IMAGE)]);
 
   compareFilter(test, "@@bla$~script,~other", ["type=whitelist", "text=@@bla$~script,~other", "regexp=bla", "contentType=" + (defaultTypes & ~(t.SCRIPT | t.OTHER))]);
   compareFilter(test, "@@http://bla$~script,~other", ["type=whitelist", "text=@@http://bla$~script,~other", "regexp=http\\:\\/\\/bla", "contentType=" + (defaultTypes & ~(t.SCRIPT | t.OTHER))]);
   compareFilter(test, "@@|ftp://bla$~script,~other", ["type=whitelist", "text=@@|ftp://bla$~script,~other", "regexp=^ftp\\:\\/\\/bla", "contentType=" + (defaultTypes & ~(t.SCRIPT | t.OTHER))]);
@@ skipping 187 matching lines @@
   test.equal(Filter.normalize("foo$csp=c s p csp= ba z,cs p  = script-src  'self'"),
              "foo$csp=c s p csp= ba z,csp=script-src 'self'");
   test.equal(Filter.normalize("foo$csp=bar,$c sp=c s p"),
              "foo$csp=bar,$csp=c s p");
   test.equal(Filter.normalize(" f o   o   $      bar   $csp=ba r"),
              "foo$bar$csp=ba r");
   test.equal(Filter.normalize("f    $    o    $    o    $    csp=f o o "),
              "f$o$o$csp=f o o");
   test.equal(Filter.normalize("/foo$/$ csp = script-src  http://example.com/?$1=1&$2=2&$3=3"),
              "/foo$/$csp=script-src http://example.com/?$1=1&$2=2&$3=3");
-
-  test.done();
-};
+  test.equal(Filter.normalize("||content.server.com/files/*.php$rewrite= $1"),
+             "||content.server.com/files/*.php$rewrite=$1");
+  test.done();
+};
+
+
+exports.testFilterRewriteOption = function(test)
+{
+  let text = "/(content\\.server\\/file\\/.*\\.txt)\\?.*$/$rewrite=$1";
+
+  let filter = Filter.fromText(text);
+
+  test.equal(filter.rewrite, "$1");
+  // no rewrite occured: didn't match.
+  test.equal(filter.rewriteUrl("foo"), "foo");
+  // rewrite occured: matched.
+  test.equal(filter.rewriteUrl("http://content.server/file/foo.txt?bar"),
+             "http://content.server/file/foo.txt");
+
+  // checking for same origin.
+  let rewriteDiffOrigin =
+      "/content\\.server(\\/file\\/.*\\.txt)\\?.*$/$rewrite=foo.com$1";
+  let filterDiffOrigin = Filter.fromText(rewriteDiffOrigin);
+
+  // no rewrite occured because of a different origin.
+  test.equal(
+    filterDiffOrigin.rewriteUrl("http://content.server/file/foo.txt?bar"),
+    "http://content.server/file/foo.txt?bar"
+  );
+
+  // relative path.
+  let rewriteRelative = "/(\\/file\\/.*\\.txt)\\?.*$/$rewrite=$1/disable";
+  let filterRelative = Filter.fromText(rewriteRelative);
+
+  test.equal(
+    filterRelative.rewriteUrl("http://content.server/file/foo.txt?bar"),
+    "http://content.server/file/foo.txt/disable"
+  );
+  test.equal(
+    filterRelative.rewriteUrl("http://example.com/file/foo.txt?bar"),
+    "http://example.com/file/foo.txt/disable"
+  );
+
+  test.done();
+};