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-2006, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
15 #define HTTP_WANT_CURL
18 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
20 #include "zend_interfaces.h"
22 #include "php_http_api.h"
23 #include "php_http_exception_object.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 #if defined(HAVE_SPL) && !defined(WONKY)
30 /* SPL doesn't install its headers */
31 extern PHPAPI zend_class_entry
*spl_ce_Countable
;
34 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpRequestPool, method, 0, req_args)
35 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpRequestPool, method, ret_ref)
36 #define HTTP_REQPOOL_ME(method, visibility) PHP_ME(HttpRequestPool, method, HTTP_ARGS(HttpRequestPool, method), visibility)
38 HTTP_BEGIN_ARGS(__construct
, 0)
39 HTTP_ARG_OBJ(HttpRequest
, request0
, 0)
40 HTTP_ARG_OBJ(HttpRequest
, request1
, 0)
41 HTTP_ARG_OBJ(HttpRequest
, requestN
, 0)
44 HTTP_EMPTY_ARGS(__destruct
, 0);
45 HTTP_EMPTY_ARGS(reset
, 0);
47 HTTP_BEGIN_ARGS(attach
, 1)
48 HTTP_ARG_OBJ(HttpRequest
, request
, 0)
51 HTTP_BEGIN_ARGS(detach
, 1)
52 HTTP_ARG_OBJ(HttpRequest
, request
, 0)
55 HTTP_EMPTY_ARGS(send
, 0);
56 HTTP_EMPTY_ARGS(socketPerform
, 0);
57 HTTP_EMPTY_ARGS(socketSelect
, 0);
59 HTTP_EMPTY_ARGS(valid
, 0);
60 HTTP_EMPTY_ARGS(current
, 1);
61 HTTP_EMPTY_ARGS(key
, 0);
62 HTTP_EMPTY_ARGS(next
, 0);
63 HTTP_EMPTY_ARGS(rewind
, 0);
65 HTTP_EMPTY_ARGS(count
, 0);
67 HTTP_EMPTY_ARGS(getAttachedRequests
, 0);
68 HTTP_EMPTY_ARGS(getFinishedRequests
, 0);
70 #define http_requestpool_object_declare_default_properties() _http_requestpool_object_declare_default_properties(TSRMLS_C)
71 static inline void _http_requestpool_object_declare_default_properties(TSRMLS_D
);
73 zend_class_entry
*http_requestpool_object_ce
;
74 zend_function_entry http_requestpool_object_fe
[] = {
75 HTTP_REQPOOL_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
76 HTTP_REQPOOL_ME(__destruct
, ZEND_ACC_PUBLIC
|ZEND_ACC_DTOR
)
77 HTTP_REQPOOL_ME(attach
, ZEND_ACC_PUBLIC
)
78 HTTP_REQPOOL_ME(detach
, ZEND_ACC_PUBLIC
)
79 HTTP_REQPOOL_ME(send
, ZEND_ACC_PUBLIC
)
80 HTTP_REQPOOL_ME(reset
, ZEND_ACC_PUBLIC
)
82 HTTP_REQPOOL_ME(socketPerform
, ZEND_ACC_PROTECTED
)
83 HTTP_REQPOOL_ME(socketSelect
, ZEND_ACC_PROTECTED
)
85 /* implements Iterator */
86 HTTP_REQPOOL_ME(valid
, ZEND_ACC_PUBLIC
)
87 HTTP_REQPOOL_ME(current
, ZEND_ACC_PUBLIC
)
88 HTTP_REQPOOL_ME(key
, ZEND_ACC_PUBLIC
)
89 HTTP_REQPOOL_ME(next
, ZEND_ACC_PUBLIC
)
90 HTTP_REQPOOL_ME(rewind
, ZEND_ACC_PUBLIC
)
92 /* implmenents Countable */
93 HTTP_REQPOOL_ME(count
, ZEND_ACC_PUBLIC
)
95 HTTP_REQPOOL_ME(getAttachedRequests
, ZEND_ACC_PUBLIC
)
96 HTTP_REQPOOL_ME(getFinishedRequests
, ZEND_ACC_PUBLIC
)
100 static zend_object_handlers http_requestpool_object_handlers
;
102 PHP_MINIT_FUNCTION(http_requestpool_object
)
104 HTTP_REGISTER_CLASS_EX(HttpRequestPool
, http_requestpool_object
, NULL
, 0);
105 #if defined(HAVE_SPL) && !defined(WONKY)
106 zend_class_implements(http_requestpool_object_ce TSRMLS_CC
, 2, spl_ce_Countable
, zend_ce_iterator
);
108 zend_class_implements(http_requestpool_object_ce TSRMLS_CC
, 1, zend_ce_iterator
);
111 http_requestpool_object_handlers
.clone_obj
= NULL
;
115 zend_object_value
_http_requestpool_object_new(zend_class_entry
*ce TSRMLS_DC
)
117 zend_object_value ov
;
118 http_requestpool_object
*o
;
120 o
= ecalloc(1, sizeof(http_requestpool_object
));
123 http_request_pool_init(&o
->pool
);
125 ALLOC_HASHTABLE(OBJ_PROP(o
));
126 zend_hash_init(OBJ_PROP(o
), 0, NULL
, ZVAL_PTR_DTOR
, 0);
127 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
129 ov
.handle
= putObject(http_requestpool_object
, o
);
130 ov
.handlers
= &http_requestpool_object_handlers
;
135 static inline void _http_requestpool_object_declare_default_properties(TSRMLS_D
)
137 zend_class_entry
*ce
= http_requestpool_object_ce
;
139 DCL_PROP_N(PROTECTED
, pool
);
142 void _http_requestpool_object_free(zend_object
*object TSRMLS_DC
)
144 http_requestpool_object
*o
= (http_requestpool_object
*) object
;
147 zend_hash_destroy(OBJ_PROP(o
));
148 FREE_HASHTABLE(OBJ_PROP(o
));
150 http_request_pool_dtor(&o
->pool
);
154 #define http_requestpool_object_llist2array _http_requestpool_object_llist2array
155 static void _http_requestpool_object_llist2array(zval
**req
, zval
*array TSRMLS_DC
)
158 add_next_index_zval(array
, *req
);
161 /* ### USERLAND ### */
163 /* {{{ proto void HttpRequestPool::__construct([HttpRequest request[, ...]])
165 * Instantiate a new HttpRequestPool object. An HttpRequestPool is
166 * able to send several HttpRequests in parallel.
168 * WARNING: Don't attach/detach HttpRequest objects to the HttpRequestPool
169 * object while you're using the implemented Iterator interface.
171 * Accepts virtual infinite optional parameters each referencing an
172 * HttpRequest object.
174 * Throws HttpRequestPoolException (HttpRequestException, HttpInvalidParamException).
180 * $pool = new HttpRequestPool(
181 * new HttpRequest('http://www.google.com/', HttpRequest::METH_HEAD),
182 * new HttpRequest('http://www.php.net/', HttpRequest::METH_HEAD)
185 * foreach($pool as $request) {
186 * printf("%s is %s (%d)\n",
187 * $request->getUrl(),
188 * $request->getResponseCode() ? 'alive' : 'not alive',
189 * $request->getResponseCode()
192 * } catch (HttpException $e) {
198 PHP_METHOD(HttpRequestPool
, __construct
)
200 int argc
= ZEND_NUM_ARGS();
201 zval
***argv
= safe_emalloc(argc
, sizeof(zval
*), 0);
202 getObject(http_requestpool_object
, obj
);
205 if (SUCCESS
== zend_get_parameters_array_ex(argc
, argv
)) {
208 for (i
= 0; i
< argc
; ++i
) {
209 if (Z_TYPE_PP(argv
[i
]) == IS_OBJECT
&& instanceof_function(Z_OBJCE_PP(argv
[i
]), http_request_object_ce TSRMLS_CC
)) {
210 http_request_pool_try
{
211 http_request_pool_attach(&obj
->pool
, *(argv
[i
]));
212 } http_request_pool_catch();
215 http_request_pool_final();
222 /* {{{ proto void HttpRequestPool::__destruct()
224 * Clean up HttpRequestPool object.
226 PHP_METHOD(HttpRequestPool
, __destruct
)
228 getObject(http_requestpool_object
, obj
);
232 http_request_pool_detach_all(&obj
->pool
);
236 /* {{{ proto void HttpRequestPool::reset()
238 * Detach all attached HttpRequest objects.
240 PHP_METHOD(HttpRequestPool
, reset
)
242 getObject(http_requestpool_object
, obj
);
246 obj
->iterator
.pos
= 0;
247 http_request_pool_detach_all(&obj
->pool
);
250 /* {{{ proto bool HttpRequestPool::attach(HttpRequest request)
252 * Attach an HttpRequest object to this HttpRequestPool.
253 * WARNING: set all options prior attaching!
255 * Expects the parameter to be an HttpRequest object not alread attached to
256 * antother HttpRequestPool object.
258 * Returns TRUE on success, or FALSE on failure.
260 * Throws HttpInvalidParamException, HttpRequestException,
261 * HttpRequestPoolException, HttpEncodingException.
263 PHP_METHOD(HttpRequestPool
, attach
)
266 STATUS status
= FAILURE
;
267 getObject(http_requestpool_object
, obj
);
270 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "O", &request
, http_request_object_ce
)) {
271 if (obj
->iterator
.pos
> 0 && obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
)) {
272 http_error(HE_THROW
, HTTP_E_REQUEST_POOL
, "Cannot attach to the HttpRequestPool while the iterator is active");
274 status
= http_request_pool_attach(&obj
->pool
, request
);
278 RETURN_SUCCESS(status
);
282 /* {{{ proto bool HttpRequestPool::detach(HttpRequest request)
284 * Detach an HttpRequest object from this HttpRequestPool.
286 * Expects the parameter to be an HttpRequest object attached to this
287 * HttpRequestPool object.
289 * Returns TRUE on success, or FALSE on failure.
291 * Throws HttpInvalidParamException, HttpRequestPoolException.
293 PHP_METHOD(HttpRequestPool
, detach
)
296 STATUS status
= FAILURE
;
297 getObject(http_requestpool_object
, obj
);
300 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "O", &request
, http_request_object_ce
)) {
301 obj
->iterator
.pos
= -1;
302 status
= http_request_pool_detach(&obj
->pool
, request
);
305 RETURN_SUCCESS(status
);
309 /* {{{ proto bool HttpRequestPool::send()
311 * Send all attached HttpRequest objects in parallel.
313 * Returns TRUE on success, or FALSE on failure.
315 * Throws HttpRequestPoolException (HttpSocketException, HttpRequestException, HttpMalformedHeaderException).
317 PHP_METHOD(HttpRequestPool
, send
)
320 getObject(http_requestpool_object
, obj
);
325 status
= http_request_pool_send(&obj
->pool
);
328 RETURN_SUCCESS(status
);
332 /* {{{ proto protected bool HttpRequestPool::socketPerform()
334 * Returns TRUE until each request has finished its transaction.
339 * class MyPool extends HttpRequestPool
341 * public function send()
343 * while ($this->socketPerform()) {
344 * if (!$this->socketSelect()) {
345 * throw new HttpSocketExcpetion;
350 * protected final function socketPerform()
352 * $result = parent::socketPerform();
353 * foreach ($this->getFinishedRequests() as $r) {
355 * // handle response of finished request
363 PHP_METHOD(HttpRequestPool
, socketPerform
)
365 getObject(http_requestpool_object
, obj
);
369 if (0 < http_request_pool_perform(&obj
->pool
)) {
377 /* {{{ proto protected bool HttpRequestPool::socketSelect()
379 * See HttpRequestPool::socketPerform().
381 * Returns TRUE on success, or FALSE on failure.
383 PHP_METHOD(HttpRequestPool
, socketSelect
)
385 getObject(http_requestpool_object
, obj
);
389 RETURN_SUCCESS(http_request_pool_select(&obj
->pool
));
393 /* implements Iterator */
395 /* {{{ proto bool HttpRequestPool::valid()
397 * Implements Iterator::valid().
399 PHP_METHOD(HttpRequestPool
, valid
)
404 getObject(http_requestpool_object
, obj
);
405 RETURN_BOOL(obj
->iterator
.pos
>= 0 && obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
));
410 /* {{{ proto HttpRequest HttpRequestPool::current()
412 * Implements Iterator::current().
414 PHP_METHOD(HttpRequestPool
, current
)
420 zval
**current
= NULL
;
421 zend_llist_position lpos
;
422 getObject(http_requestpool_object
, obj
);
424 if (obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
)) {
425 for ( current
= zend_llist_get_first_ex(&obj
->pool
.handles
, &lpos
);
426 current
&& obj
->iterator
.pos
!= pos
++;
427 current
= zend_llist_get_next_ex(&obj
->pool
.handles
, &lpos
));
429 RETURN_OBJECT(*current
, 1);
437 /* {{{ proto int HttpRequestPool::key()
439 * Implements Iterator::key().
441 PHP_METHOD(HttpRequestPool
, key
)
446 getObject(http_requestpool_object
, obj
);
447 RETURN_LONG(obj
->iterator
.pos
);
452 /* {{{ proto void HttpRequestPool::next()
454 * Implements Iterator::next().
456 PHP_METHOD(HttpRequestPool
, next
)
459 getObject(http_requestpool_object
, obj
);
460 ++(obj
->iterator
.pos
);
465 /* {{{ proto void HttpRequestPool::rewind()
467 * Implements Iterator::rewind().
469 PHP_METHOD(HttpRequestPool
, rewind
)
472 getObject(http_requestpool_object
, obj
);
473 obj
->iterator
.pos
= 0;
478 /* {{{ proto int HttpRequestPool::count()
480 * Implements Countable.
482 * Returns the number of attached HttpRequest objects.
484 PHP_METHOD(HttpRequestPool
, count
)
487 getObject(http_requestpool_object
, obj
);
488 RETURN_LONG((long) zend_llist_count(&obj
->pool
.handles
));
493 /* {{{ proto array HttpRequestPool::getAttachedRequests()
495 * Get attached HttpRequest objects.
497 * Returns an array containing all currently attached HttpRequest objects.
499 PHP_METHOD(HttpRequestPool
, getAttachedRequests
)
501 getObject(http_requestpool_object
, obj
);
505 array_init(return_value
);
506 zend_llist_apply_with_argument(&obj
->pool
.handles
,
507 (llist_apply_with_arg_func_t
) http_requestpool_object_llist2array
,
508 return_value TSRMLS_CC
);
512 /* {{{ proto array HttpRequestPool::getFinishedRequests()
514 * Get attached HttpRequest objects that already have finished their work.
516 * Returns an array containing all attached HttpRequest objects that
517 * already have finished their work.
519 PHP_METHOD(HttpRequestPool
, getFinishedRequests
)
521 getObject(http_requestpool_object
, obj
);
525 array_init(return_value
);
526 zend_llist_apply_with_argument(&obj
->pool
.finished
,
527 (llist_apply_with_arg_func_t
) http_requestpool_object_llist2array
,
528 return_value TSRMLS_CC
);
532 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
539 * vim600: noet sw=4 ts=4 fdm=marker
540 * vim<600: noet sw=4 ts=4