Download filename determination refactor (3/3)

chrome/browser/download/chrome_download_manager_delegate.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_DOWNLOAD_CHROME_DOWNLOAD_MANAGER_DELEGATE_H_
 #define CHROME_BROWSER_DOWNLOAD_CHROME_DOWNLOAD_MANAGER_DELEGATE_H_
 
 #include "base/compiler_specific.h"
 #include "base/hash_tables.h"
 #include "base/memory/ref_counted.h"
@@ skipping 27 matching lines @@
 };
 }  // namespace BASE_HASH_NAMESPACE
 #endif
 
 // This is the Chrome side helper for the download system.
 class ChromeDownloadManagerDelegate
     : public base::RefCountedThreadSafe<ChromeDownloadManagerDelegate>,
       public content::DownloadManagerDelegate,
       public content::NotificationObserver {
  public:
+  // Callback type used with ChooseDownloadPath(). The callback should be
+  // invoked with the user-selected path as the argument. If the file selection
+  // was canceled, the argument should be the empty path.
+  typedef base::Callback<void(const FilePath&)> FileSelectedCallback;
+
   explicit ChromeDownloadManagerDelegate(Profile* profile);
 
   void SetDownloadManager(content::DownloadManager* dm);
 
   // Should be called before the first call to ShouldCompleteDownload() to
   // disable SafeBrowsing checks for |item|.
   static void DisableSafeBrowsing(content::DownloadItem* item);
 
+  // content::DownloadManagerDelegate
   virtual void Shutdown() OVERRIDE;
   virtual content::DownloadId GetNextId() OVERRIDE;
-  virtual bool ShouldStartDownload(int32 download_id) OVERRIDE;
-  virtual void ChooseDownloadPath(content::DownloadItem* item) OVERRIDE;
-  virtual FilePath GetIntermediatePath(
-      const content::DownloadItem& item) OVERRIDE;
+  virtual bool DetermineDownloadTarget(
+      content::DownloadItem* item,
+      const content::DownloadTargetCallback& callback) OVERRIDE;
   virtual content::WebContents*
       GetAlternativeWebContentsToNotifyForDownload() OVERRIDE;
   virtual bool ShouldOpenFileBasedOnExtension(const FilePath& path) OVERRIDE;
   virtual bool ShouldCompleteDownload(
       content::DownloadItem* item,
       const base::Closure& complete_callback) OVERRIDE;
   virtual bool ShouldOpenDownload(content::DownloadItem* item) OVERRIDE;
   virtual bool GenerateFileHash() OVERRIDE;
   virtual void AddItemToPersistentStore(content::DownloadItem* item) OVERRIDE;
   virtual void UpdateItemInPersistentStore(
@@ skipping 10 matching lines @@
                           FilePath* website_save_dir,
                           FilePath* download_save_dir,
                           bool* skip_dir_check) OVERRIDE;
   virtual void ChooseSavePath(
       content::WebContents* web_contents,
       const FilePath& suggested_path,
       const FilePath::StringType& default_extension,
       bool can_save_as_complete,
       const content::SavePackagePathPickedCallback& callback) OVERRIDE;
 
+  // Clears the last directory chosen by the user in response to a file chooser
+  // prompt. Called when clearing recent history.
+  void ClearLastDownloadPath();
+
   DownloadPrefs* download_prefs() { return download_prefs_.get(); }
   DownloadHistory* download_history() { return download_history_.get(); }
 
  protected:
   // So that test classes can inherit from this for override purposes.
   virtual ~ChromeDownloadManagerDelegate();
 
   // Returns the SafeBrowsing download protection service if it's
   // enabled. Returns NULL otherwise. Protected virtual for testing.
   virtual safe_browsing::DownloadProtectionService*
      GetDownloadProtectionService();
 
   // Returns true if this download should show the "dangerous file" warning.
   // Various factors are considered, such as the type of the file, whether a
   // user action initiated the download, and whether the user has explicitly
   // marked the file type as "auto open". Protected virtual for testing.
   virtual bool IsDangerousFile(const content::DownloadItem& download,
                                const FilePath& suggested_path,
                                bool visited_referrer_before);
 
   // Obtains a path reservation by calling
   // DownloadPathReservationTracker::GetReservedPath(). Protected virtual for
   // testing.
   virtual void GetReservedPath(
       content::DownloadItem& download,
       const FilePath& target_path,
       const FilePath& default_download_path,
       bool should_uniquify_path,
-      const DownloadPathReservationTracker::ReservedPathCallback callback);
+      const DownloadPathReservationTracker::ReservedPathCallback& callback);
+
+  // Displays the file chooser dialog to prompt the user for the download
+  // location for |item|. |suggested_path| will be used as the initial download
+  // path. Once a location is available |callback| will be invoked with the
+  // selected full path. If the user cancels the dialog, then an empty FilePath
+  // will be passed into |callback|. Protected virtual for testing.
+  virtual void ChooseDownloadPath(content::DownloadItem* item,
+                                  const FilePath& suggested_path,
+                                  const FileSelectedCallback& callback);
 
   // So that test classes that inherit from this for override purposes
   // can call back into the DownloadManager.
   scoped_refptr<content::DownloadManager> download_manager_;
 
  private:
   friend class base::RefCountedThreadSafe<ChromeDownloadManagerDelegate>;
 
   // content::NotificationObserver implementation.
   virtual void Observe(int type,
                        const content::NotificationSource& source,
                        const content::NotificationDetails& details) OVERRIDE;
 
   // Callback function after url is checked with safebrowsing service.
   void CheckDownloadUrlDone(
       int32 download_id,
+      const content::DownloadTargetCallback& callback,
       safe_browsing::DownloadProtectionService::DownloadCheckResult result);
 
   // Callback function after the DownloadProtectionService completes.
   void CheckClientDownloadDone(
       int32 download_id,
       safe_browsing::DownloadProtectionService::DownloadCheckResult result);
 
   // Callback function after we check whether the referrer URL has been visited
   // before today. Determines the danger state of the download based on the file
   // type and |visited_referrer_before|. Generates a target path for the
   // download. Invokes |DownloadPathReservationTracker::GetReservedPath| to get
   // a reserved path for the download. The path is then passed into
   // OnPathReservationAvailable().
-  void CheckVisitedReferrerBeforeDone(int32 download_id,
-                                      content::DownloadDangerType danger_type,
-                                      bool visited_referrer_before);
+  void CheckVisitedReferrerBeforeDone(
+      int32 download_id,
+      const content::DownloadTargetCallback& callback,
+      content::DownloadDangerType danger_type,
+      bool visited_referrer_before);
 
 #if defined (OS_CHROMEOS)
   // GDataDownloadObserver::SubstituteGDataDownloadPath callback. Calls
   // |DownloadPathReservationTracker::GetReservedPath| to get a reserved path
   // for the download. The path is then passed into
   // OnPathReservationAvailable().
   void SubstituteGDataDownloadPathCallback(
       int32 download_id,
+      const content::DownloadTargetCallback& callback,
       bool should_prompt,
       bool is_forced_path,
       content::DownloadDangerType danger_type,
       const FilePath& unverified_path);
 #endif
 
+  // Determine the intermediate path to use for |target_path|. |danger_type|
+  // specifies the danger level of the download.
+  FilePath GetIntermediatePath(const FilePath& target_path,
+                               content::DownloadDangerType danger_type);
+
   // Called on the UI thread once a reserved path is available. Updates the
   // download identified by |download_id| with the |target_path|, target
   // disposition and |danger_type|.
   void OnPathReservationAvailable(
       int32 download_id,
+      const content::DownloadTargetCallback& callback,
       bool should_prompt,
       content::DownloadDangerType danger_type,
-      const FilePath& target_path,
-      bool target_path_verified);
+      const FilePath& reserved_path,
+      bool reserved_path_verified);
+
+  // Called on the UI thread once the final target path is available.
+  void OnTargetPathDetermined(
+      int32 download_id,
+      const content::DownloadTargetCallback& callback,
+      content::DownloadItem::TargetDisposition disposition,
+      content::DownloadDangerType danger_type,
+      const FilePath& target_path);
 
   // Callback from history system.
   void OnItemAddedToPersistentStore(int32 download_id, int64 db_handle);
 
   // Check policy of whether we should open this download with a web intents
   // dispatch.
   bool ShouldOpenWithWebIntents(const content::DownloadItem* item);
 
   // Open the given item with a web intent dispatch.
   void OpenWithWebIntent(const content::DownloadItem* item);
@@ skipping 24 matching lines @@
 #if !defined(OS_ANDROID)
   // The ExtensionDownloadsEventRouter dispatches download creation, change, and
   // erase events to extensions. Like ChromeDownloadManagerDelegate, it's a
   // chrome-level concept and its lifetime should match DownloadManager. There
   // should be a separate EDER for on-record and off-record managers.
   // There does not appear to be a separate ExtensionSystem for on-record and
   // off-record profiles, so ExtensionSystem cannot own the EDER.
   scoped_ptr<ExtensionDownloadsEventRouter> extension_event_router_;
 #endif
 
+  // The directory most recently chosen by the user in response to a Save As
+  // dialog for a regular download.
+  FilePath last_download_path_;
+
   DISALLOW_COPY_AND_ASSIGN(ChromeDownloadManagerDelegate);
 };
 
 #endif  // CHROME_BROWSER_DOWNLOAD_CHROME_DOWNLOAD_MANAGER_DELEGATE_H_