Merge FavoriteState into NetworkState

chromeos/network/network_state_handler.h

 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef CHROMEOS_NETWORK_NETWORK_STATE_HANDLER_H_
 #define CHROMEOS_NETWORK_NETWORK_STATE_HANDLER_H_
 
 #include <map>
 #include <set>
 #include <string>
@@ skipping 32 matching lines @@
 //
 // This class maps essential properties from the connection manager (Shill) for
 // each visible network. It is not used to change the properties of services or
 // devices, only global (manager) properties.
 //
 // All getters return the currently cached properties. This class is expected to
 // keep properties up to date by managing the appropriate Shill observers.
 // It will invoke its own more specific observer methods when the specified
 // changes occur.
 //
-// Some notes about NetworkState, FavoriteState, and GUIDs:
-// * A FavoriteState exists for all network services stored in a profile, and
+// Some notes about NetworkState and GUIDs:
+// * A NetworkState exists for all network services stored in a profile, and
 //   all "visible" networks (physically connected networks like ethernet and
 //   cellular or in-range wifi networks). If the network is stored in a profile,
-//   FavoriteState.IsInProfile() will return true.
-// * A NetworkState exists for "visible" networks only. There will always be a
-//   corresponding FavoriteState with the same service_path() property.
+//   NetworkState.IsInProfile() will return true.
+// * "Visible" networks return true for NetworkState.IsVisible().
 // * All networks saved to a profile will have a saved GUID that is persistent
 //   across sessions.
 // * Networks that are not saved to a profile will have a GUID assigned when
 //   the initial properties are received. The GUID will be consistent for
 //   the duration of a session, even if the network drops out and returns.
-// * Both FavoriteState and NetworkState store the GUID. It will always be the
-//   same for the same network (i.e. entries with the same service_path()).
 
 class CHROMEOS_EXPORT NetworkStateHandler
     : public internal::ShillPropertyHandler::Listener {
  public:
   typedef std::vector<ManagedState*> ManagedStateList;
   typedef std::vector<const NetworkState*> NetworkStateList;
   typedef std::vector<const DeviceState*> DeviceStateList;
-  typedef std::vector<const FavoriteState*> FavoriteStateList;
 
   enum TechnologyState {
     TECHNOLOGY_UNAVAILABLE,
     TECHNOLOGY_AVAILABLE,
     TECHNOLOGY_UNINITIALIZED,
     TECHNOLOGY_ENABLING,
     TECHNOLOGY_ENABLED
   };
 
   virtual ~NetworkStateHandler();
 
   // Add/remove observers.
   void AddObserver(NetworkStateHandlerObserver* observer,
                    const tracked_objects::Location& from_here);
   void RemoveObserver(NetworkStateHandlerObserver* observer,
                       const tracked_objects::Location& from_here);
 
   // Requests all Manager properties, specifically to update the complete
-  // list of services which determines the list of Favorites. This should be
+  // list of services which determines the list of Networks. This should be

[pneubeck (no reviews), 2014/06/10 10:51:37]

Isn't this usually unnecessary to call, since we have now Shill signalling
changes of the ServiceCompleteList:
https://chromium-review.googlesource.com/202223 ?

Maybe worth a try to get rid of in a follow up CL.

[stevenjb, 2014/06/10 16:17:28]

It's mostly unused now, but I will do an audit and confirm any necessary usage
and comment.

   // called any time a new service is configured or a Profile is loaded.
   void UpdateManagerProperties();
 
   // Returns the state for technology |type|. Only
   // NetworkTypePattern::Primitive, ::Mobile and ::Ethernet are supported.
   TechnologyState GetTechnologyState(const NetworkTypePattern& type) const;
   bool IsTechnologyAvailable(const NetworkTypePattern& type) const {
     return GetTechnologyState(type) != TECHNOLOGY_UNAVAILABLE;
   }
   bool IsTechnologyEnabled(const NetworkTypePattern& type) const {
@@ skipping 23 matching lines @@
   // value for each property. To receive notifications when a property changes,
   // observe this class and implement NetworkPropertyChanged().
   const NetworkState* GetNetworkState(const std::string& service_path) const;
 
   // Returns the default network (which includes VPNs) based on the Shill
   // Manager.DefaultNetwork property. Normally this is the same as
   // ConnectedNetworkByType(NetworkTypePattern::Default()), but the timing might
   // differ.
   const NetworkState* DefaultNetwork() const;
 
-  // Returns the FavoriteState associated to DefaultNetwork. Returns NULL if,
-  // and only if, DefaultNetwork returns NULL.
-  const FavoriteState* DefaultFavoriteNetwork() const;
-
   // Returns the primary connected network of matching |type|, otherwise NULL.
   const NetworkState* ConnectedNetworkByType(
       const NetworkTypePattern& type) const;
 
   // Like ConnectedNetworkByType() but returns a connecting network or NULL.
   const NetworkState* ConnectingNetworkByType(
       const NetworkTypePattern& type) const;
 
   // Like ConnectedNetworkByType() but returns any matching network or NULL.
   // Mostly useful for mobile networks where there is generally only one
   // network. Note: O(N).
   const NetworkState* FirstNetworkByType(const NetworkTypePattern& type) const;
 
   // Returns the aa:bb formatted hardware (MAC) address for the first connected
   // network matching |type|, or an empty string if none is connected.
   std::string FormattedHardwareAddressForType(
       const NetworkTypePattern& type) const;
 
-  // Sets |list| to contain the list of networks.  The returned list contains
-  // a copy of NetworkState pointers which should not be stored or used beyond
-  // the scope of the calling function (i.e. they may later become invalid, but
-  // only on the UI thread).
-  void GetNetworkList(NetworkStateList* list) const;
+  // Sets |list| to contain the list of visible networks matching |type|. The

[pneubeck (no reviews), 2014/06/10 10:51:37]

both functions GetVisibleNetworkList* should be explained by referring to
GetNetworkListByType.
That function should have a/the detailed comment.

[stevenjb, 2014/06/10 16:17:28]

Will do.

+  // returned list contains a copy of NetworkState pointers which should not be
+  // stored or used beyond the scope of the calling function (i.e. they may
+  // later become invalid, but only on the UI thread).
+  void GetVisibleNetworkListByType(const NetworkTypePattern& type,
+                                   NetworkStateList* list) const;
 
-  // Like GetNetworkList() but only returns networks with matching |type|.
+  // Convenience method for GetVisibleNetworkListByType(All).
+  void GetVisibleNetworkList(NetworkStateList* list) const;
+
+  // Sets |list| to contain the list of networks with matching |type| and the
+  // following properties:
+  // |configured_only| - if true only include networks where IsInProfile is true
+  // |visible_only| - if true only include networks in the visible Services list
+  // |limit| - if > 0 limits the number of results.
   void GetNetworkListByType(const NetworkTypePattern& type,
+                            bool configured_only,
+                            bool visible_only,
+                            int limit,
                             NetworkStateList* list) const;
 
+  // Finds and returns the NetworkState associated with |service_path| or NULL
+  // if not found. If |configured_only| is true, only returns saved entries
+  // (IsInProfile is true).
+  const NetworkState* GetNetworkStateFromServicePath(
+      const std::string& service_path,
+      bool configured_only) const;
+
+  // Finds and returns the NetworkState associated with |guid| or NULL if not
+  // found. This returns all entries (IsInProfile() may be true or false).
+  const NetworkState* GetNetworkStateFromGuid(const std::string& guid) const;
+
   // Sets |list| to contain the list of devices.  The returned list contains
   // a copy of DeviceState pointers which should not be stored or used beyond
   // the scope of the calling function (i.e. they may later become invalid, but
   // only on the UI thread).
   void GetDeviceList(DeviceStateList* list) const;
 
   // Like GetDeviceList() but only returns networks with matching |type|.
   void GetDeviceListByType(const NetworkTypePattern& type,
                            DeviceStateList* list) const;
 
-  // Sets |list| to contain the list of favorite (aka "preferred") networks.
-  // See GetNetworkList() for usage, and notes for |favorite_list_|.
-  // Favorites that are visible have the same path() as the entries in
-  // GetNetworkList(), so GetNetworkState() can be used to determine if a
-  // favorite is visible and retrieve the complete properties (and vice-versa).
-  void GetFavoriteList(FavoriteStateList* list) const;
-
-  // Like GetFavoriteList() but only returns favorites with matching |type| and
-  // the following properties:
-  // |configured_only| - if true only include networks where IsInProfile is true
-  // |visible_only| - if true only include networks in the visible Services list
-  // |limit| - if > 0 limits the number of results.
-  void GetFavoriteListByType(const NetworkTypePattern& type,
-                             bool configured_only,
-                             bool visible_only,
-                             int limit,
-                             FavoriteStateList* list) const;
-
-  // Finds and returns the FavoriteState associated with |service_path| or NULL
-  // if not found. If |configured_only| is true, only returns saved entries
-  // (IsInProfile is true).
-  const FavoriteState* GetFavoriteStateFromServicePath(
-      const std::string& service_path,
-      bool configured_only) const;
-
-  // Finds and returns the FavoriteState associated with |guid| or NULL if not
-  // found. This returns all entries (IsInProfile() may be true or false).
-  const FavoriteState* GetFavoriteStateFromGuid(const std::string& guid) const;
-
   // Requests a network scan. This may trigger updates to the network
   // list, which will trigger the appropriate observer calls.
   void RequestScan() const;
 
   // Request a scan if not scanning and run |callback| when the Scanning state
   // for any Device of network type |type| completes.
   void WaitForScan(const std::string& type, const base::Closure& callback);
 
   // Request a network scan then signal Shill to connect to the best available
   // networks when completed.
@@ skipping 11 matching lines @@
   // Clear the last_error value for the NetworkState for |service_path|.
   void ClearLastErrorForNetwork(const std::string& service_path);
 
   // Set the list of devices on which portal check is enabled.
   void SetCheckPortalList(const std::string& check_portal_list);
 
   const std::string& GetCheckPortalListForTest() const {
     return check_portal_list_;
   }
 
-  // Returns the FavoriteState of the EthernetEAP service, which contains the
+  // Returns the NetworkState of the EthernetEAP service, which contains the
   // EAP parameters used by the ethernet with |service_path|. If |service_path|
   // doesn't refer to an ethernet service or if the ethernet service is not
   // connected using EAP, returns NULL.
-  const FavoriteState* GetEAPForEthernet(const std::string& service_path) const;
+  const NetworkState* GetEAPForEthernet(const std::string& service_path) const;
 
   const std::string& default_network_path() const {
     return default_network_path_;
   }
 
   // Construct and initialize an instance for testing.
   static NetworkStateHandler* InitializeForTest();
 
   // Default set of comma separated interfaces on which to enable
   // portal checking.
   static const char kDefaultCheckPortalList[];
 
  protected:
   friend class NetworkHandler;
   NetworkStateHandler();
 
   // ShillPropertyHandler::Listener overrides.
 
-  // This adds new entries to the managed list specified by |type| and deletes
-  // any entries that are no longer in the list.
+  // This adds new entries to |network_list_| or |device_list_| and deletes any
+  // entries that are no longer in the list.
   virtual void UpdateManagedList(ManagedState::ManagedType type,
                                  const base::ListValue& entries) OVERRIDE;
 
+  // Updates the visibility if entries in |network_list_|. This should not
+  // contain entries that are not in |network_list_|. Any such entries will be
+  // ignored with an error message.
+  virtual void UpdateVisibleNetworks(const base::ListValue& entries) OVERRIDE;
+
   // The list of profiles changed (i.e. a user has logged in). Re-request
   // properties for all services since they may have changed.
   virtual void ProfileListChanged() OVERRIDE;
 
   // Parses the properties for the network service or device. Mostly calls
   // managed->PropertyChanged(key, value) for each dictionary entry.
   virtual void UpdateManagedStateProperties(
       ManagedState::ManagedType type,
       const std::string& path,
       const base::DictionaryValue& properties) OVERRIDE;
@@ skipping 47 matching lines @@
   typedef std::map<std::string, ScanCallbackList> ScanCompleteCallbackMap;
   typedef std::map<std::string, std::string> SpecifierGuidMap;
   friend class NetworkStateHandlerTest;
   FRIEND_TEST_ALL_PREFIXES(NetworkStateHandlerTest, NetworkStateHandlerStub);
 
   // NetworkState specific method for UpdateManagedStateProperties which
   // notifies observers.
   void UpdateNetworkStateProperties(NetworkState* network,
                                     const base::DictionaryValue& properties);
 
-  // Ensure a valid GUID for FavoriteState and update the NetworkState GUID from
-  // the corresponding FavoriteState if necessary.
-  void UpdateGuid(ManagedState* managed);
+  // Ensure a valid GUID for NetworkState.
+  void UpdateGuid(NetworkState* network);
 
   // Sends DeviceListChanged() to observers and logs an event.
   void NotifyDeviceListChanged();
 
   // Non-const getters for managed entries. These are const so that they can
   // be called by Get[Network|Device]State, even though they return non-const
   // pointers.
   DeviceState* GetModifiableDeviceState(const std::string& device_path) const;
   NetworkState* GetModifiableNetworkState(
       const std::string& service_path) const;
-  FavoriteState* GetModifiableFavoriteState(
-      const std::string& service_path) const;
   ManagedState* GetModifiableManagedState(const ManagedStateList* managed_list,
                                           const std::string& path) const;
 
   // Gets the list specified by |type|.
   ManagedStateList* GetManagedList(ManagedState::ManagedType type);
 
   // Helper function to notify observers. Calls CheckDefaultNetworkChanged().
   void OnNetworkConnectionStateChanged(NetworkState* network);
 
   // Notifies observers when the default network or its properties change.
@@ skipping 15 matching lines @@
 
   // Shill property handler instance, owned by this class.
   scoped_ptr<internal::ShillPropertyHandler> shill_property_handler_;
 
   // Observer list
   ObserverList<NetworkStateHandlerObserver> observers_;
 
   // List of managed network states
   ManagedStateList network_list_;
 
-  // List of managed favorite states; this list includes all entries in
-  // Manager.ServiceCompleteList, but only entries with a non-empty Profile
-  // property are returned in GetFavoriteList().
-  ManagedStateList favorite_list_;
-
   // List of managed device states
   ManagedStateList device_list_;
 
   // Keeps track of the default network for notifying observers when it changes.
   std::string default_network_path_;
 
   // List of interfaces on which portal check is enabled.
   std::string check_portal_list_;
 
   // Callbacks to run when a scan for the technology type completes.
   ScanCompleteCallbackMap scan_complete_callbacks_;
 
   // Map of network specifiers to guids. Contains an entry for each
-  // FavoriteState that is not saved in a profile.
+  // NetworkState that is not saved in a profile.
   SpecifierGuidMap specifier_guid_map_;
 
   DISALLOW_COPY_AND_ASSIGN(NetworkStateHandler);
 };
 
 }  // namespace chromeos
 
 #endif  // CHROMEOS_NETWORK_NETWORK_STATE_HANDLER_H_