| // Copyright 2018 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 COMPONENTS_UNIFIED_CONSENT_UNIFIED_CONSENT_SERVICE_H_ |
| #define COMPONENTS_UNIFIED_CONSENT_UNIFIED_CONSENT_SERVICE_H_ |
| |
| #include <map> |
| #include <memory> |
| #include <string> |
| #include <vector> |
| |
| #include "base/macros.h" |
| #include "base/values.h" |
| #include "components/keyed_service/core/keyed_service.h" |
| #include "components/prefs/pref_change_registrar.h" |
| #include "components/signin/public/identity_manager/identity_manager.h" |
| #include "components/sync/base/model_type.h" |
| #include "components/sync/driver/sync_service_observer.h" |
| #include "components/sync_preferences/pref_service_syncable_observer.h" |
| #include "components/unified_consent/unified_consent_metrics.h" |
| |
| namespace user_prefs { |
| class PrefRegistrySyncable; |
| } |
| |
| namespace sync_preferences { |
| class PrefServiceSyncable; |
| } |
| |
| namespace syncer { |
| class SyncService; |
| } |
| |
| namespace unified_consent { |
| |
| enum class MigrationState : int { |
| kNotInitialized = 0, |
| kInProgressWaitForSyncInit = 1, |
| // Reserve space for other kInProgress* entries to be added here. |
| kCompleted = 10, |
| }; |
| |
| // A browser-context keyed service that is used to manage the user consent |
| // when UnifiedConsent feature is enabled. |
| // |
| // This service makes sure that UrlKeyedAnonymizedDataCollection is turned on |
| // during sync opt-in and turned off when the user opts out. |
| // |
| // During the advanced opt-in through settings, the changes the user makes to |
| // the service toggles(prefs) are applied after prefs start syncing. This is |
| // done to prevent changes the user makes during sync setup to be overridden by |
| // syncing down older changes. |
| class UnifiedConsentService |
| : public KeyedService, |
| public signin::IdentityManager::Observer, |
| public syncer::SyncServiceObserver, |
| public sync_preferences::PrefServiceSyncableObserver { |
| public: |
| // Initializes the service. The |service_pref_names| vector is used to track |
| // pref changes during the first sync setup. |
| UnifiedConsentService(sync_preferences::PrefServiceSyncable* pref_service, |
| signin::IdentityManager* identity_manager, |
| syncer::SyncService* sync_service, |
| const std::vector<std::string>& service_pref_names); |
| |
| UnifiedConsentService(const UnifiedConsentService&) = delete; |
| UnifiedConsentService& operator=(const UnifiedConsentService&) = delete; |
| |
| ~UnifiedConsentService() override; |
| |
| // Register the prefs used by this UnifiedConsentService. |
| static void RegisterPrefs(user_prefs::PrefRegistrySyncable* registry); |
| |
| // Enables or disables URL-keyed anonymized data collection. |
| void SetUrlKeyedAnonymizedDataCollectionEnabled(bool enabled); |
| |
| // KeyedService: |
| void Shutdown() override; |
| |
| // IdentityManager::Observer: |
| void OnPrimaryAccountChanged( |
| const signin::PrimaryAccountChangeEvent& event) override; |
| |
| private: |
| friend class UnifiedConsentServiceTest; |
| |
| // syncer::SyncServiceObserver: |
| void OnStateChanged(syncer::SyncService* sync) override; |
| |
| // sync_preferences::PrefServiceSyncableObserver: |
| void OnIsSyncingChanged() override; |
| |
| // Helpers for observing changes in the service prefs. |
| void StartObservingServicePrefChanges(); |
| void StopObservingServicePrefChanges(); |
| void ServicePrefChanged(const std::string& name); |
| |
| // Migration helpers. |
| MigrationState GetMigrationState(); |
| void SetMigrationState(MigrationState migration_state); |
| // Called when the unified consent service is created. |
| void MigrateProfileToUnifiedConsent(); |
| // Updates the settings preferences for the migration when the sync engine is |
| // initialized. When it is not, this function will be called again from |
| // |OnStateChanged| when the sync engine is initialized. |
| void UpdateSettingsForMigration(); |
| |
| sync_preferences::PrefServiceSyncable* pref_service_; |
| signin::IdentityManager* identity_manager_; |
| syncer::SyncService* sync_service_; |
| |
| // Used for tracking the service pref states during the advanced sync opt-in. |
| const std::vector<std::string> service_pref_names_; |
| std::map<std::string, base::Value> service_pref_changes_; |
| PrefChangeRegistrar service_pref_change_registrar_; |
| }; |
| |
| } // namespace unified_consent |
| |
| #endif // COMPONENTS_UNIFIED_CONSENT_UNIFIED_CONSENT_SERVICE_H_ |