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 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
|
// Copyright 2013 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/sync_file_system/local/local_file_sync_service.h"
#include "base/containers/contains.h"
#include "base/functional/bind.h"
#include "base/memory/ptr_util.h"
#include "base/observer_list.h"
#include "base/task/single_thread_task_runner.h"
#include "chrome/browser/profiles/profile.h"
#include "chrome/browser/sync_file_system/file_change.h"
#include "chrome/browser/sync_file_system/local/local_file_change_tracker.h"
#include "chrome/browser/sync_file_system/local/local_file_sync_context.h"
#include "chrome/browser/sync_file_system/local/sync_file_system_backend.h"
#include "chrome/browser/sync_file_system/local_change_processor.h"
#include "chrome/browser/sync_file_system/logger.h"
#include "chrome/browser/sync_file_system/sync_file_metadata.h"
#include "content/public/browser/browser_context.h"
#include "content/public/browser/browser_task_traits.h"
#include "content/public/browser/browser_thread.h"
#include "content/public/browser/site_instance.h"
#include "content/public/browser/storage_partition.h"
#include "extensions/browser/extension_registry.h"
#include "extensions/browser/extension_util.h"
#include "extensions/common/extension_set.h"
#include "storage/browser/blob/scoped_file.h"
#include "storage/browser/file_system/file_system_context.h"
#include "storage/browser/file_system/file_system_url.h"
#include "url/gurl.h"
using content::BrowserThread;
using storage::FileSystemURL;
namespace sync_file_system {
namespace {
void PrepareForProcessRemoteChangeCallbackAdapter(
RemoteChangeProcessor::PrepareChangeCallback callback,
SyncStatusCode status,
const LocalFileSyncInfo& sync_file_info,
storage::ScopedFile snapshot) {
std::move(callback).Run(status, sync_file_info.metadata,
sync_file_info.changes);
}
void InvokeCallbackOnNthInvocation(int* count,
base::RepeatingClosure callback) {
--*count;
if (*count <= 0)
callback.Run();
}
} // namespace
LocalFileSyncService::OriginChangeMap::OriginChangeMap()
: next_(change_count_map_.end()) {}
LocalFileSyncService::OriginChangeMap::~OriginChangeMap() = default;
bool LocalFileSyncService::OriginChangeMap::NextOriginToProcess(GURL* origin) {
DCHECK(origin);
if (change_count_map_.empty())
return false;
auto begin = next_;
do {
if (next_ == change_count_map_.end())
next_ = change_count_map_.begin();
DCHECK_NE(0, next_->second);
*origin = next_++->first;
if (!base::Contains(disabled_origins_, *origin))
return true;
} while (next_ != begin);
return false;
}
int64_t LocalFileSyncService::OriginChangeMap::GetTotalChangeCount() const {
int64_t num_changes = 0;
for (auto iter = change_count_map_.begin(); iter != change_count_map_.end();
++iter) {
if (base::Contains(disabled_origins_, iter->first))
continue;
num_changes += iter->second;
}
return num_changes;
}
void LocalFileSyncService::OriginChangeMap::SetOriginChangeCount(
const GURL& origin,
int64_t changes) {
if (changes != 0) {
change_count_map_[origin] = changes;
return;
}
auto found = change_count_map_.find(origin);
if (found != change_count_map_.end()) {
if (next_ == found)
++next_;
change_count_map_.erase(found);
}
}
void LocalFileSyncService::OriginChangeMap::SetOriginEnabled(
const GURL& origin, bool enabled) {
if (enabled)
disabled_origins_.erase(origin);
else
disabled_origins_.insert(origin);
}
// LocalFileSyncService -------------------------------------------------------
std::unique_ptr<LocalFileSyncService> LocalFileSyncService::Create(
Profile* profile) {
return base::WrapUnique(new LocalFileSyncService(profile, nullptr));
}
std::unique_ptr<LocalFileSyncService> LocalFileSyncService::CreateForTesting(
Profile* profile,
leveldb::Env* env) {
auto sync_service = base::WrapUnique(new LocalFileSyncService(profile, env));
sync_service->sync_context_->set_mock_notify_changes_duration_in_sec(0);
return sync_service;
}
LocalFileSyncService::~LocalFileSyncService() {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
}
void LocalFileSyncService::Shutdown() {
sync_context_->RemoveOriginChangeObserver(this);
sync_context_->ShutdownOnUIThread();
profile_ = nullptr;
}
void LocalFileSyncService::MaybeInitializeFileSystemContext(
const GURL& app_origin,
storage::FileSystemContext* file_system_context,
SyncStatusCallback callback) {
sync_context_->MaybeInitializeFileSystemContext(
app_origin, file_system_context,
base::BindOnce(&LocalFileSyncService::DidInitializeFileSystemContext,
weak_ptr_factory_.GetWeakPtr(), app_origin,
base::RetainedRef(file_system_context),
std::move(callback)));
}
void LocalFileSyncService::AddChangeObserver(Observer* observer) {
change_observers_.AddObserver(observer);
}
void LocalFileSyncService::RegisterURLForWaitingSync(
const FileSystemURL& url,
base::OnceClosure on_syncable_callback) {
sync_context_->RegisterURLForWaitingSync(url,
std::move(on_syncable_callback));
}
void LocalFileSyncService::ProcessLocalChange(SyncFileCallback callback) {
// Pick an origin to process next.
GURL origin;
if (!origin_change_map_.NextOriginToProcess(&origin)) {
std::move(callback).Run(SYNC_STATUS_NO_CHANGE_TO_SYNC, FileSystemURL());
return;
}
DCHECK(!origin.is_empty());
DCHECK(base::Contains(origin_to_contexts_, origin));
DVLOG(1) << "Starting ProcessLocalChange";
sync_context_->GetFileForLocalSync(
origin_to_contexts_[origin],
base::BindOnce(&LocalFileSyncService::DidGetFileForLocalSync,
weak_ptr_factory_.GetWeakPtr(), std::move(callback)));
}
void LocalFileSyncService::SetLocalChangeProcessor(
LocalChangeProcessor* local_change_processor) {
local_change_processor_ = local_change_processor;
}
void LocalFileSyncService::SetLocalChangeProcessorCallback(
GetLocalChangeProcessorCallback get_local_change_processor) {
get_local_change_processor_ = std::move(get_local_change_processor);
}
void LocalFileSyncService::HasPendingLocalChanges(
const FileSystemURL& url,
HasPendingLocalChangeCallback callback) {
if (!base::Contains(origin_to_contexts_, url.origin().GetURL())) {
base::SingleThreadTaskRunner::GetCurrentDefault()->PostTask(
FROM_HERE, base::BindOnce(std::move(callback),
SYNC_FILE_ERROR_INVALID_URL, false));
return;
}
sync_context_->HasPendingLocalChanges(
origin_to_contexts_[url.origin().GetURL()], url, std::move(callback));
}
void LocalFileSyncService::PromoteDemotedChanges(
base::RepeatingClosure callback) {
if (origin_to_contexts_.empty()) {
callback.Run();
return;
}
base::RepeatingClosure completion_callback =
base::BindRepeating(&InvokeCallbackOnNthInvocation,
base::Owned(new int(origin_to_contexts_.size() + 1)),
std::move(callback));
for (auto iter = origin_to_contexts_.begin();
iter != origin_to_contexts_.end(); ++iter)
sync_context_->PromoteDemotedChanges(iter->first, iter->second,
completion_callback);
completion_callback.Run();
}
void LocalFileSyncService::GetLocalFileMetadata(
const FileSystemURL& url,
SyncFileMetadataCallback callback) {
DCHECK(base::Contains(origin_to_contexts_, url.origin().GetURL()));
sync_context_->GetFileMetadata(origin_to_contexts_[url.origin().GetURL()],
url, std::move(callback));
}
void LocalFileSyncService::PrepareForProcessRemoteChange(
const FileSystemURL& url,
PrepareChangeCallback callback) {
DVLOG(1) << "PrepareForProcessRemoteChange: " << url.DebugString();
if (!base::Contains(origin_to_contexts_, url.origin().GetURL())) {
// This could happen if a remote sync is triggered for the app that hasn't
// been initialized in this service.
DCHECK(profile_);
// The given url.origin() must be for valid installed app.
const extensions::Extension* extension =
extensions::ExtensionRegistry::Get(profile_)
->enabled_extensions()
.GetAppByURL(url.origin().GetURL());
if (!extension) {
util::Log(
logging::LOGGING_WARNING, FROM_HERE,
"PrepareForProcessRemoteChange called for non-existing origin: %s",
url.origin().GetURL().spec().c_str());
// The extension has been uninstalled and this method is called
// before the remote changes for the origin are removed.
std::move(callback).Run(SYNC_STATUS_NO_CHANGE_TO_SYNC, SyncFileMetadata(),
FileChangeList());
return;
}
scoped_refptr<storage::FileSystemContext> file_system_context =
extensions::util::GetStoragePartitionForExtensionId(extension->id(),
profile_)
->GetFileSystemContext();
MaybeInitializeFileSystemContext(
url.origin().GetURL(), file_system_context.get(),
base::BindOnce(&LocalFileSyncService::DidInitializeForRemoteSync,
weak_ptr_factory_.GetWeakPtr(), url,
base::RetainedRef(file_system_context),
std::move(callback)));
return;
}
DCHECK(base::Contains(origin_to_contexts_, url.origin().GetURL()));
sync_context_->PrepareForSync(
origin_to_contexts_[url.origin().GetURL()], url,
LocalFileSyncContext::SYNC_EXCLUSIVE,
base::BindOnce(&PrepareForProcessRemoteChangeCallbackAdapter,
std::move(callback)));
}
void LocalFileSyncService::ApplyRemoteChange(const FileChange& change,
const base::FilePath& local_path,
const FileSystemURL& url,
SyncStatusCallback callback) {
DCHECK(base::Contains(origin_to_contexts_, url.origin().GetURL()));
util::Log(logging::LOGGING_VERBOSE, FROM_HERE,
"[Remote -> Local] ApplyRemoteChange: %s on %s",
change.DebugString().c_str(), url.DebugString().c_str());
sync_context_->ApplyRemoteChange(
origin_to_contexts_[url.origin().GetURL()], change, local_path, url,
base::BindOnce(&LocalFileSyncService::DidApplyRemoteChange,
weak_ptr_factory_.GetWeakPtr(), std::move(callback)));
}
void LocalFileSyncService::FinalizeRemoteSync(
const FileSystemURL& url,
bool clear_local_changes,
base::OnceClosure completion_callback) {
DCHECK(base::Contains(origin_to_contexts_, url.origin().GetURL()));
sync_context_->FinalizeExclusiveSync(
origin_to_contexts_[url.origin().GetURL()], url, clear_local_changes,
std::move(completion_callback));
}
void LocalFileSyncService::RecordFakeLocalChange(const FileSystemURL& url,
const FileChange& change,
SyncStatusCallback callback) {
DCHECK(base::Contains(origin_to_contexts_, url.origin().GetURL()));
sync_context_->RecordFakeLocalChange(
origin_to_contexts_[url.origin().GetURL()], url, change,
std::move(callback));
}
void LocalFileSyncService::OnChangesAvailableInOrigins(
const std::set<GURL>& origins) {
bool need_notification = false;
for (auto iter = origins.begin(); iter != origins.end(); ++iter) {
const GURL& origin = *iter;
if (!base::Contains(origin_to_contexts_, origin)) {
// This could happen if this is called for apps/origins that haven't
// been initialized yet, or for apps/origins that are disabled.
// (Local change tracker could call this for uninitialized origins
// while it's reading dirty files from the database in the
// initialization phase.)
pending_origins_with_changes_.insert(origin);
continue;
}
need_notification = true;
SyncFileSystemBackend* backend =
SyncFileSystemBackend::GetBackend(origin_to_contexts_[origin]);
DCHECK(backend);
DCHECK(backend->change_tracker());
origin_change_map_.SetOriginChangeCount(
origin, backend->change_tracker()->num_changes());
}
if (!need_notification)
return;
int64_t num_changes = origin_change_map_.GetTotalChangeCount();
for (auto& observer : change_observers_)
observer.OnLocalChangeAvailable(num_changes);
}
void LocalFileSyncService::SetOriginEnabled(const GURL& origin, bool enabled) {
if (!base::Contains(origin_to_contexts_, origin))
return;
origin_change_map_.SetOriginEnabled(origin, enabled);
}
LocalFileSyncService::LocalFileSyncService(Profile* profile,
leveldb::Env* env_override)
: profile_(profile),
sync_context_(
new LocalFileSyncContext(profile_->GetPath(),
env_override,
content::GetUIThreadTaskRunner({}).get(),
content::GetIOThreadTaskRunner({}).get())),
local_change_processor_(nullptr) {
DCHECK_CURRENTLY_ON(BrowserThread::UI);
sync_context_->AddOriginChangeObserver(this);
}
void LocalFileSyncService::DidInitializeFileSystemContext(
const GURL& app_origin,
storage::FileSystemContext* file_system_context,
SyncStatusCallback callback,
SyncStatusCode status) {
if (status != SYNC_STATUS_OK) {
std::move(callback).Run(status);
return;
}
DCHECK(file_system_context);
origin_to_contexts_[app_origin] = file_system_context;
if (pending_origins_with_changes_.find(app_origin) !=
pending_origins_with_changes_.end()) {
// We have remaining changes for the origin.
pending_origins_with_changes_.erase(app_origin);
SyncFileSystemBackend* backend =
SyncFileSystemBackend::GetBackend(file_system_context);
DCHECK(backend);
DCHECK(backend->change_tracker());
origin_change_map_.SetOriginChangeCount(
app_origin, backend->change_tracker()->num_changes());
int64_t num_changes = origin_change_map_.GetTotalChangeCount();
for (auto& observer : change_observers_)
observer.OnLocalChangeAvailable(num_changes);
}
std::move(callback).Run(status);
}
void LocalFileSyncService::DidInitializeForRemoteSync(
const FileSystemURL& url,
storage::FileSystemContext* file_system_context,
PrepareChangeCallback callback,
SyncStatusCode status) {
if (status != SYNC_STATUS_OK) {
DVLOG(1) << "FileSystemContext initialization failed for remote sync:"
<< url.DebugString() << " status=" << status
<< " (" << SyncStatusCodeToString(status) << ")";
std::move(callback).Run(status, SyncFileMetadata(), FileChangeList());
return;
}
origin_to_contexts_[url.origin().GetURL()] = file_system_context;
PrepareForProcessRemoteChange(url, std::move(callback));
}
void LocalFileSyncService::DidApplyRemoteChange(SyncStatusCallback callback,
SyncStatusCode status) {
util::Log(logging::LOGGING_VERBOSE, FROM_HERE,
"[Remote -> Local] ApplyRemoteChange finished --> %s",
SyncStatusCodeToString(status));
std::move(callback).Run(status);
}
void LocalFileSyncService::DidGetFileForLocalSync(
SyncFileCallback callback,
SyncStatusCode status,
const LocalFileSyncInfo& sync_file_info,
storage::ScopedFile snapshot) {
if (status != SYNC_STATUS_OK) {
std::move(callback).Run(status, sync_file_info.url);
return;
}
if (sync_file_info.changes.empty()) {
// There's a slight chance this could happen.
ProcessLocalChange(std::move(callback));
return;
}
FileChange next_change = sync_file_info.changes.front();
DVLOG(1) << "ProcessLocalChange: " << sync_file_info.url.DebugString()
<< " change:" << next_change.DebugString();
GetLocalChangeProcessor(sync_file_info.url)
->ApplyLocalChange(
next_change, sync_file_info.local_file_path, sync_file_info.metadata,
sync_file_info.url,
base::BindOnce(&LocalFileSyncService::ProcessNextChangeForURL,
weak_ptr_factory_.GetWeakPtr(), std::move(callback),
std::move(snapshot), sync_file_info, next_change,
sync_file_info.changes.PopAndGetNewList()));
}
void LocalFileSyncService::ProcessNextChangeForURL(
SyncFileCallback callback,
storage::ScopedFile snapshot,
const LocalFileSyncInfo& sync_file_info,
const FileChange& processed_change,
const FileChangeList& changes,
SyncStatusCode status) {
DVLOG(1) << "Processed one local change: "
<< sync_file_info.url.DebugString()
<< " change:" << processed_change.DebugString()
<< " status:" << status;
if (status == SYNC_STATUS_RETRY) {
GetLocalChangeProcessor(sync_file_info.url)
->ApplyLocalChange(
processed_change, sync_file_info.local_file_path,
sync_file_info.metadata, sync_file_info.url,
base::BindOnce(&LocalFileSyncService::ProcessNextChangeForURL,
weak_ptr_factory_.GetWeakPtr(), std::move(callback),
std::move(snapshot), sync_file_info,
processed_change, changes));
return;
}
if (status == SYNC_FILE_ERROR_NOT_FOUND &&
processed_change.change() == FileChange::FILE_CHANGE_DELETE) {
// This must be ok (and could happen).
status = SYNC_STATUS_OK;
}
const FileSystemURL& url = sync_file_info.url;
if (status != SYNC_STATUS_OK || changes.empty()) {
DCHECK(base::Contains(origin_to_contexts_, url.origin().GetURL()));
sync_context_->FinalizeSnapshotSync(
origin_to_contexts_[url.origin().GetURL()], url, status,
base::BindOnce(std::move(callback), status, url));
return;
}
FileChange next_change = changes.front();
GetLocalChangeProcessor(url)->ApplyLocalChange(
changes.front(), sync_file_info.local_file_path, sync_file_info.metadata,
url,
base::BindOnce(&LocalFileSyncService::ProcessNextChangeForURL,
weak_ptr_factory_.GetWeakPtr(), std::move(callback),
std::move(snapshot), sync_file_info, next_change,
changes.PopAndGetNewList()));
}
LocalChangeProcessor* LocalFileSyncService::GetLocalChangeProcessor(
const FileSystemURL& url) {
if (!get_local_change_processor_.is_null())
return get_local_change_processor_.Run(url.origin().GetURL());
DCHECK(local_change_processor_);
return local_change_processor_;
}
} // namespace sync_file_system
|