Class: ActionDispatch::Request

Inherits:
Rack::Request
  • Object
show all
Includes:
Http::Cache::Request, Http::FilterParameters, Http::MimeNegotiation, Http::Parameters, Http::URL, Http::Upload
Defined in:
lib/action_dispatch/http/request.rb,
lib/action_dispatch/middleware/flash.rb,
lib/action_dispatch/middleware/cookies.rb

Direct Known Subclasses

TestRequest

Constant Summary collapse

LOCALHOST =
[/^127\.0\.0\.\d{1,3}$/, "::1", /^0:0:0:0:0:0:0:1(%.*)?$/].freeze
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 =
Hash.new { |h, m| h[m] = m.underscore.to_sym if HTTP_METHODS.include?(m) }

Constants included from Http::Cache::Request

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

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

Methods included from Http::Cache::Request

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

Instance Method Details

#authorizationObject

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


238
239
240
241
242
243
# File 'lib/action_dispatch/http/request.rb', line 238

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


190
191
192
193
194
195
196
197
# File 'lib/action_dispatch/http/request.rb', line 190

def body
  if raw_post = @env['RAW_POST_DATA']
    raw_post.force_encoding(Encoding::BINARY) if raw_post.respond_to?(:force_encoding)
    StringIO.new(raw_post)
  else
    @env['rack.input']
  end
end

#body_streamObject

:nodoc:


203
204
205
# File 'lib/action_dispatch/http/request.rb', line 203

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

#content_lengthObject

Returns the content length of the request as an integer.


142
143
144
# File 'lib/action_dispatch/http/request.rb', line 142

def content_length
  super.to_i
end

7
8
9
# File 'lib/action_dispatch/middleware/cookies.rb', line 7

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

#deep_munge(hash) ⇒ Object

Remove nils from the params hash


251
252
253
254
255
256
257
258
259
260
261
262
263
264
# File 'lib/action_dispatch/http/request.rb', line 251

def deep_munge(hash)
  hash.each do |k, v|
    case v
    when Array
      v.grep(Hash) { |x| deep_munge(x) }
      v.compact!
      hash[k] = nil if v.empty?
    when Hash
      deep_munge(v)
    end
  end

  hash
end

#delete?Boolean

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

Returns:

  • (Boolean)

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

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

#flashObject

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.


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

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

#form_data?Boolean

Returns:

  • (Boolean)

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

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

#fullpathObject


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

def fullpath
  @fullpath ||= super
end

#GETObject Also known as: query_parameters

Override Rack's GET method to support indifferent access


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

def GET
  @env["action_dispatch.request.query_parameters"] ||= (normalize_parameters(super) || {})
end

#get?Boolean

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

Returns:

  • (Boolean)

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

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

#head?Boolean

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

Returns:

  • (Boolean)

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

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

#headersObject

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

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

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

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

#ipObject


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

def ip
  @ip ||= super
end

#key?(key) ⇒ Boolean

Returns:

  • (Boolean)

38
39
40
# File 'lib/action_dispatch/http/request.rb', line 38

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

#local?Boolean

True if the request came from localhost, 127.0.0.1.

Returns:

  • (Boolean)

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

def local?
  LOCALHOST.any? { |local_ip| local_ip === remote_addr && local_ip === remote_ip }
end

#media_typeObject


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

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.


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

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

#method_symbolObject

Returns a symbol form of the #method


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

def method_symbol
  HTTP_METHOD_LOOKUP[method]
end

#original_fullpathObject


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

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

#original_urlObject


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

def original_url
  base_url + original_fullpath
end

#POSTObject Also known as: request_parameters

Override Rack's POST method to support indifferent access


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

def POST
  @env["action_dispatch.request.request_parameters"] ||= (normalize_parameters(super) || {})
end

#post?Boolean

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

Returns:

  • (Boolean)

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

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

#put?Boolean

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

Returns:

  • (Boolean)

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

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

#raw_postObject

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


180
181
182
183
184
185
186
# File 'lib/action_dispatch/http/request.rb', line 180

def raw_post
  unless @env.include? 'RAW_POST_DATA'
    @env['RAW_POST_DATA'] = body.read(@env['CONTENT_LENGTH'].to_i)
    body.rewind if body.respond_to?(:rewind)
  end
  @env['RAW_POST_DATA']
end

#remote_ipObject

Originating IP address, usually set by the RemoteIp middleware.


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

def remote_ip
  @remote_ip ||= (@env["action_dispatch.remote_ip"] || ip).to_s
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.


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

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

#request_method_symbolObject

Returns a symbol form of the #request_method


72
73
74
# File 'lib/action_dispatch/http/request.rb', line 72

def request_method_symbol
  HTTP_METHOD_LOOKUP[request_method]
end

#reset_sessionObject

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


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

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

#server_softwareObject

Returns the lowercase name of the HTTP server software.


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

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

#session=(session) ⇒ Object

:nodoc:


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

def session=(session) #:nodoc:
  @env['rack.session'] = session
end

#session_options=(options) ⇒ Object


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

def session_options=(options)
  @env['rack.session.options'] = options
end

#uuidObject

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.


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

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

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

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

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