Download filename determination refactor (3/3)

content/public/browser/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 CONTENT_PUBLIC_BROWSER_DOWNLOAD_MANAGER_DELEGATE_H_
 #define CONTENT_PUBLIC_BROWSER_DOWNLOAD_MANAGER_DELEGATE_H_
 #pragma once
 
 #include "base/basictypes.h"
 #include "base/callback.h"
 #include "base/file_path.h"
 #include "base/logging.h"
 #include "base/time.h"
 #include "content/common/content_export.h"
+#include "content/public/browser/download_danger_type.h"
+#include "content/public/browser/download_item.h"
 #include "content/public/browser/save_page_type.h"
 
 namespace content {
 
 class DownloadId;
-class DownloadItem;
 class WebContents;
 
 // Called by SavePackage when it creates a DownloadItem.
 typedef base::Callback<void(DownloadItem*)>
     SavePackageDownloadCreatedCallback;
 
 // Will be called asynchronously with the results of the ChooseSavePath
 // operation.  If the delegate wants notification of the download item created
 // in response to this operation, the SavePackageDownloadCreatedCallback will be
 // non-null.
 typedef base::Callback<void(const FilePath&,
                             content::SavePageType,
                             const SavePackageDownloadCreatedCallback&)>
     SavePackagePathPickedCallback;
 
+typedef base::Callback<void(
+    const FilePath& target_path,
+    content::DownloadItem::TargetDisposition disposition,
+    content::DownloadDangerType danger_type,
+    const FilePath& intermediate_path)> DownloadTargetCallback;
+
 // Browser's download manager: manages all downloads and destination view.
 class CONTENT_EXPORT DownloadManagerDelegate {
  public:
   // Lets the delegate know that the download manager is shutting down.
   virtual void Shutdown() {}
 
   // Returns a new DownloadId.
   virtual DownloadId GetNextId();
 
-  // Notifies the delegate that a download is starting. The delegate can return
-  // false to delay the start of the download, in which case it should call
-  // DownloadManager::RestartDownload when it's ready.
-  virtual bool ShouldStartDownload(int32 download_id);
-
-  // Asks the user for the path for a download. The delegate calls
-  // DownloadManager::FileSelected or DownloadManager::FileSelectionCanceled to
-  // give the answer.
-  virtual void ChooseDownloadPath(DownloadItem* item) {}
-
-  // Allows the embedder to set an intermediate name for the download until it's
-  // complete. The return value is the intermediate path to use. If the embedder
-  // doesn't want to set an intermediate path, it should return
-  // item.GetTargetFilePath(). If there's already a file at the returned path,
-  // it will not be overwritten. Instead the path will be uniquified by adding a
-  // suffix to the filename.
-  virtual FilePath GetIntermediatePath(const DownloadItem& item);
+  // The delegate needs to generate a filename for the new download |item|. Once
+  // the target information has been determined, the delegate is required to
+  // call DownloadItem::OnDownloadTargetDetermined(). This function should

[Randy Smith (Not in Mondays), 2012/07/10 18:33:09]

nit: "... required to call the callback."

[asanka, 2012/07/11 20:03:32]

Done.

+  // return |true| if it has or will invoke |callback|. If it returns |false|,
+  // the download manager will continue the download using a default, possibly
+  // empty, target path.

[Randy Smith (Not in Mondays), 2012/07/10 18:33:09]

nit: If you're allowing the callback to be invoked from inside this call (which
I *think* is not a common pattern in the code base) it's probably with being a
bit more explicit about it.  Just saying that the callback may be called
directly from the routine is fine.

[asanka, 2012/07/11 20:03:32]

Done.

+  virtual bool DetermineDownloadTarget(DownloadItem* item,
+                                       const DownloadTargetCallback& callback);
 
   // Called when the download system wants to alert a WebContents that a
   // download has started, but the TabConetnts has gone away. This lets an
   // delegate return an alternative WebContents. The delegate can return NULL.
   virtual WebContents* GetAlternativeWebContentsToNotifyForDownload();
 
   // Tests if a file type should be opened automatically.
   virtual bool ShouldOpenFileBasedOnExtension(const FilePath& path);
 
   // Allows the delegate to delay completion of the download.  This function
@@ skipping 38 matching lines @@
 
   // Notifies the delegate that it should remove the download item from its
   // persistent store.
   virtual void RemoveItemFromPersistentStore(DownloadItem* item) {}
 
   // Notifies the delegate to remove downloads from the given time range.
   virtual void RemoveItemsFromPersistentStoreBetween(
       base::Time remove_begin,
       base::Time remove_end) {}
 
+  // Invoked when history is being cleared to clear the delegate's transient
+  // state.
+  virtual void ClearTransientState() {}
+
   // Retrieve the directories to save html pages and downloads to.
   virtual void GetSaveDir(WebContents* web_contents,
                           FilePath* website_save_dir,
                           FilePath* download_save_dir,
                           bool* skip_dir_check) {}
 
   // Asks the user for the path to save a page. The delegate calls the callback
   // to give the answer.
   virtual void ChooseSavePath(WebContents* web_contents,
                               const FilePath& suggested_path,
                               const FilePath::StringType& default_extension,
                               bool can_save_as_complete,
                               const SavePackagePathPickedCallback& callback) {
   }
 
  protected:
   virtual ~DownloadManagerDelegate();
 };
 
 }  // namespace content
 
 #endif  // CONTENT_PUBLIC_BROWSER_DOWNLOAD_MANAGER_DELEGATE_H_