- http_redirect(): proper check for ext/session; fix possible mem-leaks
[m6w6/ext-http] / http_functions.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 #ifdef HAVE_CONFIG_H
19 # include "config.h"
20 #endif
21 #include "php.h"
22
23 #include "SAPI.h"
24 #include "php_ini.h"
25 #include "ext/standard/info.h"
26 #include "ext/standard/php_string.h"
27 #if defined(HAVE_PHP_SESSION) && !defined(COMPILE_DL_SESSION)
28 # include "ext/session/php_session.h"
29 #endif
30
31 #include "php_http.h"
32 #include "php_http_std_defs.h"
33 #include "php_http_api.h"
34 #include "php_http_auth_api.h"
35 #include "php_http_request_api.h"
36 #include "php_http_cache_api.h"
37 #include "php_http_request_api.h"
38 #include "php_http_date_api.h"
39 #include "php_http_headers_api.h"
40 #include "php_http_message_api.h"
41 #include "php_http_send_api.h"
42 #include "php_http_url_api.h"
43
44 #include "phpstr/phpstr.h"
45
46 ZEND_EXTERN_MODULE_GLOBALS(http)
47
48 /* {{{ proto string http_date([int timestamp])
49 *
50 * This function returns a valid HTTP date regarding RFC 822/1123
51 * looking like: "Wed, 22 Dec 2004 11:34:47 GMT"
52 *
53 */
54 PHP_FUNCTION(http_date)
55 {
56 long t = -1;
57
58 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &t) != SUCCESS) {
59 RETURN_FALSE;
60 }
61
62 if (t == -1) {
63 t = (long) time(NULL);
64 }
65
66 RETURN_STRING(http_date(t), 0);
67 }
68 /* }}} */
69
70 /* {{{ proto string http_absolute_uri(string url[, string proto[, string host[, int port]]])
71 *
72 * This function returns an absolute URI constructed from url.
73 * If the url is already abolute but a different proto was supplied,
74 * only the proto part of the URI will be updated. If url has no
75 * path specified, the path of the current REQUEST_URI will be taken.
76 * The host will be taken either from the Host HTTP header of the client
77 * the SERVER_NAME or just localhost if prior are not available.
78 *
79 * Some examples:
80 * <pre>
81 * url = "page.php" => http://www.example.com/current/path/page.php
82 * url = "/page.php" => http://www.example.com/page.php
83 * url = "/page.php", proto = "https" => https://www.example.com/page.php
84 * </pre>
85 *
86 */
87 PHP_FUNCTION(http_absolute_uri)
88 {
89 char *url = NULL, *proto = NULL, *host = NULL;
90 int url_len = 0, proto_len = 0, host_len = 0;
91 long port = 0;
92
93 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|ssl", &url, &url_len, &proto, &proto_len, &host, &host_len, &port) != SUCCESS) {
94 RETURN_FALSE;
95 }
96
97 RETURN_STRING(http_absolute_uri_ex(url, url_len, proto, proto_len, host, host_len, port), 0);
98 }
99 /* }}} */
100
101 /* {{{ proto string http_negotiate_language(array supported[, string default = 'en-US'])
102 *
103 * This function negotiates the clients preferred language based on its
104 * Accept-Language HTTP header. It returns the negotiated language or
105 * the default language if none match.
106 *
107 * The qualifier is recognized and languages without qualifier are rated highest.
108 *
109 * The supported parameter is expected to be an array having
110 * the supported languages as array values.
111 *
112 * Example:
113 * <pre>
114 * <?php
115 * $langs = array(
116 * 'en-US',// default
117 * 'fr',
118 * 'fr-FR',
119 * 'de',
120 * 'de-DE',
121 * 'de-AT',
122 * 'de-CH',
123 * );
124 * include './langs/'. http_negotiate_language($langs) .'.php';
125 * ?>
126 * </pre>
127 *
128 */
129 PHP_FUNCTION(http_negotiate_language)
130 {
131 zval *supported;
132 char *def = NULL;
133 int def_len = 0;
134
135 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|s", &supported, &def, &def_len) != SUCCESS) {
136 RETURN_FALSE;
137 }
138
139 if (!def) {
140 def = "en-US";
141 }
142
143 RETURN_STRING(http_negotiate_language(supported, def), 0);
144 }
145 /* }}} */
146
147 /* {{{ proto string http_negotiate_charset(array supported[, string default = 'iso-8859-1'])
148 *
149 * This function negotiates the clients preferred charset based on its
150 * Accept-Charset HTTP header. It returns the negotiated charset or
151 * the default charset if none match.
152 *
153 * The qualifier is recognized and charset without qualifier are rated highest.
154 *
155 * The supported parameter is expected to be an array having
156 * the supported charsets as array values.
157 *
158 * Example:
159 * <pre>
160 * <?php
161 * $charsets = array(
162 * 'iso-8859-1', // default
163 * 'iso-8859-2',
164 * 'iso-8859-15',
165 * 'utf-8'
166 * );
167 * $pref = http_negotiate_charset($charsets);
168 * if (!strcmp($pref, 'iso-8859-1')) {
169 * iconv_set_encoding('internal_encoding', 'iso-8859-1');
170 * iconv_set_encoding('output_encoding', $pref);
171 * ob_start('ob_iconv_handler');
172 * }
173 * ?>
174 * </pre>
175 */
176 PHP_FUNCTION(http_negotiate_charset)
177 {
178 zval *supported;
179 char *def = NULL;
180 int def_len = 0;
181
182 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|s", &supported, &def, &def_len) != SUCCESS) {
183 RETURN_FALSE;
184 }
185
186 if (!def) {
187 def = "iso-8859-1";
188 }
189
190 RETURN_STRING(http_negotiate_charset(supported, def), 0);
191 }
192 /* }}} */
193
194 /* {{{ proto bool http_send_status(int status)
195 *
196 * Send HTTP status code.
197 *
198 */
199 PHP_FUNCTION(http_send_status)
200 {
201 int status = 0;
202
203 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &status) != SUCCESS) {
204 RETURN_FALSE;
205 }
206 if (status < 100 || status > 510) {
207 http_error_ex(HE_WARNING, HTTP_E_HEADER, "Invalid HTTP status code (100-510): %d", status);
208 RETURN_FALSE;
209 }
210
211 RETURN_SUCCESS(http_send_status(status));
212 }
213 /* }}} */
214
215 /* {{{ proto bool http_send_last_modified([int timestamp])
216 *
217 * This converts the given timestamp to a valid HTTP date and
218 * sends it as "Last-Modified" HTTP header. If timestamp is
219 * omitted, current time is sent.
220 *
221 */
222 PHP_FUNCTION(http_send_last_modified)
223 {
224 long t = -1;
225
226 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &t) != SUCCESS) {
227 RETURN_FALSE;
228 }
229
230 if (t == -1) {
231 t = (long) time(NULL);
232 }
233
234 RETURN_SUCCESS(http_send_last_modified(t));
235 }
236 /* }}} */
237
238 /* {{{ proto bool http_send_content_type([string content_type = 'application/x-octetstream'])
239 *
240 * Sets the content type.
241 *
242 */
243 PHP_FUNCTION(http_send_content_type)
244 {
245 char *ct;
246 int ct_len = 0;
247
248 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &ct, &ct_len) != SUCCESS) {
249 RETURN_FALSE;
250 }
251
252 if (!ct_len) {
253 RETURN_SUCCESS(http_send_content_type("application/x-octetstream", lenof("application/x-octetstream")));
254 }
255 RETURN_SUCCESS(http_send_content_type(ct, ct_len));
256 }
257 /* }}} */
258
259 /* {{{ proto bool http_send_content_disposition(string filename[, bool inline = false])
260 *
261 * Set the Content Disposition. The Content-Disposition header is very useful
262 * if the data actually sent came from a file or something similar, that should
263 * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
264 *
265 */
266 PHP_FUNCTION(http_send_content_disposition)
267 {
268 char *filename;
269 int f_len;
270 zend_bool send_inline = 0;
271
272 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &filename, &f_len, &send_inline) != SUCCESS) {
273 RETURN_FALSE;
274 }
275 RETURN_SUCCESS(http_send_content_disposition(filename, f_len, send_inline));
276 }
277 /* }}} */
278
279 /* {{{ proto bool http_match_modified([int timestamp[, for_range = false]])
280 *
281 * Matches the given timestamp against the clients "If-Modified-Since" resp.
282 * "If-Unmodified-Since" HTTP headers.
283 *
284 */
285 PHP_FUNCTION(http_match_modified)
286 {
287 long t = -1;
288 zend_bool for_range = 0;
289
290 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|lb", &t, &for_range) != SUCCESS) {
291 RETURN_FALSE;
292 }
293
294 // current time if not supplied (senseless though)
295 if (t == -1) {
296 t = (long) time(NULL);
297 }
298
299 if (for_range) {
300 RETURN_BOOL(http_match_last_modified("HTTP_IF_UNMODIFIED_SINCE", t));
301 }
302 RETURN_BOOL(http_match_last_modified("HTTP_IF_MODIFIED_SINCE", t));
303 }
304 /* }}} */
305
306 /* {{{ proto bool http_match_etag(string etag[, for_range = false])
307 *
308 * This matches the given ETag against the clients
309 * "If-Match" resp. "If-None-Match" HTTP headers.
310 *
311 */
312 PHP_FUNCTION(http_match_etag)
313 {
314 int etag_len;
315 char *etag;
316 zend_bool for_range = 0;
317
318 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &etag, &etag_len, &for_range) != SUCCESS) {
319 RETURN_FALSE;
320 }
321
322 if (for_range) {
323 RETURN_BOOL(http_match_etag("HTTP_IF_MATCH", etag));
324 }
325 RETURN_BOOL(http_match_etag("HTTP_IF_NONE_MATCH", etag));
326 }
327 /* }}} */
328
329 /* {{{ proto bool http_cache_last_modified([int timestamp_or_expires]])
330 *
331 * If timestamp_or_expires is greater than 0, it is handled as timestamp
332 * and will be sent as date of last modification. If it is 0 or omitted,
333 * the current time will be sent as Last-Modified date. If it's negative,
334 * it is handled as expiration time in seconds, which means that if the
335 * requested last modification date is not between the calculated timespan,
336 * the Last-Modified header is updated and the actual body will be sent.
337 *
338 */
339 PHP_FUNCTION(http_cache_last_modified)
340 {
341 long last_modified = 0, send_modified = 0, t;
342 zval *zlm;
343
344 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &last_modified) != SUCCESS) {
345 RETURN_FALSE;
346 }
347
348 t = (long) time(NULL);
349
350 /* 0 or omitted */
351 if (!last_modified) {
352 /* does the client have? (att: caching "forever") */
353 if (zlm = http_get_server_var("HTTP_IF_MODIFIED_SINCE")) {
354 last_modified = send_modified = http_parse_date(Z_STRVAL_P(zlm));
355 /* send current time */
356 } else {
357 send_modified = t;
358 }
359 /* negative value is supposed to be expiration time */
360 } else if (last_modified < 0) {
361 last_modified += t;
362 send_modified = t;
363 /* send supplied time explicitly */
364 } else {
365 send_modified = last_modified;
366 }
367
368 RETURN_SUCCESS(http_cache_last_modified(last_modified, send_modified, HTTP_DEFAULT_CACHECONTROL, lenof(HTTP_DEFAULT_CACHECONTROL)));
369 }
370 /* }}} */
371
372 /* {{{ proto bool http_cache_etag([string etag])
373 *
374 * This function attempts to cache the HTTP body based on an ETag,
375 * either supplied or generated through calculation of the MD5
376 * checksum of the output (uses output buffering).
377 *
378 * If clients "If-None-Match" header matches the supplied/calculated
379 * ETag, the body is considered cached on the clients side and
380 * a "304 Not Modified" status code is issued.
381 *
382 */
383 PHP_FUNCTION(http_cache_etag)
384 {
385 char *etag = NULL;
386 int etag_len = 0;
387
388 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &etag, &etag_len) != SUCCESS) {
389 RETURN_FALSE;
390 }
391
392 RETURN_SUCCESS(http_cache_etag(etag, etag_len, HTTP_DEFAULT_CACHECONTROL, lenof(HTTP_DEFAULT_CACHECONTROL)));
393 }
394 /* }}} */
395
396 /* {{{ proto string ob_etaghandler(string data, int mode)
397 *
398 * For use with ob_start().
399 */
400 PHP_FUNCTION(ob_etaghandler)
401 {
402 char *data;
403 int data_len;
404 long mode;
405
406 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sl", &data, &data_len, &mode)) {
407 RETURN_FALSE;
408 }
409
410 Z_TYPE_P(return_value) = IS_STRING;
411 http_ob_etaghandler(data, data_len, &Z_STRVAL_P(return_value), &Z_STRLEN_P(return_value), mode);
412 }
413 /* }}} */
414
415 /* {{{ proto void http_throttle(double sec[, long bytes = 2097152])
416 *
417 * Use with http_send() API.
418 *
419 * Example:
420 * <pre>
421 * <?php
422 * // ~ 20 kbyte/s
423 * # http_throttle(1, 20000);
424 * # http_throttle(0.5, 10000);
425 * # http_throttle(0.1, 2000);
426 * http_send_file('document.pdf');
427 * ?>
428 * </pre>
429 */
430 PHP_FUNCTION(http_throttle)
431 {
432 long chunk_size;
433 double interval;
434
435 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "dl", &interval, &chunk_size)) {
436 return;
437 }
438
439 HTTP_G(send).throttle_delay = interval;
440 HTTP_G(send).buffer_size = chunk_size;
441 }
442 /* }}} */
443
444 /* {{{ proto void http_redirect([string url[, array params[, bool session,[ bool permanent]]]])
445 *
446 * Redirect to a given url.
447 * The supplied url will be expanded with http_absolute_uri(), the params array will
448 * be treated with http_build_query() and the session identification will be appended
449 * if session is true.
450 *
451 * Depending on permanent the redirection will be issued with a permanent
452 * ("301 Moved Permanently") or a temporary ("302 Found") redirection
453 * status code.
454 *
455 * To be RFC compliant, "Redirecting to <a>URI</a>." will be displayed,
456 * if the client doesn't redirect immediatly.
457 */
458 PHP_FUNCTION(http_redirect)
459 {
460 int url_len;
461 size_t query_len = 0;
462 zend_bool session = 0, permanent = 0, free_params = 0;
463 zval *params = NULL;
464 char *query = NULL, *url = NULL, *URI,
465 LOC[HTTP_URI_MAXLEN + sizeof("Location: ")],
466 RED[HTTP_URI_MAXLEN * 2 + sizeof("Redirecting to <a href=\"%s?%s\">%s?%s</a>.\n")];
467
468 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sa!/bb", &url, &url_len, &params, &session, &permanent) != SUCCESS) {
469 RETURN_FALSE;
470 }
471
472 /* append session info */
473 if (session) {
474 if (!params) {
475 free_params = 1;
476 MAKE_STD_ZVAL(params);
477 array_init(params);
478 }
479 #ifdef HAVE_PHP_SESSION
480 # ifdef COMPILE_DL_SESSION
481 if (SUCCESS == zend_get_module_started("session")) {
482 zval nm_retval, id_retval, func;
483
484 INIT_PZVAL(&func);
485 INIT_PZVAL(&nm_retval);
486 INIT_PZVAL(&id_retval);
487 ZVAL_NULL(&nm_retval);
488 ZVAL_NULL(&id_retval);
489
490 ZVAL_STRINGL(&func, "session_id", lenof("session_id"), 0);
491 call_user_function(EG(function_table), NULL, &func, &id_retval, 0, NULL TSRMLS_CC);
492 ZVAL_STRINGL(&func, "session_name", lenof("session_name"), 0);
493 call_user_function(EG(function_table), NULL, &func, &nm_retval, 0, NULL TSRMLS_CC);
494
495 if ( Z_TYPE(nm_retval) == IS_STRING && Z_STRLEN(nm_retval) &&
496 Z_TYPE(id_retval) == IS_STRING && Z_STRLEN(id_retval)) {
497 if (add_assoc_stringl_ex(params, Z_STRVAL(nm_retval), Z_STRLEN(nm_retval)+1,
498 Z_STRVAL(id_retval), Z_STRLEN(id_retval), 0) != SUCCESS) {
499 http_error(HE_WARNING, HTTP_E_RUNTIME, "Could not append session information");
500 }
501 }
502 }
503 # else
504 if (PS(session_status) == php_session_active) {
505 if (add_assoc_string(params, PS(session_name), PS(id), 1) != SUCCESS) {
506 http_error(HE_WARNING, HTTP_E_RUNTIME, "Could not append session information");
507 }
508 }
509 # endif
510 #endif
511 }
512
513 /* treat params array with http_build_query() */
514 if (params) {
515 if (SUCCESS != http_urlencode_hash_ex(Z_ARRVAL_P(params), 0, NULL, 0, &query, &query_len)) {
516 if (free_params) {
517 zval_dtor(params);
518 FREE_ZVAL(params);
519 }
520 if (query) {
521 efree(query);
522 }
523 RETURN_FALSE;
524 }
525 }
526
527 URI = http_absolute_uri(url);
528
529 if (query_len) {
530 snprintf(LOC, HTTP_URI_MAXLEN + sizeof("Location: "), "Location: %s?%s", URI, query);
531 sprintf(RED, "Redirecting to <a href=\"%s?%s\">%s?%s</a>.\n", URI, query, URI, query);
532 } else {
533 snprintf(LOC, HTTP_URI_MAXLEN + sizeof("Location: "), "Location: %s", URI);
534 sprintf(RED, "Redirecting to <a href=\"%s\">%s</a>.\n", URI, URI);
535 }
536
537 efree(URI);
538 if (query) {
539 efree(query);
540 }
541 if (free_params) {
542 zval_dtor(params);
543 FREE_ZVAL(params);
544 }
545
546 if ((SUCCESS == http_send_header_string(LOC)) && (SUCCESS == http_send_status((permanent ? 301 : 302)))) {
547 if (SG(request_info).request_method && strcmp(SG(request_info).request_method, "HEAD")) {
548 PHPWRITE(RED, strlen(RED));
549 }
550 RETURN_TRUE;
551 }
552 RETURN_FALSE;
553 }
554 /* }}} */
555
556 /* {{{ proto bool http_send_data(string data)
557 *
558 * Sends raw data with support for (multiple) range requests.
559 *
560 */
561 PHP_FUNCTION(http_send_data)
562 {
563 zval *zdata;
564
565 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &zdata) != SUCCESS) {
566 RETURN_FALSE;
567 }
568
569 convert_to_string_ex(&zdata);
570 RETURN_SUCCESS(http_send_data(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata)));
571 }
572 /* }}} */
573
574 /* {{{ proto bool http_send_file(string file)
575 *
576 * Sends a file with support for (multiple) range requests.
577 *
578 */
579 PHP_FUNCTION(http_send_file)
580 {
581 char *file;
582 int flen = 0;
583
584 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &file, &flen) != SUCCESS) {
585 RETURN_FALSE;
586 }
587 if (!flen) {
588 RETURN_FALSE;
589 }
590
591 RETURN_SUCCESS(http_send_file(file));
592 }
593 /* }}} */
594
595 /* {{{ proto bool http_send_stream(resource stream)
596 *
597 * Sends an already opened stream with support for (multiple) range requests.
598 *
599 */
600 PHP_FUNCTION(http_send_stream)
601 {
602 zval *zstream;
603 php_stream *file;
604
605 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &zstream) != SUCCESS) {
606 RETURN_FALSE;
607 }
608
609 php_stream_from_zval(file, &zstream);
610 RETURN_SUCCESS(http_send_stream(file));
611 }
612 /* }}} */
613
614 /* {{{ proto string http_chunked_decode(string encoded)
615 *
616 * This function decodes a string that was HTTP-chunked encoded.
617 * Returns false on failure.
618 */
619 PHP_FUNCTION(http_chunked_decode)
620 {
621 char *encoded = NULL, *decoded = NULL;
622 int encoded_len = 0, decoded_len = 0;
623
624 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &encoded, &encoded_len) != SUCCESS) {
625 RETURN_FALSE;
626 }
627
628 if (NULL != http_chunked_decode(encoded, encoded_len, &decoded, &decoded_len)) {
629 RETURN_STRINGL(decoded, decoded_len, 0);
630 } else {
631 RETURN_FALSE;
632 }
633 }
634 /* }}} */
635
636 /* {{{ proto array http_split_response(string http_response)
637 *
638 * This function splits an HTTP response into an array with headers and the
639 * content body. The returned array may look simliar to the following example:
640 *
641 * <pre>
642 * <?php
643 * array(
644 * 0 => array(
645 * 'Response Status' => '200 Ok',
646 * 'Content-Type' => 'text/plain',
647 * 'Content-Language' => 'en-US'
648 * ),
649 * 1 => "Hello World!"
650 * );
651 * ?>
652 * </pre>
653 */
654 PHP_FUNCTION(http_split_response)
655 {
656 char *response, *body;
657 int response_len;
658 size_t body_len;
659 zval *zheaders;
660
661 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &response, &response_len) != SUCCESS) {
662 RETURN_FALSE;
663 }
664
665 MAKE_STD_ZVAL(zheaders);
666 array_init(zheaders);
667
668 if (SUCCESS != http_split_response(response, response_len, Z_ARRVAL_P(zheaders), &body, &body_len)) {
669 RETURN_FALSE;
670 }
671
672 array_init(return_value);
673 add_index_zval(return_value, 0, zheaders);
674 add_index_stringl(return_value, 1, body, body_len, 0);
675 }
676 /* }}} */
677
678 /* {{{ proto array http_parse_headers(string header)
679 *
680 */
681 PHP_FUNCTION(http_parse_headers)
682 {
683 char *header;
684 int header_len;
685
686 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &header, &header_len)) {
687 RETURN_FALSE;
688 }
689
690 array_init(return_value);
691 if (SUCCESS != http_parse_headers(header, return_value)) {
692 zval_dtor(return_value);
693 RETURN_FALSE;
694 }
695 }
696 /* }}}*/
697
698 /* {{{ proto array http_get_request_headers(void)
699 *
700 * Get a list of incoming HTTP headers.
701 */
702 PHP_FUNCTION(http_get_request_headers)
703 {
704 NO_ARGS;
705
706 array_init(return_value);
707 http_get_request_headers(return_value);
708 }
709 /* }}} */
710
711 /* {{{ proto string http_get_request_body(void)
712 *
713 * Get the raw request body (e.g. POST or PUT data).
714 */
715 PHP_FUNCTION(http_get_request_body)
716 {
717 char *body;
718 size_t length;
719
720 NO_ARGS;
721
722 if (SUCCESS == http_get_request_body(&body, &length)) {
723 RETURN_STRINGL(body, (int) length, 0);
724 } else {
725 RETURN_NULL();
726 }
727 }
728 /* }}} */
729
730 /* {{{ proto bool http_match_request_header(string header, string value[, bool match_case = false])
731 *
732 * Match an incoming HTTP header.
733 */
734 PHP_FUNCTION(http_match_request_header)
735 {
736 char *header, *value;
737 int header_len, value_len;
738 zend_bool match_case = 0;
739
740 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|b", &header, &header_len, &value, &value_len, &match_case)) {
741 RETURN_FALSE;
742 }
743
744 RETURN_BOOL(http_match_request_header_ex(header, value, match_case));
745 }
746 /* }}} */
747
748 /* {{{ HAVE_CURL */
749 #ifdef HTTP_HAVE_CURL
750
751 /* {{{ proto string http_get(string url[, array options[, array &info]])
752 *
753 * Performs an HTTP GET request on the supplied url.
754 *
755 * The second parameter is expected to be an associative
756 * array where the following keys will be recognized:
757 * <pre>
758 * - redirect: int, whether and how many redirects to follow
759 * - unrestrictedauth: bool, whether to continue sending credentials on
760 * redirects to a different host
761 * - proxyhost: string, proxy host in "host[:port]" format
762 * - proxyport: int, use another proxy port as specified in proxyhost
763 * - proxyauth: string, proxy credentials in "user:pass" format
764 * - proxyauthtype: int, HTTP_AUTH_BASIC and/or HTTP_AUTH_NTLM
765 * - httpauth: string, http credentials in "user:pass" format
766 * - httpauthtype: int, HTTP_AUTH_BASIC, DIGEST and/or NTLM
767 * - compress: bool, whether to allow gzip/deflate content encoding
768 * (defaults to true)
769 * - port: int, use another port as specified in the url
770 * - referer: string, the referer to sends
771 * - useragent: string, the user agent to send
772 * (defaults to PECL::HTTP/version (PHP/version)))
773 * - headers: array, list of custom headers as associative array
774 * like array("header" => "value")
775 * - cookies: array, list of cookies as associative array
776 * like array("cookie" => "value")
777 * - cookiestore: string, path to a file where cookies are/will be stored
778 * - resume: int, byte offset to start the download from;
779 * if the server supports ranges
780 * - maxfilesize: int, maximum file size that should be downloaded;
781 * has no effect, if the size of the requested entity is not known
782 * - lastmodified: int, timestamp for If-(Un)Modified-Since header
783 * - timeout: int, seconds the request may take
784 * - connecttimeout: int, seconds the connect may take
785 * - onprogress: mixed, progress callback
786 * </pre>
787 *
788 * The optional third parameter will be filled with some additional information
789 * in form af an associative array, if supplied, like the following example:
790 * <pre>
791 * <?php
792 * array (
793 * 'effective_url' => 'http://localhost',
794 * 'response_code' => 403,
795 * 'total_time' => 0.017,
796 * 'namelookup_time' => 0.013,
797 * 'connect_time' => 0.014,
798 * 'pretransfer_time' => 0.014,
799 * 'size_upload' => 0,
800 * 'size_download' => 202,
801 * 'speed_download' => 11882,
802 * 'speed_upload' => 0,
803 * 'header_size' => 145,
804 * 'request_size' => 62,
805 * 'ssl_verifyresult' => 0,
806 * 'filetime' => -1,
807 * 'content_length_download' => 202,
808 * 'content_length_upload' => 0,
809 * 'starttransfer_time' => 0.017,
810 * 'content_type' => 'text/html; charset=iso-8859-1',
811 * 'redirect_time' => 0,
812 * 'redirect_count' => 0,
813 * 'private' => '',
814 * 'http_connectcode' => 0,
815 * 'httpauth_avail' => 0,
816 * 'proxyauth_avail' => 0,
817 * )
818 * ?>
819 * </pre>
820 */
821 PHP_FUNCTION(http_get)
822 {
823 zval *options = NULL, *info = NULL;
824 char *URL;
825 int URL_len;
826 phpstr response;
827
828 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a/!z", &URL, &URL_len, &options, &info) != SUCCESS) {
829 RETURN_FALSE;
830 }
831
832 if (info) {
833 zval_dtor(info);
834 array_init(info);
835 }
836
837 phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
838 if (SUCCESS == http_get(URL, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
839 RETURN_PHPSTR_VAL(response);
840 } else {
841 RETURN_FALSE;
842 }
843 }
844 /* }}} */
845
846 /* {{{ proto string http_head(string url[, array options[, array &info]])
847 *
848 * Performs an HTTP HEAD request on the suppied url.
849 * Returns the HTTP response as string.
850 * See http_get() for a full list of available options.
851 */
852 PHP_FUNCTION(http_head)
853 {
854 zval *options = NULL, *info = NULL;
855 char *URL;
856 int URL_len;
857 phpstr response;
858
859 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a/!z", &URL, &URL_len, &options, &info) != SUCCESS) {
860 RETURN_FALSE;
861 }
862
863 if (info) {
864 zval_dtor(info);
865 array_init(info);
866 }
867
868 phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
869 if (SUCCESS == http_head(URL, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
870 RETURN_PHPSTR_VAL(response);
871 } else {
872 RETURN_FALSE;
873 }
874 }
875 /* }}} */
876
877 /* {{{ proto string http_post_data(string url, string data[, array options[, &info]])
878 *
879 * Performs an HTTP POST request, posting data.
880 * Returns the HTTP response as string.
881 * See http_get() for a full list of available options.
882 */
883 PHP_FUNCTION(http_post_data)
884 {
885 zval *options = NULL, *info = NULL;
886 char *URL, *postdata;
887 int postdata_len, URL_len;
888 phpstr response;
889 http_request_body body;
890
891 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|a/!z", &URL, &URL_len, &postdata, &postdata_len, &options, &info) != SUCCESS) {
892 RETURN_FALSE;
893 }
894
895 if (info) {
896 zval_dtor(info);
897 array_init(info);
898 }
899
900 body.type = HTTP_REQUEST_BODY_CSTRING;
901 body.data = postdata;
902 body.size = postdata_len;
903
904 phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
905 if (SUCCESS == http_post(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
906 RETVAL_PHPSTR_VAL(response);
907 } else {
908 RETVAL_FALSE;
909 }
910 }
911 /* }}} */
912
913 /* {{{ proto string http_post_fields(string url, array data[, array files[, array options[, array &info]]])
914 *
915 * Performs an HTTP POST request, posting www-form-urlencoded array data.
916 * Returns the HTTP response as string.
917 * See http_get() for a full list of available options.
918 */
919 PHP_FUNCTION(http_post_fields)
920 {
921 zval *options = NULL, *info = NULL, *fields, *files = NULL;
922 char *URL;
923 int URL_len;
924 phpstr response;
925 http_request_body body;
926
927 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sa|aa/!z", &URL, &URL_len, &fields, &files, &options, &info) != SUCCESS) {
928 RETURN_FALSE;
929 }
930
931 if (SUCCESS != http_request_body_fill(&body, Z_ARRVAL_P(fields), files ? Z_ARRVAL_P(files) : NULL)) {
932 RETURN_FALSE;
933 }
934
935 if (info) {
936 zval_dtor(info);
937 array_init(info);
938 }
939
940 phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
941 if (SUCCESS == http_post(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
942 RETVAL_PHPSTR_VAL(response);
943 } else {
944 RETVAL_FALSE;
945 }
946 http_request_body_dtor(&body);
947 }
948 /* }}} */
949
950 /* {{{ proto string http_put_file(string url, string file[, array options[, array &info]])
951 *
952 * Performs an HTTP PUT request, uploading file.
953 * Returns the HTTP response as string.
954 * See http_get() for a full list of available options.
955 */
956 PHP_FUNCTION(http_put_file)
957 {
958 char *URL, *file;
959 int URL_len, f_len;
960 zval *options = NULL, *info = NULL;
961 phpstr response;
962 php_stream *stream;
963 php_stream_statbuf ssb;
964 http_request_body body;
965
966 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|a/!z", &URL, &URL_len, &file, &f_len, &options, &info)) {
967 RETURN_FALSE;
968 }
969
970 if (!(stream = php_stream_open_wrapper(file, "rb", REPORT_ERRORS|ENFORCE_SAFE_MODE, NULL))) {
971 RETURN_FALSE;
972 }
973 if (php_stream_stat(stream, &ssb)) {
974 php_stream_close(stream);
975 RETURN_FALSE;
976 }
977
978 if (info) {
979 zval_dtor(info);
980 array_init(info);
981 }
982
983 body.type = HTTP_REQUEST_BODY_UPLOADFILE;
984 body.data = stream;
985 body.size = ssb.sb.st_size;
986
987 phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
988 if (SUCCESS == http_put(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
989 RETVAL_PHPSTR_VAL(response);
990 } else {
991 RETVAL_FALSE;
992 }
993 http_request_body_dtor(&body);
994 }
995 /* }}} */
996
997 /* {{{ proto string http_put_stream(string url, resource stream[, array options[, array &info]])
998 *
999 * Performs an HTTP PUT request, uploading stream.
1000 * Returns the HTTP response as string.
1001 * See http_get() for a full list of available options.
1002 */
1003 PHP_FUNCTION(http_put_stream)
1004 {
1005 zval *resource, *options = NULL, *info = NULL;
1006 char *URL;
1007 int URL_len;
1008 phpstr response;
1009 php_stream *stream;
1010 php_stream_statbuf ssb;
1011 http_request_body body;
1012
1013 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sr|a/!z", &URL, &URL_len, &resource, &options, &info)) {
1014 RETURN_FALSE;
1015 }
1016
1017 php_stream_from_zval(stream, &resource);
1018 if (php_stream_stat(stream, &ssb)) {
1019 RETURN_FALSE;
1020 }
1021
1022 if (info) {
1023 zval_dtor(info);
1024 array_init(info);
1025 }
1026
1027 body.type = HTTP_REQUEST_BODY_UPLOADFILE;
1028 body.data = stream;
1029 body.size = ssb.sb.st_size;
1030
1031 phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
1032 if (SUCCESS == http_put(URL, &body, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
1033 RETURN_PHPSTR_VAL(response);
1034 } else {
1035 RETURN_NULL();
1036 }
1037 }
1038 /* }}} */
1039
1040 /* {{{ proto long http_request_method_register(string method)
1041 *
1042 * Register a custom request method.
1043 */
1044 PHP_FUNCTION(http_request_method_register)
1045 {
1046 char *method;
1047 int *method_len;
1048 unsigned long existing;
1049
1050 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &method, &method_len)) {
1051 RETURN_FALSE;
1052 }
1053 if (existing = http_request_method_exists(1, 0, method)) {
1054 RETURN_LONG((long) existing);
1055 }
1056
1057 RETVAL_LONG((long) http_request_method_register(method));
1058 }
1059 /* }}} */
1060
1061 /* {{{ proto bool http_request_method_unregister(mixed method)
1062 *
1063 * Unregister a previously registered custom request method.
1064 */
1065 PHP_FUNCTION(http_request_method_unregister)
1066 {
1067 zval *method;
1068
1069 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z/", &method)) {
1070 RETURN_FALSE;
1071 }
1072
1073 switch (Z_TYPE_P(method))
1074 {
1075 case IS_OBJECT:
1076 convert_to_string(method);
1077 case IS_STRING:
1078 #include "zend_operators.h"
1079 if (is_numeric_string(Z_STRVAL_P(method), Z_STRLEN_P(method), NULL, NULL, 1)) {
1080 convert_to_long(method);
1081 } else {
1082 unsigned long mn;
1083 if (!(mn = http_request_method_exists(1, 0, Z_STRVAL_P(method)))) {
1084 RETURN_FALSE;
1085 }
1086 zval_dtor(method);
1087 ZVAL_LONG(method, (long)mn);
1088 }
1089 case IS_LONG:
1090 RETURN_SUCCESS(http_request_method_unregister(Z_LVAL_P(method)));
1091 default:
1092 RETURN_FALSE;
1093 }
1094 }
1095 /* }}} */
1096
1097 /* {{{ proto long http_request_method_exists(mixed method)
1098 *
1099 * Check if a request method is registered (or available by default).
1100 */
1101 PHP_FUNCTION(http_request_method_exists)
1102 {
1103 IF_RETVAL_USED {
1104 zval *method;
1105
1106 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z/", &method)) {
1107 RETURN_FALSE;
1108 }
1109
1110 switch (Z_TYPE_P(method))
1111 {
1112 case IS_OBJECT:
1113 convert_to_string(method);
1114 case IS_STRING:
1115 if (is_numeric_string(Z_STRVAL_P(method), Z_STRLEN_P(method), NULL, NULL, 1)) {
1116 convert_to_long(method);
1117 } else {
1118 RETURN_LONG((long) http_request_method_exists(1, 0, Z_STRVAL_P(method)));
1119 }
1120 case IS_LONG:
1121 RETURN_LONG((long) http_request_method_exists(0, Z_LVAL_P(method), NULL));
1122 default:
1123 RETURN_FALSE;
1124 }
1125 }
1126 }
1127 /* }}} */
1128
1129 /* {{{ proto string http_request_method_name(long method)
1130 *
1131 * Get the literal string representation of a standard or registered request method.
1132 */
1133 PHP_FUNCTION(http_request_method_name)
1134 {
1135 IF_RETVAL_USED {
1136 long method;
1137
1138 if ((SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &method)) || (method < 0)) {
1139 RETURN_FALSE;
1140 }
1141
1142 RETURN_STRING(estrdup(http_request_method_name((unsigned long) method)), 0);
1143 }
1144 }
1145 /* }}} */
1146 #endif
1147 /* }}} HAVE_CURL */
1148
1149
1150 /* {{{ proto bool http_auth_basic(string user, string pass[, string realm = "Restricted"])
1151 *
1152 * Example:
1153 * <pre>
1154 * <?php
1155 * if (!http_auth_basic('mike', 's3c|r3t')) {
1156 * die('<h1>Authorization failed!</h1>');
1157 * }
1158 * ?>
1159 * </pre>
1160 */
1161 PHP_FUNCTION(http_auth_basic)
1162 {
1163 char *realm = NULL, *user, *pass, *suser, *spass;
1164 int r_len, u_len, p_len;
1165
1166 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|s", &user, &u_len, &pass, &p_len, &realm, &r_len) != SUCCESS) {
1167 RETURN_FALSE;
1168 }
1169
1170 if (!realm) {
1171 realm = "Restricted";
1172 }
1173
1174 if (SUCCESS != http_auth_basic_credentials(&suser, &spass)) {
1175 http_auth_basic_header(realm);
1176 RETURN_FALSE;
1177 }
1178
1179 if (strcasecmp(suser, user)) {
1180 http_auth_basic_header(realm);
1181 RETURN_FALSE;
1182 }
1183
1184 if (strcmp(spass, pass)) {
1185 http_auth_basic_header(realm);
1186 RETURN_FALSE;
1187 }
1188
1189 RETURN_TRUE;
1190 }
1191 /* }}} */
1192
1193 /* {{{ proto bool http_auth_basic_cb(mixed callback[, string realm = "Restricted"])
1194 *
1195 * Example:
1196 * <pre>
1197 * <?php
1198 * function auth_cb($user, $pass)
1199 * {
1200 * global $db;
1201 * $query = 'SELECT pass FROM users WHERE user='. $db->quoteSmart($user);
1202 * if (strlen($realpass = $db->getOne($query)) {
1203 * return $pass === $realpass;
1204 * }
1205 * return false;
1206 * }
1207 * if (!http_auth_basic_cb('auth_cb')) {
1208 * die('<h1>Authorization failed</h1>');
1209 * }
1210 * ?>
1211 * </pre>
1212 */
1213 PHP_FUNCTION(http_auth_basic_cb)
1214 {
1215 zval *cb;
1216 char *realm = NULL, *user, *pass;
1217 int r_len;
1218
1219 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z|s", &cb, &realm, &r_len) != SUCCESS) {
1220 RETURN_FALSE;
1221 }
1222
1223 if (!realm) {
1224 realm = "Restricted";
1225 }
1226
1227 if (SUCCESS != http_auth_basic_credentials(&user, &pass)) {
1228 http_auth_basic_header(realm);
1229 RETURN_FALSE;
1230 }
1231 {
1232 zval *zparams[2] = {NULL, NULL}, retval;
1233 int result = 0;
1234
1235 MAKE_STD_ZVAL(zparams[0]);
1236 MAKE_STD_ZVAL(zparams[1]);
1237 ZVAL_STRING(zparams[0], user, 0);
1238 ZVAL_STRING(zparams[1], pass, 0);
1239
1240 if (SUCCESS == call_user_function(EG(function_table), NULL, cb,
1241 &retval, 2, zparams TSRMLS_CC)) {
1242 result = Z_LVAL(retval);
1243 }
1244
1245 efree(user);
1246 efree(pass);
1247 efree(zparams[0]);
1248 efree(zparams[1]);
1249
1250 if (!result) {
1251 http_auth_basic_header(realm);
1252 }
1253
1254 RETURN_BOOL(result);
1255 }
1256 }
1257 /* }}}*/
1258
1259 /* {{{ Sara Golemons http_build_query() */
1260 #ifndef ZEND_ENGINE_2
1261
1262 /* {{{ proto string http_build_query(mixed formdata [, string prefix[, string arg_separator]])
1263 Generates a form-encoded query string from an associative array or object. */
1264 PHP_FUNCTION(http_build_query)
1265 {
1266 zval *formdata;
1267 char *prefix = NULL, *arg_sep = INI_STR("arg_separator.output");
1268 int prefix_len = 0, arg_sep_len = strlen(arg_sep);
1269 phpstr *formstr;
1270
1271 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z|ss", &formdata, &prefix, &prefix_len, &arg_sep, &arg_sep_len) != SUCCESS) {
1272 RETURN_FALSE;
1273 }
1274
1275 if (Z_TYPE_P(formdata) != IS_ARRAY && Z_TYPE_P(formdata) != IS_OBJECT) {
1276 http_error(HE_WARNING, HTTP_E_INVALID_PARAM, "Parameter 1 expected to be Array or Object. Incorrect value given.");
1277 RETURN_FALSE;
1278 }
1279
1280 if (!arg_sep_len) {
1281 arg_sep = HTTP_URL_ARGSEP;
1282 }
1283
1284 formstr = phpstr_new();
1285 if (SUCCESS != http_urlencode_hash_implementation_ex(HASH_OF(formdata), formstr, arg_sep, prefix, prefix_len, NULL, 0, NULL, 0, (Z_TYPE_P(formdata) == IS_OBJECT ? formdata : NULL))) {
1286 phpstr_free(formstr);
1287 RETURN_FALSE;
1288 }
1289
1290 if (!formstr->used) {
1291 phpstr_free(formstr);
1292 RETURN_NULL();
1293 }
1294
1295 RETURN_PHPSTR_PTR(formstr);
1296 }
1297 /* }}} */
1298 #endif /* !ZEND_ENGINE_2 */
1299 /* }}} */
1300
1301 PHP_FUNCTION(http_test)
1302 {
1303 }
1304
1305 /*
1306 * Local variables:
1307 * tab-width: 4
1308 * c-basic-offset: 4
1309 * End:
1310 * vim600: noet sw=4 ts=4 fdm=marker
1311 * vim<600: noet sw=4 ts=4
1312 */
1313