Issue 5184 - Support Firefox-specific webRequest types

lib/requestBlocker.js

 /*
  * This file is part of Adblock Plus <https://adblockplus.org/>,
  * Copyright (C) 2006-2017 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 11 matching lines @@
 const {Filter, RegExpFilter, BlockingFilter} = require("filterClasses");
 const {Subscription} = require("subscriptionClasses");
 const {defaultMatcher} = require("matcher");
 const {FilterNotifier} = require("filterNotifier");
 const {Prefs} = require("prefs");
 const {checkWhitelisted, getKey} = require("whitelisting");
 const {stringifyURL, extractHostFromFrame, isThirdParty} = require("url");
 const {port} = require("messaging");
 const devtools = require("devtools");
 
-// Chrome can't distinguish between OBJECT_SUBREQUEST and OBJECT requests.
+// Chrome and Firefox (WebExtensions) can't distinguish between
+// OBJECT_SUBREQUEST and OBJECT requests.
 RegExpFilter.typeMap.OBJECT_SUBREQUEST = RegExpFilter.typeMap.OBJECT;
 
+// Map of content types reported by the browser to the respecitve content types
+// used by Adblock Plus. Other content types are simply mapped to OTHER.
+let resourceTypes = new Map(function*()
+{
+  for (let type of Object.keys(RegExpFilter.typeMap))

[Manish Jethani, 2017/05/19 23:44:15]

This by the way could just be:

  yield* Object.keys(RegExpFilter.typeMap).map(type => [type.toLowerCase(),
type]);

I wasn't sure if Chrome 49 supports that.

[Sebastian Noack, 2017/05/20 06:42:37]

It seems all versions of Chrome that support generators, also support yield*. I
just confirmed that yield* works in Chrome 47. However, I'm not sure if
thismakes the code any more readable here.

But it seems to be simpler to just use `for (let type in RegExpFilter.typeMap)`
here, rather than Object.keys().

[Manish Jethani, 2017/05/20 18:50:47]

Done.

+    yield [type.toLowerCase(), type];
+
+  yield ["sub_frame", "SUBDOCUMENT"];
+
+  // Treat navigator.sendBeacon() the same as <a ping>, it's essentially the
+  // same concept - merely generalized.
+  yield ["beacon", "PING"];
+
+  // Treat <img srcset> and <picture> the same as other images.
+  yield ["imageset", "IMAGE"];
+}());
+
 function onBeforeRequestAsync(page, url, type, docDomain,
                               thirdParty, sitekey,
                               specificOnly, filter)
 {
   if (filter)
     FilterNotifier.emit("filter.hitCount", filter, 0, 0, page);
 
   if (devtools)
   {
     devtools.logRequest(
@@ skipping 11 matching lines @@
 
   let urlString = stringifyURL(url);
   let docDomain = extractHostFromFrame(frame);
   let thirdParty = isThirdParty(url, docDomain);
   let sitekey = getKey(page, frame);
 
   let specificOnly = !!checkWhitelisted(
     page, frame, RegExpFilter.typeMap.GENERICBLOCK
   );
 
+  let mappedType = resourceTypes.get(type) || "OTHER";
+
   let filter = defaultMatcher.matchesAny(
-    urlString, RegExpFilter.typeMap[type],
+    urlString, RegExpFilter.typeMap[mappedType],
     docDomain, thirdParty, sitekey, specificOnly
   );
 
   setTimeout(onBeforeRequestAsync, 0, page, urlString,
-                                      type, docDomain,
+                                      mappedType, docDomain,
                                       thirdParty, sitekey,
                                       specificOnly, filter);
 
   return !(filter instanceof BlockingFilter);
 });
 
 port.on("filters.collapse", (message, sender) =>
 {
   if (checkWhitelisted(sender.page, sender.frame))
     return false;
@@ skipping 79 matching lines @@
   if (msg.requestType in chrome.webRequest.ResourceType)
     return false;
 
   return ext.webRequest.onBeforeRequest._dispatch(
      new URL(msg.url),
      msg.requestType,
      sender.page,
      sender.frame
   ).includes(false);
 });