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



171
172
173
 
# File 'lib/rack/request.rb', line 171

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

#[]=(key, value) ⇒ Object

shortcut for request.params = value



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

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

#accept_encoding ⇒ Object 



242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/rack/request.rb', line 242

def accept_encoding
  @env["HTTP_ACCEPT_ENCODING"].to_s.split(/,\s*/).map do |part|
    m = /^([^\s,]+?)(?:;\s*q=(\d+(?:\.\d+)?))?$/.match(part) # From WEBrick

    if m
      [m[1], (m[2] || 1.0).to_f]
    else
      raise "Invalid value for Accept-Encoding: #{part.inspect}"
    end
  end
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.



63
64
65
 
# File 'lib/rack/request.rb', line 63

def content_charset
  media_type_params['charset']
end

#content_length ⇒ Object 



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

def content_length;  @env['CONTENT_LENGTH']                   end

#content_type ⇒ Object 



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

def content_type;    @env['CONTENT_TYPE']                     end

#cookies ⇒ Object 



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

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"]
    # 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.
    @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

Returns:

  • (Boolean) 


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

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) 


113
114
115
116
117
 
# File 'lib/rack/request.rb', line 113

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 



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

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

#GET ⇒ Object

Returns the data recieved in the query string.



126
127
128
129
130
131
132
133
 
# File 'lib/rack/request.rb', line 126

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

Returns:

  • (Boolean) 


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

def get?;            request_method == "GET"                  end

#head? ⇒ Boolean

Returns:

  • (Boolean) 


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

def head?;           request_method == "HEAD"                 end

#host ⇒ Object 



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

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

#host_with_port ⇒ Object 



67
68
69
70
71
72
73
 
# File 'lib/rack/request.rb', line 67

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 



254
255
256
257
258
259
260
 
# File 'lib/rack/request.rb', line 254

def ip
  if addr = @env['HTTP_X_FORWARDED_FOR']
    addr.split(',').last.strip
  else
    @env['REMOTE_ADDR']
  end
end

#logger ⇒ Object 



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

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



43
44
45
 
# File 'lib/rack/request.rb', line 43

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



52
53
54
55
56
57
 
# File 'lib/rack/request.rb', line 52

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

#params ⇒ Object

The union of GET and POST data.



164
165
166
167
168
 
# File 'lib/rack/request.rb', line 164

def params
  self.GET.update(self.POST)
rescue EOFError => e
  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) 


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

def parseable_data?
  PARSEABLE_DATA_MEDIA_TYPES.include?(media_type)
end

#path ⇒ Object 



234
235
236
 
# File 'lib/rack/request.rb', line 234

def path
  script_name + path_info
end

#path_info ⇒ Object 



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

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

#path_info=(s) ⇒ Object 



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

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

#port ⇒ Object 



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

def port;            @env["SERVER_PORT"].to_i                 end

#POST ⇒ Object

Returns the data recieved in the request body.

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



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/rack/request.rb', line 139

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/, '')

      @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

Returns:

  • (Boolean) 


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

def post?;           request_method == "POST"                 end

#put? ⇒ Boolean

Returns:

  • (Boolean) 


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

def put?;            request_method == "PUT"                  end

#query_string ⇒ Object 



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

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

#referer ⇒ Object Also known as: referrer

the referer of the client or ‘/’



186
187
188
 
# File 'lib/rack/request.rb', line 186

def referer
  @env['HTTP_REFERER'] || '/'
end

#request_method ⇒ Object 



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

def request_method;  @env["REQUEST_METHOD"]                   end

#scheme ⇒ Object 



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

def scheme;          @env["rack.url_scheme"]                  end

#script_name ⇒ Object 



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

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

#script_name=(s) ⇒ Object 



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

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

#session ⇒ Object 



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

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

#session_options ⇒ Object 



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

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

#url ⇒ Object

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



220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/rack/request.rb', line 220

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

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

  url << fullpath

  url
end

#user_agent ⇒ Object 



191
192
193
 
# File 'lib/rack/request.rb', line 191

def user_agent
  @env['HTTP_USER_AGENT']
end

#values_at(*keys) ⇒ Object

like Hash#values_at



181
182
183
 
# File 'lib/rack/request.rb', line 181

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

#xhr? ⇒ Boolean

Returns:

  • (Boolean) 


215
216
217
 
# File 'lib/rack/request.rb', line 215

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