4cf683475dd56658d5226dc705c9801393c0bd5a
[m6w6/ext-http] / http_request_api.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
22 #ifdef PHP_WIN32
23 # include <winsock2.h>
24 #endif
25
26 #include <curl/curl.h>
27
28 #include "phpstr/phpstr.h"
29
30 #include "php.h"
31 #include "php_http.h"
32 #include "php_http_std_defs.h"
33 #include "php_http_api.h"
34 #include "php_http_request_api.h"
35 #include "php_http_request_object.h"
36 #include "php_http_requestpool_object.h"
37 #include "php_http_url_api.h"
38
39 #ifndef HTTP_CURL_USE_ZEND_MM
40 # define HTTP_CURL_USE_ZEND_MM 0
41 #endif
42
43 #ifndef HTTP_DEBUG_REQPOOLS
44 # define HTTP_DEBUG_REQPOOLS 0
45 #endif
46
47 ZEND_EXTERN_MODULE_GLOBALS(http)
48
49 #if LIBCURL_VERSION_NUM < 0x070c00
50 # define curl_easy_strerror(code) HTTP_G(request).error
51 #endif
52
53 #define HTTP_CURL_INFO(I) HTTP_CURL_INFO_EX(I, I)
54 #define HTTP_CURL_INFO_EX(I, X) \
55 switch (CURLINFO_ ##I & ~CURLINFO_MASK) \
56 { \
57 case CURLINFO_STRING: \
58 { \
59 char *c; \
60 if (CURLE_OK == curl_easy_getinfo(ch, CURLINFO_ ##I, &c)) { \
61 add_assoc_string(&array, pretty_key(http_request_data_copy(COPY_STRING, #X), sizeof(#X)-1, 0, 0), c ? c : "", 1); \
62 } \
63 } \
64 break; \
65 \
66 case CURLINFO_DOUBLE: \
67 { \
68 double d; \
69 if (CURLE_OK == curl_easy_getinfo(ch, CURLINFO_ ##I, &d)) { \
70 add_assoc_double(&array, pretty_key(http_request_data_copy(COPY_STRING, #X), sizeof(#X)-1, 0, 0), d); \
71 } \
72 } \
73 break; \
74 \
75 case CURLINFO_LONG: \
76 { \
77 long l; \
78 if (CURLE_OK == curl_easy_getinfo(ch, CURLINFO_ ##I, &l)) { \
79 add_assoc_long(&array, pretty_key(http_request_data_copy(COPY_STRING, #X), sizeof(#X)-1, 0, 0), l); \
80 } \
81 } \
82 break; \
83 }
84
85 #define HTTP_CURL_OPT(OPTION, p) curl_easy_setopt(ch, CURLOPT_##OPTION, (p))
86 #define HTTP_CURL_OPT_STRING(keyname) HTTP_CURL_OPT_STRING_EX(keyname, keyname)
87 #define HTTP_CURL_OPT_SSL_STRING(keyname) HTTP_CURL_OPT_STRING_EX(keyname, SSL##keyname)
88 #define HTTP_CURL_OPT_SSL_STRING_(keyname) HTTP_CURL_OPT_STRING_EX(keyname, SSL_##keyname)
89 #define HTTP_CURL_OPT_STRING_EX(keyname, optname) \
90 if (!strcasecmp(key, #keyname)) { \
91 convert_to_string_ex(param); \
92 HTTP_CURL_OPT(optname, http_request_data_copy(COPY_STRING, Z_STRVAL_PP(param))); \
93 key = NULL; \
94 continue; \
95 }
96 #define HTTP_CURL_OPT_LONG(keyname) HTTP_OPT_SSL_LONG_EX(keyname, keyname)
97 #define HTTP_CURL_OPT_SSL_LONG(keyname) HTTP_CURL_OPT_LONG_EX(keyname, SSL##keyname)
98 #define HTTP_CURL_OPT_SSL_LONG_(keyname) HTTP_CURL_OPT_LONG_EX(keyname, SSL_##keyname)
99 #define HTTP_CURL_OPT_LONG_EX(keyname, optname) \
100 if (!strcasecmp(key, #keyname)) { \
101 convert_to_long_ex(param); \
102 HTTP_CURL_OPT(optname, Z_LVAL_PP(param)); \
103 key = NULL; \
104 continue; \
105 }
106
107
108 static const char *const http_request_methods[HTTP_MAX_REQUEST_METHOD + 1];
109 #define http_curl_getopt(o, k, t) _http_curl_getopt_ex((o), (k), sizeof(k), (t) TSRMLS_CC)
110 #define http_curl_getopt_ex(o, k, l, t) _http_curl_getopt_ex((o), (k), (l), (t) TSRMLS_CC)
111 static inline zval *_http_curl_getopt_ex(HashTable *options, char *key, size_t keylen, int type TSRMLS_DC);
112 static size_t http_curl_write_callback(char *, size_t, size_t, void *);
113 static size_t http_curl_read_callback(void *, size_t, size_t, void *);
114 static int http_curl_progress_callback(void *, double, double, double, double);
115 static int http_curl_debug_callback(CURL *, curl_infotype, char *, size_t, void *);
116
117 typedef struct {
118 void ***tsrm_ctx;
119 void *data;
120 } http_curl_callback_ctx;
121
122 #define HTTP_CURL_CALLBACK_DATA(from, type, var) \
123 http_curl_callback_ctx *__CTX = (http_curl_callback_ctx *) (from); \
124 TSRMLS_FETCH_FROM_CTX(__CTX->tsrm_ctx); \
125 type (var) = (type) (__CTX->data)
126
127 #define http_curl_callback_data(data) _http_curl_callback_data((data) TSRMLS_CC)
128 static http_curl_callback_ctx *_http_curl_callback_data(void *data TSRMLS_DC);
129
130 static void http_request_pool_freebody(http_request_body **body);
131 static void http_request_pool_freehandle(zval **request, http_request_pool *pool TSRMLS_DC);
132
133 #if HTTP_CURL_USE_ZEND_MM
134 static void http_curl_free(void *p) { efree(p); }
135 static char *http_curl_strdup(const char *p) { return estrdup(p); }
136 static void *http_curl_malloc(size_t s) { return emalloc(s); }
137 static void *http_curl_realloc(void *p, size_t s) { return erealloc(p, s); }
138 static void *http_curl_calloc(size_t n, size_t s) { return ecalloc(n, s); }
139 #endif
140
141 /* {{{ STATUS http_request_global_init() */
142 STATUS _http_request_global_init(void)
143 {
144 #if HTTP_CURL_USE_ZEND_MM
145 if (CURLE_OK != curl_global_init_mem(CURL_GLOBAL_ALL,
146 http_curl_malloc,
147 http_curl_free,
148 http_curl_realloc,
149 http_curl_strdup,
150 http_curl_calloc)) {
151 return FAILURE;
152 }
153 #else
154 if (CURLE_OK != curl_global_init(CURL_GLOBAL_ALL)) {
155 return FAILURE;
156 }
157 #endif
158 return SUCCESS;
159 }
160 /* }}} */
161
162 /* {{{ void *http_request_data_copy(int, void *) */
163 void *_http_request_data_copy(int type, void *data TSRMLS_DC)
164 {
165 switch (type)
166 {
167 case COPY_STRING:
168 {
169 char *new_str = estrdup((const char*) data);
170 zend_llist_add_element(&HTTP_G(request).copies.strings, &new_str);
171 return new_str;
172 }
173
174 case COPY_SLIST:
175 {
176 zend_llist_add_element(&HTTP_G(request).copies.slists, &data);
177 return data;
178 }
179
180 default:
181 {
182 return data;
183 }
184 }
185 }
186 /* }}} */
187
188 /* {{{ void http_request_data_free_string(char **) */
189 void _http_request_data_free_string(void *string)
190 {
191 efree(*((char **)string));
192 }
193 /* }}} */
194
195 /* {{{ void http_request_data_free_slist(struct curl_slist **) */
196 void _http_request_data_free_slist(void *list)
197 {
198 curl_slist_free_all(*((struct curl_slist **) list));
199 }
200 /* }}} */
201
202 /* {{{ http_request_body *http_request_body_new() */
203 PHP_HTTP_API http_request_body *_http_request_body_new(TSRMLS_D)
204 {
205 http_request_body *body = ecalloc(1, sizeof(http_request_body));
206 return body;
207 }
208 /* }}} */
209
210 /* {{{ STATUS http_request_body_fill(http_request_body *body, HashTable *, HashTable *) */
211 PHP_HTTP_API STATUS _http_request_body_fill(http_request_body *body, HashTable *fields, HashTable *files TSRMLS_DC)
212 {
213 if (files && (zend_hash_num_elements(files) > 0)) {
214 char *key = NULL;
215 ulong idx;
216 zval **data;
217 struct curl_httppost *http_post_data[2] = {NULL, NULL};
218
219 /* normal data */
220 FOREACH_HASH_KEYVAL(fields, key, idx, data) {
221 CURLcode err;
222 if (key) {
223 convert_to_string_ex(data);
224 err = curl_formadd(&http_post_data[0], &http_post_data[1],
225 CURLFORM_COPYNAME, key,
226 CURLFORM_COPYCONTENTS, Z_STRVAL_PP(data),
227 CURLFORM_CONTENTSLENGTH, Z_STRLEN_PP(data),
228 CURLFORM_END
229 );
230 if (CURLE_OK != err) {
231 http_error_ex(E_WARNING, HTTP_E_CURL, "Could not encode post fields: %s", curl_easy_strerror(err));
232 curl_formfree(http_post_data[0]);
233 return FAILURE;
234 }
235
236 /* reset */
237 key = NULL;
238 }
239 }
240
241 /* file data */
242 FOREACH_HASH_VAL(files, data) {
243 CURLcode err;
244 zval **file, **type, **name;
245 if ( SUCCESS == zend_hash_find(Z_ARRVAL_PP(data), "name", sizeof("name"), (void **) &name) &&
246 SUCCESS == zend_hash_find(Z_ARRVAL_PP(data), "type", sizeof("type"), (void **) &type) &&
247 SUCCESS == zend_hash_find(Z_ARRVAL_PP(data), "file", sizeof("file"), (void **) &file)) {
248 err = curl_formadd(&http_post_data[0], &http_post_data[1],
249 CURLFORM_COPYNAME, Z_STRVAL_PP(name),
250 CURLFORM_FILE, Z_STRVAL_PP(file),
251 CURLFORM_CONTENTTYPE, Z_STRVAL_PP(type),
252 CURLFORM_END
253 );
254 if (CURLE_OK != err) {
255 http_error_ex(E_WARNING, HTTP_E_CURL, "Could not encode post files: %s", curl_easy_strerror(err));
256 curl_formfree(http_post_data[0]);
257 return FAILURE;
258 }
259 } else {
260 http_error(E_NOTICE, HTTP_E_PARAM, "Post file array entry misses either 'name', 'type' or 'file' entry");
261 }
262 }
263
264 body->type = HTTP_REQUEST_BODY_CURLPOST;
265 body->data = http_post_data[0];
266 body->size = 0;
267
268 } else {
269 char *encoded;
270 size_t encoded_len;
271
272 if (SUCCESS != http_urlencode_hash_ex(fields, 1, NULL, 0, &encoded, &encoded_len)) {
273 http_error(E_WARNING, HTTP_E_ENCODE, "Could not encode post data");
274 return FAILURE;
275 }
276
277 body->type = HTTP_REQUEST_BODY_CSTRING;
278 body->data = encoded;
279 body->size = encoded_len;
280 }
281
282 return SUCCESS;
283 }
284 /* }}} */
285
286 /* {{{ void http_request_body_dtor(http_request_body *) */
287 PHP_HTTP_API void _http_request_body_dtor(http_request_body *body TSRMLS_DC)
288 {
289 if (body) {
290 switch (body->type)
291 {
292 case HTTP_REQUEST_BODY_CSTRING:
293 if (body->data) {
294 efree(body->data);
295 }
296 break;
297
298 case HTTP_REQUEST_BODY_CURLPOST:
299 curl_formfree(body->data);
300 break;
301
302 case HTTP_REQUEST_BODY_UPLOADFILE:
303 php_stream_close(body->data);
304 break;
305 }
306 }
307 }
308 /* }}} */
309
310 /* {{{ void http_request_body_free(http_request_body *) */
311 PHP_HTTP_API void _http_request_body_free(http_request_body *body TSRMLS_DC)
312 {
313 if (body) {
314 http_request_body_dtor(body);
315 efree(body);
316 }
317 }
318 /* }}} */
319
320 /* {{{ STATUS http_request_init(CURL *, http_request_method, char *, http_request_body *, HashTable *, phpstr *) */
321 PHP_HTTP_API STATUS _http_request_init(CURL *ch, http_request_method meth, const char *url, http_request_body *body, HashTable *options, phpstr *response TSRMLS_DC)
322 {
323 zval *zoption;
324 zend_bool range_req = 0;
325
326 /* reset CURL handle */
327 #if LIBCURL_VERSION_NUM >= 0x070c01
328 curl_easy_reset(ch);
329 #endif
330
331 /* set options */
332 if (url) {
333 HTTP_CURL_OPT(URL, http_request_data_copy(COPY_STRING, (void *) url));
334 }
335
336 if (response) {
337 HTTP_CURL_OPT(WRITEDATA, http_curl_callback_data(response));
338 HTTP_CURL_OPT(WRITEHEADER, http_curl_callback_data(response));
339 }
340
341 HTTP_CURL_OPT(HEADER, 0);
342 HTTP_CURL_OPT(FILETIME, 1);
343 HTTP_CURL_OPT(AUTOREFERER, 1);
344 HTTP_CURL_OPT(READFUNCTION, http_curl_read_callback);
345 HTTP_CURL_OPT(WRITEFUNCTION, http_curl_write_callback);
346 HTTP_CURL_OPT(HEADERFUNCTION, http_curl_write_callback);
347
348 #if defined(ZTS) && (LIBCURL_VERSION_NUM >= 0x070a00)
349 HTTP_CURL_OPT(NOSIGNAL, 1);
350 #endif
351 #if LIBCURL_VERSION_NUM < 0x070c00
352 HTTP_CURL_OPT(ERRORBUFFER, HTTP_G(request).curl.error);
353 #endif
354
355 /* progress callback */
356 if (zoption = http_curl_getopt(options, "onprogress", 0)) {
357 HTTP_CURL_OPT(PROGRESSFUNCTION, http_curl_progress_callback);
358 HTTP_CURL_OPT(PROGRESSDATA, http_curl_callback_data(zoption));
359 } else {
360 HTTP_CURL_OPT(NOPROGRESS, 1);
361 }
362
363 /* debug callback */
364 if (zoption = http_curl_getopt(options, "ondebug", 0)) {
365 HTTP_CURL_OPT(VERBOSE, 1);
366 HTTP_CURL_OPT(DEBUGFUNCTION, http_curl_debug_callback);
367 HTTP_CURL_OPT(DEBUGDATA, http_curl_callback_data(zoption));
368 } else {
369 HTTP_CURL_OPT(VERBOSE, 0);
370 }
371
372 /* proxy */
373 if (zoption = http_curl_getopt(options, "proxyhost", IS_STRING)) {
374 HTTP_CURL_OPT(PROXY, http_request_data_copy(COPY_STRING, Z_STRVAL_P(zoption)));
375 /* port */
376 if (zoption = http_curl_getopt(options, "proxyport", IS_LONG)) {
377 HTTP_CURL_OPT(PROXYPORT, Z_LVAL_P(zoption));
378 }
379 /* user:pass */
380 if (zoption = http_curl_getopt(options, "proxyauth", IS_STRING)) {
381 HTTP_CURL_OPT(PROXYUSERPWD, http_request_data_copy(COPY_STRING, Z_STRVAL_P(zoption)));
382 }
383 #if LIBCURL_VERSION_NUM >= 0x070a07
384 /* auth method */
385 if (zoption = http_curl_getopt(options, "proxyauthtype", IS_LONG)) {
386 HTTP_CURL_OPT(PROXYAUTH, Z_LVAL_P(zoption));
387 }
388 #endif
389 }
390
391 /* outgoing interface */
392 if (zoption = http_curl_getopt(options, "interface", IS_STRING)) {
393 HTTP_CURL_OPT(INTERFACE, http_request_data_copy(COPY_STRING, Z_STRVAL_P(zoption)));
394 }
395
396 /* another port */
397 if (zoption = http_curl_getopt(options, "port", IS_LONG)) {
398 HTTP_CURL_OPT(PORT, Z_LVAL_P(zoption));
399 }
400
401 /* auth */
402 if (zoption = http_curl_getopt(options, "httpauth", IS_STRING)) {
403 HTTP_CURL_OPT(USERPWD, http_request_data_copy(COPY_STRING, Z_STRVAL_P(zoption)));
404 }
405 #if LIBCURL_VERSION_NUM >= 0x070a06
406 if (zoption = http_curl_getopt(options, "httpauthtype", IS_LONG)) {
407 HTTP_CURL_OPT(HTTPAUTH, Z_LVAL_P(zoption));
408 }
409 #endif
410
411 /* compress, empty string enables deflate and gzip */
412 if (zoption = http_curl_getopt(options, "compress", IS_BOOL)) {
413 if (Z_LVAL_P(zoption)) {
414 HTTP_CURL_OPT(ENCODING, http_request_data_copy(COPY_STRING, ""));
415 }
416 }
417
418 /* redirects, defaults to 0 */
419 if (zoption = http_curl_getopt(options, "redirect", IS_LONG)) {
420 HTTP_CURL_OPT(FOLLOWLOCATION, Z_LVAL_P(zoption) ? 1 : 0);
421 HTTP_CURL_OPT(MAXREDIRS, Z_LVAL_P(zoption));
422 if (zoption = http_curl_getopt(options, "unrestrictedauth", IS_BOOL)) {
423 HTTP_CURL_OPT(UNRESTRICTED_AUTH, Z_LVAL_P(zoption));
424 }
425 } else {
426 HTTP_CURL_OPT(FOLLOWLOCATION, 0);
427 }
428
429 /* referer */
430 if (zoption = http_curl_getopt(options, "referer", IS_STRING)) {
431 HTTP_CURL_OPT(REFERER, http_request_data_copy(COPY_STRING, Z_STRVAL_P(zoption)));
432 }
433
434 /* useragent, default "PECL::HTTP/version (PHP/version)" */
435 if (zoption = http_curl_getopt(options, "useragent", IS_STRING)) {
436 HTTP_CURL_OPT(USERAGENT, http_request_data_copy(COPY_STRING, Z_STRVAL_P(zoption)));
437 } else {
438 HTTP_CURL_OPT(USERAGENT, http_request_data_copy(COPY_STRING, "PECL::HTTP/" HTTP_PEXT_VERSION " (PHP/" PHP_VERSION ")"));
439 }
440
441 /* additional headers, array('name' => 'value') */
442 if (zoption = http_curl_getopt(options, "headers", IS_ARRAY)) {
443 char *header_key;
444 ulong header_idx;
445 struct curl_slist *headers = NULL;
446
447 FOREACH_KEY(zoption, header_key, header_idx) {
448 if (header_key) {
449 zval **header_val;
450 if (SUCCESS == zend_hash_get_current_data(Z_ARRVAL_P(zoption), (void **) &header_val)) {
451 char header[1024] = {0};
452 snprintf(header, 1023, "%s: %s", header_key, Z_STRVAL_PP(header_val));
453 headers = curl_slist_append(headers, http_request_data_copy(COPY_STRING, header));
454 }
455
456 /* reset */
457 header_key = NULL;
458 }
459 }
460
461 if (headers) {
462 HTTP_CURL_OPT(HTTPHEADER, http_request_data_copy(COPY_SLIST, headers));
463 }
464 } else {
465 HTTP_CURL_OPT(HTTPHEADER, NULL);
466 }
467
468 /* cookies, array('name' => 'value') */
469 if (zoption = http_curl_getopt(options, "cookies", IS_ARRAY)) {
470 char *cookie_key = NULL;
471 ulong cookie_idx = 0;
472 phpstr *qstr = phpstr_new();
473
474 FOREACH_KEY(zoption, cookie_key, cookie_idx) {
475 if (cookie_key) {
476 zval **cookie_val;
477 if (SUCCESS == zend_hash_get_current_data(Z_ARRVAL_P(zoption), (void **) &cookie_val)) {
478 phpstr_appendf(qstr, "%s=%s; ", cookie_key, Z_STRVAL_PP(cookie_val));
479 }
480
481 /* reset */
482 cookie_key = NULL;
483 }
484 }
485
486 if (qstr->used) {
487 phpstr_fix(qstr);
488 HTTP_CURL_OPT(COOKIE, http_request_data_copy(COPY_STRING, qstr->data));
489 }
490 phpstr_free(qstr);
491 }
492
493 /* cookiestore */
494 if (zoption = http_curl_getopt(options, "cookiestore", IS_STRING)) {
495 HTTP_CURL_OPT(COOKIEFILE, http_request_data_copy(COPY_STRING, Z_STRVAL_P(zoption)));
496 HTTP_CURL_OPT(COOKIEJAR, http_request_data_copy(COPY_STRING, Z_STRVAL_P(zoption)));
497 }
498
499 /* resume */
500 if (zoption = http_curl_getopt(options, "resume", IS_LONG)) {
501 range_req = 1;
502 HTTP_CURL_OPT(RESUME_FROM, Z_LVAL_P(zoption));
503 }
504
505 /* maxfilesize */
506 if (zoption = http_curl_getopt(options, "maxfilesize", IS_LONG)) {
507 HTTP_CURL_OPT(MAXFILESIZE, Z_LVAL_P(zoption));
508 }
509
510 /* lastmodified */
511 if (zoption = http_curl_getopt(options, "lastmodified", IS_LONG)) {
512 HTTP_CURL_OPT(TIMECONDITION, range_req ? CURL_TIMECOND_IFUNMODSINCE : CURL_TIMECOND_IFMODSINCE);
513 HTTP_CURL_OPT(TIMEVALUE, Z_LVAL_P(zoption));
514 }
515
516 /* timeout */
517 if (zoption = http_curl_getopt(options, "timeout", IS_LONG)) {
518 HTTP_CURL_OPT(TIMEOUT, Z_LVAL_P(zoption));
519 }
520
521 /* connecttimeout, defaults to 1 */
522 if (zoption = http_curl_getopt(options, "connecttimeout", IS_LONG)) {
523 HTTP_CURL_OPT(CONNECTTIMEOUT, Z_LVAL_P(zoption));
524 } else {
525 HTTP_CURL_OPT(CONNECTTIMEOUT, 1);
526 }
527
528 /* ssl */
529 if (zoption = http_curl_getopt(options, "ssl", IS_ARRAY)) {
530 ulong idx;
531 char *key = NULL;
532 zval **param;
533
534 FOREACH_KEYVAL(zoption, key, idx, param) {
535 if (key) {
536 HTTP_CURL_OPT_SSL_STRING(CERT);
537 #if LIBCURL_VERSION_NUM >= 0x070903
538 HTTP_CURL_OPT_SSL_STRING(CERTTYPE);
539 #endif
540 HTTP_CURL_OPT_SSL_STRING(CERTPASSWD);
541
542 HTTP_CURL_OPT_SSL_STRING(KEY);
543 HTTP_CURL_OPT_SSL_STRING(KEYTYPE);
544 HTTP_CURL_OPT_SSL_STRING(KEYPASSWD);
545
546 HTTP_CURL_OPT_SSL_STRING(ENGINE);
547 HTTP_CURL_OPT_SSL_LONG(VERSION);
548
549 HTTP_CURL_OPT_SSL_LONG_(VERIFYPEER);
550 HTTP_CURL_OPT_SSL_LONG_(VERIFYHOST);
551 HTTP_CURL_OPT_SSL_STRING_(CIPHER_LIST);
552
553
554 HTTP_CURL_OPT_STRING(CAINFO);
555 #if LIBCURL_VERSION_NUM >= 0x070908
556 HTTP_CURL_OPT_STRING(CAPATH);
557 #endif
558 HTTP_CURL_OPT_STRING(RANDOM_FILE);
559 HTTP_CURL_OPT_STRING(EGDSOCKET);
560
561 /* reset key */
562 key = NULL;
563 }
564 }
565 } else {
566 /* disable SSL verification by default */
567 HTTP_CURL_OPT(SSL_VERIFYPEER, 0);
568 HTTP_CURL_OPT(SSL_VERIFYHOST, 0);
569 }
570
571 /* request method */
572 switch (meth)
573 {
574 case HTTP_GET:
575 curl_easy_setopt(ch, CURLOPT_HTTPGET, 1);
576 break;
577
578 case HTTP_HEAD:
579 curl_easy_setopt(ch, CURLOPT_NOBODY, 1);
580 break;
581
582 case HTTP_POST:
583 curl_easy_setopt(ch, CURLOPT_POST, 1);
584 break;
585
586 case HTTP_PUT:
587 curl_easy_setopt(ch, CURLOPT_UPLOAD, 1);
588 break;
589
590 default:
591 if (http_request_method_exists(0, meth, NULL)) {
592 curl_easy_setopt(ch, CURLOPT_CUSTOMREQUEST, http_request_method_name(meth));
593 } else {
594 http_error_ex(E_WARNING, HTTP_E_CURL, "Unsupported request method: %d", meth);
595 return FAILURE;
596 }
597 break;
598 }
599
600 /* attach request body */
601 if (body && (meth != HTTP_GET) && (meth != HTTP_HEAD)) {
602 switch (body->type)
603 {
604 case HTTP_REQUEST_BODY_CSTRING:
605 curl_easy_setopt(ch, CURLOPT_POSTFIELDS, body->data);
606 curl_easy_setopt(ch, CURLOPT_POSTFIELDSIZE, body->size);
607 break;
608
609 case HTTP_REQUEST_BODY_CURLPOST:
610 curl_easy_setopt(ch, CURLOPT_HTTPPOST, (struct curl_httppost *) body->data);
611 break;
612
613 case HTTP_REQUEST_BODY_UPLOADFILE:
614 curl_easy_setopt(ch, CURLOPT_READDATA, http_curl_callback_data(body));
615 curl_easy_setopt(ch, CURLOPT_INFILESIZE, body->size);
616 break;
617
618 default:
619 http_error_ex(E_WARNING, HTTP_E_CURL, "Unknown request body type: %d", body->type);
620 return FAILURE;
621 break;
622 }
623 }
624
625 return SUCCESS;
626 }
627 /* }}} */
628
629 /* {{{ STATUS http_request_exec(CURL *, HashTable *) */
630 PHP_HTTP_API STATUS _http_request_exec(CURL *ch, HashTable *info TSRMLS_DC)
631 {
632 CURLcode result;
633
634 /* perform request */
635 if (CURLE_OK != (result = curl_easy_perform(ch))) {
636 http_error_ex(E_WARNING, HTTP_E_CURL, "Could not perform request: %s", curl_easy_strerror(result));
637 return FAILURE;
638 } else {
639 /* get curl info */
640 if (info) {
641 http_request_info(ch, info);
642 }
643 return SUCCESS;
644 }
645 }
646 /* }}} */
647
648 /* {{{ void http_request_info(CURL *, HashTable *) */
649 PHP_HTTP_API void _http_request_info(CURL *ch, HashTable *info TSRMLS_DC)
650 {
651 zval array;
652 Z_ARRVAL(array) = info;
653
654 HTTP_CURL_INFO(EFFECTIVE_URL);
655 #if LIBCURL_VERSION_NUM >= 0x070a07
656 HTTP_CURL_INFO(RESPONSE_CODE);
657 #else
658 HTTP_CURL_INFO_EX(HTTP_CODE, RESPONSE_CODE);
659 #endif
660 HTTP_CURL_INFO(HTTP_CONNECTCODE);
661 #if LIBCURL_VERSION_NUM >= 0x070500
662 HTTP_CURL_INFO(FILETIME);
663 #endif
664 HTTP_CURL_INFO(TOTAL_TIME);
665 HTTP_CURL_INFO(NAMELOOKUP_TIME);
666 HTTP_CURL_INFO(CONNECT_TIME);
667 HTTP_CURL_INFO(PRETRANSFER_TIME);
668 HTTP_CURL_INFO(STARTTRANSFER_TIME);
669 #if LIBCURL_VERSION_NUM >= 0x070907
670 HTTP_CURL_INFO(REDIRECT_TIME);
671 HTTP_CURL_INFO(REDIRECT_COUNT);
672 #endif
673 HTTP_CURL_INFO(SIZE_UPLOAD);
674 HTTP_CURL_INFO(SIZE_DOWNLOAD);
675 HTTP_CURL_INFO(SPEED_DOWNLOAD);
676 HTTP_CURL_INFO(SPEED_UPLOAD);
677 HTTP_CURL_INFO(HEADER_SIZE);
678 HTTP_CURL_INFO(REQUEST_SIZE);
679 HTTP_CURL_INFO(SSL_VERIFYRESULT);
680 #if LIBCURL_VERSION_NUM >= 0x070c03
681 /*HTTP_CURL_INFO(SSL_ENGINES); todo: CURLINFO_SLIST */
682 #endif
683 HTTP_CURL_INFO(CONTENT_LENGTH_DOWNLOAD);
684 HTTP_CURL_INFO(CONTENT_LENGTH_UPLOAD);
685 HTTP_CURL_INFO(CONTENT_TYPE);
686 #if LIBCURL_VERSION_NUM >= 0x070a03
687 /*HTTP_CURL_INFO(PRIVATE);*/
688 #endif
689 #if LIBCURL_VERSION_NUM >= 0x070a08
690 HTTP_CURL_INFO(HTTPAUTH_AVAIL);
691 HTTP_CURL_INFO(PROXYAUTH_AVAIL);
692 #endif
693 #if LIBCURL_VERSION_NUM >= 0x070c02
694 /*HTTP_CURL_INFO(OS_ERRNO);*/
695 #endif
696 #if LIBCURL_VERSION_NUM >= 0x070c03
697 HTTP_CURL_INFO(NUM_CONNECTS);
698 #endif
699 }
700 /* }}} */
701
702 /* {{{ STATUS http_request_ex(CURL *, http_request_method, char *, http_request_body, HashTable, HashTable, phpstr *) */
703 PHP_HTTP_API STATUS _http_request_ex(CURL *ch, http_request_method meth, const char *url, http_request_body *body, HashTable *options, HashTable *info, phpstr *response TSRMLS_DC)
704 {
705 if (SUCCESS != http_request_init(ch, meth, url, body, options, response)) {
706 return FAILURE;
707 }
708 return http_request_exec(ch, info);
709 }
710 /* }}} */
711
712 /* {{{ char *http_request_method_name(http_request_method) */
713 PHP_HTTP_API const char *_http_request_method_name(http_request_method m TSRMLS_DC)
714 {
715 zval **meth;
716
717 if (HTTP_STD_REQUEST_METHOD(m)) {
718 return http_request_methods[m];
719 }
720
721 if (SUCCESS == zend_hash_index_find(&HTTP_G(request).methods.custom, HTTP_CUSTOM_REQUEST_METHOD(m), (void **) &meth)) {
722 return Z_STRVAL_PP(meth);
723 }
724
725 return http_request_methods[0];
726 }
727 /* }}} */
728
729 /* {{{ unsigned long http_request_method_exists(zend_bool, unsigned long, char *) */
730 PHP_HTTP_API unsigned long _http_request_method_exists(zend_bool by_name, unsigned long id, const char *name TSRMLS_DC)
731 {
732 if (by_name) {
733 unsigned i;
734
735 for (i = HTTP_NO_REQUEST_METHOD + 1; i < HTTP_MAX_REQUEST_METHOD; ++i) {
736 if (!strcmp(name, http_request_methods[i])) {
737 return i;
738 }
739 }
740 {
741 zval **data;
742 char *key;
743 ulong idx;
744
745 FOREACH_HASH_KEYVAL(&HTTP_G(request).methods.custom, key, idx, data) {
746 if (!strcmp(name, Z_STRVAL_PP(data))) {
747 return idx + HTTP_MAX_REQUEST_METHOD;
748 }
749 }
750 }
751 return 0;
752 } else {
753 return HTTP_STD_REQUEST_METHOD(id) || zend_hash_index_exists(&HTTP_G(request).methods.custom, HTTP_CUSTOM_REQUEST_METHOD(id)) ? id : 0;
754 }
755 }
756 /* }}} */
757
758 /* {{{ unsigned long http_request_method_register(char *) */
759 PHP_HTTP_API unsigned long _http_request_method_register(const char *method TSRMLS_DC)
760 {
761 zval array;
762 char *http_method;
763 unsigned long meth_num = HTTP_G(request).methods.custom.nNextFreeElement + HTTP_MAX_REQUEST_METHOD;
764
765 Z_ARRVAL(array) = &HTTP_G(request).methods.custom;
766 add_next_index_string(&array, estrdup(method), 0);
767
768 spprintf(&http_method, 0, "HTTP_%s", method);
769 zend_register_long_constant(http_method, strlen(http_method) + 1, meth_num, CONST_CS, http_module_number TSRMLS_CC);
770 efree(http_method);
771
772 return meth_num;
773 }
774 /* }}} */
775
776 /* {{{ STATUS http_request_method_unregister(usngigned long) */
777 PHP_HTTP_API STATUS _http_request_method_unregister(unsigned long method TSRMLS_DC)
778 {
779 zval **zmethod;
780 char *http_method;
781
782 if (SUCCESS != zend_hash_index_find(&HTTP_G(request).methods.custom, HTTP_CUSTOM_REQUEST_METHOD(method), (void **) &zmethod)) {
783 http_error_ex(E_NOTICE, HTTP_E_PARAM, "Request method with id %lu does not exist", method);
784 return FAILURE;
785 }
786
787 spprintf(&http_method, 0, "HTTP_%s", Z_STRVAL_PP(zmethod));
788
789 if ( (SUCCESS != zend_hash_index_del(&HTTP_G(request).methods.custom, HTTP_CUSTOM_REQUEST_METHOD(method)))
790 || (SUCCESS != zend_hash_del(EG(zend_constants), http_method, strlen(http_method) + 1))) {
791 http_error_ex(E_NOTICE, 0, "Could not unregister request method: %s", http_method);
792 efree(http_method);
793 return FAILURE;
794 }
795
796 efree(http_method);
797 return SUCCESS;
798 }
799 /* }}} */
800
801
802 /* {{{ http_request_pool *http_request_pool_init(http_request_pool *) */
803 PHP_HTTP_API http_request_pool *_http_request_pool_init(http_request_pool *pool TSRMLS_DC)
804 {
805 zend_bool free_pool;
806 #if HTTP_DEBUG_REQPOOLS
807 fprintf(stderr, "Initializing request pool\n");
808 #endif
809 if ((free_pool = (!pool))) {
810 pool = emalloc(sizeof(http_request_pool));
811 pool->ch = NULL;
812 }
813
814 if (!pool->ch) {
815 if (!(pool->ch = curl_multi_init())) {
816 http_error(E_WARNING, HTTP_E_CURL, "Could not initialize curl");
817 if (free_pool) {
818 efree(pool);
819 }
820 return NULL;
821 }
822 }
823
824 pool->unfinished = 0;
825 zend_llist_init(&pool->handles, sizeof(zval *), (llist_dtor_func_t) ZVAL_PTR_DTOR, 0);
826 zend_llist_init(&pool->bodies, sizeof(http_request_body *), (llist_dtor_func_t) http_request_pool_freebody, 0);
827 #if HTTP_DEBUG_REQPOOLS
828 fprintf(stderr, "Initialized request pool %p\n", pool);
829 #endif
830 return pool;
831 }
832 /* }}} */
833
834 /* {{{ STATUS http_request_pool_attach(http_request_pool *, zval *) */
835 PHP_HTTP_API STATUS _http_request_pool_attach(http_request_pool *pool, zval *request TSRMLS_DC)
836 {
837 getObjectEx(http_request_object, req, request);
838 #if HTTP_DEBUG_REQPOOLS
839 fprintf(stderr, "Attaching request %p to pool %p\n", req, pool);
840 #endif
841 if (req->pool) {
842 http_error(E_WARNING, HTTP_E_CURL, "HttpRequest object is already member of an HttpRequestPool");
843 } else {
844 CURLMcode code;
845 http_request_body *body = http_request_body_new();
846 zval *info = GET_PROP_EX(req, request, responseInfo);
847
848 if (SUCCESS != http_request_object_requesthandler(req, request, body)) {
849 efree(body);
850 http_error_ex(E_WARNING, HTTP_E_CURL, "Could not initialize HttpRequest object for attaching to the HttpRequestPool");
851 } else if (CURLM_OK != (code = curl_multi_add_handle(pool->ch, req->ch))) {
852 http_error_ex(E_WARNING, HTTP_E_CURL, "Could not attach HttpRequest object to the HttpRequestPool: %s", curl_multi_strerror(code));
853 } else {
854 req->pool = pool;
855 zval_add_ref(&request);
856 zend_llist_add_element(&pool->handles, &request);
857 zend_llist_add_element(&pool->bodies, &body);
858 return SUCCESS;
859 }
860 }
861 return FAILURE;
862 }
863 /* }}} */
864
865 /* {{{ STATUS http_request_pool_detach(http_request_pool *, zval *) */
866 PHP_HTTP_API STATUS _http_request_pool_detach(http_request_pool *pool, zval *request TSRMLS_DC)
867 {
868 getObjectEx(http_request_object, req, request);
869 #if HTTP_DEBUG_REQPOOLS
870 fprintf(stderr, "Detaching request %p (pool: %p) from pool %p\n", req, req->pool, pool);
871 #endif
872 if (req->pool != pool) {
873 http_error_ex(E_WARNING, HTTP_E_CURL, "HttpRequest object is not attached to this HttpRequestPool (%p != %p)", req->pool, pool);
874 } else {
875 CURLMcode code;
876
877 if (CURLM_OK != (code = curl_multi_remove_handle(pool->ch, req->ch))) {
878 http_error_ex(E_WARNING, HTTP_E_CURL, "Could not detach HttpRequest object from the HttpRequestPool: %s", curl_multi_strerror(code));
879 } else {
880 req->pool = NULL;
881 zval_ptr_dtor(&request);
882 return SUCCESS;
883 }
884 }
885 return FAILURE;
886 }
887 /* }}} */
888
889 /* {{{ void http_request_pool_detach_all(http_request_pool *) */
890 PHP_HTTP_API void _http_request_pool_detach_all(http_request_pool *pool TSRMLS_DC)
891 {
892 #if HTTP_DEBUG_REQPOOLS
893 fprintf(stderr, "Detaching all requests from pool %p\n", pool);
894 #endif
895 zend_llist_apply_with_argument(&pool->handles, (llist_apply_with_arg_func_t) http_request_pool_freehandle, pool TSRMLS_CC);
896 }
897
898
899 /* {{{ STATUS http_request_pool_send(http_request_pool *) */
900 PHP_HTTP_API STATUS _http_request_pool_send(http_request_pool *pool TSRMLS_DC)
901 {
902 #if HTTP_DEBUG_REQPOOLS
903 fprintf(stderr, "Attempt to send requests of pool %p\n", pool);
904 #endif
905 while (http_request_pool_perform(pool)) {
906 #if HTTP_DEBUG_REQPOOLS
907 fprintf(stderr, "%d unfinished requests of pool %p remaining\n", pool->unfinished, pool);
908 #endif
909 if (SUCCESS != http_request_pool_select(pool)) {
910 http_error(E_WARNING, HTTP_E_CURL, "Socket error");
911 return FAILURE;
912 }
913 }
914 zend_llist_apply(&pool->handles, (llist_apply_func_t) http_request_pool_responsehandler TSRMLS_CC);
915 return SUCCESS;
916 }
917 /* }}} */
918
919 /* {{{ void http_request_pool_dtor(http_request_pool *) */
920 PHP_HTTP_API void _http_request_pool_dtor(http_request_pool *pool TSRMLS_DC)
921 {
922 #if HTTP_DEBUG_REQPOOLS
923 fprintf(stderr, "Destructing request pool %p\n", pool);
924 #endif
925 pool->unfinished = 0;
926 zend_llist_clean(&pool->handles);
927 zend_llist_clean(&pool->bodies);
928 curl_multi_cleanup(pool->ch);
929 }
930 /* }}} */
931
932 /* {{{ STATUS http_request_pool_select(http_request_pool *) */
933 PHP_HTTP_API STATUS _http_request_pool_select(http_request_pool *pool)
934 {
935 int MAX;
936 fd_set R, W, E;
937 struct timeval timeout = {1, 0};
938
939 FD_ZERO(&R);
940 FD_ZERO(&W);
941 FD_ZERO(&E);
942
943 curl_multi_fdset(pool->ch, &R, &W, &E, &MAX);
944 return (-1 != select(MAX + 1, &R, &W, &E, &timeout)) ? SUCCESS : FAILURE;
945 }
946 /* }}} */
947
948 /* {{{ int http_request_pool_perform(http_request_pool *) */
949 PHP_HTTP_API int _http_request_pool_perform(http_request_pool *pool)
950 {
951 while (CURLM_CALL_MULTI_PERFORM == curl_multi_perform(pool->ch, &pool->unfinished));
952 return pool->unfinished;
953 }
954 /* }}} */
955
956 /* {{{ void http_request_pool_responsehandler(zval **) */
957 void _http_request_pool_responsehandler(zval **req TSRMLS_DC)
958 {
959 getObjectEx(http_request_object, obj, *req);
960 #if HTTP_DEBUG_REQPOOLS
961 fprintf(stderr, "Fetching data from request %p of pool %p\n", obj, obj->pool);
962 #endif
963 http_request_object_responsehandler(obj, *req, NULL);
964 }
965 /* }}} */
966
967 /*#*/
968
969 /* {{{ static void http_request_pool_freebody(http_request_body **) */
970 static void http_request_pool_freebody(http_request_body **body)
971 {
972 TSRMLS_FETCH();
973 http_request_body_free(*body);
974 }
975 /* }}} */
976
977 /* {{{ static void http_request_pool_freehandle(zval **, http_request_pool *) */
978 static void http_request_pool_freehandle(zval **request, http_request_pool *pool TSRMLS_DC)
979 {
980 getObjectEx(http_request_object, req, *request);
981 if (req->pool) {
982 http_request_pool_detach(pool, *request);
983 }
984 #if HTTP_DEBUG_REQPOOLS
985 else fprintf(stderr, "Request %p (pool: %p) is not (anymore) attached to pool %p\n", req, req->pool, pool);
986 #endif
987 }
988 /* }}} */
989
990 /* {{{ char *http_request_methods[] */
991 static const char *const http_request_methods[] = {
992 "UNKOWN",
993 /* HTTP/1.1 */
994 "GET",
995 "HEAD",
996 "POST",
997 "PUT",
998 "DELETE",
999 "OPTIONS",
1000 "TRACE",
1001 "CONNECT",
1002 /* WebDAV - RFC 2518 */
1003 "PROPFIND",
1004 "PROPPATCH",
1005 "MKCOL",
1006 "COPY",
1007 "MOVE",
1008 "LOCK",
1009 "UNLOCK",
1010 /* WebDAV Versioning - RFC 3253 */
1011 "VERSION-CONTROL",
1012 "REPORT",
1013 "CHECKOUT",
1014 "CHECKIN",
1015 "UNCHECKOUT",
1016 "MKWORKSPACE",
1017 "UPDATE",
1018 "LABEL",
1019 "MERGE",
1020 "BASELINE-CONTROL",
1021 "MKACTIVITY",
1022 /* WebDAV Access Control - RFC 3744 */
1023 "ACL",
1024 NULL
1025 };
1026 /* }}} */
1027
1028 /* {{{ static size_t http_curl_write_callback(char *, size_t, size_t, void *) */
1029 static size_t http_curl_write_callback(char *buf, size_t len, size_t n, void *s)
1030 {
1031 HTTP_CURL_CALLBACK_DATA(s, phpstr *, str);
1032 return str ? phpstr_append(PHPSTR(str), buf, len * n) : len * n;
1033 }
1034 /* }}} */
1035
1036 /* {{{ static size_t http_curl_read_callback(void *, size_t, size_t, void *) */
1037 static size_t http_curl_read_callback(void *data, size_t len, size_t n, void *s)
1038 {
1039 static char *offset = NULL, *original = NULL;
1040 HTTP_CURL_CALLBACK_DATA(s, http_request_body *, body);
1041
1042 if (body->type != HTTP_REQUEST_BODY_UPLOADFILE) {
1043 return 0;
1044 }
1045 return php_stream_read((php_stream *) body->data, data, len * n);
1046 }
1047 /* }}} */
1048
1049 /* {{{ http_curl_callback_ctx http_curl_callback_data(void *) */
1050 static http_curl_callback_ctx *_http_curl_callback_data(void *data TSRMLS_DC)
1051 {
1052 http_curl_callback_ctx *ctx = emalloc(sizeof(http_curl_callback_ctx));
1053 TSRMLS_SET_CTX(ctx->tsrm_ctx);
1054 ctx->data = data;
1055 return ctx;
1056 }
1057 /* }}} */
1058
1059 /* {{{ static int http_curl_progress_callback(void *, double, double, double, double) */
1060 static int http_curl_progress_callback(void *data, double dltotal, double dlnow, double ultotal, double ulnow)
1061 {
1062 zval *params_pass[4], params_local[4], retval;
1063 HTTP_CURL_CALLBACK_DATA(data, zval *, func);
1064
1065 params_pass[0] = &params_local[0];
1066 params_pass[1] = &params_local[1];
1067 params_pass[2] = &params_local[2];
1068 params_pass[3] = &params_local[3];
1069
1070 ZVAL_DOUBLE(params_pass[0], dltotal);
1071 ZVAL_DOUBLE(params_pass[1], dlnow);
1072 ZVAL_DOUBLE(params_pass[2], ultotal);
1073 ZVAL_DOUBLE(params_pass[3], ulnow);
1074
1075 return call_user_function(EG(function_table), NULL, func, &retval, 4, params_pass TSRMLS_CC);
1076 }
1077 /* }}} */
1078
1079 static int http_curl_debug_callback(CURL *ch, curl_infotype type, char *string, size_t length, void *data)
1080 {
1081 zval *params_pass[2], params_local[2], retval;
1082 HTTP_CURL_CALLBACK_DATA(data, zval *, func);
1083
1084 params_pass[0] = &params_local[0];
1085 params_pass[1] = &params_local[1];
1086
1087 ZVAL_LONG(params_pass[0], type);
1088 ZVAL_STRINGL(params_pass[1], string, length, 1);
1089
1090 call_user_function(EG(function_table), NULL, func, &retval, 2, params_pass TSRMLS_CC);
1091
1092 return 0;
1093 }
1094 /* {{{ static inline zval *http_curl_getopt(HashTable *, char *, size_t, int) */
1095 static inline zval *_http_curl_getopt_ex(HashTable *options, char *key, size_t keylen, int type TSRMLS_DC)
1096 {
1097 zval **zoption;
1098
1099 if (!options || (SUCCESS != zend_hash_find(options, key, keylen, (void **) &zoption))) {
1100 return NULL;
1101 }
1102
1103 if (Z_TYPE_PP(zoption) != type) {
1104 switch (type)
1105 {
1106 case IS_BOOL: convert_to_boolean_ex(zoption); break;
1107 case IS_LONG: convert_to_long_ex(zoption); break;
1108 case IS_DOUBLE: convert_to_double_ex(zoption); break;
1109 case IS_STRING: convert_to_string_ex(zoption); break;
1110 case IS_ARRAY: convert_to_array_ex(zoption); break;
1111 case IS_OBJECT: convert_to_object_ex(zoption); break;
1112 default:
1113 break;
1114 }
1115 }
1116
1117 return *zoption;
1118 }
1119 /* }}} */
1120
1121 /*
1122 * Local variables:
1123 * tab-width: 4
1124 * c-basic-offset: 4
1125 * End:
1126 * vim600: noet sw=4 ts=4 fdm=marker
1127 * vim<600: noet sw=4 ts=4
1128 */
1129