Issue 6030 - Ensure RTCPeerConnection exists before wrapping it

inject.preload.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 208 matching lines @@
   /*
    * RTCPeerConnection wrapper
    *
    * The webRequest API in Chrome does not yet allow the blocking of
    * WebRTC connections.
    * See https://bugs.chromium.org/p/chromium/issues/detail?id=707683
    */
   let RealRTCPeerConnection = window.RTCPeerConnection ||
                                 window.webkitRTCPeerConnection;
 
   // Firefox has the option (media.peerconnection.enabled) to disable WebRTC

[Manish Jethani, 2017/11/14 10:57:56]

Wouldn't it be better to wrap the entire code for RTCPeerConnection here into
the if block?

[Wladimir Palant, 2017/11/14 11:12:49]

I agree. While I'm normally not a big fan of increasing indentation level,
returning here might skip unrelated code that some future change adds below.

[kzar, 2017/11/14 11:36:35]

Done.

-  // in which case RealRTCPeerConnection is undefined. Note: This logic assumes
-  // that the WebRTC wrapping code comes last in the injected function!
-  if (typeof RealRTCPeerConnection == "undefined")
-    return;
-
-  let closeRTCPeerConnection = Function.prototype.call.bind(
-    RealRTCPeerConnection.prototype.close
-  );
-  let RealArray = Array;
-  let RealString = String;
-  let {create: createObject, defineProperty} = Object;
-
-  function normalizeUrl(url)
-  {
-    if (typeof url != "undefined")
-      return RealString(url);
-  }
-
-  function safeCopyArray(originalArray, transform)
-  {
-    if (originalArray == null || typeof originalArray != "object")
-      return originalArray;
-
-    let safeArray = RealArray(originalArray.length);
-    for (let i = 0; i < safeArray.length; i++)
-    {
-      defineProperty(safeArray, i, {
-        configurable: false, enumerable: false, writable: false,
-        value: transform(originalArray[i])
-      });
-    }
-    defineProperty(safeArray, "length", {
-      configurable: false, enumerable: false, writable: false,
-      value: safeArray.length
-    });
-    return safeArray;
-  }
-
-  // It would be much easier to use the .getConfiguration method to obtain
-  // the normalized and safe configuration from the RTCPeerConnection
-  // instance. Unfortunately its not implemented as of Chrome unstable 59.
-  // See https://www.chromestatus.com/feature/5271355306016768
-  function protectConfiguration(configuration)
-  {
-    if (configuration == null || typeof configuration != "object")
-      return configuration;
-
-    let iceServers = safeCopyArray(
-      configuration.iceServers,
-      iceServer =>
-      {
-        let {url, urls} = iceServer;
-
-        // RTCPeerConnection doesn't iterate through pseudo Arrays of urls.
-        if (typeof urls != "undefined" && !(urls instanceof RealArray))
-          urls = [urls];
-
-        return createObject(iceServer, {
-          url: {
-            configurable: false, enumerable: false, writable: false,
-            value: normalizeUrl(url)
-          },
-          urls: {
-            configurable: false, enumerable: false, writable: false,
-            value: safeCopyArray(urls, normalizeUrl)
-          }
+  // in which case RealRTCPeerConnection is undefined.
+  if (typeof RealRTCPeerConnection != "undefined")
+  {
+    let closeRTCPeerConnection = Function.prototype.call.bind(
+      RealRTCPeerConnection.prototype.close
+    );
+    let RealArray = Array;
+    let RealString = String;
+    let {create: createObject, defineProperty} = Object;
+
+    let normalizeUrl = url =>

[kzar, 2017/11/14 11:36:35]

This change - and several like it below - are necessary since we would be
violating the no-inner-declaration ESLint rule otherwise.

+    {
+      if (typeof url != "undefined")
+        return RealString(url);
+    };
+
+    let safeCopyArray = (originalArray, transform) =>
+    {
+      if (originalArray == null || typeof originalArray != "object")
+        return originalArray;
+
+      let safeArray = RealArray(originalArray.length);
+      for (let i = 0; i < safeArray.length; i++)
+      {
+        defineProperty(safeArray, i, {
+          configurable: false, enumerable: false, writable: false,
+          value: transform(originalArray[i])
         });
       }
-    );
-
-    return createObject(configuration, {
-      iceServers: {
+      defineProperty(safeArray, "length", {
         configurable: false, enumerable: false, writable: false,
-        value: iceServers
-      }
-    });
-  }
-
-  function checkUrl(peerconnection, url)
-  {
-    checkRequest("webrtc", url, blocked =>
-    {
-      if (blocked)
-      {
-        // Calling .close() throws if already closed.
-        try
+        value: safeArray.length
+      });
+      return safeArray;
+    };
+
+    // It would be much easier to use the .getConfiguration method to obtain
+    // the normalized and safe configuration from the RTCPeerConnection
+    // instance. Unfortunately its not implemented as of Chrome unstable 59.
+    // See https://www.chromestatus.com/feature/5271355306016768
+    let protectConfiguration = configuration =>
+    {
+      if (configuration == null || typeof configuration != "object")
+        return configuration;
+
+      let iceServers = safeCopyArray(
+        configuration.iceServers,
+        iceServer =>
         {
-          closeRTCPeerConnection(peerconnection);
+          let {url, urls} = iceServer;
+
+          // RTCPeerConnection doesn't iterate through pseudo Arrays of urls.
+          if (typeof urls != "undefined" && !(urls instanceof RealArray))
+            urls = [urls];
+
+          return createObject(iceServer, {
+            url: {
+              configurable: false, enumerable: false, writable: false,
+              value: normalizeUrl(url)
+            },
+            urls: {
+              configurable: false, enumerable: false, writable: false,
+              value: safeCopyArray(urls, normalizeUrl)
+            }
+          });
         }
-        catch (e) {}
-      }
-    });
-  }
-
-  function checkConfiguration(peerconnection, configuration)
-  {
-    if (configuration && configuration.iceServers)
-    {
-      for (let i = 0; i < configuration.iceServers.length; i++)
-      {
-        let iceServer = configuration.iceServers[i];
-        if (iceServer)
+      );
+
+      return createObject(configuration, {
+        iceServers: {
+          configurable: false, enumerable: false, writable: false,
+          value: iceServers
+        }
+      });
+    };
+
+    let checkUrl = (peerconnection, url) =>
+    {
+      checkRequest("webrtc", url, blocked =>
+      {
+        if (blocked)
         {
-          if (iceServer.url)
-            checkUrl(peerconnection, iceServer.url);
-
-          if (iceServer.urls)
+          // Calling .close() throws if already closed.
+          try
           {
-            for (let j = 0; j < iceServer.urls.length; j++)
-              checkUrl(peerconnection, iceServer.urls[j]);
+            closeRTCPeerConnection(peerconnection);
+          }
+          catch (e) {}
+        }
+      });
+    };
+
+    let checkConfiguration = (peerconnection, configuration) =>
+    {
+      if (configuration && configuration.iceServers)
+      {
+        for (let i = 0; i < configuration.iceServers.length; i++)
+        {
+          let iceServer = configuration.iceServers[i];
+          if (iceServer)
+          {
+            if (iceServer.url)
+              checkUrl(peerconnection, iceServer.url);
+
+            if (iceServer.urls)
+            {
+              for (let j = 0; j < iceServer.urls.length; j++)
+                checkUrl(peerconnection, iceServer.urls[j]);
+            }
           }
         }
       }
+    };
+
+    // Chrome unstable (tested with 59) has already implemented
+    // setConfiguration, so we need to wrap that if it exists too.
+    // https://www.chromestatus.com/feature/5596193748942848
+    if (RealRTCPeerConnection.prototype.setConfiguration)
+    {
+      let realSetConfiguration = Function.prototype.call.bind(
+        RealRTCPeerConnection.prototype.setConfiguration
+      );
+
+      RealRTCPeerConnection.prototype.setConfiguration = function(configuration)
+      {
+        configuration = protectConfiguration(configuration);
+
+        // Call the real method first, so that validates the configuration for
+        // us. Also we might as well since checkRequest is asynchronous anyway.
+        realSetConfiguration(this, configuration);
+        checkConfiguration(this, configuration);
+      };
     }
-  }
-
-  // Chrome unstable (tested with 59) has already implemented
-  // setConfiguration, so we need to wrap that if it exists too.
-  // https://www.chromestatus.com/feature/5596193748942848
-  if (RealRTCPeerConnection.prototype.setConfiguration)
-  {
-    let realSetConfiguration = Function.prototype.call.bind(
-      RealRTCPeerConnection.prototype.setConfiguration
-    );
-
-    RealRTCPeerConnection.prototype.setConfiguration = function(configuration)
-    {
-      configuration = protectConfiguration(configuration);
-
-      // Call the real method first, so that validates the configuration for
-      // us. Also we might as well since checkRequest is asynchronous anyway.
-      realSetConfiguration(this, configuration);
-      checkConfiguration(this, configuration);
-    };
-  }
-
-  function WrappedRTCPeerConnection(...args)
-  {
-    if (!(this instanceof WrappedRTCPeerConnection))
-      return RealRTCPeerConnection();
-
-    let configuration = protectConfiguration(args[0]);
-
-    // Since the old webkitRTCPeerConnection constructor takes an optional
-    // second argument we need to take care to pass that through. Necessary
-    // for older versions of Chrome such as 49.
-    let constraints = undefined;
-    if (args.length > 1)
-      constraints = args[1];
-
-    let peerconnection = new RealRTCPeerConnection(configuration, constraints);
-    checkConfiguration(peerconnection, configuration);
-    return peerconnection;
-  }
-
-  WrappedRTCPeerConnection.prototype = RealRTCPeerConnection.prototype;
-
-  let boundWrappedRTCPeerConnection = WrappedRTCPeerConnection.bind();
-  copyProperties(RealRTCPeerConnection, boundWrappedRTCPeerConnection,
-                 ["generateCertificate", "name", "prototype"]);
-  RealRTCPeerConnection.prototype.constructor = boundWrappedRTCPeerConnection;
-
-  if ("RTCPeerConnection" in window)
-    window.RTCPeerConnection = boundWrappedRTCPeerConnection;
-  if ("webkitRTCPeerConnection" in window)
-    window.webkitRTCPeerConnection = boundWrappedRTCPeerConnection;
+
+    let WrappedRTCPeerConnection = function(...args)
+    {
+      if (!(this instanceof WrappedRTCPeerConnection))
+        return RealRTCPeerConnection();
+
+      let configuration = protectConfiguration(args[0]);
+
+      // Since the old webkitRTCPeerConnection constructor takes an optional
+      // second argument we need to take care to pass that through. Necessary
+      // for older versions of Chrome such as 49.
+      let constraints = undefined;
+      if (args.length > 1)
+        constraints = args[1];
+
+      let peerconnection = new RealRTCPeerConnection(configuration,
+                                                     constraints);
+      checkConfiguration(peerconnection, configuration);
+      return peerconnection;
+    };
+
+    WrappedRTCPeerConnection.prototype = RealRTCPeerConnection.prototype;
+
+    let boundWrappedRTCPeerConnection = WrappedRTCPeerConnection.bind();
+    copyProperties(RealRTCPeerConnection, boundWrappedRTCPeerConnection,
+                   ["generateCertificate", "name", "prototype"]);
+    RealRTCPeerConnection.prototype.constructor = boundWrappedRTCPeerConnection;
+
+    if ("RTCPeerConnection" in window)
+      window.RTCPeerConnection = boundWrappedRTCPeerConnection;
+    if ("webkitRTCPeerConnection" in window)
+      window.webkitRTCPeerConnection = boundWrappedRTCPeerConnection;
+  }
 }
 
 if (document instanceof HTMLDocument)
 {
   let sandbox = window.frameElement &&
                 window.frameElement.getAttribute("sandbox");
 
   if (typeof sandbox != "string" || /(^|\s)allow-scripts(\s|$)/i.test(sandbox))
   {
     let script = document.createElement("script");
     script.type = "application/javascript";
     script.async = false;
     script.textContent = "(" + injected + ")('" + randomEventName + "');";
     document.documentElement.appendChild(script);
     document.documentElement.removeChild(script);
   }
 }