- add ob_(deflate|inflate)handler
[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-2005, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
11 */
12
13 /* $Id$ */
14
15 #ifdef HAVE_CONFIG_H
16 # include "config.h"
17 #endif
18
19 #define HTTP_WANT_CURL
20 #define HTTP_WANT_ZLIB
21 #define HTTP_WANT_MAGIC
22 #include "php_http.h"
23
24 #include "SAPI.h"
25 #include "php_ini.h"
26 #include "ext/standard/info.h"
27 #include "zend_extensions.h"
28
29 #include "php_http_api.h"
30 #include "php_http_send_api.h"
31 #include "php_http_cache_api.h"
32 #include "php_http_headers_api.h"
33 #include "php_http_message_api.h"
34 #include "php_http_request_method_api.h"
35 #ifdef HTTP_HAVE_CURL
36 # include "php_http_request_api.h"
37 #endif
38 #ifdef HTTP_HAVE_ZLIB
39 # include "php_http_encoding_api.h"
40 #endif
41
42 #ifdef ZEND_ENGINE_2
43 # include "php_http_filter_api.h"
44 # include "php_http_util_object.h"
45 # include "php_http_message_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 # 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_match_request_header, NULL)
92 #ifdef HTTP_HAVE_CURL
93 PHP_FE(http_get, http_arg_pass_ref_3)
94 PHP_FE(http_head, http_arg_pass_ref_3)
95 PHP_FE(http_post_data, http_arg_pass_ref_4)
96 PHP_FE(http_post_fields, http_arg_pass_ref_5)
97 PHP_FE(http_put_file, http_arg_pass_ref_4)
98 PHP_FE(http_put_stream, http_arg_pass_ref_4)
99 #endif
100 PHP_FE(http_request_method_register, NULL)
101 PHP_FE(http_request_method_unregister, NULL)
102 PHP_FE(http_request_method_exists, NULL)
103 PHP_FE(http_request_method_name, NULL)
104 #ifndef ZEND_ENGINE_2
105 PHP_FE(http_build_query, NULL)
106 #endif
107 PHP_FE(ob_etaghandler, NULL)
108 #ifdef HTTP_HAVE_ZLIB
109 PHP_FE(http_deflate, NULL)
110 PHP_FE(http_inflate, NULL)
111 PHP_FE(ob_deflatehandler, NULL)
112 PHP_FE(ob_inflatehandler, NULL)
113 #endif
114 PHP_FE(http_support, NULL)
115
116 EMPTY_FUNCTION_ENTRY
117 };
118 /* }}} */
119
120 /* {{{ http_module_dep */
121 #if ZEND_EXTENSION_API_NO >= 220050617
122 static zend_module_dep http_module_dep[] = {
123 # ifdef HAVE_SPL
124 ZEND_MOD_REQUIRED("spl")
125 # endif
126 # ifdef HTTP_HAVE_EXT_HASH
127 ZEND_MOD_REQUIRED("hash")
128 # endif
129 {NULL, NULL, NULL, 0}
130 };
131 #endif
132 /* }}} */
133
134 /* {{{ http_module_entry */
135 zend_module_entry http_module_entry = {
136 #if ZEND_EXTENSION_API_NO >= 220050617
137 STANDARD_MODULE_HEADER_EX, NULL,
138 http_module_dep,
139 #else
140 STANDARD_MODULE_HEADER,
141 #endif
142 "http",
143 http_functions,
144 PHP_MINIT(http),
145 PHP_MSHUTDOWN(http),
146 PHP_RINIT(http),
147 PHP_RSHUTDOWN(http),
148 PHP_MINFO(http),
149 PHP_EXT_HTTP_VERSION,
150 STANDARD_MODULE_PROPERTIES
151 };
152 /* }}} */
153
154 int http_module_number;
155
156 /* {{{ http_globals */
157 static void http_globals_init_once(zend_http_globals *G)
158 {
159 memset(G, 0, sizeof(zend_http_globals));
160 }
161
162 #define http_globals_init(g) _http_globals_init((g) TSRMLS_CC)
163 static inline void _http_globals_init(zend_http_globals *G TSRMLS_DC)
164 {
165 G->send.buffer_size = HTTP_SENDBUF_SIZE;
166 zend_hash_init(&G->request.methods.custom, 0, NULL, ZVAL_PTR_DTOR, 0);
167 }
168
169 #define http_globals_free(g) _http_globals_free((g) TSRMLS_CC)
170 static inline void _http_globals_free(zend_http_globals *G TSRMLS_DC)
171 {
172 STR_SET(G->send.content_type, NULL);
173 STR_SET(G->send.unquoted_etag, NULL);
174 zend_hash_destroy(&G->request.methods.custom);
175 }
176 /* }}} */
177
178 /* {{{ static inline void http_check_allowed_methods(char *, int) */
179 #define http_check_allowed_methods(m, l) _http_check_allowed_methods((m), (l) TSRMLS_CC)
180 static inline void _http_check_allowed_methods(char *methods, int length TSRMLS_DC)
181 {
182 if (length && SG(request_info).request_method) {
183 if (SUCCESS != http_check_method_ex(SG(request_info).request_method, methods)) {
184 char *header = emalloc(length + sizeof("Allow: "));
185 sprintf(header, "Allow: %s", methods);
186 http_exit(405, header);
187 }
188 }
189 }
190 /* }}} */
191
192 /* {{{ PHP_INI */
193 PHP_INI_MH(http_update_allowed_methods)
194 {
195 http_check_allowed_methods(new_value, new_value_length);
196 return OnUpdateString(entry, new_value, new_value_length, mh_arg1, mh_arg2, mh_arg3, stage TSRMLS_CC);
197 }
198
199 #ifndef ZEND_ENGINE_2
200 # define OnUpdateLong OnUpdateInt
201 #endif
202
203 PHP_INI_BEGIN()
204 HTTP_PHP_INI_ENTRY("http.allowed_methods", "", PHP_INI_ALL, http_update_allowed_methods, request.methods.allowed)
205 HTTP_PHP_INI_ENTRY("http.cache_log", "", PHP_INI_ALL, OnUpdateString, log.cache)
206 HTTP_PHP_INI_ENTRY("http.redirect_log", "", PHP_INI_ALL, OnUpdateString, log.redirect)
207 HTTP_PHP_INI_ENTRY("http.allowed_methods_log", "", PHP_INI_ALL, OnUpdateString, log.allowed_methods)
208 HTTP_PHP_INI_ENTRY("http.composite_log", "", PHP_INI_ALL, OnUpdateString, log.composite)
209 HTTP_PHP_INI_ENTRY("http.etag_mode", "MD5", PHP_INI_ALL, OnUpdateString, etag.mode)
210 #ifdef ZEND_ENGINE_2
211 HTTP_PHP_INI_ENTRY("http.only_exceptions", "0", PHP_INI_ALL, OnUpdateBool, only_exceptions)
212 #endif
213 HTTP_PHP_INI_ENTRY("http.force_exit", "1", PHP_INI_ALL, OnUpdateBool, force_exit)
214 #ifdef HTTP_HAVE_ZLIB
215 HTTP_PHP_INI_ENTRY("http.ob_inflate_auto", "0", PHP_INI_PERDIR, OnUpdateBool, send.inflate.start_auto)
216 HTTP_PHP_INI_ENTRY("http.ob_inflate_flags", "0", PHP_INI_ALL, OnUpdateLong, send.inflate.start_flags)
217 HTTP_PHP_INI_ENTRY("http.ob_deflate_auto", "0", PHP_INI_PERDIR, OnUpdateBool, send.deflate.start_auto)
218 HTTP_PHP_INI_ENTRY("http.ob_deflate_flags", "0", PHP_INI_ALL, OnUpdateLong, send.deflate.start_flags)
219 #endif
220 PHP_INI_END()
221 /* }}} */
222
223 /* {{{ PHP_MINIT_FUNCTION */
224 PHP_MINIT_FUNCTION(http)
225 {
226 http_module_number = module_number;
227
228 ZEND_INIT_MODULE_GLOBALS(http, http_globals_init_once, NULL)
229
230 REGISTER_INI_ENTRIES();
231
232 if ( (SUCCESS != PHP_MINIT_CALL(http_support)) ||
233 (SUCCESS != PHP_MINIT_CALL(http_headers)) ||
234 #ifdef HTTP_HAVE_CURL
235 (SUCCESS != PHP_MINIT_CALL(http_request)) ||
236 #endif /* HTTP_HAVE_CURL */
237 #ifdef HTTP_HAVE_ZLIB
238 (SUCCESS != PHP_MINIT_CALL(http_encoding)) ||
239 #endif
240 (SUCCESS != PHP_MINIT_CALL(http_request_method))) {
241 return FAILURE;
242 }
243
244 #ifdef ZEND_ENGINE_2
245 if ( (SUCCESS != PHP_MINIT_CALL(http_filter)) ||
246 (SUCCESS != PHP_MINIT_CALL(http_util_object)) ||
247 (SUCCESS != PHP_MINIT_CALL(http_message_object)) ||
248 # ifndef WONKY
249 (SUCCESS != PHP_MINIT_CALL(http_response_object)) ||
250 # endif /* WONKY */
251 # ifdef HTTP_HAVE_CURL
252 (SUCCESS != PHP_MINIT_CALL(http_request_object)) ||
253 (SUCCESS != PHP_MINIT_CALL(http_requestpool_object))||
254 # endif /* HTTP_HAVE_CURL */
255 (SUCCESS != PHP_MINIT_CALL(http_exception_object))) {
256 return FAILURE;
257 }
258 #endif /* ZEND_ENGINE_2 */
259
260 return SUCCESS;
261 }
262 /* }}} */
263
264 /* {{{ PHP_MSHUTDOWN_FUNCTION */
265 PHP_MSHUTDOWN_FUNCTION(http)
266 {
267 UNREGISTER_INI_ENTRIES();
268 #ifdef HTTP_HAVE_CURL
269 return PHP_MSHUTDOWN_CALL(http_request);
270 #endif
271 return SUCCESS;
272 }
273 /* }}} */
274
275 /* {{{ PHP_RINIT_FUNCTION */
276 PHP_RINIT_FUNCTION(http)
277 {
278 if (HTTP_G(request).methods.allowed) {
279 http_check_allowed_methods(HTTP_G(request).methods.allowed,
280 strlen(HTTP_G(request).methods.allowed));
281 }
282
283 http_globals_init(HTTP_GLOBALS);
284
285 #ifdef HTTP_HAVE_ZLIB
286 if (SUCCESS != PHP_RINIT_CALL(http_encoding)) {
287 return FAILURE;
288 }
289 #endif
290
291 return SUCCESS;
292 }
293 /* }}} */
294
295 /* {{{ PHP_RSHUTDOWN_FUNCTION */
296 PHP_RSHUTDOWN_FUNCTION(http)
297 {
298 STATUS status = SUCCESS;
299
300 if (
301 #ifdef HTTP_HAVE_ZLIB
302 (SUCCESS != PHP_RSHUTDOWN_CALL(http_encoding)) ||
303 #endif
304 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
305 (SUCCESS != PHP_RSHUTDOWN_CALL(http_request_method)) ||
306 #endif
307 0) {
308 status = FAILURE;
309 }
310
311 http_globals_free(HTTP_GLOBALS);
312 return status;
313 }
314 /* }}} */
315
316 /* {{{ PHP_MINFO_FUNCTION */
317 PHP_MINFO_FUNCTION(http)
318 {
319 php_info_print_table_start();
320 {
321 php_info_print_table_row(2, "Extended HTTP support", "enabled");
322 php_info_print_table_row(2, "Extension Version", PHP_EXT_HTTP_VERSION);
323 #ifdef HTTP_HAVE_CURL
324 php_info_print_table_row(2, "cURL HTTP Requests", curl_version());
325 #else
326 php_info_print_table_row(2, "cURL HTTP Requests", "disabled");
327 #endif
328 #ifdef HTTP_HAVE_ZLIB
329 {
330 char my_zlib_version[64] = {0};
331
332 strlcat(my_zlib_version, "zlib/", 63);
333 strlcat(my_zlib_version, zlibVersion(), 63);
334 php_info_print_table_row(2, "zlib GZIP Encodings", my_zlib_version);
335 }
336 #else
337 php_info_print_table_row(2, "zlib GZIP Encodings", "disabled");
338 #endif
339 #if defined(HTTP_HAVE_MAGIC) && !defined(WONKY)
340 php_info_print_table_row(2, "magic MIME Guessing", "libmagic/unknown");
341 #else
342 php_info_print_table_row(2, "magic MIME Guessing", "disabled");
343 #endif
344 php_info_print_table_row(2, "Registered Classes",
345 #ifndef ZEND_ENGINE_2
346 "none"
347 #else
348 "HttpUtil, "
349 "HttpMessage, "
350 # ifdef HTTP_HAVE_CURL
351 "HttpRequest, "
352 "HttpRequestPool, "
353 # endif
354 # ifndef WONKY
355 "HttpResponse"
356 # endif
357 #endif
358 );
359 }
360 php_info_print_table_end();
361
362 php_info_print_table_start();
363 php_info_print_table_colspan_header(2, "Request Methods");
364 {
365 unsigned i;
366 HashPosition pos;
367 zval **custom_method;
368 phpstr *known_request_methods = phpstr_new();
369 phpstr *custom_request_methods = phpstr_new();
370
371 for (i = HTTP_NO_REQUEST_METHOD+1; i < HTTP_MAX_REQUEST_METHOD; ++i) {
372 phpstr_appendl(known_request_methods, http_request_method_name(i));
373 phpstr_appends(known_request_methods, ", ");
374 }
375 FOREACH_HASH_VAL(pos, &HTTP_G(request).methods.custom, custom_method) {
376 phpstr_append(custom_request_methods, Z_STRVAL_PP(custom_method), Z_STRLEN_PP(custom_method));
377 phpstr_appends(custom_request_methods, ", ");
378 }
379
380 phpstr_append(known_request_methods, PHPSTR_VAL(custom_request_methods), PHPSTR_LEN(custom_request_methods));
381 phpstr_fix(known_request_methods);
382 phpstr_fix(custom_request_methods);
383
384 php_info_print_table_row(2, "Known", PHPSTR_VAL(known_request_methods));
385 php_info_print_table_row(2, "Custom",
386 PHPSTR_LEN(custom_request_methods) ? PHPSTR_VAL(custom_request_methods) : "none registered");
387 php_info_print_table_row(2, "Allowed", strlen(HTTP_G(request).methods.allowed) ? HTTP_G(request).methods.allowed : "(ANY)");
388
389 phpstr_free(&known_request_methods);
390 phpstr_free(&custom_request_methods);
391 }
392 php_info_print_table_end();
393
394 DISPLAY_INI_ENTRIES();
395 }
396 /* }}} */
397
398 /*
399 * Local variables:
400 * tab-width: 4
401 * c-basic-offset: 4
402 * End:
403 * vim600: noet sw=4 ts=4 fdm=marker
404 * vim<600: noet sw=4 ts=4
405 */
406