consitency with type names
[m6w6/ext-http] / php_http_message_parser.c
1 #include "php_http.h"
2
3 typedef struct php_http_message_parser_state_spec {
4 php_http_message_parser_state_t state;
5 unsigned need_data:1;
6 } php_http_message_parser_state_spec_t;
7
8 static const php_http_message_parser_state_spec_t php_http_message_parser_states[] = {
9 {PHP_HTTP_MESSAGE_PARSER_STATE_START, 1},
10 {PHP_HTTP_MESSAGE_PARSER_STATE_HEADER, 1},
11 {PHP_HTTP_MESSAGE_PARSER_STATE_HEADER_DONE, 0},
12 {PHP_HTTP_MESSAGE_PARSER_STATE_BODY, 0},
13 {PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DUMB, 1},
14 {PHP_HTTP_MESSAGE_PARSER_STATE_BODY_LENGTH, 1},
15 {PHP_HTTP_MESSAGE_PARSER_STATE_BODY_CHUNKED, 1},
16 {PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DONE, 0},
17 {PHP_HTTP_MESSAGE_PARSER_STATE_DONE, 0}
18 };
19
20 PHP_HTTP_API php_http_message_parser_t *php_http_message_parser_init(php_http_message_parser_t *parser TSRMLS_DC)
21 {
22 if (!parser) {
23 parser = emalloc(sizeof(*parser));
24 }
25 memset(parser, 0, sizeof(*parser));
26
27 TSRMLS_SET_CTX(parser->ts);
28
29 php_http_header_parser_init(&parser->header TSRMLS_CC);
30 zend_stack_init(&parser->stack);
31
32 return parser;
33 }
34
35 PHP_HTTP_API php_http_message_parser_state_t php_http_message_parser_state_push(php_http_message_parser_t *parser, unsigned argc, ...)
36 {
37 va_list va_args;
38 unsigned i;
39 va_start(va_args, argc);
40 php_http_message_parser_state_t state;
41
42 for (i = 0; i < argc; ++i) {
43 state = va_arg(va_args, php_http_message_parser_state_t);
44 zend_stack_push(&parser->stack, &state, sizeof(state));
45 }
46 va_end(va_args);
47
48 return state;
49 }
50
51 PHP_HTTP_API php_http_message_parser_state_t php_http_message_parser_state_is(php_http_message_parser_t *parser)
52 {
53 php_http_message_parser_state_t *state;
54
55 if (SUCCESS == zend_stack_top(&parser->stack, (void *) &state)) {
56 return *state;
57 }
58 return PHP_HTTP_MESSAGE_PARSER_STATE_START;
59 }
60
61 PHP_HTTP_API php_http_message_parser_state_t php_http_message_parser_state_pop(php_http_message_parser_t *parser)
62 {
63 php_http_message_parser_state_t state, *state_ptr;
64 if (SUCCESS == zend_stack_top(&parser->stack, (void *) &state_ptr)) {
65 state = *state_ptr;
66 zend_stack_del_top(&parser->stack);
67 return state;
68 }
69 return PHP_HTTP_MESSAGE_PARSER_STATE_START;
70 }
71
72 PHP_HTTP_API void php_http_message_parser_dtor(php_http_message_parser_t *parser)
73 {
74 php_http_header_parser_dtor(&parser->header);
75 zend_stack_destroy(&parser->stack);
76 if (parser->dechunk) {
77 php_http_encoding_stream_free(&parser->dechunk TSRMLS_CC);
78 }
79 if (parser->inflate) {
80 php_http_encoding_stream_free(&parser->inflate TSRMLS_CC);
81 }
82 }
83
84 PHP_HTTP_API void php_http_message_parser_free(php_http_message_parser_t **parser)
85 {
86 if (*parser) {
87 php_http_message_parser_dtor(*parser);
88 efree(*parser);
89 *parser = NULL;
90 }
91 }
92
93
94 PHP_HTTP_API php_http_message_parser_state_t php_http_message_parser_parse(php_http_message_parser_t *parser, php_http_buffer *buffer, unsigned flags, php_http_message_t **message)
95 {
96 TSRMLS_FETCH_FROM_CTX(parser->ts);
97 char *str = NULL;
98 size_t len = 0;
99 size_t cut = 0;
100
101 while (buffer->used || !php_http_message_parser_states[php_http_message_parser_state_is(parser)].need_data) {
102 #if 0
103 const char *state[] = {"START", "HEADER", "HEADER_DONE", "BODY", "BODY_DUMB", "BODY_LENGTH", "BODY_CHUNK", "BODY_DONE", "DONE"};
104 fprintf(stderr, "#MP: %s (%d) %zu\n",
105 state[php_http_message_parser_state_is(parser)], (*message)->type, buffer->used);
106 #endif
107
108 switch (php_http_message_parser_state_pop(parser))
109 {
110 case PHP_HTTP_MESSAGE_PARSER_STATE_FAILURE:
111 return php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_FAILURE);
112
113 case PHP_HTTP_MESSAGE_PARSER_STATE_START:
114 {
115 char *ptr = buffer->data;
116
117 while (ptr - buffer->data < buffer->used && PHP_HTTP_IS_CTYPE(space, *ptr)) {
118 ++ptr;
119 }
120
121 php_http_buffer_cut(buffer, 0, ptr - buffer->data);
122
123 if (buffer->used) {
124 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_HEADER);
125 }
126 break;
127 }
128
129 case PHP_HTTP_MESSAGE_PARSER_STATE_HEADER:
130 {
131 unsigned header_parser_flags = (flags & PHP_HTTP_MESSAGE_PARSER_CLEANUP) ? PHP_HTTP_HEADER_PARSER_CLEANUP : 0;
132
133 switch (php_http_header_parser_parse(&parser->header, buffer, header_parser_flags, &(*message)->hdrs, (php_http_info_callback_t) php_http_message_info_callback, message)) {
134 case PHP_HTTP_HEADER_PARSER_STATE_FAILURE:
135 return PHP_HTTP_MESSAGE_PARSER_STATE_FAILURE;
136
137 case PHP_HTTP_HEADER_PARSER_STATE_DONE:
138 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_HEADER_DONE);
139 break;
140
141 default:
142 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_HEADER);
143 if (buffer->used) {
144 return PHP_HTTP_MESSAGE_PARSER_STATE_HEADER;
145 }
146 }
147 break;
148 }
149
150 case PHP_HTTP_MESSAGE_PARSER_STATE_HEADER_DONE:
151 {
152 zval *h, **h_cl = NULL, **h_cr = NULL, **h_te = NULL;
153
154 if ((h = php_http_message_header(*message, ZEND_STRL("Transfer-Encoding"), 1))) {
155 zend_hash_update(&(*message)->hdrs, "X-Original-Transfer-Encoding", sizeof("X-Original-Transfer-Encoding"), &h, sizeof(zval *), (void *) &h_te);
156 zend_hash_del(&(*message)->hdrs, "Transfer-Encoding", sizeof("Transfer-Encoding"));
157 }
158 if ((h = php_http_message_header(*message, ZEND_STRL("Content-Length"), 1))) {
159 zend_hash_update(&(*message)->hdrs, "X-Original-Content-Length", sizeof("X-Original-Content-Length"), &h, sizeof(zval *), (void *) &h_cl);
160 }
161 if ((h = php_http_message_header(*message, ZEND_STRL("Content-Range"), 1))) {
162 zend_hash_update(&(*message)->hdrs, "X-Original-Content-Range", sizeof("X-Original-Content-Range"), &h, sizeof(zval *), (void *) &h_cr);
163 zend_hash_del(&(*message)->hdrs, "Content-Range", sizeof("Content-Range"));
164 }
165
166 if ((h = php_http_message_header(*message, ZEND_STRL("Content-Encoding"), 1))) {
167 if (strstr(Z_STRVAL_P(h), "gzip") || strstr(Z_STRVAL_P(h), "x-gzip") || strstr(Z_STRVAL_P(h), "deflate")) {
168 parser->inflate = php_http_encoding_stream_init(parser->inflate, php_http_encoding_stream_get_inflate_ops(), 0 TSRMLS_CC);
169 zend_hash_update(&(*message)->hdrs, "X-Original-Content-Encoding", sizeof("X-Original-Content-Encoding"), &h, sizeof(zval *), NULL);
170 zend_hash_del(&(*message)->hdrs, "Content-Encoding", sizeof("Content-Encoding"));
171 } else {
172 zval_ptr_dtor(&h);
173 }
174 }
175
176 /* default */
177 MAKE_STD_ZVAL(h);
178 ZVAL_LONG(h, 0);
179 zend_hash_update(&(*message)->hdrs, "Content-Length", sizeof("Content-Length"), &h, sizeof(zval *), NULL);
180
181 if (h_te) {
182 if (strstr(Z_STRVAL_PP(h_te), "chunked")) {
183 parser->dechunk = php_http_encoding_stream_init(parser->dechunk, php_http_encoding_stream_get_dechunk_ops(), 0 TSRMLS_CC);
184 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_CHUNKED);
185 break;
186 }
187 }
188
189 if (h_cl) {
190 char *stop;
191
192 parser->body_length = strtoul(Z_STRVAL_PP(h_cl), &stop, 10);
193
194 if (stop != Z_STRVAL_PP(h_cl)) {
195 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_LENGTH);
196 break;
197 }
198 }
199
200 if (h_cr) {
201 ulong total = 0, start = 0, end = 0;
202
203 if (!strncasecmp(Z_STRVAL_PP(h_cr), "bytes", lenof("bytes"))
204 && ( Z_STRVAL_P(h)[lenof("bytes")] == ':'
205 || Z_STRVAL_P(h)[lenof("bytes")] == ' '
206 || Z_STRVAL_P(h)[lenof("bytes")] == '='
207 )
208 ) {
209 char *total_at = NULL, *end_at = NULL;
210 char *start_at = Z_STRVAL_PP(h_cr) + sizeof("bytes");
211
212 start = strtoul(start_at, &end_at, 10);
213 if (end_at) {
214 end = strtoul(end_at + 1, &total_at, 10);
215 if (total_at && strncmp(total_at + 1, "*", 1)) {
216 total = strtoul(total_at + 1, NULL, 10);
217 }
218
219 if (end >= start && (!total || end < total)) {
220 parser->body_length = end + 1 - start;
221 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_LENGTH);
222 break;
223 }
224 }
225 }
226 }
227
228
229 if ((*message)->type == PHP_HTTP_REQUEST) {
230 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_DONE);
231 } else {
232 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DUMB);
233 }
234 break;
235 }
236
237 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY:
238 {
239 zval *zcl;
240
241 if (parser->inflate) {
242 char *dec_str = NULL;
243 size_t dec_len;
244
245 if (SUCCESS != php_http_encoding_stream_update(parser->inflate, str, len, &dec_str, &dec_len TSRMLS_CC)) {
246 return php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_FAILURE);
247 }
248
249 if (str != buffer->data) {
250 STR_FREE(str);
251 }
252 str = dec_str;
253 len = dec_len;
254 }
255
256 php_stream_write(php_http_message_body_stream(&(*message)->body), str, len);
257 php_http_buffer_cut(buffer, 0, cut);
258
259 /* keep track */
260 MAKE_STD_ZVAL(zcl);
261 ZVAL_LONG(zcl, php_http_message_body_size(&(*message)->body));
262 zend_hash_update(&(*message)->hdrs, "Content-Length", sizeof("Content-Length"), &zcl, sizeof(zval *), NULL);
263
264 if (str != buffer->data) {
265 STR_FREE(str);
266 }
267 str = NULL;
268 len = 0;
269 cut = 0;
270 break;
271 }
272
273 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DUMB:
274 {
275 str = buffer->data;
276 len = buffer->used;
277 cut = len;
278
279 php_http_message_parser_state_push(parser, 2, !buffer->used?PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DONE:PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DUMB, PHP_HTTP_MESSAGE_PARSER_STATE_BODY);
280 break;
281 }
282
283 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_LENGTH:
284 {
285 len = MIN(parser->body_length, buffer->used);
286 str = buffer->data;
287 cut = len;
288
289 parser->body_length -= len;
290
291 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);
292 break;
293 }
294
295 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_CHUNKED:
296 {
297 /*
298 * - pass available data through the dechunk stream
299 * - pass decoded data along
300 * - if stream zeroed:
301 * Y: - cut processed string out of buffer, but leave length of unprocessed dechunk stream data untouched
302 * - body done
303 * N: - parse ahaed
304 */
305 char *dec_str = NULL;
306 size_t dec_len;
307
308 if (SUCCESS != php_http_encoding_stream_update(parser->dechunk, buffer->data, buffer->used, &dec_str, &dec_len TSRMLS_CC)) {
309 return FAILURE;
310 }
311
312 str = dec_str;
313 len = dec_len;
314
315 if (php_http_encoding_stream_done(parser->dechunk)) {
316 cut = buffer->used - PHP_HTTP_BUFFER_LEN(parser->dechunk->ctx);
317 php_http_message_parser_state_push(parser, 2, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DONE, PHP_HTTP_MESSAGE_PARSER_STATE_BODY);
318 } else {
319 cut = buffer->used;
320 php_http_message_parser_state_push(parser, 2, PHP_HTTP_MESSAGE_PARSER_STATE_BODY_CHUNKED, PHP_HTTP_MESSAGE_PARSER_STATE_BODY);
321 }
322 break;
323 }
324
325 case PHP_HTTP_MESSAGE_PARSER_STATE_BODY_DONE:
326 {
327 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_DONE);
328
329 if (parser->dechunk) {
330 char *dec_str = NULL;
331 size_t dec_len;
332
333 if (SUCCESS != php_http_encoding_stream_finish(parser->dechunk, &dec_str, &dec_len TSRMLS_CC)) {
334 return php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_FAILURE);
335 }
336 php_http_encoding_stream_dtor(parser->dechunk);
337
338 if (dec_str && dec_len) {
339 str = dec_str;
340 len = dec_len;
341 cut = 0;
342 php_http_message_parser_state_push(parser, 1, PHP_HTTP_MESSAGE_PARSER_STATE_BODY);
343 }
344 }
345
346 break;
347 }
348
349 case PHP_HTTP_MESSAGE_PARSER_STATE_DONE: {
350 char *ptr = buffer->data;
351
352 while (ptr - buffer->data < buffer->used && PHP_HTTP_IS_CTYPE(space, *ptr)) {
353 ++ptr;
354 }
355
356 php_http_buffer_cut(buffer, 0, ptr - buffer->data);
357 break;
358 }
359 }
360 }
361
362 return php_http_message_parser_state_is(parser);
363 }