Class: ActionDispatch::Request

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

LOCALHOST =
Regexp.union [/^127\.\d{1,3}\.\d{1,3}\.\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
ORIGINAL_SCRIPT_NAME

HTTP_ACCEPT HTTP_ACCEPT_CHARSET HTTP_ACCEPT_ENCODING
HTTP_ACCEPT_LANGUAGE HTTP_CACHE_CONTROL HTTP_FROM
HTTP_NEGOTIATE HTTP_PRAGMA HTTP_CLIENT_IP
HTTP_X_FORWARDED_FOR HTTP_ORIGIN HTTP_VERSION
HTTP_X_CSRF_TOKEN HTTP_X_REQUEST_ID HTTP_X_FORWARDED_HOST
SERVER_ADDR
].freeze
PASS_NOT_FOUND =

:nodoc:

Class.new { # :nodoc:
  def self.action(_); self; end
  def self.call(_); [404, {'X-Cascade' => 'pass'}, []]; end
}
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)

%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)
RFC4791 =
%w(MKCALENDAR)
RFC5789 =
%w(PATCH)
HTTP_METHODS =
RFC2616 + RFC2518 + RFC3253 + RFC3648 + RFC3744 + RFC5323 + RFC4791 + RFC5789
HTTP_METHOD_LOOKUP =
{}
ACTION_DISPATCH_REQUEST_ID =

:nodoc:

"action_dispatch.request_id".freeze

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::Parameters

Http::Parameters::DEFAULT_PARSERS, Http::Parameters::PARAMETERS_KEY

Constants included from Http::Cache::Request

Http::Cache::Request::HTTP_IF_MODIFIED_SINCE, Http::Cache::Request::HTTP_IF_NONE_MATCH

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Http::URL

#domain, extract_domain, extract_subdomain, extract_subdomains, full_url_for, #host, #host_with_port, #optional_port, path_for, #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=

Methods included from ActiveSupport::Concern

#append_features, #class_methods, extended, #included

Methods included from Http::MimeNegotiation

#accepts, #content_mime_type, #content_type, #format, #format=, #formats, #formats=, #has_content_type?, #negotiate_mime, #variant, #variant=

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.


56
57
58
59
60
61
62
63
64
# File 'actionpack/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

Class Method Details

.emptyObject


52
53
54
# File 'actionpack/lib/action_dispatch/http/request.rb', line 52

def self.empty
  new({})
end

Instance Method Details

#authorizationObject

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


369
370
371
372
373
374
# File 'actionpack/lib/action_dispatch/http/request.rb', line 369

def authorization
  get_header('HTTP_AUTHORIZATION')   ||
  get_header('X-HTTP_AUTHORIZATION') ||
  get_header('X_HTTP_AUTHORIZATION') ||
  get_header('REDIRECT_X_HTTP_AUTHORIZATION')
end

#bodyObject

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


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

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

#body_streamObject

:nodoc:


316
317
318
# File 'actionpack/lib/action_dispatch/http/request.rb', line 316

def body_stream #:nodoc:
  get_header('rack.input')
end

:nodoc:


66
67
# File 'actionpack/lib/action_dispatch/http/request.rb', line 66

def commit_cookie_jar! # :nodoc:
end

#commit_flashObject


390
391
# File 'actionpack/lib/action_dispatch/http/request.rb', line 390

def commit_flash
end

#content_lengthObject

Returns the content length of the request as an integer.


232
233
234
# File 'actionpack/lib/action_dispatch/http/request.rb', line 232

def content_length
  super.to_i
end

#controller_classObject


74
75
76
77
78
79
80
81
82
83
84
85
# File 'actionpack/lib/action_dispatch/http/request.rb', line 74

def controller_class
  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

#controller_instanceObject

:nodoc:


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

def controller_instance # :nodoc:
  get_header('action_controller.instance'.freeze)
end

#controller_instance=(controller) ⇒ Object

:nodoc:


154
155
156
# File 'actionpack/lib/action_dispatch/http/request.rb', line 154

def controller_instance=(controller) # :nodoc:
  set_header('action_controller.instance'.freeze, controller)
end

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

def cookie_jar
  fetch_header('action_dispatch.cookies'.freeze) do
    self.cookie_jar = Cookies::CookieJar.build(self, cookies)
  end
end

26
27
28
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 26

def cookie_jar=(jar)
  set_header 'action_dispatch.cookies'.freeze, jar
end

#cookies_digestObject


58
59
60
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 58

def cookies_digest
  get_header Cookies::COOKIES_DIGEST
end

#cookies_serializerObject


54
55
56
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 54

def cookies_serializer
  get_header Cookies::COOKIES_SERIALIZER
end

38
39
40
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 38

def encrypted_cookie_salt
  get_header Cookies::ENCRYPTED_COOKIE_SALT
end

42
43
44
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 42

def encrypted_signed_cookie_salt
  get_header Cookies::ENCRYPTED_SIGNED_COOKIE_SALT
end

#engine_script_name(_routes) ⇒ Object

:nodoc:


136
137
138
# File 'actionpack/lib/action_dispatch/http/request.rb', line 136

def engine_script_name(_routes) # :nodoc:
  get_header(_routes.env_key)
end

#engine_script_name=(name) ⇒ Object

:nodoc:


140
141
142
# File 'actionpack/lib/action_dispatch/http/request.rb', line 140

def engine_script_name=(name) # :nodoc:
  set_header(routes.env_key, name.dup)
end

#form_data?Boolean

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.

Returns:

  • (Boolean)

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

def form_data?
  FORM_DATA_MEDIA_TYPES.include?(media_type)
end

#fullpathObject

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"

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

def fullpath
  @fullpath ||= super
end

#GETObject Also known as: query_parameters

Override Rack's GET method to support indifferent access


339
340
341
342
343
344
345
346
347
348
# File 'actionpack/lib/action_dispatch/http/request.rb', line 339

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

Returns:

  • (Boolean)

22
23
24
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 22

def have_cookie_jar?
  has_header? 'action_dispatch.cookies'.freeze
end

#headersObject

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

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

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

def headers
  @headers ||= Http::Headers.new(self)
end

#http_auth_saltObject


158
159
160
# File 'actionpack/lib/action_dispatch/http/request.rb', line 158

def http_auth_salt
  get_header "action_dispatch.http_auth_salt"
end

#ipObject

Returns the IP address of client as a String.


245
246
247
# File 'actionpack/lib/action_dispatch/http/request.rb', line 245

def ip
  @ip ||= super
end

#key?(key) ⇒ Boolean

Returns:

  • (Boolean)

87
88
89
# File 'actionpack/lib/action_dispatch/http/request.rb', line 87

def key?(key)
  has_header? key
end

#key_generatorObject


30
31
32
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 30

def key_generator
  get_header Cookies::GENERATOR_KEY
end

#local?Boolean

True if the request came from localhost, 127.0.0.1, or ::1.

Returns:

  • (Boolean)

377
378
379
# File 'actionpack/lib/action_dispatch/http/request.rb', line 377

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

#loggerObject


386
387
388
# File 'actionpack/lib/action_dispatch/http/request.rb', line 386

def logger
  get_header("action_dispatch.logger".freeze)
end

#media_typeObject

The String MIME type of the request.

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

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

def media_type
  content_mime_type.to_s
end

#methodObject

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


177
178
179
# File 'actionpack/lib/action_dispatch/http/request.rb', line 177

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

#method_symbolObject

Returns a symbol form of the #method


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

def method_symbol
  HTTP_METHOD_LOOKUP[method]
end

#original_fullpathObject

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'

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

def original_fullpath
  @original_fullpath ||= (get_header("ORIGINAL_FULLPATH") || fullpath)
end

#original_urlObject

Returns the original request URL as a String.

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

219
220
221
# File 'actionpack/lib/action_dispatch/http/request.rb', line 219

def original_url
  base_url + original_fullpath
end

#POSTObject Also known as: request_parameters

Override Rack's POST method to support indifferent access


352
353
354
355
356
357
358
359
360
361
362
363
364
# File 'actionpack/lib/action_dispatch/http/request.rb', line 352

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

#raw_postObject

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


284
285
286
287
288
289
290
291
# File 'actionpack/lib/action_dispatch/http/request.rb', line 284

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

#remote_ipObject

Returns the IP address of client as a String, usually set by the RemoteIp middleware.


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

def remote_ip
  @remote_ip ||= (get_header("action_dispatch.remote_ip") || ip).to_s
end

#remote_ip=(remote_ip) ⇒ Object


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

def remote_ip=(remote_ip)
  set_header "action_dispatch.remote_ip".freeze, remote_ip
end

#request_idObject Also known as: uuid

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.


267
268
269
# File 'actionpack/lib/action_dispatch/http/request.rb', line 267

def request_id
  get_header ACTION_DISPATCH_REQUEST_ID
end

#request_id=(id) ⇒ Object

:nodoc:


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

def request_id=(id) # :nodoc:
  set_header ACTION_DISPATCH_REQUEST_ID, id
end

#request_methodObject

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.


124
125
126
# File 'actionpack/lib/action_dispatch/http/request.rb', line 124

def request_method
  @request_method ||= check_method(super)
end

#request_method=(request_method) ⇒ Object

:nodoc:


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

def request_method=(request_method) #:nodoc:
  if check_method(request_method)
    @request_method = set_header("REQUEST_METHOD", request_method)
  end
end

#request_method_symbolObject

Returns a symbol form of the #request_method


170
171
172
# File 'actionpack/lib/action_dispatch/http/request.rb', line 170

def request_method_symbol
  HTTP_METHOD_LOOKUP[request_method]
end

#request_parameters=(params) ⇒ Object


381
382
383
384
# File 'actionpack/lib/action_dispatch/http/request.rb', line 381

def request_parameters=(params)
  raise if params.nil?
  set_header("action_dispatch.request.request_parameters".freeze, params)
end

#reset_sessionObject

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


322
323
324
325
326
327
328
# File 'actionpack/lib/action_dispatch/http/request.rb', line 322

def reset_session
  if session && session.respond_to?(:destroy)
    session.destroy
  else
    self.session = {}
  end
end

#routesObject

:nodoc:


128
129
130
# File 'actionpack/lib/action_dispatch/http/request.rb', line 128

def routes # :nodoc:
  get_header("action_dispatch.routes".freeze)
end

#routes=(routes) ⇒ Object

:nodoc:


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

def routes=(routes) # :nodoc:
  set_header("action_dispatch.routes".freeze, routes)
end

#secret_key_baseObject


50
51
52
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 50

def secret_key_base
  get_header Cookies::SECRET_KEY_BASE
end

#secret_tokenObject


46
47
48
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 46

def secret_token
  get_header Cookies::SECRET_TOKEN
end

#server_softwareObject

Returns the lowercase name of the HTTP server software.


278
279
280
# File 'actionpack/lib/action_dispatch/http/request.rb', line 278

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

#session=(session) ⇒ Object

:nodoc:


330
331
332
# File 'actionpack/lib/action_dispatch/http/request.rb', line 330

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

#session_options=(options) ⇒ Object


334
335
336
# File 'actionpack/lib/action_dispatch/http/request.rb', line 334

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

#show_exceptions?Boolean

:nodoc:

Returns:

  • (Boolean)

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

def show_exceptions? # :nodoc:
  # We're treating `nil` as "unset", and we want the default setting to be
  # `true`.  This logic should be extracted to `env_config` and calculated
  # once.
  !(get_header('action_dispatch.show_exceptions'.freeze) == false)
end

34
35
36
# File 'actionpack/lib/action_dispatch/middleware/cookies.rb', line 34

def signed_cookie_salt
  get_header Cookies::SIGNED_COOKIE_SALT
end

#ssl?Boolean

Returns:

  • (Boolean)

393
394
395
# File 'actionpack/lib/action_dispatch/http/request.rb', line 393

def ssl?
  super || scheme == 'wss'.freeze
end

#xml_http_request?Boolean Also known as: xhr?

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.

Returns:

  • (Boolean)

239
240
241
# File 'actionpack/lib/action_dispatch/http/request.rb', line 239

def xml_http_request?
  get_header('HTTP_X_REQUESTED_WITH') =~ /XMLHttpRequest/i
end