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.
5 #ifndef CHROME_BROWSER_CHROMEOS_LOGIN_CAPTIVE_PORTAL_WINDOW_PROXY_H_
6 #define CHROME_BROWSER_CHROMEOS_LOGIN_CAPTIVE_PORTAL_WINDOW_PROXY_H_
8 #include "base/compiler_specific.h"
9 #include "base/memory/scoped_ptr.h"
10 #include "ui/views/widget/widget_observer.h"
22 class CaptivePortalView;
24 // Delegate interface for CaptivePortalWindowProxy.
25 class CaptivePortalWindowProxyDelegate {
27 // Called when a captive portal is detected.
28 virtual void OnPortalDetected() = 0;
31 virtual ~CaptivePortalWindowProxyDelegate() {}
34 // Proxy which manages showing of the window for CaptivePortal sign-in.
35 class CaptivePortalWindowProxy : public views::WidgetObserver {
37 typedef CaptivePortalWindowProxyDelegate Delegate;
39 CaptivePortalWindowProxy(Delegate* delegate,
40 content::WebContents* web_contents);
41 virtual ~CaptivePortalWindowProxy();
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();
50 // Forces captive portal window show.
56 // Called by CaptivePortalView when URL loading was redirected from the
60 // Called by CaptivePortalView when origin URL is loaded without any
62 void OnOriginalURLLoaded();
64 // Overridden from views::WidgetObserver:
65 virtual void OnWidgetClosing(views::Widget* widget) OVERRIDE;
66 virtual void OnWidgetDestroying(views::Widget* widget) OVERRIDE;
67 virtual void OnWidgetDestroyed(views::Widget* widget) OVERRIDE;
70 friend class CaptivePortalWindowTest;
72 // Possible transitions between states:
74 // wp(ShowIfRedirected(), WAITING_FOR_REDIRECTION) = IDLE
75 // wp(Show(), DISPLAYED) = IDLE | WAITING_FOR_REDIRECTION
76 // wp(Close(), IDLE) = WAITING_FOR_REDIRECTION | DISPLAYED
77 // wp(OnRedirected(), DISPLAYED) = WAITING_FOR_REDIRECTION
78 // wp(OnOriginalURLLoaded(), IDLE) = WAITING_FOR_REDIRECTION | DISPLAYED
80 // where wp(E, S) is a weakest precondition (initial state) such
81 // that after execution of E the system will be surely in the state S.
84 STATE_WAITING_FOR_REDIRECTION,
89 // Initializes |captive_portal_view_| if it is not initialized and
90 // starts loading Captive Portal redirect URL.
91 void InitCaptivePortalView();
93 // Returns symbolic state name based on internal state.
94 State GetState() const;
96 // When |widget| is not NULL and the same as |widget_| stops to observe
97 // notifications from |widget_| and resets it.
98 void DetachFromWidget(views::Widget* widget);
100 // Not owned by this class.
102 // Not owned by this class.
103 views::Widget* widget_;
104 scoped_ptr<CaptivePortalView> captive_portal_view_;
106 // Not owned by this class.
107 content::WebContents* web_contents_;
109 DISALLOW_COPY_AND_ASSIGN(CaptivePortalWindowProxy);
112 } // namespace chromeos
114 #endif // CHROME_BROWSER_CHROMEOS_LOGIN_CAPTIVE_PORTAL_WINDOW_PROXY_H_