Class: Rack::Request

Inherits:
Object
  • Object
show all
Defined in:
lib/rack/request.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.

[
  'application/x-www-form-urlencoded',
  'multipart/form-data'
]
PARSEABLE_DATA_MEDIA_TYPES =

The set of media-types. Requests that do not indicate one of the media types presents in this list will not be eligible for param parsing like soap attachments or generic multiparts

[
  'multipart/related',
  'multipart/mixed'
]

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(env) ⇒ Request

Returns a new instance of Request.



20
21
22
 
# File 'lib/rack/request.rb', line 20

def initialize(env)
  @env = env
end

Instance Attribute Details

#env ⇒ Object (readonly)

The environment of the request.



18
19
20
 
# File 'lib/rack/request.rb', line 18

def env
  @env
end

Instance Method Details

#[](key) ⇒ Object

shortcut for request.params



227
228
229
 
# File 'lib/rack/request.rb', line 227

def [](key)
  params[key.to_s]
end

#[]=(key, value) ⇒ Object

shortcut for request.params = value



232
233
234
 
# File 'lib/rack/request.rb', line 232

def []=(key, value)
  params[key.to_s] = value
end

#accept_encoding ⇒ Object 



298
299
300
301
302
303
304
305
306
307
 
# File 'lib/rack/request.rb', line 298

def accept_encoding
  @env["HTTP_ACCEPT_ENCODING"].to_s.split(/\s*,\s*/).map do |part|
    encoding, parameters = part.split(/\s*;\s*/, 2)
    quality = 1.0
    if parameters and /\Aq=([\d.]+)/ =~ parameters
      quality = $1.to_f
    end
    [encoding, quality]
  end
end

#base_url ⇒ Object 



273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/rack/request.rb', line 273

def base_url
  url = scheme + "://"
  url << host

  if scheme == "https" && port != 443 ||
      scheme == "http" && port != 80
    url << ":#{port}"
  end

  url
end

#body ⇒ Object 



24
 
# File 'lib/rack/request.rb', line 24

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.



66
67
68
 
# File 'lib/rack/request.rb', line 66

def content_charset
  media_type_params['charset']
end

#content_length ⇒ Object 



29
 
# File 'lib/rack/request.rb', line 29

def content_length;  @env['CONTENT_LENGTH']                   end

#content_type ⇒ Object 



31
32
33
34
 
# File 'lib/rack/request.rb', line 31

def content_type
  content_type = @env['CONTENT_TYPE']
  content_type.nil? || content_type.empty? ? nil : content_type
end

#cookies ⇒ Object 



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

def cookies
  hash   = @env["rack.request.cookie_hash"] ||= {}
  string = @env["HTTP_COOKIE"]

  return hash if string == @env["rack.request.cookie_string"]
  hash.clear

  # According to RFC 2109:
  #   If multiple cookies satisfy the criteria above, they are ordered in
  #   the Cookie header such that those with more specific Path attributes
  #   precede those with less specific.  Ordering with respect to other
  #   attributes (e.g., Domain) is unspecified.
  cookies = Utils.parse_query(string, ';,') { |s| Rack::Utils.unescape(s) rescue s }
  cookies.each { |k,v| hash[k] = Array === v ? v.first : v }
  @env["rack.request.cookie_string"] = string
  hash
end

#delete? ⇒ Boolean

Checks the HTTP request method (or verb) to see if it was of type DELETE

Returns:

  • (Boolean) 


120
 
# File 'lib/rack/request.rb', line 120

def delete?;  request_method == "DELETE"  end

#form_data? ⇒ Boolean

Determine whether the request body contains form-data by checking the request Content-Type for one of the media-types: “application/x-www-form-urlencoded” or “multipart/form-data”. The list of form-data media types can be modified through the FORM_DATA_MEDIA_TYPES array.

A request body is also assumed to contain form-data when no Content-Type header is provided and the request_method is POST.

Returns:

  • (Boolean) 


168
169
170
171
172
 
# File 'lib/rack/request.rb', line 168

def form_data?
  type = media_type
  meth = env["rack.methodoverride.original_method"] || env['REQUEST_METHOD']
  (meth == 'POST' && type.nil?) || FORM_DATA_MEDIA_TYPES.include?(type)
end

#fullpath ⇒ Object 



294
295
296
 
# File 'lib/rack/request.rb', line 294

def fullpath
  query_string.empty? ? path : "#{path}?#{query_string}"
end

#GET ⇒ Object

Returns the data received in the query string.



181
182
183
184
185
186
187
188
 
# File 'lib/rack/request.rb', line 181

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"]   = parse_query(query_string)
  end
end

#get? ⇒ Boolean

Checks the HTTP request method (or verb) to see if it was of type GET

Returns:

  • (Boolean) 


123
 
# File 'lib/rack/request.rb', line 123

def get?;     request_method == "GET"     end

#head? ⇒ Boolean

Checks the HTTP request method (or verb) to see if it was of type HEAD

Returns:

  • (Boolean) 


126
 
# File 'lib/rack/request.rb', line 126

def head?;    request_method == "HEAD"    end

#host ⇒ Object 



110
111
112
113
 
# File 'lib/rack/request.rb', line 110

def host
  # Remove port number.
  host_with_port.to_s.gsub(/:\d+\z/, '')
end

#host_with_port ⇒ Object 



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

def 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

#ip ⇒ Object 



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/rack/request.rb', line 313

def ip
  remote_addrs = @env['REMOTE_ADDR'] ? @env['REMOTE_ADDR'].split(/[,\s]+/) : []
  remote_addrs.reject! { |addr| trusted_proxy?(addr) }
  
  return remote_addrs.first if remote_addrs.any?

  forwarded_ips = @env['HTTP_X_FORWARDED_FOR'] ? @env['HTTP_X_FORWARDED_FOR'].strip.split(/[,\s]+/) : []

  if client_ip = @env['HTTP_CLIENT_IP']
    # If forwarded_ips doesn't include the client_ip, it might be an
    # ip spoofing attempt, so we ignore HTTP_CLIENT_IP
    return client_ip if forwarded_ips.include?(client_ip)
  end

  return forwarded_ips.reject { |ip| trusted_proxy?(ip) }.last || @env["REMOTE_ADDR"]
end

#logger ⇒ Object 



38
 
# File 'lib/rack/request.rb', line 38

def logger;          @env['rack.logger']                      end

#media_type ⇒ Object

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



46
47
48
 
# File 'lib/rack/request.rb', line 46

def media_type
  content_type && content_type.split(/\s*[;,]\s*/, 2).first.downcase
end

#media_type_params ⇒ Object

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' }



55
56
57
58
59
60
 
# File 'lib/rack/request.rb', line 55

def media_type_params
  return {} if content_type.nil?
  Hash[*content_type.split(/\s*[;,]\s*/)[1..-1].
    collect { |s| s.split('=', 2) }.
    map { |k,v| [k.downcase, v] }.flatten]
end

#options? ⇒ Boolean

Checks the HTTP request method (or verb) to see if it was of type OPTIONS

Returns:

  • (Boolean) 


129
 
# File 'lib/rack/request.rb', line 129

def options?; request_method == "OPTIONS" end

#params ⇒ Object

The union of GET and POST data.



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

def params
  @params ||= self.GET.merge(self.POST)
rescue EOFError
  self.GET
end

#parseable_data? ⇒ Boolean

Determine whether the request body contains data by checking the request media_type against registered parse-data media-types

Returns:

  • (Boolean) 


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

def parseable_data?
  PARSEABLE_DATA_MEDIA_TYPES.include?(media_type)
end

#patch? ⇒ Boolean

Checks the HTTP request method (or verb) to see if it was of type PATCH

Returns:

  • (Boolean) 


132
 
# File 'lib/rack/request.rb', line 132

def patch?;   request_method == "PATCH"   end

#path ⇒ Object 



290
291
292
 
# File 'lib/rack/request.rb', line 290

def path
  script_name + path_info
end

#path_info ⇒ Object 



26
 
# File 'lib/rack/request.rb', line 26

def path_info;       @env["PATH_INFO"].to_s                   end

#path_info=(s) ⇒ Object 



116
 
# File 'lib/rack/request.rb', line 116

def path_info=(s);   @env["PATH_INFO"] = s.to_s               end

#port ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/rack/request.rb', line 96

def port
  if port = host_with_port.split(/:/)[1]
    port.to_i
  elsif port = @env['HTTP_X_FORWARDED_PORT']
    port.to_i
  elsif ssl?
    443
  elsif @env.has_key?("HTTP_X_FORWARDED_HOST")
    80
  else
    @env["SERVER_PORT"].to_i
  end
end

#POST ⇒ Object

Returns the data received in the request body.

This method support both application/x-www-form-urlencoded and multipart/form-data.



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/rack/request.rb', line 194

def POST
  if @env["rack.input"].nil?
    raise "Missing rack.input"
  elsif @env["rack.request.form_input"].eql? @env["rack.input"]
    @env["rack.request.form_hash"]
  elsif form_data? || parseable_data?
    @env["rack.request.form_input"] = @env["rack.input"]
    unless @env["rack.request.form_hash"] = parse_multipart(env)
      form_vars = @env["rack.input"].read

      # Fix for Safari Ajax postings that always append \0
      # form_vars.sub!(/\0\z/, '') # performance replacement:
      form_vars.slice!(-1) if form_vars[-1] == ?\0

      @env["rack.request.form_vars"] = form_vars
      @env["rack.request.form_hash"] = parse_query(form_vars)

      @env["rack.input"].rewind
    end
    @env["rack.request.form_hash"]
  else
    {}
  end
end

#post? ⇒ Boolean

Checks the HTTP request method (or verb) to see if it was of type POST

Returns:

  • (Boolean) 


135
 
# File 'lib/rack/request.rb', line 135

def post?;    request_method == "POST"    end

#put? ⇒ Boolean

Checks the HTTP request method (or verb) to see if it was of type PUT

Returns:

  • (Boolean) 


138
 
# File 'lib/rack/request.rb', line 138

def put?;     request_method == "PUT"     end

#query_string ⇒ Object 



28
 
# File 'lib/rack/request.rb', line 28

def query_string;    @env["QUERY_STRING"].to_s                end

#referer ⇒ Object Also known as: referrer

the referer of the client



242
243
244
 
# File 'lib/rack/request.rb', line 242

def referer
  @env['HTTP_REFERER']
end

#request_method ⇒ Object 



27
 
# File 'lib/rack/request.rb', line 27

def request_method;  @env["REQUEST_METHOD"]                   end

#scheme ⇒ Object 



70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/rack/request.rb', line 70

def scheme
  if @env['HTTPS'] == 'on'
    'https'
  elsif @env['HTTP_X_FORWARDED_SSL'] == 'on'
    'https'
  elsif @env['HTTP_X_FORWARDED_SCHEME']
    @env['HTTP_X_FORWARDED_SCHEME']
  elsif @env['HTTP_X_FORWARDED_PROTO']
    @env['HTTP_X_FORWARDED_PROTO'].split(',')[0]
  else
    @env["rack.url_scheme"]
  end
end

#script_name ⇒ Object 



25
 
# File 'lib/rack/request.rb', line 25

def script_name;     @env["SCRIPT_NAME"].to_s                 end

#script_name=(s) ⇒ Object 



115
 
# File 'lib/rack/request.rb', line 115

def script_name=(s); @env["SCRIPT_NAME"] = s.to_s             end

#session ⇒ Object 



36
 
# File 'lib/rack/request.rb', line 36

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

#session_options ⇒ Object 



37
 
# File 'lib/rack/request.rb', line 37

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

#ssl? ⇒ Boolean

Returns:

  • (Boolean) 


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

def ssl?
  scheme == 'https'
end

#trace? ⇒ Boolean

Checks the HTTP request method (or verb) to see if it was of type TRACE

Returns:

  • (Boolean) 


141
 
# File 'lib/rack/request.rb', line 141

def trace?;   request_method == "TRACE"   end

#trusted_proxy?(ip) ⇒ Boolean

Returns:

  • (Boolean) 


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

def trusted_proxy?(ip)
  ip =~ /^127\.0\.0\.1$|^(10|172\.(1[6-9]|2[0-9]|30|31)|192\.168)\.|^::1$|^fd[0-9a-f]{2}:.+|^localhost$/i
end

#url ⇒ Object

Tries to return a remake of the original request URL as a string.



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

def url
  base_url + fullpath
end

#user_agent ⇒ Object 



247
248
249
 
# File 'lib/rack/request.rb', line 247

def user_agent
  @env['HTTP_USER_AGENT']
end

#values_at(*keys) ⇒ Object

like Hash#values_at



237
238
239
 
# File 'lib/rack/request.rb', line 237

def values_at(*keys)
  keys.map{|key| params[key] }
end

#xhr? ⇒ Boolean

Returns:

  • (Boolean) 


269
270
271
 
# File 'lib/rack/request.rb', line 269

def xhr?
  @env["HTTP_X_REQUESTED_WITH"] == "XMLHttpRequest"
end