| // Copyright (c) 2013 The Chromium Authors. All rights reserved. |
| // Use of this source code is governed by a BSD-style license that can be |
| // found in the LICENSE file. |
| |
| #ifndef CHROME_BROWSER_CHROMEOS_NET_NETWORK_PORTAL_DETECTOR_H_ |
| #define CHROME_BROWSER_CHROMEOS_NET_NETWORK_PORTAL_DETECTOR_H_ |
| |
| #include "base/basictypes.h" |
| #include "net/url_request/url_fetcher.h" |
| |
| namespace chromeos { |
| |
| class NetworkState; |
| |
| // This class handles all notifications about network changes from |
| // NetworkStateHandler and delegates portal detection for the active |
| // network to CaptivePortalService. |
| class NetworkPortalDetector { |
| public: |
| enum CaptivePortalStatus { |
| CAPTIVE_PORTAL_STATUS_UNKNOWN = 0, |
| CAPTIVE_PORTAL_STATUS_OFFLINE = 1, |
| CAPTIVE_PORTAL_STATUS_ONLINE = 2, |
| CAPTIVE_PORTAL_STATUS_PORTAL = 3, |
| CAPTIVE_PORTAL_STATUS_PROXY_AUTH_REQUIRED = 4, |
| CAPTIVE_PORTAL_STATUS_COUNT |
| }; |
| |
| struct CaptivePortalState { |
| CaptivePortalState() |
| : status(CAPTIVE_PORTAL_STATUS_UNKNOWN), |
| response_code(net::URLFetcher::RESPONSE_CODE_INVALID) { |
| } |
| |
| bool operator==(const CaptivePortalState& o) const { |
| return status == o.status && response_code == o.response_code; |
| } |
| |
| CaptivePortalStatus status; |
| int response_code; |
| }; |
| |
| class Observer { |
| public: |
| // Called when portal detection is completed for |network|, or |
| // when observers add themselves via AddAndFireObserver(). In the |
| // second case, |network| is the active network and |state| is a |
| // current portal state for the active network, which can be |
| // currently in the unknown state, for instance, if portal |
| // detection is in process for the active network. Note, that |
| // |network| may be NULL. |
| virtual void OnPortalDetectionCompleted( |
| const NetworkState* network, |
| const CaptivePortalState& state) = 0; |
| |
| protected: |
| virtual ~Observer() {} |
| }; |
| |
| // Adds |observer| to the observers list. |
| virtual void AddObserver(Observer* observer) = 0; |
| |
| // Adds |observer| to the observers list and immediately calls |
| // OnPortalDetectionCompleted() with the active network (which may |
| // be NULL) and captive portal state for the active network (which |
| // may be unknown, if, for instance, portal detection is in process |
| // for the active network). |
| // |
| // WARNING: don't call this method from the Observer's ctors or |
| // dtors, as it implicitly calls OnPortalDetectionCompleted(), which |
| // is virtual. |
| // TODO (ygorshenin@): find a way to avoid this restriction. |
| virtual void AddAndFireObserver(Observer* observer) = 0; |
| |
| // Removes |observer| from the observers list. |
| virtual void RemoveObserver(Observer* observer) = 0; |
| |
| // Returns Captive Portal state for a given |network|. |
| virtual CaptivePortalState GetCaptivePortalState( |
| const chromeos::NetworkState* network) = 0; |
| |
| // Returns true if portal detection is enabled. |
| virtual bool IsEnabled() = 0; |
| |
| // Enable portal detection. This method is needed because we can't |
| // check current network for portal state unless user accepts EULA. |
| // If |start_detection| is true and NetworkPortalDetector was |
| // disabled previously, portal detection for the active network is |
| // initiated by this method. |
| virtual void Enable(bool start_detection) = 0; |
| |
| // Restarts portal detection for the default network if currently in |
| // the idle state. Returns true if new portal detection attempt was |
| // started. |
| virtual bool StartDetectionIfIdle() = 0; |
| |
| // Enables lazy detection mode. In this mode portal detection after |
| // first 3 consecutive attemps will be performed once in 5 seconds. |
| virtual void EnableLazyDetection() = 0; |
| |
| // Dizables lazy detection mode. |
| virtual void DisableLazyDetection() = 0; |
| |
| // Initializes network portal detector for testing. The |
| // |network_portal_detector| will be owned by the internal pointer |
| // and deleted by Shutdown(). |
| static void InitializeForTesting( |
| NetworkPortalDetector* network_portal_detector); |
| |
| // Creates an instance of the NetworkPortalDetector. |
| static void Initialize(); |
| |
| // Deletes the instance of the NetworkPortalDetector. |
| static void Shutdown(); |
| |
| // Gets the instance of the NetworkPortalDetector. |
| static NetworkPortalDetector* Get(); |
| |
| protected: |
| NetworkPortalDetector() {} |
| virtual ~NetworkPortalDetector() {} |
| |
| private: |
| DISALLOW_COPY_AND_ASSIGN(NetworkPortalDetector); |
| }; |
| |
| } // namespace chromeos |
| |
| #endif // CHROME_BROWSER_CHROMEOS_NET_NETWORK_PORTAL_DETECTOR_H_ |