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