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

chrome/browser/chromeos/gdata/gdata.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_H_
 #define CHROME_BROWSER_CHROMEOS_GDATA_GDATA_H_
 #pragma once
 
 #include <string>
 #include <vector>
@@ skipping 159 matching lines @@
   virtual void Observe(int type,
                        const content::NotificationSource& source,
                        const content::NotificationDetails& details) OVERRIDE;
 
   // Sets the auth_token as specified.  This should be used only for testing.
   void set_oauth2_auth_token_for_testing(const std::string& token) {
     auth_token_ = token;
   }
 
  private:
-
   // Helper function for StartAuthentication() call.
   void StartAuthenticationOnUIThread(
       GDataOperationRegistry* registry,
       scoped_refptr<base::MessageLoopProxy> relay_proxy,
       const AuthStatusCallback& callback);
 
 
   Profile* profile_;
   std::string refresh_token_;
   std::string auth_token_;
@@ skipping 41 matching lines @@
                               const EntryActionCallback& callback) = 0;
 
   // Downloads a document identified by its |content_url| in a given |format|.
   // Upon completion, invokes |callback| with results on the calling thread.
   //
   // Can be called on any thread.
   virtual void DownloadDocument(const GURL& content_url,
                                 DocumentExportFormat format,
                                 const DownloadActionCallback& callback) = 0;
 
+  // Makes a copy of a document identified by its 'self' link |document_url|.
+  // The copy is named as the UTF-8 encoded |new_name| and is not added to any
+  // collection. Use AddResourceToDirectory() to add the copy to a collection
+  // when needed. Upon completion, invokes |callback| with results.

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

nit: add "on the calling thread"

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

Done.

+  //
+  // Can be called on any thread.
+  virtual void CopyDocument(const GURL& document_url,
+                            const FilePath::StringType& new_name,
+                            const GetDataCallback& callback) = 0;
+
+  // Renames a document or collection identified by its 'self' link
+  // |document_url| to the UTF-8 encoded |new_name|. Upon completion,
+  // invokes |callback| with results.

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

ditto.

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

Done.

+  //
+  // Can be called on any thread.
+  virtual void RenameResource(const GURL& resource_url,
+                              const FilePath::StringType& new_name,
+                              const EntryActionCallback& callback) = 0;
+
+  // Adds a resource (document, file, or collection) identified by its
+  // 'self' link |resource_url| to a collection with a content link

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

nit: a collection -> a collection (directory)

I think it'd be useful to have some documentation about how directories are
represented in gdata, like gdata is not hierarchical and directories are
represented as collections which are nested labels, hence a document can be
present in multiple directories, which are like hard links on Unix.

We might also want to document some terminology used in this code as some terms
are fairly confusing:

- collections vs directories
- documents vs files vs hosted documents

It'd be nice if we could have decent documentation about these topics at the
beginning of the file. 

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

Yes, we should indeed make the terminology/naming convention more consistent in
the code. Some methods currently referring to document may apply to other kinds
of resource.

However, as GData is a moving target, I think it'd be better to minimize changes
in the meantime in order to reduce merge conflict. 

How about I make a follow-up CL to clean that up when things settle down a bit? 
I added a TODO for that.

+  // |parent_content_url|. Upon completion, invokes |callback| with
+  // results on the calling thread.
+  //
+  // Can be called on any thread.
+  virtual void AddResourceToDirectory(const GURL& parent_content_url,
+                                      const GURL& resource_url,
+                                      const EntryActionCallback& callback) = 0;
+
+  // Removes a resource (document, file, collection) identified by its
+  // 'self' link |resource_url| from a collection with a content link
+  // |parent_content_url|. Upon completion, invokes |callback| with
+  // results on the calling thread.
+  //
+  // Can be called on any thread.
+  virtual void RemoveResourceFromDirectory(
+      const GURL& parent_content_url,
+      const GURL& resource_url,
+      const std::string& resource_id,
+      const EntryActionCallback& callback) = 0;
+
   // Creates new collection with |directory_name| under parent directory
   // identified with |parent_content_url|. If |parent_content_url| is empty,
   // the new collection will be created in the root. Upon completion,
   // invokes |callback| and passes newly created entry on the calling thread.
   //
   // Can be called on any thread.
   virtual void CreateDirectory(const GURL& parent_content_url,
                                const FilePath::StringType& directory_name,
                                const GetDataCallback& callback) = 0;
 
@@ skipping 31 matching lines @@
   virtual void CancelAll() OVERRIDE;
   virtual void Authenticate(const AuthStatusCallback& callback) OVERRIDE;
   virtual void GetDocuments(const GURL& feed_url,
                             const GetDataCallback& callback) OVERRIDE;
   virtual void DeleteDocument(const GURL& document_url,
                               const EntryActionCallback& callback) OVERRIDE;
   virtual void DownloadDocument(
       const GURL& content_url,
       DocumentExportFormat format,
       const DownloadActionCallback& callback) OVERRIDE;
+  virtual void CopyDocument(const GURL& document_url,
+                            const FilePath::StringType& new_name,
+                            const GetDataCallback& callback) OVERRIDE;
+  virtual void RenameResource(const GURL& document_url,
+                              const FilePath::StringType& new_name,
+                              const EntryActionCallback& callback) OVERRIDE;
+  virtual void AddResourceToDirectory(
+      const GURL& parent_content_url,
+      const GURL& resource_url,
+      const EntryActionCallback& callback) OVERRIDE;
+  virtual void RemoveResourceFromDirectory(
+      const GURL& parent_content_url,
+      const GURL& resource_url,
+      const std::string& resource_id,
+      const EntryActionCallback& callback) OVERRIDE;
   virtual void CreateDirectory(const GURL& parent_content_url,
                                const FilePath::StringType& directory_name,
                                const GetDataCallback& callback) OVERRIDE;
   virtual void DownloadFile(const GURL& content_url,
                             const DownloadActionCallback& callback) OVERRIDE;
   virtual void InitiateUpload(const InitiateUploadParams& params,
                               const InitiateUploadCallback& callback) OVERRIDE;
   virtual void ResumeUpload(const ResumeUploadParams& params,
                             const ResumeUploadCallback& callback) OVERRIDE;
 
@@ skipping 35 matching lines @@
   scoped_ptr<GDataOperationRegistry> operation_registry_;
   base::WeakPtrFactory<DocumentsService> weak_ptr_factory_;
   base::WeakPtr<DocumentsService> weak_ptr_bound_to_ui_thread_;
 
   DISALLOW_COPY_AND_ASSIGN(DocumentsService);
 };
 
 }  // namespace gdata
 
 #endif  // CHROME_BROWSER_CHROMEOS_GDATA_GDATA_H_