[Refactor] to rename and re-layer the file_util stack layers.

webkit/fileapi/obfuscated_file_util.h

 // Copyright (c) 2011 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.
 
-#ifndef WEBKIT_FILEAPI_OBFUSCATED_FILE_SYSTEM_FILE_UTIL_H_
-#define WEBKIT_FILEAPI_OBFUSCATED_FILE_SYSTEM_FILE_UTIL_H_
+#ifndef WEBKIT_FILEAPI_OBFUSCATED_FILE_UTIL_H_
+#define WEBKIT_FILEAPI_OBFUSCATED_FILE_UTIL_H_
 
 #include <map>
 #include <vector>
 
 #include "base/file_path.h"
 #include "base/file_util_proxy.h"
 #include "base/memory/ref_counted.h"
 #include "base/platform_file.h"
 #include "base/timer.h"
 #include "webkit/fileapi/file_system_directory_database.h"
@@ skipping 20 matching lines @@
 //
 // This class is RefCountedThreadSafe because it may gain a reference on the IO
 // thread, but must be deleted on the FILE thread because that's where
 // DropDatabases needs to be called.  References will be held by the
 // SandboxMountPointProvider [and the task it uses to drop the reference] and
 // SandboxMountPointProvider::GetFileSystemRootPathTask.  Without that last one,
 // we wouldn't need ref counting.
 //
 // TODO(ericu): We don't ever update directory mtimes; which operations should
 // do that?
-class ObfuscatedFileSystemFileUtil : public FileSystemFileUtil,
-    public base::RefCountedThreadSafe<ObfuscatedFileSystemFileUtil> {
+class ObfuscatedFileUtil : public FileSystemFileUtil,
+    public base::RefCountedThreadSafe<ObfuscatedFileUtil> {
  public:
+  // Origin enumerator interface.
+  // An instance of this interface is assumed to be called on the file thread.
+  class AbstractOriginEnumerator {

[kinuko, 2011/08/29 07:20:00]

I think this question is to Eric:
It's not related to this patch itself, but I wonder why we need an abstract
class defined here while its only implementation is ObfuscatedFSOEnumerator?  Am
I missing something or maybe it was introduced due to some historical reason?

[Dai Mikurube (NOT FULLTIME), 2011/08/30 07:47:28]

Ah, I was considering it, too.  What do you think, Eric?
We can handle it in another patch if a change is required.

+   public:
+    virtual ~AbstractOriginEnumerator() {}
+
+    // Returns the next origin.  Returns empty if there are no more origins.
+    virtual GURL Next() = 0;
+
+    // Returns the current origin's information.
+    virtual bool HasFileSystemType(FileSystemType type) const = 0;
+  };
+
   // |underlying_file_util| is owned by the instance.  It will be deleted by
   // the owner instance.  For example, it can be instanciated as follows:
-  // FileSystemFileUtil* file_system_file_util =
-  //     new ObfuscatedFileSystemFileUtil(new FileSystemFileUtil());
-  ObfuscatedFileSystemFileUtil(
-      const FilePath& file_system_directory,
-      FileSystemFileUtil* underlying_file_util);
-  virtual ~ObfuscatedFileSystemFileUtil();
+  // FileSystemFileUtil* file_util =
+  //     new ObfuscatedFileUtil(new NativeFileUtil());
+  ObfuscatedFileUtil(const FilePath& file_system_directory,
+                     FileSystemFileUtil* underlying_file_util);
+  virtual ~ObfuscatedFileUtil();
 
   virtual base::PlatformFileError CreateOrOpen(
       FileSystemOperationContext* context,
       const FilePath& file_path,
       int file_flags,
       base::PlatformFile* file_handle,
       bool* created) OVERRIDE;
 
   virtual base::PlatformFileError EnsureFileExists(
       FileSystemOperationContext* context,
       const FilePath& file_path, bool* created) OVERRIDE;
 
-  virtual base::PlatformFileError GetLocalFilePath(
+  virtual base::PlatformFileError CreateDirectory(
       FileSystemOperationContext* context,
-      const FilePath& virtual_file,
-      FilePath* local_path) OVERRIDE;
+      const FilePath& file_path,
+      bool exclusive,
+      bool recursive) OVERRIDE;
 
   virtual base::PlatformFileError GetFileInfo(
       FileSystemOperationContext* context,
       const FilePath& file,
       base::PlatformFileInfo* file_info,
       FilePath* platform_file) OVERRIDE;
 
   virtual base::PlatformFileError ReadDirectory(
       FileSystemOperationContext* context,
       const FilePath& file_path,
       std::vector<base::FileUtilProxy::Entry>* entries) OVERRIDE;
 
-  virtual base::PlatformFileError CreateDirectory(
+  virtual AbstractFileEnumerator* CreateFileEnumerator(
       FileSystemOperationContext* context,
-      const FilePath& file_path,
-      bool exclusive,
-      bool recursive) OVERRIDE;
+      const FilePath& root_path) OVERRIDE;
 
-  virtual base::PlatformFileError CopyOrMoveFile(
+  virtual base::PlatformFileError GetLocalFilePath(
       FileSystemOperationContext* context,
-      const FilePath& src_file_path,
-      const FilePath& dest_file_path,
-      bool copy) OVERRIDE;
-
-  virtual PlatformFileError CopyInForeignFile(
-        FileSystemOperationContext* context,
-        const FilePath& src_file_path,
-        const FilePath& dest_file_path) OVERRIDE;
-
-  virtual base::PlatformFileError DeleteFile(
-      FileSystemOperationContext* context,
-      const FilePath& file_path) OVERRIDE;
-
-  virtual base::PlatformFileError DeleteSingleDirectory(
-      FileSystemOperationContext* context,
-      const FilePath& file_path) OVERRIDE;
+      const FilePath& virtual_file,
+      FilePath* local_path) OVERRIDE;
 
   virtual base::PlatformFileError Touch(
       FileSystemOperationContext* context,
       const FilePath& file_path,
       const base::Time& last_access_time,
       const base::Time& last_modified_time) OVERRIDE;
 
   virtual base::PlatformFileError Truncate(
       FileSystemOperationContext* context,
       const FilePath& path,
       int64 length) OVERRIDE;
 
   virtual bool PathExists(
       FileSystemOperationContext* context,
       const FilePath& file_path) OVERRIDE;
 
   virtual bool DirectoryExists(
       FileSystemOperationContext* context,
       const FilePath& file_path) OVERRIDE;
 
   virtual bool IsDirectoryEmpty(
       FileSystemOperationContext* context,
       const FilePath& file_path) OVERRIDE;
 
+  virtual base::PlatformFileError CopyOrMoveFile(
+      FileSystemOperationContext* context,
+      const FilePath& src_file_path,
+      const FilePath& dest_file_path,
+      bool copy) OVERRIDE;
+
+  virtual PlatformFileError CopyInForeignFile(
+        FileSystemOperationContext* context,
+        const FilePath& src_file_path,
+        const FilePath& dest_file_path) OVERRIDE;
+
+  virtual base::PlatformFileError DeleteFile(
+      FileSystemOperationContext* context,
+      const FilePath& file_path) OVERRIDE;
+
+  virtual base::PlatformFileError DeleteSingleDirectory(
+      FileSystemOperationContext* context,
+      const FilePath& file_path) OVERRIDE;
+
   // Gets the topmost directory specific to this origin and type.  This will
   // contain both the directory database's files and all the backing file
   // subdirectories.
   FilePath GetDirectoryForOriginAndType(
       const GURL& origin, FileSystemType type, bool create);
 
   // Deletes the topmost directory specific to this origin and type.  This will
   // delete its directory database.
   bool DeleteDirectoryForOriginAndType(const GURL& origin, FileSystemType type);
 
   // This will migrate a filesystem from the old passthrough sandbox into the
   // new obfuscated one.  It won't obfuscate the old filenames [it will maintain
   // the old structure, but move it to a new root], but any new files created
   // will go into the new standard locations.  This will be completely
   // transparent to the user.  This migration is atomic in that it won't alter
   // the source data until it's done, and that will be with a single directory
   // move [the directory with the unguessable name will move into the new
   // filesystem storage directory].  However, if this fails partway through, it
   // might leave a seemingly-valid database for this origin.  When it starts up,
   // it will clear any such database, just in case.
   bool MigrateFromOldSandbox(
       const GURL& origin, FileSystemType type, const FilePath& root);
 
   // TODO(ericu): This doesn't really feel like it belongs in this class.
   // The previous version lives in FileSystemPathManager, but perhaps
   // SandboxMountPointProvider would be better?
   static FilePath::StringType GetDirectoryNameForType(FileSystemType type);
 
-  // Origin enumerator interface.
-  // An instance of this interface is assumed to be called on the file thread.
-  class AbstractOriginEnumerator {
-   public:
-    virtual ~AbstractOriginEnumerator() {}
-
-    // Returns the next origin.  Returns empty if there are no more origins.
-    virtual GURL Next() = 0;
-
-    // Returns the current origin's information.
-    virtual bool HasFileSystemType(FileSystemType type) const = 0;
-  };
-
   // This method and all methods of its returned class must be called only on
   // the FILE thread.  The caller is responsible for deleting the returned
   // object.
   AbstractOriginEnumerator* CreateOriginEnumerator();
 
-  virtual AbstractFileEnumerator* CreateFileEnumerator(
-      FileSystemOperationContext* context,
-      const FilePath& root_path) OVERRIDE;
-
   // Deletes a directory database from the database list in the ObfuscatedFSFU
   // and destroys the database on the disk.
   bool DestroyDirectoryDatabase(const GURL& origin, FileSystemType type);
 
   // Computes a cost for storing a given file in the obfuscated FSFU.
   // As the cost of a file is independent of the cost of its parent directories,
   // this ignores all but the BaseName of the supplied path.  In order to
   // compute the cost of adding a multi-segment directory recursively, call this
   // on each path segment and add the results.
   static int64 ComputeFilePathCost(const FilePath& path);
@@ skipping 19 matching lines @@
   // responsible for closing.  If you supply a path in source_path, it will be
   // used as a source from which to COPY data.
   // Caveat: do not supply handle if you're also supplying a data path.  It was
   // easier not to support this, and no code has needed it so far, so it will
   // DCHECK and handle will hold base::kInvalidPlatformFileValue.
   base::PlatformFileError CreateFile(
       FileSystemOperationContext* context,
       const GURL& origin_url, FileSystemType type,
       const FilePath& source_path, FileInfo* file_info,
       int file_flags, base::PlatformFile* handle);
+
   // Given the filesystem's root URL and a virtual path, produces a real, full
   // local path to the underlying data file.  This does a database lookup, and
   // verifies that the file exists.
   FilePath GetLocalPath(
       const GURL& origin_url,
       FileSystemType type,
       const FilePath& virtual_path);
+
   // This converts from a relative path [as is stored in the FileInfo.data_path
   // field] to an absolute local path that can be given to the operating system.
   // It does no checks as to whether the file actually exists; it's pure path
   // manipulation.
   FilePath DataPathToLocalPath(
       const GURL& origin, FileSystemType type, const FilePath& data_path);
+
   // This does the reverse of DataPathToLocalPath.
   FilePath LocalPathToDataPath(
       const GURL& origin, FileSystemType type, const FilePath& local_path);
+
   // This returns NULL if |create| flag is false and a filesystem does not
   // exist for the given |origin_url| and |type|.
   // For read operations |create| should be false.
   FileSystemDirectoryDatabase* GetDirectoryDatabase(
       const GURL& origin_url, FileSystemType type, bool create);
+
   // Gets the topmost directory specific to this origin.  This will
   // contain both the filesystem type subdirectories.
   FilePath GetDirectoryForOrigin(const GURL& origin, bool create);
+
   void MarkUsed();
   void DropDatabases();
   bool InitOriginDatabase(bool create);
 
   typedef std::map<std::string, FileSystemDirectoryDatabase*> DirectoryMap;
   DirectoryMap directories_;
   scoped_ptr<FileSystemOriginDatabase> origin_database_;
   FilePath file_system_directory_;
-  base::OneShotTimer<ObfuscatedFileSystemFileUtil> timer_;
-  scoped_ptr<FileSystemFileUtil> underlying_file_util_;
+  base::OneShotTimer<ObfuscatedFileUtil> timer_;
 
-  DISALLOW_COPY_AND_ASSIGN(ObfuscatedFileSystemFileUtil);
+  DISALLOW_COPY_AND_ASSIGN(ObfuscatedFileUtil);
 };
 
 }  // namespace fileapi
 
-#endif  // WEBKIT_FILEAPI_OBFUSCATED_FILE_SYSTEM_FILE_UTIL_H_
+#endif  // WEBKIT_FILEAPI_OBFUSCATED_FILE_UTIL_H_