123456789_123456789_123456789_123456789_123456789_

Class: ActionDispatch::Request

Relationships & Source Files
Extension / Inclusion / Inheritance Descendants
Subclasses:
ActionController::TestRequest, TestRequest
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
Inherits: Object
Defined in: actionpack/lib/action_dispatch/http/request.rb,
actionpack/lib/action_dispatch/middleware/cookies.rb,
actionpack/lib/action_dispatch/middleware/flash.rb,
actionpack/lib/action_dispatch/request/session.rb,
actionpack/lib/action_dispatch/request/utils.rb

Constant Summary

Http::Cache::Request - Included

HTTP_IF_MODIFIED_SINCE, HTTP_IF_NONE_MATCH

Http::MimeNegotiation - Included

BROWSER_LIKE_ACCEPTS

Http::Parameters - Included

DEFAULT_PARSERS, PARAMETERS_KEY

Http::FilterParameters - Included

KV_RE, PAIR_RE

Http::URL - Included

HOST_REGEXP, IP_HOST_REGEXP, PROTOCOL_REGEXP

ContentSecurityPolicy::Request - Included

NONCE, NONCE_GENERATOR, POLICY, POLICY_REPORT_ONLY

Http::MimeNegotiation - Attributes & Methods

Http::Parameters - Attributes & Methods

Class Method Summary

Instance Attribute Summary

Flash::RequestMethods - Included

#flash

Access the contents of the flash.

#flash=

ContentSecurityPolicy::Request - Included

Http::URL - Included

#standard_port

Returns the standard port number for this request’s protocol.

#standard_port?

Returns whether this request is using the standard port.

#tld_length

Http::Parameters - Included

#path_parameters

Returns a hash with the parameters used to form the path of the request.

Http::MimeNegotiation - Included

#formats,
#formats=

Sets the formats by string extensions.

#variant,
#variant=

Sets the variant for template.

Instance Method Summary

ContentSecurityPolicy::Request - Included

Http::URL - Included

#domain

Returns the domain part of a host, such as “rubyonrails.org” in “www.rubyonrails.org”.

#host

Returns the host for this request, such as “example.com”.

#host_with_port

Returns a host:port string for this request, such as “example.com” or “example.com:8080”.

#initialize,
#optional_port

Returns a number port suffix like 8080 if the port number of this request is not the default HTTP port 80 or HTTPS port 443.

#port

Returns the port number of this request as an integer.

#port_string

Returns a string port suffix, including colon, like “:8080” if the port number of this request is not the default HTTP port 80 or HTTPS port 443.

#protocol

Returns ‘https://’ if this is an SSL request and ‘http://’ otherwise.

#raw_host_with_port

Returns the host and port for this request, such as “example.com:8080”.

#server_port

Returns the requested port, such as 8080, based on SERVER_PORT.

#subdomain

Returns all the subdomains as a string, so "dev.www" would be returned for “dev.www.rubyonrails.org”.

#subdomains

Returns all the subdomains as an array, so ["dev", "www"] would be returned for “dev.www.rubyonrails.org”.

#url

Returns the complete URL used for this request.

Http::FilterParameters - Included

#filtered_env

Returns a hash of request.env with all sensitive data replaced.

#filtered_parameters

Returns a hash of parameters with all sensitive data replaced.

#filtered_path

Reconstructs a path with all sensitive #GET parameters replaced.

#initialize, #env_filter, #filtered_query_string, #parameter_filter, #parameter_filter_for

Http::Parameters - Included

#parameters

Returns both #GET and #POST parameters in a single hash.

#params

Http::MimeNegotiation - Included

#accepts

Returns the accepted MIME type for the request.

#content_mime_type

The MIME type of the HTTP request, such as Mime.

#content_type,
#format

Returns the MIME type for the format used in the request.

#format=

Sets the format by string extension, which can be used to force custom formats that are not controlled by the extension.

#negotiate_mime

Returns the first MIME type that matches the provided array of MIME types.

#format_from_path_extension, #use_accept_header, #valid_accept_header

Http::Cache::Request - Included

#etag_matches?,
#fresh?

Check response freshness (Last-Modified and ETag) against request If-Modified-Since and If-None-Match conditions.

#if_modified_since, #if_none_match, #if_none_match_etags, #not_modified?

Constructor Details

.new(env) ⇒ Request

[ GitHub ]

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

def initialize(env)
  super
  @method            = nil
  @request_method    = nil
  @remote_ip         = nil
  @original_fullpath = nil
  @fullpath          = nil
  @ip                = nil
end

Class Attribute Details

.ignore_accept_header (rw) Also known as: #ignore_accept_header

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 11

mattr_accessor :ignore_accept_header, default: false

.parameter_parsers (readonly)

Returns the parameter parsers.

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/http/parameters.rb', line 28

attr_reader :parameter_parsers

Class Method Details

.empty

[ GitHub ]

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

def self.empty
  new({})
end

Instance Attribute Details

#form_data?Boolean (readonly)

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.

[ GitHub ]

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

def form_data?
  FORM_DATA_MEDIA_TYPES.include?(media_type)
end

#ignore_accept_header (rw)

[ GitHub ]

  
# File 'actionpack/lib/action_dispatch/http/mime_negotiation.rb', line 11

mattr_accessor :ignore_accept_header, default: false

#local?Boolean (readonly)

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

[ GitHub ]

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

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

#remote_ip (rw)

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

[ GitHub ]

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

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

#remote_ip=(remote_ip) (rw)

[ GitHub ]

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

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

#request_id (rw) 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 RequestId middleware.

[ GitHub ]

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

def request_id
  get_header ACTION_DISPATCH_REQUEST_ID
end

#request_method (rw)

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.

[ GitHub ]

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

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

#request_parameters (rw)

Alias for #POST.

[ GitHub ]

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

alias :request_parameters :POST

#request_parameters=(params) (rw)

[ GitHub ]

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

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

#session_options=(options) (writeonly)

[ GitHub ]

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

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

#ssl?Boolean (readonly)

[ GitHub ]

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

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

#uuid (readonly)

Alias for #request_id.

[ GitHub ]

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

alias_method :uuid, :request_id

#xhr? (readonly)

Alias for #xml_http_request?.

[ GitHub ]

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

alias :xhr? :xml_http_request?

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

[ GitHub ]

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

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

Instance Method Details

#authorization

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

[ GitHub ]

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

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

#body

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

[ GitHub ]

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

def body
  if raw_post = get_header("RAW_POST_DATA")
    raw_post = raw_post.dup.force_encoding(Encoding::BINARY)
    StringIO.new(raw_post)
  else
    body_stream
  end
end

#commit_flash

[ GitHub ]

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

def commit_flash
end

#content_length

Returns the content length of the request as an integer.

[ GitHub ]

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

def content_length
  super.to_i
end

#controller_class

[ GitHub ]

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

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

#controller_class_for(name)

[ GitHub ]

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

def controller_class_for(name)
  if name
    controller_param = name.underscore
    const_name = "#{controller_param.camelize}Controller"
    ActiveSupport::Dependencies.constantize(const_name)
  else
    PASS_NOT_FOUND
  end
end

#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"
[ GitHub ]

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

def fullpath
  @fullpath ||= super
end

GET Also known as: #query_parameters

Override Rack’s GET method to support indifferent access.

[ GitHub ]

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

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

#headers

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

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

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

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

#http_auth_salt

[ GitHub ]

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

def http_auth_salt
  get_header "action_dispatch.http_auth_salt"
end

#ip

Returns the IP address of client as a ::String.

[ GitHub ]

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

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
[ GitHub ]

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

def key?(key)
  has_header? key
end

#logger

[ GitHub ]

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

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

#media_type

The ::String MIME type of the request.

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

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

def media_type
  content_mime_type.to_s
end

#method

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

[ GitHub ]

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

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

#method_symbol

Returns a symbol form of the #method.

[ GitHub ]

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

def method_symbol
  HTTP_METHOD_LOOKUP[method]
end

#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'
[ GitHub ]

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

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

#original_url

Returns the original request URL as a ::String.

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

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

def original_url
  base_url + original_fullpath
end

POST Also known as: #request_parameters

Override Rack’s POST method to support indifferent access.

[ GitHub ]

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

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

#query_parameters

Alias for #GET.

[ GitHub ]

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

alias :query_parameters :GET

#raw_post

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

[ GitHub ]

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

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

#request_method_symbol

Returns a symbol form of the #request_method.

[ GitHub ]

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

def request_method_symbol
  HTTP_METHOD_LOOKUP[request_method]
end

#reset_session

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

[ GitHub ]

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

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

#send_early_hints(links)

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.

[ GitHub ]

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

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

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

#server_software

Returns the lowercase name of the HTTP server software.

[ GitHub ]

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

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