DownloadUrlParameters

content/public/browser/download_manager.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.
 //
 // 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 browser context in Chrome.
 //
 // Download observers:
@@ skipping 17 matching lines @@
 #define CONTENT_PUBLIC_BROWSER_DOWNLOAD_MANAGER_H_
 #pragma once
 
 #include <string>
 #include <vector>
 
 #include "base/basictypes.h"
 #include "base/callback.h"
 #include "base/file_path.h"
 #include "base/gtest_prod_util.h"
+#include "base/memory/scoped_ptr.h"
 #include "base/message_loop_helpers.h"
 #include "base/time.h"
+#include "base/values.h"
+#include "content/public/browser/browser_thread.h"
 #include "content/public/browser/download_id.h"
 #include "content/public/browser/download_interrupt_reasons.h"
 #include "content/public/browser/download_item.h"
-#include "content/public/browser/browser_thread.h"
+#include "content/public/browser/download_save_info.h"
+#include "googleurl/src/gurl.h"
+#include "net/base/net_errors.h"

[Randy Smith (Not in Mondays), 2012/04/30 19:44:48]

Why are there so many include files (and other stuff) being added to this file
for the removal of a lot of things and a parameter that can be forward declared?

[benjhayden, 2012/05/02 15:11:54]

Done.

 #include "net/base/net_log.h"
-#include "net/base/net_errors.h"
 
 class DownloadRequestHandle;
-class GURL;
 struct DownloadCreateInfo;
 struct DownloadRetrieveInfo;
 
 namespace content {
+
 class BrowserContext;
 class DownloadManagerDelegate;
 class DownloadQuery;
-class WebContents;
-struct DownloadSaveInfo;
+class DownloadUrlParameters;
+class ResourceContext;
+class ResourceDispatcherHostImpl;
 
 // Browser's download manager: manages all downloads and destination view.
 class CONTENT_EXPORT DownloadManager
     : public base::RefCountedThreadSafe<DownloadManager> {
  public:
-  // NOTE: If there is an error, the DownloadId will be invalid.
-  typedef base::Callback<void(DownloadId, net::Error)> OnStartedCallback;

[Randy Smith (Not in Mondays), 2012/04/30 19:44:48]

Suggestion: Several of the files in this CL have only the change of getting
OnStartedCallback from DownloadUrlParameters instead of DownloadManager.  That's
suggestive that it's at least worth asking the question whether we should leave
the callback defined on DownloadManager (even if used in DownloadUrlParamters);
if there are several locations that only need to know about the callback, should
we be making them include the whole include file?

(It's up to you, but for what it's worth when I ask the question I lean towards
leaving it on DownloadManager, but not strongly.  Looking over the locations
that need it without DownloadUrlParameters, there are two categories: Test files
(which don't count), and download system implementation (which sorta count and
sorta don't).  On the other hand, I have no problem imagining a wider range of
consumers needing the callback than need all the nitty-gritty of the
parameters.)

[benjhayden, 2012/05/02 15:11:54]

It seems strange to define a callback in an interface that doesn't use it. It
seems like that might encourage throwing other stuff that doesn't belong
anywhere in DownloadManager.

-
   virtual ~DownloadManager() {}
 
   static DownloadManager* Create(
       DownloadManagerDelegate* delegate,
       net::NetLog* net_log);
 
   // A method that can be used in tests to ensure that all the internal download
   // classes have no pending downloads.
   static bool EnsureNoPendingDownloadsForTesting();
 
@@ skipping 89 matching lines @@
 
   // Remove downloads will delete all downloads that have a timestamp that is
   // the same or more recent than |remove_begin|. The number of downloads
   // deleted is returned back to the caller.
   virtual int RemoveDownloads(base::Time remove_begin) = 0;
 
   // Remove all downloads will delete all downloads. The number of downloads
   // deleted is returned back to the caller.
   virtual int RemoveAllDownloads() = 0;
 
-  // Downloads the content at |url|. |referrer| and |referrer_encoding| are the
-  // referrer for the download, and may be empty. If |prefer_cache| is true,
-  // then if the response to |url| is in the HTTP cache it will be used without
-  // revalidation. If |post_id| is non-negative, then it identifies the post
-  // transaction used to originally retrieve the |url| resource - it also
-  // requires |prefer_cache| to be |true| since re-post'ing is not done.
-  // |save_info| specifies where the downloaded file should be
-  // saved, and whether the user should be prompted about the download.
-  // |web_contents| is the web page that the download is done in context of,
-  // and must be non-NULL.
-  // |callback| will be called when the download starts, or if an error
-  // occurs that prevents a download item from being created.
-  virtual void DownloadUrl(const GURL& url,
-                           const GURL& referrer,
-                           const std::string& referrer_encoding,
-                           bool prefer_cache,
-                           int64 post_id,
-                           const DownloadSaveInfo& save_info,
-                           WebContents* web_contents,
-                           const OnStartedCallback& callback) = 0;
+  // Takes ownership of |parameters|.

[Randy Smith (Not in Mondays), 2012/04/30 19:44:48]

nit, suggestion: "See DownloadUrlParameters for details about controlling the
download."?

[benjhayden, 2012/05/02 15:11:54]

Done.

+  virtual void DownloadUrl(DownloadUrlParameters* parameters) = 0;
 
   // Allow objects to observe the download creation process.
   virtual void AddObserver(Observer* observer) = 0;
 
   // Remove a download observer from ourself.
   virtual void RemoveObserver(Observer* observer) = 0;
 
   // Called by the embedder, after creating the download manager, to let it know
   // about downloads from previous runs of the browser.
   virtual void OnPersistentStoreQueryComplete(
@@ skipping 65 matching lines @@
  private:
   friend class base::RefCountedThreadSafe<
       DownloadManager, BrowserThread::DeleteOnUIThread>;
   friend struct BrowserThread::DeleteOnThread<BrowserThread::UI>;
   friend class base::DeleteHelper<DownloadManager>;
 };
 
 }  // namespace content
 
 #endif  // CONTENT_PUBLIC_BROWSER_DOWNLOAD_MANAGER_H_