Paul Stewart | 1b1a7f2 | 2012-01-06 16:24:06 -0800 | [diff] [blame] | 1 | // Copyright (c) 2012 The Chromium OS Authors. All rights reserved. |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -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 | |
Wade Guthrie | 60a3706 | 2013-04-02 11:39:09 -0700 | [diff] [blame] | 5 | #ifndef SHILL_PROFILE_H_ |
| 6 | #define SHILL_PROFILE_H_ |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 7 | |
Chris Masone | 7aa5f90 | 2011-07-11 11:13:35 -0700 | [diff] [blame] | 8 | #include <map> |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 9 | #include <string> |
| 10 | #include <vector> |
| 11 | |
| 12 | #include <base/memory/scoped_ptr.h> |
mukesh agrawal | 0a59a5a | 2014-04-24 19:10:46 -0700 | [diff] [blame] | 13 | #include <base/files/file_path.h> |
Darin Petkov | a476682 | 2011-07-07 10:42:22 -0700 | [diff] [blame] | 14 | #include <gtest/gtest_prod.h> // for FRIEND_TEST |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 15 | |
Paul Stewart | 26b327e | 2011-10-19 11:38:09 -0700 | [diff] [blame] | 16 | #include "shill/event_dispatcher.h" |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 17 | #include "shill/property_store.h" |
| 18 | #include "shill/refptr_types.h" |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 19 | |
Paul Stewart | 5ad1606 | 2013-02-21 18:10:48 -0800 | [diff] [blame] | 20 | namespace base { |
| 21 | |
Darin Petkov | a476682 | 2011-07-07 10:42:22 -0700 | [diff] [blame] | 22 | class FilePath; |
| 23 | |
Paul Stewart | 5ad1606 | 2013-02-21 18:10:48 -0800 | [diff] [blame] | 24 | } // namespace base |
| 25 | |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 26 | namespace shill { |
| 27 | |
| 28 | class ControlInterface; |
| 29 | class Error; |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 30 | class GLib; |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 31 | class Manager; |
Thieu Le | 5133b71 | 2013-02-19 14:47:21 -0800 | [diff] [blame] | 32 | class Metrics; |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 33 | class ProfileAdaptorInterface; |
Chris Masone | 9d77993 | 2011-08-25 16:33:41 -0700 | [diff] [blame] | 34 | class StoreInterface; |
Wade Guthrie | 60a3706 | 2013-04-02 11:39:09 -0700 | [diff] [blame] | 35 | class WiFiProvider; |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 36 | |
Chris Masone | 7aa5f90 | 2011-07-11 11:13:35 -0700 | [diff] [blame] | 37 | class Profile : public base::RefCounted<Profile> { |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 38 | public: |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 39 | enum InitStorageOption { |
| 40 | kOpenExisting, |
| 41 | kCreateNew, |
| 42 | kCreateOrOpenExisting |
| 43 | }; |
Darin Petkov | a476682 | 2011-07-07 10:42:22 -0700 | [diff] [blame] | 44 | struct Identifier { |
Chris Masone | 7df0c67 | 2011-07-15 10:24:54 -0700 | [diff] [blame] | 45 | Identifier() {} |
| 46 | explicit Identifier(const std::string &i) : identifier(i) {} |
| 47 | Identifier(const std::string &u, const std::string &i) |
| 48 | : user(u), |
| 49 | identifier(i) { |
| 50 | } |
Darin Petkov | a476682 | 2011-07-07 10:42:22 -0700 | [diff] [blame] | 51 | std::string user; // Empty for global. |
| 52 | std::string identifier; |
Paul Stewart | f3eced9 | 2013-04-17 12:18:22 -0700 | [diff] [blame] | 53 | std::string user_hash; |
Darin Petkov | a476682 | 2011-07-07 10:42:22 -0700 | [diff] [blame] | 54 | }; |
| 55 | |
Paul Stewart | 78af94c | 2013-04-17 16:02:06 -0700 | [diff] [blame] | 56 | // Path to the cached list of inserted user profiles to be loaded at |
| 57 | // startup. |
| 58 | static const char kUserProfileListPathname[]; |
| 59 | |
Chris Masone | 7df0c67 | 2011-07-15 10:24:54 -0700 | [diff] [blame] | 60 | Profile(ControlInterface *control_interface, |
Thieu Le | 5133b71 | 2013-02-19 14:47:21 -0800 | [diff] [blame] | 61 | Metrics *metrics, |
Chris Masone | 7df0c67 | 2011-07-15 10:24:54 -0700 | [diff] [blame] | 62 | Manager *manager, |
| 63 | const Identifier &name, |
mukesh agrawal | 0a59a5a | 2014-04-24 19:10:46 -0700 | [diff] [blame] | 64 | const std::string &user_storage_directory, |
Chris Masone | 7df0c67 | 2011-07-15 10:24:54 -0700 | [diff] [blame] | 65 | bool connect_to_rpc); |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 66 | |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 67 | virtual ~Profile(); |
| 68 | |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 69 | // Set up persistent storage for this Profile. |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 70 | bool InitStorage(GLib *glib, |
| 71 | InitStorageOption storage_option, |
| 72 | Error *error); |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 73 | |
mukesh agrawal | 92496a4 | 2014-04-08 16:04:43 -0700 | [diff] [blame] | 74 | // Set up stub storage for this Profile. The data will NOT be |
| 75 | // persisted. In most cases, you should prefer InitStorage. |
| 76 | void InitStubStorage(); |
| 77 | |
| 78 | // Remove the persistent storage for this Profile. It is an error to |
Paul Stewart | e73d05c | 2012-03-29 16:26:05 -0700 | [diff] [blame] | 79 | // do so while the underlying storage is open via InitStorage() or |
| 80 | // set_storage(). |
| 81 | bool RemoveStorage(GLib *glib, Error *error); |
| 82 | |
Chris Masone | 7df0c67 | 2011-07-15 10:24:54 -0700 | [diff] [blame] | 83 | std::string GetFriendlyName(); |
| 84 | |
Paul Stewart | 1b1a7f2 | 2012-01-06 16:24:06 -0800 | [diff] [blame] | 85 | virtual std::string GetRpcIdentifier(); |
Chris Masone | 7aa5f90 | 2011-07-11 11:13:35 -0700 | [diff] [blame] | 86 | |
mukesh agrawal | de29fa8 | 2011-09-16 16:16:36 -0700 | [diff] [blame] | 87 | PropertyStore *mutable_store() { return &store_; } |
| 88 | const PropertyStore &store() const { return store_; } |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 89 | |
Paul Stewart | e73d05c | 2012-03-29 16:26:05 -0700 | [diff] [blame] | 90 | // Set the storage inteface. This is used for testing purposes. It |
| 91 | // takes ownership of |storage|. |
| 92 | void set_storage(StoreInterface *storage); |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 93 | |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 94 | // Begin managing the persistence of |service|. |
| 95 | // Returns true if |service| is new to this profile and was added, |
| 96 | // false if the |service| already existed. |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 97 | virtual bool AdoptService(const ServiceRefPtr &service); |
Chris Masone | 7aa5f90 | 2011-07-11 11:13:35 -0700 | [diff] [blame] | 98 | |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 99 | // Cease managing the persistence of the Service |service|. |
| 100 | // Returns true if |service| was found and abandoned, or not found. |
| 101 | // Returns false if can't be abandoned. |
| 102 | virtual bool AbandonService(const ServiceRefPtr &service); |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 103 | |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 104 | // Clobbers persisted notion of |service| with data from |service|. |
| 105 | // Returns true if |service| was found and updated, false if not found. |
Paul Stewart | 7f61e52 | 2012-03-22 11:13:45 -0700 | [diff] [blame] | 106 | virtual bool UpdateService(const ServiceRefPtr &service); |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 107 | |
Paul Stewart | bba6a5b | 2011-11-02 18:45:59 -0700 | [diff] [blame] | 108 | // Ask |service| if it can configure itself from the profile. If it can, |
Paul Stewart | 2c575d2 | 2012-12-07 12:28:57 -0800 | [diff] [blame] | 109 | // ask |service| to perform the configuration and return true. If not, |
| 110 | // return false. |
| 111 | virtual bool LoadService(const ServiceRefPtr &service); |
| 112 | |
| 113 | // Perform LoadService() on |service|. If this succeeds, change |
| 114 | // the service to point at this profile and return true. If not, return |
| 115 | // false. |
Paul Stewart | a41e38d | 2011-11-11 07:47:29 -0800 | [diff] [blame] | 116 | virtual bool ConfigureService(const ServiceRefPtr &service); |
| 117 | |
| 118 | // Allow the device to configure itself from this profile. Returns |
| 119 | // true if the device succeeded in finding its configuration. If not, |
| 120 | // return false. |
| 121 | virtual bool ConfigureDevice(const DeviceRefPtr &device); |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 122 | |
Paul Stewart | 7522551 | 2012-01-26 22:51:33 -0800 | [diff] [blame] | 123 | // Remove a named entry from the profile. This includes detaching |
| 124 | // any service that uses this profile entry. |
| 125 | virtual void DeleteEntry(const std::string &entry_name, Error *error); |
| 126 | |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 127 | // Return a service configured from the given profile entry. |
| 128 | virtual ServiceRefPtr GetServiceFromEntry(const std::string &entry_name, |
| 129 | Error *error); |
| 130 | |
Paul Stewart | bba6a5b | 2011-11-02 18:45:59 -0700 | [diff] [blame] | 131 | // Return whether |service| can configure itself from the profile. |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 132 | bool ContainsService(const ServiceConstRefPtr &service); |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 133 | |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 134 | std::vector<std::string> EnumerateAvailableServices(Error *error); |
| 135 | std::vector<std::string> EnumerateEntries(Error *error); |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 136 | |
Darin Petkov | e7c6ad3 | 2012-06-29 10:22:09 +0200 | [diff] [blame] | 137 | // Clobbers persisted notion of |device| with data from |device|. Returns true |
| 138 | // if |device| was found and updated, false otherwise. The base implementation |
| 139 | // always returns false -- currently devices are persisted only in |
| 140 | // DefaultProfile. |
| 141 | virtual bool UpdateDevice(const DeviceRefPtr &device); |
| 142 | |
Wade Guthrie | 60a3706 | 2013-04-02 11:39:09 -0700 | [diff] [blame] | 143 | // Clobbers persisted notion of |wifi_provider| with data from |
| 144 | // |wifi_provider|. Returns true if |wifi_provider| was found and updated, |
| 145 | // false otherwise. The base implementation always returns false -- currently |
| 146 | // wifi_provider is persisted only in DefaultProfile. |
| 147 | virtual bool UpdateWiFiProvider(const WiFiProvider &wifi_provider); |
| 148 | |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 149 | // Write all in-memory state to disk via |storage_|. |
| 150 | virtual bool Save(); |
Chris Masone | 9d77993 | 2011-08-25 16:33:41 -0700 | [diff] [blame] | 151 | |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 152 | // Parses a profile identifier. There're two acceptable forms of the |raw| |
| 153 | // identifier: "identifier" and "~user/identifier". Both "user" and |
| 154 | // "identifier" must be suitable for use in a D-Bus object path. Returns true |
| 155 | // on success. |
| 156 | static bool ParseIdentifier(const std::string &raw, Identifier *parsed); |
| 157 | |
Paul Stewart | f3eced9 | 2013-04-17 12:18:22 -0700 | [diff] [blame] | 158 | // Returns the composite string identifier for a profile, as would have |
| 159 | // been used in an argument to Manager::PushProfile() in creating this |
| 160 | // profile. It returns a string in the form "identifier", or |
| 161 | // "~user/identifier" depending on whether this profile has a user |
| 162 | // component. |
| 163 | static std::string IdentifierToString(const Identifier &name); |
| 164 | |
Paul Stewart | 78af94c | 2013-04-17 16:02:06 -0700 | [diff] [blame] | 165 | // Load a list of user profile identifiers from a cache file |path|. |
| 166 | // The profiles themselves are not loaded. |
| 167 | static std::vector<Identifier> LoadUserProfileList( |
| 168 | const base::FilePath &path); |
| 169 | |
| 170 | // Save a list of user profile identifiers |profiles| to a cache file |path|. |
| 171 | // Returns true if successful, false otherwise. |
| 172 | static bool SaveUserProfileList(const base::FilePath &path, |
| 173 | const std::vector<ProfileRefPtr> &profiles); |
| 174 | |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 175 | // Returns whether |name| matches this Profile's |name_|. |
| 176 | virtual bool MatchesIdentifier(const Identifier &name) const; |
Darin Petkov | a476682 | 2011-07-07 10:42:22 -0700 | [diff] [blame] | 177 | |
Paul Stewart | d0a3b81 | 2012-03-28 22:48:22 -0700 | [diff] [blame] | 178 | // Returns the username component of the profile identifier. |
| 179 | const std::string &GetUser() const { return name_.user; } |
| 180 | |
Paul Stewart | f3eced9 | 2013-04-17 12:18:22 -0700 | [diff] [blame] | 181 | // Returns the user_hash component of the profile identifier. |
| 182 | const std::string &GetUserHash() const { return name_.user_hash; } |
| 183 | |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 184 | // Returns a read-only copy of the backing storage of the profile. |
Paul Stewart | 6681533 | 2012-04-09 18:09:36 -0700 | [diff] [blame] | 185 | virtual const StoreInterface *GetConstStorage() const { |
| 186 | return storage_.get(); |
| 187 | } |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 188 | |
Chris Masone | 88cbd5f | 2011-07-03 14:30:04 -0700 | [diff] [blame] | 189 | protected: |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 190 | // Protected getters |
Thieu Le | 5133b71 | 2013-02-19 14:47:21 -0800 | [diff] [blame] | 191 | Metrics *metrics() const { return metrics_; } |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 192 | Manager *manager() const { return manager_; } |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 193 | StoreInterface *storage() { return storage_.get(); } |
Chris Masone | 7aa5f90 | 2011-07-11 11:13:35 -0700 | [diff] [blame] | 194 | |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 195 | // Sets |path| to the persistent store file path for a profile identified by |
| 196 | // |name_|. Returns true on success, and false if unable to determine an |
| 197 | // appropriate file location. |name_| must be a valid identifier, |
| 198 | // possibly parsed and validated through Profile::ParseIdentifier. |
| 199 | // |
| 200 | // In the default implementation, |name_.user| cannot be empty, because |
| 201 | // all regular profiles should be associated with a user. |
Paul Stewart | 5ad1606 | 2013-02-21 18:10:48 -0800 | [diff] [blame] | 202 | virtual bool GetStoragePath(base::FilePath *path); |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 203 | |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 204 | private: |
Chris Masone | 88cbd5f | 2011-07-03 14:30:04 -0700 | [diff] [blame] | 205 | friend class ProfileAdaptorInterface; |
Paul Stewart | 7522551 | 2012-01-26 22:51:33 -0800 | [diff] [blame] | 206 | FRIEND_TEST(ProfileTest, DeleteEntry); |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 207 | FRIEND_TEST(ProfileTest, GetStoragePath); |
Darin Petkov | a476682 | 2011-07-07 10:42:22 -0700 | [diff] [blame] | 208 | FRIEND_TEST(ProfileTest, IsValidIdentifierToken); |
| 209 | |
| 210 | static bool IsValidIdentifierToken(const std::string &token); |
Chris Masone | 88cbd5f | 2011-07-03 14:30:04 -0700 | [diff] [blame] | 211 | |
mukesh agrawal | bebf1b8 | 2013-04-23 15:06:33 -0700 | [diff] [blame] | 212 | void HelpRegisterConstDerivedStrings( |
mukesh agrawal | ffa3d04 | 2011-10-06 15:26:10 -0700 | [diff] [blame] | 213 | const std::string &name, |
mukesh agrawal | bebf1b8 | 2013-04-23 15:06:33 -0700 | [diff] [blame] | 214 | Strings(Profile::*get)(Error *error)); |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 215 | |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 216 | // Data members shared with subclasses via getter/setters above in the |
| 217 | // protected: section |
Thieu Le | 5133b71 | 2013-02-19 14:47:21 -0800 | [diff] [blame] | 218 | Metrics *metrics_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 219 | Manager *manager_; |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 220 | |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 221 | // Shared with |adaptor_| via public getter. |
Paul Stewart | ac4ac00 | 2011-08-26 12:04:26 -0700 | [diff] [blame] | 222 | PropertyStore store_; |
Chris Masone | 7df0c67 | 2011-07-15 10:24:54 -0700 | [diff] [blame] | 223 | |
| 224 | // Properties to be gotten via PropertyStore calls. |
| 225 | Identifier name_; |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 226 | |
mukesh agrawal | 0a59a5a | 2014-04-24 19:10:46 -0700 | [diff] [blame] | 227 | // Path to user profile directory. |
| 228 | const base::FilePath storage_path_; |
Chris Masone | 2ae797d | 2011-08-23 20:41:00 -0700 | [diff] [blame] | 229 | |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 230 | // Allows this profile to be backed with on-disk storage. |
| 231 | scoped_ptr<StoreInterface> storage_; |
| 232 | |
Chris Masone | 7df0c67 | 2011-07-15 10:24:54 -0700 | [diff] [blame] | 233 | scoped_ptr<ProfileAdaptorInterface> adaptor_; |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 234 | |
Chris Masone | 88cbd5f | 2011-07-03 14:30:04 -0700 | [diff] [blame] | 235 | DISALLOW_COPY_AND_ASSIGN(Profile); |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 236 | }; |
| 237 | |
| 238 | } // namespace shill |
| 239 | |
Wade Guthrie | 60a3706 | 2013-04-02 11:39:09 -0700 | [diff] [blame] | 240 | #endif // SHILL_PROFILE_H_ |