chrome/browser/chromeos/drive/fileapi/async_file_util.cc

// Copyright 2014 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 "chrome/browser/chromeos/drive/fileapi/async_file_util.h"

#include <utility>

#include "base/bind.h"
#include "base/callback.h"
#include "base/files/file_path.h"
#include "base/logging.h"
#include "base/single_thread_task_runner.h"
#include "base/task/post_task.h"
#include "base/threading/thread_task_runner_handle.h"
#include "chrome/browser/chromeos/drive/drive_integration_service.h"
#include "chrome/browser/chromeos/drive/file_system_util.h"
#include "chrome/browser/chromeos/drive/fileapi/fileapi_worker.h"
#include "content/public/browser/browser_task_traits.h"
#include "content/public/browser/browser_thread.h"
#include "google_apis/drive/task_util.h"
#include "storage/browser/blob/shareable_file_reference.h"
#include "storage/browser/fileapi/file_system_operation_context.h"
#include "storage/browser/fileapi/file_system_url.h"

using content::BrowserThread;

namespace drive {
namespace internal {
namespace {

// Posts fileapi_internal::RunFileSystemCallback to UI thread.
// This function must be called on IO thread.
// The |on_error_callback| will be called (on error case) on IO thread.
void PostFileSystemCallback(
    const fileapi_internal::FileSystemGetter& file_system_getter,
    const base::Callback<void(FileSystemInterface*)>& function,
    const base::Closure& on_error_callback) {
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  base::PostTask(
      FROM_HERE, {BrowserThread::UI},
      base::BindOnce(&fileapi_internal::RunFileSystemCallback,
                     file_system_getter, function,
                     on_error_callback.is_null()
                         ? base::Closure()
                         : base::Bind(&google_apis::RunTaskWithTaskRunner,
                                      base::ThreadTaskRunnerHandle::Get(),
                                      on_error_callback)));
}

// Runs CreateOrOpenFile callback based on the given |error| and |file|.
void RunCreateOrOpenFileCallback(
    AsyncFileUtil::CreateOrOpenCallback callback,
    base::File file,
    const base::Closure& close_callback_on_ui_thread) {
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  // It is necessary to make a closure, which runs on file closing here.
  // It will be provided as a FileSystem::OpenFileCallback's argument later.
  // (crbug.com/259184).
  std::move(callback).Run(
      std::move(file),
      base::Bind(&google_apis::RunTaskWithTaskRunner,
                 base::CreateSingleThreadTaskRunner({BrowserThread::UI}),
                 close_callback_on_ui_thread));
}

// Runs CreateOrOpenFile when the error happens.
void RunCreateOrOpenFileCallbackOnError(
    AsyncFileUtil::CreateOrOpenCallback callback,
    base::File::Error error) {
  std::move(callback).Run(base::File(error), base::Closure());
}

// Runs EnsureFileExistsCallback based on the given |error|.
void RunEnsureFileExistsCallback(
    AsyncFileUtil::EnsureFileExistsCallback callback,
    base::File::Error error) {
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  // Remember if the file is actually created or not.
  bool created = (error == base::File::FILE_OK);

  // File::FILE_ERROR_EXISTS is not an actual error here.
  if (error == base::File::FILE_ERROR_EXISTS)
    error = base::File::FILE_OK;

  std::move(callback).Run(error, created);
}

// Runs |callback| with the arguments based on the given arguments.
void RunCreateSnapshotFileCallback(
    AsyncFileUtil::CreateSnapshotFileCallback callback,
    base::File::Error error,
    const base::File::Info& file_info,
    const base::FilePath& local_path,
    storage::ScopedFile::ScopeOutPolicy scope_out_policy) {
  // ShareableFileReference is thread *unsafe* class. So it is necessary to
  // create the instance (by invoking GetOrCreate) on IO thread, though
  // most drive file system related operations run on UI thread.
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  scoped_refptr<storage::ShareableFileReference> file_reference =
      storage::ShareableFileReference::GetOrCreate(
          storage::ScopedFile(local_path, scope_out_policy,
                              base::CreateSequencedTaskRunner(
                                  {base::ThreadPool(), base::MayBlock(),
                                   base::TaskPriority::USER_BLOCKING})));
  std::move(callback).Run(error, file_info, local_path,
                          std::move(file_reference));
}

}  // namespace

AsyncFileUtil::AsyncFileUtil() = default;

AsyncFileUtil::~AsyncFileUtil() = default;

void AsyncFileUtil::CreateOrOpen(
    std::unique_ptr<storage::FileSystemOperationContext> context,
    const storage::FileSystemURL& url,
    int file_flags,
    CreateOrOpenCallback callback) {
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  base::FilePath file_path = util::ExtractDrivePathFromFileSystemUrl(url);
  if (file_path.empty()) {
    std::move(callback).Run(base::File(base::File::FILE_ERROR_NOT_FOUND),
                            base::Closure());
    return;
  }

  // TODO(tzik): Update PostFileSystemCallback to remove
  // AdaptCallbackForRepeating here.
  auto copyable_callback = base::AdaptCallbackForRepeating(std::move(callback));
  const fileapi_internal::FileSystemGetter getter =
      base::Bind(&fileapi_internal::GetFileSystemFromUrl, url);
  PostFileSystemCallback(
      getter,
      base::Bind(&fileapi_internal::OpenFile, file_path, file_flags,
                 google_apis::CreateRelayCallback(base::Bind(
                     &RunCreateOrOpenFileCallback, copyable_callback))),
      base::Bind(&RunCreateOrOpenFileCallbackOnError, copyable_callback,
                 base::File::FILE_ERROR_FAILED));
}

void AsyncFileUtil::EnsureFileExists(
    std::unique_ptr<storage::FileSystemOperationContext> context,
    const storage::FileSystemURL& url,
    EnsureFileExistsCallback callback) {
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  base::FilePath file_path = util::ExtractDrivePathFromFileSystemUrl(url);
  if (file_path.empty()) {
    std::move(callback).Run(base::File::FILE_ERROR_NOT_FOUND, false);
    return;
  }

  // TODO(tzik): Update PostFileSystemCallback to remove
  // AdaptCallbackForRepeating here.
  auto copyable_callback = base::AdaptCallbackForRepeating(std::move(callback));
  PostFileSystemCallback(
      base::Bind(&fileapi_internal::GetFileSystemFromUrl, url),
      base::Bind(&fileapi_internal::CreateFile, file_path,
                 true /* is_exlusive */,
                 google_apis::CreateRelayCallback(base::Bind(
                     &RunEnsureFileExistsCallback, copyable_callback))),
      base::Bind(copyable_callback, base::File::FILE_ERROR_FAILED, false));
}

void AsyncFileUtil::CreateDirectory(
    std::unique_ptr<storage::FileSystemOperationContext> context,
    const storage::FileSystemURL& url,
    bool exclusive,
    bool recursive,
    StatusCallback callback) {
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  base::FilePath file_path = util::ExtractDrivePathFromFileSystemUrl(url);
  if (file_path.empty()) {
    std::move(callback).Run(base::File::FILE_ERROR_NOT_FOUND);
    return;
  }

  // TODO(tzik): Update PostFileSystemCallback to remove
  // AdaptCallbackForRepeating here.
  auto copyable_callback = base::AdaptCallbackForRepeating(std::move(callback));
  PostFileSystemCallback(
      base::Bind(&fileapi_internal::GetFileSystemFromUrl, url),
      base::Bind(&fileapi_internal::CreateDirectory, file_path, exclusive,
                 recursive,
                 google_apis::CreateRelayCallback(copyable_callback)),
      base::Bind(copyable_callback, base::File::FILE_ERROR_FAILED));
}

void AsyncFileUtil::GetFileInfo(
    std::unique_ptr<storage::FileSystemOperationContext> context,
    const storage::FileSystemURL& url,
    int /* fields */,
    GetFileInfoCallback callback) {
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  base::FilePath file_path = util::ExtractDrivePathFromFileSystemUrl(url);
  if (file_path.empty()) {
    std::move(callback).Run(base::File::FILE_ERROR_NOT_FOUND,
                            base::File::Info());
    return;
  }

  // TODO(tzik): Update PostFileSystemCallback to remove
  // AdaptCallbackForRepeating here.
  auto copyable_callback = base::AdaptCallbackForRepeating(std::move(callback));
  PostFileSystemCallback(
      base::Bind(&fileapi_internal::GetFileSystemFromUrl, url),
      base::Bind(&fileapi_internal::GetFileInfo, file_path,
                 google_apis::CreateRelayCallback(copyable_callback)),
      base::Bind(copyable_callback, base::File::FILE_ERROR_FAILED,
                 base::File::Info()));
}

void AsyncFileUtil::ReadDirectory(
    std::unique_ptr<storage::FileSystemOperationContext> context,
    const storage::FileSystemURL& url,
    ReadDirectoryCallback callback) {
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  base::FilePath file_path = util::ExtractDrivePathFromFileSystemUrl(url);
  if (file_path.empty()) {
    callback.Run(base::File::FILE_ERROR_NOT_FOUND, EntryList(), false);
    return;
  }

  PostFileSystemCallback(
      base::Bind(&fileapi_internal::GetFileSystemFromUrl, url),
      base::Bind(&fileapi_internal::ReadDirectory,
                 file_path, google_apis::CreateRelayCallback(callback)),
      base::Bind(callback, base::File::FILE_ERROR_FAILED,
                 EntryList(), false));
}

void AsyncFileUtil::Touch(
    std::unique_ptr<storage::FileSystemOperationContext> context,
    const storage::FileSystemURL& url,
    const base::Time& last_access_time,
    const base::Time& last_modified_time,
    StatusCallback callback) {
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  base::FilePath file_path = util::ExtractDrivePathFromFileSystemUrl(url);
  if (file_path.empty()) {
    std::move(callback).Run(base::File::FILE_ERROR_NOT_FOUND);
    return;
  }

  // TODO(tzik): Update PostFileSystemCallback to remove
  // AdaptCallbackForRepeating here.
  auto copyable_callback = base::AdaptCallbackForRepeating(std::move(callback));
  PostFileSystemCallback(
      base::Bind(&fileapi_internal::GetFileSystemFromUrl, url),
      base::Bind(&fileapi_internal::TouchFile, file_path, last_access_time,
                 last_modified_time,
                 google_apis::CreateRelayCallback(copyable_callback)),
      base::Bind(copyable_callback, base::File::FILE_ERROR_FAILED));
}

void AsyncFileUtil::Truncate(
    std::unique_ptr<storage::FileSystemOperationContext> context,
    const storage::FileSystemURL& url,
    int64_t length,
    StatusCallback callback) {
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  base::FilePath file_path = util::ExtractDrivePathFromFileSystemUrl(url);
  if (file_path.empty()) {
    std::move(callback).Run(base::File::FILE_ERROR_NOT_FOUND);
    return;
  }

  // TODO(tzik): Update PostFileSystemCallback to remove
  // AdaptCallbackForRepeating here.
  auto copyable_callback = base::AdaptCallbackForRepeating(std::move(callback));
  PostFileSystemCallback(
      base::Bind(&fileapi_internal::GetFileSystemFromUrl, url),
      base::Bind(&fileapi_internal::Truncate, file_path, length,
                 google_apis::CreateRelayCallback(copyable_callback)),
      base::Bind(copyable_callback, base::File::FILE_ERROR_FAILED));
}

void AsyncFileUtil::CopyFileLocal(
    std::unique_ptr<storage::FileSystemOperationContext> context,
    const storage::FileSystemURL& src_url,
    const storage::FileSystemURL& dest_url,
    CopyOrMoveOption option,
    CopyFileProgressCallback progress_callback,
    StatusCallback callback) {
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  base::FilePath src_path = util::ExtractDrivePathFromFileSystemUrl(src_url);
  base::FilePath dest_path = util::ExtractDrivePathFromFileSystemUrl(dest_url);
  if (src_path.empty() || dest_path.empty()) {
    std::move(callback).Run(base::File::FILE_ERROR_NOT_FOUND);
    return;
  }

  // TODO(kinaba): crbug.com/339794.
  // Assumption here is that |src_url| and |dest_url| are always from the same
  // profile. This indeed holds as long as we mount different profiles onto
  // different mount point. Hence, using GetFileSystemFromUrl(dest_url) is safe.
  // This will change after we introduce cross-profile sharing etc., and we
  // need to deal with files from different profiles here.
  // TODO(tzik): Update PostFileSystemCallback to remove
  // AdaptCallbackForRepeating here.
  auto copyable_callback = base::AdaptCallbackForRepeating(std::move(callback));
  PostFileSystemCallback(
      base::Bind(&fileapi_internal::GetFileSystemFromUrl, dest_url),
      base::Bind(
          &fileapi_internal::Copy, src_path, dest_path,
          option == storage::FileSystemOperation::OPTION_PRESERVE_LAST_MODIFIED,
          google_apis::CreateRelayCallback(copyable_callback)),
      base::Bind(copyable_callback, base::File::FILE_ERROR_FAILED));
}

void AsyncFileUtil::MoveFileLocal(
    std::unique_ptr<storage::FileSystemOperationContext> context,
    const storage::FileSystemURL& src_url,
    const storage::FileSystemURL& dest_url,
    CopyOrMoveOption option,
    StatusCallback callback) {
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  base::FilePath src_path = util::ExtractDrivePathFromFileSystemUrl(src_url);
  base::FilePath dest_path = util::ExtractDrivePathFromFileSystemUrl(dest_url);
  if (src_path.empty() || dest_path.empty()) {
    std::move(callback).Run(base::File::FILE_ERROR_NOT_FOUND);
    return;
  }

  // TODO(kinaba): see the comment in CopyFileLocal(). |src_url| and |dest_url|
  // always return the same FileSystem by GetFileSystemFromUrl, but we need to
  // change it in order to support cross-profile file sharing etc.
  // TODO(tzik): Update PostFileSystemCallback to remove
  // AdaptCallbackForRepeating here.
  auto copyable_callback = base::AdaptCallbackForRepeating(std::move(callback));
  PostFileSystemCallback(
      base::Bind(&fileapi_internal::GetFileSystemFromUrl, dest_url),
      base::Bind(&fileapi_internal::Move, src_path, dest_path,
                 google_apis::CreateRelayCallback(copyable_callback)),
      base::Bind(copyable_callback, base::File::FILE_ERROR_FAILED));
}

void AsyncFileUtil::CopyInForeignFile(
    std::unique_ptr<storage::FileSystemOperationContext> context,
    const base::FilePath& src_file_path,
    const storage::FileSystemURL& dest_url,
    StatusCallback callback) {
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  base::FilePath dest_path = util::ExtractDrivePathFromFileSystemUrl(dest_url);
  if (dest_path.empty()) {
    std::move(callback).Run(base::File::FILE_ERROR_NOT_FOUND);
    return;
  }

  // TODO(tzik): Update PostFileSystemCallback to remove
  // AdaptCallbackForRepeating here.
  auto copyable_callback = base::AdaptCallbackForRepeating(std::move(callback));
  PostFileSystemCallback(
      base::Bind(&fileapi_internal::GetFileSystemFromUrl, dest_url),
      base::Bind(&fileapi_internal::CopyInForeignFile, src_file_path, dest_path,
                 google_apis::CreateRelayCallback(copyable_callback)),
      base::Bind(copyable_callback, base::File::FILE_ERROR_FAILED));
}

void AsyncFileUtil::DeleteFile(
    std::unique_ptr<storage::FileSystemOperationContext> context,
    const storage::FileSystemURL& url,
    StatusCallback callback) {
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  base::FilePath file_path = util::ExtractDrivePathFromFileSystemUrl(url);
  if (file_path.empty()) {
    std::move(callback).Run(base::File::FILE_ERROR_NOT_FOUND);
    return;
  }

  // TODO(tzik): Update PostFileSystemCallback to remove
  // AdaptCallbackForRepeating here.
  auto copyable_callback = base::AdaptCallbackForRepeating(std::move(callback));
  PostFileSystemCallback(
      base::Bind(&fileapi_internal::GetFileSystemFromUrl, url),
      base::Bind(&fileapi_internal::Remove, file_path,
                 false /* not recursive */,
                 google_apis::CreateRelayCallback(copyable_callback)),
      base::Bind(copyable_callback, base::File::FILE_ERROR_FAILED));
}

void AsyncFileUtil::DeleteDirectory(
    std::unique_ptr<storage::FileSystemOperationContext> context,
    const storage::FileSystemURL& url,
    StatusCallback callback) {
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  base::FilePath file_path = util::ExtractDrivePathFromFileSystemUrl(url);
  if (file_path.empty()) {
    std::move(callback).Run(base::File::FILE_ERROR_NOT_FOUND);
    return;
  }

  // TODO(tzik): Update PostFileSystemCallback to remove
  // AdaptCallbackForRepeating here.
  auto copyable_callback = base::AdaptCallbackForRepeating(std::move(callback));
  PostFileSystemCallback(
      base::Bind(&fileapi_internal::GetFileSystemFromUrl, url),
      base::Bind(&fileapi_internal::Remove, file_path,
                 false /* not recursive */,
                 google_apis::CreateRelayCallback(copyable_callback)),
      base::Bind(copyable_callback, base::File::FILE_ERROR_FAILED));
}

void AsyncFileUtil::DeleteRecursively(
    std::unique_ptr<storage::FileSystemOperationContext> context,
    const storage::FileSystemURL& url,
    StatusCallback callback) {
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  base::FilePath file_path = util::ExtractDrivePathFromFileSystemUrl(url);
  if (file_path.empty()) {
    std::move(callback).Run(base::File::FILE_ERROR_NOT_FOUND);
    return;
  }

  // TODO(tzik): Update PostFileSystemCallback to remove
  // AdaptCallbackForRepeating here.
  auto copyable_callback = base::AdaptCallbackForRepeating(std::move(callback));
  PostFileSystemCallback(
      base::Bind(&fileapi_internal::GetFileSystemFromUrl, url),
      base::Bind(&fileapi_internal::Remove, file_path, true /* recursive */,
                 google_apis::CreateRelayCallback(copyable_callback)),
      base::Bind(copyable_callback, base::File::FILE_ERROR_FAILED));
}

void AsyncFileUtil::CreateSnapshotFile(
    std::unique_ptr<storage::FileSystemOperationContext> context,
    const storage::FileSystemURL& url,
    CreateSnapshotFileCallback callback) {
  DCHECK_CURRENTLY_ON(BrowserThread::IO);

  base::FilePath file_path = util::ExtractDrivePathFromFileSystemUrl(url);
  if (file_path.empty()) {
    std::move(callback).Run(base::File::FILE_ERROR_NOT_FOUND,
                            base::File::Info(), base::FilePath(),
                            scoped_refptr<storage::ShareableFileReference>());
    return;
  }

  // TODO(tzik): Update PostFileSystemCallback to remove
  // AdaptCallbackForRepeating here.
  auto copyable_callback = base::AdaptCallbackForRepeating(std::move(callback));
  PostFileSystemCallback(
      base::Bind(&fileapi_internal::GetFileSystemFromUrl, url),
      base::Bind(&fileapi_internal::CreateSnapshotFile, file_path,
                 google_apis::CreateRelayCallback(base::Bind(
                     &RunCreateSnapshotFileCallback, copyable_callback))),
      base::Bind(copyable_callback, base::File::FILE_ERROR_FAILED,
                 base::File::Info(), base::FilePath(),
                 scoped_refptr<storage::ShareableFileReference>()));
}

}  // namespace internal
}  // namespace drive