llhttp-ffi 0.0.0

data/ext/llhttp/llhttp_ext.c

@@ -0,0 +1,215 @@
+/*
+  This software is licensed under the MPL-2.0 License.
+
+  Copyright Bryan Powell, 2020.
+*/
+
+#include <stdlib.h>
+#include <string.h>
+#include "llhttp.h"
+
+typedef struct rb_llhttp_callbacks_s rb_llhttp_callbacks_t;
+
+typedef int (*rb_llhttp_data_cb)(const char *data, size_t length);
+typedef int (*rb_llhttp_cb)();
+
+struct rb_llhttp_callbacks_s {
+  rb_llhttp_cb on_message_begin;
+  rb_llhttp_data_cb on_url;
+  rb_llhttp_data_cb on_status;
+  rb_llhttp_data_cb on_header_field;
+  rb_llhttp_data_cb on_header_value;
+  rb_llhttp_cb on_headers_complete;
+  rb_llhttp_data_cb on_body;
+  rb_llhttp_cb on_message_complete;
+  rb_llhttp_cb on_chunk_header;
+  rb_llhttp_cb on_chunk_complete;
+  rb_llhttp_cb on_url_complete;
+  rb_llhttp_cb on_status_complete;
+  rb_llhttp_cb on_header_field_complete;
+  rb_llhttp_cb on_header_value_complete;
+};
+
+int rb_llhttp_on_message_begin(llhttp_t *parser) {
+  rb_llhttp_callbacks_t* callbacks = parser->data;
+  return callbacks->on_message_begin();
+}
+
+int rb_llhttp_on_url(llhttp_t *parser, char *data, size_t length) {
+  rb_llhttp_callbacks_t* callbacks = parser->data;
+  callbacks->on_url(data, length);
+  return 0;
+}
+
+int rb_llhttp_on_status(llhttp_t *parser, char *data, size_t length) {
+  rb_llhttp_callbacks_t* callbacks = parser->data;
+  callbacks->on_status(data, length);
+  return 0;
+}
+
+int rb_llhttp_on_header_field(llhttp_t *parser, char *data, size_t length) {
+  rb_llhttp_callbacks_t* callbacks = parser->data;
+  callbacks->on_header_field(data, length);
+  return 0;
+}
+
+int rb_llhttp_on_header_value(llhttp_t *parser, char *data, size_t length) {
+  rb_llhttp_callbacks_t* callbacks = parser->data;
+  callbacks->on_header_value(data, length);
+  return 0;
+}
+
+int rb_llhttp_on_headers_complete(llhttp_t *parser) {
+  rb_llhttp_callbacks_t* callbacks = parser->data;
+  return callbacks->on_headers_complete();
+}
+
+int rb_llhttp_on_body(llhttp_t *parser, char *data, size_t length) {
+  rb_llhttp_callbacks_t* callbacks = parser->data;
+  callbacks->on_body(data, length);
+  return 0;
+}
+
+int rb_llhttp_on_message_complete(llhttp_t *parser) {
+  rb_llhttp_callbacks_t* callbacks = parser->data;
+  return callbacks->on_message_complete();
+}
+
+int rb_llhttp_on_chunk_header(llhttp_t *parser) {
+  rb_llhttp_callbacks_t* callbacks = parser->data;
+  return callbacks->on_chunk_header();
+}
+
+int rb_llhttp_on_chunk_complete(llhttp_t *parser) {
+  rb_llhttp_callbacks_t* callbacks = parser->data;
+  callbacks->on_chunk_complete();
+  return 0;
+}
+
+int rb_llhttp_on_url_complete(llhttp_t *parser) {
+  rb_llhttp_callbacks_t* callbacks = parser->data;
+  callbacks->on_url_complete();
+  return 0;
+}
+
+int rb_llhttp_on_status_complete(llhttp_t *parser) {
+  rb_llhttp_callbacks_t* callbacks = parser->data;
+  callbacks->on_status_complete();
+  return 0;
+}
+
+int rb_llhttp_on_header_field_complete(llhttp_t *parser) {
+  rb_llhttp_callbacks_t* callbacks = parser->data;
+  callbacks->on_header_field_complete();
+  return 0;
+}
+
+int rb_llhttp_on_header_value_complete(llhttp_t *parser) {
+  rb_llhttp_callbacks_t* callbacks = parser->data;
+  callbacks->on_header_value_complete();
+  return 0;
+}
+
+llhttp_t* rb_llhttp_init(int type, rb_llhttp_callbacks_t* callbacks) {
+  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);
+
+  if (callbacks->on_message_begin) {
+    settings->on_message_begin = (llhttp_cb)rb_llhttp_on_message_begin;
+  }
+
+  if (callbacks->on_url) {
+    settings->on_url = (llhttp_data_cb)rb_llhttp_on_url;
+  }
+
+  if (callbacks->on_status) {
+    settings->on_status = (llhttp_data_cb)rb_llhttp_on_status;
+  }
+
+  if (callbacks->on_header_field) {
+    settings->on_header_field = (llhttp_data_cb)rb_llhttp_on_header_field;
+  }
+
+  if (callbacks->on_header_value) {
+    settings->on_header_value = (llhttp_data_cb)rb_llhttp_on_header_value;
+  }
+
+  if (callbacks->on_headers_complete) {
+    settings->on_headers_complete = (llhttp_cb)rb_llhttp_on_headers_complete;
+  }
+
+  if (callbacks->on_body) {
+    settings->on_body = (llhttp_data_cb)rb_llhttp_on_body;
+  }
+
+  if (callbacks->on_message_complete) {
+    settings->on_message_complete = (llhttp_cb)rb_llhttp_on_message_complete;
+  }
+
+  if (callbacks->on_chunk_header) {
+    settings->on_chunk_header = (llhttp_cb)rb_llhttp_on_chunk_header;
+  }
+
+  if (callbacks->on_chunk_complete) {
+    settings->on_chunk_complete = (llhttp_cb)rb_llhttp_on_chunk_complete;
+  }
+
+  if (callbacks->on_url_complete) {
+    settings->on_url_complete = (llhttp_cb)rb_llhttp_on_url_complete;
+  }
+
+  if (callbacks->on_status_complete) {
+    settings->on_status_complete = (llhttp_cb)rb_llhttp_on_status_complete;
+  }
+
+  if (callbacks->on_header_field_complete) {
+    settings->on_header_field_complete = (llhttp_cb)rb_llhttp_on_header_field_complete;
+  }
+
+  if (callbacks->on_header_value_complete) {
+    settings->on_header_value_complete = (llhttp_cb)rb_llhttp_on_header_value_complete;
+  }
+
+  llhttp_init(parser, type, settings);
+
+  parser->data = callbacks;
+
+  return parser;
+}
+
+void rb_llhttp_free(llhttp_t* parser) {
+  if (parser) {
+    free(parser->settings);
+    free(parser);
+  }
+}
+
+uint64_t rb_llhttp_content_length(llhttp_t* parser) {
+  return parser->content_length;
+}
+
+const char* rb_llhttp_method_name(llhttp_t* parser) {
+  return llhttp_method_name(parser->method);
+}
+
+uint16_t rb_llhttp_status_code(llhttp_t* parser) {
+  return parser->status_code;
+}
+
+uint16_t rb_llhttp_http_major(llhttp_t* parser) {
+  return parser->http_major;
+}
+
+uint16_t rb_llhttp_http_minor(llhttp_t* parser) {
+  return parser->http_minor;
+}
+
+const char* rb_llhttp_errno_name(llhttp_errno_t errno) {
+  return llhttp_errno_name(errno);
+}
+
+const char* rb_llhttp_error_reason(llhttp_t* parser) {
+  return parser->reason;
+}

data/lib/llhttp.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require "ffi"
+require "ffi-compiler/loader"
+
+module LLHttp
+  require_relative "llhttp/delegate"
+  require_relative "llhttp/error"
+  require_relative "llhttp/parser"
+  require_relative "llhttp/version"
+
+  extend FFI::Library
+  ffi_lib(FFI::Compiler::Loader.find("llhttp-ext"))
+
+  callback :llhttp_data_cb, [:pointer, :size_t], :void
+  callback :llhttp_cb, [], :int
+
+  class Callbacks < FFI::Struct
+    layout :on_message_begin, :llhttp_cb,
+      :on_url, :llhttp_data_cb,
+      :on_status, :llhttp_data_cb,
+      :on_header_field, :llhttp_data_cb,
+      :on_header_value, :llhttp_data_cb,
+      :on_headers_complete, :llhttp_cb,
+      :on_body, :llhttp_data_cb,
+      :on_message_complete, :llhttp_cb,
+      :on_chunk_header, :llhttp_cb,
+      :on_chunk_complete, :llhttp_cb,
+      :on_url_complete, :llhttp_cb,
+      :on_status_complete, :llhttp_cb,
+      :on_header_field_complete, :llhttp_cb,
+      :on_header_value_complete, :llhttp_cb
+  end
+
+  attach_function :rb_llhttp_init, [:int, Callbacks.by_ref], :pointer
+  attach_function :rb_llhttp_content_length, [:pointer], :uint64
+  attach_function :rb_llhttp_method_name, [:pointer], :string
+  attach_function :rb_llhttp_status_code, [:pointer], :uint16
+  attach_function :rb_llhttp_http_major, [:pointer], :uint16
+  attach_function :rb_llhttp_http_minor, [:pointer], :uint16
+  attach_function :rb_llhttp_free, [:pointer], :void
+
+  attach_function :llhttp_execute, [:pointer, :pointer, :size_t], :int
+  attach_function :llhttp_errno_name, [:int], :string
+  attach_function :llhttp_get_error_reason, [:pointer], :string
+  attach_function :llhttp_should_keep_alive, [:pointer], :int
+  attach_function :llhttp_finish, [:pointer], :int
+end

data/lib/llhttp/delegate.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module LLHttp
+  # [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
+    # private def internal_on_message_begin
+    #   on_message_begin
+
+    #   0
+    # rescue
+    #   -1
+    # end
+
+    # private def internal_on_headers_complete
+    #   on_headers_complete
+
+    #   0
+    # rescue
+    #   -1
+    # end
+
+    # private def internal_on_message_complete
+    #   on_message_complete
+
+    #   0
+    # rescue
+    #   -1
+    # end
+
+    # private def internal_on_chunk_header
+    #   on_chunk_header
+
+    #   0
+    # rescue
+    #   -1
+    # end
+  end
+end

data/lib/llhttp/error.rb

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

data/lib/llhttp/parser.rb

@@ -0,0 +1,158 @@
+# frozen_string_literal: true
+
+module LLHttp
+  # [public] Wraps an llhttp context for parsing http requests and responses.
+  #
+  #   class Delegate < LLHttp::Delegate
+  #     def on_message_begin
+  #       ...
+  #     end
+  #
+  #     ...
+  #   end
+  #
+  #   parser = LLHttp::Parser.new(Delegate.new, type: :request)
+  #   parser << "GET / HTTP/1.1\r\n\r\n"
+  #   parser.finish
+  #
+  #   ...
+  #
+  # 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
+
+    CALLBACKS = %i[
+      on_message_begin
+      on_headers_complete
+      on_message_complete
+      on_chunk_header
+      on_chunk_complete
+      on_url_complete
+      on_status_complete
+      on_header_field_complete
+      on_header_value_complete
+    ].freeze
+
+    CALLBACKS_WITH_DATA = %i[
+      on_url
+      on_status
+      on_header_field
+      on_header_value
+      on_body
+    ].freeze
+
+    # [public] The parser type; one of: `:both`, `:request`, or `:response`.
+    #
+    attr_reader :type
+
+    def initialize(delegate, type: :both)
+      @type, @delegate = type.to_sym, delegate
+
+      @callbacks = Callbacks.new
+
+      (CALLBACKS + CALLBACKS_WITH_DATA).each do |callback|
+        if delegate.respond_to?(callback)
+          @callbacks[callback] = method(callback).to_proc
+        end
+      end
+
+      @pointer = LLHttp.rb_llhttp_init(LLHTTP_TYPES.fetch(@type), @callbacks)
+
+      ObjectSpace.define_finalizer(self, self.class.free(@pointer))
+    end
+
+    # [public] Parse the given data.
+    #
+    def parse(data)
+      errno = LLHttp.llhttp_execute(@pointer, data, data.length)
+      raise build_error(errno) if errno > 0
+    end
+    alias_method :<<, :parse
+
+    # [public] Get the content length of the current request.
+    #
+    def content_length
+      LLHttp.rb_llhttp_content_length(@pointer)
+    end
+
+    # [public] Get the method of the current response.
+    #
+    def method_name
+      LLHttp.rb_llhttp_method_name(@pointer)
+    end
+
+    # [public] Get the status code of the current response.
+    #
+    def status_code
+      LLHttp.rb_llhttp_status_code(@pointer)
+    end
+
+    # [public] Get the major http version of the current request/response.
+    #
+    def http_major
+      LLHttp.rb_llhttp_http_major(@pointer)
+    end
+
+    # [public] Get the minor http version of the current request/response.
+    #
+    def http_minor
+      LLHttp.rb_llhttp_http_minor(@pointer)
+    end
+
+    # [public] Returns `true` if there might be more messages.
+    #
+    def keep_alive?
+      LLHttp.llhttp_should_keep_alive(@pointer) == 1
+    end
+
+    # [public] Get ready to parse the next request.
+    #
+    def finish
+      LLHttp.llhttp_finish(@pointer)
+    end
+
+    CALLBACKS.each do |callback|
+      class_eval(
+        <<~RB, __FILE__, __LINE__ + 1
+          private def #{callback}
+            @delegate.#{callback}
+
+            0
+          rescue
+            -1
+          end
+        RB
+      )
+    end
+
+    CALLBACKS_WITH_DATA.each do |callback|
+      class_eval(
+        <<~RB, __FILE__, __LINE__ + 1
+          private def #{callback}(buffer, length)
+            @delegate.#{callback}(buffer.get_bytes(0, length))
+          end
+        RB
+      )
+    end
+
+    private def build_error(errno)
+      Error.new("Error Parsing data: #{LLHttp.llhttp_errno_name(errno)} #{LLHttp.llhttp_get_error_reason(@pointer)}")
+    end
+
+    def self.free(pointer)
+      proc { LLHttp.llhttp_free(@pointer) }
+    end
+  end
+end