rack 2.2.17 → 3.2.0

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.

Potentially problematic release.


This version of rack might be problematic. Click here for more details.

Files changed (87) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +501 -70
  3. data/CONTRIBUTING.md +63 -55
  4. data/MIT-LICENSE +1 -1
  5. data/README.md +376 -0
  6. data/SPEC.rdoc +243 -277
  7. data/lib/rack/auth/abstract/handler.rb +3 -1
  8. data/lib/rack/auth/abstract/request.rb +5 -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 +108 -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 +20 -16
  16. data/lib/rack/constants.rb +68 -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 +8 -8
  25. data/lib/rack/headers.rb +238 -0
  26. data/lib/rack/lint.rb +817 -648
  27. data/lib/rack/lock.rb +2 -5
  28. data/lib/rack/media_type.rb +6 -7
  29. data/lib/rack/method_override.rb +5 -1
  30. data/lib/rack/mime.rb +14 -5
  31. data/lib/rack/mock.rb +1 -300
  32. data/lib/rack/mock_request.rb +161 -0
  33. data/lib/rack/mock_response.rb +147 -0
  34. data/lib/rack/multipart/generator.rb +7 -5
  35. data/lib/rack/multipart/parser.rb +241 -95
  36. data/lib/rack/multipart/uploaded_file.rb +45 -4
  37. data/lib/rack/multipart.rb +53 -40
  38. data/lib/rack/null_logger.rb +9 -0
  39. data/lib/rack/query_parser.rb +116 -121
  40. data/lib/rack/recursive.rb +2 -0
  41. data/lib/rack/reloader.rb +0 -2
  42. data/lib/rack/request.rb +269 -141
  43. data/lib/rack/response.rb +151 -66
  44. data/lib/rack/rewindable_input.rb +27 -5
  45. data/lib/rack/runtime.rb +7 -6
  46. data/lib/rack/sendfile.rb +30 -25
  47. data/lib/rack/show_exceptions.rb +25 -6
  48. data/lib/rack/show_status.rb +17 -9
  49. data/lib/rack/static.rb +8 -8
  50. data/lib/rack/tempfile_reaper.rb +15 -4
  51. data/lib/rack/urlmap.rb +3 -1
  52. data/lib/rack/utils.rb +228 -238
  53. data/lib/rack/version.rb +3 -15
  54. data/lib/rack.rb +13 -90
  55. metadata +15 -41
  56. data/README.rdoc +0 -347
  57. data/Rakefile +0 -130
  58. data/bin/rackup +0 -5
  59. data/contrib/rack.png +0 -0
  60. data/contrib/rack.svg +0 -150
  61. data/contrib/rack_logo.svg +0 -164
  62. data/contrib/rdoc.css +0 -412
  63. data/example/lobster.ru +0 -6
  64. data/example/protectedlobster.rb +0 -16
  65. data/example/protectedlobster.ru +0 -10
  66. data/lib/rack/auth/digest/md5.rb +0 -131
  67. data/lib/rack/auth/digest/nonce.rb +0 -53
  68. data/lib/rack/auth/digest/params.rb +0 -54
  69. data/lib/rack/auth/digest/request.rb +0 -43
  70. data/lib/rack/chunked.rb +0 -117
  71. data/lib/rack/core_ext/regexp.rb +0 -14
  72. data/lib/rack/file.rb +0 -7
  73. data/lib/rack/handler/cgi.rb +0 -59
  74. data/lib/rack/handler/fastcgi.rb +0 -100
  75. data/lib/rack/handler/lsws.rb +0 -61
  76. data/lib/rack/handler/scgi.rb +0 -71
  77. data/lib/rack/handler/thin.rb +0 -36
  78. data/lib/rack/handler/webrick.rb +0 -129
  79. data/lib/rack/handler.rb +0 -104
  80. data/lib/rack/lobster.rb +0 -70
  81. data/lib/rack/logger.rb +0 -20
  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
data/lib/rack/lint.rb CHANGED
@@ -2,794 +2,963 @@
2
2
 
3
3
  require 'forwardable'
4
4
 
5
- module Rack
6
- # Rack::Lint validates your application and the requests and
7
- # responses according to the Rack spec.
5
+ require_relative 'constants'
6
+ require_relative 'utils'
8
7
 
8
+ module Rack
9
+ # Validates your application and the requests and responses according to the Rack spec. See SPEC.rdoc for details.
9
10
  class Lint
11
+ # Represents a failure to meet the Rack specification.
12
+ class LintError < RuntimeError; end
13
+
14
+ # Invoke the application, validating the request and response according to the Rack spec.
15
+ def call(env = nil)
16
+ Wrapper.new(@app, env).response
17
+ end
18
+
19
+ # :stopdoc:
20
+
21
+ ALLOWED_SCHEMES = %w(https http wss ws).freeze
22
+
23
+ REQUEST_PATH_ORIGIN_FORM = /\A\/[^#]*\z/
24
+ REQUEST_PATH_ABSOLUTE_FORM = /\A#{Utils::URI_PARSER.make_regexp}\z/
25
+ REQUEST_PATH_AUTHORITY_FORM = /\A[^\/:]+:\d+\z/
26
+ REQUEST_PATH_ASTERISK_FORM = '*'
27
+
28
+ # Match a host name, according to RFC3986. Copied from `URI::RFC3986_Parser::HOST` because older Ruby versions (< 3.3) don't expose it.
29
+ HOST_PATTERN = /
30
+ (?<IP-literal>\[(?:
31
+ (?<IPv6address>
32
+ (?:\h{1,4}:){6}
33
+ (?<ls32>\h{1,4}:\h{1,4}
34
+ | (?<IPv4address>(?<dec-octet>[1-9]\d|1\d{2}|2[0-4]\d|25[0-5]|\d)
35
+ \.\g<dec-octet>\.\g<dec-octet>\.\g<dec-octet>)
36
+ )
37
+ | ::(?:\h{1,4}:){5}\g<ls32>
38
+ | \h{1,4}?::(?:\h{1,4}:){4}\g<ls32>
39
+ | (?:(?:\h{1,4}:)?\h{1,4})?::(?:\h{1,4}:){3}\g<ls32>
40
+ | (?:(?:\h{1,4}:){,2}\h{1,4})?::(?:\h{1,4}:){2}\g<ls32>
41
+ | (?:(?:\h{1,4}:){,3}\h{1,4})?::\h{1,4}:\g<ls32>
42
+ | (?:(?:\h{1,4}:){,4}\h{1,4})?::\g<ls32>
43
+ | (?:(?:\h{1,4}:){,5}\h{1,4})?::\h{1,4}
44
+ | (?:(?:\h{1,4}:){,6}\h{1,4})?::
45
+ )
46
+ | (?<IPvFuture>v\h++\.[!$&-.0-9:;=A-Z_a-z~]++)
47
+ )\])
48
+ | \g<IPv4address>
49
+ | (?<reg-name>(?:%\h\h|[!$&-.0-9;=A-Z_a-z~])*+)
50
+ /x.freeze
51
+ SERVER_NAME_PATTERN = /\A#{HOST_PATTERN}\z/.freeze
52
+ HTTP_HOST_PATTERN = /\A#{HOST_PATTERN}(:\d*+)?\z/.freeze
53
+
54
+ private_constant :HOST_PATTERN, :SERVER_NAME_PATTERN, :HTTP_HOST_PATTERN
55
+
56
+ # N.B. The empty `##` comments creates paragraphs in the output. A trailing "\" is used to escape the newline character, which combines the comments into a single paragraph.
57
+ #
58
+ ## = Rack Specification
59
+ ##
60
+ ## This specification aims to formalize the Rack protocol. You can (and should) use +Rack::Lint+ to enforce it. When you develop middleware, be sure to test with +Rack::Lint+ to catch possible violations of this specification.
61
+ ##
62
+ ## == The Application
63
+ ##
64
+ ## A Rack application is a Ruby object that responds to +call+. \
10
65
  def initialize(app)
66
+ raise LintError, "app must respond to call" unless app.respond_to?(:call)
67
+
11
68
  @app = app
12
- @content_length = nil
13
69
  end
14
70
 
15
- # :stopdoc:
71
+ class Wrapper
72
+ def initialize(app, env)
73
+ @app = app
74
+ @env = env
75
+ @response = nil
76
+ @head_request = false
16
77
 
17
- class LintError < RuntimeError; end
18
- module Assertion
19
- def assert(message)
20
- unless yield
21
- raise LintError, message
22
- end
78
+ @status = nil
79
+ @headers = nil
80
+ @body = nil
81
+ @consumed = nil
82
+ @content_length = nil
83
+ @closed = false
84
+ @size = 0
23
85
  end
24
- end
25
- include Assertion
26
86
 
27
- ## This specification aims to formalize the Rack protocol. You
28
- ## can (and should) use Rack::Lint to enforce it.
29
- ##
30
- ## When you develop middleware, be sure to add a Lint before and
31
- ## after to catch all mistakes.
87
+ def response
88
+ ## It takes exactly one argument, the +environment+ (representing an HTTP request) \
89
+ raise LintError, "No env given" unless @env
90
+ check_environment(@env)
32
91
 
33
- ## = Rack applications
92
+ ## and returns a non-frozen +Array+ of exactly three elements: \
93
+ @response = @app.call(@env)
34
94
 
35
- ## A Rack application is a Ruby object (not a class) that
36
- ## responds to +call+.
37
- def call(env = nil)
38
- dup._call(env)
39
- end
95
+ raise LintError, "response is not an Array, but #{@response.class}" unless @response.kind_of? Array
96
+ raise LintError, "response is frozen" if @response.frozen?
97
+ raise LintError, "response array has #{@response.size} elements instead of 3" unless @response.size == 3
98
+
99
+ @status, @headers, @body = @response
100
+ ## the +status+, \
101
+ check_status(@status)
40
102
 
41
- def _call(env)
42
- ## It takes exactly one argument, the *environment*
43
- raise LintError, "No env given" unless env
44
- check_env env
103
+ ## the +headers+, \
104
+ check_headers(@headers)
45
105
 
46
- env[RACK_INPUT] = InputWrapper.new(env[RACK_INPUT])
47
- env[RACK_ERRORS] = ErrorWrapper.new(env[RACK_ERRORS])
106
+ hijack_proc = check_hijack_response(@headers, @env)
107
+ if hijack_proc
108
+ @headers[RACK_HIJACK] = hijack_proc
109
+ end
48
110
 
49
- ## and returns an Array of exactly three values:
50
- ary = @app.call(env)
51
- raise LintError, "response is not an Array, but #{ary.class}" unless ary.kind_of? Array
52
- raise LintError, "response array has #{ary.size} elements instead of 3" unless ary.size == 3
111
+ ## and the +body+ (representing an HTTP response).
112
+ check_content_type_header(@status, @headers)
113
+ check_content_length_header(@status, @headers)
114
+ check_rack_protocol_header(@status, @headers)
115
+ @head_request = @env[REQUEST_METHOD] == HEAD
53
116
 
54
- status, headers, @body = ary
55
- ## The *status*,
56
- check_status status
57
- ## the *headers*,
58
- check_headers headers
117
+ @lint = (@env['rack.lint'] ||= []) << self
118
+
119
+ if (@env['rack.lint.body_iteration'] ||= 0) > 0
120
+ raise LintError, "Middleware must not call #each directly"
121
+ end
59
122
 
60
- hijack_proc = check_hijack_response headers, env
61
- if hijack_proc && headers.is_a?(Hash)
62
- headers[RACK_HIJACK] = hijack_proc
123
+ return [@status, @headers, self]
63
124
  end
64
125
 
65
- ## and the *body*.
66
- check_content_type status, headers
67
- check_content_length status, headers
68
- @head_request = env[REQUEST_METHOD] == HEAD
69
- [status, headers, self]
70
- end
126
+ private def assert_required(key)
127
+ raise LintError, "env missing required key #{key}" unless @env.include?(key)
71
128
 
72
- ## == The Environment
73
- def check_env(env)
74
- ## The environment must be an unfrozen instance of Hash that includes
75
- ## CGI-like headers. The application is free to modify the
76
- ## environment.
77
- raise LintError, "env #{env.inspect} is not a Hash, but #{env.class}" unless env.kind_of? Hash
78
- raise LintError, "env should not be frozen, but is" if env.frozen?
79
-
80
- ##
81
- ## The environment is required to include these variables
82
- ## (adopted from PEP333), except when they'd be empty, but see
83
- ## below.
84
-
85
- ## <tt>REQUEST_METHOD</tt>:: The HTTP request method, such as
86
- ## "GET" or "POST". This cannot ever
87
- ## be an empty string, and so is
88
- ## always required.
89
-
90
- ## <tt>SCRIPT_NAME</tt>:: The initial portion of the request
91
- ## URL's "path" that corresponds to the
92
- ## application object, so that the
93
- ## application knows its virtual
94
- ## "location". This may be an empty
95
- ## string, if the application corresponds
96
- ## to the "root" of the server.
97
-
98
- ## <tt>PATH_INFO</tt>:: The remainder of the request URL's
99
- ## "path", designating the virtual
100
- ## "location" of the request's target
101
- ## within the application. This may be an
102
- ## empty string, if the request URL targets
103
- ## the application root and does not have a
104
- ## trailing slash. This value may be
105
- ## percent-encoded when originating from
106
- ## a URL.
107
-
108
- ## <tt>QUERY_STRING</tt>:: The portion of the request URL that
109
- ## follows the <tt>?</tt>, if any. May be
110
- ## empty, but is always required!
111
-
112
- ## <tt>SERVER_NAME</tt>:: When combined with <tt>SCRIPT_NAME</tt> and
113
- ## <tt>PATH_INFO</tt>, these variables can be
114
- ## used to complete the URL. Note, however,
115
- ## that <tt>HTTP_HOST</tt>, if present,
116
- ## should be used in preference to
117
- ## <tt>SERVER_NAME</tt> for reconstructing
118
- ## the request URL.
119
- ## <tt>SERVER_NAME</tt> can never be an empty
120
- ## string, and so is always required.
121
-
122
- ## <tt>SERVER_PORT</tt>:: An optional +Integer+ which is the port the
123
- ## server is running on. Should be specified if
124
- ## the server is running on a non-standard port.
125
-
126
- ## <tt>HTTP_</tt> Variables:: Variables corresponding to the
127
- ## client-supplied HTTP request
128
- ## headers (i.e., variables whose
129
- ## names begin with <tt>HTTP_</tt>). The
130
- ## presence or absence of these
131
- ## variables should correspond with
132
- ## the presence or absence of the
133
- ## appropriate HTTP header in the
134
- ## request. See
135
- ## {RFC3875 section 4.1.18}[https://tools.ietf.org/html/rfc3875#section-4.1.18]
136
- ## for specific behavior.
137
-
138
- ## In addition to this, the Rack environment must include these
139
- ## Rack-specific variables:
140
-
141
- ## <tt>rack.version</tt>:: The Array representing this version of Rack
142
- ## See Rack::VERSION, that corresponds to
143
- ## the version of this SPEC.
144
-
145
- ## <tt>rack.url_scheme</tt>:: +http+ or +https+, depending on the
146
- ## request URL.
147
-
148
- ## <tt>rack.input</tt>:: See below, the input stream.
149
-
150
- ## <tt>rack.errors</tt>:: See below, the error stream.
151
-
152
- ## <tt>rack.multithread</tt>:: true if the application object may be
153
- ## simultaneously invoked by another thread
154
- ## in the same process, false otherwise.
155
-
156
- ## <tt>rack.multiprocess</tt>:: true if an equivalent application object
157
- ## may be simultaneously invoked by another
158
- ## process, false otherwise.
159
-
160
- ## <tt>rack.run_once</tt>:: true if the server expects
161
- ## (but does not guarantee!) that the
162
- ## application will only be invoked this one
163
- ## time during the life of its containing
164
- ## process. Normally, this will only be true
165
- ## for a server based on CGI
166
- ## (or something similar).
167
-
168
- ## <tt>rack.hijack?</tt>:: present and true if the server supports
169
- ## connection hijacking. See below, hijacking.
170
-
171
- ## <tt>rack.hijack</tt>:: an object responding to #call that must be
172
- ## called at least once before using
173
- ## rack.hijack_io.
174
- ## It is recommended #call return rack.hijack_io
175
- ## as well as setting it in env if necessary.
176
-
177
- ## <tt>rack.hijack_io</tt>:: if rack.hijack? is true, and rack.hijack
178
- ## has received #call, this will contain
179
- ## an object resembling an IO. See hijacking.
180
-
181
- ## Additional environment specifications have approved to
182
- ## standardized middleware APIs. None of these are required to
183
- ## be implemented by the server.
184
-
185
- ## <tt>rack.session</tt>:: A hash like interface for storing
186
- ## request session data.
187
- ## The store must implement:
188
- if session = env[RACK_SESSION]
189
- ## store(key, value) (aliased as []=);
190
- unless session.respond_to?(:store) && session.respond_to?(:[]=)
191
- raise LintError, "session #{session.inspect} must respond to store and []="
192
- end
193
-
194
- ## fetch(key, default = nil) (aliased as []);
195
- unless session.respond_to?(:fetch) && session.respond_to?(:[])
196
- raise LintError, "session #{session.inspect} must respond to fetch and []"
197
- end
198
-
199
- ## delete(key);
200
- unless session.respond_to?(:delete)
201
- raise LintError, "session #{session.inspect} must respond to delete"
202
- end
203
-
204
- ## clear;
205
- unless session.respond_to?(:clear)
206
- raise LintError, "session #{session.inspect} must respond to clear"
207
- end
208
-
209
- ## to_hash (returning unfrozen Hash instance);
210
- unless session.respond_to?(:to_hash) && session.to_hash.kind_of?(Hash) && !session.to_hash.frozen?
211
- raise LintError, "session #{session.inspect} must respond to to_hash and return unfrozen Hash instance"
212
- end
129
+ return @env[key]
213
130
  end
214
131
 
215
- ## <tt>rack.logger</tt>:: A common object interface for logging messages.
216
- ## The object must implement:
217
- if logger = env[RACK_LOGGER]
218
- ## info(message, &block)
219
- unless logger.respond_to?(:info)
220
- raise LintError, "logger #{logger.inspect} must respond to info"
132
+ ##
133
+ ## == The Request Environment
134
+ ##
135
+ ## Incoming HTTP requests are represented using an environment. \
136
+ def check_environment(env)
137
+ ## The environment must be an unfrozen +Hash+. The Rack application is free to modify the environment, but the modified environment should also comply with this specification. \
138
+ raise LintError, "env #{env.inspect} is not a Hash, but #{env.class}" unless env.kind_of? Hash
139
+ raise LintError, "env should not be frozen, but is" if env.frozen?
140
+
141
+ ## All environment keys must be strings.
142
+ keys = env.keys
143
+ keys.reject!{|key| String === key}
144
+ unless keys.empty?
145
+ raise LintError, "env contains non-string keys: #{keys.inspect}"
221
146
  end
222
147
 
223
- ## debug(message, &block)
224
- unless logger.respond_to?(:debug)
225
- raise LintError, "logger #{logger.inspect} must respond to debug"
148
+ ##
149
+ ## === CGI Variables
150
+ ##
151
+ ## The environment is required to include these variables, adopted from {The Common Gateway Interface}[https://datatracker.ietf.org/doc/html/rfc3875] (CGI), except when they'd be empty, but see below.
152
+
153
+ ##
154
+ ## The CGI keys (named without a period) must have +String+ values and are reserved for the Rack specification. If the values for CGI keys contain non-ASCII characters, they should use <tt>ASCII-8BIT</tt> encoding.
155
+ env.each do |key, value|
156
+ next if key.include?(".") # Skip extensions
157
+
158
+ unless value.kind_of? String
159
+ raise LintError, "env variable #{key} has non-string value #{value.inspect}"
160
+ end
161
+
162
+ next if value.encoding == Encoding::ASCII_8BIT
163
+
164
+ unless value.b !~ /[\x80-\xff]/n
165
+ raise LintError, "env variable #{key} has value containing non-ASCII characters and has non-ASCII-8BIT encoding #{value.inspect} encoding: #{value.encoding}"
166
+ end
226
167
  end
227
168
 
228
- ## warn(message, &block)
229
- unless logger.respond_to?(:warn)
230
- raise LintError, "logger #{logger.inspect} must respond to warn"
169
+ ##
170
+ ## The server and application can store their own data in the environment, too. The keys must contain at least one dot, and should be prefixed uniquely. The prefix <tt>rack.</tt> is reserved for use with the Rack specification and the classes that ship with Rack.
171
+
172
+ ##
173
+ ## ==== <tt>REQUEST_METHOD</tt>
174
+ ##
175
+ ## The HTTP request method, such as "GET" or "POST". This cannot ever be an empty string, and so is always required.
176
+ request_method = assert_required(REQUEST_METHOD)
177
+ unless request_method =~ /\A[0-9A-Za-z!\#$%&'*+.^_`|~-]+\z/
178
+ raise LintError, "REQUEST_METHOD unknown: #{request_method.inspect}"
231
179
  end
232
180
 
233
- ## error(message, &block)
234
- unless logger.respond_to?(:error)
235
- raise LintError, "logger #{logger.inspect} must respond to error"
181
+ ##
182
+ ## ==== <tt>SCRIPT_NAME</tt>
183
+ ##
184
+ ## The initial portion of the request URL's path that corresponds to the application object, so that the application knows its virtual location. This may be an empty string, if the application corresponds to the root of the server. If non-empty, the string must start with <tt>/</tt>, but should not end with <tt>/</tt>.
185
+ if script_name = env[SCRIPT_NAME]
186
+ if script_name != "" && script_name !~ /\A\//
187
+ raise LintError, "SCRIPT_NAME must start with /"
188
+ end
189
+
190
+ ##
191
+ ## In addition, <tt>SCRIPT_NAME</tt> MUST not be <tt>/</tt>, but instead be empty, \
192
+ if script_name == "/"
193
+ raise LintError, "SCRIPT_NAME cannot be '/', make it '' and PATH_INFO '/'"
194
+ end
236
195
  end
237
196
 
238
- ## fatal(message, &block)
239
- unless logger.respond_to?(:fatal)
240
- raise LintError, "logger #{logger.inspect} must respond to fatal"
197
+ ## and one of <tt>SCRIPT_NAME</tt> or <tt>PATH_INFO</tt> must be set, e.g. <tt>PATH_INFO</tt> can be <tt>/</tt> if <tt>SCRIPT_NAME</tt> is empty.
198
+ path_info = env[PATH_INFO]
199
+ if (script_name.nil? || script_name.empty?) && (path_info.nil? || path_info.empty?)
200
+ raise LintError, "One of SCRIPT_NAME or PATH_INFO must be set (make PATH_INFO '/' if SCRIPT_NAME is empty)"
241
201
  end
242
- end
243
202
 
244
- ## <tt>rack.multipart.buffer_size</tt>:: An Integer hint to the multipart parser as to what chunk size to use for reads and writes.
245
- if bufsize = env[RACK_MULTIPART_BUFFER_SIZE]
246
- unless bufsize.is_a?(Integer) && bufsize > 0
247
- raise LintError, "rack.multipart.buffer_size must be an Integer > 0 if specified"
203
+ ##
204
+ ## ==== <tt>PATH_INFO</tt>
205
+ ##
206
+ ## The remainder of the request URL's "path", designating the virtual "location" of the request's target within the application. This may be an empty string, if the request URL targets the application root and does not have a trailing slash. This value may be percent-encoded when originating from a URL.
207
+ ##
208
+ ## The <tt>PATH_INFO</tt>, if provided, must be a valid request target or an empty string, as defined by {RFC9110}[https://datatracker.ietf.org/doc/html/rfc9110#target.resource].
209
+ case path_info
210
+ when REQUEST_PATH_ASTERISK_FORM
211
+ ## * Only <tt>OPTIONS</tt> requests may have <tt>PATH_INFO</tt> set to <tt>*</tt> (asterisk-form).
212
+ unless request_method == OPTIONS
213
+ raise LintError, "Only OPTIONS requests may have PATH_INFO set to '*' (asterisk-form)"
214
+ end
215
+ when REQUEST_PATH_AUTHORITY_FORM
216
+ ## * Only <tt>CONNECT</tt> requests may have <tt>PATH_INFO</tt> set to an authority (authority-form). Note that in HTTP/2+, the authority-form is not a valid request target.
217
+ unless request_method == CONNECT
218
+ raise LintError, "Only CONNECT requests may have PATH_INFO set to an authority (authority-form)"
219
+ end
220
+ when REQUEST_PATH_ABSOLUTE_FORM
221
+ ## * <tt>CONNECT</tt> and <tt>OPTIONS</tt> requests must not have <tt>PATH_INFO</tt> set to a URI (absolute-form).
222
+ if request_method == CONNECT || request_method == OPTIONS
223
+ raise LintError, "CONNECT and OPTIONS requests must not have PATH_INFO set to a URI (absolute-form)"
224
+ end
225
+ when REQUEST_PATH_ORIGIN_FORM
226
+ ## * Otherwise, <tt>PATH_INFO</tt> must start with a <tt>/</tt> and must not include a fragment part starting with <tt>#</tt> (origin-form).
227
+ when "", nil
228
+ # Empty string or nil is okay.
229
+ else
230
+ raise LintError, "PATH_INFO must start with a '/' and must not include a fragment part starting with '#' (origin-form)"
248
231
  end
249
- end
250
232
 
251
- ## <tt>rack.multipart.tempfile_factory</tt>:: An object responding to #call with two arguments, the filename and content_type given for the multipart form field, and returning an IO-like object that responds to #<< and optionally #rewind. This factory will be used to instantiate the tempfile for each multipart form file upload field, rather than the default class of Tempfile.
252
- if tempfile_factory = env[RACK_MULTIPART_TEMPFILE_FACTORY]
253
- raise LintError, "rack.multipart.tempfile_factory must respond to #call" unless tempfile_factory.respond_to?(:call)
254
- env[RACK_MULTIPART_TEMPFILE_FACTORY] = lambda do |filename, content_type|
255
- io = tempfile_factory.call(filename, content_type)
256
- raise LintError, "rack.multipart.tempfile_factory return value must respond to #<<" unless io.respond_to?(:<<)
257
- io
233
+ ##
234
+ ## ==== <tt>QUERY_STRING</tt>
235
+ ##
236
+ ## The portion of the request URL that follows the <tt>?</tt>, if any. May be empty, but is always required!
237
+ assert_required(QUERY_STRING)
238
+
239
+ ##
240
+ ## ==== <tt>SERVER_NAME</tt>
241
+ ##
242
+ ## Must be a valid host, as defined by {RFC3986}[https://datatracker.ietf.org/doc/html/rfc3986#section-3.2.2].
243
+ ##
244
+ ## When combined with <tt>SCRIPT_NAME</tt>, <tt>PATH_INFO</tt>, and <tt>QUERY_STRING</tt>, these variables can be used to reconstruct the original the request URL. Note, however, that <tt>HTTP_HOST</tt>, if present, should be used in preference to <tt>SERVER_NAME</tt> for reconstructing the request URL.
245
+ server_name = assert_required(SERVER_NAME)
246
+ unless server_name.match?(SERVER_NAME_PATTERN)
247
+ raise LintError, "env[SERVER_NAME] must be a valid host"
258
248
  end
259
- end
260
249
 
261
- ## The server or the application can store their own data in the
262
- ## environment, too. The keys must contain at least one dot,
263
- ## and should be prefixed uniquely. The prefix <tt>rack.</tt>
264
- ## is reserved for use with the Rack core distribution and other
265
- ## accepted specifications and must not be used otherwise.
266
- ##
250
+ ##
251
+ ## ==== <tt>SERVER_PROTOCOL</tt>
252
+ ##
253
+ ## The HTTP version used for the request. It must match the regular expression <tt>HTTP\/\d(\.\d)?</tt>.
254
+ server_protocol = assert_required(SERVER_PROTOCOL)
255
+ unless %r{HTTP/\d(\.\d)?}.match?(server_protocol)
256
+ raise LintError, "env[SERVER_PROTOCOL] does not match HTTP/\\d(\\.\\d)?"
257
+ end
267
258
 
268
- %w[REQUEST_METHOD SERVER_NAME QUERY_STRING
269
- rack.version rack.input rack.errors
270
- rack.multithread rack.multiprocess rack.run_once].each { |header|
271
- raise LintError, "env missing required key #{header}" unless env.include? header
272
- }
259
+ ##
260
+ ## ==== <tt>SERVER_PORT</tt>
261
+ ##
262
+ ## The port the server is running on, if the server is running on a non-standard port. It must consist of digits only.
263
+ ##
264
+ ## The standard ports are:
265
+ ## * 80 for HTTP
266
+ ## * 443 for HTTPS
267
+ if server_port = env[SERVER_PORT]
268
+ unless server_port =~ /\A\d+\z/
269
+ raise LintError, "env[SERVER_PORT] is not an Integer"
270
+ end
271
+ end
273
272
 
274
- ## The <tt>SERVER_PORT</tt> must be an Integer if set.
275
- server_port = env["SERVER_PORT"]
276
- unless server_port.nil? || (Integer(server_port) rescue false)
277
- raise LintError, "env[SERVER_PORT] is not an Integer"
278
- end
273
+ ##
274
+ ## ==== <tt>CONTENT_TYPE</tt>
275
+ ##
276
+ ## The optional MIME type of the request body, if any.
277
+ # N.B. We do not validate this field as it is considered user-provided data.
279
278
 
280
- ## The <tt>SERVER_NAME</tt> must be a valid authority as defined by RFC7540.
281
- unless (URI.parse("http://#{env[SERVER_NAME]}/") rescue false)
282
- raise LintError, "#{env[SERVER_NAME]} must be a valid authority"
283
- end
279
+ ##
280
+ ## ==== <tt>CONTENT_LENGTH</tt>
281
+ ##
282
+ ## The length of the request body, if any. It must consist of digits only.
283
+ if content_length = env["CONTENT_LENGTH"]
284
+ if content_length !~ /\A\d+\z/
285
+ raise LintError, "Invalid CONTENT_LENGTH: #{content_length.inspect}"
286
+ end
287
+ end
284
288
 
285
- ## The <tt>HTTP_HOST</tt> must be a valid authority as defined by RFC7540.
286
- unless (URI.parse("http://#{env[HTTP_HOST]}/") rescue false)
287
- raise LintError, "#{env[HTTP_HOST]} must be a valid authority"
288
- end
289
+ ##
290
+ ## ==== <tt>HTTP_HOST</tt>
291
+ ##
292
+ ## An optional HTTP authority, as defined by {RFC9110}[https://datatracker.ietf.org/doc/html/rfc9110#name-host-and-authority].
293
+ if http_host = env[HTTP_HOST]
294
+ unless http_host.match?(HTTP_HOST_PATTERN)
295
+ raise LintError, "env[HTTP_HOST] must be a valid authority"
296
+ end
297
+ end
289
298
 
290
- ## The environment must not contain the keys
291
- ## <tt>HTTP_CONTENT_TYPE</tt> or <tt>HTTP_CONTENT_LENGTH</tt>
292
- ## (use the versions without <tt>HTTP_</tt>).
293
- %w[HTTP_CONTENT_TYPE HTTP_CONTENT_LENGTH].each { |header|
294
- if env.include? header
295
- raise LintError, "env contains #{header}, must use #{header[5, -1]}"
299
+ ##
300
+ ## ==== <tt>HTTP_</tt> Headers
301
+ ##
302
+ ## Unless specified above, the environment can contain any number of additional headers, each starting with <tt>HTTP_</tt>. The presence or absence of these variables should correspond with the presence or absence of the appropriate HTTP header in the request, and those headers have no specific interpretation or validation by the Rack specification. However, there are many standard HTTP headers that have a specific meaning in the context of a request; see {RFC3875 section 4.1.18}[https://tools.ietf.org/html/rfc3875#section-4.1.18] for more details.
303
+ ##
304
+ ## For compatibility with the CGI specifiction, the environment must not contain the keys <tt>HTTP_CONTENT_TYPE</tt> or <tt>HTTP_CONTENT_LENGTH</tt>. Instead, the keys <tt>CONTENT_TYPE</tt> and <tt>CONTENT_LENGTH</tt> must be used.
305
+ %w[HTTP_CONTENT_TYPE HTTP_CONTENT_LENGTH].each do |header|
306
+ if env.include?(header)
307
+ raise LintError, "env contains #{header}, must use #{header[5..-1]}"
308
+ end
296
309
  end
297
- }
298
310
 
299
- ## The CGI keys (named without a period) must have String values.
300
- ## If the string values for CGI keys contain non-ASCII characters,
301
- ## they should use ASCII-8BIT encoding.
302
- env.each { |key, value|
303
- next if key.include? "." # Skip extensions
304
- unless value.kind_of? String
305
- raise LintError, "env variable #{key} has non-string value #{value.inspect}"
311
+ ##
312
+ ## === Rack-Specific Variables
313
+ ##
314
+ ## In addition to CGI variables, the Rack environment includes Rack-specific variables. These variables are prefixed with <tt>rack.</tt> and are reserved for use by the Rack specification, or by the classes that ship with Rack.
315
+ ##
316
+ ## ==== <tt>rack.url_scheme</tt>
317
+ ##
318
+ ## The URL scheme, which must be one of <tt>http</tt>, <tt>https</tt>, <tt>ws</tt> or <tt>wss</tt>. This can never be an empty string, and so is always required. The scheme should be set according to the last hop. For example, if a client makes a request to a reverse proxy over HTTPS, but the connection between the reverse proxy and the server is over plain HTTP, the reverse proxy should set <tt>rack.url_scheme</tt> to <tt>http</tt>.
319
+ rack_url_scheme = assert_required(RACK_URL_SCHEME)
320
+ unless ALLOWED_SCHEMES.include?(rack_url_scheme)
321
+ raise LintError, "rack.url_scheme unknown: #{rack_url_scheme.inspect}"
306
322
  end
307
- next if value.encoding == Encoding::ASCII_8BIT
308
- unless value.b !~ /[\x80-\xff]/n
309
- raise LintError, "env variable #{key} has value containing non-ASCII characters and has non-ASCII-8BIT encoding #{value.inspect} encoding: #{value.encoding}"
323
+
324
+ ##
325
+ ## ==== <tt>rack.protocol</tt>
326
+ ##
327
+ ## An optional +Array+ of +String+ values, containing the protocols advertised by the client in the <tt>upgrade</tt> header (HTTP/1) or the <tt>:protocol</tt> pseudo-header (HTTP/2+).
328
+ if protocols = env[RACK_PROTOCOL]
329
+ unless protocols.is_a?(Array) && protocols.all?{|protocol| protocol.is_a?(String)}
330
+ raise LintError, "rack.protocol must be an Array of Strings"
331
+ end
310
332
  end
311
- }
312
333
 
313
- ## There are the following restrictions:
334
+ ##
335
+ ## ==== <tt>rack.session</tt>
336
+ ##
337
+ ## An optional +Hash+-like interface for storing request session data. The store must implement:
338
+ if session = env[RACK_SESSION]
339
+ ## * <tt>store(key, value)</tt> (aliased as <tt>[]=</tt>) to set a value for a key,
340
+ unless session.respond_to?(:store) && session.respond_to?(:[]=)
341
+ raise LintError, "session #{session.inspect} must respond to store and []="
342
+ end
314
343
 
315
- ## * <tt>rack.version</tt> must be an array of Integers.
316
- unless env[RACK_VERSION].kind_of? Array
317
- raise LintError, "rack.version must be an Array, was #{env[RACK_VERSION].class}"
318
- end
319
- ## * <tt>rack.url_scheme</tt> must either be +http+ or +https+.
320
- unless %w[http https].include?(env[RACK_URL_SCHEME])
321
- raise LintError, "rack.url_scheme unknown: #{env[RACK_URL_SCHEME].inspect}"
322
- end
344
+ ## * <tt>fetch(key, default = nil)</tt> (aliased as <tt>[]</tt>) to retrieve a value for a key,
345
+ unless session.respond_to?(:fetch) && session.respond_to?(:[])
346
+ raise LintError, "session #{session.inspect} must respond to fetch and []"
347
+ end
323
348
 
324
- ## * There must be a valid input stream in <tt>rack.input</tt>.
325
- check_input env[RACK_INPUT]
326
- ## * There must be a valid error stream in <tt>rack.errors</tt>.
327
- check_error env[RACK_ERRORS]
328
- ## * There may be a valid hijack stream in <tt>rack.hijack_io</tt>
329
- check_hijack env
349
+ ## * <tt>delete(key)</tt> to delete a key,
350
+ unless session.respond_to?(:delete)
351
+ raise LintError, "session #{session.inspect} must respond to delete"
352
+ end
330
353
 
331
- ## * The <tt>REQUEST_METHOD</tt> must be a valid token.
332
- unless env[REQUEST_METHOD] =~ /\A[0-9A-Za-z!\#$%&'*+.^_`|~-]+\z/
333
- raise LintError, "REQUEST_METHOD unknown: #{env[REQUEST_METHOD].dump}"
334
- end
354
+ ## * <tt>clear</tt> to clear the session,
355
+ unless session.respond_to?(:clear)
356
+ raise LintError, "session #{session.inspect} must respond to clear"
357
+ end
335
358
 
336
- ## * The <tt>SCRIPT_NAME</tt>, if non-empty, must start with <tt>/</tt>
337
- if env.include?(SCRIPT_NAME) && env[SCRIPT_NAME] != "" && env[SCRIPT_NAME] !~ /\A\//
338
- raise LintError, "SCRIPT_NAME must start with /"
339
- end
340
- ## * The <tt>PATH_INFO</tt>, if non-empty, must start with <tt>/</tt>
341
- if env.include?(PATH_INFO) && env[PATH_INFO] != "" && env[PATH_INFO] !~ /\A\//
342
- raise LintError, "PATH_INFO must start with /"
343
- end
344
- ## * The <tt>CONTENT_LENGTH</tt>, if given, must consist of digits only.
345
- if env.include?("CONTENT_LENGTH") && env["CONTENT_LENGTH"] !~ /\A\d+\z/
346
- raise LintError, "Invalid CONTENT_LENGTH: #{env["CONTENT_LENGTH"]}"
347
- end
359
+ ## * <tt>to_hash</tt> (optional) to retrieve the session as a Hash.
360
+ unless session.respond_to?(:to_hash) && session.to_hash.kind_of?(Hash) && !session.to_hash.frozen?
361
+ raise LintError, "session #{session.inspect} must respond to to_hash and return unfrozen Hash instance"
362
+ end
363
+ end
348
364
 
349
- ## * One of <tt>SCRIPT_NAME</tt> or <tt>PATH_INFO</tt> must be
350
- ## set. <tt>PATH_INFO</tt> should be <tt>/</tt> if
351
- ## <tt>SCRIPT_NAME</tt> is empty.
352
- unless env[SCRIPT_NAME] || env[PATH_INFO]
353
- raise LintError, "One of SCRIPT_NAME or PATH_INFO must be set (make PATH_INFO '/' if SCRIPT_NAME is empty)"
354
- end
355
- ## <tt>SCRIPT_NAME</tt> never should be <tt>/</tt>, but instead be empty.
356
- unless env[SCRIPT_NAME] != "/"
357
- raise LintError, "SCRIPT_NAME cannot be '/', make it '' and PATH_INFO '/'"
358
- end
359
- end
365
+ ##
366
+ ## ==== <tt>rack.logger</tt>
367
+ ##
368
+ ## An optional +Logger+-like interface for logging messages. The logger must implement:
369
+ if logger = env[RACK_LOGGER]
370
+ ## * <tt>info(message, &block)</tt>,
371
+ unless logger.respond_to?(:info)
372
+ raise LintError, "logger #{logger.inspect} must respond to info"
373
+ end
360
374
 
361
- ## === The Input Stream
362
- ##
363
- ## The input stream is an IO-like object which contains the raw HTTP
364
- ## POST data.
365
- def check_input(input)
366
- ## When applicable, its external encoding must be "ASCII-8BIT" and it
367
- ## must be opened in binary mode, for Ruby 1.9 compatibility.
368
- if input.respond_to?(:external_encoding) && input.external_encoding != Encoding::ASCII_8BIT
369
- raise LintError, "rack.input #{input} does not have ASCII-8BIT as its external encoding"
370
- end
371
- if input.respond_to?(:binmode?) && !input.binmode?
372
- raise LintError, "rack.input #{input} is not opened in binary mode"
373
- end
375
+ ## * <tt>debug(message, &block)</tt>,
376
+ unless logger.respond_to?(:debug)
377
+ raise LintError, "logger #{logger.inspect} must respond to debug"
378
+ end
374
379
 
375
- ## The input stream must respond to +gets+, +each+, +read+ and +rewind+.
376
- [:gets, :each, :read, :rewind].each { |method|
377
- unless input.respond_to? method
378
- raise LintError, "rack.input #{input} does not respond to ##{method}"
380
+ ## * <tt>warn(message, &block)</tt>,
381
+ unless logger.respond_to?(:warn)
382
+ raise LintError, "logger #{logger.inspect} must respond to warn"
383
+ end
384
+
385
+ ## * <tt>error(message, &block)</tt>,
386
+ unless logger.respond_to?(:error)
387
+ raise LintError, "logger #{logger.inspect} must respond to error"
388
+ end
389
+
390
+ ## * <tt>fatal(message, &block)</tt>.
391
+ unless logger.respond_to?(:fatal)
392
+ raise LintError, "logger #{logger.inspect} must respond to fatal"
393
+ end
379
394
  end
380
- }
381
- end
382
395
 
383
- class InputWrapper
384
- include Assertion
396
+ ##
397
+ ## ==== <tt>rack.multipart.buffer_size</tt>
398
+ ##
399
+ ## An optional +Integer+ hint to the multipart parser as to what chunk size to use for reads and writes.
400
+ if rack_multipart_buffer_size = env[RACK_MULTIPART_BUFFER_SIZE]
401
+ unless rack_multipart_buffer_size.is_a?(Integer) && rack_multipart_buffer_size > 0
402
+ raise LintError, "rack.multipart.buffer_size must be an Integer > 0 if specified"
403
+ end
404
+ end
385
405
 
386
- def initialize(input)
387
- @input = input
388
- end
406
+ ##
407
+ ## ==== <tt>rack.multipart.tempfile_factory</tt>
408
+ ##
409
+ ## An optional object for constructing temporary files for multipart form data. The factory must implement:
410
+ if rack_multipart_tempfile_factory = env[RACK_MULTIPART_TEMPFILE_FACTORY]
411
+ ## * <tt>call(filename, content_type)</tt> to create a temporary file for a multipart form field.
412
+ unless rack_multipart_tempfile_factory.respond_to?(:call)
413
+ raise LintError, "rack.multipart.tempfile_factory must respond to #call"
414
+ end
389
415
 
390
- ## * +gets+ must be called without arguments and return a string,
391
- ## or +nil+ on EOF.
392
- def gets(*args)
393
- raise LintError, "rack.input#gets called with arguments" unless args.size == 0
394
- v = @input.gets
395
- unless v.nil? or v.kind_of? String
396
- raise LintError, "rack.input#gets didn't return a String"
416
+ ## The factory must return an +IO+-like object that responds to <tt><<</tt> and optionally <tt>rewind</tt>.
417
+ env[RACK_MULTIPART_TEMPFILE_FACTORY] = lambda do |filename, content_type|
418
+ io = rack_multipart_tempfile_factory.call(filename, content_type)
419
+ unless io.respond_to?(:<<)
420
+ raise LintError, "rack.multipart.tempfile_factory return value must respond to #<<"
421
+ end
422
+ io
423
+ end
424
+ end
425
+
426
+ ##
427
+ ## ==== <tt>rack.hijack?</tt>
428
+ ##
429
+ ## If present and truthy, indicates that the server supports partial hijacking. See the section below on hijacking for more information.
430
+ #
431
+ # N.B. There is no specific validation here. If the user provides a partial hijack response, we will confirm this value is truthy in `check_hijack_response`.
432
+
433
+ ##
434
+ ## ==== <tt>rack.hijack</tt>
435
+ ##
436
+ ## If present, an object responding to +call+ that is used to perform a full hijack. See the section below on hijacking for more information.
437
+ check_hijack(env)
438
+
439
+ ##
440
+ ## ==== <tt>rack.early_hints</tt>
441
+ ##
442
+ ## If present, an object responding to +call+ that is used to send early hints. See the section below on early hints for more information.
443
+ check_early_hints env
444
+
445
+ ##
446
+ ## ==== <tt>rack.input</tt>
447
+ ##
448
+ ## If present, the input stream. See the section below on the input stream for more information.
449
+ if rack_input = env[RACK_INPUT]
450
+ check_input_stream(rack_input)
451
+ @env[RACK_INPUT] = InputWrapper.new(rack_input)
452
+ end
453
+
454
+ ##
455
+ ## ==== <tt>rack.errors</tt>
456
+ ##
457
+ ## The error stream. See the section below on the error stream for more information.
458
+ rack_errors = assert_required(RACK_ERRORS)
459
+ check_error_stream(rack_errors)
460
+ @env[RACK_ERRORS] = ErrorWrapper.new(rack_errors)
461
+
462
+ ##
463
+ ## ==== <tt>rack.response_finished</tt>
464
+ ##
465
+ ## If present, an array of callables that will be run by the server after the response has been processed. The callables are called with <tt>environment, status, headers, error</tt> arguments and should not raise any exceptions. The callables would typically be called after sending the response to the client, but it could also be called if an error occurs while generating the response or sending the response (in that case, the +error+ argument will be a kind of +Exception+). The callables will be called in reverse order.
466
+ if rack_response_finished = env[RACK_RESPONSE_FINISHED]
467
+ raise LintError, "rack.response_finished must be an array of callable objects" unless rack_response_finished.is_a?(Array)
468
+ rack_response_finished.each do |callable|
469
+ raise LintError, "rack.response_finished values must respond to call(env, status, headers, error)" unless callable.respond_to?(:call)
470
+ end
397
471
  end
398
- v
399
472
  end
400
473
 
401
- ## * +read+ behaves like IO#read.
402
- ## Its signature is <tt>read([length, [buffer]])</tt>.
403
- ##
404
- ## If given, +length+ must be a non-negative Integer (>= 0) or +nil+,
405
- ## and +buffer+ must be a String and may not be nil.
406
- ##
407
- ## If +length+ is given and not nil, then this method reads at most
408
- ## +length+ bytes from the input stream.
409
474
  ##
410
- ## If +length+ is not given or nil, then this method reads
411
- ## all data until EOF.
475
+ ## === The Input Stream
412
476
  ##
413
- ## When EOF is reached, this method returns nil if +length+ is given
414
- ## and not nil, or "" if +length+ is not given or is nil.
415
- ##
416
- ## If +buffer+ is given, then the read data will be placed
417
- ## into +buffer+ instead of a newly created String object.
418
- def read(*args)
419
- unless args.size <= 2
420
- raise LintError, "rack.input#read called with too many arguments"
477
+ ## The input stream is an +IO+-like object which contains the raw HTTP request data. \
478
+ def check_input_stream(input)
479
+ ## When applicable, its external encoding must be <tt>ASCII-8BIT</tt> and it must be opened in binary mode. \
480
+ if input.respond_to?(:external_encoding) && input.external_encoding != Encoding::ASCII_8BIT
481
+ raise LintError, "rack.input #{input} does not have ASCII-8BIT as its external encoding"
421
482
  end
422
- if args.size >= 1
423
- unless args.first.kind_of?(Integer) || args.first.nil?
424
- raise LintError, "rack.input#read called with non-integer and non-nil length"
425
- end
426
- unless args.first.nil? || args.first >= 0
427
- raise LintError, "rack.input#read called with a negative length"
483
+ if input.respond_to?(:binmode?) && !input.binmode?
484
+ raise LintError, "rack.input #{input} is not opened in binary mode"
485
+ end
486
+
487
+ ## The input stream must respond to +gets+, +each+, and +read+:
488
+ [:gets, :each, :read].each do |method|
489
+ unless input.respond_to? method
490
+ raise LintError, "rack.input #{input} does not respond to ##{method}"
428
491
  end
429
492
  end
430
- if args.size >= 2
431
- unless args[1].kind_of?(String)
432
- raise LintError, "rack.input#read called with non-String buffer"
493
+ end
494
+
495
+ class InputWrapper
496
+ def initialize(input)
497
+ @input = input
498
+ end
499
+
500
+ ## * +gets+ must be called without arguments and return a +String+, or +nil+ on EOF (end-of-file).
501
+ def gets(*args)
502
+ raise LintError, "rack.input#gets called with arguments" unless args.size == 0
503
+
504
+ chunk = @input.gets
505
+
506
+ unless chunk.nil? or chunk.kind_of? String
507
+ raise LintError, "rack.input#gets didn't return a String"
433
508
  end
509
+
510
+ chunk
434
511
  end
435
512
 
436
- v = @input.read(*args)
513
+ ## * +read+ behaves like <tt>IO#read</tt>. Its signature is <tt>read([length, [buffer]])</tt>.
514
+ ## * If given, +length+ must be a non-negative Integer (>= 0) or +nil+, and +buffer+ must be a +String+ and may not be +nil+.
515
+ ## * If +length+ is given and not +nil+, then this method reads at most +length+ bytes from the input stream.
516
+ ## * If +length+ is not given or +nil+, then this method reads all data until EOF.
517
+ ## * When EOF is reached, this method returns +nil+ if +length+ is given and not +nil+, or +""+ if +length+ is not given or is +nil+.
518
+ ## * If +buffer+ is given, then the read data will be placed into +buffer+ instead of a newly created +String+.
519
+ def read(*args)
520
+ unless args.size <= 2
521
+ raise LintError, "rack.input#read called with too many arguments"
522
+ end
523
+ if args.size >= 1
524
+ unless args.first.kind_of?(Integer) || args.first.nil?
525
+ raise LintError, "rack.input#read called with non-integer and non-nil length"
526
+ end
527
+ unless args.first.nil? || args.first >= 0
528
+ raise LintError, "rack.input#read called with a negative length"
529
+ end
530
+ end
531
+ if args.size >= 2
532
+ unless args[1].kind_of?(String)
533
+ raise LintError, "rack.input#read called with non-String buffer"
534
+ end
535
+ end
536
+
537
+ chunk = @input.read(*args)
437
538
 
438
- unless v.nil? or v.kind_of? String
439
- raise LintError, "rack.input#read didn't return nil or a String"
539
+ unless chunk.nil? or chunk.kind_of? String
540
+ raise LintError, "rack.input#read didn't return nil or a String"
541
+ end
542
+ if args[0].nil?
543
+ unless !chunk.nil?
544
+ raise LintError, "rack.input#read(nil) returned nil on EOF"
545
+ end
546
+ end
547
+
548
+ chunk
440
549
  end
441
- if args[0].nil?
442
- unless !v.nil?
443
- raise LintError, "rack.input#read(nil) returned nil on EOF"
550
+
551
+ ## * +each+ must be called without arguments and only yield +String+ values.
552
+ def each(*args)
553
+ raise LintError, "rack.input#each called with arguments" unless args.size == 0
554
+ @input.each do |line|
555
+ unless line.kind_of? String
556
+ raise LintError, "rack.input#each didn't yield a String"
557
+ end
558
+ yield line
444
559
  end
445
560
  end
446
561
 
447
- v
562
+ ## * +close+ can be called on the input stream to indicate that any remaining input is not needed.
563
+ def close(*args)
564
+ @input.close(*args)
565
+ end
448
566
  end
449
567
 
450
- ## * +each+ must be called without arguments and only yield Strings.
451
- def each(*args)
452
- raise LintError, "rack.input#each called with arguments" unless args.size == 0
453
- @input.each { |line|
454
- unless line.kind_of? String
455
- raise LintError, "rack.input#each didn't yield a String"
568
+ ##
569
+ ## === The Error Stream
570
+ ##
571
+ def check_error_stream(error)
572
+ ## The error stream must respond to +puts+, +write+ and +flush+:
573
+ [:puts, :write, :flush].each do |method|
574
+ unless error.respond_to? method
575
+ raise LintError, "rack.error #{error} does not respond to ##{method}"
456
576
  end
457
- yield line
458
- }
577
+ end
459
578
  end
460
579
 
461
- ## * +rewind+ must be called without arguments. It rewinds the input
462
- ## stream back to the beginning. It must not raise Errno::ESPIPE:
463
- ## that is, it may not be a pipe or a socket. Therefore, handler
464
- ## developers must buffer the input data into some rewindable object
465
- ## if the underlying input stream is not rewindable.
466
- def rewind(*args)
467
- raise LintError, "rack.input#rewind called with arguments" unless args.size == 0
468
- begin
469
- @input.rewind
470
- true
471
- rescue Errno::ESPIPE
472
- raise LintError, "rack.input#rewind raised Errno::ESPIPE"
580
+ class ErrorWrapper
581
+ def initialize(error)
582
+ @error = error
473
583
  end
474
- end
475
584
 
476
- ## * +close+ must never be called on the input stream.
477
- def close(*args)
478
- raise LintError, "rack.input#close must not be called"
479
- end
480
- end
585
+ ## * +puts+ must be called with a single argument that responds to +to_s+.
586
+ def puts(str)
587
+ @error.puts str
588
+ end
481
589
 
482
- ## === The Error Stream
483
- def check_error(error)
484
- ## The error stream must respond to +puts+, +write+ and +flush+.
485
- [:puts, :write, :flush].each { |method|
486
- unless error.respond_to? method
487
- raise LintError, "rack.error #{error} does not respond to ##{method}"
590
+ ## * +write+ must be called with a single argument that is a +String+.
591
+ def write(str)
592
+ raise LintError, "rack.errors#write not called with a String" unless str.kind_of? String
593
+ @error.write str
488
594
  end
489
- }
490
- end
491
595
 
492
- class ErrorWrapper
493
- include Assertion
596
+ ## * +flush+ must be called without arguments and must be called in order to make the error appear for sure.
597
+ def flush
598
+ @error.flush
599
+ end
494
600
 
495
- def initialize(error)
496
- @error = error
601
+ ## * +close+ must never be called on the error stream.
602
+ def close(*args)
603
+ raise LintError, "rack.errors#close must not be called"
604
+ end
497
605
  end
498
606
 
499
- ## * +puts+ must be called with a single argument that responds to +to_s+.
500
- def puts(str)
501
- @error.puts str
607
+ ##
608
+ ## === Hijacking
609
+ ##
610
+ ## The hijacking interfaces provides a means for an application to take control of the HTTP connection. There are two distinct hijack interfaces: full hijacking where the application takes over the raw connection, and partial hijacking where the application takes over just the response body stream. In both cases, the application is responsible for closing the hijacked stream.
611
+ ##
612
+ ## Full hijacking only works with HTTP/1. Partial hijacking is functionally equivalent to streaming bodies, and is still optionally supported for backwards compatibility with older Rack versions.
613
+ ##
614
+ ## ==== Full Hijack
615
+ ##
616
+ ## Full hijack is used to completely take over an HTTP/1 connection. It occurs before any headers are written and causes the server to ignore any response generated by the application. It is intended to be used when applications need access to the raw HTTP/1 connection.
617
+ ##
618
+ def check_hijack(env)
619
+ ## If <tt>rack.hijack</tt> is present in +env+, it must respond to +call+ \
620
+ if original_hijack = env[RACK_HIJACK]
621
+ raise LintError, "rack.hijack must respond to call" unless original_hijack.respond_to?(:call)
622
+
623
+ env[RACK_HIJACK] = proc do
624
+ io = original_hijack.call
625
+
626
+ ## and return an +IO+ object which can be used to read and write to the underlying connection using HTTP/1 semantics and formatting.
627
+ raise LintError, "rack.hijack must return an IO instance" unless io.is_a?(IO)
628
+
629
+ io
630
+ end
631
+ end
502
632
  end
503
633
 
504
- ## * +write+ must be called with a single argument that is a String.
505
- def write(str)
506
- raise LintError, "rack.errors#write not called with a String" unless str.kind_of? String
507
- @error.write str
634
+ ##
635
+ ## ==== Partial Hijack
636
+ ##
637
+ ## Partial hijack is used for bi-directional streaming of the request and response body. It occurs after the status and headers are written by the server and causes the server to ignore the Body of the response. It is intended to be used when applications need bi-directional streaming.
638
+ ##
639
+ def check_hijack_response(headers, env)
640
+ ## If <tt>rack.hijack?</tt> is present in +env+ and truthy, \
641
+ if env[RACK_IS_HIJACK]
642
+ ## an application may set the special response header <tt>rack.hijack</tt> \
643
+ if original_hijack = headers[RACK_HIJACK]
644
+ ## to an object that responds to +call+, \
645
+ unless original_hijack.respond_to?(:call)
646
+ raise LintError, 'rack.hijack header must respond to #call'
647
+ end
648
+ ## accepting a +stream+ argument.
649
+ return proc do |io|
650
+ original_hijack.call StreamWrapper.new(io)
651
+ end
652
+ end
653
+ ##
654
+ ## After the response status and headers have been sent, this hijack callback will be called with a +stream+ argument which follows the same interface as outlined in "Streaming Body". Servers must ignore the +body+ part of the response tuple when the <tt>rack.hijack</tt> response header is present. Using an empty +Array+ is recommended.
655
+ else
656
+ ##
657
+ ## If <tt>rack.hijack?</tt> is not present and truthy, the special response header <tt>rack.hijack</tt> must not be present in the response headers.
658
+ if headers.key?(RACK_HIJACK)
659
+ raise LintError, 'rack.hijack header must not be present if server does not support hijacking'
660
+ end
661
+ end
662
+
663
+ nil
508
664
  end
509
665
 
510
- ## * +flush+ must be called without arguments and must be called
511
- ## in order to make the error appear for sure.
512
- def flush
513
- @error.flush
666
+ ##
667
+ ## === Early Hints
668
+ ##
669
+ ## The application or any middleware may call the <tt>rack.early_hints</tt> with an object which would be valid as the headers of a Rack response.
670
+ def check_early_hints(env)
671
+ if env[RACK_EARLY_HINTS]
672
+ ##
673
+ ## If <tt>rack.early_hints</tt> is present, it must respond to +call+.
674
+ unless env[RACK_EARLY_HINTS].respond_to?(:call)
675
+ raise LintError, "rack.early_hints must respond to call"
676
+ end
677
+
678
+ original_callback = env[RACK_EARLY_HINTS]
679
+ env[RACK_EARLY_HINTS] = lambda do |headers|
680
+ ## If <tt>rack.early_hints</tt> is called, it must be called with valid Rack response headers.
681
+ check_headers(headers)
682
+ original_callback.call(headers)
683
+ end
684
+ end
514
685
  end
515
686
 
516
- ## * +close+ must never be called on the error stream.
517
- def close(*args)
518
- raise LintError, "rack.errors#close must not be called"
687
+ ##
688
+ ## == The Response
689
+ ##
690
+ ## Outgoing HTTP responses are generated from the response tuple generated by the application. The response tuple is an +Array+ of three elements, which are: the HTTP status, the headers, and the response body. The Rack application is responsible for ensuring that the response tuple is well-formed and should follow the rules set out in this specification.
691
+ ##
692
+ ## === The Status
693
+ ##
694
+ def check_status(status)
695
+ ## This is an HTTP status. It must be an Integer greater than or equal to 100.
696
+ unless status.is_a?(Integer) && status >= 100
697
+ raise LintError, "Status must be an Integer >=100"
698
+ end
519
699
  end
520
- end
521
700
 
522
- class HijackWrapper
523
- include Assertion
524
- extend Forwardable
701
+ ##
702
+ ## === The Headers
703
+ ##
704
+ def check_headers(headers)
705
+ ## The headers must be an unfrozen +Hash+. \
706
+ unless headers.kind_of?(Hash)
707
+ raise LintError, "headers object should be a hash, but isn't (got #{headers.class} as headers)"
708
+ end
525
709
 
526
- REQUIRED_METHODS = [
527
- :read, :write, :read_nonblock, :write_nonblock, :flush, :close,
528
- :close_read, :close_write, :closed?
529
- ]
710
+ if headers.frozen?
711
+ raise LintError, "headers object should not be frozen, but is"
712
+ end
530
713
 
531
- def_delegators :@io, *REQUIRED_METHODS
714
+ headers.each do |key, value|
715
+ ## The header keys must be +String+ values. \
716
+ unless key.kind_of? String
717
+ raise LintError, "header key must be a string, was #{key.class}"
718
+ end
532
719
 
533
- def initialize(io)
534
- @io = io
535
- REQUIRED_METHODS.each do |meth|
536
- raise LintError, "rack.hijack_io must respond to #{meth}" unless io.respond_to? meth
537
- end
538
- end
539
- end
720
+ ## Special headers starting <tt>rack.</tt> are for communicating with the server, and must not be sent back to the client.
721
+ next if key.start_with?("rack.")
540
722
 
541
- ## === Hijacking
542
- #
543
- # AUTHORS: n.b. The trailing whitespace between paragraphs is important and
544
- # should not be removed. The whitespace creates paragraphs in the RDoc
545
- # output.
546
- #
547
- ## ==== Request (before status)
548
- def check_hijack(env)
549
- if env[RACK_IS_HIJACK]
550
- ## If rack.hijack? is true then rack.hijack must respond to #call.
551
- original_hijack = env[RACK_HIJACK]
552
- raise LintError, "rack.hijack must respond to call" unless original_hijack.respond_to?(:call)
553
- env[RACK_HIJACK] = proc do
554
- ## rack.hijack must return the io that will also be assigned (or is
555
- ## already present, in rack.hijack_io.
556
- io = original_hijack.call
557
- HijackWrapper.new(io)
558
- ##
559
- ## rack.hijack_io must respond to:
560
- ## <tt>read, write, read_nonblock, write_nonblock, flush, close,
561
- ## close_read, close_write, closed?</tt>
562
- ##
563
- ## The semantics of these IO methods must be a best effort match to
564
- ## those of a normal ruby IO or Socket object, using standard
565
- ## arguments and raising standard exceptions. Servers are encouraged
566
- ## to simply pass on real IO objects, although it is recognized that
567
- ## this approach is not directly compatible with SPDY and HTTP 2.0.
568
- ##
569
- ## IO provided in rack.hijack_io should preference the
570
- ## IO::WaitReadable and IO::WaitWritable APIs wherever supported.
571
723
  ##
572
- ## There is a deliberate lack of full specification around
573
- ## rack.hijack_io, as semantics will change from server to server.
574
- ## Users are encouraged to utilize this API with a knowledge of their
575
- ## server choice, and servers may extend the functionality of
576
- ## hijack_io to provide additional features to users. The purpose of
577
- ## rack.hijack is for Rack to "get out of the way", as such, Rack only
578
- ## provides the minimum of specification and support.
579
- env[RACK_HIJACK_IO] = HijackWrapper.new(env[RACK_HIJACK_IO])
580
- io
581
- end
582
- else
583
- ##
584
- ## If rack.hijack? is false, then rack.hijack should not be set.
585
- raise LintError, "rack.hijack? is false, but rack.hijack is present" unless env[RACK_HIJACK].nil?
586
- ##
587
- ## If rack.hijack? is false, then rack.hijack_io should not be set.
588
- raise LintError, "rack.hijack? is false, but rack.hijack_io is present" unless env[RACK_HIJACK_IO].nil?
724
+ ## * The headers must not contain a <tt>"status"</tt> key.
725
+ raise LintError, "headers must not contain status" if key == "status"
726
+ ## * Header keys must conform to {RFC7230}[https://tools.ietf.org/html/rfc7230] token specification, i.e. cannot contain non-printable ASCII, <tt>DQUOTE</tt> or <tt>(),/:;<=>?@[\]{}</tt>.
727
+ raise LintError, "invalid header name: #{key}" if key =~ /[\(\),\/:;<=>\?@\[\\\]{}[:cntrl:]]/
728
+ ## * Header keys must not contain uppercase ASCII characters (A-Z).
729
+ raise LintError, "uppercase character in header name: #{key}" if key =~ /[A-Z]/
730
+
731
+ ## * Header values must be either a +String+, \
732
+ if value.kind_of?(String)
733
+ check_header_value(key, value)
734
+ elsif value.kind_of?(Array)
735
+ ## or an +Array+ of +String+ values, \
736
+ value.each{|value| check_header_value(key, value)}
737
+ else
738
+ raise LintError, "a header value must be a String or Array of Strings, but the value of '#{key}' is a #{value.class}"
739
+ end
740
+ end
589
741
  end
590
- end
591
742
 
592
- ## ==== Response (after headers)
593
- ## It is also possible to hijack a response after the status and headers
594
- ## have been sent.
595
- def check_hijack_response(headers, env)
743
+ def check_header_value(key, value)
744
+ ## such that each +String+ must not contain <tt>NUL</tt> (<tt>\0</tt>), <tt>CR</tt> (<tt>\r</tt>), or <tt>LF</tt> (<tt>\n</tt>).
745
+ if value.match?(/[\x00\x0A\x0D]/)
746
+ raise LintError, "invalid header value #{key}: #{value.inspect}"
747
+ end
748
+ end
596
749
 
597
- # this check uses headers like a hash, but the spec only requires
598
- # headers respond to #each
599
- headers = Rack::Utils::HeaderHash[headers]
750
+ ##
751
+ ## ==== The <tt>content-type</tt> Header
752
+ ##
753
+ def check_content_type_header(status, headers)
754
+ headers.each do |key, value|
755
+ ## There must not be a <tt>content-type</tt> header key when the status is <tt>1xx</tt>, <tt>204</tt>, or <tt>304</tt>.
756
+ if key == "content-type"
757
+ if Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.key? status.to_i
758
+ raise LintError, "content-type header found in #{status} response, not allowed"
759
+ end
760
+ return
761
+ end
762
+ end
763
+ end
600
764
 
601
- ## In order to do this, an application may set the special header
602
- ## <tt>rack.hijack</tt> to an object that responds to <tt>call</tt>
603
- ## accepting an argument that conforms to the <tt>rack.hijack_io</tt>
604
- ## protocol.
605
765
  ##
606
- ## After the headers have been sent, and this hijack callback has been
607
- ## called, the application is now responsible for the remaining lifecycle
608
- ## of the IO. The application is also responsible for maintaining HTTP
609
- ## semantics. Of specific note, in almost all cases in the current SPEC,
610
- ## applications will have wanted to specify the header Connection:close in
611
- ## HTTP/1.1, and not Connection:keep-alive, as there is no protocol for
612
- ## returning hijacked sockets to the web server. For that purpose, use the
613
- ## body streaming API instead (progressively yielding strings via each).
766
+ ## ==== The <tt>content-length</tt> Header
614
767
  ##
615
- ## Servers must ignore the <tt>body</tt> part of the response tuple when
616
- ## the <tt>rack.hijack</tt> response API is in use.
768
+ def check_content_length_header(status, headers)
769
+ headers.each do |key, value|
770
+ if key == 'content-length'
771
+ ## There must not be a <tt>content-length</tt> header key when the status is <tt>1xx</tt>, <tt>204</tt>, or <tt>304</tt>.
772
+ if Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.key? status.to_i
773
+ raise LintError, "content-length header found in #{status} response, not allowed"
774
+ end
775
+ @content_length = value
776
+ end
777
+ end
778
+ end
617
779
 
618
- if env[RACK_IS_HIJACK] && headers[RACK_HIJACK]
619
- unless headers[RACK_HIJACK].respond_to? :call
620
- raise LintError, 'rack.hijack header must respond to #call'
780
+ def verify_content_length(size)
781
+ if @head_request
782
+ unless size == 0
783
+ raise LintError, "Response body was given for HEAD request, but should be empty"
784
+ end
785
+ elsif @content_length
786
+ unless @content_length == size.to_s
787
+ raise LintError, "content-length header was #{@content_length}, but should be #{size}"
788
+ end
621
789
  end
622
- original_hijack = headers[RACK_HIJACK]
623
- proc do |io|
624
- original_hijack.call HijackWrapper.new(io)
790
+ end
791
+
792
+ ##
793
+ ## ==== The <tt>rack.protocol</tt> Header
794
+ ##
795
+ def check_rack_protocol_header(status, headers)
796
+ ## If the <tt>rack.protocol</tt> header is present, it must be a +String+, and must be one of the values from the <tt>rack.protocol</tt> array from the environment.
797
+ protocol = headers['rack.protocol']
798
+
799
+ if protocol
800
+ request_protocols = @env['rack.protocol']
801
+
802
+ if request_protocols.nil?
803
+ raise LintError, "rack.protocol header is #{protocol.inspect}, but rack.protocol was not set in request!"
804
+ elsif !request_protocols.include?(protocol)
805
+ raise LintError, "rack.protocol header is #{protocol.inspect}, but should be one of #{request_protocols.inspect} from the request!"
806
+ end
625
807
  end
626
- else
808
+ end
809
+ ##
810
+ ## Setting this value informs the server that it should perform a connection upgrade. In HTTP/1, this is done using the +upgrade+ header. In HTTP/2+, this is done by accepting the request.
811
+ ##
812
+ ## === The Body
813
+ ##
814
+ ## The Body is typically an +Array+ of +String+ values, an enumerable that yields +String+ values, a +Proc+, or an +IO+-like object.
815
+ ##
816
+ ## The Body must respond to +each+ or +call+. It may optionally respond to +to_path+ or +to_ary+. A Body that responds to +each+ is considered to be an Enumerable Body. A Body that responds to +call+ is considered to be a Streaming Body.
817
+ ##
818
+ ## A Body that responds to both +each+ and +call+ must be treated as an Enumerable Body, not a Streaming Body. If it responds to +each+, you must call +each+ and not +call+. If the Body doesn't respond to +each+, then you can assume it responds to +call+.
819
+ ##
820
+ ## The Body must either be consumed or returned. The Body is consumed by optionally calling either +each+ or +call+. Then, if the Body responds to +close+, it must be called to release any resources associated with the generation of the body. In other words, +close+ must always be called at least once; typically after the web server has sent the response to the client, but also in cases where the Rack application makes internal/virtual requests and discards the response.
821
+ def close
627
822
  ##
628
- ## The special response header <tt>rack.hijack</tt> must only be set
629
- ## if the request env has <tt>rack.hijack?</tt> <tt>true</tt>.
630
- unless headers[RACK_HIJACK].nil?
631
- raise LintError, 'rack.hijack header must not be present if server does not support hijacking'
632
- end
823
+ ## After calling +close+, the Body is considered closed and should not be consumed again. \
824
+ @closed = true
633
825
 
634
- nil
635
- end
636
- end
637
- ## ==== Conventions
638
- ## * Middleware should not use hijack unless it is handling the whole
639
- ## response.
640
- ## * Middleware may wrap the IO object for the response pattern.
641
- ## * Middleware should not wrap the IO object for the request pattern. The
642
- ## request pattern is intended to provide the hijacker with "raw tcp".
643
-
644
- ## == The Response
645
-
646
- ## === The Status
647
- def check_status(status)
648
- ## This is an HTTP status. When parsed as integer (+to_i+), it must be
649
- ## greater than or equal to 100.
650
- unless status.to_i >= 100
651
- raise LintError, "Status must be >=100 seen as integer"
652
- end
653
- end
826
+ ## If the original Body is replaced by a new Body, the new Body must also consume the original Body by calling +close+ if possible.
827
+ @body.close if @body.respond_to?(:close)
654
828
 
655
- ## === The Headers
656
- def check_headers(header)
657
- ## The header must respond to +each+, and yield values of key and value.
658
- unless header.respond_to? :each
659
- raise LintError, "headers object should respond to #each, but doesn't (got #{header.class} as headers)"
829
+ index = @lint.index(self)
830
+ unless @env['rack.lint'][0..index].all? {|lint| lint.instance_variable_get(:@closed)}
831
+ raise LintError, "Body has not been closed"
832
+ end
660
833
  end
661
834
 
662
- header.each { |key, value|
663
- ## The header keys must be Strings.
664
- unless key.kind_of? String
665
- raise LintError, "header key must be a string, was #{key.class}"
835
+ def verify_to_path
836
+ ##
837
+ ## If the Body responds to +to_path+, it must return either +nil+ or a +String+. If a +String+ is returned, it must be a path for the local file system whose contents are identical to that produced by calling +each+; this may be used by the server as an alternative, possibly more efficient way to transport the response. The +to_path+ method does not consume the body.
838
+ if @body.respond_to?(:to_path)
839
+ optional_path = @body.to_path
840
+
841
+ if optional_path != nil
842
+ unless optional_path.is_a?(String) && ::File.exist?(optional_path)
843
+ raise LintError, "body.to_path must be nil or a path to an existing file"
844
+ end
845
+ end
666
846
  end
847
+ end
667
848
 
668
- ## Special headers starting "rack." are for communicating with the
669
- ## server, and must not be sent back to the client.
670
- next if key =~ /^rack\..+$/
849
+ ##
850
+ ## ==== Enumerable Body
851
+ ##
852
+ def each
853
+ ## The Enumerable Body must respond to +each+, \
854
+ raise LintError, "Enumerable Body must respond to each" unless @body.respond_to?(:each)
671
855
 
672
- ## The header must not contain a +Status+ key.
673
- raise LintError, "header must not contain Status" if key.downcase == "status"
674
- ## The header must conform to RFC7230 token specification, i.e. cannot
675
- ## contain non-printable ASCII, DQUOTE or "(),/:;<=>?@[\]{}".
676
- raise LintError, "invalid header name: #{key}" if key =~ /[\(\),\/:;<=>\?@\[\\\]{}[:cntrl:]]/
856
+ ## which must only be called once, \
857
+ raise LintError, "Response body must only be called once (#{@consumed})" unless @consumed.nil?
677
858
 
678
- ## The values of the header must be Strings,
679
- unless value.kind_of? String
680
- raise LintError, "a header value must be a String, but the value of '#{key}' is a #{value.class}"
681
- end
682
- ## consisting of lines (for multiple header values, e.g. multiple
683
- ## <tt>Set-Cookie</tt> values) separated by "\\n".
684
- value.split("\n").each { |item|
685
- ## The lines must not contain characters below 037.
686
- if item =~ /[\000-\037]/
687
- raise LintError, "invalid header value #{key}: #{item.inspect}"
688
- end
689
- }
690
- }
691
- end
859
+ ## must not be called after being closed, \
860
+ raise LintError, "Response body is already closed" if @closed
692
861
 
693
- ## === The Content-Type
694
- def check_content_type(status, headers)
695
- headers.each { |key, value|
696
- ## There must not be a <tt>Content-Type</tt>, when the +Status+ is 1xx,
697
- ## 204 or 304.
698
- if key.downcase == "content-type"
699
- if Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.key? status.to_i
700
- raise LintError, "Content-Type header found in #{status} response, not allowed"
862
+ @consumed = :each
863
+
864
+ @body.each do |chunk|
865
+ ## and must only yield +String+ values.
866
+ unless chunk.kind_of? String
867
+ raise LintError, "Body yielded non-string value #{chunk.inspect}"
701
868
  end
702
- return
703
- end
704
- }
705
- end
706
869
 
707
- ## === The Content-Length
708
- def check_content_length(status, headers)
709
- headers.each { |key, value|
710
- if key.downcase == 'content-length'
711
- ## There must not be a <tt>Content-Length</tt> header when the
712
- ## +Status+ is 1xx, 204 or 304.
713
- if Rack::Utils::STATUS_WITH_NO_ENTITY_BODY.key? status.to_i
714
- raise LintError, "Content-Length header found in #{status} response, not allowed"
870
+ ##
871
+ ## Middleware must not call +each+ directly on the Body. Instead, middleware can return a new Body that calls +each+ on the original Body, yielding at least once per iteration.
872
+ if @lint[0] == self
873
+ @env['rack.lint.body_iteration'] += 1
874
+ else
875
+ if (@env['rack.lint.body_iteration'] -= 1) > 0
876
+ raise LintError, "New body must yield at least once per iteration of old body"
877
+ end
715
878
  end
716
- @content_length = value
717
- end
718
- }
719
- end
720
879
 
721
- def verify_content_length(bytes)
722
- if @head_request
723
- unless bytes == 0
724
- raise LintError, "Response body was given for HEAD request, but should be empty"
725
- end
726
- elsif @content_length
727
- unless @content_length == bytes.to_s
728
- raise LintError, "Content-Length header was #{@content_length}, but should be #{bytes}"
880
+ @size += chunk.bytesize
881
+ yield chunk
729
882
  end
883
+
884
+ verify_content_length(@size)
885
+
886
+ verify_to_path
730
887
  end
731
- end
732
888
 
733
- ## === The Body
734
- def each
735
- @closed = false
736
- bytes = 0
889
+ BODY_METHODS = {to_ary: true, each: true, call: true, to_path: true}
737
890
 
738
- ## The Body must respond to +each+
739
- unless @body.respond_to?(:each)
740
- raise LintError, "Response body must respond to each"
891
+ def to_path
892
+ @body.to_path
741
893
  end
742
894
 
743
- @body.each { |part|
744
- ## and must only yield String values.
745
- unless part.kind_of? String
746
- raise LintError, "Body yielded non-string value #{part.inspect}"
895
+ def respond_to?(name, *)
896
+ if BODY_METHODS.key?(name)
897
+ @body.respond_to?(name)
898
+ else
899
+ super
900
+ end
901
+ end
902
+
903
+ ##
904
+ ## If the Body responds to +to_ary+, it must return an +Array+ whose contents are identical to that produced by calling +each+. Middleware may call +to_ary+ directly on the Body and return a new Body in its place. In other words, middleware can only process the Body directly if it responds to +to_ary+. If the Body responds to both +to_ary+ and +close+, its implementation of +to_ary+ must call +close+.
905
+ def to_ary
906
+ @body.to_ary.tap do |content|
907
+ unless content == @body.enum_for.to_a
908
+ raise LintError, "#to_ary not identical to contents produced by calling #each"
909
+ end
747
910
  end
748
- bytes += part.bytesize
749
- yield part
750
- }
751
- verify_content_length(bytes)
911
+ ensure
912
+ close
913
+ end
752
914
 
753
915
  ##
754
- ## The Body itself should not be an instance of String, as this will
755
- ## break in Ruby 1.9.
916
+ ## ==== Streaming Body
756
917
  ##
757
- ## If the Body responds to +close+, it will be called after iteration. If
758
- ## the body is replaced by a middleware after action, the original body
759
- ## must be closed first, if it responds to close.
760
- # XXX howto: raise LintError, "Body has not been closed" unless @closed
918
+ def call(stream)
919
+ ## The Streaming Body must respond to +call+, \
920
+ raise LintError, "Streaming Body must respond to call" unless @body.respond_to?(:call)
761
921
 
922
+ ## which must only be called once, \
923
+ raise LintError, "Response body must only be called once (#{@consumed})" unless @consumed.nil?
762
924
 
763
- ##
764
- ## If the Body responds to +to_path+, it must return a String
765
- ## identifying the location of a file whose contents are identical
766
- ## to that produced by calling +each+; this may be used by the
767
- ## server as an alternative, possibly more efficient way to
768
- ## transport the response.
925
+ ## must not be called after being closed, \
926
+ raise LintError, "Response body is already closed" if @closed
769
927
 
770
- if @body.respond_to?(:to_path)
771
- unless ::File.exist? @body.to_path
772
- raise LintError, "The file identified by body.to_path does not exist"
773
- end
928
+ @consumed = :call
929
+
930
+ ## and accept a +stream+ argument.
931
+ ##
932
+ ## The +stream+ argument must respond to: +read+, +write+, <tt><<</tt>, +flush+, +close+, +close_read+, +close_write+, and +closed?+. \
933
+ @body.call(StreamWrapper.new(stream))
774
934
  end
775
935
 
776
- ##
777
- ## The Body commonly is an Array of Strings, the application
778
- ## instance itself, or a File-like object.
779
- end
936
+ class StreamWrapper
937
+ extend Forwardable
780
938
 
781
- def close
782
- @closed = true
783
- @body.close if @body.respond_to?(:close)
784
- end
939
+ ## The semantics of these +IO+ methods must be a best effort match to those of a normal Ruby +IO+ or +Socket+ object, using standard arguments and raising standard exceptions. Servers may simply pass on real +IO+ objects to the Streaming Body. In some cases (e.g. when using <tt>transfer-encoding</tt> or HTTP/2+), the server may need to provide a wrapper that implements the required methods, in order to provide the correct semantics.
940
+ REQUIRED_METHODS = [
941
+ :read, :write, :<<, :flush, :close,
942
+ :close_read, :close_write, :closed?
943
+ ]
944
+
945
+ def_delegators :@stream, *REQUIRED_METHODS
785
946
 
786
- # :startdoc:
947
+ def initialize(stream)
948
+ @stream = stream
787
949
 
950
+ REQUIRED_METHODS.each do |method_name|
951
+ raise LintError, "Stream must respond to #{method_name}" unless stream.respond_to?(method_name)
952
+ end
953
+ end
954
+ end
955
+ end
788
956
  end
789
957
  end
790
958
 
959
+ ##
791
960
  ## == Thanks
792
- ## Some parts of this specification are adopted from PEP333: Python
793
- ## Web Server Gateway Interface
794
- ## v1.0 (http://www.python.org/dev/peps/pep-0333/). I'd like to thank
795
- ## everyone involved in that effort.
961
+ ##
962
+ ## We'd like to thank everyone who has contributed to the Rack project over the years. Your work has made this specification possible. That includes everyone who has contributed code, documentation, bug reports, and feedback. We'd also like to thank the authors of the various web servers, frameworks, and libraries that have implemented the Rack specification. Your work has helped to make the web a better place.
963
+ ##
964
+ ## Some parts of this specification are adapted from {PEP 333 – Python Web Server Gateway Interface v1.0}[https://peps.python.org/pep-0333/]. We'd like to thank everyone involved in that effort.