Support for adding save page download items into downloads history.

chrome/browser/download/download_manager.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.
 //
 // The DownloadManager object manages the process of downloading, including
 // updates to the history system and providing the information for displaying
 // the downloads view in the Destinations tab. There is one DownloadManager per
 // active profile in Chrome.
 //
 // Download observers:
@@ skipping 146 matching lines @@
   int RemoveDownloads(const base::Time remove_begin);
 
   // Remove all downloads will delete all downloads. The number of downloads
   // deleted is returned back to the caller.
   int RemoveAllDownloads();
 
   // Final download manager transition for download: Update the download
   // history and remove the download from |active_downloads_|.
   void DownloadCompleted(int32 download_id);
 
-  // Called when a Save Page As download is started. Transfers ownership
-  // of |download_item| to the DownloadManager.
-  void SavePageAsDownloadStarted(DownloadItem* download_item);
-
   // Download the object at the URL. Used in cases such as "Save Link As..."
   void DownloadUrl(const GURL& url,
                    const GURL& referrer,
                    const std::string& referrer_encoding,
                    TabContents* tab_contents);
 
   // Download the object at the URL and save it to the specified path. The
   // download is treated as the temporary download and thus will not appear
   // in the download history. Used in cases such as drag and drop.
   void DownloadUrlToFile(const GURL& url,
@@ skipping 14 matching lines @@
   void OnCreateDownloadEntryComplete(int32 download_id, int64 db_handle);
 
   // Display a new download in the appropriate browser UI.
   void ShowDownloadInBrowser(DownloadItem* download);
 
   // The number of in progress (including paused) downloads.
   int in_progress_count() const {
     return static_cast<int>(in_progress_.size());
   }
 
-  Profile* profile() { return profile_; }
+  Profile* profile() const { return profile_; }

[Paweł Hajdan Jr., 2011/07/27 16:53:51]

Why? It is risky (in terms of hard to misuse API) to make a const method return
a non-const pointer. Same for below.

[Randy Smith (Not in Mondays), 2011/07/27 21:08:35]

This was my fault; an earlier patchset was exposing download_history() and I was
struggling for some way to limit it's usage so I suggested making it const.  I'm
good with pulling the consts back off these methods.

[achuithb, 2011/07/28 00:45:58]

If you are saying that the const does nothing of value, I agree with that - it
is somewhat misleading since the pointer is not const. Anyway, I've removed the
consts.

 
-  DownloadPrefs* download_prefs() { return download_prefs_.get(); }
+  DownloadPrefs* download_prefs() const { return download_prefs_.get(); }
 
   // Creates the download item.  Must be called on the UI thread.
   void CreateDownloadItem(DownloadCreateInfo* info);
 
   // Clears the last download path, used to initialize "save as" dialogs.
   void ClearLastDownloadPath();
 
   // Tests if a file type should be opened automatically.
   bool ShouldOpenFileBasedOnExtension(const FilePath& path) const;
 
@@ skipping 38 matching lines @@
   void CheckDownloadHashDone(int32 download_id, bool is_dangerous_hash);
 
   // Assert the named download item is on the correct queues
   // in the DownloadManager.  For debugging.
   void AssertQueueStateConsistent(DownloadItem* download);
 
   // Get the download item from the history map.  Useful after the item has
   // been removed from the active map, or was retrieved from the history DB.
   DownloadItem* GetDownloadItem(int id);
 
+  // Called when Save Page download starts. Transfers ownership of |download|
+  // to the DownloadManager.
+  void SavePageDownloadStarted(DownloadItem* download);
+
+  // Callback when Save Page As entry is commited to the history system.
+  void OnSavePageDownloadEntryAdded(int32 download_id, int64 db_handle);
+
+  // Called when Save Page download is done.
+  void SavePageDownloadFinished(DownloadItem* download);
+
+  // Save Page Ids.
+  int32 GetNextSavePageId();
+
  private:
   // For testing.
   friend class DownloadManagerTest;
   friend class MockDownloadManager;
+  friend class SavePageBrowserTest;
 
   // This class is used to let an incognito DownloadManager observe changes to
   // a normal DownloadManager, to propagate ModelChanged() calls from the parent
   // DownloadManager to the observers of the incognito DownloadManager.
   class OtherDownloadManagerObserver : public Observer {
    public:
     explicit OtherDownloadManagerObserver(
         DownloadManager* observing_download_manager);
     virtual ~OtherDownloadManagerObserver();
 
     // Observer interface.
     virtual void ModelChanged();
     virtual void ManagerGoingDown();
 
    private:
     // The incognito download manager.
     DownloadManager* observing_download_manager_;
 
     // The original profile's download manager.
     DownloadManager* observed_download_manager_;
   };
 
   friend struct BrowserThread::DeleteOnThread<BrowserThread::UI>;
   friend class DeleteTask<DownloadManager>;
   friend class OtherDownloadManagerObserver;
 
   virtual ~DownloadManager();
 
+  DownloadHistory* download_history() const { return download_history_.get(); }

[Randy Smith (Not in Mondays), 2011/07/27 21:08:35]

I don't think this is used anymore; can we remove it?

[achuithb, 2011/07/28 00:45:58]

It is used in SavePageBrowserTest::QueryDownloadHistory(). I can make this
method non-const (doesn't really matter). I can also directly access
download_history_ since SavePageBrowserTest is a friend, but I think the
accessor is nicer.

[Randy Smith (Not in Mondays), 2011/07/28 21:16:04]

Nope, that makes sense.  I don't care a lot about private accessors, and this
balance is right anyway from my POV--it's not used by code inside of
DownloadManager, so it shouldn't use the member variables, but it's from a test,
so a friend test + private restricts access.  Thanks for the explanation.

+
   // Called on the FILE thread to check the existence of a downloaded file.
   void CheckForFileRemovalOnFileThread(int64 db_handle, const FilePath& path);
 
   // Called on the UI thread if the FILE thread detects the removal of
   // the downloaded file. The UI thread updates the state of the file
   // and then notifies this update to the file's observer.
   void OnFileRemovalDetected(int64 db_handle);
 
   // Called on the download thread to check whether the suggested file path
   // exists.  We don't check if the file exists on the UI thread to avoid UI
@@ skipping 35 matching lines @@
   // yet in the history map.
   DownloadItem* GetActiveDownloadItem(int id);
 
   // Debugging routine to confirm relationship between below
   // containers; no-op if NDEBUG.
   void AssertContainersConsistent() const;
 
   // Add a DownloadItem to history_downloads_.
   void AddDownloadItemToHistory(DownloadItem* item, int64 db_handle);
 
+  typedef std::vector<DownloadItem*> DownloadVec;

[Paweł Hajdan Jr., 2011/07/27 16:53:51]

nit: Please avoid abbreviations like Vec. Use Vector, the full name. Also, don't
we already have some typedef for this? Just checking.

Or maybe we could just use DownloadSet for simplicity?

[Randy Smith (Not in Mondays), 2011/07/27 21:08:35]

I don't think we have a typedef for this--before this PS, there were several
methods in DM that took an explicit std::vector<DownloadItem*>.  I wouldn't mind
having a public typedef for this, but I agree with Pawel; it shouldn't be
abbreviated.
I'd rather not do that; DownloadSet is a private typedef having to do with the
internal implementation of the DownloadManager, and I don't want to expose it. 
I also think that vectors are more comfortable to programmers than sets, and
vectors are already in the DM interface (see, e.g., GetAllDownloads).  

[achuithb, 2011/07/28 00:45:58]

I created a public typedef for DownloadVector and used it in the other methods
that return a vector of DownloadItem*. This change has nothing to do with this
CL, so I can revert it if you don't like it.
For RemoveDownloadItem, I went with using DownloadSet, since the order doesn't
really matter.

+  int RemoveDownloadItems(const DownloadVec& items);
+
   // |downloads_| is the owning set for all downloads known to the
   // DownloadManager.  This includes downloads started by the user in
   // this session, downloads initialized from the history system, and
   // "save page as" downloads.  All other DownloadItem containers in
   // the DownloadManager are maps; they do not own the DownloadItems.
   // Note that this is the only place (with any functional implications;
   // see save_page_as_downloads_ below) that "save page as" downloads are
   // kept, as the DownloadManager's only job is to hold onto those
   // until destruction.
   //
@@ skipping 23 matching lines @@
   // Downloads from past sessions read from a persisted state from the
   // history system are placed directly into |history_downloads_| since
   // they have valid handles in the history system.
   typedef std::set<DownloadItem*> DownloadSet;
   typedef base::hash_map<int64, DownloadItem*> DownloadMap;
 
   DownloadSet downloads_;
   DownloadMap history_downloads_;
   DownloadMap in_progress_;
   DownloadMap active_downloads_;
-#if !defined(NDEBUG)
-  DownloadSet save_page_as_downloads_;
-#endif
+  DownloadMap save_page_downloads_;
 
   // True if the download manager has been initialized and requires a shutdown.
   bool shutdown_needed_;
 
   // Observers that want to be notified of changes to the set of downloads.
   ObserverList<Observer> observers_;
 
   // The current active profile.
   Profile* profile_;
 
   scoped_ptr<DownloadHistory> download_history_;
 
   scoped_ptr<DownloadPrefs> download_prefs_;
 
   // Non-owning pointer for handling file writing on the download_thread_.
   DownloadFileManager* file_manager_;
 
   // Non-owning pointer for updating the download status.
   base::WeakPtr<DownloadStatusUpdater> status_updater_;
 
   // The user's last choice for download directory. This is only used when the
   // user wants us to prompt for a save location for each download.
   FilePath last_download_path_;
 
+  // Save Page Ids.
+  int32 next_save_page_id_;
+
   // The "Save As" dialog box used to ask the user where a file should be
   // saved.
   scoped_refptr<SelectFileDialog> select_file_dialog_;
 
   scoped_ptr<OtherDownloadManagerObserver> other_download_manager_observer_;
 
   DISALLOW_COPY_AND_ASSIGN(DownloadManager);
 };
 
 #endif  // CHROME_BROWSER_DOWNLOAD_DOWNLOAD_MANAGER_H_