Implement networkingPrivate.getNetworks

chromeos/network/network_state_handler.cc

 // 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.
 
 #include "chromeos/network/network_state_handler.h"
 
 #include "base/bind.h"
 #include "base/format_macros.h"
 #include "base/guid.h"
 #include "base/location.h"
@@ skipping 280 matching lines @@
   for (ManagedStateList::const_iterator iter = device_list_.begin();
        iter != device_list_.end(); ++iter) {
     const DeviceState* device = (*iter)->AsDeviceState();
     DCHECK(device);
     if (device->update_received() && device->Matches(type))
       list->push_back(device);
   }
 }
 
 void NetworkStateHandler::GetFavoriteList(FavoriteStateList* list) const {
-  GetFavoriteListByType(NetworkTypePattern::Default(), list);
+  GetFavoriteListByType(NetworkTypePattern::Default(),
+                        true /* configured_only */,
+                        false /* visible_only */,
+                        list);
 }
 
 void NetworkStateHandler::GetFavoriteListByType(const NetworkTypePattern& type,
+                                                bool configured_only,
+                                                bool visible_only,
                                                 FavoriteStateList* list) const {
   DCHECK(list);
+  std::set<std::string> visible_networks;
+  if (visible_only) {
+    // Prepare a set of visible network service paths for fast lookup.
+    for (ManagedStateList::const_iterator iter = network_list_.begin();

[pneubeck (no reviews), 2014/05/15 18:28:38]

I like this solution if we don't care about best runtime.
Just wanted to mention an alternative:
We could set a pointer to the NetworkState (or only a boolean 'visible') in the
favorite state that we would have to update on creation/destruction of network
states.
Preparing a set wouldn't be required anymore and lookup would be very fast.
Space overhead would be one pointer (or boolean) per FavoriteState only.

This would also make it more clear / ensure that NetworkStates only exist if
there is already a FavoriteState.

[stevenjb, 2014/05/15 20:12:41]

I thought about that, but honestly if performance becomes a concern we would get
a bigger win from maintaining a map of NetworkState and FavoriteState by path
and a map of guid -> path. 

Alternately/additionally we could probably combine NetworkState and
FavoriteState at this point, but... definitely a task for another day.

[pneubeck (no reviews), 2014/05/16 13:18:55]

Yes, totally reasonable.

+         iter != network_list_.end(); ++iter) {
+      visible_networks.insert((*iter)->path());
+    }
+  }
   FavoriteStateList result;
   list->clear();
   for (ManagedStateList::const_iterator iter = favorite_list_.begin();
        iter != favorite_list_.end(); ++iter) {
     const FavoriteState* favorite = (*iter)->AsFavoriteState();
     DCHECK(favorite);
-    if (favorite->update_received() && favorite->IsInProfile() &&
-        favorite->Matches(type)) {
-      list->push_back(favorite);
-    }
+    if (!favorite->update_received() || !favorite->Matches(type))
+      continue;
+    if (configured_only && !favorite->IsInProfile())
+      continue;
+    if (visible_only && !ContainsKey(visible_networks, favorite->path()))
+      continue;
+    list->push_back(favorite);
   }
 }
 
 const FavoriteState* NetworkStateHandler::GetFavoriteStateFromServicePath(
     const std::string& service_path,
     bool configured_only) const {
   ManagedState* managed =
       GetModifiableManagedState(&favorite_list_, service_path);
   if (!managed)
     return NULL;
@@ skipping 84 matching lines @@
         base::StringPrintf("Unknown device %s of connected ethernet service %s",
                            network->device_path().c_str(),
                            service_path.c_str()));
     return NULL;
   }
   if (!device->eap_authentication_completed())
     return NULL;
 
   FavoriteStateList list;
   GetFavoriteListByType(NetworkTypePattern::Primitive(shill::kTypeEthernetEap),
+                        true /* configured_only */,
+                        false /* visible_only */,
                         &list);
   if (list.empty()) {
     NET_LOG_ERROR("GetEAPForEthernet",
                   base::StringPrintf(
                       "Ethernet service %s connected using EAP, but no "
                       "EAP service found.",
                       service_path.c_str()));
     return NULL;
   }
   DCHECK(list.size() == 1);
@@ skipping 500 matching lines @@
   if (type.MatchesType(shill::kTypeBluetooth))
     technologies.push_back(new std::string(shill::kTypeBluetooth));
   if (type.MatchesType(shill::kTypeVPN))
     technologies.push_back(new std::string(shill::kTypeVPN));
 
   CHECK_GT(technologies.size(), 0ul);
   return technologies.Pass();
 }
 
 }  // namespace chromeos