projects / m6w6 / ext-http / blob
? search:


5acf66f76529f18d20cce5fdcd40f6a9465fe8b0
[m6w6/ext-http] / php_http_message_parser.c
1 /*
2 +--------------------------------------------------------------------+
3 | PECL :: http |
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 +--------------------------------------------------------------------+
11 */
12
13 #include "php_http_api.h"
14
15 typedef struct php_http_message_parser_state_spec {
16 php_http_message_parser_state_t state;
17 unsigned need_data:1;
18 } php_http_message_parser_state_spec_t;
19
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}
30 };
31
32 PHP_HTTP_API php_http_message_parser_t *php_http_message_parser_init(php_http_message_parser_t *parser TSRMLS_DC)
33 {
34 if (!parser) {
35 parser = emalloc(sizeof(*parser));
36 }
37 memset(parser, 0, sizeof(*parser));
38
39 TSRMLS_SET_CTX(parser->ts);
40
41 php_http_header_parser_init(&parser->header TSRMLS_CC);
42 zend_stack_init(&parser->stack);
43
44 return parser;
45 }
46
47 PHP_HTTP_API php_http_message_parser_state_t php_http_message_parser_state_push(php_http_message_parser_t *parser, unsigned argc, ...)
48 {
49 php_http_message_parser_state_t state;
50 va_list va_args;
51 unsigned i;
52
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));
57 }
58 va_end(va_args);
59
60 return state;
61 }
62
63 PHP_HTTP_API php_http_message_parser_state_t php_http_message_parser_state_is(php_http_message_parser_t *parser)
64 {
65 php_http_message_parser_state_t *state;
66
67 if (SUCCESS == zend_stack_top(&parser->stack, (void *) &state)) {
68 return *state;
69 }
70 return PHP_HTTP_MESSAGE_PARSER_STATE_START;
71 }
72
73 PHP_HTTP_API php_http_message_parser_state_t php_http_message_parser_state_pop(php_http_message_parser_t *parser)
74 {
75 php_http_message_parser_state_t state, *state_ptr;
76 if (SUCCESS == zend_stack_top(&parser->stack, (void *) &state_ptr)) {
77 state = *state_ptr;
78 zend_stack_del_top(&parser->stack);
79 return state;
80 }
81 return PHP_HTTP_MESSAGE_PARSER_STATE_START;
82 }
83
84 PHP_HTTP_API void php_http_message_parser_dtor(php_http_message_parser_t *parser)
85 {
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);
90 }
91 if (parser->inflate) {
92 php_http_encoding_stream_free(&parser->inflate);
93 }
94 }
95
96 PHP_HTTP_API void php_http_message_parser_free(php_http_message_parser_t **parser)
97 {
98 if (*parser) {
99 php_http_message_parser_dtor(*parser);
100 efree(*parser);
101 *parser = NULL;
102 }
103 }
104
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)
106 {
107 php_http_buffer_t buf;
108 TSRMLS_FETCH_FROM_CTX(parser->ts);
109
110 php_http_buffer_init_ex(&buf, 0x1000, PHP_HTTP_BUFFER_INIT_PREALLOC);
111
112 while (!php_stream_eof(s)) {
113 size_t len = 0;
114
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:
119 /* read line */
120 php_stream_get_line(s, buf.data + buf.used, buf.free, &len);
121 php_http_buffer_account(&buf, len);
122 break;
123
124 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DUMB:
125 /* read all */
126 php_http_buffer_account(&buf, php_stream_read(s, buf.data + buf.used, buf.free));
127 break;
128
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)));
132 break;
133
134 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_CHUNKED:
135 /* duh, this is very naive */
136 if (len) {
137 size_t read = php_stream_read(s, buf.data + buf.used, MIN(len, buf.free));
138
139 php_http_buffer_account(&buf, read);
140
141 len -= read;
142 } else {
143 php_stream_get_line(s, buf.data, buf.free, &len);
144 php_http_buffer_account(&buf, len);
145
146 len = strtoul(buf.data - len, NULL, 16);
147 }
148 break;
149
150 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY:
151 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DONE:
152 /* should not occur */
153 abort();
154 break;
155
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);
160 }
161
162 php_http_message_parser_parse(parser, &buf, 0, message);
163 }
164
165 php_http_buffer_dtor(&buf);
166 return PHP_HTTP_MESSAGE_PARSER_STATE_DONE;
167 }
168
169
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)
171 {
172 TSRMLS_FETCH_FROM_CTX(parser->ts);
173 char *str = NULL;
174 size_t len = 0;
175 size_t cut = 0;
176
177 while (buffer->used || !php_http_message_parser_states[php_http_message_parser_state_is(parser)].need_data) {
178 #if 0
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);
182 #endif
183
184 switch (php_http_message_parser_state_pop(parser))
185 {
186 case PHP_HTTP_MESSAGE_PARSER_STATE_FAILURE:
187 return php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_FAILURE);
188
189 case PHP_HTTP_MESSAGE_PARSER_STATE_START:
190 {
191 char *ptr = buffer->data;
192
193 while (ptr - buffer->data < buffer->used && PHP_HTTP_IS_CTYPE(space, *ptr)) {
194 ++ptr;
195 }
196
197 php_http_buffer_cut(buffer, 0, ptr - buffer->data);
198
199 if (buffer->used) {
200 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_HEADER);
201 }
202 break;
203 }
204
205 case PHP_HTTP_MESSAGE_PARSER_STATE_HEADER:
206 {
207 unsigned header_parser_flags = (flags & PHP_HTTP_MESSAGE_PARSER_CLEANUP) ? PHP_HTTP_HEADER_PARSER_CLEANUP : 0;
208
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;
212
213 case PHP_HTTP_HEADER_PARSER_STATE_DONE:
214 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_HEADER_DONE);
215 break;
216
217 default:
218 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_HEADER);
219 if (buffer->used) {
220 return PHP_HTTP_MESSAGE_PARSER_STATE_HEADER;
221 }
222 }
223 break;
224 }
225
226 case PHP_HTTP_MESSAGE_PARSER_STATE_HEADER_DONE:
227 {
228 zval *h, *h_loc = NULL, *h_con = NULL, **h_cl = NULL, **h_cr = NULL, **h_te = NULL;
229
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"));
233 }
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);
236 }
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"));
240 }
241
242 /* default */
243 MAKE_STD_ZVAL(h);
244 ZVAL_LONG(h, 0);
245 zend_hash_update(&(*message)->hdrs, "Content-Length", sizeof("Content-Length"), &h, sizeof(zval *), NULL);
246
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.
249 */
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))
255 ) {
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);
260 break;
261 }
262 }
263 if (h_loc) {
264 zval_ptr_dtor(&h_loc);
265 }
266 if (h_con) {
267 zval_ptr_dtor(&h_con);
268 }
269
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)
274 ) {
275 if (parser->inflate) {
276 php_http_encoding_stream_reset(&parser->inflate);
277 } else {
278 parser->inflate = php_http_encoding_stream_init(NULL, php_http_encoding_stream_get_inflate_ops(), 0 TSRMLS_CC);
279 }
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"));
282 } else {
283 zval_ptr_dtor(&h);
284 }
285 }
286
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);
289 } else {
290 if (h_te) {
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);
294 break;
295 }
296 }
297
298 if (h_cl) {
299 char *stop;
300
301 parser->body_length = strtoul(Z_STRVAL_PP(h_cl), &stop, 10);
302
303 if (stop != Z_STRVAL_PP(h_cl)) {
304 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_LENGTH);
305 break;
306 }
307 }
308
309 if (h_cr) {
310 ulong total = 0, start = 0, end = 0;
311
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")] == '='
316 )
317 ) {
318 char *total_at = NULL, *end_at = NULL;
319 char *start_at = Z_STRVAL_PP(h_cr) + sizeof("bytes");
320
321 start = strtoul(start_at, &end_at, 10);
322 if (end_at) {
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);
326 }
327
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);
331 break;
332 }
333 }
334 }
335 }
336
337
338 if ((*message)->type == PHP_HTTP_REQUEST) {
339 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_DONE);
340 } else {
341 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DUMB);
342 }
343 }
344 break;
345 }
346
347 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY:
348 {
349 if (len) {
350 zval *zcl;
351
352 if (parser->inflate) {
353 char *dec_str = NULL;
354 size_t dec_len;
355
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);
358 }
359
360 if (str != buffer->data) {
361 STR_FREE(str);
362 }
363 str = dec_str;
364 len = dec_len;
365 }
366
367 php_stream_write(php_http_message_body_stream(&(*message)->body), str, len);
368
369 /* keep track */
370 MAKE_STD_ZVAL(zcl);
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);
373 }
374
375 if (cut) {
376 php_http_buffer_cut(buffer, 0, cut);
377 }
378
379 if (str != buffer->data) {
380 STR_FREE(str);
381 }
382
383 str = NULL;
384 len = 0;
385 cut = 0;
386 break;
387 }
388
389 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DUMB:
390 {
391 str = buffer->data;
392 len = buffer->used;
393 cut = len;
394
395 php_http_message_parser_state_push(parser, 2, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DONE, PHP_HTTP_MESSAGE_PARSER_STATE_BODY);
396 break;
397 }
398
399 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_LENGTH:
400 {
401 len = MIN(parser->body_length, buffer->used);
402 str = buffer->data;
403 cut = len;
404
405 parser->body_length -= len;
406
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);
408 break;
409 }
410
411 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_CHUNKED:
412 {
413 /*
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
418 * - body done
419 * N: - parse ahaed
420 */
421 char *dec_str = NULL;
422 size_t dec_len;
423
424 if (SUCCESS != php_http_encoding_stream_update(parser->dechunk, buffer->data, buffer->used, &dec_str, &dec_len)) {
425 return FAILURE;
426 }
427
428 str = dec_str;
429 len = dec_len;
430
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);
434 } else {
435 cut = buffer->used;
436 php_http_message_parser_state_push(parser, 2, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_CHUNKED, PHP_HTTP_MESSAGE_PARSER_STATE_BODY);
437 }
438 break;
439 }
440
441 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DONE:
442 {
443 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_DONE);
444
445 if (parser->dechunk) {
446 char *dec_str = NULL;
447 size_t dec_len;
448
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);
451 }
452 php_http_encoding_stream_dtor(parser->dechunk);
453
454 if (dec_str && dec_len) {
455 str = dec_str;
456 len = dec_len;
457 cut = 0;
458 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_BODY);
459 }
460 }
461
462 break;
463 }
464
465 case PHP_HTTP_MESSAGE_PARSER_STATE_DONE: {
466 char *ptr = buffer->data;
467
468 while (ptr - buffer->data < buffer->used && PHP_HTTP_IS_CTYPE(space, *ptr)) {
469 ++ptr;
470 }
471
472 php_http_buffer_cut(buffer, 0, ptr - buffer->data);
473 break;
474 }
475 }
476 }
477
478 return php_http_message_parser_state_is(parser);
479 }
480
481 /*
482 * Local variables:
483 * tab-width: 4
484 * c-basic-offset: 4
485 * End:
486 * vim600: noet sw=4 ts=4 fdm=marker
487 * vim<600: noet sw=4 ts=4
488 */
489
Extended HTTP Support