Class: Rack::Request

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



160
161
162
 
# File 'lib/rack/request.rb', line 160

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

#[]=(key, value) ⇒ Object

shortcut for request.params = value



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

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

#accept_encoding ⇒ Object 



228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/rack/request.rb', line 228

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.



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

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 



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
 
# File 'lib/rack/request.rb', line 181

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) 


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

def delete?;         request_method == "DELETE"               end

#form_data? ⇒ Boolean

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.

Returns:

  • (Boolean) 


102
103
104
 
# File 'lib/rack/request.rb', line 102

def form_data?
  FORM_DATA_MEDIA_TYPES.include?(media_type)
end

#fullpath ⇒ Object 



224
225
226
 
# File 'lib/rack/request.rb', line 224

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

#GET ⇒ Object

Returns the data recieved in the query string.



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

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

Returns:

  • (Boolean) 


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

def get?;            request_method == "GET"                  end

#head? ⇒ Boolean

Returns:

  • (Boolean) 


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

def head?;           request_method == "HEAD"                 end

#host ⇒ Object 



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

def host
  # Remove port number.
  (@env["HTTP_HOST"] || @env["SERVER_NAME"]).gsub(/:\d+\z/, '')
end

#ip ⇒ Object 



240
241
242
243
244
245
246
 
# File 'lib/rack/request.rb', line 240

def ip
  if addr = @env['HTTP_X_FORWARDED_FOR']
    addr.split(',').last.strip
  else
    @env['REMOTE_ADDR']
  end
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



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

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



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

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 



15
16
17
 
# File 'lib/rack/auth/openid.rb', line 15

def openid_request
  @env['rack.auth.openid.request']
end

#openid_response ⇒ Object 



19
20
21
 
# File 'lib/rack/auth/openid.rb', line 19

def openid_response
  @env['rack.auth.openid.response']
end

#params ⇒ Object

The union of GET and POST data.



153
154
155
156
157
 
# File 'lib/rack/request.rb', line 153

def params
  self.put? ? self.GET : 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) 


108
109
110
 
# File 'lib/rack/request.rb', line 108

def parseable_data?
  PARSEABLE_DATA_MEDIA_TYPES.include?(media_type)
end

#path ⇒ Object 



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

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 



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

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.



127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/rack/request.rb', line 127

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"] =
        Utils::Multipart.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"] = Utils.parse_nested_query(form_vars)

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

#post? ⇒ Boolean

Returns:

  • (Boolean) 


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

def post?;           request_method == "POST"                 end

#put? ⇒ Boolean

Returns:

  • (Boolean) 


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

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 ‘/’



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

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 



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

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.



206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/rack/request.rb', line 206

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

like Hash#values_at



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

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

#xhr? ⇒ Boolean

Returns:

  • (Boolean) 


201
202
203
 
# File 'lib/rack/request.rb', line 201

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