[Sync] Move //sync to //components/sync.

sync/internal_api/public/sync_manager.h

-// Copyright 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.
-
-#ifndef SYNC_INTERNAL_API_PUBLIC_SYNC_MANAGER_H_
-#define SYNC_INTERNAL_API_PUBLIC_SYNC_MANAGER_H_
-
-#include <stdint.h>
-
-#include <memory>
-#include <string>
-#include <vector>
-
-#include "base/callback.h"
-#include "base/files/file_path.h"
-#include "base/memory/ref_counted.h"
-#include "base/memory/scoped_vector.h"
-#include "base/task_runner.h"
-#include "base/threading/thread_checker.h"
-#include "google_apis/gaia/oauth2_token_service.h"
-#include "sync/base/sync_export.h"
-#include "sync/internal_api/public/base/invalidation_interface.h"
-#include "sync/internal_api/public/base/model_type.h"
-#include "sync/internal_api/public/change_record.h"
-#include "sync/internal_api/public/configure_reason.h"
-#include "sync/internal_api/public/connection_status.h"
-#include "sync/internal_api/public/engine/model_safe_worker.h"
-#include "sync/internal_api/public/engine/sync_status.h"
-#include "sync/internal_api/public/events/protocol_event.h"
-#include "sync/internal_api/public/http_post_provider_factory.h"
-#include "sync/internal_api/public/internal_components_factory.h"
-#include "sync/internal_api/public/model_type_connector.h"
-#include "sync/internal_api/public/shutdown_reason.h"
-#include "sync/internal_api/public/sync_encryption_handler.h"
-#include "sync/internal_api/public/util/weak_handle.h"
-#include "sync/protocol/sync_protocol_error.h"
-
-class GURL;
-
-namespace sync_pb {
-class EncryptedData;
-}  // namespace sync_pb
-
-namespace syncer {
-
-class BaseTransaction;
-class CancelationSignal;
-class DataTypeDebugInfoListener;
-class Encryptor;
-class ExtensionsActivity;
-class InternalComponentsFactory;
-class JsBackend;
-class JsEventHandler;
-class ProtocolEvent;
-class SyncEncryptionHandler;
-class SyncScheduler;
-class TypeDebugInfoObserver;
-class UnrecoverableErrorHandler;
-struct Experiments;
-struct UserShare;
-
-namespace sessions {
-class SyncSessionSnapshot;
-}  // namespace sessions
-
-// Contains everything needed to talk to and identify a user account.
-struct SYNC_EXPORT SyncCredentials {
-  SyncCredentials();
-  SyncCredentials(const SyncCredentials& other);
-  ~SyncCredentials();
-
-  // Account_id of signed in account.
-  std::string account_id;
-
-  // The email associated with this account.
-  std::string email;
-
-  // The raw authentication token's bytes.
-  std::string sync_token;
-
-  // The set of scopes to use when talking to sync server.
-  OAuth2TokenService::ScopeSet scope_set;
-};
-
-// SyncManager encapsulates syncable::Directory and serves as the parent of all
-// other objects in the sync API.  If multiple threads interact with the same
-// local sync repository (i.e. the same sqlite database), they should share a
-// single SyncManager instance.  The caller should typically create one
-// SyncManager for the lifetime of a user session.
-//
-// Unless stated otherwise, all methods of SyncManager should be called on the
-// same thread.
-class SYNC_EXPORT SyncManager {
- public:
-  // An interface the embedding application implements to be notified
-  // on change events.  Note that these methods may be called on *any*
-  // thread.
-  class SYNC_EXPORT ChangeDelegate {
-   public:
-    // Notify the delegate that changes have been applied to the sync model.
-    //
-    // This will be invoked on the same thread as on which ApplyChanges was
-    // called. |changes| is an array of size |change_count|, and contains the
-    // ID of each individual item that was changed. |changes| exists only for
-    // the duration of the call. If items of multiple data types change at
-    // the same time, this method is invoked once per data type and |changes|
-    // is restricted to items of the ModelType indicated by |model_type|.
-    // Because the observer is passed a |trans|, the observer can assume a
-    // read lock on the sync model that will be released after the function
-    // returns.
-    //
-    // The SyncManager constructs |changes| in the following guaranteed order:
-    //
-    // 1. Deletions, from leaves up to parents.
-    // 2. Updates to existing items with synced parents & predecessors.
-    // 3. New items with synced parents & predecessors.
-    // 4. Items with parents & predecessors in |changes|.
-    // 5. Repeat #4 until all items are in |changes|.
-    //
-    // Thus, an implementation of OnChangesApplied should be able to
-    // process the change records in the order without having to worry about
-    // forward dependencies.  But since deletions come before reparent
-    // operations, a delete may temporarily orphan a node that is
-    // updated later in the list.
-    virtual void OnChangesApplied(ModelType model_type,
-                                  int64_t model_version,
-                                  const BaseTransaction* trans,
-                                  const ImmutableChangeRecordList& changes) = 0;
-
-    // OnChangesComplete gets called when the TransactionComplete event is
-    // posted (after OnChangesApplied finishes), after the transaction lock
-    // and the change channel mutex are released.
-    //
-    // The purpose of this function is to support processors that require
-    // split-transactions changes. For example, if a model processor wants to
-    // perform blocking I/O due to a change, it should calculate the changes
-    // while holding the transaction lock (from within OnChangesApplied), buffer
-    // those changes, let the transaction fall out of scope, and then commit
-    // those changes from within OnChangesComplete (postponing the blocking
-    // I/O to when it no longer holds any lock).
-    virtual void OnChangesComplete(ModelType model_type) = 0;
-
-   protected:
-    virtual ~ChangeDelegate();
-  };
-
-  // Like ChangeDelegate, except called only on the sync thread and
-  // not while a transaction is held.  For objects that want to know
-  // when changes happen, but don't need to process them.
-  class SYNC_EXPORT ChangeObserver {
-   public:
-    // Ids referred to in |changes| may or may not be in the write
-    // transaction specified by |write_transaction_id|.  If they're
-    // not, that means that the node didn't actually change, but we
-    // marked them as changed for some other reason (e.g., siblings of
-    // re-ordered nodes).
-    //
-    // TODO(sync, long-term): Ideally, ChangeDelegate/Observer would
-    // be passed a transformed version of EntryKernelMutation instead
-    // of a transaction that would have to be used to look up the
-    // changed nodes.  That is, ChangeDelegate::OnChangesApplied()
-    // would still be called under the transaction, but all the needed
-    // data will be passed down.
-    //
-    // Even more ideally, we would have sync semantics such that we'd
-    // be able to apply changes without being under a transaction.
-    // But that's a ways off...
-    virtual void OnChangesApplied(ModelType model_type,
-                                  int64_t write_transaction_id,
-                                  const ImmutableChangeRecordList& changes) = 0;
-
-    virtual void OnChangesComplete(ModelType model_type) = 0;
-
-   protected:
-    virtual ~ChangeObserver();
-  };
-
-  // An interface the embedding application implements to receive
-  // notifications from the SyncManager.  Register an observer via
-  // SyncManager::AddObserver.  All methods are called only on the
-  // sync thread.
-  class SYNC_EXPORT Observer {
-   public:
-    // A round-trip sync-cycle took place and the syncer has resolved any
-    // conflicts that may have arisen.
-    virtual void OnSyncCycleCompleted(
-        const sessions::SyncSessionSnapshot& snapshot) = 0;
-
-    // Called when the status of the connection to the sync server has
-    // changed.
-    virtual void OnConnectionStatusChange(ConnectionStatus status) = 0;
-
-    // Called when initialization is complete to the point that SyncManager can
-    // process changes. This does not necessarily mean authentication succeeded
-    // or that the SyncManager is online.
-    // IMPORTANT: Creating any type of transaction before receiving this
-    // notification is illegal!
-    // WARNING: Calling methods on the SyncManager before receiving this
-    // message, unless otherwise specified, produces undefined behavior.
-
-    virtual void OnInitializationComplete(
-        const WeakHandle<JsBackend>& js_backend,
-        const WeakHandle<DataTypeDebugInfoListener>& debug_info_listener,
-        bool success,
-        ModelTypeSet restored_types) = 0;
-
-    virtual void OnActionableError(
-        const SyncProtocolError& sync_protocol_error) = 0;
-
-    virtual void OnMigrationRequested(ModelTypeSet types) = 0;
-
-    virtual void OnProtocolEvent(const ProtocolEvent& event) = 0;
-
-   protected:
-    virtual ~Observer();
-  };
-
-  // Arguments for initializing SyncManager.
-  struct SYNC_EXPORT InitArgs {
-    InitArgs();
-    ~InitArgs();
-
-    // Path in which to create or open sync's sqlite database (aka the
-    // directory).
-    base::FilePath database_location;
-
-    // Used to propagate events to chrome://sync-internals.  Optional.
-    WeakHandle<JsEventHandler> event_handler;
-
-    // URL of the sync server.
-    GURL service_url;
-
-    // Used to communicate with the sync server.
-    std::unique_ptr<HttpPostProviderFactory> post_factory;
-
-    std::vector<scoped_refptr<ModelSafeWorker> > workers;
-
-    // Must outlive SyncManager.
-    ExtensionsActivity* extensions_activity;
-
-    // Must outlive SyncManager.
-    ChangeDelegate* change_delegate;
-
-    // Credentials to be used when talking to the sync server.
-    SyncCredentials credentials;
-
-    // Unqiuely identifies this client to the invalidation notification server.
-    std::string invalidator_client_id;
-
-    // Used to boostrap the cryptographer.
-    std::string restored_key_for_bootstrapping;
-    std::string restored_keystore_key_for_bootstrapping;
-
-    std::unique_ptr<InternalComponentsFactory> internal_components_factory;
-
-    // Must outlive SyncManager.
-    Encryptor* encryptor;
-
-    WeakHandle<UnrecoverableErrorHandler> unrecoverable_error_handler;
-    base::Closure report_unrecoverable_error_function;
-
-    // Carries shutdown requests across threads and will be used to cut short
-    // any network I/O and tell the syncer to exit early.
-    //
-    // Must outlive SyncManager.
-    CancelationSignal* cancelation_signal;
-
-    // Optional nigori state to be restored.
-    std::unique_ptr<SyncEncryptionHandler::NigoriState> saved_nigori_state;
-  };
-
-  typedef base::Callback<void(void)> ClearServerDataCallback;
-
-  SyncManager();
-  virtual ~SyncManager();
-
-  // Initialize the sync manager using arguments from |args|.
-  //
-  // Note, args is passed by non-const pointer because it contains objects like
-  // unique_ptr.
-  virtual void Init(InitArgs* args) = 0;
-
-  virtual ModelTypeSet InitialSyncEndedTypes() = 0;
-
-  // Returns those types within |types| that have an empty progress marker
-  // token.
-  virtual ModelTypeSet GetTypesWithEmptyProgressMarkerToken(
-      ModelTypeSet types) = 0;
-
-  // Purge from the directory those types with non-empty progress markers
-  // but without initial synced ended set.
-  // Returns false if an error occurred, true otherwise.
-  virtual bool PurgePartiallySyncedTypes() = 0;
-
-  // Update tokens that we're using in Sync. Email must stay the same.
-  virtual void UpdateCredentials(const SyncCredentials& credentials) = 0;
-
-  // Put the syncer in normal mode ready to perform nudges and polls.
-  virtual void StartSyncingNormally(
-      const ModelSafeRoutingInfo& routing_info,
-      base::Time last_poll_time) = 0;
-
-  // Switches the mode of operation to CONFIGURATION_MODE and performs
-  // any configuration tasks needed as determined by the params. Once complete,
-  // syncer will remain in CONFIGURATION_MODE until StartSyncingNormally is
-  // called.
-  // Data whose types are not in |new_routing_info| are purged from sync
-  // directory, unless they're part of |to_ignore|, in which case they're left
-  // untouched. The purged data is backed up in delete journal for recovery in
-  // next session if its type is in |to_journal|. If in |to_unapply|
-  // only the local data is removed; the server data is preserved.
-  // |ready_task| is invoked when the configuration completes.
-  // |retry_task| is invoked if the configuration job could not immediately
-  //              execute. |ready_task| will still be called when it eventually
-  //              does finish.
-  virtual void ConfigureSyncer(
-      ConfigureReason reason,
-      ModelTypeSet to_download,
-      ModelTypeSet to_purge,
-      ModelTypeSet to_journal,
-      ModelTypeSet to_unapply,
-      const ModelSafeRoutingInfo& new_routing_info,
-      const base::Closure& ready_task,
-      const base::Closure& retry_task) = 0;
-
-  // Inform the syncer of a change in the invalidator's state.
-  virtual void SetInvalidatorEnabled(bool invalidator_enabled) = 0;
-
-  // Inform the syncer that its cached information about a type is obsolete.
-  virtual void OnIncomingInvalidation(
-      syncer::ModelType type,
-      std::unique_ptr<syncer::InvalidationInterface> invalidation) = 0;
-
-  // Adds a listener to be notified of sync events.
-  // NOTE: It is OK (in fact, it's probably a good idea) to call this before
-  // having received OnInitializationCompleted.
-  virtual void AddObserver(Observer* observer) = 0;
-
-  // Remove the given observer.  Make sure to call this if the
-  // Observer is being destroyed so the SyncManager doesn't
-  // potentially dereference garbage.
-  virtual void RemoveObserver(Observer* observer) = 0;
-
-  // Status-related getter.  May be called on any thread.
-  virtual SyncStatus GetDetailedStatus() const = 0;
-
-  // Call periodically from a database-safe thread to persist recent changes
-  // to the syncapi model.
-  virtual void SaveChanges() = 0;
-
-  // Issue a final SaveChanges, and close sqlite handles.
-  virtual void ShutdownOnSyncThread(ShutdownReason reason) = 0;
-
-  // May be called from any thread.
-  virtual UserShare* GetUserShare() = 0;
-
-  // Returns an instance of the main interface for non-blocking sync types.
-  virtual std::unique_ptr<syncer_v2::ModelTypeConnector>
-  GetModelTypeConnectorProxy() = 0;
-
-  // Returns the cache_guid of the currently open database.
-  // Requires that the SyncManager be initialized.
-  virtual const std::string cache_guid() = 0;
-
-  // Reads the nigori node to determine if any experimental features should
-  // be enabled.
-  // Note: opens a transaction.  May be called on any thread.
-  virtual bool ReceivedExperiment(Experiments* experiments) = 0;
-
-  // Uses a read-only transaction to determine if the directory being synced has
-  // any remaining unsynced items.  May be called on any thread.
-  virtual bool HasUnsyncedItems() = 0;
-
-  // Returns the SyncManager's encryption handler.
-  virtual SyncEncryptionHandler* GetEncryptionHandler() = 0;
-
-  virtual std::unique_ptr<base::ListValue> GetAllNodesForType(
-      syncer::ModelType type) = 0;
-
-  // Ask the SyncManager to fetch updates for the given types.
-  virtual void RefreshTypes(ModelTypeSet types) = 0;
-
-  // Returns any buffered protocol events.  Does not clear the buffer.
-  virtual ScopedVector<syncer::ProtocolEvent> GetBufferedProtocolEvents() = 0;
-
-  // Functions to manage registrations of DebugInfoObservers.
-  virtual void RegisterDirectoryTypeDebugInfoObserver(
-      syncer::TypeDebugInfoObserver* observer) = 0;
-  virtual void UnregisterDirectoryTypeDebugInfoObserver(
-      syncer::TypeDebugInfoObserver* observer) = 0;
-  virtual bool HasDirectoryTypeDebugInfoObserver(
-      syncer::TypeDebugInfoObserver* observer) = 0;
-
-  // Request that all current counter values be emitted as though they had just
-  // been updated.  Useful for initializing new observers' state.
-  virtual void RequestEmitDebugInfo() = 0;
-
-  // Clears server data and invokes |callback| when complete.
-  //
-  // This is an asynchronous operation that requires interaction with the sync
-  // server. The operation will automatically be retried with backoff until it
-  // completes successfully or sync is shutdown.
-  virtual void ClearServerData(const ClearServerDataCallback& callback) = 0;
-
-  // Updates Sync's tracking of whether the cookie jar has a mismatch with the
-  // chrome account. See ClientConfigParams proto message for more info.
-  // Note: this does not trigger a sync cycle. It just updates the sync context.
-  virtual void OnCookieJarChanged(bool account_mismatch, bool empty_jar) = 0;
-};
-
-}  // namespace syncer
-
-#endif  // SYNC_INTERNAL_API_PUBLIC_SYNC_MANAGER_H_