Add request header on gdata operation for testing ETag match.

chrome/browser/google_apis/gdata_operations.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_GOOGLE_APIS_GDATA_OPERATIONS_H_
 #define CHROME_BROWSER_GOOGLE_APIS_GDATA_OPERATIONS_H_
 
 #include <string>
 #include <vector>
 
@@ skipping 79 matching lines @@
 
 // Callback type for DownloadDocument/DownloadFile DocumentServiceInterface
 // calls.
 typedef base::Callback<void(GDataErrorCode error,
                             const GURL& content_url,
                             const FilePath& temp_file)> DownloadActionCallback;
 
 // This class performs the operation for downloading of a given document/file.
 class DownloadFileOperation : public UrlFetchOperationBase {
  public:
+  // Downloads a file identified by its |document_url|.
+  // If |etag| is set, checks if it matches the file before downloading.

[satorux1, 2012/10/17 03:14:27]

If etag does not match, what happens? Please document.

+  // The downloaded file will be stored at |output_file_path| location.
+  // On partial data is received, invokes |get_content_callbac| if not empty.
+  // Upon completion, invokes |download_action_callback|.

[satorux1, 2012/10/17 03:14:27]

Thank you for improving the comment here!

+  //
+  // Registers the download task to |registry| with OperationProgressStatus
+  // associated with |virtual_path|.
   DownloadFileOperation(
       OperationRegistry* registry,
       const DownloadActionCallback& download_action_callback,
       const GetContentCallback& get_content_callback,
       const GURL& document_url,
       const FilePath& virtual_path,
-      const FilePath& output_file_path);
+      const FilePath& output_file_path,
+      const std::string& etag);
   virtual ~DownloadFileOperation();
 
  protected:
   // Overridden from UrlFetchOperationBase.
   virtual GURL GetURL() const OVERRIDE;
   virtual void ProcessURLFetchResults(const net::URLFetcher* source) OVERRIDE;
   virtual void RunCallbackOnPrematureFailure(GDataErrorCode code) OVERRIDE;
+  virtual std::vector<std::string> GetExtraRequestHeaders() const OVERRIDE;
 
   // Overridden from net::URLFetcherDelegate.
   virtual void OnURLFetchDownloadProgress(const net::URLFetcher* source,
                                           int64 current, int64 total) OVERRIDE;
   virtual bool ShouldSendDownloadData() OVERRIDE;
   virtual void OnURLFetchDownloadData(
       const net::URLFetcher* source,
       scoped_ptr<std::string> download_data) OVERRIDE;
 
  private:
   DownloadActionCallback download_action_callback_;
   GetContentCallback get_content_callback_;
   GURL document_url_;
+  std::string etag_;
 
   DISALLOW_COPY_AND_ASSIGN(DownloadFileOperation);
 };
 
 //=========================== DeleteDocumentOperation ==========================
 
 // This class performs the operation for deleting a document.
 class DeleteDocumentOperation : public EntryActionOperation {
  public:
+  // Deletes a file identified by its |document_url|.
+  // If |etag| is set, checks if it matches the file before deletion.

[satorux1, 2012/10/17 03:14:27]

If etag does not match, what happens? Please document.

+  // Upon completion, invokes |callback|.
+  //
+  // Registers the download task to |registry|.
   DeleteDocumentOperation(OperationRegistry* registry,
                           const EntryActionCallback& callback,
-                          const GURL& document_url);
+                          const GURL& document_url,
+                          const std::string& etag);
   virtual ~DeleteDocumentOperation();
 
  protected:
   // Overridden from UrlFetchOperationBase.
   virtual GURL GetURL() const OVERRIDE;
 
   // Overridden from EntryActionOperation.
   virtual net::URLFetcher::RequestType GetRequestType() const OVERRIDE;
   virtual std::vector<std::string> GetExtraRequestHeaders() const OVERRIDE;
 
  private:
+  std::string etag_;
+
   DISALLOW_COPY_AND_ASSIGN(DeleteDocumentOperation);
 };
 
 //========================== CreateDirectoryOperation ==========================
 
 // This class performs the operation for creating a directory.
 class CreateDirectoryOperation : public GetDataOperation {
  public:
   // Empty |parent_content_url| will create the directory in the root folder.
   CreateDirectoryOperation(OperationRegistry* registry,
@@ skipping 160 matching lines @@
 };
 
 //=========================== InitiateUploadOperation ==========================
 
 // Struct for passing params needed for DriveServiceInterface::InitiateUpload()
 // calls.
 //
 // When uploading a new file (UPLOAD_NEW_FILE):
 // - |title| should be set.
 // - |upload_location| should be the upload_url() of the parent directory.
+// - |etag| should be empty.
 //
 // When updating an existing file (UPLOAD_EXISTING_FILE):
-// - |title| should be empty
+// - |title| should be empty.
 // - |upload_location| should be the upload_url() of the existing file.
+// - |etag| should match the existing file. If it's empty, matching is skipped.

[satorux1, 2012/10/17 03:14:27]

If etag does not match, what happens? Please document.

 struct InitiateUploadParams {
   InitiateUploadParams(UploadMode upload_mode,
                        const std::string& title,
                        const std::string& content_type,
                        int64 content_length,
                        const GURL& upload_location,
-                       const FilePath& virtual_path);
+                       const FilePath& virtual_path,
+                       const std::string& etag);
   ~InitiateUploadParams();
 
   UploadMode upload_mode;
   std::string title;
   std::string content_type;
   int64 content_length;
   GURL upload_location;
   FilePath virtual_path;
+  std::string etag;
 };
 
 // Callback type for DocumentServiceInterface::InitiateUpload.
 typedef base::Callback<void(GDataErrorCode error,
                             const GURL& upload_url)> InitiateUploadCallback;
 
 // This class performs the operation for initiating the upload of a file.
 class InitiateUploadOperation : public UrlFetchOperationBase {
  public:
   InitiateUploadOperation(OperationRegistry* registry,
@@ skipping 40 matching lines @@
 // Struct for passing params needed for DriveServiceInterface::ResumeUpload()
 // calls.
 struct ResumeUploadParams {
   ResumeUploadParams(UploadMode upload_mode,
                      int64 start_range,
                      int64 end_range,
                      int64 content_length,
                      const std::string& content_type,
                      scoped_refptr<net::IOBuffer> buf,
                      const GURL& upload_location,
-                     const FilePath& virtual_path);
+                     const FilePath& virtual_path,
+                     const std::string& etag);
   ~ResumeUploadParams();
 
   UploadMode upload_mode;  // Mode of the upload.
   int64 start_range;  // Start of range of contents currently stored in |buf|.
   int64 end_range;  // End of range of contents currently stored in |buf|.
   int64 content_length;  // File content-Length.
   std::string content_type;   // Content-Type of file.
   scoped_refptr<net::IOBuffer> buf;  // Holds current content to be uploaded.
   GURL upload_location;   // Url of where to upload the file to.
   // Virtual GData path of the file seen in the UI. Not necessary for
   // resuming an upload, but used for adding an entry to OperationRegistry.
   FilePath virtual_path;
+  // ETag matches the file to be overwritten. Matching is skipped if it's empty.
+  std::string etag;
 };
 
 // Callback type for DocumentServiceInterface::ResumeUpload.
 typedef base::Callback<void(
     const ResumeUploadResponse& response,
     scoped_ptr<gdata::DocumentEntry> new_entry)> ResumeUploadCallback;
 
 // This class performs the operation for resuming the upload of a file.
 class ResumeUploadOperation : public UrlFetchOperationBase {
  public:
@@ skipping 109 matching lines @@
 
   // Callback to which the photo data is passed.
   GetContentCallback callback_;
 
   DISALLOW_COPY_AND_ASSIGN(GetContactPhotoOperation);
 };
 
 }  // namespace gdata
 
 #endif  // CHROME_BROWSER_GOOGLE_APIS_GDATA_OPERATIONS_H_