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
24 #include "ext/standard/info.h"
25 #include "ext/standard/php_string.h"
26 #include "zend_operators.h"
28 #if defined(HAVE_PHP_SESSION) && !defined(COMPILE_DL_SESSION)
29 # include "ext/session/php_session.h"
32 #include "php_http_api.h"
33 #include "php_http_cache_api.h"
34 #include "php_http_date_api.h"
35 #include "php_http_encoding_api.h"
36 #include "php_http_headers_api.h"
37 #include "php_http_message_api.h"
38 #include "php_http_request_api.h"
39 #include "php_http_request_method_api.h"
40 #include "php_http_send_api.h"
41 #include "php_http_url_api.h"
43 ZEND_EXTERN_MODULE_GLOBALS(http
)
45 /* {{{ proto string http_date([int timestamp])
47 * Compose a valid HTTP date regarding RFC 822/1123
48 * looking like: "Wed, 22 Dec 2004 11:34:47 GMT"
50 * Takes an optional unix timestamp as parameter.
52 * Returns the HTTP date as string.
54 PHP_FUNCTION(http_date
)
58 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &t
) != SUCCESS
) {
63 t
= (long) time(NULL
);
66 RETURN_STRING(http_date(t
), 0);
70 /* {{{ proto string http_build_uri(string url[, string proto[, string host[, int port]]])
72 * Build a complete URI according to the supplied parameters.
74 * If the url is already abolute but a different proto was supplied,
75 * only the proto part of the URI will be updated. If url has no
76 * path specified, the path of the current REQUEST_URI will be taken.
77 * The host will be taken either from the Host HTTP header of the client
78 * the SERVER_NAME or just localhost if prior are not available.
79 * If a port is pecified in either the url or as sperate parameter,
80 * it will be added if it differs from te default port for HTTP(S).
82 * Returns the absolute URI as string on success or false on failure.
87 * $uri = http_build_uri("page.php", "https", NULL, 488);
91 PHP_FUNCTION(http_build_uri
)
93 char *url
= NULL
, *proto
= NULL
, *host
= NULL
, *built
= NULL
;
94 int url_len
= 0, proto_len
= 0, host_len
= 0;
97 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|ssl", &url
, &url_len
, &proto
, &proto_len
, &host
, &host_len
, &port
) != SUCCESS
) {
101 if ((built
= http_absolute_uri_ex(url
, url_len
, proto
, proto_len
, host
, host_len
, port
))) {
102 RETURN_STRING(built
, 0);
108 #define HTTP_DO_NEGOTIATE(type, supported, rs_array) \
111 if ((result = http_negotiate_ ##type(supported))) { \
116 if (HASH_KEY_IS_STRING == zend_hash_get_current_key_ex(result, &key, &key_len, &idx, 1, NULL)) { \
117 RETVAL_STRINGL(key, key_len-1, 0); \
123 zend_hash_copy(Z_ARRVAL_P(rs_array), result, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *)); \
126 zend_hash_destroy(result); \
127 FREE_HASHTABLE(result); \
132 zend_hash_internal_pointer_reset(Z_ARRVAL_P(supported)); \
133 if (SUCCESS == zend_hash_get_current_data(Z_ARRVAL_P(supported), (void **) &value)) { \
134 RETVAL_ZVAL(*value, 1, 0); \
143 FOREACH_VAL(pos, supported, value) { \
144 convert_to_string_ex(value); \
145 add_assoc_double(rs_array, Z_STRVAL_PP(value), 1.0); \
152 /* {{{ proto string http_negotiate_language(array supported[, array &result])
154 * This function negotiates the clients preferred language based on its
155 * Accept-Language HTTP header. The qualifier is recognized and languages
156 * without qualifier are rated highest. The qualifier will be decreased by
157 * 10% for partial matches (i.e. matching primary language).
159 * Expects an array as parameter cotaining the supported languages as values.
160 * If the optional second parameter is supplied, it will be filled with an
161 * array containing the negotiation results.
163 * Returns the negotiated language or the default language (i.e. first array entry)
179 * include './langs/'. http_negotiate_language($langs, $result) .'.php';
185 PHP_FUNCTION(http_negotiate_language
)
187 zval
*supported
, *rs_array
= NULL
;
189 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|z", &supported
, &rs_array
) != SUCCESS
) {
195 array_init(rs_array
);
198 HTTP_DO_NEGOTIATE(language
, supported
, rs_array
);
202 /* {{{ proto string http_negotiate_charset(array supported[, array &result])
204 * This function negotiates the clients preferred charset based on its
205 * Accept-Charset HTTP header. The qualifier is recognized and charsets
206 * without qualifier are rated highest.
208 * Expects an array as parameter cotaining the supported charsets as values.
209 * If the optional second parameter is supplied, it will be filled with an
210 * array containing the negotiation results.
212 * Returns the negotiated charset or the default charset (i.e. first array entry)
219 * 'iso-8859-1', // default
225 * $pref = http_negotiate_charset($charsets, $result);
227 * if (strcmp($pref, 'iso-8859-1')) {
228 * iconv_set_encoding('internal_encoding', 'iso-8859-1');
229 * iconv_set_encoding('output_encoding', $pref);
230 * ob_start('ob_iconv_handler');
237 PHP_FUNCTION(http_negotiate_charset
)
239 zval
*supported
, *rs_array
= NULL
;
241 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|z", &supported
, &rs_array
) != SUCCESS
) {
247 array_init(rs_array
);
250 HTTP_DO_NEGOTIATE(charset
, supported
, rs_array
);
254 /* {{{ proto string http_negotiate_ctype(array supported[, array &result])
256 * This function negotiates the clients preferred content type based on its
257 * Accept HTTP header. The qualifier is recognized and content types
258 * without qualifier are rated highest.
260 * Expects an array as parameter cotaining the supported content types as values.
261 * If the optional second parameter is supplied, it will be filled with an
262 * array containing the negotiation results.
264 * Returns the negotiated content type or the default content type
265 * (i.e. first array entry) if none match.
270 * $ctypes = array('application/xhtml+xml', 'text/html');
271 * http_send_content_type(http_negotiate_content_type($ctypes));
275 PHP_FUNCTION(http_negotiate_content_type
)
277 zval
*supported
, *rs_array
= NULL
;
279 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|z", &supported
, &rs_array
)) {
285 array_init(rs_array
);
288 HTTP_DO_NEGOTIATE(content_type
, supported
, rs_array
);
292 /* {{{ proto bool http_send_status(int status)
294 * Send HTTP status code.
296 * Expects an HTTP status code as parameter.
298 * Returns TRUE on success or FALSE on failure.
300 PHP_FUNCTION(http_send_status
)
304 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &status
) != SUCCESS
) {
307 if (status
< 100 || status
> 510) {
308 http_error_ex(HE_WARNING
, HTTP_E_HEADER
, "Invalid HTTP status code (100-510): %d", status
);
312 RETURN_SUCCESS(http_send_status(status
));
316 /* {{{ proto bool http_send_last_modified([int timestamp])
318 * Send a "Last-Modified" header with a valid HTTP date.
320 * Accepts a unix timestamp, converts it to a valid HTTP date and
321 * sends it as "Last-Modified" HTTP header. If timestamp is
322 * omitted, the current time will be sent.
324 * Returns TRUE on success or FALSE on failure.
326 PHP_FUNCTION(http_send_last_modified
)
330 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &t
) != SUCCESS
) {
335 t
= (long) time(NULL
);
338 RETURN_SUCCESS(http_send_last_modified(t
));
342 /* {{{ proto bool http_send_content_type([string content_type = 'application/x-octetstream'])
344 * Send the Content-Type of the sent entity. This is particularly important
345 * if you use the http_send() API.
347 * Accepts an optional string parameter containing the desired content type
348 * (primary/secondary).
350 * Returns TRUE on success or FALSE on failure.
352 PHP_FUNCTION(http_send_content_type
)
354 char *ct
= "application/x-octetstream";
355 int ct_len
= lenof("application/x-octetstream");
357 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &ct
, &ct_len
) != SUCCESS
) {
361 RETURN_SUCCESS(http_send_content_type(ct
, ct_len
));
365 /* {{{ proto bool http_send_content_disposition(string filename[, bool inline = false])
367 * Send the Content-Disposition. The Content-Disposition header is very useful
368 * if the data actually sent came from a file or something similar, that should
369 * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
371 * Expects a string parameter specifying the file name the "Save as..." dialogue
372 * should display. Optionally accepts a bool parameter, which, if set to true
373 * and the user agent knows how to handle the content type, will probably not
374 * cause the popup window to be shown.
376 * Returns TRUE on success or FALSE on failure.
378 PHP_FUNCTION(http_send_content_disposition
)
382 zend_bool send_inline
= 0;
384 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &filename
, &f_len
, &send_inline
) != SUCCESS
) {
387 RETURN_SUCCESS(http_send_content_disposition(filename
, f_len
, send_inline
));
391 /* {{{ proto bool http_match_modified([int timestamp[, bool for_range = false]])
393 * Matches the given unix timestamp against the clients "If-Modified-Since"
394 * resp. "If-Unmodified-Since" HTTP headers.
396 * Accepts a unix timestamp which should be matched. Optionally accepts an
397 * additional bool parameter, which if set to true will check the header
398 * usually used to validate HTTP ranges. If timestamp is omitted, the
399 * current time will be used.
401 * Returns TRUE if timestamp represents an earlier date than the header,
404 PHP_FUNCTION(http_match_modified
)
407 zend_bool for_range
= 0;
409 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|lb", &t
, &for_range
) != SUCCESS
) {
413 // current time if not supplied (senseless though)
415 t
= (long) time(NULL
);
419 RETURN_BOOL(http_match_last_modified("HTTP_IF_UNMODIFIED_SINCE", t
));
421 RETURN_BOOL(http_match_last_modified("HTTP_IF_MODIFIED_SINCE", t
));
425 /* {{{ proto bool http_match_etag(string etag[, bool for_range = false])
427 * Matches the given ETag against the clients "If-Match" resp.
428 * "If-None-Match" HTTP headers.
430 * Expects a string parameter containing the ETag to compare. Optionally
431 * accepts a bool parameter, which, if set to true, will check the header
432 * usually used to validate HTTP ranges.
434 * Retuns TRUE if ETag matches or the header contained the asterisk ("*"),
437 PHP_FUNCTION(http_match_etag
)
441 zend_bool for_range
= 0;
443 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|b", &etag
, &etag_len
, &for_range
) != SUCCESS
) {
448 RETURN_BOOL(http_match_etag("HTTP_IF_MATCH", etag
));
450 RETURN_BOOL(http_match_etag("HTTP_IF_NONE_MATCH", etag
));
454 /* {{{ proto bool http_cache_last_modified([int timestamp_or_expires]])
456 * Attempts to cache the sent entity by its last modification date.
458 * Accepts a unix timestamp as parameter which is handled as follows:
460 * If timestamp_or_expires is greater than 0, it is handled as timestamp
461 * and will be sent as date of last modification. If it is 0 or omitted,
462 * the current time will be sent as Last-Modified date. If it's negative,
463 * it is handled as expiration time in seconds, which means that if the
464 * requested last modification date is not between the calculated timespan,
465 * the Last-Modified header is updated and the actual body will be sent.
467 * Returns FALSE on failure, or *exits* with "304 Not Modified" if the entity is cached.
469 * A log entry will be written to the cache log if the INI entry
470 * http.cache_log is set and the cache attempt was successful.
472 PHP_FUNCTION(http_cache_last_modified
)
474 long last_modified
= 0, send_modified
= 0, t
;
477 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &last_modified
) != SUCCESS
) {
481 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
483 t
= (long) time(NULL
);
486 if (!last_modified
) {
487 /* does the client have? (att: caching "forever") */
488 if ((zlm
= http_get_server_var("HTTP_IF_MODIFIED_SINCE"))) {
489 last_modified
= send_modified
= http_parse_date(Z_STRVAL_P(zlm
));
490 /* send current time */
494 /* negative value is supposed to be expiration time */
495 } else if (last_modified
< 0) {
498 /* send supplied time explicitly */
500 send_modified
= last_modified
;
503 RETURN_SUCCESS(http_cache_last_modified(last_modified
, send_modified
, HTTP_DEFAULT_CACHECONTROL
, lenof(HTTP_DEFAULT_CACHECONTROL
)));
507 /* {{{ proto bool http_cache_etag([string etag])
509 * Attempts to cache the sent entity by its ETag, either supplied or generated
510 * by the hash algorythm specified by the INI setting "http.etag_mode".
512 * If the clients "If-None-Match" header matches the supplied/calculated
513 * ETag, the body is considered cached on the clients side and
514 * a "304 Not Modified" status code is issued.
516 * Returns FALSE on failure, or *exits* with "304 Not Modified" if the entity is cached.
518 * A log entry is written to the cache log if the INI entry
519 * "http.cache_log" is set and the cache attempt was successful.
521 PHP_FUNCTION(http_cache_etag
)
526 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &etag
, &etag_len
) != SUCCESS
) {
530 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE
);
532 RETURN_SUCCESS(http_cache_etag(etag
, etag_len
, HTTP_DEFAULT_CACHECONTROL
, lenof(HTTP_DEFAULT_CACHECONTROL
)));
536 /* {{{ proto string ob_etaghandler(string data, int mode)
538 * For use with ob_start(). Output buffer handler generating an ETag with
539 * the hash algorythm specified with the INI setting "http.etag_mode".
541 PHP_FUNCTION(ob_etaghandler
)
547 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sl", &data
, &data_len
, &mode
)) {
551 Z_TYPE_P(return_value
) = IS_STRING
;
552 http_ob_etaghandler(data
, data_len
, &Z_STRVAL_P(return_value
), (uint
*) &Z_STRLEN_P(return_value
), mode
);
556 /* {{{ proto void http_throttle(double sec[, int bytes = 40960])
558 * Sets the throttle delay and send buffer size for use with http_send() API.
559 * Provides a basic throttling mechanism, which will yield the current process
560 * resp. thread until the entity has been completely sent, though.
562 * Note: This doesn't really work with the FastCGI SAPI.
564 * Expects a double parameter specifying the seconds too sleep() after
565 * each chunk sent. Additionally accepts an optional int parameter
566 * representing the chunk size in bytes.
572 * # http_throttle(1, 20000);
573 * # http_throttle(0.5, 10000);
574 * # http_throttle(0.1, 2000);
575 * http_send_file('document.pdf');
579 PHP_FUNCTION(http_throttle
)
581 long chunk_size
= HTTP_SENDBUF_SIZE
;
584 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "d|l", &interval
, &chunk_size
)) {
588 HTTP_G(send
).throttle_delay
= interval
;
589 HTTP_G(send
).buffer_size
= chunk_size
;
593 /* {{{ proto void http_redirect([string url[, array params[, bool session = false[, int status = 302]]]])
595 * Redirect to the given url.
597 * The supplied url will be expanded with http_build_uri(), the params array will
598 * be treated with http_build_query() and the session identification will be appended
599 * if session is true.
601 * The HTTP response code will be set according to status.
602 * You can use one of the following constants for convenience:
603 * - HTTP_REDIRECT 302 Found
604 * - HTTP_REDIRECT_PERM 301 Moved Permanently
605 * - HTTP_REDIRECT_POST 303 See Other
606 * - HTTP_REDIRECT_TEMP 307 Temporary Redirect
608 * Please see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3
609 * for which redirect response code to use in which situation.
611 * To be RFC compliant, "Redirecting to <a>URI</a>." will be displayed,
612 * if the client doesn't redirect immediatly, and the request method was
613 * another one than HEAD.
615 * Returns FALSE on failure, or *exits* on success.
617 * A log entry will be written to the redirect log, if the INI entry
618 * "http.redirect_log" is set and the redirect attempt was successful.
620 PHP_FUNCTION(http_redirect
)
623 size_t query_len
= 0;
624 zend_bool session
= 0, free_params
= 0;
627 char *query
= NULL
, *url
= NULL
, *URI
, *LOC
, *RED
= NULL
;
629 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|sa!/bl", &url
, &url_len
, ¶ms
, &session
, &status
) != SUCCESS
) {
633 /* append session info */
637 MAKE_STD_ZVAL(params
);
640 #ifdef HAVE_PHP_SESSION
641 # ifdef COMPILE_DL_SESSION
642 if (SUCCESS
== zend_get_module_started("session")) {
643 zval nm_retval
, id_retval
, func
;
646 INIT_PZVAL(&nm_retval
);
647 INIT_PZVAL(&id_retval
);
648 ZVAL_NULL(&nm_retval
);
649 ZVAL_NULL(&id_retval
);
651 ZVAL_STRINGL(&func
, "session_id", lenof("session_id"), 0);
652 call_user_function(EG(function_table
), NULL
, &func
, &id_retval
, 0, NULL TSRMLS_CC
);
653 ZVAL_STRINGL(&func
, "session_name", lenof("session_name"), 0);
654 call_user_function(EG(function_table
), NULL
, &func
, &nm_retval
, 0, NULL TSRMLS_CC
);
656 if ( Z_TYPE(nm_retval
) == IS_STRING
&& Z_STRLEN(nm_retval
) &&
657 Z_TYPE(id_retval
) == IS_STRING
&& Z_STRLEN(id_retval
)) {
658 if (add_assoc_stringl_ex(params
, Z_STRVAL(nm_retval
), Z_STRLEN(nm_retval
)+1,
659 Z_STRVAL(id_retval
), Z_STRLEN(id_retval
), 0) != SUCCESS
) {
660 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Could not append session information");
665 if (PS(session_status
) == php_session_active
) {
666 if (add_assoc_string(params
, PS(session_name
), PS(id
), 1) != SUCCESS
) {
667 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "Could not append session information");
674 /* treat params array with http_build_query() */
676 if (SUCCESS
!= http_urlencode_hash_ex(Z_ARRVAL_P(params
), 0, NULL
, 0, &query
, &query_len
)) {
688 URI
= http_absolute_uri(url
);
691 spprintf(&LOC
, 0, "Location: %s?%s", URI
, query
);
692 if (SG(request_info
).request_method
&& strcmp(SG(request_info
).request_method
, "HEAD")) {
693 spprintf(&RED
, 0, "Redirecting to <a href=\"%s?%s\">%s?%s</a>.\n", URI
, query
, URI
, query
);
696 spprintf(&LOC
, 0, "Location: %s", URI
);
697 if (SG(request_info
).request_method
&& strcmp(SG(request_info
).request_method
, "HEAD")) {
698 spprintf(&RED
, 0, "Redirecting to <a href=\"%s\">%s</a>.\n", URI
, URI
);
711 RETURN_SUCCESS(http_exit_ex(status
, LOC
, RED
, 1));
715 /* {{{ proto bool http_send_data(string data)
717 * Sends raw data with support for (multiple) range requests.
719 * Retursn TRUE on success, or FALSE on failure.
721 PHP_FUNCTION(http_send_data
)
725 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &zdata
) != SUCCESS
) {
729 convert_to_string_ex(&zdata
);
730 RETURN_SUCCESS(http_send_data(Z_STRVAL_P(zdata
), Z_STRLEN_P(zdata
)));
734 /* {{{ proto bool http_send_file(string file)
736 * Sends a file with support for (multiple) range requests.
738 * Expects a string parameter referencing the file to send.
740 * Returns TRUE on success, or FALSE on failure.
742 PHP_FUNCTION(http_send_file
)
747 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &file
, &flen
) != SUCCESS
) {
754 RETURN_SUCCESS(http_send_file(file
));
758 /* {{{ proto bool http_send_stream(resource stream)
760 * Sends an already opened stream with support for (multiple) range requests.
762 * Expects a resource parameter referncing the stream to read from.
764 * Returns TRUE on success, or FALSE on failure.
766 PHP_FUNCTION(http_send_stream
)
771 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "r", &zstream
) != SUCCESS
) {
775 php_stream_from_zval(file
, &zstream
);
776 RETURN_SUCCESS(http_send_stream(file
));
780 /* {{{ proto string http_chunked_decode(string encoded)
782 * Decodes a string that was HTTP-chunked encoded.
784 * Expects a chunked encoded string as parameter.
786 * Returns the decoded string on success or FALSE on failure.
788 PHP_FUNCTION(http_chunked_decode
)
790 char *encoded
= NULL
, *decoded
= NULL
;
791 size_t decoded_len
= 0;
794 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &encoded
, &encoded_len
) != SUCCESS
) {
798 if (NULL
!= http_encoding_dechunk(encoded
, encoded_len
, &decoded
, &decoded_len
)) {
799 RETURN_STRINGL(decoded
, (int) decoded_len
, 0);
806 /* {{{ proto object http_parse_message(string message)
808 * Parses (a) http_message(s) into a simple recursive object structure.
810 * Expects a string parameter containing a single HTTP message or
811 * several consecutive HTTP messages.
813 * Returns an hierachical object structure of the parsed messages.
818 * print_r(http_parse_message(http_get(URL, array('redirect' => 3)));
823 * [httpVersion] => 1.1
824 * [responseCode] => 200
827 * [Content-Length] => 3
831 * [parentMessage] => stdClass object
834 * [httpVersion] => 1.1
835 * [responseCode] => 302
838 * [Content-Length] => 0
842 * [parentMessage] => ...
848 PHP_FUNCTION(http_parse_message
)
852 http_message
*msg
= NULL
;
854 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &message
, &message_len
)) {
858 if ((msg
= http_message_parse(message
, message_len
))) {
859 object_init(return_value
);
860 http_message_tostruct_recursive(msg
, return_value
);
861 http_message_free(&msg
);
868 /* {{{ proto array http_parse_headers(string header)
870 * Parses HTTP headers into an associative array.
872 * Expects a string parameter containing HTTP headers.
874 * Returns an array on success, or FALSE on failure.
879 * $headers = "content-type: text/html; charset=UTF-8\r\n".
880 * "Server: Funky/1.0\r\n".
881 * "Set-Cookie: foo=bar\r\n".
882 * "Set-Cookie: baz=quux\r\n".
883 * "Folded: works\r\n\ttoo\r\n";
884 * print_r(http_parse_headers($headers));
888 * [Content-Type] => text/html; chatset=UTF-8
889 * [Server] => Funky/1.0
890 * [Set-Cookie] => Array
900 PHP_FUNCTION(http_parse_headers
)
905 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &header
, &header_len
)) {
909 array_init(return_value
);
910 if (SUCCESS
!= http_parse_headers(header
, return_value
)) {
911 zval_dtor(return_value
);
917 /* {{{ proto array http_get_request_headers(void)
919 * Get a list of incoming HTTP headers.
921 * Returns an associative array of incoming request headers.
923 PHP_FUNCTION(http_get_request_headers
)
927 array_init(return_value
);
928 http_get_request_headers(return_value
);
932 /* {{{ proto string http_get_request_body(void)
934 * Get the raw request body (e.g. POST or PUT data).
936 * Returns NULL when using the CLI SAPI.
938 PHP_FUNCTION(http_get_request_body
)
945 if (SUCCESS
== http_get_request_body(&body
, &length
)) {
946 RETURN_STRINGL(body
, (int) length
, 0);
953 /* {{{ proto bool http_match_request_header(string header, string value[, bool match_case = false])
955 * Match an incoming HTTP header.
957 * Expects two string parameters representing the header name (case-insensitive)
958 * and the header value that should be compared. The case sensitivity of the
959 * header value depends on the additional optional bool parameter accepted.
961 * Returns TRUE if header value matches, else FALSE.
963 PHP_FUNCTION(http_match_request_header
)
965 char *header
, *value
;
966 int header_len
, value_len
;
967 zend_bool match_case
= 0;
969 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|b", &header
, &header_len
, &value
, &value_len
, &match_case
)) {
973 RETURN_BOOL(http_match_request_header_ex(header
, value
, match_case
));
978 #ifdef HTTP_HAVE_CURL
980 #define RETVAL_RESPONSE_OR_BODY(request) \
984 /* check if only the body should be returned */ \
985 if (options && (SUCCESS == zend_hash_find(Z_ARRVAL_P(options), "bodyonly", sizeof("bodyonly"), (void **) &bodyonly)) && zval_is_true(*bodyonly)) { \
986 http_message *msg = http_message_parse(PHPSTR_VAL(&request.conv.response), PHPSTR_LEN(&request.conv.response)); \
989 RETVAL_STRINGL(PHPSTR_VAL(&msg->body), PHPSTR_LEN(&msg->body), 1); \
990 http_message_free(&msg); \
993 RETVAL_STRINGL(request.conv.response.data, request.conv.response.used, 1); \
997 /* {{{ proto string http_get(string url[, array options[, array &info]])
999 * Performs an HTTP GET request on the supplied url.
1001 * The second parameter, if set, is expected to be an associative
1002 * array where the following keys will be recognized:
1004 * - redirect: int, whether and how many redirects to follow
1005 * - unrestrictedauth: bool, whether to continue sending credentials on
1006 * redirects to a different host
1007 * - proxyhost: string, proxy host in "host[:port]" format
1008 * - proxyport: int, use another proxy port as specified in proxyhost
1009 * - proxyauth: string, proxy credentials in "user:pass" format
1010 * - proxyauthtype: int, HTTP_AUTH_BASIC and/or HTTP_AUTH_NTLM
1011 * - httpauth: string, http credentials in "user:pass" format
1012 * - httpauthtype: int, HTTP_AUTH_BASIC, DIGEST and/or NTLM
1013 * - compress: bool, whether to allow gzip/deflate content encoding
1014 * (defaults to true)
1015 * - port: int, use another port as specified in the url
1016 * - referer: string, the referer to send
1017 * - useragent: string, the user agent to send
1018 * (defaults to PECL::HTTP/version (PHP/version)))
1019 * - headers: array, list of custom headers as associative array
1020 * like array("header" => "value")
1021 * - cookies: array, list of cookies as associative array
1022 * like array("cookie" => "value")
1023 * - cookiestore: string, path to a file where cookies are/will be stored
1024 * - resume: int, byte offset to start the download from;
1025 * if the server supports ranges
1026 * - maxfilesize: int, maximum file size that should be downloaded;
1027 * has no effect, if the size of the requested entity is not known
1028 * - lastmodified: int, timestamp for If-(Un)Modified-Since header
1029 * - timeout: int, seconds the request may take
1030 * - connecttimeout: int, seconds the connect may take
1031 * - onprogress: mixed, progress callback
1034 * The optional third parameter will be filled with some additional information
1035 * in form af an associative array, if supplied, like the following example:
1039 * 'effective_url' => 'http://localhost',
1040 * 'response_code' => 403,
1041 * 'total_time' => 0.017,
1042 * 'namelookup_time' => 0.013,
1043 * 'connect_time' => 0.014,
1044 * 'pretransfer_time' => 0.014,
1045 * 'size_upload' => 0,
1046 * 'size_download' => 202,
1047 * 'speed_download' => 11882,
1048 * 'speed_upload' => 0,
1049 * 'header_size' => 145,
1050 * 'request_size' => 62,
1051 * 'ssl_verifyresult' => 0,
1053 * 'content_length_download' => 202,
1054 * 'content_length_upload' => 0,
1055 * 'starttransfer_time' => 0.017,
1056 * 'content_type' => 'text/html; charset=iso-8859-1',
1057 * 'redirect_time' => 0,
1058 * 'redirect_count' => 0,
1059 * 'http_connectcode' => 0,
1060 * 'httpauth_avail' => 0,
1061 * 'proxyauth_avail' => 0,
1066 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1068 PHP_FUNCTION(http_get
)
1070 zval
*options
= NULL
, *info
= NULL
;
1073 http_request request
;
1075 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|a/!z", &URL
, &URL_len
, &options
, &info
) != SUCCESS
) {
1086 http_request_init_ex(&request
, NULL
, HTTP_GET
, URL
);
1087 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
1088 http_request_exec(&request
);
1090 http_request_info(&request
, Z_ARRVAL_P(info
));
1092 RETVAL_RESPONSE_OR_BODY(request
);
1094 http_request_dtor(&request
);
1098 /* {{{ proto string http_head(string url[, array options[, array &info]])
1100 * Performs an HTTP HEAD request on the supplied url.
1102 * See http_get() for a full list of available parameters and options.
1104 * Returns the HTTP response as string on success, or FALSE on failure.
1106 PHP_FUNCTION(http_head
)
1108 zval
*options
= NULL
, *info
= NULL
;
1111 http_request request
;
1113 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|a/!z", &URL
, &URL_len
, &options
, &info
) != SUCCESS
) {
1124 http_request_init_ex(&request
, NULL
, HTTP_HEAD
, URL
);
1125 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
1126 http_request_exec(&request
);
1128 http_request_info(&request
, Z_ARRVAL_P(info
));
1130 RETVAL_RESPONSE_OR_BODY(request
);
1132 http_request_dtor(&request
);
1136 /* {{{ proto string http_post_data(string url, string data[, array options[, array &info]])
1138 * Performs an HTTP POST requeston the supplied url.
1140 * Expects a string as second parameter containing the pre-encoded post data.
1141 * See http_get() for a full list of available parameters and options.
1143 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1145 PHP_FUNCTION(http_post_data
)
1147 zval
*options
= NULL
, *info
= NULL
;
1148 char *URL
, *postdata
;
1149 int postdata_len
, URL_len
;
1150 http_request_body body
;
1151 http_request request
;
1153 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|a/!z", &URL
, &URL_len
, &postdata
, &postdata_len
, &options
, &info
) != SUCCESS
) {
1164 body
.type
= HTTP_REQUEST_BODY_CSTRING
;
1165 body
.data
= postdata
;
1166 body
.size
= postdata_len
;
1168 http_request_init_ex(&request
, NULL
, HTTP_POST
, URL
);
1169 request
.body
= &body
;
1170 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
1171 request
.body
= NULL
;
1172 http_request_exec(&request
);
1174 http_request_info(&request
, Z_ARRVAL_P(info
));
1176 RETVAL_RESPONSE_OR_BODY(request
);
1178 http_request_dtor(&request
);
1182 /* {{{ proto string http_post_fields(string url, array data[, array files[, array options[, array &info]]])
1184 * Performs an HTTP POST request on the supplied url.
1186 * Expecrs an associative array as second parameter, which will be
1187 * www-form-urlencoded. See http_get() for a full list of available options.
1189 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1191 PHP_FUNCTION(http_post_fields
)
1193 zval
*options
= NULL
, *info
= NULL
, *fields
, *files
= NULL
;
1196 http_request_body body
;
1197 http_request request
;
1199 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sa|aa/!z", &URL
, &URL_len
, &fields
, &files
, &options
, &info
) != SUCCESS
) {
1203 if (SUCCESS
!= http_request_body_fill(&body
, Z_ARRVAL_P(fields
), files
? Z_ARRVAL_P(files
) : NULL
)) {
1214 http_request_init_ex(&request
, NULL
, HTTP_POST
, URL
);
1215 request
.body
= &body
;
1216 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
1217 request
.body
= NULL
;
1218 http_request_exec(&request
);
1219 http_request_body_dtor(&body
);
1221 http_request_info(&request
, Z_ARRVAL_P(info
));
1223 RETVAL_RESPONSE_OR_BODY(request
);
1225 http_request_body_dtor(&body
);
1226 http_request_dtor(&request
);
1230 /* {{{ proto string http_put_file(string url, string file[, array options[, array &info]])
1232 * Performs an HTTP PUT request on the supplied url.
1234 * Expects the second parameter to be a string referncing the file to upload.
1235 * See http_get() for a full list of available options.
1237 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1239 PHP_FUNCTION(http_put_file
)
1243 zval
*options
= NULL
, *info
= NULL
;
1245 php_stream_statbuf ssb
;
1246 http_request_body body
;
1247 http_request request
;
1249 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss|a/!z", &URL
, &URL_len
, &file
, &f_len
, &options
, &info
)) {
1253 if (!(stream
= php_stream_open_wrapper(file
, "rb", REPORT_ERRORS
|ENFORCE_SAFE_MODE
, NULL
))) {
1256 if (php_stream_stat(stream
, &ssb
)) {
1257 php_stream_close(stream
);
1268 body
.type
= HTTP_REQUEST_BODY_UPLOADFILE
;
1270 body
.size
= ssb
.sb
.st_size
;
1272 http_request_init_ex(&request
, NULL
, HTTP_PUT
, URL
);
1273 request
.body
= &body
;
1274 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
1275 request
.body
= NULL
;
1276 http_request_exec(&request
);
1277 http_request_body_dtor(&body
);
1279 http_request_info(&request
, Z_ARRVAL_P(info
));
1281 RETVAL_RESPONSE_OR_BODY(request
);
1283 http_request_body_dtor(&body
);
1284 http_request_dtor(&request
);
1288 /* {{{ proto string http_put_stream(string url, resource stream[, array options[, array &info]])
1290 * Performs an HTTP PUT request on the supplied url.
1292 * Expects the second parameter to be a resource referencing an already
1293 * opened stream, from which the data to upload should be read.
1294 * See http_get() for a full list of available options.
1296 * Returns the HTTP response(s) as string on success. or FALSE on failure.
1298 PHP_FUNCTION(http_put_stream
)
1300 zval
*resource
, *options
= NULL
, *info
= NULL
;
1304 php_stream_statbuf ssb
;
1305 http_request_body body
;
1306 http_request request
;
1308 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sr|a/!z", &URL
, &URL_len
, &resource
, &options
, &info
)) {
1312 php_stream_from_zval(stream
, &resource
);
1313 if (php_stream_stat(stream
, &ssb
)) {
1324 body
.type
= HTTP_REQUEST_BODY_UPLOADFILE
;
1326 body
.size
= ssb
.sb
.st_size
;
1328 http_request_init_ex(&request
, NULL
, HTTP_POST
, URL
);
1329 request
.body
= &body
;
1330 if (SUCCESS
== http_request_prepare(&request
, options
?Z_ARRVAL_P(options
):NULL
)) {
1331 request
.body
= NULL
;
1332 http_request_exec(&request
);
1334 http_request_info(&request
, Z_ARRVAL_P(info
));
1336 RETVAL_RESPONSE_OR_BODY(request
);
1338 http_request_dtor(&request
);
1341 #endif /* HTTP_HAVE_CURL */
1344 /* {{{ proto int http_request_method_register(string method)
1346 * Register a custom request method.
1348 * Expects a string parameter containing the request method name to register.
1350 * Returns the ID of the request method on success, or FALSE on failure.
1352 PHP_FUNCTION(http_request_method_register
)
1358 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &method
, &method_len
)) {
1361 if ((existing
= http_request_method_exists(1, 0, method
))) {
1362 RETURN_LONG((long) existing
);
1365 RETVAL_LONG((long) http_request_method_register(method
, method_len
));
1369 /* {{{ proto bool http_request_method_unregister(mixed method)
1371 * Unregister a previously registered custom request method.
1373 * Expects either the request method name or ID.
1375 * Returns TRUE on success, or FALSE on failure.
1377 PHP_FUNCTION(http_request_method_unregister
)
1381 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z/", &method
)) {
1385 switch (Z_TYPE_P(method
))
1388 convert_to_string(method
);
1390 if (is_numeric_string(Z_STRVAL_P(method
), Z_STRLEN_P(method
), NULL
, NULL
, 1)) {
1391 convert_to_long(method
);
1394 if (!(mn
= http_request_method_exists(1, 0, Z_STRVAL_P(method
)))) {
1398 ZVAL_LONG(method
, (long)mn
);
1401 RETURN_SUCCESS(http_request_method_unregister(Z_LVAL_P(method
)));
1408 /* {{{ proto int http_request_method_exists(mixed method)
1410 * Check if a request method is registered (or available by default).
1412 * Expects either the request method name or ID as parameter.
1414 * Returns TRUE if the request method is known, else FALSE.
1416 PHP_FUNCTION(http_request_method_exists
)
1421 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z/", &method
)) {
1425 switch (Z_TYPE_P(method
))
1428 convert_to_string(method
);
1430 if (is_numeric_string(Z_STRVAL_P(method
), Z_STRLEN_P(method
), NULL
, NULL
, 1)) {
1431 convert_to_long(method
);
1433 RETURN_LONG((long) http_request_method_exists(1, 0, Z_STRVAL_P(method
)));
1436 RETURN_LONG((long) http_request_method_exists(0, Z_LVAL_P(method
), NULL
));
1444 /* {{{ proto string http_request_method_name(int method)
1446 * Get the literal string representation of a standard or registered request method.
1448 * Expects the request method ID as parameter.
1450 * Returns the request method name as string on success, or FALSE on failure.
1452 PHP_FUNCTION(http_request_method_name
)
1457 if ((SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &method
)) || (method
< 0)) {
1461 RETURN_STRING(estrdup(http_request_method_name((ulong
) method
)), 0);
1466 /* {{{ Sara Golemons http_build_query() */
1467 #ifndef ZEND_ENGINE_2
1469 /* {{{ proto string http_build_query(mixed formdata [, string prefix[, string arg_separator]])
1470 Generates a form-encoded query string from an associative array or object. */
1471 PHP_FUNCTION(http_build_query
)
1474 char *prefix
= NULL
, *arg_sep
= INI_STR("arg_separator.output");
1475 int prefix_len
= 0, arg_sep_len
= strlen(arg_sep
);
1478 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|ss", &formdata
, &prefix
, &prefix_len
, &arg_sep
, &arg_sep_len
) != SUCCESS
) {
1483 arg_sep
= HTTP_URL_ARGSEP
;
1484 arg_sep_len
= lenof(HTTP_URL_ARGSEP
);
1487 formstr
= phpstr_new();
1488 if (SUCCESS
!= http_urlencode_hash_recursive(HASH_OF(formdata
), formstr
, arg_sep
, arg_sep_len
, prefix
, prefix_len
)) {
1489 phpstr_free(&formstr
);
1493 if (!formstr
->used
) {
1494 phpstr_free(&formstr
);
1498 RETURN_PHPSTR_PTR(formstr
);
1501 #endif /* !ZEND_ENGINE_2 */
1505 #ifdef HTTP_HAVE_ZLIB
1507 /* {{{ proto string http_gzencode(string data[, int level = -1])
1509 * Compress data with the HTTP compatible GZIP encoding.
1511 * Expects the first parameter to be a string which contains the data that
1512 * should be encoded. Additionally accepts an optional in paramter specifying
1513 * the compression level, where -1 is default, 0 is no compression and 9 is
1514 * best compression ratio.
1516 * Returns the encoded string on success, or NULL on failure.
1518 PHP_FUNCTION(http_gzencode
)
1526 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &data
, &data_len
, &level
)) {
1527 HTTP_CHECK_GZIP_LEVEL(level
, return);
1532 if (SUCCESS
== http_encoding_gzencode(level
, data
, data_len
, &encoded
, &encoded_len
)) {
1533 RETURN_STRINGL(encoded
, (int) encoded_len
, 0);
1540 /* {{{ proto string http_gzdecode(string data)
1542 * Uncompress data compressed with the HTTP compatible GZIP encoding.
1544 * Expects a string as parameter containing the compressed data.
1546 * Returns the decoded string on success, or NULL on failure.
1548 PHP_FUNCTION(http_gzdecode
)
1555 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &data
, &data_len
)) {
1559 if (SUCCESS
== http_encoding_gzdecode(data
, data_len
, &decoded
, &decoded_len
)) {
1560 RETURN_STRINGL(decoded
, (int) decoded_len
, 0);
1566 /* {{{ proto string http_deflate(string data[, int level = -1])
1568 * Compress data with the HTTP compatible DEFLATE encoding.
1570 * Expects the first parameter to be a string containing the data that should
1571 * be encoded. Additionally accepts an optional int parameter specifying the
1572 * compression level, where -1 is default, 0 is no compression and 9 is best
1573 * compression ratio.
1575 * Returns the encoded string on success, or NULL on failure.
1577 PHP_FUNCTION(http_deflate
)
1585 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &data
, &data_len
, &level
)) {
1586 HTTP_CHECK_GZIP_LEVEL(level
, return);
1591 if (SUCCESS
== http_encoding_deflate(level
, data
, data_len
, &encoded
, &encoded_len
)) {
1592 RETURN_STRINGL(encoded
, (int) encoded_len
, 0);
1599 /* {{{ proto string http_inflate(string data)
1601 * Uncompress data compressed with the HTTP compatible DEFLATE encoding.
1603 * Expects a string as parameter containing the compressed data.
1605 * Returns the decoded string on success, or NULL on failure.
1607 PHP_FUNCTION(http_inflate
)
1614 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &data
, &data_len
)) {
1618 if (SUCCESS
== http_encoding_inflate(data
, data_len
, &decoded
, &decoded_len
)) {
1619 RETURN_STRINGL(decoded
, (int) decoded_len
, 0);
1625 /* {{{ proto string http_compress(string data[, int level = -1])
1627 * Compress data with the HTTP compatible COMPRESS encoding.
1629 * Expects the first parameter to be a string containing the data which should
1630 * be encoded. Additionally accepts an optional int parameter specifying the
1631 * compression level, where -1 is default, 0 is no compression and 9 is best
1632 * compression ratio.
1634 * Returns the encoded string on success, or NULL on failure.
1636 PHP_FUNCTION(http_compress
)
1644 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s|l", &data
, &data_len
, &level
)) {
1645 HTTP_CHECK_GZIP_LEVEL(level
, return);
1650 if (SUCCESS
== http_encoding_compress(level
, data
, data_len
, &encoded
, &encoded_len
)) {
1651 RETURN_STRINGL(encoded
, (int) encoded_len
, 0);
1658 /* {{{ proto string http_uncompress(string data)
1660 * Uncompress data compressed with the HTTP compatible COMPRESS encoding.
1662 * Expects a string as parameter containing the compressed data.
1664 * Returns the decoded string on success, or NULL on failure.
1666 PHP_FUNCTION(http_uncompress
)
1673 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &data
, &data_len
)) {
1677 if (SUCCESS
== http_encoding_uncompress(data
, data_len
, &decoded
, &decoded_len
)) {
1678 RETURN_STRINGL(decoded
, (int) decoded_len
, 0);
1683 #endif /* HTTP_HAVE_ZLIB */
1686 /* {{{ proto int http_support([int feature = 0])
1688 * Check for feature that require external libraries.
1690 * Accpepts an optional in parameter specifying which feature to probe for.
1691 * If the parameter is 0 or omitted, the return value contains a bitmask of
1692 * all supported features that depend on external libraries.
1694 * Available features to probe for are:
1696 * <li> HTTP_SUPPORT: always set
1697 * <li> HTTP_SUPPORT_REQUESTS: whether ext/http was linked against libcurl,
1698 * and HTTP requests can be issued
1699 * <li> HTTP_SUPPORT_SSLREQUESTS: whether libcurl was linked against openssl,
1700 * and SSL requests can be issued
1701 * <li> HTTP_SUPPORT_ENCODINGS: whether ext/http was linked against zlib,
1702 * and compressed HTTP responses can be decoded
1703 * <li> HTTP_SUPPORT_MAGICMIME: whether ext/http was linked against libmagic,
1704 * and the HttpResponse::guessContentType() method is usable
1707 * Returns int, whether requested feature is supported, or a bitmask with
1708 * all supported features.
1710 PHP_FUNCTION(http_support
)
1716 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|l", &feature
)) {
1717 RETVAL_LONG(http_support(feature
));
1722 PHP_FUNCTION(http_test
)
1731 * vim600: noet sw=4 ts=4 fdm=marker
1732 * vim<600: noet sw=4 ts=4