chromeos/network/network_state.h

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