123456789_123456789_123456789_123456789_123456789_

Class: Puma::Client

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Forwardable
Instance Chain:
self, Const
Inherits: Object
Defined in: lib/puma/client.rb

Overview

An instance of this class represents a unique request from a client. For example, this could be a web request from a browser or from CURL.

An instance of Client can be used as if it were an ::IO object by the reactor. The reactor is expected to call #to_io on any non-IO objects it polls. For example, nio4r internally calls IO.try_convert (which may call #to_io) when a new socket is registered.

Instances of this class are responsible for knowing if the header and body are fully buffered via the #try_to_finish method. They can be used to “time out” a response via the #timeout_at reader.

Constant Summary

Const - Included

BANNED_HEADER_KEY, CGI_VER, CHUNKED, CHUNK_SIZE, CLOSE, CLOSE_CHUNKED, CODE_NAME, COLON, CONNECTION_CLOSE, CONNECTION_KEEP_ALIVE, CONTENT_LENGTH, CONTENT_LENGTH2, CONTENT_LENGTH_S, CONTINUE, DQUOTE, EARLY_HINTS, ERROR_RESPONSE, FAST_TRACK_KA_TIMEOUT, FIRST_DATA_TIMEOUT, GATEWAY_INTERFACE, HALT_COMMAND, HEAD, HIJACK, HIJACK_IO, HIJACK_P, HTTP, HTTPS, HTTPS_KEY, HTTP_10_200, HTTP_11, HTTP_11_100, HTTP_11_200, HTTP_CONNECTION, HTTP_EXPECT, HTTP_HEADER_DELIMITER, HTTP_HOST, HTTP_VERSION, HTTP_X_FORWARDED_FOR, HTTP_X_FORWARDED_PROTO, HTTP_X_FORWARDED_SCHEME, HTTP_X_FORWARDED_SSL, ILLEGAL_HEADER_KEY_REGEX, ILLEGAL_HEADER_VALUE_REGEX, KEEP_ALIVE, LINE_END, LOCALHOST, LOCALHOST_IPV4, LOCALHOST_IPV6, MAX_BODY, MAX_FAST_INLINE, MAX_HEADER, NEWLINE, PATH_INFO, PERSISTENT_TIMEOUT, PORT_443, PORT_80, PROXY_PROTOCOL_V1_REGEX, PUMA_CONFIG, PUMA_PEERCERT, PUMA_SERVER_STRING, PUMA_SOCKET, PUMA_TMP_BASE, PUMA_VERSION, QUERY_STRING, RACK_AFTER_REPLY, RACK_INPUT, RACK_URL_SCHEME, REMOTE_ADDR, REQUEST_METHOD, REQUEST_PATH, REQUEST_URI, RESTART_COMMAND, SERVER_NAME, SERVER_PORT, SERVER_PROTOCOL, SERVER_SOFTWARE, STOP_COMMAND, TRANSFER_ENCODING, TRANSFER_ENCODING2, TRANSFER_ENCODING_CHUNKED, UNSPECIFIED_IPV4, UNSPECIFIED_IPV6, WRITE_TIMEOUT

Class Method Summary

Instance Attribute Summary

Instance Method Summary

Constructor Details

.new(io, env = nil) ⇒ Client

[ GitHub ]

  
# File 'lib/puma/client.rb', line 62

def initialize(io, env=nil)
  @io = io
  @to_io = io.to_io
  @proto_env = env
  if !env
    @env = nil
  else
    @env = env.dup
  end

  @parser = HttpParser.new
  @parsed_bytes = 0
  @read_header = true
  @read_proxy = false
  @ready = false

  @body = nil
  @body_read_start = nil
  @buffer = nil
  @tempfile = nil

  @timeout_at = nil

  @requests_served = 0
  @hijacked = false

  @peerip = nil
  @peer_family = nil
  @listener = nil
  @remote_addr_header = nil
  @expect_proxy_proto = false

  @body_remain = 0

  @in_last_chunk = false
end

Instance Attribute Details

#body (readonly)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 99

attr_reader :env, :to_io, :body, :io, :timeout_at, :ready, :hijacked,
            :tempfile

#can_close?Boolean (readonly)

Returns true if the persistent connection can be closed immediately without waiting for the configured idle/shutdown timeout.

Version:

  • 5.0.0

[ GitHub ]

  
# File 'lib/puma/client.rb', line 299

def can_close?
  # Allow connection to close if we're not in the middle of parsing a request.
  @parsed_bytes == 0
end

#env (readonly)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 99

attr_reader :env, :to_io, :body, :io, :timeout_at, :ready, :hijacked,
            :tempfile

#expect_proxy_proto=(val) (writeonly)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 304

def expect_proxy_proto=(val)
  if val
    if @read_header
      @read_proxy = true
    end
  else
    @read_proxy = false
  end
  @expect_proxy_proto = val
end

#hijacked (readonly)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 99

attr_reader :env, :to_io, :body, :io, :timeout_at, :ready, :hijacked,
            :tempfile

#in_data_phase (readonly)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 127

def in_data_phase
  !(@read_header || @read_proxy)
end

#inspect (readonly)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 115

def inspect
  "#<Puma::Client:0x#{object_id.to_s(16)} @ready=#{@ready.inspect}>"
end

#io (readonly)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 99

attr_reader :env, :to_io, :body, :io, :timeout_at, :ready, :hijacked,
            :tempfile

#io_ok?Boolean (readonly)

Test to see if io meets a bare minimum of functioning, @to_io needs to be used for MiniSSL::Socket

[ GitHub ]

  
# File 'lib/puma/client.rb', line 110

def io_ok?
  @to_io.is_a?(::BasicSocket) && !closed?
end

#listener (rw)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 104

attr_accessor :remote_addr_header, :listener

#peerip (rw)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 273

def peerip
  return @peerip if @peerip

  if @remote_addr_header
    hdr = (@env[@remote_addr_header] || @io.peeraddr.last).split(/[\s,]/).first
    @peerip = hdr
    return hdr
  end

  @peerip ||= @io.peeraddr.last
end

#peerip=(value) (rw)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 102

attr_writer :peerip

#ready (readonly)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 99

attr_reader :env, :to_io, :body, :io, :timeout_at, :ready, :hijacked,
            :tempfile

#remote_addr_header (rw)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 104

attr_accessor :remote_addr_header, :listener

#tempfile (readonly)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 99

attr_reader :env, :to_io, :body, :io, :timeout_at, :ready, :hijacked,
            :tempfile

#timeout_at (readonly)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 99

attr_reader :env, :to_io, :body, :io, :timeout_at, :ready, :hijacked,
            :tempfile

#to_io (readonly)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 99

attr_reader :env, :to_io, :body, :io, :timeout_at, :ready, :hijacked,
            :tempfile

Instance Method Details

#call

For the hijack protocol (allows us to just put the Client object into the env)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 121

def call
  @hijacked = true
  env[HIJACK_IO] ||= @io
end

#close

[ GitHub ]

  
# File 'lib/puma/client.rb', line 178

def close
  begin
    @io.close
  rescue IOError, Errno::EBADF
    Puma::Util.purge_interrupt_queue
  end
end

#decode_chunk(chunk) (private)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 491

def decode_chunk(chunk)
  if @partial_part_left > 0
    if @partial_part_left <= chunk.size
      if @partial_part_left > 2
        write_chunk(chunk[0..(@partial_part_left-3)]) # skip the \r\n
      end
      chunk = chunk[@partial_part_left..-1]
      @partial_part_left = 0
    else
      if @partial_part_left > 2
        if @partial_part_left == chunk.size + 1
          # Don't include the last \r
          write_chunk(chunk[0..(@partial_part_left-3)])
        else
          # don't include the last \r\n
          write_chunk(chunk)
        end
      end
      @partial_part_left -= chunk.size
      return false
    end
  end

  if @prev_chunk.empty?
    io = StringIO.new(chunk)
  else
    io = StringIO.new(@prev_chunk+chunk)
    @prev_chunk = ""
  end

  while !io.eof?
    line = io.gets
    if line.end_with?("\r\n")
      # Puma doesn't process chunk extensions, but should parse if they're
      # present, which is the reason for the semicolon regex
      chunk_hex = line.strip[/\A[^;]+/]
      if chunk_hex =~ CHUNK_SIZE_INVALID
        raise HttpParserError, "Invalid chunk size: '#{chunk_hex}'"
      end
      len = chunk_hex.to_i(16)
      if len == 0
        @in_last_chunk = true
        @body.rewind
        rest = io.read
        last_crlf_size = "\r\n".bytesize
        if rest.bytesize < last_crlf_size
          @buffer = nil
          @partial_part_left = last_crlf_size - rest.bytesize
          return false
        else
          @buffer = rest[last_crlf_size..-1]
          @buffer = nil if @buffer.empty?
          set_ready
          return true
        end
      end

      len += 2

      part = io.read(len)

      unless part
        @partial_part_left = len
        next
      end

      got = part.size

      case
      when got == len
        # proper chunked segment must end with "\r\n"
        if part.end_with? CHUNK_VALID_ENDING
          write_chunk(part[0..-3]) # to skip the ending \r\n
        else
          raise HttpParserError, "Chunk size mismatch"
        end
      when got <= len - 2
        write_chunk(part)
        @partial_part_left = len - part.size
      when got == len - 1 # edge where we get just \r but not \n
        write_chunk(part[0..-2])
        @partial_part_left = len - part.size
      end
    else
      @prev_chunk = line
      return false
    end
  end

  if @in_last_chunk
    set_ready
    true
  else
    false
  end
end

#eagerly_finish

[ GitHub ]

  
# File 'lib/puma/client.rb', line 250

def eagerly_finish
  return true if @ready
  return false unless @to_io.wait_readable(0)
  try_to_finish
end

#finish(timeout)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 256

def finish(timeout)
  return if @ready
  @to_io.wait_readable(timeout) || timeout! until try_to_finish
end

#peer_family

[ GitHub ]

  
# File 'lib/puma/client.rb', line 285

def peer_family
  return @peer_family if @peer_family

  @peer_family ||= begin
                     @io.local_address.afamily
                   rescue
                     Socket::AF_INET
                   end
end

#read_body (private)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 399

def read_body
  if @chunked_body
    return read_chunked_body
  end

  # Read an odd sized chunk so we can read even sized ones
  # after this
  remain = @body_remain

  if remain > CHUNK_SIZE
    want = CHUNK_SIZE
  else
    want = remain
  end

  begin
    chunk = @io.read_nonblock(want)
  rescue IO::WaitReadable
    return false
  rescue SystemCallError, IOError
    raise ConnectionError, "Connection error detected during read"
  end

  # No chunk means a closed socket
  unless chunk
    @body.close
    @buffer = nil
    set_ready
    raise EOFError
  end

  remain -= @body.write(chunk)

  if remain <= 0
    @body.rewind
    @buffer = nil
    set_ready
    return true
  end

  @body_remain = remain

  false
end

#read_chunked_body (private)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 444

def read_chunked_body
  while true
    begin
      chunk = @io.read_nonblock(4096)
    rescue IO::WaitReadable
      return false
    rescue SystemCallError, IOError
      raise ConnectionError, "Connection error detected during read"
    end

    # No chunk means a closed socket
    unless chunk
      @body.close
      @buffer = nil
      set_ready
      raise EOFError
    end

    if decode_chunk(chunk)
      @env[CONTENT_LENGTH] = @chunked_content_length.to_s
      return true
    end
  end
end

#reset(fast_check = true)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 140

def reset(fast_check=true)
  @parser.reset
  @read_header = true
  @read_proxy = !!@expect_proxy_proto
  @env = @proto_env.dup
  @body = nil
  @tempfile = nil
  @parsed_bytes = 0
  @ready = false
  @body_remain = 0
  @peerip = nil if @remote_addr_header
  @in_last_chunk = false

  if @buffer
    return false unless try_to_parse_proxy_protocol

    @parsed_bytes = @parser.execute(@env, @buffer, @parsed_bytes)

    if @parser.finished?
      return setup_body
    elsif @parsed_bytes >= MAX_HEADER
      raise HttpParserError,
        "HEADER is longer than allowed, aborting client early."
    end

    return false
  else
    begin
      if fast_check && @to_io.wait_readable(FAST_TRACK_KA_TIMEOUT)
        return try_to_finish
      end
    rescue IOError
      # swallow it
    end

  end
end

#set_ready (private)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 588

def set_ready
  if @body_read_start
    @env['puma.request_body_wait'] = Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond) - @body_read_start
  end
  @requests_served += 1
  @ready = true
end

#set_timeout(val)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 131

def set_timeout(val)
  @timeout_at = Process.clock_gettime(Process::CLOCK_MONOTONIC) + val
end

#setup_body (private)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 317

def setup_body
  @body_read_start = Process.clock_gettime(Process::CLOCK_MONOTONIC, :millisecond)

  if @env[HTTP_EXPECT] == CONTINUE
    # TODO allow a hook here to check the headers before
    # going forward
    @io << HTTP_11_100
    @io.flush
  end

  @read_header = false

  body = @parser.body

  te = @env[TRANSFER_ENCODING2]
  if te
    te_lwr = te.downcase
    if te.include? ','
      te_ary = te_lwr.split ','
      te_count = te_ary.count CHUNKED
      te_valid = te_ary[0..-2].all? { |e| ALLOWED_TRANSFER_ENCODING.include? e }
      if te_ary.last == CHUNKED && te_count == 1 && te_valid
        @env.delete TRANSFER_ENCODING2
        return setup_chunked_body body
      elsif te_count >= 1
        raise HttpParserError   , "#{TE_ERR_MSG}, multiple chunked: '#{te}'"
      elsif !te_valid
        raise HttpParserError501, "#{TE_ERR_MSG}, unknown value: '#{te}'"
      end
    elsif te_lwr == CHUNKED
      @env.delete TRANSFER_ENCODING2
      return setup_chunked_body body
    elsif ALLOWED_TRANSFER_ENCODING.include? te_lwr
      raise HttpParserError     , "#{TE_ERR_MSG}, single value must be chunked: '#{te}'"
    else
      raise HttpParserError501  , "#{TE_ERR_MSG}, unknown value: '#{te}'"
    end
  end

  @chunked_body = false

  cl = @env[CONTENT_LENGTH]

  if cl
    # cannot contain characters that are not \d
    if cl =~ CONTENT_LENGTH_VALUE_INVALID
      raise HttpParserError, "Invalid Content-Length: #{cl.inspect}"
    end
  else
    @buffer = body.empty? ? nil : body
    @body = EmptyBody
    set_ready
    return true
  end

  remain = cl.to_i - body.bytesize

  if remain <= 0
    @body = StringIO.new(body)
    @buffer = nil
    set_ready
    return true
  end

  if remain > MAX_BODY
    @body = Tempfile.new(Const::PUMA_TMP_BASE)
    @body.unlink
    @body.binmode
    @tempfile = @body
  else
    # The body[0,0] trick is to get an empty string in the same
    # encoding as body.
    @body = StringIO.new body[0,0]
  end

  @body.write body

  @body_remain = remain

  false
end

#setup_chunked_body(body) (private)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 469

def setup_chunked_body(body)
  @chunked_body = true
  @partial_part_left = 0
  @prev_chunk = ""

  @body = Tempfile.new(Const::PUMA_TMP_BASE)
  @body.unlink
  @body.binmode
  @tempfile = @body
  @chunked_content_length = 0

  if decode_chunk(body)
    @env[CONTENT_LENGTH] = @chunked_content_length.to_s
    return true
  end
end

#timeout

Number of seconds until the timeout elapses.

[ GitHub ]

  
# File 'lib/puma/client.rb', line 136

def timeout
  [@timeout_at - Process.clock_gettime(Process::CLOCK_MONOTONIC), 0].max
end

#timeout!

Raises:

[ GitHub ]

  
# File 'lib/puma/client.rb', line 261

def timeout!
  write_error(408) if in_data_phase
  raise ConnectionError
end

#try_to_finish

[ GitHub ]

  
# File 'lib/puma/client.rb', line 210

def try_to_finish
  return read_body if in_data_phase

  begin
    data = @io.read_nonblock(CHUNK_SIZE)
  rescue IO::WaitReadable
    return false
  rescue EOFError
    # Swallow error, don't log
  rescue SystemCallError, IOError
    raise ConnectionError, "Connection error detected during read"
  end

  # No data means a closed socket
  unless data
    @buffer = nil
    set_ready
    raise EOFError
  end

  if @buffer
    @buffer << data
  else
    @buffer = data
  end

  return false unless try_to_parse_proxy_protocol

  @parsed_bytes = @parser.execute(@env, @buffer, @parsed_bytes)

  if @parser.finished?
    return setup_body
  elsif @parsed_bytes >= MAX_HEADER
    raise HttpParserError,
      "HEADER is longer than allowed, aborting client early."
  end

  false
end

#try_to_parse_proxy_protocol

If necessary, read the PROXY protocol from the buffer. Returns false if more data is needed.

[ GitHub ]

  
# File 'lib/puma/client.rb', line 188

def try_to_parse_proxy_protocol
  if @read_proxy
    if @expect_proxy_proto == :v1
      if @buffer.include? "\r\n"
        if md = PROXY_PROTOCOL_V1_REGEX.match(@buffer)
          if md[1]
            @peerip = md[1].split(" ")[0]
          end
          @buffer = md.post_match
        end
        # if the buffer has a \r\n but doesn't have a PROXY protocol
        # request, this is just HTTP from a non-PROXY client; move on
        @read_proxy = false
        return @buffer.size > 0
      else
        return false
      end
    end
  end
  true
end

#write_chunk(str) (private)

Version:

  • 5.0.0

[ GitHub ]

  
# File 'lib/puma/client.rb', line 487

def write_chunk(str)
  @chunked_content_length += @body.write(str)
end

#write_error(status_code)

[ GitHub ]

  
# File 'lib/puma/client.rb', line 266

def write_error(status_code)
  begin
    @io << ERROR_RESPONSE[status_code]
  rescue StandardError
  end
end