- reimplement major parts of the request api
[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 }
166
167 static inline void http_globals_free(zend_http_globals *G)
168 {
169 STR_SET(G->send.content_type, NULL);
170 STR_SET(G->send.unquoted_etag, NULL);
171 zend_hash_destroy(&G->request.methods.custom);
172 }
173 /* }}} */
174
175 /* {{{ static inline void http_check_allowed_methods(char *, int) */
176 #define http_check_allowed_methods(m, l) _http_check_allowed_methods((m), (l) TSRMLS_CC)
177 static inline void _http_check_allowed_methods(char *methods, int length TSRMLS_DC)
178 {
179 if (length && SG(request_info).request_method) {
180 if (SUCCESS != http_check_method_ex(SG(request_info).request_method, methods)) {
181 char *header = emalloc(length + sizeof("Allow: "));
182 sprintf(header, "Allow: %s", methods);
183 http_exit(405, header);
184 }
185 }
186 }
187 /* }}} */
188
189 /* {{{ PHP_INI */
190 PHP_INI_MH(http_update_allowed_methods)
191 {
192 http_check_allowed_methods(new_value, new_value_length);
193 return OnUpdateString(entry, new_value, new_value_length, mh_arg1, mh_arg2, mh_arg3, stage TSRMLS_CC);
194 }
195
196 #ifndef ZEND_ENGINE_2
197 # define OnUpdateLong OnUpdateInt
198 #endif
199
200 PHP_INI_BEGIN()
201 HTTP_PHP_INI_ENTRY("http.allowed_methods", "", PHP_INI_ALL, http_update_allowed_methods, request.methods.allowed)
202 HTTP_PHP_INI_ENTRY("http.cache_log", "", PHP_INI_ALL, OnUpdateString, log.cache)
203 HTTP_PHP_INI_ENTRY("http.redirect_log", "", PHP_INI_ALL, OnUpdateString, log.redirect)
204 HTTP_PHP_INI_ENTRY("http.allowed_methods_log", "", PHP_INI_ALL, OnUpdateString, log.allowed_methods)
205 HTTP_PHP_INI_ENTRY("http.composite_log", "", PHP_INI_ALL, OnUpdateString, log.composite)
206 HTTP_PHP_INI_ENTRY("http.etag_mode", "MD5", PHP_INI_ALL, OnUpdateString, etag.mode)
207 #ifdef ZEND_ENGINE_2
208 HTTP_PHP_INI_ENTRY("http.only_exceptions", "0", PHP_INI_ALL, OnUpdateBool, only_exceptions)
209 #endif
210 HTTP_PHP_INI_ENTRY("http.force_exit", "1", PHP_INI_ALL, OnUpdateBool, force_exit)
211 PHP_INI_END()
212 /* }}} */
213
214 /* {{{ PHP_MINIT_FUNCTION */
215 PHP_MINIT_FUNCTION(http)
216 {
217 http_module_number = module_number;
218
219 ZEND_INIT_MODULE_GLOBALS(http, http_globals_init_once, NULL)
220
221 REGISTER_INI_ENTRIES();
222
223 if ( (SUCCESS != PHP_MINIT_CALL(http_support)) ||
224 (SUCCESS != PHP_MINIT_CALL(http_headers)) ||
225 #ifdef HTTP_HAVE_CURL
226 (SUCCESS != PHP_MINIT_CALL(http_request)) ||
227 #endif /* HTTP_HAVE_CURL */
228 (SUCCESS != PHP_MINIT_CALL(http_request_method))) {
229 return FAILURE;
230 }
231
232 #ifdef ZEND_ENGINE_2
233 if ( (SUCCESS != PHP_MINIT_CALL(http_filter)) ||
234 (SUCCESS != PHP_MINIT_CALL(http_util_object)) ||
235 (SUCCESS != PHP_MINIT_CALL(http_message_object)) ||
236 # ifndef WONKY
237 (SUCCESS != PHP_MINIT_CALL(http_response_object)) ||
238 # endif /* WONKY */
239 # ifdef HTTP_HAVE_CURL
240 (SUCCESS != PHP_MINIT_CALL(http_request_object)) ||
241 (SUCCESS != PHP_MINIT_CALL(http_requestpool_object))||
242 # endif /* HTTP_HAVE_CURL */
243 (SUCCESS != PHP_MINIT_CALL(http_exception_object))) {
244 return FAILURE;
245 }
246 #endif /* ZEND_ENGINE_2 */
247
248 return SUCCESS;
249 }
250 /* }}} */
251
252 /* {{{ PHP_MSHUTDOWN_FUNCTION */
253 PHP_MSHUTDOWN_FUNCTION(http)
254 {
255 UNREGISTER_INI_ENTRIES();
256 #ifdef HTTP_HAVE_CURL
257 return PHP_MSHUTDOWN_CALL(http_request);
258 #endif
259 return SUCCESS;
260 }
261 /* }}} */
262
263 /* {{{ PHP_RINIT_FUNCTION */
264 PHP_RINIT_FUNCTION(http)
265 {
266 if (HTTP_G(request).methods.allowed) {
267 http_check_allowed_methods(HTTP_G(request).methods.allowed,
268 strlen(HTTP_G(request).methods.allowed));
269 }
270
271 http_globals_init(HTTP_GLOBALS);
272 return SUCCESS;
273 }
274 /* }}} */
275
276 /* {{{ PHP_RSHUTDOWN_FUNCTION */
277 PHP_RSHUTDOWN_FUNCTION(http)
278 {
279 STATUS status = SUCCESS;
280
281 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
282 status = PHP_RSHUTDOWN_CALL(http_request_method);
283 #endif
284
285 http_globals_free(HTTP_GLOBALS);
286 return status;
287 }
288 /* }}} */
289
290 /* {{{ PHP_MINFO_FUNCTION */
291 PHP_MINFO_FUNCTION(http)
292 {
293 php_info_print_table_start();
294 {
295 php_info_print_table_row(2, "Extended HTTP support", "enabled");
296 php_info_print_table_row(2, "Extension Version", PHP_EXT_HTTP_VERSION);
297 #ifdef HTTP_HAVE_CURL
298 php_info_print_table_row(2, "cURL HTTP Requests", curl_version());
299 #else
300 php_info_print_table_row(2, "cURL HTTP Requests", "disabled");
301 #endif
302 #ifdef HTTP_HAVE_ZLIB
303 {
304 char my_zlib_version[64] = {0};
305
306 strlcat(my_zlib_version, "zlib/", 63);
307 strlcat(my_zlib_version, zlibVersion(), 63);
308 php_info_print_table_row(2, "zlib GZIP Encodings", my_zlib_version);
309 }
310 #else
311 php_info_print_table_row(2, "zlib GZIP Encodings", "disabled");
312 #endif
313 #if defined(HTTP_HAVE_MAGIC) && !defined(WONKY)
314 php_info_print_table_row(2, "magic MIME Guessing", "libmagic/unknown");
315 #else
316 php_info_print_table_row(2, "magic MIME Guessing", "disabled");
317 #endif
318 php_info_print_table_row(2, "Registered Classes",
319 #ifndef ZEND_ENGINE_2
320 "none"
321 #else
322 "HttpUtil, "
323 "HttpMessage, "
324 # ifdef HTTP_HAVE_CURL
325 "HttpRequest, "
326 "HttpRequestPool, "
327 # endif
328 # ifndef WONKY
329 "HttpResponse"
330 # endif
331 #endif
332 );
333 }
334 php_info_print_table_end();
335
336 php_info_print_table_start();
337 php_info_print_table_colspan_header(2, "Request Methods");
338 {
339 unsigned i;
340 HashPosition pos;
341 zval **custom_method;
342 phpstr *known_request_methods = phpstr_new();
343 phpstr *custom_request_methods = phpstr_new();
344
345 for (i = HTTP_NO_REQUEST_METHOD+1; i < HTTP_MAX_REQUEST_METHOD; ++i) {
346 phpstr_appendl(known_request_methods, http_request_method_name(i));
347 phpstr_appends(known_request_methods, ", ");
348 }
349 FOREACH_HASH_VAL(pos, &HTTP_G(request).methods.custom, custom_method) {
350 phpstr_append(custom_request_methods, Z_STRVAL_PP(custom_method), Z_STRLEN_PP(custom_method));
351 phpstr_appends(custom_request_methods, ", ");
352 }
353
354 phpstr_append(known_request_methods, PHPSTR_VAL(custom_request_methods), PHPSTR_LEN(custom_request_methods));
355 phpstr_fix(known_request_methods);
356 phpstr_fix(custom_request_methods);
357
358 php_info_print_table_row(2, "Known", PHPSTR_VAL(known_request_methods));
359 php_info_print_table_row(2, "Custom",
360 PHPSTR_LEN(custom_request_methods) ? PHPSTR_VAL(custom_request_methods) : "none registered");
361 php_info_print_table_row(2, "Allowed", strlen(HTTP_G(request).methods.allowed) ? HTTP_G(request).methods.allowed : "(ANY)");
362
363 phpstr_free(&known_request_methods);
364 phpstr_free(&custom_request_methods);
365 }
366 php_info_print_table_end();
367
368 DISPLAY_INI_ENTRIES();
369 }
370 /* }}} */
371
372 /*
373 * Local variables:
374 * tab-width: 4
375 * c-basic-offset: 4
376 * End:
377 * vim600: noet sw=4 ts=4 fdm=marker
378 * vim<600: noet sw=4 ts=4
379 */
380