// Copyright (c) 2008 The Chromium Embedded Framework Authors. // Portions copyright (c) 2006-2008 The Chromium Authors. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. // // This file contains an implementation of the ResourceLoaderBridge class. // The class is implemented using URLRequest, meaning it is a "simple" version // that directly issues requests. The more complicated one used in the // browser uses IPC. // // Because URLRequest only provides an asynchronous resource loading API, this // file makes use of URLRequest from a background IO thread. Requests for // cookies and synchronously loaded resources result in the main thread of the // application blocking until the IO thread completes the operation. (See // GetCookies and SyncLoad) // // Main thread IO thread // ----------- --------- // ResourceLoaderBridge <---o---------> RequestProxy (normal case) // \ -> URLRequest // o-------> SyncRequestProxy (synchronous case) // -> URLRequest // SetCookie <------------------------> CookieSetter // -> net_util::SetCookie // GetCookies <-----------------------> CookieGetter // -> net_util::GetCookies // // NOTE: The implementation in this file may be used to have WebKit fetch // resources in-process. For example, it is handy for building a single- // process WebKit embedding (e.g., test_shell) that can use URLRequest to // perform URL loads. See renderer/resource_dispatcher.h for details on an // alternate implementation that defers fetching to another process. #include "precompiled_libcef.h" #include "browser_resource_loader_bridge.h" #include "browser_request_context.h" #include "browser_impl.h" #include "request_impl.h" #include "base/message_loop.h" #include "base/ref_counted.h" #include "base/string_util.h" #include "base/thread.h" #include "base/waitable_event.h" #include "net/base/cookie_monster.h" #include "net/base/net_util.h" #include "net/base/upload_data.h" #include "net/url_request/url_request.h" #include "webkit/glue/resource_loader_bridge.h" #include "webkit/glue/webframe.h" #include "webkit/glue/webview.h" using webkit_glue::ResourceLoaderBridge; using net::HttpResponseHeaders; namespace { //----------------------------------------------------------------------------- URLRequestContext* request_context = NULL; base::Thread* io_thread = NULL; class IOThread : public base::Thread { public: IOThread() : base::Thread("IOThread") { } ~IOThread() { // We cannot rely on our base class to stop the thread since we want our // CleanUp function to run. Stop(); } virtual void CleanUp() { if (request_context) { request_context->Release(); request_context = NULL; } } }; bool EnsureIOThread() { if (io_thread) return true; if (!request_context) BrowserResourceLoaderBridge::Init(NULL); io_thread = new IOThread(); base::Thread::Options options; options.message_loop_type = MessageLoop::TYPE_IO; return io_thread->StartWithOptions(options); } //----------------------------------------------------------------------------- struct RequestParams { std::string method; GURL url; GURL policy_url; GURL referrer; std::string headers; int load_flags; scoped_refptr upload; }; // The RequestProxy does most of its work on the IO thread. The Start and // Cancel methods are proxied over to the IO thread, where an URLRequest object // is instantiated. class RequestProxy : public URLRequest::Delegate, public base::RefCountedThreadSafe { public: // Takes ownership of the params. RequestProxy(CefRefPtr browser) : browser_(browser) { } virtual ~RequestProxy() { // If we have a request, then we'd better be on the io thread! DCHECK(!request_.get() || MessageLoop::current() == io_thread->message_loop()); } void DropPeer() { peer_ = NULL; } void Start(ResourceLoaderBridge::Peer* peer, RequestParams* params) { peer_ = peer; owner_loop_ = MessageLoop::current(); // proxy over to the io thread io_thread->message_loop()->PostTask(FROM_HERE, NewRunnableMethod( this, &RequestProxy::AsyncStart, params)); } void Cancel() { // proxy over to the io thread io_thread->message_loop()->PostTask(FROM_HERE, NewRunnableMethod( this, &RequestProxy::AsyncCancel)); } protected: // -------------------------------------------------------------------------- // The following methods are called on the owner's thread in response to // various URLRequest callbacks. The event hooks, defined below, trigger // these methods asynchronously. void NotifyReceivedRedirect(const GURL& new_url) { if (peer_) peer_->OnReceivedRedirect(new_url); } void NotifyReceivedResponse(const ResourceLoaderBridge::ResponseInfo& info, bool content_filtered) { if (peer_) peer_->OnReceivedResponse(info, content_filtered); } void NotifyReceivedData(int bytes_read) { if (!peer_) return; // Make a local copy of buf_, since AsyncReadData reuses it. scoped_array buf_copy(new char[bytes_read]); memcpy(buf_copy.get(), buf_, bytes_read); // Continue reading more data into buf_ // Note: Doing this before notifying our peer ensures our load events get // dispatched in a manner consistent with DumpRenderTree (and also avoids a // race condition). If the order of the next 2 functions were reversed, the // peer could generate new requests in reponse to the received data, which // when run on the io thread, could race against this function in doing // another InvokeLater. See bug 769249. io_thread->message_loop()->PostTask(FROM_HERE, NewRunnableMethod( this, &RequestProxy::AsyncReadData)); peer_->OnReceivedData(buf_copy.get(), bytes_read); } void NotifyCompletedRequest(const URLRequestStatus& status) { if (peer_) { peer_->OnCompletedRequest(status); DropPeer(); // ensure no further notifications } } // -------------------------------------------------------------------------- // The following methods are called on the io thread. They correspond to // actions performed on the owner's thread. void AsyncStart(RequestParams* params) { bool handled = false; CefRefPtr handler = browser_->GetHandler(); if(handler.get()) { // Build the request object for passing to the handler CefRefPtr request(new CefRequestImpl()); CefRequestImpl* requestimpl = static_cast(request.get()); requestimpl->SetURL(UTF8ToWide(params->url.spec())); requestimpl->SetMethod(UTF8ToWide(params->method)); // TODO(cef): Parse the extra header values from params->headers and // add to the header map. CefRequest::HeaderMap headerMap; headerMap.insert( std::make_pair(L"Referrer", UTF8ToWide(params->referrer.spec()))); requestimpl->SetHeaderMap(headerMap); scoped_refptr upload = params->upload; CefRefPtr postdata; if(upload.get()) { postdata = new CefPostDataImpl(); static_cast(postdata.get())->Set(*upload.get()); requestimpl->SetPostData(postdata); } int loadFlags = params->load_flags; // Handler output will be returned in these variables std::wstring redirectUrl; CefRefPtr resourceStream; std::wstring mimeType; CefHandler::RetVal rv = handler->HandleBeforeResourceLoad( browser_, request, redirectUrl, resourceStream, mimeType, loadFlags); if(rv == CefHandler::RV_HANDLED) { // cancel the resource load handled = true; OnCompletedRequest(URLRequestStatus(URLRequestStatus::CANCELED, 0)); } else if(!redirectUrl.empty()) { // redirect to the specified URL params->url = GURL(WideToUTF8(redirectUrl)); OnReceivedRedirect(params->url); } else if(resourceStream.get()) { // load from the provided resource stream handled = true; long offset = resourceStream->Seek(0, SEEK_END); resourceStream->Seek(0, SEEK_SET); resource_stream_ = resourceStream; ResourceLoaderBridge::ResponseInfo info; info.content_length = static_cast(offset); if(!mimeType.empty()) info.mime_type = WideToUTF8(mimeType); OnReceivedResponse(info, false); AsyncReadData(); } } if(!handled) { request_.reset(new URLRequest(params->url, this)); request_->set_method(params->method); request_->set_policy_url(params->policy_url); request_->set_referrer(params->referrer.spec()); request_->SetExtraRequestHeaders(params->headers); request_->set_load_flags(params->load_flags); request_->set_upload(params->upload.get()); request_->set_context(request_context); request_->Start(); } delete params; } void AsyncCancel() { // This can be null in cases where the request is already done. if (!resource_stream_.get() && !request_.get()) return; request_->Cancel(); Done(); } void AsyncReadData() { if(resource_stream_.get()) { // Read from the handler-provided resource stream int bytes_read = resource_stream_->Read(buf_, 1, sizeof(buf_)); if(bytes_read > 0) { OnReceivedData(bytes_read); } else { Done(); } return; } // This can be null in cases where the request is already done. if (!request_.get()) return; if (request_->status().is_success()) { int bytes_read; if (request_->Read(buf_, sizeof(buf_), &bytes_read) && bytes_read) { OnReceivedData(bytes_read); } else if (!request_->status().is_io_pending()) { Done(); } // else wait for OnReadCompleted } else { Done(); } } // -------------------------------------------------------------------------- // The following methods are event hooks (corresponding to URLRequest // callbacks) that run on the IO thread. They are designed to be overridden // by the SyncRequestProxy subclass. virtual void OnReceivedRedirect(const GURL& new_url) { owner_loop_->PostTask(FROM_HERE, NewRunnableMethod( this, &RequestProxy::NotifyReceivedRedirect, new_url)); } virtual void OnReceivedResponse( const ResourceLoaderBridge::ResponseInfo& info, bool content_filtered) { owner_loop_->PostTask(FROM_HERE, NewRunnableMethod( this, &RequestProxy::NotifyReceivedResponse, info, content_filtered)); } virtual void OnReceivedData(int bytes_read) { owner_loop_->PostTask(FROM_HERE, NewRunnableMethod( this, &RequestProxy::NotifyReceivedData, bytes_read)); } virtual void OnCompletedRequest(const URLRequestStatus& status) { owner_loop_->PostTask(FROM_HERE, NewRunnableMethod( this, &RequestProxy::NotifyCompletedRequest, status)); } // -------------------------------------------------------------------------- // URLRequest::Delegate implementation: virtual void OnReceivedRedirect(URLRequest* request, const GURL& new_url) { DCHECK(request->status().is_success()); OnReceivedRedirect(new_url); } virtual void OnResponseStarted(URLRequest* request) { if (request->status().is_success()) { ResourceLoaderBridge::ResponseInfo info; info.request_time = request->request_time(); info.response_time = request->response_time(); info.headers = request->response_headers(); request->GetMimeType(&info.mime_type); request->GetCharset(&info.charset); OnReceivedResponse(info, false); AsyncReadData(); // start reading } else { Done(); } } virtual void OnReadCompleted(URLRequest* request, int bytes_read) { if (request->status().is_success() && bytes_read > 0) { OnReceivedData(bytes_read); } else { Done(); } } // -------------------------------------------------------------------------- // Helpers and data: void Done() { if(resource_stream_.get()) { // Resource stream reads always complete successfully OnCompletedRequest(URLRequestStatus(URLRequestStatus::SUCCESS, 0)); resource_stream_ = NULL; } else { DCHECK(request_.get()); OnCompletedRequest(request_->status()); request_.reset(); // destroy on the io thread } } scoped_ptr request_; CefRefPtr resource_stream_; // Size of our async IO data buffers static const int kDataSize = 16*1024; // read buffer for async IO char buf_[kDataSize]; CefRefPtr browser_; MessageLoop* owner_loop_; // This is our peer in WebKit (implemented as ResourceHandleInternal). We do // not manage its lifetime, and we may only access it from the owner's // message loop (owner_loop_). ResourceLoaderBridge::Peer* peer_; }; //----------------------------------------------------------------------------- class SyncRequestProxy : public RequestProxy { public: explicit SyncRequestProxy(CefRefPtr browser, ResourceLoaderBridge::SyncLoadResponse* result) : RequestProxy(browser), result_(result), event_(true, false) { } void WaitForCompletion() { if (!event_.Wait()) NOTREACHED(); } // -------------------------------------------------------------------------- // Event hooks that run on the IO thread: virtual void OnReceivedRedirect(const GURL& new_url) { result_->url = new_url; } virtual void OnReceivedResponse( const ResourceLoaderBridge::ResponseInfo& info, bool content_filtered) { *static_cast(result_) = info; } virtual void OnReceivedData(int bytes_read) { result_->data.append(buf_, bytes_read); AsyncReadData(); // read more (may recurse) } virtual void OnCompletedRequest(const URLRequestStatus& status) { result_->status = status; event_.Signal(); } private: ResourceLoaderBridge::SyncLoadResponse* result_; base::WaitableEvent event_; }; //----------------------------------------------------------------------------- class ResourceLoaderBridgeImpl : public ResourceLoaderBridge { public: ResourceLoaderBridgeImpl(CefRefPtr browser, const std::string& method, const GURL& url, const GURL& policy_url, const GURL& referrer, const std::string& headers, int load_flags) : browser_(browser), params_(new RequestParams), proxy_(NULL) { params_->method = method; params_->url = url; params_->policy_url = policy_url; params_->referrer = referrer; params_->headers = headers; params_->load_flags = load_flags; } virtual ~ResourceLoaderBridgeImpl() { if (proxy_) { proxy_->DropPeer(); // Let the proxy die on the IO thread io_thread->message_loop()->ReleaseSoon(FROM_HERE, proxy_); } } // -------------------------------------------------------------------------- // ResourceLoaderBridge implementation: virtual void AppendDataToUpload(const char* data, int data_len) { DCHECK(params_.get()); if (!params_->upload) params_->upload = new net::UploadData(); params_->upload->AppendBytes(data, data_len); } virtual void AppendFileRangeToUpload(const std::wstring& file_path, uint64 offset, uint64 length) { DCHECK(params_.get()); if (!params_->upload) params_->upload = new net::UploadData(); params_->upload->AppendFileRange(file_path, offset, length); } virtual bool Start(Peer* peer) { DCHECK(!proxy_); if (!EnsureIOThread()) return false; proxy_ = new RequestProxy(browser_); proxy_->AddRef(); proxy_->Start(peer, params_.release()); return true; // Any errors will be reported asynchronously. } virtual void Cancel() { DCHECK(proxy_); proxy_->Cancel(); } virtual void SetDefersLoading(bool value) { // TODO(darin): implement me } virtual void SyncLoad(SyncLoadResponse* response) { DCHECK(!proxy_); if (!EnsureIOThread()) return; // this may change as the result of a redirect response->url = params_->url; proxy_ = new SyncRequestProxy(browser_, response); proxy_->AddRef(); proxy_->Start(NULL, params_.release()); static_cast(proxy_)->WaitForCompletion(); } private: CefRefPtr browser_; // Ownership of params_ is transfered to the proxy when the proxy is created. scoped_ptr params_; // The request proxy is allocated when we start the request, and then it // sticks around until this ResourceLoaderBridge is destroyed. RequestProxy* proxy_; }; //----------------------------------------------------------------------------- class CookieSetter : public base::RefCountedThreadSafe { public: void Set(const GURL& url, const std::string& cookie) { DCHECK(MessageLoop::current() == io_thread->message_loop()); request_context->cookie_store()->SetCookie(url, cookie); } }; class CookieGetter : public base::RefCountedThreadSafe { public: CookieGetter() : event_(false, false) { } void Get(const GURL& url) { result_ = request_context->cookie_store()->GetCookies(url); event_.Signal(); } std::string GetResult() { if (!event_.Wait()) NOTREACHED(); return result_; } private: base::WaitableEvent event_; std::string result_; }; } // anonymous namespace //----------------------------------------------------------------------------- namespace webkit_glue { // factory function ResourceLoaderBridge* ResourceLoaderBridge::Create( WebFrame* webframe, const std::string& method, const GURL& url, const GURL& policy_url, const GURL& referrer, const std::string& headers, int load_flags, int origin_pid, ResourceType::Type request_type, bool mixed_contents) { return new ResourceLoaderBridgeImpl( (webframe->GetView()->GetDelegate() ? static_cast( webframe->GetView()->GetDelegate())->GetBrowser() : NULL), method, url, policy_url, referrer, headers, load_flags); } void SetCookie(const GURL& url, const GURL& policy_url, const std::string& cookie) { // Proxy to IO thread to synchronize w/ network loading. if (!EnsureIOThread()) { NOTREACHED(); return; } scoped_refptr cookie_setter = new CookieSetter(); io_thread->message_loop()->PostTask(FROM_HERE, NewRunnableMethod( cookie_setter.get(), &CookieSetter::Set, url, cookie)); } std::string GetCookies(const GURL& url, const GURL& policy_url) { // Proxy to IO thread to synchronize w/ network loading if (!EnsureIOThread()) { NOTREACHED(); return std::string(); } scoped_refptr getter = new CookieGetter(); io_thread->message_loop()->PostTask(FROM_HERE, NewRunnableMethod( getter.get(), &CookieGetter::Get, url)); return getter->GetResult(); } } // namespace webkit_glue //----------------------------------------------------------------------------- // static void BrowserResourceLoaderBridge::Init(URLRequestContext* context) { // Make sure to stop any existing IO thread since it may be using the // current request context. Shutdown(); if (context) { request_context = context; } else { request_context = new BrowserRequestContext(); } request_context->AddRef(); } // static void BrowserResourceLoaderBridge::Shutdown() { if (io_thread) { delete io_thread; io_thread = NULL; DCHECK(!request_context) << "should have been nulled by thread dtor"; } }