Code to facilitate sending message to external host.

Note that at this time the parameters to the message
are still tentative. The call goes as a sync call from
renderer to the browser. From then onwards it happens 
async and no return value is available yet.


git-svn-id: svn://svn.chromium.org/chrome/trunk/src@957 0039d316-1c4b-4281-b951-d872f2087c98

12 files changed, 203 insertions, 3 deletions

diff --git a/chrome/browser/render_view_host.cc b/chrome/browser/render_view_host.cc
index 0b84911..a6b0f9d 100644
--- a/chrome/browser/render_view_host.cc
+++ b/chrome/browser/render_view_host.cc
@@ -665,6 +665,8 @@ void RenderViewHost::OnMessageReceived(const IPC::Message& msg) {
                         OnMsgDomOperationResponse)
     IPC_MESSAGE_HANDLER(ViewHostMsg_DOMUISend,
                         OnMsgDOMUISend)
+    IPC_MESSAGE_HANDLER(ViewHostMsg_ExternalHostMessage,
+                        OnMsgExternalHostMessage)
 #ifdef CHROME_PERSONALIZATION
     IPC_MESSAGE_HANDLER(ViewHostMsg_PersonalizationEvent,
                         OnPersonalizationEvent)
@@ -1013,6 +1015,12 @@ void RenderViewHost::OnMsgDOMUISend(
   delegate_->ProcessDOMUIMessage(message, content);
 }
 
+void RenderViewHost::OnMsgExternalHostMessage(
+    const std::string& receiver,
+    const std::string& message) {
+  delegate_->ProcessExternalHostMessage(receiver, message);
+}
+
 #ifdef CHROME_PERSONALIZATION
 void RenderViewHost::OnPersonalizationEvent(const std::string& message,
                                                const std::string& content) {
diff --git a/chrome/browser/render_view_host.h b/chrome/browser/render_view_host.h
index b546331..2faf76a 100644
--- a/chrome/browser/render_view_host.h
+++ b/chrome/browser/render_view_host.h
@@ -459,6 +459,8 @@ class RenderViewHost : public RenderWidgetHost {
                                  int automation_id);
   void OnMsgDOMUISend(const std::string& message,
                       const std::string& content);
+  void OnMsgExternalHostMessage(const std::string& receiver,
+                                const std::string& message);
 #ifdef CHROME_PERSONALIZATION
   void OnPersonalizationEvent(const std::string& message,
                               const std::string& content);
diff --git a/chrome/browser/render_view_host_delegate.h b/chrome/browser/render_view_host_delegate.h
index 959f427..c6cc9a2 100644
--- a/chrome/browser/render_view_host_delegate.h
+++ b/chrome/browser/render_view_host_delegate.h
@@ -220,6 +220,12 @@ class RenderViewHostDelegate {
   virtual void ProcessDOMUIMessage(const std::string& message,
                                    const std::string& content) { }
 
+  // A message for external host. By default we ignore such messages.
+  // |receiver| can be a receiving script and |message| is any
+  // arbitrary string that makes sense to the receiver.
+  virtual void ProcessExternalHostMessage(const std::string& receiver,
+                                          const std::string& message) { }
+
   // Navigate to the history entry for the given offset from the current
   // position within the NavigationController.  Makes no change if offset is
   // not valid.
diff --git a/chrome/browser/web_contents.cc b/chrome/browser/web_contents.cc
index 32b1ecd..96834dc 100644
--- a/chrome/browser/web_contents.cc
+++ b/chrome/browser/web_contents.cc
@@ -1988,6 +1988,12 @@ void WebContents::DomOperationResponse(const std::string& json_string,
       Details<DomOperationNotificationDetails>(&details));
 }
 
+void WebContents::ProcessExternalHostMessage(const std::string& receiver,
+                                             const std::string& message) {
+  if (delegate())
+    delegate()->SendExternalHostMessage(receiver, message);
+}
+
 void WebContents::GoToEntryAtOffset(int offset) {
   if (!controller())
     return;
diff --git a/chrome/browser/web_contents.h b/chrome/browser/web_contents.h
index b61eb70..09a07d0 100644
--- a/chrome/browser/web_contents.h
+++ b/chrome/browser/web_contents.h
@@ -427,6 +427,8 @@ class WebContents : public TabContents,
                               WindowOpenDisposition disposition);
   virtual void DomOperationResponse(const std::string& json_string,
                                     int automation_id);
+  virtual void ProcessExternalHostMessage(const std::string& receiver,
+                                          const std::string& message);
   virtual void GoToEntryAtOffset(int offset);
   virtual void GetHistoryListCount(int* back_list_count,
                                    int* forward_list_count);
diff --git a/chrome/common/render_messages_internal.h b/chrome/common/render_messages_internal.h
index 2257551..058dc7b 100644
--- a/chrome/common/render_messages_internal.h
+++ b/chrome/common/render_messages_internal.h
@@ -723,11 +723,18 @@ IPC_BEGIN_MESSAGES(ViewHost, 2)
                       std::string  /* message */,
                       std::string  /* args (as a JSON string) */)
 
+  // A message for an external host.
+  // |receiver| can be a receiving script and |message| is any
+  // arbitrary string that makes sense to the receiver.
+  IPC_MESSAGE_ROUTED2(ViewHostMsg_ExternalHostMessage,
+                      std::string  /* receiver */,
+                      std::string  /* message */)
+
 #ifdef CHROME_PERSONALIZATION
   IPC_MESSAGE_ROUTED2(ViewHostMsg_PersonalizationEvent,
                       std::string, std::string )
 #endif
-  
+
   // A renderer sends this to the browser process when it wants to create a
   // plugin.  The browser will create the plugin process if necessary, and
   // will return the channel name on success.  On error an empty string is
diff --git a/chrome/renderer/external_host_bindings.cc b/chrome/renderer/external_host_bindings.cc
new file mode 100644
index 0000000..ffcd5fd
--- /dev/null
+++ b/chrome/renderer/external_host_bindings.cc
@@ -0,0 +1,70 @@
+// Copyright 2008, Google Inc.
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//    * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//    * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//    * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+#include "chrome/renderer/external_host_bindings.h"
+
+#include "base/json_writer.h"
+#include "base/scoped_handle.h"
+#include "base/values.h"
+#include "chrome/common/render_messages.h"
+#include "chrome/common/stl_util-inl.h"
+
+ExternalHostBindings::ExternalHostBindings() : routing_id_(0), sender_(NULL) {
+  BindMethod("postMessage", &ExternalHostBindings::postMessage);
+}
+
+ExternalHostBindings::~ExternalHostBindings() {
+  STLDeleteContainerPointers(properties_.begin(), properties_.end());
+}
+
+void ExternalHostBindings::postMessage(const CppArgumentList& args,
+                                       CppVariant* result) {
+  // We expect at least a string message identifier, and optionally take
+  // an object parameter.  If we get anything else we bail.
+  if (args.size() < 2)
+    return;
+
+  // Args should be strings.
+  if (!args[0].isString() && !args[1].isString())
+    return;
+
+  const std::string receiver = args[0].ToString();
+  const std::string message = args[1].ToString();
+
+  sender_->Send(
+      new ViewHostMsg_ExternalHostMessage(routing_id_, receiver, message));
+}
+
+void ExternalHostBindings::SetProperty(const std::string& name,
+                                       const std::string& value) {
+  CppVariant* cpp_value = new CppVariant;
+  cpp_value->Set(value);
+  BindProperty(name, cpp_value);
+  properties_.push_back(cpp_value);
+}
diff --git a/chrome/renderer/external_host_bindings.h b/chrome/renderer/external_host_bindings.h
new file mode 100644
index 0000000..dde86af
--- /dev/null
+++ b/chrome/renderer/external_host_bindings.h
@@ -0,0 +1,74 @@
+// Copyright 2008, Google Inc.
+// All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+//    * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+//    * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+//    * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+#ifndef CHROME_RENDERER_EXTERNAL_HOST_BINDINGS_H__
+#define CHROME_RENDERER_EXTERNAL_HOST_BINDINGS_H__
+
+#include "chrome/common/ipc_message.h"
+#include "webkit/glue/cpp_bound_class.h"
+
+// ExternalHostBindings is the class backing the "externalHost" object
+// accessible from Javascript
+//
+// We expose one function, for sending a message to the external host:
+//  postMessage(String receiver, String message);
+class ExternalHostBindings : public CppBoundClass {
+ public:
+  ExternalHostBindings();
+  ~ExternalHostBindings();
+
+  // The postMessage() function provided to Javascript.
+  void postMessage(const CppArgumentList& args, CppVariant* result);
+
+  // Set the message channel back to the browser.
+  void set_message_sender(IPC::Message::Sender* sender) {
+    sender_ = sender;
+  }
+
+  // Set the routing id for messages back to the browser.
+  void set_routing_id(int routing_id) {
+    routing_id_ = routing_id;
+  }
+
+  // Sets a property with the given name and value.
+  void SetProperty(const std::string& name, const std::string& value);
+
+ private:
+  // Our channel back to the browser is a message sender
+  // and routing id.
+  IPC::Message::Sender* sender_;
+  int routing_id_;
+
+  // The list of properties that have been set.  We keep track of this so we
+  // can free them on destruction.
+  typedef std::vector<CppVariant*> PropertyList;
+  PropertyList properties_;
+};
+
+#endif  // CHROME_RENDERER_DOM_UI_BINDINGS_H__
diff --git a/chrome/renderer/render_view.cc b/chrome/renderer/render_view.cc
index 81e05bb..0257927 100644
--- a/chrome/renderer/render_view.cc
+++ b/chrome/renderer/render_view.cc
@@ -1417,6 +1417,11 @@ void RenderView::WindowObjectCleared(WebFrame* webframe) {
     dom_ui_bindings_.set_routing_id(routing_id_);
     dom_ui_bindings_.BindToJavascript(webframe, L"chrome");
   }
+
+  external_host_bindings_.set_message_sender(this);
+  external_host_bindings_.set_routing_id(routing_id_);
+  external_host_bindings_.BindToJavascript(webframe, L"externalHost");
+
 #ifdef CHROME_PERSONALIZATION
   Personalization::ConfigureRendererPersonalization(personalization_, this,
                                                     routing_id_, webframe);
diff --git a/chrome/renderer/render_view.h b/chrome/renderer/render_view.h
index 635c077..1aa945f 100644
--- a/chrome/renderer/render_view.h
+++ b/chrome/renderer/render_view.h
@@ -46,6 +46,7 @@
 #endif
 #include "chrome/renderer/automation/dom_automation_controller.h"
 #include "chrome/renderer/dom_ui_bindings.h"
+#include "chrome/renderer/external_host_bindings.h"
 #include "chrome/renderer/external_js_object.h"
 #include "chrome/renderer/render_process.h"
 #include "chrome/renderer/render_widget.h"
@@ -499,11 +500,11 @@ class RenderView : public RenderWidget, public WebViewDelegate,
   // Handles resource loads for this view.
   scoped_refptr<ResourceDispatcher> resource_dispatcher_;
 
-  // DOM Automation Controller CppBoundClass
+  // DOM Automation Controller CppBoundClass.
   bool enable_dom_automation_;
   DomAutomationController dom_automation_controller_;
 
-  // Chrome page<->browser messaging CppBoundClass
+  // Chrome page<->browser messaging CppBoundClass.
   bool enable_dom_ui_bindings_;
   DOMUIBindings dom_ui_bindings_;
 
@@ -514,6 +515,9 @@ class RenderView : public RenderWidget, public WebViewDelegate,
   // window.external object for "built-in" JS extensions
   ExternalJSObject external_js_object_;
 
+  // External host exposed through automation controller.
+  ExternalHostBindings external_host_bindings_;
+
   // The last gotten main frame's encoding.
   std::wstring last_encoding_name_;
 
diff --git a/chrome/renderer/renderer.vcproj b/chrome/renderer/renderer.vcproj
index 753f517..9d82fecb 100644
--- a/chrome/renderer/renderer.vcproj
+++ b/chrome/renderer/renderer.vcproj
@@ -186,6 +186,14 @@
 			>
 		</File>
 		<File
+			RelativePath=".\external_host_bindings.cc"
+			>
+		</File>
+		<File
+			RelativePath=".\external_host_bindings.h"
+			>
+		</File>
+		<File
 			RelativePath=".\external_js_object.cc"
 			>
 		</File>
diff --git a/chrome/test/automation/automation_messages_internal.h b/chrome/test/automation/automation_messages_internal.h
index e21a2cc..82ae220 100644
--- a/chrome/test/automation/automation_messages_internal.h
+++ b/chrome/test/automation/automation_messages_internal.h
@@ -736,4 +736,12 @@ IPC_BEGIN_MESSAGES(Automation, 0)
   // supplied tab handle. 
   IPC_MESSAGE_ROUTED1(AutomationMsg_OpenFindInPageRequest,
                       int /* tab_handle */)
+
+  // A message for an external host.
+  // |receiver| can be a receiving script and |message| is any
+  // arbitrary string that makes sense to the receiver.
+  IPC_MESSAGE_ROUTED2(AutomationMsg_SendExternalHostMessage,
+                      std::string /* receiver*/,
+                      std::string /* message*/)
+
 IPC_END_MESSAGES(Automation)