Simplify WebNavigationApi by using RenderFrameHost internally.

chrome/browser/extensions/api/web_navigation/web_navigation_api_helpers.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.
 
 // Implements the Chrome Extensions WebNavigation API.
 
 #include "chrome/browser/extensions/api/web_navigation/web_navigation_api_helpers.h"
 
 #include "base/json/json_writer.h"
 #include "base/strings/string_number_conversions.h"
 #include "base/time/time.h"
 #include "base/values.h"
 #include "chrome/browser/extensions/api/web_navigation/web_navigation_api_constants.h"
 #include "chrome/browser/extensions/extension_tab_util.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/common/extensions/api/web_navigation.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/web_contents.h"
 #include "content/public/common/page_transition_types.h"
 #include "extensions/browser/event_router.h"
 #include "extensions/common/event_filtering_info.h"
 #include "net/base/net_errors.h"
 
 namespace extensions {
 
@@ skipping 22 matching lines @@
   if (profile && event_router) {
     scoped_ptr<Event> event(new Event(event_name, args.Pass()));
     event->restrict_to_browser_context = profile;
     event->filter_info = info;
     event_router->BroadcastEvent(event.Pass());
   }
 }
 
 }  // namespace
 
-int GetFrameId(bool is_main_frame, int64 frame_id) {
-  return is_main_frame ? 0 : static_cast<int>(frame_id);
+int GetFrameId(content::RenderFrameHost* frame_host) {
+  if (!frame_host)
+    return -1;
+  return !frame_host->GetParent() ? 0 : frame_host->GetRoutingID();
 }
 
 // Constructs and dispatches an onBeforeNavigate event.
+// TODO(dcheng): Is it actually OK to omit the parent process ID here?

[jochen (gone - plz use gerrit), 2014/07/14 09:38:36]

can you file a bug for this (exposing the parent process ID)?

[dcheng, 2014/07/14 20:12:56]

I actually wasn't sure if we needed this. My recollection is in cases where the
opener isn't disowned, we try to keep things in the same process... of course,
this will probably change with OOPIF, so bug filed =)

+// Collisions are probably possible... but maybe this won't ever happen because
+// of the SiteInstance grouping policies.
 void DispatchOnBeforeNavigate(content::WebContents* web_contents,
-                              int render_process_id,
-                              int64 frame_id,
-                              bool is_main_frame,
-                              int64 parent_frame_id,
-                              bool parent_is_main_frame,
+                              content::RenderFrameHost* frame_host,
                               const GURL& validated_url) {
   scoped_ptr<base::ListValue> args(new base::ListValue());
   base::DictionaryValue* dict = new base::DictionaryValue();
   dict->SetInteger(keys::kTabIdKey, ExtensionTabUtil::GetTabId(web_contents));
   dict->SetString(keys::kUrlKey, validated_url.spec());
-  dict->SetInteger(keys::kProcessIdKey, render_process_id);
-  dict->SetInteger(keys::kFrameIdKey, GetFrameId(is_main_frame, frame_id));
+  dict->SetInteger(keys::kProcessIdKey, frame_host->GetProcess()->GetID());
+  dict->SetInteger(keys::kFrameIdKey, GetFrameId(frame_host));
   dict->SetInteger(keys::kParentFrameIdKey,
-                   GetFrameId(parent_is_main_frame, parent_frame_id));
+                   GetFrameId(frame_host->GetParent()));
   dict->SetDouble(keys::kTimeStampKey, MilliSecondsFromTime(base::Time::Now()));
   args->Append(dict);
 
   DispatchEvent(web_contents->GetBrowserContext(),
                 web_navigation::OnBeforeNavigate::kEventName,
                 args.Pass(),
                 validated_url);
 }
 
 // Constructs and dispatches an onCommitted or onReferenceFragmentUpdated
 // event.
 void DispatchOnCommitted(const std::string& event_name,
                          content::WebContents* web_contents,
-                         int64 frame_id,
-                         bool is_main_frame,
+                         content::RenderFrameHost* frame_host,
                          const GURL& url,
                          content::PageTransition transition_type) {
   scoped_ptr<base::ListValue> args(new base::ListValue());
   base::DictionaryValue* dict = new base::DictionaryValue();
   dict->SetInteger(keys::kTabIdKey, ExtensionTabUtil::GetTabId(web_contents));
   dict->SetString(keys::kUrlKey, url.spec());
-  dict->SetInteger(keys::kProcessIdKey,
-                   web_contents->GetRenderViewHost()->GetProcess()->GetID());
-  dict->SetInteger(keys::kFrameIdKey, GetFrameId(is_main_frame, frame_id));
+  dict->SetInteger(keys::kProcessIdKey, frame_host->GetProcess()->GetID());
+  dict->SetInteger(keys::kFrameIdKey, GetFrameId(frame_host));
   std::string transition_type_string =
       content::PageTransitionGetCoreTransitionString(transition_type);
   // For webNavigation API backward compatibility, keep "start_page" even after
   // renamed to "auto_toplevel".
   if (PageTransitionStripQualifier(transition_type) ==
           content::PAGE_TRANSITION_AUTO_TOPLEVEL)
     transition_type_string = "start_page";
   dict->SetString(keys::kTransitionTypeKey, transition_type_string);
   base::ListValue* qualifiers = new base::ListValue();
   if (transition_type & content::PAGE_TRANSITION_CLIENT_REDIRECT)
     qualifiers->Append(new base::StringValue("client_redirect"));
   if (transition_type & content::PAGE_TRANSITION_SERVER_REDIRECT)
     qualifiers->Append(new base::StringValue("server_redirect"));
   if (transition_type & content::PAGE_TRANSITION_FORWARD_BACK)
     qualifiers->Append(new base::StringValue("forward_back"));
   if (transition_type & content::PAGE_TRANSITION_FROM_ADDRESS_BAR)
     qualifiers->Append(new base::StringValue("from_address_bar"));
   dict->Set(keys::kTransitionQualifiersKey, qualifiers);
   dict->SetDouble(keys::kTimeStampKey, MilliSecondsFromTime(base::Time::Now()));
   args->Append(dict);
 
   DispatchEvent(web_contents->GetBrowserContext(), event_name, args.Pass(),
                 url);
 }
 
 // Constructs and dispatches an onDOMContentLoaded event.
 void DispatchOnDOMContentLoaded(content::WebContents* web_contents,
-                                const GURL& url,
-                                bool is_main_frame,
-                                int64 frame_id) {
+                                content::RenderFrameHost* frame_host,
+                                const GURL& url) {
   scoped_ptr<base::ListValue> args(new base::ListValue());
   base::DictionaryValue* dict = new base::DictionaryValue();
   dict->SetInteger(keys::kTabIdKey,
                    ExtensionTabUtil::GetTabId(web_contents));
   dict->SetString(keys::kUrlKey, url.spec());
-  dict->SetInteger(keys::kProcessIdKey,
-                   web_contents->GetRenderViewHost()->GetProcess()->GetID());
-  dict->SetInteger(keys::kFrameIdKey, GetFrameId(is_main_frame, frame_id));
+  dict->SetInteger(keys::kProcessIdKey, frame_host->GetProcess()->GetID());
+  dict->SetInteger(keys::kFrameIdKey, GetFrameId(frame_host));
   dict->SetDouble(keys::kTimeStampKey, MilliSecondsFromTime(base::Time::Now()));
   args->Append(dict);
 
   DispatchEvent(web_contents->GetBrowserContext(),
                 web_navigation::OnDOMContentLoaded::kEventName,
                 args.Pass(),
                 url);
 }
 
 // Constructs and dispatches an onCompleted event.
 void DispatchOnCompleted(content::WebContents* web_contents,
-                         const GURL& url,
-                         bool is_main_frame,
-                         int64 frame_id) {
+                         content::RenderFrameHost* frame_host,
+                         const GURL& url) {
   scoped_ptr<base::ListValue> args(new base::ListValue());
   base::DictionaryValue* dict = new base::DictionaryValue();
   dict->SetInteger(keys::kTabIdKey,
                    ExtensionTabUtil::GetTabId(web_contents));
   dict->SetString(keys::kUrlKey, url.spec());
-  dict->SetInteger(keys::kProcessIdKey,
-                   web_contents->GetRenderViewHost()->GetProcess()->GetID());
-  dict->SetInteger(keys::kFrameIdKey, GetFrameId(is_main_frame, frame_id));
+  dict->SetInteger(keys::kProcessIdKey, frame_host->GetProcess()->GetID());
+  dict->SetInteger(keys::kFrameIdKey, GetFrameId(frame_host));
   dict->SetDouble(keys::kTimeStampKey, MilliSecondsFromTime(base::Time::Now()));
   args->Append(dict);
 
   DispatchEvent(web_contents->GetBrowserContext(),
                 web_navigation::OnCompleted::kEventName,
                 args.Pass(), url);
 }
 
 // Constructs and dispatches an onCreatedNavigationTarget event.
 void DispatchOnCreatedNavigationTarget(
     content::WebContents* web_contents,
     content::BrowserContext* browser_context,
-    int64 source_frame_id,
-    bool source_frame_is_main_frame,
+    content::RenderFrameHost* source_frame_host,
     content::WebContents* target_web_contents,
     const GURL& target_url) {
   // Check that the tab is already inserted into a tab strip model. This code
   // path is exercised by ExtensionApiTest.WebNavigationRequestOpenTab.
   DCHECK(ExtensionTabUtil::GetTabById(
       ExtensionTabUtil::GetTabId(target_web_contents),
       Profile::FromBrowserContext(target_web_contents->GetBrowserContext()),
       false, NULL, NULL, NULL, NULL));
 
   scoped_ptr<base::ListValue> args(new base::ListValue());
   base::DictionaryValue* dict = new base::DictionaryValue();
   dict->SetInteger(keys::kSourceTabIdKey,
                    ExtensionTabUtil::GetTabId(web_contents));
   dict->SetInteger(keys::kSourceProcessIdKey,
-                   web_contents->GetRenderViewHost()->GetProcess()->GetID());
-  dict->SetInteger(keys::kSourceFrameIdKey,
-      GetFrameId(source_frame_is_main_frame, source_frame_id));
+                   source_frame_host->GetProcess()->GetID());
+  dict->SetInteger(keys::kSourceFrameIdKey, GetFrameId(source_frame_host));
   dict->SetString(keys::kUrlKey, target_url.possibly_invalid_spec());
   dict->SetInteger(keys::kTabIdKey,
                    ExtensionTabUtil::GetTabId(target_web_contents));
   dict->SetDouble(keys::kTimeStampKey, MilliSecondsFromTime(base::Time::Now()));
   args->Append(dict);
 
   DispatchEvent(browser_context,
                 web_navigation::OnCreatedNavigationTarget::kEventName,
                 args.Pass(),
                 target_url);
 }
 
 // Constructs and dispatches an onErrorOccurred event.
 void DispatchOnErrorOccurred(content::WebContents* web_contents,
-                             int render_process_id,
+                             content::RenderFrameHost* frame_host,
                              const GURL& url,
-                             int64 frame_id,
-                             bool is_main_frame,
                              int error_code) {
   scoped_ptr<base::ListValue> args(new base::ListValue());
   base::DictionaryValue* dict = new base::DictionaryValue();
   dict->SetInteger(keys::kTabIdKey, ExtensionTabUtil::GetTabId(web_contents));
   dict->SetString(keys::kUrlKey, url.spec());
-  dict->SetInteger(keys::kProcessIdKey, render_process_id);
-  dict->SetInteger(keys::kFrameIdKey, GetFrameId(is_main_frame, frame_id));
+  dict->SetInteger(keys::kProcessIdKey, frame_host->GetProcess()->GetID());
+  dict->SetInteger(keys::kFrameIdKey, GetFrameId(frame_host));
   dict->SetString(keys::kErrorKey, net::ErrorToString(error_code));
   dict->SetDouble(keys::kTimeStampKey,
       MilliSecondsFromTime(base::Time::Now()));
   args->Append(dict);
 
   DispatchEvent(web_contents->GetBrowserContext(),
                 web_navigation::OnErrorOccurred::kEventName,
                 args.Pass(), url);
 }
 
@@ skipping 14 matching lines @@
 
   DispatchEvent(browser_context,
                 web_navigation::OnTabReplaced::kEventName,
                 args.Pass(),
                 GURL());
 }
 
 }  // namespace web_navigation_api_helpers
 
 }  // namespace extensions