Add frameId to MessageSender (extension messaging API)

chrome/browser/extensions/api/messaging/message_service.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 "chrome/browser/extensions/api/messaging/message_service.h"
 
 #include "base/atomic_sequence_num.h"
 #include "base/bind.h"
 #include "base/callback.h"
 #include "base/json/json_writer.h"
 #include "base/lazy_instance.h"
 #include "base/metrics/histogram.h"
 #include "base/prefs/pref_service.h"
 #include "base/stl_util.h"
 #include "base/values.h"
 #include "chrome/browser/chrome_notification_types.h"
 #include "chrome/browser/extensions/api/messaging/extension_message_port.h"
 #include "chrome/browser/extensions/api/messaging/incognito_connectability.h"
 #include "chrome/browser/extensions/api/messaging/native_message_port.h"
 #include "chrome/browser/extensions/api/tabs/tabs_constants.h"
 #include "chrome/browser/extensions/extension_service.h"
 #include "chrome/browser/extensions/extension_tab_util.h"
 #include "chrome/browser/extensions/extension_util.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/tab_contents/tab_util.h"
 #include "content/public/browser/notification_service.h"
+#include "content/public/browser/render_frame_host.h"
 #include "content/public/browser/render_process_host.h"
 #include "content/public/browser/render_view_host.h"
 #include "content/public/browser/render_widget_host.h"
 #include "content/public/browser/render_widget_host_view.h"
 #include "content/public/browser/site_instance.h"
 #include "content/public/browser/web_contents.h"
 #include "extensions/browser/extension_host.h"
 #include "extensions/browser/extension_system.h"
 #include "extensions/browser/extensions_browser_client.h"
 #include "extensions/browser/lazy_background_task_queue.h"
@@ skipping 74 matching lines @@
     "administrator.";
 #endif
 
 struct MessageService::MessageChannel {
   scoped_ptr<MessagePort> opener;
   scoped_ptr<MessagePort> receiver;
 };
 
 struct MessageService::OpenChannelParams {
   content::RenderProcessHost* source;
-  base::DictionaryValue source_tab;
+  scoped_ptr<base::DictionaryValue> source_tab;
+  int source_frame_id;
   scoped_ptr<MessagePort> receiver;
   int receiver_port_id;
   std::string source_extension_id;
   std::string target_extension_id;
   GURL source_url;
   std::string channel_name;
   bool include_tls_channel_id;
   std::string tls_channel_id;
 
   // Takes ownership of receiver.
   OpenChannelParams(content::RenderProcessHost* source,
                     scoped_ptr<base::DictionaryValue> source_tab,
+                    int source_frame_id,
                     MessagePort* receiver,
                     int receiver_port_id,
                     const std::string& source_extension_id,
                     const std::string& target_extension_id,
                     const GURL& source_url,
                     const std::string& channel_name,
                     bool include_tls_channel_id)
       : source(source),
+        source_frame_id(source_frame_id),
         receiver(receiver),
         receiver_port_id(receiver_port_id),
         source_extension_id(source_extension_id),
         target_extension_id(target_extension_id),
         source_url(source_url),
         channel_name(channel_name),
         include_tls_channel_id(include_tls_channel_id) {
     if (source_tab)
-      this->source_tab.Swap(source_tab.get());
+      this->source_tab = source_tab.Pass();
   }
 
  private:
   DISALLOW_COPY_AND_ASSIGN(OpenChannelParams);
 };
 
 namespace {
 
 static base::StaticAtomicSequenceNumber g_next_channel_id;
 static base::StaticAtomicSequenceNumber g_channel_id_overflow_count;
@@ skipping 130 matching lines @@
     if (!is_externally_connectable) {
       // Important: use kReceivingEndDoesntExistError here so that we don't
       // leak information about this extension to callers. This way it's
       // indistinguishable from the extension just not existing.
       DispatchOnDisconnect(
           source, receiver_port_id, kReceivingEndDoesntExistError);
       return;
     }
   }
 
-  WebContents* source_contents = tab_util::GetWebContentsByID(
+  WebContents* source_contents = tab_util::GetWebContentsByFrameID(
       source_process_id, source_routing_id);
 
   if (context->IsOffTheRecord() &&
       !util::IsIncognitoEnabled(target_extension_id, context)) {
     // Give the user a chance to accept an incognito connection from the web if
     // they haven't already, with the conditions:
     // - Only for spanning-mode incognito. We don't want the complication of
     //   spinning up an additional process here which might need to do some
     //   setup that we're not expecting.
     // - Only for extensions that can't normally be enabled in incognito, since
@@ skipping 13 matching lines @@
   // Note: we use the source's profile here. If the source is an incognito
   // process, we will use the incognito EPM to find the right extension process,
   // which depends on whether the extension uses spanning or split mode.
   MessagePort* receiver = new ExtensionMessagePort(
       GetExtensionProcess(context, target_extension_id),
       MSG_ROUTING_CONTROL,
       target_extension_id);
 
   // Include info about the opener's tab (if it was a tab).
   scoped_ptr<base::DictionaryValue> source_tab;
+  int source_frame_id = -1;
   if (source_contents && ExtensionTabUtil::GetTabId(source_contents) >= 0) {
     // Only the tab id is useful to platform apps for internal use. The
     // unnecessary bits will be stripped out in
     // MessagingBindings::DispatchOnConnect().
     source_tab.reset(ExtensionTabUtil::CreateTabValue(source_contents));
+
+    content::RenderFrameHost* rfh =
+        content::RenderFrameHost::FromID(source_process_id, source_routing_id);
+    // Main frame's frameId is 0.

[Charlie Reis, 2014/11/13 19:47:05]

Is the source_frame_id a new API addition?  Do we need it to have 0 as the main
frame's ID?  Might be better not to paint ourselves into that corner again if
possible, unless we have a plan for how to deal with that in the future.

[robwu, 2014/11/13 22:35:30]

frameId is consistent with the existing webNavigation/webRequest API, which use
0 for main frames (see e.g.
https://developer.chrome.com/extensions/webNavigation#property-detailsType-fr...).

[Charlie Reis, 2014/11/18 23:08:58]

I brought it up in case we wanted to remain flexible and have fewer APIs that
might break in the future.  If you have a plan for how to update all 3 cases for
OOPIF consistently, then this LGTM.

+    if (rfh)
+      source_frame_id = !rfh->GetParent() ? 0 : source_routing_id;
   }
 
   OpenChannelParams* params = new OpenChannelParams(
-      source, source_tab.Pass(), receiver, receiver_port_id,
+      source, source_tab.Pass(), source_frame_id, receiver, receiver_port_id,
       source_extension_id, target_extension_id, source_url, channel_name,
       include_tls_channel_id);
 
   // If the target requests the TLS channel id, begin the lookup for it.
   // The target might also be a lazy background page, checked next, but the
   // loading of lazy background pages continues asynchronously, so enqueue
   // messages awaiting TLS channel ID first.
   if (include_tls_channel_id) {
     pending_tls_channel_id_channels_[GET_CHANNEL_ID(params->receiver_port_id)]
         = PendingMessagesQueue();
@@ skipping 102 matching lines @@
   content::RenderProcessHost* source =
       content::RenderProcessHost::FromID(source_process_id);
   if (!source)
     return;
   Profile* profile = Profile::FromBrowserContext(source->GetBrowserContext());
 
   WebContents* contents = NULL;
   scoped_ptr<MessagePort> receiver;
   if (ExtensionTabUtil::GetTabById(tab_id, profile, true,
                                    NULL, NULL, &contents, NULL)) {
+    // TODO(robwu): Update logic so that frames that are not hosted in the main
+    // frame's process can also receive the port.
     receiver.reset(new ExtensionMessagePort(
         contents->GetRenderProcessHost(),
-        contents->GetRenderViewHost()->GetRoutingID(),
+        contents->GetMainFrame()->GetRoutingID(),
         extension_id));
   }
 
   if (contents && contents->GetController().NeedsReload()) {
     // The tab isn't loaded yet. Don't attempt to connect.
     DispatchOnDisconnect(
         source, receiver_port_id, kReceivingEndDoesntExistError);
     return;
   }
 
   scoped_ptr<OpenChannelParams> params(new OpenChannelParams(
         source,
         scoped_ptr<base::DictionaryValue>(),  // Source tab doesn't make sense
                                               // for opening to tabs.
+        -1,  // If there is no tab, then there is no frame either.
         receiver.release(),
         receiver_port_id,
         extension_id,
         extension_id,
         GURL(),  // Source URL doesn't make sense for opening to tabs.
         channel_name,
         false));  // Connections to tabs don't get TLS channel IDs.
   OpenChannelImpl(params.Pass());
 }
 
@@ skipping 21 matching lines @@
   CHECK(channel->receiver->GetRenderProcessHost());
 
   AddChannel(channel, params->receiver_port_id);
 
   CHECK(channel->receiver->GetRenderProcessHost());
 
   // Send the connect event to the receiver.  Give it the opener's port ID (the
   // opener has the opposite port ID).
   channel->receiver->DispatchOnConnect(params->receiver_port_id,
                                        params->channel_name,
-                                       params->source_tab,
+                                       params->source_tab.Pass(),
+                                       params->source_frame_id,
                                        params->source_extension_id,
                                        params->target_extension_id,
                                        params->source_url,
                                        params->tls_channel_id);
 
   // Keep both ends of the channel alive until the channel is closed.
   channel->opener->IncrementLazyKeepaliveCount();
   channel->receiver->IncrementLazyKeepaliveCount();
   return true;
 }
@@ skipping 248 matching lines @@
 }
 
 void MessageService::DispatchOnDisconnect(content::RenderProcessHost* source,
                                           int port_id,
                                           const std::string& error_message) {
   ExtensionMessagePort port(source, MSG_ROUTING_CONTROL, "");
   port.DispatchOnDisconnect(GET_OPPOSITE_PORT_ID(port_id), error_message);
 }
 
 }  // namespace extensions