Module: Rack::Utils

Included in:
Chunked, Chunked::Body, ContentLength, ContentType
Defined in:
lib/rack/utils.rb

Overview

Rack::Utils contains a grab-bag of useful methods for writing web applications adopted from all kinds of Ruby libraries.

Defined Under Namespace

Classes: Context, HeaderHash

Constant Summary collapse

ParameterTypeError = 
QueryParser::ParameterTypeError
InvalidParameterError = 
QueryParser::InvalidParameterError
DEFAULT_SEP = 
QueryParser::DEFAULT_SEP
COMMON_SEP = 
QueryParser::COMMON_SEP
KeySpaceConstrainedParams = 
QueryParser::Params
ESCAPE_HTML = 
{
  "&" => "&",
  "<" => "&lt;",
  ">" => "&gt;",
  "'" => "&#x27;",
  '"' => "&quot;",
  "/" => "&#x2F;"
}
ESCAPE_HTML_PATTERN = 
Regexp.union(*ESCAPE_HTML.keys)
HTTP_STATUS_CODES =

Every standard HTTP code mapped to the appropriate message. Generated with:

curl -s https://www.iana.org/assignments/http-status-codes/http-status-codes-1.csv | \
  ruby -ne 'm = /^(\d{3}),(?!Unassigned|\(Unused\))([^,]+)/.match($_) and \
            puts "#{m[1]} => \x27#{m[2].strip}\x27,"'

{
  100 => 'Continue',
  101 => 'Switching Protocols',
  102 => 'Processing',
  103 => 'Early Hints',
  200 => 'OK',
  201 => 'Created',
  202 => 'Accepted',
  203 => 'Non-Authoritative Information',
  204 => 'No Content',
  205 => 'Reset Content',
  206 => 'Partial Content',
  207 => 'Multi-Status',
  208 => 'Already Reported',
  226 => 'IM Used',
  300 => 'Multiple Choices',
  301 => 'Moved Permanently',
  302 => 'Found',
  303 => 'See Other',
  304 => 'Not Modified',
  305 => 'Use Proxy',
  306 => '(Unused)',
  307 => 'Temporary Redirect',
  308 => 'Permanent Redirect',
  400 => 'Bad Request',
  401 => 'Unauthorized',
  402 => 'Payment Required',
  403 => 'Forbidden',
  404 => 'Not Found',
  405 => 'Method Not Allowed',
  406 => 'Not Acceptable',
  407 => 'Proxy Authentication Required',
  408 => 'Request Timeout',
  409 => 'Conflict',
  410 => 'Gone',
  411 => 'Length Required',
  412 => 'Precondition Failed',
  413 => 'Payload Too Large',
  414 => 'URI Too Long',
  415 => 'Unsupported Media Type',
  416 => 'Range Not Satisfiable',
  417 => 'Expectation Failed',
  421 => 'Misdirected Request',
  422 => 'Unprocessable Entity',
  423 => 'Locked',
  424 => 'Failed Dependency',
  425 => 'Too Early',
  426 => 'Upgrade Required',
  428 => 'Precondition Required',
  429 => 'Too Many Requests',
  431 => 'Request Header Fields Too Large',
  451 => 'Unavailable for Legal Reasons',
  500 => 'Internal Server Error',
  501 => 'Not Implemented',
  502 => 'Bad Gateway',
  503 => 'Service Unavailable',
  504 => 'Gateway Timeout',
  505 => 'HTTP Version Not Supported',
  506 => 'Variant Also Negotiates',
  507 => 'Insufficient Storage',
  508 => 'Loop Detected',
  509 => 'Bandwidth Limit Exceeded',
  510 => 'Not Extended',
  511 => 'Network Authentication Required'
}
STATUS_WITH_NO_ENTITY_BODY =

Responses with HTTP status codes that should not have an entity body



SYMBOL_TO_STATUS_CODE =





PATH_SEPS =



Regexp.union(*[::File::SEPARATOR, ::File::ALT_SEPARATOR].compact)



NULL_BYTE =



"\0"





Class Attribute Summary collapse




Class Method Summary
collapse






Class Attribute Details






.default_query_parser ⇒ Object







Returns the value of attribute default_query_parser.















27
28
29




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

def default_query_parser
  @default_query_parser
end














.multipart_part_limit ⇒ Object







Returns the value of attribute multipart_part_limit.















62
63
64




# File 'lib/rack/utils.rb', line 62

def multipart_part_limit
  @multipart_part_limit
end














Class Method Details












223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262




# File 'lib/rack/utils.rb', line 223

def add_cookie_to_header(header, key, value)
  case value
  when Hash
    domain  = "; domain=#{value[:domain]}"   if value[:domain]
    path    = "; path=#{value[:path]}"       if value[:path]
    max_age = "; max-age=#{value[:max_age]}" if value[:max_age]
    expires = "; expires=#{value[:expires].httpdate}" if value[:expires]
    secure = "; secure"  if value[:secure]
    httponly = "; HttpOnly" if (value.key?(:httponly) ? value[:httponly] : value[:http_only])
    same_site =
      case value[:same_site]
      when false, nil
        nil
      when :none, 'None', :None
        '; SameSite=None'
      when :lax, 'Lax', :Lax
        '; SameSite=Lax'
      when true, :strict, 'Strict', :Strict
        '; SameSite=Strict'
      else
        raise ArgumentError, "Invalid SameSite value: #{value[:same_site].inspect}"
      end
    value = value[:value]
  end
  value = [value] unless Array === value

  cookie = "#{escape(key)}=#{value.map { |v| escape v }.join('&')}#{domain}" \
    "#{path}#{max_age}#{expires}#{secure}#{httponly}#{same_site}"

  case header
  when nil, ''
    cookie
  when String
    [header, cookie].join("\n")
  when Array
    (header + [cookie]).join("\n")
  else
    raise ArgumentError, "Unrecognized cookie header value. Expected String, Array, or nil, got #{header.inspect}"
  end
end













.add_remove_cookie_to_header(header, key, value = {}) ⇒ Object







Adds a cookie that will remove a cookie from the client. Hence the strange method name.















303
304
305
306
307
308
309
310
311




# File 'lib/rack/utils.rb', line 303

def add_remove_cookie_to_header(header, key, value = {})
  new_header = make_delete_cookie_header(header, key, value)

  add_cookie_to_header(new_header, key,
             { value: '', path: nil, domain: nil,
               max_age: '0',
               expires: Time.at(0) }.merge(value))

end













.best_q_match(q_value_header, available_mimes) ⇒ Object










149
150
151
152
153
154
155
156
157
158
159
160




# File 'lib/rack/utils.rb', line 149

def best_q_match(q_value_header, available_mimes)
  values = q_values(q_value_header)

  matches = values.map do |req_mime, quality|
    match = available_mimes.find { |am| Rack::Mime.match?(am, req_mime) }
    next unless match
    [match, quality]
  end.compact.sort_by do |match, quality|
    (match.split('/', 2).count('*') * -10) + quality
  end.last
  matches && matches.first
end













.build_nested_query(value, prefix = nil) ⇒ Object










118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134




# File 'lib/rack/utils.rb', line 118

def build_nested_query(value, prefix = nil)
  case value
  when Array
    value.map { |v|
      build_nested_query(v, "#{prefix}[]")
    }.join("&")
  when Hash
    value.map { |k, v|
      build_nested_query(v, prefix ? "#{prefix}[#{escape(k)}]" : escape(k))
    }.delete_if(&:empty?).join('&')
  when nil
    prefix
  else
    raise ArgumentError, "value must be a Hash" if prefix.nil?
    "#{prefix}=#{escape(value)}"
  end
end













.build_query(params) ⇒ Object










107
108
109
110
111
112
113
114
115




# File 'lib/rack/utils.rb', line 107

def build_query(params)
  params.map { |k, v|
    if v.class == Array
      build_query(v.map { |x| [k, x] })
    else
      v.nil? ? escape(k) : "#{escape(k)}=#{escape(v)}"
    end
  }.join("&")
end













.byte_ranges(env, size) ⇒ Object







Parses the “Range:” header, if present, into an array of Range objects. Returns nil if the header is missing or syntactically invalid. Returns an empty array if none of the ranges are satisfiable.















338
339
340
341




# File 'lib/rack/utils.rb', line 338

def byte_ranges(env, size)
  warn "`byte_ranges` is deprecated, please use `get_byte_ranges`" if $VERBOSE
  get_byte_ranges env['HTTP_RANGE'], size
end













.clean_path_info(path_info) ⇒ Object










581
582
583
584
585
586
587
588
589
590
591
592
593
594




# File 'lib/rack/utils.rb', line 581

def clean_path_info(path_info)
  parts = path_info.split PATH_SEPS

  clean = []

  parts.each do |part|
    next if part.empty? || part == '.'
    part == '..' ? clean.pop : clean << part
  end

  clean.unshift '/' if parts.empty? || parts.first.empty?

  ::File.join clean
end













.clock_time ⇒ Object










87
88
89




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

def clock_time
  Process.clock_gettime(Process::CLOCK_MONOTONIC)
end













.delete_cookie_header!(header, key, value = {}) ⇒ Object










295
296
297
298




# File 'lib/rack/utils.rb', line 295

def delete_cookie_header!(header, key, value = {})
  header[SET_COOKIE] = add_remove_cookie_to_header(header[SET_COOKIE], key, value)
  nil
end













.escape(s) ⇒ Object







URI escapes. (CGI style space to +)















34
35
36




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

def escape(s)
  URI.encode_www_form_component(s)
end













.escape_html(string) ⇒ Object







Escape ampersands, brackets and quotes to their HTML/XML entities.















175
176
177




# File 'lib/rack/utils.rb', line 175

def escape_html(string)
  string.to_s.gsub(ESCAPE_HTML_PATTERN){|c| ESCAPE_HTML[c] }
end













.escape_path(s) ⇒ Object







Like URI escaping, but with %20 instead of +. Strictly speaking this is true URI escaping.















41
42
43




# File 'lib/rack/utils.rb', line 41

def escape_path(s)
  ::URI::DEFAULT_PARSER.escape s
end













.get_byte_ranges(http_range, size) ⇒ Object










344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370




# File 'lib/rack/utils.rb', line 344

def get_byte_ranges(http_range, size)
  # See <http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.35>
  return nil unless http_range && http_range =~ /bytes=([^;]+)/
  ranges = []
  $1.split(/,\s*/).each do |range_spec|
    return nil  unless range_spec =~ /(\d*)-(\d*)/
    r0, r1 = $1, $2
    if r0.empty?
      return nil  if r1.empty?
      # suffix-byte-range-spec, represents trailing suffix of file
      r0 = size - r1.to_i
      r0 = 0  if r0 < 0
      r1 = size - 1
    else
      r0 = r0.to_i
      if r1.empty?
        r1 = size - 1
      else
        r1 = r1.to_i
        return nil  if r1 < r0  # backwards range is syntactically invalid
        r1 = size - 1  if r1 >= size
      end
    end
    ranges << (r0..r1)  if r0 <= r1
  end
  ranges
end













.key_space_limit ⇒ Object










78
79
80




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

def self.key_space_limit
  default_query_parser.key_space_limit
end













.key_space_limit=(v) ⇒ Object










82
83
84




# File 'lib/rack/utils.rb', line 82

def self.key_space_limit=(v)
  self.default_query_parser = self.default_query_parser.new_space_limit(v)
end













.make_delete_cookie_header(header, key, value) ⇒ Object










271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292




# File 'lib/rack/utils.rb', line 271

def make_delete_cookie_header(header, key, value)
  case header
  when nil, ''
    cookies = []
  when String
    cookies = header.split("\n")
  when Array
    cookies = header
  end

  regexp = if value[:domain]
             /\A#{escape(key)}=.*domain=#{value[:domain]}/
           elsif value[:path]
             /\A#{escape(key)}=.*path=#{value[:path]}/
           else
             /\A#{escape(key)}=/
           end

  cookies.reject! { |cookie| regexp.match? cookie }

  cookies.join("\n")
end













.param_depth_limit ⇒ Object










70
71
72




# File 'lib/rack/utils.rb', line 70

def self.param_depth_limit
  default_query_parser.param_depth_limit
end













.param_depth_limit=(v) ⇒ Object










74
75
76




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

def self.param_depth_limit=(v)
  self.default_query_parser = self.default_query_parser.new_depth_limit(v)
end













.parse_cookies(env) ⇒ Object










207
208
209




# File 'lib/rack/utils.rb', line 207

def parse_cookies(env)
  parse_cookies_header env[HTTP_COOKIE]
end













.parse_cookies_header(header) ⇒ Object










212
213
214
215
216
217
218
219
220




# File 'lib/rack/utils.rb', line 212

def parse_cookies_header(header)
  # 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 = parse_query(header, ';,') { |s| unescape(s) rescue s }
  cookies.each_with_object({}) { |(k, v), hash| hash[k] = Array === v ? v.first : v }
end













.parse_nested_query(qs, d = nil) ⇒ Object










102
103
104




# File 'lib/rack/utils.rb', line 102

def parse_nested_query(qs, d = nil)
  Rack::Utils.default_query_parser.parse_nested_query(qs, d)
end













.parse_query(qs, d = nil, &unescaper) ⇒ Object










97
98
99




# File 'lib/rack/utils.rb', line 97

def parse_query(qs, d = nil, &unescaper)
  Rack::Utils.default_query_parser.parse_query(qs, d, &unescaper)
end













.q_values(q_value_header) ⇒ Object










137
138
139
140
141
142
143
144
145
146




# File 'lib/rack/utils.rb', line 137

def q_values(q_value_header)
  q_value_header.to_s.split(/\s*,\s*/).map do |part|
    value, parameters = part.split(/\s*;\s*/, 2)
    quality = 1.0
    if parameters && (md = /\Aq=([\d.]+)/.match(parameters))
      quality = md[1].to_f
    end
    [value, quality]
  end
end













.rfc2109(time) ⇒ Object







Modified version of stdlib time.rb Time#rfc2822 to use ‘%d-%b-%Y’ instead of ‘% %b %Y’. It assumes that the time is in GMT to comply to the RFC 2109.


NOTE: I’m not sure the RFC says it requires GMT, but is ambiguous enough that I’m certain someone implemented only that option. Do not use %a and %b from Time.strptime, it would use localized names for weekday and month.















328
329
330
331
332




# File 'lib/rack/utils.rb', line 328

def rfc2109(time)
  wday = Time::RFC2822_DAY_NAME[time.wday]
  mon = Time::RFC2822_MONTH_NAME[time.mon - 1]
  time.strftime("#{wday}, %d-#{mon}-%Y %H:%M:%S GMT")
end













.rfc2822(time) ⇒ Object










314
315
316




# File 'lib/rack/utils.rb', line 314

def rfc2822(time)
  time.rfc2822
end













.secure_compare(a, b) ⇒ Object







Constant time string comparison.


NOTE: the values compared should be of fixed length, such as strings that have already been processed by HMAC. This should not be used on variable length plaintext strings because it could leak length info via timing attacks.















379
380
381
382
383
384
385
386
387




# File 'lib/rack/utils.rb', line 379

def secure_compare(a, b)
  return false unless a.bytesize == b.bytesize

  l = a.unpack("C*")

  r, i = 0, -1
  b.each_byte { |v| r |= v ^ l[i += 1] }
  r == 0
end













.select_best_encoding(available_encodings, accept_encoding) ⇒ Object










180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204




# File 'lib/rack/utils.rb', line 180

def select_best_encoding(available_encodings, accept_encoding)
  # http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html

  expanded_accept_encoding =
    accept_encoding.each_with_object([]) do |(m, q), list|
      if m == "*"
        (available_encodings - accept_encoding.map(&:first))
          .each { |m2| list << [m2, q] }
      else
        list << [m, q]
      end
    end

  encoding_candidates = expanded_accept_encoding.sort_by { |_, q| -q }.map!(&:first)

  unless encoding_candidates.include?("identity")
    encoding_candidates.push("identity")
  end

  expanded_accept_encoding.each do |m, q|
    encoding_candidates.delete(m) if q == 0.0
  end

  (encoding_candidates & available_encodings)[0]
end













.set_cookie_header!(header, key, value) ⇒ Object










265
266
267
268




# File 'lib/rack/utils.rb', line 265

def set_cookie_header!(header, key, value)
  header[SET_COOKIE] = add_cookie_to_header(header[SET_COOKIE], key, value)
  nil
end













.status_code(status) ⇒ Object










570
571
572
573
574
575
576




# File 'lib/rack/utils.rb', line 570

def status_code(status)
  if status.is_a?(Symbol)
    SYMBOL_TO_STATUS_CODE.fetch(status) { raise ArgumentError, "Unrecognized status code #{status.inspect}" }
  else
    status.to_i
  end
end













.unescape(s, encoding = Encoding::UTF_8) ⇒ Object







Unescapes a URI escaped string with encoding. encoding will be the target encoding of the string returned, and it defaults to UTF-8















56
57
58




# File 'lib/rack/utils.rb', line 56

def unescape(s, encoding = Encoding::UTF_8)
  URI.decode_www_form_component(s, encoding)
end













.unescape_path(s) ⇒ Object







Unescapes the path component of a URI. See Rack::Utils.unescape for unescaping query parameters or form components.















48
49
50




# File 'lib/rack/utils.rb', line 48

def unescape_path(s)
  ::URI::DEFAULT_PARSER.unescape s
end













.valid_path?(path) ⇒ Boolean













Returns:


    

  • 
(Boolean)

    • 










599
600
601




# File 'lib/rack/utils.rb', line 599

def valid_path?(path)
  path.valid_encoding? && !path.include?(NULL_BYTE)
end