Introduce webNavigation.onTabReplaced event that is fired when a tab from instant or prerender repl…

chrome/browser/extensions/api/web_navigation/web_navigation_api.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.h"
 
 #include "base/json/json_writer.h"
 #include "base/lazy_instance.h"
 #include "base/string_number_conversions.h"
 #include "base/time.h"
 #include "base/values.h"
 #include "chrome/browser/extensions/api/web_navigation/web_navigation_api_constants.h"
 #include "chrome/browser/extensions/extension_event_router.h"
 #include "chrome/browser/extensions/extension_tab_util.h"
 #include "chrome/browser/profiles/profile.h"
 #include "chrome/browser/tab_contents/retargeting_details.h"
+#include "chrome/browser/ui/browser.h"
 #include "chrome/browser/ui/tab_contents/tab_contents.h"
 #include "chrome/browser/view_type_utils.h"
 #include "chrome/common/chrome_notification_types.h"
 #include "chrome/common/extensions/api/web_navigation.h"
 #include "chrome/common/extensions/event_filtering_info.h"
 #include "chrome/common/url_constants.h"
 #include "content/public/browser/resource_request_details.h"
 #include "content/public/browser/navigation_details.h"
 #include "content/public/browser/notification_service.h"
 #include "content/public/browser/notification_types.h"
@@ skipping 170 matching lines @@
   dict->SetInteger(keys::kSourceTabIdKey,
                    ExtensionTabUtil::GetTabId(web_contents));
   dict->SetInteger(keys::kSourceFrameIdKey,
       GetFrameId(source_frame_is_main_frame, source_frame_id));
   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);
 
+  // TODO(koz): Why not web_contents->GetURL() instead of target_url or both?
   DispatchEvent(browser_context, keys::kOnCreatedNavigationTarget, args,
                 target_url);
 }
 
 // Constructs and dispatches an onErrorOccurred event.
 void DispatchOnErrorOccurred(WebContents* web_contents,
                              const GURL& url,
                              int64 frame_id,
                              bool is_main_frame,
                              int error_code) {
   ListValue args;
   DictionaryValue* dict = new DictionaryValue();
   dict->SetInteger(keys::kTabIdKey, ExtensionTabUtil::GetTabId(web_contents));
   dict->SetString(keys::kUrlKey, url.spec());
   dict->SetInteger(keys::kFrameIdKey, GetFrameId(is_main_frame, frame_id));
   dict->SetString(keys::kErrorKey, net::ErrorToString(error_code));
   dict->SetDouble(keys::kTimeStampKey, MilliSecondsFromTime(base::Time::Now()));
   args.Append(dict);
 
   DispatchEvent(web_contents->GetBrowserContext(), keys::kOnErrorOccurred,
                 args, url);
 }
 
+// Constructs and dispatches an onTabReplaced event.
+void DispatchOnTabReplaced(
+    WebContents* old_web_contents,
+    BrowserContext* browser_context,
+    WebContents* new_web_contents) {
+  ListValue args;
+  DictionaryValue* dict = new DictionaryValue();
+  dict->SetInteger(keys::kSourceTabIdKey,
+                   ExtensionTabUtil::GetTabId(old_web_contents));
+  dict->SetInteger(keys::kTabIdKey,
+                   ExtensionTabUtil::GetTabId(new_web_contents));
+  dict->SetDouble(keys::kTimeStampKey, MilliSecondsFromTime(base::Time::Now()));
+  args.Append(dict);
+
+  // TODO(koz): Why not old_web_contents->GetURL() or both?
+  DispatchEvent(browser_context, keys::kOnTabReplaced, args,
+                new_web_contents->GetURL());
+}
+
 }  // namespace
 
 
 // FrameNavigationState -------------------------------------------------------
 
 // static
 bool FrameNavigationState::allow_extension_scheme_ = false;
 
 FrameNavigationState::FrameNavigationState()
     : main_frame_id_(-1) {
@@ skipping 148 matching lines @@
       source_frame_is_main_frame(source_frame_is_main_frame),
       target_web_contents(target_web_contents),
       target_url(target_url) {
 }
 
 WebNavigationEventRouter::PendingWebContents::~PendingWebContents() {}
 
 WebNavigationEventRouter::WebNavigationEventRouter(Profile* profile)
     : profile_(profile) {}
 
 WebNavigationEventRouter::~WebNavigationEventRouter() {}

[battre, 2012/07/05 15:38:46]

The WebNavigationEventRouter is owned by the ExtensionService. I *suppose* that
it gets destroyed before the static browser list. Should we call
BrowserList::RemoveObserver(this) here?

[jochen (gone - plz use gerrit), 2012/07/06 11:13:50]

Done.

 
 void WebNavigationEventRouter::Init() {
-  if (registrar_.IsEmpty()) {
-    registrar_.Add(this,
-                   chrome::NOTIFICATION_RETARGETING,
-                   content::NotificationService::AllSources());
-    registrar_.Add(this,
-                   chrome::NOTIFICATION_TAB_ADDED,
-                   content::NotificationService::AllSources());
-    registrar_.Add(this,
-                   content::NOTIFICATION_WEB_CONTENTS_DESTROYED,
-                   content::NotificationService::AllSources());
+  if (!registrar_.IsEmpty())
+    return;
+  registrar_.Add(this,
+                 chrome::NOTIFICATION_RETARGETING,
+                 content::NotificationService::AllSources());
+  registrar_.Add(this,
+                 chrome::NOTIFICATION_TAB_ADDED,
+                 content::NotificationService::AllSources());
+  registrar_.Add(this,
+                 content::NOTIFICATION_WEB_CONTENTS_DESTROYED,
+                 content::NotificationService::AllSources());
+
+  BrowserList::AddObserver(this);
+  for (BrowserList::const_iterator iter = BrowserList::begin();
+       iter != BrowserList::end(); ++iter) {
+    OnBrowserAdded(*iter);
   }
 }
 
+void WebNavigationEventRouter::OnBrowserAdded(Browser* browser) {
+  if (!profile_->IsSameProfile(browser->profile()))
+    return;
+  browser->tab_strip_model()->AddObserver(this);
+}
+
+void WebNavigationEventRouter::OnBrowserRemoved(Browser* browser) {
+  if (!profile_->IsSameProfile(browser->profile()))
+    return;
+  browser->tab_strip_model()->RemoveObserver(this);
+}
+
+void WebNavigationEventRouter::TabReplacedAt(
+    TabStripModel* tab_strip_model,
+    TabContents* old_contents,
+    TabContents* new_contents,
+    int index) {
+  WebNavigationTabObserver* tab_observer =
+      WebNavigationTabObserver::Get(old_contents->web_contents());
+  if (!tab_observer) {
+    // If you hit this DCHECK(), please add reproduction steps to
+    // http://crbug.com/109464.
+    DCHECK(chrome::GetViewType(old_contents->web_contents()) !=
+           chrome::VIEW_TYPE_TAB_CONTENTS);
+    return;
+  }
+  const FrameNavigationState& frame_navigation_state =
+      tab_observer->frame_navigation_state();
+
+  if (!frame_navigation_state.IsValidUrl(
+          old_contents->web_contents()->GetURL()) ||
+      !frame_navigation_state.IsValidUrl(
+          new_contents->web_contents()->GetURL()))
+    return;
+
+  DispatchOnTabReplaced(
+      old_contents->web_contents(),
+      profile_,
+      new_contents->web_contents());
+}
+
 void WebNavigationEventRouter::Observe(
     int type,
     const content::NotificationSource& source,
     const content::NotificationDetails& details) {
   switch (type) {
     case chrome::NOTIFICATION_RETARGETING: {
       Profile* profile = content::Source<Profile>(source).ptr();
       if (profile->GetOriginalProfile() == profile_) {
         Retargeting(
             content::Details<const RetargetingDetails>(details).ptr());
@@ skipping 375 matching lines @@
     frame->frame_id = GetFrameId(navigation_state.IsMainFrame(frame_id),
                                  frame_id);
     frame->error_occurred = navigation_state.GetErrorOccurredInFrame(frame_id);
     result_list.push_back(frame);
   }
   result_.reset(GetAllFrames::Result::Create(result_list));
   return true;
 }
 
 }  // namespace extensions