1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
|
// Copyright 2018 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "components/unified_consent/url_keyed_data_collection_consent_helper.h"
#include <algorithm>
#include <map>
#include <set>
#include "base/functional/bind.h"
#include "base/memory/raw_ptr.h"
#include "base/observer_list.h"
#include "components/prefs/pref_change_registrar.h"
#include "components/prefs/pref_service.h"
#include "components/sync/base/data_type.h"
#include "components/sync/service/sync_service.h"
#include "components/sync/service/sync_service_observer.h"
#include "components/sync/service/sync_service_utils.h"
#include "components/unified_consent/pref_names.h"
namespace unified_consent {
namespace {
class PrefBasedUrlKeyedDataCollectionConsentHelper
: public UrlKeyedDataCollectionConsentHelper {
public:
explicit PrefBasedUrlKeyedDataCollectionConsentHelper(
PrefService* pref_service);
PrefBasedUrlKeyedDataCollectionConsentHelper(
const PrefBasedUrlKeyedDataCollectionConsentHelper&) = delete;
PrefBasedUrlKeyedDataCollectionConsentHelper& operator=(
const PrefBasedUrlKeyedDataCollectionConsentHelper&) = delete;
~PrefBasedUrlKeyedDataCollectionConsentHelper() override = default;
// UrlKeyedDataCollectionConsentHelper:
State GetConsentState() override;
private:
void OnPrefChanged();
raw_ptr<PrefService> pref_service_; // weak (must outlive this)
PrefChangeRegistrar pref_change_registrar_;
};
class SyncBasedUrlKeyedDataCollectionConsentHelper
: public UrlKeyedDataCollectionConsentHelper,
syncer::SyncServiceObserver {
public:
SyncBasedUrlKeyedDataCollectionConsentHelper(
syncer::SyncService* sync_service,
std::set<syncer::DataType> sync_data_types,
bool require_sync_feature_enabled);
SyncBasedUrlKeyedDataCollectionConsentHelper(
const SyncBasedUrlKeyedDataCollectionConsentHelper&) = delete;
SyncBasedUrlKeyedDataCollectionConsentHelper& operator=(
const SyncBasedUrlKeyedDataCollectionConsentHelper&) = delete;
~SyncBasedUrlKeyedDataCollectionConsentHelper() override;
// UrlKeyedDataCollectionConsentHelper:
State GetConsentState() override;
// syncer::SyncServiceObserver:
void OnStateChanged(syncer::SyncService* sync) override;
void OnSyncShutdown(syncer::SyncService* sync) override;
private:
void UpdateSyncDataTypeStates();
const bool require_sync_feature_enabled_;
raw_ptr<syncer::SyncService> sync_service_;
std::map<syncer::DataType, syncer::UploadState> sync_data_type_states_;
bool sync_feature_state_ = false;
};
PrefBasedUrlKeyedDataCollectionConsentHelper::
PrefBasedUrlKeyedDataCollectionConsentHelper(PrefService* pref_service)
: pref_service_(pref_service) {
pref_change_registrar_.Init(pref_service_);
pref_change_registrar_.Add(
prefs::kUrlKeyedAnonymizedDataCollectionEnabled,
base::BindRepeating(
&PrefBasedUrlKeyedDataCollectionConsentHelper::OnPrefChanged,
base::Unretained(this)));
}
UrlKeyedDataCollectionConsentHelper::State
PrefBasedUrlKeyedDataCollectionConsentHelper::GetConsentState() {
// There's no initializing state for pref-based helpers.
return pref_service_->GetBoolean(
prefs::kUrlKeyedAnonymizedDataCollectionEnabled)
? State::kEnabled
: State::kDisabled;
}
void PrefBasedUrlKeyedDataCollectionConsentHelper::OnPrefChanged() {
FireOnStateChanged();
}
SyncBasedUrlKeyedDataCollectionConsentHelper::
SyncBasedUrlKeyedDataCollectionConsentHelper(
syncer::SyncService* sync_service,
std::set<syncer::DataType> sync_data_types,
bool require_sync_feature_enabled)
: require_sync_feature_enabled_(require_sync_feature_enabled),
sync_service_(sync_service) {
DCHECK(!sync_data_types.empty());
for (const auto& sync_data_type : sync_data_types) {
sync_data_type_states_[sync_data_type] = syncer::UploadState::NOT_ACTIVE;
}
UpdateSyncDataTypeStates();
if (sync_service_)
sync_service_->AddObserver(this);
}
SyncBasedUrlKeyedDataCollectionConsentHelper::
~SyncBasedUrlKeyedDataCollectionConsentHelper() {
if (sync_service_)
sync_service_->RemoveObserver(this);
}
// Note: This method must only consume cached state (not query anything from
// SyncService), to ensure that the state-change detection in OnStateChanged()
// works correctly.
UrlKeyedDataCollectionConsentHelper::State
SyncBasedUrlKeyedDataCollectionConsentHelper::GetConsentState() {
if (require_sync_feature_enabled_ && !sync_feature_state_) {
return State::kDisabled;
}
// Any sync type that's NOT_ACTIVE makes the whole consent kDisabled.
for (const auto& sync_data_type_states : sync_data_type_states_) {
if (sync_data_type_states.second == syncer::UploadState::NOT_ACTIVE) {
return State::kDisabled;
}
}
// If no sync type is NOT_ACTIVE, any sync type still INITIALIZING makes the
// whole consent kInitializing.
for (const auto& sync_data_type_states : sync_data_type_states_) {
if (sync_data_type_states.second == syncer::UploadState::INITIALIZING) {
return State::kInitializing;
}
}
DCHECK(std::ranges::all_of(sync_data_type_states_, [](auto& state) {
return state.second == syncer::UploadState::ACTIVE;
})) << "Nothing is NOT_ACTIVE or INITIALIZING, so all must be ACTIVE.";
return State::kEnabled;
}
void SyncBasedUrlKeyedDataCollectionConsentHelper::OnStateChanged(
syncer::SyncService* sync_service) {
DCHECK_EQ(sync_service_, sync_service);
auto old_state = GetConsentState();
UpdateSyncDataTypeStates();
if (old_state != GetConsentState()) {
FireOnStateChanged();
}
}
void SyncBasedUrlKeyedDataCollectionConsentHelper::OnSyncShutdown(
syncer::SyncService* sync_service) {
DCHECK_EQ(sync_service_, sync_service);
sync_service_->RemoveObserver(this);
sync_service_ = nullptr;
}
void SyncBasedUrlKeyedDataCollectionConsentHelper::UpdateSyncDataTypeStates() {
// TODO(crbug.com/40067025): Remove the `require_sync_feature_enabled` param
// once kReplaceSyncPromosWithSignInPromos is launched.
if (require_sync_feature_enabled_) {
sync_feature_state_ =
sync_service_ && sync_service_->IsSyncFeatureEnabled();
}
for (auto& [data_type, upload_state] : sync_data_type_states_) {
upload_state = syncer::GetUploadToGoogleState(sync_service_, data_type);
}
}
} // namespace
UrlKeyedDataCollectionConsentHelper::UrlKeyedDataCollectionConsentHelper() =
default;
UrlKeyedDataCollectionConsentHelper::~UrlKeyedDataCollectionConsentHelper() =
default;
// static
std::unique_ptr<UrlKeyedDataCollectionConsentHelper>
UrlKeyedDataCollectionConsentHelper::NewAnonymizedDataCollectionConsentHelper(
PrefService* pref_service) {
return std::make_unique<PrefBasedUrlKeyedDataCollectionConsentHelper>(
pref_service);
}
// static
std::unique_ptr<UrlKeyedDataCollectionConsentHelper>
UrlKeyedDataCollectionConsentHelper::NewPersonalizedDataCollectionConsentHelper(
syncer::SyncService* sync_service) {
return std::make_unique<SyncBasedUrlKeyedDataCollectionConsentHelper>(
sync_service,
std::set<syncer::DataType>({syncer::DataType::HISTORY_DELETE_DIRECTIVES}),
/*require_sync_feature_enabled=*/false);
}
// static
std::unique_ptr<UrlKeyedDataCollectionConsentHelper>
UrlKeyedDataCollectionConsentHelper::
NewPersonalizedBookmarksDataCollectionConsentHelper(
syncer::SyncService* sync_service,
bool require_sync_feature_enabled) {
return std::make_unique<SyncBasedUrlKeyedDataCollectionConsentHelper>(
sync_service, std::set<syncer::DataType>({syncer::DataType::BOOKMARKS}),
require_sync_feature_enabled);
}
bool UrlKeyedDataCollectionConsentHelper::IsEnabled() {
return GetConsentState() == State::kEnabled;
}
void UrlKeyedDataCollectionConsentHelper::AddObserver(Observer* observer) {
observer_list_.AddObserver(observer);
}
void UrlKeyedDataCollectionConsentHelper::RemoveObserver(Observer* observer) {
observer_list_.RemoveObserver(observer);
}
void UrlKeyedDataCollectionConsentHelper::FireOnStateChanged() {
for (auto& observer : observer_list_)
observer.OnUrlKeyedDataCollectionConsentStateChanged(this);
}
} // namespace unified_consent
|