- http_request_method_*() API should have been available even since last 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 #include "php_http_request_method_api.h"
34 #ifdef HTTP_HAVE_CURL
35 # include "php_http_request_api.h"
36 #endif
37
38 #ifdef ZEND_ENGINE_2
39 # include "php_http_util_object.h"
40 # include "php_http_message_object.h"
41 # ifndef WONKY
42 # include "php_http_response_object.h"
43 # endif
44 # ifdef HTTP_HAVE_CURL
45 # include "php_http_request_object.h"
46 # include "php_http_requestpool_object.h"
47 # endif
48 # include "php_http_exception_object.h"
49 #endif
50
51 #include "missing.h"
52 #include "phpstr/phpstr.h"
53
54 #ifdef HTTP_HAVE_CURL
55 # ifdef PHP_WIN32
56 # include <winsock2.h>
57 # endif
58 # include <curl/curl.h>
59 #endif
60 #ifdef HTTP_HAVE_MHASH
61 # include <mhash.h>
62 #endif
63
64 #include <ctype.h>
65
66 ZEND_DECLARE_MODULE_GLOBALS(http);
67 HTTP_DECLARE_ARG_PASS_INFO();
68
69 #ifdef COMPILE_DL_HTTP
70 ZEND_GET_MODULE(http)
71 #endif
72
73 /* {{{ http_functions[] */
74 zend_function_entry http_functions[] = {
75 PHP_FE(http_test, NULL)
76 PHP_FE(http_date, NULL)
77 PHP_FE(http_absolute_uri, NULL)
78 PHP_FE(http_negotiate_language, NULL)
79 PHP_FE(http_negotiate_charset, NULL)
80 PHP_FE(http_redirect, NULL)
81 PHP_FE(http_throttle, NULL)
82 PHP_FE(http_send_status, NULL)
83 PHP_FE(http_send_last_modified, NULL)
84 PHP_FE(http_send_content_type, NULL)
85 PHP_FE(http_send_content_disposition, NULL)
86 PHP_FE(http_match_modified, NULL)
87 PHP_FE(http_match_etag, NULL)
88 PHP_FE(http_cache_last_modified, NULL)
89 PHP_FE(http_cache_etag, NULL)
90 PHP_FE(http_send_data, NULL)
91 PHP_FE(http_send_file, NULL)
92 PHP_FE(http_send_stream, NULL)
93 PHP_FE(http_chunked_decode, NULL)
94 PHP_FE(http_parse_message, NULL)
95 PHP_FE(http_parse_headers, NULL)
96 PHP_FE(http_get_request_headers, NULL)
97 PHP_FE(http_get_request_body, NULL)
98 PHP_FE(http_match_request_header, NULL)
99 #ifdef HTTP_HAVE_CURL
100 PHP_FE(http_get, http_arg_pass_ref_3)
101 PHP_FE(http_head, http_arg_pass_ref_3)
102 PHP_FE(http_post_data, http_arg_pass_ref_4)
103 PHP_FE(http_post_fields, http_arg_pass_ref_5)
104 PHP_FE(http_put_file, http_arg_pass_ref_4)
105 PHP_FE(http_put_stream, http_arg_pass_ref_4)
106 #endif
107 PHP_FE(http_request_method_register, NULL)
108 PHP_FE(http_request_method_unregister, NULL)
109 PHP_FE(http_request_method_exists, NULL)
110 PHP_FE(http_request_method_name, NULL)
111 #ifndef ZEND_ENGINE_2
112 PHP_FE(http_build_query, NULL)
113 #endif
114 PHP_FE(ob_etaghandler, NULL)
115
116 EMPTY_FUNCTION_ENTRY
117 };
118 /* }}} */
119
120 /* {{{ http_module_entry */
121 zend_module_entry http_module_entry = {
122 #if ZEND_MODULE_API_NO >= 20010901
123 STANDARD_MODULE_HEADER,
124 #endif
125 "http",
126 http_functions,
127 PHP_MINIT(http),
128 PHP_MSHUTDOWN(http),
129 PHP_RINIT(http),
130 PHP_RSHUTDOWN(http),
131 PHP_MINFO(http),
132 #if ZEND_MODULE_API_NO >= 20010901
133 HTTP_PEXT_VERSION,
134 #endif
135 STANDARD_MODULE_PROPERTIES
136 };
137 /* }}} */
138
139 int http_module_number;
140
141 /* {{{ http_globals */
142 static void http_globals_init_once(zend_http_globals *G)
143 {
144 memset(G, 0, sizeof(zend_http_globals));
145 }
146
147 static inline void http_globals_init(zend_http_globals *G)
148 {
149 G->send.buffer_size = HTTP_SENDBUF_SIZE;
150 zend_hash_init(&G->request.methods.custom, 0, NULL, ZVAL_PTR_DTOR, 0);
151 #ifdef HTTP_HAVE_CURL
152 zend_llist_init(&G->request.copies.strings, sizeof(char *), http_request_data_free_string, 0);
153 zend_llist_init(&G->request.copies.slists, sizeof(struct curl_slist *), http_request_data_free_slist, 0);
154 zend_llist_init(&G->request.copies.contexts, sizeof(http_request_callback_ctx *), http_request_data_free_context, 0);
155 zend_llist_init(&G->request.copies.convs, sizeof(http_request_conv *), http_request_data_free_conv, 0);
156 #endif
157 }
158
159 static inline void http_globals_free(zend_http_globals *G)
160 {
161 STR_SET(G->send.content_type, NULL);
162 STR_SET(G->send.unquoted_etag, NULL);
163 zend_hash_destroy(&G->request.methods.custom);
164 #ifdef HTTP_HAVE_CURL
165 zend_llist_clean(&G->request.copies.strings);
166 zend_llist_clean(&G->request.copies.slists);
167 zend_llist_clean(&G->request.copies.contexts);
168 zend_llist_clean(&G->request.copies.convs);
169 #endif
170 }
171 /* }}} */
172
173 /* {{{ static inline void http_check_allowed_methods(char *, int) */
174 #define http_check_allowed_methods(m, l) _http_check_allowed_methods((m), (l) TSRMLS_CC)
175 static inline void _http_check_allowed_methods(char *methods, int length TSRMLS_DC)
176 {
177 if (length && SG(request_info).request_method) {
178 if (SUCCESS != http_check_method_ex(SG(request_info).request_method, methods)) {
179 char *header = emalloc(length + sizeof("Allow: "));
180 sprintf(header, "Allow: %s", methods);
181 http_exit(405, header);
182 }
183 }
184 }
185 /* }}} */
186
187 /* {{{ PHP_INI */
188 PHP_INI_MH(http_update_allowed_methods)
189 {
190 http_check_allowed_methods(new_value, new_value_length);
191 return OnUpdateString(entry, new_value, new_value_length, mh_arg1, mh_arg2, mh_arg3, stage TSRMLS_CC);
192 }
193
194 PHP_INI_DISP(http_etag_mode_displayer)
195 {
196 long value;
197
198 if (type == ZEND_INI_DISPLAY_ORIG && ini_entry->modified) {
199 value = (ini_entry->orig_value) ? atoi(ini_entry->orig_value) : HTTP_ETAG_MD5;
200 } else if (ini_entry->value) {
201 value = (ini_entry->value[0]) ? atoi(ini_entry->value) : HTTP_ETAG_MD5;
202 } else {
203 value = HTTP_ETAG_MD5;
204 }
205
206 switch (value)
207 {
208 case HTTP_ETAG_SHA1:
209 ZEND_WRITE("HTTP_ETAG_SHA1", lenof("HTTP_ETAG_SHA1"));
210 break;
211
212 case HTTP_ETAG_MD5:
213 #ifndef HTTP_HAVE_MHASH
214 default:
215 #endif
216 ZEND_WRITE("HTTP_ETAG_MD5", lenof("HTTP_ETAG_MD5"));
217 break;
218
219 #ifdef HTTP_HAVE_MHASH
220 default:
221 {
222 const char *hash_name = mhash_get_hash_name_static(value);
223
224 if (!hash_name) {
225 ZEND_WRITE("HTTP_ETAG_MD5", lenof("HTTP_ETAG_MD5"));
226 } else {
227 ZEND_WRITE("HTTP_ETAG_MHASH_", lenof("HTTP_ETAG_MHASH_"));
228 ZEND_WRITE(hash_name, strlen(hash_name));
229 }
230 }
231 break;
232 #endif
233 }
234 }
235
236 #ifndef ZEND_ENGINE_2
237 # define OnUpdateLong OnUpdateInt
238 #endif
239
240 PHP_INI_BEGIN()
241 HTTP_PHP_INI_ENTRY("http.allowed_methods", "", PHP_INI_ALL, http_update_allowed_methods, request.methods.allowed)
242 HTTP_PHP_INI_ENTRY("http.cache_log", "", PHP_INI_ALL, OnUpdateString, log.cache)
243 HTTP_PHP_INI_ENTRY("http.redirect_log", "", PHP_INI_ALL, OnUpdateString, log.redirect)
244 HTTP_PHP_INI_ENTRY("http.allowed_methods_log", "", PHP_INI_ALL, OnUpdateString, log.allowed_methods)
245 HTTP_PHP_INI_ENTRY("http.composite_log", "", PHP_INI_ALL, OnUpdateString, log.composite)
246 #ifdef ZEND_ENGINE_2
247 HTTP_PHP_INI_ENTRY("http.only_exceptions", "0", PHP_INI_ALL, OnUpdateBool, only_exceptions)
248 #endif
249 HTTP_PHP_INI_ENTRY_EX("http.etag_mode", "-2", PHP_INI_ALL, OnUpdateLong, http_etag_mode_displayer, etag.mode)
250 PHP_INI_END()
251 /* }}} */
252
253 /* {{{ SSL */
254 #ifdef HTTP_NEED_SSL
255
256 #endif
257 /* }}} */
258
259 /* {{{ PHP_MINIT_FUNCTION */
260 PHP_MINIT_FUNCTION(http)
261 {
262 http_module_number = module_number;
263
264 ZEND_INIT_MODULE_GLOBALS(http, http_globals_init_once, NULL)
265
266 REGISTER_INI_ENTRIES();
267
268 if (SUCCESS != http_cache_global_init()) {
269 return FAILURE;
270 }
271 if (SUCCESS != http_request_method_global_init()) {
272 return FAILURE;
273 }
274 #ifdef HTTP_HAVE_CURL
275 if (SUCCESS != http_request_global_init()) {
276 return FAILURE;
277 }
278 #endif /* HTTP_HAVE_CURL */
279
280 #ifdef ZEND_ENGINE_2
281 http_util_object_init();
282 http_message_object_init();
283 # ifndef WONKY
284 http_response_object_init();
285 # endif
286 # ifdef HTTP_HAVE_CURL
287 http_request_object_init();
288 http_requestpool_object_init();
289 # endif /* HTTP_HAVE_CURL */
290 http_exception_object_init();
291 #endif /* ZEND_ENGINE_2 */
292
293 return SUCCESS;
294 }
295 /* }}} */
296
297 /* {{{ PHP_MSHUTDOWN_FUNCTION */
298 PHP_MSHUTDOWN_FUNCTION(http)
299 {
300 UNREGISTER_INI_ENTRIES();
301 #ifdef HTTP_HAVE_CURL
302 http_request_global_cleanup();
303 #endif
304 return SUCCESS;
305 }
306 /* }}} */
307
308 /* {{{ PHP_RINIT_FUNCTION */
309 PHP_RINIT_FUNCTION(http)
310 {
311 char *m;
312
313 if (m = INI_STR("http.allowed_methods")) {
314 http_check_allowed_methods(m, strlen(m));
315 }
316
317 http_globals_init(HTTP_GLOBALS);
318 return SUCCESS;
319 }
320 /* }}} */
321
322 /* {{{ PHP_RSHUTDOWN_FUNCTION */
323 PHP_RSHUTDOWN_FUNCTION(http)
324 {
325 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
326 int i, c = zend_hash_num_elements(&HTTP_G(request).methods.custom);
327
328 for (i = 0; i < c; ++i) {
329 zend_printf("RSHUTDOWN: unregistering %d (%d)\n", i,
330 http_request_method_unregister(HTTP_MAX_REQUEST_METHOD + i));
331 }
332 #endif
333 http_globals_free(HTTP_GLOBALS);
334 return SUCCESS;
335 }
336 /* }}} */
337
338 /* {{{ PHP_MINFO_FUNCTION */
339 PHP_MINFO_FUNCTION(http)
340 {
341 php_info_print_table_start();
342 {
343 php_info_print_table_row(2, "Extended HTTP support:", "enabled");
344 php_info_print_table_row(2, "Extension Version:", HTTP_PEXT_VERSION);
345 #ifdef HTTP_HAVE_CURL
346 php_info_print_table_row(2, "cURL HTTP Requests:", curl_version());
347 #else
348 php_info_print_table_row(2, "cURL HTTP Requests:", "disabled");
349 #endif
350 #ifdef HTTP_HAVE_MHASH
351 {
352 char mhash_info[32];
353
354 snprintf(mhash_info, 32, "libmhash/%d", MHASH_API_VERSION);
355 php_info_print_table_row(2, "mhash ETag Generator:", mhash_info);
356 }
357 #else
358 php_info_print_table_row(2, "mhash ETag Generator:", "disabled");
359 #endif
360 #if defined(HTTP_HAVE_MAGIC) && !defined(WONKY)
361 php_info_print_table_row(2, "magic MIME Guessing:", "libmagic/unknown");
362 #else
363 php_info_print_table_row(2, "magic MIME Guessing:", "disabled");
364 #endif
365 php_info_print_table_row(2, "Registered Classes:",
366 #ifndef ZEND_ENGINE_2
367 "none"
368 #else
369 "HttpUtil, "
370 "HttpMessage, "
371 # ifdef HTTP_HAVE_CURL
372 "HttpRequest, "
373 "HttpRequestPool, "
374 # endif
375 # ifndef WONKY
376 "HttpResponse"
377 # endif
378 #endif
379 );
380 }
381 php_info_print_table_end();
382
383 php_info_print_table_start();
384 {
385 unsigned i;
386 zval **custom_method;
387 phpstr *known_request_methods = phpstr_new();
388 phpstr *custom_request_methods = phpstr_new();
389
390 for (i = HTTP_NO_REQUEST_METHOD+1; i < HTTP_MAX_REQUEST_METHOD; ++i) {
391 phpstr_appendl(known_request_methods, http_request_method_name(i));
392 phpstr_appends(known_request_methods, ", ");
393 }
394 FOREACH_HASH_VAL(&HTTP_G(request).methods.custom, custom_method) {
395 phpstr_append(custom_request_methods, Z_STRVAL_PP(custom_method), Z_STRLEN_PP(custom_method));
396 phpstr_appends(custom_request_methods, ", ");
397 }
398
399 phpstr_append(known_request_methods, PHPSTR_VAL(custom_request_methods), PHPSTR_LEN(custom_request_methods));
400 phpstr_fix(known_request_methods);
401 phpstr_fix(custom_request_methods);
402
403 php_info_print_table_row(2, "Known Request Methods:", PHPSTR_VAL(known_request_methods));
404 php_info_print_table_row(2, "Custom Request Methods:",
405 PHPSTR_LEN(custom_request_methods) ? PHPSTR_VAL(custom_request_methods) : "none registered");
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