2 +--------------------------------------------------------------------+
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 +--------------------------------------------------------------------+
19 #define HTTP_WANT_CURL
20 #define HTTP_WANT_ZLIB
25 #include "ext/standard/info.h"
26 #include "ext/standard/php_string.h"
27 #include "zend_operators.h"
29 #ifdef HAVE_PHP_SESSION
30 # include "ext/session/php_session.h"
33 #include "php_http_api.h"
34 #include "php_http_cache_api.h"
35 #include "php_http_date_api.h"
36 #include "php_http_encoding_api.h"
37 #include "php_http_headers_api.h"
38 #include "php_http_message_api.h"
39 #include "php_http_request_api.h"
40 #include "php_http_request_method_api.h"
41 #include "php_http_send_api.h"
42 #include "php_http_url_api.h"
44 /* {{{ proto string http_date([int timestamp])
46 * Compose a valid HTTP date regarding RFC 822/1123
47 * looking like: "Wed, 22 Dec 2004 11:34:47 GMT"
49 * Takes an optional unix timestamp as parameter.
51 * Returns the HTTP date as string.
53 PHP_FUNCTION(http_date
)
57 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &t
) != SUCCESS
) {
62 t
= (long) time(NULL
);
65 RETURN_STRING(http_date(t
), 0);
69 /* {{{ proto string http_build_url(mixed url[, mixed parts[, array &new_url]])
71 * Returns the new URL as string on success or FALSE on failure.
73 PHP_FUNCTION(http_build_url
)
77 zval
*z_old_url
= NULL
, *z_new_url
= NULL
, *z_composed_url
= NULL
;
78 php_url
*old_url
= NULL
, *new_url
= NULL
, *composed_url
= NULL
;
80 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z/|z/z", &z_old_url
, &z_new_url
, &z_composed_url
) != SUCCESS
) {
85 if (Z_TYPE_P(z_new_url
) == IS_ARRAY
|| Z_TYPE_P(z_new_url
) == IS_OBJECT
) {
86 new_url
= array2url(HASH_OF(z_new_url
));
88 convert_to_string(z_new_url
);
89 if (!(new_url
= php_url_parse_ex(Z_STRVAL_P(z_new_url
), Z_STRLEN_P(z_new_url
)))) {
90 http_error_ex(HE_WARNING
, HTTP_E_URL
, "Could not parse URL (%s)", Z_STRVAL_P(z_new_url
));
96 if (Z_TYPE_P(z_old_url
) == IS_ARRAY
|| Z_TYPE_P(z_old_url
) == IS_OBJECT
) {
97 old_url
= array2url(HASH_OF(z_old_url
));
99 convert_to_string(z_old_url
);
100 if (!(old_url
= php_url_parse_ex(Z_STRVAL_P(z_old_url
), Z_STRLEN_P(z_old_url
)))) {
102 php_url_free(new_url
);
104 http_error_ex(HE_WARNING
, HTTP_E_URL
, "Could not parse URL (%s)", Z_STRVAL_P(z_old_url
));
109 if (z_composed_url
) {
110 http_build_url(old_url
, new_url
, &composed_url
, &url_str
, &url_len
);
112 zval_dtor(z_composed_url
);
113 array_init(z_composed_url
);
114 if (composed_url
->scheme
) {
115 add_assoc_string(z_composed_url
, "scheme", composed_url
->scheme
, 1);
117 if (composed_url
->user
) {
118 add_assoc_string(z_composed_url
, "user", composed_url
->user
, 1);
120 if (composed_url
->pass
) {
121 add_assoc_string(z_composed_url
, "pass", composed_url
->pass
, 1);
123 if (composed_url
->host
) {
124 add_assoc_string(z_composed_url
, "host", composed_url
->host
, 1);
126 if (composed_url
->port
) {
127 add_assoc_long(z_composed_url
, "port", composed_url
->port
);
129 if (composed_url
->path
) {
130 add_assoc_string(z_composed_url
, "path", composed_url
->path
, 1);
132 if (composed_url
->query
) {
133 add_assoc_string(z_composed_url
, "query", composed_url
->query
, 1);
135 if (composed_url
->fragment
) {
136 add_assoc_string(z_composed_url
, "fragment", composed_url
->fragment
, 1);
138 php_url_free(composed_url
);
140 http_build_url(old_url
, new_url
, NULL
, &url_str
, &url_len
);
144 php_url_free(new_url
);
146 php_url_free(old_url
);
148 RETURN_STRINGL(url_str
, url_len
, 0);
152 #define HTTP_DO_NEGOTIATE(type, supported, rs_array) \
155 if ((result = http_negotiate_ ##type(supported))) { \
160 if (HASH_KEY_IS_STRING == zend_hash_get_current_key_ex(result, &key, &key_len, &idx, 1, NULL)) { \
161 RETVAL_STRINGL(key, key_len-1, 0); \
167 zend_hash_copy(Z_ARRVAL_P(rs_array), result, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *)); \
170 zend_hash_destroy(result); \
171 FREE_HASHTABLE(result); \
176 zend_hash_internal_pointer_reset(Z_ARRVAL_P(supported)); \
177 if (SUCCESS == zend_hash_get_current_data(Z_ARRVAL_P(supported), (void **) &value)) { \
178 RETVAL_ZVAL(*value, 1, 0); \
187 FOREACH_VAL(pos, supported, value) { \
188 convert_to_string_ex(value); \
189 add_assoc_double(rs_array, Z_STRVAL_PP(value), 1.0); \
196 /* {{{ proto string http_negotiate_language(array supported[, array &result])
198 * This function negotiates the clients preferred language based on its
199 * Accept-Language HTTP header. The qualifier is recognized and languages
200 * without qualifier are rated highest. The qualifier will be decreased by
201 * 10% for partial matches (i.e. matching primary language).
203 * Expects an array as parameter cotaining the supported languages as values.
204 * If the optional second parameter is supplied, it will be filled with an
205 * array containing the negotiation results.
207 * Returns the negotiated language or the default language (i.e. first array entry)
223 * include './langs/'. http_negotiate_language($langs, $result) .'.php';
229 PHP_FUNCTION(http_negotiate_language
)
231 zval
*supported
, *rs_array
= NULL
;
233 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|z", &supported
, &rs_array
) != SUCCESS
) {
239 array_init(rs_array
);
242 HTTP_DO_NEGOTIATE(language
, supported
, rs_array
);
246 /* {{{ proto string http_negotiate_charset(array supported[, array &result])
248 * This function negotiates the clients preferred charset based on its
249 * Accept-Charset HTTP header. The qualifier is recognized and charsets
250 * without qualifier are rated highest.
252 * Expects an array as parameter cotaining the supported charsets as values.
253 * If the optional second parameter is supplied, it will be filled with an
254 * array containing the negotiation results.
256 * Returns the negotiated charset or the default charset (i.e. first array entry)
263 * 'iso-8859-1', // default
269 * $pref = http_negotiate_charset($charsets, $result);
271 * if (strcmp($pref, 'iso-8859-1')) {
272 * iconv_set_encoding('internal_encoding', 'iso-8859-1');
273 * iconv_set_encoding('output_encoding', $pref);
274 * ob_start('ob_iconv_handler');
281 PHP_FUNCTION(http_negotiate_charset
)
283 zval
*supported
, *rs_array
= NULL
;
285 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|z", &supported
, &rs_array
) != SUCCESS
) {
291 array_init(rs_array
);
294 HTTP_DO_NEGOTIATE(charset
, supported
, rs_array
);
298 /* {{{ proto string http_negotiate_ctype(array supported[, array &result])
300 * This function negotiates the clients preferred content type based on its
301 * Accept HTTP header. The qualifier is recognized and content types
302 * without qualifier are rated highest.
304 * Expects an array as parameter cotaining the supported content types as values.
305 * If the optional second parameter is supplied, it will be filled with an
306 * array containing the negotiation results.
308 * Returns the negotiated content type or the default content type
309 * (i.e. first array entry) if none match.
314 * $ctypes = array('application/xhtml+xml', 'text/html');
315 * http_send_content_type(http_negotiate_content_type($ctypes));
319 PHP_FUNCTION(http_negotiate_content_type
)
321 zval
*supported
, *rs_array
= NULL
;
323 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|z", &supported
, &rs_array
)) {
329 array_init(rs_array
);
332 HTTP_DO_NEGOTIATE(content_type
, supported
, rs_array
);
336 /* {{{ proto bool http_send_status(int status)
338 * Send HTTP status code.
340 * Expects an HTTP status code as parameter.
342 * Returns TRUE on success or FALSE on failure.
344 PHP_FUNCTION(http_send_status
)
348 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &status
) != SUCCESS
) {
351 if (status
< 100 || status
> 510) {
352 http_error_ex(HE_WARNING
, HTTP_E_HEADER
, "Invalid HTTP status code (100-510): %d", status
);
356 RETURN_SUCCESS(http_send_status(status
));
360 /* {{{ proto bool http_send_last_modified([int timestamp])
362 * Send a "Last-Modified" header with a valid HTTP date.
364 * Accepts a unix timestamp, converts it to a valid HTTP date and
365 * sends it as "Last-Modified" HTTP header. If timestamp is
366 * omitted, the current time will be sent.
368 * Returns TRUE on success or FALSE on failure.
370 PHP_FUNCTION(http_send_last_modified
)
374 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &t
) != SUCCESS
) {
379 t
= (long) time(NULL
);
382 RETURN_SUCCESS(http_send_last_modified(t
));
386 /* {{{ proto bool http_send_content_type([string content_type = 'application/x-octetstream'])
388 * Send the Content-Type of the sent entity. This is particularly important
389 * if you use the http_send() API.
391 * Accepts an optional string parameter containing the desired content type
392 * (primary/secondary).
394 * Returns TRUE on success or FALSE on failure.
396 PHP_FUNCTION(http_send_content_type
)
398 char *ct
= "application/x-octetstream";
399 int ct_len
= lenof("application/x-octetstream");
401 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &ct
, &ct_len
) != SUCCESS
) {
405 RETURN_SUCCESS(http_send_content_type(ct
, ct_len
));
409 /* {{{ proto bool http_send_content_disposition(string filename[, bool inline = false])
411 * Send the Content-Disposition. The Content-Disposition header is very useful
412 * if the data actually sent came from a file or something similar, that should
413 * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
415 * Expects a string parameter specifying the file name the "Save as..." dialogue
416 * should display. Optionally accepts a bool parameter, which, if set to true
417 * and the user agent knows how to handle the content type, will probably not
418 * cause the popup window to be shown.
420 * Returns TRUE on success or FALSE on failure.
422 PHP_FUNCTION(http_send_content_disposition
)
426 zend_bool send_inline
= 0;
428 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &filename
, &f_len
, &send_inline
) != SUCCESS
) {
431 RETURN_SUCCESS(http_send_content_disposition(filename
, f_len
, send_inline
));
435 /* {{{ proto bool http_match_modified([int timestamp[, bool for_range = false]])
437 * Matches the given unix timestamp against the clients "If-Modified-Since"
438 * resp. "If-Unmodified-Since" HTTP headers.
440 * Accepts a unix timestamp which should be matched. Optionally accepts an
441 * additional bool parameter, which if set to true will check the header
442 * usually used to validate HTTP ranges. If timestamp is omitted, the
443 * current time will be used.
445 * Returns TRUE if timestamp represents an earlier date than the header,
448 PHP_FUNCTION(http_match_modified
)
451 zend_bool for_range
= 0;
453 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|lb", &t
, &for_range
) != SUCCESS
) {
457 // current time if not supplied (senseless though)
459 t
= (long) time(NULL
);
463 RETURN_BOOL(http_match_last_modified("HTTP_IF_UNMODIFIED_SINCE", t
));
465 RETURN_BOOL(http_match_last_modified("HTTP_IF_MODIFIED_SINCE", t
));
469 /* {{{ proto bool http_match_etag(string etag[, bool for_range = false])
471 * Matches the given ETag against the clients "If-Match" resp.
472 * "If-None-Match" HTTP headers.
474 * Expects a string parameter containing the ETag to compare. Optionally
475 * accepts a bool parameter, which, if set to true, will check the header
476 * usually used to validate HTTP ranges.
478 * Retuns TRUE if ETag matches or the header contained the asterisk ("*"),
481 PHP_FUNCTION(http_match_etag
)
485 zend_bool for_range
= 0;
487 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &etag
, &etag_len
, &for_range
) != SUCCESS
) {
492 RETURN_BOOL(http_match_etag("HTTP_IF_MATCH", etag
));
494 RETURN_BOOL(http_match_etag("HTTP_IF_NONE_MATCH", etag
));
498 /* {{{ proto bool http_cache_last_modified([int timestamp_or_expires]])
500 * Attempts to cache the sent entity by its last modification date.
502 * Accepts a unix timestamp as parameter which is handled as follows:
504 * If timestamp_or_expires is greater than 0, it is handled as timestamp
505 * and will be sent as date of last modification. If it is 0 or omitted,
506 * the current time will be sent as Last-Modified date. If it's negative,
507 * it is handled as expiration time in seconds, which means that if the
508 * requested last modification date is not between the calculated timespan,
509 * the Last-Modified header is updated and the actual body will be sent.
511 * Returns FALSE on failure, or *exits* with "304 Not Modified" if the entity is cached.
513 * A log entry will be written to the cache log if the INI entry
514 * http.cache_log is set and the cache attempt was successful.
516 PHP_FUNCTION(http_cache_last_modified
)
518 long last_modified
= 0, send_modified
= 0, t
;
521 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &last_modified
) != SUCCESS
) {
525 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
527 t
= (long) time(NULL
);
530 if (!last_modified
) {
531 /* does the client have? (att: caching "forever") */
532 if ((zlm
= http_get_server_var("HTTP_IF_MODIFIED_SINCE"))) {
533 last_modified
= send_modified
= http_parse_date(Z_STRVAL_P(zlm
));
534 /* send current time */
538 /* negative value is supposed to be expiration time */
539 } else if (last_modified
< 0) {
542 /* send supplied time explicitly */
544 send_modified
= last_modified
;
547 RETURN_SUCCESS(http_cache_last_modified(last_modified
, send_modified
, HTTP_DEFAULT_CACHECONTROL
, lenof(HTTP_DEFAULT_CACHECONTROL
)));
551 /* {{{ proto bool http_cache_etag([string etag])
553 * Attempts to cache the sent entity by its ETag, either supplied or generated
554 * by the hash algorythm specified by the INI setting "http.etag_mode".
556 * If the clients "If-None-Match" header matches the supplied/calculated
557 * ETag, the body is considered cached on the clients side and
558 * a "304 Not Modified" status code is issued.
560 * Returns FALSE on failure, or *exits* with "304 Not Modified" if the entity is cached.
562 * A log entry is written to the cache log if the INI entry
563 * "http.cache_log" is set and the cache attempt was successful.
565 PHP_FUNCTION(http_cache_etag
)
570 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &etag
, &etag_len
) != SUCCESS
) {
574 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
576 RETURN_SUCCESS(http_cache_etag(etag
, etag_len
, HTTP_DEFAULT_CACHECONTROL
, lenof(HTTP_DEFAULT_CACHECONTROL
)));
580 /* {{{ proto string ob_etaghandler(string data, int mode)
582 * For use with ob_start(). Output buffer handler generating an ETag with
583 * the hash algorythm specified with the INI setting "http.etag_mode".
585 PHP_FUNCTION(ob_etaghandler
)
591 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sl", &data
, &data_len
, &mode
)) {
595 Z_TYPE_P(return_value
) = IS_STRING
;
596 http_ob_etaghandler(data
, data_len
, &Z_STRVAL_P(return_value
), (uint
*) &Z_STRLEN_P(return_value
), mode
);
600 /* {{{ proto void http_throttle(double sec[, int bytes = 40960])
602 * Sets the throttle delay and send buffer size for use with http_send() API.
603 * Provides a basic throttling mechanism, which will yield the current process
604 * resp. thread until the entity has been completely sent, though.
606 * Expects a double parameter specifying the seconds too sleep() after
607 * each chunk sent. Additionally accepts an optional int parameter
608 * representing the chunk size in bytes.
614 * # http_throttle(1, 20000);
615 * # http_throttle(0.5, 10000);
616 * # http_throttle(0.1, 2000);
617 * http_send_file('document.pdf');
621 PHP_FUNCTION(http_throttle
)
623 long chunk_size
= HTTP_SENDBUF_SIZE
;
626 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "d|l", &interval
, &chunk_size
)) {
630 HTTP_G(send
).throttle_delay
= interval
;
631 HTTP_G(send
).buffer_size
= chunk_size
;
635 /* {{{ proto void http_redirect([string url[, array params[, bool session = false[, int status = 302]]]])
637 * Redirect to the given url.
639 * The supplied url will be expanded with http_build_uri(), the params array will
640 * be treated with http_build_query() and the session identification will be appended
641 * if session is true.
643 * The HTTP response code will be set according to status.
644 * You can use one of the following constants for convenience:
645 * - HTTP_REDIRECT 302 Found
646 * - HTTP_REDIRECT_PERM 301 Moved Permanently
647 * - HTTP_REDIRECT_POST 303 See Other
648 * - HTTP_REDIRECT_TEMP 307 Temporary Redirect
650 * Please see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3
651 * for which redirect response code to use in which situation.
653 * To be RFC compliant, "Redirecting to <a>URI</a>." will be displayed,
654 * if the client doesn't redirect immediatly, and the request method was
655 * another one than HEAD.
657 * Returns FALSE on failure, or *exits* on success.
659 * A log entry will be written to the redirect log, if the INI entry
660 * "http.redirect_log" is set and the redirect attempt was successful.
662 PHP_FUNCTION(http_redirect
)
665 size_t query_len
= 0;
666 zend_bool session
= 0, free_params
= 0;
669 char *query
= NULL
, *url
= NULL
, *URI
, *LOC
, *RED
= NULL
;
671 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|sa!/bl", &url
, &url_len
, ¶ms
, &session
, &status
) != SUCCESS
) {
675 #ifdef HAVE_PHP_SESSION
676 /* append session info */
680 MAKE_STD_ZVAL(params
);
683 if (PS(session_status
) == php_session_active
) {
684 if (add_assoc_string(params
, PS(session_name
), PS(id
), 1) != SUCCESS
) {
685 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Could not append session information");
691 /* treat params array with http_build_query() */
693 if (SUCCESS
!= http_urlencode_hash_ex(Z_ARRVAL_P(params
), 0, NULL
, 0, &query
, &query_len
)) {
705 URI
= http_absolute_url(url
);
708 spprintf(&LOC
, 0, "Location: %s?%s", URI
, query
);
709 if (SG(request_info
).request_method
&& strcmp(SG(request_info
).request_method
, "HEAD")) {
710 spprintf(&RED
, 0, "Redirecting to <a href=\"%s?%s\">%s?%s</a>.\n", URI
, query
, URI
, query
);
713 spprintf(&LOC
, 0, "Location: %s", URI
);
714 if (SG(request_info
).request_method
&& strcmp(SG(request_info
).request_method
, "HEAD")) {
715 spprintf(&RED
, 0, "Redirecting to <a href=\"%s\">%s</a>.\n", URI
, URI
);
728 RETURN_SUCCESS(http_exit_ex(status
, LOC
, RED
, 1));
732 /* {{{ proto bool http_send_data(string data)
734 * Sends raw data with support for (multiple) range requests.
736 * Retursn TRUE on success, or FALSE on failure.
738 PHP_FUNCTION(http_send_data
)
742 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &zdata
) != SUCCESS
) {
746 convert_to_string_ex(&zdata
);
747 RETURN_SUCCESS(http_send_data(Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
)));
751 /* {{{ proto bool http_send_file(string file)
753 * Sends a file with support for (multiple) range requests.
755 * Expects a string parameter referencing the file to send.
757 * Returns TRUE on success, or FALSE on failure.
759 PHP_FUNCTION(http_send_file
)
764 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &file
, &flen
) != SUCCESS
) {
771 RETURN_SUCCESS(http_send_file(file
));
775 /* {{{ proto bool http_send_stream(resource stream)
777 * Sends an already opened stream with support for (multiple) range requests.
779 * Expects a resource parameter referncing the stream to read from.
781 * Returns TRUE on success, or FALSE on failure.
783 PHP_FUNCTION(http_send_stream
)
788 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r", &zstream
) != SUCCESS
) {
792 php_stream_from_zval(file
, &zstream
);
793 RETURN_SUCCESS(http_send_stream(file
));
797 /* {{{ proto string http_chunked_decode(string encoded)
799 * Decodes a string that was HTTP-chunked encoded.
801 * Expects a chunked encoded string as parameter.
803 * Returns the decoded string on success or FALSE on failure.
805 PHP_FUNCTION(http_chunked_decode
)
807 char *encoded
= NULL
, *decoded
= NULL
;
808 size_t decoded_len
= 0;
811 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &encoded
, &encoded_len
) != SUCCESS
) {
815 if (NULL
!= http_encoding_dechunk(encoded
, encoded_len
, &decoded
, &decoded_len
)) {
816 RETURN_STRINGL(decoded
, (int) decoded_len
, 0);
823 /* {{{ proto object http_parse_message(string message)
825 * Parses (a) http_message(s) into a simple recursive object structure.
827 * Expects a string parameter containing a single HTTP message or
828 * several consecutive HTTP messages.
830 * Returns an hierachical object structure of the parsed messages.
835 * print_r(http_parse_message(http_get(URL, array('redirect' => 3)));
840 * [httpVersion] => 1.1
841 * [responseCode] => 200
844 * [Content-Length] => 3
848 * [parentMessage] => stdClass object
851 * [httpVersion] => 1.1
852 * [responseCode] => 302
855 * [Content-Length] => 0
859 * [parentMessage] => ...
865 PHP_FUNCTION(http_parse_message
)
869 http_message
*msg
= NULL
;
871 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &message
, &message_len
)) {
875 if ((msg
= http_message_parse(message
, message_len
))) {
876 object_init(return_value
);
877 http_message_tostruct_recursive(msg
, return_value
);
878 http_message_free(&msg
);
885 /* {{{ proto array http_parse_headers(string header)
887 * Parses HTTP headers into an associative array.
889 * Expects a string parameter containing HTTP headers.
891 * Returns an array on success, or FALSE on failure.
896 * $headers = "content-type: text/html; charset=UTF-8\r\n".
897 * "Server: Funky/1.0\r\n".
898 * "Set-Cookie: foo=bar\r\n".
899 * "Set-Cookie: baz=quux\r\n".
900 * "Folded: works\r\n\ttoo\r\n";
901 * print_r(http_parse_headers($headers));
905 * [Content-Type] => text/html; chatset=UTF-8
906 * [Server] => Funky/1.0
907 * [Set-Cookie] => Array
918 PHP_FUNCTION(http_parse_headers
)
923 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &header
, &header_len
)) {
927 array_init(return_value
);
928 if (SUCCESS
!= http_parse_headers(header
, return_value
)) {
929 zval_dtor(return_value
);
935 /* {{{ proto object http_parse_cookie(string cookie)
937 * Parses HTTP cookies like sent in a response into a struct.
939 * Expects a string as parameter containing the value of a Set-Cookie response header.
941 * Returns an stdClass object with the cookie params as properties on success or FALSE on failure.
946 * print_r(http_parse_cookie("foo=bar; path=/"));
957 PHP_FUNCTION(http_parse_cookie
)
962 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &cookie
, &cookie_len
)) {
966 object_init(return_value
);
967 if (SUCCESS
!= http_parse_cookie(cookie
, HASH_OF(return_value
))) {
968 zval_dtor(return_value
);
973 /* {{{ proto array http_get_request_headers(void)
975 * Get a list of incoming HTTP headers.
977 * Returns an associative array of incoming request headers.
979 PHP_FUNCTION(http_get_request_headers
)
983 array_init(return_value
);
984 http_get_request_headers(return_value
);
988 /* {{{ proto string http_get_request_body(void)
990 * Get the raw request body (e.g. POST or PUT data).
992 * Returns NULL when using the CLI SAPI.
994 PHP_FUNCTION(http_get_request_body
)
1001 if (SUCCESS
== http_get_request_body(&body
, &length
)) {
1002 RETURN_STRINGL(body
, (int) length
, 0);
1009 /* {{{ proto bool http_match_request_header(string header, string value[, bool match_case = false])
1011 * Match an incoming HTTP header.
1013 * Expects two string parameters representing the header name (case-insensitive)
1014 * and the header value that should be compared. The case sensitivity of the
1015 * header value depends on the additional optional bool parameter accepted.
1017 * Returns TRUE if header value matches, else FALSE.
1019 PHP_FUNCTION(http_match_request_header
)
1021 char *header
, *value
;
1022 int header_len
, value_len
;
1023 zend_bool match_case
= 0;
1025 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|b", &header
, &header_len
, &value
, &value_len
, &match_case
)) {
1029 RETURN_BOOL(http_match_request_header_ex(header
, value
, match_case
));
1034 #ifdef HTTP_HAVE_CURL
1036 #define RETVAL_RESPONSE_OR_BODY(request) \
1040 /* check if only the body should be returned */ \
1041 if (options && (SUCCESS == zend_hash_find(Z_ARRVAL_P(options), "bodyonly", sizeof("bodyonly"), (void **) &bodyonly)) && zval_is_true(*bodyonly)) { \
1042 http_message *msg = http_message_parse(PHPSTR_VAL(&request.conv.response), PHPSTR_LEN(&request.conv.response)); \
1045 RETVAL_STRINGL(PHPSTR_VAL(&msg->body), PHPSTR_LEN(&msg->body), 1); \
1046 http_message_free(&msg); \
1049 RETVAL_STRINGL(request.conv.response.data, request.conv.response.used, 1); \
1053 /* {{{ proto string http_get(string url[, array options[, array &info]])
1055 * Performs an HTTP GET request on the supplied url.
1057 * The second parameter, if set, is expected to be an associative
1058 * array where the following keys will be recognized:
1060 * - redirect: int, whether and how many redirects to follow
1061 * - unrestrictedauth: bool, whether to continue sending credentials on
1062 * redirects to a different host
1063 * - proxyhost: string, proxy host in "host[:port]" format
1064 * - proxyport: int, use another proxy port as specified in proxyhost
1065 * - proxyauth: string, proxy credentials in "user:pass" format
1066 * - proxyauthtype: int, HTTP_AUTH_BASIC and/or HTTP_AUTH_NTLM
1067 * - httpauth: string, http credentials in "user:pass" format
1068 * - httpauthtype: int, HTTP_AUTH_BASIC, DIGEST and/or NTLM
1069 * - compress: bool, whether to allow gzip/deflate content encoding
1070 * (defaults to true)
1071 * - port: int, use another port as specified in the url
1072 * - referer: string, the referer to send
1073 * - useragent: string, the user agent to send
1074 * (defaults to PECL::HTTP/version (PHP/version)))
1075 * - headers: array, list of custom headers as associative array
1076 * like array("header" => "value")
1077 * - cookies: array, list of cookies as associative array
1078 * like array("cookie" => "value")
1079 * - cookiestore: string, path to a file where cookies are/will be stored
1080 * - resume: int, byte offset to start the download from;
1081 * if the server supports ranges
1082 * - maxfilesize: int, maximum file size that should be downloaded;
1083 * has no effect, if the size of the requested entity is not known
1084 * - lastmodified: int, timestamp for If-(Un)Modified-Since header
1085 * - timeout: int, seconds the request may take
1086 * - connecttimeout: int, seconds the connect may take
1087 * - onprogress: mixed, progress callback
1090 * The optional third parameter will be filled with some additional information
1091 * in form af an associative array, if supplied, like the following example:
1095 * 'effective_url' => 'http://localhost',
1096 * 'response_code' => 403,
1097 * 'total_time' => 0.017,
1098 * 'namelookup_time' => 0.013,
1099 * 'connect_time' => 0.014,
1100 * 'pretransfer_time' => 0.014,
1101 * 'size_upload' => 0,
1102 * 'size_download' => 202,
1103 * 'speed_download' => 11882,
1104 * 'speed_upload' => 0,
1105 * 'header_size' => 145,
1106 * 'request_size' => 62,
1107 * 'ssl_verifyresult' => 0,
1109 * 'content_length_download' => 202,
1110 * 'content_length_upload' => 0,
1111 * 'starttransfer_time' => 0.017,
1112 * 'content_type' => 'text/html; charset=iso-8859-1',
1113 * 'redirect_time' => 0,
1114 * 'redirect_count' => 0,
1115 * 'http_connectcode' => 0,
1116 * 'httpauth_avail' => 0,
1117 * 'proxyauth_avail' => 0,
1122 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1124 PHP_FUNCTION(http_get
)
1126 zval
*options
= NULL
, *info
= NULL
;
1129 http_request request
;
1131 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|a/!z", &URL
, &URL_len
, &options
, &info
) != SUCCESS
) {
1142 http_request_init_ex(&request
, NULL
, HTTP_GET
, URL
);
1143 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
1144 http_request_exec(&request
);
1146 http_request_info(&request
, Z_ARRVAL_P(info
));
1148 RETVAL_RESPONSE_OR_BODY(request
);
1150 http_request_dtor(&request
);
1154 /* {{{ proto string http_head(string url[, array options[, array &info]])
1156 * Performs an HTTP HEAD request on the supplied url.
1158 * See http_get() for a full list of available parameters and options.
1160 * Returns the HTTP response as string on success, or FALSE on failure.
1162 PHP_FUNCTION(http_head
)
1164 zval
*options
= NULL
, *info
= NULL
;
1167 http_request request
;
1169 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|a/!z", &URL
, &URL_len
, &options
, &info
) != SUCCESS
) {
1180 http_request_init_ex(&request
, NULL
, HTTP_HEAD
, URL
);
1181 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
1182 http_request_exec(&request
);
1184 http_request_info(&request
, Z_ARRVAL_P(info
));
1186 RETVAL_RESPONSE_OR_BODY(request
);
1188 http_request_dtor(&request
);
1192 /* {{{ proto string http_post_data(string url, string data[, array options[, array &info]])
1194 * Performs an HTTP POST requeston the supplied url.
1196 * Expects a string as second parameter containing the pre-encoded post data.
1197 * See http_get() for a full list of available parameters and options.
1199 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1201 PHP_FUNCTION(http_post_data
)
1203 zval
*options
= NULL
, *info
= NULL
;
1204 char *URL
, *postdata
;
1205 int postdata_len
, URL_len
;
1206 http_request_body body
;
1207 http_request request
;
1209 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|a/!z", &URL
, &URL_len
, &postdata
, &postdata_len
, &options
, &info
) != SUCCESS
) {
1220 http_request_init_ex(&request
, NULL
, HTTP_POST
, URL
);
1221 request
.body
= http_request_body_init_ex(&body
, HTTP_REQUEST_BODY_CSTRING
, postdata
, postdata_len
, 0);
1222 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
1223 http_request_exec(&request
);
1225 http_request_info(&request
, Z_ARRVAL_P(info
));
1227 RETVAL_RESPONSE_OR_BODY(request
);
1229 http_request_dtor(&request
);
1233 /* {{{ proto string http_post_fields(string url, array data[, array files[, array options[, array &info]]])
1235 * Performs an HTTP POST request on the supplied url.
1237 * Expecrs an associative array as second parameter, which will be
1238 * www-form-urlencoded. See http_get() for a full list of available options.
1240 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1242 PHP_FUNCTION(http_post_fields
)
1244 zval
*options
= NULL
, *info
= NULL
, *fields
, *files
= NULL
;
1247 http_request_body body
;
1248 http_request request
;
1250 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sa|aa/!z", &URL
, &URL_len
, &fields
, &files
, &options
, &info
) != SUCCESS
) {
1254 if (!http_request_body_fill(&body
, Z_ARRVAL_P(fields
), files
? Z_ARRVAL_P(files
) : NULL
)) {
1265 http_request_init_ex(&request
, NULL
, HTTP_POST
, URL
);
1266 request
.body
= &body
;
1267 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
1268 http_request_exec(&request
);
1270 http_request_info(&request
, Z_ARRVAL_P(info
));
1272 RETVAL_RESPONSE_OR_BODY(request
);
1274 http_request_dtor(&request
);
1278 /* {{{ proto string http_put_file(string url, string file[, array options[, array &info]])
1280 * Performs an HTTP PUT request on the supplied url.
1282 * Expects the second parameter to be a string referncing the file to upload.
1283 * See http_get() for a full list of available options.
1285 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1287 PHP_FUNCTION(http_put_file
)
1291 zval
*options
= NULL
, *info
= NULL
;
1293 php_stream_statbuf ssb
;
1294 http_request_body body
;
1295 http_request request
;
1297 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|a/!z", &URL
, &URL_len
, &file
, &f_len
, &options
, &info
)) {
1301 if (!(stream
= php_stream_open_wrapper(file
, "rb", REPORT_ERRORS
|ENFORCE_SAFE_MODE
, NULL
))) {
1304 if (php_stream_stat(stream
, &ssb
)) {
1305 php_stream_close(stream
);
1316 body
.type
= HTTP_REQUEST_BODY_UPLOADFILE
;
1318 body
.size
= ssb
.sb
.st_size
;
1320 http_request_init_ex(&request
, NULL
, HTTP_PUT
, URL
);
1321 request
.body
= &body
;
1322 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
1323 http_request_exec(&request
);
1325 http_request_info(&request
, Z_ARRVAL_P(info
));
1327 RETVAL_RESPONSE_OR_BODY(request
);
1329 http_request_body_dtor(&body
);
1330 request
.body
= NULL
;
1331 http_request_dtor(&request
);
1335 /* {{{ proto string http_put_stream(string url, resource stream[, array options[, array &info]])
1337 * Performs an HTTP PUT request on the supplied url.
1339 * Expects the second parameter to be a resource referencing an already
1340 * opened stream, from which the data to upload should be read.
1341 * See http_get() for a full list of available options.
1343 * Returns the HTTP response(s) as string on success. or FALSE on failure.
1345 PHP_FUNCTION(http_put_stream
)
1347 zval
*resource
, *options
= NULL
, *info
= NULL
;
1351 php_stream_statbuf ssb
;
1352 http_request_body body
;
1353 http_request request
;
1355 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sr|a/!z", &URL
, &URL_len
, &resource
, &options
, &info
)) {
1359 php_stream_from_zval(stream
, &resource
);
1360 if (php_stream_stat(stream
, &ssb
)) {
1371 body
.type
= HTTP_REQUEST_BODY_UPLOADFILE
;
1373 body
.size
= ssb
.sb
.st_size
;
1375 http_request_init_ex(&request
, NULL
, HTTP_POST
, URL
);
1376 request
.body
= &body
;
1377 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
1378 http_request_exec(&request
);
1380 http_request_info(&request
, Z_ARRVAL_P(info
));
1382 RETVAL_RESPONSE_OR_BODY(request
);
1384 request
.body
= NULL
;
1385 http_request_dtor(&request
);
1388 #endif /* HTTP_HAVE_CURL */
1391 /* {{{ proto int http_request_method_register(string method)
1393 * Register a custom request method.
1395 * Expects a string parameter containing the request method name to register.
1397 * Returns the ID of the request method on success, or FALSE on failure.
1399 PHP_FUNCTION(http_request_method_register
)
1405 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &method
, &method_len
)) {
1408 if ((existing
= http_request_method_exists(1, 0, method
))) {
1409 RETURN_LONG((long) existing
);
1412 RETVAL_LONG((long) http_request_method_register(method
, method_len
));
1416 /* {{{ proto bool http_request_method_unregister(mixed method)
1418 * Unregister a previously registered custom request method.
1420 * Expects either the request method name or ID.
1422 * Returns TRUE on success, or FALSE on failure.
1424 PHP_FUNCTION(http_request_method_unregister
)
1428 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z/", &method
)) {
1432 switch (Z_TYPE_P(method
))
1435 convert_to_string(method
);
1437 if (is_numeric_string(Z_STRVAL_P(method
), Z_STRLEN_P(method
), NULL
, NULL
, 1)) {
1438 convert_to_long(method
);
1441 if (!(mn
= http_request_method_exists(1, 0, Z_STRVAL_P(method
)))) {
1445 ZVAL_LONG(method
, (long)mn
);
1448 RETURN_SUCCESS(http_request_method_unregister(Z_LVAL_P(method
)));
1455 /* {{{ proto int http_request_method_exists(mixed method)
1457 * Check if a request method is registered (or available by default).
1459 * Expects either the request method name or ID as parameter.
1461 * Returns TRUE if the request method is known, else FALSE.
1463 PHP_FUNCTION(http_request_method_exists
)
1468 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z/", &method
)) {
1472 switch (Z_TYPE_P(method
))
1475 convert_to_string(method
);
1477 if (is_numeric_string(Z_STRVAL_P(method
), Z_STRLEN_P(method
), NULL
, NULL
, 1)) {
1478 convert_to_long(method
);
1480 RETURN_LONG((long) http_request_method_exists(1, 0, Z_STRVAL_P(method
)));
1483 RETURN_LONG((long) http_request_method_exists(0, (int) Z_LVAL_P(method
), NULL
));
1491 /* {{{ proto string http_request_method_name(int method)
1493 * Get the literal string representation of a standard or registered request method.
1495 * Expects the request method ID as parameter.
1497 * Returns the request method name as string on success, or FALSE on failure.
1499 PHP_FUNCTION(http_request_method_name
)
1504 if ((SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &method
)) || (method
< 0)) {
1508 RETURN_STRING(estrdup(http_request_method_name((int) method
)), 0);
1513 /* {{{ Sara Golemons http_build_query() */
1514 #ifndef ZEND_ENGINE_2
1516 /* {{{ proto string http_build_query(mixed formdata [, string prefix[, string arg_separator]])
1517 Generates a form-encoded query string from an associative array or object. */
1518 PHP_FUNCTION(http_build_query
)
1521 char *prefix
= NULL
, *arg_sep
= INI_STR("arg_separator.output");
1522 int prefix_len
= 0, arg_sep_len
= strlen(arg_sep
);
1525 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|ss", &formdata
, &prefix
, &prefix_len
, &arg_sep
, &arg_sep_len
) != SUCCESS
) {
1530 arg_sep
= HTTP_URL_ARGSEP
;
1531 arg_sep_len
= lenof(HTTP_URL_ARGSEP
);
1534 formstr
= phpstr_new();
1535 if (SUCCESS
!= http_urlencode_hash_recursive(HASH_OF(formdata
), formstr
, arg_sep
, arg_sep_len
, prefix
, prefix_len
)) {
1536 phpstr_free(&formstr
);
1540 if (!formstr
->used
) {
1541 phpstr_free(&formstr
);
1545 RETURN_PHPSTR_PTR(formstr
);
1548 #endif /* !ZEND_ENGINE_2 */
1552 #ifdef HTTP_HAVE_ZLIB
1554 /* {{{ proto string http_deflate(string data[, int flags = 0])
1556 * Compress data with gzip, zlib AKA deflate or raw deflate encoding.
1558 * Expects the first parameter to be a string containing the data that should
1561 * Returns the encoded string on success, or NULL on failure.
1563 PHP_FUNCTION(http_deflate
)
1571 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &data
, &data_len
, &flags
)) {
1575 if (SUCCESS
== http_encoding_deflate(flags
, data
, data_len
, &encoded
, &encoded_len
)) {
1576 RETURN_STRINGL(encoded
, (int) encoded_len
, 0);
1582 /* {{{ proto string http_inflate(string data)
1584 * Uncompress data compressed with either gzip, deflate AKA zlib or raw
1587 * Expects a string as parameter containing the compressed data.
1589 * Returns the decoded string on success, or NULL on failure.
1591 PHP_FUNCTION(http_inflate
)
1598 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &data
, &data_len
)) {
1602 if (SUCCESS
== http_encoding_inflate(data
, data_len
, &decoded
, &decoded_len
)) {
1603 RETURN_STRINGL(decoded
, (int) decoded_len
, 0);
1609 /* {{{ proto string ob_deflatehandler(string data, int mode)
1611 * For use with ob_start(). The deflate output buffer handler can only be used once.
1612 * It conflicts with ob_gzhanlder and zlib.output_compression as well and should
1613 * not be used after ext/mbstrings mb_output_handler and ext/sessions URL-Rewriter (AKA
1614 * session.use_trans_sid).
1616 PHP_FUNCTION(ob_deflatehandler
)
1622 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sl", &data
, &data_len
, &mode
)) {
1626 http_ob_deflatehandler(data
, data_len
, &Z_STRVAL_P(return_value
), (uint
*) &Z_STRLEN_P(return_value
), mode
);
1627 Z_TYPE_P(return_value
) = Z_STRVAL_P(return_value
) ? IS_STRING
: IS_NULL
;
1631 /* {{{ proto string ob_inflatehandler(string data, int mode)
1633 * For use with ob_start(). Same restrictions as with ob_deflatehandler apply.
1635 PHP_FUNCTION(ob_inflatehandler
)
1641 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sl", &data
, &data_len
, &mode
)) {
1645 http_ob_inflatehandler(data
, data_len
, &Z_STRVAL_P(return_value
), (uint
*) &Z_STRLEN_P(return_value
), mode
);
1646 Z_TYPE_P(return_value
) = Z_STRVAL_P(return_value
) ? IS_STRING
: IS_NULL
;
1650 #endif /* HTTP_HAVE_ZLIB */
1653 /* {{{ proto int http_support([int feature = 0])
1655 * Check for feature that require external libraries.
1657 * Accpepts an optional in parameter specifying which feature to probe for.
1658 * If the parameter is 0 or omitted, the return value contains a bitmask of
1659 * all supported features that depend on external libraries.
1661 * Available features to probe for are:
1663 * <li> HTTP_SUPPORT: always set
1664 * <li> HTTP_SUPPORT_REQUESTS: whether ext/http was linked against libcurl,
1665 * and HTTP requests can be issued
1666 * <li> HTTP_SUPPORT_SSLREQUESTS: whether libcurl was linked against openssl,
1667 * and SSL requests can be issued
1668 * <li> HTTP_SUPPORT_ENCODINGS: whether ext/http was linked against zlib,
1669 * and compressed HTTP responses can be decoded
1670 * <li> HTTP_SUPPORT_MAGICMIME: whether ext/http was linked against libmagic,
1671 * and the HttpResponse::guessContentType() method is usable
1674 * Returns int, whether requested feature is supported, or a bitmask with
1675 * all supported features.
1677 PHP_FUNCTION(http_support
)
1683 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &feature
)) {
1684 RETVAL_LONG(http_support(feature
));
1689 PHP_FUNCTION(http_test
)
1698 * vim600: noet sw=4 ts=4 fdm=marker
1699 * vim<600: noet sw=4 ts=4