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