39327d10f4fa76f8292b0457a989f001ec42a466
[m6w6/ext-http] / http_functions.c
1 /*
2 +--------------------------------------------------------------------+
3 | PECL :: http |
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2004-2005, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
11 */
12
13 /* $Id$ */
14
15 #ifdef HAVE_CONFIG_H
16 # include "config.h"
17 #endif
18
19 #define HTTP_WANT_CURL
20 #define HTTP_WANT_ZLIB
21 #include "php_http.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 #include "zend_operators.h"
28
29 #if defined(HAVE_PHP_SESSION) && !defined(COMPILE_DL_SESSION)
30 # include "ext/session/php_session.h"
31 #endif
32
33 #include "php_http_api.h"
34 #include "php_http_cache_api.h"
35 #include "php_http_date_api.h"
36 #include "php_http_encoding_api.h"
37 #include "php_http_headers_api.h"
38 #include "php_http_message_api.h"
39 #include "php_http_request_api.h"
40 #include "php_http_request_method_api.h"
41 #include "php_http_send_api.h"
42 #include "php_http_url_api.h"
43
44 ZEND_EXTERN_MODULE_GLOBALS(http)
45
46 /* {{{ proto string http_date([int timestamp])
47 *
48 * Compose a valid HTTP date regarding RFC 822/1123
49 * looking like: "Wed, 22 Dec 2004 11:34:47 GMT"
50 *
51 * Takes an optional unix timestamp as parameter.
52 *
53 * Returns the HTTP date as string.
54 */
55 PHP_FUNCTION(http_date)
56 {
57 long t = -1;
58
59 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &t) != SUCCESS) {
60 RETURN_FALSE;
61 }
62
63 if (t == -1) {
64 t = (long) time(NULL);
65 }
66
67 RETURN_STRING(http_date(t), 0);
68 }
69 /* }}} */
70
71 /* {{{ proto string http_build_url(mixed url[, mixed parts[, array new_url]])
72 *
73 * Returns the new URL as string on success or FALSE on failure.
74 */
75 PHP_FUNCTION(http_build_url)
76 {
77 char *url_str = NULL;
78 size_t url_len = 0;
79 zval *z_old_url = NULL, *z_new_url = NULL, *z_composed_url = NULL;
80 php_url *old_url = NULL, *new_url = NULL, *composed_url = NULL;
81
82 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z/|z/z", &z_old_url, &z_new_url, &z_composed_url) != SUCCESS) {
83 RETURN_FALSE;
84 }
85
86 if (z_new_url) {
87 if (Z_TYPE_P(z_new_url) == IS_ARRAY || Z_TYPE_P(z_new_url) == IS_OBJECT) {
88 new_url = array2url(HASH_OF(z_new_url));
89 } else {
90 convert_to_string(z_new_url);
91 if (!(new_url = php_url_parse_ex(Z_STRVAL_P(z_new_url), Z_STRLEN_P(z_new_url)))) {
92 RETURN_FALSE;
93 }
94 }
95 }
96
97 if (Z_TYPE_P(z_old_url) == IS_ARRAY || Z_TYPE_P(z_old_url) == IS_OBJECT) {
98 old_url = array2url(HASH_OF(z_old_url));
99 } else {
100 convert_to_string(z_old_url);
101 if (!(old_url = php_url_parse_ex(Z_STRVAL_P(z_old_url), Z_STRLEN_P(z_old_url)))) {
102 if (new_url) {
103 php_url_free(new_url);
104 }
105 RETURN_FALSE;
106 }
107 }
108
109 if (z_composed_url) {
110 http_build_url(old_url, new_url, &composed_url, &url_str, &url_len);
111
112 zval_dtor(z_composed_url);
113 array_init(z_composed_url);
114 if (composed_url->scheme) {
115 add_assoc_string(z_composed_url, "scheme", composed_url->scheme, 1);
116 }
117 if (composed_url->user) {
118 add_assoc_string(z_composed_url, "user", composed_url->user, 1);
119 }
120 if (composed_url->pass) {
121 add_assoc_string(z_composed_url, "pass", composed_url->pass, 1);
122 }
123 if (composed_url->host) {
124 add_assoc_string(z_composed_url, "host", composed_url->host, 1);
125 }
126 if (composed_url->port) {
127 add_assoc_long(z_composed_url, "port", composed_url->port);
128 }
129 if (composed_url->path) {
130 add_assoc_string(z_composed_url, "path", composed_url->path, 1);
131 }
132 if (composed_url->query) {
133 add_assoc_string(z_composed_url, "query", composed_url->query, 1);
134 }
135 if (composed_url->fragment) {
136 add_assoc_string(z_composed_url, "fragment", composed_url->fragment, 1);
137 }
138 php_url_free(composed_url);
139 } else {
140 http_build_url(old_url, new_url, NULL, &url_str, &url_len);
141 }
142
143 if (new_url) {
144 php_url_free(new_url);
145 }
146 php_url_free(old_url);
147
148 RETURN_STRINGL(url_str, url_len, 0);
149 }
150 /* }}} */
151
152 #define HTTP_DO_NEGOTIATE(type, supported, rs_array) \
153 { \
154 HashTable *result; \
155 if ((result = http_negotiate_ ##type(supported))) { \
156 char *key; \
157 uint key_len; \
158 ulong idx; \
159 \
160 if (HASH_KEY_IS_STRING == zend_hash_get_current_key_ex(result, &key, &key_len, &idx, 1, NULL)) { \
161 RETVAL_STRINGL(key, key_len-1, 0); \
162 } else { \
163 RETVAL_NULL(); \
164 } \
165 \
166 if (rs_array) { \
167 zend_hash_copy(Z_ARRVAL_P(rs_array), result, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *)); \
168 } \
169 \
170 zend_hash_destroy(result); \
171 FREE_HASHTABLE(result); \
172 \
173 } else { \
174 zval **value; \
175 \
176 zend_hash_internal_pointer_reset(Z_ARRVAL_P(supported)); \
177 if (SUCCESS == zend_hash_get_current_data(Z_ARRVAL_P(supported), (void **) &value)) { \
178 RETVAL_ZVAL(*value, 1, 0); \
179 } else { \
180 RETVAL_NULL(); \
181 } \
182 \
183 if (rs_array) { \
184 HashPosition pos; \
185 zval **value; \
186 \
187 FOREACH_VAL(pos, supported, value) { \
188 convert_to_string_ex(value); \
189 add_assoc_double(rs_array, Z_STRVAL_PP(value), 1.0); \
190 } \
191 } \
192 } \
193 }
194
195
196 /* {{{ proto string http_negotiate_language(array supported[, array &result])
197 *
198 * This function negotiates the clients preferred language based on its
199 * Accept-Language HTTP header. The qualifier is recognized and languages
200 * without qualifier are rated highest. The qualifier will be decreased by
201 * 10% for partial matches (i.e. matching primary language).
202 *
203 * Expects an array as parameter cotaining the supported languages as values.
204 * If the optional second parameter is supplied, it will be filled with an
205 * array containing the negotiation results.
206 *
207 * Returns the negotiated language or the default language (i.e. first array entry)
208 * if none match.
209 *
210 * Example:
211 * <pre>
212 * <?php
213 * $langs = array(
214 * 'en-US',// default
215 * 'fr',
216 * 'fr-FR',
217 * 'de',
218 * 'de-DE',
219 * 'de-AT',
220 * 'de-CH',
221 * );
222 *
223 * include './langs/'. http_negotiate_language($langs, $result) .'.php';
224 *
225 * print_r($result);
226 * ?>
227 * </pre>
228 */
229 PHP_FUNCTION(http_negotiate_language)
230 {
231 zval *supported, *rs_array = NULL;
232
233 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|z", &supported, &rs_array) != SUCCESS) {
234 RETURN_FALSE;
235 }
236
237 if (rs_array) {
238 zval_dtor(rs_array);
239 array_init(rs_array);
240 }
241
242 HTTP_DO_NEGOTIATE(language, supported, rs_array);
243 }
244 /* }}} */
245
246 /* {{{ proto string http_negotiate_charset(array supported[, array &result])
247 *
248 * This function negotiates the clients preferred charset based on its
249 * Accept-Charset HTTP header. The qualifier is recognized and charsets
250 * without qualifier are rated highest.
251 *
252 * Expects an array as parameter cotaining the supported charsets as values.
253 * If the optional second parameter is supplied, it will be filled with an
254 * array containing the negotiation results.
255 *
256 * Returns the negotiated charset or the default charset (i.e. first array entry)
257 * if none match.
258 *
259 * Example:
260 * <pre>
261 * <?php
262 * $charsets = array(
263 * 'iso-8859-1', // default
264 * 'iso-8859-2',
265 * 'iso-8859-15',
266 * 'utf-8'
267 * );
268 *
269 * $pref = http_negotiate_charset($charsets, $result);
270 *
271 * if (strcmp($pref, 'iso-8859-1')) {
272 * iconv_set_encoding('internal_encoding', 'iso-8859-1');
273 * iconv_set_encoding('output_encoding', $pref);
274 * ob_start('ob_iconv_handler');
275 * }
276 *
277 * print_r($result);
278 * ?>
279 * </pre>
280 */
281 PHP_FUNCTION(http_negotiate_charset)
282 {
283 zval *supported, *rs_array = NULL;
284
285 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|z", &supported, &rs_array) != SUCCESS) {
286 RETURN_FALSE;
287 }
288
289 if (rs_array) {
290 zval_dtor(rs_array);
291 array_init(rs_array);
292 }
293
294 HTTP_DO_NEGOTIATE(charset, supported, rs_array);
295 }
296 /* }}} */
297
298 /* {{{ proto string http_negotiate_ctype(array supported[, array &result])
299 *
300 * This function negotiates the clients preferred content type based on its
301 * Accept HTTP header. The qualifier is recognized and content types
302 * without qualifier are rated highest.
303 *
304 * Expects an array as parameter cotaining the supported content types as values.
305 * If the optional second parameter is supplied, it will be filled with an
306 * array containing the negotiation results.
307 *
308 * Returns the negotiated content type or the default content type
309 * (i.e. first array entry) if none match.
310 *
311 * Example:
312 * <pre>
313 * <?php
314 * $ctypes = array('application/xhtml+xml', 'text/html');
315 * http_send_content_type(http_negotiate_content_type($ctypes));
316 * ?>
317 * </pre>
318 */
319 PHP_FUNCTION(http_negotiate_content_type)
320 {
321 zval *supported, *rs_array = NULL;
322
323 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|z", &supported, &rs_array)) {
324 RETURN_FALSE;
325 }
326
327 if (rs_array) {
328 zval_dtor(rs_array);
329 array_init(rs_array);
330 }
331
332 HTTP_DO_NEGOTIATE(content_type, supported, rs_array);
333 }
334 /* }}} */
335
336 /* {{{ proto bool http_send_status(int status)
337 *
338 * Send HTTP status code.
339 *
340 * Expects an HTTP status code as parameter.
341 *
342 * Returns TRUE on success or FALSE on failure.
343 */
344 PHP_FUNCTION(http_send_status)
345 {
346 int status = 0;
347
348 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &status) != SUCCESS) {
349 RETURN_FALSE;
350 }
351 if (status < 100 || status > 510) {
352 http_error_ex(HE_WARNING, HTTP_E_HEADER, "Invalid HTTP status code (100-510): %d", status);
353 RETURN_FALSE;
354 }
355
356 RETURN_SUCCESS(http_send_status(status));
357 }
358 /* }}} */
359
360 /* {{{ proto bool http_send_last_modified([int timestamp])
361 *
362 * Send a "Last-Modified" header with a valid HTTP date.
363 *
364 * Accepts a unix timestamp, converts it to a valid HTTP date and
365 * sends it as "Last-Modified" HTTP header. If timestamp is
366 * omitted, the current time will be sent.
367 *
368 * Returns TRUE on success or FALSE on failure.
369 */
370 PHP_FUNCTION(http_send_last_modified)
371 {
372 long t = -1;
373
374 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &t) != SUCCESS) {
375 RETURN_FALSE;
376 }
377
378 if (t == -1) {
379 t = (long) time(NULL);
380 }
381
382 RETURN_SUCCESS(http_send_last_modified(t));
383 }
384 /* }}} */
385
386 /* {{{ proto bool http_send_content_type([string content_type = 'application/x-octetstream'])
387 *
388 * Send the Content-Type of the sent entity. This is particularly important
389 * if you use the http_send() API.
390 *
391 * Accepts an optional string parameter containing the desired content type
392 * (primary/secondary).
393 *
394 * Returns TRUE on success or FALSE on failure.
395 */
396 PHP_FUNCTION(http_send_content_type)
397 {
398 char *ct = "application/x-octetstream";
399 int ct_len = lenof("application/x-octetstream");
400
401 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &ct, &ct_len) != SUCCESS) {
402 RETURN_FALSE;
403 }
404
405 RETURN_SUCCESS(http_send_content_type(ct, ct_len));
406 }
407 /* }}} */
408
409 /* {{{ proto bool http_send_content_disposition(string filename[, bool inline = false])
410 *
411 * Send the Content-Disposition. The Content-Disposition header is very useful
412 * if the data actually sent came from a file or something similar, that should
413 * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
414 *
415 * Expects a string parameter specifying the file name the "Save as..." dialogue
416 * should display. Optionally accepts a bool parameter, which, if set to true
417 * and the user agent knows how to handle the content type, will probably not
418 * cause the popup window to be shown.
419 *
420 * Returns TRUE on success or FALSE on failure.
421 */
422 PHP_FUNCTION(http_send_content_disposition)
423 {
424 char *filename;
425 int f_len;
426 zend_bool send_inline = 0;
427
428 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &filename, &f_len, &send_inline) != SUCCESS) {
429 RETURN_FALSE;
430 }
431 RETURN_SUCCESS(http_send_content_disposition(filename, f_len, send_inline));
432 }
433 /* }}} */
434
435 /* {{{ proto bool http_match_modified([int timestamp[, bool for_range = false]])
436 *
437 * Matches the given unix timestamp against the clients "If-Modified-Since"
438 * resp. "If-Unmodified-Since" HTTP headers.
439 *
440 * Accepts a unix timestamp which should be matched. Optionally accepts an
441 * additional bool parameter, which if set to true will check the header
442 * usually used to validate HTTP ranges. If timestamp is omitted, the
443 * current time will be used.
444 *
445 * Returns TRUE if timestamp represents an earlier date than the header,
446 * else FALSE.
447 */
448 PHP_FUNCTION(http_match_modified)
449 {
450 long t = -1;
451 zend_bool for_range = 0;
452
453 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|lb", &t, &for_range) != SUCCESS) {
454 RETURN_FALSE;
455 }
456
457 // current time if not supplied (senseless though)
458 if (t == -1) {
459 t = (long) time(NULL);
460 }
461
462 if (for_range) {
463 RETURN_BOOL(http_match_last_modified("HTTP_IF_UNMODIFIED_SINCE", t));
464 }
465 RETURN_BOOL(http_match_last_modified("HTTP_IF_MODIFIED_SINCE", t));
466 }
467 /* }}} */
468
469 /* {{{ proto bool http_match_etag(string etag[, bool for_range = false])
470 *
471 * Matches the given ETag against the clients "If-Match" resp.
472 * "If-None-Match" HTTP headers.
473 *
474 * Expects a string parameter containing the ETag to compare. Optionally
475 * accepts a bool parameter, which, if set to true, will check the header
476 * usually used to validate HTTP ranges.
477 *
478 * Retuns TRUE if ETag matches or the header contained the asterisk ("*"),
479 * else FALSE.
480 */
481 PHP_FUNCTION(http_match_etag)
482 {
483 int etag_len;
484 char *etag;
485 zend_bool for_range = 0;
486
487 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &etag, &etag_len, &for_range) != SUCCESS) {
488 RETURN_FALSE;
489 }
490
491 if (for_range) {
492 RETURN_BOOL(http_match_etag("HTTP_IF_MATCH", etag));
493 }
494 RETURN_BOOL(http_match_etag("HTTP_IF_NONE_MATCH", etag));
495 }
496 /* }}} */
497
498 /* {{{ proto bool http_cache_last_modified([int timestamp_or_expires]])
499 *
500 * Attempts to cache the sent entity by its last modification date.
501 *
502 * Accepts a unix timestamp as parameter which is handled as follows:
503 *
504 * If timestamp_or_expires is greater than 0, it is handled as timestamp
505 * and will be sent as date of last modification. If it is 0 or omitted,
506 * the current time will be sent as Last-Modified date. If it's negative,
507 * it is handled as expiration time in seconds, which means that if the
508 * requested last modification date is not between the calculated timespan,
509 * the Last-Modified header is updated and the actual body will be sent.
510 *
511 * Returns FALSE on failure, or *exits* with "304 Not Modified" if the entity is cached.
512 *
513 * A log entry will be written to the cache log if the INI entry
514 * http.cache_log is set and the cache attempt was successful.
515 */
516 PHP_FUNCTION(http_cache_last_modified)
517 {
518 long last_modified = 0, send_modified = 0, t;
519 zval *zlm;
520
521 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &last_modified) != SUCCESS) {
522 RETURN_FALSE;
523 }
524
525 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE);
526
527 t = (long) time(NULL);
528
529 /* 0 or omitted */
530 if (!last_modified) {
531 /* does the client have? (att: caching "forever") */
532 if ((zlm = http_get_server_var("HTTP_IF_MODIFIED_SINCE"))) {
533 last_modified = send_modified = http_parse_date(Z_STRVAL_P(zlm));
534 /* send current time */
535 } else {
536 send_modified = t;
537 }
538 /* negative value is supposed to be expiration time */
539 } else if (last_modified < 0) {
540 last_modified += t;
541 send_modified = t;
542 /* send supplied time explicitly */
543 } else {
544 send_modified = last_modified;
545 }
546
547 RETURN_SUCCESS(http_cache_last_modified(last_modified, send_modified, HTTP_DEFAULT_CACHECONTROL, lenof(HTTP_DEFAULT_CACHECONTROL)));
548 }
549 /* }}} */
550
551 /* {{{ proto bool http_cache_etag([string etag])
552 *
553 * Attempts to cache the sent entity by its ETag, either supplied or generated
554 * by the hash algorythm specified by the INI setting "http.etag_mode".
555 *
556 * If the clients "If-None-Match" header matches the supplied/calculated
557 * ETag, the body is considered cached on the clients side and
558 * a "304 Not Modified" status code is issued.
559 *
560 * Returns FALSE on failure, or *exits* with "304 Not Modified" if the entity is cached.
561 *
562 * A log entry is written to the cache log if the INI entry
563 * "http.cache_log" is set and the cache attempt was successful.
564 */
565 PHP_FUNCTION(http_cache_etag)
566 {
567 char *etag = NULL;
568 int etag_len = 0;
569
570 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &etag, &etag_len) != SUCCESS) {
571 RETURN_FALSE;
572 }
573
574 HTTP_CHECK_HEADERS_SENT(RETURN_FALSE);
575
576 RETURN_SUCCESS(http_cache_etag(etag, etag_len, HTTP_DEFAULT_CACHECONTROL, lenof(HTTP_DEFAULT_CACHECONTROL)));
577 }
578 /* }}} */
579
580 /* {{{ proto string ob_etaghandler(string data, int mode)
581 *
582 * For use with ob_start(). Output buffer handler generating an ETag with
583 * the hash algorythm specified with the INI setting "http.etag_mode".
584 */
585 PHP_FUNCTION(ob_etaghandler)
586 {
587 char *data;
588 int data_len;
589 long mode;
590
591 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sl", &data, &data_len, &mode)) {
592 RETURN_FALSE;
593 }
594
595 Z_TYPE_P(return_value) = IS_STRING;
596 http_ob_etaghandler(data, data_len, &Z_STRVAL_P(return_value), (uint *) &Z_STRLEN_P(return_value), mode);
597 }
598 /* }}} */
599
600 /* {{{ proto void http_throttle(double sec[, int bytes = 40960])
601 *
602 * Sets the throttle delay and send buffer size for use with http_send() API.
603 * Provides a basic throttling mechanism, which will yield the current process
604 * resp. thread until the entity has been completely sent, though.
605 *
606 * Note: This doesn't really work with the FastCGI SAPI.
607 *
608 * Expects a double parameter specifying the seconds too sleep() after
609 * each chunk sent. Additionally accepts an optional int parameter
610 * representing the chunk size in bytes.
611 *
612 * Example:
613 * <pre>
614 * <?php
615 * // ~ 20 kbyte/s
616 * # http_throttle(1, 20000);
617 * # http_throttle(0.5, 10000);
618 * # http_throttle(0.1, 2000);
619 * http_send_file('document.pdf');
620 * ?>
621 * </pre>
622 */
623 PHP_FUNCTION(http_throttle)
624 {
625 long chunk_size = HTTP_SENDBUF_SIZE;
626 double interval;
627
628 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "d|l", &interval, &chunk_size)) {
629 return;
630 }
631
632 HTTP_G(send).throttle_delay = interval;
633 HTTP_G(send).buffer_size = chunk_size;
634 }
635 /* }}} */
636
637 /* {{{ proto void http_redirect([string url[, array params[, bool session = false[, int status = 302]]]])
638 *
639 * Redirect to the given url.
640 *
641 * The supplied url will be expanded with http_build_uri(), the params array will
642 * be treated with http_build_query() and the session identification will be appended
643 * if session is true.
644 *
645 * The HTTP response code will be set according to status.
646 * You can use one of the following constants for convenience:
647 * - HTTP_REDIRECT 302 Found
648 * - HTTP_REDIRECT_PERM 301 Moved Permanently
649 * - HTTP_REDIRECT_POST 303 See Other
650 * - HTTP_REDIRECT_TEMP 307 Temporary Redirect
651 *
652 * Please see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3
653 * for which redirect response code to use in which situation.
654 *
655 * To be RFC compliant, "Redirecting to <a>URI</a>." will be displayed,
656 * if the client doesn't redirect immediatly, and the request method was
657 * another one than HEAD.
658 *
659 * Returns FALSE on failure, or *exits* on success.
660 *
661 * A log entry will be written to the redirect log, if the INI entry
662 * "http.redirect_log" is set and the redirect attempt was successful.
663 */
664 PHP_FUNCTION(http_redirect)
665 {
666 int url_len;
667 size_t query_len = 0;
668 zend_bool session = 0, free_params = 0;
669 zval *params = NULL;
670 long status = 302;
671 char *query = NULL, *url = NULL, *URI, *LOC, *RED = NULL;
672
673 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sa!/bl", &url, &url_len, &params, &session, &status) != SUCCESS) {
674 RETURN_FALSE;
675 }
676
677 /* append session info */
678 if (session) {
679 if (!params) {
680 free_params = 1;
681 MAKE_STD_ZVAL(params);
682 array_init(params);
683 }
684 #ifdef HAVE_PHP_SESSION
685 # ifdef COMPILE_DL_SESSION
686 if (SUCCESS == zend_get_module_started("session")) {
687 zval nm_retval, id_retval, func;
688
689 INIT_PZVAL(&func);
690 INIT_PZVAL(&nm_retval);
691 INIT_PZVAL(&id_retval);
692 ZVAL_NULL(&nm_retval);
693 ZVAL_NULL(&id_retval);
694
695 ZVAL_STRINGL(&func, "session_id", lenof("session_id"), 0);
696 call_user_function(EG(function_table), NULL, &func, &id_retval, 0, NULL TSRMLS_CC);
697 ZVAL_STRINGL(&func, "session_name", lenof("session_name"), 0);
698 call_user_function(EG(function_table), NULL, &func, &nm_retval, 0, NULL TSRMLS_CC);
699
700 if ( Z_TYPE(nm_retval) == IS_STRING && Z_STRLEN(nm_retval) &&
701 Z_TYPE(id_retval) == IS_STRING && Z_STRLEN(id_retval)) {
702 if (add_assoc_stringl_ex(params, Z_STRVAL(nm_retval), Z_STRLEN(nm_retval)+1,
703 Z_STRVAL(id_retval), Z_STRLEN(id_retval), 0) != SUCCESS) {
704 http_error(HE_WARNING, HTTP_E_RUNTIME, "Could not append session information");
705 }
706 }
707 }
708 # else
709 if (PS(session_status) == php_session_active) {
710 if (add_assoc_string(params, PS(session_name), PS(id), 1) != SUCCESS) {
711 http_error(HE_WARNING, HTTP_E_RUNTIME, "Could not append session information");
712 }
713 }
714 # endif
715 #endif
716 }
717
718 /* treat params array with http_build_query() */
719 if (params) {
720 if (SUCCESS != http_urlencode_hash_ex(Z_ARRVAL_P(params), 0, NULL, 0, &query, &query_len)) {
721 if (free_params) {
722 zval_dtor(params);
723 FREE_ZVAL(params);
724 }
725 if (query) {
726 efree(query);
727 }
728 RETURN_FALSE;
729 }
730 }
731
732 URI = http_absolute_url(url);
733
734 if (query_len) {
735 spprintf(&LOC, 0, "Location: %s?%s", URI, query);
736 if (SG(request_info).request_method && strcmp(SG(request_info).request_method, "HEAD")) {
737 spprintf(&RED, 0, "Redirecting to <a href=\"%s?%s\">%s?%s</a>.\n", URI, query, URI, query);
738 }
739 } else {
740 spprintf(&LOC, 0, "Location: %s", URI);
741 if (SG(request_info).request_method && strcmp(SG(request_info).request_method, "HEAD")) {
742 spprintf(&RED, 0, "Redirecting to <a href=\"%s\">%s</a>.\n", URI, URI);
743 }
744 }
745
746 efree(URI);
747 if (query) {
748 efree(query);
749 }
750 if (free_params) {
751 zval_dtor(params);
752 FREE_ZVAL(params);
753 }
754
755 RETURN_SUCCESS(http_exit_ex(status, LOC, RED, 1));
756 }
757 /* }}} */
758
759 /* {{{ proto bool http_send_data(string data)
760 *
761 * Sends raw data with support for (multiple) range requests.
762 *
763 * Retursn TRUE on success, or FALSE on failure.
764 */
765 PHP_FUNCTION(http_send_data)
766 {
767 zval *zdata;
768
769 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &zdata) != SUCCESS) {
770 RETURN_FALSE;
771 }
772
773 convert_to_string_ex(&zdata);
774 RETURN_SUCCESS(http_send_data(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata)));
775 }
776 /* }}} */
777
778 /* {{{ proto bool http_send_file(string file)
779 *
780 * Sends a file with support for (multiple) range requests.
781 *
782 * Expects a string parameter referencing the file to send.
783 *
784 * Returns TRUE on success, or FALSE on failure.
785 */
786 PHP_FUNCTION(http_send_file)
787 {
788 char *file;
789 int flen = 0;
790
791 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &file, &flen) != SUCCESS) {
792 RETURN_FALSE;
793 }
794 if (!flen) {
795 RETURN_FALSE;
796 }
797
798 RETURN_SUCCESS(http_send_file(file));
799 }
800 /* }}} */
801
802 /* {{{ proto bool http_send_stream(resource stream)
803 *
804 * Sends an already opened stream with support for (multiple) range requests.
805 *
806 * Expects a resource parameter referncing the stream to read from.
807 *
808 * Returns TRUE on success, or FALSE on failure.
809 */
810 PHP_FUNCTION(http_send_stream)
811 {
812 zval *zstream;
813 php_stream *file;
814
815 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &zstream) != SUCCESS) {
816 RETURN_FALSE;
817 }
818
819 php_stream_from_zval(file, &zstream);
820 RETURN_SUCCESS(http_send_stream(file));
821 }
822 /* }}} */
823
824 /* {{{ proto string http_chunked_decode(string encoded)
825 *
826 * Decodes a string that was HTTP-chunked encoded.
827 *
828 * Expects a chunked encoded string as parameter.
829 *
830 * Returns the decoded string on success or FALSE on failure.
831 */
832 PHP_FUNCTION(http_chunked_decode)
833 {
834 char *encoded = NULL, *decoded = NULL;
835 size_t decoded_len = 0;
836 int encoded_len = 0;
837
838 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &encoded, &encoded_len) != SUCCESS) {
839 RETURN_FALSE;
840 }
841
842 if (NULL != http_encoding_dechunk(encoded, encoded_len, &decoded, &decoded_len)) {
843 RETURN_STRINGL(decoded, (int) decoded_len, 0);
844 } else {
845 RETURN_FALSE;
846 }
847 }
848 /* }}} */
849
850 /* {{{ proto object http_parse_message(string message)
851 *
852 * Parses (a) http_message(s) into a simple recursive object structure.
853 *
854 * Expects a string parameter containing a single HTTP message or
855 * several consecutive HTTP messages.
856 *
857 * Returns an hierachical object structure of the parsed messages.
858 *
859 * Example:
860 * <pre>
861 * <?php
862 * print_r(http_parse_message(http_get(URL, array('redirect' => 3)));
863 *
864 * stdClass object
865 * (
866 * [type] => 2
867 * [httpVersion] => 1.1
868 * [responseCode] => 200
869 * [headers] => Array
870 * (
871 * [Content-Length] => 3
872 * [Server] => Apache
873 * )
874 * [body] => Hi!
875 * [parentMessage] => stdClass object
876 * (
877 * [type] => 2
878 * [httpVersion] => 1.1
879 * [responseCode] => 302
880 * [headers] => Array
881 * (
882 * [Content-Length] => 0
883 * [Location] => ...
884 * )
885 * [body] =>
886 * [parentMessage] => ...
887 * )
888 * )
889 * ?>
890 * </pre>
891 */
892 PHP_FUNCTION(http_parse_message)
893 {
894 char *message;
895 int message_len;
896 http_message *msg = NULL;
897
898 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &message, &message_len)) {
899 RETURN_NULL();
900 }
901
902 if ((msg = http_message_parse(message, message_len))) {
903 object_init(return_value);
904 http_message_tostruct_recursive(msg, return_value);
905 http_message_free(&msg);
906 } else {
907 RETURN_NULL();
908 }
909 }
910 /* }}} */
911
912 /* {{{ proto array http_parse_headers(string header)
913 *
914 * Parses HTTP headers into an associative array.
915 *
916 * Expects a string parameter containing HTTP headers.
917 *
918 * Returns an array on success, or FALSE on failure.
919 *
920 * Example:
921 * <pre>
922 * <?php
923 * $headers = "content-type: text/html; charset=UTF-8\r\n".
924 * "Server: Funky/1.0\r\n".
925 * "Set-Cookie: foo=bar\r\n".
926 * "Set-Cookie: baz=quux\r\n".
927 * "Folded: works\r\n\ttoo\r\n";
928 * print_r(http_parse_headers($headers));
929 *
930 * Array
931 * (
932 * [Content-Type] => text/html; chatset=UTF-8
933 * [Server] => Funky/1.0
934 * [Set-Cookie] => Array
935 * (
936 * [0] => foo=bar
937 * [1] => baz=quux
938 * )
939 * [Folded] => works
940 * too
941 * )
942 * ?>
943 * </pre>
944 */
945 PHP_FUNCTION(http_parse_headers)
946 {
947 char *header;
948 int header_len;
949
950 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &header, &header_len)) {
951 RETURN_FALSE;
952 }
953
954 array_init(return_value);
955 if (SUCCESS != http_parse_headers(header, return_value)) {
956 zval_dtor(return_value);
957 RETURN_FALSE;
958 }
959 }
960 /* }}}*/
961
962 /* {{{ proto object http_parse_cookie(string cookie)
963 *
964 * Parses HTTP cookies like sent in a response into a struct.
965 *
966 * Expects a string as parameter containing the value of a Set-Cookie response header.
967 *
968 * Returns an stdClass object with the cookie params as properties on success or FALSE on failure.
969 *
970 * Example:
971 * <pre>
972 * <?php
973 * print_r(http_parse_cookie("foo=bar; path=/"));
974 *
975 * stdClass Object
976 * (
977 * [name] => foo
978 * [value] => bar
979 * [path] => /
980 * )
981 * ?>
982 * </pre>
983 */
984 PHP_FUNCTION(http_parse_cookie)
985 {
986 char *cookie;
987 int cookie_len;
988
989 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &cookie, &cookie_len)) {
990 RETURN_FALSE;
991 }
992
993 object_init(return_value);
994 if (SUCCESS != http_parse_cookie(cookie, HASH_OF(return_value))) {
995 zval_dtor(return_value);
996 RETURN_FALSE;
997 }
998 }
999
1000 /* {{{ proto array http_get_request_headers(void)
1001 *
1002 * Get a list of incoming HTTP headers.
1003 *
1004 * Returns an associative array of incoming request headers.
1005 */
1006 PHP_FUNCTION(http_get_request_headers)
1007 {
1008 NO_ARGS;
1009
1010 array_init(return_value);
1011 http_get_request_headers(return_value);
1012 }
1013 /* }}} */
1014
1015 /* {{{ proto string http_get_request_body(void)
1016 *
1017 * Get the raw request body (e.g. POST or PUT data).
1018 *
1019 * Returns NULL when using the CLI SAPI.
1020 */
1021 PHP_FUNCTION(http_get_request_body)
1022 {
1023 char *body;
1024 size_t length;
1025
1026 NO_ARGS;
1027
1028 if (SUCCESS == http_get_request_body(&body, &length)) {
1029 RETURN_STRINGL(body, (int) length, 0);
1030 } else {
1031 RETURN_NULL();
1032 }
1033 }
1034 /* }}} */
1035
1036 /* {{{ proto bool http_match_request_header(string header, string value[, bool match_case = false])
1037 *
1038 * Match an incoming HTTP header.
1039 *
1040 * Expects two string parameters representing the header name (case-insensitive)
1041 * and the header value that should be compared. The case sensitivity of the
1042 * header value depends on the additional optional bool parameter accepted.
1043 *
1044 * Returns TRUE if header value matches, else FALSE.
1045 */
1046 PHP_FUNCTION(http_match_request_header)
1047 {
1048 char *header, *value;
1049 int header_len, value_len;
1050 zend_bool match_case = 0;
1051
1052 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|b", &header, &header_len, &value, &value_len, &match_case)) {
1053 RETURN_FALSE;
1054 }
1055
1056 RETURN_BOOL(http_match_request_header_ex(header, value, match_case));
1057 }
1058 /* }}} */
1059
1060 /* {{{ HAVE_CURL */
1061 #ifdef HTTP_HAVE_CURL
1062
1063 #define RETVAL_RESPONSE_OR_BODY(request) \
1064 { \
1065 zval **bodyonly; \
1066 \
1067 /* check if only the body should be returned */ \
1068 if (options && (SUCCESS == zend_hash_find(Z_ARRVAL_P(options), "bodyonly", sizeof("bodyonly"), (void **) &bodyonly)) && zval_is_true(*bodyonly)) { \
1069 http_message *msg = http_message_parse(PHPSTR_VAL(&request.conv.response), PHPSTR_LEN(&request.conv.response)); \
1070 \
1071 if (msg) { \
1072 RETVAL_STRINGL(PHPSTR_VAL(&msg->body), PHPSTR_LEN(&msg->body), 1); \
1073 http_message_free(&msg); \
1074 } \
1075 } else { \
1076 RETVAL_STRINGL(request.conv.response.data, request.conv.response.used, 1); \
1077 } \
1078 }
1079
1080 /* {{{ proto string http_get(string url[, array options[, array &info]])
1081 *
1082 * Performs an HTTP GET request on the supplied url.
1083 *
1084 * The second parameter, if set, is expected to be an associative
1085 * array where the following keys will be recognized:
1086 * <pre>
1087 * - redirect: int, whether and how many redirects to follow
1088 * - unrestrictedauth: bool, whether to continue sending credentials on
1089 * redirects to a different host
1090 * - proxyhost: string, proxy host in "host[:port]" format
1091 * - proxyport: int, use another proxy port as specified in proxyhost
1092 * - proxyauth: string, proxy credentials in "user:pass" format
1093 * - proxyauthtype: int, HTTP_AUTH_BASIC and/or HTTP_AUTH_NTLM
1094 * - httpauth: string, http credentials in "user:pass" format
1095 * - httpauthtype: int, HTTP_AUTH_BASIC, DIGEST and/or NTLM
1096 * - compress: bool, whether to allow gzip/deflate content encoding
1097 * (defaults to true)
1098 * - port: int, use another port as specified in the url
1099 * - referer: string, the referer to send
1100 * - useragent: string, the user agent to send
1101 * (defaults to PECL::HTTP/version (PHP/version)))
1102 * - headers: array, list of custom headers as associative array
1103 * like array("header" => "value")
1104 * - cookies: array, list of cookies as associative array
1105 * like array("cookie" => "value")
1106 * - cookiestore: string, path to a file where cookies are/will be stored
1107 * - resume: int, byte offset to start the download from;
1108 * if the server supports ranges
1109 * - maxfilesize: int, maximum file size that should be downloaded;
1110 * has no effect, if the size of the requested entity is not known
1111 * - lastmodified: int, timestamp for If-(Un)Modified-Since header
1112 * - timeout: int, seconds the request may take
1113 * - connecttimeout: int, seconds the connect may take
1114 * - onprogress: mixed, progress callback
1115 * </pre>
1116 *
1117 * The optional third parameter will be filled with some additional information
1118 * in form af an associative array, if supplied, like the following example:
1119 * <pre>
1120 * <?php
1121 * array (
1122 * 'effective_url' => 'http://localhost',
1123 * 'response_code' => 403,
1124 * 'total_time' => 0.017,
1125 * 'namelookup_time' => 0.013,
1126 * 'connect_time' => 0.014,
1127 * 'pretransfer_time' => 0.014,
1128 * 'size_upload' => 0,
1129 * 'size_download' => 202,
1130 * 'speed_download' => 11882,
1131 * 'speed_upload' => 0,
1132 * 'header_size' => 145,
1133 * 'request_size' => 62,
1134 * 'ssl_verifyresult' => 0,
1135 * 'filetime' => -1,
1136 * 'content_length_download' => 202,
1137 * 'content_length_upload' => 0,
1138 * 'starttransfer_time' => 0.017,
1139 * 'content_type' => 'text/html; charset=iso-8859-1',
1140 * 'redirect_time' => 0,
1141 * 'redirect_count' => 0,
1142 * 'http_connectcode' => 0,
1143 * 'httpauth_avail' => 0,
1144 * 'proxyauth_avail' => 0,
1145 * )
1146 * ?>
1147 * </pre>
1148 *
1149 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1150 */
1151 PHP_FUNCTION(http_get)
1152 {
1153 zval *options = NULL, *info = NULL;
1154 char *URL;
1155 int URL_len;
1156 http_request request;
1157
1158 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a/!z", &URL, &URL_len, &options, &info) != SUCCESS) {
1159 RETURN_FALSE;
1160 }
1161
1162 if (info) {
1163 zval_dtor(info);
1164 array_init(info);
1165 }
1166
1167 RETVAL_FALSE;
1168
1169 http_request_init_ex(&request, NULL, HTTP_GET, URL);
1170 if (SUCCESS == http_request_prepare(&request, options?Z_ARRVAL_P(options):NULL)) {
1171 http_request_exec(&request);
1172 if (info) {
1173 http_request_info(&request, Z_ARRVAL_P(info));
1174 }
1175 RETVAL_RESPONSE_OR_BODY(request);
1176 }
1177 http_request_dtor(&request);
1178 }
1179 /* }}} */
1180
1181 /* {{{ proto string http_head(string url[, array options[, array &info]])
1182 *
1183 * Performs an HTTP HEAD request on the supplied url.
1184 *
1185 * See http_get() for a full list of available parameters and options.
1186 *
1187 * Returns the HTTP response as string on success, or FALSE on failure.
1188 */
1189 PHP_FUNCTION(http_head)
1190 {
1191 zval *options = NULL, *info = NULL;
1192 char *URL;
1193 int URL_len;
1194 http_request request;
1195
1196 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a/!z", &URL, &URL_len, &options, &info) != SUCCESS) {
1197 RETURN_FALSE;
1198 }
1199
1200 if (info) {
1201 zval_dtor(info);
1202 array_init(info);
1203 }
1204
1205 RETVAL_FALSE;
1206
1207 http_request_init_ex(&request, NULL, HTTP_HEAD, URL);
1208 if (SUCCESS == http_request_prepare(&request, options?Z_ARRVAL_P(options):NULL)) {
1209 http_request_exec(&request);
1210 if (info) {
1211 http_request_info(&request, Z_ARRVAL_P(info));
1212 }
1213 RETVAL_RESPONSE_OR_BODY(request);
1214 }
1215 http_request_dtor(&request);
1216 }
1217 /* }}} */
1218
1219 /* {{{ proto string http_post_data(string url, string data[, array options[, array &info]])
1220 *
1221 * Performs an HTTP POST requeston the supplied url.
1222 *
1223 * Expects a string as second parameter containing the pre-encoded post data.
1224 * See http_get() for a full list of available parameters and options.
1225 *
1226 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1227 */
1228 PHP_FUNCTION(http_post_data)
1229 {
1230 zval *options = NULL, *info = NULL;
1231 char *URL, *postdata;
1232 int postdata_len, URL_len;
1233 http_request_body body;
1234 http_request request;
1235
1236 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|a/!z", &URL, &URL_len, &postdata, &postdata_len, &options, &info) != SUCCESS) {
1237 RETURN_FALSE;
1238 }
1239
1240 if (info) {
1241 zval_dtor(info);
1242 array_init(info);
1243 }
1244
1245 RETVAL_FALSE;
1246
1247 http_request_init_ex(&request, NULL, HTTP_POST, URL);
1248 request.body = http_request_body_init_ex(&body, HTTP_REQUEST_BODY_CSTRING, postdata, postdata_len, 0);
1249 if (SUCCESS == http_request_prepare(&request, options?Z_ARRVAL_P(options):NULL)) {
1250 http_request_exec(&request);
1251 if (info) {
1252 http_request_info(&request, Z_ARRVAL_P(info));
1253 }
1254 RETVAL_RESPONSE_OR_BODY(request);
1255 }
1256 http_request_dtor(&request);
1257 }
1258 /* }}} */
1259
1260 /* {{{ proto string http_post_fields(string url, array data[, array files[, array options[, array &info]]])
1261 *
1262 * Performs an HTTP POST request on the supplied url.
1263 *
1264 * Expecrs an associative array as second parameter, which will be
1265 * www-form-urlencoded. See http_get() for a full list of available options.
1266 *
1267 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1268 */
1269 PHP_FUNCTION(http_post_fields)
1270 {
1271 zval *options = NULL, *info = NULL, *fields, *files = NULL;
1272 char *URL;
1273 int URL_len;
1274 http_request_body body;
1275 http_request request;
1276
1277 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sa|aa/!z", &URL, &URL_len, &fields, &files, &options, &info) != SUCCESS) {
1278 RETURN_FALSE;
1279 }
1280
1281 if (!http_request_body_fill(&body, Z_ARRVAL_P(fields), files ? Z_ARRVAL_P(files) : NULL)) {
1282 RETURN_FALSE;
1283 }
1284
1285 if (info) {
1286 zval_dtor(info);
1287 array_init(info);
1288 }
1289
1290 RETVAL_FALSE;
1291
1292 http_request_init_ex(&request, NULL, HTTP_POST, URL);
1293 request.body = &body;
1294 if (SUCCESS == http_request_prepare(&request, options?Z_ARRVAL_P(options):NULL)) {
1295 http_request_exec(&request);
1296 if (info) {
1297 http_request_info(&request, Z_ARRVAL_P(info));
1298 }
1299 RETVAL_RESPONSE_OR_BODY(request);
1300 }
1301 http_request_dtor(&request);
1302 }
1303 /* }}} */
1304
1305 /* {{{ proto string http_put_file(string url, string file[, array options[, array &info]])
1306 *
1307 * Performs an HTTP PUT request on the supplied url.
1308 *
1309 * Expects the second parameter to be a string referncing the file to upload.
1310 * See http_get() for a full list of available options.
1311 *
1312 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1313 */
1314 PHP_FUNCTION(http_put_file)
1315 {
1316 char *URL, *file;
1317 int URL_len, f_len;
1318 zval *options = NULL, *info = NULL;
1319 php_stream *stream;
1320 php_stream_statbuf ssb;
1321 http_request_body body;
1322 http_request request;
1323
1324 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|a/!z", &URL, &URL_len, &file, &f_len, &options, &info)) {
1325 RETURN_FALSE;
1326 }
1327
1328 if (!(stream = php_stream_open_wrapper(file, "rb", REPORT_ERRORS|ENFORCE_SAFE_MODE, NULL))) {
1329 RETURN_FALSE;
1330 }
1331 if (php_stream_stat(stream, &ssb)) {
1332 php_stream_close(stream);
1333 RETURN_FALSE;
1334 }
1335
1336 if (info) {
1337 zval_dtor(info);
1338 array_init(info);
1339 }
1340
1341 RETVAL_FALSE;
1342
1343 body.type = HTTP_REQUEST_BODY_UPLOADFILE;
1344 body.data = stream;
1345 body.size = ssb.sb.st_size;
1346
1347 http_request_init_ex(&request, NULL, HTTP_PUT, URL);
1348 request.body = &body;
1349 if (SUCCESS == http_request_prepare(&request, options?Z_ARRVAL_P(options):NULL)) {
1350 http_request_exec(&request);
1351 if (info) {
1352 http_request_info(&request, Z_ARRVAL_P(info));
1353 }
1354 RETVAL_RESPONSE_OR_BODY(request);
1355 }
1356 http_request_body_dtor(&body);
1357 request.body = NULL;
1358 http_request_dtor(&request);
1359 }
1360 /* }}} */
1361
1362 /* {{{ proto string http_put_stream(string url, resource stream[, array options[, array &info]])
1363 *
1364 * Performs an HTTP PUT request on the supplied url.
1365 *
1366 * Expects the second parameter to be a resource referencing an already
1367 * opened stream, from which the data to upload should be read.
1368 * See http_get() for a full list of available options.
1369 *
1370 * Returns the HTTP response(s) as string on success. or FALSE on failure.
1371 */
1372 PHP_FUNCTION(http_put_stream)
1373 {
1374 zval *resource, *options = NULL, *info = NULL;
1375 char *URL;
1376 int URL_len;
1377 php_stream *stream;
1378 php_stream_statbuf ssb;
1379 http_request_body body;
1380 http_request request;
1381
1382 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sr|a/!z", &URL, &URL_len, &resource, &options, &info)) {
1383 RETURN_FALSE;
1384 }
1385
1386 php_stream_from_zval(stream, &resource);
1387 if (php_stream_stat(stream, &ssb)) {
1388 RETURN_FALSE;
1389 }
1390
1391 if (info) {
1392 zval_dtor(info);
1393 array_init(info);
1394 }
1395
1396 RETVAL_FALSE;
1397
1398 body.type = HTTP_REQUEST_BODY_UPLOADFILE;
1399 body.data = stream;
1400 body.size = ssb.sb.st_size;
1401
1402 http_request_init_ex(&request, NULL, HTTP_POST, URL);
1403 request.body = &body;
1404 if (SUCCESS == http_request_prepare(&request, options?Z_ARRVAL_P(options):NULL)) {
1405 http_request_exec(&request);
1406 if (info) {
1407 http_request_info(&request, Z_ARRVAL_P(info));
1408 }
1409 RETVAL_RESPONSE_OR_BODY(request);
1410 }
1411 request.body = NULL;
1412 http_request_dtor(&request);
1413 }
1414 /* }}} */
1415 #endif /* HTTP_HAVE_CURL */
1416 /* }}} HAVE_CURL */
1417
1418 /* {{{ proto int http_request_method_register(string method)
1419 *
1420 * Register a custom request method.
1421 *
1422 * Expects a string parameter containing the request method name to register.
1423 *
1424 * Returns the ID of the request method on success, or FALSE on failure.
1425 */
1426 PHP_FUNCTION(http_request_method_register)
1427 {
1428 char *method;
1429 int method_len;
1430 ulong existing;
1431
1432 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &method, &method_len)) {
1433 RETURN_FALSE;
1434 }
1435 if ((existing = http_request_method_exists(1, 0, method))) {
1436 RETURN_LONG((long) existing);
1437 }
1438
1439 RETVAL_LONG((long) http_request_method_register(method, method_len));
1440 }
1441 /* }}} */
1442
1443 /* {{{ proto bool http_request_method_unregister(mixed method)
1444 *
1445 * Unregister a previously registered custom request method.
1446 *
1447 * Expects either the request method name or ID.
1448 *
1449 * Returns TRUE on success, or FALSE on failure.
1450 */
1451 PHP_FUNCTION(http_request_method_unregister)
1452 {
1453 zval *method;
1454
1455 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z/", &method)) {
1456 RETURN_FALSE;
1457 }
1458
1459 switch (Z_TYPE_P(method))
1460 {
1461 case IS_OBJECT:
1462 convert_to_string(method);
1463 case IS_STRING:
1464 if (is_numeric_string(Z_STRVAL_P(method), Z_STRLEN_P(method), NULL, NULL, 1)) {
1465 convert_to_long(method);
1466 } else {
1467 ulong mn;
1468 if (!(mn = http_request_method_exists(1, 0, Z_STRVAL_P(method)))) {
1469 RETURN_FALSE;
1470 }
1471 zval_dtor(method);
1472 ZVAL_LONG(method, (long)mn);
1473 }
1474 case IS_LONG:
1475 RETURN_SUCCESS(http_request_method_unregister(Z_LVAL_P(method)));
1476 default:
1477 RETURN_FALSE;
1478 }
1479 }
1480 /* }}} */
1481
1482 /* {{{ proto int http_request_method_exists(mixed method)
1483 *
1484 * Check if a request method is registered (or available by default).
1485 *
1486 * Expects either the request method name or ID as parameter.
1487 *
1488 * Returns TRUE if the request method is known, else FALSE.
1489 */
1490 PHP_FUNCTION(http_request_method_exists)
1491 {
1492 IF_RETVAL_USED {
1493 zval *method;
1494
1495 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z/", &method)) {
1496 RETURN_FALSE;
1497 }
1498
1499 switch (Z_TYPE_P(method))
1500 {
1501 case IS_OBJECT:
1502 convert_to_string(method);
1503 case IS_STRING:
1504 if (is_numeric_string(Z_STRVAL_P(method), Z_STRLEN_P(method), NULL, NULL, 1)) {
1505 convert_to_long(method);
1506 } else {
1507 RETURN_LONG((long) http_request_method_exists(1, 0, Z_STRVAL_P(method)));
1508 }
1509 case IS_LONG:
1510 RETURN_LONG((long) http_request_method_exists(0, Z_LVAL_P(method), NULL));
1511 default:
1512 RETURN_FALSE;
1513 }
1514 }
1515 }
1516 /* }}} */
1517
1518 /* {{{ proto string http_request_method_name(int method)
1519 *
1520 * Get the literal string representation of a standard or registered request method.
1521 *
1522 * Expects the request method ID as parameter.
1523 *
1524 * Returns the request method name as string on success, or FALSE on failure.
1525 */
1526 PHP_FUNCTION(http_request_method_name)
1527 {
1528 IF_RETVAL_USED {
1529 long method;
1530
1531 if ((SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &method)) || (method < 0)) {
1532 RETURN_FALSE;
1533 }
1534
1535 RETURN_STRING(estrdup(http_request_method_name((ulong) method)), 0);
1536 }
1537 }
1538 /* }}} */
1539
1540 /* {{{ Sara Golemons http_build_query() */
1541 #ifndef ZEND_ENGINE_2
1542
1543 /* {{{ proto string http_build_query(mixed formdata [, string prefix[, string arg_separator]])
1544 Generates a form-encoded query string from an associative array or object. */
1545 PHP_FUNCTION(http_build_query)
1546 {
1547 zval *formdata;
1548 char *prefix = NULL, *arg_sep = INI_STR("arg_separator.output");
1549 int prefix_len = 0, arg_sep_len = strlen(arg_sep);
1550 phpstr *formstr;
1551
1552 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|ss", &formdata, &prefix, &prefix_len, &arg_sep, &arg_sep_len) != SUCCESS) {
1553 RETURN_FALSE;
1554 }
1555
1556 if (!arg_sep_len) {
1557 arg_sep = HTTP_URL_ARGSEP;
1558 arg_sep_len = lenof(HTTP_URL_ARGSEP);
1559 }
1560
1561 formstr = phpstr_new();
1562 if (SUCCESS != http_urlencode_hash_recursive(HASH_OF(formdata), formstr, arg_sep, arg_sep_len, prefix, prefix_len)) {
1563 phpstr_free(&formstr);
1564 RETURN_FALSE;
1565 }
1566
1567 if (!formstr->used) {
1568 phpstr_free(&formstr);
1569 RETURN_NULL();
1570 }
1571
1572 RETURN_PHPSTR_PTR(formstr);
1573 }
1574 /* }}} */
1575 #endif /* !ZEND_ENGINE_2 */
1576 /* }}} */
1577
1578 /* {{{ */
1579 #ifdef HTTP_HAVE_ZLIB
1580
1581 /* {{{ proto string http_deflate(string data[, int flags = 0])
1582 *
1583 * Compress data with gzip, zlib AKA deflate or raw deflate encoding.
1584 *
1585 * Expects the first parameter to be a string containing the data that should
1586 * be encoded.
1587 *
1588 * Returns the encoded string on success, or NULL on failure.
1589 */
1590 PHP_FUNCTION(http_deflate)
1591 {
1592 char *data;
1593 int data_len;
1594 long flags = 0;
1595
1596 RETVAL_NULL();
1597
1598 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &data, &data_len, &flags)) {
1599 {
1600 char *encoded;
1601 size_t encoded_len;
1602
1603 if (SUCCESS == http_encoding_deflate(flags, data, data_len, &encoded, &encoded_len)) {
1604 RETURN_STRINGL(encoded, (int) encoded_len, 0);
1605 }
1606 }
1607 }
1608 }
1609 /* }}} */
1610
1611 /* {{{ proto string http_inflate(string data)
1612 *
1613 * Uncompress data compressed with either gzip, deflate AKA zlib or raw
1614 * deflate encoding.
1615 *
1616 * Expects a string as parameter containing the compressed data.
1617 *
1618 * Returns the decoded string on success, or NULL on failure.
1619 */
1620 PHP_FUNCTION(http_inflate)
1621 {
1622 char *data;
1623 int data_len;
1624
1625 RETVAL_NULL();
1626
1627 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &data, &data_len)) {
1628 char *decoded;
1629 size_t decoded_len;
1630
1631 if (SUCCESS == http_encoding_inflate(data, data_len, &decoded, &decoded_len)) {
1632 RETURN_STRINGL(decoded, (int) decoded_len, 0);
1633 }
1634 }
1635 }
1636 /* }}} */
1637
1638 #endif /* HTTP_HAVE_ZLIB */
1639 /* }}} */
1640
1641 /* {{{ proto int http_support([int feature = 0])
1642 *
1643 * Check for feature that require external libraries.
1644 *
1645 * Accpepts an optional in parameter specifying which feature to probe for.
1646 * If the parameter is 0 or omitted, the return value contains a bitmask of
1647 * all supported features that depend on external libraries.
1648 *
1649 * Available features to probe for are:
1650 * <ul>
1651 * <li> HTTP_SUPPORT: always set
1652 * <li> HTTP_SUPPORT_REQUESTS: whether ext/http was linked against libcurl,
1653 * and HTTP requests can be issued
1654 * <li> HTTP_SUPPORT_SSLREQUESTS: whether libcurl was linked against openssl,
1655 * and SSL requests can be issued
1656 * <li> HTTP_SUPPORT_ENCODINGS: whether ext/http was linked against zlib,
1657 * and compressed HTTP responses can be decoded
1658 * <li> HTTP_SUPPORT_MAGICMIME: whether ext/http was linked against libmagic,
1659 * and the HttpResponse::guessContentType() method is usable
1660 * </ul>
1661 *
1662 * Returns int, whether requested feature is supported, or a bitmask with
1663 * all supported features.
1664 */
1665 PHP_FUNCTION(http_support)
1666 {
1667 long feature = 0;
1668
1669 RETVAL_LONG(0L);
1670
1671 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &feature)) {
1672 RETVAL_LONG(http_support(feature));
1673 }
1674 }
1675 /* }}} */
1676
1677 PHP_FUNCTION(http_test)
1678 {
1679 }
1680
1681 /*
1682 * Local variables:
1683 * tab-width: 4
1684 * c-basic-offset: 4
1685 * End:
1686 * vim600: noet sw=4 ts=4 fdm=marker
1687 * vim<600: noet sw=4 ts=4
1688 */
1689