Make DownloadHistory observe manager, items

content/public/browser/download_item.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.
 //
 // 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.
 
 #ifndef CONTENT_PUBLIC_BROWSER_DOWNLOAD_ITEM_H_
 #define CONTENT_PUBLIC_BROWSER_DOWNLOAD_ITEM_H_
 
 #include <map>
 #include <string>
 #include <vector>
 
 #include "base/file_path.h"
 #include "base/string16.h"
+#include "base/supports_user_data.h"
 #include "content/public/browser/download_danger_type.h"
 #include "content/public/browser/download_interrupt_reasons.h"
 #include "content/public/common/page_transition_types.h"
 
 class FilePath;
 class GURL;
 struct DownloadCreateInfo;
 
 namespace base {
 class Time;
 class TimeDelta;
 }
 
 namespace content {
 
 class BrowserContext;
 class DownloadId;
 class DownloadManager;
 class WebContents;
 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 {
+class CONTENT_EXPORT DownloadItem : public base::SupportsUserData {
  public:
   enum DownloadState {
     // Download is actively progressing.
     IN_PROGRESS = 0,
 
     // Download is completely finished.
     COMPLETE,
 
     // Download has been cancelled.
     CANCELLED,
 
-    // This state indicates that the download item is about to be destroyed,
-    // and observers seeing this state should release all references.
-    REMOVING,
-
     // This state indicates that the download has been interrupted.
     INTERRUPTED,
 
     // Maximum value.
     MAX_DOWNLOAD_STATE
   };
 
   enum SafetyState {
     SAFE = 0,
     DANGEROUS,
@@ skipping 17 matching lines @@
   // A fake download table ID which represents a download that has started,
   // but is not yet in the table.
   static const int kUninitializedHandle;
 
   static const char kEmptyFileHash[];
 
   // 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;
+    virtual void OnDownloadUpdated(DownloadItem* download) {}
 
     // Called when a downloaded file has been opened.
-    virtual void OnDownloadOpened(DownloadItem* download) = 0;
+    virtual void OnDownloadOpened(DownloadItem* download) {}
+
+    // Called when the user removes a download.
+    virtual void OnDownloadRemoved(DownloadItem* download) {}
+
+    // Called when the download is being destroyed. This happens after
+    // every OnDownloadRemoved() as well as when the DownloadManager is going
+    // down.
+    virtual void OnDownloadDestroyed(DownloadItem* download) {}
 
    protected:
     virtual ~Observer() {}
   };
 
-  // Interface for data that can be stored associated with (and owned
-  // by) an object of this class via GetExternalData/SetExternalData.
-  class ExternalData {
-   public:
-    virtual ~ExternalData() {};
-  };
-
   virtual ~DownloadItem() {}
 
   virtual void AddObserver(DownloadItem::Observer* observer) = 0;
   virtual void RemoveObserver(DownloadItem::Observer* observer) = 0;
 
   // Notifies our observers periodically.
   virtual void UpdateObservers() = 0;
 
   // Returns true if it is OK to open a folder which this file is inside.
   virtual bool CanShowInFolder() = 0;
@@ skipping 87 matching lines @@
   virtual const FilePath& GetTargetFilePath() const = 0;
 
   // Get the target disposition.
   virtual TargetDisposition GetTargetDisposition() const = 0;
 
   // Called if a check of the download contents was performed and the results of
   // the test are available. This should only be called after AllDataSaved() is
   // true.
   virtual void OnContentCheckCompleted(DownloadDangerType danger_type) = 0;
 
-  virtual bool IsPersisted() const = 0;
-
   // Accessors
   virtual const std::string& GetHash() const = 0;
   virtual DownloadState GetState() const = 0;
   virtual const GURL& GetURL() const = 0;
   virtual const std::vector<GURL>& GetUrlChain() const = 0;
   virtual const GURL& GetOriginalUrl() const = 0;
   virtual const GURL& GetReferrerUrl() const = 0;
   virtual std::string GetSuggestedFilename() const = 0;
   virtual std::string GetContentDisposition() const = 0;
   virtual std::string GetMimeType() const = 0;
   virtual std::string GetOriginalMimeType() const = 0;
   virtual std::string GetReferrerCharset() const = 0;
   virtual std::string GetRemoteAddress() const = 0;
   virtual int64 GetTotalBytes() const = 0;
   virtual int64 GetReceivedBytes() const = 0;
   virtual const std::string& GetHashState() const = 0;
   virtual int32 GetId() const = 0;
   virtual DownloadId GetGlobalId() const = 0;
   virtual base::Time GetStartTime() const = 0;
   virtual base::Time GetEndTime() const = 0;
-  virtual int64 GetDbHandle() const = 0;
   virtual bool IsPaused() const = 0;
   virtual bool GetOpenWhenComplete() const = 0;
   virtual void SetOpenWhenComplete(bool open) = 0;
   virtual bool GetFileExternallyRemoved() const = 0;
   virtual SafetyState GetSafetyState() const = 0;
   // Why |safety_state_| is not SAFE.
   virtual DownloadDangerType GetDangerType() const = 0;
   virtual bool IsDangerous() const = 0;
 
   virtual bool GetAutoOpened() = 0;
   virtual FilePath GetTargetName() const = 0;
   virtual const FilePath& GetForcedFilePath() const = 0;
   virtual bool HasUserGesture() const = 0;
   virtual PageTransition GetTransitionType() const = 0;
   virtual bool IsOtr() const = 0;
   virtual bool IsTemporary() const = 0;
   virtual void SetIsTemporary(bool temporary) = 0;
   virtual void SetOpened(bool opened) = 0;
   virtual bool GetOpened() const = 0;
 
   virtual const std::string& GetLastModifiedTime() const = 0;
   virtual const std::string& GetETag() const = 0;
 
   virtual DownloadInterruptReason GetLastReason() const = 0;
-  virtual DownloadPersistentStoreInfo GetPersistentStoreInfo() const = 0;
   virtual BrowserContext* GetBrowserContext() const = 0;
   virtual WebContents* GetWebContents() const = 0;
 
   // Returns the file-name that should be reported to the user. If a display
   // name has been explicitly set using SetDisplayName(), this function returns
   // that display name. Otherwise returns the final target filename.
   virtual FilePath GetFileNameToReportUser() const = 0;
 
   // Set a display name for the download that will be independent of the target
   // filename. If |name| is not empty, then GetFileNameToReportUser() will
   // return |name|. Has no effect on the final target filename.
   virtual void SetDisplayName(const FilePath& name) = 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.
   virtual FilePath GetUserVerifiedFilePath() const = 0;
 
-  // Manage data owned by other subsystems associated with the
-  // DownloadItem.  By custom, key is the address of a
-  // static char subsystem_specific_string[] = ".."; defined
-  // in the subsystem, but the only requirement of this interface
-  // is that the key be unique over all data stored with this
-  // DownloadItem.
-  //
-  // Note that SetExternalData takes ownership of the
-  // passed object; it will be destroyed when the DownloadItem is.
-  // If an object is already held by the DownloadItem associated with
-  // the passed key, it will be destroyed if overwriten by a new pointer
-  // (overwrites by the same pointer are ignored).
-  virtual       ExternalData* GetExternalData(const void* key) = 0;
-  virtual const ExternalData* GetExternalData(const void* key) const = 0;
-  virtual void SetExternalData(const void* key, ExternalData* data) = 0;
-
   virtual std::string DebugString(bool verbose) const = 0;
 
   virtual void MockDownloadOpenForTesting() = 0;
 };
 
 }  // namespace content
 
 #endif  // CONTENT_PUBLIC_BROWSER_DOWNLOAD_ITEM_H_