// Copyright Joyent, Inc. and other Node contributors. // // Permission is hereby granted, free of charge, to any person obtaining a // copy of this software and associated documentation files (the // "Software"), to deal in the Software without restriction, including // without limitation the rights to use, copy, modify, merge, publish, // distribute, sublicense, and/or sell copies of the Software, and to permit // persons to whom the Software is furnished to do so, subject to the // following conditions: // // The above copyright notice and this permission notice shall be included // in all copies or substantial portions of the Software. // // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS // OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN // NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, // DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR // OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE // USE OR OTHER DEALINGS IN THE SOFTWARE. #include "node_http_parser.h" #include "v8.h" #include "node.h" #include "node_buffer.h" #include /* strdup() */ #if !defined(_MSC_VER) #include /* strcasecmp() */ #else #define strcasecmp _stricmp #endif #include /* free() */ // This is a binding to http_parser (https://github.com/joyent/http-parser) // The goal is to decouple sockets from parsing for more javascript-level // agility. A Buffer is read from a socket and passed to parser.execute(). // The parser then issues callbacks with slices of the data // parser.onMessageBegin // parser.onPath // parser.onBody // ... // No copying is performed when slicing the buffer, only small reference // allocations. namespace node { using namespace v8; static Persistent on_headers_sym; static Persistent on_headers_complete_sym; static Persistent on_body_sym; static Persistent on_message_complete_sym; static Persistent method_sym; static Persistent status_code_sym; static Persistent http_version_sym; static Persistent version_major_sym; static Persistent version_minor_sym; static Persistent should_keep_alive_sym; static Persistent upgrade_sym; static Persistent headers_sym; static Persistent url_sym; static Persistent unknown_method_sym; #define X(num, name, string) static Persistent name##_sym; HTTP_METHOD_MAP(X) #undef X static struct http_parser_settings settings; // This is a hack to get the current_buffer to the callbacks with the least // amount of overhead. Nothing else will run while http_parser_execute() // runs, therefore this pointer can be set and used for the execution. static Local* current_buffer; static char* current_buffer_data; static size_t current_buffer_len; #define HTTP_CB(name) \ static int name(http_parser* p_) { \ Parser* self = container_of(p_, Parser, parser_); \ return self->name##_(); \ } \ int name##_() #define HTTP_DATA_CB(name) \ static int name(http_parser* p_, const char* at, size_t length) { \ Parser* self = container_of(p_, Parser, parser_); \ return self->name##_(at, length); \ } \ int name##_(const char* at, size_t length) static inline Persistent method_to_str(unsigned short m) { switch (m) { #define X(num, name, string) case HTTP_##name: return name##_sym; HTTP_METHOD_MAP(X) #undef X } return unknown_method_sym; } // helper class for the Parser struct StringPtr { StringPtr() { on_heap_ = false; Reset(); } ~StringPtr() { Reset(); } // If str_ does not point to a heap string yet, this function makes it do // so. This is called at the end of each http_parser_execute() so as not // to leak references. See issue #2438 and test-http-parser-bad-ref.js. void Save() { if (!on_heap_ && size_ > 0) { char* s = new char[size_]; memcpy(s, str_, size_); str_ = s; on_heap_ = true; } } void Reset() { if (on_heap_) { delete[] str_; on_heap_ = false; } str_ = NULL; size_ = 0; } void Update(const char* str, size_t size) { if (str_ == NULL) str_ = str; else if (on_heap_ || str_ + size_ != str) { // Non-consecutive input, make a copy on the heap. // TODO Use slab allocation, O(n) allocs is bad. char* s = new char[size_ + size]; memcpy(s, str_, size_); memcpy(s + size_, str, size); if (on_heap_) delete[] str_; else on_heap_ = true; str_ = s; } size_ += size; } Local ToString() const { if (str_) return String::New(str_, size_); else return String::Empty(node_isolate); } const char* str_; bool on_heap_; size_t size_; }; class Parser : public ObjectWrap { public: Parser(enum http_parser_type type) : ObjectWrap() { Init(type); } ~Parser() { } HTTP_CB(on_message_begin) { num_fields_ = num_values_ = 0; url_.Reset(); return 0; } HTTP_DATA_CB(on_url) { url_.Update(at, length); return 0; } HTTP_DATA_CB(on_header_field) { if (num_fields_ == num_values_) { // start of new field name num_fields_++; if (num_fields_ == ARRAY_SIZE(fields_)) { // ran out of space - flush to javascript land Flush(); num_fields_ = 1; num_values_ = 0; } fields_[num_fields_ - 1].Reset(); } assert(num_fields_ < (int)ARRAY_SIZE(fields_)); assert(num_fields_ == num_values_ + 1); fields_[num_fields_ - 1].Update(at, length); return 0; } HTTP_DATA_CB(on_header_value) { if (num_values_ != num_fields_) { // start of new header value num_values_++; values_[num_values_ - 1].Reset(); } assert(num_values_ < (int)ARRAY_SIZE(values_)); assert(num_values_ == num_fields_); values_[num_values_ - 1].Update(at, length); return 0; } HTTP_CB(on_headers_complete) { Local cb = handle_->Get(on_headers_complete_sym); if (!cb->IsFunction()) return 0; Local message_info = Object::New(); if (have_flushed_) { // Slow case, flush remaining headers. Flush(); } else { // Fast case, pass headers and URL to JS land. message_info->Set(headers_sym, CreateHeaders()); if (parser_.type == HTTP_REQUEST) message_info->Set(url_sym, url_.ToString()); } num_fields_ = num_values_ = 0; // METHOD if (parser_.type == HTTP_REQUEST) { message_info->Set(method_sym, method_to_str(parser_.method)); } // STATUS if (parser_.type == HTTP_RESPONSE) { message_info->Set(status_code_sym, Integer::New(parser_.status_code, node_isolate)); } // VERSION message_info->Set(version_major_sym, Integer::New(parser_.http_major, node_isolate)); message_info->Set(version_minor_sym, Integer::New(parser_.http_minor, node_isolate)); message_info->Set(should_keep_alive_sym, http_should_keep_alive(&parser_) ? True(node_isolate) : False(node_isolate)); message_info->Set(upgrade_sym, parser_.upgrade ? True(node_isolate) : False(node_isolate)); Local argv[1] = { message_info }; Local head_response = Local::Cast(cb)->Call(handle_, 1, argv); if (head_response.IsEmpty()) { got_exception_ = true; return -1; } return head_response->IsTrue() ? 1 : 0; } HTTP_DATA_CB(on_body) { HandleScope scope(node_isolate); Local cb = handle_->Get(on_body_sym); if (!cb->IsFunction()) return 0; Local argv[3] = { *current_buffer, Integer::New(at - current_buffer_data, node_isolate), Integer::New(length, node_isolate) }; Local r = Local::Cast(cb)->Call(handle_, 3, argv); if (r.IsEmpty()) { got_exception_ = true; return -1; } return 0; } HTTP_CB(on_message_complete) { HandleScope scope(node_isolate); if (num_fields_) Flush(); // Flush trailing HTTP headers. Local cb = handle_->Get(on_message_complete_sym); if (!cb->IsFunction()) return 0; Local r = Local::Cast(cb)->Call(handle_, 0, NULL); if (r.IsEmpty()) { got_exception_ = true; return -1; } return 0; } static Handle New(const Arguments& args) { HandleScope scope(node_isolate); http_parser_type type = static_cast(args[0]->Int32Value()); if (type != HTTP_REQUEST && type != HTTP_RESPONSE) { return ThrowException(Exception::Error(String::New( "Argument must be HTTPParser.REQUEST or HTTPParser.RESPONSE"))); } Parser* parser = new Parser(type); parser->Wrap(args.This()); return args.This(); } void Save() { url_.Save(); for (int i = 0; i < num_fields_; i++) { fields_[i].Save(); } for (int i = 0; i < num_values_; i++) { values_[i].Save(); } } // var bytesParsed = parser->execute(buffer, off, len); static Handle Execute(const Arguments& args) { HandleScope scope(node_isolate); Parser* parser = ObjectWrap::Unwrap(args.This()); assert(!current_buffer); assert(!current_buffer_data); if (current_buffer) { return ThrowException(Exception::TypeError( String::New("Already parsing a buffer"))); } Local buffer_v = args[0]; if (!Buffer::HasInstance(buffer_v)) { return ThrowException(Exception::TypeError( String::New("Argument should be a buffer"))); } Local buffer_obj = buffer_v->ToObject(); char *buffer_data = Buffer::Data(buffer_obj); size_t buffer_len = Buffer::Length(buffer_obj); size_t off = args[1]->Int32Value(); if (off >= buffer_len) { return ThrowException(Exception::Error( String::New("Offset is out of bounds"))); } size_t len = args[2]->Int32Value(); if (off+len > buffer_len) { return ThrowException(Exception::Error( String::New("off + len > buffer.length"))); } // Assign 'buffer_' while we parse. The callbacks will access that varible. current_buffer = &buffer_v; current_buffer_data = buffer_data; current_buffer_len = buffer_len; parser->got_exception_ = false; size_t nparsed = http_parser_execute(&parser->parser_, &settings, buffer_data + off, len); parser->Save(); // Unassign the 'buffer_' variable assert(current_buffer); current_buffer = NULL; current_buffer_data = NULL; // If there was an exception in one of the callbacks if (parser->got_exception_) return Local(); Local nparsed_obj = Integer::New(nparsed, node_isolate); // If there was a parse error in one of the callbacks // TODO What if there is an error on EOF? if (!parser->parser_.upgrade && nparsed != len) { enum http_errno err = HTTP_PARSER_ERRNO(&parser->parser_); Local e = Exception::Error(String::NewSymbol("Parse Error")); Local obj = e->ToObject(); obj->Set(String::NewSymbol("bytesParsed"), nparsed_obj); obj->Set(String::NewSymbol("code"), String::New(http_errno_name(err))); return scope.Close(e); } else { return scope.Close(nparsed_obj); } } static Handle Finish(const Arguments& args) { HandleScope scope(node_isolate); Parser* parser = ObjectWrap::Unwrap(args.This()); assert(!current_buffer); parser->got_exception_ = false; int rv = http_parser_execute(&(parser->parser_), &settings, NULL, 0); if (parser->got_exception_) return Local(); if (rv != 0) { enum http_errno err = HTTP_PARSER_ERRNO(&parser->parser_); Local e = Exception::Error(String::NewSymbol("Parse Error")); Local obj = e->ToObject(); obj->Set(String::NewSymbol("bytesParsed"), Integer::New(0, node_isolate)); obj->Set(String::NewSymbol("code"), String::New(http_errno_name(err))); return scope.Close(e); } return Undefined(node_isolate); } static Handle Reinitialize(const Arguments& args) { HandleScope scope(node_isolate); http_parser_type type = static_cast(args[0]->Int32Value()); if (type != HTTP_REQUEST && type != HTTP_RESPONSE) { return ThrowException(Exception::Error(String::New( "Argument must be HTTPParser.REQUEST or HTTPParser.RESPONSE"))); } Parser* parser = ObjectWrap::Unwrap(args.This()); parser->Init(type); return Undefined(node_isolate); } private: Local CreateHeaders() { // num_values_ is either -1 or the entry # of the last header // so num_values_ == 0 means there's a single header Local headers = Array::New(2 * num_values_); for (int i = 0; i < num_values_; ++i) { headers->Set(2 * i, fields_[i].ToString()); headers->Set(2 * i + 1, values_[i].ToString()); } return headers; } // spill headers and request path to JS land void Flush() { HandleScope scope(node_isolate); Local cb = handle_->Get(on_headers_sym); if (!cb->IsFunction()) return; Local argv[2] = { CreateHeaders(), url_.ToString() }; Local r = Local::Cast(cb)->Call(handle_, 2, argv); if (r.IsEmpty()) got_exception_ = true; url_.Reset(); have_flushed_ = true; } void Init(enum http_parser_type type) { http_parser_init(&parser_, type); url_.Reset(); num_fields_ = 0; num_values_ = 0; have_flushed_ = false; got_exception_ = false; } http_parser parser_; StringPtr fields_[32]; // header fields StringPtr values_[32]; // header values StringPtr url_; int num_fields_; int num_values_; bool have_flushed_; bool got_exception_; }; void InitHttpParser(Handle target) { HandleScope scope(node_isolate); Local t = FunctionTemplate::New(Parser::New); t->InstanceTemplate()->SetInternalFieldCount(1); t->SetClassName(String::NewSymbol("HTTPParser")); PropertyAttribute attrib = (PropertyAttribute) (ReadOnly | DontDelete); t->Set(String::NewSymbol("REQUEST"), Integer::New(HTTP_REQUEST, node_isolate), attrib); t->Set(String::NewSymbol("RESPONSE"), Integer::New(HTTP_RESPONSE, node_isolate), attrib); NODE_SET_PROTOTYPE_METHOD(t, "execute", Parser::Execute); NODE_SET_PROTOTYPE_METHOD(t, "finish", Parser::Finish); NODE_SET_PROTOTYPE_METHOD(t, "reinitialize", Parser::Reinitialize); target->Set(String::NewSymbol("HTTPParser"), t->GetFunction()); on_headers_sym = NODE_PSYMBOL("onHeaders"); on_headers_complete_sym = NODE_PSYMBOL("onHeadersComplete"); on_body_sym = NODE_PSYMBOL("onBody"); on_message_complete_sym = NODE_PSYMBOL("onMessageComplete"); #define X(num, name, string) name##_sym = NODE_PSYMBOL(#string); HTTP_METHOD_MAP(X) #undef X unknown_method_sym = NODE_PSYMBOL("UNKNOWN_METHOD"); method_sym = NODE_PSYMBOL("method"); status_code_sym = NODE_PSYMBOL("statusCode"); http_version_sym = NODE_PSYMBOL("httpVersion"); version_major_sym = NODE_PSYMBOL("versionMajor"); version_minor_sym = NODE_PSYMBOL("versionMinor"); should_keep_alive_sym = NODE_PSYMBOL("shouldKeepAlive"); upgrade_sym = NODE_PSYMBOL("upgrade"); headers_sym = NODE_PSYMBOL("headers"); url_sym = NODE_PSYMBOL("url"); settings.on_message_begin = Parser::on_message_begin; settings.on_url = Parser::on_url; settings.on_header_field = Parser::on_header_field; settings.on_header_value = Parser::on_header_value; settings.on_headers_complete = Parser::on_headers_complete; settings.on_body = Parser::on_body; settings.on_message_complete = Parser::on_message_complete; } } // namespace node NODE_MODULE(node_http_parser, node::InitHttpParser)