Class: ActionDispatch::Request

Inherits:
Rack::Request
  • Object
show all
Includes:
Http::Cache::Request, Http::FilterParameters, Http::MimeNegotiation, Http::Parameters, Http::URL
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

TestRequest

Defined Under Namespace

Classes: Session, Utils

Constant Summary

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 Attribute Summary

Attributes included from Http::MimeNegotiation

#variant

Instance Method Summary (collapse)

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, #class_methods, 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

- (Request) initialize(env)

Returns a new instance of Request



45
46
47
48
49
50
51
52
53
54
# File 'actionpack/lib/action_dispatch/http/request.rb', line 45

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

- (Object) authorization

Returns the authorization header regardless of whether it was specified directly or through one of the proxy alternatives.



297
298
299
300
301
302
# File 'actionpack/lib/action_dispatch/http/request.rb', line 297

def authorization
  @env['HTTP_AUTHORIZATION']   ||
  @env['X-HTTP_AUTHORIZATION'] ||
  @env['X_HTTP_AUTHORIZATION'] ||
  @env['REDIRECT_X_HTTP_AUTHORIZATION']
end

- (Object) body

The request body is an IO input stream. If the RAW_POST_DATA environment variable is already set, wrap it in a StringIO.



243
244
245
246
247
248
249
250
# File 'actionpack/lib/action_dispatch/http/request.rb', line 243

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

- (Object) body_stream

:nodoc:



256
257
258
# File 'actionpack/lib/action_dispatch/http/request.rb', line 256

def body_stream #:nodoc:
  @env['rack.input']
end

- (Object) content_length

Returns the content length of the request as an integer.



194
195
196
# File 'actionpack/lib/action_dispatch/http/request.rb', line 194

def content_length
  super.to_i
end


9
10
11
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 9

def cookie_jar
  env['action_dispatch.cookies'] ||= Cookies::CookieJar.build(self)
end

- (Object) deep_munge(hash)

Extracted into ActionDispatch::Request::Utils.deep_munge, but kept here for backwards compatibility.



310
311
312
313
314
315
316
# File 'actionpack/lib/action_dispatch/http/request.rb', line 310

def deep_munge(hash)
  ActiveSupport::Deprecation.warn(
    "This method has been extracted into ActionDispatch::Request::Utils.deep_munge. Please start using that instead."
  )

  Utils.deep_munge(hash)
end

- (Boolean) delete?

Is this a DELETE request? Equivalent to request.request_method_symbol == :delete.

Returns:

  • (Boolean)


138
139
140
# File 'actionpack/lib/action_dispatch/http/request.rb', line 138

def delete?
  HTTP_METHOD_LOOKUP[request_method] == :delete
end

- (Object) flash

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.



8
9
10
# File 'actionpack/lib/action_dispatch/middleware/flash.rb', line 8

def flash
  @env[Flash::KEY] ||= Flash::FlashHash.from_session_value(session["flash"])
end

- (Boolean) form_data?

Returns:

  • (Boolean)


252
253
254
# File 'actionpack/lib/action_dispatch/http/request.rb', line 252

def form_data?
  FORM_DATA_MEDIA_TYPES.include?(content_mime_type.to_s)
end

- (Object) fullpath

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"


173
174
175
# File 'actionpack/lib/action_dispatch/http/request.rb', line 173

def fullpath
  @fullpath ||= super
end

- (Object) GET Also known as: query_parameters

Override Rack's GET method to support indifferent access



280
281
282
283
284
# File 'actionpack/lib/action_dispatch/http/request.rb', line 280

def GET
  @env["action_dispatch.request.query_parameters"] ||= Utils.deep_munge((normalize_encode_params(super) || {}))
rescue TypeError => e
  raise ActionController::BadRequest.new(:query, e)
end

- (Boolean) get?

Is this a GET (or HEAD) request? Equivalent to request.request_method_symbol == :get.

Returns:

  • (Boolean)


114
115
116
# File 'actionpack/lib/action_dispatch/http/request.rb', line 114

def get?
  HTTP_METHOD_LOOKUP[request_method] == :get
end

- (Boolean) head?

Is this a HEAD request? Equivalent to request.request_method_symbol == :head.

Returns:

  • (Boolean)


144
145
146
# File 'actionpack/lib/action_dispatch/http/request.rb', line 144

def head?
  HTTP_METHOD_LOOKUP[request_method] == :head
end

- (Object) headers

Provides access to the request's HTTP headers, for example:

request.headers["Content-Type"] # => "text/plain"


151
152
153
# File 'actionpack/lib/action_dispatch/http/request.rb', line 151

def headers
  Http::Headers.new(@env)
end

- (Object) ip



206
207
208
# File 'actionpack/lib/action_dispatch/http/request.rb', line 206

def ip
  @ip ||= super
end

- (Boolean) key?(key)

Returns:

  • (Boolean)


56
57
58
# File 'actionpack/lib/action_dispatch/http/request.rb', line 56

def key?(key)
  @env.key?(key)
end

- (Boolean) local?

True if the request came from localhost, 127.0.0.1.

Returns:

  • (Boolean)


305
306
307
# File 'actionpack/lib/action_dispatch/http/request.rb', line 305

def local?
  LOCALHOST =~ remote_addr && LOCALHOST =~ remote_ip
end

- (Object) media_type

The String MIME type of the request.

# get "/articles"
request.media_type # => "application/x-www-form-urlencoded"


189
190
191
# File 'actionpack/lib/action_dispatch/http/request.rb', line 189

def media_type
  content_mime_type.to_s
end

- (Object) method

Returns the original value of the environment's REQUEST_METHOD, even if it was overridden by middleware. See #request_method for more information.



103
104
105
# File 'actionpack/lib/action_dispatch/http/request.rb', line 103

def method
  @method ||= check_method(env["rack.methodoverride.original_method"] || env['REQUEST_METHOD'])
end

- (Object) method_symbol

Returns a symbol form of the #method



108
109
110
# File 'actionpack/lib/action_dispatch/http/request.rb', line 108

def method_symbol
  HTTP_METHOD_LOOKUP[method]
end

- (Object) original_fullpath

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'


162
163
164
# File 'actionpack/lib/action_dispatch/http/request.rb', line 162

def original_fullpath
  @original_fullpath ||= (env["ORIGINAL_FULLPATH"] || fullpath)
end

- (Object) original_url

Returns the original request URL as a String.

# get "/articles?page=2"
request.original_url # => "http://www.example.com/articles?page=2"


181
182
183
# File 'actionpack/lib/action_dispatch/http/request.rb', line 181

def original_url
  base_url + original_fullpath
end

- (Boolean) patch?

Is this a PATCH request? Equivalent to request.request_method == :patch.

Returns:

  • (Boolean)


126
127
128
# File 'actionpack/lib/action_dispatch/http/request.rb', line 126

def patch?
  HTTP_METHOD_LOOKUP[request_method] == :patch
end

- (Object) POST Also known as: request_parameters

Override Rack's POST method to support indifferent access



288
289
290
291
292
# File 'actionpack/lib/action_dispatch/http/request.rb', line 288

def POST
  @env["action_dispatch.request.request_parameters"] ||= Utils.deep_munge((normalize_encode_params(super) || {}))
rescue TypeError => e
  raise ActionController::BadRequest.new(:request, e)
end

- (Boolean) post?

Is this a POST request? Equivalent to request.request_method_symbol == :post.

Returns:

  • (Boolean)


120
121
122
# File 'actionpack/lib/action_dispatch/http/request.rb', line 120

def post?
  HTTP_METHOD_LOOKUP[request_method] == :post
end

- (Boolean) put?

Is this a PUT request? Equivalent to request.request_method_symbol == :put.

Returns:

  • (Boolean)


132
133
134
# File 'actionpack/lib/action_dispatch/http/request.rb', line 132

def put?
  HTTP_METHOD_LOOKUP[request_method] == :put
end

- (Object) raw_post

Read the request body. This is useful for web services that need to work with raw requests directly.



232
233
234
235
236
237
238
239
# File 'actionpack/lib/action_dispatch/http/request.rb', line 232

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

- (Object) remote_ip

Originating IP address, usually set by the RemoteIp middleware.



211
212
213
# File 'actionpack/lib/action_dispatch/http/request.rb', line 211

def remote_ip
  @remote_ip ||= (@env["action_dispatch.remote_ip"] || ip).to_s
end

- (Object) request_method

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.



91
92
93
# File 'actionpack/lib/action_dispatch/http/request.rb', line 91

def request_method
  @request_method ||= check_method(env["REQUEST_METHOD"])
end

- (Object) request_method_symbol

Returns a symbol form of the #request_method



96
97
98
# File 'actionpack/lib/action_dispatch/http/request.rb', line 96

def request_method_symbol
  HTTP_METHOD_LOOKUP[request_method]
end

- (Object) reset_session

TODO This should be broken apart into AD::Request::Session and probably be included by the session middleware.



262
263
264
265
266
267
268
269
# File 'actionpack/lib/action_dispatch/http/request.rb', line 262

def reset_session
  if session && session.respond_to?(:destroy)
    session.destroy
  else
    self.session = {}
  end
  @env['action_dispatch.request.flash_hash'] = nil
end

- (Object) server_software

Returns the lowercase name of the HTTP server software.



226
227
228
# File 'actionpack/lib/action_dispatch/http/request.rb', line 226

def server_software
  (@env['SERVER_SOFTWARE'] && /^([a-zA-Z]+)/ =~ @env['SERVER_SOFTWARE']) ? $1.downcase : nil
end

- (Object) session=(session)

:nodoc:



271
272
273
# File 'actionpack/lib/action_dispatch/http/request.rb', line 271

def session=(session) #:nodoc:
  Session.set @env, session
end

- (Object) session_options=(options)



275
276
277
# File 'actionpack/lib/action_dispatch/http/request.rb', line 275

def session_options=(options)
  Session::Options.set @env, options
end

- (Object) uuid

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.



221
222
223
# File 'actionpack/lib/action_dispatch/http/request.rb', line 221

def uuid
  @uuid ||= env["action_dispatch.request_id"]
end

- (Boolean) xml_http_request? 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.

Returns:

  • (Boolean)


201
202
203
# File 'actionpack/lib/action_dispatch/http/request.rb', line 201

def xml_http_request?
  @env['HTTP_X_REQUESTED_WITH'] =~ /XMLHttpRequest/i
end