content/browser/frame_host/frame_tree_node.cc

   1 // Copyright 2013 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 #include "content/browser/frame_host/frame_tree_node.h"
   6
   7 #include <queue>
   8
   9 #include "base/command_line.h"
  10 #include "base/profiler/scoped_tracker.h"
  11 #include "base/stl_util.h"
  12 #include "content/browser/frame_host/frame_tree.h"
  13 #include "content/browser/frame_host/navigation_request.h"
  14 #include "content/browser/frame_host/navigator.h"
  15 #include "content/browser/frame_host/render_frame_host_impl.h"
  16 #include "content/browser/renderer_host/render_view_host_impl.h"
  17 #include "content/common/frame_messages.h"
  18 #include "content/public/browser/browser_thread.h"
  19 #include "content/public/common/content_switches.h"
  20
  21 namespace content {
  22
  23 namespace {
  24
  25 // This is a global map between frame_tree_node_ids and pointers to
  26 // FrameTreeNodes.
  27 typedef base::hash_map<int, FrameTreeNode*> FrameTreeNodeIDMap;
  28
  29 base::LazyInstance<FrameTreeNodeIDMap> g_frame_tree_node_id_map =
  30     LAZY_INSTANCE_INITIALIZER;
  31
  32 // These values indicate the loading progress status. The minimum progress
  33 // value matches what Blink's ProgressTracker has traditionally used for a
  34 // minimum progress value.
  35 const double kLoadingProgressNotStarted = 0.0;
  36 const double kLoadingProgressMinimum = 0.1;
  37 const double kLoadingProgressDone = 1.0;
  38
  39 }  // namespace
  40
  41 // This observer watches the opener of its owner FrameTreeNode and clears the
  42 // owner's opener if the opener is destroyed.
  43 class FrameTreeNode::OpenerDestroyedObserver : public FrameTreeNode::Observer {
  44  public:
  45   OpenerDestroyedObserver(FrameTreeNode* owner) : owner_(owner) {}
  46
  47   // FrameTreeNode::Observer
  48   void OnFrameTreeNodeDestroyed(FrameTreeNode* node) override {
  49     CHECK_EQ(owner_->opener(), node);
  50     owner_->SetOpener(nullptr);
  51   }
  52
  53  private:
  54   FrameTreeNode* owner_;
  55
  56   DISALLOW_COPY_AND_ASSIGN(OpenerDestroyedObserver);
  57 };
  58
  59 int FrameTreeNode::next_frame_tree_node_id_ = 1;
  60
  61 // static
  62 FrameTreeNode* FrameTreeNode::GloballyFindByID(int frame_tree_node_id) {
  63   DCHECK_CURRENTLY_ON(BrowserThread::UI);
  64   FrameTreeNodeIDMap* nodes = g_frame_tree_node_id_map.Pointer();
  65   FrameTreeNodeIDMap::iterator it = nodes->find(frame_tree_node_id);
  66   return it == nodes->end() ? nullptr : it->second;
  67 }
  68
  69 FrameTreeNode::FrameTreeNode(FrameTree* frame_tree,
  70                              Navigator* navigator,
  71                              RenderFrameHostDelegate* render_frame_delegate,
  72                              RenderViewHostDelegate* render_view_delegate,
  73                              RenderWidgetHostDelegate* render_widget_delegate,
  74                              RenderFrameHostManager::Delegate* manager_delegate,
  75                              blink::WebTreeScopeType scope,
  76                              const std::string& name,
  77                              blink::WebSandboxFlags sandbox_flags)
  78     : frame_tree_(frame_tree),
  79       navigator_(navigator),
  80       render_manager_(this,
  81                       render_frame_delegate,
  82                       render_view_delegate,
  83                       render_widget_delegate,
  84                       manager_delegate),
  85       frame_tree_node_id_(next_frame_tree_node_id_++),
  86       parent_(NULL),
  87       opener_(nullptr),
  88       opener_observer_(nullptr),
  89       has_committed_real_load_(false),
  90       replication_state_(scope, name, sandbox_flags),
  91       // Effective sandbox flags also need to be set, since initial sandbox
  92       // flags should apply to the initial empty document in the frame.
  93       effective_sandbox_flags_(sandbox_flags),
  94       loading_progress_(kLoadingProgressNotStarted) {
  95   std::pair<FrameTreeNodeIDMap::iterator, bool> result =
  96       g_frame_tree_node_id_map.Get().insert(
  97           std::make_pair(frame_tree_node_id_, this));
  98   CHECK(result.second);
  99 }
 100
 101 FrameTreeNode::~FrameTreeNode() {
 102   frame_tree_->FrameRemoved(this);
 103   FOR_EACH_OBSERVER(Observer, observers_, OnFrameTreeNodeDestroyed(this));
 104
 105   if (opener_)
 106     opener_->RemoveObserver(opener_observer_.get());
 107
 108   g_frame_tree_node_id_map.Get().erase(frame_tree_node_id_);
 109 }
 110
 111 void FrameTreeNode::AddObserver(Observer* observer) {
 112   observers_.AddObserver(observer);
 113 }
 114
 115 void FrameTreeNode::RemoveObserver(Observer* observer) {
 116   observers_.RemoveObserver(observer);
 117 }
 118
 119 bool FrameTreeNode::IsMainFrame() const {
 120   return frame_tree_->root() == this;
 121 }
 122
 123 void FrameTreeNode::AddChild(scoped_ptr<FrameTreeNode> child,
 124                              int process_id,
 125                              int frame_routing_id) {
 126   // Child frame must always be created in the same process as the parent.
 127   CHECK_EQ(process_id, render_manager_.current_host()->GetProcess()->GetID());
 128
 129   // Initialize the RenderFrameHost for the new node.  We always create child
 130   // frames in the same SiteInstance as the current frame, and they can swap to
 131   // a different one if they navigate away.
 132   child->render_manager()->Init(
 133       render_manager_.current_host()->GetSiteInstance()->GetBrowserContext(),
 134       render_manager_.current_host()->GetSiteInstance(),
 135       render_manager_.current_host()->GetRoutingID(),
 136       frame_routing_id);
 137   child->set_parent(this);
 138
 139   // Other renderer processes in this BrowsingInstance may need to find out
 140   // about the new frame.  Create a proxy for the child frame in all
 141   // SiteInstances that have a proxy for the frame's parent, since all frames
 142   // in a frame tree should have the same set of proxies.
 143   if (base::CommandLine::ForCurrentProcess()->HasSwitch(
 144           switches::kSitePerProcess))
 145     render_manager_.CreateProxiesForChildFrame(child.get());
 146
 147   children_.push_back(child.release());
 148 }
 149
 150 void FrameTreeNode::RemoveChild(FrameTreeNode* child) {
 151   std::vector<FrameTreeNode*>::iterator iter;
 152   for (iter = children_.begin(); iter != children_.end(); ++iter) {
 153     if ((*iter) == child)
 154       break;
 155   }
 156
 157   if (iter != children_.end()) {
 158     // Subtle: we need to make sure the node is gone from the tree before
 159     // observers are notified of its deletion.
 160     scoped_ptr<FrameTreeNode> node_to_delete(*iter);
 161     children_.weak_erase(iter);
 162     node_to_delete.reset();
 163   }
 164 }
 165
 166 void FrameTreeNode::ResetForNewProcess() {
 167   current_url_ = GURL();
 168
 169   // The children may not have been cleared if a cross-process navigation
 170   // commits before the old process cleans everything up.  Make sure the child
 171   // nodes get deleted before swapping to a new process.
 172   ScopedVector<FrameTreeNode> old_children = children_.Pass();
 173   old_children.clear();  // May notify observers.
 174 }
 175
 176 void FrameTreeNode::SetOpener(FrameTreeNode* opener) {
 177   if (opener_) {
 178     opener_->RemoveObserver(opener_observer_.get());
 179     opener_observer_.reset();
 180   }
 181
 182   opener_ = opener;
 183
 184   if (opener_) {
 185     if (!opener_observer_)
 186       opener_observer_ = make_scoped_ptr(new OpenerDestroyedObserver(this));
 187     opener_->AddObserver(opener_observer_.get());
 188   }
 189 }
 190
 191 void FrameTreeNode::SetCurrentURL(const GURL& url) {
 192   if (!has_committed_real_load_ && url != GURL(url::kAboutBlankURL))
 193     has_committed_real_load_ = true;
 194   current_url_ = url;
 195 }
 196
 197 void FrameTreeNode::SetCurrentOrigin(const url::Origin& origin) {
 198   if (!origin.IsSameOriginWith(replication_state_.origin))
 199     render_manager_.OnDidUpdateOrigin(origin);
 200   replication_state_.origin = origin;
 201 }
 202
 203 void FrameTreeNode::SetFrameName(const std::string& name) {
 204   if (name != replication_state_.name)
 205     render_manager_.OnDidUpdateName(name);
 206   replication_state_.name = name;
 207 }
 208
 209 bool FrameTreeNode::IsDescendantOf(FrameTreeNode* other) const {
 210   if (!other || !other->child_count())
 211     return false;
 212
 213   for (FrameTreeNode* node = parent(); node; node = node->parent()) {
 214     if (node == other)
 215       return true;
 216   }
 217
 218   return false;
 219 }
 220
 221 FrameTreeNode* FrameTreeNode::PreviousSibling() const {
 222   if (!parent_)
 223     return nullptr;
 224
 225   for (size_t i = 0; i < parent_->child_count(); ++i) {
 226     if (parent_->child_at(i) == this)
 227       return (i == 0) ? nullptr : parent_->child_at(i - 1);
 228   }
 229
 230   NOTREACHED() << "FrameTreeNode not found in its parent's children.";
 231   return nullptr;
 232 }
 233
 234 bool FrameTreeNode::IsLoading() const {
 235   RenderFrameHostImpl* current_frame_host =
 236       render_manager_.current_frame_host();
 237   RenderFrameHostImpl* pending_frame_host =
 238       render_manager_.pending_frame_host();
 239
 240   DCHECK(current_frame_host);
 241
 242   if (base::CommandLine::ForCurrentProcess()->HasSwitch(
 243           switches::kEnableBrowserSideNavigation)) {
 244     if (navigation_request_)
 245       return true;
 246
 247     RenderFrameHostImpl* speculative_frame_host =
 248         render_manager_.speculative_frame_host();
 249     if (speculative_frame_host && speculative_frame_host->is_loading())
 250       return true;
 251   } else {
 252     if (pending_frame_host && pending_frame_host->is_loading())
 253       return true;
 254   }
 255   return current_frame_host->is_loading();
 256 }
 257
 258 bool FrameTreeNode::CommitPendingSandboxFlags() {
 259   bool did_change_flags =
 260       effective_sandbox_flags_ != replication_state_.sandbox_flags;
 261   effective_sandbox_flags_ = replication_state_.sandbox_flags;
 262   return did_change_flags;
 263 }
 264
 265 void FrameTreeNode::CreatedNavigationRequest(
 266     scoped_ptr<NavigationRequest> navigation_request) {
 267   CHECK(base::CommandLine::ForCurrentProcess()->HasSwitch(
 268       switches::kEnableBrowserSideNavigation));
 269   ResetNavigationRequest(false);
 270
 271   // Force the throbber to start to keep it in sync with what is happening in
 272   // the UI. Blink doesn't send throb notifications for JavaScript URLs, so it
 273   // is not done here either.
 274   if (!navigation_request->common_params().url.SchemeIs(
 275           url::kJavaScriptScheme)) {
 276     // TODO(fdegans): Check if this is a same-document navigation and set the
 277     // proper argument.
 278     DidStartLoading(true);
 279   }
 280
 281   navigation_request_ = navigation_request.Pass();
 282
 283   render_manager()->DidCreateNavigationRequest(*navigation_request_);
 284 }
 285
 286 void FrameTreeNode::ResetNavigationRequest(bool is_commit) {
 287   CHECK(base::CommandLine::ForCurrentProcess()->HasSwitch(
 288       switches::kEnableBrowserSideNavigation));
 289   if (!navigation_request_)
 290     return;
 291   navigation_request_.reset();
 292
 293   // During commit, the clean up of a speculative RenderFrameHost is done in
 294   // RenderFrameHostManager::DidNavigateFrame. The load is also still being
 295   // tracked.
 296   if (is_commit)
 297     return;
 298
 299   // If the reset corresponds to a cancelation, the RenderFrameHostManager
 300   // should clean up any speculative RenderFrameHost it created for the
 301   // navigation.
 302   DidStopLoading();
 303   render_manager_.CleanUpNavigation();
 304 }
 305
 306 bool FrameTreeNode::has_started_loading() const {
 307   return loading_progress_ != kLoadingProgressNotStarted;
 308 }
 309
 310 void FrameTreeNode::reset_loading_progress() {
 311   loading_progress_ = kLoadingProgressNotStarted;
 312 }
 313
 314 void FrameTreeNode::DidStartLoading(bool to_different_document) {
 315   // Any main frame load to a new document should reset the load progress since
 316   // it will replace the current page and any frames. The WebContents will
 317   // be notified when DidChangeLoadProgress is called.
 318   if (to_different_document && IsMainFrame())
 319     frame_tree_->ResetLoadProgress();
 320
 321   // Notify the WebContents.
 322   if (!frame_tree_->IsLoading())
 323     navigator()->GetDelegate()->DidStartLoading(this, to_different_document);
 324
 325   // Set initial load progress and update overall progress. This will notify
 326   // the WebContents of the load progress change.
 327   DidChangeLoadProgress(kLoadingProgressMinimum);
 328
 329   // Notify the RenderFrameHostManager of the event.
 330   render_manager()->OnDidStartLoading();
 331 }
 332
 333 void FrameTreeNode::DidStopLoading() {
 334   // TODO(erikchen): Remove ScopedTracker below once crbug.com/465796 is fixed.
 335   tracked_objects::ScopedTracker tracking_profile1(
 336       FROM_HERE_WITH_EXPLICIT_FUNCTION(
 337           "465796 FrameTreeNode::DidStopLoading::Start"));
 338
 339   // Set final load progress and update overall progress. This will notify
 340   // the WebContents of the load progress change.
 341   DidChangeLoadProgress(kLoadingProgressDone);
 342
 343   // TODO(erikchen): Remove ScopedTracker below once crbug.com/465796 is fixed.
 344   tracked_objects::ScopedTracker tracking_profile2(
 345       FROM_HERE_WITH_EXPLICIT_FUNCTION(
 346           "465796 FrameTreeNode::DidStopLoading::WCIDidStopLoading"));
 347
 348   // Notify the WebContents.
 349   if (!frame_tree_->IsLoading())
 350     navigator()->GetDelegate()->DidStopLoading();
 351
 352   // TODO(erikchen): Remove ScopedTracker below once crbug.com/465796 is fixed.
 353   tracked_objects::ScopedTracker tracking_profile3(
 354       FROM_HERE_WITH_EXPLICIT_FUNCTION(
 355           "465796 FrameTreeNode::DidStopLoading::RFHMDidStopLoading"));
 356
 357   // Notify the RenderFrameHostManager of the event.
 358   render_manager()->OnDidStopLoading();
 359
 360   // TODO(erikchen): Remove ScopedTracker below once crbug.com/465796 is fixed.
 361   tracked_objects::ScopedTracker tracking_profile4(
 362       FROM_HERE_WITH_EXPLICIT_FUNCTION(
 363           "465796 FrameTreeNode::DidStopLoading::End"));
 364 }
 365
 366 void FrameTreeNode::DidChangeLoadProgress(double load_progress) {
 367   loading_progress_ = load_progress;
 368   frame_tree_->UpdateLoadProgress();
 369 }
 370
 371 bool FrameTreeNode::StopLoading() {
 372   if (base::CommandLine::ForCurrentProcess()->HasSwitch(
 373           switches::kEnableBrowserSideNavigation)) {
 374     ResetNavigationRequest(false);
 375   }
 376
 377   // TODO(nasko): see if child frames should send IPCs in site-per-process
 378   // mode.
 379   if (!IsMainFrame())
 380     return true;
 381
 382   render_manager_.Stop();
 383   return true;
 384 }
 385
 386 }  // namespace content