15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright (c) 2012 The Chromium Authors. All rights reserved. 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Use of this source code is governed by a BSD-style license that can be 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// found in the LICENSE file. 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#ifndef NET_PROXY_PROXY_SCRIPT_FETCHER_IMPL_H_ 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#define NET_PROXY_PROXY_SCRIPT_FETCHER_IMPL_H_ 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <string> 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/basictypes.h" 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/compiler_specific.h" 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/ref_counted.h" 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/scoped_ptr.h" 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "base/memory/weak_ptr.h" 155e3f23d412006dc4db4e659864679f29341e113fTorne (Richard Coles)#include "base/strings/string16.h" 16eb525c5499e34cc9c4b825d6d9e75bb07cc06aceBen Murdoch#include "base/time/time.h" 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/proxy/proxy_script_fetcher.h" 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include "net/url_request/url_request.h" 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class GURL; 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace net { 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class URLRequestContext; 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Implementation of ProxyScriptFetcher that downloads scripts using the 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// specified request context. 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class NET_EXPORT ProxyScriptFetcherImpl : public ProxyScriptFetcher, 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public URLRequest::Delegate { 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Creates a ProxyScriptFetcher that issues requests through 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |url_request_context|. |url_request_context| must remain valid for the 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // lifetime of ProxyScriptFetcherImpl. 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Note that while a request is in progress, we will be holding a reference 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to |url_request_context|. Be careful not to create cycles between the 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // fetcher and the context; you can break such cycles by calling Cancel(). 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) explicit ProxyScriptFetcherImpl(URLRequestContext* url_request_context); 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual ~ProxyScriptFetcherImpl(); 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Used by unit-tests to modify the default limits. 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::TimeDelta SetTimeoutConstraint(base::TimeDelta timeout); 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t SetSizeConstraint(size_t size_bytes); 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnResponseCompleted(URLRequest* request); 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // ProxyScriptFetcher methods: 48c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) virtual int Fetch(const GURL& url, base::string16* text, 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const net::CompletionCallback& callback) OVERRIDE; 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void Cancel() OVERRIDE; 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual URLRequestContext* GetRequestContext() const OVERRIDE; 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // URLRequest::Delegate methods: 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnAuthRequired(URLRequest* request, 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) AuthChallengeInfo* auth_info) OVERRIDE; 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnSSLCertificateError(URLRequest* request, 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const SSLInfo& ssl_info, 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool is_hsts_ok) OVERRIDE; 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnResponseStarted(URLRequest* request) OVERRIDE; 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual void OnReadCompleted(URLRequest* request, int num_bytes) OVERRIDE; 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) private: 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) enum { kBufSize = 4096 }; 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Read more bytes from the response. 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ReadBody(URLRequest* request); 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Handles a response from Read(). Returns true if we should continue trying 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // to read. |num_bytes| is 0 for EOF, and < 0 on errors. 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) bool ConsumeBytesRead(URLRequest* request, int num_bytes); 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Called once the request has completed to notify the caller of 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // |response_code_| and |response_text_|. 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void FetchCompleted(); 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Clear out the state for the current request. 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void ResetCurRequestState(); 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Callback for time-out task of request with id |id|. 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void OnTimeout(int id); 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The context used for making network requests. 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) URLRequestContext* const url_request_context_; 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Buffer that URLRequest writes into. 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_refptr<IOBuffer> buf_; 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The next ID to use for |cur_request_| (monotonically increasing). 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int next_id_; 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The current (in progress) request, or NULL. 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<URLRequest> cur_request_; 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // State for current request (only valid when |cur_request_| is not NULL): 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Unique ID for the current request. 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int cur_request_id_; 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Callback to invoke on completion of the fetch. 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) net::CompletionCallback callback_; 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Holds the error condition that was hit on the current request, or OK. 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) int result_code_; 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // Holds the bytes read so far. Will not exceed |max_response_bytes|. 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) std::string bytes_read_so_far_; 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // This buffer is owned by the owner of |callback|, and will be filled with 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // UTF16 response on completion. 110c2e0dbddbe15c98d52c4786dac06cb8952a8ae6dTorne (Richard Coles) base::string16* result_text_; 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The maximum number of bytes to allow in responses. 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) size_t max_response_bytes_; 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) // The maximum amount of time to wait for download to complete. 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) base::TimeDelta max_duration_; 1175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1181320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci // Factory for creating the time-out task. This takes care of revoking 1191320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci // outstanding tasks when |this| is deleted. 1201320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci base::WeakPtrFactory<ProxyScriptFetcherImpl> weak_factory_; 1211320f92c476a1ad9d19dba2a48c72b75566198e9Primiano Tucci 1225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) DISALLOW_COPY_AND_ASSIGN(ProxyScriptFetcherImpl); 1235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 1245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace net 1265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#endif // NET_PROXY_PROXY_SCRIPT_FETCHER_IMPL_H_ 128