Introduce NetworkState::is_captive_portal()

chromeos/network/network_state.h

 // Copyright (c) 2012 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 CHROMEOS_NETWORK_NETWORK_STATE_H_
 #define CHROMEOS_NETWORK_NETWORK_STATE_H_
 
 #include <stdint.h>
 
 #include <string>
@@ skipping 58 matching lines @@
   // so cache them to avoid excessively complex client code.
   const std::string& ip_address() const { return ip_address_; }
   const std::string& gateway() const { return gateway_; }
   const std::vector<std::string>& dns_servers() const { return dns_servers_; }
   const GURL& web_proxy_auto_discovery_url() const {
     return web_proxy_auto_discovery_url_;
   }
 
   // Wireless property accessors
   bool connectable() const { return connectable_; }
+  bool is_captive_portal() const { return is_captive_portal_; }
   int signal_strength() const { return signal_strength_; }
 
   // Wifi property accessors
   const std::string& eap_method() const { return eap_method_; }
   const std::vector<uint8_t>& raw_ssid() const { return raw_ssid_; }
 
   // Cellular property accessors
   const std::string& network_technology() const {
     return network_technology_;
   }
@@ skipping 20 matching lines @@
   std::string GetNetmask() const;
 
   // Returns a specifier for identifying this network in the absence of a GUID.
   // This should only be used by NetworkStateHandler for keeping track of
   // GUIDs assigned to unsaved networks.
   std::string GetSpecifier() const;
 
   // Set the GUID. Called exclusively by NetworkStateHandler.
   void SetGuid(const std::string& guid);
 
-  // Helpers (used e.g. when a state or error is cached)
+  // Helpers (used e.g. when a state, error, or shill dictionary is cached)
   static bool StateIsConnected(const std::string& connection_state);
   static bool StateIsConnecting(const std::string& connection_state);
+  static bool NetworkStateIsCaptivePortal(
+      const base::DictionaryValue& shill_properties);
   static bool ErrorIsValid(const std::string& error);
 
  private:
   friend class MobileActivatorTest;
   friend class NetworkStateHandler;
   friend class NetworkChangeNotifierChromeosUpdateTest;
 
   // Updates |name_| from WiFi.HexSSID if provided, and validates |name_|.
   // Returns true if |name_| changes.
   bool UpdateName(const base::DictionaryValue& properties);
 
   // Set to true if the network is a member of Manager.Services.
   bool visible_;
 
   // Network Service properties. Avoid adding any additional properties here.
   // Instead use NetworkConfigurationHandler::GetProperties() to asynchronously
   // request properties from Shill.
   std::string security_class_;
   std::string eap_method_;  // Needed for WiFi EAP networks
   std::string device_path_;
   std::string guid_;
   std::string connection_state_;
   std::string profile_path_;
   std::vector<uint8_t> raw_ssid_;  // Unknown encoding. Not necessarily UTF-8.
-  bool connectable_;
 
   // Reflects the current Shill Service.Error property. This might get cleared
   // by Shill shortly after a failure.
   std::string error_;
 
   // Last non empty Service.Error property. Cleared by NetworkConnectionHandler
   // when a connection attempt is initiated.
   std::string last_error_;
 
   // IPConfig properties.
   // Note: These do not correspond to actual Shill.Service properties
   // but are derived from the service's corresponding IPConfig object.
   std::string ip_address_;
   std::string gateway_;
   std::vector<std::string> dns_servers_;
   int prefix_length_;  // Used by GetNetmask()
   GURL web_proxy_auto_discovery_url_;
 
   // Wireless properties, used for icons and Connect logic.
+  bool connectable_;

[pneubeck (no reviews), 2015/01/24 10:06:56]

is this a pure wireless state? i guessed it would be useable for VPN as well
(e.g. !connectable if not connect with any other network)

[stevenjb, 2015/01/26 20:16:30]

Hmm, interesting point. I moved this to match the logic above and in the .cc
file.

service-api.txt doesn't say anything about VPN, and I don't see any indication
that we set this for VPN in the Shill code, so I will move this to the
'Wireless' section for now to match the .cc file.

+  bool is_captive_portal_;
   int signal_strength_;
 
   // Cellular properties, used for icons, Connect, and Activation.
   std::string network_technology_;
   std::string activation_type_;
   std::string activation_state_;
   std::string roaming_;
   std::string payment_url_;
   bool cellular_out_of_credits_;
 
   // TODO(pneubeck): Remove this once (Managed)NetworkConfigurationHandler
   // provides proxy configuration. crbug.com/241775
   base::DictionaryValue proxy_config_;
 
   DISALLOW_COPY_AND_ASSIGN(NetworkState);
 };
 
 }  // namespace chromeos
 
 #endif  // CHROMEOS_NETWORK_NETWORK_STATE_H_