Rely on Service.Visible instead of Manager.Services

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 118 matching lines @@
   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 visible 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;
+  const NetworkState* FirstNetworkByType(const NetworkTypePattern& type);
 
   // 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;
 
   // Convenience method to call GetNetworkListByType(visible=true).
   void GetVisibleNetworkListByType(const NetworkTypePattern& type,
-                                   NetworkStateList* list) const;
+                                   NetworkStateList* list);
 
   // Convenience method for GetVisibleNetworkListByType(Default).
-  void GetVisibleNetworkList(NetworkStateList* list) const;
+  void GetVisibleNetworkList(NetworkStateList* list);
 
   // 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.
   // 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).
+  // later become invalid, but only on the UI thread). SortNetworkList() will be
+  // called if necessary to prove the states in the a convenient order (see

[pneubeck (no reviews), 2014/06/18 09:45:49]

prove? or should it be 'provide'?

'the a' -> 'a'

[stevenjb, 2014/06/18 22:33:26]

Done.

+  // SortNetworkList for details).
   void GetNetworkListByType(const NetworkTypePattern& type,
                             bool configured_only,
                             bool visible_only,
                             int limit,
-                            NetworkStateList* list) const;
+                            NetworkStateList* list);
 
   // 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).
@@ skipping 37 matching lines @@
   void SetCheckPortalList(const std::string& check_portal_list);
 
   const std::string& GetCheckPortalListForTest() const {
     return check_portal_list_;
   }
 
   // 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 NetworkState* GetEAPForEthernet(const std::string& service_path) const;
+  const NetworkState* GetEAPForEthernet(const std::string& service_path);
 
   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 |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 of 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 21 matching lines @@
   // Called by ShillPropertyHandler when the portal check list manager property
   // changes.
   virtual void CheckPortalListChanged(
       const std::string& check_portal_list) OVERRIDE;
 
   // Called by ShillPropertyHandler when a technology list changes.
   virtual void TechnologyListChanged() OVERRIDE;
 
   // Called by |shill_property_handler_| when the service or device list has
   // changed and all entries have been updated. This updates the list and
-  // notifies observers. If |type| == TYPE_NETWORK this also calls
-  // CheckDefaultNetworkChanged().
+  // notifies observers.
   virtual void ManagedStateListChanged(
       ManagedState::ManagedType type) OVERRIDE;
 
   // Called when the default network service changes. Sets default_network_path_
   // and notifies listeners.
   virtual void DefaultNetworkServiceChanged(
       const std::string& service_path) OVERRIDE;
 
   // Called after construction. Called explicitly by tests after adding
   // test observers.
   void InitShillPropertyHandler();
 
  private:
   typedef std::list<base::Closure> ScanCallbackList;
   typedef std::map<std::string, ScanCallbackList> ScanCompleteCallbackMap;
   typedef std::map<std::string, std::string> SpecifierGuidMap;
   friend class NetworkStateHandlerTest;
   FRIEND_TEST_ALL_PREFIXES(NetworkStateHandlerTest, NetworkStateHandlerStub);
 
+  // Sorts the network list. Called when all network updates have been received,
+  // or when the network list is requested but the list is in an unsorted state.
+  // Networks are sorted as follows, maintaining the existing relative ordering:
+  // * Connected or connecting networks (should be listed first by Shill)
+  // * Visible non-wifi networks
+  // * Visible wifi networks
+  // * Hidden (wifi) networks
+  void SortNetworkList();
+
+  // Updates UMA stats. Called once after all requested networks are updated.
+  void UpdateNetworkStats();
+
   // NetworkState specific method for UpdateManagedStateProperties which
   // notifies observers.
   void UpdateNetworkStateProperties(NetworkState* network,
                                     const base::DictionaryValue& properties);
 
   // Ensure a valid GUID for NetworkState.
   void UpdateGuid(NetworkState* network);
 
   // Sends DeviceListChanged() to observers and logs an event.
   void NotifyDeviceListChanged();
@@ skipping 32 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_;
 
+  // Set to true when the network list is sorted, cleared when network updates
+  // arrive. Used to trigger sorting when needed.
+  bool network_list_sorted_;
+
   // 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
   // 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_