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


fdbac18698572bee89d2c316d2405a833b04363b
[m6w6/ext-http] / php_http_header_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-2014, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
11 */
12
13 #include "php_http_api.h"
14
15 #ifndef DBG_PARSER
16 # define DBG_PARSER 0
17 #endif
18
19 typedef struct php_http_header_parser_state_spec {
20 php_http_header_parser_state_t state;
21 unsigned need_data:1;
22 } php_http_header_parser_state_spec_t;
23
24 static const php_http_header_parser_state_spec_t php_http_header_parser_states[] = {
25 {PHP_HTTP_HEADER_PARSER_STATE_START, 1},
26 {PHP_HTTP_HEADER_PARSER_STATE_KEY, 1},
27 {PHP_HTTP_HEADER_PARSER_STATE_VALUE, 1},
28 {PHP_HTTP_HEADER_PARSER_STATE_VALUE_EX, 0},
29 {PHP_HTTP_HEADER_PARSER_STATE_HEADER_DONE, 0},
30 {PHP_HTTP_HEADER_PARSER_STATE_DONE, 0}
31 };
32
33 php_http_header_parser_t *php_http_header_parser_init(php_http_header_parser_t *parser TSRMLS_DC)
34 {
35 if (!parser) {
36 parser = emalloc(sizeof(*parser));
37 }
38 memset(parser, 0, sizeof(*parser));
39
40 TSRMLS_SET_CTX(parser->ts);
41
42 return parser;
43 }
44
45 php_http_header_parser_state_t php_http_header_parser_state_push(php_http_header_parser_t *parser, unsigned argc, ...)
46 {
47 va_list va_args;
48 unsigned i;
49 php_http_header_parser_state_t state = 0;
50
51 /* short circuit */
52 ZEND_PTR_STACK_RESIZE_IF_NEEDED((&parser->stack), argc);
53
54 va_start(va_args, argc);
55 for (i = 0; i < argc; ++i) {
56 state = va_arg(va_args, php_http_header_parser_state_t);
57 zend_ptr_stack_push(&parser->stack, (void *) state);
58 }
59 va_end(va_args);
60
61 return state;
62 }
63
64 php_http_header_parser_state_t php_http_header_parser_state_is(php_http_header_parser_t *parser)
65 {
66 if (parser->stack.top) {
67 return (php_http_header_parser_state_t) parser->stack.elements[parser->stack.top - 1];
68 }
69
70 return PHP_HTTP_HEADER_PARSER_STATE_START;
71 }
72
73 php_http_header_parser_state_t php_http_header_parser_state_pop(php_http_header_parser_t *parser)
74 {
75 if (parser->stack.top) {
76 return (php_http_header_parser_state_t) zend_ptr_stack_pop(&parser->stack);
77 }
78
79 return PHP_HTTP_HEADER_PARSER_STATE_START;
80 }
81
82 void php_http_header_parser_dtor(php_http_header_parser_t *parser)
83 {
84 zend_ptr_stack_destroy(&parser->stack);
85 php_http_info_dtor(&parser->info);
86 PTR_FREE(parser->_key.str);
87 PTR_FREE(parser->_val.str);
88 }
89
90 void php_http_header_parser_free(php_http_header_parser_t **parser)
91 {
92 if (*parser) {
93 php_http_header_parser_dtor(*parser);
94 efree(*parser);
95 *parser = NULL;
96 }
97 }
98
99 /* NOTE: 'str' has to be null terminated */
100 static void php_http_header_parser_error(size_t valid_len, char *str, size_t len, const char *eol_str TSRMLS_DC)
101 {
102 int escaped_len;
103 char *escaped_str;
104
105 escaped_str = php_addcslashes(str, len, &escaped_len, 0, ZEND_STRL("\x0..\x1F\x7F..\xFF") TSRMLS_CC);
106
107 if (valid_len != len) {
108 php_error_docref(NULL TSRMLS_CC, E_WARNING, "Failed to parse headers: unexpected character '\\%03o' at pos %zu of '%.*s'", str[valid_len], valid_len, escaped_len, escaped_str);
109 } else if (eol_str) {
110 php_error_docref(NULL TSRMLS_CC, E_WARNING, "Failed to parse headers: unexpected character '\\%03o' at pos %zu of '%.*s'", *eol_str, eol_str - str, escaped_len, escaped_str);
111 } else {
112 php_error_docref(NULL TSRMLS_CC, E_WARNING, "Failed to parse headers: unexpected end of input at pos %zu of '%.*s'", len, escaped_len, escaped_str);
113 }
114
115 efree(escaped_str);
116 }
117
118 STATUS php_http_header_parser_parse(php_http_header_parser_t *parser, php_http_buffer_t *buffer, unsigned flags, HashTable *headers, php_http_info_callback_t callback_func, void *callback_arg)
119 {
120 TSRMLS_FETCH_FROM_CTX(parser->ts);
121
122 while (buffer->used || !php_http_header_parser_states[php_http_header_parser_state_is(parser)].need_data) {
123 #if DBG_PARSER
124 const char *state[] = {"START", "KEY", "VALUE", "VALUE_EX", "HEADER_DONE", "DONE"};
125 fprintf(stderr, "#HP: %s (avail:%zu, num:%d cleanup:%u)\n", php_http_header_parser_state_is(parser) < 0 ? "FAILURE" : state[php_http_header_parser_state_is(parser)], buffer->used, headers?zend_hash_num_elements(headers):0, flags);
126 _dpf(0, buffer->data, buffer->used);
127 #endif
128 switch (php_http_header_parser_state_pop(parser)) {
129 case PHP_HTTP_HEADER_PARSER_STATE_FAILURE:
130 php_error_docref(NULL TSRMLS_CC, E_WARNING, "Failed to parse headers");
131 return php_http_header_parser_state_push(parser, 1, PHP_HTTP_HEADER_PARSER_STATE_FAILURE);
132
133 case PHP_HTTP_HEADER_PARSER_STATE_START: {
134 char *ptr = buffer->data;
135
136 while (ptr - buffer->data < buffer->used && PHP_HTTP_IS_CTYPE(space, *ptr)) {
137 ++ptr;
138 }
139
140 php_http_buffer_cut(buffer, 0, ptr - buffer->data);
141 php_http_header_parser_state_push(parser, 1, PHP_HTTP_HEADER_PARSER_STATE_KEY);
142 break;
143 }
144
145 case PHP_HTTP_HEADER_PARSER_STATE_KEY: {
146 const char *colon, *eol_str = NULL;
147 int eol_len = 0;
148
149 if (buffer->data == (eol_str = php_http_locate_bin_eol(buffer->data, buffer->used, &eol_len))) {
150 /* end of headers */
151 php_http_buffer_cut(buffer, 0, eol_len);
152 php_http_header_parser_state_push(parser, 1, PHP_HTTP_HEADER_PARSER_STATE_DONE);
153 } else if (php_http_info_parse(&parser->info, php_http_buffer_fix(buffer)->data TSRMLS_CC)) {
154 /* new message starting with request/response line */
155 if (callback_func) {
156 callback_func(callback_arg, &headers, &parser->info TSRMLS_CC);
157 }
158 php_http_info_dtor(&parser->info);
159 php_http_buffer_cut(buffer, 0, eol_str + eol_len - buffer->data);
160 php_http_header_parser_state_push(parser, 1, PHP_HTTP_HEADER_PARSER_STATE_HEADER_DONE);
161 } else if ((colon = memchr(buffer->data, ':', buffer->used)) && (!eol_str || eol_str > colon)) {
162 /* header: string */
163 size_t valid_len;
164
165 parser->_key.len = colon - buffer->data;
166 parser->_key.str = estrndup(buffer->data, parser->_key.len);
167
168 valid_len = strspn(parser->_key.str, PHP_HTTP_HEADER_NAME_CHARS);
169 if (valid_len != parser->_key.len) {
170 php_http_header_parser_error(valid_len, parser->_key.str, parser->_key.len, eol_str TSRMLS_CC);
171 PTR_SET(parser->_key.str, NULL);
172 return php_http_header_parser_state_push(parser, 1, PHP_HTTP_HEADER_PARSER_STATE_FAILURE);
173 }
174 while (PHP_HTTP_IS_CTYPE(space, *++colon) && *colon != '\n' && *colon != '\r');
175 php_http_buffer_cut(buffer, 0, colon - buffer->data);
176 php_http_header_parser_state_push(parser, 1, PHP_HTTP_HEADER_PARSER_STATE_VALUE);
177 } else if (eol_str || (flags & PHP_HTTP_HEADER_PARSER_CLEANUP)) {
178 /* neither reqeust/response line nor 'header:' string, or injected new line or NUL etc. */
179 php_http_buffer_fix(buffer);
180 php_http_header_parser_error(strspn(buffer->data, PHP_HTTP_HEADER_NAME_CHARS), buffer->data, buffer->used, eol_str TSRMLS_CC);
181 return php_http_header_parser_state_push(parser, 1, PHP_HTTP_HEADER_PARSER_STATE_FAILURE);
182 } else {
183 /* keep feeding */
184 return php_http_header_parser_state_push(parser, 1, PHP_HTTP_HEADER_PARSER_STATE_KEY);
185 }
186 break;
187 }
188
189 case PHP_HTTP_HEADER_PARSER_STATE_VALUE: {
190 const char *eol_str;
191 int eol_len;
192
193 #define SET_ADD_VAL(slen, eol_len) \
194 do { \
195 const char *ptr = buffer->data; \
196 size_t len = slen; \
197 \
198 while (len > 0 && PHP_HTTP_IS_CTYPE(space, *ptr)) { \
199 ++ptr; \
200 --len; \
201 } \
202 while (len > 0 && PHP_HTTP_IS_CTYPE(space, ptr[len - 1])) { \
203 --len; \
204 } \
205 \
206 if (len > 0) { \
207 if (parser->_val.str) { \
208 parser->_val.str = erealloc(parser->_val.str, parser->_val.len + len + 2); \
209 parser->_val.str[parser->_val.len++] = ' '; \
210 memcpy(&parser->_val.str[parser->_val.len], ptr, len); \
211 parser->_val.len += len; \
212 parser->_val.str[parser->_val.len] = '\0'; \
213 } else { \
214 parser->_val.len = len; \
215 parser->_val.str = estrndup(ptr, len); \
216 } \
217 } \
218 php_http_buffer_cut(buffer, 0, slen + eol_len); \
219 } while (0)
220
221 if ((eol_str = php_http_locate_bin_eol(buffer->data, buffer->used, &eol_len))) {
222 SET_ADD_VAL(eol_str - buffer->data, eol_len);
223 php_http_header_parser_state_push(parser, 1, PHP_HTTP_HEADER_PARSER_STATE_VALUE_EX);
224 } else if (flags & PHP_HTTP_HEADER_PARSER_CLEANUP) {
225 if (buffer->used) {
226 SET_ADD_VAL(buffer->used, 0);
227 }
228 php_http_header_parser_state_push(parser, 1, PHP_HTTP_HEADER_PARSER_STATE_HEADER_DONE);
229 } else {
230 return php_http_header_parser_state_push(parser, 1, PHP_HTTP_HEADER_PARSER_STATE_VALUE);
231 }
232 break;
233 }
234
235 case PHP_HTTP_HEADER_PARSER_STATE_VALUE_EX:
236 if (buffer->used && (*buffer->data == ' ' || *buffer->data == '\t')) {
237 php_http_header_parser_state_push(parser, 1, PHP_HTTP_HEADER_PARSER_STATE_VALUE);
238 } else if (buffer->used || (flags & PHP_HTTP_HEADER_PARSER_CLEANUP)) {
239 php_http_header_parser_state_push(parser, 1, PHP_HTTP_HEADER_PARSER_STATE_HEADER_DONE);
240 } else {
241 /* keep feeding */
242 return php_http_header_parser_state_push(parser, 1, PHP_HTTP_HEADER_PARSER_STATE_VALUE_EX);
243 }
244 break;
245
246 case PHP_HTTP_HEADER_PARSER_STATE_HEADER_DONE:
247 if (parser->_key.str && parser->_val.str) {
248 zval array, **exist;
249
250 if (!headers && callback_func) {
251 callback_func(callback_arg, &headers, NULL TSRMLS_CC);
252 }
253
254 INIT_PZVAL_ARRAY(&array, headers);
255 php_http_pretty_key(parser->_key.str, parser->_key.len, 1, 1);
256 if (SUCCESS == zend_symtable_find(headers, parser->_key.str, parser->_key.len + 1, (void *) &exist)) {
257 convert_to_array(*exist);
258 add_next_index_stringl(*exist, parser->_val.str, parser->_val.len, 0);
259 } else {
260 add_assoc_stringl_ex(&array, parser->_key.str, parser->_key.len + 1, parser->_val.str, parser->_val.len, 0);
261 }
262 parser->_val.str = NULL;
263 }
264
265 PTR_SET(parser->_key.str, NULL);
266 PTR_SET(parser->_val.str, NULL);
267
268 php_http_header_parser_state_push(parser, 1, PHP_HTTP_HEADER_PARSER_STATE_KEY);
269 break;
270
271 case PHP_HTTP_HEADER_PARSER_STATE_DONE:
272 return PHP_HTTP_HEADER_PARSER_STATE_DONE;
273 }
274 }
275
276 return php_http_header_parser_state_is(parser);
277 }
278
279 php_http_header_parser_state_t php_http_header_parser_parse_stream(php_http_header_parser_t *parser, php_http_buffer_t *buf, php_stream *s, unsigned flags, HashTable *headers, php_http_info_callback_t callback_func, void *callback_arg)
280 {
281 php_http_message_parser_state_t state = PHP_HTTP_MESSAGE_PARSER_STATE_START;
282 TSRMLS_FETCH_FROM_CTX(parser->ts);
283
284 if (!buf->data) {
285 php_http_buffer_resize_ex(buf, 0x1000, 1, 0);
286 }
287 while (1) {
288 size_t justread = 0;
289 #if DBG_PARSER
290 const char *states[] = {"START", "KEY", "VALUE", "VALUE_EX", "HEADER_DONE", "DONE"};
291 fprintf(stderr, "#SHP: %s (f:%u)\n", states[state], flags);
292 #endif
293 /* resize if needed */
294 if (buf->free < 0x1000) {
295 php_http_buffer_resize_ex(buf, 0x1000, 1, 0);
296 }
297 switch (state) {
298 case PHP_HTTP_HEADER_PARSER_STATE_FAILURE:
299 case PHP_HTTP_HEADER_PARSER_STATE_DONE:
300 return state;
301
302 default:
303 /* read line */
304 php_stream_get_line(s, buf->data + buf->used, buf->free, &justread);
305 /* if we fail reading a whole line, try a single char */
306 if (!justread) {
307 int c = php_stream_getc(s);
308
309 if (c != EOF) {
310 char s[1] = {c};
311 justread = php_http_buffer_append(buf, s, 1);
312 }
313 }
314 php_http_buffer_account(buf, justread);
315 }
316
317 if (justread) {
318 state = php_http_header_parser_parse(parser, buf, flags, headers, callback_func, callback_arg);
319 } else if (php_stream_eof(s)) {
320 return php_http_header_parser_parse(parser, buf, flags | PHP_HTTP_HEADER_PARSER_CLEANUP, headers, callback_func, callback_arg);
321 } else {
322 return state;
323 }
324 }
325
326 return PHP_HTTP_HEADER_PARSER_STATE_DONE;
327 }
328
329 zend_class_entry *php_http_header_parser_class_entry;
330 static zend_object_handlers php_http_header_parser_object_handlers;
331
332 zend_object_value php_http_header_parser_object_new(zend_class_entry *ce TSRMLS_DC)
333 {
334 return php_http_header_parser_object_new_ex(ce, NULL, NULL TSRMLS_CC);
335 }
336
337 zend_object_value php_http_header_parser_object_new_ex(zend_class_entry *ce, php_http_header_parser_t *parser, php_http_header_parser_object_t **ptr TSRMLS_DC)
338 {
339 php_http_header_parser_object_t *o;
340
341 o = ecalloc(1, sizeof(php_http_header_parser_object_t));
342 zend_object_std_init((zend_object *) o, ce TSRMLS_CC);
343 object_properties_init((zend_object *) o, ce);
344
345 if (ptr) {
346 *ptr = o;
347 }
348
349 if (parser) {
350 o->parser = parser;
351 } else {
352 o->parser = php_http_header_parser_init(NULL TSRMLS_CC);
353 }
354 o->buffer = php_http_buffer_new();
355
356 o->zv.handle = zend_objects_store_put((zend_object *) o, NULL, php_http_header_parser_object_free, NULL TSRMLS_CC);
357 o->zv.handlers = &php_http_header_parser_object_handlers;
358
359 return o->zv;
360 }
361
362 void php_http_header_parser_object_free(void *object TSRMLS_DC)
363 {
364 php_http_header_parser_object_t *o = (php_http_header_parser_object_t *) object;
365
366 if (o->parser) {
367 php_http_header_parser_free(&o->parser);
368 }
369 if (o->buffer) {
370 php_http_buffer_free(&o->buffer);
371 }
372 zend_object_std_dtor((zend_object *) o TSRMLS_CC);
373 efree(o);
374 }
375
376 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeaderParser_getState, 0, 0, 0)
377 ZEND_END_ARG_INFO();
378 static PHP_METHOD(HttpHeaderParser, getState)
379 {
380 php_http_header_parser_object_t *parser_obj = zend_object_store_get_object(getThis() TSRMLS_CC);
381
382 zend_parse_parameters_none();
383 /* always return the real state */
384 RETVAL_LONG(php_http_header_parser_state_is(parser_obj->parser));
385 }
386
387 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeaderParser_parse, 0, 0, 3)
388 ZEND_ARG_INFO(0, data)
389 ZEND_ARG_INFO(0, flags)
390 ZEND_ARG_ARRAY_INFO(1, headers, 1)
391 ZEND_END_ARG_INFO();
392 static PHP_METHOD(HttpHeaderParser, parse)
393 {
394 php_http_header_parser_object_t *parser_obj;
395 zval *zmsg;
396 char *data_str;
397 int data_len;
398 long flags;
399
400 php_http_expect(SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "slz", &data_str, &data_len, &flags, &zmsg), invalid_arg, return);
401
402 if (Z_TYPE_P(zmsg) != IS_ARRAY) {
403 zval_dtor(zmsg);
404 array_init(zmsg);
405 }
406 parser_obj = zend_object_store_get_object(getThis() TSRMLS_CC);
407 php_http_buffer_append(parser_obj->buffer, data_str, data_len);
408 RETVAL_LONG(php_http_header_parser_parse(parser_obj->parser, parser_obj->buffer, flags, Z_ARRVAL_P(zmsg), NULL, NULL));
409 }
410
411 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeaderParser_stream, 0, 0, 3)
412 ZEND_ARG_INFO(0, stream)
413 ZEND_ARG_INFO(0, flags)
414 ZEND_ARG_ARRAY_INFO(1, headers, 1)
415 ZEND_END_ARG_INFO();
416 static PHP_METHOD(HttpHeaderParser, stream)
417 {
418 php_http_header_parser_object_t *parser_obj;
419 zend_error_handling zeh;
420 zval *zmsg, *zstream;
421 php_stream *s;
422 long flags;
423
424 php_http_expect(SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "rlz", &zstream, &flags, &zmsg), invalid_arg, return);
425
426 zend_replace_error_handling(EH_THROW, php_http_exception_unexpected_val_class_entry, &zeh TSRMLS_CC);
427 php_stream_from_zval(s, &zstream);
428 zend_restore_error_handling(&zeh TSRMLS_CC);
429
430 if (Z_TYPE_P(zmsg) != IS_ARRAY) {
431 zval_dtor(zmsg);
432 array_init(zmsg);
433 }
434 parser_obj = zend_object_store_get_object(getThis() TSRMLS_CC);
435 RETVAL_LONG(php_http_header_parser_parse_stream(parser_obj->parser, parser_obj->buffer, s, flags, Z_ARRVAL_P(zmsg), NULL, NULL));
436 }
437
438 static zend_function_entry php_http_header_parser_methods[] = {
439 PHP_ME(HttpHeaderParser, getState, ai_HttpHeaderParser_getState, ZEND_ACC_PUBLIC)
440 PHP_ME(HttpHeaderParser, parse, ai_HttpHeaderParser_parse, ZEND_ACC_PUBLIC)
441 PHP_ME(HttpHeaderParser, stream, ai_HttpHeaderParser_stream, ZEND_ACC_PUBLIC)
442 {NULL, NULL, NULL}
443 };
444
445 PHP_MINIT_FUNCTION(http_header_parser)
446 {
447 zend_class_entry ce;
448
449 INIT_NS_CLASS_ENTRY(ce, "http\\Header", "Parser", php_http_header_parser_methods);
450 php_http_header_parser_class_entry = zend_register_internal_class(&ce TSRMLS_CC);
451 memcpy(&php_http_header_parser_object_handlers, zend_get_std_object_handlers(), sizeof(zend_object_handlers));
452 php_http_header_parser_class_entry->create_object = php_http_header_parser_object_new;
453 php_http_header_parser_object_handlers.clone_obj = NULL;
454
455 zend_declare_class_constant_long(php_http_header_parser_class_entry, ZEND_STRL("CLEANUP"), PHP_HTTP_HEADER_PARSER_CLEANUP TSRMLS_CC);
456
457 zend_declare_class_constant_long(php_http_header_parser_class_entry, ZEND_STRL("STATE_FAILURE"), PHP_HTTP_HEADER_PARSER_STATE_FAILURE TSRMLS_CC);
458 zend_declare_class_constant_long(php_http_header_parser_class_entry, ZEND_STRL("STATE_START"), PHP_HTTP_HEADER_PARSER_STATE_START TSRMLS_CC);
459 zend_declare_class_constant_long(php_http_header_parser_class_entry, ZEND_STRL("STATE_KEY"), PHP_HTTP_HEADER_PARSER_STATE_KEY TSRMLS_CC);
460 zend_declare_class_constant_long(php_http_header_parser_class_entry, ZEND_STRL("STATE_VALUE"), PHP_HTTP_HEADER_PARSER_STATE_VALUE TSRMLS_CC);
461 zend_declare_class_constant_long(php_http_header_parser_class_entry, ZEND_STRL("STATE_VALUE_EX"), PHP_HTTP_HEADER_PARSER_STATE_VALUE_EX TSRMLS_CC);
462 zend_declare_class_constant_long(php_http_header_parser_class_entry, ZEND_STRL("STATE_HEADER_DONE"), PHP_HTTP_HEADER_PARSER_STATE_HEADER_DONE TSRMLS_CC);
463 zend_declare_class_constant_long(php_http_header_parser_class_entry, ZEND_STRL("STATE_DONE"), PHP_HTTP_HEADER_PARSER_STATE_DONE TSRMLS_CC);
464
465 return SUCCESS;
466 }
467
468 /*
469 * Local variables:
470 * tab-width: 4
471 * c-basic-offset: 4
472 * End:
473 * vim600: noet sw=4 ts=4 fdm=marker
474 * vim<600: noet sw=4 ts=4
475 */
476
Extended HTTP Support