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


452ec8f86a98fed4ea6e2e4e17c2a43fd6f69372
[m6w6/ext-http] / http.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 #define _WINSOCKAPI_
19 #define ZEND_INCLUDE_FULL_WINDOWS_HEADERS
20
21 #ifdef HAVE_CONFIG_H
22 # include "config.h"
23 #endif
24
25 #include "php.h"
26 #include "php_ini.h"
27 #include "snprintf.h"
28 #include "ext/standard/info.h"
29 #include "ext/session/php_session.h"
30 #include "ext/standard/php_string.h"
31 #include "ext/standard/php_smart_str.h"
32
33 #include "SAPI.h"
34
35 #include "php_http.h"
36 #include "php_http_api.h"
37
38 #ifdef ZEND_ENGINE_2
39 # include "ext/standard/php_http.h"
40 #endif
41
42 #ifdef HTTP_HAVE_CURL
43
44 # ifdef PHP_WIN32
45 # include <winsock2.h>
46 # include <sys/types.h>
47 # endif
48
49 # include <curl/curl.h>
50
51 /* {{{ ARG_INFO */
52 # ifdef ZEND_BEGIN_ARG_INFO
53 ZEND_BEGIN_ARG_INFO(http_request_info_ref_3, 0)
54 ZEND_ARG_PASS_INFO(0)
55 ZEND_ARG_PASS_INFO(0)
56 ZEND_ARG_PASS_INFO(1)
57 ZEND_END_ARG_INFO();
58
59 ZEND_BEGIN_ARG_INFO(http_request_info_ref_4, 0)
60 ZEND_ARG_PASS_INFO(0)
61 ZEND_ARG_PASS_INFO(0)
62 ZEND_ARG_PASS_INFO(0)
63 ZEND_ARG_PASS_INFO(1)
64 ZEND_END_ARG_INFO();
65 # else
66 static unsigned char http_request_info_ref_3[] = {3, BYREF_NONE, BYREF_NONE, BYREF_FORCE};
67 static unsigned char http_request_info_ref_4[] = {4, BYREF_NONE, BYREF_NONE, BYREF_NONE, BYREF_FORCE};
68 # endif
69 /* }}} ARG_INFO */
70
71 #endif /* HTTP_HAVE_CURL */
72
73 ZEND_DECLARE_MODULE_GLOBALS(http)
74
75 #ifdef COMPILE_DL_HTTP
76 ZEND_GET_MODULE(http)
77 #endif
78
79
80 /* {{{ http_functions[] */
81 function_entry http_functions[] = {
82 PHP_FE(http_date, NULL)
83 PHP_FE(http_absolute_uri, NULL)
84 PHP_FE(http_negotiate_language, NULL)
85 PHP_FE(http_negotiate_charset, NULL)
86 PHP_FE(http_redirect, NULL)
87 PHP_FE(http_send_status, NULL)
88 PHP_FE(http_send_last_modified, NULL)
89 PHP_FE(http_match_modified, NULL)
90 PHP_FE(http_match_etag, NULL)
91 PHP_FE(http_cache_last_modified, NULL)
92 PHP_FE(http_cache_etag, NULL)
93 PHP_FE(http_content_type, NULL)
94 PHP_FE(http_content_disposition, NULL)
95 PHP_FE(http_send_data, NULL)
96 PHP_FE(http_send_file, NULL)
97 PHP_FE(http_send_stream, NULL)
98 PHP_FE(http_chunked_decode, NULL)
99 PHP_FE(http_split_response, NULL)
100 PHP_FE(http_parse_headers, NULL)
101 PHP_FE(http_get_request_headers, NULL)
102 #ifdef HTTP_HAVE_CURL
103 PHP_FE(http_get, http_request_info_ref_3)
104 PHP_FE(http_head, http_request_info_ref_3)
105 PHP_FE(http_post_data, http_request_info_ref_4)
106 PHP_FE(http_post_array, http_request_info_ref_4)
107 #endif
108 PHP_FE(http_auth_basic, NULL)
109 PHP_FE(http_auth_basic_cb, NULL)
110 #ifndef ZEND_ENGINE_2
111 PHP_FE(http_build_query, NULL)
112 #endif
113 PHP_FE(ob_httpetaghandler, NULL)
114 {NULL, NULL, NULL}
115 };
116 /* }}} */
117
118 /* {{{ http_module_entry */
119 zend_module_entry http_module_entry = {
120 #if ZEND_MODULE_API_NO >= 20010901
121 STANDARD_MODULE_HEADER,
122 #endif
123 "http",
124 http_functions,
125 PHP_MINIT(http),
126 NULL,
127 NULL,
128 PHP_RSHUTDOWN(http),
129 PHP_MINFO(http),
130 #if ZEND_MODULE_API_NO >= 20010901
131 PHP_EXT_HTTP_VERSION,
132 #endif
133 STANDARD_MODULE_PROPERTIES
134 };
135 /* }}} */
136
137 #define RETURN_SUCCESS(v) RETURN_BOOL(SUCCESS == (v))
138 #define HASH_ORNULL(z) ((z) ? Z_ARRVAL_P(z) : NULL)
139
140 /* {{{ proto string http_date([int timestamp])
141 *
142 * This function returns a valid HTTP date regarding RFC 822/1123
143 * looking like: "Wed, 22 Dec 2004 11:34:47 GMT"
144 *
145 */
146 PHP_FUNCTION(http_date)
147 {
148 long t = -1;
149
150 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &t) != SUCCESS) {
151 RETURN_FALSE;
152 }
153
154 if (t == -1) {
155 t = (long) time(NULL);
156 }
157
158 RETURN_STRING(http_date(t), 0);
159 }
160 /* }}} */
161
162 /* {{{ proto string http_absolute_uri(string url[, string proto])
163 *
164 * This function returns an absolute URI constructed from url.
165 * If the url is already abolute but a different proto was supplied,
166 * only the proto part of the URI will be updated. If url has no
167 * path specified, the path of the current REQUEST_URI will be taken.
168 * The host will be taken either from the Host HTTP header of the client
169 * the SERVER_NAME or just localhost if prior are not available.
170 *
171 * Some examples:
172 * <pre>
173 * url = "page.php" => http://www.example.com/current/path/page.php
174 * url = "/page.php" => http://www.example.com/page.php
175 * url = "/page.php", proto = "https" => https://www.example.com/page.php
176 * </pre>
177 *
178 */
179 PHP_FUNCTION(http_absolute_uri)
180 {
181 char *url = NULL, *proto = NULL;
182 int url_len = 0, proto_len = 0;
183
184 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|s", &url, &url_len, &proto, &proto_len) != SUCCESS) {
185 RETURN_FALSE;
186 }
187
188 RETURN_STRING(http_absolute_uri(url, proto), 0);
189 }
190 /* }}} */
191
192 /* {{{ proto string http_negotiate_language(array supported[, string default = 'en-US'])
193 *
194 * This function negotiates the clients preferred language based on its
195 * Accept-Language HTTP header. It returns the negotiated language or
196 * the default language if none match.
197 *
198 * The qualifier is recognized and languages without qualifier are rated highest.
199 *
200 * The supported parameter is expected to be an array having
201 * the supported languages as array values.
202 *
203 * Example:
204 * <pre>
205 * <?php
206 * $langs = array(
207 * 'en-US',// default
208 * 'fr',
209 * 'fr-FR',
210 * 'de',
211 * 'de-DE',
212 * 'de-AT',
213 * 'de-CH',
214 * );
215 * include './langs/'. http_negotiate_language($langs) .'.php';
216 * ?>
217 * </pre>
218 *
219 */
220 PHP_FUNCTION(http_negotiate_language)
221 {
222 zval *supported;
223 char *def = NULL;
224 int def_len = 0;
225
226 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|s", &supported, &def, &def_len) != SUCCESS) {
227 RETURN_FALSE;
228 }
229
230 if (!def) {
231 def = "en-US";
232 }
233
234 RETURN_STRING(http_negotiate_language(supported, def), 0);
235 }
236 /* }}} */
237
238 /* {{{ proto string http_negotiate_charset(array supported[, string default = 'iso-8859-1'])
239 *
240 * This function negotiates the clients preferred charset based on its
241 * Accept-Charset HTTP header. It returns the negotiated charset or
242 * the default charset if none match.
243 *
244 * The qualifier is recognized and charset without qualifier are rated highest.
245 *
246 * The supported parameter is expected to be an array having
247 * the supported charsets as array values.
248 *
249 * Example:
250 * <pre>
251 * <?php
252 * $charsets = array(
253 * 'iso-8859-1', // default
254 * 'iso-8859-2',
255 * 'iso-8859-15',
256 * 'utf-8'
257 * );
258 * $pref = http_negotiate_charset($charsets);
259 * if (!strcmp($pref, 'iso-8859-1')) {
260 * iconv_set_encoding('internal_encoding', 'iso-8859-1');
261 * iconv_set_encoding('output_encoding', $pref);
262 * ob_start('ob_iconv_handler');
263 * }
264 * ?>
265 * </pre>
266 */
267 PHP_FUNCTION(http_negotiate_charset)
268 {
269 zval *supported;
270 char *def = NULL;
271 int def_len = 0;
272
273 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "a|s", &supported, &def, &def_len) != SUCCESS) {
274 RETURN_FALSE;
275 }
276
277 if (!def) {
278 def = "iso-8859-1";
279 }
280
281 RETURN_STRING(http_negotiate_charset(supported, def), 0);
282 }
283 /* }}} */
284
285 /* {{{ proto bool http_send_status(int status)
286 *
287 * Send HTTP status code.
288 *
289 */
290 PHP_FUNCTION(http_send_status)
291 {
292 int status = 0;
293
294 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &status) != SUCCESS) {
295 RETURN_FALSE;
296 }
297 if (status < 100 || status > 510) {
298 php_error_docref(NULL TSRMLS_CC, E_WARNING, "Invalid HTTP status code (100-510): %d", status);
299 RETURN_FALSE;
300 }
301
302 RETURN_SUCCESS(http_send_status(status));
303 }
304 /* }}} */
305
306 /* {{{ proto bool http_send_last_modified([int timestamp])
307 *
308 * This converts the given timestamp to a valid HTTP date and
309 * sends it as "Last-Modified" HTTP header. If timestamp is
310 * omitted, current time is sent.
311 *
312 */
313 PHP_FUNCTION(http_send_last_modified)
314 {
315 long t = -1;
316
317 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &t) != SUCCESS) {
318 RETURN_FALSE;
319 }
320
321 if (t == -1) {
322 t = (long) time(NULL);
323 }
324
325 RETURN_SUCCESS(http_send_last_modified(t));
326 }
327 /* }}} */
328
329 /* {{{ proto bool http_match_modified([int timestamp])
330 *
331 * Matches the given timestamp against the clients "If-Modified-Since" resp.
332 * "If-Unmodified-Since" HTTP headers.
333 *
334 */
335 PHP_FUNCTION(http_match_modified)
336 {
337 long t = -1;
338
339 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &t) != SUCCESS) {
340 RETURN_FALSE;
341 }
342
343 // current time if not supplied (senseless though)
344 if (t == -1) {
345 t = (long) time(NULL);
346 }
347
348 RETURN_BOOL(http_modified_match("HTTP_IF_MODIFIED_SINCE", t) || http_modified_match("HTTP_IF_UNMODIFIED_SINCE", t));
349 }
350 /* }}} */
351
352 /* {{{ proto bool http_match_etag(string etag)
353 *
354 * This matches the given ETag against the clients
355 * "If-Match" resp. "If-None-Match" HTTP headers.
356 *
357 */
358 PHP_FUNCTION(http_match_etag)
359 {
360 int etag_len;
361 char *etag;
362
363 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &etag, &etag_len) != SUCCESS) {
364 RETURN_FALSE;
365 }
366
367 RETURN_BOOL(http_etag_match("HTTP_IF_NONE_MATCH", etag) || http_etag_match("HTTP_IF_MATCH", etag));
368 }
369 /* }}} */
370
371 /* {{{ proto bool http_cache_last_modified([int timestamp_or_expires]])
372 *
373 * If timestamp_or_exires is greater than 0, it is handled as timestamp
374 * and will be sent as date of last modification. If it is 0 or omitted,
375 * the current time will be sent as Last-Modified date. If it's negative,
376 * it is handled as expiration time in seconds, which means that if the
377 * requested last modification date is not between the calculated timespan,
378 * the Last-Modified header is updated and the actual body will be sent.
379 *
380 */
381 PHP_FUNCTION(http_cache_last_modified)
382 {
383 long last_modified = 0, send_modified = 0, t;
384 zval *zlm;
385
386 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|l", &last_modified) != SUCCESS) {
387 RETURN_FALSE;
388 }
389
390 t = (long) time(NULL);
391
392 /* 0 or omitted */
393 if (!last_modified) {
394 /* does the client have? (att: caching "forever") */
395 if (zlm = http_get_server_var("HTTP_IF_MODIFIED_SINCE")) {
396 last_modified = send_modified = http_parse_date(Z_STRVAL_P(zlm));
397 /* send current time */
398 } else {
399 send_modified = t;
400 }
401 /* negative value is supposed to be expiration time */
402 } else if (last_modified < 0) {
403 last_modified += t;
404 send_modified = t;
405 /* send supplied time explicitly */
406 } else {
407 send_modified = last_modified;
408 }
409
410 http_send_header("Cache-Control: private, must-revalidate, max-age=0");
411
412 if (http_modified_match("HTTP_IF_MODIFIED_SINCE", last_modified)) {
413 if (SUCCESS == http_send_status(304)) {
414 zend_bailout();
415 } else {
416 php_error_docref(NULL TSRMLS_CC, E_WARNING, "Could not send 304 Not Modified");
417 RETURN_FALSE;
418 }
419 }
420 RETURN_SUCCESS(http_send_last_modified(send_modified));
421 }
422 /* }}} */
423
424 /* {{{ proto bool http_cache_etag([string etag])
425 *
426 * This function attempts to cache the HTTP body based on an ETag,
427 * either supplied or generated through calculation of the MD5
428 * checksum of the output (uses output buffering).
429 *
430 * If clients "If-None-Match" header matches the supplied/calculated
431 * ETag, the body is considered cached on the clients side and
432 * a "304 Not Modified" status code is issued.
433 *
434 */
435 PHP_FUNCTION(http_cache_etag)
436 {
437 char *etag;
438 int etag_len = 0;
439
440 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &etag, &etag_len) != SUCCESS) {
441 RETURN_FALSE;
442 }
443
444 http_send_header("Cache-Control: private, must-revalidate, max-age=0");
445
446 if (etag_len) {
447 http_send_etag(etag, etag_len);
448 if (http_etag_match("HTTP_IF_NONE_MATCH", etag)) {
449 if (SUCCESS == http_send_status(304)) {
450 zend_bailout();
451 } else {
452 php_error_docref(NULL TSRMLS_CC, E_WARNING, "Could not send 304 Not Modified");
453 RETURN_FALSE;
454 }
455 }
456 }
457
458 /* if no etag is given and we didn't already start ob_etaghandler -- start it */
459 if (!HTTP_G(etag_started)) {
460 RETURN_BOOL(HTTP_G(etag_started) = (SUCCESS == http_start_ob_handler(_http_ob_etaghandler, "ob_etaghandler", 4096, 1)));
461 }
462 RETURN_TRUE;
463 }
464 /* }}} */
465
466 /* {{{ proto string ob_httpetaghandler(string data, int mode)
467 *
468 * For use with ob_start().
469 * Note that this has to be started as first output buffer.
470 * WARNING: Don't use with http_send_*().
471 */
472 PHP_FUNCTION(ob_httpetaghandler)
473 {
474 char *data;
475 int data_len;
476 long mode;
477
478 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sl", &data, &data_len, &mode)) {
479 RETURN_FALSE;
480 }
481
482 if (mode & PHP_OUTPUT_HANDLER_START) {
483 if (HTTP_G(etag_started)) {
484 php_error_docref(NULL TSRMLS_CC, E_WARNING, "ob_httpetaghandler can only be used once");
485 RETURN_STRINGL(data, data_len, 1);
486 }
487 http_send_header("Cache-Control: private, must-revalidate, max-age=0");
488 HTTP_G(etag_started) = 1;
489 }
490
491 if (OG(ob_nesting_level) > 1) {
492 php_error_docref(NULL TSRMLS_CC, E_WARNING, "ob_httpetaghandler must be started prior to other output buffers");
493 RETURN_STRINGL(data, data_len, 1);
494 }
495
496 Z_TYPE_P(return_value) = IS_STRING;
497 http_ob_etaghandler(data, data_len, &Z_STRVAL_P(return_value), &Z_STRLEN_P(return_value), mode);
498 }
499 /* }}} */
500
501 /* {{{ proto void http_redirect([string url[, array params[, bool session,[ bool permanent]]]])
502 *
503 * Redirect to a given url.
504 * The supplied url will be expanded with http_absolute_uri(), the params array will
505 * be treated with http_build_query() and the session identification will be appended
506 * if session is true.
507 *
508 * Depending on permanent the redirection will be issued with a permanent
509 * ("301 Moved Permanently") or a temporary ("302 Found") redirection
510 * status code.
511 *
512 * To be RFC compliant, "Redirecting to <a>URI</a>." will be displayed,
513 * if the client doesn't redirect immediatly.
514 */
515 PHP_FUNCTION(http_redirect)
516 {
517 int url_len;
518 zend_bool session = 0, permanent = 0;
519 zval *params = NULL;
520 smart_str qstr = {0};
521 char *url, *URI, LOC[HTTP_URI_MAXLEN + 9], RED[HTTP_URI_MAXLEN * 2 + 34];
522
523 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|sa!/bb", &url, &url_len, &params, &session, &permanent) != SUCCESS) {
524 RETURN_FALSE;
525 }
526
527 /* append session info */
528 if (session && (PS(session_status) == php_session_active)) {
529 if (!params) {
530 MAKE_STD_ZVAL(params);
531 array_init(params);
532 }
533 if (add_assoc_string(params, PS(session_name), PS(id), 1) != SUCCESS) {
534 php_error_docref(NULL TSRMLS_CC, E_WARNING, "Could not append session information");
535 }
536 }
537
538 /* treat params array with http_build_query() */
539 if (params) {
540 if (php_url_encode_hash_ex(Z_ARRVAL_P(params), &qstr, NULL,0,NULL,0,NULL,0,NULL TSRMLS_CC) != SUCCESS) {
541 if (qstr.c) {
542 efree(qstr.c);
543 }
544 php_error_docref(NULL TSRMLS_CC, E_WARNING, "Could not encode query parameters");
545 RETURN_FALSE;
546 }
547 smart_str_0(&qstr);
548 }
549
550 URI = http_absolute_uri(url, NULL);
551 if (qstr.c) {
552 snprintf(LOC, HTTP_URI_MAXLEN + strlen("Location: "), "Location: %s?%s", URI, qstr.c);
553 sprintf(RED, "Redirecting to <a href=\"%s?%s\">%s?%s</a>.\n", URI, qstr.c, URI, qstr.c);
554 efree(qstr.c);
555 } else {
556 snprintf(LOC, HTTP_URI_MAXLEN + strlen("Location: "), "Location: %s", URI);
557 sprintf(RED, "Redirecting to <a href=\"%s\">%s</a>.\n", URI, URI);
558 }
559 efree(URI);
560
561 if ((SUCCESS == http_send_header(LOC)) && (SUCCESS == http_send_status((permanent ? 301 : 302)))) {
562 php_body_write(RED, strlen(RED) TSRMLS_CC);
563 RETURN_TRUE;
564 }
565 RETURN_FALSE;
566 }
567 /* }}} */
568
569 /* {{{ proto bool http_send_data(string data)
570 *
571 * Sends raw data with support for (multiple) range requests.
572 *
573 */
574 PHP_FUNCTION(http_send_data)
575 {
576 zval *zdata;
577
578 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &zdata) != SUCCESS) {
579 RETURN_FALSE;
580 }
581
582 convert_to_string_ex(&zdata);
583 http_send_header("Accept-Ranges: bytes");
584 RETURN_SUCCESS(http_send_data(zdata));
585 }
586 /* }}} */
587
588 /* {{{ proto bool http_send_file(string file)
589 *
590 * Sends a file with support for (multiple) range requests.
591 *
592 */
593 PHP_FUNCTION(http_send_file)
594 {
595 zval *zfile;
596
597 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &zfile) != SUCCESS) {
598 RETURN_FALSE;
599 }
600
601 convert_to_string_ex(&zfile);
602 http_send_header("Accept-Ranges: bytes");
603 RETURN_SUCCESS(http_send_file(zfile));
604 }
605 /* }}} */
606
607 /* {{{ proto bool http_send_stream(resource stream)
608 *
609 * Sends an already opened stream with support for (multiple) range requests.
610 *
611 */
612 PHP_FUNCTION(http_send_stream)
613 {
614 zval *zstream;
615 php_stream *file;
616
617 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "r", &zstream) != SUCCESS) {
618 RETURN_FALSE;
619 }
620
621 php_stream_from_zval(file, &zstream);
622 http_send_header("Accept-Ranges: bytes");
623 RETURN_SUCCESS(http_send_stream(file));
624 }
625 /* }}} */
626
627 /* {{{ proto bool http_content_type([string content_type = 'application/x-octetstream'])
628 *
629 * Sets the content type.
630 *
631 */
632 PHP_FUNCTION(http_content_type)
633 {
634 char *ct, *content_type;
635 int ct_len = 0;
636
637 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|s", &ct, &ct_len) != SUCCESS) {
638 RETURN_FALSE;
639 }
640
641 if (!ct_len) {
642 RETURN_SUCCESS(http_send_header("Content-Type: application/x-octetstream"));
643 }
644
645 /* remember for multiple ranges */
646 if (HTTP_G(ctype)) {
647 efree(HTTP_G(ctype));
648 }
649 HTTP_G(ctype) = estrndup(ct, ct_len);
650
651 content_type = (char *) emalloc(strlen("Content-Type: ") + ct_len + 1);
652 sprintf(content_type, "Content-Type: %s", ct);
653
654 RETVAL_BOOL(SUCCESS == http_send_header(content_type));
655 efree(content_type);
656 }
657 /* }}} */
658
659 /* {{{ proto bool http_content_disposition(string filename[, bool inline = false])
660 *
661 * Set the Content Disposition. The Content-Disposition header is very useful
662 * if the data actually sent came from a file or something similar, that should
663 * be "saved" by the client/user (i.e. by browsers "Save as..." popup window).
664 *
665 */
666 PHP_FUNCTION(http_content_disposition)
667 {
668 char *filename, *header;
669 int f_len;
670 zend_bool send_inline = 0;
671
672 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|b", &filename, &f_len, &send_inline) != SUCCESS) {
673 RETURN_FALSE;
674 }
675
676 if (send_inline) {
677 header = (char *) emalloc(strlen("Content-Disposition: inline; filename=\"\"") + f_len + 1);
678 sprintf(header, "Content-Disposition: inline; filename=\"%s\"", filename);
679 } else {
680 header = (char *) emalloc(strlen("Content-Disposition: attachment; filename=\"\"") + f_len + 1);
681 sprintf(header, "Content-Disposition: attachment; filename=\"%s\"", filename);
682 }
683
684 RETVAL_BOOL(SUCCESS == http_send_header(header));
685 efree(header);
686 }
687 /* }}} */
688
689 /* {{{ proto string http_chunked_decode(string encoded)
690 *
691 * This function decodes a string that was HTTP-chunked encoded.
692 * Returns false on failure.
693 */
694 PHP_FUNCTION(http_chunked_decode)
695 {
696 char *encoded = NULL, *decoded = NULL;
697 int encoded_len = 0, decoded_len = 0;
698
699 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &encoded, &encoded_len) != SUCCESS) {
700 RETURN_FALSE;
701 }
702
703 if (SUCCESS == http_chunked_decode(encoded, encoded_len, &decoded, &decoded_len)) {
704 RETURN_STRINGL(decoded, decoded_len, 0);
705 } else {
706 RETURN_FALSE;
707 }
708 }
709 /* }}} */
710
711 /* {{{ proto array http_split_response(string http_response)
712 *
713 * This function splits an HTTP response into an array with headers and the
714 * content body. The returned array may look simliar to the following example:
715 *
716 * <pre>
717 * <?php
718 * array(
719 * 0 => array(
720 * 'Status' => '200 Ok',
721 * 'Content-Type' => 'text/plain',
722 * 'Content-Language' => 'en-US'
723 * ),
724 * 1 => "Hello World!"
725 * );
726 * ?>
727 * </pre>
728 */
729 PHP_FUNCTION(http_split_response)
730 {
731 zval *zresponse, *zbody, *zheaders;
732
733 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &zresponse) != SUCCESS) {
734 RETURN_FALSE;
735 }
736
737 convert_to_string_ex(&zresponse);
738
739 MAKE_STD_ZVAL(zbody);
740 MAKE_STD_ZVAL(zheaders);
741 array_init(zheaders);
742
743 if (SUCCESS != http_split_response(zresponse, zheaders, zbody)) {
744 php_error_docref(NULL TSRMLS_CC, E_WARNING, "Could not parse HTTP response");
745 RETURN_FALSE;
746 }
747
748 array_init(return_value);
749 add_index_zval(return_value, 0, zheaders);
750 add_index_zval(return_value, 1, zbody);
751 }
752 /* }}} */
753
754 /* {{{ proto array http_parse_headers(string header)
755 *
756 */
757 PHP_FUNCTION(http_parse_headers)
758 {
759 char *header, *rnrn;
760 int header_len;
761
762 if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &header, &header_len)) {
763 RETURN_FALSE;
764 }
765
766 array_init(return_value);
767
768 if (rnrn = strstr(header, HTTP_CRLF HTTP_CRLF)) {
769 header_len = rnrn - header + 2;
770 }
771 if (SUCCESS != http_parse_headers(header, header_len, return_value)) {
772 php_error_docref(NULL TSRMLS_CC, E_WARNING, "Could not parse HTTP header");
773 zval_dtor(return_value);
774 RETURN_FALSE;
775 }
776 }
777 /* }}}*/
778
779 /* {{{ proto array http_get_request_headers(void)
780 *
781 */
782 PHP_FUNCTION(http_get_request_headers)
783 {
784 if (ZEND_NUM_ARGS()) {
785 WRONG_PARAM_COUNT;
786 }
787
788 array_init(return_value);
789 http_get_request_headers(return_value);
790 }
791 /* }}} */
792
793 /* {{{ HAVE_CURL */
794 #ifdef HTTP_HAVE_CURL
795
796 /* {{{ proto string http_get(string url[, array options[, array &info]])
797 *
798 * Performs an HTTP GET request on the supplied url.
799 *
800 * The second parameter is expected to be an associative
801 * array where the following keys will be recognized:
802 * <pre>
803 * - redirect: int, whether and how many redirects to follow
804 * - unrestrictedauth: bool, whether to continue sending credentials on
805 * redirects to a different host
806 * - proxyhost: string, proxy host in "host[:port]" format
807 * - proxyport: int, use another proxy port as specified in proxyhost
808 * - proxyauth: string, proxy credentials in "user:pass" format
809 * - proxyauthtype: int, HTTP_AUTH_BASIC and/or HTTP_AUTH_NTLM
810 * - httpauth: string, http credentials in "user:pass" format
811 * - httpauthtype: int, HTTP_AUTH_BASIC, DIGEST and/or NTLM
812 * - compress: bool, whether to allow gzip/deflate content encoding
813 * (defaults to true)
814 * - port: int, use another port as specified in the url
815 * - referer: string, the referer to sends
816 * - useragent: string, the user agent to send
817 * (defaults to PECL::HTTP/version (PHP/version)))
818 * - headers: array, list of custom headers as associative array
819 * like array("header" => "value")
820 * - cookies: array, list of cookies as associative array
821 * like array("cookie" => "value")
822 * - cookiestore: string, path to a file where cookies are/will be stored
823 * </pre>
824 *
825 * The optional third parameter will be filled with some additional information
826 * in form af an associative array, if supplied, like the following example:
827 * <pre>
828 * <?php
829 * array (
830 * 'effective_url' => 'http://localhost',
831 * 'response_code' => 403,
832 * 'total_time' => 0.017,
833 * 'namelookup_time' => 0.013,
834 * 'connect_time' => 0.014,
835 * 'pretransfer_time' => 0.014,
836 * 'size_upload' => 0,
837 * 'size_download' => 202,
838 * 'speed_download' => 11882,
839 * 'speed_upload' => 0,
840 * 'header_size' => 145,
841 * 'request_size' => 62,
842 * 'ssl_verifyresult' => 0,
843 * 'filetime' => -1,
844 * 'content_length_download' => 202,
845 * 'content_length_upload' => 0,
846 * 'starttransfer_time' => 0.017,
847 * 'content_type' => 'text/html; charset=iso-8859-1',
848 * 'redirect_time' => 0,
849 * 'redirect_count' => 0,
850 * 'private' => '',
851 * 'http_connectcode' => 0,
852 * 'httpauth_avail' => 0,
853 * 'proxyauth_avail' => 0,
854 * )
855 * ?>
856 * </pre>
857 */
858 PHP_FUNCTION(http_get)
859 {
860 char *URL, *data = NULL;
861 size_t data_len = 0;
862 int URL_len;
863 zval *options = NULL, *info = NULL;
864
865 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a/!z", &URL, &URL_len, &options, &info) != SUCCESS) {
866 RETURN_FALSE;
867 }
868
869 if (info) {
870 zval_dtor(info);
871 array_init(info);
872 }
873
874 if (SUCCESS == http_get(URL, HASH_ORNULL(options), HASH_ORNULL(info), &data, &data_len)) {
875 RETURN_STRINGL(data, data_len, 0);
876 } else {
877 RETURN_FALSE;
878 }
879 }
880 /* }}} */
881
882 /* {{{ proto string http_head(string url[, array options[, array &info]])
883 *
884 * Performs an HTTP HEAD request on the suppied url.
885 * Returns the HTTP response as string.
886 * See http_get() for a full list of available options.
887 */
888 PHP_FUNCTION(http_head)
889 {
890 char *URL, *data = NULL;
891 size_t data_len = 0;
892 int URL_len;
893 zval *options = NULL, *info = NULL;
894
895 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|a/!z", &URL, &URL_len, &options, &info) != SUCCESS) {
896 RETURN_FALSE;
897 }
898
899 if (info) {
900 zval_dtor(info);
901 array_init(info);
902 }
903
904 if (SUCCESS == http_head(URL, HASH_ORNULL(options), HASH_ORNULL(info), &data, &data_len)) {
905 RETURN_STRINGL(data, data_len, 0);
906 } else {
907 RETURN_FALSE;
908 }
909 }
910 /* }}} */
911
912 /* {{{ proto string http_post_data(string url, string data[, array options[, &info]])
913 *
914 * Performs an HTTP POST request, posting data.
915 * Returns the HTTP response as string.
916 * See http_get() for a full list of available options.
917 */
918 PHP_FUNCTION(http_post_data)
919 {
920 char *URL, *postdata, *data = NULL;
921 size_t data_len = 0;
922 int postdata_len, URL_len;
923 zval *options = NULL, *info = NULL;
924
925 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|a/!z", &URL, &URL_len, &postdata, &postdata_len, &options, &info) != SUCCESS) {
926 RETURN_FALSE;
927 }
928
929 if (info) {
930 zval_dtor(info);
931 array_init(info);
932 }
933
934 if (SUCCESS == http_post_data(URL, postdata, (size_t) postdata_len, HASH_ORNULL(options), HASH_ORNULL(info), &data, &data_len)) {
935 RETURN_STRINGL(data, data_len, 0);
936 } else {
937 RETURN_FALSE;
938 }
939 }
940 /* }}} */
941
942 /* {{{ proto string http_post_array(string url, array data[, array options[, array &info]])
943 *
944 * Performs an HTTP POST request, posting www-form-urlencoded array data.
945 * Returns the HTTP response as string.
946 * See http_get() for a full list of available options.
947 */
948 PHP_FUNCTION(http_post_array)
949 {
950 char *URL, *data = NULL;
951 size_t data_len = 0;
952 int URL_len;
953 zval *options = NULL, *info = NULL, *postdata;
954
955 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "sa|a/!z", &URL, &URL_len, &postdata, &options, &info) != SUCCESS) {
956 RETURN_FALSE;
957 }
958
959 if (info) {
960 zval_dtor(info);
961 array_init(info);
962 }
963
964 if (SUCCESS == http_post_array(URL, Z_ARRVAL_P(postdata), HASH_ORNULL(options), HASH_ORNULL(info), &data, &data_len)) {
965 RETURN_STRINGL(data, data_len, 0);
966 } else {
967 RETURN_FALSE;
968 }
969 }
970 /* }}} */
971
972 #endif
973 /* }}} HAVE_CURL */
974
975
976 /* {{{ proto bool http_auth_basic(string user, string pass[, string realm = "Restricted"])
977 *
978 * Example:
979 * <pre>
980 * <?php
981 * if (!http_auth_basic('mike', 's3c|r3t')) {
982 * die('<h1>Authorization failed!</h1>');
983 * }
984 * ?>
985 * </pre>
986 */
987 PHP_FUNCTION(http_auth_basic)
988 {
989 char *realm = NULL, *user, *pass, *suser, *spass;
990 int r_len, u_len, p_len;
991
992 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss|s", &user, &u_len, &pass, &p_len, &realm, &r_len) != SUCCESS) {
993 RETURN_FALSE;
994 }
995
996 if (!realm) {
997 realm = "Restricted";
998 }
999
1000 if (SUCCESS != http_auth_credentials(&suser, &spass)) {
1001 http_auth_header("Basic", realm);
1002 RETURN_FALSE;
1003 }
1004
1005 if (strcasecmp(suser, user)) {
1006 http_auth_header("Basic", realm);
1007 RETURN_FALSE;
1008 }
1009
1010 if (strcmp(spass, pass)) {
1011 http_auth_header("Basic", realm);
1012 RETURN_FALSE;
1013 }
1014
1015 RETURN_TRUE;
1016 }
1017 /* }}} */
1018
1019 /* {{{ proto bool http_auth_basic_cb(mixed callback[, string realm = "Restricted"])
1020 *
1021 * Example:
1022 * <pre>
1023 * <?php
1024 * function auth_cb($user, $pass)
1025 * {
1026 * global $db;
1027 * $query = 'SELECT pass FROM users WHERE user='. $db->quoteSmart($user);
1028 * if (strlen($realpass = $db->getOne($query)) {
1029 * return $pass === $realpass;
1030 * }
1031 * return false;
1032 * }
1033 *
1034 * if (!http_auth_basic_cb('auth_cb')) {
1035 * die('<h1>Authorization failed</h1>');
1036 * }
1037 * ?>
1038 * </pre>
1039 */
1040 PHP_FUNCTION(http_auth_basic_cb)
1041 {
1042 zval *cb;
1043 char *realm = NULL, *user, *pass;
1044 int r_len;
1045
1046 if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z|s", &cb, &realm, &r_len) != SUCCESS) {
1047 RETURN_FALSE;
1048 }
1049
1050 if (!realm) {
1051 realm = "Restricted";
1052 }
1053
1054 if (SUCCESS != http_auth_credentials(&user, &pass)) {
1055 http_auth_header("Basic", realm);
1056 RETURN_FALSE;
1057 }
1058 {
1059 zval *zparams[2] = {NULL, NULL}, retval;
1060 int result = 0;
1061
1062 MAKE_STD_ZVAL(zparams[0]);
1063 MAKE_STD_ZVAL(zparams[1]);
1064 ZVAL_STRING(zparams[0], user, 0);
1065 ZVAL_STRING(zparams[1], pass, 0);
1066
1067 if (SUCCESS == call_user_function(EG(function_table), NULL, cb,
1068 &retval, 2, zparams TSRMLS_CC)) {
1069 result = Z_LVAL(retval);
1070 }
1071
1072 efree(user);
1073 efree(pass);
1074 efree(zparams[0]);
1075 efree(zparams[1]);
1076
1077 if (!result) {
1078 http_auth_header("Basic", realm);
1079 }
1080
1081 RETURN_BOOL(result);
1082 }
1083 }
1084 /* }}}*/
1085
1086
1087 /* {{{ php_http_init_globals(zend_http_globals *) */
1088 static void php_http_init_globals(zend_http_globals *http_globals)
1089 {
1090 http_globals->etag_started = 0;
1091 http_globals->ctype = NULL;
1092 http_globals->etag = NULL;
1093 http_globals->lmod = 0;
1094 #ifdef HTTP_HAVE_CURL
1095 http_globals->curlbuf.body.data = NULL;
1096 http_globals->curlbuf.body.used = 0;
1097 http_globals->curlbuf.body.free = 0;
1098 http_globals->curlbuf.hdrs.data = NULL;
1099 http_globals->curlbuf.hdrs.used = 0;
1100 http_globals->curlbuf.hdrs.free = 0;
1101 #endif
1102 http_globals->allowed_methods = NULL;
1103 }
1104 /* }}} */
1105
1106 /* {{{ static inline STATUS http_check_allowed_methods(char *, int) */
1107 #define http_check_allowed_methods(m, l) _http_check_allowed_methods((m), (l) TSRMLS_CC)
1108 static inline void _http_check_allowed_methods(char *methods, int length TSRMLS_DC)
1109 {
1110 if (length && SG(request_info).request_method && (!strstr(methods, SG(request_info).request_method))) {
1111 char *allow_header = emalloc(length + sizeof("Allow: "));
1112 sprintf(allow_header, "Allow: %s", methods);
1113 http_send_header(allow_header);
1114 efree(allow_header);
1115 http_send_status(405);
1116 zend_bailout();
1117 }
1118 }
1119 /* }}} */
1120
1121 /* {{{ PHP_INI */
1122 PHP_INI_MH(update_allowed_methods)
1123 {
1124 http_check_allowed_methods(new_value, new_value_length);
1125 return OnUpdateString(entry, new_value, new_value_length, mh_arg1, mh_arg2, mh_arg3, stage TSRMLS_CC);
1126 }
1127
1128 PHP_INI_BEGIN()
1129 STD_PHP_INI_ENTRY("http.allowed_methods", "OPTIONS,GET,HEAD,POST,PUT,DELETE,TRACE,CONNECT", PHP_INI_ALL, update_allowed_methods, allowed_methods, zend_http_globals, http_globals)
1130 PHP_INI_END()
1131 /* }}} */
1132
1133 /* {{{ PHP_MINIT_FUNCTION */
1134 PHP_MINIT_FUNCTION(http)
1135 {
1136 ZEND_INIT_MODULE_GLOBALS(http, php_http_init_globals, NULL);
1137 REGISTER_INI_ENTRIES();
1138 #ifdef HTTP_HAVE_CURL
1139 REGISTER_LONG_CONSTANT("HTTP_AUTH_BASIC", CURLAUTH_BASIC, CONST_CS | CONST_PERSISTENT);
1140 REGISTER_LONG_CONSTANT("HTTP_AUTH_DIGEST", CURLAUTH_DIGEST, CONST_CS | CONST_PERSISTENT);
1141 REGISTER_LONG_CONSTANT("HTTP_AUTH_NTLM", CURLAUTH_NTLM, CONST_CS | CONST_PERSISTENT);
1142 #endif
1143 return SUCCESS;
1144 }
1145 /* }}} */
1146
1147 /* {{{ PHP_MSHUTDOWN_FUNCTION */
1148 PHP_MSHUTDOWN_FUNCTION(http)
1149 {
1150 UNREGISTER_INI_ENTRIES();
1151 return SUCCESS;
1152 }
1153 /* }}} */
1154
1155 /* {{{ PHP_RINIT_FUNCTION */
1156 PHP_RINIT_FUNCTION(http)
1157 {
1158 char *allowed_methods = INI_STR("http.allowed_methods");
1159 http_check_allowed_methods(allowed_methods, strlen(allowed_methods));
1160 return SUCCESS;
1161 }
1162 /* }}} */
1163
1164 /* {{{ PHP_RSHUTDOWN_FUNCTION */
1165 PHP_RSHUTDOWN_FUNCTION(http)
1166 {
1167 HTTP_G(etag_started) = 0;
1168 HTTP_G(lmod) = 0;
1169
1170 if (HTTP_G(etag)) {
1171 efree(HTTP_G(etag));
1172 HTTP_G(etag) = NULL;
1173 }
1174
1175 if (HTTP_G(ctype)) {
1176 efree(HTTP_G(ctype));
1177 HTTP_G(ctype) = NULL;
1178 }
1179 #ifdef HTTP_HAVE_CURL
1180 if (HTTP_G(curlbuf).body.data) {
1181 efree(HTTP_G(curlbuf).body.data);
1182 HTTP_G(curlbuf).body.data = NULL;
1183 }
1184 if (HTTP_G(curlbuf).hdrs.data) {
1185 efree(HTTP_G(curlbuf).hdrs.data);
1186 HTTP_G(curlbuf).hdrs.data = NULL;
1187 }
1188 #endif
1189 return SUCCESS;
1190 }
1191 /* }}} */
1192
1193 /* {{{ PHP_MINFO_FUNCTION */
1194 PHP_MINFO_FUNCTION(http)
1195 {
1196 php_info_print_table_start();
1197 php_info_print_table_header(2, "Extended HTTP support", "enabled");
1198 php_info_print_table_row(2, "Version:", PHP_EXT_HTTP_VERSION);
1199 php_info_print_table_row(2, "cURL convenience functions:",
1200 #ifdef HTTP_HAVE_CURL
1201 "enabled"
1202 #else
1203 "disabled"
1204 #endif
1205 );
1206 php_info_print_table_end();
1207
1208 DISPLAY_INI_ENTRIES();
1209 }
1210 /* }}} */
1211
1212 /*
1213 * Local variables:
1214 * tab-width: 4
1215 * c-basic-offset: 4
1216 * End:
1217 * vim600: noet sw=4 ts=4 fdm=marker
1218 * vim<600: noet sw=4 ts=4
1219 */
1220
Extended HTTP Support