network_state.h revision 116680a4aac90f2aa7413d9095a592090648e557 
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
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.
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.
33class 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
53  bool visible() const { return visible_; }
54  const std::string& security() const { return security_; }
55  const std::string& device_path() const { return device_path_; }
56  const std::string& guid() const { return guid_; }
57  const std::string& profile_path() const { return profile_path_; }
58  const std::string& error() const { return error_; }
59  const std::string& last_error() const { return 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
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.
69  const std::string& ip_address() const { return ip_address_; }
70  const std::string& gateway() const { return gateway_; }
71  const std::vector<std::string>& dns_servers() const { return dns_servers_; }
72  const GURL& web_proxy_auto_discovery_url() const {
73    return web_proxy_auto_discovery_url_;
74  }
75
76  // Wireless property accessors
77  bool connectable() const { return connectable_; }
78  int signal_strength() const { return signal_strength_; }
79
80  // Wifi property accessors
81  const std::string& eap_method() const { return eap_method_; }
82
83  // Cellular property accessors
84  const std::string& network_technology() const {
85    return network_technology_;
86  }
87  const std::string& activation_state() const { return activation_state_; }
88  const std::string& roaming() const { return roaming_; }
89  bool activate_over_non_cellular_networks() const {
90    return activate_over_non_cellular_networks_;
91  }
92  bool cellular_out_of_credits() const { return cellular_out_of_credits_; }
93
94  // Whether this network has a CACertNSS nickname set.
95  bool HasCACertNSS() const { return has_ca_cert_nss_; }
96
97  // Returns true if |connection_state_| is a connected/connecting state.
98  bool IsConnectedState() const;
99  bool IsConnectingState() const;
100
101  // Returns true if this is a network stored in a profile.
102  bool IsInProfile() const;
103
104  // Returns true if the network properties are stored in a user profile.
105  bool IsPrivate() const;
106
107  // Returns a comma separated string of name servers.
108  std::string GetDnsServersAsString() const;
109
110  // Converts the prefix length to a netmask string.
111  std::string GetNetmask() const;
112
113  // Returns a specifier for identifying this network in the absence of a GUID.
114  // This should only be used by NetworkStateHandler for keeping track of
115  // GUIDs assigned to unsaved networks.
116  std::string GetSpecifier() const;
117
118  // Set the GUID. Called exclusively by NetworkStateHandler.
119  void SetGuid(const std::string& guid);
120
121  // Helpers (used e.g. when a state or error is cached)
122  static bool StateIsConnected(const std::string& connection_state);
123  static bool StateIsConnecting(const std::string& connection_state);
124  static bool ErrorIsValid(const std::string& error);
125
126 private:
127  friend class MobileActivatorTest;
128  friend class NetworkStateHandler;
129  friend class NetworkChangeNotifierChromeosUpdateTest;
130
131  // Updates |name_| from WiFi.HexSSID if provided, and validates |name_|.
132  // Returns true if |name_| changes.
133  bool UpdateName(const base::DictionaryValue& properties);
134
135  // Set to true if the network is a member of Manager.Services.
136  bool visible_;
137
138  // Network Service properties. Avoid adding any additional properties here.
139  // Instead use NetworkConfigurationHandler::GetProperties() to asynchronously
140  // request properties from Shill.
141  std::string security_;
142  std::string eap_method_;  // Needed for WiFi EAP networks
143  std::string device_path_;
144  std::string guid_;
145  std::string connection_state_;
146  std::string profile_path_;
147  bool connectable_;
148
149  // Reflects the current Shill Service.Error property. This might get cleared
150  // by Shill shortly after a failure.
151  std::string error_;
152
153  // Last non empty Service.Error property. Cleared by NetworkConnectionHandler
154  // when a connection attempt is initiated.
155  std::string last_error_;
156
157  // IPConfig properties.
158  // Note: These do not correspond to actual Shill.Service properties
159  // but are derived from the service's corresponding IPConfig object.
160  std::string ip_address_;
161  std::string gateway_;
162  std::vector<std::string> dns_servers_;
163  int prefix_length_;  // Used by GetNetmask()
164  GURL web_proxy_auto_discovery_url_;
165
166  // Wireless properties, used for icons and Connect logic.
167  int signal_strength_;
168
169  // Cellular properties, used for icons, Connect, and Activation.
170  std::string network_technology_;
171  std::string activation_state_;
172  std::string roaming_;
173  bool activate_over_non_cellular_networks_;
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