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

chrome/browser/chromeos/gdata/gdata_files.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_FILES_H_
 #define CHROME_BROWSER_CHROMEOS_GDATA_GDATA_FILES_H_
 
+#include <sys/stat.h>
+
 #include <map>
-#include <sys/stat.h>
+#include <string>
 
 #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_parser.h"
 #include "chrome/browser/chromeos/gdata/gdata_uploader.h"
@@ skipping 21 matching lines @@
                                           DocumentEntry* doc);
   static std::string EscapeUtf8FileName(const std::string& input);
   static std::string UnescapeUtf8FileName(const std::string& input);
 
   GDataDirectory* parent() { return parent_; }
   const base::PlatformFileInfo& file_info() const { return file_info_; }
   const FilePath::StringType& file_name() const { return file_name_; }
   const FilePath::StringType& original_file_name() const {
     return original_file_name_;
   }
+  void set_original_file_name(const FilePath::StringType& name) {

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

While you are at it, could you document the difference between |file_name| and
|original_file_name| ?

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

Done.

+    original_file_name_ = name;
+  }
   void set_file_name(const FilePath::StringType& name) { file_name_ = name; }
+  void set_parent(GDataDirectory* parent) { parent_ = parent; }

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

Looks scary. Let's move this to protected: section, so it won't be misused from
random client code.

The tree will be messed up if this function is used wrong. for instance:

  dest_dir->AddFile(file);
  // what if we forget to call this?
  // file->set_parent(dest_dir);

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

Done.

+
+  const std::string& resource() const { return resource_id_; }

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

resource() -> resource_id().

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

Done.

 
   // The content URL is used for downloading regular files as is.
   const GURL& content_url() const { return content_url_; }
 
   // The self URL is used for removing files and hosted documents.
   const GURL& self_url() const { return self_url_; }
 
   // Returns virtual file path representing this file system entry. This path
   // corresponds to file path expected by public methods of GDataFileSyste
   // class.
   FilePath GetFilePath();
 
+  // Restores |file_name_| to the original file name before de-duplication.
+  virtual void UseOriginalFileName();
+
  protected:
   base::PlatformFileInfo file_info_;
   FilePath::StringType file_name_;
   FilePath::StringType original_file_name_;
+  std::string resource_id_;
   // Files with the same original name will be uniquely identified with this
   // field so we can represent them with unique URLs/paths in File API layer.
   // For example, two files in the same directory with the same name "Foo"
   // will show up in the virtual directory as "Foo" and "Foo (2)".
   GURL self_url_;
   GURL content_url_;
   GDataDirectory* parent_;
   GDataRootDirectory* root_;  // Weak pointer to GDataRootDirectory.
 
  private:
@@ skipping 19 matching lines @@
   virtual GDataFile* AsGDataFile() OVERRIDE;
 
   static GDataFileBase* FromDocumentEntry(GDataDirectory* parent,
                                           DocumentEntry* doc);
 
   DocumentEntry::EntryKind kind() const { return kind_; }
   const GURL& thumbnail_url() const { return thumbnail_url_; }
   const GURL& edit_url() const { return edit_url_; }
   const std::string& content_mime_type() const { return content_mime_type_; }
   const std::string& etag() const { return etag_; }
-  const std::string& resource() const { return resource_id_; }
   const std::string& id() const { return id_; }
   const std::string& file_md5() const { return file_md5_; }
   // Returns a bitmask of CacheState enum values.
   int GetCacheState();
+  const std::string& document_extension() const { return document_extension_; }
   bool is_hosted_document() const { return is_hosted_document_; }
 
+  // GDataFileBase override.
+  virtual void UseOriginalFileName() OVERRIDE;
+
  private:
   // Content URL for files.
   DocumentEntry::EntryKind kind_;
   GURL thumbnail_url_;
   GURL edit_url_;
   std::string content_mime_type_;
   std::string etag_;
-  std::string resource_id_;
   std::string id_;
   std::string file_md5_;
+  std::string document_extension_;
   bool is_hosted_document_;
 
   DISALLOW_COPY_AND_ASSIGN(GDataFile);
 };
 
 // Represents "directory" in a GData virtual file system. Maps to gdata
 // collection element.
 class GDataDirectory : public GDataFileBase {
  public:
   explicit GDataDirectory(GDataDirectory* parent);
   virtual ~GDataDirectory();
   virtual GDataDirectory* AsGDataDirectory() OVERRIDE;
 
   static GDataFileBase* FromDocumentEntry(GDataDirectory* parent,
                                           DocumentEntry* doc);
 
   // Adds child file to the directory and takes over the ownership of |file|
   // object. The method will also do name deduplication to ensure that the
   // exposed presentation path does not have naming conflicts. Two files with
   // the same name "Foo" will be renames to "Foo (1)" and "Foo (2)".
   void AddFile(GDataFileBase* file);
 
+  // Moves the file from its children list to the children list of |dir|.
+  bool MoveFile(GDataFileBase* file, GDataDirectory* dir);

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

Instead of this, what about adding a function like

  // Takes the file. The parent of |file| is changed to this directory.
  bool TakeFile(GDataFileBase* file);

One less parameter would be nice.

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

Done.

+
   // Removes the file from its children list.
   bool RemoveFile(GDataFileBase* file);
 
   // Removes children elements.
   void RemoveChildren();
 
   // Checks if directory content needs to be retrieved again. If it does,
   // the function will return URL for next feed in |next_feed_url|.
   bool NeedsRefresh(GURL* next_feed_url);
 
@@ skipping 108 matching lines @@
   ResourceMap resource_map_;
 
   CacheMap cache_map_;
 
   DISALLOW_COPY_AND_ASSIGN(GDataRootDirectory);
 };
 
 }  // namespace gdata
 
 #endif  // CHROME_BROWSER_CHROMEOS_GDATA_GDATA_FILES_H_