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