ios/chrome/browser/sync/sync_setup_service.h

// Copyright 2012 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

#ifndef IOS_CHROME_BROWSER_SYNC_SYNC_SETUP_SERVICE_H_
#define IOS_CHROME_BROWSER_SYNC_SYNC_SETUP_SERVICE_H_

#include <memory>

#include "components/keyed_service/core/keyed_service.h"
#include "components/sync/base/model_type.h"
#include "components/sync/base/user_selectable_type.h"
#include "components/sync/service/sync_user_settings.h"

namespace syncer {
class SyncService;
class SyncSetupInProgressHandle;
}  // namespace syncer

// Class that allows configuring sync. It handles enabling and disabling it, as
// well as choosing datatypes. Most actions are delayed until a commit is done,
// to allow the complex sync setup flow on iOS.
class SyncSetupService : public KeyedService {
 public:
  explicit SyncSetupService(syncer::SyncService* sync_service);

  SyncSetupService(const SyncSetupService&) = delete;
  SyncSetupService& operator=(const SyncSetupService&) = delete;

  ~SyncSetupService() override;

  // Returns whether all conditions are satisfied for Sync-the-feature to start.
  // This means that there is a Sync-consented account, no disable reasons, and
  // first-time Sync setup has been completed by the user.
  virtual bool IsSyncFeatureEnabled() const;

  // Returns whether the given datatype has been enabled for sync and its
  // initialization is complete (SyncEngineHost::OnEngineInitialized has been
  // called).
  virtual bool IsDataTypeActive(syncer::ModelType datatype) const;
  // Returns whether the given datatype is enabled by the user.
  // TODO(crbug.com/1429249): Rename to get rid of the `preferred` terminology.
  virtual bool IsDataTypePreferred(syncer::UserSelectableType datatype) const;
  // Enables or disables the given datatype. To be noted: this can be called at
  // any time, but will only be meaningful if `IsSyncFeatureEnabled` is true and
  // `IsSyncEverythingEnabled` is false. Changes won't take effect in the sync
  // backend before the next call to `CommitChanges`.
  void SetDataTypeEnabled(syncer::UserSelectableType datatype, bool enabled);

  // Returns whether the user needs to enter a passphrase or enable sync to make
  // tab sync work.
  bool UserActionIsRequiredToHaveTabSyncWork();

  // Returns whether all datatypes are being synced.
  virtual bool IsSyncEverythingEnabled() const;
  // Sets whether all datatypes should be synced or not. Changes won't take
  // effect before the next call to `CommitChanges`.
  virtual void SetSyncEverythingEnabled(bool sync_all);

  // Returns whether all sync data is being encrypted.
  virtual bool IsEncryptEverythingEnabled() const;

  // Pauses sync allowing the user to configure what data to sync before
  // actually starting to sync data with the server.
  // TODO(crbug.com/1438800): Rename to PrepareForSyncSetup().
  virtual void PrepareForFirstSyncSetup();

  // Sets the first setup complete flag. This method doesn't commit sync
  // changes. PrepareForFirstSyncSetup() needs to be called before. This flag is
  // not set if the user didn't turn on sync.
  // This method should only be used with UnifiedConsent flag.
  virtual void SetInitialSyncFeatureSetupComplete(
      syncer::SyncFirstSetupCompleteSource source);

  // Returns true if the user finished the Sync setup flow.
  virtual bool IsInitialSyncFeatureSetupComplete() const;

  // Commits all the pending configuration changes to Sync.
  void CommitSyncChanges();

  // Returns true if there are uncommitted sync changes.
  bool HasUncommittedChanges();

 private:
  syncer::SyncService* const sync_service_;

  // Prevents Sync from running until configuration is complete.
  std::unique_ptr<syncer::SyncSetupInProgressHandle> sync_blocker_;
};

#endif  // IOS_CHROME_BROWSER_SYNC_SYNC_SETUP_SERVICE_H_