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 CHROMEOS_NETWORK_NETWORK_STATE_H_ 6 #define CHROMEOS_NETWORK_NETWORK_STATE_H_ 7 8 #include <string> 9 #include <vector> 10 11 #include "base/values.h" 12 #include "chromeos/network/managed_state.h" 13 #include "components/onc/onc_constants.h" 14 #include "url/gurl.h" 15 16 namespace base { 17 class DictionaryValue; 18 class Value; 19 } 20 21 namespace chromeos { 22 23 // Simple class to provide network state information about a network service. 24 // This class should always be passed as a const* and should never be held 25 // on to. Store network_state->path() (defined in ManagedState) instead and 26 // call NetworkStateHandler::GetNetworkState(path) to retrieve the state for 27 // the network. 28 // 29 // Note: NetworkStateHandler will store an entry for each member of 30 // Manager.ServiceCompleteList. The visible() method indicates whether the 31 // network is visible, and the IsInProfile() method indicates whether the 32 // network is saved in a profile. 33 class CHROMEOS_EXPORT NetworkState : public ManagedState { 34 public: 35 explicit NetworkState(const std::string& path); 36 virtual ~NetworkState(); 37 38 // ManagedState overrides 39 // If you change this method, update GetProperties too. 40 virtual bool PropertyChanged(const std::string& key, 41 const base::Value& value) OVERRIDE; 42 virtual bool InitialPropertiesReceived( 43 const base::DictionaryValue& properties) OVERRIDE; 44 virtual void GetStateProperties( 45 base::DictionaryValue* dictionary) const OVERRIDE; 46 47 void IPConfigPropertiesChanged(const base::DictionaryValue& properties); 48 49 // Returns true, if the network requires a service activation. 50 bool RequiresActivation() const; 51 52 // Accessors visible()53 bool visible() const { return visible_; } security()54 const std::string& security() const { return security_; } device_path()55 const std::string& device_path() const { return device_path_; } guid()56 const std::string& guid() const { return guid_; } profile_path()57 const std::string& profile_path() const { return profile_path_; } error()58 const std::string& error() const { return error_; } last_error()59 const std::string& last_error() const { return last_error_; } clear_last_error()60 void clear_last_error() { last_error_.clear(); } 61 62 // Returns |connection_state_| if visible, kStateDisconnect otherwise. 63 std::string connection_state() const; 64 proxy_config()65 const base::DictionaryValue& proxy_config() const { return proxy_config_; } 66 67 // IPConfig Properties. These require an extra call to ShillIPConfigClient, 68 // so cache them to avoid excessively complex client code. ip_address()69 const std::string& ip_address() const { return ip_address_; } gateway()70 const std::string& gateway() const { return gateway_; } dns_servers()71 const std::vector<std::string>& dns_servers() const { return dns_servers_; } web_proxy_auto_discovery_url()72 const GURL& web_proxy_auto_discovery_url() const { 73 return web_proxy_auto_discovery_url_; 74 } 75 76 // Wireless property accessors connectable()77 bool connectable() const { return connectable_; } signal_strength()78 int signal_strength() const { return signal_strength_; } 79 80 // Wifi property accessors eap_method()81 const std::string& eap_method() const { return eap_method_; } 82 83 // Cellular property accessors network_technology()84 const std::string& network_technology() const { 85 return network_technology_; 86 } activation_type()87 const std::string& activation_type() const { return activation_type_; } activation_state()88 const std::string& activation_state() const { return activation_state_; } roaming()89 const std::string& roaming() const { return roaming_; } payment_url()90 const std::string& payment_url() const { return payment_url_; } cellular_out_of_credits()91 bool cellular_out_of_credits() const { return cellular_out_of_credits_; } 92 93 // Whether this network has a CACertNSS nickname set. HasCACertNSS()94 bool HasCACertNSS() const { return has_ca_cert_nss_; } 95 96 // Returns true if |connection_state_| is a connected/connecting state. 97 bool IsConnectedState() const; 98 bool IsConnectingState() const; 99 100 // Returns true if this is a network stored in a profile. 101 bool IsInProfile() const; 102 103 // Returns true if the network properties are stored in a user profile. 104 bool IsPrivate() const; 105 106 // Returns a comma separated string of name servers. 107 std::string GetDnsServersAsString() const; 108 109 // Converts the prefix length to a netmask string. 110 std::string GetNetmask() const; 111 112 // Returns a specifier for identifying this network in the absence of a GUID. 113 // This should only be used by NetworkStateHandler for keeping track of 114 // GUIDs assigned to unsaved networks. 115 std::string GetSpecifier() const; 116 117 // Set the GUID. Called exclusively by NetworkStateHandler. 118 void SetGuid(const std::string& guid); 119 120 // Helpers (used e.g. when a state or error is cached) 121 static bool StateIsConnected(const std::string& connection_state); 122 static bool StateIsConnecting(const std::string& connection_state); 123 static bool ErrorIsValid(const std::string& error); 124 125 private: 126 friend class MobileActivatorTest; 127 friend class NetworkStateHandler; 128 friend class NetworkChangeNotifierChromeosUpdateTest; 129 130 // Updates |name_| from WiFi.HexSSID if provided, and validates |name_|. 131 // Returns true if |name_| changes. 132 bool UpdateName(const base::DictionaryValue& properties); 133 134 // Set to true if the network is a member of Manager.Services. 135 bool visible_; 136 137 // Network Service properties. Avoid adding any additional properties here. 138 // Instead use NetworkConfigurationHandler::GetProperties() to asynchronously 139 // request properties from Shill. 140 std::string security_; 141 std::string eap_method_; // Needed for WiFi EAP networks 142 std::string device_path_; 143 std::string guid_; 144 std::string connection_state_; 145 std::string profile_path_; 146 bool connectable_; 147 148 // Reflects the current Shill Service.Error property. This might get cleared 149 // by Shill shortly after a failure. 150 std::string error_; 151 152 // Last non empty Service.Error property. Cleared by NetworkConnectionHandler 153 // when a connection attempt is initiated. 154 std::string last_error_; 155 156 // IPConfig properties. 157 // Note: These do not correspond to actual Shill.Service properties 158 // but are derived from the service's corresponding IPConfig object. 159 std::string ip_address_; 160 std::string gateway_; 161 std::vector<std::string> dns_servers_; 162 int prefix_length_; // Used by GetNetmask() 163 GURL web_proxy_auto_discovery_url_; 164 165 // Wireless properties, used for icons and Connect logic. 166 int signal_strength_; 167 168 // Cellular properties, used for icons, Connect, and Activation. 169 std::string network_technology_; 170 std::string activation_type_; 171 std::string activation_state_; 172 std::string roaming_; 173 std::string payment_url_; 174 bool cellular_out_of_credits_; 175 176 // Whether a deprecated CaCertNSS property of this network is set. Required 177 // for migration to PEM. 178 bool has_ca_cert_nss_; 179 180 // TODO(pneubeck): Remove this once (Managed)NetworkConfigurationHandler 181 // provides proxy configuration. crbug.com/241775 182 base::DictionaryValue proxy_config_; 183 184 DISALLOW_COPY_AND_ASSIGN(NetworkState); 185 }; 186 187 } // namespace chromeos 188 189 #endif // CHROMEOS_NETWORK_NETWORK_STATE_H_ 190