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