components/sync_driver/sync_prefs.h

   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 #ifndef COMPONENTS_SYNC_DRIVER_SYNC_PREFS_H_
   6 #define COMPONENTS_SYNC_DRIVER_SYNC_PREFS_H_
   7
   8 #include "base/basictypes.h"
   9 #include "base/compiler_specific.h"
  10 #include "base/memory/weak_ptr.h"
  11 #include "base/observer_list.h"
  12 #include "base/prefs/pref_member.h"
  13 #include "base/threading/non_thread_safe.h"
  14 #include "base/time/time.h"
  15 #include "sync/internal_api/public/base/model_type.h"
  16
  17 class PrefService;
  18 class ProfileIOData;
  19
  20 namespace user_prefs {
  21 class PrefRegistrySyncable;
  22 }
  23
  24 namespace sync_driver {
  25
  26 class SyncPrefObserver {
  27  public:
  28   // Called whenever the pref that controls whether sync is managed
  29   // changes.
  30   virtual void OnSyncManagedPrefChange(bool is_sync_managed) = 0;
  31
  32  protected:
  33   virtual ~SyncPrefObserver();
  34 };
  35
  36 // SyncPrefs is a helper class that manages getting, setting, and
  37 // persisting global sync preferences.  It is not thread-safe, and
  38 // lives on the UI thread.
  39 //
  40 // TODO(akalin): Some classes still read the prefs directly.  Consider
  41 // passing down a pointer to SyncPrefs to them.  A list of files:
  42 //
  43 //   profile_sync_service_startup_unittest.cc
  44 //   profile_sync_service.cc
  45 //   sync_setup_flow.cc
  46 //   sync_setup_wizard.cc
  47 //   sync_setup_wizard_unittest.cc
  48 //   two_client_preferences_sync_test.cc
  49 class SyncPrefs : NON_EXPORTED_BASE(public base::NonThreadSafe),
  50                   public base::SupportsWeakPtr<SyncPrefs> {
  51  public:
  52   // |pref_service| may not be NULL.
  53   // Does not take ownership of |pref_service|.
  54   explicit SyncPrefs(PrefService* pref_service);
  55
  56   // For testing.
  57   SyncPrefs();
  58
  59   virtual ~SyncPrefs();
  60
  61   static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
  62
  63   void AddSyncPrefObserver(SyncPrefObserver* sync_pref_observer);
  64   void RemoveSyncPrefObserver(SyncPrefObserver* sync_pref_observer);
  65
  66   // Clears important sync preferences.
  67   void ClearPreferences();
  68
  69   // Getters and setters for global sync prefs.
  70
  71   bool HasSyncSetupCompleted() const;
  72   void SetSyncSetupCompleted();
  73
  74   bool SyncHasAuthError() const;
  75   void SetSyncAuthError(bool error);
  76
  77   bool IsSyncRequested() const;
  78   void SetSyncRequested(bool is_requested);
  79
  80   base::Time GetLastSyncedTime() const;
  81   void SetLastSyncedTime(base::Time time);
  82
  83   base::Time GetLastPollTime() const;
  84   void SetLastPollTime(base::Time time);
  85
  86   bool HasKeepEverythingSynced() const;
  87   void SetKeepEverythingSynced(bool keep_everything_synced);
  88
  89   // The returned set is guaranteed to be a subset of
  90   // |registered_types|.  Returns |registered_types| directly if
  91   // HasKeepEverythingSynced() is true.
  92   syncer::ModelTypeSet GetPreferredDataTypes(
  93       syncer::ModelTypeSet registered_types) const;
  94   // |preferred_types| should be a subset of |registered_types|.  All
  95   // types in |preferred_types| are marked preferred, and all types in
  96   // |registered_types| \ |preferred_types| are marked not preferred.
  97   // Changes are still made to the prefs even if
  98   // HasKeepEverythingSynced() is true, but won't be visible until
  99   // SetKeepEverythingSynced(false) is called.
 100   void SetPreferredDataTypes(syncer::ModelTypeSet registered_types,
 101                              syncer::ModelTypeSet preferred_types);
 102
 103   // This pref is set outside of sync.
 104   bool IsManaged() const;
 105
 106   // Use this encryption bootstrap token if we're using an explicit passphrase.
 107   std::string GetEncryptionBootstrapToken() const;
 108   void SetEncryptionBootstrapToken(const std::string& token);
 109
 110   // Use this keystore bootstrap token if we're not using an explicit
 111   // passphrase.
 112   std::string GetKeystoreEncryptionBootstrapToken() const;
 113   void SetKeystoreEncryptionBootstrapToken(const std::string& token);
 114
 115   // Use this for the unique machine tag used for session sync.
 116   std::string GetSyncSessionsGUID() const;
 117   void SetSyncSessionsGUID(const std::string& guid);
 118
 119   // Maps |data_type| to its corresponding preference name.
 120   static const char* GetPrefNameForDataType(syncer::ModelType data_type);
 121
 122 #if defined(OS_CHROMEOS)
 123   // Use this spare bootstrap token only when setting up sync for the first
 124   // time.
 125   std::string GetSpareBootstrapToken() const;
 126   void SetSpareBootstrapToken(const std::string& token);
 127 #endif
 128
 129   // Get/Set number of rollback attempts allowed.
 130   virtual int GetRemainingRollbackTries() const;
 131   virtual void SetRemainingRollbackTries(int times);
 132
 133   // Get/set/clear first sync time of current user. Used to roll back browsing
 134   // data later when user signs out.
 135   base::Time GetFirstSyncTime() const;
 136   void SetFirstSyncTime(base::Time time);
 137   void ClearFirstSyncTime();
 138
 139   // Out of band sync passphrase prompt getter/setter.
 140   bool IsPassphrasePrompted() const;
 141   void SetPassphrasePrompted(bool value);
 142
 143   // For testing.
 144   void SetManagedForTest(bool is_managed);
 145
 146   // Get/Set number of memory warnings received.
 147   int GetMemoryPressureWarningCount() const;
 148   void SetMemoryPressureWarningCount(int value);
 149
 150   // Check if the previous shutdown was clean.
 151   bool DidSyncShutdownCleanly() const;
 152
 153   // Set whetherthe last shutdown was clean.
 154   void SetCleanShutdown(bool value);
 155
 156   // Get/set for the last known sync invalidation versions.
 157   void GetInvalidationVersions(
 158       std::map<syncer::ModelType, int64>* invalidation_versions) const;
 159   void UpdateInvalidationVersions(
 160       const std::map<syncer::ModelType, int64>& invalidation_versions);
 161
 162   // Will return the contents of the LastRunVersion preference. This may be an
 163   // empty string if no version info was present, and is only valid at
 164   // Sync startup time (after which the LastRunVersion preference will have been
 165   // updated to the current version).
 166   std::string GetLastRunVersion() const;
 167   void SetLastRunVersion(const std::string& current_version);
 168
 169  private:
 170   void RegisterPrefGroups();
 171
 172   static void RegisterDataTypePreferredPref(
 173       user_prefs::PrefRegistrySyncable* prefs,
 174       syncer::ModelType type,
 175       bool is_preferred);
 176   bool GetDataTypePreferred(syncer::ModelType type) const;
 177   void SetDataTypePreferred(syncer::ModelType type, bool is_preferred);
 178
 179   // Returns a ModelTypeSet based on |types| expanded to include pref groups
 180   // (see |pref_groups_|), but as a subset of |registered_types|.
 181   syncer::ModelTypeSet ResolvePrefGroups(syncer::ModelTypeSet registered_types,
 182                                          syncer::ModelTypeSet types) const;
 183
 184   void OnSyncManagedPrefChanged();
 185
 186   // May be NULL.
 187   PrefService* const pref_service_;
 188
 189   base::ObserverList<SyncPrefObserver> sync_pref_observers_;
 190
 191   // The preference that controls whether sync is under control by
 192   // configuration management.
 193   BooleanPrefMember pref_sync_managed_;
 194
 195   // Groups of prefs that always have the same value as a "master" pref.
 196   // For example, the APPS group has {APP_NOTIFICATIONS, APP_SETTINGS}
 197   // (as well as APPS, but that is implied), so
 198   //   pref_groups_[syncer::APPS] =       { syncer::APP_NOTIFICATIONS,
 199   //                                          syncer::APP_SETTINGS }
 200   //   pref_groups_[syncer::EXTENSIONS] = { syncer::EXTENSION_SETTINGS }
 201   // etc.
 202   typedef std::map<syncer::ModelType, syncer::ModelTypeSet> PrefGroupsMap;
 203   PrefGroupsMap pref_groups_;
 204
 205   DISALLOW_COPY_AND_ASSIGN(SyncPrefs);
 206 };
 207
 208 }  // namespace sync_driver
 209
 210 #endif  // COMPONENTS_SYNC_DRIVER_SYNC_PREFS_H_