-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
/
request.cr
382 lines (308 loc) · 10.7 KB
/
request.cr
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
require "./common"
require "uri"
require "http/params"
# An HTTP request.
#
# It serves both to perform requests by an `HTTP::Client` and to
# represent requests received by an `HTTP::Server`.
#
# A request always holds an `IO` as a body.
# When creating a request with a `String` or `Bytes` its body
# will be a `IO::Memory` wrapping these, and the `Content-Length`
# header will be set appropriately.
class HTTP::Request
property method : String
property headers : Headers
getter body : IO?
property version : String
@cookies : Cookies?
@query_params : URI::Params?
@uri : URI?
{% unless flag?(:win32) %}
# The network address that sent the request to an HTTP server.
#
# `HTTP::Server` will try to fill this property, and its value
# will have a format like "IP:port", but this format is not guaranteed.
# Middlewares can overwrite this value.
#
# This property is not used by `HTTP::Client`.
property remote_address : Socket::Address?
# The network address of the HTTP server.
#
# `HTTP::Server` will try to fill this property, and its value
# will have a format like "IP:port", but this format is not guaranteed.
# Middlewares can overwrite this value.
#
# This property is not used by `HTTP::Client`.
property local_address : Socket::Address?
{% else %}
# TODO: Remove this once `Socket` is working on Windows
property remote_address : Nil
property local_address : Nil
{% end %}
def self.new(method : String, resource : String, headers : Headers? = nil, body : String | Bytes | IO | Nil = nil, version = "HTTP/1.1")
# Duplicate headers to prevent the request from modifying data that the user might hold.
new(method, resource, headers.try(&.dup), body, version, internal: nil)
end
private def initialize(@method : String, @resource : String, headers : Headers? = nil, body : String | Bytes | IO | Nil = nil, @version = "HTTP/1.1", *, internal)
@headers = headers || Headers.new
self.body = body
end
# Returns a convenience wrapper around querying and setting cookie related
# headers, see `HTTP::Cookies`.
def cookies
@cookies ||= Cookies.from_client_headers(headers)
end
# Returns a convenience wrapper around querying and setting query params,
# see `URI::Params`.
def query_params
@query_params ||= uri.query_params
end
def resource
update_uri
@uri.try(&.request_target) || @resource
end
def keep_alive?
HTTP.keep_alive?(self)
end
def ignore_body?
@method == "HEAD"
end
def content_length=(length : Int)
headers["Content-Length"] = length.to_s
end
def content_length
HTTP.content_length(headers)
end
def body=(body : String)
@body = IO::Memory.new(body)
self.content_length = body.bytesize
end
def body=(body : Bytes)
@body = IO::Memory.new(body)
self.content_length = body.size
end
def body=(@body : IO)
end
def body=(@body : Nil)
@headers["Content-Length"] = "0" if @method == "POST" || @method == "PUT"
end
def to_io(io)
io << @method << ' ' << resource << ' ' << @version << "\r\n"
cookies = @cookies
headers = cookies ? cookies.add_request_headers(@headers) : @headers
HTTP.serialize_headers_and_body(io, headers, nil, @body, @version)
end
# :nodoc:
record RequestLine, method : String, resource : String, http_version : String
# Returns a `HTTP::Request` instance if successfully parsed,
# `nil` on EOF or `HTTP::Status` otherwise.
def self.from_io(io, *, max_request_line_size : Int32 = HTTP::MAX_REQUEST_LINE_SIZE, max_headers_size : Int32 = HTTP::MAX_HEADERS_SIZE) : HTTP::Request | HTTP::Status | Nil
line = parse_request_line(io, max_request_line_size)
return line unless line.is_a?(RequestLine)
status = HTTP.parse_headers_and_body(io, max_headers_size: max_headers_size) do |headers, body|
# No need to dup headers since nobody else holds them
request = new line.method, line.resource, headers, body, line.http_version, internal: nil
if io.responds_to?(:remote_address)
request.remote_address = io.remote_address
end
if io.responds_to?(:local_address)
request.local_address = io.local_address
end
return request
end
# Malformed or unexpectedly ended http request
status || HTTP::Status::BAD_REQUEST
end
private METHODS = %w(GET HEAD POST PUT DELETE CONNECT OPTIONS PATCH TRACE)
private def self.parse_request_line(io : IO, max_request_line_size) : RequestLine | HTTP::Status | Nil
# Optimization: see if we have a peek buffer
# (avoids a string allocation for the entire request line)
if peek = io.peek
# peek.empty? means there's no more input (EOF), so no more requests
return nil if peek.empty?
# See if we can find \n
index = peek.index('\n'.ord.to_u8)
if index
return HTTP::Status::URI_TOO_LONG if index > max_request_line_size
end_index = index
# Also check (and discard) \r before that
if index > 0 && peek[index - 1] == '\r'.ord.to_u8
end_index -= 1
end
parts = parse_request_line(peek[0, end_index])
io.skip(index + 1) # Must skip until after \n
return parts
end
end
request_line = io.gets(max_request_line_size + 1, chomp: true)
return nil unless request_line
# Identify Request-URI too long
if request_line.bytesize > max_request_line_size
return HTTP::Status::URI_TOO_LONG
end
parse_request_line(request_line)
end
private def self.parse_request_line(line : String) : RequestLine | HTTP::Status
parse_request_line(line.to_slice)
end
private def self.parse_request_line(slice : Bytes) : RequestLine | HTTP::Status
space_index = slice.index(' '.ord.to_u8)
# Oops, only a single part (should be three)
return HTTP::Status::BAD_REQUEST unless space_index
subslice = slice[0...space_index]
# Optimization: see if it's one of the common methods
# (avoids a string allocation for these methods)
method = METHODS.find { |method| method.to_slice == subslice } ||
String.new(subslice)
# Skip spaces.
# The RFC just mentions a single space but most servers allow multiple.
while space_index < slice.size && slice[space_index] == ' '.ord.to_u8
space_index += 1
end
# Oops, we only found the "method" part followed by spaces
return HTTP::Status::BAD_REQUEST if space_index == slice.size
next_space_index = slice.index(' '.ord.to_u8, offset: space_index)
# Oops, we only found two parts (should be three)
return HTTP::Status::BAD_REQUEST unless next_space_index
resource = String.new(slice[space_index...next_space_index])
# Skip spaces again
space_index = next_space_index
while space_index < slice.size && slice[space_index] == ' '.ord.to_u8
space_index += 1
end
next_space_index = slice.index(' '.ord.to_u8, offset: space_index) || slice.size
subslice = slice[space_index...next_space_index]
# Optimization: avoid allocating a string for common HTTP version
http_version = HTTP::SUPPORTED_VERSIONS.find { |version| version.to_slice == subslice }
return HTTP::Status::BAD_REQUEST unless http_version
# Skip trailing spaces
space_index = next_space_index
while space_index < slice.size
# Oops, we find something else (more than three parts)
return HTTP::Status::BAD_REQUEST unless slice[space_index] == ' '.ord.to_u8
space_index += 1
end
RequestLine.new method: method, resource: resource, http_version: http_version
end
# Returns the request's path component.
def path
uri.path.presence || "/"
end
# Sets request's path component.
def path=(path)
uri.path = path
end
# Lazily parses and returns the request's query component.
def query
update_uri
uri.query
end
# Sets request's query component.
def query=(value)
uri.query = value
update_query_params
value
end
# Extracts the hostname from `Host` header.
#
# Returns `nil` if the `Host` header is missing.
#
# If the `Host` header contains a port number, it is stripped off.
def hostname : String?
header = @headers["Host"]?
return unless header
host, _, port = header.rpartition(":")
if host.empty?
# no colon in header
host = header
else
port = port.to_i?(whitespace: false)
# TODO: Remove temporal fix when Socket::IPAddress has been ported to
# win32
unless port && {% if flag?(:win32) %}port.in?(0..UInt16::MAX){% else %}Socket::IPAddress.valid_port?(port){% end %}
# what we identified as port is not valid, so use the entire header
host = header
end
end
URI.unwrap_ipv6(host)
end
# Returns request host with port from headers.
@[Deprecated(%q(Use `headers["Host"]?` instead.))]
def host_with_port
@headers["Host"]?
end
private def uri
(@uri ||= URI.parse(@resource)).not_nil!
end
private def update_query_params
return unless @query_params
@query_params = uri.query_params
end
private def update_uri
return unless @query_params
uri.query = query_params.to_s
end
def if_match : Array(String)?
parse_etags("If-Match")
end
def if_none_match : Array(String)?
parse_etags("If-None-Match")
end
private def parse_etags(header_name)
header = headers[header_name]?
return unless header
return ["*"] if header == "*"
etags = [] of String
reader = Char::Reader.new(header)
require_comma = false
while reader.has_next?
case char = reader.current_char
when ' ', '\t'
reader.next_char
when ','
reader.next_char
require_comma = false
when '"', 'W'
if require_comma
# return what we've got on error
return etags
end
reader, etag = consume_etag(reader)
if etag
etags << etag
require_comma = true
else
# return what we've got on error
return etags
end
else
# return what we've got on error
return etags
end
end
etags
end
private def consume_etag(reader)
start = reader.pos
if reader.current_char == 'W'
reader.next_char
return reader, nil if reader.current_char != '/' || !reader.has_next?
reader.next_char
end
return reader, nil if reader.current_char != '"'
reader.next_char
while reader.has_next?
case char = reader.current_char
when '!', '\u{23}'..'\u{7E}', '\u{80}'..'\u{FF}'
reader.next_char
when '"'
reader.next_char
return reader, reader.string.byte_slice(start, reader.pos - start)
else
return reader, nil
end
end
return reader, nil
end
end