chrome/browser/chromeos/login/captive_portal_window_proxy.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_CHROMEOS_LOGIN_CAPTIVE_PORTAL_WINDOW_PROXY_H_
   6 #define CHROME_BROWSER_CHROMEOS_LOGIN_CAPTIVE_PORTAL_WINDOW_PROXY_H_
   7
   8 #include "base/compiler_specific.h"
   9 #include "base/memory/scoped_ptr.h"
  10 #include "ui/views/widget/widget_observer.h"
  11
  12 namespace content {
  13 class WebContents;
  14 }
  15
  16 namespace views {
  17 class Widget;
  18 }
  19
  20 namespace chromeos {
  21
  22 class CaptivePortalView;
  23
  24 // Delegate interface for CaptivePortalWindowProxy.
  25 class CaptivePortalWindowProxyDelegate {
  26  public:
  27   // Called when a captive portal is detected.
  28   virtual void OnPortalDetected() = 0;
  29
  30  protected:
  31   virtual ~CaptivePortalWindowProxyDelegate() {}
  32 };
  33
  34 // Proxy which manages showing of the window for CaptivePortal sign-in.
  35 class CaptivePortalWindowProxy : public views::WidgetObserver {
  36  public:
  37   typedef CaptivePortalWindowProxyDelegate Delegate;
  38
  39   CaptivePortalWindowProxy(Delegate* delegate,
  40                            content::WebContents* web_contents);
  41   virtual ~CaptivePortalWindowProxy();
  42
  43   // Shows captive portal window only after a redirection has happened. So it is
  44   // safe to call this method, when the caller isn't 100% sure that the network
  45   // is in the captive portal state.
  46   // Subsequent call to this method would reuses existing view
  47   // but reloads test page (generate_204).
  48   void ShowIfRedirected();
  49
  50   // Forces captive portal window show.
  51   void Show();
  52
  53   // Closes the window.
  54   void Close();
  55
  56   // Called by CaptivePortalView when URL loading was redirected from the
  57   // original URL.
  58   void OnRedirected();
  59
  60   // Called by CaptivePortalView when origin URL is loaded without any
  61   // redirections.
  62   void OnOriginalURLLoaded();
  63
  64   // Overridden from views::WidgetObserver:
  65   virtual void OnWidgetClosing(views::Widget* widget) OVERRIDE;
  66
  67  private:
  68   friend class CaptivePortalWindowTest;
  69
  70   // Possible transitions between states:
  71   //
  72   // wp(ShowIfRedirected(), WAITING_FOR_REDIRECTION) = IDLE
  73   // wp(Show(), DISPLAYED) = IDLE | WAITING_FOR_REDIRECTION
  74   // wp(Close(), IDLE) = WAITING_FOR_REDIRECTION | DISPLAYED
  75   // wp(OnRedirected(), DISPLAYED) = WAITING_FOR_REDIRECTION
  76   // wp(OnOriginalURLLoaded(), IDLE) = WAITING_FOR_REDIRECTION | DISPLAYED
  77   //
  78   // where wp(E, S) is a weakest precondition (initial state) such
  79   // that after execution of E the system will be surely in the state S.
  80   enum State {
  81     STATE_IDLE = 0,
  82     STATE_WAITING_FOR_REDIRECTION,
  83     STATE_DISPLAYED,
  84     STATE_UNKNOWN
  85   };
  86
  87   // Initializes |captive_portal_view_| if it is not initialized and
  88   // starts loading Captive Portal redirect URL.
  89   void InitCaptivePortalView();
  90
  91   // Returns symbolic state name based on internal state.
  92   State GetState() const;
  93
  94   // Not owned by this class.
  95   Delegate* delegate_;
  96   // Not owned by this class.
  97   views::Widget* widget_;
  98   scoped_ptr<CaptivePortalView> captive_portal_view_;
  99
 100   // Not owned by this class.
 101   content::WebContents* web_contents_;
 102
 103   DISALLOW_COPY_AND_ASSIGN(CaptivePortalWindowProxy);
 104 };
 105
 106 }  // namespace chromeos
 107
 108 #endif  // CHROME_BROWSER_CHROMEOS_LOGIN_CAPTIVE_PORTAL_WINDOW_PROXY_H_