- ad verbosity about checking for ext/hash and avoid empty else..fi case
[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
39 #ifdef ZEND_ENGINE_2
40 # include "php_http_filter_api.h"
41 # include "php_http_util_object.h"
42 # include "php_http_message_object.h"
43 # ifndef WONKY
44 # include "php_http_response_object.h"
45 # endif
46 # ifdef HTTP_HAVE_CURL
47 # include "php_http_request_object.h"
48 # include "php_http_requestpool_object.h"
49 # endif
50 # include "php_http_exception_object.h"
51 #endif
52
53
54 ZEND_DECLARE_MODULE_GLOBALS(http);
55 HTTP_DECLARE_ARG_PASS_INFO();
56
57 #ifdef COMPILE_DL_HTTP
58 ZEND_GET_MODULE(http)
59 #endif
60
61 /* {{{ http_functions[] */
62 zend_function_entry http_functions[] = {
63 PHP_FE(http_test, NULL)
64 PHP_FE(http_date, NULL)
65 PHP_FE(http_build_uri, NULL)
66 PHP_FALIAS(http_absolute_uri, http_build_uri, NULL)
67 PHP_FE(http_negotiate_language, http_arg_pass_ref_2)
68 PHP_FE(http_negotiate_charset, http_arg_pass_ref_2)
69 PHP_FE(http_negotiate_content_type, http_arg_pass_ref_2)
70 PHP_FE(http_redirect, NULL)
71 PHP_FE(http_throttle, NULL)
72 PHP_FE(http_send_status, NULL)
73 PHP_FE(http_send_last_modified, NULL)
74 PHP_FE(http_send_content_type, NULL)
75 PHP_FE(http_send_content_disposition, NULL)
76 PHP_FE(http_match_modified, NULL)
77 PHP_FE(http_match_etag, NULL)
78 PHP_FE(http_cache_last_modified, NULL)
79 PHP_FE(http_cache_etag, NULL)
80 PHP_FE(http_send_data, NULL)
81 PHP_FE(http_send_file, NULL)
82 PHP_FE(http_send_stream, NULL)
83 PHP_FE(http_chunked_decode, NULL)
84 PHP_FE(http_parse_message, NULL)
85 PHP_FE(http_parse_headers, NULL)
86 PHP_FE(http_get_request_headers, NULL)
87 PHP_FE(http_get_request_body, NULL)
88 PHP_FE(http_match_request_header, NULL)
89 #ifdef HTTP_HAVE_CURL
90 PHP_FE(http_get, http_arg_pass_ref_3)
91 PHP_FE(http_head, http_arg_pass_ref_3)
92 PHP_FE(http_post_data, http_arg_pass_ref_4)
93 PHP_FE(http_post_fields, http_arg_pass_ref_5)
94 PHP_FE(http_put_file, http_arg_pass_ref_4)
95 PHP_FE(http_put_stream, http_arg_pass_ref_4)
96 #endif
97 PHP_FE(http_request_method_register, NULL)
98 PHP_FE(http_request_method_unregister, NULL)
99 PHP_FE(http_request_method_exists, NULL)
100 PHP_FE(http_request_method_name, NULL)
101 #ifndef ZEND_ENGINE_2
102 PHP_FE(http_build_query, NULL)
103 #endif
104 PHP_FE(ob_etaghandler, NULL)
105 #ifdef HTTP_HAVE_ZLIB
106 PHP_FE(http_gzencode, NULL)
107 PHP_FE(http_gzdecode, NULL)
108 PHP_FE(http_deflate, NULL)
109 PHP_FE(http_inflate, NULL)
110 PHP_FE(http_compress, NULL)
111 PHP_FE(http_uncompress, NULL)
112 #endif
113 PHP_FE(http_support, NULL)
114
115 EMPTY_FUNCTION_ENTRY
116 };
117 /* }}} */
118
119 /* {{{ http_module_dep */
120 #if ZEND_EXTENSION_API_NO >= 220050617
121 static zend_module_dep http_module_dep[] = {
122 # ifdef HAVE_SPL
123 ZEND_MOD_REQUIRED("spl")
124 # endif
125 # ifdef HTTP_HAVE_EXT_HASH
126 ZEND_MOD_REQUIRED("hash")
127 # endif
128 {NULL, NULL, NULL, 0}
129 };
130 #endif
131 /* }}} */
132
133 /* {{{ http_module_entry */
134 zend_module_entry http_module_entry = {
135 #if ZEND_EXTENSION_API_NO >= 220050617
136 STANDARD_MODULE_HEADER_EX, NULL,
137 http_module_dep,
138 #else
139 STANDARD_MODULE_HEADER,
140 #endif
141 "http",
142 http_functions,
143 PHP_MINIT(http),
144 PHP_MSHUTDOWN(http),
145 PHP_RINIT(http),
146 PHP_RSHUTDOWN(http),
147 PHP_MINFO(http),
148 PHP_EXT_HTTP_VERSION,
149 STANDARD_MODULE_PROPERTIES
150 };
151 /* }}} */
152
153 int http_module_number;
154
155 /* {{{ http_globals */
156 static void http_globals_init_once(zend_http_globals *G)
157 {
158 memset(G, 0, sizeof(zend_http_globals));
159 }
160
161 static inline void http_globals_init(zend_http_globals *G)
162 {
163 G->send.buffer_size = HTTP_SENDBUF_SIZE;
164 zend_hash_init(&G->request.methods.custom, 0, NULL, ZVAL_PTR_DTOR, 0);
165 #ifdef HTTP_HAVE_CURL
166 zend_llist_init(&G->request.copies.strings, sizeof(char *), http_request_data_free_string, 0);
167 zend_llist_init(&G->request.copies.slists, sizeof(struct curl_slist *), http_request_data_free_slist, 0);
168 zend_llist_init(&G->request.copies.contexts, sizeof(http_request_callback_ctx *), http_request_data_free_context, 0);
169 zend_llist_init(&G->request.copies.convs, sizeof(http_request_conv *), http_request_data_free_conv, 0);
170 #endif
171 }
172
173 static inline void http_globals_free(zend_http_globals *G)
174 {
175 STR_SET(G->send.content_type, NULL);
176 STR_SET(G->send.unquoted_etag, NULL);
177 zend_hash_destroy(&G->request.methods.custom);
178 #ifdef HTTP_HAVE_CURL
179 zend_llist_clean(&G->request.copies.strings);
180 zend_llist_clean(&G->request.copies.slists);
181 zend_llist_clean(&G->request.copies.contexts);
182 zend_llist_clean(&G->request.copies.convs);
183 #endif
184 }
185 /* }}} */
186
187 /* {{{ static inline void http_check_allowed_methods(char *, int) */
188 #define http_check_allowed_methods(m, l) _http_check_allowed_methods((m), (l) TSRMLS_CC)
189 static inline void _http_check_allowed_methods(char *methods, int length TSRMLS_DC)
190 {
191 if (length && SG(request_info).request_method) {
192 if (SUCCESS != http_check_method_ex(SG(request_info).request_method, methods)) {
193 char *header = emalloc(length + sizeof("Allow: "));
194 sprintf(header, "Allow: %s", methods);
195 http_exit(405, header);
196 }
197 }
198 }
199 /* }}} */
200
201 /* {{{ PHP_INI */
202 PHP_INI_MH(http_update_allowed_methods)
203 {
204 http_check_allowed_methods(new_value, new_value_length);
205 return OnUpdateString(entry, new_value, new_value_length, mh_arg1, mh_arg2, mh_arg3, stage TSRMLS_CC);
206 }
207
208 #ifndef ZEND_ENGINE_2
209 # define OnUpdateLong OnUpdateInt
210 #endif
211
212 PHP_INI_BEGIN()
213 HTTP_PHP_INI_ENTRY("http.allowed_methods", "", PHP_INI_ALL, http_update_allowed_methods, request.methods.allowed)
214 HTTP_PHP_INI_ENTRY("http.cache_log", "", PHP_INI_ALL, OnUpdateString, log.cache)
215 HTTP_PHP_INI_ENTRY("http.redirect_log", "", PHP_INI_ALL, OnUpdateString, log.redirect)
216 HTTP_PHP_INI_ENTRY("http.allowed_methods_log", "", PHP_INI_ALL, OnUpdateString, log.allowed_methods)
217 HTTP_PHP_INI_ENTRY("http.composite_log", "", PHP_INI_ALL, OnUpdateString, log.composite)
218 HTTP_PHP_INI_ENTRY("http.etag_mode", "MD5", PHP_INI_ALL, OnUpdateString, etag.mode)
219 #ifdef ZEND_ENGINE_2
220 HTTP_PHP_INI_ENTRY("http.only_exceptions", "0", PHP_INI_ALL, OnUpdateBool, only_exceptions)
221 #endif
222 HTTP_PHP_INI_ENTRY("http.force_exit", "1", PHP_INI_ALL, OnUpdateBool, force_exit)
223 PHP_INI_END()
224 /* }}} */
225
226 /* {{{ PHP_MINIT_FUNCTION */
227 PHP_MINIT_FUNCTION(http)
228 {
229 http_module_number = module_number;
230
231 ZEND_INIT_MODULE_GLOBALS(http, http_globals_init_once, NULL)
232
233 REGISTER_INI_ENTRIES();
234
235 if ( (SUCCESS != PHP_MINIT_CALL(http_support)) ||
236 (SUCCESS != PHP_MINIT_CALL(http_headers)) ||
237 #ifdef HTTP_HAVE_CURL
238 (SUCCESS != PHP_MINIT_CALL(http_request)) ||
239 #endif /* HTTP_HAVE_CURL */
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 return SUCCESS;
285 }
286 /* }}} */
287
288 /* {{{ PHP_RSHUTDOWN_FUNCTION */
289 PHP_RSHUTDOWN_FUNCTION(http)
290 {
291 STATUS status = SUCCESS;
292
293 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
294 status = PHP_RSHUTDOWN_CALL(http_request_method);
295 #endif
296
297 http_globals_free(HTTP_GLOBALS);
298 return status;
299 }
300 /* }}} */
301
302 /* {{{ PHP_MINFO_FUNCTION */
303 PHP_MINFO_FUNCTION(http)
304 {
305 php_info_print_table_start();
306 {
307 php_info_print_table_row(2, "Extended HTTP support", "enabled");
308 php_info_print_table_row(2, "Extension Version", PHP_EXT_HTTP_VERSION);
309 #ifdef HTTP_HAVE_CURL
310 php_info_print_table_row(2, "cURL HTTP Requests", curl_version());
311 #else
312 php_info_print_table_row(2, "cURL HTTP Requests", "disabled");
313 #endif
314 #ifdef HTTP_HAVE_ZLIB
315 {
316 char my_zlib_version[64] = {0};
317
318 strlcat(my_zlib_version, "zlib/", 63);
319 strlcat(my_zlib_version, zlibVersion(), 63);
320 php_info_print_table_row(2, "zlib GZIP Encodings", my_zlib_version);
321 }
322 #else
323 php_info_print_table_row(2, "zlib GZIP Encodings", "disabled");
324 #endif
325 #if defined(HTTP_HAVE_MAGIC) && !defined(WONKY)
326 php_info_print_table_row(2, "magic MIME Guessing", "libmagic/unknown");
327 #else
328 php_info_print_table_row(2, "magic MIME Guessing", "disabled");
329 #endif
330 php_info_print_table_row(2, "Registered Classes",
331 #ifndef ZEND_ENGINE_2
332 "none"
333 #else
334 "HttpUtil, "
335 "HttpMessage, "
336 # ifdef HTTP_HAVE_CURL
337 "HttpRequest, "
338 "HttpRequestPool, "
339 # endif
340 # ifndef WONKY
341 "HttpResponse"
342 # endif
343 #endif
344 );
345 }
346 php_info_print_table_end();
347
348 php_info_print_table_start();
349 php_info_print_table_colspan_header(2, "Request Methods");
350 {
351 unsigned i;
352 HashPosition pos;
353 zval **custom_method;
354 phpstr *known_request_methods = phpstr_new();
355 phpstr *custom_request_methods = phpstr_new();
356
357 for (i = HTTP_NO_REQUEST_METHOD+1; i < HTTP_MAX_REQUEST_METHOD; ++i) {
358 phpstr_appendl(known_request_methods, http_request_method_name(i));
359 phpstr_appends(known_request_methods, ", ");
360 }
361 FOREACH_HASH_VAL(pos, &HTTP_G(request).methods.custom, custom_method) {
362 phpstr_append(custom_request_methods, Z_STRVAL_PP(custom_method), Z_STRLEN_PP(custom_method));
363 phpstr_appends(custom_request_methods, ", ");
364 }
365
366 phpstr_append(known_request_methods, PHPSTR_VAL(custom_request_methods), PHPSTR_LEN(custom_request_methods));
367 phpstr_fix(known_request_methods);
368 phpstr_fix(custom_request_methods);
369
370 php_info_print_table_row(2, "Known", PHPSTR_VAL(known_request_methods));
371 php_info_print_table_row(2, "Custom",
372 PHPSTR_LEN(custom_request_methods) ? PHPSTR_VAL(custom_request_methods) : "none registered");
373 php_info_print_table_row(2, "Allowed", strlen(HTTP_G(request).methods.allowed) ? HTTP_G(request).methods.allowed : "(ANY)");
374
375 phpstr_free(&known_request_methods);
376 phpstr_free(&custom_request_methods);
377 }
378 php_info_print_table_end();
379
380 DISPLAY_INI_ENTRIES();
381 }
382 /* }}} */
383
384 /*
385 * Local variables:
386 * tab-width: 4
387 * c-basic-offset: 4
388 * End:
389 * vim600: noet sw=4 ts=4 fdm=marker
390 * vim<600: noet sw=4 ts=4
391 */
392