Add stub functions for chrome.* APIs in content scripts. ...

chrome/renderer/resources/renderer_extension_bindings.js

 // Copyright (c) 2009 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // This script contains unprivileged javascript APIs related to chrome
 // extensions.  It is loaded by any extension-related context, such as content
 // scripts or toolstrips.
 // See user_script_slave.cc for script that is loaded by content scripts only.
 // TODO(mpcomplete): we also load this in regular web pages, but don't need
 // to.
@@ skipping 123 matching lines @@
   };
 
   // Disconnects the port from the other end.
   chrome.Port.prototype.disconnect = function() {
     delete ports[this.portId_];
     CloseChannel(this.portId_);
   }
 
   // This function is called on context initialization for both content scripts
   // and extension contexts.
-  chrome.initExtension = function(extensionId) {
+  chrome.initExtension = function(extensionId, warnOnPrivilegedApiAccess) {
     delete chrome.initExtension;
     chromeHidden.extensionId = extensionId;
 
     chrome.extension = chrome.extension || {};
 
     // TODO(EXTENSIONS_DEPRECATED): chrome.self is obsolete.
     // http://code.google.com/p/chromium/issues/detail?id=16356
     chrome.self = chrome.extension;
 
     // Events for when a message channel is opened to our extension.
@@ skipping 38 matching lines @@
           responseCallback(response);
         port.disconnect();
       });
     };
 
     // Returns a resource URL that can be used to fetch a resource from this
     // extension.
     chrome.extension.getURL = function(path) {
       return "chrome-extension://" + extensionId + "/" + path;
     };
+
+    if (warnOnPrivilegedApiAccess) {
+      setupApiStubs();
+    }
   }
+
+  var notSupportedSuffix = " is not supported in content scripts. " +
+      "See the content scripts documentation for more details.";
+
+  // Setup to throw an error message when trying to access |name| on the chrome
+  // object. The |name| can be a dot-separated path.
+  function createStub(name) {
+    var module = chrome;
+    var parts = name.split(".");
+    for (var i = 0; i < parts.length - 1; i++) {
+      var nextPart = parts[i];
+      // Make sure an object at the path so far is defined.
+      module[nextPart] = module[nextPart] || {};
+      module = module[nextPart];
+    }
+    var finalPart = parts[parts.length-1];
+    module.__defineGetter__(finalPart, function() {
+      throw new Error("chrome." + name + notSupportedSuffix);
+    });
+  }
+
+  // Sets up stubs to throw a better error message for the common case of
+  // developers trying to call extension API's that aren't allowed to be
+  // called from content scripts.
+  function setupApiStubs() {
+    // TODO(asargent) It would be nice to eventually generate this
+    // programmatically from extension_api.json (there is already a browser test
+    // that should prevent it from getting stale).
+    var privileged = [
+      // Entire namespaces.
+      "bookmarks", "browserAction", "devtools", "experimental.extension",
+      "experimental.history", "experimental.popup", "i18n", "pageAction",
+      "pageActions", "tabs", "test", "toolstrip", "windows",
+
+      // Functions/events/properties within the extension namespace.
+      "extension.getBackgroundPage", "extension.getExtensionTabs",
+      "extension.getToolstrips", "extension.getViews", "extension.lastError",
+      "extension.onConnectExternal", "extension.onRequestExternal"
+    ];
+    for (var i = 0; i < privileged.length; i++) {
+      createStub(privileged[i]);
+    }
+  }
+
 })();