-
Notifications
You must be signed in to change notification settings - Fork 30
/
chunker.cl
463 lines (348 loc) · 14.5 KB
/
chunker.cl
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
;; -*- mode: common-lisp; package: net.aserve -*-
;;
;; chunker.cl
;;
;; See the file LICENSE for the full license governing this code.
;; Description:
;; aserve's main loop
;;- This code in this file obeys the Lisp Coding Standard found in
;;- http://www.franz.com/~jkf/coding_standards.html
;;-
(in-package :net.aserve)
(eval-when (compile) (declaim (optimize (speed 3))))
; stream that reads the input and chunks the data to the output
(def-stream-class chunking-stream (single-channel-simple-stream http-stream)
((trailers :initform nil :accessor chunking-stream-trailers)
(eof-sent :initform nil :accessor chunking-stream-eof-sent)))
;; Mention class in make-instance after class def to avoid bug24329.
(defun make-instance-chunking-stream+output-handle (output-handle)
(make-instance 'chunking-stream :output-handle output-handle))
(defmethod chunking-stream-trailers (stream)
;; so this will return nil for non chunkers
(declare (ignore stream))
nil)
(defvar *binary-crlf*
(make-array 2 :element-type '(unsigned-byte 8)
:initial-contents '(#.(char-code #\return)
#.(char-code #\linefeed))))
(defmethod device-open ((p chunking-stream) dummy options)
(declare (ignore dummy))
(let ((output-handle (getf options :output-handle)))
(setf (slot-value p 'excl::input-handle) nil)
(setf (slot-value p 'excl::output-handle) output-handle)
(install-single-channel-character-strategy
p (stream-external-format output-handle)
nil)
(add-stream-instance-flags p :output :simple)
(setf (slot-value p 'excl::buffer)
(or (getf options :buffer)
(make-array (* 4 1024) :element-type '(unsigned-byte 8))))
(setf (slot-value p 'excl::control-out) excl::*std-control-out-table*)
;; this is so that if a deflate stream is sending data to the chunker
;; the deflate stream will know to send a chunking eof when the deflate
;; stream is closed. It doesn't want to close the chunking stream since
;; due to the logic in publish.cl there may be further attempts to
;; force-output the chunking stream and close it.
(locally
(declare (special sys::*deflate-target-stream-close-hook*))
(setq sys::*deflate-target-stream-close-hook* 'send-chunking-eof))
t))
(defmethod print-object ((stream chunking-stream) s)
(print-unreadable-object (stream s :identity *print-escape* :type t)
(format s "ef ~s, to ~s "
(excl::ef-name (find-external-format (stream-external-format stream)))
(slot-value stream 'excl::output-handle))))
(defmethod device-write ((p chunking-stream) buffer start end blocking)
(declare (ignore blocking))
(setf (slot-value p 'excl::oc-state) nil)
(let ((buffer (or buffer (slot-value p 'excl::buffer)))
(output (slot-value p 'excl::output-handle)))
(setq end (or end (length buffer)))
(if* (> end start)
then ; write it out with chunking
; chunk header
(format output "~x" (- end start))
(write-sequence *binary-crlf* output)
(write-sequence buffer output :start start :end end)
(write-sequence *binary-crlf* output)
(force-output output)))
end)
(defmethod device-close ((p chunking-stream) abort)
;;
;; note: we don't close the inner stream
;;
(if* (not abort)
then (force-output p)
(send-chunking-eof p))
p)
(defmethod send-chunking-eof ((p chunking-stream))
(if* (not (chunking-stream-eof-sent p))
then (let ((inner-stream (slot-value p 'excl::output-handle)))
; chunking eof
(write-char #\0 inner-stream)
(write-sequence *binary-crlf* inner-stream)
(dolist (trailer (chunking-stream-trailers p))
(write-sequence (string (car trailer)) inner-stream)
(write-sequence ": " inner-stream)
(if* (cdr trailer) then (write-sequence (cdr trailer) inner-stream))
(write-sequence *binary-crlf* inner-stream))
(write-sequence *binary-crlf* inner-stream)
(force-output inner-stream)
(setf (chunking-stream-eof-sent p) t))))
(defmethod send-chunking-eof (p)
;; do nothing for other kinds of streams
p
)
(without-package-locks
(defmethod excl::inner-stream ((p chunking-stream))
(slot-value p 'excl::output-handle)))
(defmethod set-trailers (p trailers)
;; by default we can't set trailers
(declare (ignore p trailers))
;; do nothing
nil
)
(defmethod can-set-trailers-p (p)
(declare (ignore p))
nil
)
(defmethod set-trailers ((p deflate-stream) trailers)
(set-trailers (deflate-target-stream p) trailers))
(defmethod can-set-trailers-p ((p deflate-stream))
(can-set-trailers-p (deflate-target-stream p)))
(defmethod excl::socket-bytes-written ((stream deflate-stream) &optional set)
(excl::socket-bytes-written (deflate-target-stream stream) set))
(defmethod excl::socket-bytes-read ((stream deflate-stream) &optional set)
(excl::socket-bytes-read (deflate-target-stream stream) set))
(defmethod set-trailers ((p chunking-stream) trailers)
;; Set the values only for the trailers already declared in the "Trailer"
;; header by (with-http-response (.. :trailers ..) ..). Other trailers
;; are not allowed to be set.
;;
;; Returns t if all trailers were declared and could be set, nil if some
;; trailers were not declared earlier and were dropped.
;;
(let ((saved-trailers (chunking-stream-trailers p)))
(if* (consp trailers)
then (let ((all-success t))
(dolist (trailer trailers)
(let (success)
(if* (and (consp trailer)
(or (stringp (car trailer))
(symbolp (car trailer)))
(stringp (cdr trailer)))
then (let ((predeclared-header
(assoc (header-kwdize (car trailer)) saved-trailers
:test #'eq)))
(if* predeclared-header
then (setf (cdr predeclared-header) (cdr trailer))
(setf success t))))
(if* (not success)
then (setf all-success nil))))
all-success))))
(defmethod can-set-trailers-p ((p chunking-stream))
t)
(defmethod set-trailers ((bs broadcast-stream) trailers)
;; Relevant when (member :xmit-server-response-body *debug-current*)
;; as that combines the response stream and debug log stream in a B-S.
;;
;; Will try to set trailers on all the enclosed streams, returning
;; true if one of the enclosed streams was a chunking-stream on which
;; trailers could be set.
;;
;; Does not stop at first success, to be robust against a (user-provided)
;; broadcast-stream that encloses multiple chunking response streams.
(find-if-not #'null (mapcar (lambda (s) (set-trailers s trailers))
(broadcast-stream-streams bs))))
(defmethod can-set-trailers-p ((bs broadcast-stream))
;; Also relevant when (member :xmit-server-response-body *debug-current*).
;; Returns true if trailers can be set on at least one of BS's streams.
(some #'can-set-trailers-p (broadcast-stream-streams bs)))
(defmethod set-trailers ((req http-request) trailers)
(set-trailers (request-reply-stream req) trailers))
(defmethod can-set-trailers-p ((req http-request))
(can-set-trailers-p (request-reply-stream req)))
(defmethod excl::socket-bytes-written ((stream http-request) &optional set)
(excl::socket-bytes-written (request-reply-stream stream) set))
(defmethod excl::socket-bytes-read ((stream http-request) &optional set)
(excl::socket-bytes-read (request-reply-stream stream) set))
;;; un chunking
;;
;; (make-instance 'unchunker-stream :input-handle stream)
;;
;; creates a unchunker-stream which filters the input-handle stream
;; filters out the meta data about chunk sizes.
;; unchunker stream returns eof when the end of the chunked data
;; is reached however the inner stream is not closed.
;;
(def-stream-class unchunking-stream (single-channel-simple-stream http-stream)
((state :initform :need-count
:accessor unchunking-state)
(count :initform 0
:accessor unchunking-count)
(trailers :initform nil
:accessor unchunking-trailers)
))
;; Mention class in make-instance after class def to avoid bug24329.
(defun make-instance-unchunking-stream+input-handle (input-handle)
(make-instance 'unchunking-stream :input-handle input-handle))
(defmethod unchunking-trailers ((stream inflate-stream))
(unchunking-trailers (slot-value stream 'excl::input-handle)))
(defmethod unchunking-trailers (stream)
;; so this returns nil if stream isn't a chunker
(declare (ignore stream))
nil
)
(defmethod socket-bytes-written ((stream unchunking-stream) &optional set)
(excl::socket-bytes-written (excl::stream-input-handle stream) set))
(defmethod socket-bytes-read ((stream unchunking-stream) &optional set)
(excl::socket-bytes-read (excl::stream-input-handle stream) set))
(defmethod device-open ((p unchunking-stream) dummy options)
(declare (ignore dummy))
(let ((input-handle (getf options :input-handle)))
(setf (slot-value p 'excl::input-handle) input-handle)
(setf (slot-value p 'excl::output-handle) nil)
(install-single-channel-character-strategy
p (stream-external-format input-handle) nil)
(setf (stream-external-format p) (stream-external-format input-handle))
(add-stream-instance-flags p :input :simple)
(setf (slot-value p 'excl::buffer)
(or (getf options :buffer)
(make-array (* 4 1024) :element-type '(unsigned-byte 8))))
(setf (slot-value p 'excl::co-state) nil)
(setf (slot-value p 'excl::oc-state) nil)
t))
(defmethod print-object ((stream unchunking-stream) s)
(print-unreadable-object (stream s :identity *print-escape* :type t)
(format s "ef ~s, from ~s "
(excl::ef-name (find-external-format (stream-external-format stream)))
(slot-value stream 'excl::input-handle))))
(defmethod device-read ((p unchunking-stream) buffer start end blocking)
(declare (ignore blocking))
(setq buffer (or buffer (slot-value p 'excl::buffer)))
(setq end (or end (length buffer)))
(loop
(let ((state (unchunking-state p))
(ins (slot-value p 'excl::input-handle)))
(case state
(:eof
(return-from device-read -1))
(:need-count
(let ((count 0)
(seen nil))
; read and parse
(loop
(let ((ch (read-byte ins nil nil)))
(if* (null ch)
then (error "premature eof before chunking data"))
(if* (<= #.(char-int #\0) ch #.(char-int #\9))
then (setq count (+ (ash count 4) (- ch #.(char-int #\0)))
seen t)
elseif (<= #.(char-int #\a) ch #.(char-int #\f))
then (setq count (+ (ash count 4) 10 (- ch #.(char-int #\a)))
seen t)
elseif (<= #.(char-int #\A) ch #.(char-int #\F))
then (setq count (+ (ash count 4) (+ 10 (- ch #.(char-int #\A))))
seen t)
elseif seen
then (return) ; valid count
else ; non hex char
(error "bad chunking count"))))
; now skip to newline
(loop
(let ((ch (read-byte ins nil nil)))
(if* (null ch) then (error "premature eof before chunking data"))
(if* (eq ch #.(char-int #\newline))
then (return))))
(if* (zerop count)
then ; chunking eof, read trailers and trailing crlf
; read any trailers
(setf (unchunking-trailers p) (read-trailers ins))
; return signal of eof
(setf (unchunking-state p) :eof)
(return-from device-read -1)
else ; now ready to ready data
(setf (unchunking-state p) :read-data
(unchunking-count p) count)
)))
(:read-data
;; we'll read all we can from this chunk
(let ((count (unchunking-count p)))
(if* (zerop count)
then ; read crlf
(setf (unchunking-state p) :need-count)
else (do ((bytes-read 0)
(i start (+ i bytes-read))
(count count (- count bytes-read)))
((or (zerop count)
(>= i end))
(if* (zerop count)
then (loop (let ((ch (read-byte ins)))
(if* (eq ch #.(char-int #\newline))
then (return))))
(setf (unchunking-state p) :need-count))
(setf (unchunking-count p) count)
(return-from device-read (- i start)))
(let ((res (read-vector buffer ins :start i :end (min (+ i count) end))))
(if* (= res i)
then (return-from device-read -1))
(setf bytes-read (- res i)))))))))))
(defun read-trailers (ins)
;; read the trailers from the unchunking stream
(let ((trailers)
(header)
(value))
(loop
(let ((ch (read-byte ins nil nil)))
(if* (null ch) then (error "premature eof before chunking data"))
(if* (eq ch #.(char-int #\newline))
then ; see if we've seen a header value
(if* header
then (setq header (make-array (length header)
:element-type 'character
:initial-contents (nreverse header))
value (if* value
then (let ((value (nreverse value)))
; eliminate leading blanks
(loop
(if* (eq #\space (car value))
then (pop value)
else (return)))
(setq value
(make-array (length value)
:element-type 'character
:initial-contents
value)))
else (setq value "")))
(push (cons header value) trailers)
(setq header nil value nil)
else ; blank line, end of trailers
(return trailers))
elseif (eq ch #.(char-int #\return))
then nil ;ignore
else (if* (eq ch #.(char-int #\:))
then (if* value
then (push (code-char ch) value)
elseif header
then (push #\space value)
else ; colon beginning a line.. bogus
; so create a header
(setq header (list #\x #\x #\x)
value (list #\space)))
elseif value
then (push (code-char ch) value)
else (push (code-char ch) header)))))))
(defmethod device-close ((p unchunking-stream) abort)
(declare (ignore abort))
p)
(without-package-locks
(defmethod excl::inner-stream ((p unchunking-stream))
(slot-value p 'excl::input-handle)))
(without-package-locks
(defmethod excl::record-stream-advance-to-eof ((p unchunking-stream))
;; if the stream is composed of records ending in a pseudo eof
;; then read up to an eof
(loop
;; advance to eof
(if* (null (read-byte p nil nil)) then (return)))
p))