content/browser/frame_host/navigator_impl.h

   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 #ifndef CONTENT_BROWSER_FRAME_HOST_NAVIGATOR_IMPL_H_
   6 #define CONTENT_BROWSER_FRAME_HOST_NAVIGATOR_IMPL_H_
   7
   8 #include "base/containers/scoped_ptr_hash_map.h"
   9 #include "base/memory/ref_counted.h"
  10 #include "base/memory/scoped_ptr.h"
  11 #include "base/time/time.h"
  12 #include "content/browser/frame_host/navigation_controller_impl.h"
  13 #include "content/browser/frame_host/navigator.h"
  14 #include "content/common/content_export.h"
  15 #include "url/gurl.h"
  16
  17 class GURL;
  18 struct FrameMsg_Navigate_Params;
  19
  20 namespace content {
  21
  22 class NavigationControllerImpl;
  23 class NavigatorDelegate;
  24 class NavigatorTest;
  25 struct LoadCommittedDetails;
  26 struct CommitNavigationParams;
  27 struct CommonNavigationParams;
  28 struct RequestNavigationParams;
  29
  30 // This class is an implementation of Navigator, responsible for managing
  31 // navigations in regular browser tabs.
  32 class CONTENT_EXPORT NavigatorImpl : public Navigator {
  33  public:
  34   NavigatorImpl(NavigationControllerImpl* navigation_controller,
  35                 NavigatorDelegate* delegate);
  36
  37   // Navigator implementation.
  38   NavigationController* GetController() override;
  39   void DidStartProvisionalLoad(RenderFrameHostImpl* render_frame_host,
  40                                const GURL& url,
  41                                bool is_transition_navigation) override;
  42   void DidFailProvisionalLoadWithError(
  43       RenderFrameHostImpl* render_frame_host,
  44       const FrameHostMsg_DidFailProvisionalLoadWithError_Params& params)
  45       override;
  46   void DidFailLoadWithError(RenderFrameHostImpl* render_frame_host,
  47                             const GURL& url,
  48                             int error_code,
  49                             const base::string16& error_description) override;
  50   void DidNavigate(RenderFrameHostImpl* render_frame_host,
  51                    const FrameHostMsg_DidCommitProvisionalLoad_Params&
  52                        input_params) override;
  53   bool NavigateToPendingEntry(
  54       FrameTreeNode* frame_tree_node,
  55       NavigationController::ReloadType reload_type) override;
  56   void RequestOpenURL(RenderFrameHostImpl* render_frame_host,
  57                       const GURL& url,
  58                       SiteInstance* source_site_instance,
  59                       const Referrer& referrer,
  60                       WindowOpenDisposition disposition,
  61                       bool should_replace_current_entry,
  62                       bool user_gesture) override;
  63   void RequestTransferURL(RenderFrameHostImpl* render_frame_host,
  64                           const GURL& url,
  65                           SiteInstance* source_site_instance,
  66                           const std::vector<GURL>& redirect_chain,
  67                           const Referrer& referrer,
  68                           ui::PageTransition page_transition,
  69                           WindowOpenDisposition disposition,
  70                           const GlobalRequestID& transferred_global_request_id,
  71                           bool should_replace_current_entry,
  72                           bool user_gesture) override;
  73   void OnBeforeUnloadACK(FrameTreeNode* frame_tree_node, bool proceed) override;
  74   void OnBeginNavigation(FrameTreeNode* frame_tree_node,
  75                          const CommonNavigationParams& common_params,
  76                          const BeginNavigationParams& begin_params,
  77                          scoped_refptr<ResourceRequestBody> body) override;
  78   void CommitNavigation(FrameTreeNode* frame_tree_node,
  79                         ResourceResponse* response,
  80                         scoped_ptr<StreamHandle> body) override;
  81   void LogResourceRequestTime(base::TimeTicks timestamp,
  82                               const GURL& url) override;
  83   void LogBeforeUnloadTime(
  84       const base::TimeTicks& renderer_before_unload_start_time,
  85       const base::TimeTicks& renderer_before_unload_end_time) override;
  86   void CancelNavigation(FrameTreeNode* frame_tree_node) override;
  87   bool IsWaitingForBeforeUnloadACK(FrameTreeNode* frame_tree_node) override;
  88
  89   // PlzNavigate
  90   // Returns the navigation request for a given node. Used in tests.
  91   NavigationRequest* GetNavigationRequestForNodeForTesting(
  92       FrameTreeNode* frame_tree_node);
  93
  94  private:
  95   // Holds data used to track browser side navigation metrics.
  96   struct NavigationMetricsData;
  97
  98   friend class NavigatorTestWithBrowserSideNavigation;
  99   ~NavigatorImpl() override;
 100
 101   // Navigates to the given entry, which must be the pending entry.  Private
 102   // because all callers should use NavigateToPendingEntry.
 103   bool NavigateToEntry(
 104       FrameTreeNode* frame_tree_node,
 105       const NavigationEntryImpl& entry,
 106       NavigationController::ReloadType reload_type);
 107
 108   bool ShouldAssignSiteForURL(const GURL& url);
 109
 110   void CheckWebUIRendererDoesNotDisplayNormalURL(
 111     RenderFrameHostImpl* render_frame_host,
 112     const GURL& url);
 113
 114   // PlzNavigate: if needed, sends a BeforeUnload IPC to the renderer to ask it
 115   // to execute the beforeUnload event. Otherwise, the navigation request will
 116   // be started.
 117   void RequestNavigation(FrameTreeNode* frame_tree_node,
 118                          const NavigationEntryImpl& entry,
 119                          NavigationController::ReloadType reload_type,
 120                          base::TimeTicks navigation_start);
 121
 122   // PlzNavigate: sends the NavigationRequest for |frame_tree_node| to the
 123   // network stack so that it can start.
 124   void BeginNavigation(FrameTreeNode* frame_tree_node);
 125
 126   void RecordNavigationMetrics(
 127       const LoadCommittedDetails& details,
 128       const FrameHostMsg_DidCommitProvisionalLoad_Params& params,
 129       SiteInstance* site_instance);
 130
 131   // The NavigationController that will keep track of session history for all
 132   // RenderFrameHost objects using this NavigatorImpl.
 133   // TODO(nasko): Move ownership of the NavigationController from
 134   // WebContentsImpl to this class.
 135   NavigationControllerImpl* controller_;
 136
 137   // Used to notify the object embedding this Navigator about navigation
 138   // events. Can be NULL in tests.
 139   NavigatorDelegate* delegate_;
 140
 141   scoped_ptr<NavigatorImpl::NavigationMetricsData> navigation_data_;
 142
 143   // PlzNavigate: used to track the various ongoing NavigationRequests in the
 144   // different FrameTreeNodes, based on the frame_tree_node_id.
 145   typedef base::ScopedPtrHashMap<int64, NavigationRequest> NavigationRequestMap;
 146   NavigationRequestMap navigation_request_map_;
 147
 148   DISALLOW_COPY_AND_ASSIGN(NavigatorImpl);
 149 };
 150
 151 }  // namespace content
 152
 153 #endif  // CONTENT_BROWSER_FRAME_HOST_NAVIGATOR_IMPL_H_