- simplify
[m6w6/ext-http] / http.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-2006, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
11 */
12
13 /* $Id$ */
14
15 #define HTTP_WANT_SAPI
16 #define HTTP_WANT_CURL
17 #define HTTP_WANT_ZLIB
18 #define HTTP_WANT_MAGIC
19 #include "php_http.h"
20
21 #include "php_ini.h"
22 #include "ext/standard/info.h"
23 #include "zend_extensions.h"
24
25 #include "php_http_api.h"
26 #include "php_http_send_api.h"
27 #include "php_http_cookie_api.h"
28 #include "php_http_cache_api.h"
29 #include "php_http_send_api.h"
30 #include "php_http_message_api.h"
31 #include "php_http_request_method_api.h"
32 #ifdef HTTP_HAVE_CURL
33 # include "php_http_request_api.h"
34 # include "php_http_request_pool_api.h"
35 # include "php_http_request_datashare_api.h"
36 # ifdef HTTP_HAVE_PERSISTENT_HANDLES
37 # include "php_http_persistent_handle_api.h"
38 # endif
39 #endif
40 #ifdef HTTP_HAVE_ZLIB
41 # include "php_http_encoding_api.h"
42 #endif
43 #include "php_http_url_api.h"
44
45 #ifdef ZEND_ENGINE_2
46 # include "php_http_filter_api.h"
47 # include "php_http_util_object.h"
48 # include "php_http_message_object.h"
49 # include "php_http_querystring_object.h"
50 # ifndef WONKY
51 # include "php_http_response_object.h"
52 # endif
53 # ifdef HTTP_HAVE_CURL
54 # include "php_http_request_object.h"
55 # include "php_http_requestpool_object.h"
56 # include "php_http_requestdatashare_object.h"
57 # endif
58 # ifdef HTTP_HAVE_ZLIB
59 # include "php_http_deflatestream_object.h"
60 # include "php_http_inflatestream_object.h"
61 # endif
62 # include "php_http_exception_object.h"
63 #endif
64
65
66 ZEND_DECLARE_MODULE_GLOBALS(http);
67 HTTP_DECLARE_ARG_PASS_INFO();
68
69 #ifdef COMPILE_DL_HTTP
70 ZEND_GET_MODULE(http)
71 #endif
72
73 /* {{{ http_functions[] */
74 zend_function_entry http_functions[] = {
75 PHP_FE(http_date, NULL)
76 PHP_FE(http_build_url, http_arg_pass_ref_4)
77 PHP_FE(http_build_str, NULL)
78 #ifndef ZEND_ENGINE_2
79 PHP_FALIAS(http_build_query, http_build_str, NULL)
80 #endif
81 PHP_FE(http_negotiate_language, http_arg_pass_ref_2)
82 PHP_FE(http_negotiate_charset, http_arg_pass_ref_2)
83 PHP_FE(http_negotiate_content_type, http_arg_pass_ref_2)
84 PHP_FE(http_redirect, NULL)
85 PHP_FE(http_throttle, NULL)
86 PHP_FE(http_send_status, NULL)
87 PHP_FE(http_send_last_modified, NULL)
88 PHP_FE(http_send_content_type, NULL)
89 PHP_FE(http_send_content_disposition, NULL)
90 PHP_FE(http_match_modified, NULL)
91 PHP_FE(http_match_etag, NULL)
92 PHP_FE(http_cache_last_modified, NULL)
93 PHP_FE(http_cache_etag, NULL)
94 PHP_FE(http_send_data, NULL)
95 PHP_FE(http_send_file, NULL)
96 PHP_FE(http_send_stream, NULL)
97 PHP_FE(http_chunked_decode, NULL)
98 PHP_FE(http_parse_message, NULL)
99 PHP_FE(http_parse_headers, NULL)
100 PHP_FE(http_parse_cookie, NULL)
101 PHP_FE(http_build_cookie, NULL)
102 PHP_FE(http_parse_params, NULL)
103 PHP_FE(http_get_request_headers, NULL)
104 PHP_FE(http_get_request_body, NULL)
105 PHP_FE(http_get_request_body_stream, NULL)
106 PHP_FE(http_match_request_header, NULL)
107 #ifdef HTTP_HAVE_CURL
108 # ifdef HTTP_HAVE_PERSISTENT_HANDLES
109 PHP_FE(http_persistent_handles_count, NULL)
110 PHP_FE(http_persistent_handles_clean, NULL)
111 # endif
112 PHP_FE(http_get, http_arg_pass_ref_3)
113 PHP_FE(http_head, http_arg_pass_ref_3)
114 PHP_FE(http_post_data, http_arg_pass_ref_4)
115 PHP_FE(http_post_fields, http_arg_pass_ref_5)
116 PHP_FE(http_put_data, http_arg_pass_ref_4)
117 PHP_FE(http_put_file, http_arg_pass_ref_4)
118 PHP_FE(http_put_stream, http_arg_pass_ref_4)
119 PHP_FE(http_request, http_arg_pass_ref_5)
120 PHP_FE(http_request_body_encode, NULL)
121 #endif
122 PHP_FE(http_request_method_register, NULL)
123 PHP_FE(http_request_method_unregister, NULL)
124 PHP_FE(http_request_method_exists, NULL)
125 PHP_FE(http_request_method_name, NULL)
126 PHP_FE(ob_etaghandler, NULL)
127 #ifdef HTTP_HAVE_ZLIB
128 PHP_FE(http_deflate, NULL)
129 PHP_FE(http_inflate, NULL)
130 PHP_FE(ob_deflatehandler, NULL)
131 PHP_FE(ob_inflatehandler, NULL)
132 #endif
133 PHP_FE(http_support, NULL)
134
135 EMPTY_FUNCTION_ENTRY
136 };
137 /* }}} */
138
139 PHP_MINIT_FUNCTION(http);
140 PHP_MSHUTDOWN_FUNCTION(http);
141 PHP_RINIT_FUNCTION(http);
142 PHP_RSHUTDOWN_FUNCTION(http);
143 PHP_MINFO_FUNCTION(http);
144
145 /* {{{ http_module_dep */
146 #if ZEND_EXTENSION_API_NO >= 220050617
147 static zend_module_dep http_module_deps[] = {
148 # ifdef HTTP_HAVE_SPL
149 ZEND_MOD_REQUIRED("spl")
150 # endif
151 # ifdef HTTP_HAVE_HASH
152 ZEND_MOD_REQUIRED("hash")
153 # endif
154 # ifdef HTTP_HAVE_SESSION
155 ZEND_MOD_REQUIRED("session")
156 # endif
157 # ifdef HTTP_HAVE_ICONV
158 ZEND_MOD_REQUIRED("iconv")
159 # endif
160 {NULL, NULL, NULL, 0}
161 };
162 #endif
163 /* }}} */
164
165 /* {{{ http_module_entry */
166 zend_module_entry http_module_entry = {
167 #if ZEND_EXTENSION_API_NO >= 220050617
168 STANDARD_MODULE_HEADER_EX, NULL,
169 http_module_deps,
170 #else
171 STANDARD_MODULE_HEADER,
172 #endif
173 "http",
174 http_functions,
175 PHP_MINIT(http),
176 PHP_MSHUTDOWN(http),
177 PHP_RINIT(http),
178 PHP_RSHUTDOWN(http),
179 PHP_MINFO(http),
180 PHP_EXT_HTTP_VERSION,
181 STANDARD_MODULE_PROPERTIES
182 };
183 /* }}} */
184
185 int http_module_number;
186
187 /* {{{ http_globals */
188 static void http_globals_init_once(zend_http_globals *G)
189 {
190 memset(G, 0, sizeof(zend_http_globals));
191 }
192
193 #define http_globals_init(g) _http_globals_init((g) TSRMLS_CC)
194 static inline void _http_globals_init(zend_http_globals *G TSRMLS_DC)
195 {
196 #ifdef HTTP_HAVE_SAPI_RTIME
197 G->request.time = sapi_get_request_time(TSRMLS_C);
198 #else
199 G->request.time = time(NULL);
200 #endif
201 G->send.buffer_size = 0;
202 G->send.not_found_404 = 1;
203 G->read_post_data = 0;
204 }
205
206 #define http_globals_free(g) _http_globals_free((g) TSRMLS_CC)
207 static inline void _http_globals_free(zend_http_globals *G TSRMLS_DC)
208 {
209 if (G->request.headers) {
210 zend_hash_destroy(G->request.headers);
211 FREE_HASHTABLE(G->request.headers);
212 G->request.headers = NULL;
213 }
214 STR_SET(G->send.content_type, NULL);
215 STR_SET(G->send.unquoted_etag, NULL);
216 if (G->server_var) {
217 zval_ptr_dtor(&G->server_var);
218 G->server_var = NULL;
219 }
220 }
221 /* }}} */
222
223 /* {{{ static inline void http_check_allowed_methods(char *, int) */
224 #define http_check_allowed_methods(m, l) _http_check_allowed_methods((m), (l) TSRMLS_CC)
225 static inline void _http_check_allowed_methods(char *methods, int length TSRMLS_DC)
226 {
227 if (length && SG(request_info).request_method) {
228 if (SUCCESS != http_check_method_ex(SG(request_info).request_method, methods)) {
229 char *header = emalloc(length + sizeof("Allow: "));
230 sprintf(header, "Allow: %s", methods);
231 http_exit(405, header);
232 }
233 }
234 }
235 /* }}} */
236
237 /* {{{ PHP_INI */
238 PHP_INI_MH(http_update_allowed_methods)
239 {
240 http_check_allowed_methods(new_value, new_value_length);
241 return OnUpdateString(entry, new_value, new_value_length, mh_arg1, mh_arg2, mh_arg3, stage TSRMLS_CC);
242 }
243
244 #ifndef ZEND_ENGINE_2
245 # define OnUpdateLong OnUpdateInt
246 #endif
247
248 PHP_INI_BEGIN()
249 HTTP_PHP_INI_ENTRY("http.etag.mode", "MD5", PHP_INI_ALL, OnUpdateString, etag.mode)
250 HTTP_PHP_INI_ENTRY("http.log.cache", "", PHP_INI_ALL, OnUpdateString, log.cache)
251 HTTP_PHP_INI_ENTRY("http.log.redirect", "", PHP_INI_ALL, OnUpdateString, log.redirect)
252 HTTP_PHP_INI_ENTRY("http.log.not_found", "", PHP_INI_ALL, OnUpdateString, log.not_found)
253 HTTP_PHP_INI_ENTRY("http.log.allowed_methods", "", PHP_INI_ALL, OnUpdateString, log.allowed_methods)
254 HTTP_PHP_INI_ENTRY("http.log.composite", "", PHP_INI_ALL, OnUpdateString, log.composite)
255 HTTP_PHP_INI_ENTRY("http.request.methods.allowed", "", PHP_INI_ALL, http_update_allowed_methods, request.methods.allowed)
256 HTTP_PHP_INI_ENTRY("http.request.methods.custom", "", PHP_INI_PERDIR|PHP_INI_SYSTEM, OnUpdateString, request.methods.custom.ini)
257 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
258 HTTP_PHP_INI_ENTRY("http.request.datashare.cookie", "0", PHP_INI_SYSTEM, OnUpdateBool, request.datashare.cookie)
259 HTTP_PHP_INI_ENTRY("http.request.datashare.dns", "1", PHP_INI_SYSTEM, OnUpdateBool, request.datashare.dns)
260 HTTP_PHP_INI_ENTRY("http.request.datashare.ssl", "0", PHP_INI_SYSTEM, OnUpdateBool, request.datashare.ssl)
261 HTTP_PHP_INI_ENTRY("http.request.datashare.connect", "0", PHP_INI_SYSTEM, OnUpdateBool, request.datashare.connect)
262 #endif
263 #ifdef HTTP_HAVE_ZLIB
264 HTTP_PHP_INI_ENTRY("http.send.inflate.start_auto", "0", PHP_INI_PERDIR|PHP_INI_SYSTEM, OnUpdateBool, send.inflate.start_auto)
265 HTTP_PHP_INI_ENTRY("http.send.inflate.start_flags", "0", PHP_INI_ALL, OnUpdateLong, send.inflate.start_flags)
266 HTTP_PHP_INI_ENTRY("http.send.deflate.start_auto", "0", PHP_INI_PERDIR|PHP_INI_SYSTEM, OnUpdateBool, send.deflate.start_auto)
267 HTTP_PHP_INI_ENTRY("http.send.deflate.start_flags", "0", PHP_INI_ALL, OnUpdateLong, send.deflate.start_flags)
268 #endif
269 HTTP_PHP_INI_ENTRY("http.send.not_found_404", "1", PHP_INI_ALL, OnUpdateBool, send.not_found_404)
270 #ifdef ZEND_ENGINE_2
271 HTTP_PHP_INI_ENTRY("http.only_exceptions", "0", PHP_INI_ALL, OnUpdateBool, only_exceptions)
272 #endif
273 HTTP_PHP_INI_ENTRY("http.force_exit", "1", PHP_INI_ALL, OnUpdateBool, force_exit)
274 PHP_INI_END()
275 /* }}} */
276
277 /* {{{ PHP_MINIT_FUNCTION */
278 PHP_MINIT_FUNCTION(http)
279 {
280 http_module_number = module_number;
281
282 ZEND_INIT_MODULE_GLOBALS(http, http_globals_init_once, NULL)
283
284 REGISTER_INI_ENTRIES();
285
286 if ( (SUCCESS != PHP_MINIT_CALL(http_support)) ||
287 (SUCCESS != PHP_MINIT_CALL(http_cookie)) ||
288 (SUCCESS != PHP_MINIT_CALL(http_send)) ||
289 (SUCCESS != PHP_MINIT_CALL(http_url)) ||
290 #ifdef HTTP_HAVE_CURL
291 # ifdef HTTP_HAVE_PERSISTENT_HANDLES
292 (SUCCESS != PHP_MINIT_CALL(http_persistent_handle)) ||
293 (SUCCESS != PHP_MINIT_CALL(http_request_pool)) ||
294 # endif
295 (SUCCESS != PHP_MINIT_CALL(http_request)) ||
296 # ifdef ZEND_ENGINE_2
297 (SUCCESS != PHP_MINIT_CALL(http_request_datashare)) ||
298 # endif
299 #endif /* HTTP_HAVE_CURL */
300 #ifdef HTTP_HAVE_ZLIB
301 (SUCCESS != PHP_MINIT_CALL(http_encoding)) ||
302 #endif
303 (SUCCESS != PHP_MINIT_CALL(http_request_method))) {
304 return FAILURE;
305 }
306
307 #ifdef ZEND_ENGINE_2
308 if ( (SUCCESS != PHP_MINIT_CALL(http_filter)) ||
309 (SUCCESS != PHP_MINIT_CALL(http_util_object)) ||
310 (SUCCESS != PHP_MINIT_CALL(http_message_object)) ||
311 (SUCCESS != PHP_MINIT_CALL(http_querystring_object))||
312 # ifndef WONKY
313 (SUCCESS != PHP_MINIT_CALL(http_response_object)) ||
314 # endif /* WONKY */
315 # ifdef HTTP_HAVE_CURL
316 (SUCCESS != PHP_MINIT_CALL(http_request_object)) ||
317 (SUCCESS != PHP_MINIT_CALL(http_requestpool_object))||
318 (SUCCESS != PHP_MINIT_CALL(http_requestdatashare_object))||
319 # endif /* HTTP_HAVE_CURL */
320 # ifdef HTTP_HAVE_ZLIB
321 (SUCCESS != PHP_MINIT_CALL(http_deflatestream_object)) ||
322 (SUCCESS != PHP_MINIT_CALL(http_inflatestream_object)) ||
323 # endif /* HTTP_HAVE_ZLIB */
324 (SUCCESS != PHP_MINIT_CALL(http_exception_object))) {
325 return FAILURE;
326 }
327 #endif /* ZEND_ENGINE_2 */
328
329 return SUCCESS;
330 }
331 /* }}} */
332
333 /* {{{ PHP_MSHUTDOWN_FUNCTION */
334 PHP_MSHUTDOWN_FUNCTION(http)
335 {
336 UNREGISTER_INI_ENTRIES();
337 #ifdef HTTP_HAVE_CURL
338 if (
339 # ifdef ZEND_ENGINE_2
340 (SUCCESS != PHP_MSHUTDOWN_CALL(http_request_datashare)) ||
341 # endif
342 (SUCCESS != PHP_MSHUTDOWN_CALL(http_request))
343 # ifdef HTTP_HAVE_PERSISTENT_HANDLES
344 || (SUCCESS != PHP_MSHUTDOWN_CALL(http_persistent_handle))
345 # endif
346 ) {
347 return FAILURE;
348 }
349 #endif
350 return SUCCESS;
351 }
352 /* }}} */
353
354 /* {{{ PHP_RINIT_FUNCTION */
355 PHP_RINIT_FUNCTION(http)
356 {
357 http_globals_init(HTTP_G);
358
359 if (HTTP_G->request.methods.allowed) {
360 http_check_allowed_methods(HTTP_G->request.methods.allowed,
361 strlen(HTTP_G->request.methods.allowed));
362 }
363
364 if ( (SUCCESS != PHP_RINIT_CALL(http_request_method))
365 #ifdef HTTP_HAVE_ZLIB
366 || (SUCCESS != PHP_RINIT_CALL(http_encoding))
367 #endif
368 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
369 || (SUCCESS != PHP_RINIT_CALL(http_request_datashare))
370 #endif
371 ) {
372 return FAILURE;
373 }
374
375 return SUCCESS;
376 }
377 /* }}} */
378
379 /* {{{ PHP_RSHUTDOWN_FUNCTION */
380 PHP_RSHUTDOWN_FUNCTION(http)
381 {
382 STATUS status = SUCCESS;
383
384 if ( (SUCCESS != PHP_RSHUTDOWN_CALL(http_request_method))
385 #ifdef HTTP_HAVE_ZLIB
386 || (SUCCESS != PHP_RSHUTDOWN_CALL(http_encoding))
387 #endif
388 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
389 || (SUCCESS != PHP_RSHUTDOWN_CALL(http_request_datashare))
390 #endif
391 ) {
392 status = FAILURE;
393 }
394
395 http_globals_free(HTTP_G);
396 return status;
397 }
398 /* }}} */
399
400 /* {{{ PHP_MINFO_FUNCTION */
401 PHP_MINFO_FUNCTION(http)
402 {
403 php_info_print_table_start();
404 {
405 php_info_print_table_row(2, "HTTP Support", "enabled");
406 php_info_print_table_row(2, "Extension Version", PHP_EXT_HTTP_VERSION);
407 php_info_print_table_row(2, "Registered Classes",
408 #ifndef ZEND_ENGINE_2
409 "none"
410 #else
411 "HttpUtil, "
412 "HttpMessage, "
413 # ifdef HTTP_HAVE_CURL
414 "HttpRequest, "
415 "HttpRequestPool, "
416 "HttpRequestDataShare, "
417 # endif
418 # ifdef HTTP_HAVE_ZLIB
419 "HttpDeflateStream, "
420 "HttpInflateStream, "
421 # endif
422 # ifndef WONKY
423 "HttpResponse, "
424 # endif
425 "HttpQueryString"
426 #endif
427 );
428 php_info_print_table_row(2, "Output Handlers", "ob_deflatehandler, ob_inflatehandler, ob_etaghandler");
429 php_info_print_table_row(2, "Stream Filters",
430 #ifndef ZEND_ENGINE_2
431 "none"
432 #else
433 "http.chunked_decode, http.chunked_encode, http.deflate, http.inflate"
434 #endif
435 );
436 #ifdef HTTP_HAVE_PERSISTENT_HANDLES
437 {
438 phpstr s;
439 HashTable *ht;
440 HashPosition pos;
441 HashKey key = initHashKey(0);
442 zval **val;
443
444 if ((ht = http_persistent_handle_statall())) {
445 phpstr_init(&s);
446
447 FOREACH_HASH_KEYVAL(pos, ht, key, val) {
448 phpstr_appendf(&s, "%s (%ld), ", key.str, Z_LVAL_PP(val));
449 }
450 zend_hash_destroy(ht);
451 FREE_HASHTABLE(ht);
452
453 PHPSTR_LEN(&s) -= 2; /* get rid of last ", " */
454 phpstr_fix(&s);
455
456 php_info_print_table_row(2, "Persistent Handles", PHPSTR_VAL(&s));
457 phpstr_dtor(&s);
458 } else {
459 php_info_print_table_row(2, "Persistent Handles", "none");
460 }
461 }
462 #else
463 php_info_print_table_row(2, "Persistent Handles", "disabled");
464 #endif
465 }
466 php_info_print_table_end();
467
468 php_info_print_table_start();
469 php_info_print_table_header(3, "Used Library", "Compiled", "Linked");
470 {
471 #ifdef HTTP_HAVE_CURL
472 curl_version_info_data *cv = curl_version_info(CURLVERSION_NOW);
473 php_info_print_table_row(3, "libcurl", LIBCURL_VERSION, cv->version);
474 #else
475 php_info_print_table_row(2, "libcurl", "disabled", "disabled");
476 #endif
477 #ifdef HTTP_HAVE_ZLIB
478 php_info_print_table_row(3, "libz", ZLIB_VERSION, zlibVersion());
479 #else
480 php_info_print_table_row(3, "libz", "disabled", "disabled");
481 #endif
482 #if defined(HTTP_HAVE_MAGIC) && !defined(WONKY)
483 php_info_print_table_row(3, "libmagic", "unknown", "unknown");
484 #else
485 php_info_print_table_row(3, "libmagic", "disabled", "disabled");
486 #endif
487 }
488 php_info_print_table_end();
489
490 php_info_print_table_start();
491 php_info_print_table_colspan_header(2, "Request Methods");
492 {
493 int i;
494 phpstr *custom_request_methods = phpstr_new();
495 phpstr *known_request_methods = phpstr_from_string(HTTP_KNOWN_METHODS, lenof(HTTP_KNOWN_METHODS));
496 http_request_method_entry **ptr = HTTP_G->request.methods.custom.entries;
497
498 for (i = 0; i < HTTP_G->request.methods.custom.count; ++i) {
499 if (ptr[i]) {
500 phpstr_appendf(custom_request_methods, "%s, ", ptr[i]->name);
501 }
502 }
503
504 phpstr_append(known_request_methods, PHPSTR_VAL(custom_request_methods), PHPSTR_LEN(custom_request_methods));
505 phpstr_fix(known_request_methods);
506 phpstr_fix(custom_request_methods);
507
508 php_info_print_table_row(2, "Known", PHPSTR_VAL(known_request_methods));
509 php_info_print_table_row(2, "Custom",
510 PHPSTR_LEN(custom_request_methods) ? PHPSTR_VAL(custom_request_methods) : "none registered");
511 php_info_print_table_row(2, "Allowed", strlen(HTTP_G->request.methods.allowed) ? HTTP_G->request.methods.allowed : "(ANY)");
512
513 phpstr_free(&known_request_methods);
514 phpstr_free(&custom_request_methods);
515 }
516 php_info_print_table_end();
517
518 DISPLAY_INI_ENTRIES();
519 }
520 /* }}} */
521
522 /*
523 * Local variables:
524 * tab-width: 4
525 * c-basic-offset: 4
526 * End:
527 * vim600: noet sw=4 ts=4 fdm=marker
528 * vim<600: noet sw=4 ts=4
529 */
530