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-2011, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
13 #include "php_http_api.h"
15 PHP_HTTP_API php_http_client_pool_t
*php_http_client_pool_init(php_http_client_pool_t
*h
, php_http_client_pool_ops_t
*ops
, php_http_resource_factory_t
*rf
, void *init_arg TSRMLS_DC
)
17 php_http_client_pool_t
*free_h
= NULL
;
20 free_h
= h
= emalloc(sizeof(*h
));
22 memset(h
, 0, sizeof(*h
));
27 } else if (ops
->rsrc
) {
28 h
->rf
= php_http_resource_factory_init(NULL
, h
->ops
->rsrc
, h
, NULL
);
30 zend_llist_init(&h
->clients
.attached
, sizeof(zval
*), (llist_dtor_func_t
) ZVAL_PTR_DTOR
, 0);
31 zend_llist_init(&h
->clients
.finished
, sizeof(zval
*), (llist_dtor_func_t
) ZVAL_PTR_DTOR
, 0);
32 TSRMLS_SET_CTX(h
->ts
);
35 if (!(h
= h
->ops
->init(h
, init_arg
))) {
36 php_http_error(HE_WARNING
, PHP_HTTP_E_CLIENT_POOL
, "Could not initialize request pool");
46 PHP_HTTP_API php_http_client_pool_t
*php_http_client_pool_copy(php_http_client_pool_t
*from
, php_http_client_pool_t
*to
)
48 if (from
->ops
->copy
) {
49 return from
->ops
->copy(from
, to
);
55 PHP_HTTP_API
void php_http_client_pool_dtor(php_http_client_pool_t
*h
)
61 zend_llist_clean(&h
->clients
.finished
);
62 zend_llist_clean(&h
->clients
.attached
);
64 php_http_resource_factory_free(&h
->rf
);
67 PHP_HTTP_API
void php_http_client_pool_free(php_http_client_pool_t
**h
) {
69 php_http_client_pool_dtor(*h
);
75 PHP_HTTP_API STATUS
php_http_client_pool_attach(php_http_client_pool_t
*h
, zval
*client
)
77 TSRMLS_FETCH_FROM_CTX(h
->ts
);
81 php_http_client_object_t
*obj
;
82 php_http_message_object_t
*msg_obj
;
84 if (SUCCESS
!= php_http_client_object_handle_request(client
, &zreq TSRMLS_CC
)) {
88 obj
= zend_object_store_get_object(client TSRMLS_CC
);
89 msg_obj
= zend_object_store_get_object(zreq TSRMLS_CC
);
91 if (SUCCESS
== h
->ops
->attach(h
, obj
->client
, msg_obj
->message
)) {
93 zend_llist_add_element(&h
->clients
.attached
, &client
);
101 static int php_http_client_pool_compare_handles(void *h1
, void *h2
)
103 return (Z_OBJ_HANDLE_PP((zval
**) h1
) == Z_OBJ_HANDLE_P((zval
*) h2
));
107 PHP_HTTP_API STATUS
php_http_client_pool_detach(php_http_client_pool_t
*h
, zval
*client
)
109 TSRMLS_FETCH_FROM_CTX(h
->ts
);
111 if (h
->ops
->detach
) {
112 php_http_client_object_t
*obj
= zend_object_store_get_object(client TSRMLS_CC
);
114 if (SUCCESS
== h
->ops
->detach(h
, obj
->client
)) {
115 zend_llist_del_element(&h
->clients
.finished
, client
, php_http_client_pool_compare_handles
);
116 zend_llist_del_element(&h
->clients
.attached
, client
, php_http_client_pool_compare_handles
);
124 PHP_HTTP_API STATUS
php_http_client_pool_wait(php_http_client_pool_t
*h
, struct timeval
*custom_timeout
)
127 return h
->ops
->wait(h
, custom_timeout
);
133 PHP_HTTP_API
int php_http_client_pool_once(php_http_client_pool_t
*h
)
136 return h
->ops
->once(h
);
142 PHP_HTTP_API STATUS
php_http_client_pool_exec(php_http_client_pool_t
*h
)
145 return h
->ops
->exec(h
);
151 static void detach(void *r
, void *h TSRMLS_DC
)
153 ((php_http_client_pool_t
*) h
)->ops
->detach(h
, ((php_http_client_object_t
*) zend_object_store_get_object(*((zval
**) r
) TSRMLS_CC
))->client
);
156 PHP_HTTP_API
void php_http_client_pool_reset(php_http_client_pool_t
*h
)
160 } else if (h
->ops
->detach
) {
161 TSRMLS_FETCH_FROM_CTX(h
->ts
);
163 zend_llist_apply_with_argument(&h
->clients
.attached
, detach
, h TSRMLS_CC
);
166 zend_llist_clean(&h
->clients
.attached
);
167 zend_llist_clean(&h
->clients
.finished
);
170 PHP_HTTP_API STATUS
php_http_client_pool_setopt(php_http_client_pool_t
*h
, php_http_client_pool_setopt_opt_t opt
, void *arg
)
172 if (h
->ops
->setopt
) {
173 return h
->ops
->setopt(h
, opt
, arg
);
179 PHP_HTTP_API
void php_http_client_pool_requests(php_http_client_pool_t
*h
, zval
***attached
, zval
***finished
)
185 if ((count
= zend_llist_count(&h
->clients
.attached
))) {
186 *attached
= ecalloc(count
+ 1 /* terminating NULL */, sizeof(zval
*));
188 for (i
= 0, handle
= zend_llist_get_first(&h
->clients
.attached
); handle
; handle
= zend_llist_get_next(&h
->clients
.attached
)) {
190 (*attached
)[i
++] = *handle
;
198 if ((count
= zend_llist_count(&h
->clients
.finished
))) {
199 *finished
= ecalloc(count
+ 1 /* terminating NULL */, sizeof(zval
*));
201 for (i
= 0, handle
= zend_llist_get_first(&h
->clients
.finished
); handle
; handle
= zend_llist_get_next(&h
->clients
.finished
)) {
203 (*finished
)[i
++] = *handle
;
213 #define PHP_HTTP_BEGIN_ARGS(method, req_args) PHP_HTTP_BEGIN_ARGS_EX(HttpClientPool, method, 0, req_args)
214 #define PHP_HTTP_EMPTY_ARGS(method) PHP_HTTP_EMPTY_ARGS_EX(HttpClientPool, method, 0)
215 #define PHP_HTTP_CLIENT_POOL_ME(method, visibility) PHP_ME(HttpClientPool, method, PHP_HTTP_ARGS(HttpClientPool, method), visibility)
217 PHP_HTTP_EMPTY_ARGS(__destruct
);
218 PHP_HTTP_EMPTY_ARGS(reset
);
220 PHP_HTTP_BEGIN_ARGS(attach
, 1)
221 PHP_HTTP_ARG_OBJ(http
\\Client
\\AbstractClient
, request
, 0)
224 PHP_HTTP_BEGIN_ARGS(detach
, 1)
225 PHP_HTTP_ARG_OBJ(http
\\Client
\\AbstractClient
, request
, 0)
228 PHP_HTTP_EMPTY_ARGS(send
);
229 PHP_HTTP_EMPTY_ARGS(once
);
230 PHP_HTTP_BEGIN_ARGS(wait
, 0)
231 PHP_HTTP_ARG_VAL(timeout
, 0)
234 PHP_HTTP_EMPTY_ARGS(valid
);
235 PHP_HTTP_EMPTY_ARGS(current
);
236 PHP_HTTP_EMPTY_ARGS(key
);
237 PHP_HTTP_EMPTY_ARGS(next
);
238 PHP_HTTP_EMPTY_ARGS(rewind
);
240 PHP_HTTP_EMPTY_ARGS(count
);
242 PHP_HTTP_EMPTY_ARGS(getAttached
);
243 PHP_HTTP_EMPTY_ARGS(getFinished
);
245 PHP_HTTP_BEGIN_ARGS(enablePipelining
, 0)
246 PHP_HTTP_ARG_VAL(enable
, 0)
249 PHP_HTTP_BEGIN_ARGS(enableEvents
, 0)
250 PHP_HTTP_ARG_VAL(enable
, 0)
253 static zend_class_entry
*php_http_client_pool_class_entry
;
255 zend_class_entry
*php_http_client_pool_get_class_entry(void)
257 return php_http_client_pool_class_entry
;
260 static zend_function_entry php_http_client_pool_method_entry
[] = {
261 PHP_HTTP_CLIENT_POOL_ME(__destruct
, ZEND_ACC_PUBLIC
|ZEND_ACC_DTOR
)
262 PHP_HTTP_CLIENT_POOL_ME(attach
, ZEND_ACC_PUBLIC
)
263 PHP_HTTP_CLIENT_POOL_ME(detach
, ZEND_ACC_PUBLIC
)
264 PHP_HTTP_CLIENT_POOL_ME(send
, ZEND_ACC_PUBLIC
)
265 PHP_HTTP_CLIENT_POOL_ME(reset
, ZEND_ACC_PUBLIC
)
267 PHP_HTTP_CLIENT_POOL_ME(once
, ZEND_ACC_PROTECTED
)
268 PHP_HTTP_CLIENT_POOL_ME(wait
, ZEND_ACC_PROTECTED
)
270 /* implements Iterator */
271 PHP_HTTP_CLIENT_POOL_ME(valid
, ZEND_ACC_PUBLIC
)
272 PHP_HTTP_CLIENT_POOL_ME(current
, ZEND_ACC_PUBLIC
)
273 PHP_HTTP_CLIENT_POOL_ME(key
, ZEND_ACC_PUBLIC
)
274 PHP_HTTP_CLIENT_POOL_ME(next
, ZEND_ACC_PUBLIC
)
275 PHP_HTTP_CLIENT_POOL_ME(rewind
, ZEND_ACC_PUBLIC
)
277 /* implmenents Countable */
278 PHP_HTTP_CLIENT_POOL_ME(count
, ZEND_ACC_PUBLIC
)
280 PHP_HTTP_CLIENT_POOL_ME(getAttached
, ZEND_ACC_PUBLIC
)
281 PHP_HTTP_CLIENT_POOL_ME(getFinished
, ZEND_ACC_PUBLIC
)
283 PHP_HTTP_CLIENT_POOL_ME(enablePipelining
, ZEND_ACC_PUBLIC
)
284 PHP_HTTP_CLIENT_POOL_ME(enableEvents
, ZEND_ACC_PUBLIC
)
289 static zend_object_handlers php_http_client_pool_object_handlers
;
291 extern zend_object_handlers
*php_http_client_pool_get_object_handlers(void)
293 return &php_http_client_pool_object_handlers
;
296 static php_http_client_pool_ops_t php_http_client_pool_user_ops
= {
308 (php_http_new_t
) php_http_client_pool_object_new_ex
,
309 php_http_client_pool_get_class_entry
312 zend_object_value
php_http_client_pool_object_new(zend_class_entry
*ce TSRMLS_DC
)
314 return php_http_client_pool_object_new_ex(ce
, NULL
, NULL TSRMLS_CC
);
317 zend_object_value
php_http_client_pool_object_new_ex(zend_class_entry
*ce
, php_http_client_pool_t
*p
, php_http_client_pool_object_t
**ptr TSRMLS_DC
)
319 zend_object_value ov
;
320 php_http_client_pool_object_t
*o
;
322 o
= ecalloc(1, sizeof(php_http_client_pool_object_t
));
323 zend_object_std_init((zend_object
*) o
, ce TSRMLS_CC
);
324 object_properties_init((zend_object
*) o
, ce
);
326 if (!(o
->pool
= p
)) {
327 o
->pool
= php_http_client_pool_init(NULL
, &php_http_client_pool_user_ops
, NULL
, NULL TSRMLS_CC
);
334 ov
.handle
= zend_objects_store_put(o
, NULL
, php_http_client_pool_object_free
, NULL TSRMLS_CC
);
335 ov
.handlers
= &php_http_client_pool_object_handlers
;
340 void php_http_client_pool_object_free(void *object TSRMLS_DC
)
342 php_http_client_pool_object_t
*o
= (php_http_client_pool_object_t
*) object
;
344 php_http_client_pool_free(&o
->pool
);
345 zend_object_std_dtor((zend_object
*) o TSRMLS_CC
);
349 static void php_http_client_pool_object_llist2array(zval
**req
, zval
*array TSRMLS_DC
)
352 add_next_index_zval(array
, *req
);
355 PHP_METHOD(HttpClientPool
, __destruct
)
357 php_http_client_pool_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
359 if (SUCCESS
!= zend_parse_parameters_none()) {
360 ; /* we always want to clean up */
362 /* FIXME: move to php_http_client_pool_dtor */
363 php_http_client_pool_reset(obj
->pool
);
366 PHP_METHOD(HttpClientPool
, reset
)
368 if (SUCCESS
== zend_parse_parameters_none()) {
369 php_http_client_pool_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
371 obj
->iterator
.pos
= 0;
372 php_http_client_pool_reset(obj
->pool
);
374 RETVAL_ZVAL(getThis(), 1, 0);
377 PHP_METHOD(HttpClientPool
, attach
)
379 with_error_handling(EH_THROW
, php_http_exception_class_entry
) {
382 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "O", &request
, php_http_client_get_class_entry())) {
383 with_error_handling(EH_THROW
, php_http_exception_class_entry
) {
384 php_http_client_pool_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
386 if (obj
->iterator
.pos
> 0 && obj
->iterator
.pos
< zend_llist_count(&obj
->pool
->clients
.attached
)) {
387 php_http_error(HE_THROW
, PHP_HTTP_E_CLIENT_POOL
, "Cannot attach to the HttpClientPool while the iterator is active");
389 php_http_client_pool_attach(obj
->pool
, request
);
391 } end_error_handling();
393 } end_error_handling();
395 RETVAL_ZVAL(getThis(), 1, 0);
398 PHP_METHOD(HttpClientPool
, detach
)
402 with_error_handling(EH_THROW
, php_http_exception_class_entry
) {
405 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "O", &request
, php_http_client_get_class_entry())) {
406 with_error_handling(EH_THROW
, php_http_exception_class_entry
) {
407 php_http_client_pool_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
409 obj
->iterator
.pos
= -1;
410 php_http_client_pool_detach(obj
->pool
, request
);
411 } end_error_handling();
413 } end_error_handling();
415 RETVAL_ZVAL(getThis(), 1, 0);
418 PHP_METHOD(HttpClientPool
, send
)
422 with_error_handling(EH_THROW
, php_http_exception_class_entry
) {
423 if (SUCCESS
== zend_parse_parameters_none()) {
424 with_error_handling(EH_THROW
, php_http_exception_class_entry
) {
425 php_http_client_pool_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
427 php_http_client_pool_exec(obj
->pool
);
428 } end_error_handling();
430 } end_error_handling();
432 RETVAL_ZVAL(getThis(), 1, 0);
435 PHP_METHOD(HttpClientPool
, once
)
437 if (SUCCESS
== zend_parse_parameters_none()) {
438 php_http_client_pool_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
440 if (0 < php_http_client_pool_once(obj
->pool
)) {
447 PHP_METHOD(HttpClientPool
, wait
)
451 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|d", &timeout
)) {
452 struct timeval timeout_val
;
453 php_http_client_pool_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
455 timeout_val
.tv_sec
= (time_t) timeout
;
456 timeout_val
.tv_usec
= PHP_HTTP_USEC(timeout
) % PHP_HTTP_MCROSEC
;
458 RETURN_SUCCESS(php_http_client_pool_wait(obj
->pool
, timeout
> 0 ? &timeout_val
: NULL
));
463 PHP_METHOD(HttpClientPool
, valid
)
465 if (SUCCESS
== zend_parse_parameters_none()) {
466 php_http_client_pool_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
468 RETURN_BOOL(obj
->iterator
.pos
>= 0 && obj
->iterator
.pos
< zend_llist_count(&obj
->pool
->clients
.attached
));
473 PHP_METHOD(HttpClientPool
, current
)
475 if (SUCCESS
== zend_parse_parameters_none()) {
476 php_http_client_pool_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
478 if (obj
->iterator
.pos
< zend_llist_count(&obj
->pool
->clients
.attached
)) {
480 zval
**current
= NULL
;
481 zend_llist_position lpos
;
483 for ( current
= zend_llist_get_first_ex(&obj
->pool
->clients
.attached
, &lpos
);
484 current
&& obj
->iterator
.pos
!= pos
++;
485 current
= zend_llist_get_next_ex(&obj
->pool
->clients
.attached
, &lpos
));
487 RETURN_OBJECT(*current
, 1);
494 PHP_METHOD(HttpClientPool
, key
)
496 if (SUCCESS
== zend_parse_parameters_none()) {
497 php_http_client_pool_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
499 RETURN_LONG(obj
->iterator
.pos
);
504 PHP_METHOD(HttpClientPool
, next
)
506 if (SUCCESS
== zend_parse_parameters_none()) {
507 php_http_client_pool_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
513 PHP_METHOD(HttpClientPool
, rewind
)
515 if (SUCCESS
== zend_parse_parameters_none()) {
516 php_http_client_pool_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
518 obj
->iterator
.pos
= 0;
522 PHP_METHOD(HttpClientPool
, count
)
524 if (SUCCESS
== zend_parse_parameters_none()) {
525 php_http_client_pool_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
527 RETURN_LONG((long) zend_llist_count(&obj
->pool
->clients
.attached
));
531 PHP_METHOD(HttpClientPool
, getAttached
)
533 if (SUCCESS
== zend_parse_parameters_none()) {
534 php_http_client_pool_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
536 array_init(return_value
);
537 zend_llist_apply_with_argument(&obj
->pool
->clients
.attached
,
538 (llist_apply_with_arg_func_t
) php_http_client_pool_object_llist2array
,
539 return_value TSRMLS_CC
);
545 PHP_METHOD(HttpClientPool
, getFinished
)
547 if (SUCCESS
== zend_parse_parameters_none()) {
548 php_http_client_pool_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
550 array_init(return_value
);
551 zend_llist_apply_with_argument(&obj
->pool
->clients
.finished
,
552 (llist_apply_with_arg_func_t
) php_http_client_pool_object_llist2array
,
553 return_value TSRMLS_CC
);
559 PHP_METHOD(HttpClientPool
, enablePipelining
)
561 zend_bool enable
= 1;
563 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &enable
)) {
564 php_http_client_pool_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
566 php_http_client_pool_setopt(obj
->pool
, PHP_HTTP_CLIENT_POOL_OPT_ENABLE_PIPELINING
, &enable
);
568 RETVAL_ZVAL(getThis(), 1, 0);
571 PHP_METHOD(HttpClientPool
, enableEvents
)
573 zend_bool enable
= 1;
575 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &enable
)) {
576 php_http_client_pool_object_t
*obj
= zend_object_store_get_object(getThis() TSRMLS_CC
);
578 php_http_client_pool_setopt(obj
->pool
, PHP_HTTP_CLIENT_POOL_OPT_USE_EVENTS
, &enable
);
580 RETVAL_ZVAL(getThis(), 1, 0);
583 PHP_MINIT_FUNCTION(http_client_pool
)
585 PHP_HTTP_REGISTER_CLASS(http
\\Client
\\Pool
, AbstractPool
, http_client_pool
, php_http_object_class_entry
, 0);
586 php_http_client_pool_class_entry
->create_object
= php_http_client_pool_object_new
;
587 memcpy(&php_http_client_pool_object_handlers
, zend_get_std_object_handlers(), sizeof(zend_object_handlers
));
588 php_http_client_pool_object_handlers
.clone_obj
= NULL
;
590 zend_class_implements(php_http_client_pool_class_entry TSRMLS_CC
, 2, spl_ce_Countable
, zend_ce_iterator
);
601 * vim600: noet sw=4 ts=4 fdm=marker
602 * vim<600: noet sw=4 ts=4