diff options
author | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-01-26 01:12:54 +0000 |
---|---|---|
committer | drbrain <drbrain@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-01-26 01:12:54 +0000 |
commit | 28afe277a8e543da0e6353bdacbcad0b69739e06 (patch) | |
tree | 1591c370f08ab4db6c888eea99f2936262e137ca /lib/webrick/httprequest.rb | |
parent | 89232d1dd97251b6fc626d4338c49e9e8c4f6535 (diff) |
* lib/webrick/accesslog.rb: Improved WEBrick documentation.
* lib/webrick/cgi.rb: ditto.
* lib/webrick/config.rb: ditto.
* lib/webrick/cookie.rb: ditto.
* lib/webrick/httpauth/authenticator.rb: ditto.
* lib/webrick/httpauth/basicauth.rb: ditto.
* lib/webrick/httpauth/digestauth.rb: ditto.
* lib/webrick/httpproxy.rb: ditto.
* lib/webrick/httprequest.rb: ditto.
* lib/webrick/httpresponse.rb: ditto.
* lib/webrick/https.rb: ditto.
* lib/webrick/httpserver.rb: ditto.
* lib/webrick/httpservlet/cgihandler.rb: ditto.
* lib/webrick/httpservlet/filehandler.rb: ditto.
* lib/webrick/httpservlet/prochandler.rb: ditto.
* lib/webrick/httputils.rb: ditto.
* lib/webrick/httpversion.rb: ditto.
* lib/webrick/log.rb: ditto.
* lib/webrick/server.rb: ditto.
* lib/webrick/ssl.rb: ditto.
* lib/webrick/utils.rb: ditto.
* lib/webrick/version.rb: ditto.
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@38945 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/webrick/httprequest.rb')
-rw-r--r-- | lib/webrick/httprequest.rb | 146 |
1 files changed, 134 insertions, 12 deletions
diff --git a/lib/webrick/httprequest.rb b/lib/webrick/httprequest.rb index 050b5ed45b..10b9e6131e 100644 --- a/lib/webrick/httprequest.rb +++ b/lib/webrick/httprequest.rb @@ -17,31 +17,137 @@ require 'webrick/cookie' module WEBrick ## - # An HTTP request. + # An HTTP request. This is consumed by service and do_* methods in + # WEBrick servlets + class HTTPRequest - BODY_CONTAINABLE_METHODS = [ "POST", "PUT" ] + BODY_CONTAINABLE_METHODS = [ "POST", "PUT" ] # :nodoc: # :section: Request line + + ## + # The complete request line such as: + # + # GET / HTTP/1.1 + attr_reader :request_line - attr_reader :request_method, :unparsed_uri, :http_version + + ## + # The request method, GET, POST, PUT, etc. + + attr_reader :request_method + + ## + # The unparsed URI of the request + + attr_reader :unparsed_uri + + ## + # The HTTP version of the request + + attr_reader :http_version # :section: Request-URI - attr_reader :request_uri, :path - attr_accessor :script_name, :path_info, :query_string + + ## + # The parsed URI of the request + + attr_reader :request_uri + + ## + # The request path + + attr_reader :path + + ## + # The script name (CGI variable) + + attr_accessor :script_name + + ## + # The path info (CGI variable) + + attr_accessor :path_info + + ## + # The query from the URI of the request + + attr_accessor :query_string # :section: Header and entity body - attr_reader :raw_header, :header, :cookies - attr_reader :accept, :accept_charset - attr_reader :accept_encoding, :accept_language + + ## + # The raw header of the request + + attr_reader :raw_header + + ## + # The parsed header of the request + + attr_reader :header + + ## + # The parsed request cookies + + attr_reader :cookies + + ## + # The Accept header value + + attr_reader :accept + + ## + # The Accept-Charset header value + + attr_reader :accept_charset + + ## + # The Accept-Encoding header value + + attr_reader :accept_encoding + + ## + # The Accept-Language header value + + attr_reader :accept_language # :section: + + ## + # The remote user (CGI variable) + attr_accessor :user - attr_reader :addr, :peeraddr + + ## + # The socket address of the server + + attr_reader :addr + + ## + # The socket address of the client + + attr_reader :peeraddr + + ## + # Hash of request attributes + attr_reader :attributes + + ## + # Is this a keep-alive connection? + attr_reader :keep_alive + + ## + # The local time this request was received + attr_reader :request_time + ## + # Creates a new HTTP request. WEBrick::Config::HTTP is the default + # configuration. + def initialize(config) @config = config @buffer_size = @config[:InputBufferSize] @@ -78,6 +184,10 @@ module WEBrick @forwarded_server = @forwarded_for = nil end + ## + # Parses a request from +socket+. This is called internally by + # WEBrick::HTTPServer. + def parse(socket=nil) @socket = socket begin @@ -126,16 +236,21 @@ module WEBrick end end + ## # Generate HTTP/1.1 100 continue response if the client expects it, # otherwise does nothing. - def continue + + def continue # :nodoc: if self['expect'] == '100-continue' && @config[:HTTPVersion] >= "1.1" @socket << "HTTP/#{@config[:HTTPVersion]} 100 continue#{CRLF}#{CRLF}" @header.delete('expect') end end - def body(&block) + ## + # Returns the request body. + + def body(&block) # :yields: body_chunk block ||= Proc.new{|chunk| @body << chunk } read_body(@socket, block) @body.empty? ? nil : @body @@ -237,7 +352,10 @@ module WEBrick ret end - def fixup() + ## + # Consumes any remaining body and updates keep-alive status + + def fixup() # :nodoc: begin body{|chunk| } # read remaining body rescue HTTPStatus::Error => ex @@ -290,6 +408,8 @@ module WEBrick private + # :stopdoc: + MAX_URI_LENGTH = 2083 # :nodoc: def read_request_line(socket) @@ -457,5 +577,7 @@ module WEBrick @forwarded_for = addrs.first end end + + # :startdoc: end end |