dom/filesystem/FileSystemTaskBase.cpp

   1 /* -*- Mode: C++; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
   2 /* vim: set ts=8 sts=2 et sw=2 tw=80: */
   3 /* This Source Code Form is subject to the terms of the Mozilla Public
   4  * License, v. 2.0. If a copy of the MPL was not distributed with this file,
   5  * You can obtain one at http://mozilla.org/MPL/2.0/. */
   6
   7 #include "mozilla/dom/FileSystemTaskBase.h"
   8
   9 #include "nsNetCID.h"
  10 #include "mozilla/dom/File.h"
  11 #include "mozilla/dom/FileSystemBase.h"
  12 #include "mozilla/dom/FileSystemRequestParent.h"
  13 #include "mozilla/dom/FileSystemUtils.h"
  14 #include "mozilla/dom/Promise.h"
  15 #include "mozilla/ipc/BackgroundChild.h"
  16 #include "mozilla/ipc/BackgroundParent.h"
  17 #include "mozilla/ipc/PBackgroundChild.h"
  18 #include "mozilla/Unused.h"
  19 #include "nsProxyRelease.h"
  20
  21 namespace mozilla {
  22 namespace dom {
  23
  24 namespace {
  25
  26 nsresult FileSystemErrorFromNsError(const nsresult& aErrorValue) {
  27   uint16_t module = NS_ERROR_GET_MODULE(aErrorValue);
  28   if (module == NS_ERROR_MODULE_DOM_FILESYSTEM ||
  29       module == NS_ERROR_MODULE_DOM_FILE || module == NS_ERROR_MODULE_DOM) {
  30     return aErrorValue;
  31   }
  32
  33   switch (aErrorValue) {
  34     case NS_OK:
  35       return NS_OK;
  36
  37     case NS_ERROR_FILE_INVALID_PATH:
  38     case NS_ERROR_FILE_UNRECOGNIZED_PATH:
  39       return NS_ERROR_DOM_FILESYSTEM_INVALID_PATH_ERR;
  40
  41     case NS_ERROR_FILE_DESTINATION_NOT_DIR:
  42       return NS_ERROR_DOM_FILESYSTEM_INVALID_MODIFICATION_ERR;
  43
  44     case NS_ERROR_FILE_ACCESS_DENIED:
  45     case NS_ERROR_FILE_DIR_NOT_EMPTY:
  46       return NS_ERROR_DOM_FILESYSTEM_NO_MODIFICATION_ALLOWED_ERR;
  47
  48     case NS_ERROR_FILE_TARGET_DOES_NOT_EXIST:
  49     case NS_ERROR_NOT_AVAILABLE:
  50       return NS_ERROR_DOM_FILE_NOT_FOUND_ERR;
  51
  52     case NS_ERROR_FILE_ALREADY_EXISTS:
  53       return NS_ERROR_DOM_FILESYSTEM_PATH_EXISTS_ERR;
  54
  55     case NS_ERROR_FILE_NOT_DIRECTORY:
  56       return NS_ERROR_DOM_FILESYSTEM_TYPE_MISMATCH_ERR;
  57
  58     case NS_ERROR_UNEXPECTED:
  59     default:
  60       return NS_ERROR_DOM_FILESYSTEM_UNKNOWN_ERR;
  61   }
  62 }
  63
  64 nsresult DispatchToIOThread(nsIRunnable* aRunnable) {
  65   MOZ_ASSERT(aRunnable);
  66
  67   nsCOMPtr<nsIEventTarget> target =
  68       do_GetService(NS_STREAMTRANSPORTSERVICE_CONTRACTID);
  69   MOZ_ASSERT(target);
  70
  71   return target->Dispatch(aRunnable, NS_DISPATCH_NORMAL);
  72 }
  73
  74 // This runnable is used when an error value is set before doing any real
  75 // operation on the I/O thread. In this case we skip all and we directly
  76 // communicate the error.
  77 class ErrorRunnable final : public CancelableRunnable {
  78  public:
  79   explicit ErrorRunnable(FileSystemTaskChildBase* aTask)
  80       : CancelableRunnable("ErrorRunnable"), mTask(aTask) {
  81     MOZ_ASSERT(aTask);
  82   }
  83
  84   NS_IMETHOD
  85   Run() override {
  86     MOZ_ASSERT(NS_IsMainThread());
  87     MOZ_ASSERT(mTask->HasError());
  88
  89     mTask->HandlerCallback();
  90     return NS_OK;
  91   }
  92
  93  private:
  94   RefPtr<FileSystemTaskChildBase> mTask;
  95 };
  96
  97 }  // anonymous namespace
  98
  99 /**
 100  * FileSystemTaskBase class
 101  */
 102
 103 FileSystemTaskChildBase::FileSystemTaskChildBase(nsIGlobalObject* aGlobalObject,
 104                                                  FileSystemBase* aFileSystem)
 105     : mErrorValue(NS_OK),
 106       mFileSystem(aFileSystem),
 107       mGlobalObject(aGlobalObject) {
 108   MOZ_ASSERT(aFileSystem, "aFileSystem should not be null.");
 109   aFileSystem->AssertIsOnOwningThread();
 110   MOZ_ASSERT(aGlobalObject);
 111 }
 112
 113 FileSystemTaskChildBase::~FileSystemTaskChildBase() {
 114   mFileSystem->AssertIsOnOwningThread();
 115 }
 116
 117 FileSystemBase* FileSystemTaskChildBase::GetFileSystem() const {
 118   mFileSystem->AssertIsOnOwningThread();
 119   return mFileSystem.get();
 120 }
 121
 122 void FileSystemTaskChildBase::Start() {
 123   mFileSystem->AssertIsOnOwningThread();
 124
 125   mozilla::ipc::PBackgroundChild* actor =
 126       mozilla::ipc::BackgroundChild::GetOrCreateForCurrentThread();
 127   if (NS_WARN_IF(!actor)) {
 128     // We are probably shutting down.
 129     return;
 130   }
 131
 132   nsAutoString serialization;
 133   mFileSystem->SerializeDOMPath(serialization);
 134
 135   ErrorResult rv;
 136   FileSystemParams params = GetRequestParams(serialization, rv);
 137   if (NS_WARN_IF(rv.Failed())) {
 138     rv.SuppressException();
 139     return;
 140   }
 141
 142   if (NS_IsMainThread()) {
 143     nsIEventTarget* target = mGlobalObject->EventTargetFor(TaskCategory::Other);
 144     MOZ_ASSERT(target);
 145
 146     actor->SetEventTargetForActor(this, target);
 147   }
 148
 149   actor->SendPFileSystemRequestConstructor(this, params);
 150 }
 151
 152 void FileSystemTaskChildBase::SetRequestResult(
 153     const FileSystemResponseValue& aValue) {
 154   mFileSystem->AssertIsOnOwningThread();
 155
 156   if (aValue.type() == FileSystemResponseValue::TFileSystemErrorResponse) {
 157     FileSystemErrorResponse r = aValue;
 158     mErrorValue = r.error();
 159   } else {
 160     ErrorResult rv;
 161     SetSuccessRequestResult(aValue, rv);
 162     mErrorValue = rv.StealNSResult();
 163   }
 164 }
 165
 166 mozilla::ipc::IPCResult FileSystemTaskChildBase::Recv__delete__(
 167     const FileSystemResponseValue& aValue) {
 168   mFileSystem->AssertIsOnOwningThread();
 169
 170   SetRequestResult(aValue);
 171   HandlerCallback();
 172   return IPC_OK();
 173 }
 174
 175 void FileSystemTaskChildBase::SetError(const nsresult& aErrorValue) {
 176   mErrorValue = FileSystemErrorFromNsError(aErrorValue);
 177 }
 178
 179 /**
 180  * FileSystemTaskParentBase class
 181  */
 182
 183 FileSystemTaskParentBase::FileSystemTaskParentBase(
 184     FileSystemBase* aFileSystem, const FileSystemParams& aParam,
 185     FileSystemRequestParent* aParent)
 186     : Runnable("dom::FileSystemTaskParentBase"),
 187       mErrorValue(NS_OK),
 188       mFileSystem(aFileSystem),
 189       mRequestParent(aParent),
 190       mBackgroundEventTarget(GetCurrentThreadEventTarget()) {
 191   MOZ_ASSERT(XRE_IsParentProcess(), "Only call from parent process!");
 192   MOZ_ASSERT(aFileSystem, "aFileSystem should not be null.");
 193   MOZ_ASSERT(aParent);
 194   MOZ_ASSERT(mBackgroundEventTarget);
 195   AssertIsOnBackgroundThread();
 196 }
 197
 198 FileSystemTaskParentBase::~FileSystemTaskParentBase() {
 199   // This task can be released on different threads because we dispatch it (as
 200   // runnable) to main-thread, I/O and then back to the PBackground thread.
 201   NS_ProxyRelease("FileSystemTaskParentBase::mFileSystem",
 202                   mBackgroundEventTarget, mFileSystem.forget());
 203   NS_ProxyRelease("FileSystemTaskParentBase::mRequestParent",
 204                   mBackgroundEventTarget, mRequestParent.forget());
 205 }
 206
 207 void FileSystemTaskParentBase::Start() {
 208   AssertIsOnBackgroundThread();
 209   mFileSystem->AssertIsOnOwningThread();
 210
 211   DebugOnly<nsresult> rv = DispatchToIOThread(this);
 212   NS_WARNING_ASSERTION(NS_SUCCEEDED(rv), "DispatchToIOThread failed");
 213 }
 214
 215 void FileSystemTaskParentBase::HandleResult() {
 216   AssertIsOnBackgroundThread();
 217   mFileSystem->AssertIsOnOwningThread();
 218
 219   if (mFileSystem->IsShutdown()) {
 220     return;
 221   }
 222
 223   MOZ_ASSERT(mRequestParent);
 224   Unused << mRequestParent->Send__delete__(mRequestParent, GetRequestResult());
 225 }
 226
 227 FileSystemResponseValue FileSystemTaskParentBase::GetRequestResult() const {
 228   AssertIsOnBackgroundThread();
 229   mFileSystem->AssertIsOnOwningThread();
 230
 231   if (HasError()) {
 232     return FileSystemErrorResponse(mErrorValue);
 233   }
 234
 235   ErrorResult rv;
 236   FileSystemResponseValue value = GetSuccessRequestResult(rv);
 237   if (NS_WARN_IF(rv.Failed())) {
 238     return FileSystemErrorResponse(rv.StealNSResult());
 239   }
 240
 241   return value;
 242 }
 243
 244 void FileSystemTaskParentBase::SetError(const nsresult& aErrorValue) {
 245   mErrorValue = FileSystemErrorFromNsError(aErrorValue);
 246 }
 247
 248 NS_IMETHODIMP
 249 FileSystemTaskParentBase::Run() {
 250   // This method can run in 2 different threads. Here why:
 251   // 1. We are are on the I/O thread and we call IOWork().
 252   // 2. After step 1, it returns back to the PBackground thread.
 253
 254   // Run I/O thread tasks
 255   if (!IsOnBackgroundThread()) {
 256     nsresult rv = IOWork();
 257     if (NS_WARN_IF(NS_FAILED(rv))) {
 258       SetError(rv);
 259     }
 260
 261     // Let's go back to PBackground thread to finish the work.
 262     rv = mBackgroundEventTarget->Dispatch(this, NS_DISPATCH_NORMAL);
 263     if (NS_WARN_IF(NS_FAILED(rv))) {
 264       return rv;
 265     }
 266
 267     return NS_OK;
 268   }
 269
 270   // If we are here, it's because the I/O work has been done and we have to
 271   // handle the result back via IPC.
 272   AssertIsOnBackgroundThread();
 273   HandleResult();
 274   return NS_OK;
 275 }
 276
 277 }  // namespace dom
 278 }  // namespace mozilla