content/browser/loader/resource_request_info_impl.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_BROWSER_LOADER_RESOURCE_REQUEST_INFO_IMPL_H_
   6 #define CONTENT_BROWSER_LOADER_RESOURCE_REQUEST_INFO_IMPL_H_
   7
   8 #include <string>
   9
  10 #include "base/basictypes.h"
  11 #include "base/gtest_prod_util.h"
  12 #include "base/memory/ref_counted.h"
  13 #include "base/memory/scoped_ptr.h"
  14 #include "base/memory/weak_ptr.h"
  15 #include "base/supports_user_data.h"
  16 #include "content/public/browser/resource_request_info.h"
  17 #include "content/public/common/referrer.h"
  18 #include "content/public/common/resource_type.h"
  19 #include "net/base/load_states.h"
  20
  21 namespace content {
  22 class CrossSiteResourceHandler;
  23 class DetachableResourceHandler;
  24 class ResourceContext;
  25 class ResourceMessageFilter;
  26 struct GlobalRequestID;
  27 struct GlobalRoutingID;
  28
  29 // Holds the data ResourceDispatcherHost associates with each request.
  30 // Retrieve this data by calling ResourceDispatcherHost::InfoForRequest.
  31 class ResourceRequestInfoImpl : public ResourceRequestInfo,
  32                                 public base::SupportsUserData::Data {
  33  public:
  34   // Returns the ResourceRequestInfoImpl associated with the given URLRequest.
  35   CONTENT_EXPORT static ResourceRequestInfoImpl* ForRequest(
  36       net::URLRequest* request);
  37
  38   // And, a const version for cases where you only need read access.
  39   CONTENT_EXPORT static const ResourceRequestInfoImpl* ForRequest(
  40       const net::URLRequest* request);
  41
  42   CONTENT_EXPORT ResourceRequestInfoImpl(
  43       int process_type,
  44       int child_id,
  45       int route_id,
  46       int origin_pid,
  47       int request_id,
  48       int render_frame_id,
  49       bool is_main_frame,
  50       bool parent_is_main_frame,
  51       int parent_render_frame_id,
  52       ResourceType resource_type,
  53       ui::PageTransition transition_type,
  54       bool should_replace_current_entry,
  55       bool is_download,
  56       bool is_stream,
  57       bool allow_download,
  58       bool has_user_gesture,
  59       bool enable_load_timing,
  60       bool enable_upload_progress,
  61       blink::WebReferrerPolicy referrer_policy,
  62       blink::WebPageVisibilityState visibility_state,
  63       ResourceContext* context,
  64       base::WeakPtr<ResourceMessageFilter> filter,
  65       bool is_async);
  66   ~ResourceRequestInfoImpl() override;
  67
  68   // ResourceRequestInfo implementation:
  69   ResourceContext* GetContext() const override;
  70   int GetChildID() const override;
  71   int GetRouteID() const override;
  72   int GetOriginPID() const override;
  73   int GetRequestID() const override;
  74   int GetRenderFrameID() const override;
  75   bool IsMainFrame() const override;
  76   bool ParentIsMainFrame() const override;
  77   int GetParentRenderFrameID() const override;
  78   ResourceType GetResourceType() const override;
  79   int GetProcessType() const override;
  80   blink::WebReferrerPolicy GetReferrerPolicy() const override;
  81   blink::WebPageVisibilityState GetVisibilityState() const override;
  82   ui::PageTransition GetPageTransition() const override;
  83   bool HasUserGesture() const override;
  84   bool WasIgnoredByHandler() const override;
  85   bool GetAssociatedRenderFrame(int* render_process_id,
  86                                 int* render_frame_id) const override;
  87   bool IsAsync() const override;
  88   bool IsDownload() const override;
  89
  90   CONTENT_EXPORT void AssociateWithRequest(net::URLRequest* request);
  91
  92   CONTENT_EXPORT GlobalRequestID GetGlobalRequestID() const;
  93   GlobalRoutingID GetGlobalRoutingID() const;
  94
  95   // May be NULL (e.g., if process dies during a transfer).
  96   ResourceMessageFilter* filter() const {
  97     return filter_.get();
  98   }
  99
 100   // Updates the data associated with this request after it is is transferred
 101   // to a new renderer process.  Not all data will change during a transfer.
 102   // We do not expect the ResourceContext to change during navigation, so that
 103   // does not need to be updated.
 104   void UpdateForTransfer(int child_id,
 105                          int route_id,
 106                          int origin_pid,
 107                          int request_id,
 108                          int parent_render_frame_id,
 109                          base::WeakPtr<ResourceMessageFilter> filter);
 110
 111   // CrossSiteResourceHandler for this request.  May be null.
 112   CrossSiteResourceHandler* cross_site_handler() {
 113     return cross_site_handler_;
 114   }
 115   void set_cross_site_handler(CrossSiteResourceHandler* h) {
 116     cross_site_handler_ = h;
 117   }
 118
 119   // Whether this request is part of a navigation that should replace the
 120   // current session history entry. This state is shuffled up and down the stack
 121   // for request transfers.
 122   bool should_replace_current_entry() const {
 123     return should_replace_current_entry_;
 124   }
 125
 126   // DetachableResourceHandler for this request.  May be NULL.
 127   DetachableResourceHandler* detachable_handler() const {
 128     return detachable_handler_;
 129   }
 130   void set_detachable_handler(DetachableResourceHandler* h) {
 131     detachable_handler_ = h;
 132   }
 133
 134   // Identifies the type of process (renderer, plugin, etc.) making the request.
 135   int process_type() const { return process_type_; }
 136
 137   // Downloads are allowed only as a top level request.
 138   bool allow_download() const { return allow_download_; }
 139
 140   // Whether this is a download.
 141   void set_is_download(bool download) { is_download_ = download; }
 142
 143   // Whether this is a stream.
 144   bool is_stream() const { return is_stream_; }
 145   void set_is_stream(bool stream) { is_stream_ = stream; }
 146
 147   void set_was_ignored_by_handler(bool value) {
 148     was_ignored_by_handler_ = value;
 149   }
 150
 151   // Whether this request has been counted towards the number of in flight
 152   // requests, which is only true for requests that require a file descriptor
 153   // for their shared memory buffer.
 154   bool counted_as_in_flight_request() const {
 155     return counted_as_in_flight_request_;
 156   }
 157   void set_counted_as_in_flight_request(bool was_counted) {
 158     counted_as_in_flight_request_ = was_counted;
 159   }
 160
 161   // The approximate in-memory size (bytes) that we credited this request
 162   // as consuming in |outstanding_requests_memory_cost_map_|.
 163   int memory_cost() const { return memory_cost_; }
 164   void set_memory_cost(int cost) { memory_cost_ = cost; }
 165
 166   bool is_load_timing_enabled() const { return enable_load_timing_; }
 167
 168   bool is_upload_progress_enabled() const { return enable_upload_progress_; }
 169
 170  private:
 171   FRIEND_TEST_ALL_PREFIXES(ResourceDispatcherHostTest,
 172                            DeletedFilterDetached);
 173   FRIEND_TEST_ALL_PREFIXES(ResourceDispatcherHostTest,
 174                            DeletedFilterDetachedRedirect);
 175   // Non-owning, may be NULL.
 176   CrossSiteResourceHandler* cross_site_handler_;
 177   DetachableResourceHandler* detachable_handler_;
 178
 179   int process_type_;
 180   int child_id_;
 181   int route_id_;
 182   int origin_pid_;
 183   int request_id_;
 184   int render_frame_id_;
 185   bool is_main_frame_;
 186   bool parent_is_main_frame_;
 187   int parent_render_frame_id_;
 188   bool should_replace_current_entry_;
 189   bool is_download_;
 190   bool is_stream_;
 191   bool allow_download_;
 192   bool has_user_gesture_;
 193   bool enable_load_timing_;
 194   bool enable_upload_progress_;
 195   bool was_ignored_by_handler_;
 196   bool counted_as_in_flight_request_;
 197   ResourceType resource_type_;
 198   ui::PageTransition transition_type_;
 199   int memory_cost_;
 200   blink::WebReferrerPolicy referrer_policy_;
 201   blink::WebPageVisibilityState visibility_state_;
 202   ResourceContext* context_;
 203   // The filter might be deleted without deleting this object if the process
 204   // exits during a transfer.
 205   base::WeakPtr<ResourceMessageFilter> filter_;
 206   bool is_async_;
 207
 208   DISALLOW_COPY_AND_ASSIGN(ResourceRequestInfoImpl);
 209 };
 210
 211 }  // namespace content
 212
 213 #endif  // CONTENT_BROWSER_LOADER_RESOURCE_REQUEST_INFO_IMPL_H_