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   enum Event {
  36     EVENT_LOGGED_IN_TABLE_REQUESTED = 0,
  37     EVENT_LOGGED_IN_TABLE_PRESENT = 1,
  38     EVENT_MAINFRAME_CHANGE = 2,
  39     EVENT_MAINFRAME_CHANGE_DOMAIN_LOGGED_IN = 3,
  40     EVENT_MAINFRAME_COMMIT = 4,
  41     EVENT_MAINFRAME_COMMIT_DOMAIN_LOGGED_IN = 5,
  42     EVENT_LOGIN_ACTION_ADDED = 6,
  43     EVENT_LOGIN_ACTION_ADDED_PW_EMPTY = 7,
  44     EVENT_MAX_VALUE
  45   };
  46
  47   ~PrerenderTabHelper() override;
  48
  49   // content::WebContentsObserver implementation.
  50   void DidGetRedirectForResourceRequest(
  51       content::RenderFrameHost* render_frame_host,
  52       const content::ResourceRedirectDetails& details) override;
  53   void DidStopLoading() override;
  54   void DidStartProvisionalLoadForFrame(
  55       content::RenderFrameHost* render_frame_host,
  56       const GURL& validated_url,
  57       bool is_error_page,
  58       bool is_iframe_srcdoc) override;
  59   void DidCommitProvisionalLoadForFrame(
  60       content::RenderFrameHost* render_frame_host,
  61       const GURL& validated_url,
  62       ui::PageTransition transition_type) override;
  63
  64   // Called when the URL of the main frame changed, either when the load
  65   // commits, or a redirect happens.
  66   void MainFrameUrlDidChange(const GURL& url);
  67
  68   // Called when a password form has been submitted.
  69   void PasswordSubmitted(const autofill::PasswordForm& form);
  70
  71   // Called when this prerendered WebContents has just been swapped in.
  72   void PrerenderSwappedIn();
  73
  74   // Called when a control prerender is resolved. Applies to the next load.
  75   void WouldHavePrerenderedNextLoad(Origin origin);
  76
  77  private:
  78   explicit PrerenderTabHelper(content::WebContents* web_contents);
  79   friend class content::WebContentsUserData<PrerenderTabHelper>;
  80
  81   void RecordEvent(Event event) const;
  82   void RecordEventIfLoggedInURL(Event event, const GURL& url);
  83   void RecordEventIfLoggedInURLResult(Event event, scoped_ptr<bool> is_present,
  84                                       scoped_ptr<bool> lookup_succeeded);
  85
  86   void RecordPerceivedPageLoadTime(
  87       base::TimeDelta perceived_page_load_time,
  88       double fraction_plt_elapsed_at_swap_in);
  89
  90   // Retrieves the PrerenderManager, or NULL, if none was found.
  91   PrerenderManager* MaybeGetPrerenderManager() const;
  92
  93   // Returns whether the WebContents being observed is currently prerendering.
  94   bool IsPrerendering();
  95
  96   // The type the current pending navigation, if there is one. If the tab is a
  97   // prerender before swap, the value is always NAVIGATION_TYPE_PRERENDERED,
  98   // even if the prerender is not currently loading.
  99   NavigationType navigation_type_;
 100
 101   // If |navigation_type_| is not NAVIGATION_TYPE_NORMAL, the origin of the
 102   // relevant prerender. Otherwise, ORIGIN_NONE.
 103   Origin origin_;
 104
 105   // True if the next load will be associated with a control prerender. This
 106   // extra state is needed because control prerenders are resolved before the
 107   // actual load begins. |next_load_origin_| gives the origin of the control
 108   // prerender.
 109   bool next_load_is_control_prerender_;
 110   Origin next_load_origin_;
 111
 112   // System time at which the current load was started for the purpose of
 113   // the perceived page load time (PPLT). If null, there is no current
 114   // load.
 115   base::TimeTicks pplt_load_start_;
 116
 117   // System time at which the actual pageload started (pre-swapin), if
 118   // a applicable (in cases when a prerender that was still loading was
 119   // swapped in).
 120   base::TimeTicks actual_load_start_;
 121
 122   // Current URL being loaded.
 123   GURL url_;
 124
 125   base::WeakPtrFactory<PrerenderTabHelper> weak_factory_;
 126
 127   DISALLOW_COPY_AND_ASSIGN(PrerenderTabHelper);
 128 };
 129
 130 }  // namespace prerender
 131
 132 #endif  // CHROME_BROWSER_PRERENDER_PRERENDER_TAB_HELPER_H_