mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 2 | // Use of this source code is governed by a BSD-style license that can be |
| 3 | // found in the LICENSE file. |
| 4 | |
Darin Petkov | 002c58e | 2012-06-19 02:56:05 +0200 | [diff] [blame] | 5 | #ifndef SHILL_MANAGER_H_ |
| 6 | #define SHILL_MANAGER_H_ |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 7 | |
Darin Petkov | a5e07ef | 2012-07-09 14:27:57 +0200 | [diff] [blame] | 8 | #include <map> |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 9 | #include <string> |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 10 | #include <vector> |
Chris Masone | 487b8bf | 2011-05-13 16:27:57 -0700 | [diff] [blame] | 11 | |
Paul Stewart | dfa4605 | 2012-06-26 09:44:14 -0700 | [diff] [blame] | 12 | #include <base/cancelable_callback.h> |
Paul Stewart | e613202 | 2011-08-16 09:11:02 -0700 | [diff] [blame] | 13 | #include <base/file_path.h> |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 14 | #include <base/memory/ref_counted.h> |
Chris Masone | 487b8bf | 2011-05-13 16:27:57 -0700 | [diff] [blame] | 15 | #include <base/memory/scoped_ptr.h> |
Eric Shienbrood | 3e20a23 | 2012-02-16 11:35:56 -0500 | [diff] [blame] | 16 | #include <base/memory/weak_ptr.h> |
Chris Masone | 88cbd5f | 2011-07-03 14:30:04 -0700 | [diff] [blame] | 17 | #include <chromeos/dbus/service_constants.h> |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 18 | #include <gtest/gtest_prod.h> // for FRIEND_TEST |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 19 | |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 20 | #include "shill/device.h" |
Paul Stewart | 0af98bf | 2011-05-10 17:38:08 -0700 | [diff] [blame] | 21 | #include "shill/device_info.h" |
Paul Stewart | 26b327e | 2011-10-19 11:38:09 -0700 | [diff] [blame] | 22 | #include "shill/event_dispatcher.h" |
Gaurav Shah | b790aa2 | 2012-10-23 12:51:12 -0700 | [diff] [blame] | 23 | #include "shill/geolocation_info.h" |
Gary Morain | a9fb325 | 2012-05-31 12:05:31 -0700 | [diff] [blame] | 24 | #include "shill/hook_table.h" |
Arman Uguray | ab22c16 | 2012-10-08 19:08:38 -0700 | [diff] [blame] | 25 | #include "shill/metrics.h" |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 26 | #include "shill/modem_info.h" |
Gary Morain | ac1bdb4 | 2012-02-16 17:42:29 -0800 | [diff] [blame] | 27 | #include "shill/power_manager.h" |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 28 | #include "shill/property_store.h" |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 29 | #include "shill/service.h" |
Darin Petkov | 33af05c | 2012-02-28 10:10:30 +0100 | [diff] [blame] | 30 | #include "shill/vpn_provider.h" |
mukesh agrawal | 7a4e400 | 2011-09-06 11:26:05 -0700 | [diff] [blame] | 31 | #include "shill/wifi.h" |
Darin Petkov | b72b62e | 2012-05-15 16:55:36 +0200 | [diff] [blame] | 32 | #include "shill/wimax_provider.h" |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 33 | |
| 34 | namespace shill { |
| 35 | |
Chris Masone | d0ceb8c | 2011-06-02 10:05:39 -0700 | [diff] [blame] | 36 | class ControlInterface; |
Darin Petkov | 002c58e | 2012-06-19 02:56:05 +0200 | [diff] [blame] | 37 | class DBusManager; |
Paul Stewart | 4d5efb7 | 2012-09-17 12:24:34 -0700 | [diff] [blame] | 38 | class DefaultProfile; |
Chris Masone | 8fe2c7e | 2011-06-09 15:51:19 -0700 | [diff] [blame] | 39 | class Error; |
Chris Masone | d0ceb8c | 2011-06-02 10:05:39 -0700 | [diff] [blame] | 40 | class EventDispatcher; |
Thieu Le | 3426c8f | 2012-01-11 17:35:11 -0800 | [diff] [blame] | 41 | class ManagerAdaptorInterface; |
Paul Stewart | 4d5efb7 | 2012-09-17 12:24:34 -0700 | [diff] [blame] | 42 | class Resolver; |
Chris Masone | d0ceb8c | 2011-06-02 10:05:39 -0700 | [diff] [blame] | 43 | |
Eric Shienbrood | 3e20a23 | 2012-02-16 11:35:56 -0500 | [diff] [blame] | 44 | class Manager : public base::SupportsWeakPtr<Manager> { |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 45 | public: |
Darin Petkov | a5e07ef | 2012-07-09 14:27:57 +0200 | [diff] [blame] | 46 | typedef base::Callback<void(const ServiceRefPtr &service)> ServiceCallback; |
| 47 | |
Chris Masone | 88cbd5f | 2011-07-03 14:30:04 -0700 | [diff] [blame] | 48 | struct Properties { |
| 49 | public: |
Paul Stewart | c681fa0 | 2012-03-02 19:40:04 -0800 | [diff] [blame] | 50 | Properties() |
Paul Stewart | d408fdf | 2012-05-07 17:15:57 -0700 | [diff] [blame] | 51 | : offline_mode(false), |
| 52 | portal_check_interval_seconds(0), |
| 53 | arp_gateway(true) {} |
Chris Masone | 88cbd5f | 2011-07-03 14:30:04 -0700 | [diff] [blame] | 54 | bool offline_mode; |
| 55 | std::string check_portal_list; |
| 56 | std::string country; |
Paul Stewart | c681fa0 | 2012-03-02 19:40:04 -0800 | [diff] [blame] | 57 | int32 portal_check_interval_seconds; |
Chris Masone | 88cbd5f | 2011-07-03 14:30:04 -0700 | [diff] [blame] | 58 | std::string portal_url; |
Paul Stewart | d32f484 | 2012-01-11 16:08:13 -0800 | [diff] [blame] | 59 | std::string host_name; |
Paul Stewart | d408fdf | 2012-05-07 17:15:57 -0700 | [diff] [blame] | 60 | // Whether to ARP for the default gateway in the DHCP client after |
| 61 | // acquiring a lease. |
| 62 | bool arp_gateway; |
Paul Stewart | bf66761 | 2012-06-29 14:49:54 -0700 | [diff] [blame] | 63 | // Comma separated list of technologies on which to use a short DNS |
| 64 | // timeout to improve performance. |
| 65 | std::string short_dns_timeout_technologies; |
Paul Stewart | 036dba0 | 2012-08-07 12:34:41 -0700 | [diff] [blame] | 66 | // Comma-separated list of technologies for which link-monitoring is |
| 67 | // enabled. |
| 68 | std::string link_monitor_technologies; |
Paul Stewart | 4d5efb7 | 2012-09-17 12:24:34 -0700 | [diff] [blame] | 69 | // Comma-separated list of DNS search paths to be ignored. |
| 70 | std::string ignored_dns_search_paths; |
Chris Masone | 88cbd5f | 2011-07-03 14:30:04 -0700 | [diff] [blame] | 71 | }; |
| 72 | |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 73 | Manager(ControlInterface *control_interface, |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 74 | EventDispatcher *dispatcher, |
Thieu Le | 3426c8f | 2012-01-11 17:35:11 -0800 | [diff] [blame] | 75 | Metrics *metrics, |
Chris Masone | 2ae797d | 2011-08-23 20:41:00 -0700 | [diff] [blame] | 76 | GLib *glib, |
| 77 | const std::string &run_directory, |
| 78 | const std::string &storage_directory, |
| 79 | const std::string &user_storage_format); |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 80 | virtual ~Manager(); |
mukesh agrawal | 8f317b6 | 2011-07-15 11:53:23 -0700 | [diff] [blame] | 81 | |
| 82 | void AddDeviceToBlackList(const std::string &device_name); |
Gary Morain | ac1bdb4 | 2012-02-16 17:42:29 -0800 | [diff] [blame] | 83 | |
Thieu Le | fb46caf | 2012-03-08 11:57:15 -0800 | [diff] [blame] | 84 | virtual void Start(); |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 85 | void Stop(); |
| 86 | |
Paul Stewart | 1b25314 | 2012-01-26 14:05:52 -0800 | [diff] [blame] | 87 | const ProfileRefPtr &ActiveProfile() const; |
| 88 | bool IsActiveProfile(const ProfileRefPtr &profile) const; |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 89 | bool MoveServiceToProfile(const ServiceRefPtr &to_move, |
| 90 | const ProfileRefPtr &destination); |
Paul Stewart | 7f61e52 | 2012-03-22 11:13:45 -0700 | [diff] [blame] | 91 | ProfileRefPtr LookupProfileByRpcIdentifier(const std::string &profile_rpcid); |
Chris Masone | 7aa5f90 | 2011-07-11 11:13:35 -0700 | [diff] [blame] | 92 | |
Paul Stewart | 1b1a7f2 | 2012-01-06 16:24:06 -0800 | [diff] [blame] | 93 | // Called via RPC call on Service (|to_set|) to set the "Profile" property. |
| 94 | void SetProfileForService(const ServiceRefPtr &to_set, |
| 95 | const std::string &profile, |
| 96 | Error *error); |
| 97 | |
Paul Stewart | 8c116a9 | 2012-05-02 18:30:03 -0700 | [diff] [blame] | 98 | virtual void RegisterDevice(const DeviceRefPtr &to_manage); |
| 99 | virtual void DeregisterDevice(const DeviceRefPtr &to_forget); |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 100 | |
mukesh agrawal | 4eb4d78 | 2011-12-05 17:34:37 +0000 | [diff] [blame] | 101 | virtual bool HasService(const ServiceRefPtr &service); |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 102 | // Register a Service with the Manager. Manager may choose to |
| 103 | // connect to it immediately. |
mukesh agrawal | 3239932 | 2011-09-01 10:53:43 -0700 | [diff] [blame] | 104 | virtual void RegisterService(const ServiceRefPtr &to_manage); |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 105 | // Deregister a Service from the Manager. Caller is responsible |
| 106 | // for disconnecting the Service before-hand. |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 107 | virtual void DeregisterService(const ServiceRefPtr &to_forget); |
mukesh agrawal | 00917ce | 2011-11-22 23:56:55 +0000 | [diff] [blame] | 108 | virtual void UpdateService(const ServiceRefPtr &to_update); |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 109 | |
Darin Petkov | e7c6ad3 | 2012-06-29 10:22:09 +0200 | [diff] [blame] | 110 | // Persists |to_update| into an appropriate profile. |
| 111 | virtual void UpdateDevice(const DeviceRefPtr &to_update); |
| 112 | |
Paul Stewart | fdd1607 | 2011-09-16 12:41:35 -0700 | [diff] [blame] | 113 | void FilterByTechnology(Technology::Identifier tech, |
Chris Masone | c1e5041 | 2011-06-07 13:04:53 -0700 | [diff] [blame] | 114 | std::vector<DeviceRefPtr> *found); |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 115 | |
Chris Masone | e0dea76 | 2011-06-09 09:06:03 -0700 | [diff] [blame] | 116 | ServiceRefPtr FindService(const std::string& name); |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 117 | std::vector<std::string> EnumerateAvailableServices(Error *error); |
Chris Masone | 9be4a9d | 2011-05-16 15:44:09 -0700 | [diff] [blame] | 118 | |
mukesh agrawal | 3239932 | 2011-09-01 10:53:43 -0700 | [diff] [blame] | 119 | // called via RPC (e.g., from ManagerDBusAdaptor) |
Darin Petkov | b65c245 | 2012-02-23 15:17:06 +0100 | [diff] [blame] | 120 | ServiceRefPtr GetService(const KeyValueStore &args, Error *error); |
Paul Stewart | 7f5ad57 | 2012-06-04 15:18:54 -0700 | [diff] [blame] | 121 | ServiceRefPtr ConfigureService(const KeyValueStore &args, Error *error); |
Gaurav Shah | b790aa2 | 2012-10-23 12:51:12 -0700 | [diff] [blame] | 122 | std::map<std::string, GeolocationInfos> GetNetworksForGeolocation(); |
Paul Stewart | 7f61e52 | 2012-03-22 11:13:45 -0700 | [diff] [blame] | 123 | |
Paul Stewart | c681fa0 | 2012-03-02 19:40:04 -0800 | [diff] [blame] | 124 | // Request portal detection checks on each registered device until a portal |
| 125 | // detection attempt starts on one of them. |
| 126 | void RecheckPortal(Error *error); |
Paul Stewart | d215af6 | 2012-04-24 23:25:50 -0700 | [diff] [blame] | 127 | // Request portal detection be restarted on the device connected to |
| 128 | // |service|. |
| 129 | virtual void RecheckPortalOnService(const ServiceRefPtr &service); |
| 130 | |
mukesh agrawal | 3239932 | 2011-09-01 10:53:43 -0700 | [diff] [blame] | 131 | void RequestScan(const std::string &technology, Error *error); |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 132 | std::string GetTechnologyOrder(); |
| 133 | void SetTechnologyOrder(const std::string &order, Error *error); |
Gaurav Shah | 7135476 | 2011-11-28 19:22:49 -0800 | [diff] [blame] | 134 | // Set up the profile list starting with a default profile along with |
| 135 | // an (optional) list of startup profiles. |
| 136 | void InitializeProfiles(); |
Paul Stewart | 19c871d | 2011-12-15 16:10:13 -0800 | [diff] [blame] | 137 | // Create a profile. This does not affect the profile stack. Returns |
| 138 | // the RPC path of the created profile in |path|. |
| 139 | void CreateProfile(const std::string &name, std::string *path, Error *error); |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 140 | // Pushes existing profile with name |name| onto stack of managed profiles. |
Paul Stewart | 19c871d | 2011-12-15 16:10:13 -0800 | [diff] [blame] | 141 | // Returns the RPC path of the pushed profile in |path|. |
| 142 | void PushProfile(const std::string &name, std::string *path, Error *error); |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 143 | // Pops profile named |name| off the top of the stack of managed profiles. |
| 144 | void PopProfile(const std::string &name, Error *error); |
| 145 | // Remove the active profile. |
| 146 | void PopAnyProfile(Error *error); |
Paul Stewart | e73d05c | 2012-03-29 16:26:05 -0700 | [diff] [blame] | 147 | // Remove the underlying persistent storage for a profile. |
| 148 | void RemoveProfile(const std::string &name, Error *error); |
Paul Stewart | 7522551 | 2012-01-26 22:51:33 -0800 | [diff] [blame] | 149 | // Handle the event where a profile is about to remove a profile entry. |
| 150 | // Any Services that are dependent on this storage identifier will need |
| 151 | // to find new profiles. Return true if any service has been moved to a new |
| 152 | // profile. Any such services will have had the profile group removed from |
| 153 | // the profile. |
| 154 | virtual bool HandleProfileEntryDeletion(const ProfileRefPtr &profile, |
| 155 | const std::string &entry_name); |
Paul Stewart | 13ed225 | 2012-03-21 12:52:46 -0700 | [diff] [blame] | 156 | // Find a registered service that contains a GUID property that |
| 157 | // matches |guid|. |
| 158 | virtual ServiceRefPtr GetServiceWithGUID(const std::string &guid, |
| 159 | Error *error); |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 160 | // Find a service that is both the member of |profile| and has a |
| 161 | // storage identifier that matches |entry_name|. This function is |
| 162 | // called by the Profile in order to return a profile entry's properties. |
| 163 | virtual ServiceRefPtr GetServiceWithStorageIdentifier( |
| 164 | const ProfileRefPtr &profile, |
| 165 | const std::string &entry_name, |
| 166 | Error *error); |
Paul Stewart | e2bad7c | 2012-03-14 08:55:33 -0700 | [diff] [blame] | 167 | // Return a reference to the Service associated with the default connection. |
| 168 | // If there is no such connection, this function returns a reference to NULL. |
| 169 | virtual ServiceRefPtr GetDefaultService() const; |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 170 | |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 171 | // Enable all devices for the named technology. |
| 172 | void EnableTechnology(const std::string &technology_name, |
| 173 | Error *error, |
| 174 | const ResultCallback &callback); |
| 175 | // Disable all devices for the named technology. |
| 176 | void DisableTechnology(const std::string &technology_name, |
| 177 | Error *error, |
| 178 | const ResultCallback &callback); |
Paul Stewart | 20088d8 | 2012-02-16 06:58:55 -0800 | [diff] [blame] | 179 | // Return whether a technology is marked as enabled for portal detection. |
| 180 | virtual bool IsPortalDetectionEnabled(Technology::Identifier tech); |
Paul Stewart | 10e9e4e | 2012-04-26 19:46:28 -0700 | [diff] [blame] | 181 | // Set the start-up value for the portal detection list. This list will |
| 182 | // be used until a value set explicitly over the control API. Until |
| 183 | // then, we ignore but do not overwrite whatever value is stored in the |
| 184 | // profile. |
| 185 | void SetStartupPortalList(const std::string &portal_list); |
Paul Stewart | 20088d8 | 2012-02-16 06:58:55 -0800 | [diff] [blame] | 186 | |
Paul Stewart | 10ccbb3 | 2012-04-26 15:59:30 -0700 | [diff] [blame] | 187 | // Return whether a service belongs to the ephemeral profile. |
| 188 | virtual bool IsServiceEphemeral(const ServiceConstRefPtr &service) const; |
| 189 | |
Paul Stewart | bf66761 | 2012-06-29 14:49:54 -0700 | [diff] [blame] | 190 | // Return whether a technology is enabled for using short DNS timeouts. |
| 191 | bool IsTechnologyShortDNSTimeoutEnabled(Technology::Identifier tech) const; |
| 192 | |
Paul Stewart | 036dba0 | 2012-08-07 12:34:41 -0700 | [diff] [blame] | 193 | // Return whether a technology is enabled for link monitoring. |
| 194 | virtual bool IsTechnologyLinkMonitorEnabled( |
| 195 | Technology::Identifier technology) const; |
| 196 | |
Paul Stewart | 38fd24c | 2012-04-25 14:06:29 -0700 | [diff] [blame] | 197 | std::string CalculateState(Error *error); |
| 198 | |
Paul Stewart | c681fa0 | 2012-03-02 19:40:04 -0800 | [diff] [blame] | 199 | virtual int GetPortalCheckInterval() const { |
| 200 | return props_.portal_check_interval_seconds; |
| 201 | } |
Paul Stewart | 20088d8 | 2012-02-16 06:58:55 -0800 | [diff] [blame] | 202 | virtual const std::string &GetPortalCheckURL() const { |
| 203 | return props_.portal_url; |
| 204 | } |
mukesh agrawal | 3239932 | 2011-09-01 10:53:43 -0700 | [diff] [blame] | 205 | |
Darin Petkov | 2b8e44e | 2012-06-25 15:13:26 +0200 | [diff] [blame] | 206 | DBusManager *dbus_manager() const { return dbus_manager_.get(); } |
Chris Masone | 626719f | 2011-08-18 16:58:48 -0700 | [diff] [blame] | 207 | virtual DeviceInfo *device_info() { return &device_info_; } |
Paul Stewart | 8c116a9 | 2012-05-02 18:30:03 -0700 | [diff] [blame] | 208 | virtual ModemInfo *modem_info() { return &modem_info_; } |
| 209 | virtual VPNProvider *vpn_provider() { return &vpn_provider_; } |
Darin Petkov | b72b62e | 2012-05-15 16:55:36 +0200 | [diff] [blame] | 210 | virtual WiMaxProvider *wimax_provider() { return &wimax_provider_; } |
mukesh agrawal | de29fa8 | 2011-09-16 16:16:36 -0700 | [diff] [blame] | 211 | PropertyStore *mutable_store() { return &store_; } |
| 212 | virtual const PropertyStore &store() const { return store_; } |
Darin Petkov | 36a3ace | 2012-03-06 17:22:14 +0100 | [diff] [blame] | 213 | GLib *glib() const { return glib_; } |
Darin Petkov | f7ef50a | 2012-04-16 20:54:31 +0200 | [diff] [blame] | 214 | virtual const FilePath &run_path() const { return run_path_; } |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 215 | |
Gaurav Shah | 7135476 | 2011-11-28 19:22:49 -0800 | [diff] [blame] | 216 | void set_startup_profiles(const std::vector<std::string> &startup_profiles) { |
| 217 | startup_profiles_ = startup_profiles; |
| 218 | } |
Paul Stewart | d408fdf | 2012-05-07 17:15:57 -0700 | [diff] [blame] | 219 | bool GetArpGateway() const { return props_.arp_gateway; } |
| 220 | const std::string &GetHostName() const { return props_.host_name; } |
Chris Masone | 877ff98 | 2011-09-21 16:18:24 -0700 | [diff] [blame] | 221 | |
Eric Shienbrood | 9a24553 | 2012-03-07 14:20:39 -0500 | [diff] [blame] | 222 | virtual void UpdateEnabledTechnologies(); |
Gary Morain | ac1bdb4 | 2012-02-16 17:42:29 -0800 | [diff] [blame] | 223 | |
Gary Morain | d93615e | 2012-04-27 11:50:03 -0700 | [diff] [blame] | 224 | // Writes the service |to_update| to persistant storage. If the service's is |
| 225 | // ephemeral, it is moved to the current profile. |
| 226 | void SaveServiceToProfile(const ServiceRefPtr &to_update); |
| 227 | |
Paul Stewart | 87a4ae8 | 2012-10-26 15:49:32 -0700 | [diff] [blame] | 228 | // Configure the device with profile data from all current profiles. |
| 229 | virtual void LoadDeviceFromProfiles(const DeviceRefPtr &device); |
| 230 | |
Gary Morain | a9fb325 | 2012-05-31 12:05:31 -0700 | [diff] [blame] | 231 | // Adds a closure to be executed when ChromeOS suspends or shill terminates. |
| 232 | // |name| should be unique; otherwise, a previous closure by the same name |
| 233 | // will be replaced. |start| will be called when RunTerminationActions() is |
| 234 | // called. When an action completed, TerminationActionComplete() must be |
| 235 | // called. |
| 236 | void AddTerminationAction(const std::string &name, |
| 237 | const base::Closure &start); |
| 238 | |
| 239 | // Users call this function to report the completion of an action |name|. |
| 240 | // This function should be called once for each action. |
| 241 | void TerminationActionComplete(const std::string &name); |
| 242 | |
| 243 | // Removes the action associtated with |name|. |
| 244 | void RemoveTerminationAction(const std::string &name); |
| 245 | |
Arman Uguray | ab22c16 | 2012-10-08 19:08:38 -0700 | [diff] [blame] | 246 | // Runs the termination actions and notifies the metrics framework |
| 247 | // that the termination actions started running, only if any termination |
| 248 | // actions have been registered. |reason| specifies whether this method was |
| 249 | // called due to termination or suspend. If all actions complete within |
Darin Petkov | 3ec5534 | 2012-09-28 14:04:44 +0200 | [diff] [blame] | 250 | // |kTerminationActionsTimeoutMilliseconds|, |done| is called with a value of |
Arman Uguray | ab22c16 | 2012-10-08 19:08:38 -0700 | [diff] [blame] | 251 | // Error::kSuccess. Otherwise, it is called with Error::kOperationTimeout. |
| 252 | // |
| 253 | // Returns true, if termination actions were run. |
| 254 | bool RunTerminationActionsAndNotifyMetrics( |
| 255 | const base::Callback<void(const Error &)> &done, |
| 256 | Metrics::TerminationActionReason reason); |
Gary Morain | a9fb325 | 2012-05-31 12:05:31 -0700 | [diff] [blame] | 257 | |
Darin Petkov | a5e07ef | 2012-07-09 14:27:57 +0200 | [diff] [blame] | 258 | // Registers a |callback| that's invoked whenever the default service |
| 259 | // changes. Returns a unique tag that can be used to deregister the |
| 260 | // callback. A tag equal to 0 is invalid. |
| 261 | virtual int RegisterDefaultServiceCallback(const ServiceCallback &callback); |
| 262 | virtual void DeregisterDefaultServiceCallback(int tag); |
| 263 | |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 264 | private: |
Arman Uguray | ab22c16 | 2012-10-08 19:08:38 -0700 | [diff] [blame] | 265 | friend class CellularTest; |
Darin Petkov | 6f9eaa3 | 2011-08-09 15:26:44 -0700 | [diff] [blame] | 266 | friend class ManagerAdaptorInterface; |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 267 | friend class ManagerTest; |
Paul Stewart | e369ece | 2012-05-22 09:11:03 -0700 | [diff] [blame] | 268 | friend class WiFiObjectTest; |
Darin Petkov | b501ad2 | 2012-07-03 12:50:52 +0200 | [diff] [blame] | 269 | friend class WiMaxProviderTest; |
Arman Uguray | ab22c16 | 2012-10-08 19:08:38 -0700 | [diff] [blame] | 270 | |
| 271 | FRIEND_TEST(CellularTest, ConnectAddsTerminationAction); |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 272 | FRIEND_TEST(ManagerTest, AvailableTechnologies); |
Gary Morain | 028545d | 2012-04-07 14:55:52 -0700 | [diff] [blame] | 273 | FRIEND_TEST(ManagerTest, CalculateStateOffline); |
| 274 | FRIEND_TEST(ManagerTest, CalculateStateOnline); |
Gaurav Shah | 435de2c | 2011-11-17 19:01:07 -0800 | [diff] [blame] | 275 | FRIEND_TEST(ManagerTest, ConnectedTechnologies); |
| 276 | FRIEND_TEST(ManagerTest, DefaultTechnology); |
Paul Stewart | 1b25314 | 2012-01-26 14:05:52 -0800 | [diff] [blame] | 277 | FRIEND_TEST(ManagerTest, DeviceRegistrationAndStart); |
Darin Petkov | a5e07ef | 2012-07-09 14:27:57 +0200 | [diff] [blame] | 278 | FRIEND_TEST(ManagerTest, DisableTechnology); |
| 279 | FRIEND_TEST(ManagerTest, EnableTechnology); |
Paul Stewart | 1b25314 | 2012-01-26 14:05:52 -0800 | [diff] [blame] | 280 | FRIEND_TEST(ManagerTest, EnumerateProfiles); |
Paul Stewart | 65512e1 | 2012-03-26 18:01:08 -0700 | [diff] [blame] | 281 | FRIEND_TEST(ManagerTest, HandleProfileEntryDeletionWithUnload); |
Paul Stewart | 036dba0 | 2012-08-07 12:34:41 -0700 | [diff] [blame] | 282 | FRIEND_TEST(ManagerTest, LinkMonitorEnabled); |
Darin Petkov | a5e07ef | 2012-07-09 14:27:57 +0200 | [diff] [blame] | 283 | FRIEND_TEST(ManagerTest, NotifyDefaultServiceChanged); |
Paul Stewart | 65512e1 | 2012-03-26 18:01:08 -0700 | [diff] [blame] | 284 | FRIEND_TEST(ManagerTest, PopProfileWithUnload); |
Arman Uguray | ab22c16 | 2012-10-08 19:08:38 -0700 | [diff] [blame] | 285 | FRIEND_TEST(ManagerTest, RunTerminationActions); |
Paul Stewart | 1b25314 | 2012-01-26 14:05:52 -0800 | [diff] [blame] | 286 | FRIEND_TEST(ManagerTest, SortServices); |
| 287 | FRIEND_TEST(ManagerTest, SortServicesWithConnection); |
Paul Stewart | 10e9e4e | 2012-04-26 19:46:28 -0700 | [diff] [blame] | 288 | FRIEND_TEST(ManagerTest, StartupPortalList); |
Darin Petkov | 6f9eaa3 | 2011-08-09 15:26:44 -0700 | [diff] [blame] | 289 | |
Darin Petkov | b65c245 | 2012-02-23 15:17:06 +0100 | [diff] [blame] | 290 | static const char kErrorNoDevice[]; |
| 291 | static const char kErrorTypeRequired[]; |
| 292 | static const char kErrorUnsupportedServiceType[]; |
| 293 | |
Darin Petkov | 3ec5534 | 2012-09-28 14:04:44 +0200 | [diff] [blame] | 294 | // Time to wait for termination actions to complete. |
| 295 | static const int kTerminationActionsTimeoutMilliseconds; |
| 296 | |
| 297 | static const char kPowerManagerKey[]; |
| 298 | |
Darin Petkov | b65c245 | 2012-02-23 15:17:06 +0100 | [diff] [blame] | 299 | WiFiServiceRefPtr GetWifiService(const KeyValueStore &args, Error *error); |
mukesh agrawal | 7a4e400 | 2011-09-06 11:26:05 -0700 | [diff] [blame] | 300 | |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 301 | void AutoConnect(); |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 302 | std::vector<std::string> AvailableTechnologies(Error *error); |
| 303 | std::vector<std::string> ConnectedTechnologies(Error *error); |
| 304 | std::string DefaultTechnology(Error *error); |
| 305 | std::vector<std::string> EnabledTechnologies(Error *error); |
Paul Stewart | cb3eb89 | 2012-06-07 14:24:46 -0700 | [diff] [blame] | 306 | RpcIdentifiers EnumerateDevices(Error *error); |
| 307 | RpcIdentifiers EnumerateProfiles(Error *error); |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 308 | // TODO(cmasone): This should be implemented by filtering |services_|. |
Paul Stewart | cb3eb89 | 2012-06-07 14:24:46 -0700 | [diff] [blame] | 309 | RpcIdentifiers EnumerateWatchedServices(Error *error); |
Paul Stewart | 1b25314 | 2012-01-26 14:05:52 -0800 | [diff] [blame] | 310 | std::string GetActiveProfileRpcIdentifier(Error *error); |
Paul Stewart | 10e9e4e | 2012-04-26 19:46:28 -0700 | [diff] [blame] | 311 | std::string GetCheckPortalList(Error *error); |
Paul Stewart | 49739c0 | 2012-08-08 17:24:03 -0700 | [diff] [blame] | 312 | RpcIdentifier GetDefaultServiceRpcIdentifier(Error *error); |
Paul Stewart | 4d5efb7 | 2012-09-17 12:24:34 -0700 | [diff] [blame] | 313 | std::string GetIgnoredDNSSearchPaths(Error *error); |
Paul Stewart | 7f5ad57 | 2012-06-04 15:18:54 -0700 | [diff] [blame] | 314 | ServiceRefPtr GetServiceInner(const KeyValueStore &args, Error *error); |
Paul Stewart | 10e9e4e | 2012-04-26 19:46:28 -0700 | [diff] [blame] | 315 | void SetCheckPortalList(const std::string &portal_list, Error *error); |
Paul Stewart | 4d5efb7 | 2012-09-17 12:24:34 -0700 | [diff] [blame] | 316 | void SetIgnoredDNSSearchPaths(const std::string &ignored_paths, Error *error); |
Paul Stewart | 49739c0 | 2012-08-08 17:24:03 -0700 | [diff] [blame] | 317 | void EmitDefaultService(); |
Paul Stewart | 036dba0 | 2012-08-07 12:34:41 -0700 | [diff] [blame] | 318 | bool IsTechnologyInList(const std::string &technology_list, |
| 319 | Technology::Identifier tech) const; |
Eric Shienbrood | 8839a89 | 2012-03-29 10:33:48 -0400 | [diff] [blame] | 320 | void EmitDeviceProperties(); |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 321 | |
Paul Stewart | 65512e1 | 2012-03-26 18:01:08 -0700 | [diff] [blame] | 322 | // Unload a service while iterating through |services_|. Returns true if |
| 323 | // service was erased (which means the caller loop should not increment |
| 324 | // |service_iterator|), false otherwise (meaning the caller should |
| 325 | // increment |service_iterator|). |
| 326 | bool UnloadService(std::vector<ServiceRefPtr>::iterator *service_iterator); |
| 327 | |
Paul Stewart | 4d5efb7 | 2012-09-17 12:24:34 -0700 | [diff] [blame] | 328 | // Load Manager default properties from |profile|. |
| 329 | bool LoadProperties(const scoped_refptr<DefaultProfile> &profile); |
| 330 | |
Paul Stewart | 49739c0 | 2012-08-08 17:24:03 -0700 | [diff] [blame] | 331 | void HelpRegisterConstDerivedRpcIdentifier( |
| 332 | const std::string &name, |
| 333 | RpcIdentifier(Manager::*get)(Error *)); |
mukesh agrawal | 2366eed | 2012-03-20 18:21:50 -0700 | [diff] [blame] | 334 | void HelpRegisterConstDerivedRpcIdentifiers( |
| 335 | const std::string &name, |
| 336 | RpcIdentifiers(Manager::*get)(Error *)); |
mukesh agrawal | ffa3d04 | 2011-10-06 15:26:10 -0700 | [diff] [blame] | 337 | void HelpRegisterDerivedString( |
| 338 | const std::string &name, |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 339 | std::string(Manager::*get)(Error *), |
mukesh agrawal | ffa3d04 | 2011-10-06 15:26:10 -0700 | [diff] [blame] | 340 | void(Manager::*set)(const std::string&, Error *)); |
| 341 | void HelpRegisterDerivedStrings( |
| 342 | const std::string &name, |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 343 | Strings(Manager::*get)(Error *), |
mukesh agrawal | ffa3d04 | 2011-10-06 15:26:10 -0700 | [diff] [blame] | 344 | void(Manager::*set)(const Strings&, Error *)); |
Chris Masone | 27c4aa5 | 2011-07-02 13:10:14 -0700 | [diff] [blame] | 345 | |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 346 | void PopProfileInternal(); |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 347 | void SortServices(); |
Paul Stewart | dfa4605 | 2012-06-26 09:44:14 -0700 | [diff] [blame] | 348 | void SortServicesTask(); |
Paul Stewart | 7522551 | 2012-01-26 22:51:33 -0800 | [diff] [blame] | 349 | bool MatchProfileWithService(const ServiceRefPtr &service); |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 350 | |
Darin Petkov | a5e07ef | 2012-07-09 14:27:57 +0200 | [diff] [blame] | 351 | void NotifyDefaultServiceChanged(const ServiceRefPtr &service); |
| 352 | |
Arman Uguray | ab22c16 | 2012-10-08 19:08:38 -0700 | [diff] [blame] | 353 | // Runs the termination actions. If all actions complete within |
| 354 | // |kTerminationActionsTimeoutMilliseconds|, |done| is called with a value of |
| 355 | // Error::kSuccess. Otherwise, it is called with Error::kOperationTimeout. |
| 356 | void RunTerminationActions(const base::Callback<void(const Error &)> &done); |
| 357 | |
Darin Petkov | ca62154 | 2012-07-25 14:25:56 +0200 | [diff] [blame] | 358 | void OnPowerStateChanged(PowerManagerProxyDelegate::SuspendState power_state); |
Darin Petkov | 3ec5534 | 2012-09-28 14:04:44 +0200 | [diff] [blame] | 359 | void OnSuspendDelay(uint32 sequence_number); |
| 360 | |
| 361 | void OnSuspendActionsComplete(uint32 sequence_number, const Error &error); |
Darin Petkov | ca62154 | 2012-07-25 14:25:56 +0200 | [diff] [blame] | 362 | |
Thieu Le | a20cbc2 | 2012-01-09 22:01:43 +0000 | [diff] [blame] | 363 | // For unit testing. |
| 364 | void set_metrics(Metrics *metrics) { metrics_ = metrics; } |
| 365 | |
Gary Morain | ac1bdb4 | 2012-02-16 17:42:29 -0800 | [diff] [blame] | 366 | // Used by tests to set a mock PowerManager. Takes ownership of |
| 367 | // power_manager. |
| 368 | void set_power_manager(PowerManager *power_manager) { |
| 369 | power_manager_.reset(power_manager); |
| 370 | } |
| 371 | |
mukesh agrawal | 8a3188d | 2011-12-01 20:56:44 +0000 | [diff] [blame] | 372 | EventDispatcher *dispatcher_; |
Chris Masone | 2ae797d | 2011-08-23 20:41:00 -0700 | [diff] [blame] | 373 | const FilePath run_path_; |
| 374 | const FilePath storage_path_; |
| 375 | const std::string user_storage_format_; |
Paul Stewart | 0af98bf | 2011-05-10 17:38:08 -0700 | [diff] [blame] | 376 | scoped_ptr<ManagerAdaptorInterface> adaptor_; |
Darin Petkov | 002c58e | 2012-06-19 02:56:05 +0200 | [diff] [blame] | 377 | scoped_ptr<DBusManager> dbus_manager_; |
Paul Stewart | 0af98bf | 2011-05-10 17:38:08 -0700 | [diff] [blame] | 378 | DeviceInfo device_info_; |
Darin Petkov | 887f298 | 2011-07-14 16:10:17 -0700 | [diff] [blame] | 379 | ModemInfo modem_info_; |
Darin Petkov | 33af05c | 2012-02-28 10:10:30 +0100 | [diff] [blame] | 380 | VPNProvider vpn_provider_; |
Darin Petkov | b72b62e | 2012-05-15 16:55:36 +0200 | [diff] [blame] | 381 | WiMaxProvider wimax_provider_; |
Paul Stewart | 4d5efb7 | 2012-09-17 12:24:34 -0700 | [diff] [blame] | 382 | // Hold pointer to singleton Resolver instance for testing purposes. |
| 383 | Resolver *resolver_; |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 384 | bool running_; |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 385 | // Used to facilitate unit tests which can't use RPC. |
| 386 | bool connect_profiles_to_rpc_; |
Chris Masone | c1e5041 | 2011-06-07 13:04:53 -0700 | [diff] [blame] | 387 | std::vector<DeviceRefPtr> devices_; |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 388 | // We store Services in a vector, because we want to keep them sorted. |
Gary Morain | 028545d | 2012-04-07 14:55:52 -0700 | [diff] [blame] | 389 | // Services that are connected appear first in the vector. See |
| 390 | // Service::Compare() for details of the sorting criteria. |
Chris Masone | c1e5041 | 2011-06-07 13:04:53 -0700 | [diff] [blame] | 391 | std::vector<ServiceRefPtr> services_; |
Gaurav Shah | 7135476 | 2011-11-28 19:22:49 -0800 | [diff] [blame] | 392 | // List of startup profile names to push on the profile stack on startup. |
| 393 | std::vector<std::string> startup_profiles_; |
Chris Masone | 7aa5f90 | 2011-07-11 11:13:35 -0700 | [diff] [blame] | 394 | std::vector<ProfileRefPtr> profiles_; |
| 395 | ProfileRefPtr ephemeral_profile_; |
Chris Masone | 2ae797d | 2011-08-23 20:41:00 -0700 | [diff] [blame] | 396 | ControlInterface *control_interface_; |
Thieu Le | 3426c8f | 2012-01-11 17:35:11 -0800 | [diff] [blame] | 397 | Metrics *metrics_; |
Chris Masone | 2ae797d | 2011-08-23 20:41:00 -0700 | [diff] [blame] | 398 | GLib *glib_; |
Gary Morain | ac1bdb4 | 2012-02-16 17:42:29 -0800 | [diff] [blame] | 399 | scoped_ptr<PowerManager> power_manager_; |
Chris Masone | 3bd3c8c | 2011-06-13 08:20:26 -0700 | [diff] [blame] | 400 | |
Paul Stewart | 22aa71b | 2011-09-16 12:15:11 -0700 | [diff] [blame] | 401 | // The priority order of technologies |
| 402 | std::vector<Technology::Identifier> technology_order_; |
| 403 | |
Paul Stewart | 49739c0 | 2012-08-08 17:24:03 -0700 | [diff] [blame] | 404 | // This is the last Service RPC Identifier for which we emitted a |
| 405 | // "DefaultService" signal for. |
| 406 | RpcIdentifier default_service_rpc_identifier_; |
| 407 | |
Paul Stewart | 10e9e4e | 2012-04-26 19:46:28 -0700 | [diff] [blame] | 408 | // Manager can be optionally configured with a list of technologies to |
| 409 | // do portal detection on at startup. We need to keep track of that list |
| 410 | // as well as a flag that tells us whether we should continue using it |
| 411 | // instead of the configured portal list. |
| 412 | std::string startup_portal_list_; |
| 413 | bool use_startup_portal_list_; |
| 414 | |
Chris Masone | b925cc8 | 2011-06-22 15:39:57 -0700 | [diff] [blame] | 415 | // Properties to be get/set via PropertyStore calls. |
Chris Masone | 88cbd5f | 2011-07-03 14:30:04 -0700 | [diff] [blame] | 416 | Properties props_; |
Chris Masone | 27c4aa5 | 2011-07-02 13:10:14 -0700 | [diff] [blame] | 417 | PropertyStore store_; |
Gary Morain | a9fb325 | 2012-05-31 12:05:31 -0700 | [diff] [blame] | 418 | |
Paul Stewart | dfa4605 | 2012-06-26 09:44:14 -0700 | [diff] [blame] | 419 | base::CancelableClosure sort_services_task_; |
Darin Petkov | 3ec5534 | 2012-09-28 14:04:44 +0200 | [diff] [blame] | 420 | |
| 421 | // TODO(petkov): Currently this handles both terminate and suspend |
| 422 | // actions. Rename all relevant identifiers to capture this. |
Gary Morain | a9fb325 | 2012-05-31 12:05:31 -0700 | [diff] [blame] | 423 | HookTable termination_actions_; |
Darin Petkov | a5e07ef | 2012-07-09 14:27:57 +0200 | [diff] [blame] | 424 | |
| 425 | // Maps tags to callbacks for monitoring default service changes. |
| 426 | std::map<int, ServiceCallback> default_service_callbacks_; |
| 427 | int default_service_callback_tag_; |
Paul Stewart | 75897df | 2011-04-27 09:05:53 -0700 | [diff] [blame] | 428 | }; |
| 429 | |
| 430 | } // namespace shill |
| 431 | |
Darin Petkov | 002c58e | 2012-06-19 02:56:05 +0200 | [diff] [blame] | 432 | #endif // SHILL_MANAGER_H_ |