Class: ActionController::Request

Inherits:
Rack::Request show all
Defined in:
lib/action_controller/request.rb

Direct Known Subclasses

TestRequest

Constant Summary collapse

HTTP_METHODS = 
%w(get head put post delete options)
HTTP_METHOD_LOOKUP = 
HTTP_METHODS.inject({}) { |h, m| h[m] = h[m.upcase] = m.to_sym; h }
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

Constants inherited from Rack::Request

Rack::Request::FORM_DATA_MEDIA_TYPES

Instance Attribute Summary

Attributes inherited from Rack::Request

#env

Instance Method Summary collapse

Methods inherited from Rack::Request

#[], #[]=, #accept_encoding, #content_charset, #cookies, #fullpath, #initialize, #ip, #media_type, #media_type_params, new, #openid_request, #openid_response, #path_info, #path_info=, #referer, #scheme, #script_name, #script_name=, #values_at

Constructor Details

This class inherits a constructor from Rack::Request

Instance Method Details

#accepts ⇒ Object

Returns the accepted MIME type for the request.



99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/action_controller/request.rb', line 99

def accepts
  @accepts ||= begin
    header = @env['HTTP_ACCEPT'].to_s.strip

    if header.empty?
      [content_type, Mime::ALL].compact
    else
      Mime::Type.parse(header)
    end
  end
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.



407
408
409
410
411
412
413
414
 
# File 'lib/action_controller/request.rb', line 407

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:



432
433
434
 
# File 'lib/action_controller/request.rb', line 432

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

#cache_format ⇒ Object 



195
196
197
 
# File 'lib/action_controller/request.rb', line 195

def cache_format
  parameters[:format]
end

#content_length ⇒ Object

Returns the content length of the request as an integer.



80
81
82
 
# File 'lib/action_controller/request.rb', line 80

def content_length
  super.to_i
end

#content_type ⇒ Object

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

For backward compatibility, the post format is extracted from the X-Post-Data-Format HTTP header if present.



88
89
90
91
92
93
94
95
96
 
# File 'lib/action_controller/request.rb', line 88

def content_type
  @content_type ||= begin
    if @env['CONTENT_TYPE'] =~ /^([^,\;]*)/
      Mime::Type.lookup($1.strip.downcase)
    else
      nil
    end
  end
end

#delete? ⇒ Boolean

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

Returns:

  • (Boolean) 


62
63
64
 
# File 'lib/action_controller/request.rb', line 62

def delete?
  request_method == :delete
end

#domain(tld_length = 1) ⇒ Object

Returns the domain part of a host, such as “rubyonrails.org” in “www.rubyonrails.org”. You can specify a different tld_length, such as 2 to catch rubyonrails.co.uk in “www.rubyonrails.co.uk”.



315
316
317
318
319
 
# File 'lib/action_controller/request.rb', line 315

def domain(tld_length = 1)
  return nil unless named_host?(host)

  host.split('.').last(1 + tld_length).join('.')
end

#etag_matches?(etag) ⇒ Boolean

Returns:

  • (Boolean) 


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

def etag_matches?(etag)
  if_none_match && if_none_match == etag
end

#form_data? ⇒ Boolean

Returns:

  • (Boolean) 


416
417
418
 
# File 'lib/action_controller/request.rb', line 416

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

#format ⇒ Object

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

GET /posts/5.xml   | request.format => Mime::XML
GET /posts/5.xhtml | request.format => Mime::HTML
GET /posts/5       | request.format => Mime::HTML or MIME::JS, or request.accepts.first depending on the value of <tt>ActionController::Base.use_accept_header</tt>



150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/action_controller/request.rb', line 150

def format
  @format ||=
    if parameters[:format]
      Mime::Type.lookup_by_extension(parameters[:format])
    elsif ActionController::Base.use_accept_header
      accepts.first
    elsif xhr?
      Mime::Type.lookup_by_extension("js")
    else
      Mime::Type.lookup_by_extension("html")
    end
end

#format=(extension) ⇒ Object

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

class ApplicationController < ActionController::Base
  before_filter :adjust_format_for_iphone

  private
    def adjust_format_for_iphone
      request.format = :iphone if request.env["HTTP_USER_AGENT"][/iPhone/]
    end
end



175
176
177
178
 
# File 'lib/action_controller/request.rb', line 175

def format=(extension)
  parameters[:format] = extension.to_s
  @format = Mime::Type.lookup_by_extension(parameters[:format])
end

#fresh?(response) ⇒ Boolean

Check response freshness (Last-Modified and ETag) against request If-Modified-Since and If-None-Match conditions. If both headers are supplied, both must match, or the request is not considered fresh.

Returns:

  • (Boolean) 


132
133
134
135
136
137
138
139
140
141
142
143
 
# File 'lib/action_controller/request.rb', line 132

def fresh?(response)
  case
  when if_modified_since && if_none_match
    not_modified?(response.last_modified) && etag_matches?(response.etag)
  when if_modified_since
    not_modified?(response.last_modified)
  when if_none_match
    etag_matches?(response.etag)
  else
    false
  end
end

#GET ⇒ Object Also known as: query_parameters

Override Rack’s GET method to support indifferent access



421
422
423
 
# File 'lib/action_controller/request.rb', line 421

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

#get? ⇒ Boolean

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

Returns:

  • (Boolean) 


47
48
49
 
# File 'lib/action_controller/request.rb', line 47

def get?
  method == :get
end

#head? ⇒ Boolean

Is this a HEAD request? Since request.method sees HEAD as :get, this method checks the actual HTTP method directly.

Returns:

  • (Boolean) 


68
69
70
 
# File 'lib/action_controller/request.rb', line 68

def head?
  request_method == :head
end

#headers ⇒ Object

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

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



75
76
77
 
# File 'lib/action_controller/request.rb', line 75

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

#host ⇒ Object

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



280
281
282
 
# File 'lib/action_controller/request.rb', line 280

def host
  raw_host_with_port.sub(/:\d+$/, '')
end

#host_with_port ⇒ Object

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



286
287
288
 
# File 'lib/action_controller/request.rb', line 286

def host_with_port
  "#{host}#{port_string}"
end

#if_modified_since ⇒ Object 



111
112
113
114
115
 
# File 'lib/action_controller/request.rb', line 111

def if_modified_since
  if since = env['HTTP_IF_MODIFIED_SINCE']
    Time.rfc2822(since) rescue nil
  end
end

#if_none_match ⇒ Object 



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

def if_none_match
  env['HTTP_IF_NONE_MATCH']
end

#key?(key) ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
 
# File 'lib/action_controller/request.rb', line 24

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

#method ⇒ Object

Returns the HTTP request method used for action processing as a lowercase symbol, such as :post. (Unlike #request_method, this method returns :get for a HEAD request because the two are functionally equivalent from the application’s perspective.)



42
43
44
 
# File 'lib/action_controller/request.rb', line 42

def method
  request_method == :head ? :get : request_method
end

#not_modified?(modified_at) ⇒ Boolean

Returns:

  • (Boolean) 


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

def not_modified?(modified_at)
  if_modified_since && modified_at && if_modified_since >= modified_at
end

#parameters ⇒ Object Also known as: params

Returns both GET and POST parameters in a single hash.



380
381
382
 
# File 'lib/action_controller/request.rb', line 380

def parameters
  @parameters ||= request_parameters.merge(query_parameters).update(path_parameters).with_indifferent_access
end

#path ⇒ Object

Returns the interpreted path to requested resource after all the installation directory of this application was taken into account.



363
364
365
366
367
 
# File 'lib/action_controller/request.rb', line 363

def path
  path = request_uri.to_s[/\A[^\?]*/]
  path.sub!(/\A#{ActionController::Base.relative_url_root}/, '')
  path
end

#path_parameters ⇒ Object

Returns a hash with the parameters used to form the path of the request. Returned hash keys are strings:

{'action' => 'my_action', 'controller' => 'my_controller'}

See symbolized_path_parameters for symbolized keys.



401
402
403
 
# File 'lib/action_controller/request.rb', line 401

def path_parameters
  @env["rack.routing_args"] ||= {}
end

#path_parameters=(parameters) ⇒ Object

:nodoc:



385
386
387
388
 
# File 'lib/action_controller/request.rb', line 385

def path_parameters=(parameters) #:nodoc:
  @env["rack.routing_args"] = parameters
  @symbolized_path_parameters = @parameters = nil
end

#port ⇒ Object

Returns the port number of this request as an integer.



291
292
293
294
295
296
297
 
# File 'lib/action_controller/request.rb', line 291

def port
  if raw_host_with_port =~ /:(\d+)$/
    $1.to_i
  else
    standard_port
  end
end

#port_string ⇒ Object

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



309
310
311
 
# File 'lib/action_controller/request.rb', line 309

def port_string
  port == standard_port ? '' : ":#{port}"
end

#POST ⇒ Object Also known as: request_parameters

Override Rack’s POST method to support indifferent access



427
428
429
 
# File 'lib/action_controller/request.rb', line 427

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

#post? ⇒ Boolean

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

Returns:

  • (Boolean) 


52
53
54
 
# File 'lib/action_controller/request.rb', line 52

def post?
  request_method == :post
end

#protocol ⇒ Object

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



261
262
263
 
# File 'lib/action_controller/request.rb', line 261

def protocol
  ssl? ? 'https://' : 'http://'
end

#put? ⇒ Boolean

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

Returns:

  • (Boolean) 


57
58
59
 
# File 'lib/action_controller/request.rb', line 57

def put?
  request_method == :put
end

#query_string ⇒ Object

Returns the query string, accounting for server idiosyncrasies.



332
333
334
 
# File 'lib/action_controller/request.rb', line 332

def query_string
  @env['QUERY_STRING'].present? ? @env['QUERY_STRING'] : (@env['REQUEST_URI'].split('?', 2)[1] || '')
end

#raw_host_with_port ⇒ Object

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



271
272
273
274
275
276
277
 
# File 'lib/action_controller/request.rb', line 271

def raw_host_with_port
  if forwarded = env["HTTP_X_FORWARDED_HOST"]
    forwarded.split(/,\s?/).last
  else
    env['HTTP_HOST'] || "#{env['SERVER_NAME'] || env['SERVER_ADDR']}:#{env['SERVER_PORT']}"
  end
end

#raw_post ⇒ Object

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



371
372
373
374
375
376
377
 
# File 'lib/action_controller/request.rb', line 371

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.



217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/action_controller/request.rb', line 217

def remote_ip
  remote_addr_list = @env['REMOTE_ADDR'] && @env['REMOTE_ADDR'].scan(/[^,\s]+/)

  unless remote_addr_list.blank?
    not_trusted_addrs = remote_addr_list.reject {|addr| addr =~ TRUSTED_PROXIES}
    return not_trusted_addrs.first unless not_trusted_addrs.empty?
  end
  remote_ips = @env['HTTP_X_FORWARDED_FOR'] && @env['HTTP_X_FORWARDED_FOR'].split(',')

  if @env.include? 'HTTP_CLIENT_IP'
    if ActionController::Base.ip_spoofing_check && remote_ips && !remote_ips.include?(@env['HTTP_CLIENT_IP'])
      # We don't know which came from the proxy, and which from the user
      raise ActionControllerError.new("IP spoofing attack?!\nHTTP_CLIENT_IP=\#{@env['HTTP_CLIENT_IP'].inspect}\nHTTP_X_FORWARDED_FOR=\#{@env['HTTP_X_FORWARDED_FOR'].inspect}\n")
    end

    return @env['HTTP_CLIENT_IP']
  end

  if remote_ips
    while remote_ips.size > 1 && TRUSTED_PROXIES =~ remote_ips.last.strip
      remote_ips.pop
    end

    return remote_ips.last.strip
  end

  @env['REMOTE_ADDR']
end

#request_method ⇒ Object

Returns the true HTTP request method as a lowercase symbol, such as :get. If the request method is not listed in the HTTP_METHODS constant above, an UnknownHttpMethod exception is raised.



34
35
36
 
# File 'lib/action_controller/request.rb', line 34

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

#request_uri ⇒ Object

Returns the request URI, accounting for server idiosyncrasies. WEBrick includes the full URL. IIS leaves REQUEST_URI blank.



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/action_controller/request.rb', line 338

def request_uri
  if uri = @env['REQUEST_URI']
    # Remove domain, which webrick puts into the request_uri.
    (%r{^\w+\://[^/]+(/.*|$)$} =~ uri) ? $1 : uri
  else
    # Construct IIS missing REQUEST_URI from SCRIPT_NAME and PATH_INFO.
    uri = @env['PATH_INFO'].to_s

    if script_filename = @env['SCRIPT_NAME'].to_s.match(%r{[^/]+$})
      uri = uri.sub(/#{script_filename}\//, '')
    end

    env_qs = @env['QUERY_STRING'].to_s
    uri += "?#{env_qs}" unless env_qs.empty?

    if uri.blank?
      @env.delete('REQUEST_URI')
    else
      @env['REQUEST_URI'] = uri
    end
  end
end

#reset_session ⇒ Object 



444
445
446
447
 
# File 'lib/action_controller/request.rb', line 444

def reset_session
  @env['rack.session.options'].delete(:id)
  @env['rack.session'] = {}
end

#server_port ⇒ Object 



457
458
459
 
# File 'lib/action_controller/request.rb', line 457

def server_port
  @env['SERVER_PORT'].to_i
end

#server_software ⇒ Object

Returns the lowercase name of the HTTP server software.



251
252
253
 
# File 'lib/action_controller/request.rb', line 251

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

#session ⇒ Object 



436
437
438
 
# File 'lib/action_controller/request.rb', line 436

def session
  @env['rack.session'] ||= {}
end

#session=(session) ⇒ Object

:nodoc:



440
441
442
 
# File 'lib/action_controller/request.rb', line 440

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

#session_options ⇒ Object 



449
450
451
 
# File 'lib/action_controller/request.rb', line 449

def session_options
  @env['rack.session.options'] ||= {}
end

#session_options=(options) ⇒ Object 



453
454
455
 
# File 'lib/action_controller/request.rb', line 453

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

#ssl? ⇒ Boolean

Is this an SSL request?

Returns:

  • (Boolean) 


266
267
268
 
# File 'lib/action_controller/request.rb', line 266

def ssl?
  @env['HTTPS'] == 'on' || @env['HTTP_X_FORWARDED_PROTO'] == 'https'
end

#standard_port ⇒ Object

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



300
301
302
303
304
305
 
# File 'lib/action_controller/request.rb', line 300

def standard_port
  case protocol
    when 'https://' then 443
    else 80
  end
end

#subdomains(tld_length = 1) ⇒ Object

Returns all the subdomains as an array, so ["dev", "www"] would be returned for “dev.www.rubyonrails.org”. You can specify a different tld_length, such as 2 to catch ["www"] instead of ["www", "rubyonrails"] in “www.rubyonrails.co.uk”.



325
326
327
328
329
 
# File 'lib/action_controller/request.rb', line 325

def subdomains(tld_length = 1)
  return [] unless named_host?(host)
  parts = host.split('.')
  parts[0..-(tld_length+2)]
end

#symbolized_path_parameters ⇒ Object

The same as path_parameters with explicitly symbolized keys.



391
392
393
 
# File 'lib/action_controller/request.rb', line 391

def symbolized_path_parameters
  @symbolized_path_parameters ||= path_parameters.symbolize_keys
end

#template_format ⇒ Object

Returns a symbolized version of the :format parameter of the request. If no format is given it returns :jsfor Ajax requests and :html otherwise.



183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/action_controller/request.rb', line 183

def template_format
  parameter_format = parameters[:format]

  if parameter_format
    parameter_format
  elsif xhr?
    :js
  else
    :html
  end
end

#url ⇒ Object

Returns the complete URL used for this request.



256
257
258
 
# File 'lib/action_controller/request.rb', line 256

def url
  protocol + host_with_port + request_uri
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) 


202
203
204
 
# File 'lib/action_controller/request.rb', line 202

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