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