2 +--------------------------------------------------------------------+
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-2007, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
15 #define HTTP_WANT_CURL
16 #define HTTP_WANT_EVENT
19 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
21 #include "php_http_api.h"
22 #include "php_http_exception_object.h"
23 #include "php_http_persistent_handle_api.h"
24 #include "php_http_request_api.h"
25 #include "php_http_request_object.h"
26 #include "php_http_request_pool_api.h"
27 #include "php_http_requestpool_object.h"
29 #ifndef HTTP_DEBUG_REQPOOLS
30 # define HTTP_DEBUG_REQPOOLS 0
33 #ifdef HTTP_HAVE_EVENT
34 typedef struct _http_request_pool_event_t
{
36 http_request_pool
*pool
;
37 } http_request_pool_event
;
39 static inline void http_request_pool_update_timeout(http_request_pool
*pool
);
40 static void http_request_pool_timeout_callback(int socket
, short action
, void *event_data
);
41 static void http_request_pool_event_callback(int socket
, short action
, void *event_data
);
42 static int http_request_pool_socket_callback(CURL
*easy
, curl_socket_t s
, int action
, void *, void *);
45 static int http_request_pool_compare_handles(void *h1
, void *h2
);
47 PHP_MINIT_FUNCTION(http_request_pool
)
49 if (SUCCESS
!= http_persistent_handle_provide("http_request_pool", curl_multi_init
, (http_persistent_handle_dtor
) curl_multi_cleanup
, NULL
)) {
55 #ifdef HTTP_HAVE_EVENT
56 PHP_RINIT_FUNCTION(http_request_pool
)
58 if (!HTTP_G
->request
.pool
.event
.base
&& !(HTTP_G
->request
.pool
.event
.base
= event_init())) {
66 /* {{{ http_request_pool *http_request_pool_init(http_request_pool *) */
67 PHP_HTTP_API http_request_pool
*_http_request_pool_init(http_request_pool
*pool TSRMLS_DC
)
71 #if HTTP_DEBUG_REQPOOLS
72 fprintf(stderr
, "Initializing request pool %p\n", pool
);
75 if ((free_pool
= (!pool
))) {
76 pool
= emalloc(sizeof(http_request_pool
));
80 if (SUCCESS
!= http_persistent_handle_acquire("http_request_pool", &pool
->ch
)) {
87 TSRMLS_SET_CTX(pool
->tsrm_ls
);
90 pool
->timeout
= ecalloc(1, sizeof(struct event
));
91 curl_multi_setopt(pool
->ch
, CURLMOPT_SOCKETDATA
, pool
);
92 curl_multi_setopt(pool
->ch
, CURLMOPT_SOCKETFUNCTION
, http_request_pool_socket_callback
);
96 zend_llist_init(&pool
->finished
, sizeof(zval
*), (llist_dtor_func_t
) ZVAL_PTR_DTOR
, 0);
97 zend_llist_init(&pool
->handles
, sizeof(zval
*), (llist_dtor_func_t
) ZVAL_PTR_DTOR
, 0);
99 #if HTTP_DEBUG_REQPOOLS
100 fprintf(stderr
, "Initialized request pool %p\n", pool
);
107 /* {{{ STATUS http_request_pool_attach(http_request_pool *, zval *) */
108 PHP_HTTP_API STATUS
_http_request_pool_attach(http_request_pool
*pool
, zval
*request
)
110 TSRMLS_FETCH_FROM_CTX(pool
->tsrm_ls
);
111 getObjectEx(http_request_object
, req
, request
);
113 #if HTTP_DEBUG_REQPOOLS
114 fprintf(stderr
, "Attaching HttpRequest(#%d) %p to pool %p\n", Z_OBJ_HANDLE_P(request
), req
, pool
);
118 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "HttpRequest object(#%d) is already member of %s HttpRequestPool", Z_OBJ_HANDLE_P(request
), req
->pool
== pool
? "this" : "another");
119 } else if (SUCCESS
!= http_request_object_requesthandler(req
, request
)) {
120 http_error_ex(HE_WARNING
, HTTP_E_REQUEST
, "Could not initialize HttpRequest object(#%d) for attaching to the HttpRequestPool", Z_OBJ_HANDLE_P(request
));
122 CURLMcode code
= curl_multi_add_handle(pool
->ch
, req
->request
->ch
);
124 if ((CURLM_OK
!= code
) && (CURLM_CALL_MULTI_PERFORM
!= code
)) {
125 http_error_ex(HE_WARNING
, HTTP_E_REQUEST_POOL
, "Could not attach HttpRequest object(#%d) to the HttpRequestPool: %s", Z_OBJ_HANDLE_P(request
), curl_multi_strerror(code
));
129 ZVAL_ADDREF(request
);
130 zend_llist_add_element(&pool
->handles
, &request
);
132 #if HTTP_DEBUG_REQPOOLS
133 fprintf(stderr
, "> %d HttpRequests attached to pool %p\n", zend_llist_count(&pool
->handles
), pool
);
142 /* {{{ STATUS http_request_pool_detach(http_request_pool *, zval *) */
143 PHP_HTTP_API STATUS
_http_request_pool_detach(http_request_pool
*pool
, zval
*request
)
146 TSRMLS_FETCH_FROM_CTX(pool
->tsrm_ls
);
147 getObjectEx(http_request_object
, req
, request
);
149 #if HTTP_DEBUG_REQPOOLS
150 fprintf(stderr
, "Detaching HttpRequest(#%d) %p from pool %p\n", Z_OBJ_HANDLE_P(request
), req
, pool
);
154 /* not attached to any pool */
155 #if HTTP_DEBUG_REQPOOLS
156 fprintf(stderr
, "HttpRequest object(#%d) %p is not attached to any HttpRequestPool\n", Z_OBJ_HANDLE_P(request
), req
);
158 } else if (req
->pool
!= pool
) {
159 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "HttpRequest object(#%d) is not attached to this HttpRequestPool", Z_OBJ_HANDLE_P(request
));
160 } else if (req
->request
->_in_progress_cb
) {
161 http_error_ex(HE_WARNING
, HTTP_E_REQUEST_POOL
, "HttpRequest object(#%d) cannot be detached from the HttpRequestPool while executing the progress callback", Z_OBJ_HANDLE_P(request
));
162 } else if (CURLM_OK
!= (code
= curl_multi_remove_handle(pool
->ch
, req
->request
->ch
))) {
163 http_error_ex(HE_WARNING
, HTTP_E_REQUEST_POOL
, "Could not detach HttpRequest object(#%d) from the HttpRequestPool: %s", Z_OBJ_HANDLE_P(request
), curl_multi_strerror(code
));
166 zend_llist_del_element(&pool
->finished
, request
, http_request_pool_compare_handles
);
167 zend_llist_del_element(&pool
->handles
, request
, http_request_pool_compare_handles
);
169 #if HTTP_DEBUG_REQPOOLS
170 fprintf(stderr
, "> %d HttpRequests remaining in pool %p\n", zend_llist_count(&pool
->handles
), pool
);
179 /* {{{ void http_request_pool_apply(http_request_pool *, http_request_pool_apply_func) */
180 PHP_HTTP_API
void _http_request_pool_apply(http_request_pool
*pool
, http_request_pool_apply_func cb
)
182 int count
= zend_llist_count(&pool
->handles
);
186 zend_llist_position pos
;
187 zval
**handle
, **handles
= emalloc(count
* sizeof(zval
*));
189 for (handle
= zend_llist_get_first_ex(&pool
->handles
, &pos
); handle
; handle
= zend_llist_get_next_ex(&pool
->handles
, &pos
)) {
190 handles
[i
++] = *handle
;
193 /* should never happen */
195 zend_error(E_ERROR
, "number of fetched request handles do not match overall count");
199 for (i
= 0; i
< count
; ++i
) {
200 if (cb(pool
, handles
[i
])) {
209 /* {{{ void http_request_pool_apply_with_arg(http_request_pool *, http_request_pool_apply_with_arg_func, void *) */
210 PHP_HTTP_API
void _http_request_pool_apply_with_arg(http_request_pool
*pool
, http_request_pool_apply_with_arg_func cb
, void *arg
)
212 int count
= zend_llist_count(&pool
->handles
);
216 zend_llist_position pos
;
217 zval
**handle
, **handles
= emalloc(count
* sizeof(zval
*));
219 for (handle
= zend_llist_get_first_ex(&pool
->handles
, &pos
); handle
; handle
= zend_llist_get_next_ex(&pool
->handles
, &pos
)) {
220 handles
[i
++] = *handle
;
223 /* should never happen */
225 zend_error(E_ERROR
, "number of fetched request handles do not match overall count");
229 for (i
= 0; i
< count
; ++i
) {
230 if (cb(pool
, handles
[i
], arg
)) {
239 /* {{{ void http_request_pool_detach_all(http_request_pool *) */
240 PHP_HTTP_API
void _http_request_pool_detach_all(http_request_pool
*pool
)
242 #if HTTP_DEBUG_REQPOOLS
243 fprintf(stderr
, "Detaching %d requests from pool %p\n", zend_llist_count(&pool
->handles
), pool
);
245 http_request_pool_apply(pool
, _http_request_pool_detach
);
249 /* {{{ STATUS http_request_pool_send(http_request_pool *) */
250 PHP_HTTP_API STATUS
_http_request_pool_send(http_request_pool
*pool
)
252 TSRMLS_FETCH_FROM_CTX(pool
->tsrm_ls
);
254 #if HTTP_DEBUG_REQPOOLS
255 fprintf(stderr
, "Attempt to send %d requests of pool %p\n", zend_llist_count(&pool
->handles
), pool
);
258 #ifdef HTTP_HAVE_EVENT
259 while (CURLM_CALL_MULTI_PERFORM
== curl_multi_socket_all(pool
->ch
, &pool
->unfinished
));
260 http_request_pool_update_timeout(pool
);
262 event_base_dispatch(HTTP_G
->request
.pool
.event
.base
);
264 while (http_request_pool_perform(pool
)) {
265 if (SUCCESS
!= http_request_pool_select(pool
)) {
267 /* see http://msdn.microsoft.com/library/en-us/winsock/winsock/windows_sockets_error_codes_2.asp */
268 http_error_ex(HE_WARNING
, HTTP_E_SOCKET
, "WinSock error: %d", WSAGetLastError());
270 http_error(HE_WARNING
, HTTP_E_SOCKET
, strerror(errno
));
277 #if HTTP_DEBUG_REQPOOLS
278 fprintf(stderr
, "Finished sending %d HttpRequests of pool %p (still unfinished: %d)\n", zend_llist_count(&pool
->handles
), pool
, pool
->unfinished
);
285 /* {{{ void http_request_pool_dtor(http_request_pool *) */
286 PHP_HTTP_API
void _http_request_pool_dtor(http_request_pool
*pool
)
288 TSRMLS_FETCH_FROM_CTX(pool
->tsrm_ls
);
290 #if HTTP_DEBUG_REQPOOLS
291 fprintf(stderr
, "Destructing request pool %p\n", pool
);
295 efree(pool
->timeout
);
298 pool
->unfinished
= 0;
299 zend_llist_clean(&pool
->finished
);
300 zend_llist_clean(&pool
->handles
);
301 http_persistent_handle_release("http_request_pool", &pool
->ch
);
306 # define SELECT_ERROR SOCKET_ERROR
308 # define SELECT_ERROR -1
311 /* {{{ STATUS http_request_pool_select(http_request_pool *) */
312 PHP_HTTP_API STATUS
_http_request_pool_select(http_request_pool
*pool
)
314 #ifdef HTTP_HAVE_EVENT
315 TSRMLS_FETCH_FROM_CTX(pool
->tsrm_ls
);
316 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "not implemented; use HttpRequest::onProgress callback");
321 struct timeval timeout
;
323 http_request_pool_timeout(pool
, &timeout
);
329 if (CURLM_OK
== curl_multi_fdset(pool
->ch
, &R
, &W
, &E
, &MAX
)) {
331 http_sleep((double) timeout
.tv_sec
+ (double) (timeout
.tv_usec
/ HTTP_MCROSEC
));
333 } else if (SELECT_ERROR
!= select(MAX
+ 1, &R
, &W
, &E
, &timeout
)) {
342 /* {{{ int http_request_pool_perform(http_request_pool *) */
343 PHP_HTTP_API
int _http_request_pool_perform(http_request_pool
*pool
)
345 TSRMLS_FETCH_FROM_CTX(pool
->tsrm_ls
);
346 #ifdef HTTP_HAVE_EVENT
347 http_error(HE_WARNING
, HTTP_E_RUNTIME
, "not implemented; use HttpRequest::onProgress callback");
353 while (CURLM_CALL_MULTI_PERFORM
== curl_multi_perform(pool
->ch
, &pool
->unfinished
));
355 http_request_pool_response_handler(pool
);
357 return pool
->unfinished
;
362 /* {{{ void http_request_pool_responsehandler(http_request_pool *) */
363 void _http_request_pool_responsehandler(http_request_pool
*pool
)
367 TSRMLS_FETCH_FROM_CTX(pool
->tsrm_ls
);
370 msg
= curl_multi_info_read(pool
->ch
, &remaining
);
371 if (msg
&& CURLMSG_DONE
== msg
->msg
) {
372 if (CURLE_OK
!= msg
->data
.result
) {
373 http_request
*r
= NULL
;
374 curl_easy_getinfo(msg
->easy_handle
, CURLINFO_PRIVATE
, &r
);
375 http_error_ex(HE_WARNING
, HTTP_E_REQUEST
, "%s; %s (%s)", curl_easy_strerror(msg
->data
.result
), r
?r
->_error
:"", r
?r
->url
:"");
377 http_request_pool_apply_with_arg(pool
, _http_request_pool_apply_responsehandler
, msg
->easy_handle
);
383 /* {{{ int http_request_pool_apply_responsehandler(http_request_pool *, zval *, void *) */
384 int _http_request_pool_apply_responsehandler(http_request_pool
*pool
, zval
*req
, void *ch
)
386 TSRMLS_FETCH_FROM_CTX(pool
->tsrm_ls
);
387 getObjectEx(http_request_object
, obj
, req
);
389 if ((!ch
) || obj
->request
->ch
== (CURL
*) ch
) {
391 #if HTTP_DEBUG_REQPOOLS
392 fprintf(stderr
, "Fetching data from HttpRequest(#%d) %p of pool %p\n", Z_OBJ_HANDLE_P(req
), obj
, obj
->pool
);
396 zend_llist_add_element(&obj
->pool
->finished
, &req
);
397 http_request_object_responsehandler(obj
, req
);
404 /* {{{ struct timeval *_http_request_pool_timeout(http_request_pool *, struct timeval *) */
405 struct timeval
*_http_request_pool_timeout(http_request_pool
*pool
, struct timeval
*timeout
)
407 #ifdef HAVE_CURL_MULTI_TIMEOUT
408 long max_tout
= 1000;
410 if ((CURLM_OK
== curl_multi_timeout(pool
->ch
, &max_tout
)) && (max_tout
!= -1)) {
411 timeout
->tv_sec
= max_tout
/ 1000;
412 timeout
->tv_usec
= (max_tout
% 1000) * 1000;
416 timeout
->tv_usec
= 0;
417 #ifdef HAVE_CURL_MULTI_TIMEOUT
421 #if HTTP_DEBUG_REQPOOLS
422 fprintf(stderr
, "Calculating timeout (%lu, %lu) of pool %p\n", (ulong
) timeout
->tv_sec
, (ulong
) timeout
->tv_usec
, pool
);
431 /* {{{ static int http_request_pool_compare_handles(void *, void *) */
432 static int http_request_pool_compare_handles(void *h1
, void *h2
)
434 return (Z_OBJ_HANDLE_PP((zval
**) h1
) == Z_OBJ_HANDLE_P((zval
*) h2
));
438 #ifdef HTTP_HAVE_EVENT
439 /* {{{ static void http_request_pool_update_timeout(http_request_pool *) */
440 static inline void http_request_pool_update_timeout(http_request_pool
*pool
)
442 struct timeval timeout
;
443 TSRMLS_FETCH_FROM_CTX(pool
->tsrm_ls
);
445 if (event_initialized(pool
->timeout
)) {
446 event_del(pool
->timeout
);
449 if (pool
->unfinished
) {
450 event_set(pool
->timeout
, -1, 0, http_request_pool_timeout_callback
, pool
);
451 event_base_set(HTTP_G
->request
.pool
.event
.base
, pool
->timeout
);
452 event_add(pool
->timeout
, http_request_pool_timeout(pool
, &timeout
));
454 #if HTTP_DEBUG_REQPOOLS
455 fprintf(stderr
, "Updating timeout (%lu, %lu) of pool %p\n", (ulong
) timeout
.tv_sec
, (ulong
) timeout
.tv_usec
, pool
);
458 #if HTTP_DEBUG_REQPOOLS
459 else fprintf(stderr
, "Removed timeout of pool %p\n", pool
);
464 /* {{{ static void http_request_pool_timeout_callback(int, short, void *) */
465 static void http_request_pool_timeout_callback(int socket
, short action
, void *event_data
)
468 http_request_pool
*pool
= event_data
;
469 TSRMLS_FETCH_FROM_CTX(pool
->tsrm_ls
);
471 #if HTTP_DEBUG_REQPOOLS
472 fprintf(stderr
, "Timeout occurred of pool %p\n", pool
);
475 while (CURLM_CALL_MULTI_PERFORM
== (rc
= curl_multi_socket(pool
->ch
, CURL_SOCKET_TIMEOUT
, &pool
->unfinished
)));
477 if (CURLM_OK
!= rc
) {
478 http_error(HE_WARNING
, HTTP_E_SOCKET
, curl_multi_strerror(rc
));
481 http_request_pool_update_timeout(pool
);
485 /* {{{ static void http_request_pool_event_callback(int, short, void *) */
486 static void http_request_pool_event_callback(int socket
, short action
, void *event_data
)
488 CURLMcode rc
= CURLE_OK
;
489 http_request_pool_event
*ev
= event_data
;
490 http_request_pool
*pool
= ev
->pool
;
491 TSRMLS_FETCH_FROM_CTX(ev
->pool
->tsrm_ls
);
493 #if HTTP_DEBUG_REQPOOLS
495 static const char event_strings
[][20] = {"NONE","TIMEOUT","READ","TIMEOUT|READ","WRITE","TIMEOUT|WRITE","READ|WRITE","TIMEOUT|READ|WRITE","SIGNAL"};
496 fprintf(stderr
, "Event on socket %d (%s) event %p of pool %p\n", socket
, event_strings
[action
], ev
, pool
);
500 /* don't use 'ev' below this loop as it might 've been freed in the socket callback */
502 #ifdef HAVE_CURL_MULTI_SOCKET_ACTION
503 switch (action
& (EV_READ
|EV_WRITE
)) {
505 rc
= curl_multi_socket_action(pool
->ch
, socket
, CURL_CSELECT_IN
, &pool
->unfinished
);
508 rc
= curl_multi_socket_action(pool
->ch
, socket
, CURL_CSELECT_OUT
, &pool
->unfinished
);
510 case EV_READ
|EV_WRITE
:
511 rc
= curl_multi_socket_action(pool
->chm socket
, CURL_CSELECT_IN
|CURL_CSELECT_OUT
, &pool
->unfinished
);
514 http_error(HE_WARNING
, HTTP_E_SOCKET
, "Unknown event %d", (int) action
);
518 rc
= curl_multi_socket(pool
->ch
, socket
, &pool
->unfinished
);
520 } while (CURLM_CALL_MULTI_PERFORM
== rc
);
522 if (CURLM_OK
!= rc
) {
523 http_error(HE_WARNING
, HTTP_E_SOCKET
, curl_multi_strerror(rc
));
526 http_request_pool_responsehandler(pool
);
528 if (!pool
->unfinished
) {
529 http_request_pool_update_timeout(pool
);
534 /* {{{ static int http_request_pool_socket_callback(CURL *, curl_socket_t, int, void *, void *) */
535 static int http_request_pool_socket_callback(CURL
*easy
, curl_socket_t sock
, int action
, void *socket_data
, void *assign_data
)
537 int events
= EV_PERSIST
;
538 http_request_pool
*pool
= socket_data
;
539 http_request_pool_event
*ev
= assign_data
;
540 TSRMLS_FETCH_FROM_CTX(pool
->tsrm_ls
);
543 ev
= ecalloc(1, sizeof(http_request_pool_event
));
545 curl_multi_assign(pool
->ch
, sock
, ev
);
547 event_del(&ev
->evnt
);
550 #if HTTP_DEBUG_REQPOOLS
552 static const char action_strings
[][8] = {"NONE", "IN", "OUT", "INOUT", "REMOVE"};
553 fprintf(stderr
, "Callback on socket %d (%s) event %p of pool %p\n", (int) sock
, action_strings
[action
], ev
, pool
);
564 case CURL_POLL_INOUT
:
565 events
|= EV_READ
|EV_WRITE
;
568 case CURL_POLL_REMOVE
:
574 http_error_ex(HE_WARNING
, HTTP_E_SOCKET
, "Unknown socket action %d", action
);
578 event_set(&ev
->evnt
, sock
, events
, http_request_pool_event_callback
, ev
);
579 event_base_set(HTTP_G
->request
.pool
.event
.base
, &ev
->evnt
);
580 event_add(&ev
->evnt
, NULL
);
585 #endif /* HTTP_HAVE_EVENT */
587 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
595 * vim600: noet sw=4 ts=4 fdm=marker
596 * vim<600: noet sw=4 ts=4