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