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