class ActionDispatch::Request
Constants
- ENV_METHODS
- HTTP_METHODS
- HTTP_METHOD_LOOKUP
- LOCALHOST
- RFC2518
- RFC2616
List of HTTP request methods from the following RFCs: Hypertext Transfer Protocol – HTTP/1.1 (www.ietf.org/rfc/rfc2616.txt) HTTP Extensions for Distributed Authoring – WEBDAV (www.ietf.org/rfc/rfc2518.txt) Versioning Extensions to WebDAV (www.ietf.org/rfc/rfc3253.txt) Ordered Collections Protocol (WebDAV) (www.ietf.org/rfc/rfc3648.txt) Web Distributed Authoring and Versioning (WebDAV) Access Control Protocol (www.ietf.org/rfc/rfc3744.txt) Web Distributed Authoring and Versioning (WebDAV) SEARCH (www.ietf.org/rfc/rfc5323.txt) Calendar Extensions to WebDAV (www.ietf.org/rfc/rfc4791.txt) PATCH Method for HTTP (www.ietf.org/rfc/rfc5789.txt)
- RFC3253
- RFC3648
- RFC3744
- RFC4791
- RFC5323
- RFC5789
Public Class Methods
# File lib/action_dispatch/http/request.rb, line 52 def self.empty new({}) end
# File lib/action_dispatch/http/request.rb, line 56 def initialize(env) super @method = nil @request_method = nil @remote_ip = nil @original_fullpath = nil @fullpath = nil @ip = nil end
Public Instance Methods
Override Rack's #GET method to support indifferent access
# File lib/action_dispatch/http/request.rb, line 351 def GET fetch_header("action_dispatch.request.query_parameters") do |k| rack_query_params = super || {} # Check for non UTF-8 parameter values, which would cause errors later Request::Utils.check_param_encoding(rack_query_params) set_header k, Request::Utils.normalize_encode_params(rack_query_params) end rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError => e raise ActionController::BadRequest.new("Invalid query parameters: #{e.message}") end
Override Rack's #POST method to support indifferent access
# File lib/action_dispatch/http/request.rb, line 364 def POST fetch_header("action_dispatch.request.request_parameters") do pr = parse_formatted_parameters(params_parsers) do |params| super || {} end self.request_parameters = Request::Utils.normalize_encode_params(pr) end rescue ParamsParser::ParseError # one of the parse strategies blew up self.request_parameters = Request::Utils.normalize_encode_params(super || {}) raise rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError => e raise ActionController::BadRequest.new("Invalid request parameters: #{e.message}") end
The request body is an IO input stream. If the RAW_POST_DATA environment variable is already set, wrap it in a StringIO.
# File lib/action_dispatch/http/request.rb, line 307 def body if raw_post = get_header('RAW_POST_DATA') raw_post.force_encoding(Encoding::BINARY) StringIO.new(raw_post) else body_stream end end
# File lib/action_dispatch/http/request.rb, line 69 def check_path_parameters! # If any of the path parameters has an invalid encoding then # raise since it's likely to trigger errors further on. path_parameters.each do |key, value| next unless value.respond_to?(:valid_encoding?) unless value.valid_encoding? raise ActionController::BadRequest, "Invalid parameter encoding: #{key} => #{value.inspect}" end end end
# File lib/action_dispatch/http/request.rb, line 402 def commit_flash end
Returns the content length of the request as an integer.
# File lib/action_dispatch/http/request.rb, line 244 def content_length super.to_i end
# File lib/action_dispatch/http/request.rb, line 85 def controller_class check_path_parameters! params = path_parameters if params.key?(:controller) controller_param = params[:controller].underscore params[:action] ||= 'index' const_name = "#{controller_param.camelize}Controller" ActiveSupport::Dependencies.constantize(const_name) else PASS_NOT_FOUND end 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 not assumed to contain form-data when no Content-Type header is provided and the #request_method is #POST.
# File lib/action_dispatch/http/request.rb, line 324 def form_data? FORM_DATA_MEDIA_TYPES.include?(media_type) end
Returns the String
full path including params of the last URL
requested.
# get "/articles" request.fullpath # => "/articles" # get "/articles?page=2" request.fullpath # => "/articles?page=2"
# File lib/action_dispatch/http/request.rb, line 223 def fullpath @fullpath ||= super end
Provides access to the request's HTTP headers, for example:
request.headers["Content-Type"] # => "text/plain"
# File lib/action_dispatch/http/request.rb, line 201 def headers @headers ||= Http::Headers.new(self) end
# File lib/action_dispatch/http/request.rb, line 170 def http_auth_salt get_header "action_dispatch.http_auth_salt" end
Returns the IP address of client as a String
.
# File lib/action_dispatch/http/request.rb, line 257 def ip @ip ||= super end
# File lib/action_dispatch/http/request.rb, line 99 def key?(key) has_header? key end
True if the request came from localhost, 127.0.0.1, or ::1.
# File lib/action_dispatch/http/request.rb, line 389 def local? LOCALHOST =~ remote_addr && LOCALHOST =~ remote_ip end
# File lib/action_dispatch/http/request.rb, line 398 def logger get_header("action_dispatch.logger".freeze) end
The String
MIME type of the request.
# get "/articles" request.media_type # => "application/x-www-form-urlencoded"
# File lib/action_dispatch/http/request.rb, line 239 def media_type content_mime_type.to_s end
Returns the original value of the environment's REQUEST_METHOD, even if it was overridden by middleware. See request_method for more information.
# File lib/action_dispatch/http/request.rb, line 189 def method @method ||= check_method(get_header("rack.methodoverride.original_method") || get_header('REQUEST_METHOD')) end
Returns a symbol form of the method
# File lib/action_dispatch/http/request.rb, line 194 def method_symbol HTTP_METHOD_LOOKUP[method] end
Returns a String
with the last requested path including their
params.
# get '/foo' request.original_fullpath # => '/foo' # get '/foo?bar' request.original_fullpath # => '/foo?bar'
# File lib/action_dispatch/http/request.rb, line 212 def original_fullpath @original_fullpath ||= (get_header("ORIGINAL_FULLPATH") || fullpath) end
Returns the original request URL as a String
.
# get "/articles?page=2" request.original_url # => "http://www.example.com/articles?page=2"
# File lib/action_dispatch/http/request.rb, line 231 def original_url base_url + original_fullpath end
Read the request body. This is useful for web services that need to work with raw requests directly.
# File lib/action_dispatch/http/request.rb, line 296 def raw_post unless has_header? 'RAW_POST_DATA' raw_post_body = body set_header('RAW_POST_DATA', raw_post_body.read(content_length)) raw_post_body.rewind if raw_post_body.respond_to?(:rewind) end get_header 'RAW_POST_DATA' end
Returns the IP address of client as a String
, usually set by
the RemoteIp middleware.
# File lib/action_dispatch/http/request.rb, line 263 def remote_ip @remote_ip ||= (get_header("action_dispatch.remote_ip") || ip).to_s end
# File lib/action_dispatch/http/request.rb, line 267 def remote_ip=(remote_ip) set_header "action_dispatch.remote_ip".freeze, remote_ip end
Returns the unique request id, which is based on either the X-Request-Id header that can be generated by a firewall, load balancer, or web server or by the RequestId middleware (which sets the action_dispatch.request_id environment variable).
This unique ID is useful for tracing a request from end-to-end as part of logging or debugging. This relies on the rack variable set by the ActionDispatch::RequestId middleware.
# File lib/action_dispatch/http/request.rb, line 279 def request_id get_header ACTION_DISPATCH_REQUEST_ID end
Returns the HTTP method that the application should see. In the case where the method was overridden by a middleware (for instance, if a HEAD request was converted to a #GET, or if a _method parameter was used to determine the method the application should use), this method returns the overridden value, not the original.
# File lib/action_dispatch/http/request.rb, line 136 def request_method @request_method ||= check_method(super) end
Returns a symbol form of the request_method
# File lib/action_dispatch/http/request.rb, line 182 def request_method_symbol HTTP_METHOD_LOOKUP[request_method] end
# File lib/action_dispatch/http/request.rb, line 393 def request_parameters=(params) raise if params.nil? set_header("action_dispatch.request.request_parameters".freeze, params) end
TODO This should be broken apart into AD::Request::Session and probably be included by the session middleware.
# File lib/action_dispatch/http/request.rb, line 334 def reset_session if session && session.respond_to?(:destroy) session.destroy else self.session = {} end end
Returns the lowercase name of the HTTP server software.
# File lib/action_dispatch/http/request.rb, line 290 def server_software (get_header('SERVER_SOFTWARE') && /^([a-zA-Z]+)/ =~ get_header('SERVER_SOFTWARE')) ? $1.downcase : nil end
# File lib/action_dispatch/http/request.rb, line 346 def session_options=(options) Session::Options.set self, options end
# File lib/action_dispatch/http/request.rb, line 405 def ssl? super || scheme == 'wss'.freeze end
Returns true if the “X-Requested-With” header contains “XMLHttpRequest” (case-insensitive), which may need to be manually added depending on the choice of JavaScript libraries and frameworks.
# File lib/action_dispatch/http/request.rb, line 251 def xml_http_request? get_header('HTTP_X_REQUESTED_WITH') =~ /XMLHttpRequest/i end
Private Instance Methods
# File lib/action_dispatch/http/request.rb, line 410 def check_method(name) HTTP_METHOD_LOOKUP[name] || raise(ActionController::UnknownHttpMethod, "#{name}, accepted HTTP methods are #{HTTP_METHODS[0...-1].join(', ')}, and #{HTTP_METHODS[-1]}") name end