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