Implement chrome.downloads.onDeterminingFilename()

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"
 #include "base/memory/scoped_ptr.h"
 #include "chrome/browser/common/cancelable_request.h"
 #include "chrome/browser/download/download_path_reservation_tracker.h"
 #include "chrome/browser/safe_browsing/download_protection_service.h"
 #include "content/public/browser/download_danger_type.h"
 #include "content/public/browser/download_item.h"
 #include "content/public/browser/download_manager_delegate.h"
 #include "content/public/browser/notification_observer.h"
 #include "content/public/browser/notification_registrar.h"
 
 class DownloadPrefs;
-class ExtensionDownloadsEventRouter;
 class Profile;
 
 namespace content {
 class DownloadManager;
 }
 
 namespace extensions {
 class CrxInstaller;
 }
 
@@ skipping 96 matching lines @@
                                   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>;
 
+  struct ContinueFilenameDeterminationInfo {
+    ContinueFilenameDeterminationInfo();
+    ~ContinueFilenameDeterminationInfo();
+    int32 download_id;
+    content::DownloadTargetCallback callback;
+    content::DownloadDangerType danger_type;
+    bool visited_referrer_before;

[battre, 2013/01/11 14:29:37]

This and the following parameter are unclear to me without having much
background in the download manager. Up to you whether you want to add comments.

[benjhayden, 2013/01/11 21:21:27]

I'll let Randy decide this.

+    bool should_prompt;
+  };
+
   // 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);
@@ skipping 38 matching lines @@
   // 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& reserved_path,
       bool reserved_path_verified);
 
+  // When an extension opts to change a download's target filename, this
+  // sanitizes it before continuing with the filename determination process.
+  void OnExtensionsChangingFilename(
+      ContinueFilenameDeterminationInfo continue_info,

[battre, 2013/01/11 14:29:37]

pass structs as const ref?

[benjhayden, 2013/01/11 21:21:27]

Done.

+      const FilePath& changed_filename,
+      bool overwrite);
+
+  // When extensions either opt not to change a download's target filename, or
+  // the changed filename has been sanitized, this method continues with the
+  // filename determination process, optionally prompting the user to manually
+  // set the filename.
+  void OnExtensionsDeterminedFilename(
+      ContinueFilenameDeterminationInfo continue_info,

[battre, 2013/01/11 14:29:37]

pass structs as const ref?

[benjhayden, 2013/01/11 21:21:27]

Done.

+      const FilePath& suggested_path,
+      bool is_forced_path);
+
   // 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);
 
   // Check policy of whether we should open this download with a web intents
   // dispatch.
@@ skipping 16 matching lines @@
 
   // Maps from pending extension installations to DownloadItem IDs.
   typedef base::hash_map<extensions::CrxInstaller*,
       content::DownloadOpenDelayedCallback> CrxInstallerMap;
   CrxInstallerMap crx_installers_;
 
   CancelableRequestConsumer history_consumer_;
 
   content::NotificationRegistrar registrar_;
 
-  // On Android, GET downloads are not handled by the DownloadManager.
-  // Once we have extensions on android, we probably need the EventRouter
-  // in ContentViewDownloadDelegate which knows about both GET and POST
-  // downloads.
-#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_