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
Source
# File lib/action_dispatch/http/request.rb, line 60 def initialize(env) super @method = nil @request_method = nil @remote_ip = nil @original_fullpath = nil @fullpath = nil @ip = nil end
ActionDispatch::Http::URL::new
Public Instance Methods
Source
# File lib/action_dispatch/http/request.rb, line 371 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 GET
method to support indifferent access.
Source
# File lib/action_dispatch/http/request.rb, line 387 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
Override Rack’s POST
method to support indifferent access.
Source
# File lib/action_dispatch/http/request.rb, line 333 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
The request body is an IO input stream. If the RAW_POST_DATA environment variable is already set, wrap it in a StringIO.
Source
# File lib/action_dispatch/http/request.rb, line 269 def content_length super.to_i end
Returns the content length of the request as an integer.
Source
# File lib/action_dispatch/http/request.rb, line 79 def controller_class params = path_parameters params[:action] ||= "index" controller_class_for(params[:controller]) end
Source
# File lib/action_dispatch/http/request.rb, line 85 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
Source
# File lib/action_dispatch/http/request.rb, line 350 def form_data? FORM_DATA_MEDIA_TYPES.include?(media_type) 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
.
Source
# File lib/action_dispatch/http/request.rb, line 248 def fullpath @fullpath ||= super 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"
Source
# File lib/action_dispatch/http/request.rb, line 209 def headers @headers ||= Http::Headers.new(self) end
Provides access to the request’s HTTP headers, for example:
request.headers["Content-Type"] # => "text/plain"
Source
# File lib/action_dispatch/http/request.rb, line 178 def http_auth_salt get_header "action_dispatch.http_auth_salt" end
Source
# File lib/action_dispatch/http/request.rb, line 282 def ip @ip ||= super end
Returns the IP address of client as a String
.
Source
# File lib/action_dispatch/http/request.rb, line 106 def key?(key) has_header? key end
Returns true if the request has a header matching the given key parameter.
request.key? :ip_spoofing_check # => true
Source
# File lib/action_dispatch/http/request.rb, line 411 def local? LOCALHOST.match?(remote_addr) && LOCALHOST.match?(remote_ip) end
True if the request came from localhost, 127.0.0.1, or ::1.
Source
# File lib/action_dispatch/http/request.rb, line 420 def logger get_header("action_dispatch.logger") end
Source
# File lib/action_dispatch/http/request.rb, line 264 def media_type content_mime_type&.to_s end
The String
MIME type of the request.
# get "/articles" request.media_type # => "application/x-www-form-urlencoded"
Source
# File lib/action_dispatch/http/request.rb, line 197 def method @method ||= check_method(get_header("rack.methodoverride.original_method") || get_header("REQUEST_METHOD")) end
Returns the original value of the environment’s REQUEST_METHOD, even if it was overridden by middleware. See request_method
for more information.
Source
# File lib/action_dispatch/http/request.rb, line 202 def method_symbol HTTP_METHOD_LOOKUP[method] end
Returns a symbol form of the method
.
Source
# File lib/action_dispatch/http/request.rb, line 237 def original_fullpath @original_fullpath ||= (get_header("ORIGINAL_FULLPATH") || fullpath) 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'
Source
# File lib/action_dispatch/http/request.rb, line 256 def original_url base_url + original_fullpath end
Returns the original request URL as a String
.
# get "/articles?page=2" request.original_url # => "http://www.example.com/articles?page=2"
Source
# File lib/action_dispatch/http/request.rb, line 322 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
Read the request body. This is useful for web services that need to work with raw requests directly.
Source
# File lib/action_dispatch/http/request.rb, line 288 def remote_ip @remote_ip ||= (get_header("action_dispatch.remote_ip") || ip).to_s end
Returns the IP address of client as a String
, usually set by the RemoteIp
middleware.
Source
# File lib/action_dispatch/http/request.rb, line 292 def remote_ip=(remote_ip) @remote_ip = nil set_header "action_dispatch.remote_ip", remote_ip end
Source
# File lib/action_dispatch/http/request.rb, line 305 def request_id get_header ACTION_DISPATCH_REQUEST_ID 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.
Source
# File lib/action_dispatch/http/request.rb, line 144 def request_method @request_method ||= check_method(super) 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.
Source
# File lib/action_dispatch/http/request.rb, line 190 def request_method_symbol HTTP_METHOD_LOOKUP[request_method] end
Returns a symbol form of the request_method
.
Source
# File lib/action_dispatch/http/request.rb, line 415 def request_parameters=(params) raise if params.nil? set_header("action_dispatch.request.request_parameters", params) end
Source
# File lib/action_dispatch/http/request.rb, line 358 def reset_session session.destroy end
Source
# File lib/action_dispatch/http/request.rb, line 224 def send_early_hints(links) return unless env["rack.early_hints"] env["rack.early_hints"].call(links) 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.
Source
# File lib/action_dispatch/http/request.rb, line 316 def server_software (get_header("SERVER_SOFTWARE") && /^([a-zA-Z]+)/ =~ get_header("SERVER_SOFTWARE")) ? $1.downcase : nil end
Returns the lowercase name of the HTTP server software.
Source
# File lib/action_dispatch/http/request.rb, line 366 def session_options=(options) Session::Options.set self, options end
Source
# File lib/action_dispatch/http/request.rb, line 276 def xml_http_request? /XMLHttpRequest/i.match?(get_header("HTTP_X_REQUESTED_WITH")) 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.
Private Instance Methods
Source
# File lib/action_dispatch/http/request.rb, line 432 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
Source
# File lib/action_dispatch/http/request.rb, line 437 def default_session Session.disabled(self) end