Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(415)

Unified Diff: components/sync_driver/sync_service.h

Issue 1067843002: Add API to sync_driver::SyncService for iOS (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master
Patch Set: Review comments Created 5 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « chrome/browser/sync/profile_sync_service.h ('k') | no next file » | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: components/sync_driver/sync_service.h
diff --git a/components/sync_driver/sync_service.h b/components/sync_driver/sync_service.h
index 945d25a190d2cd93009371b067cdc8bdd41ff509..3a810fa53ab980036dc4b30a5287563d5a3cc610 100644
--- a/components/sync_driver/sync_service.h
+++ b/components/sync_driver/sync_service.h
@@ -5,15 +5,29 @@
#ifndef COMPONENTS_SYNC_DRIVER_SYNC_SERVICE_H_
#define COMPONENTS_SYNC_DRIVER_SYNC_SERVICE_H_
+#include <string>
+
#include "base/macros.h"
+#include "base/time/time.h"
+#include "components/sync_driver/data_type_encryption_handler.h"
#include "components/sync_driver/sync_service_observer.h"
#include "sync/internal_api/public/base/model_type.h"
+class GoogleServiceAuthError;
+
namespace sync_driver {
-class SyncService {
+class SyncService : public sync_driver::DataTypeEncryptionHandler {
public:
- virtual ~SyncService() {}
+ // Used to specify the kind of passphrase with which sync data is encrypted.
+ enum PassphraseType {
+ IMPLICIT, // The user did not provide a custom passphrase for encryption.
+ // We implicitly use the GAIA password in such cases.
+ EXPLICIT, // The user selected the "use custom passphrase" radio button
+ // during sync setup and provided a passphrase.
+ };
+
+ ~SyncService() override {}
// Whether sync is enabled by user or not. This does not necessarily mean
// that sync is currently running (due to delayed startup, unrecoverable
@@ -44,6 +58,106 @@ class SyncService {
// Returns true if |observer| has already been added as an observer.
virtual bool HasObserver(const SyncServiceObserver* observer) const = 0;
+ // ---------------------------------------------------------------------------
+ // TODO(sync): The methods below were pulled from ProfileSyncService, and
+ // should be evaluated to see if they should stay.
+
+ // Returns true if sync is enabled/not suppressed and the user is logged in.
+ // (being logged in does not mean that tokens are available - tokens may
+ // be missing because they have not loaded yet, or because they were deleted
+ // due to http://crbug.com/121755).
+ // Virtual to enable mocking in tests.
+ // TODO(tim): Remove this? Nothing in ProfileSyncService uses it, and outside
+ // callers use a seemingly arbitrary / redundant / bug prone combination of
+ // this method, IsSyncAccessible, and others.
+ virtual bool IsSyncEnabledAndLoggedIn() = 0;
+
+ // Disables sync for user. Use ShowLoginDialog to enable.
+ virtual void DisableForUser() = 0;
+
+ // Stops the sync backend and sets the flag for suppressing sync startup.
+ virtual void StopAndSuppress() = 0;
+
+ // Resets the flag for suppressing sync startup and starts the sync backend.
+ virtual void UnsuppressAndStart() = 0;
+
+ // Returns the set of types which are preferred for enabling. This is a
+ // superset of the active types (see GetActiveDataTypes()).
+ virtual syncer::ModelTypeSet GetPreferredDataTypes() const = 0;
+
+ // Called when a user chooses which data types to sync as part of the sync
+ // setup wizard. |sync_everything| represents whether they chose the
+ // "keep everything synced" option; if true, |chosen_types| will be ignored
+ // and all data types will be synced. |sync_everything| means "sync all
+ // current and future data types."
+ virtual void OnUserChoseDatatypes(bool sync_everything,
+ syncer::ModelTypeSet chosen_types) = 0;
+
+ // Called whe Sync has been setup by the user and can be started.
+ virtual void SetSyncSetupCompleted() = 0;
+
+ // Returns true if initial sync setup is in progress (does not return true
+ // if the user is customizing sync after already completing setup once).
+ // SyncService uses this to determine if it's OK to start syncing, or if the
+ // user is still setting up the initial sync configuration.
+ virtual bool FirstSetupInProgress() const = 0;
+
+ // Called by the UI to notify the SyncService that UI is visible so it will
+ // not start syncing. This tells sync whether it's safe to start downloading
+ // data types yet (we don't start syncing until after sync setup is complete).
+ // The UI calls this as soon as any part of the signin wizard is displayed
+ // (even just the login UI).
+ // If |setup_in_progress| is false, this also kicks the sync engine to ensure
+ // that data download starts. In this case, |ReconfigureDatatypeManager| will
+ // get triggered.
+ virtual void SetSetupInProgress(bool setup_in_progress) = 0;
+
+ // Used by tests.
+ virtual bool setup_in_progress() const = 0;
+
+ // Whether the data types active for the current mode have finished
+ // configuration.
+ virtual bool ConfigurationDone() const = 0;
+
+ virtual const GoogleServiceAuthError& GetAuthError() const = 0;
+ virtual bool HasUnrecoverableError() const = 0;
+
+ // Returns true if the SyncBackendHost has told us it's ready to accept
+ // changes. This should only be used for sync's internal configuration logic
+ // (such as deciding when to prompt for an encryption passphrase).
+ virtual bool backend_initialized() const = 0;
+
+ // Returns true if OnPassphraseRequired has been called for decryption and
+ // we have an encrypted data type enabled.
+ virtual bool IsPassphraseRequiredForDecryption() const = 0;
+
+ // Returns the time the current explicit passphrase (if any), was set.
+ // If no secondary passphrase is in use, or no time is available, returns an
+ // unset base::Time.
+ virtual base::Time GetExplicitPassphraseTime() const = 0;
+
+ // Returns true if a secondary (explicit) passphrase is being used. It is not
+ // legal to call this method before the backend is initialized.
+ virtual bool IsUsingSecondaryPassphrase() const = 0;
+
+ // Turns on encryption for all data. Callers must call OnUserChoseDatatypes()
+ // after calling this to force the encryption to occur.
+ virtual void EnableEncryptEverything() = 0;
+
+ // Asynchronously sets the passphrase to |passphrase| for encryption. |type|
+ // specifies whether the passphrase is a custom passphrase or the GAIA
+ // password being reused as a passphrase.
+ // TODO(atwilson): Change this so external callers can only set an EXPLICIT
+ // passphrase with this API.
+ virtual void SetEncryptionPassphrase(const std::string& passphrase,
+ PassphraseType type) = 0;
+
+ // Asynchronously decrypts pending keys using |passphrase|. Returns false
+ // immediately if the passphrase could not be used to decrypt a locally cached
+ // copy of encrypted keys; returns true otherwise.
+ virtual bool SetDecryptionPassphrase(const std::string& passphrase)
+ WARN_UNUSED_RESULT = 0;
+
protected:
SyncService() {}
« no previous file with comments | « chrome/browser/sync/profile_sync_service.h ('k') | no next file » | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698