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