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 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309
|
// Copyright 2022 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#include "chrome/browser/ash/printing/oauth2/profile_auth_servers_sync_bridge.h"
#include <memory>
#include <optional>
#include <set>
#include <string>
#include <vector>
#include "base/check.h"
#include "base/containers/contains.h"
#include "base/functional/bind.h"
#include "base/logging.h"
#include "base/memory/ptr_util.h"
#include "base/trace_event/trace_event.h"
#include "chrome/common/channel_info.h"
#include "components/sync/base/report_unrecoverable_error.h"
#include "components/sync/model/client_tag_based_data_type_processor.h"
#include "components/sync/model/data_type_local_change_processor.h"
#include "components/sync/model/data_type_store.h"
#include "components/sync/model/data_type_store_base.h"
#include "components/sync/model/data_type_sync_bridge.h"
#include "components/sync/model/entity_change.h"
#include "components/sync/model/metadata_change_list.h"
#include "components/sync/model/model_error.h"
#include "components/sync/model/mutable_data_batch.h"
#include "components/sync/protocol/entity_data.h"
#include "components/sync/protocol/entity_specifics.pb.h"
#include "components/sync/protocol/printers_authorization_server_specifics.pb.h"
#include "url/gurl.h"
namespace ash::printing::oauth2 {
namespace {
sync_pb::PrintersAuthorizationServerSpecifics ToSpecifics(
const std::string& uri) {
sync_pb::PrintersAuthorizationServerSpecifics specifics;
specifics.set_uri(uri);
return specifics;
}
std::unique_ptr<syncer::EntityData> ToEntityDataPtr(const std::string& uri) {
auto entity_data = std::make_unique<syncer::EntityData>();
*entity_data->specifics.mutable_printers_authorization_server() =
ToSpecifics(uri);
entity_data->name = uri;
return entity_data;
}
std::set<GURL> ToSetOfUris(const std::set<std::string>& strs) {
std::set<GURL> uris;
for (const std::string& str : strs) {
GURL uri(str);
if (!uri.is_valid()) {
LOG(WARNING) << "Failed to parse URI in ProfileAuthServersSyncBridge";
continue;
}
uris.insert(std::move(uri));
}
return uris;
}
} // namespace
std::unique_ptr<ProfileAuthServersSyncBridge>
ProfileAuthServersSyncBridge::Create(
Observer* observer,
syncer::OnceDataTypeStoreFactory store_factory) {
DCHECK(observer);
return base::WrapUnique(new ProfileAuthServersSyncBridge(
std::make_unique<syncer::ClientTagBasedDataTypeProcessor>(
syncer::PRINTERS_AUTHORIZATION_SERVERS,
base::BindRepeating(&syncer::ReportUnrecoverableError,
chrome::GetChannel())),
std::move(store_factory), observer));
}
std::unique_ptr<ProfileAuthServersSyncBridge>
ProfileAuthServersSyncBridge::CreateForTesting(
Observer* observer,
std::unique_ptr<syncer::DataTypeLocalChangeProcessor> change_processor,
syncer::OnceDataTypeStoreFactory store_factory) {
DCHECK(observer);
DCHECK(change_processor);
return base::WrapUnique(new ProfileAuthServersSyncBridge(
std::move(change_processor), std::move(store_factory), observer));
}
ProfileAuthServersSyncBridge::~ProfileAuthServersSyncBridge() = default;
void ProfileAuthServersSyncBridge::AddAuthorizationServer(
const GURL& server_uri) {
DCHECK(initialization_completed_);
const std::string key = server_uri.spec();
DCHECK(!key.empty());
servers_uris_.insert(key);
auto batch = store_->CreateWriteBatch();
batch->WriteData(key, ToSpecifics(key).SerializeAsString());
if (change_processor()->IsTrackingMetadata()) {
change_processor()->Put(key, ToEntityDataPtr(key),
batch->GetMetadataChangeList());
}
store_->CommitWriteBatch(
std::move(batch), base::BindOnce(&ProfileAuthServersSyncBridge::OnCommit,
weak_ptr_factory_.GetWeakPtr()));
}
ProfileAuthServersSyncBridge::ProfileAuthServersSyncBridge(
std::unique_ptr<syncer::DataTypeLocalChangeProcessor> change_processor,
syncer::OnceDataTypeStoreFactory store_factory,
Observer* observer)
: syncer::DataTypeSyncBridge(std::move(change_processor)),
observer_(observer) {
std::move(store_factory)
.Run(syncer::PRINTERS_AUTHORIZATION_SERVERS,
base::BindOnce(&ProfileAuthServersSyncBridge::OnStoreCreated,
weak_ptr_factory_.GetWeakPtr()));
}
void ProfileAuthServersSyncBridge::OnStoreCreated(
const std::optional<syncer::ModelError>& error,
std::unique_ptr<syncer::DataTypeStore> store) {
if (error) {
change_processor()->ReportError(*error);
return;
}
store_ = std::move(store);
store_->ReadAllData(
base::BindOnce(&ProfileAuthServersSyncBridge::OnReadAllData,
weak_ptr_factory_.GetWeakPtr()));
}
void ProfileAuthServersSyncBridge::OnReadAllData(
const std::optional<syncer::ModelError>& error,
std::unique_ptr<syncer::DataTypeStore::RecordList> record_list) {
if (error) {
change_processor()->ReportError(*error);
return;
}
for (const syncer::DataTypeStore::Record& r : *record_list) {
sync_pb::PrintersAuthorizationServerSpecifics specifics;
if (!specifics.ParseFromString(r.value)) {
change_processor()->ReportError(
{FROM_HERE, "Failed to deserialize all specifics."});
return;
}
servers_uris_.insert(specifics.uri());
}
// Data loaded. Notify the observer and load metadata.
NotifyObserver(servers_uris_, /*deleted=*/{});
store_->ReadAllMetadata(
base::BindOnce(&ProfileAuthServersSyncBridge::OnReadAllMetadata,
weak_ptr_factory_.GetWeakPtr()));
}
void ProfileAuthServersSyncBridge::OnReadAllMetadata(
const std::optional<syncer::ModelError>& error,
std::unique_ptr<syncer::MetadataBatch> metadata_batch) {
TRACE_EVENT0("ui", "ProfileAuthServersSyncBridge::OnReadAllMetadata");
if (error) {
change_processor()->ReportError(*error);
return;
}
change_processor()->ModelReadyToSync(std::move(metadata_batch));
initialization_completed_ = true;
observer_->OnProfileAuthorizationServersInitialized();
}
std::unique_ptr<syncer::MetadataChangeList>
ProfileAuthServersSyncBridge::CreateMetadataChangeList() {
return syncer::DataTypeStore::WriteBatch::CreateMetadataChangeList();
}
std::optional<syncer::ModelError>
ProfileAuthServersSyncBridge::MergeFullSyncData(
std::unique_ptr<syncer::MetadataChangeList> metadata_change_list,
syncer::EntityChangeList entity_data) {
// Every local URI is considered unsynced until the contrary is proven, i.e.
// until the same URI is seen in the incoming `entity_data`.
std::set<std::string> unsynced_local_uris = servers_uris_;
std::set<std::string> added_local_uris;
std::unique_ptr<syncer::DataTypeStore::WriteBatch> batch =
store_->CreateWriteBatch();
for (const std::unique_ptr<syncer::EntityChange>& change : entity_data) {
const sync_pb::PrintersAuthorizationServerSpecifics& specifics =
change->data().specifics.printers_authorization_server();
const std::string& remote_uri = specifics.uri();
DCHECK_EQ(change->storage_key(), remote_uri);
auto [unused, is_new] = servers_uris_.insert(remote_uri);
if (is_new) {
added_local_uris.insert(remote_uri);
batch->WriteData(remote_uri, specifics.SerializeAsString());
} else {
unsynced_local_uris.erase(remote_uri);
}
}
// Send unmatched local URIs to the server.
for (const std::string& uri : unsynced_local_uris) {
change_processor()->Put(uri, ToEntityDataPtr(uri),
metadata_change_list.get());
}
// Save new local URIs to the local store.
batch->TakeMetadataChangesFrom(std::move(metadata_change_list));
store_->CommitWriteBatch(
std::move(batch), base::BindOnce(&ProfileAuthServersSyncBridge::OnCommit,
weak_ptr_factory_.GetWeakPtr()));
NotifyObserver(added_local_uris, /*deleted=*/{});
return std::nullopt;
}
std::optional<syncer::ModelError>
ProfileAuthServersSyncBridge::ApplyIncrementalSyncChanges(
std::unique_ptr<syncer::MetadataChangeList> metadata_change_list,
syncer::EntityChangeList entity_changes) {
std::set<std::string> added_local_uris;
std::set<std::string> deleted_local_uris;
std::unique_ptr<syncer::DataTypeStore::WriteBatch> batch =
store_->CreateWriteBatch();
for (const std::unique_ptr<syncer::EntityChange>& change : entity_changes) {
const std::string& uri = change->storage_key();
if (change->type() == syncer::EntityChange::ACTION_DELETE) {
if (servers_uris_.erase(uri)) {
batch->DeleteData(uri);
deleted_local_uris.insert(uri);
}
} else {
if (servers_uris_.insert(uri).second) { // true <=> uri wasn't there
batch->WriteData(uri, change->data()
.specifics.printers_authorization_server()
.SerializeAsString());
added_local_uris.insert(uri);
}
}
}
batch->TakeMetadataChangesFrom(std::move(metadata_change_list));
store_->CommitWriteBatch(
std::move(batch), base::BindOnce(&ProfileAuthServersSyncBridge::OnCommit,
weak_ptr_factory_.GetWeakPtr()));
NotifyObserver(added_local_uris, deleted_local_uris);
return std::nullopt;
}
std::unique_ptr<syncer::DataBatch>
ProfileAuthServersSyncBridge::GetDataForCommit(StorageKeyList storage_keys) {
auto batch = std::make_unique<syncer::MutableDataBatch>();
for (const std::string& key : storage_keys) {
if (base::Contains(servers_uris_, key)) {
batch->Put(key, ToEntityDataPtr(key));
}
}
return batch;
}
std::unique_ptr<syncer::DataBatch>
ProfileAuthServersSyncBridge::GetAllDataForDebugging() {
auto batch = std::make_unique<syncer::MutableDataBatch>();
for (const auto& uri : servers_uris_) {
batch->Put(uri, ToEntityDataPtr(uri));
}
return batch;
}
std::string ProfileAuthServersSyncBridge::GetClientTag(
const syncer::EntityData& entity_data) const {
return GetStorageKey(entity_data);
}
std::string ProfileAuthServersSyncBridge::GetStorageKey(
const syncer::EntityData& entity_data) const {
DCHECK(entity_data.specifics.has_printers_authorization_server());
return entity_data.specifics.printers_authorization_server().uri();
}
void ProfileAuthServersSyncBridge::OnCommit(
const std::optional<syncer::ModelError>& error) {
if (error) {
LOG(WARNING) << "Failed to commit operation to store in "
"ProfileAuthServersSyncBridge";
change_processor()->ReportError(*error);
}
}
void ProfileAuthServersSyncBridge::NotifyObserver(
const std::set<std::string>& added,
const std::set<std::string>& deleted) {
// Convert std::set<std::string> to std::set<GURL>.
std::set<GURL> added_uris = ToSetOfUris(added);
std::set<GURL> deleted_uris = ToSetOfUris(deleted);
// Call the observer.
if (!added_uris.empty() || !deleted_uris.empty()) {
observer_->OnProfileAuthorizationServersUpdate(std::move(added_uris),
std::move(deleted_uris));
}
}
} // namespace ash::printing::oauth2
|