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
Class Chain:
self, Rack::Request
Instance Chain:
Inherits: Rack::Request
  • ::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

PARAMETERS_KEY

Http::FilterParameters - Included

KV_RE, PAIR_RE

Http::URL - Included

HOST_REGEXP, IP_HOST_REGEXP, PROTOCOL_REGEXP

Http::MimeNegotiation - Attributes & Methods

Class Method Summary

Instance Attribute Summary

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

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 for this request, such as “example.com”.

#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

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

#filtered_parameters

Return a hash of parameters with all sensitive data replaced.

#filtered_path

Reconstructed a path with all sensitive #GET parameters replaced.

#initialize

Http::Parameters - Included

#parameters

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

#params
#symbolized_path_parameters

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::XML.

#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

Receives an array of mimes and return the first user sent mime that matches the order array.

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 45

def initialize(env)
  super
  @method            = nil
  @request_method    = nil
  @remote_ip         = nil
  @original_fullpath = nil
  @fullpath          = nil
  @ip                = nil
  @uuid              = 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 9

mattr_accessor :ignore_accept_header

Instance Attribute Details

#delete?Boolean (readonly)

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

[ GitHub ]

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

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

#form_data?Boolean (readonly)

[ GitHub ]

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

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

#get?Boolean (readonly)

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

[ GitHub ]

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

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

#head?Boolean (readonly)

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

[ GitHub ]

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

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

#ignore_accept_header (rw)

[ GitHub ]

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

mattr_accessor :ignore_accept_header

#local?Boolean (readonly)

True if the request came from localhost, 127.0.0.1.

[ GitHub ]

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

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

#patch?Boolean (readonly)

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

[ GitHub ]

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

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

#post?Boolean (readonly)

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

[ GitHub ]

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

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

#put?Boolean (readonly)

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

[ GitHub ]

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

def put?
  HTTP_METHOD_LOOKUP[request_method] == :put
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 104

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

#session_options=(options) (writeonly)

[ GitHub ]

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

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

#xhr? (readonly)

Alias for #xml_http_request?.

[ GitHub ]

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

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 220

def xml_http_request?
  @env['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 316

def authorization
  @env['HTTP_AUTHORIZATION']   ||
  @env['X-HTTP_AUTHORIZATION'] ||
  @env['X_HTTP_AUTHORIZATION'] ||
  @env['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 262

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

#check_path_parameters!

[ GitHub ]

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

def check_path_parameters!
  # If any of the path parameters has an invalid encoding then
  # raise since it's likely to trigger errors further on.
  path_parameters.each do |key, value|
    next unless value.respond_to?(:valid_encoding?)
    unless value.valid_encoding?
      raise ActionController::BadRequest, "Invalid parameter: #{key} => #{value}"
    end
  end
end

#content_length

Returns the content length of the request as an integer.

[ GitHub ]

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

def content_length
  super.to_i
end

#deep_munge(hash)

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

[ GitHub ]

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

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

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

[ GitHub ]

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

def flash
  @env[Flash::KEY] ||= Flash::FlashHash.from_session_value(session["flash"])
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 192

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 299

def GET
  @env["action_dispatch.request.query_parameters"] ||= Utils.deep_munge(normalize_encode_params(super || {}))
rescue Rack::Utils::ParameterTypeError, Rack::Utils::InvalidParameterError => e
  raise ActionController::BadRequest.new(:query, e)
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 170

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

#ip

[ GitHub ]

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

def ip
  @ip ||= super
end

#key?(key) ⇒ Boolean

[ GitHub ]

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

def key?(key)
  @env.key?(key)
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 208

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 122

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

#method_symbol

Returns a symbol form of the #method

[ GitHub ]

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

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 181

def original_fullpath
  @original_fullpath ||= (env["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 200

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 307

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

#query_parameters

Alias for #GET.

[ GitHub ]

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

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 251

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

Originating IP address, usually set by the RemoteIp middleware.

[ GitHub ]

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

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

#request_method_symbol

Returns a symbol form of the #request_method

[ GitHub ]

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

def request_method_symbol
  HTTP_METHOD_LOOKUP[request_method]
end

#request_parameters

Alias for #POST.

[ GitHub ]

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

alias :request_parameters :POST

#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 281

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

Returns the lowercase name of the HTTP server software.

[ GitHub ]

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

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

#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 240

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