Class: WEBrick::HTTPServer

Relationships & Source Files
Namespace Children
Classes: `MountTable`
Extension / Inclusion / Inheritance Descendants
Subclasses: HTTPProxyServer
Super Chains via Extension / Inclusion / Inheritance
Class Chain: self, `GenericServer`
Instance Chain: self, `GenericServer`
Inherits:	WEBrick::GenericServer Object WEBrick::GenericServer WEBrick::HTTPServer
Defined in:	lib/webrick/https.rb, lib/webrick/httpserver.rb

Class Method Summary

.new(config = {}, default = Config::HTTP) ⇒ HTTPServer constructor

Creates a new HTTP server according to config

`GenericServer` - Inherited

.new	Creates a new generic server from `config`.

Instance Attribute Summary

`GenericServer` - Inherited

#config	The server configuration.
#listeners	Sockets listening for connections.
#logger	The server logger.
#status	The server status.
#tokens	Tokens control the number of outstanding clients.

Instance Method Summary

#access_log(config, req, res)

Logs req and res in the access logs.
#create_request(with_webrick_config)

Creates the HTTPRequest used when handling the HTTP request.
#create_response(with_webrick_config)

Creates the HTTPResponse used when handling the HTTP request.
#do_OPTIONS(req, res)

The default OPTIONS request handler says GET, HEAD, POST and OPTIONS requests are allowed.
#lookup_server(req)

Finds the appropriate virtual host to handle req
#mount(dir, servlet, *options)

Mounts servlet on dir passing options to the servlet at creation time.
#mount_proc(dir, proc = nil, &block)

Mounts proc or block on dir and calls it with a HTTPRequest and HTTPResponse
#run(sock)

Processes requests on sock
#search_servlet(path)

Finds a servlet for path
#service(req, res)

Services req and fills in res
#ssl_servername_callback(sslsocket, hostname = nil)

ServerNameIndication callback.
#umount(dir)

Alias for #unmount.
#unmount(dir) (also: #umount)

Unmounts dir
#orig_virtual_host Internal use only

Check whether server is also SSL server.
#virtual_host(server) Internal use only

Adds server as a virtual host.

`GenericServer` - Inherited

#[]	Retrieves `key` from the configuration.
#run	You must subclass `GenericServer` and implement #run which accepts a TCP client socket.
#shutdown	Shuts down the server and all listening sockets.
#ssl_servername_callback	ServerNameIndication callback.
#start	Starts the server and runs the `block` for each connection.
#stop	Stops the server from accepting new connections.
#listen	Updates `listen` to enable SSL when the SSL configuration is active.
#setup_ssl_context	Sets up an SSL context for `config`
#ssl_context	SSL context for the server when run in SSL mode.
#accept_client	Accepts a TCP client socket from the TCP server socket `svr` and returns the client socket.
#alarm_shutdown_pipe,
#call_callback	Calls the callback `callback_name` from the configuration with `args`
#cleanup_listener, #cleanup_shutdown_pipe, #setup_shutdown_pipe,
#start_thread	Starts a server thread for the client socket `sock` that runs the given `block`.

Constructor Details

.new(config = {}, default = Config::HTTP) ⇒ `HTTPServer`

Creates a new HTTP server according to config

An HTTP server uses the following attributes:

:AccessLog: An array of access logs. See AccessLog
:BindAddress: Local address for the server to bind to
:DocumentRoot: Root path to serve files from
:DocumentRootOptions: Options for the default HTTPServlet::FileHandler
:HTTPVersion: The HTTP version of this server
:Port: Port to listen on
:RequestCallback: Called with a request and response before each request is serviced.
:RequestTimeout: Maximum time to wait between requests
:ServerAlias: Array of alternate names for this server for virtual hosting
:ServerName: Name for this server for virtual hosting

[ GitHub ]

# File 'lib/webrick/httpserver.rb', line 46


def initialize(config={}, default=Config::HTTP)
  super(config, default)
  @http_version = HTTPVersion::convert(@config[:HTTPVersion])

  @mount_tab = MountTable.new
  if @config[:DocumentRoot]
    mount("/", HTTPServlet::FileHandler, @config[:DocumentRoot],
          @config[:DocumentRootOptions])
  end

  unless @config[:AccessLog]
    @config[:AccessLog] = [
      [ $stderr, AccessLog::COMMON_LOG_FORMAT ],
      [ $stderr, AccessLog::REFERER_LOG_FORMAT ]
    ]
  end

  @virtual_hosts = Array.new
end

Instance Method Details

#access_log(config, req, res)

Logs req and res in the access logs. config is used for the server name.

[ GitHub ]

# File 'lib/webrick/httpserver.rb', line 220


def access_log(config, req, res)
  param = AccessLog::setup_params(config, req, res)
  @config[:AccessLog].each{|logger, fmt|
    logger << AccessLog::format(fmt+"\n", param)
  }
end

#create_request(with_webrick_config)

Creates the HTTPRequest used when handling the HTTP request. Can be overridden by subclasses.

[ GitHub ]

# File 'lib/webrick/httpserver.rb', line 230


def create_request(with_webrick_config)
  HTTPRequest.new(with_webrick_config)
end

#create_response(with_webrick_config)

Creates the HTTPResponse used when handling the HTTP request. Can be overridden by subclasses.

[ GitHub ]

# File 'lib/webrick/httpserver.rb', line 237


def create_response(with_webrick_config)
  HTTPResponse.new(with_webrick_config)
end

#do_OPTIONS(req, res)

The default OPTIONS request handler says GET, HEAD, POST and OPTIONS requests are allowed.

[ GitHub ]

# File 'lib/webrick/httpserver.rb', line 147


def do_OPTIONS(req, res)
  res["allow"] = "GET,HEAD,POST,OPTIONS"
end

#lookup_server(req)

Finds the appropriate virtual host to handle req

[ GitHub ]

# File 'lib/webrick/httpserver.rb', line 207


def lookup_server(req)
  @virtual_hosts.find{|s|
    (s[:BindAddress].nil? || req.addr[3] == s[:BindAddress]) &&
    (s[:Port].nil?        || req.port == s[:Port])           &&
    ((s[:ServerName].nil?  || req.host == s[:ServerName]) ||
     (!s[:ServerAlias].nil? && s[:ServerAlias].find{|h| h === req.host}))
  }
end

#mount(dir, servlet, *options)

Mounts servlet on dir passing options to the servlet at creation time

[ GitHub ]

# File 'lib/webrick/httpserver.rb', line 155


def mount(dir, servlet, *options)
  @logger.debug(sprintf("%s is mounted on %s.", servlet.inspect, dir))
  @mount_tab[dir] = [ servlet, options ]
end

#mount_proc(dir, proc = nil, &block)

Mounts proc or block on dir and calls it with a HTTPRequest and HTTPResponse

Raises:

(HTTPServerError)

[ GitHub ]

# File 'lib/webrick/httpserver.rb', line 164


def mount_proc(dir, proc=nil, &block)
  proc ||= block
  raise HTTPServerError, "must pass a proc or block" unless proc
  mount(dir, HTTPServlet::ProcHandler.new(proc))
end

#orig_virtual_host

This method is for internal use only.

Check whether server is also SSL server. Also server‘s SSL context will be created.

[ GitHub ]

# File 'lib/webrick/https.rb', line 141


alias orig_virtual_host virtual_host

#run(sock)

Processes requests on sock

[ GitHub ]

# File 'lib/webrick/httpserver.rb', line 69


def run(sock)
  while true
    req = create_request(@config)
    res = create_response(@config)
    server = self
    begin
      timeout = @config[:RequestTimeout]
      while timeout > 0
        break if sock.to_io.wait_readable(0.5)
        break if @status != :Running
        timeout -= 0.5
      end
      raise HTTPStatus::EOFError if timeout <= 0 || @status != :Running
      raise HTTPStatus::EOFError if sock.eof?
      req.parse(sock)
      res.request_method = req.request_method
      res.request_uri = req.request_uri
      res.request_http_version = req.http_version
      res.keep_alive = req.keep_alive?
      server = lookup_server(req) || self
      if callback = server[:RequestCallback]
        callback.call(req, res)
      elsif callback = server[:RequestHandler]
        msg = ":RequestHandler is deprecated, please use :RequestCallback"
        @logger.warn(msg)
        callback.call(req, res)
      end
      server.service(req, res)
    rescue HTTPStatus::EOFError, HTTPStatus::RequestTimeout => ex
      res.set_error(ex)
    rescue HTTPStatus::Error => ex
      @logger.error(ex.message)
      res.set_error(ex)
    rescue HTTPStatus::Status => ex
      res.status = ex.code
    rescue StandardError => ex
      @logger.error(ex)
      res.set_error(ex, true)
    ensure
      if req.request_line
        if req.keep_alive? && res.keep_alive?
          req.fixup()
        end
        res.send_response(sock)
        server.access_log(@config, req, res)
      end
    end
    break if @http_version < "1.1"
    break unless req.keep_alive?
    break unless res.keep_alive?
  end
end

#search_servlet(path)

Finds a servlet for path

[ GitHub ]

# File 'lib/webrick/httpserver.rb', line 182


def search_servlet(path)
  script_name, path_info = @mount_tab.scan(path)
  servlet, options = @mount_tab[script_name]
  if servlet
    [ servlet, options, script_name, path_info ]
  end
end

#service(req, res)

Services req and fills in res

Raises:

(HTTPStatus::NotFound)

[ GitHub ]

# File 'lib/webrick/httpserver.rb', line 125


def service(req, res)
  if req.unparsed_uri == "*"
    if req.request_method == "OPTIONS"
      do_OPTIONS(req, res)
      raise HTTPStatus::OK
    end
    raise HTTPStatus::NotFound, "`#{req.unparsed_uri}' not found."
  end

  servlet, options, script_name, path_info = search_servlet(req.path)
  raise HTTPStatus::NotFound, "`#{req.path}' not found." unless servlet
  req.script_name = script_name
  req.path_info = path_info
  si = servlet.get_instance(self, *options)
  @logger.debug(format("%s is invoked.", si.class.name))
  si.service(req, res)
end

#ssl_servername_callback(sslsocket, hostname = nil)

ServerNameIndication callback

[ GitHub ]

# File 'lib/webrick/https.rb', line 129


def ssl_servername_callback(sslsocket, hostname = nil)
  req = SNIRequest.new(sslsocket, hostname)
  server = lookup_server(req)
  server ? server.ssl_context : nil
end

#umount(dir)

Alias for #unmount.

[ GitHub ]

# File 'lib/webrick/httpserver.rb', line 177


alias umount unmount

#unmount(dir) Also known as: #umount

Unmounts dir

[ GitHub ]

# File 'lib/webrick/httpserver.rb', line 173


def unmount(dir)
  @logger.debug(sprintf("unmount %s.", dir))
  @mount_tab.delete(dir)
end

#virtual_host(server)

This method is for internal use only.

Adds server as a virtual host.

[ GitHub ]

# File 'lib/webrick/httpserver.rb', line 193


def virtual_host(server)
  if @config[:SSLEnable] && !server.ssl_context
    raise ArgumentError, "virtual host must set SSLEnable to true"
  end
  orig_virtual_host(server)
end

Class: WEBrick::HTTPServer

Class Method Summary

GenericServer - Inherited

Instance Attribute Summary

GenericServer - Inherited

Instance Method Summary

GenericServer - Inherited

Constructor Details

.new(config = {}, default = Config::HTTP) ⇒ HTTPServer

Instance Method Details

#access_log(config, req, res)

#create_request(with_webrick_config)

#create_response(with_webrick_config)

#do_OPTIONS(req, res)

#lookup_server(req)

#mount(dir, servlet, *options)

#mount_proc(dir, proc = nil, &block)

#orig_virtual_host

#run(sock)

#search_servlet(path)

#service(req, res)

#ssl_servername_callback(sslsocket, hostname = nil)

#umount(dir)

#unmount(dir) Also known as: #umount

#virtual_host(server)

`GenericServer` - Inherited

`GenericServer` - Inherited

`GenericServer` - Inherited

.new(config = {}, default = Config::HTTP) ⇒ `HTTPServer`