- release
[m6w6/ext-http] / http.c
1 /*
2 +----------------------------------------------------------------------+
3 | PECL :: http |
4 +----------------------------------------------------------------------+
5 | This source file is subject to version 3.0 of the PHP license, that |
6 | is bundled with this package in the file LICENSE, and is available |
7 | through the world-wide-web at http://www.php.net/license/3_0.txt. |
8 | If you did not receive a copy of the PHP license and are unable to |
9 | obtain it through the world-wide-web, please send a note to |
10 | license@php.net so we can mail you a copy immediately. |
11 +----------------------------------------------------------------------+
12 | Copyright (c) 2004-2005 Michael Wallner <mike@php.net> |
13 +----------------------------------------------------------------------+
14 */
15
16 /* $Id$ */
17
18
19 #ifdef HAVE_CONFIG_H
20 # include "config.h"
21 #endif
22 #include "php.h"
23
24 #include "SAPI.h"
25 #include "php_ini.h"
26 #include "ext/standard/info.h"
27
28 #include "php_http.h"
29 #include "php_http_std_defs.h"
30 #include "php_http_api.h"
31 #include "php_http_send_api.h"
32 #include "php_http_cache_api.h"
33 #ifdef HTTP_HAVE_CURL
34 # include "php_http_request_api.h"
35 #endif
36
37 #ifdef ZEND_ENGINE_2
38 # include "php_http_util_object.h"
39 # include "php_http_message_object.h"
40 # include "php_http_response_object.h"
41 # ifdef HTTP_HAVE_CURL
42 # include "php_http_request_object.h"
43 # include "php_http_requestpool_object.h"
44 # endif
45 # include "php_http_exception_object.h"
46 #endif
47
48 #include "missing.h"
49 #include "phpstr/phpstr.h"
50
51 #ifdef HTTP_HAVE_CURL
52 # ifdef PHP_WIN32
53 # include <winsock2.h>
54 # endif
55 # include <curl/curl.h>
56 #endif
57
58 #include <ctype.h>
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 function_entry http_functions[] = {
69 PHP_FE(http_test, NULL)
70 PHP_FE(http_date, NULL)
71 PHP_FE(http_absolute_uri, NULL)
72 PHP_FE(http_negotiate_language, NULL)
73 PHP_FE(http_negotiate_charset, NULL)
74 PHP_FE(http_redirect, NULL)
75 PHP_FE(http_throttle, NULL)
76 PHP_FE(http_send_status, NULL)
77 PHP_FE(http_send_last_modified, NULL)
78 PHP_FE(http_send_content_type, NULL)
79 PHP_FE(http_send_content_disposition, NULL)
80 PHP_FE(http_match_modified, NULL)
81 PHP_FE(http_match_etag, NULL)
82 PHP_FE(http_cache_last_modified, NULL)
83 PHP_FE(http_cache_etag, NULL)
84 PHP_FE(http_send_data, NULL)
85 PHP_FE(http_send_file, NULL)
86 PHP_FE(http_send_stream, NULL)
87 PHP_FE(http_chunked_decode, NULL)
88 PHP_FE(http_parse_message, NULL)
89 PHP_FE(http_parse_headers, NULL)
90 PHP_FE(http_get_request_headers, NULL)
91 PHP_FE(http_get_request_body, 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 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 #endif
105 #ifndef ZEND_ENGINE_2
106 PHP_FE(http_build_query, NULL)
107 #endif
108 PHP_FE(ob_etaghandler, NULL)
109 {NULL, NULL, NULL}
110 };
111 /* }}} */
112
113 /* {{{ http_module_entry */
114 zend_module_entry http_module_entry = {
115 #if ZEND_MODULE_API_NO >= 20010901
116 STANDARD_MODULE_HEADER,
117 #endif
118 "http",
119 http_functions,
120 PHP_MINIT(http),
121 PHP_MSHUTDOWN(http),
122 PHP_RINIT(http),
123 PHP_RSHUTDOWN(http),
124 PHP_MINFO(http),
125 #if ZEND_MODULE_API_NO >= 20010901
126 HTTP_PEXT_VERSION,
127 #endif
128 STANDARD_MODULE_PROPERTIES
129 };
130 /* }}} */
131
132 int http_module_number;
133
134 /* {{{ http_globals */
135 static void http_globals_init_once(zend_http_globals *G)
136 {
137 memset(G, 0, sizeof(zend_http_globals));
138 }
139
140 static inline void http_globals_init(zend_http_globals *G)
141 {
142 G->send.buffer_size = HTTP_SENDBUF_SIZE;
143 zend_hash_init(&G->request.methods.custom, 0, NULL, ZVAL_PTR_DTOR, 0);
144 #ifdef HTTP_HAVE_CURL
145 zend_llist_init(&G->request.copies.strings, sizeof(char *), http_request_data_free_string, 0);
146 zend_llist_init(&G->request.copies.slists, sizeof(struct curl_slist *), http_request_data_free_slist, 0);
147 zend_llist_init(&G->request.copies.contexts, sizeof(http_curl_callback_ctx *), http_request_data_free_context, 0);
148 zend_llist_init(&G->request.copies.convs, sizeof(http_curl_conv *), http_request_data_free_conv, 0);
149 #endif
150 }
151
152 static inline void http_globals_free(zend_http_globals *G)
153 {
154 STR_SET(G->send.content_type, NULL);
155 STR_SET(G->send.unquoted_etag, NULL);
156 zend_hash_destroy(&G->request.methods.custom);
157 #ifdef HTTP_HAVE_CURL
158 zend_llist_clean(&G->request.copies.strings);
159 zend_llist_clean(&G->request.copies.slists);
160 zend_llist_clean(&G->request.copies.contexts);
161 zend_llist_clean(&G->request.copies.convs);
162 #endif
163 }
164 /* }}} */
165
166 /* {{{ static inline void http_check_allowed_methods(char *, int) */
167 #define http_check_allowed_methods(m, l) _http_check_allowed_methods((m), (l) TSRMLS_CC)
168 static inline void _http_check_allowed_methods(char *methods, int length TSRMLS_DC)
169 {
170 if (length && SG(request_info).request_method) {
171 if (SUCCESS != http_check_method_ex(SG(request_info).request_method, methods)) {
172 char *header = emalloc(length + sizeof("Allow: "));
173 sprintf(header, "Allow: %s", methods);
174 http_exit(405, header);
175 }
176 }
177 }
178 /* }}} */
179
180 /* {{{ PHP_INI */
181 PHP_INI_MH(http_update_allowed_methods)
182 {
183 http_check_allowed_methods(new_value, new_value_length);
184 return OnUpdateString(entry, new_value, new_value_length, mh_arg1, mh_arg2, mh_arg3, stage TSRMLS_CC);
185 }
186
187 #ifndef ZEND_ENGINE_2
188 # define OnUpdateLong OnUpdateInt
189 #endif
190
191 PHP_INI_BEGIN()
192 HTTP_PHP_INI_ENTRY("http.allowed_methods", "", PHP_INI_ALL, http_update_allowed_methods, request.methods.allowed)
193 HTTP_PHP_INI_ENTRY("http.cache_log", "", PHP_INI_ALL, OnUpdateString, log.cache)
194 HTTP_PHP_INI_ENTRY("http.redirect_log", "", PHP_INI_ALL, OnUpdateString, log.redirect)
195 HTTP_PHP_INI_ENTRY("http.allowed_methods_log", "", PHP_INI_ALL, OnUpdateString, log.allowed_methods)
196 HTTP_PHP_INI_ENTRY("http.composite_log", "", PHP_INI_ALL, OnUpdateString, log.composite)
197 #ifdef ZEND_ENGINE_2
198 HTTP_PHP_INI_ENTRY("http.only_exceptions", "0", PHP_INI_ALL, OnUpdateBool, only_exceptions)
199 #endif
200 HTTP_PHP_INI_ENTRY("http.etag_mode", "-2", PHP_INI_ALL, OnUpdateLong, etag.mode)
201 PHP_INI_END()
202 /* }}} */
203
204
205 /* {{{ PHP_MINIT_FUNCTION */
206 PHP_MINIT_FUNCTION(http)
207 {
208 http_module_number = module_number;
209
210 ZEND_INIT_MODULE_GLOBALS(http, http_globals_init_once, NULL)
211
212 REGISTER_INI_ENTRIES();
213
214 HTTP_LONG_CONSTANT("HTTP_ETAG_MD5", HTTP_ETAG_MD5);
215 HTTP_LONG_CONSTANT("HTTP_ETAG_SHA1", HTTP_ETAG_SHA1);
216 HTTP_LONG_CONSTANT("HTTP_ETAG_MHASH", HTTP_ETAG_MHASH);
217
218 #ifdef HTTP_HAVE_CURL
219 if (CURLE_OK != curl_global_init(CURL_GLOBAL_ALL)) {
220 return FAILURE;
221 }
222 #endif /* HTTP_HAVE_CURL */
223
224 #ifdef ZEND_ENGINE_2
225 http_util_object_init();
226 http_message_object_init();
227 http_response_object_init();
228 # ifdef HTTP_HAVE_CURL
229 http_request_object_init();
230 http_requestpool_object_init();
231 # endif /* HTTP_HAVE_CURL */
232 http_exception_object_init();
233 #endif /* ZEND_ENGINE_2 */
234
235 #ifdef ZEND_ENGINE_2
236 zend_hash_init_ex(&http_response_statics, 0, NULL, ZVAL_INTERNAL_PTR_DTOR, 1, 0);
237 zend_fix_static_properties(http_response_object_ce, &http_response_statics TSRMLS_CC);
238 #endif
239 return SUCCESS;
240 }
241 /* }}} */
242
243 /* {{{ PHP_MSHUTDOWN_FUNCTION */
244 PHP_MSHUTDOWN_FUNCTION(http)
245 {
246 #ifdef ZEND_ENGINE_2
247 zend_hash_destroy(&http_response_statics);
248 #endif
249 UNREGISTER_INI_ENTRIES();
250 #ifdef HTTP_HAVE_CURL
251 curl_global_cleanup();
252 #endif
253 return SUCCESS;
254 }
255 /* }}} */
256
257 /* {{{ PHP_RINIT_FUNCTION */
258 PHP_RINIT_FUNCTION(http)
259 {
260 char *m;
261
262 if (m = INI_STR("http.allowed_methods")) {
263 http_check_allowed_methods(m, strlen(m));
264 }
265
266 http_globals_init(HTTP_GLOBALS);
267 #ifdef ZEND_ENGINE_2
268 zend_init_static_properties(http_response_object_ce, &http_response_statics TSRMLS_CC);
269 #endif
270 return SUCCESS;
271 }
272 /* }}} */
273
274 /* {{{ PHP_RSHUTDOWN_FUNCTION */
275 PHP_RSHUTDOWN_FUNCTION(http)
276 {
277 #ifdef ZEND_ENGINE_2
278 zend_clean_static_properties(http_response_object_ce TSRMLS_CC);
279 #endif
280 http_globals_free(HTTP_GLOBALS);
281 return SUCCESS;
282 }
283 /* }}} */
284
285 /* {{{ PHP_MINFO_FUNCTION */
286 PHP_MINFO_FUNCTION(http)
287 {
288 #ifdef ZEND_ENGINE_2
289 # define HTTP_FUNC_AVAIL(CLASS) "procedural, object oriented (" CLASS ")"
290 #else
291 # define HTTP_FUNC_AVAIL(CLASS) "procedural"
292 #endif
293
294 #ifdef HTTP_HAVE_CURL
295 # define HTTP_CURL_VERSION curl_version()
296 # ifdef ZEND_ENGINE_2
297 # define HTTP_CURL_AVAIL(CLASS) "procedural, object oriented (" CLASS ")"
298 # else
299 # define HTTP_CURL_AVAIL(CLASS) "procedural"
300 # endif
301 #else
302 # define HTTP_CURL_VERSION "libcurl not available"
303 # define HTTP_CURL_AVAIL(CLASS) "libcurl not available"
304 #endif
305
306 #include "php_http_request_api.h"
307
308 php_info_print_table_start();
309 {
310 char full_version_string[1024] = {0};
311 snprintf(full_version_string, 1023, "%s (%s)", HTTP_PEXT_VERSION, HTTP_CURL_VERSION);
312
313 php_info_print_table_row(2, "Extended HTTP support:", "enabled");
314 php_info_print_table_row(2, "Extension Version:", full_version_string);
315 }
316 php_info_print_table_end();
317
318 #ifdef HTTP_HAVE_CURL
319 php_info_print_table_start();
320 {
321 unsigned i;
322 zval **custom_method;
323 phpstr *known_request_methods = phpstr_new();
324 phpstr *custom_request_methods = phpstr_new();
325
326 for (i = HTTP_NO_REQUEST_METHOD+1; i < HTTP_MAX_REQUEST_METHOD; ++i) {
327 phpstr_appendl(known_request_methods, http_request_method_name(i));
328 phpstr_appends(known_request_methods, ", ");
329 }
330 FOREACH_HASH_VAL(&HTTP_G(request).methods.custom, custom_method) {
331 phpstr_append(custom_request_methods, Z_STRVAL_PP(custom_method), Z_STRLEN_PP(custom_method));
332 phpstr_appends(custom_request_methods, ", ");
333 }
334
335 phpstr_append(known_request_methods, PHPSTR_VAL(custom_request_methods), PHPSTR_LEN(custom_request_methods));
336 phpstr_fix(known_request_methods);
337 phpstr_fix(custom_request_methods);
338
339 php_info_print_table_row(2, "Known Request Methods:", PHPSTR_VAL(known_request_methods));
340 php_info_print_table_row(2, "Custom Request Methods:",
341 PHPSTR_LEN(custom_request_methods) ? PHPSTR_VAL(custom_request_methods) : "none registered");
342
343 phpstr_free(&known_request_methods);
344 phpstr_free(&custom_request_methods);
345 }
346 php_info_print_table_end();
347 #endif
348
349 php_info_print_table_start();
350 {
351 php_info_print_table_header(2, "Functionality", "Availability");
352 php_info_print_table_row(2, "Miscellaneous Utilities:", HTTP_FUNC_AVAIL("HttpUtil, HttpMessage"));
353 php_info_print_table_row(2, "Extended HTTP Responses:", HTTP_FUNC_AVAIL("HttpResponse"));
354 php_info_print_table_row(2, "Extended HTTP Requests:", HTTP_CURL_AVAIL("HttpRequest, HttpRequestPool"));
355 }
356 php_info_print_table_end();
357
358 DISPLAY_INI_ENTRIES();
359 }
360 /* }}} */
361
362 /*
363 * Local variables:
364 * tab-width: 4
365 * c-basic-offset: 4
366 * End:
367 * vim600: noet sw=4 ts=4 fdm=marker
368 * vim<600: noet sw=4 ts=4
369 */
370