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