components/sync_driver/sync_prefs.cc

   1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
   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 "components/sync_driver/sync_prefs.h"
   6
   7 #include "base/logging.h"
   8 #include "base/prefs/pref_member.h"
   9 #include "base/prefs/pref_service.h"
  10 #include "base/strings/string_number_conversions.h"
  11 #include "base/values.h"
  12 #include "build/build_config.h"
  13 #include "components/pref_registry/pref_registry_syncable.h"
  14 #include "components/sync_driver/pref_names.h"
  15
  16 namespace sync_driver {
  17
  18 SyncPrefObserver::~SyncPrefObserver() {}
  19
  20 SyncPrefs::SyncPrefs(PrefService* pref_service) : pref_service_(pref_service) {
  21   DCHECK(pref_service);
  22   RegisterPrefGroups();
  23   // Watch the preference that indicates sync is managed so we can take
  24   // appropriate action.
  25   pref_sync_managed_.Init(
  26       prefs::kSyncManaged,
  27       pref_service_,
  28       base::Bind(&SyncPrefs::OnSyncManagedPrefChanged, base::Unretained(this)));
  29 }
  30
  31 SyncPrefs::SyncPrefs() : pref_service_(NULL) {}
  32
  33 SyncPrefs::~SyncPrefs() { DCHECK(CalledOnValidThread()); }
  34
  35 // static
  36 void SyncPrefs::RegisterProfilePrefs(
  37     user_prefs::PrefRegistrySyncable* registry) {
  38   registry->RegisterBooleanPref(
  39       prefs::kSyncHasSetupCompleted,
  40       false,
  41       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
  42   registry->RegisterBooleanPref(
  43       prefs::kSyncSuppressStart,
  44       false,
  45       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
  46   registry->RegisterInt64Pref(
  47       prefs::kSyncLastSyncedTime,
  48       0,
  49       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
  50   registry->RegisterInt64Pref(
  51       prefs::kSyncFirstSyncTime,
  52       0,
  53       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
  54
  55   // All datatypes are on by default, but this gets set explicitly
  56   // when you configure sync (when turning it on), in
  57   // ProfileSyncService::OnUserChoseDatatypes.
  58   registry->RegisterBooleanPref(
  59       prefs::kSyncKeepEverythingSynced,
  60       true,
  61       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
  62
  63   syncer::ModelTypeSet user_types = syncer::UserTypes();
  64
  65   // Include proxy types as well, as they can be individually selected,
  66   // although they don't have sync representations.
  67   user_types.PutAll(syncer::ProxyTypes());
  68
  69   // Treat bookmarks and device info specially.
  70   RegisterDataTypePreferredPref(registry, syncer::BOOKMARKS, true);
  71   RegisterDataTypePreferredPref(registry, syncer::DEVICE_INFO, true);
  72   user_types.Remove(syncer::BOOKMARKS);
  73   user_types.Remove(syncer::DEVICE_INFO);
  74
  75   // These two prefs are set from sync experiment to enable enhanced bookmarks.
  76   registry->RegisterIntegerPref(
  77       prefs::kEnhancedBookmarksExperimentEnabled,
  78       0,
  79       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
  80
  81   registry->RegisterStringPref(
  82       prefs::kEnhancedBookmarksExtensionId,
  83       std::string(),
  84       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
  85
  86   // All types are set to off by default, which forces a configuration to
  87   // explicitly enable them. GetPreferredTypes() will ensure that any new
  88   // implicit types are enabled when their pref group is, or via
  89   // KeepEverythingSynced.
  90   for (syncer::ModelTypeSet::Iterator it = user_types.First(); it.Good();
  91        it.Inc()) {
  92     RegisterDataTypePreferredPref(registry, it.Get(), false);
  93   }
  94
  95   registry->RegisterBooleanPref(
  96       prefs::kSyncManaged,
  97       false,
  98       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
  99   registry->RegisterStringPref(
 100       prefs::kSyncEncryptionBootstrapToken,
 101       std::string(),
 102       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
 103   registry->RegisterStringPref(
 104       prefs::kSyncKeystoreEncryptionBootstrapToken,
 105       std::string(),
 106       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
 107 #if defined(OS_CHROMEOS)
 108   registry->RegisterStringPref(
 109       prefs::kSyncSpareBootstrapToken,
 110       "",
 111       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
 112 #endif
 113
 114   registry->RegisterBooleanPref(
 115       prefs::kSyncHasAuthError,
 116       false,
 117       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
 118
 119   registry->RegisterStringPref(
 120       prefs::kSyncSessionsGUID,
 121       std::string(),
 122       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
 123
 124   // We will start prompting people about new data types after the launch of
 125   // SESSIONS - all previously launched data types are treated as if they are
 126   // already acknowledged.
 127   syncer::ModelTypeSet model_set;
 128   model_set.Put(syncer::BOOKMARKS);
 129   model_set.Put(syncer::PREFERENCES);
 130   model_set.Put(syncer::PASSWORDS);
 131   model_set.Put(syncer::AUTOFILL_PROFILE);
 132   model_set.Put(syncer::AUTOFILL);
 133   model_set.Put(syncer::THEMES);
 134   model_set.Put(syncer::EXTENSIONS);
 135   model_set.Put(syncer::NIGORI);
 136   model_set.Put(syncer::SEARCH_ENGINES);
 137   model_set.Put(syncer::APPS);
 138   model_set.Put(syncer::APP_LIST);
 139   model_set.Put(syncer::TYPED_URLS);
 140   model_set.Put(syncer::SESSIONS);
 141   model_set.Put(syncer::ARTICLES);
 142   model_set.Put(syncer::WIFI_CREDENTIALS);
 143   registry->RegisterListPref(prefs::kSyncAcknowledgedSyncTypes,
 144                              syncer::ModelTypeSetToValue(model_set),
 145                              user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
 146
 147   registry->RegisterIntegerPref(
 148       prefs::kSyncRemainingRollbackTries, 0,
 149       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
 150 }
 151
 152 void SyncPrefs::AddSyncPrefObserver(SyncPrefObserver* sync_pref_observer) {
 153   DCHECK(CalledOnValidThread());
 154   sync_pref_observers_.AddObserver(sync_pref_observer);
 155 }
 156
 157 void SyncPrefs::RemoveSyncPrefObserver(SyncPrefObserver* sync_pref_observer) {
 158   DCHECK(CalledOnValidThread());
 159   sync_pref_observers_.RemoveObserver(sync_pref_observer);
 160 }
 161
 162 void SyncPrefs::ClearPreferences() {
 163   DCHECK(CalledOnValidThread());
 164   pref_service_->ClearPref(prefs::kSyncLastSyncedTime);
 165   pref_service_->ClearPref(prefs::kSyncHasSetupCompleted);
 166   pref_service_->ClearPref(prefs::kSyncEncryptionBootstrapToken);
 167   pref_service_->ClearPref(prefs::kSyncKeystoreEncryptionBootstrapToken);
 168
 169   // TODO(nick): The current behavior does not clear
 170   // e.g. prefs::kSyncBookmarks.  Is that really what we want?
 171 }
 172
 173 bool SyncPrefs::HasSyncSetupCompleted() const {
 174   DCHECK(CalledOnValidThread());
 175   return pref_service_->GetBoolean(prefs::kSyncHasSetupCompleted);
 176 }
 177
 178 void SyncPrefs::SetSyncSetupCompleted() {
 179   DCHECK(CalledOnValidThread());
 180   pref_service_->SetBoolean(prefs::kSyncHasSetupCompleted, true);
 181   SetStartSuppressed(false);
 182 }
 183
 184 bool SyncPrefs::SyncHasAuthError() const {
 185   DCHECK(CalledOnValidThread());
 186   return pref_service_->GetBoolean(prefs::kSyncHasAuthError);
 187 }
 188
 189 void SyncPrefs::SetSyncAuthError(bool error) {
 190   DCHECK(CalledOnValidThread());
 191   pref_service_->SetBoolean(prefs::kSyncHasAuthError, error);
 192 }
 193
 194 bool SyncPrefs::IsStartSuppressed() const {
 195   DCHECK(CalledOnValidThread());
 196   return pref_service_->GetBoolean(prefs::kSyncSuppressStart);
 197 }
 198
 199 void SyncPrefs::SetStartSuppressed(bool is_suppressed) {
 200   DCHECK(CalledOnValidThread());
 201   pref_service_->SetBoolean(prefs::kSyncSuppressStart, is_suppressed);
 202 }
 203
 204 base::Time SyncPrefs::GetLastSyncedTime() const {
 205   DCHECK(CalledOnValidThread());
 206   return base::Time::FromInternalValue(
 207       pref_service_->GetInt64(prefs::kSyncLastSyncedTime));
 208 }
 209
 210 void SyncPrefs::SetLastSyncedTime(base::Time time) {
 211   DCHECK(CalledOnValidThread());
 212   pref_service_->SetInt64(prefs::kSyncLastSyncedTime, time.ToInternalValue());
 213 }
 214
 215 bool SyncPrefs::HasKeepEverythingSynced() const {
 216   DCHECK(CalledOnValidThread());
 217   return pref_service_->GetBoolean(prefs::kSyncKeepEverythingSynced);
 218 }
 219
 220 void SyncPrefs::SetKeepEverythingSynced(bool keep_everything_synced) {
 221   DCHECK(CalledOnValidThread());
 222   pref_service_->SetBoolean(prefs::kSyncKeepEverythingSynced,
 223                             keep_everything_synced);
 224 }
 225
 226 syncer::ModelTypeSet SyncPrefs::GetPreferredDataTypes(
 227     syncer::ModelTypeSet registered_types) const {
 228   DCHECK(CalledOnValidThread());
 229
 230   if (pref_service_->GetBoolean(prefs::kSyncKeepEverythingSynced)) {
 231     return registered_types;
 232   }
 233
 234   syncer::ModelTypeSet preferred_types;
 235   for (syncer::ModelTypeSet::Iterator it = registered_types.First(); it.Good();
 236        it.Inc()) {
 237     if (GetDataTypePreferred(it.Get())) {
 238       preferred_types.Put(it.Get());
 239     }
 240   }
 241   return ResolvePrefGroups(registered_types, preferred_types);
 242 }
 243
 244 void SyncPrefs::SetPreferredDataTypes(syncer::ModelTypeSet registered_types,
 245                                       syncer::ModelTypeSet preferred_types) {
 246   DCHECK(CalledOnValidThread());
 247   DCHECK(registered_types.HasAll(preferred_types));
 248   preferred_types = ResolvePrefGroups(registered_types, preferred_types);
 249   for (syncer::ModelTypeSet::Iterator i = registered_types.First(); i.Good();
 250        i.Inc()) {
 251     SetDataTypePreferred(i.Get(), preferred_types.Has(i.Get()));
 252   }
 253 }
 254
 255 bool SyncPrefs::IsManaged() const {
 256   DCHECK(CalledOnValidThread());
 257   return pref_service_->GetBoolean(prefs::kSyncManaged);
 258 }
 259
 260 std::string SyncPrefs::GetEncryptionBootstrapToken() const {
 261   DCHECK(CalledOnValidThread());
 262   return pref_service_->GetString(prefs::kSyncEncryptionBootstrapToken);
 263 }
 264
 265 void SyncPrefs::SetEncryptionBootstrapToken(const std::string& token) {
 266   DCHECK(CalledOnValidThread());
 267   pref_service_->SetString(prefs::kSyncEncryptionBootstrapToken, token);
 268 }
 269
 270 std::string SyncPrefs::GetKeystoreEncryptionBootstrapToken() const {
 271   DCHECK(CalledOnValidThread());
 272   return pref_service_->GetString(prefs::kSyncKeystoreEncryptionBootstrapToken);
 273 }
 274
 275 void SyncPrefs::SetKeystoreEncryptionBootstrapToken(const std::string& token) {
 276   DCHECK(CalledOnValidThread());
 277   pref_service_->SetString(prefs::kSyncKeystoreEncryptionBootstrapToken, token);
 278 }
 279
 280 std::string SyncPrefs::GetSyncSessionsGUID() const {
 281   DCHECK(CalledOnValidThread());
 282   return pref_service_->GetString(prefs::kSyncSessionsGUID);
 283 }
 284
 285 void SyncPrefs::SetSyncSessionsGUID(const std::string& guid) {
 286   DCHECK(CalledOnValidThread());
 287   pref_service_->SetString(prefs::kSyncSessionsGUID, guid);
 288 }
 289
 290 // static
 291 const char* SyncPrefs::GetPrefNameForDataType(syncer::ModelType data_type) {
 292   switch (data_type) {
 293     case syncer::BOOKMARKS:
 294       return prefs::kSyncBookmarks;
 295     case syncer::PASSWORDS:
 296       return prefs::kSyncPasswords;
 297     case syncer::PREFERENCES:
 298       return prefs::kSyncPreferences;
 299     case syncer::AUTOFILL:
 300       return prefs::kSyncAutofill;
 301     case syncer::AUTOFILL_PROFILE:
 302       return prefs::kSyncAutofillProfile;
 303     case syncer::THEMES:
 304       return prefs::kSyncThemes;
 305     case syncer::TYPED_URLS:
 306       return prefs::kSyncTypedUrls;
 307     case syncer::EXTENSION_SETTINGS:
 308       return prefs::kSyncExtensionSettings;
 309     case syncer::EXTENSIONS:
 310       return prefs::kSyncExtensions;
 311     case syncer::APP_LIST:
 312       return prefs::kSyncAppList;
 313     case syncer::APP_SETTINGS:
 314       return prefs::kSyncAppSettings;
 315     case syncer::APPS:
 316       return prefs::kSyncApps;
 317     case syncer::SEARCH_ENGINES:
 318       return prefs::kSyncSearchEngines;
 319     case syncer::SESSIONS:
 320       return prefs::kSyncSessions;
 321     case syncer::APP_NOTIFICATIONS:
 322       return prefs::kSyncAppNotifications;
 323     case syncer::HISTORY_DELETE_DIRECTIVES:
 324       return prefs::kSyncHistoryDeleteDirectives;
 325     case syncer::SYNCED_NOTIFICATIONS:
 326       return prefs::kSyncSyncedNotifications;
 327     case syncer::SYNCED_NOTIFICATION_APP_INFO:
 328       return prefs::kSyncSyncedNotificationAppInfo;
 329     case syncer::DICTIONARY:
 330       return prefs::kSyncDictionary;
 331     case syncer::FAVICON_IMAGES:
 332       return prefs::kSyncFaviconImages;
 333     case syncer::FAVICON_TRACKING:
 334       return prefs::kSyncFaviconTracking;
 335     case syncer::SUPERVISED_USER_SETTINGS:
 336       return prefs::kSyncSupervisedUserSettings;
 337     case syncer::PROXY_TABS:
 338       return prefs::kSyncTabs;
 339     case syncer::PRIORITY_PREFERENCES:
 340       return prefs::kSyncPriorityPreferences;
 341     case syncer::SUPERVISED_USERS:
 342       return prefs::kSyncSupervisedUsers;
 343     case syncer::ARTICLES:
 344       return prefs::kSyncArticles;
 345     case syncer::SUPERVISED_USER_SHARED_SETTINGS:
 346       return prefs::kSyncSupervisedUserSharedSettings;
 347     case syncer::DEVICE_INFO:
 348       return prefs::kSyncDeviceInfo;
 349     case syncer::WIFI_CREDENTIALS:
 350       return prefs::kSyncWifiCredentials;
 351     default:
 352       break;
 353   }
 354   NOTREACHED() << "Type is " << data_type;
 355   return NULL;
 356 }
 357
 358 #if defined(OS_CHROMEOS)
 359 std::string SyncPrefs::GetSpareBootstrapToken() const {
 360   DCHECK(CalledOnValidThread());
 361   return pref_service_->GetString(prefs::kSyncSpareBootstrapToken);
 362 }
 363
 364 void SyncPrefs::SetSpareBootstrapToken(const std::string& token) {
 365   DCHECK(CalledOnValidThread());
 366   pref_service_->SetString(prefs::kSyncSpareBootstrapToken, token);
 367 }
 368 #endif
 369
 370 void SyncPrefs::AcknowledgeSyncedTypes(syncer::ModelTypeSet types) {
 371   DCHECK(CalledOnValidThread());
 372   // Add the types to the current set of acknowledged
 373   // types, and then store the resulting set in prefs.
 374   const syncer::ModelTypeSet acknowledged_types =
 375       Union(types,
 376             syncer::ModelTypeSetFromValue(
 377                 *pref_service_->GetList(prefs::kSyncAcknowledgedSyncTypes)));
 378
 379   scoped_ptr<base::ListValue> value(
 380       syncer::ModelTypeSetToValue(acknowledged_types));
 381   pref_service_->Set(prefs::kSyncAcknowledgedSyncTypes, *value);
 382 }
 383
 384 int SyncPrefs::GetRemainingRollbackTries() const {
 385   return pref_service_->GetInteger(prefs::kSyncRemainingRollbackTries);
 386 }
 387
 388 void SyncPrefs::SetRemainingRollbackTries(int times) {
 389   pref_service_->SetInteger(prefs::kSyncRemainingRollbackTries, times);
 390 }
 391
 392 void SyncPrefs::OnSyncManagedPrefChanged() {
 393   DCHECK(CalledOnValidThread());
 394   FOR_EACH_OBSERVER(SyncPrefObserver,
 395                     sync_pref_observers_,
 396                     OnSyncManagedPrefChange(*pref_sync_managed_));
 397 }
 398
 399 void SyncPrefs::SetManagedForTest(bool is_managed) {
 400   DCHECK(CalledOnValidThread());
 401   pref_service_->SetBoolean(prefs::kSyncManaged, is_managed);
 402 }
 403
 404 syncer::ModelTypeSet SyncPrefs::GetAcknowledgeSyncedTypesForTest() const {
 405   DCHECK(CalledOnValidThread());
 406   return syncer::ModelTypeSetFromValue(
 407       *pref_service_->GetList(prefs::kSyncAcknowledgedSyncTypes));
 408 }
 409
 410 void SyncPrefs::RegisterPrefGroups() {
 411   pref_groups_[syncer::APPS].Put(syncer::APP_NOTIFICATIONS);
 412   pref_groups_[syncer::APPS].Put(syncer::APP_SETTINGS);
 413   pref_groups_[syncer::APPS].Put(syncer::APP_LIST);
 414
 415   pref_groups_[syncer::AUTOFILL].Put(syncer::AUTOFILL_PROFILE);
 416
 417   pref_groups_[syncer::EXTENSIONS].Put(syncer::EXTENSION_SETTINGS);
 418
 419   pref_groups_[syncer::PREFERENCES].Put(syncer::DICTIONARY);
 420   pref_groups_[syncer::PREFERENCES].Put(syncer::PRIORITY_PREFERENCES);
 421   pref_groups_[syncer::PREFERENCES].Put(syncer::SEARCH_ENGINES);
 422
 423   pref_groups_[syncer::TYPED_URLS].Put(syncer::HISTORY_DELETE_DIRECTIVES);
 424   pref_groups_[syncer::TYPED_URLS].Put(syncer::SESSIONS);
 425   pref_groups_[syncer::TYPED_URLS].Put(syncer::FAVICON_IMAGES);
 426   pref_groups_[syncer::TYPED_URLS].Put(syncer::FAVICON_TRACKING);
 427
 428   pref_groups_[syncer::PROXY_TABS].Put(syncer::SESSIONS);
 429   pref_groups_[syncer::PROXY_TABS].Put(syncer::FAVICON_IMAGES);
 430   pref_groups_[syncer::PROXY_TABS].Put(syncer::FAVICON_TRACKING);
 431
 432   // TODO(zea): put favicons in the bookmarks group as well once it handles
 433   // those favicons.
 434 }
 435
 436 // static
 437 void SyncPrefs::RegisterDataTypePreferredPref(
 438     user_prefs::PrefRegistrySyncable* registry,
 439     syncer::ModelType type,
 440     bool is_preferred) {
 441   const char* pref_name = GetPrefNameForDataType(type);
 442   if (!pref_name) {
 443     NOTREACHED();
 444     return;
 445   }
 446   registry->RegisterBooleanPref(
 447       pref_name,
 448       is_preferred,
 449       user_prefs::PrefRegistrySyncable::UNSYNCABLE_PREF);
 450 }
 451
 452 bool SyncPrefs::GetDataTypePreferred(syncer::ModelType type) const {
 453   DCHECK(CalledOnValidThread());
 454   const char* pref_name = GetPrefNameForDataType(type);
 455   if (!pref_name) {
 456     NOTREACHED();
 457     return false;
 458   }
 459
 460   // Device info is always enabled.
 461   if (pref_name == prefs::kSyncDeviceInfo)
 462     return true;
 463
 464   if (type == syncer::PROXY_TABS &&
 465       pref_service_->GetUserPrefValue(pref_name) == NULL &&
 466       pref_service_->IsUserModifiablePreference(pref_name)) {
 467     // If there is no tab sync preference yet (i.e. newly enabled type),
 468     // default to the session sync preference value.
 469     pref_name = GetPrefNameForDataType(syncer::SESSIONS);
 470   }
 471
 472   return pref_service_->GetBoolean(pref_name);
 473 }
 474
 475 void SyncPrefs::SetDataTypePreferred(syncer::ModelType type,
 476                                      bool is_preferred) {
 477   DCHECK(CalledOnValidThread());
 478   const char* pref_name = GetPrefNameForDataType(type);
 479   if (!pref_name) {
 480     NOTREACHED();
 481     return;
 482   }
 483
 484   // Device info is always preferred.
 485   if (type == syncer::DEVICE_INFO)
 486     return;
 487
 488   pref_service_->SetBoolean(pref_name, is_preferred);
 489 }
 490
 491 syncer::ModelTypeSet SyncPrefs::ResolvePrefGroups(
 492     syncer::ModelTypeSet registered_types,
 493     syncer::ModelTypeSet types) const {
 494   DCHECK(registered_types.HasAll(types));
 495   syncer::ModelTypeSet types_with_groups = types;
 496   for (PrefGroupsMap::const_iterator i = pref_groups_.begin();
 497        i != pref_groups_.end();
 498        ++i) {
 499     if (types.Has(i->first))
 500       types_with_groups.PutAll(i->second);
 501   }
 502   types_with_groups.RetainAll(registered_types);
 503   return types_with_groups;
 504 }
 505
 506 base::Time SyncPrefs::GetFirstSyncTime() const {
 507   return base::Time::FromInternalValue(
 508       pref_service_->GetInt64(prefs::kSyncFirstSyncTime));
 509 }
 510
 511 void SyncPrefs::SetFirstSyncTime(base::Time time) {
 512   pref_service_->SetInt64(prefs::kSyncFirstSyncTime, time.ToInternalValue());
 513 }
 514
 515 void SyncPrefs::ClearFirstSyncTime() {
 516   pref_service_->ClearPref(prefs::kSyncFirstSyncTime);
 517 }
 518
 519 }  // namespace sync_driver