class ActionDispatch::Request
Constants
- ENV_METHODS
- HTTP_METHODS
- HTTP_METHOD_LOOKUP
- LOCALHOST
- RFC2518
HTTP methods from RFC 2518: HTTP Extensions for Distributed Authoring – WEBDAV
- RFC2616
HTTP methods from RFC 2616: Hypertext Transfer Protocol – HTTP/1.1
- RFC3253
HTTP methods from RFC 3253: Versioning Extensions to WebDAV
- RFC3648
HTTP methods from RFC 3648: WebDAV Ordered Collections Protocol
- RFC3744
HTTP methods from RFC 3744: WebDAV Access Control Protocol
- RFC4791
HTTP methods from RFC 4791: Calendaring Extensions to WebDAV
- RFC5323
HTTP methods from RFC 5323: WebDAV SEARCH
- RFC5789
HTTP methods from RFC 5789: PATCH Method for HTTP
Public Class Methods
# File lib/action_dispatch/http/request.rb, line 55 def self.empty new({}) end
# File lib/action_dispatch/http/request.rb, line 59 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 370 def GET fetch_header("action_dispatch.request.query_parameters") do |k| rack_query_params = super || {} controller = path_parameters[:controller] action = path_parameters[:action] rack_query_params = Request::Utils.set_binary_encoding(self, rack_query_params, controller, action) # 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, Rack::QueryParser::ParamsTooDeepError => 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 386 def POST fetch_header("action_dispatch.request.request_parameters") do pr = parse_formatted_parameters(params_parsers) do |params| super || {} end pr = Request::Utils.set_binary_encoding(self, pr, path_parameters[:controller], path_parameters[:action]) Request::Utils.check_param_encoding(pr) self.request_parameters = Request::Utils.normalize_encode_params(pr) end rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError, Rack::QueryParser::ParamsTooDeepError, EOFError => 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 332 def body if raw_post = get_header("RAW_POST_DATA") raw_post = (+raw_post).force_encoding(Encoding::BINARY) StringIO.new(raw_post) else body_stream end end
# File lib/action_dispatch/http/request.rb, line 423 def commit_flash end
Returns the content length of the request as an integer.
# File lib/action_dispatch/http/request.rb, line 268 def content_length super.to_i end
# File lib/action_dispatch/http/request.rb, line 78 def controller_class params = path_parameters params[:action] ||= "index" controller_class_for(params[:controller]) end
# File lib/action_dispatch/http/request.rb, line 84 def controller_class_for(name) if name controller_param = name.underscore const_name = controller_param.camelize << "Controller" begin const_name.constantize rescue NameError => error if error.missing_name == const_name || const_name.start_with?("#{error.missing_name}::") raise MissingController.new(error.message, error.name) else raise end end 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 349 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 247 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 208 def headers @headers ||= Http::Headers.new(self) end
# File lib/action_dispatch/http/request.rb, line 177 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 281 def ip @ip ||= super end
Returns true if the request has a header matching the given key parameter.
request.key? :ip_spoofing_check # => true
# File lib/action_dispatch/http/request.rb, line 105 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 410 def local? LOCALHOST.match?(remote_addr) && LOCALHOST.match?(remote_ip) end
# File lib/action_dispatch/http/request.rb, line 419 def logger get_header("action_dispatch.logger") 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 263 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 196 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 201 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 236 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 255 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 321 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 287 def remote_ip @remote_ip ||= (get_header("action_dispatch.remote_ip") || ip).to_s end
# File lib/action_dispatch/http/request.rb, line 291 def remote_ip=(remote_ip) @remote_ip = nil set_header "action_dispatch.remote_ip", 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 304 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 143 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 189 def request_method_symbol HTTP_METHOD_LOOKUP[request_method] end
# File lib/action_dispatch/http/request.rb, line 414 def request_parameters=(params) raise if params.nil? set_header("action_dispatch.request.request_parameters", params) end
# File lib/action_dispatch/http/request.rb, line 357 def reset_session session.destroy end
Early Hints is an HTTP/2 status code that indicates hints to help a client start making preparations for processing the final response.
If the env contains rack.early_hints
then the server accepts
HTTP2 push for Link headers.
The send_early_hints
method accepts a hash of links as
follows:
send_early_hints("Link" => "</style.css>; rel=preload; as=style\n</script.js>; rel=preload")
If you are using javascript_include_tag
or
stylesheet_link_tag
the Early Hints headers are included by
default if supported.
# File lib/action_dispatch/http/request.rb, line 223 def send_early_hints(links) return unless env["rack.early_hints"] env["rack.early_hints"].call(links) end
Returns the lowercase name of the HTTP server software.
# File lib/action_dispatch/http/request.rb, line 315 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 365 def session_options=(options) Session::Options.set self, options 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 275 def xml_http_request? /XMLHttpRequest/i.match?(get_header("HTTP_X_REQUESTED_WITH")) end
Private Instance Methods
# File lib/action_dispatch/http/request.rb, line 431 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
# File lib/action_dispatch/http/request.rb, line 436 def default_session Session.disabled(self) end