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
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) }
TRUSTED_PROXIES =

Which IP addresses are “trusted proxies” that can be stripped from the right-hand-side of X-Forwarded-For

/^127\.0\.0\.1$|^(10|172\.(1[6-9]|2[0-9]|30|31)|192\.168)\./i

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Http::URL

#domain, #host, #host_with_port, #port, #port_string, #protocol, #raw_host_with_port, #request_uri, #scheme, #server_port, #ssl?, #standard_port, #standard_port?, #subdomain, #subdomains, #url

Methods included from Http::FilterParameters

#filtered_env, #filtered_parameters, #filtered_path

Methods included from Http::Parameters

#parameters, #path_parameters, #path_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?

Class Method Details

.new(env) ⇒ Object 



37
38
39
40
41
42
43
 
# File 'lib/action_dispatch/http/request.rb', line 37

def self.new(env)
  if request = env["action_dispatch.request"] && request.instance_of?(self)
    return request
  end

  super
end

Instance Method Details

#authorization ⇒ Object

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



249
250
251
252
253
254
 
# File 'lib/action_dispatch/http/request.rb', line 249

def authorization
  @env['HTTP_AUTHORIZATION']   ||
  @env['X-HTTP_AUTHORIZATION'] ||
  @env['X_HTTP_AUTHORIZATION'] ||
  @env['REDIRECT_X_HTTP_AUTHORIZATION']
end

#body ⇒ Object

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



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

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_stream ⇒ Object

:nodoc:



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

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

#content_length ⇒ Object

Returns the content length of the request as an integer.



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

def content_length
  super.to_i
end

#cookie_jar ⇒ Object 



5
6
7
 
# File 'lib/action_dispatch/middleware/cookies.rb', line 5

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

#delete? ⇒ Boolean

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

Returns:

  • (Boolean) 


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

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

#flash ⇒ Object

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['action_dispatch.request.flash_hash'] ||= (session["flash"] || Flash::FlashHash.new)
end

#forgery_whitelisted? ⇒ Boolean

Returns:

  • (Boolean) 


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

def forgery_whitelisted?
  get?
end

#form_data? ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#fullpath ⇒ Object 



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

def fullpath
  @fullpath ||= super
end

#GET ⇒ Object Also known as: query_parameters

Override Rack’s GET method to support indifferent access



235
236
237
 
# File 'lib/action_dispatch/http/request.rb', line 235

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

Returns:

  • (Boolean) 


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

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

#head? ⇒ Boolean

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

Returns:

  • (Boolean) 


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

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

#headers ⇒ Object

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

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



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

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

#ip ⇒ Object 



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

def ip
  @ip ||= super
end

#key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


45
46
47
 
# File 'lib/action_dispatch/http/request.rb', line 45

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

#local? ⇒ Boolean

True if the request came from localhost, 127.0.0.1.

Returns:

  • (Boolean) 


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

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

#media_type ⇒ Object 



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

def media_type
  content_mime_type.to_s
end

#method ⇒ Object

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



90
91
92
93
94
95
96
 
# File 'lib/action_dispatch/http/request.rb', line 90

def method
  @method ||= begin
    method = env["rack.methodoverride.original_method"] || env['REQUEST_METHOD']
    HTTP_METHOD_LOOKUP[method] || raise(ActionController::UnknownHttpMethod, "#{method}, accepted HTTP methods are #{HTTP_METHODS.to_sentence(:locale => :en)}")
    method
  end
end

#method_symbol ⇒ Object

Returns a symbol form of the #method



99
100
101
 
# File 'lib/action_dispatch/http/request.rb', line 99

def method_symbol
  HTTP_METHOD_LOOKUP[method]
end

#POST ⇒ Object Also known as: request_parameters

Override Rack’s POST method to support indifferent access



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

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

#post? ⇒ Boolean

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

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/action_dispatch/http/request.rb', line 111

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

#put? ⇒ Boolean

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

Returns:

  • (Boolean) 


117
118
119
 
# File 'lib/action_dispatch/http/request.rb', line 117

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

#raw_post ⇒ Object

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



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

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_ip ⇒ Object

Determines originating IP address. REMOTE_ADDR is the standard but will fail if the user is behind a proxy. HTTP_CLIENT_IP and/or HTTP_X_FORWARDED_FOR are set by proxies so check for these if REMOTE_ADDR is a proxy. HTTP_X_FORWARDED_FOR may be a comma- delimited list in the case of multiple chained proxies; the last address which is not trusted is the originating IP.



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

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

#request_method ⇒ Object

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.



74
75
76
77
78
79
80
 
# File 'lib/action_dispatch/http/request.rb', line 74

def request_method
  @request_method ||= begin
    method = env["REQUEST_METHOD"]
    HTTP_METHOD_LOOKUP[method] || raise(ActionController::UnknownHttpMethod, "#{method}, accepted HTTP methods are #{HTTP_METHODS.to_sentence(:locale => :en)}")
    method
  end
end

#request_method_symbol ⇒ Object

Returns a symbol form of the #request_method



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

def request_method_symbol
  HTTP_METHOD_LOOKUP[request_method]
end

#reset_session ⇒ Object

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



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

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

#server_software ⇒ Object

Returns the lowercase name of the HTTP server software.



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

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

#session=(session) ⇒ Object

:nodoc:



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

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

#session_options=(options) ⇒ Object 



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

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

#xml_http_request? ⇒ Boolean Also known as: xhr?

Returns true if the request’s “X-Requested-With” header contains “XMLHttpRequest”. (The Prototype Javascript library sends this header with every Ajax request.)

Returns:

  • (Boolean) 


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

def xml_http_request?
  !(@env['HTTP_X_REQUESTED_WITH'] !~ /XMLHttpRequest/i)
end