llhttp 0.0.1 → 0.3.0

data/ext/llhttp/llhttp_ext.c

@@ -0,0 +1,314 @@
+/*
+  This software is licensed under the MPL-2.0 License.
+
+  Copyright Bryan Powell, 2020.
+*/
+
+#include <ruby/ruby.h>
+
+#include "llhttp.h"
+
+static VALUE mLLHttp, cParser, eError;
+
+static ID rb_llhttp_callback_on_message_begin;
+static ID rb_llhttp_callback_on_url;
+static ID rb_llhttp_callback_on_status;
+static ID rb_llhttp_callback_on_header_field;
+static ID rb_llhttp_callback_on_header_value;
+static ID rb_llhttp_callback_on_headers_complete;
+static ID rb_llhttp_callback_on_body;
+static ID rb_llhttp_callback_on_message_complete;
+static ID rb_llhttp_callback_on_chunk_header;
+static ID rb_llhttp_callback_on_chunk_complete;
+static ID rb_llhttp_callback_on_url_complete;
+static ID rb_llhttp_callback_on_status_complete;
+static ID rb_llhttp_callback_on_header_field_complete;
+static ID rb_llhttp_callback_on_header_value_complete;
+
+static void rb_llhttp_free(llhttp_t *parser) {
+  if (parser) {
+    free(parser->settings);
+    free(parser);
+  }
+}
+
+VALUE rb_llhttp_allocate(VALUE klass) {
+  llhttp_t *parser = (llhttp_t *)malloc(sizeof(llhttp_t));
+  llhttp_settings_t *settings = (llhttp_settings_t *)malloc(sizeof(llhttp_settings_t));
+
+  llhttp_settings_init(settings);
+  llhttp_init(parser, HTTP_BOTH, settings);
+
+  return Data_Wrap_Struct(klass, 0, rb_llhttp_free, parser);
+}
+
+VALUE rb_llhttp_callback_call(VALUE delegate, ID method) {
+  return rb_funcall(delegate, method, 0);
+}
+
+void rb_llhttp_data_callback_call(VALUE delegate, ID method, char *data, size_t length) {
+  rb_funcall(delegate, method, 1, rb_str_new(data, length));
+}
+
+int rb_llhttp_on_message_begin(llhttp_t *parser) {
+  return NUM2INT(rb_llhttp_callback_call((VALUE)parser->data, rb_llhttp_callback_on_message_begin));
+}
+
+int rb_llhttp_on_headers_complete(llhttp_t *parser) {
+  return NUM2INT(rb_llhttp_callback_call((VALUE)parser->data, rb_llhttp_callback_on_headers_complete));
+}
+
+int rb_llhttp_on_message_complete(llhttp_t *parser) {
+  return NUM2INT(rb_llhttp_callback_call((VALUE)parser->data, rb_llhttp_callback_on_message_complete));
+}
+
+int rb_llhttp_on_chunk_header(llhttp_t *parser) {
+  return NUM2INT(rb_llhttp_callback_call((VALUE)parser->data, rb_llhttp_callback_on_chunk_header));
+}
+
+int rb_llhttp_on_url(llhttp_t *parser, char *data, size_t length) {
+  rb_llhttp_data_callback_call((VALUE)parser->data, rb_llhttp_callback_on_url, data, length);
+
+  return 0;
+}
+
+int rb_llhttp_on_status(llhttp_t *parser, char *data, size_t length) {
+  rb_llhttp_data_callback_call((VALUE)parser->data, rb_llhttp_callback_on_status, data, length);
+
+  return 0;
+}
+
+int rb_llhttp_on_header_field(llhttp_t *parser, char *data, size_t length) {
+  rb_llhttp_data_callback_call((VALUE)parser->data, rb_llhttp_callback_on_header_field, data, length);
+
+  return 0;
+}
+
+int rb_llhttp_on_header_value(llhttp_t *parser, char *data, size_t length) {
+  rb_llhttp_data_callback_call((VALUE)parser->data, rb_llhttp_callback_on_header_value, data, length);
+
+  return 0;
+}
+
+int rb_llhttp_on_body(llhttp_t *parser, char *data, size_t length) {
+  rb_llhttp_data_callback_call((VALUE)parser->data, rb_llhttp_callback_on_body, data, length);
+
+  return 0;
+}
+
+int rb_llhttp_on_chunk_complete(llhttp_t *parser) {
+  rb_llhttp_callback_call((VALUE)parser->data, rb_llhttp_callback_on_chunk_complete);
+
+  return 0;
+}
+
+int rb_llhttp_on_url_complete(llhttp_t *parser) {
+  rb_llhttp_callback_call((VALUE)parser->data, rb_llhttp_callback_on_url_complete);
+
+  return 0;
+}
+
+int rb_llhttp_on_status_complete(llhttp_t *parser) {
+  rb_llhttp_callback_call((VALUE)parser->data, rb_llhttp_callback_on_status_complete);
+
+  return 0;
+}
+
+int rb_llhttp_on_header_field_complete(llhttp_t *parser) {
+  rb_llhttp_callback_call((VALUE)parser->data, rb_llhttp_callback_on_header_field_complete);
+
+  return 0;
+}
+
+int rb_llhttp_on_header_value_complete(llhttp_t *parser) {
+  rb_llhttp_callback_call((VALUE)parser->data, rb_llhttp_callback_on_header_value_complete);
+
+  return 0;
+}
+
+VALUE rb_llhttp_parse(VALUE self, VALUE data) {
+  llhttp_t *parser;
+
+  Data_Get_Struct(self, llhttp_t, parser);
+
+  enum llhttp_errno err = llhttp_execute(parser, RSTRING_PTR(data), RSTRING_LEN(data));
+
+  if (err != HPE_OK) {
+    rb_raise(eError, "Error Parsing data: %s %s", llhttp_errno_name(err), parser->reason);
+  }
+
+  return Qtrue;
+}
+
+VALUE rb_llhttp_finish(VALUE self) {
+  llhttp_t *parser;
+
+  Data_Get_Struct(self, llhttp_t, parser);
+
+  enum llhttp_errno err = llhttp_finish(parser);
+
+  if (err != HPE_OK) {
+    rb_raise(eError, "Error Parsing data: %s %s", llhttp_errno_name(err), parser->reason);
+  }
+
+  return Qtrue;
+}
+
+VALUE rb_llhttp_content_length(VALUE self) {
+  llhttp_t *parser;
+
+  Data_Get_Struct(self, llhttp_t, parser);
+
+  return ULL2NUM(parser->content_length);
+}
+
+VALUE rb_llhttp_method_name(VALUE self) {
+  llhttp_t *parser;
+
+  Data_Get_Struct(self, llhttp_t, parser);
+
+  return rb_str_new_cstr(llhttp_method_name(parser->method));
+}
+
+VALUE rb_llhttp_status_code(VALUE self) {
+  llhttp_t *parser;
+
+  Data_Get_Struct(self, llhttp_t, parser);
+
+  return UINT2NUM(parser->status_code);
+}
+
+VALUE rb_llhttp_http_major(VALUE self) {
+  llhttp_t *parser;
+
+  Data_Get_Struct(self, llhttp_t, parser);
+
+  return UINT2NUM(parser->http_major);
+}
+
+VALUE rb_llhttp_http_minor(VALUE self) {
+  llhttp_t *parser;
+
+  Data_Get_Struct(self, llhttp_t, parser);
+
+  return UINT2NUM(parser->http_minor);
+}
+
+VALUE rb_llhttp_keep_alive(VALUE self) {
+  llhttp_t *parser;
+
+  Data_Get_Struct(self, llhttp_t, parser);
+
+  int ret = llhttp_should_keep_alive(parser);
+
+  return ret == 1 ? Qtrue : Qfalse;
+}
+
+static VALUE rb_llhttp_init(VALUE self, VALUE type) {
+  llhttp_t *parser;
+
+  Data_Get_Struct(self, llhttp_t, parser);
+
+  llhttp_settings_t *settings = parser->settings;
+
+  VALUE delegate = rb_iv_get(self, "@delegate");
+
+  rb_llhttp_callback_on_message_begin = rb_intern("internal_on_message_begin");
+  rb_llhttp_callback_on_headers_complete = rb_intern("internal_on_headers_complete");
+  rb_llhttp_callback_on_message_complete = rb_intern("internal_on_message_complete");
+  rb_llhttp_callback_on_chunk_header = rb_intern("internal_on_chunk_header");
+  rb_llhttp_callback_on_url = rb_intern("on_url");
+  rb_llhttp_callback_on_status = rb_intern("on_status");
+  rb_llhttp_callback_on_header_field = rb_intern("on_header_field");
+  rb_llhttp_callback_on_header_value = rb_intern("on_header_value");
+  rb_llhttp_callback_on_body = rb_intern("on_body");
+  rb_llhttp_callback_on_chunk_complete = rb_intern("on_chunk_complete");
+  rb_llhttp_callback_on_url_complete = rb_intern("on_url_complete");
+  rb_llhttp_callback_on_status_complete = rb_intern("on_status_complete");
+  rb_llhttp_callback_on_header_field_complete = rb_intern("on_header_field_complete");
+  rb_llhttp_callback_on_header_value_complete = rb_intern("on_header_value_complete");
+
+  if (rb_respond_to(delegate, rb_intern("on_message_begin"))) {
+    settings->on_message_begin = (llhttp_cb)rb_llhttp_on_message_begin;
+  }
+
+  if (rb_respond_to(delegate, rb_intern("on_headers_complete"))) {
+    settings->on_headers_complete = (llhttp_cb)rb_llhttp_on_headers_complete;
+  }
+
+  if (rb_respond_to(delegate, rb_intern("on_message_complete"))) {
+    settings->on_message_complete = (llhttp_cb)rb_llhttp_on_message_complete;
+  }
+
+  if (rb_respond_to(delegate, rb_intern("on_chunk_header"))) {
+    settings->on_chunk_header = (llhttp_cb)rb_llhttp_on_chunk_header;
+  }
+
+  if (rb_respond_to(delegate, rb_llhttp_callback_on_url)) {
+    settings->on_url = (llhttp_data_cb)rb_llhttp_on_url;
+  }
+
+  if (rb_respond_to(delegate, rb_llhttp_callback_on_status)) {
+    settings->on_status = (llhttp_data_cb)rb_llhttp_on_status;
+  }
+
+  if (rb_respond_to(delegate, rb_llhttp_callback_on_header_field)) {
+    settings->on_header_field = (llhttp_data_cb)rb_llhttp_on_header_field;
+  }
+
+  if (rb_respond_to(delegate, rb_llhttp_callback_on_header_value)) {
+    settings->on_header_value = (llhttp_data_cb)rb_llhttp_on_header_value;
+  }
+
+  if (rb_respond_to(delegate, rb_llhttp_callback_on_body)) {
+    settings->on_body = (llhttp_data_cb)rb_llhttp_on_body;
+  }
+
+  if (rb_respond_to(delegate, rb_llhttp_callback_on_chunk_complete)) {
+    settings->on_chunk_complete = (llhttp_cb)rb_llhttp_on_chunk_complete;
+  }
+
+  if (rb_respond_to(delegate, rb_llhttp_callback_on_url_complete)) {
+    settings->on_url_complete = (llhttp_cb)rb_llhttp_on_url_complete;
+  }
+
+  if (rb_respond_to(delegate, rb_llhttp_callback_on_status_complete)) {
+    settings->on_status_complete = (llhttp_cb)rb_llhttp_on_status_complete;
+  }
+
+  if (rb_respond_to(delegate, rb_llhttp_callback_on_header_field_complete)) {
+    settings->on_header_field_complete = (llhttp_cb)rb_llhttp_on_header_field_complete;
+  }
+
+  if (rb_respond_to(delegate, rb_llhttp_callback_on_header_value_complete)) {
+    settings->on_header_value_complete = (llhttp_cb)rb_llhttp_on_header_value_complete;
+  }
+
+  llhttp_init(parser, FIX2INT(type), settings);
+
+  parser->data = (void*)delegate;
+
+  return Qtrue;
+}
+
+void Init_llhttp_ext(void) {
+  mLLHttp = rb_const_get(rb_cObject, rb_intern("LLHttp"));
+  cParser = rb_const_get(mLLHttp, rb_intern("Parser"));
+  eError = rb_const_get(mLLHttp, rb_intern("Error"));
+
+  rb_define_alloc_func(cParser, rb_llhttp_allocate);
+
+  rb_define_method(cParser, "<<", rb_llhttp_parse, 1);
+  rb_define_method(cParser, "parse", rb_llhttp_parse, 1);
+  rb_define_method(cParser, "finish", rb_llhttp_finish, 0);
+
+  rb_define_method(cParser, "content_length", rb_llhttp_content_length, 0);
+  rb_define_method(cParser, "method_name", rb_llhttp_method_name, 0);
+  rb_define_method(cParser, "status_code", rb_llhttp_status_code, 0);
+  rb_define_method(cParser, "http_major", rb_llhttp_http_major, 0);
+  rb_define_method(cParser, "http_minor", rb_llhttp_http_minor, 0);
+
+  rb_define_method(cParser, "keep_alive?", rb_llhttp_keep_alive, 0);
+
+  rb_define_private_method(cParser, "llhttp_init", rb_llhttp_init, 1);
+}

data/lib/llhttp/delegate.rb

@@ -1,37 +1,97 @@
 # frozen_string_literal: true
 
 module LLHttp
-  # Delegate for handling callbacks. Subclass this, implementing the necessary methods.
+  # [public] Delegate for handling callbacks. Subclass this object and implement necessary methods.
+  #
+  #   class Delegate < LLHttp::Delegate
+  #     def on_message_begin
+  #       ...
+  #     end
+  #
+  #     def on_url(url)
+  #       ...
+  #     end
+  #
+  #     def on_status(status)
+  #       ...
+  #     end
+  #
+  #     def on_header_field(field)
+  #       ...
+  #     end
+  #
+  #     def on_header_value(value)
+  #       ...
+  #     end
+  #
+  #     def on_headers_complete
+  #       ...
+  #     end
+  #
+  #     def on_body(body)
+  #       ...
+  #     end
+  #
+  #     def on_message_complete
+  #       ...
+  #     end
+  #
+  #     def on_chunk_header
+  #       ...
+  #     end
+  #
+  #     def on_chunk_complete
+  #       ...
+  #     end
+  #
+  #     def on_url_complete
+  #       ...
+  #     end
+  #
+  #     def on_status_complete
+  #       ...
+  #     end
+  #
+  #     def on_header_field_complete
+  #       ...
+  #     end
+  #
+  #     def on_header_value_complete
+  #       ...
+  #     end
+  #   end
   #
   class Delegate
-    def on_message_begin
-    end
+    private def internal_on_message_begin
+      on_message_begin
 
-    def on_url(url)
+      0
+    rescue
+      -1
     end
 
-    def on_status(status)
-    end
+    private def internal_on_headers_complete
+      on_headers_complete
 
-    def on_header_field(field)
+      0
+    rescue
+      -1
     end
 
-    def on_header_value(value)
-    end
+    private def internal_on_message_complete
+      on_message_complete
 
-    def on_headers_complete
+      0
+    rescue
+      -1
     end
 
-    def on_body(body)
-    end
-
-    def on_message_complete
-    end
-
-    def on_chunk_header
-    end
+    private def internal_on_chunk_header
+      on_chunk_header
 
-    def on_chunk_complete
+      0
+    rescue
+      -1
     end
   end
 end

data/lib/llhttp/error.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module LLHttp
+  # [public] LLHttp's standard error object.
+  #
   class Error < StandardError
   end
 end

data/lib/llhttp/parser.rb

@@ -1,19 +1,40 @@
 # frozen_string_literal: true
 
 module LLHttp
-  # Wraps an llhttp context for parsing http requests and responses.
+  # [public] Wraps an llhttp context for parsing http requests and responses.
   #
-  # = Finishing
+  #   class Delegate < LLHttp::Delegate
+  #     def on_message_begin
+  #       ...
+  #     end
   #
-  # Call `LLHttp::Parser#finish` when processing is complete for the current request or response.
+  #     ...
+  #   end
   #
-  # = Introspection
+  #   parser = LLHttp::Parser.new(Delegate.new, type: :request)
+  #   parser << "GET / HTTP/1.1\r\n\r\n"
+  #   parser.finish
   #
-  # `LLHttp::Parser#keep_alive?` returns `true` if there might be any other messages following the last that was successfuly parsed.
+  #   ...
+  #
+  # Introspection
+  #
+  #   * `LLHttp::Parser#content_length` returns the content length of the current request.
+  #   * `LLHttp::Parser#method_name` returns the method name of the current response.
+  #   * `LLHttp::Parser#status_code` returns the status code of the current response.
+  #   * `LLHttp::Parser#http_major` returns the major http version of the current request/response.
+  #   * `LLHttp::Parser#http_minor` returns the minor http version of the current request/response.
+  #   * `LLHttp::Parser#keep_alive?` returns `true` if there might be more messages.
+  #
+  # Finishing
+  #
+  #   Call `LLHttp::Parser#finish` when processing is complete for the current request or response.
   #
   class Parser
     LLHTTP_TYPES = {both: 0, request: 1, response: 2}.freeze
 
+    # [public] The parser type; one of: `both`, `request`, or `response`.
+    #
     attr_reader :type
 
     def initialize(delegate, type: :both)
@@ -24,4 +45,4 @@ module LLHttp
   end
 end
 
-require_relative "llhttp_ext"
+require_relative "../llhttp_ext"