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