Class: ActionDispatch::Request
- Includes:
- Http::Cache::Request, Http::FilterParameters, Http::MimeNegotiation, Http::Parameters, Http::URL, Http::Upload
- Defined in:
- actionpack/lib/action_dispatch/http/request.rb,
actionpack/lib/action_dispatch/request/utils.rb,
actionpack/lib/action_dispatch/request/session.rb,
actionpack/lib/action_dispatch/middleware/flash.rb,
actionpack/lib/action_dispatch/middleware/cookies.rb
Direct Known Subclasses
Defined Under Namespace
Constant Summary collapse
- LOCALHOST =
Regexp.union [/^127\.0\.0\.\d{1,3}$/, /^::1$/, /^0:0:0:0:0:0:0:1(%.*)?$/]
- ENV_METHODS =
%w[ AUTH_TYPE GATEWAY_INTERFACE PATH_TRANSLATED REMOTE_HOST REMOTE_IDENT REMOTE_USER REMOTE_ADDR SERVER_NAME SERVER_PROTOCOL HTTP_ACCEPT HTTP_ACCEPT_CHARSET HTTP_ACCEPT_ENCODING HTTP_ACCEPT_LANGUAGE HTTP_CACHE_CONTROL HTTP_FROM HTTP_NEGOTIATE HTTP_PRAGMA ].freeze
- 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) PATCH Method for HTTP (www.ietf.org/rfc/rfc5789.txt)
%w(OPTIONS GET HEAD POST PUT DELETE TRACE CONNECT)
- RFC2518 =
%w(PROPFIND PROPPATCH MKCOL COPY MOVE LOCK UNLOCK)
- RFC3253 =
%w(VERSION-CONTROL REPORT CHECKOUT CHECKIN UNCHECKOUT MKWORKSPACE UPDATE LABEL MERGE BASELINE-CONTROL MKACTIVITY)
- RFC3648 =
%w(ORDERPATCH)
- RFC3744 =
%w(ACL)
- RFC5323 =
%w(SEARCH)
- RFC5789 =
%w(PATCH)
- HTTP_METHODS =
RFC2616 + RFC2518 + RFC3253 + RFC3648 + RFC3744 + RFC5323 + RFC5789
- HTTP_METHOD_LOOKUP =
{}
Constants included from Http::URL
Http::URL::HOST_REGEXP, Http::URL::IP_HOST_REGEXP, Http::URL::PROTOCOL_REGEXP
Constants included from Http::FilterParameters
Http::FilterParameters::ENV_MATCH, Http::FilterParameters::NULL_ENV_FILTER, Http::FilterParameters::NULL_PARAM_FILTER
Constants included from Http::Cache::Request
Http::Cache::Request::HTTP_IF_MODIFIED_SINCE, Http::Cache::Request::HTTP_IF_NONE_MATCH
Instance Method Summary collapse
-
#authorization ⇒ Object
Returns the authorization header regardless of whether it was specified directly or through one of the proxy alternatives.
-
#body ⇒ Object
The request body is an IO input stream.
-
#body_stream ⇒ Object
:nodoc:.
-
#content_length ⇒ Object
Returns the content length of the request as an integer.
- #cookie_jar ⇒ Object
-
#delete? ⇒ Boolean
Is this a DELETE request? Equivalent to
request.request_method_symbol == :delete
. -
#flash ⇒ Object
Access the contents of the flash.
- #form_data? ⇒ Boolean
-
#fullpath ⇒ Object
Returns the
String
full path including params of the last URL requested. -
#GET ⇒ Object
(also: #query_parameters)
Override Rack’s GET method to support indifferent access.
-
#get? ⇒ Boolean
Is this a GET (or HEAD) request? Equivalent to
request.request_method_symbol == :get
. -
#head? ⇒ Boolean
Is this a HEAD request? Equivalent to
request.request_method_symbol == :head
. -
#headers ⇒ Object
Provides access to the request’s HTTP headers, for example:.
-
#initialize(env) ⇒ Request
constructor
A new instance of Request.
- #ip ⇒ Object
- #key?(key) ⇒ Boolean
-
#local? ⇒ Boolean
True if the request came from localhost, 127.0.0.1.
-
#media_type ⇒ Object
The
String
MIME type of the request. -
#method ⇒ Object
Returns the original value of the environment’s REQUEST_METHOD, even if it was overridden by middleware.
-
#method_symbol ⇒ Object
Returns a symbol form of the #method.
- #original_fullpath ⇒ Object
-
#original_url ⇒ Object
Returns the original request URL as a
String
. -
#patch? ⇒ Boolean
Is this a PATCH request? Equivalent to
request.request_method == :patch
. -
#POST ⇒ Object
(also: #request_parameters)
Override Rack’s POST method to support indifferent access.
-
#post? ⇒ Boolean
Is this a POST request? Equivalent to
request.request_method_symbol == :post
. -
#put? ⇒ Boolean
Is this a PUT request? Equivalent to
request.request_method_symbol == :put
. -
#raw_post ⇒ Object
Read the request body.
-
#remote_ip ⇒ Object
Originating IP address, usually set by the RemoteIp middleware.
-
#request_method ⇒ Object
Returns the HTTP method that the application should see.
-
#request_method_symbol ⇒ Object
Returns a symbol form of the #request_method.
-
#reset_session ⇒ Object
TODO This should be broken apart into AD::Request::Session and probably be included by the session middleware.
-
#server_software ⇒ Object
Returns the lowercase name of the HTTP server software.
-
#session=(session) ⇒ Object
:nodoc:.
- #session_options=(options) ⇒ Object
-
#uuid ⇒ Object
Returns the unique request id, which is based off 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).
-
#xml_http_request? ⇒ Boolean
(also: #xhr?)
Returns true if the “X-Requested-With” header contains “XMLHttpRequest” (case-insensitive).
Methods included from Http::URL
#domain, extract_domain, extract_subdomain, extract_subdomains, #host, #host_with_port, #optional_port, #port, #port_string, #protocol, #raw_host_with_port, #server_port, #standard_port, #standard_port?, #subdomain, #subdomains, #url, url_for
Methods included from Http::FilterParameters
#filtered_env, #filtered_parameters, #filtered_path
Methods included from Http::Parameters
#parameters, #path_parameters, #path_parameters=, #reset_parameters, #symbolized_path_parameters
Methods included from Http::MimeNegotiation
#accepts, #content_mime_type, #content_type, #format, #format=, #formats, #formats=, #negotiate_mime
Methods included from ActiveSupport::Concern
#append_features, extended, #included
Methods included from Http::Cache::Request
#etag_matches?, #fresh?, #if_modified_since, #if_none_match, #if_none_match_etags, #not_modified?
Constructor Details
#initialize(env) ⇒ Request
Returns a new instance of Request.
46 47 48 49 50 51 52 53 54 55 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 46 def initialize(env) super @method = nil @request_method = nil @remote_ip = nil @original_fullpath = nil @fullpath = nil @ip = nil @uuid = nil end |
Instance Method Details
#authorization ⇒ Object
Returns the authorization header regardless of whether it was specified directly or through one of the proxy alternatives.
291 292 293 294 295 296 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 291 def @env['HTTP_AUTHORIZATION'] || @env['X-HTTP_AUTHORIZATION'] || @env['X_HTTP_AUTHORIZATION'] || @env['REDIRECT_X_HTTP_AUTHORIZATION'] end |
#body ⇒ Object
The request body is an IO input stream. If the RAW_POST_DATA environment variable is already set, wrap it in a StringIO.
237 238 239 240 241 242 243 244 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 237 def body if raw_post = @env['RAW_POST_DATA'] raw_post.force_encoding(Encoding::BINARY) StringIO.new(raw_post) else @env['rack.input'] end end |
#body_stream ⇒ Object
:nodoc:
250 251 252 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 250 def body_stream #:nodoc: @env['rack.input'] end |
#content_length ⇒ Object
Returns the content length of the request as an integer.
188 189 190 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 188 def content_length super.to_i end |
#cookie_jar ⇒ Object
9 10 11 |
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 9 def env['action_dispatch.cookies'] ||= Cookies::CookieJar.build(self) end |
#delete? ⇒ Boolean
Is this a DELETE request? Equivalent to request.request_method_symbol == :delete
.
139 140 141 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 139 def delete? HTTP_METHOD_LOOKUP[request_method] == :delete end |
#flash ⇒ Object
Access the contents of the flash. Use flash["notice"]
to read a notice you put there or flash["notice"] = "hello"
to put a new one.
6 7 8 |
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 6 def flash @env[Flash::KEY] ||= Flash::FlashHash.from_session_value(session["flash"]) end |
#form_data? ⇒ Boolean
246 247 248 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 246 def form_data? FORM_DATA_MEDIA_TYPES.include?(content_mime_type.to_s) end |
#fullpath ⇒ Object
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"
167 168 169 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 167 def fullpath @fullpath ||= super end |
#GET ⇒ Object Also known as: query_parameters
Override Rack’s GET method to support indifferent access
274 275 276 277 278 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 274 def GET @env["action_dispatch.request.query_parameters"] ||= (normalize_encode_params(super) || {}) rescue TypeError => e raise ActionController::BadRequest.new(:query, e) end |
#get? ⇒ Boolean
Is this a GET (or HEAD) request? Equivalent to request.request_method_symbol == :get
.
115 116 117 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 115 def get? HTTP_METHOD_LOOKUP[request_method] == :get end |
#head? ⇒ Boolean
Is this a HEAD request? Equivalent to request.request_method_symbol == :head
.
145 146 147 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 145 def head? HTTP_METHOD_LOOKUP[request_method] == :head end |
#headers ⇒ Object
Provides access to the request’s HTTP headers, for example:
request.headers["Content-Type"] # => "text/plain"
152 153 154 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 152 def headers Http::Headers.new(@env) end |
#ip ⇒ Object
200 201 202 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 200 def ip @ip ||= super end |
#key?(key) ⇒ Boolean
57 58 59 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 57 def key?(key) @env.key?(key) end |
#local? ⇒ Boolean
True if the request came from localhost, 127.0.0.1.
299 300 301 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 299 def local? LOCALHOST =~ remote_addr && LOCALHOST =~ remote_ip end |
#media_type ⇒ Object
The String
MIME type of the request.
# get "/articles"
request.media_type # => "application/x-www-form-urlencoded"
183 184 185 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 183 def media_type content_mime_type.to_s end |
#method ⇒ Object
Returns the original value of the environment’s REQUEST_METHOD, even if it was overridden by middleware. See #request_method for more information.
104 105 106 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 104 def method @method ||= check_method(env["rack.methodoverride.original_method"] || env['REQUEST_METHOD']) end |
#method_symbol ⇒ Object
Returns a symbol form of the #method
109 110 111 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 109 def method_symbol HTTP_METHOD_LOOKUP[method] end |
#original_fullpath ⇒ Object
156 157 158 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 156 def original_fullpath @original_fullpath ||= (env["ORIGINAL_FULLPATH"] || fullpath) end |
#original_url ⇒ Object
Returns the original request URL as a String
.
# get "/articles?page=2"
request.original_url # => "http://www.example.com/articles?page=2"
175 176 177 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 175 def original_url base_url + original_fullpath end |
#patch? ⇒ Boolean
Is this a PATCH request? Equivalent to request.request_method == :patch
.
127 128 129 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 127 def patch? HTTP_METHOD_LOOKUP[request_method] == :patch end |
#POST ⇒ Object Also known as: request_parameters
Override Rack’s POST method to support indifferent access
282 283 284 285 286 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 282 def POST @env["action_dispatch.request.request_parameters"] ||= (normalize_encode_params(super) || {}) rescue TypeError => e raise ActionController::BadRequest.new(:request, e) end |
#post? ⇒ Boolean
Is this a POST request? Equivalent to request.request_method_symbol == :post
.
121 122 123 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 121 def post? HTTP_METHOD_LOOKUP[request_method] == :post end |
#put? ⇒ Boolean
Is this a PUT request? Equivalent to request.request_method_symbol == :put
.
133 134 135 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 133 def put? HTTP_METHOD_LOOKUP[request_method] == :put end |
#raw_post ⇒ Object
Read the request body. This is useful for web services that need to work with raw requests directly.
226 227 228 229 230 231 232 233 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 226 def raw_post unless @env.include? 'RAW_POST_DATA' raw_post_body = body @env['RAW_POST_DATA'] = raw_post_body.read(content_length) raw_post_body.rewind if raw_post_body.respond_to?(:rewind) end @env['RAW_POST_DATA'] end |
#remote_ip ⇒ Object
Originating IP address, usually set by the RemoteIp middleware.
205 206 207 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 205 def remote_ip @remote_ip ||= (@env["action_dispatch.remote_ip"] || ip).to_s end |
#request_method ⇒ Object
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.
92 93 94 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 92 def request_method @request_method ||= check_method(env["REQUEST_METHOD"]) end |
#request_method_symbol ⇒ Object
Returns a symbol form of the #request_method
97 98 99 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 97 def request_method_symbol HTTP_METHOD_LOOKUP[request_method] end |
#reset_session ⇒ Object
TODO This should be broken apart into AD::Request::Session and probably be included by the session middleware.
256 257 258 259 260 261 262 263 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 256 def reset_session if session && session.respond_to?(:destroy) session.destroy else self.session = {} end @env['action_dispatch.request.flash_hash'] = nil end |
#server_software ⇒ Object
Returns the lowercase name of the HTTP server software.
220 221 222 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 220 def server_software (@env['SERVER_SOFTWARE'] && /^([a-zA-Z]+)/ =~ @env['SERVER_SOFTWARE']) ? $1.downcase : nil end |
#session=(session) ⇒ Object
:nodoc:
265 266 267 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 265 def session=(session) #:nodoc: Session.set @env, session end |
#session_options=(options) ⇒ Object
269 270 271 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 269 def () Session::Options.set @env, end |
#uuid ⇒ Object
Returns the unique request id, which is based off 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.
215 216 217 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 215 def uuid @uuid ||= env["action_dispatch.request_id"] end |
#xml_http_request? ⇒ Boolean Also known as: xhr?
Returns true if the “X-Requested-With” header contains “XMLHttpRequest” (case-insensitive). All major JavaScript libraries send this header with every Ajax request.
195 196 197 |
# File 'actionpack/lib/action_dispatch/http/request.rb', line 195 def xml_http_request? @env['HTTP_X_REQUESTED_WITH'] =~ /XMLHttpRequest/i end |