Bug 1263992 - patch 1 - Remove DirectoryType enum, r=smaug

dom/base/StructuredCloneHolder.cpp

@@ -707,8 +707,7 @@ WriteBlob(JSStructuredCloneWriter* aWriter,
 }
 
 // A directory is serialized as:
-// - pair of ints: SCTAG_DOM_DIRECTORY, 0
-// - pair of ints: type (eDOMRootDirectory/eDOMNotRootDirectory) - path length
+// - pair of ints: SCTAG_DOM_DIRECTORY, path length
 // - path as string
 bool
 WriteDirectory(JSStructuredCloneWriter* aWriter,
@@ -721,36 +720,25 @@ WriteDirectory(JSStructuredCloneWriter* aWriter,
   aDirectory->GetFullRealPath(path);
 
   size_t charSize = sizeof(nsString::char_type);
-  return JS_WriteUint32Pair(aWriter, SCTAG_DOM_DIRECTORY, 0) &&
-         JS_WriteUint32Pair(aWriter, (uint32_t)aDirectory->Type(),
-                            path.Length()) &&
+  return JS_WriteUint32Pair(aWriter, SCTAG_DOM_DIRECTORY, path.Length()) &&
          JS_WriteBytes(aWriter, path.get(), path.Length() * charSize);
 }
 
 JSObject*
 ReadDirectory(JSContext* aCx,
               JSStructuredCloneReader* aReader,
-              uint32_t aZero,
+              uint32_t aPathLength,
               StructuredCloneHolder* aHolder)
 {
   MOZ_ASSERT(aCx);
   MOZ_ASSERT(aReader);
   MOZ_ASSERT(aHolder);
-  MOZ_ASSERT(aZero == 0);
-
-  uint32_t directoryType, lengthOfString;
-  if (!JS_ReadUint32Pair(aReader, &directoryType, &lengthOfString)) {
-    return nullptr;
-  }
-
-  MOZ_ASSERT(directoryType == Directory::eDOMRootDirectory ||
-             directoryType == Directory::eNotDOMRootDirectory);
 
   nsAutoString path;
-  path.SetLength(lengthOfString);
+  path.SetLength(aPathLength);
   size_t charSize = sizeof(nsString::char_type);
   if (!JS_ReadBytes(aReader, (void*) path.BeginWriting(),
-                    lengthOfString * charSize)) {
+                    aPathLength * charSize)) {
     return nullptr;
   }
 
@@ -769,8 +757,7 @@ ReadDirectory(JSContext* aCx,
   JS::Rooted<JS::Value> val(aCx);
   {
     RefPtr<Directory> directory =
-      Directory::Create(aHolder->ParentDuringRead(), file,
-                        (Directory::DirectoryType) directoryType);
+      Directory::Create(aHolder->ParentDuringRead(), file);
 
     if (!ToJSValue(aCx, directory, &val)) {
       return nullptr;

dom/filesystem/CreateDirectoryTask.cpp

@@ -119,9 +119,7 @@ CreateDirectoryTaskChild::HandlerCallback()
   }
 
   RefPtr<Directory> dir = Directory::Create(mFileSystem->GetParentObject(),
-                                            mTargetPath,
-                                            Directory::eNotDOMRootDirectory,
-                                            mFileSystem);
+                                            mTargetPath, mFileSystem);
   MOZ_ASSERT(dir);
 
   mPromise->MaybeResolve(dir);

dom/filesystem/DeviceStorageFileSystem.cpp

@@ -115,10 +115,32 @@ DeviceStorageFileSystem::GetParentObject() const
 }
 
 void
-DeviceStorageFileSystem::GetRootName(nsAString& aRetval) const
+DeviceStorageFileSystem::GetDirectoryName(nsIFile* aFile, nsAString& aRetval,
+                                          ErrorResult& aRv) const
 {
   AssertIsOnOwningThread();
-  aRetval = mStorageName;
+  MOZ_ASSERT(aFile);
+
+  nsCOMPtr<nsIFile> rootPath;
+  aRv = NS_NewLocalFile(LocalOrDeviceStorageRootPath(), false,
+                        getter_AddRefs(rootPath));
+  if (NS_WARN_IF(aRv.Failed())) {
+    return;
+  }
+
+  bool equal = false;
+  aRv = aFile->Equals(rootPath, &equal);
+  if (NS_WARN_IF(aRv.Failed())) {
+    return;
+  }
+
+  if (equal) {
+    aRetval = mStorageName;
+    return;
+  }
+
+  FileSystemBase::GetDirectoryName(aFile, aRetval, aRv);
+  NS_WARN_IF(aRv.Failed());
 }
 
 bool

dom/filesystem/DeviceStorageFileSystem.h

@@ -37,7 +37,8 @@ class DeviceStorageFileSystem
   GetParentObject() const override;
 
   virtual void
-  GetRootName(nsAString& aRetval) const override;
+  GetDirectoryName(nsIFile* aFile, nsAString& aRetval,
+                   ErrorResult& aRv) const override;
 
   virtual bool
   IsSafeFile(nsIFile* aFile) const override;

dom/filesystem/Directory.cpp

@@ -137,8 +137,7 @@ Directory::GetRoot(FileSystemBase* aFileSystem, ErrorResult& aRv)
   }
 
   RefPtr<GetFileOrDirectoryTaskChild> task =
-    GetFileOrDirectoryTaskChild::Create(aFileSystem, path, eDOMRootDirectory,
-                                        true, aRv);
+    GetFileOrDirectoryTaskChild::Create(aFileSystem, path, true, aRv);
   if (NS_WARN_IF(aRv.Failed())) {
     return nullptr;
   }
@@ -149,7 +148,7 @@ Directory::GetRoot(FileSystemBase* aFileSystem, ErrorResult& aRv)
 
 /* static */ already_AddRefed<Directory>
 Directory::Create(nsISupports* aParent, nsIFile* aFile,
-                  DirectoryType aType, FileSystemBase* aFileSystem)
+                  FileSystemBase* aFileSystem)
 {
   MOZ_ASSERT(aParent);
   MOZ_ASSERT(aFile);
@@ -158,27 +157,17 @@ Directory::Create(nsISupports* aParent, nsIFile* aFile,
   bool isDir;
   nsresult rv = aFile->IsDirectory(&isDir);
   MOZ_ASSERT(NS_SUCCEEDED(rv) && isDir);
-
-  if (aType == eNotDOMRootDirectory) {
-    RefPtr<nsIFile> parent;
-    rv = aFile->GetParent(getter_AddRefs(parent));
-    // We must have a parent if this is not the root directory.
-    MOZ_ASSERT(NS_SUCCEEDED(rv) && parent);
-  }
 #endif
 
-  RefPtr<Directory> directory =
-    new Directory(aParent, aFile, aType, aFileSystem);
+  RefPtr<Directory> directory = new Directory(aParent, aFile, aFileSystem);
   return directory.forget();
 }
 
 Directory::Directory(nsISupports* aParent,
                      nsIFile* aFile,
-                     DirectoryType aType,
                      FileSystemBase* aFileSystem)
   : mParent(aParent)
   , mFile(aFile)
-  , mType(aType)
 {
   MOZ_ASSERT(aFile);
 
@@ -213,18 +202,12 @@ Directory::GetName(nsAString& aRetval, ErrorResult& aRv)
 {
   aRetval.Truncate();
 
-  if (mType == eDOMRootDirectory) {
-    RefPtr<FileSystemBase> fs = GetFileSystem(aRv);
-    if (NS_WARN_IF(aRv.Failed())) {
-      return;
-    }
-
-    fs->GetRootName(aRetval);
+  RefPtr<FileSystemBase> fs = GetFileSystem(aRv);
+  if (NS_WARN_IF(aRv.Failed())) {
     return;
   }
 
-  aRv = mFile->GetLeafName(aRetval);
-  NS_WARN_IF(aRv.Failed());
+  fs->GetDirectoryName(mFile, aRetval, aRv);
 }
 
 already_AddRefed<Promise>
@@ -318,8 +301,7 @@ Directory::Get(const nsAString& aPath, ErrorResult& aRv)
   }
 
   RefPtr<GetFileOrDirectoryTaskChild> task =
-    GetFileOrDirectoryTaskChild::Create(fs, realPath, eNotDOMRootDirectory,
-                                        false, aRv);
+    GetFileOrDirectoryTaskChild::Create(fs, realPath, false, aRv);
   if (NS_WARN_IF(aRv.Failed())) {
     return nullptr;
   }
@@ -409,7 +391,7 @@ Directory::GetPath(nsAString& aRetval, ErrorResult& aRv)
       return;
     }
 
-    fs->GetDOMPath(mFile, mType, mPath, aRv);
+    fs->GetDOMPath(mFile, mPath, aRv);
     if (NS_WARN_IF(aRv.Failed())) {
       return;
     }
@@ -438,7 +420,7 @@ Directory::GetFilesAndDirectories(ErrorResult& aRv)
   }
 
   RefPtr<GetDirectoryListingTaskChild> task =
-    GetDirectoryListingTaskChild::Create(fs, mFile, mType, mFilters, aRv);
+    GetDirectoryListingTaskChild::Create(fs, mFile, mFilters, aRv);
   if (NS_WARN_IF(aRv.Failed())) {
     return nullptr;
   }
@@ -478,10 +460,6 @@ FileSystemBase*
 Directory::GetFileSystem(ErrorResult& aRv)
 {
   if (!mFileSystem) {
-    // Any subdir inherits the FileSystem of the parent Directory. If we are
-    // here it's because we are dealing with the DOM root.
-    MOZ_ASSERT(mType == eDOMRootDirectory);
-
     nsAutoString path;
     aRv = mFile->GetPath(path);
     if (NS_WARN_IF(aRv.Failed())) {

dom/filesystem/Directory.h

@@ -59,20 +59,9 @@ class Directory final
   static already_AddRefed<Promise>
   GetRoot(FileSystemBase* aFileSystem, ErrorResult& aRv);
 
-  enum DirectoryType {
-    // When a directory is selected using a HTMLInputElement, that will be the
-    // DOM root directory and its name will be '/'. All the sub directory will
-    // be called with they real name. We use this enum to mark what we must
-    // consider the '/' of this DOM filesystem.
-    eDOMRootDirectory,
-
-    // All the sub directories of the '/' will be marked using this other value.
-    eNotDOMRootDirectory
-  };
-
   static already_AddRefed<Directory>
   Create(nsISupports* aParent, nsIFile* aDirectory,
-         DirectoryType aType, FileSystemBase* aFileSystem = 0);
+         FileSystemBase* aFileSystem = 0);
 
   // ========= Begin WebIDL bindings. ===========
 
@@ -145,17 +134,12 @@ class Directory final
   FileSystemBase*
   GetFileSystem(ErrorResult& aRv);
 
-  DirectoryType Type() const
-  {
-    return mType;
-  }
-
   bool
   ClonableToDifferentThreadOrProcess() const;
 
 private:
   Directory(nsISupports* aParent,
-            nsIFile* aFile, DirectoryType aType,
+            nsIFile* aFile,
             FileSystemBase* aFileSystem = nullptr);
   ~Directory();
 
@@ -172,7 +156,6 @@ class Directory final
   nsCOMPtr<nsISupports> mParent;
   RefPtr<FileSystemBase> mFileSystem;
   nsCOMPtr<nsIFile> mFile;
-  DirectoryType mType;
 
   nsString mFilters;
   nsString mPath;

dom/filesystem/FileSystemBase.cpp

@@ -110,19 +110,26 @@ FileSystemBase::IsSafeDirectory(Directory* aDir) const
   return false;
 }
 
+void
+FileSystemBase::GetDirectoryName(nsIFile* aFile, nsAString& aRetval,
+                                 ErrorResult& aRv) const
+{
+  AssertIsOnOwningThread();
+  MOZ_ASSERT(aFile);
+
+  aRv = aFile->GetLeafName(aRetval);
+  NS_WARN_IF(aRv.Failed());
+}
+
 void
 FileSystemBase::GetDOMPath(nsIFile* aFile,
-                           Directory::DirectoryType aType,
                            nsAString& aRetval,
                            ErrorResult& aRv) const
 {
   AssertIsOnOwningThread();
   MOZ_ASSERT(aFile);
 
-  if (aType == Directory::eDOMRootDirectory) {
-    aRetval.AssignLiteral(FILESYSTEM_DOM_PATH_SEPARATOR_LITERAL);
-    return;
-  }
+  aRetval.Truncate();
 
   nsCOMPtr<nsIFile> fileSystemPath;
   aRv = NS_NewNativeLocalFile(NS_ConvertUTF16toUTF8(LocalOrDeviceStorageRootPath()),
@@ -131,8 +138,6 @@ FileSystemBase::GetDOMPath(nsIFile* aFile,
     return;
   }
 
-  MOZ_ASSERT(FileSystemUtils::IsDescendantPath(fileSystemPath, aFile));
-
   nsCOMPtr<nsIFile> path;
   aRv = aFile->Clone(getter_AddRefs(path));
   if (NS_WARN_IF(aRv.Failed())) {
@@ -142,23 +147,23 @@ FileSystemBase::GetDOMPath(nsIFile* aFile,
   nsTArray<nsString> parts;
 
   while (true) {
-    bool equal = false;
-    aRv = fileSystemPath->Equals(path, &equal);
+    nsAutoString leafName;
+    aRv = path->GetLeafName(leafName);
     if (NS_WARN_IF(aRv.Failed())) {
       return;
     }
 
-    if (equal) {
-      break;
-    }
+    parts.AppendElement(leafName);
 
-    nsAutoString leafName;
-    aRv = path->GetLeafName(leafName);
+    bool equal = false;
+    aRv = fileSystemPath->Equals(path, &equal);
     if (NS_WARN_IF(aRv.Failed())) {
       return;
     }
 
-    parts.AppendElement(leafName);
+    if (equal) {
+      break;
+    }
 
     nsCOMPtr<nsIFile> parentPath;
     aRv = path->GetParent(getter_AddRefs(parentPath));
@@ -176,8 +181,6 @@ FileSystemBase::GetDOMPath(nsIFile* aFile,
 
   MOZ_ASSERT(!parts.IsEmpty());
 
-  aRetval.Truncate();
-
   for (int32_t i = parts.Length() - 1; i >= 0; --i) {
     aRetval.AppendLiteral(FILESYSTEM_DOM_PATH_SEPARATOR_LITERAL);
     aRetval.Append(parts[i]);

dom/filesystem/FileSystemBase.h

@@ -40,16 +40,12 @@ class FileSystemBase
   virtual nsISupports*
   GetParentObject() const;
 
-  /*
-   * Get the virtual name of the root directory. This name will be exposed to
-   * the content page.
-   */
   virtual void
-  GetRootName(nsAString& aRetval) const = 0;
+  GetDirectoryName(nsIFile* aFile, nsAString& aRetval,
+                   ErrorResult& aRv) const;
 
   void
-  GetDOMPath(nsIFile* aFile, Directory::DirectoryType aType,
-             nsAString& aRetval, ErrorResult& aRv) const;
+  GetDOMPath(nsIFile* aFile, nsAString& aRetval, ErrorResult& aRv) const;
 
   /*
    * Return the local root path of the FileSystem implementation.