SyncFS: Introduce SyncFileSystemBackend

webkit/browser/fileapi/sandbox_file_system_backend.cc

 // Copyright (c) 2012 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.
 
 #include "webkit/browser/fileapi/sandbox_file_system_backend.h"
 
 #include "base/bind.h"
 #include "base/command_line.h"
 #include "base/file_util.h"
 #include "base/logging.h"
@@ skipping 46 matching lines @@
   kIncognito,
   kInvalidSchemeError,
   kCreateDirectoryError,
   kNotFound,
   kUnknownError,
   kFileSystemErrorMax,
 };
 
 const char kTemporaryOriginsCountLabel[] = "FileSystem.TemporaryOriginsCount";
 const char kPersistentOriginsCountLabel[] = "FileSystem.PersistentOriginsCount";
-const char kSyncableOriginsCountLabel[] = "FileSystem.SyncableOriginsCount";
 
 // Restricted names.
 // http://dev.w3.org/2009/dap/file-system/file-dir-sys.html#naming-restrictions
 const base::FilePath::CharType* const kRestrictedNames[] = {
   FILE_PATH_LITERAL("."), FILE_PATH_LITERAL(".."),
 };
 
 // Restricted chars.
 const base::FilePath::CharType kRestrictedChars[] = {
   FILE_PATH_LITERAL('/'), FILE_PATH_LITERAL('\\'),
@@ skipping 13 matching lines @@
 
   virtual bool HasFileSystemType(fileapi::FileSystemType type) const OVERRIDE {
     return enum_->HasFileSystemType(type);
   }
 
  private:
   scoped_ptr<ObfuscatedFileUtil::AbstractOriginEnumerator> enum_;
 };
 
 void DidOpenFileSystem(
-    base::WeakPtr<SandboxFileSystemBackend> mount_point_provider,
+    base::WeakPtr<SandboxFileSystemBackend> file_system_backend,
     const base::Callback<void(base::PlatformFileError error)>& callback,
     base::PlatformFileError* error) {
-  if (mount_point_provider.get())
-    mount_point_provider.get()->CollectOpenFileSystemMetrics(*error);
+  if (file_system_backend.get())
+    file_system_backend.get()->CollectOpenFileSystemMetrics(*error);
   callback.Run(*error);
 }
 
 void OpenFileSystemOnFileThread(
     ObfuscatedFileUtil* file_util,
     const GURL& origin_url,
     FileSystemType type,
     OpenFileSystemMode mode,
     base::PlatformFileError* error_ptr) {
   DCHECK(error_ptr);
@@ skipping 11 matching lines @@
   }
   // The reference of file_util will be derefed on the FILE thread
   // when the storage of this callback gets deleted regardless of whether
   // this method is called or not.
 }
 
 }  // anonymous namespace
 
 SandboxFileSystemBackend::SandboxFileSystemBackend(
     SandboxContext* sandbox_context,
+    base::SequencedTaskRunner* file_task_runner,
     const FileSystemOptions& file_system_options)
-    : file_system_options_(file_system_options),
+    : file_task_runner_(file_task_runner),

[kinuko, 2013/07/17 15:01:30]

Why does this need to be passed separately in this CL?

[kinuko, 2013/07/17 15:02:59]

I mean, it used to be passed via sandbox_context but in this CL we pass this as
a separate value.  Can you explain why this change is necessary?

[nhiroki, 2013/07/22 04:34:14]

This is because that SyncFileSystemBackend::set_change_tracker needs the runner
before calling InitializeFileSystem().

Probably it is no longer necessary to pass separately because of calling
LazyInitialize() in GetFileUtil().

[nhiroki, 2013/07/22 06:33:38]

Pushed file_task_runner into SandboxContext again.

+      file_system_options_(file_system_options),
       sandbox_context_(sandbox_context),
       enable_temporary_file_system_in_incognito_(false),
       enable_usage_tracking_(
           !CommandLine::ForCurrentProcess()->HasSwitch(
               kDisableUsageTracking)),
       weak_factory_(this) {
+  // SyncFileSystemBackend is instantiated with null context.
+  if (!sandbox_context)
+    return;
+
   // Set quota observers.
   if (enable_usage_tracking_) {
     update_observers_ = update_observers_.AddObserver(
-        sandbox_context_->quota_observer(),
-        sandbox_context_->file_task_runner());
+        sandbox_context_->quota_observer(), file_task_runner_.get());
     access_observers_ = access_observers_.AddObserver(
         sandbox_context_->quota_observer(), NULL);
   }
 
-  syncable_update_observers_ = update_observers_;
-
-  if (!sandbox_context_->file_task_runner()->RunsTasksOnCurrentThread()) {
+  if (!file_task_runner->RunsTasksOnCurrentThread()) {
     // Post prepopulate task only if it's not already running on
     // file_task_runner (which implies running in tests).
-    sandbox_context_->file_task_runner()->PostTask(
+    file_task_runner->PostTask(
         FROM_HERE,
         base::Bind(&ObfuscatedFileUtil::MaybePrepopulateDatabase,
                   base::Unretained(sandbox_sync_file_util())));
   }
 }
 
 SandboxFileSystemBackend::~SandboxFileSystemBackend() {
 }
 
 bool SandboxFileSystemBackend::CanHandleType(FileSystemType type) const {
   return type == kFileSystemTypeTemporary ||
-         type == kFileSystemTypePersistent ||
-         type == kFileSystemTypeSyncable ||
-         type == kFileSystemTypeSyncableForInternalSync;
+         type == kFileSystemTypePersistent;
 }
 
 void SandboxFileSystemBackend::InitializeFileSystem(
     const GURL& origin_url,
     fileapi::FileSystemType type,
     OpenFileSystemMode mode,
     FileSystemContext* context,
     const InitializeFileSystemCallback& callback) {
   if (file_system_options_.is_incognito() &&
       !(type == kFileSystemTypeTemporary &&
@@ skipping 15 matching lines @@
   }
 
   // TODO(nhiroki): Factor out SyncFS related code to SyncFileSystemBackend we
   // plan to introduce. (http://crbug.com/242422/)
   GURL root_url = (type == kFileSystemTypeSyncable)
       ? sync_file_system::GetSyncableFileSystemRootURI(origin_url)
       : GetFileSystemRootURI(origin_url, type);
   std::string name = GetFileSystemName(origin_url, type);
 
   base::PlatformFileError* error_ptr = new base::PlatformFileError;
-  sandbox_context_->file_task_runner()->PostTaskAndReply(
+  file_task_runner_->PostTaskAndReply(
       FROM_HERE,
       base::Bind(&OpenFileSystemOnFileThread,
                  sandbox_sync_file_util(),
                  origin_url, type, mode,
                  base::Unretained(error_ptr)),
       base::Bind(&DidOpenFileSystem,
                  weak_factory_.GetWeakPtr(),
                  base::Bind(callback, root_url, name),
                  base::Owned(error_ptr)));
 
   if (enable_usage_tracking_)
     return;
 
   // Schedule full usage recalculation on the next launch without
   // --disable-file-system-usage-tracking.
-  sandbox_context_->file_task_runner()->PostTask(
+  file_task_runner_->PostTask(
       FROM_HERE,
       base::Bind(&SandboxFileSystemBackend::InvalidateUsageCacheOnFileThread,
                  sandbox_sync_file_util(), origin_url, type, usage_cache()));
 };
 
 FileSystemFileUtil* SandboxFileSystemBackend::GetFileUtil(
-    FileSystemType type) {
+    FileSystemType type,
+    const FileSystemContext* context) {
   DCHECK(sandbox_context_);
   return sandbox_context_->sync_file_util();
 }
 
 AsyncFileUtil* SandboxFileSystemBackend::GetAsyncFileUtil(
-    FileSystemType type) {
+    FileSystemType type,
+    const FileSystemContext* context) {
   DCHECK(sandbox_context_);
   return sandbox_context_->file_util();
 }
 
 CopyOrMoveFileValidatorFactory*
 SandboxFileSystemBackend::GetCopyOrMoveFileValidatorFactory(
     FileSystemType type,
     base::PlatformFileError* error_code) {
   DCHECK(error_code);
   *error_code = base::PLATFORM_FILE_OK;
   return NULL;
 }
 
 FileSystemOperation* SandboxFileSystemBackend::CreateFileSystemOperation(
     const FileSystemURL& url,
     FileSystemContext* context,
     base::PlatformFileError* error_code) const {
   if (!IsAccessValid(url)) {
     *error_code = base::PLATFORM_FILE_ERROR_SECURITY;
     return NULL;
   }
 
   scoped_ptr<FileSystemOperationContext> operation_context(
       new FileSystemOperationContext(context));
-
-  // Copy the observer lists (assuming we only have small number of observers).
-  if (url.type() == kFileSystemTypeSyncable) {
-    operation_context->set_update_observers(syncable_update_observers_);
-    operation_context->set_change_observers(syncable_change_observers_);
-    return new sync_file_system::SyncableFileSystemOperation(
-        url, context, operation_context.Pass());
-  }
-
-  // For regular sandboxed types.
   operation_context->set_update_observers(update_observers_);
   operation_context->set_change_observers(change_observers_);
 
   SpecialStoragePolicy* policy = sandbox_context_->special_storage_policy();
   if (policy && policy->IsStorageUnlimited(url.origin()))
     operation_context->set_quota_limit_type(quota::kQuotaLimitTypeUnlimited);
   else
     operation_context->set_quota_limit_type(quota::kQuotaLimitTypeLimited);
 
   return new LocalFileSystemOperation(url, context, operation_context.Pass());
@@ skipping 77 matching lines @@
     if (enumerator->HasFileSystemType(type))
       origins->insert(origin);
   }
   switch (type) {
     case kFileSystemTypeTemporary:
       UMA_HISTOGRAM_COUNTS(kTemporaryOriginsCountLabel, origins->size());
       break;
     case kFileSystemTypePersistent:
       UMA_HISTOGRAM_COUNTS(kPersistentOriginsCountLabel, origins->size());
       break;
-    case kFileSystemTypeSyncable:
-      UMA_HISTOGRAM_COUNTS(kSyncableOriginsCountLabel, origins->size());
-      break;
     default:
       break;
   }
 }
 
 void SandboxFileSystemBackend::GetOriginsForHostOnFileThread(
     fileapi::FileSystemType type, const std::string& host,
     std::set<GURL>* origins) {
   DCHECK(CanHandleType(type));
   DCHECK(origins);
@@ skipping 68 matching lines @@
   sandbox_context_->quota_observer()->SetUsageCacheEnabled(origin, type, false);
   InvalidateUsageCache(origin, type);
 }
 
 void SandboxFileSystemBackend::AddFileUpdateObserver(
     FileSystemType type,
     FileUpdateObserver* observer,
     base::SequencedTaskRunner* task_runner) {
   DCHECK(CanHandleType(type));
   UpdateObserverList* list = &update_observers_;
-  if (type == kFileSystemTypeSyncable)
-    list = &syncable_update_observers_;
   *list = list->AddObserver(observer, task_runner);
 }
 
 void SandboxFileSystemBackend::AddFileChangeObserver(
     FileSystemType type,
     FileChangeObserver* observer,
     base::SequencedTaskRunner* task_runner) {
   DCHECK(CanHandleType(type));
   ChangeObserverList* list = &change_observers_;
-  if (type == kFileSystemTypeSyncable)
-    list = &syncable_change_observers_;
   *list = list->AddObserver(observer, task_runner);
 }
 
 void SandboxFileSystemBackend::AddFileAccessObserver(
     FileSystemType type,
     FileAccessObserver* observer,
     base::SequencedTaskRunner* task_runner) {
   DCHECK(CanHandleType(type));
   access_observers_ = access_observers_.AddObserver(observer, task_runner);
 }
 
 const UpdateObserverList* SandboxFileSystemBackend::GetUpdateObservers(
     FileSystemType type) const {
   DCHECK(CanHandleType(type));
-  if (type == kFileSystemTypeSyncable)
-    return &syncable_update_observers_;
   return &update_observers_;
 }
 
 const ChangeObserverList* SandboxFileSystemBackend::GetChangeObservers(
     FileSystemType type) const {
   DCHECK(CanHandleType(type));
-  if (type == kFileSystemTypeSyncable)
-    return &syncable_change_observers_;
   return &change_observers_;
 }
 
 const AccessObserverList* SandboxFileSystemBackend::GetAccessObservers(
     FileSystemType type) const {
   DCHECK(CanHandleType(type));
   return &access_observers_;
 }
 
 void SandboxFileSystemBackend::CollectOpenFileSystemMetrics(
@@ skipping 150 matching lines @@
 
   while (!(file_path_each = enumerator->Next()).empty()) {
     usage += enumerator->Size();
     usage += ObfuscatedFileUtil::ComputeFilePathCost(file_path_each);
   }
 
   return usage;
 }
 
 }  // namespace fileapi