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