Track in which frames navigation errors occurred and don't send further navigation events for them

chrome/browser/extensions/extension_webnavigation_api.cc

 // Copyright (c) 2010 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/extension_webnavigation_api.h"
 
 #include "base/json/json_writer.h"
 #include "base/time.h"
 #include "base/values.h"
 #include "chrome/browser/extensions/extension_event_router.h"
 #include "chrome/browser/extensions/extension_tabs_module.h"
 #include "chrome/browser/extensions/extension_webnavigation_api_constants.h"
 #include "chrome/browser/profile.h"
 #include "chrome/browser/tab_contents/navigation_controller.h"
 #include "chrome/browser/tab_contents/provisional_load_details.h"
 #include "chrome/common/notification_type.h"
 #include "chrome/common/notification_service.h"
+#include "chrome/common/url_constants.h"
 #include "net/base/net_errors.h"
 
 namespace keys = extension_webnavigation_api_constants;
 
 namespace {
 
 // Returns 0 if the navigation happens in the main frame, or the frame ID
 // modulo 32 bits otherwise.
 int GetFrameId(ProvisionalLoadDetails* details) {
   return details->main_frame() ? 0 : static_cast<int>(details->frame_id());
 }
 
 // Returns |time| as milliseconds since the epoch.
 double MilliSecondsFromTime(const base::Time& time) {
   return 1000 * time.ToDoubleT();
 }
 
 }  // namespace
 
+FrameNavigationState::FrameNavigationState() {
+  registrar_.Add(this,
+                 NotificationType::TAB_CONTENTS_DESTROYED,
+                 NotificationService::AllSources());
+}
+
+FrameNavigationState::~FrameNavigationState() {
+}
+
+bool FrameNavigationState::CanSendEvents(long long frame_id) const {
+  FrameIdToErrorStateMap::const_iterator frame_state =
+      frame_state_map_.find(frame_id);
+  return frame_state != frame_state_map_.end() &&
+      !frame_state->second;
+}
+
+void FrameNavigationState::TrackFrame(long long frame_id,
+                                      const GURL& url,
+                                      bool is_main_frame,
+                                      const TabContents* tab_contents) {
+  if (is_main_frame)
+    RemoveTabContentsState(tab_contents);
+  tab_contents_map_.insert(
+      TabContentsToFrameIdMap::value_type(tab_contents, frame_id));
+  frame_state_map_[frame_id] =
+      (url.spec() == chrome::kChromeUnreachableWebDataURL);
+}
+
+void FrameNavigationState::ErrorOccurredInFrame(long long frame_id) {
+  DCHECK(frame_state_map_.find(frame_id) != frame_state_map_.end());
+  frame_state_map_[frame_id] = true;
+}
+
+void FrameNavigationState::Observe(
+    NotificationType type,
+    const NotificationSource& source,
+    const NotificationDetails& details) {
+  RemoveTabContentsState(Source<TabContents>(source).ptr());
+}
+
+void FrameNavigationState::RemoveTabContentsState(
+    const TabContents* tab_contents) {
+  typedef TabContentsToFrameIdMap::iterator FrameIdIterator;
+  std::pair<FrameIdIterator, FrameIdIterator> frame_ids =
+          tab_contents_map_.equal_range(tab_contents);
+  for (FrameIdIterator frame_id = frame_ids.first; frame_id != frame_ids.second;
+       frame_id++) {

[yzshen, 2010/10/27 17:43:38]

[optional] Better to use ++frame_id.

+    frame_state_map_.erase(frame_id->second);
+  }
+  tab_contents_map_.erase(tab_contents);
+}
+
+
 // static
 ExtensionWebNavigationEventRouter*
 ExtensionWebNavigationEventRouter::GetInstance() {
   return Singleton<ExtensionWebNavigationEventRouter>::get();
 }
 
 void ExtensionWebNavigationEventRouter::Init() {
   if (registrar_.IsEmpty()) {
     registrar_.Add(this,
                    NotificationType::FRAME_PROVISIONAL_LOAD_START,
@@ skipping 28 matching lines @@
           Details<ProvisionalLoadDetails>(details).ptr());
       break;
 
     default:
       NOTREACHED();
   }
 }
 void ExtensionWebNavigationEventRouter::FrameProvisionalLoadStart(
     NavigationController* controller,
     ProvisionalLoadDetails* details) {
+  navigation_state_.TrackFrame(details->frame_id(),
+                               details->url(),
+                               details->main_frame(),
+                               controller->tab_contents());
   ListValue args;
   DictionaryValue* dict = new DictionaryValue();
   dict->SetInteger(keys::kTabIdKey,
                    ExtensionTabUtil::GetTabId(controller->tab_contents()));
   dict->SetString(keys::kUrlKey,
                   details->url().spec());
   dict->SetInteger(keys::kFrameIdKey, GetFrameId(details));
   dict->SetInteger(keys::kRequestIdKey, 0);
   dict->SetReal(keys::kTimeStampKey, MilliSecondsFromTime(base::Time::Now()));
   args.Append(dict);
 
   std::string json_args;
   base::JSONWriter::Write(&args, false, &json_args);
-  DispatchEvent(controller->profile(), keys::kOnBeforeNavigate, json_args);
+  if (navigation_state_.CanSendEvents(details->frame_id()))
+    DispatchEvent(controller->profile(), keys::kOnBeforeNavigate, json_args);
 }
 
 void ExtensionWebNavigationEventRouter::FrameProvisionalLoadCommitted(
     NavigationController* controller,
     ProvisionalLoadDetails* details) {
   ListValue args;
   DictionaryValue* dict = new DictionaryValue();
   dict->SetInteger(keys::kTabIdKey,
                    ExtensionTabUtil::GetTabId(controller->tab_contents()));
   dict->SetString(keys::kUrlKey,
                   details->url().spec());
   dict->SetInteger(keys::kFrameIdKey, GetFrameId(details));
   dict->SetString(keys::kTransitionTypeKey,
                   PageTransition::CoreTransitionString(
                       details->transition_type()));
   dict->SetString(keys::kTransitionQualifiersKey,
                   PageTransition::QualifierString(
                       details->transition_type()));
   dict->SetReal(keys::kTimeStampKey, MilliSecondsFromTime(base::Time::Now()));
   args.Append(dict);
 
   std::string json_args;
   base::JSONWriter::Write(&args, false, &json_args);
-  DispatchEvent(controller->profile(), keys::kOnCommitted, json_args);
+  if (navigation_state_.CanSendEvents(details->frame_id()))
+    DispatchEvent(controller->profile(), keys::kOnCommitted, json_args);
 }
 
 void ExtensionWebNavigationEventRouter::FailProvisionalLoadWithError(
     NavigationController* controller,
     ProvisionalLoadDetails* details) {
   ListValue args;
   DictionaryValue* dict = new DictionaryValue();
   dict->SetInteger(keys::kTabIdKey,
                    ExtensionTabUtil::GetTabId(controller->tab_contents()));
   dict->SetString(keys::kUrlKey,
                   details->url().spec());
   dict->SetInteger(keys::kFrameIdKey, GetFrameId(details));
   dict->SetString(keys::kErrorKey,
                   std::string(net::ErrorToString(details->error_code())));
   dict->SetReal(keys::kTimeStampKey, MilliSecondsFromTime(base::Time::Now()));
   args.Append(dict);
 
   std::string json_args;
   base::JSONWriter::Write(&args, false, &json_args);
-  DispatchEvent(controller->profile(), keys::kOnErrorOccurred, json_args);
+  if (navigation_state_.CanSendEvents(details->frame_id())) {
+    navigation_state_.ErrorOccurredInFrame(details->frame_id());
+    DispatchEvent(controller->profile(), keys::kOnErrorOccurred, json_args);
+  }
 }
 
 void ExtensionWebNavigationEventRouter::DispatchEvent(
     Profile* profile,
     const char* event_name,
     const std::string& json_args) {
   if (profile && profile->GetExtensionEventRouter()) {
     profile->GetExtensionEventRouter()->DispatchEventToRenderers(
         event_name, json_args, profile, GURL());
   }
 }