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:
actionpack/lib/action_dispatch/http/request.rb,
actionpack/lib/action_dispatch/middleware/flash.rb,
actionpack/lib/action_dispatch/middleware/cookies.rb

Direct Known Subclasses

TestRequest

Constant Summary

LOCALHOST =
[/^127\.0\.0\.\d{1,3}$/, "::1", /^0:0:0:0:0:0:0:1(%.*)?$/].freeze
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

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

Methods included from ActiveSupport::Concern

#append_features, extended, #included

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

+ (Object) new(env)



35
36
37
38
39
40
41
# File 'actionpack/lib/action_dispatch/http/request.rb', line 35

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

  super
end

Instance Method Details

- (Object) authorization

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



230
231
232
233
234
235
# File 'actionpack/lib/action_dispatch/http/request.rb', line 230

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

- (Object) body

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



182
183
184
185
186
187
188
189
# File 'actionpack/lib/action_dispatch/http/request.rb', line 182

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

- (Object) body_stream

:nodoc:



195
196
197
# File 'actionpack/lib/action_dispatch/http/request.rb', line 195

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

- (Object) content_length

Returns the content length of the request as an integer.



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

def content_length
  super.to_i
end


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

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

- (Boolean) delete?

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

Returns:

  • (Boolean)


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

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

- (Object) 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.



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

def flash
  @env['action_dispatch.request.flash_hash'] ||= (session["flash"] || Flash::FlashHash.new)
end

- (Boolean) forgery_whitelisted?

Returns:

  • (Boolean)


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

def forgery_whitelisted?
  get? || xhr? || content_mime_type.nil? || !content_mime_type.verify_request?
end

- (Boolean) form_data?

Returns:

  • (Boolean)


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

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

- (Object) fullpath



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

def fullpath
  @fullpath ||= super
end

- (Object) GET Also known as: query_parameters

Override Rack's GET method to support indifferent access



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

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

- (Boolean) get?

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

Returns:

  • (Boolean)


87
88
89
# File 'actionpack/lib/action_dispatch/http/request.rb', line 87

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

- (Boolean) head?

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

Returns:

  • (Boolean)


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

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

- (Object) headers

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

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


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

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

- (Object) ip



147
148
149
# File 'actionpack/lib/action_dispatch/http/request.rb', line 147

def ip
  @ip ||= super
end

- (Boolean) key?(key)

Returns:

  • (Boolean)


43
44
45
# File 'actionpack/lib/action_dispatch/http/request.rb', line 43

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

- (Boolean) local?

True if the request came from localhost, 127.0.0.1.

Returns:

  • (Boolean)


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

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

- (Object) media_type



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

def media_type
  content_mime_type.to_s
end

- (Object) method

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



72
73
74
75
76
77
78
# File 'actionpack/lib/action_dispatch/http/request.rb', line 72

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

- (Object) method_symbol

Returns a symbol form of the #method



81
82
83
# File 'actionpack/lib/action_dispatch/http/request.rb', line 81

def method_symbol
  HTTP_METHOD_LOOKUP[method]
end

- (Object) POST Also known as: request_parameters

Override Rack's POST method to support indifferent access



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

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

- (Boolean) post?

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

Returns:

  • (Boolean)


93
94
95
# File 'actionpack/lib/action_dispatch/http/request.rb', line 93

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

- (Boolean) put?

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

Returns:

  • (Boolean)


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

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

- (Object) raw_post

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



172
173
174
175
176
177
178
# File 'actionpack/lib/action_dispatch/http/request.rb', line 172

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

- (Object) remote_ip

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.



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

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

- (Object) request_method

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.



56
57
58
59
60
61
62
# File 'actionpack/lib/action_dispatch/http/request.rb', line 56

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

- (Object) request_method_symbol

Returns a symbol form of the #request_method



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

def request_method_symbol
  HTTP_METHOD_LOOKUP[request_method]
end

- (Object) reset_session

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



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

def reset_session
  session.destroy if session
  self.session = {}
  @env['action_dispatch.request.flash_hash'] = nil
end

- (Object) server_software

Returns the lowercase name of the HTTP server software.



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

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

- (Object) session=(session)

:nodoc:



207
208
209
# File 'actionpack/lib/action_dispatch/http/request.rb', line 207

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

- (Object) session_options=(options)



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

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

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


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

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