content/public/browser/download_url_parameters.h

   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.
   4
   5 #ifndef CONTENT_PUBLIC_BROWSER_DOWNLOAD_URL_PARAMETERS_H_
   6 #define CONTENT_PUBLIC_BROWSER_DOWNLOAD_URL_PARAMETERS_H_
   7
   8 #include <string>
   9 #include <vector>
  10
  11 #include "base/basictypes.h"
  12 #include "base/callback.h"
  13 #include "content/public/browser/download_interrupt_reasons.h"
  14 #include "content/public/browser/download_save_info.h"
  15 #include "content/public/common/referrer.h"
  16 #include "url/gurl.h"
  17
  18 namespace content {
  19
  20 class DownloadItem;
  21 class ResourceContext;
  22 class ResourceDispatcherHost;
  23 class WebContents;
  24
  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
  37 // object isn't made.
  38
  39 class CONTENT_EXPORT DownloadUrlParameters {
  40  public:
  41   // If there is an error, then |item| will be nullptr.
  42   typedef base::Callback<void(DownloadItem*, DownloadInterruptReason)>
  43       OnStartedCallback;
  44
  45   typedef std::pair<std::string, std::string> RequestHeadersNameValuePair;
  46   typedef std::vector<RequestHeadersNameValuePair> RequestHeadersType;
  47
  48   static DownloadUrlParameters* FromWebContents(
  49       WebContents* web_contents,
  50       const GURL& url);
  51
  52   DownloadUrlParameters(
  53       const GURL& url,
  54       int render_process_host_id,
  55       int render_view_host_routing_id,
  56       content::ResourceContext* resource_context);
  57
  58   ~DownloadUrlParameters();
  59
  60   void set_content_initiated(bool content_initiated) {
  61     content_initiated_ = content_initiated;
  62   }
  63   void add_request_header(const std::string& name, const std::string& value) {
  64     request_headers_.push_back(make_pair(name, value));
  65   }
  66   void set_referrer(const Referrer& referrer) { referrer_ = referrer; }
  67   void set_referrer_encoding(const std::string& referrer_encoding) {
  68     referrer_encoding_ = referrer_encoding;
  69   }
  70   void set_last_modified(const std::string& last_modified) {
  71     last_modified_ = last_modified;
  72   }
  73   void set_etag(const std::string& etag) {
  74     etag_ = etag;
  75   }
  76   void set_method(const std::string& method) {
  77     method_ = method;
  78   }
  79   void set_post_body(const std::string& post_body) {
  80     post_body_ = post_body;
  81   }
  82   void set_prefer_cache(bool prefer_cache) {
  83     prefer_cache_ = prefer_cache;
  84   }
  85   void set_post_id(int64 post_id) { post_id_ = post_id; }
  86   void set_callback(const OnStartedCallback& callback) {
  87     callback_ = callback;
  88   }
  89   void set_file_path(const base::FilePath& file_path) {
  90     save_info_.file_path = file_path;
  91   }
  92   void set_suggested_name(const base::string16& suggested_name) {
  93     save_info_.suggested_name = suggested_name;
  94   }
  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;
  98   }
  99   void set_prompt(bool prompt) { save_info_.prompt_for_save_location = prompt; }
 100   void set_file(base::File file) {
 101     save_info_.file = file.Pass();
 102   }
 103   void set_do_not_prompt_for_login(bool do_not_prompt) {
 104     do_not_prompt_for_login_ = do_not_prompt;
 105   }
 106
 107   const OnStartedCallback& callback() const { return callback_; }
 108   bool content_initiated() const { return content_initiated_; }
 109   const std::string& last_modified() const { return last_modified_; }
 110   const std::string& etag() const { return etag_; }
 111   const std::string& method() const { return method_; }
 112   const std::string& post_body() const { return post_body_; }
 113   int64 post_id() const { return post_id_; }
 114   bool prefer_cache() const { return prefer_cache_; }
 115   const Referrer& referrer() const { return referrer_; }
 116   const std::string& referrer_encoding() const { return referrer_encoding_; }
 117   int render_process_host_id() const { return render_process_host_id_; }
 118   int render_view_host_routing_id() const {
 119     return render_view_host_routing_id_;
 120   }
 121   RequestHeadersType::const_iterator request_headers_begin() const {
 122     return request_headers_.begin();
 123   }
 124   RequestHeadersType::const_iterator request_headers_end() const {
 125     return request_headers_.end();
 126   }
 127   content::ResourceContext* resource_context() const {
 128     return resource_context_;
 129   }
 130   const base::FilePath& file_path() const { return save_info_.file_path; }
 131   const base::string16& suggested_name() const {
 132     return save_info_.suggested_name;
 133   }
 134   int64 offset() const { return save_info_.offset; }
 135   const std::string& hash_state() const { return save_info_.hash_state; }
 136   bool prompt() const { return save_info_.prompt_for_save_location; }
 137   const GURL& url() const { return url_; }
 138   bool do_not_prompt_for_login() const { return do_not_prompt_for_login_; }
 139
 140   // Note that this is state changing--the DownloadUrlParameters object
 141   // will not have a file attached to it after this call.
 142   base::File GetFile() { return save_info_.file.Pass(); }
 143
 144  private:
 145   OnStartedCallback callback_;
 146   bool content_initiated_;
 147   RequestHeadersType request_headers_;
 148   std::string last_modified_;
 149   std::string etag_;
 150   std::string method_;
 151   std::string post_body_;
 152   int64 post_id_;
 153   bool prefer_cache_;
 154   Referrer referrer_;
 155   std::string referrer_encoding_;
 156   int render_process_host_id_;
 157   int render_view_host_routing_id_;
 158   ResourceContext* resource_context_;
 159   DownloadSaveInfo save_info_;
 160   GURL url_;
 161   bool do_not_prompt_for_login_;
 162
 163   DISALLOW_COPY_AND_ASSIGN(DownloadUrlParameters);
 164 };
 165
 166 }  // namespace content
 167
 168 #endif  // CONTENT_PUBLIC_BROWSER_DOWNLOAD_URL_PARAMETERS_H_