blob: d0bac28652ba1bbcb102d36cf96f5e998a91ebe5 [file] [log] [blame]
// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "base/basictypes.h"
#include "base/compiler_specific.h"
#include "base/memory/weak_ptr.h"
#include "base/observer_list.h"
#include "base/prefs/pref_member.h"
#include "base/threading/non_thread_safe.h"
#include "base/time/time.h"
#include "sync/internal_api/public/base/model_type.h"
class PrefService;
class ProfileIOData;
namespace user_prefs {
class PrefRegistrySyncable;
namespace sync_driver {
class SyncPrefObserver {
// Called whenever the pref that controls whether sync is managed
// changes.
virtual void OnSyncManagedPrefChange(bool is_sync_managed) = 0;
virtual ~SyncPrefObserver();
// SyncPrefs is a helper class that manages getting, setting, and
// persisting global sync preferences. It is not thread-safe, and
// lives on the UI thread.
// TODO(akalin): Some classes still read the prefs directly. Consider
// passing down a pointer to SyncPrefs to them. A list of files:
class SyncPrefs : NON_EXPORTED_BASE(public base::NonThreadSafe),
public base::SupportsWeakPtr<SyncPrefs> {
// |pref_service| may not be NULL.
// Does not take ownership of |pref_service|.
explicit SyncPrefs(PrefService* pref_service);
// For testing.
virtual ~SyncPrefs();
static void RegisterProfilePrefs(user_prefs::PrefRegistrySyncable* registry);
void AddSyncPrefObserver(SyncPrefObserver* sync_pref_observer);
void RemoveSyncPrefObserver(SyncPrefObserver* sync_pref_observer);
// Clears important sync preferences.
void ClearPreferences();
// Getters and setters for global sync prefs.
bool HasSyncSetupCompleted() const;
void SetSyncSetupCompleted();
bool SyncHasAuthError() const;
void SetSyncAuthError(bool error);
bool IsStartSuppressed() const;
void SetStartSuppressed(bool is_suppressed);
base::Time GetLastSyncedTime() const;
void SetLastSyncedTime(base::Time time);
bool HasKeepEverythingSynced() const;
void SetKeepEverythingSynced(bool keep_everything_synced);
// The returned set is guaranteed to be a subset of
// |registered_types|. Returns |registered_types| directly if
// HasKeepEverythingSynced() is true.
syncer::ModelTypeSet GetPreferredDataTypes(
syncer::ModelTypeSet registered_types) const;
// |preferred_types| should be a subset of |registered_types|. All
// types in |preferred_types| are marked preferred, and all types in
// |registered_types| \ |preferred_types| are marked not preferred.
// Changes are still made to the prefs even if
// HasKeepEverythingSynced() is true, but won't be visible until
// SetKeepEverythingSynced(false) is called.
void SetPreferredDataTypes(syncer::ModelTypeSet registered_types,
syncer::ModelTypeSet preferred_types);
// This pref is set outside of sync.
bool IsManaged() const;
// Use this encryption bootstrap token if we're using an explicit passphrase.
std::string GetEncryptionBootstrapToken() const;
void SetEncryptionBootstrapToken(const std::string& token);
// Use this keystore bootstrap token if we're not using an explicit
// passphrase.
std::string GetKeystoreEncryptionBootstrapToken() const;
void SetKeystoreEncryptionBootstrapToken(const std::string& token);
// Use this for the unique machine tag used for session sync.
std::string GetSyncSessionsGUID() const;
void SetSyncSessionsGUID(const std::string& guid);
// Maps |data_type| to its corresponding preference name.
static const char* GetPrefNameForDataType(syncer::ModelType data_type);
#if defined(OS_CHROMEOS)
// Use this spare bootstrap token only when setting up sync for the first
// time.
std::string GetSpareBootstrapToken() const;
void SetSpareBootstrapToken(const std::string& token);
// Merges the given set of types with the set of acknowledged types.
void AcknowledgeSyncedTypes(syncer::ModelTypeSet types);
// Get/Set number of rollback attempts allowed.
virtual int GetRemainingRollbackTries() const;
virtual void SetRemainingRollbackTries(int times);
// Get/set/clear first sync time of current user. Used to roll back browsing
// data later when user signs out.
base::Time GetFirstSyncTime() const;
void SetFirstSyncTime(base::Time time);
void ClearFirstSyncTime();
// For testing.
void SetManagedForTest(bool is_managed);
syncer::ModelTypeSet GetAcknowledgeSyncedTypesForTest() const;
void RegisterPrefGroups();
static void RegisterDataTypePreferredPref(
user_prefs::PrefRegistrySyncable* prefs,
syncer::ModelType type,
bool is_preferred);
bool GetDataTypePreferred(syncer::ModelType type) const;
void SetDataTypePreferred(syncer::ModelType type, bool is_preferred);
// Returns a ModelTypeSet based on |types| expanded to include pref groups
// (see |pref_groups_|), but as a subset of |registered_types|.
syncer::ModelTypeSet ResolvePrefGroups(syncer::ModelTypeSet registered_types,
syncer::ModelTypeSet types) const;
void OnSyncManagedPrefChanged();
// May be NULL.
PrefService* const pref_service_;
ObserverList<SyncPrefObserver> sync_pref_observers_;
// The preference that controls whether sync is under control by
// configuration management.
BooleanPrefMember pref_sync_managed_;
// Groups of prefs that always have the same value as a "master" pref.
// For example, the APPS group has {APP_NOTIFICATIONS, APP_SETTINGS}
// (as well as APPS, but that is implied), so
// pref_groups_[syncer::APPS] = { syncer::APP_NOTIFICATIONS,
// syncer::APP_SETTINGS }
// pref_groups_[syncer::EXTENSIONS] = { syncer::EXTENSION_SETTINGS }
// etc.
typedef std::map<syncer::ModelType, syncer::ModelTypeSet> PrefGroupsMap;
PrefGroupsMap pref_groups_;
} // namespace sync_driver