network_state.h revision a1401311d1ab56c4ed0a474bd38c108f75cb0cd9 
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
16namespace base {
17class DictionaryValue;
18class Value;
19}
20
21namespace 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.
28class 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  const std::string& last_error() const { return last_error_; }
57  void clear_last_error() { last_error_.clear(); }
58  bool connectable() const { return connectable_; }
59
60  const NetworkUIData& ui_data() const { return ui_data_; }
61
62  // IPConfig Properties. These require an extra call to ShillIPConfigClient,
63  // so cache them to avoid excessively complex client code.
64  const std::string& ip_address() const { return ip_address_; }
65  const std::string& gateway() const { return gateway_; }
66  const std::vector<std::string>& dns_servers() const { return dns_servers_; }
67  const GURL& web_proxy_auto_discovery_url() const {
68    return web_proxy_auto_discovery_url_;
69  }
70
71  // Wireless property accessors
72  int signal_strength() const { return signal_strength_; }
73
74  // Cellular property accessors
75  const std::string& network_technology() const {
76    return network_technology_;
77  }
78  const std::string& activation_state() const { return activation_state_; }
79  const std::string& roaming() const { return roaming_; }
80  bool activate_over_non_cellular_networks() const {
81    return activate_over_non_cellular_networks_;
82  }
83  bool cellular_out_of_credits() const { return cellular_out_of_credits_; }
84
85  // Whether this network has a CACertNSS nickname set.
86  bool HasCACertNSS() const { return has_ca_cert_nss_; }
87
88  // Returns true if |connection_state_| is a connected/connecting state.
89  bool IsConnectedState() const;
90  bool IsConnectingState() const;
91
92  // Returns true if the network properties are stored in a user profile.
93  bool IsPrivate() const;
94
95  // Returns a comma separated string of name servers.
96  std::string GetDnsServersAsString() const;
97
98  // Converts the prefix length to a netmask string.
99  std::string GetNetmask() const;
100
101  // Helpers (used e.g. when a state is cached)
102  static bool StateIsConnected(const std::string& connection_state);
103  static bool StateIsConnecting(const std::string& connection_state);
104
105  // Helper to return a full prefixed version of an IPConfig property key.
106  static std::string IPConfigProperty(const char* key);
107
108
109 private:
110  friend class MobileActivatorTest;
111  friend class NetworkStateHandler;
112  friend class NetworkChangeNotifierChromeosUpdateTest;
113
114  // Updates |name_| from WiFi.HexSSID if provided, and validates |name_|.
115  // Returns true if |name_| changes.
116  bool UpdateName(const base::DictionaryValue& properties);
117
118  // Network Service properties. Avoid adding any additional properties here.
119  // Instead use NetworkConfigurationHandler::GetProperties() to asynchronously
120  // request properties from Shill.
121  std::string security_;
122  std::string eap_method_;  // Needed for WiFi EAP networks
123  std::string device_path_;
124  std::string guid_;
125  std::string connection_state_;
126  std::string profile_path_;
127  bool connectable_;
128
129  // Reflects the current Shill Service.Error property. This might get cleared
130  // by Shill shortly after a failure.
131  std::string error_;
132
133  // Last non empty Service.Error property. Cleared by NetworkConnectionHandler
134  // when a connection attempt is initiated.
135  std::string last_error_;
136
137  // This is convenient to keep cached for now, but shouldn't be necessary;
138  // avoid using it if possible.
139  NetworkUIData ui_data_;
140
141  // IPConfig properties.
142  // Note: These do not correspond to actual Shill.Service properties
143  // but are derived from the service's corresponding IPConfig object.
144  std::string ip_address_;
145  std::string gateway_;
146  std::vector<std::string> dns_servers_;
147  int prefix_length_;  // Used by GetNetmask()
148  GURL web_proxy_auto_discovery_url_;
149
150  // Wireless properties, used for icons and Connect logic.
151  int signal_strength_;
152
153  // Cellular properties, used for icons, Connect, and Activation.
154  std::string network_technology_;
155  std::string activation_state_;
156  std::string roaming_;
157  bool activate_over_non_cellular_networks_;
158  bool cellular_out_of_credits_;
159
160  // Whether a deprecated CaCertNSS property of this network is set. Required
161  // for migration to PEM.
162  bool has_ca_cert_nss_;
163
164  DISALLOW_COPY_AND_ASSIGN(NetworkState);
165};
166
167}  // namespace chromeos
168
169#endif  // CHROMEOS_NETWORK_NETWORK_STATE_H_
170