rack 2.2.14 → 3.1.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (87) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +423 -70
  3. data/CONTRIBUTING.md +63 -55
  4. data/MIT-LICENSE +1 -1
  5. data/README.md +355 -0
  6. data/SPEC.rdoc +204 -131
  7. data/lib/rack/auth/abstract/handler.rb +3 -1
  8. data/lib/rack/auth/abstract/request.rb +3 -1
  9. data/lib/rack/auth/basic.rb +1 -3
  10. data/lib/rack/bad_request.rb +8 -0
  11. data/lib/rack/body_proxy.rb +21 -3
  12. data/lib/rack/builder.rb +102 -69
  13. data/lib/rack/cascade.rb +2 -3
  14. data/lib/rack/common_logger.rb +22 -17
  15. data/lib/rack/conditional_get.rb +18 -15
  16. data/lib/rack/constants.rb +67 -0
  17. data/lib/rack/content_length.rb +12 -16
  18. data/lib/rack/content_type.rb +8 -5
  19. data/lib/rack/deflater.rb +40 -26
  20. data/lib/rack/directory.rb +9 -3
  21. data/lib/rack/etag.rb +17 -23
  22. data/lib/rack/events.rb +4 -0
  23. data/lib/rack/files.rb +15 -17
  24. data/lib/rack/head.rb +9 -8
  25. data/lib/rack/headers.rb +238 -0
  26. data/lib/rack/lint.rb +840 -644
  27. data/lib/rack/lock.rb +2 -5
  28. data/lib/rack/logger.rb +3 -0
  29. data/lib/rack/media_type.rb +8 -3
  30. data/lib/rack/method_override.rb +5 -1
  31. data/lib/rack/mime.rb +14 -5
  32. data/lib/rack/mock.rb +1 -271
  33. data/lib/rack/mock_request.rb +161 -0
  34. data/lib/rack/mock_response.rb +124 -0
  35. data/lib/rack/multipart/generator.rb +7 -5
  36. data/lib/rack/multipart/parser.rb +213 -95
  37. data/lib/rack/multipart/uploaded_file.rb +4 -0
  38. data/lib/rack/multipart.rb +53 -40
  39. data/lib/rack/null_logger.rb +9 -0
  40. data/lib/rack/query_parser.rb +79 -101
  41. data/lib/rack/recursive.rb +2 -0
  42. data/lib/rack/reloader.rb +0 -2
  43. data/lib/rack/request.rb +260 -123
  44. data/lib/rack/response.rb +151 -66
  45. data/lib/rack/rewindable_input.rb +24 -5
  46. data/lib/rack/runtime.rb +7 -6
  47. data/lib/rack/sendfile.rb +30 -25
  48. data/lib/rack/show_exceptions.rb +21 -4
  49. data/lib/rack/show_status.rb +17 -7
  50. data/lib/rack/static.rb +8 -8
  51. data/lib/rack/tempfile_reaper.rb +15 -4
  52. data/lib/rack/urlmap.rb +3 -1
  53. data/lib/rack/utils.rb +236 -237
  54. data/lib/rack/version.rb +1 -9
  55. data/lib/rack.rb +13 -89
  56. metadata +13 -39
  57. data/README.rdoc +0 -347
  58. data/Rakefile +0 -130
  59. data/bin/rackup +0 -5
  60. data/contrib/rack.png +0 -0
  61. data/contrib/rack.svg +0 -150
  62. data/contrib/rack_logo.svg +0 -164
  63. data/contrib/rdoc.css +0 -412
  64. data/example/lobster.ru +0 -6
  65. data/example/protectedlobster.rb +0 -16
  66. data/example/protectedlobster.ru +0 -10
  67. data/lib/rack/auth/digest/md5.rb +0 -131
  68. data/lib/rack/auth/digest/nonce.rb +0 -53
  69. data/lib/rack/auth/digest/params.rb +0 -54
  70. data/lib/rack/auth/digest/request.rb +0 -43
  71. data/lib/rack/chunked.rb +0 -117
  72. data/lib/rack/core_ext/regexp.rb +0 -14
  73. data/lib/rack/file.rb +0 -7
  74. data/lib/rack/handler/cgi.rb +0 -59
  75. data/lib/rack/handler/fastcgi.rb +0 -100
  76. data/lib/rack/handler/lsws.rb +0 -61
  77. data/lib/rack/handler/scgi.rb +0 -71
  78. data/lib/rack/handler/thin.rb +0 -36
  79. data/lib/rack/handler/webrick.rb +0 -129
  80. data/lib/rack/handler.rb +0 -104
  81. data/lib/rack/lobster.rb +0 -70
  82. data/lib/rack/server.rb +0 -466
  83. data/lib/rack/session/abstract/id.rb +0 -523
  84. data/lib/rack/session/cookie.rb +0 -203
  85. data/lib/rack/session/memcache.rb +0 -10
  86. data/lib/rack/session/pool.rb +0 -90
  87. data/rack.gemspec +0 -46
@@ -1,64 +1,77 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ require_relative 'constants'
4
+ require_relative 'utils'
5
+
3
6
  require_relative 'multipart/parser'
7
+ require_relative 'multipart/generator'
8
+
9
+ require_relative 'bad_request'
4
10
 
5
11
  module Rack
6
12
  # A multipart form data parser, adapted from IOWA.
7
13
  #
8
14
  # Usually, Rack::Request#POST takes care of calling this.
9
15
  module Multipart
10
- autoload :UploadedFile, 'rack/multipart/uploaded_file'
11
- autoload :Generator, 'rack/multipart/generator'
12
-
13
- EOL = "\r\n"
14
16
  MULTIPART_BOUNDARY = "AaB03x"
15
- MULTIPART = %r|\Amultipart/.*boundary=\"?([^\";,]+)\"?|ni
16
- TOKEN = /[^\s()<>,;:\\"\/\[\]?=]+/
17
- CONDISP = /Content-Disposition:\s*#{TOKEN}\s*/i
18
- VALUE = /"(?:\\"|[^"])*"|#{TOKEN}/
19
- BROKEN = /^#{CONDISP}.*;\s*filename=(#{VALUE})/i
20
- MULTIPART_CONTENT_TYPE = /Content-Type: (.*)#{EOL}/ni
21
- MULTIPART_CONTENT_DISPOSITION = /Content-Disposition:[^:]*;\s*name=(#{VALUE})/ni
22
- MULTIPART_CONTENT_ID = /Content-ID:\s*([^#{EOL}]*)/ni
23
- # Updated definitions from RFC 2231
24
- ATTRIBUTE_CHAR = %r{[^ \x00-\x1f\x7f)(><@,;:\\"/\[\]?='*%]}
25
- ATTRIBUTE = /#{ATTRIBUTE_CHAR}+/
26
- SECTION = /\*[0-9]+/
27
- REGULAR_PARAMETER_NAME = /#{ATTRIBUTE}#{SECTION}?/
28
- REGULAR_PARAMETER = /(#{REGULAR_PARAMETER_NAME})=(#{VALUE})/
29
- EXTENDED_OTHER_NAME = /#{ATTRIBUTE}\*[1-9][0-9]*\*/
30
- EXTENDED_OTHER_VALUE = /%[0-9a-fA-F]{2}|#{ATTRIBUTE_CHAR}/
31
- EXTENDED_OTHER_PARAMETER = /(#{EXTENDED_OTHER_NAME})=(#{EXTENDED_OTHER_VALUE}*)/
32
- EXTENDED_INITIAL_NAME = /#{ATTRIBUTE}(?:\*0)?\*/
33
- EXTENDED_INITIAL_VALUE = /[a-zA-Z0-9\-]*'[a-zA-Z0-9\-]*'#{EXTENDED_OTHER_VALUE}*/
34
- EXTENDED_INITIAL_PARAMETER = /(#{EXTENDED_INITIAL_NAME})=(#{EXTENDED_INITIAL_VALUE})/
35
- EXTENDED_PARAMETER = /#{EXTENDED_INITIAL_PARAMETER}|#{EXTENDED_OTHER_PARAMETER}/
36
- DISPPARM = /;\s*(?:#{REGULAR_PARAMETER}|#{EXTENDED_PARAMETER})\s*/
37
- RFC2183 = /^#{CONDISP}(#{DISPPARM})+$/i
17
+
18
+ class MissingInputError < StandardError
19
+ include BadRequest
20
+ end
21
+
22
+ # Accumulator for multipart form data, conforming to the QueryParser API.
23
+ # In future, the Parser could return the pair list directly, but that would
24
+ # change its API.
25
+ class ParamList # :nodoc:
26
+ def self.make_params
27
+ new
28
+ end
29
+
30
+ def self.normalize_params(params, key, value)
31
+ params << [key, value]
32
+ end
33
+
34
+ def initialize
35
+ @pairs = []
36
+ end
37
+
38
+ def <<(pair)
39
+ @pairs << pair
40
+ end
41
+
42
+ def to_params_hash
43
+ @pairs
44
+ end
45
+ end
38
46
 
39
47
  class << self
40
48
  def parse_multipart(env, params = Rack::Utils.default_query_parser)
41
- extract_multipart Rack::Request.new(env), params
42
- end
49
+ unless io = env[RACK_INPUT]
50
+ raise MissingInputError, "Missing input stream!"
51
+ end
43
52
 
44
- def extract_multipart(req, params = Rack::Utils.default_query_parser)
45
- io = req.get_header(RACK_INPUT)
46
- io.rewind
47
- content_length = req.content_length
48
- content_length = content_length.to_i if content_length
53
+ if content_length = env['CONTENT_LENGTH']
54
+ content_length = content_length.to_i
55
+ end
49
56
 
50
- tempfile = req.get_header(RACK_MULTIPART_TEMPFILE_FACTORY) || Parser::TEMPFILE_FACTORY
51
- bufsize = req.get_header(RACK_MULTIPART_BUFFER_SIZE) || Parser::BUFSIZE
57
+ content_type = env['CONTENT_TYPE']
52
58
 
53
- info = Parser.parse io, content_length, req.get_header('CONTENT_TYPE'), tempfile, bufsize, params
54
- req.set_header(RACK_TEMPFILES, info.tmp_files)
55
- info.params
59
+ tempfile = env[RACK_MULTIPART_TEMPFILE_FACTORY] || Parser::TEMPFILE_FACTORY
60
+ bufsize = env[RACK_MULTIPART_BUFFER_SIZE] || Parser::BUFSIZE
61
+
62
+ info = Parser.parse(io, content_length, content_type, tempfile, bufsize, params)
63
+ env[RACK_TEMPFILES] = info.tmp_files
64
+
65
+ return info.params
66
+ end
67
+
68
+ def extract_multipart(request, params = Rack::Utils.default_query_parser)
69
+ parse_multipart(request.env)
56
70
  end
57
71
 
58
72
  def build_multipart(params, first = true)
59
73
  Generator.new(params, first).dump
60
74
  end
61
75
  end
62
-
63
76
  end
64
77
  end
@@ -1,5 +1,7 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ require_relative 'constants'
4
+
3
5
  module Rack
4
6
  class NullLogger
5
7
  def initialize(app)
@@ -22,6 +24,11 @@ module Rack
22
24
  def warn? ; end
23
25
  def error? ; end
24
26
  def fatal? ; end
27
+ def debug! ; end
28
+ def error! ; end
29
+ def fatal! ; end
30
+ def info! ; end
31
+ def warn! ; end
25
32
  def level ; end
26
33
  def progname ; end
27
34
  def datetime_format ; end
@@ -34,6 +41,8 @@ module Rack
34
41
  def sev_threshold=(sev_threshold); end
35
42
  def close ; end
36
43
  def add(severity, message = nil, progname = nil, &block); end
44
+ def log(severity, message = nil, progname = nil, &block); end
37
45
  def <<(msg); end
46
+ def reopen(logdev = nil); end
38
47
  end
39
48
  end
@@ -1,24 +1,30 @@
1
1
  # frozen_string_literal: true
2
2
 
3
+ require_relative 'bad_request'
4
+ require 'uri'
5
+
3
6
  module Rack
4
7
  class QueryParser
5
- (require_relative 'core_ext/regexp'; using ::Rack::RegexpExtensions) if RUBY_VERSION < '2.4'
6
-
7
- DEFAULT_SEP = /[&;] */n
8
- COMMON_SEP = { ";" => /[;] */n, ";," => /[;,] */n, "&" => /[&] */n }
8
+ DEFAULT_SEP = /& */n
9
+ COMMON_SEP = { ";" => /; */n, ";," => /[;,] */n, "&" => /& */n }
9
10
 
10
11
  # ParameterTypeError is the error that is raised when incoming structural
11
12
  # parameters (parsed by parse_nested_query) contain conflicting types.
12
- class ParameterTypeError < TypeError; end
13
+ class ParameterTypeError < TypeError
14
+ include BadRequest
15
+ end
13
16
 
14
17
  # InvalidParameterError is the error that is raised when incoming structural
15
18
  # parameters (parsed by parse_nested_query) contain invalid format or byte
16
19
  # sequence.
17
- class InvalidParameterError < ArgumentError; end
20
+ class InvalidParameterError < ArgumentError
21
+ include BadRequest
22
+ end
18
23
 
19
24
  # QueryLimitError is for errors raised when the query provided exceeds one
20
25
  # of the query parser limits.
21
26
  class QueryLimitError < RangeError
27
+ include BadRequest
22
28
  end
23
29
 
24
30
  # ParamsTooDeepError is the old name for the error that is raised when params
@@ -27,11 +33,11 @@ module Rack
27
33
  # to handle bad query strings also now handles other limits.
28
34
  ParamsTooDeepError = QueryLimitError
29
35
 
30
- def self.make_default(key_space_limit, param_depth_limit, **options)
31
- new(Params, key_space_limit, param_depth_limit, **options)
36
+ def self.make_default(param_depth_limit, **options)
37
+ new(Params, param_depth_limit, **options)
32
38
  end
33
39
 
34
- attr_reader :key_space_limit, :param_depth_limit
40
+ attr_reader :param_depth_limit
35
41
 
36
42
  env_int = lambda do |key, val|
37
43
  if str_val = ENV[key]
@@ -51,25 +57,23 @@ module Rack
51
57
  PARAMS_LIMIT = env_int.call("RACK_QUERY_PARSER_PARAMS_LIMIT", 4096)
52
58
  private_constant :PARAMS_LIMIT
53
59
 
54
- def initialize(params_class, key_space_limit, param_depth_limit, bytesize_limit: BYTESIZE_LIMIT, params_limit: PARAMS_LIMIT)
60
+ def initialize(params_class, param_depth_limit, bytesize_limit: BYTESIZE_LIMIT, params_limit: PARAMS_LIMIT)
55
61
  @params_class = params_class
56
- @key_space_limit = key_space_limit
57
62
  @param_depth_limit = param_depth_limit
58
63
  @bytesize_limit = bytesize_limit
59
64
  @params_limit = params_limit
60
65
  end
61
66
 
62
67
  # Stolen from Mongrel, with some small modifications:
63
- # Parses a query string by breaking it up at the '&'
64
- # and ';' characters. You can also use this to parse
65
- # cookies by changing the characters used in the second
66
- # parameter (which defaults to '&;').
67
- def parse_query(qs, d = nil, &unescaper)
68
+ # Parses a query string by breaking it up at the '&'. You can also use this
69
+ # to parse cookies by changing the characters used in the second parameter
70
+ # (which defaults to '&').
71
+ def parse_query(qs, separator = nil, &unescaper)
68
72
  unescaper ||= method(:unescape)
69
73
 
70
74
  params = make_params
71
75
 
72
- check_query_string(qs, d).split(d ? (COMMON_SEP[d] || /[#{d}] */n) : DEFAULT_SEP).each do |p|
76
+ check_query_string(qs, separator).split(separator ? (COMMON_SEP[separator] || /[#{separator}] */n) : DEFAULT_SEP).each do |p|
73
77
  next if p.empty?
74
78
  k, v = p.split('=', 2).map!(&unescaper)
75
79
 
@@ -92,14 +96,14 @@ module Rack
92
96
  # query strings with parameters of conflicting types, in this case a
93
97
  # ParameterTypeError is raised. Users are encouraged to return a 400 in this
94
98
  # case.
95
- def parse_nested_query(qs, d = nil)
99
+ def parse_nested_query(qs, separator = nil)
96
100
  params = make_params
97
101
 
98
102
  unless qs.nil? || qs.empty?
99
- check_query_string(qs, d).split(d ? (COMMON_SEP[d] || /[#{d}] */n) : DEFAULT_SEP).each do |p|
103
+ check_query_string(qs, separator).split(separator ? (COMMON_SEP[separator] || /[#{separator}] */n) : DEFAULT_SEP).each do |p|
100
104
  k, v = p.split('=', 2).map! { |s| unescape(s) }
101
105
 
102
- normalize_params(params, k, v, param_depth_limit)
106
+ _normalize_params(params, k, v, 0)
103
107
  end
104
108
  end
105
109
 
@@ -110,58 +114,87 @@ module Rack
110
114
 
111
115
  # normalize_params recursively expands parameters into structural types. If
112
116
  # the structural types represented by two different parameter names are in
113
- # conflict, a ParameterTypeError is raised.
114
- def normalize_params(params, name, v, depth)
115
- raise ParamsTooDeepError if depth <= 0
116
-
117
- name =~ %r(\A[\[\]]*([^\[\]]+)\]*)
118
- k = $1 || ''
119
- after = $' || ''
117
+ # conflict, a ParameterTypeError is raised. The depth argument is deprecated
118
+ # and should no longer be used, it is kept for backwards compatibility with
119
+ # earlier versions of rack.
120
+ def normalize_params(params, name, v, _depth=nil)
121
+ _normalize_params(params, name, v, 0)
122
+ end
120
123
 
121
- if k.empty?
122
- if !v.nil? && name == "[]"
123
- return Array(v)
124
+ private def _normalize_params(params, name, v, depth)
125
+ raise ParamsTooDeepError if depth >= param_depth_limit
126
+
127
+ if !name
128
+ # nil name, treat same as empty string (required by tests)
129
+ k = after = ''
130
+ elsif depth == 0
131
+ # Start of parsing, don't treat [] or [ at start of string specially
132
+ if start = name.index('[', 1)
133
+ # Start of parameter nesting, use part before brackets as key
134
+ k = name[0, start]
135
+ after = name[start, name.length]
124
136
  else
125
- return
137
+ # Plain parameter with no nesting
138
+ k = name
139
+ after = ''
126
140
  end
141
+ elsif name.start_with?('[]')
142
+ # Array nesting
143
+ k = '[]'
144
+ after = name[2, name.length]
145
+ elsif name.start_with?('[') && (start = name.index(']', 1))
146
+ # Hash nesting, use the part inside brackets as the key
147
+ k = name[1, start-1]
148
+ after = name[start+1, name.length]
149
+ else
150
+ # Probably malformed input, nested but not starting with [
151
+ # treat full name as key for backwards compatibility.
152
+ k = name
153
+ after = ''
127
154
  end
128
155
 
156
+ return if k.empty?
157
+
129
158
  if after == ''
130
- params[k] = v
159
+ if k == '[]' && depth != 0
160
+ return [v]
161
+ else
162
+ params[k] = v
163
+ end
131
164
  elsif after == "["
132
165
  params[name] = v
133
166
  elsif after == "[]"
134
167
  params[k] ||= []
135
168
  raise ParameterTypeError, "expected Array (got #{params[k].class.name}) for param `#{k}'" unless params[k].is_a?(Array)
136
169
  params[k] << v
137
- elsif after =~ %r(^\[\]\[([^\[\]]+)\]$) || after =~ %r(^\[\](.+)$)
138
- child_key = $1
170
+ elsif after.start_with?('[]')
171
+ # Recognize x[][y] (hash inside array) parameters
172
+ unless after[2] == '[' && after.end_with?(']') && (child_key = after[3, after.length-4]) && !child_key.empty? && !child_key.index('[') && !child_key.index(']')
173
+ # Handle other nested array parameters
174
+ child_key = after[2, after.length]
175
+ end
139
176
  params[k] ||= []
140
177
  raise ParameterTypeError, "expected Array (got #{params[k].class.name}) for param `#{k}'" unless params[k].is_a?(Array)
141
178
  if params_hash_type?(params[k].last) && !params_hash_has_key?(params[k].last, child_key)
142
- normalize_params(params[k].last, child_key, v, depth - 1)
179
+ _normalize_params(params[k].last, child_key, v, depth + 1)
143
180
  else
144
- params[k] << normalize_params(make_params, child_key, v, depth - 1)
181
+ params[k] << _normalize_params(make_params, child_key, v, depth + 1)
145
182
  end
146
183
  else
147
184
  params[k] ||= make_params
148
185
  raise ParameterTypeError, "expected Hash (got #{params[k].class.name}) for param `#{k}'" unless params_hash_type?(params[k])
149
- params[k] = normalize_params(params[k], after, v, depth - 1)
186
+ params[k] = _normalize_params(params[k], after, v, depth + 1)
150
187
  end
151
188
 
152
189
  params
153
190
  end
154
191
 
155
192
  def make_params
156
- @params_class.new @key_space_limit
157
- end
158
-
159
- def new_space_limit(key_space_limit)
160
- self.class.new @params_class, key_space_limit, param_depth_limit
193
+ @params_class.new
161
194
  end
162
195
 
163
196
  def new_depth_limit(param_depth_limit)
164
- self.class.new @params_class, key_space_limit, param_depth_limit
197
+ self.class.new @params_class, param_depth_limit
165
198
  end
166
199
 
167
200
  private
@@ -198,66 +231,11 @@ module Rack
198
231
  end
199
232
  end
200
233
 
201
- def unescape(string)
202
- Utils.unescape(string)
234
+ def unescape(string, encoding = Encoding::UTF_8)
235
+ URI.decode_www_form_component(string, encoding)
203
236
  end
204
237
 
205
- class Params
206
- def initialize(limit)
207
- @limit = limit
208
- @size = 0
209
- @params = {}
210
- end
211
-
212
- def [](key)
213
- @params[key]
214
- end
215
-
216
- def []=(key, value)
217
- @size += key.size if key && !@params.key?(key)
218
- raise ParamsTooDeepError, 'exceeded available parameter key space' if @size > @limit
219
- @params[key] = value
220
- end
221
-
222
- def key?(key)
223
- @params.key?(key)
224
- end
225
-
226
- # Recursively unwraps nested `Params` objects and constructs an object
227
- # of the same shape, but using the objects' internal representations
228
- # (Ruby hashes) in place of the objects. The result is a hash consisting
229
- # purely of Ruby primitives.
230
- #
231
- # Mutation warning!
232
- #
233
- # 1. This method mutates the internal representation of the `Params`
234
- # objects in order to save object allocations.
235
- #
236
- # 2. The value you get back is a reference to the internal hash
237
- # representation, not a copy.
238
- #
239
- # 3. Because the `Params` object's internal representation is mutable
240
- # through the `#[]=` method, it is not thread safe. The result of
241
- # getting the hash representation while another thread is adding a
242
- # key to it is non-deterministic.
243
- #
244
- def to_h
245
- @params.each do |key, value|
246
- case value
247
- when self
248
- # Handle circular references gracefully.
249
- @params[key] = @params
250
- when Params
251
- @params[key] = value.to_h
252
- when Array
253
- value.map! { |v| v.kind_of?(Params) ? v.to_h : v }
254
- else
255
- # Ignore anything that is not a `Params` object or
256
- # a collection that can contain one.
257
- end
258
- end
259
- @params
260
- end
238
+ class Params < Hash
261
239
  alias_method :to_params_hash, :to_h
262
240
  end
263
241
  end
@@ -2,6 +2,8 @@
2
2
 
3
3
  require 'uri'
4
4
 
5
+ require_relative 'constants'
6
+
5
7
  module Rack
6
8
  # Rack::ForwardRequest gets caught by Rack::Recursive and redirects
7
9
  # the current request to the app at +url+.
data/lib/rack/reloader.rb CHANGED
@@ -22,8 +22,6 @@ module Rack
22
22
  # It is performing a check/reload cycle at the start of every request, but
23
23
  # also respects a cool down time, during which nothing will be done.
24
24
  class Reloader
25
- (require_relative 'core_ext/regexp'; using ::Rack::RegexpExtensions) if RUBY_VERSION < '2.4'
26
-
27
25
  def initialize(app, cooldown = 10, backend = Stat)
28
26
  @app = app
29
27
  @cooldown = cooldown