Class: Rack::Request
- Inherits:
-
Object
show all
- Defined in:
- lib/action_controller/vendor/rack-1.0/rack/request.rb,
lib/action_controller/vendor/rack-1.0/rack/auth/openid.rb
Overview
Rack::Request provides a convenient interface to a Rack environment. It is stateless, the environment env
passed to the constructor will be directly modified.
req = Rack::Request.new(env)
req.post?
req.params["data"]
The environment hash passed will store a reference to the Request object instantiated so that it will only instantiate if an instance of the Request object doesn’t already exist.
Constant Summary
collapse
- FORM_DATA_MEDIA_TYPES =
The set of form-data media-types. Requests that do not indicate one of the media types presents in this list will not be eligible for form-data / param parsing.
[
nil,
'application/x-www-form-urlencoded',
'multipart/form-data'
]
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
Constructor Details
#initialize(env) ⇒ Request
Returns a new instance of Request.
28
29
30
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 28
def initialize(env)
@env = env
end
|
Instance Attribute Details
The environment of the request.
18
19
20
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 18
def env
@env
end
|
Class Method Details
20
21
22
23
24
25
26
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 20
def self.new(env)
if self == Rack::Request
env["rack.request"] ||= super
else
super
end
end
|
Instance Method Details
155
156
157
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 155
def [](key)
params[key.to_s]
end
|
#[]=(key, value) ⇒ Object
160
161
162
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 160
def []=(key, value)
params[key.to_s] = value
end
|
#accept_encoding ⇒ Object
221
222
223
224
225
226
227
228
229
230
231
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 221
def accept_encoding
@env["HTTP_ACCEPT_ENCODING"].to_s.split(/,\s*/).map do |part|
m = /^([^\s,]+?)(?:;\s*q=(\d+(?:\.\d+)?))?$/.match(part)
if m
[m[1], (m[2] || 1.0).to_f]
else
raise "Invalid value for Accept-Encoding: #{part.inspect}"
end
end
end
|
32
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 32
def body; @env["rack.input"] end
|
#content_charset ⇒ Object
The character set of the request body if a “charset” media type parameter was given, or nil if no “charset” was specified. Note that, per RFC2616, text/* media types that specify no explicit charset are to be considered ISO-8859-1.
68
69
70
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 68
def content_charset
media_type_params['charset']
end
|
#content_length ⇒ Object
39
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 39
def content_length; @env['CONTENT_LENGTH'] end
|
#content_type ⇒ Object
40
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 40
def content_type; @env['CONTENT_TYPE'] end
|
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 176
def cookies
return {} unless @env["HTTP_COOKIE"]
if @env["rack.request.cookie_string"] == @env["HTTP_COOKIE"]
@env["rack.request.cookie_hash"]
else
@env["rack.request.cookie_string"] = @env["HTTP_COOKIE"]
@env["rack.request.cookie_hash"] =
Utils.parse_query(@env["rack.request.cookie_string"], ';,').inject({}) {|h,(k,v)|
h[k] = Array === v ? v.first : v
h
}
end
end
|
#delete? ⇒ Boolean
83
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 83
def delete?; request_method == "DELETE" end
|
Determine whether the request body contains form-data by checking the request media_type against registered form-data media-types: “application/x-www-form-urlencoded” and “multipart/form-data”. The list of form-data media types can be modified through the FORM_DATA_MEDIA_TYPES
array.
100
101
102
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 100
def form_data?
FORM_DATA_MEDIA_TYPES.include?(media_type)
end
|
215
216
217
218
219
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 215
def fullpath
path = script_name + path_info
path << "?" << query_string unless query_string.empty?
path
end
|
Returns the data recieved in the query string.
105
106
107
108
109
110
111
112
113
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 105
def GET
if @env["rack.request.query_string"] == query_string
@env["rack.request.query_hash"]
else
@env["rack.request.query_string"] = query_string
@env["rack.request.query_hash"] =
Utils.parse_nested_query(query_string)
end
end
|
#get? ⇒ Boolean
80
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 80
def get?; request_method == "GET" end
|
#head? ⇒ Boolean
84
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 84
def head?; request_method == "HEAD" end
|
72
73
74
75
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 72
def host
(@env["HTTP_HOST"] || @env["SERVER_NAME"]).gsub(/:\d+\z/, '')
end
|
233
234
235
236
237
238
239
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 233
def ip
if addr = @env['HTTP_X_FORWARDED_FOR']
addr.split(',').last.strip
else
@env['REMOTE_ADDR']
end
end
|
The media type (type/subtype) portion of the CONTENT_TYPE header without any media type parameters. e.g., when CONTENT_TYPE is “text/plain;charset=utf-8”, the media-type is “text/plain”.
For more information on the use of media types in HTTP, see: www.w3.org/Protocols/rfc2616/rfc2616-sec3.html#sec3.7
48
49
50
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 48
def media_type
content_type && content_type.split(/\s*[;,]\s*/, 2)[0].downcase
end
|
The media type parameters provided in CONTENT_TYPE as a Hash, or an empty Hash if no CONTENT_TYPE or media-type parameters were provided. e.g., when the CONTENT_TYPE is “text/plain;charset=utf-8”, this method responds with the following Hash:
{ 'charset' => 'utf-8' }
57
58
59
60
61
62
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 57
def media_type_params
return {} if content_type.nil?
content_type.split(/\s*[;,]\s*/)[1..-1].
collect { |s| s.split('=', 2) }.
inject({}) { |hash,(k,v)| hash[k.downcase] = v ; hash }
end
|
#openid_request ⇒ Object
14
15
16
|
# File 'lib/action_controller/vendor/rack-1.0/rack/auth/openid.rb', line 14
def openid_request
@env['rack.auth.openid.request']
end
|
#openid_response ⇒ Object
18
19
20
|
# File 'lib/action_controller/vendor/rack-1.0/rack/auth/openid.rb', line 18
def openid_response
@env['rack.auth.openid.response']
end
|
The union of GET and POST data.
148
149
150
151
152
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 148
def params
self.put? ? self.GET : self.GET.update(self.POST)
rescue EOFError => e
self.GET
end
|
#path_info ⇒ Object
35
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 35
def path_info; @env["PATH_INFO"].to_s end
|
#path_info=(s) ⇒ Object
78
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 78
def path_info=(s); @env["PATH_INFO"] = s.to_s end
|
36
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 36
def port; @env["SERVER_PORT"].to_i end
|
Returns the data recieved in the request body.
This method support both application/x-www-form-urlencoded and multipart/form-data.
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 119
def POST
if @env["rack.request.form_input"].eql? @env["rack.input"]
@env["rack.request.form_hash"]
elsif form_data?
@env["rack.request.form_input"] = @env["rack.input"]
unless @env["rack.request.form_hash"] =
Utils::Multipart.parse_multipart(env)
form_vars = @env["rack.input"].read
form_vars.sub!(/\0\z/, '')
@env["rack.request.form_vars"] = form_vars
@env["rack.request.form_hash"] = Utils.parse_nested_query(form_vars)
begin
@env["rack.input"].rewind if @env["rack.input"].respond_to?(:rewind)
rescue Errno::ESPIPE
end
end
@env["rack.request.form_hash"]
else
{}
end
end
|
#post? ⇒ Boolean
81
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 81
def post?; request_method == "POST" end
|
#put? ⇒ Boolean
82
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 82
def put?; request_method == "PUT" end
|
#query_string ⇒ Object
38
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 38
def query_string; @env["QUERY_STRING"].to_s end
|
#referer ⇒ Object
Also known as:
referrer
the referer of the client or ‘/’
170
171
172
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 170
def referer
@env['HTTP_REFERER'] || '/'
end
|
#request_method ⇒ Object
37
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 37
def request_method; @env["REQUEST_METHOD"] end
|
33
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 33
def scheme; @env["rack.url_scheme"] end
|
#script_name ⇒ Object
34
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 34
def script_name; @env["SCRIPT_NAME"].to_s end
|
#script_name=(s) ⇒ Object
77
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 77
def script_name=(s); @env["SCRIPT_NAME"] = s.to_s end
|
Tries to return a remake of the original request URL as a string.
201
202
203
204
205
206
207
208
209
210
211
212
213
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 201
def url
url = scheme + "://"
url << host
if scheme == "https" && port != 443 ||
scheme == "http" && port != 80
url << ":#{port}"
end
url << fullpath
url
end
|
#values_at(*keys) ⇒ Object
165
166
167
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 165
def values_at(*keys)
keys.map{|key| params[key] }
end
|
#xhr? ⇒ Boolean
196
197
198
|
# File 'lib/action_controller/vendor/rack-1.0/rack/request.rb', line 196
def xhr?
@env["HTTP_X_REQUESTED_WITH"] == "XMLHttpRequest"
end
|