chrome/browser/captive_portal/captive_portal_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_CAPTIVE_PORTAL_CAPTIVE_PORTAL_TAB_HELPER_H_
   6 #define CHROME_BROWSER_CAPTIVE_PORTAL_CAPTIVE_PORTAL_TAB_HELPER_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/compiler_specific.h"
  10 #include "base/memory/scoped_ptr.h"
  11 #include "base/threading/non_thread_safe.h"
  12 #include "chrome/browser/captive_portal/captive_portal_service.h"
  13 #include "content/public/browser/notification_observer.h"
  14 #include "content/public/browser/notification_registrar.h"
  15 #include "content/public/browser/web_contents_observer.h"
  16 #include "content/public/browser/web_contents_user_data.h"
  17 #include "webkit/glue/resource_type.h"
  18
  19 class GURL;
  20 class Profile;
  21
  22 namespace content {
  23   class WebContents;
  24 }
  25
  26 namespace net {
  27 class SSLInfo;
  28 }
  29
  30 namespace captive_portal {
  31
  32 class CaptivePortalLoginDetector;
  33 class CaptivePortalTabReloader;
  34
  35 // Along with the classes it owns, responsible for detecting page loads broken
  36 // by a captive portal, triggering captive portal checks on navigation events
  37 // that may indicate a captive portal is present, or has been removed / logged
  38 // in to, and taking any correcting actions.
  39 //
  40 // It acts as a WebContentsObserver for its CaptivePortalLoginDetector and
  41 // CaptivePortalTabReloader.  It filters out non-main-frame resource loads, and
  42 // treats the commit of an error page as a single event, rather than as 3
  43 // (ProvisionalLoadFail, DidStartProvisionalLoad, DidCommit), which simplifies
  44 // the CaptivePortalTabReloader.  It is also needed by CaptivePortalTabReloaders
  45 // to inform the tab's CaptivePortalLoginDetector when the tab is at a captive
  46 // portal's login page.
  47 //
  48 // The TabHelper assumes that a WebContents can only have one RenderViewHost
  49 // with a provisional load at a time, and tracks only that navigation.  This
  50 // assumption can be violated in rare cases, for example, a same-site
  51 // navigation interrupted by a cross-process navigation started from the
  52 // omnibox, may commit before it can be cancelled.  In these cases, this class
  53 // may pass incorrect messages to the TabReloader, which will, at worst, result
  54 // in not opening up a login tab until a second load fails or not automatically
  55 // reloading a tab after logging in.
  56 //
  57 // For the design doc, see:
  58 // https://docs.google.com/document/d/1k-gP2sswzYNvryu9NcgN7q5XrsMlUdlUdoW9WRaEmfM/edit
  59 class CaptivePortalTabHelper
  60     : public content::WebContentsObserver,
  61       public content::NotificationObserver,
  62       public base::NonThreadSafe,
  63       public content::WebContentsUserData<CaptivePortalTabHelper> {
  64  public:
  65   virtual ~CaptivePortalTabHelper();
  66
  67   // content::WebContentsObserver:
  68   virtual void RenderViewDeleted(
  69       content::RenderViewHost* render_view_host) OVERRIDE;
  70
  71   virtual void DidStartProvisionalLoadForFrame(
  72       int64 frame_id,
  73       int64 parent_frame_id,
  74       bool is_main_frame,
  75       const GURL& validated_url,
  76       bool is_error_page,
  77       bool is_iframe_srcdoc,
  78       content::RenderViewHost* render_view_host) OVERRIDE;
  79
  80   virtual void DidCommitProvisionalLoadForFrame(
  81       int64 frame_id,
  82       bool is_main_frame,
  83       const GURL& url,
  84       content::PageTransition transition_type,
  85       content::RenderViewHost* render_view_host) OVERRIDE;
  86
  87   virtual void DidFailProvisionalLoad(
  88       int64 frame_id,
  89       bool is_main_frame,
  90       const GURL& validated_url,
  91       int error_code,
  92       const string16& error_description,
  93       content::RenderViewHost* render_view_host) OVERRIDE;
  94
  95   virtual void DidStopLoading(
  96       content::RenderViewHost* render_view_host) OVERRIDE;
  97
  98   // content::NotificationObserver:
  99   virtual void Observe(
 100       int type,
 101       const content::NotificationSource& source,
 102       const content::NotificationDetails& details) OVERRIDE;
 103
 104   // Called when a certificate interstitial error page is about to be shown.
 105   void OnSSLCertError(const net::SSLInfo& ssl_info);
 106
 107   // A "Login Tab" is a tab that was originally at a captive portal login
 108   // page.  This is set to false when a captive portal is no longer detected.
 109   bool IsLoginTab() const;
 110
 111  private:
 112   friend class CaptivePortalBrowserTest;
 113   friend class CaptivePortalTabHelperTest;
 114
 115   friend class content::WebContentsUserData<CaptivePortalTabHelper>;
 116   explicit CaptivePortalTabHelper(content::WebContents* web_contents);
 117
 118   // Called by Observe in response to the corresponding event.
 119   void OnRedirect(int child_id,
 120                   ResourceType::Type resource_type,
 121                   const GURL& new_url);
 122
 123   // Called by Observe in response to the corresponding event.
 124   void OnCaptivePortalResults(Result previous_result, Result result);
 125
 126   void OnLoadAborted();
 127
 128   // Called to indicate a tab is at, or is navigating to, the captive portal
 129   // login page.
 130   void SetIsLoginTab();
 131
 132   // |this| takes ownership of |tab_reloader|.
 133   void SetTabReloaderForTest(CaptivePortalTabReloader* tab_reloader);
 134
 135   const content::RenderViewHost* provisional_render_view_host() const {
 136     return provisional_render_view_host_;
 137   }
 138
 139   CaptivePortalTabReloader* GetTabReloaderForTest();
 140
 141   // Opens a login tab if the profile's active window doesn't have one already.
 142   void OpenLoginTab();
 143
 144   Profile* profile_;
 145
 146   // Neither of these will ever be NULL.
 147   scoped_ptr<CaptivePortalTabReloader> tab_reloader_;
 148   scoped_ptr<CaptivePortalLoginDetector> login_detector_;
 149
 150   content::WebContents* web_contents_;
 151
 152   // If a provisional load has failed, and the tab is loading an error page, the
 153   // error code associated with the error page we're loading.
 154   // net::OK, otherwise.
 155   int pending_error_code_;
 156
 157   // The RenderViewHost with a provisional load, if any.  Can either be
 158   // the currently displayed RenderViewHost or a pending RenderViewHost for
 159   // cross-process navitations.  NULL when there's currently no provisional
 160   // load.
 161   content::RenderViewHost* provisional_render_view_host_;
 162
 163   content::NotificationRegistrar registrar_;
 164
 165   DISALLOW_COPY_AND_ASSIGN(CaptivePortalTabHelper);
 166 };
 167
 168 }  // namespace captive_portal
 169
 170 #endif  // CHROME_BROWSER_CAPTIVE_PORTAL_CAPTIVE_PORTAL_TAB_HELPER_H_