- implement accessors to messages response status text
[m6w6/ext-http] / http_request_api.c
1 /*
2 +--------------------------------------------------------------------+
3 | PECL :: http |
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2004-2006, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
11 */
12
13 /* $Id$ */
14
15 #define HTTP_WANT_SAPI
16 #define HTTP_WANT_CURL
17 #include "php_http.h"
18
19 #ifdef HTTP_HAVE_CURL
20
21 #include "php_http_api.h"
22 #include "php_http_request_api.h"
23 #include "php_http_url_api.h"
24
25 #ifdef ZEND_ENGINE_2
26 # include "php_http_request_object.h"
27 #endif
28
29 /* {{{ cruft for thread safe SSL crypto locks */
30 #if defined(ZTS) && defined(HTTP_HAVE_SSL)
31 # ifdef PHP_WIN32
32 # define HTTP_NEED_OPENSSL_TSL
33 # include <openssl/crypto.h>
34 # else /* !PHP_WIN32 */
35 # if defined(HTTP_HAVE_OPENSSL)
36 # if defined(HAVE_OPENSSL_CRYPTO_H)
37 # define HTTP_NEED_OPENSSL_TSL
38 # include <openssl/crypto.h>
39 # else
40 # warning \
41 "libcurl was compiled with OpenSSL support, but configure could not find " \
42 "openssl/crypto.h; thus no SSL crypto locking callbacks will be set, which may " \
43 "cause random crashes on SSL requests"
44 # endif
45 # elif defined(HTTP_HAVE_GNUTLS)
46 # if defined(HAVE_GCRYPT_H)
47 # define HTTP_NEED_GNUTLS_TSL
48 # include <gcrypt.h>
49 # else
50 # warning \
51 "libcurl was compiled with GnuTLS support, but configure could not find " \
52 "gcrypt.h; thus no SSL crypto locking callbacks will be set, which may " \
53 "cause random crashes on SSL requests"
54 # endif
55 # else
56 # warning \
57 "libcurl was compiled with SSL support, but configure could not determine which" \
58 "library was used; thus no SSL crypto locking callbacks will be set, which may " \
59 "cause random crashes on SSL requests"
60 # endif /* HTTP_HAVE_OPENSSL || HTTP_HAVE_GNUTLS */
61 # endif /* PHP_WIN32 */
62 #endif /* ZTS && HTTP_HAVE_SSL */
63
64 #ifdef HTTP_NEED_OPENSSL_TSL
65 static MUTEX_T *http_openssl_tsl = NULL;
66
67 static void http_openssl_thread_lock(int mode, int n, const char * file, int line)
68 {
69 if (mode & CRYPTO_LOCK) {
70 tsrm_mutex_lock(http_openssl_tsl[n]);
71 } else {
72 tsrm_mutex_unlock(http_openssl_tsl[n]);
73 }
74 }
75
76 static ulong http_openssl_thread_id(void)
77 {
78 return (ulong) tsrm_thread_id();
79 }
80 #endif
81 #ifdef HTTP_NEED_GNUTLS_TSL
82 static int http_gnutls_mutex_create(void **m)
83 {
84 if (*((MUTEX_T *) m) = tsrm_mutex_alloc()) {
85 return SUCCESS;
86 } else {
87 return FAILURE;
88 }
89 }
90
91 static int http_gnutls_mutex_destroy(void **m)
92 {
93 tsrm_mutex_free(*((MUTEX_T *) m));
94 return SUCCESS;
95 }
96
97 static int http_gnutls_mutex_lock(void **m)
98 {
99 return tsrm_mutex_lock(*((MUTEX_T *) m));
100 }
101
102 static int http_gnutls_mutex_unlock(void **m)
103 {
104 return tsrm_mutex_unlock(*((MUTEX_T *) m));
105 }
106
107 static struct gcry_thread_cbs http_gnutls_tsl = {
108 GCRY_THREAD_OPTION_USER,
109 NULL,
110 http_gnutls_mutex_create,
111 http_gnutls_mutex_destroy,
112 http_gnutls_mutex_lock,
113 http_gnutls_mutex_unlock
114 };
115 #endif
116 /* }}} */
117
118 /* {{{ MINIT */
119 PHP_MINIT_FUNCTION(http_request)
120 {
121 #ifdef HTTP_NEED_OPENSSL_TSL
122 int i, c = CRYPTO_num_locks();
123
124 http_openssl_tsl = malloc(c * sizeof(MUTEX_T));
125
126 for (i = 0; i < c; ++i) {
127 http_openssl_tsl[i] = tsrm_mutex_alloc();
128 }
129
130 CRYPTO_set_id_callback(http_openssl_thread_id);
131 CRYPTO_set_locking_callback(http_openssl_thread_lock);
132 #endif
133 #ifdef HTTP_NED_GNUTLS_TSL
134 gcry_control(GCRYCTL_SET_THREAD_CBS, &http_gnutls_tsl);
135 #endif
136
137 if (CURLE_OK != curl_global_init(CURL_GLOBAL_ALL)) {
138 return FAILURE;
139 }
140
141 HTTP_LONG_CONSTANT("HTTP_AUTH_BASIC", CURLAUTH_BASIC);
142 HTTP_LONG_CONSTANT("HTTP_AUTH_DIGEST", CURLAUTH_DIGEST);
143 HTTP_LONG_CONSTANT("HTTP_AUTH_NTLM", CURLAUTH_NTLM);
144 HTTP_LONG_CONSTANT("HTTP_AUTH_ANY", CURLAUTH_ANY);
145
146 HTTP_LONG_CONSTANT("HTTP_VERSION_NONE", CURL_HTTP_VERSION_NONE);
147 HTTP_LONG_CONSTANT("HTTP_VERSION_1_0", CURL_HTTP_VERSION_1_0);
148 HTTP_LONG_CONSTANT("HTTP_VERSION_1_1", CURL_HTTP_VERSION_1_1);
149
150 return SUCCESS;
151 }
152 /* }}} */
153
154 /* {{{ MSHUTDOWN */
155 PHP_MSHUTDOWN_FUNCTION(http_request)
156 {
157 #ifdef HTTP_NEED_OPENSSL_TSL
158 CRYPTO_set_id_callback(http_openssl_thread_id);
159 CRYPTO_set_locking_callback(http_openssl_thread_lock);
160 #endif
161 curl_global_cleanup();
162 #ifdef HTTP_NEED_OPENSSL_TSL
163 if (http_openssl_tsl) {
164 int i, c = CRYPTO_num_locks();
165
166 CRYPTO_set_id_callback(NULL);
167 CRYPTO_set_locking_callback(NULL);
168
169 for (i = 0; i < c; ++i) {
170 tsrm_mutex_free(http_openssl_tsl[i]);
171 }
172
173 free(http_openssl_tsl);
174 http_openssl_tsl = NULL;
175 }
176 #endif
177 return SUCCESS;
178 }
179 /* }}} */
180
181 /* {{{ MACROS */
182 #ifndef HAVE_CURL_EASY_STRERROR
183 # define curl_easy_strerror(dummy) "unknown error"
184 #endif
185
186 #define HTTP_CURL_INFO(I) \
187 { \
188 char *N = #I; \
189 HTTP_CURL_INFO_EX(I, N+lenof("CURLINFO_")); \
190 }
191 #define HTTP_CURL_INFO_EX(I, X) \
192 switch (I & ~CURLINFO_MASK) \
193 { \
194 case CURLINFO_STRING: \
195 { \
196 char *c; \
197 if (CURLE_OK == curl_easy_getinfo(request->ch, I, &c)) { \
198 char *key = estrndup(X, strlen(X)); \
199 add_assoc_string(&array, pretty_key(key, strlen(X), 0, 0), c ? c : "", 1); \
200 efree(key); \
201 } \
202 } \
203 break; \
204 \
205 case CURLINFO_DOUBLE: \
206 { \
207 double d; \
208 if (CURLE_OK == curl_easy_getinfo(request->ch, I, &d)) { \
209 char *key = estrndup(X, strlen(X)); \
210 add_assoc_double(&array, pretty_key(key, strlen(X), 0, 0), d); \
211 efree(key); \
212 } \
213 } \
214 break; \
215 \
216 case CURLINFO_LONG: \
217 { \
218 long l; \
219 if (CURLE_OK == curl_easy_getinfo(request->ch, I, &l)) { \
220 char *key = estrndup(X, strlen(X)); \
221 add_assoc_long(&array, pretty_key(key, strlen(X), 0, 0), l); \
222 efree(key); \
223 } \
224 } \
225 break; \
226 \
227 case CURLINFO_SLIST: \
228 { \
229 struct curl_slist *l, *p; \
230 if (CURLE_OK == curl_easy_getinfo(request->ch, I, &l)) { \
231 zval *subarray; \
232 char *key = estrndup(X, strlen(X)); \
233 MAKE_STD_ZVAL(subarray); \
234 array_init(subarray); \
235 for (p = l; p; p = p->next) { \
236 add_next_index_string(subarray, p->data, 1); \
237 } \
238 add_assoc_zval(&array, pretty_key(key, strlen(X), 0, 0), subarray); \
239 curl_slist_free_all(l); \
240 efree(key); \
241 } \
242 } \
243 }
244
245 #define HTTP_CURL_OPT(OPTION, p) HTTP_CURL_OPT_EX(request->ch, OPTION, (p))
246 #define HTTP_CURL_OPT_EX(ch, OPTION, p) curl_easy_setopt((ch), OPTION, (p))
247 #define HTTP_CURL_OPT_STRING(keyname, obdc) HTTP_CURL_OPT_STRING_EX(keyname, keyname, obdc)
248 #define HTTP_CURL_OPT_STRING_EX(keyname, optname, obdc) \
249 if (!strcasecmp(key, #keyname)) { \
250 zval *copy = http_request_option_cache(request, #keyname, zval_copy(IS_STRING, *param)); \
251 if (obdc) { \
252 HTTP_CHECK_OPEN_BASEDIR(Z_STRVAL_P(copy), return FAILURE); \
253 } \
254 HTTP_CURL_OPT(optname, Z_STRVAL_P(copy)); \
255 key = NULL; \
256 continue; \
257 }
258 #define HTTP_CURL_OPT_LONG(keyname) HTTP_CURL_OPT_LONG_EX(keyname, keyname)
259 #define HTTP_CURL_OPT_LONG_EX(keyname, optname) \
260 if (!strcasecmp(key, #keyname)) { \
261 zval *copy = http_request_option_cache(request, #keyname, zval_copy(IS_LONG, *param)); \
262 HTTP_CURL_OPT(optname, Z_LVAL_P(copy)); \
263 key = NULL; \
264 continue; \
265 }
266 /* }}} */
267
268 /* {{{ forward declarations */
269 #define http_request_option(r, o, k, t) _http_request_option_ex((r), (o), (k), sizeof(k), (t) TSRMLS_CC)
270 #define http_request_option_ex(r, o, k, l, t) _http_request_option_ex((r), (o), (k), (l), (t) TSRMLS_CC)
271 static inline zval *_http_request_option_ex(http_request *request, HashTable *options, char *key, size_t keylen, int type TSRMLS_DC);
272 #define http_request_option_cache(r, k, z) _http_request_option_cache_ex((r), (k), sizeof(k), 0, (z) TSRMLS_CC)
273 #define http_request_option_cache_ex(r, k, kl, h, z) _http_request_option_cache_ex((r), (k), (kl), (h), (z) TSRMLS_CC)
274 static inline zval *_http_request_option_cache_ex(http_request *r, char *key, size_t keylen, ulong h, zval *opt TSRMLS_DC);
275
276 static size_t http_curl_read_callback(void *, size_t, size_t, void *);
277 static int http_curl_progress_callback(void *, double, double, double, double);
278 static int http_curl_raw_callback(CURL *, curl_infotype, char *, size_t, void *);
279 static int http_curl_dummy_callback(char *data, size_t n, size_t l, void *s) { return n*l; }
280 static curlioerr http_curl_ioctl_callback(CURL *, curliocmd, void *);
281 /* }}} */
282
283 /* {{{ CURL *http_curl_init(http_request *) */
284 PHP_HTTP_API CURL * _http_curl_init_ex(CURL *ch, http_request *request)
285 {
286 if (ch || (ch = curl_easy_init())) {
287 #if defined(ZTS)
288 HTTP_CURL_OPT_EX(ch, CURLOPT_NOSIGNAL, 1);
289 #endif
290 HTTP_CURL_OPT_EX(ch, CURLOPT_HEADER, 0);
291 HTTP_CURL_OPT_EX(ch, CURLOPT_FILETIME, 1);
292 HTTP_CURL_OPT_EX(ch, CURLOPT_AUTOREFERER, 1);
293 HTTP_CURL_OPT_EX(ch, CURLOPT_VERBOSE, 1);
294 HTTP_CURL_OPT_EX(ch, CURLOPT_HEADERFUNCTION, NULL);
295 HTTP_CURL_OPT_EX(ch, CURLOPT_DEBUGFUNCTION, http_curl_raw_callback);
296 HTTP_CURL_OPT_EX(ch, CURLOPT_READFUNCTION, http_curl_read_callback);
297 HTTP_CURL_OPT_EX(ch, CURLOPT_IOCTLFUNCTION, http_curl_ioctl_callback);
298 HTTP_CURL_OPT_EX(ch, CURLOPT_WRITEFUNCTION, http_curl_dummy_callback);
299
300 /* set context */
301 if (request) {
302 HTTP_CURL_OPT_EX(ch, CURLOPT_PRIVATE, request);
303 HTTP_CURL_OPT_EX(ch, CURLOPT_DEBUGDATA, request);
304 HTTP_CURL_OPT_EX(ch, CURLOPT_ERRORBUFFER, request->_error);
305
306 /* attach curl handle */
307 request->ch = ch;
308 /* set defaults (also in http_request_reset()) */
309 http_request_defaults(request);
310 }
311 }
312
313 return ch;
314 }
315 /* }}} */
316
317 /* {{{ void http_curl_free(CURL **) */
318 PHP_HTTP_API void _http_curl_free(CURL **ch)
319 {
320 if (*ch) {
321 /* avoid nasty segfaults with already cleaned up callbacks */
322 HTTP_CURL_OPT_EX(*ch, CURLOPT_NOPROGRESS, 1);
323 HTTP_CURL_OPT_EX(*ch, CURLOPT_PROGRESSFUNCTION, NULL);
324 HTTP_CURL_OPT_EX(*ch, CURLOPT_VERBOSE, 0);
325 HTTP_CURL_OPT_EX(*ch, CURLOPT_DEBUGFUNCTION, NULL);
326 curl_easy_cleanup(*ch);
327 *ch = NULL;
328 }
329 }
330 /* }}} */
331
332 /* {{{ http_request *http_request_init(http_request *) */
333 PHP_HTTP_API http_request *_http_request_init_ex(http_request *request, CURL *ch, http_request_method meth, const char *url ZEND_FILE_LINE_DC ZEND_FILE_LINE_ORIG_DC TSRMLS_DC)
334 {
335 http_request *r;
336
337 if (request) {
338 r = request;
339 } else {
340 r = emalloc_rel(sizeof(http_request));
341 }
342 memset(r, 0, sizeof(http_request));
343
344 r->ch = ch;
345 r->url = (url) ? http_absolute_url(url) : NULL;
346 r->meth = (meth > 0) ? meth : HTTP_GET;
347
348 phpstr_init(&r->conv.request);
349 phpstr_init_ex(&r->conv.response, HTTP_CURLBUF_SIZE, 0);
350 phpstr_init(&r->_cache.cookies);
351 zend_hash_init(&r->_cache.options, 0, NULL, ZVAL_PTR_DTOR, 0);
352
353 TSRMLS_SET_CTX(r->tsrm_ls);
354
355 return r;
356 }
357 /* }}} */
358
359 /* {{{ void http_request_dtor(http_request *) */
360 PHP_HTTP_API void _http_request_dtor(http_request *request)
361 {
362 TSRMLS_FETCH_FROM_CTX(request->tsrm_ls);
363
364 http_curl_free(&request->ch);
365 http_request_reset(request);
366
367 phpstr_dtor(&request->_cache.cookies);
368 zend_hash_destroy(&request->_cache.options);
369 if (request->_cache.headers) {
370 curl_slist_free_all(request->_cache.headers);
371 request->_cache.headers = NULL;
372 }
373 if (request->_progress_callback) {
374 zval_ptr_dtor(&request->_progress_callback);
375 request->_progress_callback = NULL;
376 }
377 }
378 /* }}} */
379
380 /* {{{ void http_request_free(http_request **) */
381 PHP_HTTP_API void _http_request_free(http_request **request)
382 {
383 if (*request) {
384 TSRMLS_FETCH_FROM_CTX((*request)->tsrm_ls);
385 http_request_body_free(&(*request)->body);
386 http_request_dtor(*request);
387 efree(*request);
388 *request = NULL;
389 }
390 }
391 /* }}} */
392
393 /* {{{ void http_request_reset(http_request *) */
394 PHP_HTTP_API void _http_request_reset(http_request *request)
395 {
396 TSRMLS_FETCH_FROM_CTX(request->tsrm_ls);
397 STR_SET(request->url, NULL);
398 request->conv.last_type = 0;
399 phpstr_dtor(&request->conv.request);
400 phpstr_dtor(&request->conv.response);
401 http_request_body_dtor(request->body);
402
403 if (request->ch) {
404 http_request_defaults(request);
405 }
406 }
407 /* }}} */
408
409 /* {{{ void http_request_defaults(http_request *) */
410 PHP_HTTP_API void _http_request_defaults(http_request *request)
411 {
412 if (request->ch) {
413 HTTP_CURL_OPT(CURLOPT_PROGRESSFUNCTION, NULL);
414 HTTP_CURL_OPT(CURLOPT_URL, NULL);
415 HTTP_CURL_OPT(CURLOPT_NOPROGRESS, 1);
416 HTTP_CURL_OPT(CURLOPT_PROXY, NULL);
417 HTTP_CURL_OPT(CURLOPT_PROXYPORT, 0);
418 HTTP_CURL_OPT(CURLOPT_PROXYUSERPWD, NULL);
419 HTTP_CURL_OPT(CURLOPT_PROXYAUTH, 0);
420 HTTP_CURL_OPT(CURLOPT_INTERFACE, NULL);
421 HTTP_CURL_OPT(CURLOPT_PORT, 0);
422 HTTP_CURL_OPT(CURLOPT_USERPWD, NULL);
423 HTTP_CURL_OPT(CURLOPT_HTTPAUTH, 0);
424 HTTP_CURL_OPT(CURLOPT_ENCODING, NULL);
425 HTTP_CURL_OPT(CURLOPT_FOLLOWLOCATION, 0);
426 HTTP_CURL_OPT(CURLOPT_UNRESTRICTED_AUTH, 0);
427 HTTP_CURL_OPT(CURLOPT_REFERER, NULL);
428 HTTP_CURL_OPT(CURLOPT_USERAGENT, "PECL::HTTP/" PHP_EXT_HTTP_VERSION " (PHP/" PHP_VERSION ")");
429 HTTP_CURL_OPT(CURLOPT_HTTPHEADER, NULL);
430 HTTP_CURL_OPT(CURLOPT_COOKIE, NULL);
431 #if LIBCURL_VERSION_NUM >= 0x070e01
432 HTTP_CURL_OPT(CURLOPT_COOKIELIST, NULL);
433 #endif
434 HTTP_CURL_OPT(CURLOPT_COOKIEFILE, NULL);
435 HTTP_CURL_OPT(CURLOPT_COOKIEJAR, NULL);
436 HTTP_CURL_OPT(CURLOPT_RESUME_FROM, 0);
437 HTTP_CURL_OPT(CURLOPT_MAXFILESIZE, 0);
438 HTTP_CURL_OPT(CURLOPT_TIMECONDITION, 0);
439 HTTP_CURL_OPT(CURLOPT_TIMEVALUE, 0);
440 HTTP_CURL_OPT(CURLOPT_TIMEOUT, 0);
441 HTTP_CURL_OPT(CURLOPT_CONNECTTIMEOUT, 3);
442 HTTP_CURL_OPT(CURLOPT_SSLCERT, NULL);
443 HTTP_CURL_OPT(CURLOPT_SSLCERTTYPE, NULL);
444 HTTP_CURL_OPT(CURLOPT_SSLCERTPASSWD, NULL);
445 HTTP_CURL_OPT(CURLOPT_SSLKEY, NULL);
446 HTTP_CURL_OPT(CURLOPT_SSLKEYTYPE, NULL);
447 HTTP_CURL_OPT(CURLOPT_SSLKEYPASSWD, NULL);
448 HTTP_CURL_OPT(CURLOPT_SSLENGINE, NULL);
449 HTTP_CURL_OPT(CURLOPT_SSLVERSION, 0);
450 HTTP_CURL_OPT(CURLOPT_SSL_VERIFYPEER, 0);
451 HTTP_CURL_OPT(CURLOPT_SSL_VERIFYHOST, 0);
452 HTTP_CURL_OPT(CURLOPT_SSL_CIPHER_LIST, NULL);
453 HTTP_CURL_OPT(CURLOPT_CAINFO, NULL);
454 HTTP_CURL_OPT(CURLOPT_CAPATH, NULL);
455 HTTP_CURL_OPT(CURLOPT_RANDOM_FILE, NULL);
456 HTTP_CURL_OPT(CURLOPT_EGDSOCKET, NULL);
457 HTTP_CURL_OPT(CURLOPT_POSTFIELDS, NULL);
458 HTTP_CURL_OPT(CURLOPT_POSTFIELDSIZE, 0);
459 HTTP_CURL_OPT(CURLOPT_HTTPPOST, NULL);
460 HTTP_CURL_OPT(CURLOPT_IOCTLDATA, NULL);
461 HTTP_CURL_OPT(CURLOPT_READDATA, NULL);
462 HTTP_CURL_OPT(CURLOPT_INFILESIZE, 0);
463 HTTP_CURL_OPT(CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_NONE);
464 HTTP_CURL_OPT(CURLOPT_CUSTOMREQUEST, NULL);
465 HTTP_CURL_OPT(CURLOPT_NOBODY, 0);
466 HTTP_CURL_OPT(CURLOPT_POST, 0);
467 HTTP_CURL_OPT(CURLOPT_UPLOAD, 0);
468 HTTP_CURL_OPT(CURLOPT_HTTPGET, 1);
469 }
470 }
471 /* }}} */
472
473 PHP_HTTP_API void _http_request_set_progress_callback(http_request *request, zval *cb)
474 {
475 TSRMLS_FETCH_FROM_CTX(request->tsrm_ls);
476
477 if (request->_progress_callback) {
478 zval_ptr_dtor(&request->_progress_callback);
479 }
480 if ((request->_progress_callback = cb)) {
481 ZVAL_ADDREF(cb);
482 HTTP_CURL_OPT(CURLOPT_NOPROGRESS, 0);
483 HTTP_CURL_OPT(CURLOPT_PROGRESSDATA, request);
484 HTTP_CURL_OPT(CURLOPT_PROGRESSFUNCTION, http_curl_progress_callback);
485 } else {
486 HTTP_CURL_OPT(CURLOPT_NOPROGRESS, 1);
487 HTTP_CURL_OPT(CURLOPT_PROGRESSDATA, NULL);
488 HTTP_CURL_OPT(CURLOPT_PROGRESSFUNCTION, NULL);
489 }
490 }
491
492 /* {{{ STATUS http_request_prepare(http_request *, HashTable *) */
493 PHP_HTTP_API STATUS _http_request_prepare(http_request *request, HashTable *options)
494 {
495 zval *zoption;
496 zend_bool range_req = 0;
497
498 TSRMLS_FETCH_FROM_CTX(request->tsrm_ls);
499
500 HTTP_CHECK_CURL_INIT(request->ch, http_curl_init(request), return FAILURE);
501
502 /* set options */
503 HTTP_CURL_OPT(CURLOPT_URL, request->url);
504
505 /* progress callback */
506 if ((zoption = http_request_option(request, options, "onprogress", -1))) {
507 http_request_set_progress_callback(request, zoption);
508 }
509
510 /* proxy */
511 if ((zoption = http_request_option(request, options, "proxyhost", IS_STRING))) {
512 if (Z_STRLEN_P(zoption)) {
513 HTTP_CURL_OPT(CURLOPT_PROXY, Z_STRVAL_P(zoption));
514 }
515
516 /* port */
517 if ((zoption = http_request_option(request, options, "proxyport", IS_LONG))) {
518 HTTP_CURL_OPT(CURLOPT_PROXYPORT, Z_LVAL_P(zoption));
519 }
520 /* user:pass */
521 if ((zoption = http_request_option(request, options, "proxyauth", IS_STRING)) && Z_STRLEN_P(zoption)) {
522 HTTP_CURL_OPT(CURLOPT_PROXYUSERPWD, Z_STRVAL_P(zoption));
523 }
524 /* auth method */
525 if ((zoption = http_request_option(request, options, "proxyauthtype", IS_LONG))) {
526 HTTP_CURL_OPT(CURLOPT_PROXYAUTH, Z_LVAL_P(zoption));
527 }
528 }
529
530 /* outgoing interface */
531 if ((zoption = http_request_option(request, options, "interface", IS_STRING))) {
532 HTTP_CURL_OPT(CURLOPT_INTERFACE, Z_STRVAL_P(zoption));
533 }
534
535 /* another port */
536 if ((zoption = http_request_option(request, options, "port", IS_LONG))) {
537 HTTP_CURL_OPT(CURLOPT_PORT, Z_LVAL_P(zoption));
538 }
539
540 /* auth */
541 if ((zoption = http_request_option(request, options, "httpauth", IS_STRING)) && Z_STRLEN_P(zoption)) {
542 HTTP_CURL_OPT(CURLOPT_USERPWD, Z_STRVAL_P(zoption));
543 }
544 if ((zoption = http_request_option(request, options, "httpauthtype", IS_LONG))) {
545 HTTP_CURL_OPT(CURLOPT_HTTPAUTH, Z_LVAL_P(zoption));
546 }
547
548 /* redirects, defaults to 0 */
549 if ((zoption = http_request_option(request, options, "redirect", IS_LONG))) {
550 HTTP_CURL_OPT(CURLOPT_FOLLOWLOCATION, Z_LVAL_P(zoption) ? 1 : 0);
551 HTTP_CURL_OPT(CURLOPT_MAXREDIRS, Z_LVAL_P(zoption));
552 if ((zoption = http_request_option(request, options, "unrestrictedauth", IS_BOOL))) {
553 HTTP_CURL_OPT(CURLOPT_UNRESTRICTED_AUTH, Z_LVAL_P(zoption));
554 }
555 }
556
557 /* referer */
558 if ((zoption = http_request_option(request, options, "referer", IS_STRING)) && Z_STRLEN_P(zoption)) {
559 HTTP_CURL_OPT(CURLOPT_REFERER, Z_STRVAL_P(zoption));
560 }
561
562 /* useragent, default "PECL::HTTP/version (PHP/version)" */
563 if ((zoption = http_request_option(request, options, "useragent", IS_STRING))) {
564 /* allow to send no user agent, not even default one */
565 if (Z_STRLEN_P(zoption)) {
566 HTTP_CURL_OPT(CURLOPT_USERAGENT, Z_STRVAL_P(zoption));
567 } else {
568 HTTP_CURL_OPT(CURLOPT_USERAGENT, NULL);
569 }
570 }
571
572 /* resume */
573 if ((zoption = http_request_option(request, options, "resume", IS_LONG)) && (Z_LVAL_P(zoption) != 0)) {
574 range_req = 1;
575 HTTP_CURL_OPT(CURLOPT_RESUME_FROM, Z_LVAL_P(zoption));
576 }
577
578 /* additional headers, array('name' => 'value') */
579 if (request->_cache.headers) {
580 curl_slist_free_all(request->_cache.headers);
581 request->_cache.headers = NULL;
582 }
583 if ((zoption = http_request_option(request, options, "headers", IS_ARRAY))) {
584 char *header_key;
585 ulong header_idx;
586 HashPosition pos;
587
588 FOREACH_KEY(pos, zoption, header_key, header_idx) {
589 if (header_key) {
590 zval **header_val;
591 if (SUCCESS == zend_hash_get_current_data_ex(Z_ARRVAL_P(zoption), (void **) &header_val, &pos)) {
592 char header[1024] = {0};
593
594 ZVAL_ADDREF(*header_val);
595 convert_to_string_ex(header_val);
596 if (!strcasecmp(header_key, "range")) {
597 range_req = 1;
598 }
599 snprintf(header, lenof(header), "%s: %s", header_key, Z_STRVAL_PP(header_val));
600 request->_cache.headers = curl_slist_append(request->_cache.headers, header);
601 zval_ptr_dtor(header_val);
602 }
603
604 /* reset */
605 header_key = NULL;
606 }
607 }
608 }
609 /* etag */
610 if ((zoption = http_request_option(request, options, "etag", IS_STRING)) && Z_STRLEN_P(zoption)) {
611 char match_header[1024] = {0}, *quoted_etag = NULL;
612
613 if ((Z_STRVAL_P(zoption)[0] != '"') || (Z_STRVAL_P(zoption)[Z_STRLEN_P(zoption)-1] != '"')) {
614 spprintf(&quoted_etag, 0, "\"%s\"", Z_STRVAL_P(zoption));
615 }
616 snprintf(match_header, lenof(match_header), "%s: %s", range_req?"If-Match":"If-None-Match", quoted_etag?quoted_etag:Z_STRVAL_P(zoption));
617 request->_cache.headers = curl_slist_append(request->_cache.headers, match_header);
618 STR_FREE(quoted_etag);
619 }
620 /* compression */
621 if ((zoption = http_request_option(request, options, "compress", IS_BOOL)) && Z_LVAL_P(zoption)) {
622 request->_cache.headers = curl_slist_append(request->_cache.headers, "Accept-Encoding: gzip;q=1.0,deflate;q=0.5");
623 }
624 HTTP_CURL_OPT(CURLOPT_HTTPHEADER, request->_cache.headers);
625
626 /* lastmodified */
627 if ((zoption = http_request_option(request, options, "lastmodified", IS_LONG))) {
628 if (Z_LVAL_P(zoption)) {
629 if (Z_LVAL_P(zoption) > 0) {
630 HTTP_CURL_OPT(CURLOPT_TIMEVALUE, Z_LVAL_P(zoption));
631 } else {
632 HTTP_CURL_OPT(CURLOPT_TIMEVALUE, HTTP_GET_REQUEST_TIME() + Z_LVAL_P(zoption));
633 }
634 HTTP_CURL_OPT(CURLOPT_TIMECONDITION, range_req ? CURL_TIMECOND_IFUNMODSINCE : CURL_TIMECOND_IFMODSINCE);
635 } else {
636 HTTP_CURL_OPT(CURLOPT_TIMECONDITION, CURL_TIMECOND_NONE);
637 }
638 }
639
640 /* cookies, array('name' => 'value') */
641 if ((zoption = http_request_option(request, options, "cookies", IS_ARRAY))) {
642 phpstr_dtor(&request->_cache.cookies);
643 if (zend_hash_num_elements(Z_ARRVAL_P(zoption))) {
644 if (SUCCESS == http_urlencode_hash_recursive(HASH_OF(zoption), &request->_cache.cookies, "; ", sizeof("; ")-1, NULL, 0)) {
645 phpstr_fix(&request->_cache.cookies);
646 HTTP_CURL_OPT(CURLOPT_COOKIE, request->_cache.cookies.data);
647 }
648 }
649 }
650
651 #if LIBCURL_VERSION_NUM >= 0x070e01
652 /* reset cookies */
653 if ((zoption = http_request_option(request, options, "resetcookies", IS_BOOL)) && Z_LVAL_P(zoption)) {
654 HTTP_CURL_OPT(CURLOPT_COOKIELIST, "ALL");
655 }
656 #endif
657
658 /* session cookies */
659 if ((zoption = http_request_option(request, options, "cookiesession", IS_BOOL))) {
660 if (Z_LVAL_P(zoption)) {
661 /* accept cookies for this session */
662 HTTP_CURL_OPT(CURLOPT_COOKIEFILE, "");
663 } else {
664 /* reset session cookies */
665 HTTP_CURL_OPT(CURLOPT_COOKIESESSION, 1);
666 }
667 }
668
669 /* cookiestore, read initial cookies from that file and store cookies back into that file */
670 if ((zoption = http_request_option(request, options, "cookiestore", IS_STRING)) && Z_STRLEN_P(zoption)) {
671 HTTP_CHECK_OPEN_BASEDIR(Z_STRVAL_P(zoption), return FAILURE);
672 HTTP_CURL_OPT(CURLOPT_COOKIEFILE, Z_STRVAL_P(zoption));
673 HTTP_CURL_OPT(CURLOPT_COOKIEJAR, Z_STRVAL_P(zoption));
674 }
675
676 /* maxfilesize */
677 if ((zoption = http_request_option(request, options, "maxfilesize", IS_LONG))) {
678 HTTP_CURL_OPT(CURLOPT_MAXFILESIZE, Z_LVAL_P(zoption));
679 }
680
681 /* http protocol */
682 if ((zoption = http_request_option(request, options, "protocol", IS_LONG))) {
683 HTTP_CURL_OPT(CURLOPT_HTTP_VERSION, Z_LVAL_P(zoption));
684 }
685
686 /* timeout, defaults to 0 */
687 if ((zoption = http_request_option(request, options, "timeout", IS_LONG))) {
688 HTTP_CURL_OPT(CURLOPT_TIMEOUT, Z_LVAL_P(zoption));
689 }
690
691 /* connecttimeout, defaults to 3 */
692 if ((zoption = http_request_option(request, options, "connecttimeout", IS_LONG))) {
693 HTTP_CURL_OPT(CURLOPT_CONNECTTIMEOUT, Z_LVAL_P(zoption));
694 }
695
696 /* ssl */
697 if ((zoption = http_request_option(request, options, "ssl", IS_ARRAY))) {
698 ulong idx;
699 char *key = NULL;
700 zval **param;
701 HashPosition pos;
702
703 FOREACH_KEYVAL(pos, zoption, key, idx, param) {
704 if (key) {
705 HTTP_CURL_OPT_STRING(CURLOPT_SSLCERT, 1);
706 HTTP_CURL_OPT_STRING(CURLOPT_SSLCERTTYPE, 0);
707 HTTP_CURL_OPT_STRING(CURLOPT_SSLCERTPASSWD, 0);
708
709 HTTP_CURL_OPT_STRING(CURLOPT_SSLKEY, 0);
710 HTTP_CURL_OPT_STRING(CURLOPT_SSLKEYTYPE, 0);
711 HTTP_CURL_OPT_STRING(CURLOPT_SSLKEYPASSWD, 0);
712
713 HTTP_CURL_OPT_STRING(CURLOPT_SSLENGINE, 0);
714 HTTP_CURL_OPT_LONG(CURLOPT_SSLVERSION);
715
716 HTTP_CURL_OPT_LONG(CURLOPT_SSL_VERIFYPEER);
717 HTTP_CURL_OPT_LONG(CURLOPT_SSL_VERIFYHOST);
718 HTTP_CURL_OPT_STRING(CURLOPT_SSL_CIPHER_LIST, 0);
719
720 HTTP_CURL_OPT_STRING(CURLOPT_CAINFO, 1);
721 HTTP_CURL_OPT_STRING(CURLOPT_CAPATH, 1);
722 HTTP_CURL_OPT_STRING(CURLOPT_RANDOM_FILE, 1);
723 HTTP_CURL_OPT_STRING(CURLOPT_EGDSOCKET, 1);
724
725 /* reset key */
726 key = NULL;
727 }
728 }
729 }
730
731 /* request method */
732 switch (request->meth)
733 {
734 case HTTP_GET:
735 HTTP_CURL_OPT(CURLOPT_HTTPGET, 1);
736 break;
737
738 case HTTP_HEAD:
739 HTTP_CURL_OPT(CURLOPT_NOBODY, 1);
740 break;
741
742 case HTTP_POST:
743 HTTP_CURL_OPT(CURLOPT_POST, 1);
744 break;
745
746 case HTTP_PUT:
747 HTTP_CURL_OPT(CURLOPT_UPLOAD, 1);
748 break;
749
750 default:
751 if (http_request_method_exists(0, request->meth, NULL)) {
752 HTTP_CURL_OPT(CURLOPT_CUSTOMREQUEST, http_request_method_name(request->meth));
753 } else {
754 http_error_ex(HE_WARNING, HTTP_E_REQUEST_METHOD, "Unsupported request method: %d (%s)", request->meth, request->url);
755 return FAILURE;
756 }
757 break;
758 }
759
760 /* attach request body */
761 if (request->body && (request->meth != HTTP_GET) && (request->meth != HTTP_HEAD) && (request->meth != HTTP_OPTIONS)) {
762 switch (request->body->type)
763 {
764 case HTTP_REQUEST_BODY_EMPTY:
765 /* nothing */
766 break;
767
768 case HTTP_REQUEST_BODY_CSTRING:
769 HTTP_CURL_OPT(CURLOPT_POSTFIELDS, request->body->data);
770 HTTP_CURL_OPT(CURLOPT_POSTFIELDSIZE, request->body->size);
771 break;
772
773 case HTTP_REQUEST_BODY_CURLPOST:
774 HTTP_CURL_OPT(CURLOPT_HTTPPOST, (struct curl_httppost *) request->body->data);
775 break;
776
777 case HTTP_REQUEST_BODY_UPLOADFILE:
778 HTTP_CURL_OPT(CURLOPT_IOCTLDATA, request);
779 HTTP_CURL_OPT(CURLOPT_READDATA, request);
780 HTTP_CURL_OPT(CURLOPT_INFILESIZE, request->body->size);
781 break;
782
783 default:
784 /* shouldn't ever happen */
785 http_error_ex(HE_ERROR, 0, "Unknown request body type: %d (%s)", request->body->type, request->url);
786 return FAILURE;
787 break;
788 }
789 }
790
791 return SUCCESS;
792 }
793 /* }}} */
794
795 /* {{{ void http_request_exec(http_request *) */
796 PHP_HTTP_API void _http_request_exec(http_request *request)
797 {
798 CURLcode result;
799 TSRMLS_FETCH_FROM_CTX(request->tsrm_ls);
800
801 if (CURLE_OK != (result = curl_easy_perform(request->ch))) {
802 http_error_ex(HE_WARNING, HTTP_E_REQUEST, "%s; %s (%s)", curl_easy_strerror(result), request->_error, request->url);
803 }
804 }
805 /* }}} */
806
807 /* {{{ void http_request_info(http_request *, HashTable *) */
808 PHP_HTTP_API void _http_request_info(http_request *request, HashTable *info)
809 {
810 zval array;
811 INIT_ZARR(array, info);
812
813 HTTP_CURL_INFO(CURLINFO_EFFECTIVE_URL);
814 HTTP_CURL_INFO(CURLINFO_RESPONSE_CODE);
815 HTTP_CURL_INFO_EX(CURLINFO_HTTP_CONNECTCODE, "connect_code");
816 HTTP_CURL_INFO(CURLINFO_FILETIME);
817 HTTP_CURL_INFO(CURLINFO_TOTAL_TIME);
818 HTTP_CURL_INFO(CURLINFO_NAMELOOKUP_TIME);
819 HTTP_CURL_INFO(CURLINFO_CONNECT_TIME);
820 HTTP_CURL_INFO(CURLINFO_PRETRANSFER_TIME);
821 HTTP_CURL_INFO(CURLINFO_STARTTRANSFER_TIME);
822 HTTP_CURL_INFO(CURLINFO_REDIRECT_TIME);
823 HTTP_CURL_INFO(CURLINFO_REDIRECT_COUNT);
824 HTTP_CURL_INFO(CURLINFO_SIZE_UPLOAD);
825 HTTP_CURL_INFO(CURLINFO_SIZE_DOWNLOAD);
826 HTTP_CURL_INFO(CURLINFO_SPEED_DOWNLOAD);
827 HTTP_CURL_INFO(CURLINFO_SPEED_UPLOAD);
828 HTTP_CURL_INFO(CURLINFO_HEADER_SIZE);
829 HTTP_CURL_INFO(CURLINFO_REQUEST_SIZE);
830 HTTP_CURL_INFO(CURLINFO_SSL_VERIFYRESULT);
831 HTTP_CURL_INFO(CURLINFO_SSL_ENGINES);
832 HTTP_CURL_INFO(CURLINFO_CONTENT_LENGTH_DOWNLOAD);
833 HTTP_CURL_INFO(CURLINFO_CONTENT_LENGTH_UPLOAD);
834 HTTP_CURL_INFO(CURLINFO_CONTENT_TYPE);
835 HTTP_CURL_INFO(CURLINFO_HTTPAUTH_AVAIL);
836 HTTP_CURL_INFO(CURLINFO_PROXYAUTH_AVAIL);
837 /*HTTP_CURL_INFO(OS_ERRNO);*/
838 HTTP_CURL_INFO(CURLINFO_NUM_CONNECTS);
839 #if LIBCURL_VERSION_NUM >= 0x070e01
840 HTTP_CURL_INFO_EX(CURLINFO_COOKIELIST, "cookies");
841 #endif
842 }
843 /* }}} */
844
845 /* {{{ static size_t http_curl_read_callback(void *, size_t, size_t, void *) */
846 static size_t http_curl_read_callback(void *data, size_t len, size_t n, void *ctx)
847 {
848 http_request *request = (http_request *) ctx;
849 TSRMLS_FETCH_FROM_CTX(request->tsrm_ls);
850
851 if (request->body == NULL || request->body->type != HTTP_REQUEST_BODY_UPLOADFILE) {
852 return 0;
853 }
854 return php_stream_read((php_stream *) request->body->data, data, len * n);
855 }
856 /* }}} */
857
858 /* {{{ static int http_curl_progress_callback(void *, double, double, double, double) */
859 static int http_curl_progress_callback(void *ctx, double dltotal, double dlnow, double ultotal, double ulnow)
860 {
861 zval *param, retval;
862 http_request *request = (http_request *) ctx;
863 TSRMLS_FETCH_FROM_CTX(request->tsrm_ls);
864
865 INIT_PZVAL(&retval);
866 ZVAL_NULL(&retval);
867
868 MAKE_STD_ZVAL(param);
869 array_init(param);
870 add_assoc_double(param, "dltotal", dltotal);
871 add_assoc_double(param, "dlnow", dlnow);
872 add_assoc_double(param, "ultotal", ultotal);
873 add_assoc_double(param, "ulnow", ulnow);
874
875 call_user_function(EG(function_table), NULL, request->_progress_callback, &retval, 1, &param TSRMLS_CC);
876
877 zval_ptr_dtor(&param);
878 zval_dtor(&retval);
879
880 return 0;
881 }
882 /* }}} */
883
884 /* {{{ static curlioerr http_curl_ioctl_callback(CURL *, curliocmd, void *) */
885 static curlioerr http_curl_ioctl_callback(CURL *ch, curliocmd cmd, void *ctx)
886 {
887 http_request *request = (http_request *) ctx;
888 TSRMLS_FETCH_FROM_CTX(request->tsrm_ls);
889
890 if (cmd != CURLIOCMD_RESTARTREAD) {
891 return CURLIOE_UNKNOWNCMD;
892 }
893 if ( request->body == NULL ||
894 request->body->type != HTTP_REQUEST_BODY_UPLOADFILE ||
895 SUCCESS != php_stream_rewind((php_stream *) request->body->data)) {
896 return CURLIOE_FAILRESTART;
897 }
898 return CURLIOE_OK;
899 }
900 /* }}} */
901
902 /* {{{ static int http_curl_raw_callback(CURL *, curl_infotype, char *, size_t, void *) */
903 static int http_curl_raw_callback(CURL *ch, curl_infotype type, char *data, size_t length, void *ctx)
904 {
905 http_request *request = (http_request *) ctx;
906
907 switch (type)
908 {
909 case CURLINFO_DATA_IN:
910 if (request->conv.last_type == CURLINFO_HEADER_IN) {
911 phpstr_appends(&request->conv.response, HTTP_CRLF);
912 }
913 case CURLINFO_HEADER_IN:
914 phpstr_append(&request->conv.response, data, length);
915 break;
916 case CURLINFO_DATA_OUT:
917 if (request->conv.last_type == CURLINFO_HEADER_OUT) {
918 phpstr_appends(&request->conv.request, HTTP_CRLF);
919 }
920 case CURLINFO_HEADER_OUT:
921 phpstr_append(&request->conv.request, data, length);
922 break;
923 default:
924 #if 0
925 fprintf(stderr, "## ", type);
926 if (!type) {
927 fprintf(stderr, "%s", data);
928 } else {
929 ulong i;
930 for (i = 1; i <= length; ++i) {
931 fprintf(stderr, "%02X ", data[i-1] & 0xFF);
932 if (!(i % 20)) {
933 fprintf(stderr, "\n## ");
934 }
935 }
936 fprintf(stderr, "\n");
937 }
938 if (data[length-1] != 0xa) {
939 fprintf(stderr, "\n");
940 }
941 #endif
942 break;
943 }
944
945 if (type) {
946 request->conv.last_type = type;
947 }
948 return 0;
949 }
950 /* }}} */
951
952 /* {{{ static inline zval *http_request_option(http_request *, HashTable *, char *, size_t, int) */
953 static inline zval *_http_request_option_ex(http_request *r, HashTable *options, char *key, size_t keylen, int type TSRMLS_DC)
954 {
955 zval **zoption;
956 #ifdef ZEND_ENGINE_2
957 ulong h = zend_get_hash_value(key, keylen);
958 #else
959 ulong h = 0;
960 #endif
961
962 if (!options ||
963 #ifdef ZEND_ENGINE_2
964 (SUCCESS != zend_hash_quick_find(options, key, keylen, h, (void **) &zoption))
965 #else
966 (SUCCESS != zend_hash_find(options, key, keylen, (void **) &zoption))
967 #endif
968 ) {
969 return NULL;
970 }
971
972 return http_request_option_cache_ex(r, key, keylen, h, zval_copy(type, *zoption));
973 }
974 /* }}} */
975
976 /* {{{ static inline zval *http_request_option_cache(http_request *, char *key, zval *) */
977 static inline zval *_http_request_option_cache_ex(http_request *r, char *key, size_t keylen, ulong h, zval *opt TSRMLS_DC)
978 {
979 ZVAL_ADDREF(opt);
980
981 #ifdef ZEND_ENGINE_2
982 if (h) {
983 _zend_hash_quick_add_or_update(&r->_cache.options, key, keylen, h, &opt, sizeof(zval *), NULL,
984 zend_hash_quick_exists(&r->_cache.options, key, keylen, h)?HASH_UPDATE:HASH_ADD ZEND_FILE_LINE_CC);
985 }
986 else
987 #endif
988 {
989 if (zend_hash_exists(&r->_cache.options, key, keylen)) {
990 zend_hash_update(&r->_cache.options, key, keylen, &opt, sizeof(zval *), NULL);
991 } else {
992 zend_hash_add(&r->_cache.options, key, keylen, &opt, sizeof(zval *), NULL);
993 }
994 }
995
996 return opt;
997 }
998 /* }}} */
999
1000 #endif /* HTTP_HAVE_CURL */
1001
1002 /*
1003 * Local variables:
1004 * tab-width: 4
1005 * c-basic-offset: 4
1006 * End:
1007 * vim600: noet sw=4 ts=4 fdm=marker
1008 * vim<600: noet sw=4 ts=4
1009 */
1010