Browser Plugin: New Implementation (Browser Side)

content/browser/web_contents/web_contents_impl.cc

 // Copyright (c) 2012 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.
 
 #include "content/browser/web_contents/web_contents_impl.h"
 
 #include <utility>
 
 #include "base/command_line.h"
 #include "base/metrics/histogram.h"
 #include "base/metrics/stats_counters.h"
 #include "base/string16.h"
 #include "base/string_number_conversions.h"
 #include "base/string_util.h"
 #include "base/sys_info.h"
 #include "base/time.h"
 #include "base/utf_string_conversions.h"
+#include "content/browser/browser_plugin/browser_plugin_embedder.h"
+#include "content/browser/browser_plugin/browser_plugin_guest.h"
 #include "content/browser/browser_plugin/old/old_browser_plugin_host.h"
 #include "content/browser/child_process_security_policy_impl.h"
 #include "content/browser/debugger/devtools_manager_impl.h"
 #include "content/browser/dom_storage/session_storage_namespace_impl.h"
 #include "content/browser/download/download_stats.h"
 #include "content/browser/download/mhtml_generation_manager.h"
 #include "content/browser/download/save_package.h"
 #include "content/browser/gpu/gpu_data_manager_impl.h"
 #include "content/browser/gpu/gpu_process_host.h"
 #include "content/browser/host_zoom_map_impl.h"
 #include "content/browser/intents/web_intents_dispatcher_impl.h"
 #include "content/browser/renderer_host/render_process_host_impl.h"
 #include "content/browser/renderer_host/render_view_host_impl.h"
 #include "content/browser/renderer_host/render_widget_host_impl.h"
 #include "content/browser/renderer_host/resource_dispatcher_host_impl.h"
 #include "content/browser/site_instance_impl.h"
 #include "content/browser/web_contents/interstitial_page_impl.h"
 #include "content/browser/web_contents/navigation_entry_impl.h"
 #include "content/browser/webui/web_ui_impl.h"
+#include "content/common/browser_plugin_messages.h"
 #include "content/common/intents_messages.h"
 #include "content/common/ssl_status_serialization.h"
 #include "content/common/view_messages.h"
 #include "content/port/browser/render_view_host_delegate_view.h"
 #include "content/port/browser/render_widget_host_view_port.h"
 #include "content/public/browser/browser_context.h"
 #include "content/public/browser/color_chooser.h"
 #include "content/public/browser/content_browser_client.h"
 #include "content/public/browser/devtools_agent_host_registry.h"
 #include "content/public/browser/download_manager.h"
@@ skipping 632 matching lines @@
                         OnRegisterProtocolHandler)
     IPC_MESSAGE_HANDLER(ViewHostMsg_Find_Reply, OnFindReply)
     IPC_MESSAGE_HANDLER(ViewHostMsg_CrashedPlugin, OnCrashedPlugin)
     IPC_MESSAGE_HANDLER(ViewHostMsg_AppCacheAccessed, OnAppCacheAccessed)
     IPC_MESSAGE_HANDLER(ViewHostMsg_OpenColorChooser, OnOpenColorChooser)
     IPC_MESSAGE_HANDLER(ViewHostMsg_EndColorChooser, OnEndColorChooser)
     IPC_MESSAGE_HANDLER(ViewHostMsg_SetSelectedColorInColorChooser,
                         OnSetSelectedColorInColorChooser)
     IPC_MESSAGE_HANDLER(ViewHostMsg_PepperPluginHung, OnPepperPluginHung)
     IPC_MESSAGE_HANDLER(ViewHostMsg_WebUISend, OnWebUISend)
+    IPC_MESSAGE_HANDLER(BrowserPluginHostMsg_NavigateGuest,
+                        OnBrowserPluginNavigateGuest)
     IPC_MESSAGE_UNHANDLED(handled = false)
   IPC_END_MESSAGE_MAP_EX()
   message_source_ = NULL;
 
   if (!message_is_ok) {
     content::RecordAction(UserMetricsAction("BadMessageTerminate_RVD"));
     GetRenderProcessHost()->ReceivedBadMessage();
   }
 
   return handled;
@@ skipping 1472 matching lines @@
 
 // This exists for render views that don't have a WebUI, but do have WebUI
 // bindings enabled.
 void WebContentsImpl::OnWebUISend(const GURL& source_url,
                                   const std::string& name,
                                   const base::ListValue& args) {
   if (delegate_)
     delegate_->WebUISend(this, source_url, name, args);
 }
 
+void WebContentsImpl::OnBrowserPluginNavigateGuest(int instance_id,
+                                                   int64 frame_id,
+                                                   std::string src,
+                                                   gfx::Size size) {
+  // This is the first 'navigate' to a browser plugin, before WebContents has/is
+  // an 'Embedder'; subsequent navigate messages for this WebContents will
+  // be handled by the BrowserPluginEmbedderHelper of the embedder itself (this
+  // also means any message from browser plugin renderer prior to NavigateGuest
+  // which is not NavigateGuest will be ignored). Therefore
+  // browser_plugin_embedder_ should not be set.
+  DCHECK(!browser_plugin_embedder_.get());
+
+  // TODO(lazyboy, rjkroege): This might trigger a race condition if we receive
+  // NavigateGuest message in WebContents via IO thread (by capturing it via

[Fady Samuel, 2012/08/27 15:35:00]

Why handle NavigateGuest on the I/O thread?

[lazyboy, 2012/08/28 19:07:14]

If we can do this in MessageFilter (running in IO) then we can install or not
install the filter based on current mode of the web_contents, (e.g. no such
filter if we are not in platform apps), that way the messages don't arrive at
all in WebContents; maybe this is not necessary, wdyt? (see comment below too
please).

[Charlie Reis, 2012/08/29 00:11:04]

Yeah, a race is worse than an unnecessary filter, in my opinion.

[lazyboy, 2012/08/31 00:38:04]

I've removed the todo since moving this to a filter will introduce race
condition.

+  // MesssageFilter) for the following case: if first two 'NavigateGuest'
+  // messages are around the same time (i.e. both gets routed to WebContents
+  // before BrowserPluginEmbedderHelper has a chance to intercept the second
+  // 'NavigateGuest' message).

[Charlie Reis, 2012/08/27 20:23:59]

I agree, this sounds fragile.  Maybe it's better for the guest to first
initialize the BrowserPluginEmbedder (on the UI thread) before sending
NavigateGuest, and only handle NavigateGuest in the BrowserPluginEmbedder?

(Or, as Fady asks, why make it possible to process this on the IO thread?)

[lazyboy, 2012/08/28 19:07:14]

(See comments above too), it sounds like it's better to keep it on UI thread?
I can remove the todo.

+  browser_plugin_embedder_.reset(
+      new content::BrowserPluginEmbedder(this, GetRenderViewHost()));
+  browser_plugin_embedder_->NavigateGuest(GetRenderViewHost(),
+                                          instance_id,
+                                          frame_id,
+                                          src,
+                                          size);
+}
+
 // Notifies the RenderWidgetHost instance about the fact that the page is
 // loading, or done loading and calls the base implementation.
 void WebContentsImpl::SetIsLoading(bool is_loading,
                                    LoadNotificationDetails* details) {
   if (is_loading == is_loading_)
     return;
 
   if (!is_loading) {
     load_state_ = net::LoadStateWithParam(net::LOAD_STATE_IDLE, string16());
     load_state_host_.clear();
@@ skipping 950 matching lines @@
       old_browser_plugin_host()->embedder_render_process_host();
   *embedder_container_id = old_browser_plugin_host()->instance_id();
   int embedder_process_id =
       embedder_render_process_host ? embedder_render_process_host->GetID() : -1;
   if (embedder_process_id != -1) {
     *embedder_channel_name =
         StringPrintf("%d.r%d", render_view_host->GetProcess()->GetID(),
                      embedder_process_id);
   }
 }
+
+content::BrowserPluginGuest* WebContentsImpl::AddBrowserPluginGuest(

[Fady Samuel, 2012/08/27 15:35:00]

I think SetBrowserPluginGuest might be a better name because a WebContents is
either a guest or its not, it does not keep track of more than one guest.

[lazyboy, 2012/08/28 19:07:14]

Done.

+    int instance_id) {
+  browser_plugin_guest_.reset(new content::BrowserPluginGuest(
+      instance_id, this, GetRenderViewHost()));
+  return browser_plugin_guest_.get();
+}
+
+content::BrowserPluginGuest* WebContentsImpl::GetBrowserPluginGuest() {
+  return browser_plugin_guest_.get();
+}
+
+content::BrowserPluginEmbedder* WebContentsImpl::
+    GetBrowserPluginEmbedder() {
+  return browser_plugin_embedder_.get();
+}