webrick 1.8.2 → 1.9.0

data/sig/httprequest.rbs

@@ -0,0 +1,169 @@
+module WEBrick
+  class HTTPRequest
+    @config: Hash[Symbol, untyped]
+
+    @buffer_size: Integer
+
+    @logger: Log
+
+    @query: Hash[String, HTTPUtils::FormData]?
+
+    @form_data: nil
+
+    @body: String
+
+    @remaining_size: Integer?
+
+    @socket: TCPSocket?
+
+    @forwarded_proto: String?
+
+    @host: String?
+
+    @port: Integer?
+
+    @body_tmp: Array[String]
+
+    @body_rd: Fiber
+
+    @request_bytes: Integer
+
+    @forwarded_server: String?
+
+    @forwarded_host: String?
+
+    @forwarded_port: Integer?
+
+    @forwarded_for: String?
+
+    BODY_CONTAINABLE_METHODS: Array[String]
+
+    attr_reader request_line: String?
+
+    attr_reader request_method: String?
+
+    attr_reader unparsed_uri: String?
+
+    attr_reader http_version: HTTPVersion?
+
+    attr_reader request_uri: URI::Generic?
+
+    attr_reader path: String?
+
+    attr_accessor script_name: String?
+
+    attr_accessor path_info: String?
+
+    attr_accessor query_string: String?
+
+    attr_reader raw_header: Array[String]
+
+    attr_reader header: Hash[String, Array[String]]?
+
+    attr_reader cookies: Array[Cookie]
+
+    attr_reader accept: Array[String]
+
+    attr_reader accept_charset: Array[String]
+
+    attr_reader accept_encoding: Array[String]
+
+    attr_reader accept_language: Array[String]
+
+    attr_accessor user: String?
+
+    attr_reader addr: ([String, Integer, String, String] | [])?
+
+    attr_reader peeraddr: ([String, Integer, String, String] | [])?
+
+    attr_reader attributes: Hash[untyped, untyped]
+
+    attr_reader keep_alive: bool
+
+    attr_reader request_time: Time?
+
+    def initialize: (Hash[Symbol, untyped] config) -> void
+
+    def parse: (?TCPSocket? socket) -> void
+
+    def continue: () -> void
+
+    type body_chunk_block = ^(String body_chunk) -> void
+
+    def body: () ?{ (String body_chunk) -> void } -> String
+
+    def body_reader: () -> self
+
+    # for IO.copy_stream.
+    def readpartial: (Integer size, ?String buf) -> String
+
+    def query: () -> Hash[String, HTTPUtils::FormData]
+
+    def content_length: () -> Integer
+
+    def content_type: () -> String?
+
+    def []: (String header_name) -> String?
+
+    def each: [T] () { (String, String) -> T } -> T?
+
+    def host: () -> String?
+
+    def port: () -> Integer?
+
+    def server_name: () -> String?
+
+    def remote_ip: () -> String?
+
+    def ssl?: () -> bool
+
+    def keep_alive?: () -> bool
+
+    def to_s: () -> String
+
+    def fixup: () -> void
+
+    def meta_vars: () -> Hash[String, String]
+
+    private
+
+    MAX_URI_LENGTH: Integer
+
+    # same as Mongrel, Thin and Puma
+    MAX_HEADER_LENGTH: Integer
+
+    def read_request_line: (IO socket) -> void
+
+    def read_header: (IO socket) -> void
+
+    def parse_uri: (String str, ?String scheme) -> URI::Generic
+
+    HOST_PATTERN: Regexp
+
+    def parse_host_request_line: (String host) -> [String, String]
+
+    def read_body: (IO socket, body_chunk_block block) -> String
+                 | (nil socket, top block) -> nil
+
+    def read_chunk_size: (IO socket) -> [Integer, String?]
+
+    def read_chunked: (IO socket, body_chunk_block block) -> void
+
+    def _read_data: (IO io, Symbol method, *untyped arg) -> String?
+
+    def read_line: (IO io, ?Integer size) -> String?
+
+    def read_data: (IO io, Integer size) -> String?
+
+    def parse_query: () -> void
+
+    PrivateNetworkRegexp: Regexp
+
+    # It's said that all X-Forwarded-* headers will contain more than one
+    # (comma-separated) value if the original request already contained one of
+    # these headers. Since we could use these values as Host header, we choose
+    # the initial(first) value. (apr_table_mergen() adds new value after the
+    # existing value with ", " prefix)
+    def setup_forwarded_info: () -> void
+  end
+end

data/sig/httpresponse.rbs

@@ -0,0 +1,117 @@
+module WEBrick
+  class HTTPResponse
+    @buffer_size: Integer
+
+    @logger: Log
+
+    @chunked: bool
+
+    @bodytempfile: File | Tempfile | nil
+
+    class InvalidHeader < StandardError
+    end
+
+    attr_reader http_version: HTTPVersion
+
+    attr_reader status: Integer
+
+    attr_reader header: Hash[String, String]
+
+    attr_reader cookies: Array[Cookie]
+
+    attr_accessor reason_phrase: String
+
+    interface _CallableBody
+      def call: (_Writer) -> void
+    end
+
+    attr_accessor body: String | _ReaderPartial | _CallableBody
+
+    attr_accessor request_method: String?
+
+    attr_accessor request_uri: URI::Generic?
+
+    attr_accessor request_http_version: HTTPVersion?
+
+    attr_accessor filename: String?
+
+    attr_accessor keep_alive: bool
+
+    attr_reader config: Hash[Symbol, untyped]
+
+    attr_reader sent_size: Integer
+
+    attr_accessor upgrade: String?
+
+    def initialize: (Hash[Symbol, untyped] config) -> void
+
+    def status_line: () -> String
+
+    def status=: (Integer status) -> Integer
+
+    def []: (String field) -> String?
+
+    def []=: (String field, _ToS value) -> _ToS
+
+    def content_length: () -> Integer?
+
+    def content_length=: (Integer len) -> Integer
+
+    def content_type: () -> String?
+
+    def content_type=: (String type) -> String
+
+    def each: () { (String, String) -> void } -> void
+
+    def chunked?: () -> bool
+
+    def chunked=: (boolish val) -> boolish
+
+    def keep_alive?: () -> bool
+
+    def upgrade!: (String protocol) -> void
+
+    def send_response: (_Writer socket) -> void
+
+    def setup_header: () -> void
+
+    def make_body_tempfile: () -> void
+
+    def remove_body_tempfile: () -> void
+
+    def send_header: (_Writer socket) -> void
+
+    def send_body: (_Writer socket) -> void
+
+    def set_redirect: (singleton(WEBrick::HTTPStatus::Redirect) status, URI::Generic | String url) -> bot
+
+    def set_error: (singleton(Exception) ex, ?bool backtrace) -> void
+
+    private
+
+    def check_header: (_ToS header_value) -> String
+
+    def error_body: (bool backtrace, singleton(Exception) ex, String? host, Integer? port) -> void
+
+    def send_body_io: (_Writer socket) -> void
+
+    def send_body_string: (_Writer socket) -> void
+
+    def send_body_proc: (_Writer socket) -> void
+
+    class ChunkedWrapper
+      @socket: _Writer
+
+      @resp: HTTPResponse
+
+      def initialize: (_Writer socket, HTTPResponse resp) -> void
+
+      def write: (_ToS buf) -> Integer
+
+      def <<: (*_ToS buf) -> self
+    end
+
+    # preserved for compatibility with some 3rd-party handlers
+    def _write_data: [T] (T socket, _ToS data) -> T
+  end
+end

data/sig/https.rbs

@@ -0,0 +1,49 @@
+module WEBrick
+  class HTTPRequest
+    @client_cert_chain: Array[OpenSSL::X509::Certificate]
+
+    attr_reader cipher: [String, String, Integer, Integer]?
+
+    attr_reader server_cert: OpenSSL::X509::Certificate
+
+    attr_reader client_cert: OpenSSL::X509::Certificate?
+
+    alias orig_parse parse
+
+    def parse: (?(TCPSocket | OpenSSL::SSL::SSLSocket)? socket) -> void
+             | ...
+
+    alias orig_parse_uri parse_uri
+
+    private
+
+    def parse_uri: (String str, ?::String scheme) -> URI::Generic
+                 | ...
+
+    public
+
+    alias orig_meta_vars meta_vars
+
+    def meta_vars: () -> Hash[String, String]
+                 | ...
+  end
+
+  class SNIRequest
+    attr_reader host: String?
+
+    attr_reader addr: [String, Integer, String, String]
+
+    attr_reader port: Integer
+
+    def initialize: (OpenSSL::SSL::SSLSocket sslsocket, ?String? hostname) -> void
+  end
+
+  class HTTPServer < ::WEBrick::GenericServer
+    def ssl_servername_callback: (OpenSSL::SSL::SSLSocket sslsocket, ?String? hostname) -> OpenSSL::SSL::SSLContext?
+
+    alias orig_virtual_host virtual_host
+
+    def virtual_host: (instance server) -> void
+                    | ...
+  end
+end

data/sig/httpserver.rbs

@@ -0,0 +1,71 @@
+module WEBrick
+  class HTTPServerError < ServerError
+  end
+
+  class HTTPServer < ::WEBrick::GenericServer
+    @http_version: HTTPVersion
+
+    @mount_tab: MountTable
+
+    @virtual_hosts: Array[untyped]
+
+    def initialize: (?Hash[Symbol, untyped] config, ?Hash[Symbol, untyped] default) -> void
+
+    def run: (TCPSocket sock) -> void
+
+    def service: (HTTPRequest req, HTTPResponse res) -> void
+
+    def do_OPTIONS: (HTTPRequest req, HTTPResponse res) -> void
+
+    def mount: (String dir, singleton(HTTPServlet::AbstractServlet) servlet, *untyped options) -> void
+
+    def mount_proc: (String dir, ?HTTPServlet::ProcHandler::_Callable proc) -> void
+                  | (String dir, ?nil proc) { (HTTPRequest, HTTPResponse) -> void } -> void
+
+    def unmount: (String dir) -> MountTable::value_type
+
+    alias umount unmount
+
+    def search_servlet: (String path) -> [singleton(HTTPServlet::AbstractServlet), Array[untyped], String, String]?
+
+    def virtual_host: (instance server) -> void
+
+    def lookup_server: (HTTPRequest req) -> instance?
+
+    def access_log: (Hash[Symbol, untyped] config, HTTPRequest req, HTTPResponse res) -> void
+
+    #
+    # Creates the HTTPRequest used when handling the HTTP
+    # request. Can be overridden by subclasses.
+    def create_request: (Hash[Symbol, untyped] with_webrick_config) -> HTTPRequest
+
+    #
+    # Creates the HTTPResponse used when handling the HTTP
+    # request. Can be overridden by subclasses.
+    def create_response: (Hash[Symbol, untyped] with_webrick_config) -> HTTPResponse
+
+    class MountTable
+      type value_type = [singleton(HTTPServlet::AbstractServlet), Array[untyped]]
+
+      @tab: Hash[String, value_type]
+
+      @scanner: Regexp
+
+      def initialize: () -> void
+
+      def []: (String dir) -> value_type
+
+      def []=: (String dir, value_type val) -> value_type
+
+      def delete: (String dir) -> value_type
+
+      def scan: (String path) -> [String, String]
+
+      private
+
+      def compile: () -> void
+
+      def normalize: (String dir) -> String
+    end
+  end
+end

data/sig/httpservlet/abstract.rbs

@@ -0,0 +1,36 @@
+module WEBrick
+  module HTTPServlet
+    class HTTPServletError < StandardError
+    end
+
+    class AbstractServlet
+      @server: HTTPServer
+
+      interface _Config
+        def []: (Symbol) -> untyped
+      end
+
+      @config: _Config
+
+      @logger: Log
+
+      @options: untyped # Array[untyped] causes RBS::InstanceVariableTypeError
+
+      def self.get_instance: (HTTPServer server, *untyped options) -> instance
+
+      def initialize: (HTTPServer server, *untyped options) -> void
+
+      def service: (HTTPRequest req, HTTPResponse res) -> void
+
+      def do_GET: (HTTPRequest req, HTTPResponse res) -> bot
+
+      def do_HEAD: (HTTPRequest req, HTTPResponse res) -> bot
+
+      def do_OPTIONS: (HTTPRequest req, HTTPResponse res) -> void
+
+      private
+
+      def redirect_to_directory_uri: (HTTPRequest req, HTTPResponse res) -> void
+    end
+  end
+end

data/sig/httpservlet/cgi_runner.rbs

@@ -0,0 +1,3 @@
+class Object
+  def sysread: (IO io, Integer size) -> String
+end

data/sig/httpservlet/cgihandler.rbs

@@ -0,0 +1,23 @@
+module WEBrick
+  module HTTPServlet
+    class CGIHandler < AbstractServlet
+      @script_filename: String
+
+      @tempdir: String?
+
+      @cgicmd: Array[String] | String
+
+      Ruby: String
+
+      CGIRunner: String
+
+      CGIRunnerArray: [String, String]
+
+      def initialize: (HTTPServer server, String name) -> void
+
+      def do_GET: (HTTPRequest req, HTTPResponse res) -> void
+
+      alias do_POST do_GET
+    end
+  end
+end

data/sig/httpservlet/erbhandler.rbs

@@ -0,0 +1,17 @@
+module WEBrick
+  module HTTPServlet
+    class ERBHandler < AbstractServlet
+      @script_filename: String
+
+      def initialize: (HTTPServer server, String name) -> void
+
+      def do_GET: (HTTPRequest req, HTTPResponse res) -> void
+
+      alias do_POST do_GET
+
+      private
+
+      def evaluate: (ERB erb, HTTPRequest servlet_request, HTTPResponse servlet_response) -> String
+    end
+  end
+end

data/sig/httpservlet/filehandler.rbs

@@ -0,0 +1,76 @@
+module WEBrick
+  module HTTPServlet
+    class DefaultFileHandler < AbstractServlet
+      @local_path: String
+
+      def initialize: (HTTPServer server, String local_path) -> void
+
+      def do_GET: (HTTPRequest req, HTTPResponse res) -> void
+
+      def not_modified?: (HTTPRequest req, HTTPResponse res, Time mtime, String etag) -> bool
+
+      # returns a lambda for webrick/httpresponse.rb send_body_proc
+      def multipart_body: (File body, Array[[Numeric, Numeric]] parts, String boundary, String mtype, Integer filesize) -> HTTPResponse::_CallableBody
+
+      def make_partial_content: (HTTPRequest req, HTTPResponse res, String filename, Integer filesize) -> void
+
+      def prepare_range: (Range[Integer] range, Integer filesize) -> [Numeric, Numeric]
+    end
+
+    class FileHandler < AbstractServlet
+      @config: AbstractServlet::_Config
+
+      @logger: Log
+
+      @root: String
+
+      @options: Hash[Symbol, untyped]
+
+      HandlerTable: Hash[String, singleton(AbstractServlet)]
+
+      def self.add_handler: (String suffix, singleton(AbstractServlet) handler) -> singleton(AbstractServlet)
+
+      def self.remove_handler: (String suffix) -> singleton(AbstractServlet)
+
+      def initialize: (HTTPServer server, String root, ?Hash[Symbol, untyped] options, ?Hash[Symbol, untyped] default) -> void
+
+      def set_filesystem_encoding: (String str) -> String
+
+      def service: (HTTPRequest req, HTTPResponse res) -> void
+
+      def do_GET: (HTTPRequest req, HTTPResponse res) -> void
+
+      def do_POST: (HTTPRequest req, HTTPResponse res) -> void
+
+      def do_OPTIONS: (HTTPRequest req, HTTPResponse res) -> void
+
+      private
+
+      def trailing_pathsep?: (String path) -> bool
+
+      def prevent_directory_traversal: (HTTPRequest req, HTTPResponse res) -> void
+
+      def exec_handler: (HTTPRequest req, HTTPResponse res) -> bool
+
+      def get_handler: (HTTPRequest req, HTTPResponse res) -> singleton(AbstractServlet)
+
+      def set_filename: (HTTPRequest req, HTTPResponse res) -> bool
+
+      def check_filename: (HTTPRequest req, HTTPResponse res, String name) -> void
+
+      def shift_path_info: (HTTPRequest req, HTTPResponse res, String path_info, ?String? base) -> void
+
+      def search_index_file: (HTTPRequest req, HTTPResponse res) -> String?
+
+      def search_file: (HTTPRequest req, HTTPResponse res, String basename) -> String?
+
+      def call_callback: (Symbol callback_name, HTTPRequest req, HTTPResponse res) -> void
+
+      def windows_ambiguous_name?: (String name) -> bool
+
+      def nondisclosure_name?: (String name) -> bool
+
+      def set_dir_list: (HTTPRequest req, HTTPResponse res) -> void
+    end
+  end
+end

data/sig/httpservlet/prochandler.rbs

@@ -0,0 +1,21 @@
+module WEBrick
+  module HTTPServlet
+    class ProcHandler < AbstractServlet
+      interface _Callable
+        def call: (WEBrick::HTTPRequest, WEBrick::HTTPResponse) -> void
+      end
+
+      @proc: _Callable
+
+      def get_instance: (HTTPServer server, *untyped options) -> self
+
+      def initialize: (_Callable proc) -> void
+
+      def do_GET: (HTTPRequest request, HTTPResponse response) -> void
+
+      alias do_POST do_GET
+
+      alias do_PUT do_GET
+    end
+  end
+end

data/sig/httpservlet.rbs

@@ -0,0 +1,4 @@
+module WEBrick
+  module HTTPServlet
+  end
+end