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) HTTP_EMPTY_ARGS_EX(HttpRequestPool, method, 0)
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
);
45 HTTP_EMPTY_ARGS(reset
);
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
);
56 HTTP_EMPTY_ARGS(socketPerform
);
57 HTTP_EMPTY_ARGS(socketSelect
);
59 HTTP_EMPTY_ARGS(valid
);
60 HTTP_EMPTY_ARGS(current
);
62 HTTP_EMPTY_ARGS(next
);
63 HTTP_EMPTY_ARGS(rewind
);
65 HTTP_EMPTY_ARGS(count
);
67 HTTP_EMPTY_ARGS(getAttachedRequests
);
68 HTTP_EMPTY_ARGS(getFinishedRequests
);
70 zend_class_entry
*http_requestpool_object_ce
;
71 zend_function_entry http_requestpool_object_fe
[] = {
72 HTTP_REQPOOL_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
73 HTTP_REQPOOL_ME(__destruct
, ZEND_ACC_PUBLIC
|ZEND_ACC_DTOR
)
74 HTTP_REQPOOL_ME(attach
, ZEND_ACC_PUBLIC
)
75 HTTP_REQPOOL_ME(detach
, ZEND_ACC_PUBLIC
)
76 HTTP_REQPOOL_ME(send
, ZEND_ACC_PUBLIC
)
77 HTTP_REQPOOL_ME(reset
, ZEND_ACC_PUBLIC
)
79 HTTP_REQPOOL_ME(socketPerform
, ZEND_ACC_PROTECTED
)
80 HTTP_REQPOOL_ME(socketSelect
, ZEND_ACC_PROTECTED
)
82 /* implements Iterator */
83 HTTP_REQPOOL_ME(valid
, ZEND_ACC_PUBLIC
)
84 HTTP_REQPOOL_ME(current
, ZEND_ACC_PUBLIC
)
85 HTTP_REQPOOL_ME(key
, ZEND_ACC_PUBLIC
)
86 HTTP_REQPOOL_ME(next
, ZEND_ACC_PUBLIC
)
87 HTTP_REQPOOL_ME(rewind
, ZEND_ACC_PUBLIC
)
89 /* implmenents Countable */
90 HTTP_REQPOOL_ME(count
, ZEND_ACC_PUBLIC
)
92 HTTP_REQPOOL_ME(getAttachedRequests
, ZEND_ACC_PUBLIC
)
93 HTTP_REQPOOL_ME(getFinishedRequests
, ZEND_ACC_PUBLIC
)
97 static zend_object_handlers http_requestpool_object_handlers
;
99 PHP_MINIT_FUNCTION(http_requestpool_object
)
101 HTTP_REGISTER_CLASS_EX(HttpRequestPool
, http_requestpool_object
, NULL
, 0);
102 http_requestpool_object_handlers
.clone_obj
= NULL
;
104 #if defined(HAVE_SPL) && !defined(WONKY)
105 zend_class_implements(http_requestpool_object_ce TSRMLS_CC
, 2, spl_ce_Countable
, zend_ce_iterator
);
107 zend_class_implements(http_requestpool_object_ce TSRMLS_CC
, 1, zend_ce_iterator
);
113 zend_object_value
_http_requestpool_object_new(zend_class_entry
*ce TSRMLS_DC
)
115 zend_object_value ov
;
116 http_requestpool_object
*o
;
118 o
= ecalloc(1, sizeof(http_requestpool_object
));
121 http_request_pool_init(&o
->pool
);
123 ALLOC_HASHTABLE(OBJ_PROP(o
));
124 zend_hash_init(OBJ_PROP(o
), zend_hash_num_elements(&ce
->default_properties
), NULL
, ZVAL_PTR_DTOR
, 0);
125 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
127 ov
.handle
= putObject(http_requestpool_object
, o
);
128 ov
.handlers
= &http_requestpool_object_handlers
;
133 void _http_requestpool_object_free(zend_object
*object TSRMLS_DC
)
135 http_requestpool_object
*o
= (http_requestpool_object
*) object
;
137 http_request_pool_dtor(&o
->pool
);
141 #define http_requestpool_object_llist2array _http_requestpool_object_llist2array
142 static void _http_requestpool_object_llist2array(zval
**req
, zval
*array TSRMLS_DC
)
145 add_next_index_zval(array
, *req
);
148 /* ### USERLAND ### */
150 /* {{{ proto void HttpRequestPool::__construct([HttpRequest request[, ...]])
152 * Instantiate a new HttpRequestPool object. An HttpRequestPool is
153 * able to send several HttpRequests in parallel.
155 * WARNING: Don't attach/detach HttpRequest objects to the HttpRequestPool
156 * object while you're using the implemented Iterator interface.
158 * Accepts virtual infinite optional parameters each referencing an
159 * HttpRequest object.
161 * Throws HttpRequestPoolException (HttpRequestException, HttpInvalidParamException).
167 * $pool = new HttpRequestPool(
168 * new HttpRequest('http://www.google.com/', HttpRequest::METH_HEAD),
169 * new HttpRequest('http://www.php.net/', HttpRequest::METH_HEAD)
172 * foreach($pool as $request) {
173 * printf("%s is %s (%d)\n",
174 * $request->getUrl(),
175 * $request->getResponseCode() ? 'alive' : 'not alive',
176 * $request->getResponseCode()
179 * } catch (HttpException $e) {
185 PHP_METHOD(HttpRequestPool
, __construct
)
187 int argc
= ZEND_NUM_ARGS();
188 zval
***argv
= safe_emalloc(argc
, sizeof(zval
*), 0);
189 getObject(http_requestpool_object
, obj
);
192 if (SUCCESS
== zend_get_parameters_array_ex(argc
, argv
)) {
195 for (i
= 0; i
< argc
; ++i
) {
196 if (Z_TYPE_PP(argv
[i
]) == IS_OBJECT
&& instanceof_function(Z_OBJCE_PP(argv
[i
]), http_request_object_ce TSRMLS_CC
)) {
197 http_request_pool_attach(&obj
->pool
, *(argv
[i
]));
203 http_final(HTTP_EX_CE(request_pool
));
207 /* {{{ proto void HttpRequestPool::__destruct()
209 * Clean up HttpRequestPool object.
211 PHP_METHOD(HttpRequestPool
, __destruct
)
213 getObject(http_requestpool_object
, obj
);
217 http_request_pool_detach_all(&obj
->pool
);
221 /* {{{ proto void HttpRequestPool::reset()
223 * Detach all attached HttpRequest objects.
225 PHP_METHOD(HttpRequestPool
, reset
)
227 getObject(http_requestpool_object
, obj
);
231 obj
->iterator
.pos
= 0;
232 http_request_pool_detach_all(&obj
->pool
);
235 /* {{{ proto bool HttpRequestPool::attach(HttpRequest request)
237 * Attach an HttpRequest object to this HttpRequestPool.
238 * WARNING: set all options prior attaching!
240 * Expects the parameter to be an HttpRequest object not already attached to
241 * antother HttpRequestPool object.
243 * Returns TRUE on success, or FALSE on failure.
245 * Throws HttpInvalidParamException, HttpRequestException,
246 * HttpRequestPoolException, HttpEncodingException.
248 PHP_METHOD(HttpRequestPool
, attach
)
251 STATUS status
= FAILURE
;
252 getObject(http_requestpool_object
, obj
);
255 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "O", &request
, http_request_object_ce
)) {
256 if (obj
->iterator
.pos
> 0 && obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
)) {
257 http_error(HE_THROW
, HTTP_E_REQUEST_POOL
, "Cannot attach to the HttpRequestPool while the iterator is active");
259 status
= http_request_pool_attach(&obj
->pool
, request
);
263 RETURN_SUCCESS(status
);
267 /* {{{ proto bool HttpRequestPool::detach(HttpRequest request)
269 * Detach an HttpRequest object from this HttpRequestPool.
271 * Expects the parameter to be an HttpRequest object attached to this
272 * HttpRequestPool object.
274 * Returns TRUE on success, or FALSE on failure.
276 * Throws HttpInvalidParamException, HttpRequestPoolException.
278 PHP_METHOD(HttpRequestPool
, detach
)
281 STATUS status
= FAILURE
;
282 getObject(http_requestpool_object
, obj
);
285 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "O", &request
, http_request_object_ce
)) {
286 obj
->iterator
.pos
= -1;
287 status
= http_request_pool_detach(&obj
->pool
, request
);
290 RETURN_SUCCESS(status
);
294 /* {{{ proto bool HttpRequestPool::send()
296 * Send all attached HttpRequest objects in parallel.
298 * Returns TRUE on success, or FALSE on failure.
300 * Throws HttpRequestPoolException (HttpSocketException, HttpRequestException, HttpMalformedHeaderException).
302 PHP_METHOD(HttpRequestPool
, send
)
305 getObject(http_requestpool_object
, obj
);
310 status
= http_request_pool_send(&obj
->pool
);
313 /* rethrow as HttpRequestPoolException */
314 http_final(HTTP_EX_CE(request_pool
));
316 RETURN_SUCCESS(status
);
320 /* {{{ proto protected bool HttpRequestPool::socketPerform()
322 * Returns TRUE until each request has finished its transaction.
327 * class MyPool extends HttpRequestPool
329 * public function send()
331 * while ($this->socketPerform()) {
332 * if (!$this->socketSelect()) {
333 * throw new HttpSocketExcpetion;
338 * protected final function socketPerform()
340 * $result = parent::socketPerform();
341 * foreach ($this->getFinishedRequests() as $r) {
343 * // handle response of finished request
351 PHP_METHOD(HttpRequestPool
, socketPerform
)
353 getObject(http_requestpool_object
, obj
);
357 if (0 < http_request_pool_perform(&obj
->pool
)) {
365 /* {{{ proto protected bool HttpRequestPool::socketSelect()
367 * See HttpRequestPool::socketPerform().
369 * Returns TRUE on success, or FALSE on failure.
371 PHP_METHOD(HttpRequestPool
, socketSelect
)
373 getObject(http_requestpool_object
, obj
);
377 RETURN_SUCCESS(http_request_pool_select(&obj
->pool
));
381 /* implements Iterator */
383 /* {{{ proto bool HttpRequestPool::valid()
385 * Implements Iterator::valid().
387 PHP_METHOD(HttpRequestPool
, valid
)
391 if (return_value_used
) {
392 getObject(http_requestpool_object
, obj
);
393 RETURN_BOOL(obj
->iterator
.pos
>= 0 && obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
));
398 /* {{{ proto HttpRequest HttpRequestPool::current()
400 * Implements Iterator::current().
402 PHP_METHOD(HttpRequestPool
, current
)
406 if (return_value_used
) {
408 zval
**current
= NULL
;
409 zend_llist_position lpos
;
410 getObject(http_requestpool_object
, obj
);
412 if (obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
)) {
413 for ( current
= zend_llist_get_first_ex(&obj
->pool
.handles
, &lpos
);
414 current
&& obj
->iterator
.pos
!= pos
++;
415 current
= zend_llist_get_next_ex(&obj
->pool
.handles
, &lpos
));
417 RETURN_OBJECT(*current
, 1);
425 /* {{{ proto int HttpRequestPool::key()
427 * Implements Iterator::key().
429 PHP_METHOD(HttpRequestPool
, key
)
433 if (return_value_used
) {
434 getObject(http_requestpool_object
, obj
);
435 RETURN_LONG(obj
->iterator
.pos
);
440 /* {{{ proto void HttpRequestPool::next()
442 * Implements Iterator::next().
444 PHP_METHOD(HttpRequestPool
, next
)
447 getObject(http_requestpool_object
, obj
);
448 ++(obj
->iterator
.pos
);
453 /* {{{ proto void HttpRequestPool::rewind()
455 * Implements Iterator::rewind().
457 PHP_METHOD(HttpRequestPool
, rewind
)
460 getObject(http_requestpool_object
, obj
);
461 obj
->iterator
.pos
= 0;
466 /* {{{ proto int HttpRequestPool::count()
468 * Implements Countable.
470 * Returns the number of attached HttpRequest objects.
472 PHP_METHOD(HttpRequestPool
, count
)
475 getObject(http_requestpool_object
, obj
);
476 RETURN_LONG((long) zend_llist_count(&obj
->pool
.handles
));
481 /* {{{ proto array HttpRequestPool::getAttachedRequests()
483 * Get attached HttpRequest objects.
485 * Returns an array containing all currently attached HttpRequest objects.
487 PHP_METHOD(HttpRequestPool
, getAttachedRequests
)
489 getObject(http_requestpool_object
, obj
);
493 array_init(return_value
);
494 zend_llist_apply_with_argument(&obj
->pool
.handles
,
495 (llist_apply_with_arg_func_t
) http_requestpool_object_llist2array
,
496 return_value TSRMLS_CC
);
500 /* {{{ proto array HttpRequestPool::getFinishedRequests()
502 * Get attached HttpRequest objects that already have finished their work.
504 * Returns an array containing all attached HttpRequest objects that
505 * already have finished their work.
507 PHP_METHOD(HttpRequestPool
, getFinishedRequests
)
509 getObject(http_requestpool_object
, obj
);
513 array_init(return_value
);
514 zend_llist_apply_with_argument(&obj
->pool
.finished
,
515 (llist_apply_with_arg_func_t
) http_requestpool_object_llist2array
,
516 return_value TSRMLS_CC
);
520 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
527 * vim600: noet sw=4 ts=4 fdm=marker
528 * vim<600: noet sw=4 ts=4