- revised request_method api
[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 /* {{{ proto string http_date([int timestamp])
45 *
46 * Compose a valid HTTP date regarding RFC 822/1123
47 * looking like: "Wed, 22 Dec 2004 11:34:47 GMT"
48 *
49 * Takes an optional unix timestamp as parameter.
50 *
51 * Returns the HTTP date as string.
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_build_url(mixed url[, mixed parts[, array &new_url]])
70 *
71 * Returns the new URL as string on success or FALSE on failure.
72 */
73 PHP_FUNCTION(http_build_url)
74 {
75 char *url_str = NULL;
76 size_t url_len = 0;
77 zval *z_old_url = NULL, *z_new_url = NULL, *z_composed_url = NULL;
78 php_url *old_url = NULL, *new_url = NULL, *composed_url = NULL;
79
80 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z/|z/z", &z_old_url, &z_new_url, &z_composed_url) != SUCCESS) {
81 RETURN_FALSE;
82 }
83
84 if (z_new_url) {
85 if (Z_TYPE_P(z_new_url) == IS_ARRAY || Z_TYPE_P(z_new_url) == IS_OBJECT) {
86 new_url = array2url(HASH_OF(z_new_url));
87 } else {
88 convert_to_string(z_new_url);
89 if (!(new_url = php_url_parse_ex(Z_STRVAL_P(z_new_url), Z_STRLEN_P(z_new_url)))) {
90 http_error_ex(HE_WARNING, HTTP_E_URL, "Could not parse URL (%s)", Z_STRVAL_P(z_new_url));
91 RETURN_FALSE;
92 }
93 }
94 }
95
96 if (Z_TYPE_P(z_old_url) == IS_ARRAY || Z_TYPE_P(z_old_url) == IS_OBJECT) {
97 old_url = array2url(HASH_OF(z_old_url));
98 } else {
99 convert_to_string(z_old_url);
100 if (!(old_url = php_url_parse_ex(Z_STRVAL_P(z_old_url), Z_STRLEN_P(z_old_url)))) {
101 if (new_url) {
102 php_url_free(new_url);
103 }
104 http_error_ex(HE_WARNING, HTTP_E_URL, "Could not parse URL (%s)", Z_STRVAL_P(z_old_url));
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 * Expects a double parameter specifying the seconds too sleep() after
607 * each chunk sent. Additionally accepts an optional int parameter
608 * representing the chunk size in bytes.
609 *
610 * Example:
611 * <pre>
612 * <?php
613 * // ~ 20 kbyte/s
614 * # http_throttle(1, 20000);
615 * # http_throttle(0.5, 10000);
616 * # http_throttle(0.1, 2000);
617 * http_send_file('document.pdf');
618 * ?>
619 * </pre>
620 */
621 PHP_FUNCTION(http_throttle)
622 {
623 long chunk_size = HTTP_SENDBUF_SIZE;
624 double interval;
625
626 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "d|l", &interval, &chunk_size)) {
627 return;
628 }
629
630 HTTP_G(send).throttle_delay = interval;
631 HTTP_G(send).buffer_size = chunk_size;
632 }
633 /* }}} */
634
635 /* {{{ proto void http_redirect([string url[, array params[, bool session = false[, int status = 302]]]])
636 *
637 * Redirect to the given url.
638 *
639 * The supplied url will be expanded with http_build_uri(), the params array will
640 * be treated with http_build_query() and the session identification will be appended
641 * if session is true.
642 *
643 * The HTTP response code will be set according to status.
644 * You can use one of the following constants for convenience:
645 * - HTTP_REDIRECT 302 Found
646 * - HTTP_REDIRECT_PERM 301 Moved Permanently
647 * - HTTP_REDIRECT_POST 303 See Other
648 * - HTTP_REDIRECT_TEMP 307 Temporary Redirect
649 *
650 * Please see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3
651 * for which redirect response code to use in which situation.
652 *
653 * To be RFC compliant, "Redirecting to <a>URI</a>." will be displayed,
654 * if the client doesn't redirect immediatly, and the request method was
655 * another one than HEAD.
656 *
657 * Returns FALSE on failure, or *exits* on success.
658 *
659 * A log entry will be written to the redirect log, if the INI entry
660 * "http.redirect_log" is set and the redirect attempt was successful.
661 */
662 PHP_FUNCTION(http_redirect)
663 {
664 int url_len;
665 size_t query_len = 0;
666 zend_bool session = 0, free_params = 0;
667 zval *params = NULL;
668 long status = 302;
669 char *query = NULL, *url = NULL, *URI, *LOC, *RED = NULL;
670
671 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sa!/bl", &url, &url_len, &params, &session, &status) != SUCCESS) {
672 RETURN_FALSE;
673 }
674
675 /* append session info */
676 if (session) {
677 if (!params) {
678 free_params = 1;
679 MAKE_STD_ZVAL(params);
680 array_init(params);
681 }
682 #ifdef HAVE_PHP_SESSION
683 # ifdef COMPILE_DL_SESSION
684 if (SUCCESS == zend_get_module_started("session")) {
685 zval nm_retval, id_retval, func;
686
687 INIT_PZVAL(&func);
688 INIT_PZVAL(&nm_retval);
689 INIT_PZVAL(&id_retval);
690 ZVAL_NULL(&nm_retval);
691 ZVAL_NULL(&id_retval);
692
693 ZVAL_STRINGL(&func, "session_id", lenof("session_id"), 0);
694 call_user_function(EG(function_table), NULL, &func, &id_retval, 0, NULL TSRMLS_CC);
695 ZVAL_STRINGL(&func, "session_name", lenof("session_name"), 0);
696 call_user_function(EG(function_table), NULL, &func, &nm_retval, 0, NULL TSRMLS_CC);
697
698 if ( Z_TYPE(nm_retval) == IS_STRING && Z_STRLEN(nm_retval) &&
699 Z_TYPE(id_retval) == IS_STRING && Z_STRLEN(id_retval)) {
700 if (add_assoc_stringl_ex(params, Z_STRVAL(nm_retval), Z_STRLEN(nm_retval)+1,
701 Z_STRVAL(id_retval), Z_STRLEN(id_retval), 0) != SUCCESS) {
702 http_error(HE_WARNING, HTTP_E_RUNTIME, "Could not append session information");
703 }
704 }
705 }
706 # else
707 if (PS(session_status) == php_session_active) {
708 if (add_assoc_string(params, PS(session_name), PS(id), 1) != SUCCESS) {
709 http_error(HE_WARNING, HTTP_E_RUNTIME, "Could not append session information");
710 }
711 }
712 # endif
713 #endif
714 }
715
716 /* treat params array with http_build_query() */
717 if (params) {
718 if (SUCCESS != http_urlencode_hash_ex(Z_ARRVAL_P(params), 0, NULL, 0, &query, &query_len)) {
719 if (free_params) {
720 zval_dtor(params);
721 FREE_ZVAL(params);
722 }
723 if (query) {
724 efree(query);
725 }
726 RETURN_FALSE;
727 }
728 }
729
730 URI = http_absolute_url(url);
731
732 if (query_len) {
733 spprintf(&LOC, 0, "Location: %s?%s", URI, query);
734 if (SG(request_info).request_method && strcmp(SG(request_info).request_method, "HEAD")) {
735 spprintf(&RED, 0, "Redirecting to <a href=\"%s?%s\">%s?%s</a>.\n", URI, query, URI, query);
736 }
737 } else {
738 spprintf(&LOC, 0, "Location: %s", URI);
739 if (SG(request_info).request_method && strcmp(SG(request_info).request_method, "HEAD")) {
740 spprintf(&RED, 0, "Redirecting to <a href=\"%s\">%s</a>.\n", URI, URI);
741 }
742 }
743
744 efree(URI);
745 if (query) {
746 efree(query);
747 }
748 if (free_params) {
749 zval_dtor(params);
750 FREE_ZVAL(params);
751 }
752
753 RETURN_SUCCESS(http_exit_ex(status, LOC, RED, 1));
754 }
755 /* }}} */
756
757 /* {{{ proto bool http_send_data(string data)
758 *
759 * Sends raw data with support for (multiple) range requests.
760 *
761 * Retursn TRUE on success, or FALSE on failure.
762 */
763 PHP_FUNCTION(http_send_data)
764 {
765 zval *zdata;
766
767 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &zdata) != SUCCESS) {
768 RETURN_FALSE;
769 }
770
771 convert_to_string_ex(&zdata);
772 RETURN_SUCCESS(http_send_data(Z_STRVAL_P(zdata), Z_STRLEN_P(zdata)));
773 }
774 /* }}} */
775
776 /* {{{ proto bool http_send_file(string file)
777 *
778 * Sends a file with support for (multiple) range requests.
779 *
780 * Expects a string parameter referencing the file to send.
781 *
782 * Returns TRUE on success, or FALSE on failure.
783 */
784 PHP_FUNCTION(http_send_file)
785 {
786 char *file;
787 int flen = 0;
788
789 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &file, &flen) != SUCCESS) {
790 RETURN_FALSE;
791 }
792 if (!flen) {
793 RETURN_FALSE;
794 }
795
796 RETURN_SUCCESS(http_send_file(file));
797 }
798 /* }}} */
799
800 /* {{{ proto bool http_send_stream(resource stream)
801 *
802 * Sends an already opened stream with support for (multiple) range requests.
803 *
804 * Expects a resource parameter referncing the stream to read from.
805 *
806 * Returns TRUE on success, or FALSE on failure.
807 */
808 PHP_FUNCTION(http_send_stream)
809 {
810 zval *zstream;
811 php_stream *file;
812
813 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &zstream) != SUCCESS) {
814 RETURN_FALSE;
815 }
816
817 php_stream_from_zval(file, &zstream);
818 RETURN_SUCCESS(http_send_stream(file));
819 }
820 /* }}} */
821
822 /* {{{ proto string http_chunked_decode(string encoded)
823 *
824 * Decodes a string that was HTTP-chunked encoded.
825 *
826 * Expects a chunked encoded string as parameter.
827 *
828 * Returns the decoded string on success or FALSE on failure.
829 */
830 PHP_FUNCTION(http_chunked_decode)
831 {
832 char *encoded = NULL, *decoded = NULL;
833 size_t decoded_len = 0;
834 int encoded_len = 0;
835
836 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &encoded, &encoded_len) != SUCCESS) {
837 RETURN_FALSE;
838 }
839
840 if (NULL != http_encoding_dechunk(encoded, encoded_len, &decoded, &decoded_len)) {
841 RETURN_STRINGL(decoded, (int) decoded_len, 0);
842 } else {
843 RETURN_FALSE;
844 }
845 }
846 /* }}} */
847
848 /* {{{ proto object http_parse_message(string message)
849 *
850 * Parses (a) http_message(s) into a simple recursive object structure.
851 *
852 * Expects a string parameter containing a single HTTP message or
853 * several consecutive HTTP messages.
854 *
855 * Returns an hierachical object structure of the parsed messages.
856 *
857 * Example:
858 * <pre>
859 * <?php
860 * print_r(http_parse_message(http_get(URL, array('redirect' => 3)));
861 *
862 * stdClass object
863 * (
864 * [type] => 2
865 * [httpVersion] => 1.1
866 * [responseCode] => 200
867 * [headers] => Array
868 * (
869 * [Content-Length] => 3
870 * [Server] => Apache
871 * )
872 * [body] => Hi!
873 * [parentMessage] => stdClass object
874 * (
875 * [type] => 2
876 * [httpVersion] => 1.1
877 * [responseCode] => 302
878 * [headers] => Array
879 * (
880 * [Content-Length] => 0
881 * [Location] => ...
882 * )
883 * [body] =>
884 * [parentMessage] => ...
885 * )
886 * )
887 * ?>
888 * </pre>
889 */
890 PHP_FUNCTION(http_parse_message)
891 {
892 char *message;
893 int message_len;
894 http_message *msg = NULL;
895
896 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &message, &message_len)) {
897 RETURN_NULL();
898 }
899
900 if ((msg = http_message_parse(message, message_len))) {
901 object_init(return_value);
902 http_message_tostruct_recursive(msg, return_value);
903 http_message_free(&msg);
904 } else {
905 RETURN_NULL();
906 }
907 }
908 /* }}} */
909
910 /* {{{ proto array http_parse_headers(string header)
911 *
912 * Parses HTTP headers into an associative array.
913 *
914 * Expects a string parameter containing HTTP headers.
915 *
916 * Returns an array on success, or FALSE on failure.
917 *
918 * Example:
919 * <pre>
920 * <?php
921 * $headers = "content-type: text/html; charset=UTF-8\r\n".
922 * "Server: Funky/1.0\r\n".
923 * "Set-Cookie: foo=bar\r\n".
924 * "Set-Cookie: baz=quux\r\n".
925 * "Folded: works\r\n\ttoo\r\n";
926 * print_r(http_parse_headers($headers));
927 *
928 * Array
929 * (
930 * [Content-Type] => text/html; chatset=UTF-8
931 * [Server] => Funky/1.0
932 * [Set-Cookie] => Array
933 * (
934 * [0] => foo=bar
935 * [1] => baz=quux
936 * )
937 * [Folded] => works
938 * too
939 * )
940 * ?>
941 * </pre>
942 */
943 PHP_FUNCTION(http_parse_headers)
944 {
945 char *header;
946 int header_len;
947
948 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &header, &header_len)) {
949 RETURN_FALSE;
950 }
951
952 array_init(return_value);
953 if (SUCCESS != http_parse_headers(header, return_value)) {
954 zval_dtor(return_value);
955 RETURN_FALSE;
956 }
957 }
958 /* }}}*/
959
960 /* {{{ proto object http_parse_cookie(string cookie)
961 *
962 * Parses HTTP cookies like sent in a response into a struct.
963 *
964 * Expects a string as parameter containing the value of a Set-Cookie response header.
965 *
966 * Returns an stdClass object with the cookie params as properties on success or FALSE on failure.
967 *
968 * Example:
969 * <pre>
970 * <?php
971 * print_r(http_parse_cookie("foo=bar; path=/"));
972 *
973 * stdClass Object
974 * (
975 * [name] => foo
976 * [value] => bar
977 * [path] => /
978 * )
979 * ?>
980 * </pre>
981 */
982 PHP_FUNCTION(http_parse_cookie)
983 {
984 char *cookie;
985 int cookie_len;
986
987 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &cookie, &cookie_len)) {
988 RETURN_FALSE;
989 }
990
991 object_init(return_value);
992 if (SUCCESS != http_parse_cookie(cookie, HASH_OF(return_value))) {
993 zval_dtor(return_value);
994 RETURN_FALSE;
995 }
996 }
997
998 /* {{{ proto array http_get_request_headers(void)
999 *
1000 * Get a list of incoming HTTP headers.
1001 *
1002 * Returns an associative array of incoming request headers.
1003 */
1004 PHP_FUNCTION(http_get_request_headers)
1005 {
1006 NO_ARGS;
1007
1008 array_init(return_value);
1009 http_get_request_headers(return_value);
1010 }
1011 /* }}} */
1012
1013 /* {{{ proto string http_get_request_body(void)
1014 *
1015 * Get the raw request body (e.g. POST or PUT data).
1016 *
1017 * Returns NULL when using the CLI SAPI.
1018 */
1019 PHP_FUNCTION(http_get_request_body)
1020 {
1021 char *body;
1022 size_t length;
1023
1024 NO_ARGS;
1025
1026 if (SUCCESS == http_get_request_body(&body, &length)) {
1027 RETURN_STRINGL(body, (int) length, 0);
1028 } else {
1029 RETURN_NULL();
1030 }
1031 }
1032 /* }}} */
1033
1034 /* {{{ proto bool http_match_request_header(string header, string value[, bool match_case = false])
1035 *
1036 * Match an incoming HTTP header.
1037 *
1038 * Expects two string parameters representing the header name (case-insensitive)
1039 * and the header value that should be compared. The case sensitivity of the
1040 * header value depends on the additional optional bool parameter accepted.
1041 *
1042 * Returns TRUE if header value matches, else FALSE.
1043 */
1044 PHP_FUNCTION(http_match_request_header)
1045 {
1046 char *header, *value;
1047 int header_len, value_len;
1048 zend_bool match_case = 0;
1049
1050 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|b", &header, &header_len, &value, &value_len, &match_case)) {
1051 RETURN_FALSE;
1052 }
1053
1054 RETURN_BOOL(http_match_request_header_ex(header, value, match_case));
1055 }
1056 /* }}} */
1057
1058 /* {{{ HAVE_CURL */
1059 #ifdef HTTP_HAVE_CURL
1060
1061 #define RETVAL_RESPONSE_OR_BODY(request) \
1062 { \
1063 zval **bodyonly; \
1064 \
1065 /* check if only the body should be returned */ \
1066 if (options && (SUCCESS == zend_hash_find(Z_ARRVAL_P(options), "bodyonly", sizeof("bodyonly"), (void **) &bodyonly)) && zval_is_true(*bodyonly)) { \
1067 http_message *msg = http_message_parse(PHPSTR_VAL(&request.conv.response), PHPSTR_LEN(&request.conv.response)); \
1068 \
1069 if (msg) { \
1070 RETVAL_STRINGL(PHPSTR_VAL(&msg->body), PHPSTR_LEN(&msg->body), 1); \
1071 http_message_free(&msg); \
1072 } \
1073 } else { \
1074 RETVAL_STRINGL(request.conv.response.data, request.conv.response.used, 1); \
1075 } \
1076 }
1077
1078 /* {{{ proto string http_get(string url[, array options[, array &info]])
1079 *
1080 * Performs an HTTP GET request on the supplied url.
1081 *
1082 * The second parameter, if set, is expected to be an associative
1083 * array where the following keys will be recognized:
1084 * <pre>
1085 * - redirect: int, whether and how many redirects to follow
1086 * - unrestrictedauth: bool, whether to continue sending credentials on
1087 * redirects to a different host
1088 * - proxyhost: string, proxy host in "host[:port]" format
1089 * - proxyport: int, use another proxy port as specified in proxyhost
1090 * - proxyauth: string, proxy credentials in "user:pass" format
1091 * - proxyauthtype: int, HTTP_AUTH_BASIC and/or HTTP_AUTH_NTLM
1092 * - httpauth: string, http credentials in "user:pass" format
1093 * - httpauthtype: int, HTTP_AUTH_BASIC, DIGEST and/or NTLM
1094 * - compress: bool, whether to allow gzip/deflate content encoding
1095 * (defaults to true)
1096 * - port: int, use another port as specified in the url
1097 * - referer: string, the referer to send
1098 * - useragent: string, the user agent to send
1099 * (defaults to PECL::HTTP/version (PHP/version)))
1100 * - headers: array, list of custom headers as associative array
1101 * like array("header" => "value")
1102 * - cookies: array, list of cookies as associative array
1103 * like array("cookie" => "value")
1104 * - cookiestore: string, path to a file where cookies are/will be stored
1105 * - resume: int, byte offset to start the download from;
1106 * if the server supports ranges
1107 * - maxfilesize: int, maximum file size that should be downloaded;
1108 * has no effect, if the size of the requested entity is not known
1109 * - lastmodified: int, timestamp for If-(Un)Modified-Since header
1110 * - timeout: int, seconds the request may take
1111 * - connecttimeout: int, seconds the connect may take
1112 * - onprogress: mixed, progress callback
1113 * </pre>
1114 *
1115 * The optional third parameter will be filled with some additional information
1116 * in form af an associative array, if supplied, like the following example:
1117 * <pre>
1118 * <?php
1119 * array (
1120 * 'effective_url' => 'http://localhost',
1121 * 'response_code' => 403,
1122 * 'total_time' => 0.017,
1123 * 'namelookup_time' => 0.013,
1124 * 'connect_time' => 0.014,
1125 * 'pretransfer_time' => 0.014,
1126 * 'size_upload' => 0,
1127 * 'size_download' => 202,
1128 * 'speed_download' => 11882,
1129 * 'speed_upload' => 0,
1130 * 'header_size' => 145,
1131 * 'request_size' => 62,
1132 * 'ssl_verifyresult' => 0,
1133 * 'filetime' => -1,
1134 * 'content_length_download' => 202,
1135 * 'content_length_upload' => 0,
1136 * 'starttransfer_time' => 0.017,
1137 * 'content_type' => 'text/html; charset=iso-8859-1',
1138 * 'redirect_time' => 0,
1139 * 'redirect_count' => 0,
1140 * 'http_connectcode' => 0,
1141 * 'httpauth_avail' => 0,
1142 * 'proxyauth_avail' => 0,
1143 * )
1144 * ?>
1145 * </pre>
1146 *
1147 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1148 */
1149 PHP_FUNCTION(http_get)
1150 {
1151 zval *options = NULL, *info = NULL;
1152 char *URL;
1153 int URL_len;
1154 http_request request;
1155
1156 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a/!z", &URL, &URL_len, &options, &info) != SUCCESS) {
1157 RETURN_FALSE;
1158 }
1159
1160 if (info) {
1161 zval_dtor(info);
1162 array_init(info);
1163 }
1164
1165 RETVAL_FALSE;
1166
1167 http_request_init_ex(&request, NULL, HTTP_GET, URL);
1168 if (SUCCESS == http_request_prepare(&request, options?Z_ARRVAL_P(options):NULL)) {
1169 http_request_exec(&request);
1170 if (info) {
1171 http_request_info(&request, Z_ARRVAL_P(info));
1172 }
1173 RETVAL_RESPONSE_OR_BODY(request);
1174 }
1175 http_request_dtor(&request);
1176 }
1177 /* }}} */
1178
1179 /* {{{ proto string http_head(string url[, array options[, array &info]])
1180 *
1181 * Performs an HTTP HEAD request on the supplied url.
1182 *
1183 * See http_get() for a full list of available parameters and options.
1184 *
1185 * Returns the HTTP response as string on success, or FALSE on failure.
1186 */
1187 PHP_FUNCTION(http_head)
1188 {
1189 zval *options = NULL, *info = NULL;
1190 char *URL;
1191 int URL_len;
1192 http_request request;
1193
1194 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a/!z", &URL, &URL_len, &options, &info) != SUCCESS) {
1195 RETURN_FALSE;
1196 }
1197
1198 if (info) {
1199 zval_dtor(info);
1200 array_init(info);
1201 }
1202
1203 RETVAL_FALSE;
1204
1205 http_request_init_ex(&request, NULL, HTTP_HEAD, URL);
1206 if (SUCCESS == http_request_prepare(&request, options?Z_ARRVAL_P(options):NULL)) {
1207 http_request_exec(&request);
1208 if (info) {
1209 http_request_info(&request, Z_ARRVAL_P(info));
1210 }
1211 RETVAL_RESPONSE_OR_BODY(request);
1212 }
1213 http_request_dtor(&request);
1214 }
1215 /* }}} */
1216
1217 /* {{{ proto string http_post_data(string url, string data[, array options[, array &info]])
1218 *
1219 * Performs an HTTP POST requeston the supplied url.
1220 *
1221 * Expects a string as second parameter containing the pre-encoded post data.
1222 * See http_get() for a full list of available parameters and options.
1223 *
1224 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1225 */
1226 PHP_FUNCTION(http_post_data)
1227 {
1228 zval *options = NULL, *info = NULL;
1229 char *URL, *postdata;
1230 int postdata_len, URL_len;
1231 http_request_body body;
1232 http_request request;
1233
1234 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|a/!z", &URL, &URL_len, &postdata, &postdata_len, &options, &info) != SUCCESS) {
1235 RETURN_FALSE;
1236 }
1237
1238 if (info) {
1239 zval_dtor(info);
1240 array_init(info);
1241 }
1242
1243 RETVAL_FALSE;
1244
1245 http_request_init_ex(&request, NULL, HTTP_POST, URL);
1246 request.body = http_request_body_init_ex(&body, HTTP_REQUEST_BODY_CSTRING, postdata, postdata_len, 0);
1247 if (SUCCESS == http_request_prepare(&request, options?Z_ARRVAL_P(options):NULL)) {
1248 http_request_exec(&request);
1249 if (info) {
1250 http_request_info(&request, Z_ARRVAL_P(info));
1251 }
1252 RETVAL_RESPONSE_OR_BODY(request);
1253 }
1254 http_request_dtor(&request);
1255 }
1256 /* }}} */
1257
1258 /* {{{ proto string http_post_fields(string url, array data[, array files[, array options[, array &info]]])
1259 *
1260 * Performs an HTTP POST request on the supplied url.
1261 *
1262 * Expecrs an associative array as second parameter, which will be
1263 * www-form-urlencoded. See http_get() for a full list of available options.
1264 *
1265 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1266 */
1267 PHP_FUNCTION(http_post_fields)
1268 {
1269 zval *options = NULL, *info = NULL, *fields, *files = NULL;
1270 char *URL;
1271 int URL_len;
1272 http_request_body body;
1273 http_request request;
1274
1275 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sa|aa/!z", &URL, &URL_len, &fields, &files, &options, &info) != SUCCESS) {
1276 RETURN_FALSE;
1277 }
1278
1279 if (!http_request_body_fill(&body, Z_ARRVAL_P(fields), files ? Z_ARRVAL_P(files) : NULL)) {
1280 RETURN_FALSE;
1281 }
1282
1283 if (info) {
1284 zval_dtor(info);
1285 array_init(info);
1286 }
1287
1288 RETVAL_FALSE;
1289
1290 http_request_init_ex(&request, NULL, HTTP_POST, URL);
1291 request.body = &body;
1292 if (SUCCESS == http_request_prepare(&request, options?Z_ARRVAL_P(options):NULL)) {
1293 http_request_exec(&request);
1294 if (info) {
1295 http_request_info(&request, Z_ARRVAL_P(info));
1296 }
1297 RETVAL_RESPONSE_OR_BODY(request);
1298 }
1299 http_request_dtor(&request);
1300 }
1301 /* }}} */
1302
1303 /* {{{ proto string http_put_file(string url, string file[, array options[, array &info]])
1304 *
1305 * Performs an HTTP PUT request on the supplied url.
1306 *
1307 * Expects the second parameter to be a string referncing the file to upload.
1308 * See http_get() for a full list of available options.
1309 *
1310 * Returns the HTTP response(s) as string on success, or FALSE on failure.
1311 */
1312 PHP_FUNCTION(http_put_file)
1313 {
1314 char *URL, *file;
1315 int URL_len, f_len;
1316 zval *options = NULL, *info = NULL;
1317 php_stream *stream;
1318 php_stream_statbuf ssb;
1319 http_request_body body;
1320 http_request request;
1321
1322 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|a/!z", &URL, &URL_len, &file, &f_len, &options, &info)) {
1323 RETURN_FALSE;
1324 }
1325
1326 if (!(stream = php_stream_open_wrapper(file, "rb", REPORT_ERRORS|ENFORCE_SAFE_MODE, NULL))) {
1327 RETURN_FALSE;
1328 }
1329 if (php_stream_stat(stream, &ssb)) {
1330 php_stream_close(stream);
1331 RETURN_FALSE;
1332 }
1333
1334 if (info) {
1335 zval_dtor(info);
1336 array_init(info);
1337 }
1338
1339 RETVAL_FALSE;
1340
1341 body.type = HTTP_REQUEST_BODY_UPLOADFILE;
1342 body.data = stream;
1343 body.size = ssb.sb.st_size;
1344
1345 http_request_init_ex(&request, NULL, HTTP_PUT, URL);
1346 request.body = &body;
1347 if (SUCCESS == http_request_prepare(&request, options?Z_ARRVAL_P(options):NULL)) {
1348 http_request_exec(&request);
1349 if (info) {
1350 http_request_info(&request, Z_ARRVAL_P(info));
1351 }
1352 RETVAL_RESPONSE_OR_BODY(request);
1353 }
1354 http_request_body_dtor(&body);
1355 request.body = NULL;
1356 http_request_dtor(&request);
1357 }
1358 /* }}} */
1359
1360 /* {{{ proto string http_put_stream(string url, resource stream[, array options[, array &info]])
1361 *
1362 * Performs an HTTP PUT request on the supplied url.
1363 *
1364 * Expects the second parameter to be a resource referencing an already
1365 * opened stream, from which the data to upload should be read.
1366 * See http_get() for a full list of available options.
1367 *
1368 * Returns the HTTP response(s) as string on success. or FALSE on failure.
1369 */
1370 PHP_FUNCTION(http_put_stream)
1371 {
1372 zval *resource, *options = NULL, *info = NULL;
1373 char *URL;
1374 int URL_len;
1375 php_stream *stream;
1376 php_stream_statbuf ssb;
1377 http_request_body body;
1378 http_request request;
1379
1380 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sr|a/!z", &URL, &URL_len, &resource, &options, &info)) {
1381 RETURN_FALSE;
1382 }
1383
1384 php_stream_from_zval(stream, &resource);
1385 if (php_stream_stat(stream, &ssb)) {
1386 RETURN_FALSE;
1387 }
1388
1389 if (info) {
1390 zval_dtor(info);
1391 array_init(info);
1392 }
1393
1394 RETVAL_FALSE;
1395
1396 body.type = HTTP_REQUEST_BODY_UPLOADFILE;
1397 body.data = stream;
1398 body.size = ssb.sb.st_size;
1399
1400 http_request_init_ex(&request, NULL, HTTP_POST, URL);
1401 request.body = &body;
1402 if (SUCCESS == http_request_prepare(&request, options?Z_ARRVAL_P(options):NULL)) {
1403 http_request_exec(&request);
1404 if (info) {
1405 http_request_info(&request, Z_ARRVAL_P(info));
1406 }
1407 RETVAL_RESPONSE_OR_BODY(request);
1408 }
1409 request.body = NULL;
1410 http_request_dtor(&request);
1411 }
1412 /* }}} */
1413 #endif /* HTTP_HAVE_CURL */
1414 /* }}} HAVE_CURL */
1415
1416 /* {{{ proto int http_request_method_register(string method)
1417 *
1418 * Register a custom request method.
1419 *
1420 * Expects a string parameter containing the request method name to register.
1421 *
1422 * Returns the ID of the request method on success, or FALSE on failure.
1423 */
1424 PHP_FUNCTION(http_request_method_register)
1425 {
1426 char *method;
1427 int method_len;
1428 ulong existing;
1429
1430 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &method, &method_len)) {
1431 RETURN_FALSE;
1432 }
1433 if ((existing = http_request_method_exists(1, 0, method))) {
1434 RETURN_LONG((long) existing);
1435 }
1436
1437 RETVAL_LONG((long) http_request_method_register(method, method_len));
1438 }
1439 /* }}} */
1440
1441 /* {{{ proto bool http_request_method_unregister(mixed method)
1442 *
1443 * Unregister a previously registered custom request method.
1444 *
1445 * Expects either the request method name or ID.
1446 *
1447 * Returns TRUE on success, or FALSE on failure.
1448 */
1449 PHP_FUNCTION(http_request_method_unregister)
1450 {
1451 zval *method;
1452
1453 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z/", &method)) {
1454 RETURN_FALSE;
1455 }
1456
1457 switch (Z_TYPE_P(method))
1458 {
1459 case IS_OBJECT:
1460 convert_to_string(method);
1461 case IS_STRING:
1462 if (is_numeric_string(Z_STRVAL_P(method), Z_STRLEN_P(method), NULL, NULL, 1)) {
1463 convert_to_long(method);
1464 } else {
1465 int mn;
1466 if (!(mn = http_request_method_exists(1, 0, Z_STRVAL_P(method)))) {
1467 RETURN_FALSE;
1468 }
1469 zval_dtor(method);
1470 ZVAL_LONG(method, (long)mn);
1471 }
1472 case IS_LONG:
1473 RETURN_SUCCESS(http_request_method_unregister(Z_LVAL_P(method)));
1474 default:
1475 RETURN_FALSE;
1476 }
1477 }
1478 /* }}} */
1479
1480 /* {{{ proto int http_request_method_exists(mixed method)
1481 *
1482 * Check if a request method is registered (or available by default).
1483 *
1484 * Expects either the request method name or ID as parameter.
1485 *
1486 * Returns TRUE if the request method is known, else FALSE.
1487 */
1488 PHP_FUNCTION(http_request_method_exists)
1489 {
1490 IF_RETVAL_USED {
1491 zval *method;
1492
1493 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z/", &method)) {
1494 RETURN_FALSE;
1495 }
1496
1497 switch (Z_TYPE_P(method))
1498 {
1499 case IS_OBJECT:
1500 convert_to_string(method);
1501 case IS_STRING:
1502 if (is_numeric_string(Z_STRVAL_P(method), Z_STRLEN_P(method), NULL, NULL, 1)) {
1503 convert_to_long(method);
1504 } else {
1505 RETURN_LONG((long) http_request_method_exists(1, 0, Z_STRVAL_P(method)));
1506 }
1507 case IS_LONG:
1508 RETURN_LONG((long) http_request_method_exists(0, (int) Z_LVAL_P(method), NULL));
1509 default:
1510 RETURN_FALSE;
1511 }
1512 }
1513 }
1514 /* }}} */
1515
1516 /* {{{ proto string http_request_method_name(int method)
1517 *
1518 * Get the literal string representation of a standard or registered request method.
1519 *
1520 * Expects the request method ID as parameter.
1521 *
1522 * Returns the request method name as string on success, or FALSE on failure.
1523 */
1524 PHP_FUNCTION(http_request_method_name)
1525 {
1526 IF_RETVAL_USED {
1527 long method;
1528
1529 if ((SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &method)) || (method < 0)) {
1530 RETURN_FALSE;
1531 }
1532
1533 RETURN_STRING(estrdup(http_request_method_name((int) method)), 0);
1534 }
1535 }
1536 /* }}} */
1537
1538 /* {{{ Sara Golemons http_build_query() */
1539 #ifndef ZEND_ENGINE_2
1540
1541 /* {{{ proto string http_build_query(mixed formdata [, string prefix[, string arg_separator]])
1542 Generates a form-encoded query string from an associative array or object. */
1543 PHP_FUNCTION(http_build_query)
1544 {
1545 zval *formdata;
1546 char *prefix = NULL, *arg_sep = INI_STR("arg_separator.output");
1547 int prefix_len = 0, arg_sep_len = strlen(arg_sep);
1548 phpstr *formstr;
1549
1550 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|ss", &formdata, &prefix, &prefix_len, &arg_sep, &arg_sep_len) != SUCCESS) {
1551 RETURN_FALSE;
1552 }
1553
1554 if (!arg_sep_len) {
1555 arg_sep = HTTP_URL_ARGSEP;
1556 arg_sep_len = lenof(HTTP_URL_ARGSEP);
1557 }
1558
1559 formstr = phpstr_new();
1560 if (SUCCESS != http_urlencode_hash_recursive(HASH_OF(formdata), formstr, arg_sep, arg_sep_len, prefix, prefix_len)) {
1561 phpstr_free(&formstr);
1562 RETURN_FALSE;
1563 }
1564
1565 if (!formstr->used) {
1566 phpstr_free(&formstr);
1567 RETURN_NULL();
1568 }
1569
1570 RETURN_PHPSTR_PTR(formstr);
1571 }
1572 /* }}} */
1573 #endif /* !ZEND_ENGINE_2 */
1574 /* }}} */
1575
1576 /* {{{ */
1577 #ifdef HTTP_HAVE_ZLIB
1578
1579 /* {{{ proto string http_deflate(string data[, int flags = 0])
1580 *
1581 * Compress data with gzip, zlib AKA deflate or raw deflate encoding.
1582 *
1583 * Expects the first parameter to be a string containing the data that should
1584 * be encoded.
1585 *
1586 * Returns the encoded string on success, or NULL on failure.
1587 */
1588 PHP_FUNCTION(http_deflate)
1589 {
1590 char *data;
1591 int data_len;
1592 long flags = 0;
1593
1594 RETVAL_NULL();
1595
1596 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|l", &data, &data_len, &flags)) {
1597 char *encoded;
1598 size_t encoded_len;
1599
1600 if (SUCCESS == http_encoding_deflate(flags, data, data_len, &encoded, &encoded_len)) {
1601 RETURN_STRINGL(encoded, (int) encoded_len, 0);
1602 }
1603 }
1604 }
1605 /* }}} */
1606
1607 /* {{{ proto string http_inflate(string data)
1608 *
1609 * Uncompress data compressed with either gzip, deflate AKA zlib or raw
1610 * deflate encoding.
1611 *
1612 * Expects a string as parameter containing the compressed data.
1613 *
1614 * Returns the decoded string on success, or NULL on failure.
1615 */
1616 PHP_FUNCTION(http_inflate)
1617 {
1618 char *data;
1619 int data_len;
1620
1621 RETVAL_NULL();
1622
1623 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &data, &data_len)) {
1624 char *decoded;
1625 size_t decoded_len;
1626
1627 if (SUCCESS == http_encoding_inflate(data, data_len, &decoded, &decoded_len)) {
1628 RETURN_STRINGL(decoded, (int) decoded_len, 0);
1629 }
1630 }
1631 }
1632 /* }}} */
1633
1634 /* {{{ proto string ob_deflatehandler(string data, int mode)
1635 *
1636 * For use with ob_start(). The deflate output buffer handler can only be used once.
1637 * It conflicts with ob_gzhanlder and zlib.output_compression as well and should
1638 * not be used after ext/mbstrings mb_output_handler and ext/sessions URL-Rewriter (AKA
1639 * session.use_trans_sid).
1640 */
1641 PHP_FUNCTION(ob_deflatehandler)
1642 {
1643 char *data;
1644 int data_len;
1645 long mode;
1646
1647 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sl", &data, &data_len, &mode)) {
1648 RETURN_FALSE;
1649 }
1650
1651 http_ob_deflatehandler(data, data_len, &Z_STRVAL_P(return_value), (uint *) &Z_STRLEN_P(return_value), mode);
1652 Z_TYPE_P(return_value) = Z_STRVAL_P(return_value) ? IS_STRING : IS_NULL;
1653 }
1654 /* }}} */
1655
1656 /* {{{ proto string ob_inflatehandler(string data, int mode)
1657 *
1658 * For use with ob_start(). Same restrictions as with ob_deflatehandler apply.
1659 */
1660 PHP_FUNCTION(ob_inflatehandler)
1661 {
1662 char *data;
1663 int data_len;
1664 long mode;
1665
1666 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sl", &data, &data_len, &mode)) {
1667 RETURN_FALSE;
1668 }
1669
1670 http_ob_inflatehandler(data, data_len, &Z_STRVAL_P(return_value), (uint *) &Z_STRLEN_P(return_value), mode);
1671 Z_TYPE_P(return_value) = Z_STRVAL_P(return_value) ? IS_STRING : IS_NULL;
1672 }
1673 /* }}} */
1674
1675 #endif /* HTTP_HAVE_ZLIB */
1676 /* }}} */
1677
1678 /* {{{ proto int http_support([int feature = 0])
1679 *
1680 * Check for feature that require external libraries.
1681 *
1682 * Accpepts an optional in parameter specifying which feature to probe for.
1683 * If the parameter is 0 or omitted, the return value contains a bitmask of
1684 * all supported features that depend on external libraries.
1685 *
1686 * Available features to probe for are:
1687 * <ul>
1688 * <li> HTTP_SUPPORT: always set
1689 * <li> HTTP_SUPPORT_REQUESTS: whether ext/http was linked against libcurl,
1690 * and HTTP requests can be issued
1691 * <li> HTTP_SUPPORT_SSLREQUESTS: whether libcurl was linked against openssl,
1692 * and SSL requests can be issued
1693 * <li> HTTP_SUPPORT_ENCODINGS: whether ext/http was linked against zlib,
1694 * and compressed HTTP responses can be decoded
1695 * <li> HTTP_SUPPORT_MAGICMIME: whether ext/http was linked against libmagic,
1696 * and the HttpResponse::guessContentType() method is usable
1697 * </ul>
1698 *
1699 * Returns int, whether requested feature is supported, or a bitmask with
1700 * all supported features.
1701 */
1702 PHP_FUNCTION(http_support)
1703 {
1704 long feature = 0;
1705
1706 RETVAL_LONG(0L);
1707
1708 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &feature)) {
1709 RETVAL_LONG(http_support(feature));
1710 }
1711 }
1712 /* }}} */
1713
1714 PHP_FUNCTION(http_test)
1715 {
1716 }
1717
1718 /*
1719 * Local variables:
1720 * tab-width: 4
1721 * c-basic-offset: 4
1722 * End:
1723 * vim600: noet sw=4 ts=4 fdm=marker
1724 * vim<600: noet sw=4 ts=4
1725 */
1726