1 // Copyright (c) 2012 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef CONTENT_PUBLIC_BROWSER_DOWNLOAD_URL_PARAMETERS_H_
6 #define CONTENT_PUBLIC_BROWSER_DOWNLOAD_URL_PARAMETERS_H_
11 #include "base/basictypes.h"
12 #include "base/callback.h"
13 #include "content/public/browser/download_save_info.h"
14 #include "content/public/common/referrer.h"
15 #include "net/base/net_errors.h"
21 class ResourceContext;
22 class ResourceDispatcherHost;
25 // Pass an instance of DownloadUrlParameters to DownloadManager::DownloadUrl()
26 // to download the content at |url|. All parameters with setters are optional.
27 // |referrer| and |referrer_encoding| are the referrer for the download. If
28 // |prefer_cache| is true, then if the response to |url| is in the HTTP cache it
29 // will be used without revalidation. If |post_id| is non-negative, then it
30 // identifies the post transaction used to originally retrieve the |url|
31 // resource - it also requires |prefer_cache| to be |true| since re-post'ing is
32 // not done. |save_info| specifies where the downloaded file should be saved,
33 // and whether the user should be prompted about the download. If not null,
34 // |callback| will be called when the download starts, or if an error occurs
35 // that prevents a download item from being created. We send a pointer to
36 // content::ResourceContext instead of the usual reference so that a copy of the
39 class CONTENT_EXPORT DownloadUrlParameters {
41 // If there is an error, then |item| will be NULL.
42 typedef base::Callback<void(DownloadItem*, net::Error)> OnStartedCallback;
44 typedef std::pair<std::string, std::string> RequestHeadersNameValuePair;
45 typedef std::vector<RequestHeadersNameValuePair> RequestHeadersType;
47 static DownloadUrlParameters* FromWebContents(
48 WebContents* web_contents,
51 DownloadUrlParameters(
53 int render_process_host_id,
54 int render_view_host_routing_id,
55 content::ResourceContext* resource_context);
57 ~DownloadUrlParameters();
59 void set_content_initiated(bool content_initiated) {
60 content_initiated_ = content_initiated;
62 void add_request_header(const std::string& name, const std::string& value) {
63 request_headers_.push_back(make_pair(name, value));
65 void set_referrer(const Referrer& referrer) { referrer_ = referrer; }
66 void set_referrer_encoding(const std::string& referrer_encoding) {
67 referrer_encoding_ = referrer_encoding;
69 void set_load_flags(int load_flags) { load_flags_ |= load_flags; }
70 void set_last_modified(const std::string& last_modified) {
71 last_modified_ = last_modified;
73 void set_etag(const std::string& etag) {
76 void set_method(const std::string& method) {
79 void set_post_body(const std::string& post_body) {
80 post_body_ = post_body;
82 void set_prefer_cache(bool prefer_cache) {
83 prefer_cache_ = prefer_cache;
85 void set_post_id(int64 post_id) { post_id_ = post_id; }
86 void set_callback(const OnStartedCallback& callback) {
89 void set_file_path(const base::FilePath& file_path) {
90 save_info_.file_path = file_path;
92 void set_suggested_name(const string16& suggested_name) {
93 save_info_.suggested_name = suggested_name;
95 void set_offset(int64 offset) { save_info_.offset = offset; }
96 void set_hash_state(std::string hash_state) {
97 save_info_.hash_state = hash_state;
99 void set_prompt(bool prompt) { save_info_.prompt_for_save_location = prompt; }
100 void set_file_stream(scoped_ptr<net::FileStream> file_stream) {
101 save_info_.file_stream = file_stream.Pass();
104 const OnStartedCallback& callback() const { return callback_; }
105 bool content_initiated() const { return content_initiated_; }
106 int load_flags() const { return load_flags_; }
107 const std::string& last_modified() { return last_modified_; }
108 const std::string& etag() { return etag_; }
109 const std::string& method() const { return method_; }
110 const std::string& post_body() const { return post_body_; }
111 int64 post_id() const { return post_id_; }
112 bool prefer_cache() const { return prefer_cache_; }
113 const Referrer& referrer() const { return referrer_; }
114 const std::string& referrer_encoding() const { return referrer_encoding_; }
115 int render_process_host_id() const { return render_process_host_id_; }
116 int render_view_host_routing_id() const {
117 return render_view_host_routing_id_;
119 RequestHeadersType::const_iterator request_headers_begin() const {
120 return request_headers_.begin();
122 RequestHeadersType::const_iterator request_headers_end() const {
123 return request_headers_.end();
125 content::ResourceContext* resource_context() const {
126 return resource_context_;
128 const base::FilePath& file_path() const { return save_info_.file_path; }
129 const string16& suggested_name() const { return save_info_.suggested_name; }
130 int64 offset() const { return save_info_.offset; }
131 const std::string& hash_state() const { return save_info_.hash_state; }
132 bool prompt() const { return save_info_.prompt_for_save_location; }
133 const GURL& url() const { return url_; }
135 // Note that this is state changing--the DownloadUrlParameters object
136 // will not have a file_stream attached to it after this call.
137 scoped_ptr<net::FileStream> GetFileStream() {
138 return save_info_.file_stream.Pass();
142 OnStartedCallback callback_;
143 bool content_initiated_;
144 RequestHeadersType request_headers_;
146 std::string last_modified_;
149 std::string post_body_;
153 std::string referrer_encoding_;
154 int render_process_host_id_;
155 int render_view_host_routing_id_;
156 ResourceContext* resource_context_;
157 DownloadSaveInfo save_info_;
160 DISALLOW_COPY_AND_ASSIGN(DownloadUrlParameters);
163 } // namespace content
165 #endif // CONTENT_PUBLIC_BROWSER_DOWNLOAD_URL_PARAMETERS_H_