Issue 6622 - Implement $rewrite filter option

lib/requestBlocker.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 52 matching lines @@
   if (!(browser.webRequest.ResourceType))
     return;
 
   for (let type in browser.webRequest.ResourceType)
     yield resourceTypes.get(browser.webRequest.ResourceType[type]) || "OTHER";
 
   // WEBRTC gets addressed through a workaround, even if the webRequest API is
   // lacking support to block this kind of a request.
   yield "WEBRTC";
 
-  // POPUP, CSP and ELEMHIDE filters aren't mapped to resource types.
+  // POPUP, CSP, REWRITE and ELEMHIDE filters aren't mapped to resource types.
   yield "POPUP";
   yield "ELEMHIDE";
   yield "CSP";
+  yield "REWRITE";
 }());
 
 function getDocumentInfo(page, frame, originUrl)
 {
   return [
     extractHostFromFrame(frame, originUrl),
     getKey(page, frame, originUrl),
     !!checkWhitelisted(page, frame, originUrl,
                        RegExpFilter.typeMap.GENERICBLOCK)
   ];
@@ skipping 100 matching lines @@
 
   if (checkWhitelisted(page, frame, originUrl))
     return;
 
   let type = resourceTypes.get(details.type) || "OTHER";
   let [docDomain, sitekey, specificOnly] = getDocumentInfo(page, frame,
                                                            originUrl);
   let [filter, urlString, thirdParty] = matchRequest(url, type, docDomain,
                                                      sitekey, specificOnly);
 
+  if (filter instanceof RegExpFilter && filter.rewrite)
+  {
+    let matches = filter.regexp.exec(urlString);
+    if (matches)
+    {
+      let rewritten = filter.rewrite.replace("%1", matches[0]);

[hub, 2018/04/24 20:39:05]

I actually wonder if we should move the rewrite part to adblockpluscore in the
filter class to totally self contain it in adblockpluscore.

[hub, 2018/04/25 03:39:08]

moved this to core in the end.

+      if (rewritten != urlString)
+      {
+        getRelatedTabIds(details).then(tabIds =>
+        {
+          logRequest(tabIds, urlString, "REWRITE", docDomain,
+                     thirdParty, sitekey, specificOnly, filter);
+        });
+
+        return {redirectUrl: rewritten};
+      }
+    }
+    // we couldn't do the rewrite, so just let it through.
+    return;
+  }
+
   getRelatedTabIds(details).then(tabIds =>
   {
     logRequest(tabIds, urlString, type, docDomain,
                thirdParty, sitekey, specificOnly, filter);
   });
 
   if (filter instanceof BlockingFilter)
     return {cancel: true};
 }, {urls: ["<all_urls>"]}, ["blocking"]);
 
@@ skipping 102 matching lines @@
 }
 
 FilterNotifier.on("subscription.added", onFilterChange);
 FilterNotifier.on("subscription.removed", onFilterChange);
 FilterNotifier.on("subscription.updated", onFilterChange);
 FilterNotifier.on("subscription.disabled", arg => onFilterChange(arg, true));
 FilterNotifier.on("filter.added", onFilterChange);
 FilterNotifier.on("filter.removed", onFilterChange);
 FilterNotifier.on("filter.disabled", arg => onFilterChange(arg, true));
 FilterNotifier.on("load", onFilterChange);