- revised request_method 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 #ifdef HTTP_HAVE_ZLIB
39 # include "php_http_encoding_api.h"
40 #endif
41
42 #ifdef ZEND_ENGINE_2
43 # include "php_http_filter_api.h"
44 # include "php_http_util_object.h"
45 # include "php_http_message_object.h"
46 # ifndef WONKY
47 # include "php_http_response_object.h"
48 # endif
49 # ifdef HTTP_HAVE_CURL
50 # include "php_http_request_object.h"
51 # include "php_http_requestpool_object.h"
52 # endif
53 # ifdef HTTP_HAVE_ZLIB
54 # include "php_http_deflatestream_object.h"
55 # include "php_http_inflatestream_object.h"
56 # endif
57 # include "php_http_exception_object.h"
58 #endif
59
60
61 ZEND_DECLARE_MODULE_GLOBALS(http);
62 HTTP_DECLARE_ARG_PASS_INFO();
63
64 #ifdef COMPILE_DL_HTTP
65 ZEND_GET_MODULE(http)
66 #endif
67
68 /* {{{ http_functions[] */
69 zend_function_entry http_functions[] = {
70 PHP_FE(http_test, NULL)
71 PHP_FE(http_date, NULL)
72 PHP_FE(http_build_url, http_arg_pass_ref_3)
73 PHP_FE(http_negotiate_language, http_arg_pass_ref_2)
74 PHP_FE(http_negotiate_charset, http_arg_pass_ref_2)
75 PHP_FE(http_negotiate_content_type, http_arg_pass_ref_2)
76 PHP_FE(http_redirect, NULL)
77 PHP_FE(http_throttle, NULL)
78 PHP_FE(http_send_status, NULL)
79 PHP_FE(http_send_last_modified, NULL)
80 PHP_FE(http_send_content_type, NULL)
81 PHP_FE(http_send_content_disposition, NULL)
82 PHP_FE(http_match_modified, NULL)
83 PHP_FE(http_match_etag, NULL)
84 PHP_FE(http_cache_last_modified, NULL)
85 PHP_FE(http_cache_etag, NULL)
86 PHP_FE(http_send_data, NULL)
87 PHP_FE(http_send_file, NULL)
88 PHP_FE(http_send_stream, NULL)
89 PHP_FE(http_chunked_decode, NULL)
90 PHP_FE(http_parse_message, NULL)
91 PHP_FE(http_parse_headers, NULL)
92 PHP_FE(http_parse_cookie, NULL)
93 PHP_FE(http_get_request_headers, NULL)
94 PHP_FE(http_get_request_body, NULL)
95 PHP_FE(http_match_request_header, NULL)
96 #ifdef HTTP_HAVE_CURL
97 PHP_FE(http_get, http_arg_pass_ref_3)
98 PHP_FE(http_head, http_arg_pass_ref_3)
99 PHP_FE(http_post_data, http_arg_pass_ref_4)
100 PHP_FE(http_post_fields, http_arg_pass_ref_5)
101 PHP_FE(http_put_file, http_arg_pass_ref_4)
102 PHP_FE(http_put_stream, http_arg_pass_ref_4)
103 #endif
104 PHP_FE(http_request_method_register, NULL)
105 PHP_FE(http_request_method_unregister, NULL)
106 PHP_FE(http_request_method_exists, NULL)
107 PHP_FE(http_request_method_name, NULL)
108 #ifndef ZEND_ENGINE_2
109 PHP_FE(http_build_query, NULL)
110 #endif
111 PHP_FE(ob_etaghandler, NULL)
112 #ifdef HTTP_HAVE_ZLIB
113 PHP_FE(http_deflate, NULL)
114 PHP_FE(http_inflate, NULL)
115 PHP_FE(ob_deflatehandler, NULL)
116 PHP_FE(ob_inflatehandler, NULL)
117 #endif
118 PHP_FE(http_support, NULL)
119
120 EMPTY_FUNCTION_ENTRY
121 };
122 /* }}} */
123
124 /* {{{ http_module_dep */
125 #if ZEND_EXTENSION_API_NO >= 220050617
126 static zend_module_dep http_module_dep[] = {
127 # ifdef HAVE_SPL
128 ZEND_MOD_REQUIRED("spl")
129 # endif
130 # ifdef HTTP_HAVE_EXT_HASH
131 ZEND_MOD_REQUIRED("hash")
132 # endif
133 {NULL, NULL, NULL, 0}
134 };
135 #endif
136 /* }}} */
137
138 /* {{{ http_module_entry */
139 zend_module_entry http_module_entry = {
140 #if ZEND_EXTENSION_API_NO >= 220050617
141 STANDARD_MODULE_HEADER_EX, NULL,
142 http_module_dep,
143 #else
144 STANDARD_MODULE_HEADER,
145 #endif
146 "http",
147 http_functions,
148 PHP_MINIT(http),
149 PHP_MSHUTDOWN(http),
150 PHP_RINIT(http),
151 PHP_RSHUTDOWN(http),
152 PHP_MINFO(http),
153 PHP_EXT_HTTP_VERSION,
154 STANDARD_MODULE_PROPERTIES
155 };
156 /* }}} */
157
158 int http_module_number;
159
160 /* {{{ http_globals */
161 static void http_globals_init_once(zend_http_globals *G)
162 {
163 memset(G, 0, sizeof(zend_http_globals));
164 }
165
166 #define http_globals_init(g) _http_globals_init((g) TSRMLS_CC)
167 static inline void _http_globals_init(zend_http_globals *G TSRMLS_DC)
168 {
169 G->send.buffer_size = HTTP_SENDBUF_SIZE;
170 }
171
172 #define http_globals_free(g) _http_globals_free((g) TSRMLS_CC)
173 static inline void _http_globals_free(zend_http_globals *G TSRMLS_DC)
174 {
175 STR_SET(G->send.content_type, NULL);
176 STR_SET(G->send.unquoted_etag, NULL);
177 }
178 /* }}} */
179
180 /* {{{ static inline void http_check_allowed_methods(char *, int) */
181 #define http_check_allowed_methods(m, l) _http_check_allowed_methods((m), (l) TSRMLS_CC)
182 static inline void _http_check_allowed_methods(char *methods, int length TSRMLS_DC)
183 {
184 if (length && SG(request_info).request_method) {
185 if (SUCCESS != http_check_method_ex(SG(request_info).request_method, methods)) {
186 char *header = emalloc(length + sizeof("Allow: "));
187 sprintf(header, "Allow: %s", methods);
188 http_exit(405, header);
189 }
190 }
191 }
192 /* }}} */
193
194 /* {{{ PHP_INI */
195 PHP_INI_MH(http_update_allowed_methods)
196 {
197 http_check_allowed_methods(new_value, new_value_length);
198 return OnUpdateString(entry, new_value, new_value_length, mh_arg1, mh_arg2, mh_arg3, stage TSRMLS_CC);
199 }
200
201 #ifndef ZEND_ENGINE_2
202 # define OnUpdateLong OnUpdateInt
203 #endif
204
205 PHP_INI_BEGIN()
206 HTTP_PHP_INI_ENTRY("http.allowed_methods", "", PHP_INI_ALL, http_update_allowed_methods, request.methods.allowed)
207 HTTP_PHP_INI_ENTRY("http.cache_log", "", PHP_INI_ALL, OnUpdateString, log.cache)
208 HTTP_PHP_INI_ENTRY("http.redirect_log", "", PHP_INI_ALL, OnUpdateString, log.redirect)
209 HTTP_PHP_INI_ENTRY("http.allowed_methods_log", "", PHP_INI_ALL, OnUpdateString, log.allowed_methods)
210 HTTP_PHP_INI_ENTRY("http.composite_log", "", PHP_INI_ALL, OnUpdateString, log.composite)
211 HTTP_PHP_INI_ENTRY("http.etag_mode", "MD5", PHP_INI_ALL, OnUpdateString, etag.mode)
212 #ifdef ZEND_ENGINE_2
213 HTTP_PHP_INI_ENTRY("http.only_exceptions", "0", PHP_INI_ALL, OnUpdateBool, only_exceptions)
214 #endif
215 HTTP_PHP_INI_ENTRY("http.force_exit", "1", PHP_INI_ALL, OnUpdateBool, force_exit)
216 #ifdef HTTP_HAVE_ZLIB
217 HTTP_PHP_INI_ENTRY("http.ob_inflate_auto", "0", PHP_INI_PERDIR, OnUpdateBool, send.inflate.start_auto)
218 HTTP_PHP_INI_ENTRY("http.ob_inflate_flags", "0", PHP_INI_ALL, OnUpdateLong, send.inflate.start_flags)
219 HTTP_PHP_INI_ENTRY("http.ob_deflate_auto", "0", PHP_INI_PERDIR, OnUpdateBool, send.deflate.start_auto)
220 HTTP_PHP_INI_ENTRY("http.ob_deflate_flags", "0", PHP_INI_ALL, OnUpdateLong, send.deflate.start_flags)
221 #endif
222 PHP_INI_END()
223 /* }}} */
224
225 /* {{{ PHP_MINIT_FUNCTION */
226 PHP_MINIT_FUNCTION(http)
227 {
228 http_module_number = module_number;
229
230 ZEND_INIT_MODULE_GLOBALS(http, http_globals_init_once, NULL)
231
232 REGISTER_INI_ENTRIES();
233
234 if ( (SUCCESS != PHP_MINIT_CALL(http_support)) ||
235 (SUCCESS != PHP_MINIT_CALL(http_headers)) ||
236 #ifdef HTTP_HAVE_CURL
237 (SUCCESS != PHP_MINIT_CALL(http_request)) ||
238 #endif /* HTTP_HAVE_CURL */
239 #ifdef HTTP_HAVE_ZLIB
240 (SUCCESS != PHP_MINIT_CALL(http_encoding)) ||
241 #endif
242 (SUCCESS != PHP_MINIT_CALL(http_request_method))) {
243 return FAILURE;
244 }
245
246 #ifdef ZEND_ENGINE_2
247 if ( (SUCCESS != PHP_MINIT_CALL(http_filter)) ||
248 (SUCCESS != PHP_MINIT_CALL(http_util_object)) ||
249 (SUCCESS != PHP_MINIT_CALL(http_message_object)) ||
250 # ifndef WONKY
251 (SUCCESS != PHP_MINIT_CALL(http_response_object)) ||
252 # endif /* WONKY */
253 # ifdef HTTP_HAVE_CURL
254 (SUCCESS != PHP_MINIT_CALL(http_request_object)) ||
255 (SUCCESS != PHP_MINIT_CALL(http_requestpool_object))||
256 # endif /* HTTP_HAVE_CURL */
257 # ifdef HTTP_HAVE_ZLIB
258 (SUCCESS != PHP_MINIT_CALL(http_deflatestream_object)) ||
259 (SUCCESS != PHP_MINIT_CALL(http_inflatestream_object)) ||
260 # endif /* HTTP_HAVE_ZLIB */
261 (SUCCESS != PHP_MINIT_CALL(http_exception_object))) {
262 return FAILURE;
263 }
264 #endif /* ZEND_ENGINE_2 */
265
266 return SUCCESS;
267 }
268 /* }}} */
269
270 /* {{{ PHP_MSHUTDOWN_FUNCTION */
271 PHP_MSHUTDOWN_FUNCTION(http)
272 {
273 UNREGISTER_INI_ENTRIES();
274 #ifdef HTTP_HAVE_CURL
275 return PHP_MSHUTDOWN_CALL(http_request);
276 #endif
277 return SUCCESS;
278 }
279 /* }}} */
280
281 /* {{{ PHP_RINIT_FUNCTION */
282 PHP_RINIT_FUNCTION(http)
283 {
284 if (HTTP_G(request).methods.allowed) {
285 http_check_allowed_methods(HTTP_G(request).methods.allowed,
286 strlen(HTTP_G(request).methods.allowed));
287 }
288
289 http_globals_init(HTTP_GLOBALS);
290
291 if ( (SUCCESS != PHP_RINIT_CALL(http_request_method))
292 #ifdef HTTP_HAVE_ZLIB
293 || (SUCCESS != PHP_RINIT_CALL(http_encoding))
294 #endif
295 ) {
296 return FAILURE;
297 }
298
299 return SUCCESS;
300 }
301 /* }}} */
302
303 /* {{{ PHP_RSHUTDOWN_FUNCTION */
304 PHP_RSHUTDOWN_FUNCTION(http)
305 {
306 STATUS status = SUCCESS;
307
308 if ( (SUCCESS != PHP_RSHUTDOWN_CALL(http_request_method))
309 #ifdef HTTP_HAVE_ZLIB
310 || (SUCCESS != PHP_RSHUTDOWN_CALL(http_encoding))
311 #endif
312 ) {
313 status = FAILURE;
314 }
315
316 http_globals_free(HTTP_GLOBALS);
317 return status;
318 }
319 /* }}} */
320
321 /* {{{ PHP_MINFO_FUNCTION */
322 PHP_MINFO_FUNCTION(http)
323 {
324 php_info_print_table_start();
325 {
326 php_info_print_table_row(2, "HTTP Support", "enabled");
327 php_info_print_table_row(2, "Extension Version", PHP_EXT_HTTP_VERSION);
328 php_info_print_table_row(2, "Registered Classes",
329 #ifndef ZEND_ENGINE_2
330 "none"
331 #else
332 "HttpUtil, "
333 "HttpMessage, "
334 # ifdef HTTP_HAVE_CURL
335 "HttpRequest, "
336 "HttpRequestPool, "
337 # endif
338 # ifdef HTTP_HAVE_ZLIB
339 "HttpDeflateStream, "
340 "HttpInflateStream, "
341 # endif
342 # ifndef WONKY
343 "HttpResponse"
344 # endif
345 #endif
346 );
347 }
348 php_info_print_table_end();
349
350 php_info_print_table_start();
351 php_info_print_table_header(3, "Used Library", "Compiled", "Linked");
352 {
353 #ifdef HTTP_HAVE_CURL
354 curl_version_info_data *cv = curl_version_info(CURLVERSION_NOW);
355 php_info_print_table_row(3, "libcurl", LIBCURL_VERSION, cv->version);
356 #else
357 php_info_print_table_row(2, "libcurl", "disabled", "disabled");
358 #endif
359 #ifdef HTTP_HAVE_ZLIB
360 php_info_print_table_row(3, "libz", ZLIB_VERSION, zlibVersion());
361 #else
362 php_info_print_table_row(3, "libz", "disabled", "disabled");
363 #endif
364 #if defined(HTTP_HAVE_MAGIC) && !defined(WONKY)
365 php_info_print_table_row(3, "libmagic", "unknown", "unknown");
366 #else
367 php_info_print_table_row(3, "libmagic", "disabled", "disabled");
368 #endif
369 }
370 php_info_print_table_end();
371
372 php_info_print_table_start();
373 php_info_print_table_colspan_header(2, "Request Methods");
374 {
375 int i;
376 getGlobals(G);
377 struct _entry {char *name; char *cnst;} *entry;
378 phpstr *known_request_methods = phpstr_new();
379 phpstr *custom_request_methods = phpstr_new();
380
381 for (i = HTTP_MIN_REQUEST_METHOD; i < HTTP_MAX_REQUEST_METHOD; ++i) {
382 phpstr_appendl(known_request_methods, http_request_method_name(i));
383 phpstr_appends(known_request_methods, ", ");
384 }
385 for (i = 0; i < G->request.methods.custom.count; ++i) {
386 if ((entry = ((struct _entry **) G->request.methods.custom.entries)[i])) {
387 phpstr_appendf(custom_request_methods, "%s, ", entry->name);
388 }
389 }
390
391 phpstr_append(known_request_methods, PHPSTR_VAL(custom_request_methods), PHPSTR_LEN(custom_request_methods));
392 phpstr_fix(known_request_methods);
393 phpstr_fix(custom_request_methods);
394
395 php_info_print_table_row(2, "Known", PHPSTR_VAL(known_request_methods));
396 php_info_print_table_row(2, "Custom",
397 PHPSTR_LEN(custom_request_methods) ? PHPSTR_VAL(custom_request_methods) : "none registered");
398 php_info_print_table_row(2, "Allowed", strlen(HTTP_G(request).methods.allowed) ? HTTP_G(request).methods.allowed : "(ANY)");
399
400 phpstr_free(&known_request_methods);
401 phpstr_free(&custom_request_methods);
402 }
403 php_info_print_table_end();
404
405 DISPLAY_INI_ENTRIES();
406 }
407 /* }}} */
408
409 /*
410 * Local variables:
411 * tab-width: 4
412 * c-basic-offset: 4
413 * End:
414 * vim600: noet sw=4 ts=4 fdm=marker
415 * vim<600: noet sw=4 ts=4
416 */
417