Class: ActionDispatch::Request

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

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
].freeze
PASS_NOT_FOUND =

:nodoc:

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

Constants included from PermissionsPolicy::Request

PermissionsPolicy::Request::POLICY

Constants included from ContentSecurityPolicy::Request

ContentSecurityPolicy::Request::NONCE, ContentSecurityPolicy::Request::NONCE_DIRECTIVES, ContentSecurityPolicy::Request::NONCE_GENERATOR, ContentSecurityPolicy::Request::POLICY, ContentSecurityPolicy::Request::POLICY_REPORT_ONLY

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

Http::MimeNegotiation::RESCUABLE_MIME_FORMAT_ERRORS

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 PermissionsPolicy::Request

#permissions_policy, #permissions_policy=

Methods included from ContentSecurityPolicy::Request

#content_security_policy, #content_security_policy=, #content_security_policy_nonce, #content_security_policy_nonce_directives, #content_security_policy_nonce_directives=, #content_security_policy_nonce_generator, #content_security_policy_nonce_generator=, #content_security_policy_report_only, #content_security_policy_report_only=

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, #prepend_features, #prepended

Methods included from Http::MimeNegotiation

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

Methods included from Http::Cache::Request

#etag_matches?, #fresh?, #if_modified_since, #if_none_match, #if_none_match_etags, #not_modified?

Methods included from Flash::RequestMethods

#flash, #flash=, #flash_hash

Constructor Details

#initialize(env) ⇒ Request

Returns a new instance of Request.


60
61
62
63
64
65
66
67
68
# File 'actionpack/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

Class Method Details

.emptyObject


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

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.


416
417
418
419
420
421
# File 'actionpack/lib/action_dispatch/http/request.rb', line 416

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.


345
346
347
348
349
350
351
352
# File 'actionpack/lib/action_dispatch/http/request.rb', line 345

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

#body_streamObject

:nodoc:


366
367
368
# File 'actionpack/lib/action_dispatch/http/request.rb', line 366

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

:nodoc:


70
71
# File 'actionpack/lib/action_dispatch/http/request.rb', line 70

def commit_cookie_jar! # :nodoc:
end

#commit_csrf_tokenObject


448
449
450
# File 'actionpack/lib/action_dispatch/http/request.rb', line 448

def commit_csrf_token
  controller_instance.commit_csrf_token(self) if controller_instance.respond_to?(:commit_csrf_token)
end

#commit_flashObject


437
438
# File 'actionpack/lib/action_dispatch/http/request.rb', line 437

def commit_flash
end

#content_lengthObject

Returns the content length of the request as an integer.


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

def content_length
  super.to_i
end

#controller_classObject


79
80
81
82
83
# File 'actionpack/lib/action_dispatch/http/request.rb', line 79

def controller_class
  params = path_parameters
  params[:action] ||= "index"
  controller_class_for(params[:controller])
end

#controller_class_for(name) ⇒ Object


85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
# File 'actionpack/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

#controller_instanceObject

:nodoc:


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

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

#controller_instance=(controller) ⇒ Object

:nodoc:


175
176
177
# File 'actionpack/lib/action_dispatch/http/request.rb', line 175

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

#engine_script_name(_routes) ⇒ Object

:nodoc:


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

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

#engine_script_name=(name) ⇒ Object

:nodoc:


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

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)

362
363
364
# File 'actionpack/lib/action_dispatch/http/request.rb', line 362

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"

260
261
262
# File 'actionpack/lib/action_dispatch/http/request.rb', line 260

def fullpath
  @fullpath ||= super
end

#GETObject Also known as: query_parameters

Override Rack's GET method to support indifferent access.


384
385
386
387
388
389
390
391
392
393
394
395
396
# File 'actionpack/lib/action_dispatch/http/request.rb', line 384

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 => e
  raise ActionController::BadRequest.new("Invalid query parameters: #{e.message}")
end

#headersObject

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

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

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

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

#http_auth_saltObject


179
180
181
# File 'actionpack/lib/action_dispatch/http/request.rb', line 179

def http_auth_salt
  get_header "action_dispatch.http_auth_salt"
end

#inspectObject

:nodoc:


440
441
442
# File 'actionpack/lib/action_dispatch/http/request.rb', line 440

def inspect # :nodoc:
  "#<#{self.class.name} #{method} #{original_url.dump} for #{remote_ip}>"
end

#ipObject

Returns the IP address of client as a String.


294
295
296
# File 'actionpack/lib/action_dispatch/http/request.rb', line 294

def ip
  @ip ||= super
end

#key?(key) ⇒ Boolean

Returns true if the request has a header matching the given key parameter.

request.key? :ip_spoofing_check # => true

Returns:

  • (Boolean)

106
107
108
# File 'actionpack/lib/action_dispatch/http/request.rb', line 106

def key?(key)
  has_header? key
end

#local?Boolean

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

Returns:

  • (Boolean)

424
425
426
# File 'actionpack/lib/action_dispatch/http/request.rb', line 424

def local?
  LOCALHOST.match?(remote_addr) && LOCALHOST.match?(remote_ip)
end

#loggerObject


433
434
435
# File 'actionpack/lib/action_dispatch/http/request.rb', line 433

def logger
  get_header("action_dispatch.logger")
end

#media_typeObject

The String MIME type of the request.

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

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

def media_type
  content_mime_type&.to_s
end

#method(*args) ⇒ Object

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

For debugging purposes, when called with arguments this method will fallback to Object#method


201
202
203
204
205
206
207
208
209
210
# File 'actionpack/lib/action_dispatch/http/request.rb', line 201

def method(*args)
  if args.empty?
    @method ||= check_method(
      get_header("rack.methodoverride.original_method") ||
      get_header("REQUEST_METHOD")
    )
  else
    super
  end
end

#method_symbolObject

Returns a symbol form of the #method.


214
215
216
# File 'actionpack/lib/action_dispatch/http/request.rb', line 214

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'

249
250
251
# File 'actionpack/lib/action_dispatch/http/request.rb', line 249

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"

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

def original_url
  base_url + original_fullpath
end

#POSTObject Also known as: request_parameters

Override Rack's POST method to support indifferent access.


400
401
402
403
404
405
406
407
408
409
410
411
# File 'actionpack/lib/action_dispatch/http/request.rb', line 400

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 => 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.


334
335
336
337
338
339
340
341
# File 'actionpack/lib/action_dispatch/http/request.rb', line 334

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

#raw_request_methodObject

:nodoc:


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

alias raw_request_method request_method

#remote_ipObject

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


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

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

#remote_ip=(remote_ip) ⇒ Object


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

def remote_ip=(remote_ip)
  @remote_ip = nil
  set_header "action_dispatch.remote_ip", 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.


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

def request_id
  get_header ACTION_DISPATCH_REQUEST_ID
end

#request_id=(id) ⇒ Object

:nodoc:


321
322
323
# File 'actionpack/lib/action_dispatch/http/request.rb', line 321

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.


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

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

#request_method=(request_method) ⇒ Object

:nodoc:


165
166
167
168
169
# File 'actionpack/lib/action_dispatch/http/request.rb', line 165

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.


191
192
193
# File 'actionpack/lib/action_dispatch/http/request.rb', line 191

def request_method_symbol
  HTTP_METHOD_LOOKUP[request_method]
end

#request_parameters=(params) ⇒ Object


428
429
430
431
# File 'actionpack/lib/action_dispatch/http/request.rb', line 428

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

#reset_csrf_tokenObject


444
445
446
# File 'actionpack/lib/action_dispatch/http/request.rb', line 444

def reset_csrf_token
  controller_instance.reset_csrf_token(self) if controller_instance.respond_to?(:reset_csrf_token)
end

#reset_sessionObject


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

def reset_session
  session.destroy
  reset_csrf_token
end

#routesObject

:nodoc:


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

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

#routes=(routes) ⇒ Object

:nodoc:


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

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

#send_early_hints(links) ⇒ Object

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.


236
237
238
239
240
# File 'actionpack/lib/action_dispatch/http/request.rb', line 236

def send_early_hints(links)
  return unless env["rack.early_hints"]

  env["rack.early_hints"].call(links)
end

#server_softwareObject

Returns the lowercase name of the HTTP server software.


328
329
330
# File 'actionpack/lib/action_dispatch/http/request.rb', line 328

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

#session=(session) ⇒ Object

:nodoc:


375
376
377
# File 'actionpack/lib/action_dispatch/http/request.rb', line 375

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

#session_options=(options) ⇒ Object


379
380
381
# File 'actionpack/lib/action_dispatch/http/request.rb', line 379

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

#show_exceptions?Boolean

:nodoc:

Returns:

  • (Boolean)

183
184
185
186
187
188
# File 'actionpack/lib/action_dispatch/http/request.rb', line 183

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") == false)
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)

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

def xml_http_request?
  /XMLHttpRequest/i.match?(get_header("HTTP_X_REQUESTED_WITH"))
end