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 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531
|
#lang racket/base
(require file/md5
racket/contract
racket/port
racket/list
racket/match
web-server/private/connection-manager
(submod web-server/private/connection-manager private)
web-server/http/request-structs
web-server/http/response-structs
web-server/private/util
syntax/parse/define
(for-syntax racket/base
racket/list
syntax/parse
syntax/parse/lib/function-header))
(provide
(contract-out
[print-headers
(output-port? (listof header?) . -> . any)]
[output-response
(connection? response? . -> . any)]
[output-response/method
(connection? response? bytes? . -> . any)]
[output-file
(connection? path-string? bytes? (or/c bytes? #f) (or/c pair? #f) . -> . any)]))
(define-simple-macro (define/ext (~and (name:id conn:id arg:formal ...) fun-header)
body:expr ...+)
(define fun-header
(with-handlers ([exn:fail?
(λ (e)
(kill-connection! conn)
(raise e))])
body ...
(flush-output (connection-o-port conn)))))
(define (output-response conn resp)
(output-response/method conn resp #"GET"))
(define/ext (output-response/method conn resp meth)
(cond
[(or
;; If it is terminated, just continue
(terminated-response? resp)
;; If it is HTTP/1.0, ditto
(connection-close? conn)
;; Or, if it is a HEAD request
(bytes-ci=? meth #"HEAD"))
(output-response-head conn resp)
(unless (bytes-ci=? meth #"HEAD")
(output-response-body conn resp))]
;; Otherwise, use chunked encoding
[else
(output-response-head conn resp #t)
(output-response-body/chunked conn resp)]))
;; Write the headers portion of a response to an output port.
;; NOTE: According to RFC 2145 the server should write HTTP/1.1
;; header for *all* clients.
(define-syntax (add-missing-headers stx)
(syntax-parse stx
[(_ hs:expr [name:bytes value:expr] ...+)
#'(let ([res hs])
(define to-add
(for/fold ([to-add (list name ...)])
([h (in-list hs)])
(remove (header-field h) to-add bytes-ci=?)))
(let ([value-e value])
(when (and value-e (member name to-add bytes-ci=?))
(set! res (cons (header name value-e) res)))) ...
res)]))
;; Compile-time fprintf specialized to byte strings.
(define-syntax (cprintf stx)
(define (parse-fmt bs)
(filter-not
(lambda (sub)
(equal? sub #""))
(add-between (regexp-split #rx#"~a" bs) 'arg)))
(syntax-parse stx
[(_ fmt:bytes arg-e:expr ...)
#'(cprintf (current-output-port) fmt arg-e ...)]
[(_ out-e:expr fmt:bytes arg-e:expr ...)
#:with out-id (datum->syntax #'out-e 'out)
#:with (write-e ...) (for/fold ([exprs null]
[args (syntax-e #'(arg-e ...))]
#:result (reverse exprs))
([chunk (in-list (parse-fmt (syntax->datum #'fmt)))])
(if (eq? chunk 'arg)
(values
(cons #`(display #,(car args) out-id) exprs)
(cdr args))
(values
(cons #`(write-bytes #,(datum->syntax #'fmt chunk) out-id) exprs)
args)))
#'(let ([out-id out-e])
write-e ...)]))
(define (output-response-head conn bresp [chunked? #f])
(cprintf
(connection-o-port conn)
#"HTTP/1.1 ~a ~a\r\n"
(response-code bresp)
(response-message bresp))
(define hs
(add-missing-headers
(response-headers bresp)
[#"Connection" (and (connection-close? conn) #"close")]
[#"Content-Type" (response-mime bresp)]
[#"Date" (seconds->gmt-bytes (current-seconds))]
[#"Last-Modified" (seconds->gmt-bytes (response-seconds bresp))]
[#"Server" #"Racket"]
[#"Transfer-Encoding" (and chunked? #"chunked")]))
(output-headers conn hs))
;; output-headers : connection (list-of header) -> void
(define (output-headers conn headers)
(print-headers (connection-o-port conn) headers))
;; print-headers : output-port (list-of header) -> void
(define (print-headers out hs)
(for ([h (in-list hs)])
(cprintf
out
#"~a: ~a\r\n"
(header-field h)
(header-value h)))
(write-bytes #"\r\n" out))
; RFC 2616 Section 4.4
(define (terminated-response? r)
(define hs (response-headers r))
(or (headers-assq* #"Content-Length" hs)
(cond
[(headers-assq* #"Transfer-Encoding" hs)
=> (λ (h) (not (bytes=? (header-value h) #"identity")))]
[else #f])))
(define (output-response-body conn bresp)
;; This function gets whatever time is left after the headers were
;; written to write its body to the client.
(define o-port (connection-o-port conn))
((response-output bresp) o-port)
(flush-output o-port))
(define (output-response-body/chunked conn bresp)
;; Flush the headers immediately since the response handler can wait
;; a while before writing anything out to the output port.
(flush-output (connection-o-port conn))
(define-values (from-servlet to-chunker) (make-pipe))
(define to-client (connection-o-port conn))
(define to-chunker-t
(thread
(λ ()
;; When errors occur, we immediately kill the connection to
;; make it clear to the client that something went wrong. By
;; doing this, we ensure that the terminating chunk won't be
;; sent and the client can't misinterpret the response as
;; successful. This is in line with how other web servers
;; behave.
;;
;; See: https://github.com/racket/web-server/pull/93
(with-handlers ([exn:fail?
(lambda (e)
(kill-connection! conn)
(close-output-port to-chunker)
(raise e))])
((response-output bresp) to-chunker)
(close-output-port to-chunker)))))
;; The client might go away while the response is being generated,
;; in which case the output port will be closed so we have to
;; gracefully back out when that happens.
(with-handlers ([exn:fail?
(lambda (_)
(kill-thread to-chunker-t))])
(define buffer (make-bytes 16384))
(let loop ()
(define bytes-read-or-eof
(read-bytes-avail! buffer from-servlet))
(unless (eof-object? bytes-read-or-eof)
;; For every chunk, increase the connection timeout s.t.
;; a responder can run indefinitely as long as it writes
;; *something* every (current-send-timeout) seconds.
(reset-connection-response-send-timeout! conn)
(cprintf to-client #"~a\r\n" (number->string bytes-read-or-eof 16))
(write-bytes buffer to-client 0 bytes-read-or-eof)
(write-bytes #"\r\n" to-client)
(flush-output to-client)
(loop)))
(thread-wait to-chunker-t)
(write-bytes #"0\r\n\r\n" to-client)
(flush-output to-client)))
; seconds->gmt-bytes : exact-integer -> bytes
; format is rfc1123 compliant according to rfc2068 (http/1.1)
(define (seconds->gmt-bytes s)
(define d (seconds->date s #f))
(define t (make-bytes 29 32)) ;; #\space = 32
(begin0 t
(write-week-day! t (date-week-day d))
(write-zero-padded! t 5 (date-day d))
(write-month! t (date-month d))
(write-number! t 15 (date-year d))
(write-zero-padded! t 17 (date-hour d))
(bytes-set! t 19 58) ;; #\:
(write-zero-padded! t 20 (date-minute d))
(bytes-set! t 22 58) ;; #\:
(write-zero-padded! t 23 (date-second d))
(bytes-copy! t 26 #"GMT")))
(module+ testing
(provide seconds->gmt-bytes))
(define-syntax-rule (write-zero-padded! dest dest-start e)
(let ([n e])
(cond
[(< n 10)
(bytes-set! dest dest-start 48) ;; #\0 = 48
(bytes-set! dest (add1 dest-start) (+ n 48))]
[else
(write-number! dest (add1 dest-start) n)])))
(define-syntax-rule (write-month! dest m)
(bytes-copy!
dest 8
(case m
[(1) #"Jan"]
[(2) #"Feb"]
[(3) #"Mar"]
[(4) #"Apr"]
[(5) #"May"]
[(6) #"Jun"]
[(7) #"Jul"]
[(8) #"Aug"]
[(9) #"Sep"]
[(10) #"Oct"]
[(11) #"Nov"]
[(12) #"Dev"])))
(define-syntax-rule (write-week-day! dest d)
(bytes-copy!
dest 0
(case d
[(0) #"Sun,"]
[(1) #"Mon,"]
[(2) #"Tue,"]
[(3) #"Wed,"]
[(4) #"Thu,"]
[(5) #"Fri,"]
[(6) #"Sat,"])))
(define-syntax-rule (write-number! dest dest-end num)
(let loop ([k dest-end] [n num])
(define d (remainder n 10))
(bytes-set! dest k (+ d 48)) ;; #\0
(when (>= n 10)
(loop (sub1 k) (quotient n 10)))))
;; output-file: connection
;; path
;; symbol
;; bytes
;; (U (listof (U byte-range-spec suffix-byte-range-spec)) #f)
;; -> void
;;
;; Ranges is #f if the client did not specify a Range header, or:
;;
;; (list-of (U byte-range-spec suffix-byte-range-spec))
;;
;; where:
;;
;; byte-range-spec : (cons integer (U integer #f))
;; suffix-byte-range-spec : (cons #f integer)
;;
;; as described in the comments in dispatchers/dispatch-files.
;;
;; A boundary is generated only if a multipart/byteranges response needs
;; to be generated (i.e. if a Ranges header was specified with more than
;; one range in it).
(define/ext (output-file conn file-path method maybe-mime-type ranges)
(output-file/boundary
conn
file-path
method
maybe-mime-type
ranges
(if (and ranges (> (length ranges) 1))
(md5 (string->bytes/utf-8 (number->string (current-inexact-milliseconds))))
#f)))
;; output-file/boundary: connection
;; path
;; symbol
;; bytes
;; (U (listof (U byte-range-spec suffix-byte-range-spec)) #f)
;; (U bytes #f)
;; -> void
(define (output-file/boundary conn file-path method maybe-mime-type ranges boundary)
;; Ensure there is enough time left to write the first chunk of
;; response data. `output-file-range' then resets the connection
;; timeout once for every chunk it's able to write to the client.
(reset-connection-response-send-timeout! conn)
; total-file-length : integer
(define total-file-length
(file-size file-path))
; modified-seconds : integer
(define modified-seconds
(file-or-directory-modify-seconds file-path))
; boundary-length : (U integer #f)
(define boundary-length
(if boundary
(bytes-length boundary)
#f))
; If convert-http-ranges fails, send a 416 bad range resposne:
(with-handlers ([exn:fail?
(lambda (exn)
(output-response-head
conn
(make-416-response modified-seconds maybe-mime-type)))])
(let* (; converted-ranges : (alist-of integer integer)
; This is a list of actual start and end offsets in the file.
; See the comments for convert-http-ranges for more information.
[converted-ranges
(if ranges
(convert-http-ranges ranges total-file-length)
(list (cons 0 total-file-length)))]
; multipart-headers : (list-of bytes)
; This is a list of header blocks to prepend to each range being sent.
; The idea is so we can calculate an overall content-length for the
; response. This *must be* the same length as converted-ranges.
[multipart-headers
(if (> (length converted-ranges) 1)
(prerender-multipart/byteranges-headers maybe-mime-type converted-ranges total-file-length)
(list #""))]
; total-content-length : integer
[total-content-length
(if (= (length converted-ranges) 1)
; One range: content-length is the length of the range being sent:
(- (cdar converted-ranges) (caar converted-ranges))
; Multiple ranges: content-length is the length of the multipart,
; including content, headers and boundaries:
(+ (for/sum ([range (in-list converted-ranges)]
[headers (in-list multipart-headers)])
(+ (bytes-length headers) ; length of the headers and header newline
(- (cdr range) (car range)) ; length of the content
2)) ; length of the content newline
; length of the intermediate boundaries
(* (+ boundary-length 4)
(length converted-ranges))
; length of the final boundary
(+ boundary-length 6)))])
; Send a 206 iff ranges were specified in the request:
(output-response-head
conn
(if ranges
(make-206-response modified-seconds maybe-mime-type total-content-length total-file-length converted-ranges boundary)
(make-200-response modified-seconds maybe-mime-type total-content-length)))
; Send the appropriate file content:
; TODO: What if we want to output-file during a POST?
(when (bytes-ci=? method #"GET")
(with-handlers ([exn:fail? (lambda (exn)
(network-error 'output-file "~a" (exn-message exn)))])
(call-with-input-file* file-path
(lambda (input)
(cond
; Single ranges (in 200 or 206 responses) are sent straight out
; in their simplest form:
[(= (length converted-ranges) 1)
(output-file-range conn input (caar converted-ranges) (cdar converted-ranges))]
; Multiple ranges are encoded as multipart/byteranges:
[else
(define out (connection-o-port conn))
(let loop ([ranges converted-ranges]
[multipart-headers multipart-headers])
(match ranges
[(list)
; Final boundary (must start on new line; ends with a new line)
(cprintf out #"--~a--\r\n" boundary)
(void)]
[(list-rest (list-rest start end) rest)
; Intermediate boundary (must start on new line; ends with a new line)
(cprintf out #"--~a\r\n" boundary)
; Headers and new line
(display (car multipart-headers) out)
; Content
(output-file-range conn input start end)
; Newline before next field
(write-bytes #"\r\n" out)
(loop rest (cdr multipart-headers))]))]))))))))
;; prerender-multipart/byteranges-headers : bytes (alist-of integer integer) integer -> (list-of bytes)
(define (prerender-multipart/byteranges-headers maybe-mime-type converted-ranges total-file-length)
(map (lambda (range)
(match range
[(list-rest start end)
(let ([out (open-output-bytes)])
(when maybe-mime-type
(print-headers out (list (make-header #"Content-Type" maybe-mime-type))))
(print-headers out (list (make-content-range-header start end total-file-length)))
(begin0 (get-output-bytes out)
(close-output-port out)))]))
converted-ranges))
;; output-file-range : connection file-input-port integer integer -> void
;;
;; start must be inclusive; end must be exclusive.
(define (output-file-range conn input start end)
(file-position input start)
(define custodian (make-custodian))
(parameterize ([current-custodian custodian])
(define limited-input (make-limited-input-port input (- end start) #f))
(thread
(lambda _
(let loop ()
;; Every time the limited-input is read from, reset
;; the connection timeout and give the client another
;; `response-send-timeout` seconds' worth of lease.
(sync (port-progress-evt limited-input))
(unless (port-closed? limited-input)
(reset-connection-response-send-timeout! conn)
(loop)))))
(copy-port limited-input (connection-o-port conn))
(close-input-port limited-input)))
;; convert-http-ranges : (alist-of (U integer #f) (U integer #f))
;; integer
;; -> (alist-of integer integer)
;;
;; Converts a list of HTTP ranges:
;;
;; into pairs of offsets we can use to read from a file:
;;
;; - suffix-byte-range-specs are converted to pairs of absolute offsets;
;; - missing end offsets in byte-range-specs ranges are filled in;
;; - end offsets are exclusive (as opposed to the inclusive offsets in ranges and the HTTP spec).
;;
;; The HTTP spec recommends that ranges are sent in the order they are specified in the request.
(define (convert-http-ranges ranges total-file-length)
(define converted
(filter-map (lambda (range)
; a : (U integer #f)
; b : (U integer #f)
; The original values quoted in the Range header:
(define-values (a b)
(values (car range)
(cdr range)))
; a* : integer
; b* : integer
; Convert inclusive end offsets and suffix ranges:
(define-values (a* b*)
(cond [(not a) (values (- total-file-length b) total-file-length)]
[(not b) (values a total-file-length)]
[else (values a (add1 b))]))
; a** : integer
; b** : integer
; Trim to the size of the file:
(define-values (a** b**)
(values (max 0 (min total-file-length a*))
(max 0 (min total-file-length b*))))
; Get rid of zero-length ranges (including ones that are outside the file length):
(if (< a** b**)
(cons a** b**)
#f))
ranges))
(if (null? converted)
(error 'convert-http-ranges "No satisfiable ranges in ~a/~a." ranges total-file-length)
converted))
;; make-206-response : integer bytes integer integer (alist-of integer integer) bytes -> basic-response
(define (make-206-response modified-seconds maybe-mime-type total-content-length total-file-length converted-ranges boundary)
(if (= (length converted-ranges) 1)
(let ([start (caar converted-ranges)]
[end (cdar converted-ranges)])
(response
206 #"Partial content"
modified-seconds
maybe-mime-type
(list (make-header #"Accept-Ranges" #"bytes")
(make-content-length-header total-content-length)
(make-content-range-header start end total-file-length))
void))
(response
206 #"Partial content"
modified-seconds
(bytes-append #"multipart/byteranges; boundary=" boundary)
(list (make-header #"Accept-Ranges" #"bytes")
(make-content-length-header total-content-length))
void)))
;; make-200-response : integer bytes integer -> basic-response
(define (make-200-response modified-seconds maybe-mime-type total-content-length)
(response
200 #"OK"
modified-seconds
maybe-mime-type
(list (make-header #"Accept-Ranges" #"bytes")
(make-content-length-header total-content-length))
void))
;; make-416-response : integer bytes -> basic-response
(define (make-416-response modified-seconds maybe-mime-type)
(response
416 #"Invalid range request"
modified-seconds
maybe-mime-type
null
void))
;; make-content-length-header : integer -> header
(define (make-content-length-header total-content-length)
(make-header #"Content-Length" (string->bytes/utf-8 (number->string total-content-length))))
;; make-content-range-header : integer integer integer -> header
;; start must be inclusive; end must be exclusive.
(define (make-content-range-header start end total-file-length)
(make-header #"Content-Range"
(string->bytes/utf-8
(format "bytes ~a-~a/~a" start (sub1 end) total-file-length))))
|