content/browser/loader/resource_loader.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_LOADER_H_
   6 #define CONTENT_BROWSER_LOADER_RESOURCE_LOADER_H_
   7
   8 #include "base/gtest_prod_util.h"
   9 #include "base/memory/scoped_ptr.h"
  10 #include "base/memory/weak_ptr.h"
  11 #include "content/browser/loader/resource_handler.h"
  12 #include "content/browser/ssl/ssl_error_handler.h"
  13 #include "content/common/content_export.h"
  14 #include "content/public/browser/resource_controller.h"
  15 #include "content/public/common/signed_certificate_timestamp_id_and_status.h"
  16 #include "net/url_request/url_request.h"
  17
  18 namespace net {
  19 class X509Certificate;
  20 }
  21
  22 namespace content {
  23 class ResourceDispatcherHostLoginDelegate;
  24 class ResourceLoaderDelegate;
  25 class ResourceRequestInfoImpl;
  26 class SSLClientAuthHandler;
  27
  28 // This class is responsible for driving the URLRequest (i.e., calling Start,
  29 // Read, and servicing events).  It has a ResourceHandler, which is typically a
  30 // chain of ResourceHandlers, and is the ResourceController for its handler.
  31 class CONTENT_EXPORT ResourceLoader : public net::URLRequest::Delegate,
  32                                       public SSLErrorHandler::Delegate,
  33                                       public ResourceController {
  34  public:
  35   ResourceLoader(scoped_ptr<net::URLRequest> request,
  36                  scoped_ptr<ResourceHandler> handler,
  37                  ResourceLoaderDelegate* delegate);
  38   ~ResourceLoader() override;
  39
  40   void StartRequest();
  41   void CancelRequest(bool from_renderer);
  42
  43   void ReportUploadProgress();
  44
  45   bool is_transferring() const { return is_transferring_; }
  46   void MarkAsTransferring();
  47   void CompleteTransfer();
  48
  49   net::URLRequest* request() { return request_.get(); }
  50   ResourceRequestInfoImpl* GetRequestInfo();
  51
  52   void ClearLoginDelegate();
  53
  54   // IPC message handlers:
  55   void OnUploadProgressACK();
  56
  57  private:
  58   FRIEND_TEST_ALL_PREFIXES(ResourceLoaderTest, ClientCertStoreLookup);
  59   FRIEND_TEST_ALL_PREFIXES(ResourceLoaderTest, ClientCertStoreNull);
  60
  61   // net::URLRequest::Delegate implementation:
  62   void OnReceivedRedirect(net::URLRequest* request,
  63                           const net::RedirectInfo& redirect_info,
  64                           bool* defer) override;
  65   void OnAuthRequired(net::URLRequest* request,
  66                       net::AuthChallengeInfo* info) override;
  67   void OnCertificateRequested(net::URLRequest* request,
  68                               net::SSLCertRequestInfo* info) override;
  69   void OnSSLCertificateError(net::URLRequest* request,
  70                              const net::SSLInfo& info,
  71                              bool fatal) override;
  72   void OnBeforeNetworkStart(net::URLRequest* request, bool* defer) override;
  73   void OnResponseStarted(net::URLRequest* request) override;
  74   void OnReadCompleted(net::URLRequest* request, int bytes_read) override;
  75
  76   // SSLErrorHandler::Delegate implementation:
  77   void CancelSSLRequest(int error, const net::SSLInfo* ssl_info) override;
  78   void ContinueSSLRequest() override;
  79
  80   // ResourceController implementation:
  81   void Resume() override;
  82   void Cancel() override;
  83   void CancelAndIgnore() override;
  84   void CancelWithError(int error_code) override;
  85
  86   void StartRequestInternal();
  87   void CancelRequestInternal(int error, bool from_renderer);
  88   // Stores the SignedCertificateTimestamps held in |sct_list| in the
  89   // SignedCertificateTimestampStore singleton, associated with |process_id|.
  90   // On return, |sct_ids| contains the assigned ID and verification status of
  91   // each SignedCertificateTimestamp.
  92   void StoreSignedCertificateTimestamps(
  93       const net::SignedCertificateTimestampAndStatusList& sct_list,
  94       int process_id,
  95       SignedCertificateTimestampIDStatusList* sct_ids);
  96   void CompleteResponseStarted();
  97   void StartReading(bool is_continuation);
  98   void ResumeReading();
  99   void ReadMore(int* bytes_read);
 100   // Passes a read result to the handler.
 101   void CompleteRead(int bytes_read);
 102   void ResponseCompleted();
 103   void CallDidFinishLoading();
 104   void RecordHistograms();
 105   void ContinueWithCertificate(net::X509Certificate* cert);
 106
 107   bool is_deferred() const { return deferred_stage_ != DEFERRED_NONE; }
 108
 109   // Used for categorizing loading of prefetches for reporting in histograms.
 110   // NOTE: This enumeration is used in histograms, so please do not add entries
 111   // in the middle.
 112   enum PrefetchStatus {
 113     STATUS_UNDEFINED,
 114     STATUS_SUCCESS_FROM_CACHE,
 115     STATUS_SUCCESS_FROM_NETWORK,
 116     STATUS_CANCELED,
 117     STATUS_MAX,
 118   };
 119
 120   enum DeferredStage {
 121     DEFERRED_NONE,
 122     DEFERRED_START,
 123     DEFERRED_NETWORK_START,
 124     DEFERRED_REDIRECT,
 125     DEFERRED_READ,
 126     DEFERRED_RESPONSE_COMPLETE,
 127     DEFERRED_FINISH
 128   };
 129   DeferredStage deferred_stage_;
 130
 131   scoped_ptr<net::URLRequest> request_;
 132   scoped_ptr<ResourceHandler> handler_;
 133   ResourceLoaderDelegate* delegate_;
 134
 135   scoped_refptr<ResourceDispatcherHostLoginDelegate> login_delegate_;
 136   scoped_ptr<SSLClientAuthHandler> ssl_client_auth_handler_;
 137
 138   uint64 last_upload_position_;
 139   bool waiting_for_upload_progress_ack_;
 140   base::TimeTicks last_upload_ticks_;
 141   base::TimeTicks read_deferral_start_time_;
 142
 143   // Indicates that we are in a state of being transferred to a new downstream
 144   // consumer.  We are waiting for a notification to complete the transfer, at
 145   // which point we'll receive a new ResourceHandler.
 146   bool is_transferring_;
 147
 148   base::WeakPtrFactory<ResourceLoader> weak_ptr_factory_;
 149
 150   DISALLOW_COPY_AND_ASSIGN(ResourceLoader);
 151 };
 152
 153 }  // namespace content
 154
 155 #endif  // CONTENT_BROWSER_LOADER_RESOURCE_LOADER_H_