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