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