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 "chromeos/network/managed_state.h" 12 #include "chromeos/network/network_ui_data.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 class CHROMEOS_EXPORT NetworkState : public ManagedState { 29 public: 30 explicit NetworkState(const std::string& path); 31 virtual ~NetworkState(); 32 33 // ManagedState overrides 34 // If you change this method, update GetProperties too. 35 virtual bool PropertyChanged(const std::string& key, 36 const base::Value& value) OVERRIDE; 37 virtual bool InitialPropertiesReceived( 38 const base::DictionaryValue& properties) OVERRIDE; 39 40 // Fills |dictionary| with the state properties. All the properties that are 41 // accepted by PropertyChanged are stored in |dictionary|, no other values are 42 // stored. 43 void GetProperties(base::DictionaryValue* dictionary) const; 44 45 // Returns true, if the network requires a service activation. 46 bool RequiresActivation() const; 47 48 // Accessors 49 const std::string& security() const { return security_; } 50 const std::string& eap_method() const { return eap_method_; } 51 const std::string& device_path() const { return device_path_; } 52 const std::string& guid() const { return guid_; } 53 const std::string& connection_state() const { return connection_state_; } 54 const std::string& profile_path() const { return profile_path_; } 55 const std::string& error() const { return error_; } 56 bool connectable() const { return connectable_; } 57 58 const NetworkUIData& ui_data() const { return ui_data_; } 59 60 // IPConfig Properties. These require an extra call to ShillIPConfigClient, 61 // so cache them to avoid excessively complex client code. 62 const std::string& ip_address() const { return ip_address_; } 63 const std::string& gateway() const { return gateway_; } 64 const std::vector<std::string>& dns_servers() const { return dns_servers_; } 65 const GURL& web_proxy_auto_discovery_url() const { 66 return web_proxy_auto_discovery_url_; 67 } 68 69 // Wireless property accessors 70 int signal_strength() const { return signal_strength_; } 71 72 // Cellular property accessors 73 const std::string& network_technology() const { 74 return network_technology_; 75 } 76 const std::string& activation_state() const { return activation_state_; } 77 const std::string& roaming() const { return roaming_; } 78 bool activate_over_non_cellular_networks() const { 79 return activate_over_non_cellular_networks_; 80 } 81 bool cellular_out_of_credits() const { return cellular_out_of_credits_; } 82 83 // Whether this network has a CACertNSS nickname set. 84 bool HasCACertNSS() const { return has_ca_cert_nss_; } 85 86 // Returns true if |connection_state_| is a connected/connecting state. 87 bool IsConnectedState() const; 88 bool IsConnectingState() const; 89 90 // Returns true if the network properties are stored in a user profile. 91 bool IsPrivate() const; 92 93 // Returns a comma separated string of name servers. 94 std::string GetDnsServersAsString() const; 95 96 // Converts the prefix length to a netmask string. 97 std::string GetNetmask() const; 98 99 // Helpers (used e.g. when a state is cached) 100 static bool StateIsConnected(const std::string& connection_state); 101 static bool StateIsConnecting(const std::string& connection_state); 102 103 // Helper to return a full prefixed version of an IPConfig property key. 104 static std::string IPConfigProperty(const char* key); 105 106 107 private: 108 friend class MobileActivatorTest; 109 friend class NetworkStateHandler; 110 friend class NetworkChangeNotifierChromeosUpdateTest; 111 112 // Updates |name_| from WiFi.HexSSID if provided, and validates |name_|. 113 // Returns true if |name_| changes. 114 bool UpdateName(const base::DictionaryValue& properties); 115 116 // Network Service properties. Avoid adding any additional properties here. 117 // Instead use NetworkConfigurationHandler::GetProperties() to asynchronously 118 // request properties from Shill. 119 std::string security_; 120 std::string eap_method_; // Needed for WiFi EAP networks 121 std::string device_path_; 122 std::string guid_; 123 std::string connection_state_; 124 std::string profile_path_; 125 std::string error_; 126 bool connectable_; 127 128 // This is convenient to keep cached for now, but shouldn't be necessary; 129 // avoid using it if possible. 130 NetworkUIData ui_data_; 131 132 // IPConfig properties. 133 // Note: These do not correspond to actual Shill.Service properties 134 // but are derived from the service's corresponding IPConfig object. 135 std::string ip_address_; 136 std::string gateway_; 137 std::vector<std::string> dns_servers_; 138 int prefix_length_; // Used by GetNetmask() 139 GURL web_proxy_auto_discovery_url_; 140 141 // Wireless properties, used for icons and Connect logic. 142 int signal_strength_; 143 144 // Cellular properties, used for icons, Connect, and Activation. 145 std::string network_technology_; 146 std::string activation_state_; 147 std::string roaming_; 148 bool activate_over_non_cellular_networks_; 149 bool cellular_out_of_credits_; 150 151 // Whether a deprecated CaCertNSS property of this network is set. Required 152 // for migration to PEM. 153 bool has_ca_cert_nss_; 154 155 DISALLOW_COPY_AND_ASSIGN(NetworkState); 156 }; 157 158 } // namespace chromeos 159 160 #endif // CHROMEOS_NETWORK_NETWORK_STATE_H_ 161
