Darin Petkov | e7c6ad3 | 2012-06-29 10:22:09 +0200 | [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 | #include "shill/profile.h" |
| 6 | |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 7 | #include <set> |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 8 | #include <string> |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 9 | #include <vector> |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 10 | |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 11 | #include <base/file_path.h> |
Paul Stewart | e73d05c | 2012-03-29 16:26:05 -0700 | [diff] [blame] | 12 | #include <base/file_util.h> |
Eric Shienbrood | 3e20a23 | 2012-02-16 11:35:56 -0500 | [diff] [blame] | 13 | #include <base/stl_util.h> |
Darin Petkov | a476682 | 2011-07-07 10:42:22 -0700 | [diff] [blame] | 14 | #include <base/string_util.h> |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 15 | #include <base/stringprintf.h> |
Chris Masone | 88cbd5f | 2011-07-03 14:30:04 -0700 | [diff] [blame] | 16 | #include <chromeos/dbus/service_constants.h> |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 17 | |
| 18 | #include "shill/adaptor_interfaces.h" |
| 19 | #include "shill/control_interface.h" |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 20 | #include "shill/key_file_store.h" |
Christopher Wiley | b691efd | 2012-08-09 13:51:51 -0700 | [diff] [blame] | 21 | #include "shill/logging.h" |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 22 | #include "shill/manager.h" |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 23 | #include "shill/property_accessor.h" |
Chris Masone | 7aa5f90 | 2011-07-11 11:13:35 -0700 | [diff] [blame] | 24 | #include "shill/service.h" |
Chris Masone | 9d77993 | 2011-08-25 16:33:41 -0700 | [diff] [blame] | 25 | #include "shill/store_interface.h" |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 26 | |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 27 | using std::set; |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 28 | using std::string; |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 29 | using std::vector; |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 30 | |
| 31 | namespace shill { |
Darin Petkov | a476682 | 2011-07-07 10:42:22 -0700 | [diff] [blame] | 32 | |
Darin Petkov | a476682 | 2011-07-07 10:42:22 -0700 | [diff] [blame] | 33 | Profile::Profile(ControlInterface *control_interface, |
Chris Masone | 7df0c67 | 2011-07-15 10:24:54 -0700 | [diff] [blame] | 34 | Manager *manager, |
| 35 | const Identifier &name, |
Chris Masone | 2ae797d | 2011-08-23 20:41:00 -0700 | [diff] [blame] | 36 | const string &user_storage_format, |
Chris Masone | 7df0c67 | 2011-07-15 10:24:54 -0700 | [diff] [blame] | 37 | bool connect_to_rpc) |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 38 | : manager_(manager), |
Chris Masone | 7df0c67 | 2011-07-15 10:24:54 -0700 | [diff] [blame] | 39 | name_(name), |
Chris Masone | 2ae797d | 2011-08-23 20:41:00 -0700 | [diff] [blame] | 40 | storage_format_(user_storage_format) { |
Chris Masone | 7df0c67 | 2011-07-15 10:24:54 -0700 | [diff] [blame] | 41 | if (connect_to_rpc) |
| 42 | adaptor_.reset(control_interface->CreateProfileAdaptor(this)); |
| 43 | |
Chris Masone | 88cbd5f | 2011-07-03 14:30:04 -0700 | [diff] [blame] | 44 | // flimflam::kCheckPortalListProperty: Registered in DefaultProfile |
| 45 | // flimflam::kCountryProperty: Registered in DefaultProfile |
Chris Masone | 7df0c67 | 2011-07-15 10:24:54 -0700 | [diff] [blame] | 46 | store_.RegisterConstString(flimflam::kNameProperty, &name_.identifier); |
Chris Masone | 88cbd5f | 2011-07-03 14:30:04 -0700 | [diff] [blame] | 47 | |
| 48 | // flimflam::kOfflineModeProperty: Registered in DefaultProfile |
| 49 | // flimflam::kPortalURLProperty: Registered in DefaultProfile |
| 50 | |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 51 | HelpRegisterDerivedStrings(flimflam::kServicesProperty, |
| 52 | &Profile::EnumerateAvailableServices, |
| 53 | NULL); |
Chris Masone | 7df0c67 | 2011-07-15 10:24:54 -0700 | [diff] [blame] | 54 | HelpRegisterDerivedStrings(flimflam::kEntriesProperty, |
| 55 | &Profile::EnumerateEntries, |
| 56 | NULL); |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 57 | } |
| 58 | |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 59 | Profile::~Profile() {} |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 60 | |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 61 | bool Profile::InitStorage(GLib *glib, InitStorageOption storage_option, |
| 62 | Error *error) { |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 63 | FilePath final_path; |
| 64 | if (!GetStoragePath(&final_path)) { |
Paul Stewart | be00517 | 2011-11-02 18:10:29 -0700 | [diff] [blame] | 65 | Error::PopulateAndLog(error, Error::kInvalidArguments, |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 66 | base::StringPrintf("Could not set up profile storage for %s:%s", |
Paul Stewart | be00517 | 2011-11-02 18:10:29 -0700 | [diff] [blame] | 67 | name_.user.c_str(), name_.identifier.c_str())); |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 68 | return false; |
| 69 | } |
| 70 | scoped_ptr<KeyFileStore> storage(new KeyFileStore(glib)); |
| 71 | storage->set_path(final_path); |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 72 | bool already_exists = storage->IsNonEmpty(); |
| 73 | if (!already_exists && storage_option != kCreateNew && |
| 74 | storage_option != kCreateOrOpenExisting) { |
Paul Stewart | be00517 | 2011-11-02 18:10:29 -0700 | [diff] [blame] | 75 | Error::PopulateAndLog(error, Error::kNotFound, |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 76 | base::StringPrintf("Profile storage for %s:%s does not already exist", |
Paul Stewart | be00517 | 2011-11-02 18:10:29 -0700 | [diff] [blame] | 77 | name_.user.c_str(), name_.identifier.c_str())); |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 78 | return false; |
| 79 | } else if (already_exists && storage_option != kOpenExisting && |
| 80 | storage_option != kCreateOrOpenExisting) { |
Paul Stewart | be00517 | 2011-11-02 18:10:29 -0700 | [diff] [blame] | 81 | Error::PopulateAndLog(error, Error::kAlreadyExists, |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 82 | base::StringPrintf("Profile storage for %s:%s already exists", |
Paul Stewart | be00517 | 2011-11-02 18:10:29 -0700 | [diff] [blame] | 83 | name_.user.c_str(), name_.identifier.c_str())); |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 84 | return false; |
| 85 | } |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 86 | if (!storage->Open()) { |
Paul Stewart | be00517 | 2011-11-02 18:10:29 -0700 | [diff] [blame] | 87 | Error::PopulateAndLog(error, Error::kInternalError, |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 88 | base::StringPrintf("Could not open profile storage for %s:%s", |
Paul Stewart | be00517 | 2011-11-02 18:10:29 -0700 | [diff] [blame] | 89 | name_.user.c_str(), name_.identifier.c_str())); |
Paul Stewart | 2ebc16d | 2012-08-23 10:38:39 -0700 | [diff] [blame] | 90 | if (already_exists) { |
| 91 | // The profile contents is corrupt, or we do not have access to |
| 92 | // this file. Move this file out of the way so a future open attempt |
| 93 | // will succeed, assuming the failure reason was the former. |
| 94 | storage->MarkAsCorrupted(); |
| 95 | } |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 96 | return false; |
| 97 | } |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 98 | if (!already_exists) { |
| 99 | // Add a descriptive header to the profile so even if nothing is stored |
| 100 | // to it, it still has some content. Completely empty keyfiles are not |
| 101 | // valid for reading. |
| 102 | storage->SetHeader( |
| 103 | base::StringPrintf("Profile %s:%s", name_.user.c_str(), |
| 104 | name_.identifier.c_str())); |
| 105 | } |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 106 | set_storage(storage.release()); |
| 107 | return true; |
| 108 | } |
| 109 | |
Paul Stewart | e73d05c | 2012-03-29 16:26:05 -0700 | [diff] [blame] | 110 | bool Profile::RemoveStorage(GLib *glib, Error *error) { |
| 111 | FilePath path; |
| 112 | |
| 113 | CHECK(!storage_.get()); |
| 114 | |
| 115 | if (!GetStoragePath(&path)) { |
| 116 | Error::PopulateAndLog( |
| 117 | error, Error::kInvalidArguments, |
| 118 | base::StringPrintf("Could get the storage path for %s:%s", |
| 119 | name_.user.c_str(), name_.identifier.c_str())); |
| 120 | return false; |
| 121 | } |
| 122 | |
| 123 | if (!file_util::Delete(path, false)) { |
| 124 | Error::PopulateAndLog( |
| 125 | error, Error::kOperationFailed, |
| 126 | base::StringPrintf("Could not remove path %s", path.value().c_str())); |
| 127 | return false; |
| 128 | } |
| 129 | |
| 130 | return true; |
| 131 | } |
| 132 | |
Chris Masone | 7df0c67 | 2011-07-15 10:24:54 -0700 | [diff] [blame] | 133 | string Profile::GetFriendlyName() { |
| 134 | return (name_.user.empty() ? "" : name_.user + "/") + name_.identifier; |
| 135 | } |
| 136 | |
| 137 | string Profile::GetRpcIdentifier() { |
Paul Stewart | 19c871d | 2011-12-15 16:10:13 -0800 | [diff] [blame] | 138 | if (!adaptor_.get()) { |
| 139 | // NB: This condition happens in unit tests. |
| 140 | return string(); |
| 141 | } |
Chris Masone | 7df0c67 | 2011-07-15 10:24:54 -0700 | [diff] [blame] | 142 | return adaptor_->GetRpcIdentifier(); |
| 143 | } |
| 144 | |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 145 | void Profile::set_storage(StoreInterface *storage) { |
| 146 | storage_.reset(storage); |
| 147 | } |
| 148 | |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 149 | bool Profile::AdoptService(const ServiceRefPtr &service) { |
Paul Stewart | 451aa7f | 2012-04-11 19:07:58 -0700 | [diff] [blame] | 150 | if (service->profile() == this) { |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 151 | return false; |
Paul Stewart | 451aa7f | 2012-04-11 19:07:58 -0700 | [diff] [blame] | 152 | } |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 153 | service->set_profile(this); |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 154 | return service->Save(storage_.get()) && storage_->Flush(); |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 155 | } |
| 156 | |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 157 | bool Profile::AbandonService(const ServiceRefPtr &service) { |
| 158 | if (service->profile() == this) |
| 159 | service->set_profile(NULL); |
| 160 | return storage_->DeleteGroup(service->GetStorageIdentifier()) && |
| 161 | storage_->Flush(); |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 162 | } |
| 163 | |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 164 | bool Profile::UpdateService(const ServiceRefPtr &service) { |
| 165 | return service->Save(storage_.get()) && storage_->Flush(); |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 166 | } |
| 167 | |
Paul Stewart | bba6a5b | 2011-11-02 18:45:59 -0700 | [diff] [blame] | 168 | bool Profile::ConfigureService(const ServiceRefPtr &service) { |
| 169 | if (!ContainsService(service)) |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 170 | return false; |
| 171 | service->set_profile(this); |
| 172 | return service->Load(storage_.get()); |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 173 | } |
| 174 | |
Paul Stewart | a41e38d | 2011-11-11 07:47:29 -0800 | [diff] [blame] | 175 | bool Profile::ConfigureDevice(const DeviceRefPtr &device) { |
| 176 | return device->Load(storage_.get()); |
| 177 | } |
| 178 | |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 179 | bool Profile::ContainsService(const ServiceConstRefPtr &service) { |
Paul Stewart | bba6a5b | 2011-11-02 18:45:59 -0700 | [diff] [blame] | 180 | return service->IsLoadableFrom(storage_.get()); |
Chris Masone | 7aa5f90 | 2011-07-11 11:13:35 -0700 | [diff] [blame] | 181 | } |
| 182 | |
Paul Stewart | 7522551 | 2012-01-26 22:51:33 -0800 | [diff] [blame] | 183 | void Profile::DeleteEntry(const std::string &entry_name, Error *error) { |
| 184 | if (!storage_->ContainsGroup(entry_name)) { |
| 185 | Error::PopulateAndLog(error, Error::kNotFound, |
| 186 | base::StringPrintf("Entry %s does not exist in profile", |
| 187 | entry_name.c_str())); |
| 188 | return; |
| 189 | } |
| 190 | if (!manager_->HandleProfileEntryDeletion(this, entry_name)) { |
| 191 | // If HandleProfileEntryDeletion() returns succeeds, DeleteGroup() |
| 192 | // has already been called when AbandonService was called. |
| 193 | // Otherwise, we need to delete the group ourselves. |
| 194 | storage_->DeleteGroup(entry_name); |
| 195 | } |
Paul Stewart | 0756db9 | 2012-01-27 08:34:47 -0800 | [diff] [blame] | 196 | Save(); |
| 197 | } |
| 198 | |
| 199 | ServiceRefPtr Profile::GetServiceFromEntry(const std::string &entry_name, |
| 200 | Error *error) { |
| 201 | return manager_->GetServiceWithStorageIdentifier(this, entry_name, error); |
Paul Stewart | 7522551 | 2012-01-26 22:51:33 -0800 | [diff] [blame] | 202 | } |
| 203 | |
Paul Stewart | a41e38d | 2011-11-11 07:47:29 -0800 | [diff] [blame] | 204 | bool Profile::IsValidIdentifierToken(const string &token) { |
Darin Petkov | a476682 | 2011-07-07 10:42:22 -0700 | [diff] [blame] | 205 | if (token.empty()) { |
| 206 | return false; |
| 207 | } |
| 208 | for (string::const_iterator it = token.begin(); it != token.end(); ++it) { |
| 209 | if (!IsAsciiAlpha(*it) && !IsAsciiDigit(*it)) { |
| 210 | return false; |
| 211 | } |
| 212 | } |
| 213 | return true; |
| 214 | } |
| 215 | |
| 216 | bool Profile::ParseIdentifier(const string &raw, Identifier *parsed) { |
| 217 | if (raw.empty()) { |
| 218 | return false; |
| 219 | } |
| 220 | if (raw[0] == '~') { |
| 221 | // Format: "~user/identifier". |
| 222 | size_t slash = raw.find('/'); |
| 223 | if (slash == string::npos) { |
| 224 | return false; |
| 225 | } |
| 226 | string user(raw.begin() + 1, raw.begin() + slash); |
| 227 | string identifier(raw.begin() + slash + 1, raw.end()); |
| 228 | if (!IsValidIdentifierToken(user) || !IsValidIdentifierToken(identifier)) { |
| 229 | return false; |
| 230 | } |
| 231 | parsed->user = user; |
| 232 | parsed->identifier = identifier; |
| 233 | return true; |
| 234 | } |
| 235 | |
| 236 | // Format: "identifier". |
| 237 | if (!IsValidIdentifierToken(raw)) { |
| 238 | return false; |
| 239 | } |
| 240 | parsed->user = ""; |
| 241 | parsed->identifier = raw; |
| 242 | return true; |
| 243 | } |
| 244 | |
Paul Stewart | 5dc40aa | 2011-10-28 19:43:43 -0700 | [diff] [blame] | 245 | bool Profile::MatchesIdentifier(const Identifier &name) const { |
| 246 | return name.user == name_.user && name.identifier == name_.identifier; |
| 247 | } |
| 248 | |
Chris Masone | b9c0059 | 2011-10-06 13:10:39 -0700 | [diff] [blame] | 249 | bool Profile::Save() { |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 250 | return storage_->Flush(); |
Chris Masone | 9d77993 | 2011-08-25 16:33:41 -0700 | [diff] [blame] | 251 | } |
| 252 | |
Chris Masone | 2ae797d | 2011-08-23 20:41:00 -0700 | [diff] [blame] | 253 | bool Profile::GetStoragePath(FilePath *path) { |
| 254 | if (name_.user.empty()) { |
| 255 | LOG(ERROR) << "Non-default profiles cannot be stored globally."; |
| 256 | return false; |
| 257 | } |
| 258 | FilePath dir(base::StringPrintf(storage_format_.c_str(), name_.user.c_str())); |
Darin Petkov | a476682 | 2011-07-07 10:42:22 -0700 | [diff] [blame] | 259 | // TODO(petkov): Validate the directory permissions, etc. |
| 260 | *path = dir.Append(base::StringPrintf("%s.profile", |
Chris Masone | 2ae797d | 2011-08-23 20:41:00 -0700 | [diff] [blame] | 261 | name_.identifier.c_str())); |
Darin Petkov | a476682 | 2011-07-07 10:42:22 -0700 | [diff] [blame] | 262 | return true; |
| 263 | } |
| 264 | |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 265 | vector<string> Profile::EnumerateAvailableServices(Error *error) { |
Paul Stewart | 1b25314 | 2012-01-26 14:05:52 -0800 | [diff] [blame] | 266 | // We should return the Manager's service list if this is the active profile. |
| 267 | if (manager_->IsActiveProfile(this)) { |
| 268 | return manager_->EnumerateAvailableServices(error); |
| 269 | } else { |
| 270 | return vector<string>(); |
| 271 | } |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 272 | } |
| 273 | |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 274 | vector<string> Profile::EnumerateEntries(Error */*error*/) { |
Chris Masone | 6515aab | 2011-10-12 16:19:09 -0700 | [diff] [blame] | 275 | set<string> groups(storage_->GetGroups()); |
Paul Stewart | 1b25314 | 2012-01-26 14:05:52 -0800 | [diff] [blame] | 276 | vector<string> service_groups; |
| 277 | |
| 278 | // Filter this list down to only entries that correspond |
| 279 | // to a technology. (wifi_*, etc) |
| 280 | for (set<string>::iterator it = groups.begin(); |
| 281 | it != groups.end(); ++it) { |
| 282 | if (Technology::IdentifierFromStorageGroup(*it) != Technology::kUnknown) |
| 283 | service_groups.push_back(*it); |
| 284 | } |
| 285 | |
| 286 | return service_groups; |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 287 | } |
| 288 | |
Darin Petkov | e7c6ad3 | 2012-06-29 10:22:09 +0200 | [diff] [blame] | 289 | bool Profile::UpdateDevice(const DeviceRefPtr &device) { |
| 290 | return false; |
| 291 | } |
| 292 | |
mukesh agrawal | ffa3d04 | 2011-10-06 15:26:10 -0700 | [diff] [blame] | 293 | void Profile::HelpRegisterDerivedStrings( |
| 294 | const string &name, |
Gaurav Shah | 1b7a616 | 2011-11-09 11:41:01 -0800 | [diff] [blame] | 295 | Strings(Profile::*get)(Error *), |
mukesh agrawal | ffa3d04 | 2011-10-06 15:26:10 -0700 | [diff] [blame] | 296 | void(Profile::*set)(const Strings&, Error *)) { |
Chris Masone | 6791a43 | 2011-07-12 13:23:19 -0700 | [diff] [blame] | 297 | store_.RegisterDerivedStrings( |
| 298 | name, |
| 299 | StringsAccessor(new CustomAccessor<Profile, Strings>(this, get, set))); |
| 300 | } |
| 301 | |
Chris Masone | 52cd19b | 2011-06-29 17:23:04 -0700 | [diff] [blame] | 302 | } // namespace shill |