chrome/browser/prerender/prerender_tab_helper.h

   1 // Copyright (c) 2012 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 CHROME_BROWSER_PRERENDER_PRERENDER_TAB_HELPER_H_
   6 #define CHROME_BROWSER_PRERENDER_PRERENDER_TAB_HELPER_H_
   7
   8 #include "base/memory/scoped_ptr.h"
   9 #include "base/memory/weak_ptr.h"
  10 #include "base/time/time.h"
  11 #include "chrome/browser/prerender/prerender_histograms.h"
  12 #include "chrome/browser/prerender/prerender_origin.h"
  13 #include "content/public/browser/web_contents_observer.h"
  14 #include "content/public/browser/web_contents_user_data.h"
  15 #include "url/gurl.h"
  16
  17 namespace autofill {
  18 struct PasswordForm;
  19 }
  20
  21 namespace password_manager {
  22 class PasswordManager;
  23 }
  24
  25 namespace prerender {
  26
  27 class PrerenderManager;
  28
  29 // PrerenderTabHelper is responsible for recording perceived pageload times
  30 // to compare PLT's with prerendering enabled and disabled.
  31 class PrerenderTabHelper
  32     : public content::WebContentsObserver,
  33       public content::WebContentsUserData<PrerenderTabHelper> {
  34  public:
  35   ~PrerenderTabHelper() override;
  36
  37   // content::WebContentsObserver implementation.
  38   void DidGetRedirectForResourceRequest(
  39       content::RenderFrameHost* render_frame_host,
  40       const content::ResourceRedirectDetails& details) override;
  41   void DidStopLoading() override;
  42   void DidStartProvisionalLoadForFrame(
  43       content::RenderFrameHost* render_frame_host,
  44       const GURL& validated_url,
  45       bool is_error_page,
  46       bool is_iframe_srcdoc) override;
  47   void DidCommitProvisionalLoadForFrame(
  48       content::RenderFrameHost* render_frame_host,
  49       const GURL& validated_url,
  50       ui::PageTransition transition_type) override;
  51
  52   // Called when the URL of the main frame changed, either when the load
  53   // commits, or a redirect happens.
  54   void MainFrameUrlDidChange(const GURL& url);
  55
  56   // Called when this prerendered WebContents has just been swapped in.
  57   void PrerenderSwappedIn();
  58
  59   // Called when a control prerender is resolved. Applies to the next load.
  60   void WouldHavePrerenderedNextLoad(Origin origin);
  61
  62  private:
  63   explicit PrerenderTabHelper(content::WebContents* web_contents);
  64   friend class content::WebContentsUserData<PrerenderTabHelper>;
  65
  66   void RecordPerceivedPageLoadTime(
  67       base::TimeDelta perceived_page_load_time,
  68       double fraction_plt_elapsed_at_swap_in);
  69
  70   // Retrieves the PrerenderManager, or NULL, if none was found.
  71   PrerenderManager* MaybeGetPrerenderManager() const;
  72
  73   // Returns whether the WebContents being observed is currently prerendering.
  74   bool IsPrerendering();
  75
  76   // The type the current pending navigation, if there is one. If the tab is a
  77   // prerender before swap, the value is always NAVIGATION_TYPE_PRERENDERED,
  78   // even if the prerender is not currently loading.
  79   NavigationType navigation_type_;
  80
  81   // If |navigation_type_| is not NAVIGATION_TYPE_NORMAL, the origin of the
  82   // relevant prerender. Otherwise, ORIGIN_NONE.
  83   Origin origin_;
  84
  85   // True if the next load will be associated with a control prerender. This
  86   // extra state is needed because control prerenders are resolved before the
  87   // actual load begins. |next_load_origin_| gives the origin of the control
  88   // prerender.
  89   bool next_load_is_control_prerender_;
  90   Origin next_load_origin_;
  91
  92   // System time at which the current load was started for the purpose of
  93   // the perceived page load time (PPLT). If null, there is no current
  94   // load.
  95   base::TimeTicks pplt_load_start_;
  96
  97   // System time at which the actual pageload started (pre-swapin), if
  98   // a applicable (in cases when a prerender that was still loading was
  99   // swapped in).
 100   base::TimeTicks actual_load_start_;
 101
 102   // Current URL being loaded.
 103   GURL url_;
 104
 105   base::WeakPtrFactory<PrerenderTabHelper> weak_factory_;
 106
 107   DISALLOW_COPY_AND_ASSIGN(PrerenderTabHelper);
 108 };
 109
 110 }  // namespace prerender
 111
 112 #endif  // CHROME_BROWSER_PRERENDER_PRERENDER_TAB_HELPER_H_