Implement copy and move operations within the same remote file system.

chrome/browser/chromeos/gdata/gdata_file_system.h

 // 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.
 
 #ifndef CHROME_BROWSER_CHROMEOS_GDATA_GDATA_FILE_SYSTEM_H_
 #define CHROME_BROWSER_CHROMEOS_GDATA_GDATA_FILE_SYSTEM_H_
 
+#include <sys/stat.h>
+
 #include <map>
 #include <string>
-#include <sys/stat.h>
 #include <vector>
 
 #include "base/gtest_prod_util.h"
 #include "base/memory/scoped_ptr.h"
 #include "base/memory/singleton.h"
 #include "base/memory/weak_ptr.h"
 #include "base/platform_file.h"
 #include "base/synchronization/lock.h"
 #include "chrome/browser/chromeos/gdata/gdata.h"
 #include "chrome/browser/chromeos/gdata/gdata_files.h"
@@ skipping 96 matching lines @@
 
   // Finds file info by using virtual |file_path|. If |require_content| is set,
   // the found directory will be pre-populated before passed back to the
   // |delegate|. If |allow_refresh| is not set, directories' content
   // won't be performed.
   //
   // Can be called from any thread.
   void FindFileByPath(const FilePath& file_path,
                       scoped_refptr<FindFileDelegate> delegate);
 
+  // Copies |src_file_path| to |dest_file_path| on the file system.

[satorux1, 2012/03/12 17:48:24]

Please document that if this allows copy of directories. What if |src_file_path|
is a directory?

[Ben Chan, 2012/03/13 00:29:21]

Done.

+  // The file entries represented by |src_file_path| and the parent directory
+  // of |dest_file_path| need to be present in the in-memory representation

[satorux1, 2012/03/12 17:48:24]

Please also document if |dest_file_path| can be a directory. "cp" command allows
the destination to be a directory (ex. cp /etc/hosts /tmp"), but here, we don't
allow it, right?

[Ben Chan, 2012/03/13 00:29:21]

Done.

+  // of the file system.

[satorux1, 2012/03/12 17:48:24]

//
// Can be called from any thread.

?

[Ben Chan, 2012/03/13 00:29:21]

Done.

+  void Copy(const FilePath& src_file_path,
+            const FilePath& dest_file_path,
+            const FileOperationCallback& callback);
+
+  // Moves |src_file_path| to |dest_file_path| on the file system.
+  // The file entries represented by |src_file_path| and the parent directory
+  // of |dest_file_path| need to be present in the in-memory representation
+  // of the file system.

[satorux1, 2012/03/12 17:48:24]

ditto.

[Ben Chan, 2012/03/13 00:29:21]

Done.

+  void Move(const FilePath& src_file_path,
+            const FilePath& dest_file_path,
+            const FileOperationCallback& callback);
+
   // Removes |file_path| from the file system.  If |is_recursive| is set and
   // |file_path| represents a directory, we will also delete all of its
   // contained children elements. The file entry represented by |file_path|
   // needs to be present in in-memory representation of the file system that
   // in order to be removed.
   //
   // TODO(zelidrag): Wire |is_recursive| through gdata api
   // (find appropriate calls for it).
   //
   // Can be called from any thread. |callback| is run on the calling thread.
@@ skipping 32 matching lines @@
   // Finds file object by |file_path| and returns the file info.
   // Returns NULL if it does not find the file.
   GDataFileBase* GetGDataFileInfoFromPath(const FilePath& file_path);
 
  private:
   friend class GDataUploader;
   friend class GDataFileSystemFactory;
   friend class GDataFileSystemTestBase;
   FRIEND_TEST_ALL_PREFIXES(GDataFileSystemTest,
                            FindFirstMissingParentDirectory);
+  FRIEND_TEST_ALL_PREFIXES(GDataFileSystemTest, GetCopyMoveFileParams);
 
   // Defines possible search results of FindFirstMissingParentDirectory().
   enum FindMissingDirectoryResult {
     // Target directory found, it's not a directory.
     FOUND_INVALID,
     // Found missing directory segment while searching for given directory.
     FOUND_MISSING,
     // Found target directory, it already exists.
     DIRECTORY_ALREADY_PRESENT,
   };
 
   // Defines set of parameters passes to intermediate callbacks during
   // execution of CreateDirectory() method.
   struct CreateDirectoryParams {
     CreateDirectoryParams(const FilePath& created_directory_path,
                           const FilePath& target_directory_path,
                           bool is_exclusive,
                           bool is_recursive,
                           const FileOperationCallback& callback);
     ~CreateDirectoryParams();
 
     const FilePath created_directory_path;
     const FilePath target_directory_path;
     const bool is_exclusive;
     const bool is_recursive;
     FileOperationCallback callback;
   };
 
+  // Defines set of parameters of a file/directory that is needed for
+  // copy/move related operations.
+  struct CopyMoveFileParams {
+    CopyMoveFileParams();
+    ~CopyMoveFileParams();
+
+    GURL self_url;
+    GURL content_url;
+    bool is_directory;
+    bool is_root_directory;
+    bool is_hosted_document;
+    std::string resource_id;
+    std::string document_extension;
+  };
+
   enum CacheType {  // This indexes into |cache_paths_| vector.
     CACHE_TYPE_BLOBS = 0,
     CACHE_TYPE_META,
   };
 
-  explicit GDataFileSystem(Profile* profile,
-                           DocumentsServiceInterface* documents_service);
+  // Callback similar to FileOperationCallback but with a given
+  // |file_path|.
+  typedef base::Callback<void(base::PlatformFileError error,
+                              const FilePath& file_path)>
+      FilePathUpdateCallback;
+
+  GDataFileSystem(Profile* profile,
+                  DocumentsServiceInterface* documents_service);
   virtual ~GDataFileSystem();
 
   // Initiates upload operation of file defined with |file_name|,
   // |content_type| and |content_length|. The operation will place the newly
   // created file entity into |destination_directory|.
   //
   // Can be called from any thread. |callback| is run on the calling thread.
   void InitiateUpload(const std::string& file_name,
                       const std::string& content_type,
                       int64 content_length,
@@ skipping 16 matching lines @@
   // DocumentsService.
   void ContinueDirectoryRefresh(const FindFileParams& params,
                                 scoped_ptr<base::ListValue> feed_list);
 
   // Converts document feed from gdata service into DirectoryInfo. On failure,
   // returns NULL and fills in |error| with an appropriate value.
   GDataDirectory* ParseGDataFeed(GDataErrorCode status,
                                  base::Value* data,
                                  base::PlatformFileError *error);
 
+  // Gets the parameters of a file or directory at |file_path| for copy/move
+  // related operations. Returns false if |file_path| is not found.
+  bool GetCopyMoveFileParams(const FilePath& file_path,
+                             CopyMoveFileParams* params);
+
+  // Renames a file or directory at |file_path| to |new_name|.
+  void Rename(const FilePath& file_path,
+              const FilePath::StringType& new_name,
+              const FilePathUpdateCallback& callback);
+
+  // Adds a file or directory at |file_path| to the directory at |dir_path|.
+  void AddFileToDirectory(const FilePath& dir_path,
+                          const FileOperationCallback& callback,
+                          base::PlatformFileError error,
+                          const FilePath& file_path);
+
+  // Removes a file or directory at |file_path| from the directory at
+  // |dir_path| and moves it to the root directory.
+  void RemoveFileFromDirectory(const FilePath& dir_path,
+                               const FilePathUpdateCallback& callback,
+                               base::PlatformFileError error,
+                               const FilePath& file_path);
+
   // Callback for handling feed content fetching while searching for file info.
   // This callback is invoked after async feed fetch operation that was
   // invoked by StartDirectoryRefresh() completes. This callback will update
   // the content of the refreshed directory object and continue initially
   // started FindFileByPath() request.
   void OnGetDocuments(const FindFileParams& params,
                       scoped_ptr<base::ListValue> feed_list,
                       GDataErrorCode status,
                       scoped_ptr<base::Value> data);
 
+  // A pass-through callback used for bridging from
+  // FilePathUpdateCallback to FileOperationCallback.
+  void OnFilePathUpdated(const FileOperationCallback& cllback,
+                         base::PlatformFileError error,
+                         const FilePath& file_path);
+
+  // Callback for handling resource rename attempt.
+  void OnRenameResourceCompleted(const FilePath& file_path,
+                                 const FilePath::StringType& new_name,
+                                 const FilePathUpdateCallback& callback,
+                                 GDataErrorCode status,
+                                 const GURL& document_url);
+
+  // Callback for handling document copy attempt.
+  void OnCopyDocumentCompleted(const FilePathUpdateCallback& callback,
+                               GDataErrorCode status,
+                               scoped_ptr<base::Value> data);
+
+  // Callback for handling an attempt to add a file or directory to another
+  // directory.
+  void OnAddFileToDirectoryCompleted(const FileOperationCallback& callback,
+                                     const FilePath& file_path,
+                                     const FilePath& dir_path,
+                                     GDataErrorCode status,
+                                     const GURL& document_url);
+
+  // Callback for handling an attempt to remove a file or directory from
+  // another directory.
+  void OnRemoveFileFromDirectoryCompleted(
+      const FilePathUpdateCallback& callback,
+      const FilePath& file_path,
+      const FilePath& dir_path,
+      GDataErrorCode status,
+      const GURL& document_url);
+
   // Callback for handling document remove attempt.
   void OnRemovedDocument(
       const FileOperationCallback& callback,
       const FilePath& file_path,
       GDataErrorCode status,
       const GURL& document_url);
 
   // Callback for handling directory create requests.
   void OnCreateDirectoryCompleted(
       const CreateDirectoryParams& params,
@@ skipping 15 matching lines @@
       const GURL& upload_location);
 
   // Callback for handling file upload resume requests.
   void OnResumeUpload(
       const ResumeUploadOperationCallback& callback,
       scoped_refptr<base::MessageLoopProxy> message_loop_proxy,
       GDataErrorCode code,
       int64 start_range_received,
       int64 end_range_received);
 
+  // Renames a file or directory at |file_path| on in-memory snapshot
+  // of the file system. Returns PLATFORM_FILE_OK if successful.
+  base::PlatformFileError RenameFileOnFilesystem(
+      const FilePath& file_path, const FilePath::StringType& new_name,
+      FilePath* updated_file_path);
+
+  // Adds a file or directory at |file_path| to another directory at
+  // |dir_path| on in-memory snapshot of the file system.
+  // Returns PLATFORM_FILE_OK if successful.
+  base::PlatformFileError AddFileToDirectoryOnFilesystem(
+      const FilePath& file_path, const FilePath& dir_path);
+
+  // Removes a file or directory at |file_path| from another directory at
+  // |dir_path| on in-memory snapshot of the file system.
+  // Returns PLATFORM_FILE_OK if successful.
+  base::PlatformFileError RemoveFileFromDirectoryOnFilesystem(
+      const FilePath& file_path, const FilePath& dir_path,
+      FilePath* updated_file_path);
+
   // Removes file under |file_path| from in-memory snapshot of the file system.
   // Return PLATFORM_FILE_OK if successful.
   base::PlatformFileError RemoveFileFromFileSystem(const FilePath& file_path);
 
   // Parses the content of |feed_data| and returns DocumentFeed instance
   // represeting it.
   DocumentFeed* ParseDocumentFeed(base::Value* feed_data);
 
   // Updates content of the directory identified with |directory_path| with
   // feeds collected in |feed_list|.
@@ skipping 236 matching lines @@
                                                     GDataDirectory*) OVERRIDE;
   virtual void OnError(base::PlatformFileError) OVERRIDE;
 
   // File entry that was found.
   GDataFileBase* file_;
 };
 
 }  // namespace gdata
 
 #endif  // CHROME_BROWSER_CHROMEOS_GDATA_GDATA_FILE_SYSTEM_H_