// Copyright (c) 2013 GitHub, Inc. All rights reserved. // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. #include "atom/browser/api/atom_api_protocol.h" #include "base/stl_util.h" #include "atom/browser/atom_browser_context.h" #include "atom/browser/net/adapter_request_job.h" #include "atom/browser/net/atom_url_request_context_getter.h" #include "atom/browser/net/atom_url_request_job_factory.h" #include "atom/common/v8/native_type_conversions.h" #include "content/public/browser/browser_thread.h" #include "net/url_request/url_request_context.h" #include "atom/common/v8/node_common.h" namespace atom { namespace api { typedef net::URLRequestJobFactory::ProtocolHandler ProtocolHandler; namespace { // The protocol module object. ScopedPersistent g_protocol_object; // Registered protocol handlers. typedef std::map HandlersMap; static HandlersMap g_handlers; static const char* kEarlyUseProtocolError = "This method can only be used" "after the application has finished launching."; // Emit an event for the protocol module. void EmitEventInUI(const std::string& event, const std::string& parameter) { v8::Locker locker(node_isolate); v8::HandleScope handle_scope(node_isolate); v8::Handle argv[] = { ToV8Value(event), ToV8Value(parameter), }; node::MakeCallback(g_protocol_object.NewHandle(node_isolate), "emit", 2, argv); } // Convert the URLRequest object to V8 object. v8::Handle ConvertURLRequestToV8Object( const net::URLRequest* request) { v8::Local obj = v8::Object::New(); obj->Set(ToV8Value("method"), ToV8Value(request->method())); obj->Set(ToV8Value("url"), ToV8Value(request->url().spec())); obj->Set(ToV8Value("referrer"), ToV8Value(request->referrer())); return obj; } // Get the job factory. AtomURLRequestJobFactory* GetRequestJobFactory() { return AtomBrowserContext::Get()->url_request_context_getter()->job_factory(); } class CustomProtocolRequestJob : public AdapterRequestJob { public: CustomProtocolRequestJob(ProtocolHandler* protocol_handler, net::URLRequest* request, net::NetworkDelegate* network_delegate) : AdapterRequestJob(protocol_handler, request, network_delegate) { } // AdapterRequestJob: virtual void GetJobTypeInUI() OVERRIDE { DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::UI)); v8::Locker locker(node_isolate); v8::HandleScope handle_scope(node_isolate); // Call the JS handler. v8::Handle argv[] = { ConvertURLRequestToV8Object(request()), }; RefCountedV8Function callback = g_handlers[request()->url().scheme()]; v8::Handle result = callback->NewHandle(node_isolate)->Call( v8::Context::GetCurrent()->Global(), 1, argv); // Determine the type of the job we are going to create. if (result->IsString()) { std::string data = FromV8Value(result); content::BrowserThread::PostTask( content::BrowserThread::IO, FROM_HERE, base::Bind(&AdapterRequestJob::CreateStringJobAndStart, GetWeakPtr(), "text/plain", "UTF-8", data)); return; } else if (result->IsObject()) { v8::Handle obj = result->ToObject(); std::string name = FromV8Value(obj->GetConstructorName()); if (name == "RequestStringJob") { std::string mime_type = FromV8Value(obj->Get( v8::String::New("mimeType"))); std::string charset = FromV8Value(obj->Get(v8::String::New("charset"))); std::string data = FromV8Value(obj->Get(v8::String::New("data"))); content::BrowserThread::PostTask( content::BrowserThread::IO, FROM_HERE, base::Bind(&AdapterRequestJob::CreateStringJobAndStart, GetWeakPtr(), mime_type, charset, data)); return; } else if (name == "RequestFileJob") { base::FilePath path = FromV8Value(obj->Get(v8::String::New("path"))); content::BrowserThread::PostTask( content::BrowserThread::IO, FROM_HERE, base::Bind(&AdapterRequestJob::CreateFileJobAndStart, GetWeakPtr(), path)); return; } } // Try the default protocol handler if we have. if (default_protocol_handler()) { content::BrowserThread::PostTask( content::BrowserThread::IO, FROM_HERE, base::Bind(&AdapterRequestJob::CreateJobFromProtocolHandlerAndStart, GetWeakPtr())); return; } // Fallback to the not implemented error. content::BrowserThread::PostTask( content::BrowserThread::IO, FROM_HERE, base::Bind(&AdapterRequestJob::CreateErrorJobAndStart, GetWeakPtr(), net::ERR_NOT_IMPLEMENTED)); } }; // Always return the same CustomProtocolRequestJob for all requests, because // the content API needs the ProtocolHandler to return a job immediately, and // getting the real job from the JS requires asynchronous calls, so we have // to create an adapter job first. // Users can also pass an extra ProtocolHandler as the fallback one when // registered handler doesn't want to deal with the request. class CustomProtocolHandler : public ProtocolHandler { public: explicit CustomProtocolHandler(ProtocolHandler* protocol_handler = NULL) : protocol_handler_(protocol_handler) { } virtual net::URLRequestJob* MaybeCreateJob( net::URLRequest* request, net::NetworkDelegate* network_delegate) const OVERRIDE { return new CustomProtocolRequestJob(protocol_handler_.get(), request, network_delegate); } ProtocolHandler* ReleaseDefaultProtocolHandler() { return protocol_handler_.release(); } ProtocolHandler* original_handler() { return protocol_handler_.get(); } private: scoped_ptr protocol_handler_; DISALLOW_COPY_AND_ASSIGN(CustomProtocolHandler); }; } // namespace // static void Protocol::RegisterProtocol( const v8::FunctionCallbackInfo& args) { std::string scheme; RefCountedV8Function callback; if (!FromV8Arguments(args, &scheme, &callback)) return node::ThrowTypeError("Bad argument"); if (g_handlers.find(scheme) != g_handlers.end() || GetRequestJobFactory()->IsHandledProtocol(scheme)) return node::ThrowError("The scheme is already registered"); if (AtomBrowserContext::Get()->url_request_context_getter() == NULL) return node::ThrowError(kEarlyUseProtocolError); // Store the handler in a map. g_handlers[scheme] = callback; content::BrowserThread::PostTask(content::BrowserThread::IO, FROM_HERE, base::Bind(&RegisterProtocolInIO, scheme)); } // static void Protocol::UnregisterProtocol( const v8::FunctionCallbackInfo& args) { std::string scheme; if (!FromV8Arguments(args, &scheme)) return node::ThrowTypeError("Bad argument"); if (AtomBrowserContext::Get()->url_request_context_getter() == NULL) return node::ThrowError(kEarlyUseProtocolError); // Erase the handler from map. HandlersMap::iterator it(g_handlers.find(scheme)); if (it == g_handlers.end()) return node::ThrowError("The scheme has not been registered"); g_handlers.erase(it); content::BrowserThread::PostTask(content::BrowserThread::IO, FROM_HERE, base::Bind(&UnregisterProtocolInIO, scheme)); } // static void Protocol::IsHandledProtocol( const v8::FunctionCallbackInfo& args) { std::string scheme; if (!FromV8Arguments(args, &scheme)) return node::ThrowTypeError("Bad argument"); args.GetReturnValue().Set(GetRequestJobFactory()->IsHandledProtocol(scheme)); } // static void Protocol::InterceptProtocol( const v8::FunctionCallbackInfo& args) { std::string scheme; RefCountedV8Function callback; if (!FromV8Arguments(args, &scheme, &callback)) return node::ThrowTypeError("Bad argument"); if (!GetRequestJobFactory()->HasProtocolHandler(scheme)) return node::ThrowError("Cannot intercept procotol"); if (ContainsKey(g_handlers, scheme)) return node::ThrowError("Cannot intercept custom procotols"); if (AtomBrowserContext::Get()->url_request_context_getter() == NULL) return node::ThrowError(kEarlyUseProtocolError); // Store the handler in a map. g_handlers[scheme] = callback; content::BrowserThread::PostTask(content::BrowserThread::IO, FROM_HERE, base::Bind(&InterceptProtocolInIO, scheme)); } // static void Protocol::UninterceptProtocol( const v8::FunctionCallbackInfo& args) { std::string scheme; if (!FromV8Arguments(args, &scheme)) return node::ThrowTypeError("Bad argument"); if (AtomBrowserContext::Get()->url_request_context_getter() == NULL) return node::ThrowError(kEarlyUseProtocolError); // Erase the handler from map. HandlersMap::iterator it(g_handlers.find(scheme)); if (it == g_handlers.end()) return node::ThrowError("The scheme has not been registered"); g_handlers.erase(it); content::BrowserThread::PostTask(content::BrowserThread::IO, FROM_HERE, base::Bind(&UninterceptProtocolInIO, scheme)); } // static void Protocol::RegisterProtocolInIO(const std::string& scheme) { DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::IO)); AtomURLRequestJobFactory* job_factory(GetRequestJobFactory()); job_factory->SetProtocolHandler(scheme, new CustomProtocolHandler); content::BrowserThread::PostTask(content::BrowserThread::UI, FROM_HERE, base::Bind(&EmitEventInUI, "registered", scheme)); } // static void Protocol::UnregisterProtocolInIO(const std::string& scheme) { DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::IO)); AtomURLRequestJobFactory* job_factory(GetRequestJobFactory()); job_factory->SetProtocolHandler(scheme, NULL); content::BrowserThread::PostTask(content::BrowserThread::UI, FROM_HERE, base::Bind(&EmitEventInUI, "unregistered", scheme)); } // static void Protocol::InterceptProtocolInIO(const std::string& scheme) { DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::IO)); AtomURLRequestJobFactory* job_factory(GetRequestJobFactory()); ProtocolHandler* original_handler = job_factory->GetProtocolHandler(scheme); if (original_handler == NULL) { content::BrowserThread::PostTask( content::BrowserThread::UI, FROM_HERE, base::Bind(&EmitEventInUI, "error", "There is no protocol handler to intercpet")); return; } job_factory->ReplaceProtocol(scheme, new CustomProtocolHandler(original_handler)); content::BrowserThread::PostTask(content::BrowserThread::UI, FROM_HERE, base::Bind(&EmitEventInUI, "intercepted", scheme)); } // static void Protocol::UninterceptProtocolInIO(const std::string& scheme) { DCHECK(content::BrowserThread::CurrentlyOn(content::BrowserThread::IO)); AtomURLRequestJobFactory* job_factory(GetRequestJobFactory()); // Check if the protocol handler is intercepted. CustomProtocolHandler* handler = static_cast( job_factory->GetProtocolHandler(scheme)); if (handler->original_handler() == NULL) { content::BrowserThread::PostTask( content::BrowserThread::UI, FROM_HERE, base::Bind(&EmitEventInUI, "error", "The protocol is not intercpeted")); return; } // Reset the protocol handler to the orignal one and delete current // protocol handler. ProtocolHandler* original_handler = handler->ReleaseDefaultProtocolHandler(); delete job_factory->ReplaceProtocol(scheme, original_handler); content::BrowserThread::PostTask(content::BrowserThread::UI, FROM_HERE, base::Bind(&EmitEventInUI, "unintercepted", scheme)); } // static void Protocol::Initialize(v8::Handle target) { // Remember the protocol object, used for emitting event later. g_protocol_object.reset(target); // Make sure the job factory has been created. AtomBrowserContext::Get()->url_request_context_getter()-> GetURLRequestContext(); NODE_SET_METHOD(target, "registerProtocol", RegisterProtocol); NODE_SET_METHOD(target, "unregisterProtocol", UnregisterProtocol); NODE_SET_METHOD(target, "isHandledProtocol", IsHandledProtocol); NODE_SET_METHOD(target, "interceptProtocol", InterceptProtocol); NODE_SET_METHOD(target, "uninterceptProtocol", UninterceptProtocol); } } // namespace api } // namespace atom NODE_MODULE(atom_browser_protocol, atom::api::Protocol::Initialize)