Split DownloadItem into an ABC, an Impl, and a Mock.

content/browser/download/download_item.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.
-//
-// Each download is represented by a DownloadItem, and all DownloadItems
-// are owned by the DownloadManager which maintains a global list of all
-// downloads. DownloadItems are created when a user initiates a download,
-// and exist for the duration of the browser life time.
-//
-// Download observers:
-//   DownloadItem::Observer:
-//     - allows observers to receive notifications about one download from start
-//       to completion
-// Use AddObserver() / RemoveObserver() on the appropriate download object to
-// receive state updates.

[Randy Smith (Not in Mondays), 2011/11/09 17:09:57]

I'm inclined to leave this here.  It's a question of what's the "real" download
item from the perspective of someone reading this file.  I think of .h files as
being targeted at consumers, and thus the interface is the real download item.

[benjhayden, 2011/11/11 22:31:12]

Done.

 
 #ifndef CONTENT_BROWSER_DOWNLOAD_DOWNLOAD_ITEM_H_
 #define CONTENT_BROWSER_DOWNLOAD_DOWNLOAD_ITEM_H_
 #pragma once
 
 #include <string>
 
-#include "base/basictypes.h"
-#include "base/file_path.h"
-#include "base/memory/scoped_ptr.h"
-#include "base/observer_list.h"
-#include "base/time.h"
-#include "content/browser/download/download_id.h"
-#include "content/browser/download/download_request_handle.h"
+#include "base/string16.h"
 #include "content/browser/download/download_state_info.h"
 #include "content/browser/download/interrupt_reasons.h"
-#include "content/common/content_export.h"
-#include "googleurl/src/gurl.h"
-#include "net/base/net_errors.h"
 
+namespace base {
+class Time;
+class TimeDelta;
+}
 class DownloadFileManager;
 class DownloadId;
 class DownloadManager;
+class FilePath;
+class GURL;
 class TabContents;
-
 struct DownloadCreateInfo;
 struct DownloadPersistentStoreInfo;
 
 // One DownloadItem per download. This is the model class that stores all the
 // state for a download. Multiple views, such as a tab's download shelf and the
 // Destination tab's download view, may refer to a given DownloadItem.
 //
 // This is intended to be used only on the UI thread.
 class CONTENT_EXPORT DownloadItem {
  public:
+  // A fake download table ID which represents a download that has started,
+  // but is not yet in the table.
+  static const int kUninitializedHandle;
+
+  // Reason for deleting the download.  Passed to Delete().
+  enum DeleteReason {
+    DELETE_DUE_TO_BROWSER_SHUTDOWN = 0,
+    DELETE_DUE_TO_USER_DISCARD
+  };
+

[Randy Smith (Not in Mondays), 2011/11/09 17:09:57]

Why change ordering?  I think of the DownloadState as of more interest to
DownloadItem consumers (not a request, just my perspective).

[benjhayden, 2011/11/11 22:31:12]

It wasn't intentional, it happened in one of the merges before I mailed it out.
Done.

   enum DownloadState {
     // Download is actively progressing.
     IN_PROGRESS = 0,
 
     // Download is completely finished.
     COMPLETE,
 
     // Download has been cancelled.
     CANCELLED,
 
@@ skipping 24 matching lines @@
     DANGEROUS_FILE,
 
     // Safebrowsing service shows this URL leads to malicious file download.
     DANGEROUS_URL,
 
     // Memory space for histograms is determined by the max.
     // ALWAYS ADD NEW VALUES BEFORE THIS ONE.
     DANGEROUS_TYPE_MAX
   };
 
-  // Reason for deleting the download.  Passed to Delete().
-  enum DeleteReason {
-    DELETE_DUE_TO_BROWSER_SHUTDOWN = 0,
-    DELETE_DUE_TO_USER_DISCARD
-  };
-
-  // A fake download table ID which represents a download that has started,
-  // but is not yet in the table.
-  static const int kUninitializedHandle;
-
   // Interface that observers of a particular download must implement in order
   // to receive updates to the download's status.
   class CONTENT_EXPORT Observer {
    public:
     virtual void OnDownloadUpdated(DownloadItem* download) = 0;
 
     // Called when a downloaded file has been opened.
     virtual void OnDownloadOpened(DownloadItem* download) = 0;
 
    protected:
     virtual ~Observer() {}
   };
 
-  // Constructing from persistent store:
-  DownloadItem(DownloadManager* download_manager,
-               const DownloadPersistentStoreInfo& info);
-
-  // Constructing for a regular download.
-  // Takes ownership of the object pointed to by |request_handle|.
-  DownloadItem(DownloadManager* download_manager,
-               const DownloadCreateInfo& info,
-               DownloadRequestHandleInterface* request_handle,
-               bool is_otr);
-
-  // Constructing for the "Save Page As..." feature:
-  DownloadItem(DownloadManager* download_manager,
-               const FilePath& path,
-               const GURL& url,
-               bool is_otr,
-               DownloadId download_id);
-
-  virtual ~DownloadItem();

[Randy Smith (Not in Mondays), 2011/11/09 17:09:57]

If anyone else is going to own a DownloadItem, don't you need it to have a
virtual destructor?

[benjhayden, 2011/11/11 22:31:12]

Done.

-
-  void AddObserver(Observer* observer);
-  void RemoveObserver(Observer* observer);
+  virtual void AddObserver(DownloadItem::Observer* observer) = 0;
+  virtual void RemoveObserver(DownloadItem::Observer* observer) = 0;
 
   // Notifies our observers periodically.
-  void UpdateObservers();
+  virtual void UpdateObservers() = 0;
 
   // Returns true if it is OK to open a folder which this file is inside.
-  bool CanShowInFolder();
+  virtual bool CanShowInFolder() = 0;
 
   // Returns true if it is OK to register the type of this file so that
   // it opens automatically.
-  bool CanOpenDownload();
+  virtual bool CanOpenDownload() = 0;
 
   // Tests if a file type should be opened automatically.
-  bool ShouldOpenFileBasedOnExtension();
+  virtual bool ShouldOpenFileBasedOnExtension() = 0;
 
   // Open the file associated with this download (wait for the download to
   // complete if it is in progress).
-  void OpenDownload();
+  virtual void OpenDownload() = 0;
 
   // Show the download via the OS shell.
-  void ShowDownloadInShell();
+  virtual void ShowDownloadInShell() = 0;
 
   // Called when the user has validated the download of a dangerous file.
-  void DangerousDownloadValidated();
+  virtual void DangerousDownloadValidated() = 0;
 
   // Received a new chunk of data
-  void Update(int64 bytes_so_far);
+  virtual void Update(int64 bytes_so_far) = 0;
 
   // Cancel the download operation. We need to distinguish between cancels at
   // exit (DownloadManager destructor) from user interface initiated cancels
   // because at exit, the history system may not exist, and any updates to it
   // require AddRef'ing the DownloadManager in the destructor which results in
   // a DCHECK failure. Set |user_cancel| to false when canceling from at
   // exit to prevent this crash. This may result in a difference between the
   // downloaded file's size on disk, and what the history system's last record
   // of it is. At worst, we'll end up re-downloading a small portion of the file
   // when resuming a download (assuming the server supports byte ranges).
-  void Cancel(bool user_cancel);
+  virtual void Cancel(bool user_cancel) = 0;
 
   // Called by external code (SavePackage) using the DownloadItem interface
   // to display progress when the DownloadItem should be considered complete.
-  void MarkAsComplete();
+  virtual void MarkAsComplete() = 0;
 
   // Called by the delegate after it delayed opening the download in
   // DownloadManagerDelegate::ShouldOpenDownload.
-  void DelayedDownloadOpened();
+  virtual void DelayedDownloadOpened() = 0;
 
   // Called when all data has been saved. Only has display effects.
-  void OnAllDataSaved(int64 size);
+  virtual void OnAllDataSaved(int64 size) = 0;
 
   // Called when the downloaded file is removed.
-  void OnDownloadedFileRemoved();
+  virtual void OnDownloadedFileRemoved() = 0;
 
   // Download operation had an error.
   // |size| is the amount of data received at interruption.
   // |reason| is the download interrupt reason code that the operation received.
-  void Interrupted(int64 size, InterruptReason reason);
+  virtual void Interrupted(int64 size, InterruptReason reason) = 0;
 
   // Deletes the file from disk and removes the download from the views and
   // history.  |user| should be true if this is the result of the user clicking
   // the discard button, and false if it is being deleted for other reasons like
   // browser shutdown.
-  void Delete(DeleteReason reason);
+  virtual void Delete(DeleteReason reason) = 0;
 
   // Removes the download from the views and history.
-  void Remove();
+  virtual void Remove() = 0;
 
   // Simple calculation of the amount of time remaining to completion. Fills
   // |*remaining| with the amount of time remaining if successful. Fails and
   // returns false if we do not have the number of bytes or the speed so can
   // not estimate.
-  bool TimeRemaining(base::TimeDelta* remaining) const;
+  virtual bool TimeRemaining(base::TimeDelta* remaining) const = 0;
 
   // Simple speed estimate in bytes/s
-  int64 CurrentSpeed() const;
+  virtual int64 CurrentSpeed() const = 0;
 
   // Rough percent complete, -1 means we don't know (since we didn't receive a
   // total size).
-  int PercentComplete() const;
+  virtual int PercentComplete() const = 0;
 
   // Called when the final path has been determined.
-  void OnPathDetermined(const FilePath& path);
+  virtual void OnPathDetermined(const FilePath& path) = 0;
 
   // Returns true if this download has saved all of its data.
-  bool all_data_saved() const { return all_data_saved_; }
+  virtual bool all_data_saved() const = 0;
 
   // Update the fields that may have changed in DownloadStateInfo as a
   // result of analyzing the file and figuring out its type, location, etc.
   // May only be called once.
-  void SetFileCheckResults(const DownloadStateInfo& state);
+  virtual void SetFileCheckResults(const DownloadStateInfo& state) = 0;
 
   // Update the download's path, the actual file is renamed on the download
   // thread.
-  void Rename(const FilePath& full_path);
+  virtual void Rename(const FilePath& full_path) = 0;
 
   // Allow the user to temporarily pause a download or resume a paused download.
-  void TogglePause();
+  virtual void TogglePause() = 0;
 
   // Called when the download is ready to complete.
   // This may perform final rename if necessary and will eventually call
   // DownloadItem::Completed().
-  void OnDownloadCompleting(DownloadFileManager* file_manager);
+  virtual void OnDownloadCompleting(DownloadFileManager* file_manager) = 0;
 
   // Called when the file name for the download is renamed to its final name.
-  void OnDownloadRenamedToFinalName(const FilePath& full_path);
+  virtual void OnDownloadRenamedToFinalName(const FilePath& full_path) = 0;
 
   // Returns true if this item matches |query|. |query| must be lower-cased.
-  bool MatchesQuery(const string16& query) const;
+  virtual bool MatchesQuery(const string16& query) const = 0;
 
   // Returns true if the download needs more data.
-  bool IsPartialDownload() const;
+  virtual bool IsPartialDownload() const = 0;
 
   // Returns true if the download is still receiving data.
-  bool IsInProgress() const;
+  virtual bool IsInProgress() const = 0;
 
   // Returns true if the download has been cancelled or was interrupted.
-  bool IsCancelled() const;
+  virtual bool IsCancelled() const = 0;
 
   // Returns true if the download was interrupted.
-  bool IsInterrupted() const;
+  virtual bool IsInterrupted() const = 0;
 
   // Returns true if we have all the data and know the final file name.
-  bool IsComplete() const;
+  virtual bool IsComplete() const = 0;
 
   // Accessors
-  DownloadState state() const { return state_; }
-  const FilePath& full_path() const { return full_path_; }
-  void set_path_uniquifier(int uniquifier) {
-    state_info_.path_uniquifier = uniquifier;
-  }
-  const GURL& GetURL() const;
+  virtual DownloadState state() const = 0;
+  virtual const FilePath& full_path() const = 0;
+  virtual void set_path_uniquifier(int uniquifier) = 0;
+  virtual const GURL& GetURL() const = 0;
+  virtual const std::vector<GURL>& url_chain() const = 0;
+  virtual const GURL& original_url() const = 0;
+  virtual const GURL& referrer_url() const = 0;
+  virtual std::string suggested_filename() const = 0;
+  virtual std::string content_disposition() const = 0;
+  virtual std::string mime_type() const = 0;
+  virtual std::string original_mime_type() const = 0;
+  virtual std::string referrer_charset() const = 0;
+  virtual int64 total_bytes() const = 0;
+  virtual void set_total_bytes(int64 total_bytes) = 0;
+  virtual int64 received_bytes() const = 0;
+  virtual int32 id() const = 0;
+  virtual DownloadId global_id() const = 0;
+  virtual base::Time start_time() const = 0;
+  virtual base::Time end_time() const = 0;
+  virtual void set_db_handle(int64 handle) = 0;
+  virtual int64 db_handle() const = 0;
+  virtual DownloadManager* download_manager() = 0;
+  virtual bool is_paused() const = 0;
+  virtual bool open_when_complete() const = 0;
+  virtual void set_open_when_complete(bool open) = 0;
+  virtual bool file_externally_removed() const = 0;
+  virtual SafetyState safety_state() const = 0;
+  // Why |safety_state_| is not SAFE.
+  virtual DangerType GetDangerType() const = 0;
+  virtual bool IsDangerous() const = 0;
+  virtual void MarkFileDangerous() = 0;
+  virtual void MarkUrlDangerous() = 0;
 
-  const std::vector<GURL>& url_chain() const { return url_chain_; }
-  const GURL& original_url() const { return url_chain_.front(); }
-  const GURL& referrer_url() const { return referrer_url_; }
-  std::string suggested_filename() const { return suggested_filename_; }
-  std::string content_disposition() const { return content_disposition_; }
-  std::string mime_type() const { return mime_type_; }
-  std::string original_mime_type() const { return original_mime_type_; }
-  std::string referrer_charset() const { return referrer_charset_; }
-  int64 total_bytes() const { return total_bytes_; }
-  void set_total_bytes(int64 total_bytes) {
-    total_bytes_ = total_bytes;
-  }
-  int64 received_bytes() const { return received_bytes_; }
-  int32 id() const { return download_id_.local(); }
-  DownloadId global_id() const { return download_id_; }
-  base::Time start_time() const { return start_time_; }
-  base::Time end_time() const { return end_time_; }
-  void set_db_handle(int64 handle) { db_handle_ = handle; }
-  int64 db_handle() const { return db_handle_; }
-  DownloadManager* download_manager() { return download_manager_; }
-  bool is_paused() const { return is_paused_; }
-  bool open_when_complete() const { return open_when_complete_; }
-  void set_open_when_complete(bool open) { open_when_complete_ = open; }
-  bool file_externally_removed() const { return file_externally_removed_; }
-  SafetyState safety_state() const { return safety_state_; }
-  // Why |safety_state_| is not SAFE.
-  DangerType GetDangerType() const;
-  bool IsDangerous() const;
-  void MarkFileDangerous();
-  void MarkUrlDangerous();
+  virtual bool auto_opened() = 0;
+  virtual const FilePath& target_name() const = 0;
+  virtual bool prompt_user_for_save_location() const = 0;
+  virtual bool is_otr() const = 0;
+  virtual const FilePath& suggested_path() const = 0;
+  virtual bool is_temporary() const = 0;
+  virtual void set_opened(bool opened) = 0;
+  virtual bool opened() const = 0;
 
-  bool auto_opened() { return auto_opened_; }
-  const FilePath& target_name() const { return state_info_.target_name; }
-  bool prompt_user_for_save_location() const {
-    return state_info_.prompt_user_for_save_location;
-  }
-  bool is_otr() const { return is_otr_; }
-  const FilePath& suggested_path() const { return state_info_.suggested_path; }
-  bool is_temporary() const { return is_temporary_; }
-  void set_opened(bool opened) { opened_ = opened; }
-  bool opened() const { return opened_; }
-
-  InterruptReason last_reason() const { return last_reason_; }
-
-  DownloadPersistentStoreInfo GetPersistentStoreInfo() const;
-  DownloadStateInfo state_info() const { return state_info_; }
-
-  TabContents* GetTabContents() const;
+  virtual InterruptReason last_reason() const = 0;
+  virtual DownloadPersistentStoreInfo GetPersistentStoreInfo() const = 0;
+  virtual DownloadStateInfo state_info() const = 0;
+  virtual TabContents* GetTabContents() const = 0;
 
   // Returns the final target file path for the download.
-  FilePath GetTargetFilePath() const;
+  virtual FilePath GetTargetFilePath() const = 0;
 
   // Returns the file-name that should be reported to the user, which is
   // target_name possibly with the uniquifier number.
-  FilePath GetFileNameToReportUser() const;
+  virtual FilePath GetFileNameToReportUser() const = 0;
 
   // Returns the user-verified target file path for the download.
   // This returns the same path as GetTargetFilePath() for safe downloads
   // but does not for dangerous downloads until the name is verified.
-  FilePath GetUserVerifiedFilePath() const;
+  virtual FilePath GetUserVerifiedFilePath() const = 0;
 
   // Returns true if the current file name is not the final target name yet.
-  bool NeedsRename() const {
-    return state_info_.target_name != full_path_.BaseName();
-  }
+  virtual bool NeedsRename() const = 0;
 
   // Cancels the off-thread aspects of the download.
   // TODO(rdsmith): This should be private and only called from
   // DownloadItem::Cancel/Interrupt; it isn't now because we can't
   // call those functions from
   // DownloadManager::FileSelectionCancelled() without doing some
   // rewrites of the DownloadManager queues.
-  void OffThreadCancel(DownloadFileManager* file_manager);
+  virtual void OffThreadCancel(DownloadFileManager* file_manager) = 0;
 
-  std::string DebugString(bool verbose) const;
+  virtual std::string DebugString(bool verbose) const = 0;
 
-  void MockDownloadOpenForTesting() { open_enabled_ = false; }
-
- private:
-  // Construction common to all constructors. |active| should be true for new
-  // downloads and false for downloads from the history.
-  void Init(bool active);
-
-  // Internal helper for maintaining consistent received and total sizes.
-  void UpdateSize(int64 size);
-
-  // Called when the entire download operation (including renaming etc)
-  // is completed.
-  void Completed();
-
-  // Call to transition state; all state transitions should go through this.
-  void TransitionTo(DownloadState new_state);
-
-  // Called when safety_state_ should be recomputed from is_dangerous_file
-  // and is_dangerous_url.
-  void UpdateSafetyState();
-
-  // Helper function to recompute |state_info_.target_name| when
-  // it may have changed.  (If it's non-null it should be left alone,
-  // otherwise updated from |full_path_|.)
-  void UpdateTarget();
-
-  // State information used by the download manager.
-  DownloadStateInfo state_info_;
-
-  // The handle to the request information.  Used for operations outside the
-  // download system.
-  scoped_ptr<DownloadRequestHandleInterface> request_handle_;
-
-  // Download ID assigned by DownloadResourceHandler.
-  DownloadId download_id_;
-
-  // Full path to the downloaded or downloading file.
-  FilePath full_path_;
-
-  // A number that should be appended to the path to make it unique, or 0 if the
-  // path should be used as is.
-  int path_uniquifier_;
-
-  // The chain of redirects that leading up to and including the final URL.
-  std::vector<GURL> url_chain_;
-
-  // The URL of the page that initiated the download.
-  GURL referrer_url_;
-
-  // Suggested filename in 'download' attribute of an anchor. Details:
-  // http://www.whatwg.org/specs/web-apps/current-work/#downloading-hyperlinks
-  std::string suggested_filename_;
-
-  // Information from the request.
-  // Content-disposition field from the header.
-  std::string content_disposition_;
-
-  // Mime-type from the header.  Subject to change.
-  std::string mime_type_;
-
-  // The value of the content type header sent with the downloaded item.  It
-  // may be different from |mime_type_|, which may be set based on heuristics
-  // which may look at the file extension and first few bytes of the file.
-  std::string original_mime_type_;
-
-  // The charset of the referring page where the download request comes from.
-  // It's used to construct a suggested filename.
-  std::string referrer_charset_;
-
-  // Total bytes expected
-  int64 total_bytes_;
-
-  // Current received bytes
-  int64 received_bytes_;
-
-  // Last reason.
-  InterruptReason last_reason_;
-
-  // Start time for calculating remaining time
-  base::TimeTicks start_tick_;
-
-  // The current state of this download
-  DownloadState state_;
-
-  // The views of this item in the download shelf and download tab
-  ObserverList<Observer> observers_;
-
-  // Time the download was started
-  base::Time start_time_;
-
-  // Time the download completed
-  base::Time end_time_;
-
-  // Our persistent store handle
-  int64 db_handle_;
-
-  // Our owning object
-  DownloadManager* download_manager_;
-
-  // In progress downloads may be paused by the user, we note it here
-  bool is_paused_;
-
-  // A flag for indicating if the download should be opened at completion.
-  bool open_when_complete_;
-
-  // A flag for indicating if the downloaded file is externally removed.
-  bool file_externally_removed_;
-
-  // Indicates if the download is considered potentially safe or dangerous
-  // (executable files are typically considered dangerous).
-  SafetyState safety_state_;
-
-  // True if the download was auto-opened. We set this rather than using
-  // an observer as it's frequently possible for the download to be auto opened
-  // before the observer is added.
-  bool auto_opened_;
-
-  // True if the download was initiated in an incognito window.
-  bool is_otr_;
-
-  // True if the item was downloaded temporarily.
-  bool is_temporary_;
-
-  // True if we've saved all the data for the download.
-  bool all_data_saved_;
-
-  // Did the user open the item either directly or indirectly (such as by
-  // setting always open files of this type)? The shelf also sets this field
-  // when the user closes the shelf before the item has been opened but should
-  // be treated as though the user opened it.
-  bool opened_;
-
-  // Do we actual open downloads when requested?  For testing purposes
-  // only.
-  bool open_enabled_;
-
-  // Did the delegate delay calling Complete on this download?
-  bool delegate_delayed_complete_;
-
-  DISALLOW_COPY_AND_ASSIGN(DownloadItem);
+  virtual void MockDownloadOpenForTesting() = 0;
 };
 
 #endif  // CONTENT_BROWSER_DOWNLOAD_DOWNLOAD_ITEM_H_