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
  22 #include "php.h"
  23 #include "php_ini.h"
  24 #include "ext/standard/info.h"
  25 #include "ext/session/php_session.h"
  26 #include "ext/standard/php_string.h"
  27
  28 #include "SAPI.h"
  29
  30 #include "phpstr/phpstr.h"
  31
  32 #include "php_http.h"
  33 #include "php_http_std_defs.h"
  34 #include "php_http_api.h"
  35 #include "php_http_auth_api.h"
  36 #include "php_http_curl_api.h"
  37 #include "php_http_cache_api.h"
  38 #include "php_http_curl_api.h"
  39 #include "php_http_date_api.h"
  40 #include "php_http_headers_api.h"
  41 #include "php_http_message_api.h"
  42 #include "php_http_send_api.h"
  43 #include "php_http_url_api.h"
  44
  45 ZEND_EXTERN_MODULE_GLOBALS(http)
  46
  47 /* {{{ proto string http_date([int timestamp])
  48  *
  49  * This function returns a valid HTTP date regarding RFC 822/1123
  50  * looking like: "Wed, 22 Dec 2004 11:34:47 GMT"
  51  *
  52  */
  53 PHP_FUNCTION(http_date)
  54 {
  55         long t = -1;
  56
  57         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &t) != SUCCESS) {
  58                 RETURN_FALSE;
  59         }
  60
  61         if (t == -1) {
  62                 t = (long) time(NULL);
  63         }
  64
  65         RETURN_STRING(http_date(t), 0);
  66 }
  67 /* }}} */
  68
  69 /* {{{ proto string http_absolute_uri(string url[, string proto[, string host[, int port]]])
  70  *
  71  * This function returns an absolute URI constructed from url.
  72  * If the url is already abolute but a different proto was supplied,
  73  * only the proto part of the URI will be updated.  If url has no
  74  * path specified, the path of the current REQUEST_URI will be taken.
  75  * The host will be taken either from the Host HTTP header of the client
  76  * the SERVER_NAME or just localhost if prior are not available.
  77  *
  78  * Some examples:
  79  * <pre>
  80  *  url = "page.php"                    => http://www.example.com/current/path/page.php
  81  *  url = "/page.php"                   => http://www.example.com/page.php
  82  *  url = "/page.php", proto = "https"  => https://www.example.com/page.php
  83  * </pre>
  84  *
  85  */
  86 PHP_FUNCTION(http_absolute_uri)
  87 {
  88         char *url = NULL, *proto = NULL, *host = NULL;
  89         int url_len = 0, proto_len = 0, host_len = 0;
  90         long port = 0;
  91
  92         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|ssl", &url, &url_len, &proto, &proto_len, &host, &host_len, &port) != SUCCESS) {
  93                 RETURN_FALSE;
  94         }
  95
  96         RETURN_STRING(http_absolute_uri_ex(url, url_len, proto, proto_len, host, host_len, port), 0);
  97 }
  98 /* }}} */
  99
 100 /* {{{ proto string http_negotiate_language(array supported[, string default = 'en-US'])
 101  *
 102  * This function negotiates the clients preferred language based on its
 103  * Accept-Language HTTP header.  It returns the negotiated language or
 104  * the default language if none match.
 105  *
 106  * The qualifier is recognized and languages without qualifier are rated highest.
 107  *
 108  * The supported parameter is expected to be an array having
 109  * the supported languages as array values.
 110  *
 111  * Example:
 112  * <pre>
 113  * <?php
 114  * $langs = array(
 115  *              'en-US',// default
 116  *              'fr',
 117  *              'fr-FR',
 118  *              'de',
 119  *              'de-DE',
 120  *              'de-AT',
 121  *              'de-CH',
 122  * );
 123  * include './langs/'. http_negotiate_language($langs) .'.php';
 124  * ?>
 125  * </pre>
 126  *
 127  */
 128 PHP_FUNCTION(http_negotiate_language)
 129 {
 130         zval *supported;
 131         char *def = NULL;
 132         int def_len = 0;
 133
 134         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|s", &supported, &def, &def_len) != SUCCESS) {
 135                 RETURN_FALSE;
 136         }
 137
 138         if (!def) {
 139                 def = "en-US";
 140         }
 141
 142         RETURN_STRING(http_negotiate_language(supported, def), 0);
 143 }
 144 /* }}} */
 145
 146 /* {{{ proto string http_negotiate_charset(array supported[, string default = 'iso-8859-1'])
 147  *
 148  * This function negotiates the clients preferred charset based on its
 149  * Accept-Charset HTTP header.  It returns the negotiated charset or
 150  * the default charset if none match.
 151  *
 152  * The qualifier is recognized and charset without qualifier are rated highest.
 153  *
 154  * The supported parameter is expected to be an array having
 155  * the supported charsets as array values.
 156  *
 157  * Example:
 158  * <pre>
 159  * <?php
 160  * $charsets = array(
 161  *              'iso-8859-1', // default
 162  *              'iso-8859-2',
 163  *              'iso-8859-15',
 164  *              'utf-8'
 165  * );
 166  * $pref = http_negotiate_charset($charsets);
 167  * if (!strcmp($pref, 'iso-8859-1')) {
 168  *              iconv_set_encoding('internal_encoding', 'iso-8859-1');
 169  *              iconv_set_encoding('output_encoding', $pref);
 170  *              ob_start('ob_iconv_handler');
 171  * }
 172  * ?>
 173  * </pre>
 174  */
 175 PHP_FUNCTION(http_negotiate_charset)
 176 {
 177         zval *supported;
 178         char *def = NULL;
 179         int def_len = 0;
 180
 181         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|s", &supported, &def, &def_len) != SUCCESS) {
 182                 RETURN_FALSE;
 183         }
 184
 185         if (!def) {
 186                 def = "iso-8859-1";
 187         }
 188
 189         RETURN_STRING(http_negotiate_charset(supported, def), 0);
 190 }
 191 /* }}} */
 192
 193 /* {{{ proto bool http_send_status(int status)
 194  *
 195  * Send HTTP status code.
 196  *
 197  */
 198 PHP_FUNCTION(http_send_status)
 199 {
 200         int status = 0;
 201
 202         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &status) != SUCCESS) {
 203                 RETURN_FALSE;
 204         }
 205         if (status < 100 || status > 510) {
 206                 http_error_ex(E_WARNING, HTTP_E_HEADER, "Invalid HTTP status code (100-510): %d", status);
 207                 RETURN_FALSE;
 208         }
 209
 210         RETURN_SUCCESS(http_send_status(status));
 211 }
 212 /* }}} */
 213
 214 /* {{{ proto bool http_send_last_modified([int timestamp])
 215  *
 216  * This converts the given timestamp to a valid HTTP date and
 217  * sends it as "Last-Modified" HTTP header.  If timestamp is
 218  * omitted, current time is sent.
 219  *
 220  */
 221 PHP_FUNCTION(http_send_last_modified)
 222 {
 223         long t = -1;
 224
 225         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &t) != SUCCESS) {
 226                 RETURN_FALSE;
 227         }
 228
 229         if (t == -1) {
 230                 t = (long) time(NULL);
 231         }
 232
 233         RETURN_SUCCESS(http_send_last_modified(t));
 234 }
 235 /* }}} */
 236
 237 /* {{{ proto bool http_send_content_type([string content_type = 'application/x-octetstream'])
 238  *
 239  * Sets the content type.
 240  *
 241  */
 242 PHP_FUNCTION(http_send_content_type)
 243 {
 244         char *ct;
 245         int ct_len = 0;
 246
 247         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &ct, &ct_len) != SUCCESS) {
 248                 RETURN_FALSE;
 249         }
 250
 251         if (!ct_len) {
 252                 RETURN_SUCCESS(http_send_content_type("application/x-octetstream", lenof("application/x-octetstream")));
 253         }
 254         RETURN_SUCCESS(http_send_content_type(ct, ct_len));
 255 }
 256 /* }}} */
 257
 258 /* {{{ proto bool http_send_content_disposition(string filename[, bool inline = false])
 259  *
 260  * Set the Content Disposition.  The Content-Disposition header is very useful
 261  * if the data actually sent came from a file or something similar, that should
 262  * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
 263  *
 264  */
 265 PHP_FUNCTION(http_send_content_disposition)
 266 {
 267         char *filename;
 268         int f_len;
 269         zend_bool send_inline = 0;
 270
 271         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &filename, &f_len, &send_inline) != SUCCESS) {
 272                 RETURN_FALSE;
 273         }
 274         RETURN_SUCCESS(http_send_content_disposition(filename, f_len, send_inline));
 275 }
 276 /* }}} */
 277
 278 /* {{{ proto bool http_match_modified([int timestamp[, for_range = false]])
 279  *
 280  * Matches the given timestamp against the clients "If-Modified-Since" resp.
 281  * "If-Unmodified-Since" HTTP headers.
 282  *
 283  */
 284 PHP_FUNCTION(http_match_modified)
 285 {
 286         long t = -1;
 287         zend_bool for_range = 0;
 288
 289         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|lb", &t, &for_range) != SUCCESS) {
 290                 RETURN_FALSE;
 291         }
 292
 293         // current time if not supplied (senseless though)
 294         if (t == -1) {
 295                 t = (long) time(NULL);
 296         }
 297
 298         if (for_range) {
 299                 RETURN_BOOL(http_match_last_modified("HTTP_IF_UNMODIFIED_SINCE", t));
 300         }
 301         RETURN_BOOL(http_match_last_modified("HTTP_IF_MODIFIED_SINCE", t));
 302 }
 303 /* }}} */
 304
 305 /* {{{ proto bool http_match_etag(string etag[, for_range = false])
 306  *
 307  * This matches the given ETag against the clients
 308  * "If-Match" resp. "If-None-Match" HTTP headers.
 309  *
 310  */
 311 PHP_FUNCTION(http_match_etag)
 312 {
 313         int etag_len;
 314         char *etag;
 315         zend_bool for_range = 0;
 316
 317         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &etag, &etag_len, &for_range) != SUCCESS) {
 318                 RETURN_FALSE;
 319         }
 320
 321         if (for_range) {
 322                 RETURN_BOOL(http_match_etag("HTTP_IF_MATCH", etag));
 323         }
 324         RETURN_BOOL(http_match_etag("HTTP_IF_NONE_MATCH", etag));
 325 }
 326 /* }}} */
 327
 328 /* {{{ proto bool http_cache_last_modified([int timestamp_or_expires]])
 329  *
 330  * If timestamp_or_expires is greater than 0, it is handled as timestamp
 331  * and will be sent as date of last modification.  If it is 0 or omitted,
 332  * the current time will be sent as Last-Modified date.  If it's negative,
 333  * it is handled as expiration time in seconds, which means that if the
 334  * requested last modification date is not between the calculated timespan,
 335  * the Last-Modified header is updated and the actual body will be sent.
 336  *
 337  */
 338 PHP_FUNCTION(http_cache_last_modified)
 339 {
 340         long last_modified = 0, send_modified = 0, t;
 341         zval *zlm;
 342
 343         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &last_modified) != SUCCESS) {
 344                 RETURN_FALSE;
 345         }
 346
 347         t = (long) time(NULL);
 348
 349         /* 0 or omitted */
 350         if (!last_modified) {
 351                 /* does the client have? (att: caching "forever") */
 352                 if (zlm = http_get_server_var("HTTP_IF_MODIFIED_SINCE")) {
 353                         last_modified = send_modified = http_parse_date(Z_STRVAL_P(zlm));
 354                 /* send current time */
 355                 } else {
 356                         send_modified = t;
 357                 }
 358         /* negative value is supposed to be expiration time */
 359         } else if (last_modified < 0) {
 360                 last_modified += t;
 361                 send_modified  = t;
 362         /* send supplied time explicitly */
 363         } else {
 364                 send_modified = last_modified;
 365         }
 366
 367         RETURN_SUCCESS(http_cache_last_modified(last_modified, send_modified, HTTP_DEFAULT_CACHECONTROL, lenof(HTTP_DEFAULT_CACHECONTROL)));
 368 }
 369 /* }}} */
 370
 371 /* {{{ proto bool http_cache_etag([string etag])
 372  *
 373  * This function attempts to cache the HTTP body based on an ETag,
 374  * either supplied or generated through calculation of the MD5
 375  * checksum of the output (uses output buffering).
 376  *
 377  * If clients "If-None-Match" header matches the supplied/calculated
 378  * ETag, the body is considered cached on the clients side and
 379  * a "304 Not Modified" status code is issued.
 380  *
 381  */
 382 PHP_FUNCTION(http_cache_etag)
 383 {
 384         char *etag = NULL;
 385         int etag_len = 0;
 386
 387         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &etag, &etag_len) != SUCCESS) {
 388                 RETURN_FALSE;
 389         }
 390
 391         RETURN_SUCCESS(http_cache_etag(etag, etag_len, HTTP_DEFAULT_CACHECONTROL, lenof(HTTP_DEFAULT_CACHECONTROL)));
 392 }
 393 /* }}} */
 394
 395 /* {{{ proto string ob_etaghandler(string data, int mode)
 396  *
 397  * For use with ob_start().
 398  */
 399 PHP_FUNCTION(ob_etaghandler)
 400 {
 401         char *data;
 402         int data_len;
 403         long mode;
 404
 405         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sl", &data, &data_len, &mode)) {
 406                 RETURN_FALSE;
 407         }
 408
 409         Z_TYPE_P(return_value) = IS_STRING;
 410         http_ob_etaghandler(data, data_len, &Z_STRVAL_P(return_value), &Z_STRLEN_P(return_value), mode);
 411 }
 412 /* }}} */
 413
 414 /* {{{ proto void http_redirect([string url[, array params[, bool session,[ bool permanent]]]])
 415  *
 416  * Redirect to a given url.
 417  * The supplied url will be expanded with http_absolute_uri(), the params array will
 418  * be treated with http_build_query() and the session identification will be appended
 419  * if session is true.
 420  *
 421  * Depending on permanent the redirection will be issued with a permanent
 422  * ("301 Moved Permanently") or a temporary ("302 Found") redirection
 423  * status code.
 424  *
 425  * To be RFC compliant, "Redirecting to <a>URI</a>." will be displayed,
 426  * if the client doesn't redirect immediatly.
 427  */
 428 PHP_FUNCTION(http_redirect)
 429 {
 430         int url_len;
 431         size_t query_len = 0;
 432         zend_bool session = 0, permanent = 0;
 433         zval *params = NULL;
 434         char *query, *url, *URI,
 435                 LOC[HTTP_URI_MAXLEN + sizeof("Location: ")],
 436                 RED[HTTP_URI_MAXLEN * 2 + sizeof("Redirecting to <a href=\"%s?%s\">%s?%s</a>.\n")];
 437
 438         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sa!/bb", &url, &url_len, &params, &session, &permanent) != SUCCESS) {
 439                 RETURN_FALSE;
 440         }
 441
 442         /* append session info */
 443         if (session && (PS(session_status) == php_session_active)) {
 444                 if (!params) {
 445                         MAKE_STD_ZVAL(params);
 446                         array_init(params);
 447                 }
 448                 if (add_assoc_string(params, PS(session_name), PS(id), 1) != SUCCESS) {
 449                         http_error(E_WARNING, HTTP_E_ENCODE, "Could not append session information");
 450                 }
 451         }
 452
 453         /* treat params array with http_build_query() */
 454         if (params) {
 455                 if (SUCCESS != http_urlencode_hash_ex(Z_ARRVAL_P(params), 0, NULL, 0, &query, &query_len)) {
 456                         RETURN_FALSE;
 457                 }
 458         }
 459
 460         URI = http_absolute_uri(url);
 461
 462         if (query_len) {
 463                 snprintf(LOC, HTTP_URI_MAXLEN + sizeof("Location: "), "Location: %s?%s", URI, query);
 464                 sprintf(RED, "Redirecting to <a href=\"%s?%s\">%s?%s</a>.\n", URI, query, URI, query);
 465                 efree(query);
 466         } else {
 467                 snprintf(LOC, HTTP_URI_MAXLEN + sizeof("Location: "), "Location: %s", URI);
 468                 sprintf(RED, "Redirecting to <a href=\"%s\">%s</a>.\n", URI, URI);
 469         }
 470         efree(URI);
 471
 472         if ((SUCCESS == http_send_header(LOC)) && (SUCCESS == http_send_status((permanent ? 301 : 302)))) {
 473                 php_body_write(RED, strlen(RED) TSRMLS_CC);
 474                 RETURN_TRUE;
 475         }
 476         RETURN_FALSE;
 477 }
 478 /* }}} */
 479
 480 /* {{{ proto bool http_send_data(string data)
 481  *
 482  * Sends raw data with support for (multiple) range requests.
 483  *
 484  */
 485 PHP_FUNCTION(http_send_data)
 486 {
 487         zval *zdata;
 488
 489         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &zdata) != SUCCESS) {
 490                 RETURN_FALSE;
 491         }
 492
 493         convert_to_string_ex(&zdata);
 494         RETURN_SUCCESS(http_send_data(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata)));
 495 }
 496 /* }}} */
 497
 498 /* {{{ proto bool http_send_file(string file)
 499  *
 500  * Sends a file with support for (multiple) range requests.
 501  *
 502  */
 503 PHP_FUNCTION(http_send_file)
 504 {
 505         char *file;
 506         int flen = 0;
 507
 508         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &file, &flen) != SUCCESS) {
 509                 RETURN_FALSE;
 510         }
 511         if (!flen) {
 512                 RETURN_FALSE;
 513         }
 514
 515         RETURN_SUCCESS(http_send_file(file));
 516 }
 517 /* }}} */
 518
 519 /* {{{ proto bool http_send_stream(resource stream)
 520  *
 521  * Sends an already opened stream with support for (multiple) range requests.
 522  *
 523  */
 524 PHP_FUNCTION(http_send_stream)
 525 {
 526         zval *zstream;
 527         php_stream *file;
 528
 529         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &zstream) != SUCCESS) {
 530                 RETURN_FALSE;
 531         }
 532
 533         php_stream_from_zval(file, &zstream);
 534         RETURN_SUCCESS(http_send_stream(file));
 535 }
 536 /* }}} */
 537
 538 /* {{{ proto string http_chunked_decode(string encoded)
 539  *
 540  * This function decodes a string that was HTTP-chunked encoded.
 541  * Returns false on failure.
 542  */
 543 PHP_FUNCTION(http_chunked_decode)
 544 {
 545         char *encoded = NULL, *decoded = NULL;
 546         int encoded_len = 0, decoded_len = 0;
 547
 548         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &encoded, &encoded_len) != SUCCESS) {
 549                 RETURN_FALSE;
 550         }
 551
 552         if (NULL != http_chunked_decode(encoded, encoded_len, &decoded, &decoded_len)) {
 553                 RETURN_STRINGL(decoded, decoded_len, 0);
 554         } else {
 555                 RETURN_FALSE;
 556         }
 557 }
 558 /* }}} */
 559
 560 /* {{{ proto array http_split_response(string http_response)
 561  *
 562  * This function splits an HTTP response into an array with headers and the
 563  * content body. The returned array may look simliar to the following example:
 564  *
 565  * <pre>
 566  * <?php
 567  * array(
 568  *     0 => array(
 569  *         'Response Status' => '200 Ok',
 570  *         'Content-Type' => 'text/plain',
 571  *         'Content-Language' => 'en-US'
 572  *     ),
 573  *     1 => "Hello World!"
 574  * );
 575  * ?>
 576  * </pre>
 577  */
 578 PHP_FUNCTION(http_split_response)
 579 {
 580         zval *zresponse, *zbody, *zheaders;
 581
 582         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &zresponse) != SUCCESS) {
 583                 RETURN_FALSE;
 584         }
 585
 586         convert_to_string(zresponse);
 587
 588         MAKE_STD_ZVAL(zbody);
 589         MAKE_STD_ZVAL(zheaders);
 590         array_init(zheaders);
 591
 592         if (SUCCESS != http_split_response(zresponse, zheaders, zbody)) {
 593                 http_error(E_WARNING, HTTP_E_PARSE, "Could not parse HTTP response");
 594                 RETURN_FALSE;
 595         }
 596
 597         array_init(return_value);
 598         add_index_zval(return_value, 0, zheaders);
 599         add_index_zval(return_value, 1, zbody);
 600 }
 601 /* }}} */
 602
 603 /* {{{ proto array http_parse_headers(string header)
 604  *
 605  */
 606 PHP_FUNCTION(http_parse_headers)
 607 {
 608         char *header;
 609         int header_len;
 610
 611         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &header, &header_len)) {
 612                 RETURN_FALSE;
 613         }
 614
 615         array_init(return_value);
 616         if (SUCCESS != http_parse_headers(header, return_value)) {
 617                 http_error(E_WARNING, HTTP_E_PARSE, "Could not parse HTTP headers");
 618                 zval_dtor(return_value);
 619                 RETURN_FALSE;
 620         }
 621 }
 622 /* }}}*/
 623
 624 /* {{{ proto array http_get_request_headers(void)
 625  *
 626  */
 627 PHP_FUNCTION(http_get_request_headers)
 628 {
 629         NO_ARGS;
 630
 631         array_init(return_value);
 632         http_get_request_headers(return_value);
 633 }
 634 /* }}} */
 635
 636 /* {{{ HAVE_CURL */
 637 #ifdef HTTP_HAVE_CURL
 638
 639 /* {{{ proto string http_get(string url[, array options[, array &info]])
 640  *
 641  * Performs an HTTP GET request on the supplied url.
 642  *
 643  * The second parameter is expected to be an associative
 644  * array where the following keys will be recognized:
 645  * <pre>
 646  *  - redirect:         int, whether and how many redirects to follow
 647  *  - unrestrictedauth: bool, whether to continue sending credentials on
 648  *                      redirects to a different host
 649  *  - proxyhost:        string, proxy host in "host[:port]" format
 650  *  - proxyport:        int, use another proxy port as specified in proxyhost
 651  *  - proxyauth:        string, proxy credentials in "user:pass" format
 652  *  - proxyauthtype:    int, HTTP_AUTH_BASIC and/or HTTP_AUTH_NTLM
 653  *  - httpauth:         string, http credentials in "user:pass" format
 654  *  - httpauthtype:     int, HTTP_AUTH_BASIC, DIGEST and/or NTLM
 655  *  - compress:         bool, whether to allow gzip/deflate content encoding
 656  *                      (defaults to true)
 657  *  - port:             int, use another port as specified in the url
 658  *  - referer:          string, the referer to sends
 659  *  - useragent:        string, the user agent to send
 660  *                      (defaults to PECL::HTTP/version (PHP/version)))
 661  *  - headers:          array, list of custom headers as associative array
 662  *                      like array("header" => "value")
 663  *  - cookies:          array, list of cookies as associative array
 664  *                      like array("cookie" => "value")
 665  *  - cookiestore:      string, path to a file where cookies are/will be stored
 666  *  - resume:           int, byte offset to start the download from;
 667  *                      if the server supports ranges
 668  *  - maxfilesize:      int, maximum file size that should be downloaded;
 669  *                      has no effect, if the size of the requested entity is not known
 670  *  - lastmodified:     int, timestamp for If-(Un)Modified-Since header
 671  *  - timeout:          int, seconds the request may take
 672  *  - connecttimeout:   int, seconds the connect may take
 673  * </pre>
 674  *
 675  * The optional third parameter will be filled with some additional information
 676  * in form af an associative array, if supplied, like the following example:
 677  * <pre>
 678  * <?php
 679  * array (
 680  *     'effective_url' => 'http://localhost',
 681  *     'response_code' => 403,
 682  *     'total_time' => 0.017,
 683  *     'namelookup_time' => 0.013,
 684  *     'connect_time' => 0.014,
 685  *     'pretransfer_time' => 0.014,
 686  *     'size_upload' => 0,
 687  *     'size_download' => 202,
 688  *     'speed_download' => 11882,
 689  *     'speed_upload' => 0,
 690  *     'header_size' => 145,
 691  *     'request_size' => 62,
 692  *     'ssl_verifyresult' => 0,
 693  *     'filetime' => -1,
 694  *     'content_length_download' => 202,
 695  *     'content_length_upload' => 0,
 696  *     'starttransfer_time' => 0.017,
 697  *     'content_type' => 'text/html; charset=iso-8859-1',
 698  *     'redirect_time' => 0,
 699  *     'redirect_count' => 0,
 700  *     'private' => '',
 701  *     'http_connectcode' => 0,
 702  *     'httpauth_avail' => 0,
 703  *     'proxyauth_avail' => 0,
 704  * )
 705  * ?>
 706  * </pre>
 707  */
 708 PHP_FUNCTION(http_get)
 709 {
 710         zval *options = NULL, *info = NULL;
 711         char *URL;
 712         int URL_len;
 713         phpstr response;
 714
 715         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a/!z", &URL, &URL_len, &options, &info) != SUCCESS) {
 716                 RETURN_FALSE;
 717         }
 718
 719         if (info) {
 720                 zval_dtor(info);
 721                 array_init(info);
 722         }
 723
 724         phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
 725         if (SUCCESS == http_get(URL, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
 726                 RETURN_PHPSTR_VAL(response);
 727         } else {
 728                 RETURN_FALSE;
 729         }
 730 }
 731 /* }}} */
 732
 733 /* {{{ proto string http_head(string url[, array options[, array &info]])
 734  *
 735  * Performs an HTTP HEAD request on the suppied url.
 736  * Returns the HTTP response as string.
 737  * See http_get() for a full list of available options.
 738  */
 739 PHP_FUNCTION(http_head)
 740 {
 741         zval *options = NULL, *info = NULL;
 742         char *URL;
 743         int URL_len;
 744         phpstr response;
 745
 746         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a/!z", &URL, &URL_len, &options, &info) != SUCCESS) {
 747                 RETURN_FALSE;
 748         }
 749
 750         if (info) {
 751                 zval_dtor(info);
 752                 array_init(info);
 753         }
 754
 755         phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
 756         if (SUCCESS == http_head(URL, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
 757                 RETURN_PHPSTR_VAL(response);
 758         } else {
 759                 RETURN_FALSE;
 760         }
 761 }
 762 /* }}} */
 763
 764 /* {{{ proto string http_post_data(string url, string data[, array options[, &info]])
 765  *
 766  * Performs an HTTP POST request, posting data.
 767  * Returns the HTTP response as string.
 768  * See http_get() for a full list of available options.
 769  */
 770 PHP_FUNCTION(http_post_data)
 771 {
 772         zval *options = NULL, *info = NULL;
 773         char *URL, *postdata;
 774         int postdata_len, URL_len;
 775         phpstr response;
 776
 777         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|a/!z", &URL, &URL_len, &postdata, &postdata_len, &options, &info) != SUCCESS) {
 778                 RETURN_FALSE;
 779         }
 780
 781         if (info) {
 782                 zval_dtor(info);
 783                 array_init(info);
 784         }
 785
 786         phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
 787         if (SUCCESS == http_post_data(URL, postdata, (size_t) postdata_len, options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
 788                 RETURN_PHPSTR_VAL(response);
 789         } else {
 790                 RETURN_FALSE;
 791         }
 792 }
 793 /* }}} */
 794
 795 /* {{{ proto string http_post_array(string url, array data[, array options[, array &info]])
 796  *
 797  * Performs an HTTP POST request, posting www-form-urlencoded array data.
 798  * Returns the HTTP response as string.
 799  * See http_get() for a full list of available options.
 800  */
 801 PHP_FUNCTION(http_post_array)
 802 {
 803         zval *options = NULL, *info = NULL, *postdata;
 804         char *URL;
 805         int URL_len;
 806         phpstr response;
 807
 808         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sa|a/!z", &URL, &URL_len, &postdata, &options, &info) != SUCCESS) {
 809                 RETURN_FALSE;
 810         }
 811
 812         if (info) {
 813                 zval_dtor(info);
 814                 array_init(info);
 815         }
 816
 817         phpstr_init_ex(&response, HTTP_CURLBUF_SIZE, 0);
 818         if (SUCCESS == http_post_array(URL, Z_ARRVAL_P(postdata), options ? Z_ARRVAL_P(options) : NULL, info ? Z_ARRVAL_P(info) : NULL, &response)) {
 819                 RETURN_PHPSTR_VAL(response);
 820         } else {
 821                 RETURN_FALSE;
 822         }
 823 }
 824 /* }}} */
 825
 826 #endif
 827 /* }}} HAVE_CURL */
 828
 829
 830 /* {{{ proto bool http_auth_basic(string user, string pass[, string realm = "Restricted"])
 831  *
 832  * Example:
 833  * <pre>
 834  * <?php
 835  * if (!http_auth_basic('mike', 's3c|r3t')) {
 836  *     die('<h1>Authorization failed!</h1>');
 837  * }
 838  * ?>
 839  * </pre>
 840  */
 841 PHP_FUNCTION(http_auth_basic)
 842 {
 843         char *realm = NULL, *user, *pass, *suser, *spass;
 844         int r_len, u_len, p_len;
 845
 846         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|s", &user, &u_len, &pass, &p_len, &realm, &r_len) != SUCCESS) {
 847                 RETURN_FALSE;
 848         }
 849
 850         if (!realm) {
 851                 realm = "Restricted";
 852         }
 853
 854         if (SUCCESS != http_auth_credentials(&suser, &spass)) {
 855                 http_auth_header("Basic", realm);
 856                 RETURN_FALSE;
 857         }
 858
 859         if (strcasecmp(suser, user)) {
 860                 http_auth_header("Basic", realm);
 861                 RETURN_FALSE;
 862         }
 863
 864         if (strcmp(spass, pass)) {
 865                 http_auth_header("Basic", realm);
 866                 RETURN_FALSE;
 867         }
 868
 869         RETURN_TRUE;
 870 }
 871 /* }}} */
 872
 873 /* {{{ proto bool http_auth_basic_cb(mixed callback[, string realm = "Restricted"])
 874  *
 875  * Example:
 876  * <pre>
 877  * <?php
 878  * function auth_cb($user, $pass)
 879  * {
 880  *     global $db;
 881  *     $query = 'SELECT pass FROM users WHERE user='. $db->quoteSmart($user);
 882  *     if (strlen($realpass = $db->getOne($query)) {
 883  *         return $pass === $realpass;
 884  *     }
 885  *     return false;
 886  * }
 887  * if (!http_auth_basic_cb('auth_cb')) {
 888  *     die('<h1>Authorization failed</h1>');
 889  * }
 890  * ?>
 891  * </pre>
 892  */
 893 PHP_FUNCTION(http_auth_basic_cb)
 894 {
 895         zval *cb;
 896         char *realm = NULL, *user, *pass;
 897         int r_len;
 898
 899         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z|s", &cb, &realm, &r_len) != SUCCESS) {
 900                 RETURN_FALSE;
 901         }
 902
 903         if (!realm) {
 904                 realm = "Restricted";
 905         }
 906
 907         if (SUCCESS != http_auth_credentials(&user, &pass)) {
 908                 http_auth_header("Basic", realm);
 909                 RETURN_FALSE;
 910         }
 911         {
 912                 zval *zparams[2] = {NULL, NULL}, retval;
 913                 int result = 0;
 914
 915                 MAKE_STD_ZVAL(zparams[0]);
 916                 MAKE_STD_ZVAL(zparams[1]);
 917                 ZVAL_STRING(zparams[0], user, 0);
 918                 ZVAL_STRING(zparams[1], pass, 0);
 919
 920                 if (SUCCESS == call_user_function(EG(function_table), NULL, cb,
 921                                 &retval, 2, zparams TSRMLS_CC)) {
 922                         result = Z_LVAL(retval);
 923                 }
 924
 925                 efree(user);
 926                 efree(pass);
 927                 efree(zparams[0]);
 928                 efree(zparams[1]);
 929
 930                 if (!result) {
 931                         http_auth_header("Basic", realm);
 932                 }
 933
 934                 RETURN_BOOL(result);
 935         }
 936 }
 937 /* }}}*/
 938
 939 /* {{{ Sara Golemons http_build_query() */
 940 #ifndef ZEND_ENGINE_2
 941
 942 /* {{{ proto string http_build_query(mixed formdata [, string prefix[, string arg_separator]])
 943    Generates a form-encoded query string from an associative array or object. */
 944 PHP_FUNCTION(http_build_query)
 945 {
 946         zval *formdata;
 947         char *prefix = NULL, *arg_sep = INI_STR("arg_separator.output");
 948         int prefix_len = 0, arg_sep_len = strlen(arg_sep);
 949         phpstr *formstr;
 950
 951         if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z|ss", &formdata, &prefix, &prefix_len, &arg_sep, &arg_sep_len) != SUCCESS) {
 952                 RETURN_FALSE;
 953         }
 954
 955         if (Z_TYPE_P(formdata) != IS_ARRAY && Z_TYPE_P(formdata) != IS_OBJECT) {
 956                 http_error(E_WARNING, HTTP_E_PARAM, "Parameter 1 expected to be Array or Object.  Incorrect value given.");
 957                 RETURN_FALSE;
 958         }
 959
 960         if (!arg_sep_len) {
 961                 arg_sep = HTTP_URL_ARGSEP;
 962         }
 963
 964         formstr = phpstr_new();
 965         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))) {
 966                 phpstr_free(formstr);
 967                 RETURN_FALSE;
 968         }
 969
 970         if (!formstr->used) {
 971                 phpstr_free(formstr);
 972                 RETURN_NULL();
 973         }
 974
 975         RETURN_PHPSTR_PTR(formstr);
 976 }
 977 /* }}} */
 978 #endif /* !ZEND_ENGINE_2 */
 979 /* }}} */
 980
 981 PHP_FUNCTION(http_test)
 982 {
 983         RETURN_NULL();
 984 }
 985
 986 /*
 987  * Local variables:
 988  * tab-width: 4
 989  * c-basic-offset: 4
 990  * End:
 991  * vim600: noet sw=4 ts=4 fdm=marker
 992  * vim<600: noet sw=4 ts=4
 993  */
 994