// Copyright (c) 2015 GitHub, Inc. // Use of this source code is governed by the MIT license that can be // found in the LICENSE file. #include "atom/browser/net/atom_network_delegate.h" #include #include "atom/browser/api/atom_api_web_contents.h" #include "atom/common/native_mate_converters/net_converter.h" #include "base/stl_util.h" #include "base/strings/string_util.h" #include "brightray/browser/net/devtools_network_transaction.h" #include "content/public/browser/browser_thread.h" #include "content/public/browser/render_frame_host.h" #include "net/url_request/url_request.h" using brightray::DevToolsNetworkTransaction; using content::BrowserThread; namespace atom { const char* ResourceTypeToString(content::ResourceType type) { switch (type) { case content::RESOURCE_TYPE_MAIN_FRAME: return "mainFrame"; case content::RESOURCE_TYPE_SUB_FRAME: return "subFrame"; case content::RESOURCE_TYPE_STYLESHEET: return "stylesheet"; case content::RESOURCE_TYPE_SCRIPT: return "script"; case content::RESOURCE_TYPE_IMAGE: return "image"; case content::RESOURCE_TYPE_OBJECT: return "object"; case content::RESOURCE_TYPE_XHR: return "xhr"; default: return "other"; } } namespace { using ResponseHeadersContainer = std::pair*, const std::string&>; void RunSimpleListener(const AtomNetworkDelegate::SimpleListener& listener, std::unique_ptr details) { return listener.Run(*(details.get())); } void RunResponseListener( const AtomNetworkDelegate::ResponseListener& listener, std::unique_ptr details, const AtomNetworkDelegate::ResponseCallback& callback) { return listener.Run(*(details.get()), callback); } // Test whether the URL of |request| matches |patterns|. bool MatchesFilterCondition(net::URLRequest* request, const URLPatterns& patterns) { if (patterns.empty()) return true; for (const auto& pattern : patterns) { if (pattern.MatchesURL(request->url())) return true; } return false; } // Overloaded by multiple types to fill the |details| object. void ToDictionary(base::DictionaryValue* details, net::URLRequest* request) { FillRequestDetails(details, request); details->SetInteger("id", request->identifier()); details->SetDouble("timestamp", base::Time::Now().ToDoubleT() * 1000); const auto* info = content::ResourceRequestInfo::ForRequest(request); if (info) { int process_id = info->GetChildID(); int frame_id = info->GetRenderFrameID(); auto* webContents = content::WebContents::FromRenderFrameHost( content::RenderFrameHost::FromID(process_id, frame_id)); details->SetInteger("webContentsId", atom::api::WebContents::GetIDFromWrappedClass(webContents)); details->SetString("resourceType", ResourceTypeToString(info->GetResourceType())); } else { details->SetString("resourceType", "other"); } } void ToDictionary(base::DictionaryValue* details, const net::HttpRequestHeaders& headers) { std::unique_ptr dict(new base::DictionaryValue); net::HttpRequestHeaders::Iterator it(headers); while (it.GetNext()) dict->SetStringWithoutPathExpansion(it.name(), it.value()); details->Set("requestHeaders", std::move(dict)); } void ToDictionary(base::DictionaryValue* details, const net::HttpResponseHeaders* headers) { if (!headers) return; std::unique_ptr dict(new base::DictionaryValue); size_t iter = 0; std::string key; std::string value; while (headers->EnumerateHeaderLines(&iter, &key, &value)) { if (dict->HasKey(key)) { base::ListValue* values = nullptr; if (dict->GetList(key, &values)) values->AppendString(value); } else { std::unique_ptr values(new base::ListValue); values->AppendString(value); dict->Set(key, std::move(values)); } } details->Set("responseHeaders", std::move(dict)); details->SetString("statusLine", headers->GetStatusLine()); details->SetInteger("statusCode", headers->response_code()); } void ToDictionary(base::DictionaryValue* details, const GURL& location) { details->SetString("redirectURL", location.spec()); } void ToDictionary(base::DictionaryValue* details, const net::HostPortPair& host_port) { if (host_port.host().empty()) details->SetString("ip", host_port.host()); } void ToDictionary(base::DictionaryValue* details, bool from_cache) { details->SetBoolean("fromCache", from_cache); } void ToDictionary(base::DictionaryValue* details, const net::URLRequestStatus& status) { details->SetString("error", net::ErrorToString(status.error())); } // Helper function to fill |details| with arbitrary |args|. template void FillDetailsObject(base::DictionaryValue* details, Arg arg) { ToDictionary(details, arg); } template void FillDetailsObject(base::DictionaryValue* details, Arg arg, Args... args) { ToDictionary(details, arg); FillDetailsObject(details, args...); } // Fill the native types with the result from the response object. void ReadFromResponseObject(const base::DictionaryValue& response, GURL* new_location) { std::string url; if (response.GetString("redirectURL", &url)) *new_location = GURL(url); } void ReadFromResponseObject(const base::DictionaryValue& response, net::HttpRequestHeaders* headers) { const base::DictionaryValue* dict; if (response.GetDictionary("requestHeaders", &dict)) { headers->Clear(); for (base::DictionaryValue::Iterator it(*dict); !it.IsAtEnd(); it.Advance()) { std::string value; if (it.value().GetAsString(&value)) headers->SetHeader(it.key(), value); } } } void ReadFromResponseObject(const base::DictionaryValue& response, const ResponseHeadersContainer& container) { const base::DictionaryValue* dict; std::string status_line; if (!response.GetString("statusLine", &status_line)) status_line = container.second; if (response.GetDictionary("responseHeaders", &dict)) { auto headers = container.first; *headers = new net::HttpResponseHeaders(""); (*headers)->ReplaceStatusLine(status_line); for (base::DictionaryValue::Iterator it(*dict); !it.IsAtEnd(); it.Advance()) { const base::ListValue* list; if (it.value().GetAsList(&list)) { (*headers)->RemoveHeader(it.key()); for (size_t i = 0; i < list->GetSize(); ++i) { std::string value; if (list->GetString(i, &value)) (*headers)->AddHeader(it.key() + " : " + value); } } } } } } // namespace AtomNetworkDelegate::AtomNetworkDelegate() { } AtomNetworkDelegate::~AtomNetworkDelegate() { } void AtomNetworkDelegate::SetSimpleListenerInIO( SimpleEvent type, const URLPatterns& patterns, const SimpleListener& callback) { if (callback.is_null()) simple_listeners_.erase(type); else simple_listeners_[type] = { patterns, callback }; } void AtomNetworkDelegate::SetResponseListenerInIO( ResponseEvent type, const URLPatterns& patterns, const ResponseListener& callback) { if (callback.is_null()) response_listeners_.erase(type); else response_listeners_[type] = { patterns, callback }; } void AtomNetworkDelegate::SetDevToolsNetworkEmulationClientId( const std::string& client_id) { base::AutoLock auto_lock(lock_); client_id_ = client_id; } int AtomNetworkDelegate::OnBeforeURLRequest( net::URLRequest* request, const net::CompletionCallback& callback, GURL* new_url) { if (!base::ContainsKey(response_listeners_, kOnBeforeRequest)) return brightray::NetworkDelegate::OnBeforeURLRequest( request, callback, new_url); return HandleResponseEvent(kOnBeforeRequest, request, callback, new_url); } int AtomNetworkDelegate::OnBeforeStartTransaction( net::URLRequest* request, const net::CompletionCallback& callback, net::HttpRequestHeaders* headers) { std::string client_id; { base::AutoLock auto_lock(lock_); client_id = client_id_; } if (!client_id.empty()) headers->SetHeader( DevToolsNetworkTransaction::kDevToolsEmulateNetworkConditionsClientId, client_id); if (!base::ContainsKey(response_listeners_, kOnBeforeSendHeaders)) return brightray::NetworkDelegate::OnBeforeStartTransaction( request, callback, headers); return HandleResponseEvent( kOnBeforeSendHeaders, request, callback, headers, *headers); } void AtomNetworkDelegate::OnStartTransaction( net::URLRequest* request, const net::HttpRequestHeaders& headers) { if (!base::ContainsKey(simple_listeners_, kOnSendHeaders)) { brightray::NetworkDelegate::OnStartTransaction(request, headers); return; } HandleSimpleEvent(kOnSendHeaders, request, headers); } int AtomNetworkDelegate::OnHeadersReceived( net::URLRequest* request, const net::CompletionCallback& callback, const net::HttpResponseHeaders* original, scoped_refptr* override, GURL* allowed) { if (!base::ContainsKey(response_listeners_, kOnHeadersReceived)) return brightray::NetworkDelegate::OnHeadersReceived( request, callback, original, override, allowed); return HandleResponseEvent( kOnHeadersReceived, request, callback, std::make_pair(override, original->GetStatusLine()), original); } void AtomNetworkDelegate::OnBeforeRedirect(net::URLRequest* request, const GURL& new_location) { if (!base::ContainsKey(simple_listeners_, kOnBeforeRedirect)) { brightray::NetworkDelegate::OnBeforeRedirect(request, new_location); return; } HandleSimpleEvent(kOnBeforeRedirect, request, new_location, request->response_headers(), request->GetSocketAddress(), request->was_cached()); } void AtomNetworkDelegate::OnResponseStarted(net::URLRequest* request) { if (!base::ContainsKey(simple_listeners_, kOnResponseStarted)) { brightray::NetworkDelegate::OnResponseStarted(request); return; } if (request->status().status() != net::URLRequestStatus::SUCCESS) return; HandleSimpleEvent(kOnResponseStarted, request, request->response_headers(), request->was_cached()); } void AtomNetworkDelegate::OnCompleted(net::URLRequest* request, bool started) { // OnCompleted may happen before other events. callbacks_.erase(request->identifier()); if (request->status().status() == net::URLRequestStatus::FAILED || request->status().status() == net::URLRequestStatus::CANCELED) { // Error event. OnErrorOccurred(request, started); return; } else if (request->response_headers() && net::HttpResponseHeaders::IsRedirectResponseCode( request->response_headers()->response_code())) { // Redirect event. brightray::NetworkDelegate::OnCompleted(request, started); return; } if (!base::ContainsKey(simple_listeners_, kOnCompleted)) { brightray::NetworkDelegate::OnCompleted(request, started); return; } HandleSimpleEvent(kOnCompleted, request, request->response_headers(), request->was_cached()); } void AtomNetworkDelegate::OnURLRequestDestroyed(net::URLRequest* request) { callbacks_.erase(request->identifier()); } void AtomNetworkDelegate::OnErrorOccurred( net::URLRequest* request, bool started) { if (!base::ContainsKey(simple_listeners_, kOnErrorOccurred)) { brightray::NetworkDelegate::OnCompleted(request, started); return; } HandleSimpleEvent(kOnErrorOccurred, request, request->was_cached(), request->status()); } template int AtomNetworkDelegate::HandleResponseEvent( ResponseEvent type, net::URLRequest* request, const net::CompletionCallback& callback, Out out, Args... args) { const auto& info = response_listeners_[type]; if (!MatchesFilterCondition(request, info.url_patterns)) return net::OK; std::unique_ptr details(new base::DictionaryValue); FillDetailsObject(details.get(), request, args...); // The |request| could be destroyed before the |callback| is called. callbacks_[request->identifier()] = callback; ResponseCallback response = base::Bind(&AtomNetworkDelegate::OnListenerResultInUI, base::Unretained(this), request->identifier(), out); BrowserThread::PostTask( BrowserThread::UI, FROM_HERE, base::Bind(RunResponseListener, info.listener, base::Passed(&details), response)); return net::ERR_IO_PENDING; } template void AtomNetworkDelegate::HandleSimpleEvent( SimpleEvent type, net::URLRequest* request, Args... args) { const auto& info = simple_listeners_[type]; if (!MatchesFilterCondition(request, info.url_patterns)) return; std::unique_ptr details(new base::DictionaryValue); FillDetailsObject(details.get(), request, args...); BrowserThread::PostTask( BrowserThread::UI, FROM_HERE, base::Bind(RunSimpleListener, info.listener, base::Passed(&details))); } template void AtomNetworkDelegate::OnListenerResultInIO( uint64_t id, T out, std::unique_ptr response) { // The request has been destroyed. if (!base::ContainsKey(callbacks_, id)) return; ReadFromResponseObject(*response, out); bool cancel = false; response->GetBoolean("cancel", &cancel); callbacks_[id].Run(cancel ? net::ERR_BLOCKED_BY_CLIENT : net::OK); } template void AtomNetworkDelegate::OnListenerResultInUI( uint64_t id, T out, const base::DictionaryValue& response) { std::unique_ptr copy = response.CreateDeepCopy(); BrowserThread::PostTask( BrowserThread::IO, FROM_HERE, base::Bind(&AtomNetworkDelegate::OnListenerResultInIO, base::Unretained(this), id, out, base::Passed(©))); } } // namespace atom