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 and Firefox can't distinguish between OBJECT_SUBREQUEST and OBJECT

[Sebastian Noack, 2017/05/18 21:33:41]

Nit: Thanks for updating the comment, but it's still a little misleading as
Firefox before they moved to WebExtensions actually distinguished these types.
So I'd either refer to "Chrome and Firefox (WebExtensions) ..." or "Browsers
targeted by this code ...".

[Manish Jethani, 2017/05/18 21:49:34]

Done.

-// requests.
+// Chrome and Firefox (WebExtensions) can't distinguish between
+// OBJECT_SUBREQUEST and OBJECT requests.
 RegExpFilter.typeMap.OBJECT_SUBREQUEST = RegExpFilter.typeMap.OBJECT;
 
-let resourceTypeMapping = new Map([
-  ["beacon", "PING"],
-  ["imageset", "IMAGE"],
-  ["sub_frame", "SUBDOCUMENT"]
-]);
+// 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 in RegExpFilter.typeMap)
+    yield [type.toLowerCase(), type];
 
-let typeMasks = new Map(
-  Object.keys(chrome.webRequest.ResourceType)
-  .map(typeKey => chrome.webRequest.ResourceType[typeKey])
-  .map(type => [type, RegExpFilter.typeMap[resourceTypeMapping.get(type)] ||
-                      RegExpFilter.typeMap[type.toUpperCase()] ||
-                      RegExpFilter.typeMap.OTHER])
-);
+  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(
-      page, url,
-      resourceTypeMapping.get(type) || type.toUpperCase(), docDomain,

[Sebastian Noack, 2017/05/18 21:33:42]

In case of the resource types we handle as OTHER, this would cause the original
type (as reported by the webRequest API), merely in upper case, to show up in
the devtools panel, right? This will be a change in behavior, and also confusing
because filter lists don't know anything about the webRequest API but only know
our filter syntax which identifies these requests as OTHER.

[Manish Jethani, 2017/05/18 21:49:34]

Oops, somehow I missed this. Fixed.

+      page, url, type, docDomain,
       thirdParty, sitekey,
       specificOnly, filter
     );
   }
 }
 
 ext.webRequest.onBeforeRequest.addListener((url, type, page, frame) =>
 {
   if (checkWhitelisted(page, frame))
     return true;
 
   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, typeMasks.get(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);
 });