module Rack::Request::Helpers
Constants
- DEFAULT_PORTS
Default ports depending on scheme. Used to decide whether or not to include the port in a generated URI.
- FORM_DATA_MEDIA_TYPES
The set of form-data media-types. Requests that do not indicate one of the media types present in this list will not be eligible for form-data / param parsing.
- HTTP_X_FORWARDED_HOST
- HTTP_X_FORWARDED_PORT
- HTTP_X_FORWARDED_PROTO
- HTTP_X_FORWARDED_SCHEME
- HTTP_X_FORWARDED_SSL
- PARSEABLE_DATA_MEDIA_TYPES
The set of media-types. Requests that do not indicate one of the media types present in this list will not be eligible for param parsing like soap attachments or generic multiparts
Public Instance Methods
Returns the data received in the query string.
# File lib/rack/request.rb, line 336 def GET if get_header(RACK_REQUEST_QUERY_STRING) == query_string get_header(RACK_REQUEST_QUERY_HASH) else query_hash = parse_query(query_string, '&;') set_header(RACK_REQUEST_QUERY_STRING, query_string) set_header(RACK_REQUEST_QUERY_HASH, query_hash) end end
Returns the data received in the request body.
This method support both application/x-www-form-urlencoded and multipart/form-data.
# File lib/rack/request.rb, line 350 def POST if get_header(RACK_INPUT).nil? raise "Missing rack.input" elsif get_header(RACK_REQUEST_FORM_INPUT) == get_header(RACK_INPUT) get_header(RACK_REQUEST_FORM_HASH) elsif form_data? || parseable_data? unless set_header(RACK_REQUEST_FORM_HASH, parse_multipart) form_vars = get_header(RACK_INPUT).read # Fix for Safari Ajax postings that always append \0 # form_vars.sub!(/\0\z/, '') # performance replacement: form_vars.slice!(-1) if form_vars.end_with?("\0") set_header RACK_REQUEST_FORM_VARS, form_vars set_header RACK_REQUEST_FORM_HASH, parse_query(form_vars, '&') get_header(RACK_INPUT).rewind end set_header RACK_REQUEST_FORM_INPUT, get_header(RACK_INPUT) get_header RACK_REQUEST_FORM_HASH else {} end end
shortcut for request.params[key]
# File lib/rack/request.rb, line 446 def [](key) if $VERBOSE warn("Request#[] is deprecated and will be removed in a future version of Rack. Please use request.params[] instead") end params[key.to_s] end
shortcut for request.params[key] = value
Note that modifications will not be persisted in the env. Use update_param
or delete_param
if you want to destructively modify params.
# File lib/rack/request.rb, line 457 def []=(key, value) if $VERBOSE warn("Request#[]= is deprecated and will be removed in a future version of Rack. Please use request.params[]= instead") end params[key.to_s] = value end
# File lib/rack/request.rb, line 433 def accept_encoding parse_http_accept_header(get_header("HTTP_ACCEPT_ENCODING")) end
# File lib/rack/request.rb, line 437 def accept_language parse_http_accept_header(get_header("HTTP_ACCEPT_LANGUAGE")) end
# File lib/rack/request.rb, line 414 def base_url url = "#{scheme}://#{host}" url = "#{url}:#{port}" if port != DEFAULT_PORTS[scheme] url end
# File lib/rack/request.rb, line 143 def body; get_header(RACK_INPUT) end
The character set of the request body if a “charset” media type parameter was given, or nil if no “charset” was specified. Note that, per RFC2616, text/* media types that specify no explicit charset are to be considered ISO-8859-1.
# File lib/rack/request.rb, line 311 def content_charset media_type_params['charset'] end
# File lib/rack/request.rb, line 152 def content_length; get_header('CONTENT_LENGTH') end
# File lib/rack/request.rb, line 231 def content_type content_type = get_header('CONTENT_TYPE') content_type.nil? || content_type.empty? ? nil : content_type end
Checks the HTTP request method (or verb) to see if it was of type DELETE
# File lib/rack/request.rb, line 174 def delete?; request_method == DELETE end
Destructively delete a parameter, whether it's in GET
or POST
. Returns the value of the deleted parameter.
If the parameter is in both GET
and POST
, the POST
value takes precedence since that's how params
works.
env['rack.input']
is not touched.
# File lib/rack/request.rb, line 409 def delete_param(k) post_value, get_value = self.POST.delete(k), self.GET.delete(k) post_value || get_value end
Determine whether the request body contains form-data by checking the request Content-Type for one of the media-types: “application/x-www-form-urlencoded” or “multipart/form-data”. The list of form-data media types can be modified through the FORM_DATA_MEDIA_TYPES
array.
A request body is also assumed to contain form-data when no Content-Type header is provided and the request_method
is POST
.
# File lib/rack/request.rb, line 323 def form_data? type = media_type meth = get_header(RACK_METHODOVERRIDE_ORIGINAL_METHOD) || get_header(REQUEST_METHOD) (meth == POST && type.nil?) || FORM_DATA_MEDIA_TYPES.include?(type) end
# File lib/rack/request.rb, line 429 def fullpath query_string.empty? ? path : "#{path}?#{query_string}" end
Checks the HTTP request method (or verb) to see if it was of type GET
# File lib/rack/request.rb, line 177 def get?; request_method == GET end
Checks the HTTP request method (or verb) to see if it was of type HEAD
# File lib/rack/request.rb, line 180 def head?; request_method == HEAD end
# File lib/rack/request.rb, line 248 def host # Remove port number. h = host_with_port if colon_index = h.index(":") h[0, colon_index] else h end end
# File lib/rack/request.rb, line 240 def host_with_port if forwarded = get_header(HTTP_X_FORWARDED_HOST) forwarded.split(/,\s?/).last else get_header(HTTP_HOST) || "#{get_header(SERVER_NAME) || get_header(SERVER_ADDR)}:#{get_header(SERVER_PORT)}" end end
# File lib/rack/request.rb, line 276 def ip remote_addrs = split_ip_addresses(get_header('REMOTE_ADDR')) remote_addrs = reject_trusted_ip_addresses(remote_addrs) return remote_addrs.first if remote_addrs.any? forwarded_ips = split_ip_addresses(get_header('HTTP_X_FORWARDED_FOR')) .map { |ip| strip_port(ip) } return reject_trusted_ip_addresses(forwarded_ips).last || forwarded_ips.first || get_header("REMOTE_ADDR") end
Checks the HTTP request method (or verb) to see if it was of type LINK
# File lib/rack/request.rb, line 186 def link?; request_method == LINK end
# File lib/rack/request.rb, line 153 def logger; get_header(RACK_LOGGER) end
The media type (type/subtype) portion of the CONTENT_TYPE header without any media type parameters. e.g., when CONTENT_TYPE is “text/plain;charset=utf-8”, the media-type is “text/plain”.
For more information on the use of media types in HTTP, see: www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7
# File lib/rack/request.rb, line 294 def media_type MediaType.type(content_type) end
The media type parameters provided in CONTENT_TYPE as a Hash, or an empty Hash if no CONTENT_TYPE or media-type parameters were provided. e.g., when the CONTENT_TYPE is “text/plain;charset=utf-8”, this method responds with the following Hash:
{ 'charset' => 'utf-8' }
# File lib/rack/request.rb, line 303 def media_type_params MediaType.params(content_type) end
# File lib/rack/request.rb, line 155 def multithread?; get_header(RACK_MULTITHREAD) end
Checks the HTTP request method (or verb) to see if it was of type OPTIONS
# File lib/rack/request.rb, line 183 def options?; request_method == OPTIONS end
The union of GET
and POST
data.
Note that modifications will not be persisted in the env. Use update_param
or delete_param
if you want to destructively modify params.
# File lib/rack/request.rb, line 378 def params self.GET.merge(self.POST) rescue EOFError self.GET.dup end
Determine whether the request body contains data by checking the request media_type
against registered parse-data media-types
# File lib/rack/request.rb, line 331 def parseable_data? PARSEABLE_DATA_MEDIA_TYPES.include?(media_type) end
Checks the HTTP request method (or verb) to see if it was of type PATCH
# File lib/rack/request.rb, line 189 def patch?; request_method == PATCH end
# File lib/rack/request.rb, line 425 def path script_name + path_info end
# File lib/rack/request.rb, line 147 def path_info; get_header(PATH_INFO).to_s end
# File lib/rack/request.rb, line 148 def path_info=(s); set_header(PATH_INFO, s.to_s) end
# File lib/rack/request.rb, line 258 def port if port = extract_port(host_with_port) port.to_i elsif port = get_header(HTTP_X_FORWARDED_PORT) port.to_i elsif has_header?(HTTP_X_FORWARDED_HOST) DEFAULT_PORTS[scheme] elsif has_header?(HTTP_X_FORWARDED_PROTO) DEFAULT_PORTS[extract_proto_header(get_header(HTTP_X_FORWARDED_PROTO))] else get_header(SERVER_PORT).to_i end end
Checks the HTTP request method (or verb) to see if it was of type POST
# File lib/rack/request.rb, line 192 def post?; request_method == POST end
Checks the HTTP request method (or verb) to see if it was of type PUT
# File lib/rack/request.rb, line 195 def put?; request_method == PUT end
# File lib/rack/request.rb, line 151 def query_string; get_header(QUERY_STRING).to_s end
the referer of the client
# File lib/rack/request.rb, line 158 def referer; get_header('HTTP_REFERER') end
# File lib/rack/request.rb, line 150 def request_method; get_header(REQUEST_METHOD) end
# File lib/rack/request.rb, line 203 def scheme if get_header(HTTPS) == 'on' 'https' elsif get_header(HTTP_X_FORWARDED_SSL) == 'on' 'https' elsif forwarded_scheme forwarded_scheme else get_header(RACK_URL_SCHEME) end end
# File lib/rack/request.rb, line 144 def script_name; get_header(SCRIPT_NAME).to_s end
# File lib/rack/request.rb, line 145 def script_name=(s); set_header(SCRIPT_NAME, s.to_s) end
# File lib/rack/request.rb, line 161 def session fetch_header(RACK_SESSION) do |k| set_header RACK_SESSION, default_session end end
# File lib/rack/request.rb, line 167 def session_options fetch_header(RACK_SESSION_OPTIONS) do |k| set_header RACK_SESSION_OPTIONS, {} end end
# File lib/rack/request.rb, line 272 def ssl? scheme == 'https' end
Checks the HTTP request method (or verb) to see if it was of type TRACE
# File lib/rack/request.rb, line 198 def trace?; request_method == TRACE end
# File lib/rack/request.rb, line 441 def trusted_proxy?(ip) Rack::Request.ip_filter.call(ip) end
Checks the HTTP request method (or verb) to see if it was of type UNLINK
# File lib/rack/request.rb, line 201 def unlink?; request_method == UNLINK end
Destructively update a parameter, whether it's in GET
and/or POST
. Returns nil.
The parameter is updated wherever it was previous defined, so GET
, POST
, or both. If it wasn't previously defined, it's inserted into GET
.
env['rack.input']
is not touched.
# File lib/rack/request.rb, line 389 def update_param(k, v) found = false if self.GET.has_key?(k) found = true self.GET[k] = v end if self.POST.has_key?(k) found = true self.POST[k] = v end unless found self.GET[k] = v end end
Tries to return a remake of the original request URL as a string.
# File lib/rack/request.rb, line 421 def url base_url + fullpath end
# File lib/rack/request.rb, line 154 def user_agent; get_header('HTTP_USER_AGENT') end
like Hash#values_at
# File lib/rack/request.rb, line 466 def values_at(*keys) keys.map { |key| params[key] } end
# File lib/rack/request.rb, line 236 def xhr? get_header("HTTP_X_REQUESTED_WITH") == "XMLHttpRequest" end
Private Instance Methods
# File lib/rack/request.rb, line 529 def allowed_scheme(header) header if ALLOWED_SCHEMES.include?(header) end
# File lib/rack/request.rb, line 472 def default_session; {}; end
# File lib/rack/request.rb, line 543 def extract_port(uri) if (colon_index = uri.index(':')) uri[colon_index + 1, uri.length] end end
# File lib/rack/request.rb, line 533 def extract_proto_header(header) if header if (comma_index = header.index(',')) header[0, comma_index] else header end end end
# File lib/rack/request.rb, line 524 def forwarded_scheme allowed_scheme(get_header(HTTP_X_FORWARDED_SCHEME)) || allowed_scheme(extract_proto_header(get_header(HTTP_X_FORWARDED_PROTO))) end
# File lib/rack/request.rb, line 474 def parse_http_accept_header(header) header.to_s.split(/\s*,\s*/).map do |part| attribute, parameters = part.split(/\s*;\s*/, 2) quality = 1.0 if parameters and /\Aq=([\d.]+)/ =~ parameters quality = $1.to_f end [attribute, quality] end end
# File lib/rack/request.rb, line 493 def parse_multipart Rack::Multipart.extract_multipart(self, query_parser) end
# File lib/rack/request.rb, line 489 def parse_query(qs, d = '&') query_parser.parse_nested_query(qs, d) end
# File lib/rack/request.rb, line 485 def query_parser Utils.default_query_parser end
# File lib/rack/request.rb, line 520 def reject_trusted_ip_addresses(ip_addresses) ip_addresses.reject { |ip| trusted_proxy?(ip) } end
# File lib/rack/request.rb, line 497 def split_ip_addresses(ip_addresses) ip_addresses ? ip_addresses.strip.split(/[,\s]+/) : [] end
# File lib/rack/request.rb, line 501 def strip_port(ip_address) # IPv6 format with optional port: "[2001:db8:cafe::17]:47011" # returns: "2001:db8:cafe::17" sep_start = ip_address.index('[') sep_end = ip_address.index(']') if (sep_start && sep_end) return ip_address[sep_start + 1, sep_end - 1] end # IPv4 format with optional port: "192.0.2.43:47011" # returns: "192.0.2.43" sep = ip_address.index(':') if (sep && ip_address.count(':') == 1) return ip_address[0, sep] end ip_address end