2 +--------------------------------------------------------------------+
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2004-2011, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
13 #include "php_http_api.h"
15 typedef struct php_http_message_parser_state_spec
{
16 php_http_message_parser_state_t state
;
18 } php_http_message_parser_state_spec_t
;
20 static const php_http_message_parser_state_spec_t php_http_message_parser_states
[] = {
21 {PHP_HTTP_MESSAGE_PARSER_STATE_START
, 1},
22 {PHP_HTTP_MESSAGE_PARSER_STATE_HEADER
, 1},
23 {PHP_HTTP_MESSAGE_PARSER_STATE_HEADER_DONE
, 0},
24 {PHP_HTTP_MESSAGE_PARSER_STATE_BODY
, 0},
25 {PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DUMB
, 1},
26 {PHP_HTTP_MESSAGE_PARSER_STATE_BODY_LENGTH
, 1},
27 {PHP_HTTP_MESSAGE_PARSER_STATE_BODY_CHUNKED
, 1},
28 {PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DONE
, 0},
29 {PHP_HTTP_MESSAGE_PARSER_STATE_DONE
, 0}
32 PHP_HTTP_API php_http_message_parser_t
*php_http_message_parser_init(php_http_message_parser_t
*parser TSRMLS_DC
)
35 parser
= emalloc(sizeof(*parser
));
37 memset(parser
, 0, sizeof(*parser
));
39 TSRMLS_SET_CTX(parser
->ts
);
41 php_http_header_parser_init(&parser
->header TSRMLS_CC
);
42 zend_stack_init(&parser
->stack
);
47 PHP_HTTP_API php_http_message_parser_state_t
php_http_message_parser_state_push(php_http_message_parser_t
*parser
, unsigned argc
, ...)
49 php_http_message_parser_state_t state
;
53 va_start(va_args
, argc
);
54 for (i
= 0; i
< argc
; ++i
) {
55 state
= va_arg(va_args
, php_http_message_parser_state_t
);
56 zend_stack_push(&parser
->stack
, &state
, sizeof(state
));
63 PHP_HTTP_API php_http_message_parser_state_t
php_http_message_parser_state_is(php_http_message_parser_t
*parser
)
65 php_http_message_parser_state_t
*state
;
67 if (SUCCESS
== zend_stack_top(&parser
->stack
, (void *) &state
)) {
70 return PHP_HTTP_MESSAGE_PARSER_STATE_START
;
73 PHP_HTTP_API php_http_message_parser_state_t
php_http_message_parser_state_pop(php_http_message_parser_t
*parser
)
75 php_http_message_parser_state_t state
, *state_ptr
;
76 if (SUCCESS
== zend_stack_top(&parser
->stack
, (void *) &state_ptr
)) {
78 zend_stack_del_top(&parser
->stack
);
81 return PHP_HTTP_MESSAGE_PARSER_STATE_START
;
84 PHP_HTTP_API
void php_http_message_parser_dtor(php_http_message_parser_t
*parser
)
86 php_http_header_parser_dtor(&parser
->header
);
87 zend_stack_destroy(&parser
->stack
);
88 if (parser
->dechunk
) {
89 php_http_encoding_stream_free(&parser
->dechunk
);
91 if (parser
->inflate
) {
92 php_http_encoding_stream_free(&parser
->inflate
);
96 PHP_HTTP_API
void php_http_message_parser_free(php_http_message_parser_t
**parser
)
99 php_http_message_parser_dtor(*parser
);
105 PHP_HTTP_API php_http_message_parser_state_t
php_http_message_parser_parse_stream(php_http_message_parser_t
*parser
, php_stream
*s
, php_http_message_t
**message
)
107 php_http_buffer_t buf
;
108 TSRMLS_FETCH_FROM_CTX(parser
->ts
);
110 php_http_buffer_init_ex(&buf
, 0x1000, PHP_HTTP_BUFFER_INIT_PREALLOC
);
112 while (!php_stream_eof(s
)) {
115 switch (php_http_message_parser_state_is(parser
)) {
116 case PHP_HTTP_MESSAGE_PARSER_STATE_START
:
117 case PHP_HTTP_MESSAGE_PARSER_STATE_HEADER
:
118 case PHP_HTTP_MESSAGE_PARSER_STATE_HEADER_DONE
:
120 php_stream_get_line(s
, buf
.data
+ buf
.used
, buf
.free
, &len
);
121 php_http_buffer_account(&buf
, len
);
124 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DUMB
:
126 php_http_buffer_account(&buf
, php_stream_read(s
, buf
.data
+ buf
.used
, buf
.free
));
129 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_LENGTH
:
130 /* read body_length */
131 php_http_buffer_account(&buf
, php_stream_read(s
, buf
.data
+ buf
.used
, MIN(buf
.free
, parser
->body_length
)));
134 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_CHUNKED
:
135 /* duh, this is very naive */
137 size_t read
= php_stream_read(s
, buf
.data
+ buf
.used
, MIN(len
, buf
.free
));
139 php_http_buffer_account(&buf
, read
);
143 php_stream_get_line(s
, buf
.data
, buf
.free
, &len
);
144 php_http_buffer_account(&buf
, len
);
146 len
= strtoul(buf
.data
- len
, NULL
, 16);
150 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY
:
151 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DONE
:
152 /* should not occur */
156 case PHP_HTTP_MESSAGE_PARSER_STATE_DONE
:
157 case PHP_HTTP_MESSAGE_PARSER_STATE_FAILURE
:
158 php_http_buffer_dtor(&buf
);
159 return php_http_message_parser_state_is(parser
);
162 php_http_message_parser_parse(parser
, &buf
, 0, message
);
165 php_http_buffer_dtor(&buf
);
166 return PHP_HTTP_MESSAGE_PARSER_STATE_DONE
;
170 PHP_HTTP_API php_http_message_parser_state_t
php_http_message_parser_parse(php_http_message_parser_t
*parser
, php_http_buffer_t
*buffer
, unsigned flags
, php_http_message_t
**message
)
172 TSRMLS_FETCH_FROM_CTX(parser
->ts
);
177 while (buffer
->used
|| !php_http_message_parser_states
[php_http_message_parser_state_is(parser
)].need_data
) {
179 const char *state
[] = {"START", "HEADER", "HEADER_DONE", "BODY", "BODY_DUMB", "BODY_LENGTH", "BODY_CHUNK", "BODY_DONE", "DONE"};
180 fprintf(stderr
, "#MP: %s (%d)\n", php_http_message_parser_state_is(parser
) < 0 ? "FAILURE" : state
[php_http_message_parser_state_is(parser
)], message
&& *message
? (*message
)->type
: -1);
181 _dpf(0, buffer
->data
, buffer
->used
);
184 switch (php_http_message_parser_state_pop(parser
))
186 case PHP_HTTP_MESSAGE_PARSER_STATE_FAILURE
:
187 return php_http_message_parser_state_push(parser
, 1, PHP_HTTP_MESSAGE_PARSER_STATE_FAILURE
);
189 case PHP_HTTP_MESSAGE_PARSER_STATE_START
:
191 char *ptr
= buffer
->data
;
193 while (ptr
- buffer
->data
< buffer
->used
&& PHP_HTTP_IS_CTYPE(space
, *ptr
)) {
197 php_http_buffer_cut(buffer
, 0, ptr
- buffer
->data
);
200 php_http_message_parser_state_push(parser
, 1, PHP_HTTP_MESSAGE_PARSER_STATE_HEADER
);
205 case PHP_HTTP_MESSAGE_PARSER_STATE_HEADER
:
207 unsigned header_parser_flags
= (flags
& PHP_HTTP_MESSAGE_PARSER_CLEANUP
) ? PHP_HTTP_HEADER_PARSER_CLEANUP
: 0;
209 switch (php_http_header_parser_parse(&parser
->header
, buffer
, header_parser_flags
, *message
? &(*message
)->hdrs
: NULL
, (php_http_info_callback_t
) php_http_message_info_callback
, message
)) {
210 case PHP_HTTP_HEADER_PARSER_STATE_FAILURE
:
211 return PHP_HTTP_MESSAGE_PARSER_STATE_FAILURE
;
213 case PHP_HTTP_HEADER_PARSER_STATE_DONE
:
214 php_http_message_parser_state_push(parser
, 1, PHP_HTTP_MESSAGE_PARSER_STATE_HEADER_DONE
);
218 php_http_message_parser_state_push(parser
, 1, PHP_HTTP_MESSAGE_PARSER_STATE_HEADER
);
220 return PHP_HTTP_MESSAGE_PARSER_STATE_HEADER
;
226 case PHP_HTTP_MESSAGE_PARSER_STATE_HEADER_DONE
:
228 zval
*h
, *h_loc
= NULL
, *h_con
= NULL
, **h_cl
= NULL
, **h_cr
= NULL
, **h_te
= NULL
;
230 if ((h
= php_http_message_header(*message
, ZEND_STRL("Transfer-Encoding"), 1))) {
231 zend_hash_update(&(*message
)->hdrs
, "X-Original-Transfer-Encoding", sizeof("X-Original-Transfer-Encoding"), &h
, sizeof(zval
*), (void *) &h_te
);
232 zend_hash_del(&(*message
)->hdrs
, "Transfer-Encoding", sizeof("Transfer-Encoding"));
234 if ((h
= php_http_message_header(*message
, ZEND_STRL("Content-Length"), 1))) {
235 zend_hash_update(&(*message
)->hdrs
, "X-Original-Content-Length", sizeof("X-Original-Content-Length"), &h
, sizeof(zval
*), (void *) &h_cl
);
237 if ((h
= php_http_message_header(*message
, ZEND_STRL("Content-Range"), 1))) {
238 zend_hash_update(&(*message
)->hdrs
, "X-Original-Content-Range", sizeof("X-Original-Content-Range"), &h
, sizeof(zval
*), (void *) &h_cr
);
239 zend_hash_del(&(*message
)->hdrs
, "Content-Range", sizeof("Content-Range"));
245 zend_hash_update(&(*message
)->hdrs
, "Content-Length", sizeof("Content-Length"), &h
, sizeof(zval
*), NULL
);
247 /* so, if curl sees a 3xx code, a Location header and a Connection:close header
248 * it decides not to read the response body.
250 if ((flags
& PHP_HTTP_MESSAGE_PARSER_EMPTY_REDIRECTS
)
251 && (*message
)->type
== PHP_HTTP_RESPONSE
252 && (*message
)->http
.info
.response
.code
/100 == 3
253 && (h_loc
= php_http_message_header(*message
, ZEND_STRL("Location"), 1))
254 && (h_con
= php_http_message_header(*message
, ZEND_STRL("Connection"), 1))
256 if (php_http_match(Z_STRVAL_P(h_con
), "close", PHP_HTTP_MATCH_WORD
)) {
257 php_http_message_parser_state_push(parser
, 1, PHP_HTTP_MESSAGE_PARSER_STATE_DONE
);
258 zval_ptr_dtor(&h_loc
);
259 zval_ptr_dtor(&h_con
);
264 zval_ptr_dtor(&h_loc
);
267 zval_ptr_dtor(&h_con
);
270 if ((h
= php_http_message_header(*message
, ZEND_STRL("Content-Encoding"), 1))) {
271 if (php_http_match(Z_STRVAL_P(h
), "gzip", PHP_HTTP_MATCH_WORD
)
272 || php_http_match(Z_STRVAL_P(h
), "x-gzip", PHP_HTTP_MATCH_WORD
)
273 || php_http_match(Z_STRVAL_P(h
), "deflate", PHP_HTTP_MATCH_WORD
)
275 if (parser
->inflate
) {
276 php_http_encoding_stream_reset(&parser
->inflate
);
278 parser
->inflate
= php_http_encoding_stream_init(NULL
, php_http_encoding_stream_get_inflate_ops(), 0 TSRMLS_CC
);
280 zend_hash_update(&(*message
)->hdrs
, "X-Original-Content-Encoding", sizeof("X-Original-Content-Encoding"), &h
, sizeof(zval
*), NULL
);
281 zend_hash_del(&(*message
)->hdrs
, "Content-Encoding", sizeof("Content-Encoding"));
287 if ((flags
& PHP_HTTP_MESSAGE_PARSER_DUMB_BODIES
)) {
288 php_http_message_parser_state_push(parser
, 1, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DUMB
);
291 if (strstr(Z_STRVAL_PP(h_te
), "chunked")) {
292 parser
->dechunk
= php_http_encoding_stream_init(parser
->dechunk
, php_http_encoding_stream_get_dechunk_ops(), 0 TSRMLS_CC
);
293 php_http_message_parser_state_push(parser
, 1, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_CHUNKED
);
301 parser
->body_length
= strtoul(Z_STRVAL_PP(h_cl
), &stop
, 10);
303 if (stop
!= Z_STRVAL_PP(h_cl
)) {
304 php_http_message_parser_state_push(parser
, 1, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_LENGTH
);
310 ulong total
= 0, start
= 0, end
= 0;
312 if (!strncasecmp(Z_STRVAL_PP(h_cr
), "bytes", lenof("bytes"))
313 && ( Z_STRVAL_P(h
)[lenof("bytes")] == ':'
314 || Z_STRVAL_P(h
)[lenof("bytes")] == ' '
315 || Z_STRVAL_P(h
)[lenof("bytes")] == '='
318 char *total_at
= NULL
, *end_at
= NULL
;
319 char *start_at
= Z_STRVAL_PP(h_cr
) + sizeof("bytes");
321 start
= strtoul(start_at
, &end_at
, 10);
323 end
= strtoul(end_at
+ 1, &total_at
, 10);
324 if (total_at
&& strncmp(total_at
+ 1, "*", 1)) {
325 total
= strtoul(total_at
+ 1, NULL
, 10);
328 if (end
>= start
&& (!total
|| end
< total
)) {
329 parser
->body_length
= end
+ 1 - start
;
330 php_http_message_parser_state_push(parser
, 1, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_LENGTH
);
338 if ((*message
)->type
== PHP_HTTP_REQUEST
) {
339 php_http_message_parser_state_push(parser
, 1, PHP_HTTP_MESSAGE_PARSER_STATE_DONE
);
341 php_http_message_parser_state_push(parser
, 1, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DUMB
);
347 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY
:
352 if (parser
->inflate
) {
353 char *dec_str
= NULL
;
356 if (SUCCESS
!= php_http_encoding_stream_update(parser
->inflate
, str
, len
, &dec_str
, &dec_len
)) {
357 return php_http_message_parser_state_push(parser
, 1, PHP_HTTP_MESSAGE_PARSER_STATE_FAILURE
);
360 if (str
!= buffer
->data
) {
367 php_stream_write(php_http_message_body_stream(&(*message
)->body
), str
, len
);
371 ZVAL_LONG(zcl
, php_http_message_body_size(&(*message
)->body
));
372 zend_hash_update(&(*message
)->hdrs
, "Content-Length", sizeof("Content-Length"), &zcl
, sizeof(zval
*), NULL
);
376 php_http_buffer_cut(buffer
, 0, cut
);
379 if (str
!= buffer
->data
) {
389 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DUMB
:
395 php_http_message_parser_state_push(parser
, 2, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DONE
, PHP_HTTP_MESSAGE_PARSER_STATE_BODY
);
399 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_LENGTH
:
401 len
= MIN(parser
->body_length
, buffer
->used
);
405 parser
->body_length
-= len
;
407 php_http_message_parser_state_push(parser
, 2, !parser
->body_length
?PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DONE
:PHP_HTTP_MESSAGE_PARSER_STATE_BODY_LENGTH
, PHP_HTTP_MESSAGE_PARSER_STATE_BODY
);
411 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_CHUNKED
:
414 * - pass available data through the dechunk stream
415 * - pass decoded data along
416 * - if stream zeroed:
417 * Y: - cut processed string out of buffer, but leave length of unprocessed dechunk stream data untouched
421 char *dec_str
= NULL
;
424 if (SUCCESS
!= php_http_encoding_stream_update(parser
->dechunk
, buffer
->data
, buffer
->used
, &dec_str
, &dec_len
)) {
431 if (php_http_encoding_stream_done(parser
->dechunk
)) {
432 cut
= buffer
->used
- PHP_HTTP_BUFFER_LEN(parser
->dechunk
->ctx
);
433 php_http_message_parser_state_push(parser
, 2, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DONE
, PHP_HTTP_MESSAGE_PARSER_STATE_BODY
);
436 php_http_message_parser_state_push(parser
, 2, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_CHUNKED
, PHP_HTTP_MESSAGE_PARSER_STATE_BODY
);
441 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DONE
:
443 php_http_message_parser_state_push(parser
, 1, PHP_HTTP_MESSAGE_PARSER_STATE_DONE
);
445 if (parser
->dechunk
) {
446 char *dec_str
= NULL
;
449 if (SUCCESS
!= php_http_encoding_stream_finish(parser
->dechunk
, &dec_str
, &dec_len
)) {
450 return php_http_message_parser_state_push(parser
, 1, PHP_HTTP_MESSAGE_PARSER_STATE_FAILURE
);
452 php_http_encoding_stream_dtor(parser
->dechunk
);
454 if (dec_str
&& dec_len
) {
458 php_http_message_parser_state_push(parser
, 1, PHP_HTTP_MESSAGE_PARSER_STATE_BODY
);
465 case PHP_HTTP_MESSAGE_PARSER_STATE_DONE
: {
466 char *ptr
= buffer
->data
;
468 while (ptr
- buffer
->data
< buffer
->used
&& PHP_HTTP_IS_CTYPE(space
, *ptr
)) {
472 php_http_buffer_cut(buffer
, 0, ptr
- buffer
->data
);
478 return php_http_message_parser_state_is(parser
);
486 * vim600: noet sw=4 ts=4 fdm=marker
487 * vim<600: noet sw=4 ts=4