projects / m6w6 / ext-http / blob
? search:


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