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-2005, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
21 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
23 #include "php_http_std_defs.h"
24 #include "php_http_api.h"
25 #include "php_http_requestpool_object.h"
26 #include "php_http_request_pool_api.h"
27 #include "php_http_request_object.h"
28 #include "php_http_exception_object.h"
30 #include "zend_interfaces.h"
33 # include <winsock2.h>
35 #include <curl/curl.h>
37 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpRequestPool, method, 0, req_args)
38 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpRequestPool, method, ret_ref)
39 #define HTTP_REQPOOL_ME(method, visibility) PHP_ME(HttpRequestPool, method, HTTP_ARGS(HttpRequestPool, method), visibility)
41 HTTP_BEGIN_ARGS_AR(HttpRequestPool
, __construct
, 0, 0)
42 HTTP_ARG_OBJ(HttpRequest
, request0
, 0)
43 HTTP_ARG_OBJ(HttpRequest
, request1
, 0)
44 HTTP_ARG_OBJ(HttpRequest
, requestN
, 0)
47 HTTP_EMPTY_ARGS(__destruct
, 0);
48 HTTP_EMPTY_ARGS(reset
, 0);
50 HTTP_BEGIN_ARGS(attach
, 1)
51 HTTP_ARG_OBJ(HttpRequest
, request
, 0)
54 HTTP_BEGIN_ARGS(detach
, 1)
55 HTTP_ARG_OBJ(HttpRequest
, request
, 0)
58 HTTP_EMPTY_ARGS(send
, 0);
59 HTTP_EMPTY_ARGS(socketPerform
, 0);
60 HTTP_EMPTY_ARGS(socketSelect
, 0);
62 HTTP_EMPTY_ARGS(valid
, 0);
63 HTTP_EMPTY_ARGS(current
, 1);
64 HTTP_EMPTY_ARGS(key
, 0);
65 HTTP_EMPTY_ARGS(next
, 0);
66 HTTP_EMPTY_ARGS(rewind
, 0);
68 HTTP_EMPTY_ARGS(getAttachedRequests
, 0);
69 HTTP_EMPTY_ARGS(getFinishedRequests
, 0);
71 #define http_requestpool_object_declare_default_properties() _http_requestpool_object_declare_default_properties(TSRMLS_C)
72 static inline void _http_requestpool_object_declare_default_properties(TSRMLS_D
);
74 zend_class_entry
*http_requestpool_object_ce
;
75 zend_function_entry http_requestpool_object_fe
[] = {
76 HTTP_REQPOOL_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
77 HTTP_REQPOOL_ME(__destruct
, ZEND_ACC_PUBLIC
|ZEND_ACC_DTOR
)
78 HTTP_REQPOOL_ME(attach
, ZEND_ACC_PUBLIC
)
79 HTTP_REQPOOL_ME(detach
, ZEND_ACC_PUBLIC
)
80 HTTP_REQPOOL_ME(send
, ZEND_ACC_PUBLIC
)
81 HTTP_REQPOOL_ME(reset
, ZEND_ACC_PUBLIC
)
83 HTTP_REQPOOL_ME(socketPerform
, ZEND_ACC_PROTECTED
)
84 HTTP_REQPOOL_ME(socketSelect
, ZEND_ACC_PROTECTED
)
86 /* implements Interator */
87 HTTP_REQPOOL_ME(valid
, ZEND_ACC_PUBLIC
)
88 HTTP_REQPOOL_ME(current
, ZEND_ACC_PUBLIC
)
89 HTTP_REQPOOL_ME(key
, ZEND_ACC_PUBLIC
)
90 HTTP_REQPOOL_ME(next
, ZEND_ACC_PUBLIC
)
91 HTTP_REQPOOL_ME(rewind
, ZEND_ACC_PUBLIC
)
93 HTTP_REQPOOL_ME(getAttachedRequests
, ZEND_ACC_PUBLIC
)
94 HTTP_REQPOOL_ME(getFinishedRequests
, ZEND_ACC_PUBLIC
)
98 static zend_object_handlers http_requestpool_object_handlers
;
100 PHP_MINIT_FUNCTION(http_requestpool_object
)
102 HTTP_REGISTER_CLASS_EX(HttpRequestPool
, http_requestpool_object
, NULL
, 0);
103 zend_class_implements(http_requestpool_object_ce TSRMLS_CC
, 1, zend_ce_iterator
);
104 http_requestpool_object_handlers
.clone_obj
= NULL
;
108 zend_object_value
_http_requestpool_object_new(zend_class_entry
*ce TSRMLS_DC
)
110 zend_object_value ov
;
111 http_requestpool_object
*o
;
113 o
= ecalloc(1, sizeof(http_requestpool_object
));
116 http_request_pool_init(&o
->pool
);
118 ALLOC_HASHTABLE(OBJ_PROP(o
));
119 zend_hash_init(OBJ_PROP(o
), 0, NULL
, ZVAL_PTR_DTOR
, 0);
120 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
122 ov
.handle
= putObject(http_requestpool_object
, o
);
123 ov
.handlers
= &http_requestpool_object_handlers
;
128 static inline void _http_requestpool_object_declare_default_properties(TSRMLS_D
)
130 zend_class_entry
*ce
= http_requestpool_object_ce
;
132 DCL_PROP_N(PROTECTED
, pool
);
135 void _http_requestpool_object_free(zend_object
*object TSRMLS_DC
)
137 http_requestpool_object
*o
= (http_requestpool_object
*) object
;
140 zend_hash_destroy(OBJ_PROP(o
));
141 FREE_HASHTABLE(OBJ_PROP(o
));
143 http_request_pool_dtor(&o
->pool
);
147 #define http_requestpool_object_llist2array _http_requestpool_object_llist2array
148 static void _http_requestpool_object_llist2array(zval
**req
, zval
*array TSRMLS_DC
)
151 add_next_index_zval(array
, *req
);
154 /* ### USERLAND ### */
156 /* {{{ proto void HttpRequestPool::__construct([HttpRequest request[, ...]])
158 * Instantiate a new HttpRequestPool object. An HttpRequestPool is
159 * able to send several HttpRequests in parallel.
161 * WARNING: Don't attach/detach HttpRequest objects to the HttpRequestPool
162 * object while you're using the implemented Interator interface.
164 * Accepts virtual infinite optional parameters each referencing an
165 * HttpRequest object.
167 * Throws HttpRequestException, HttpRequestPoolException, HttpInvalidParamException.
173 * $pool = new HttpRequestPool(
174 * new HttpRequest('http://www.google.com/', HttpRequest::METH_HEAD),
175 * new HttpRequest('http://www.php.net/', HttpRequest::METH_HEAD)
178 * foreach($pool as $request) {
179 * printf("%s is %s (%d)\n",
180 * $request->getUrl(),
181 * $request->getResponseCode() ? 'alive' : 'not alive',
182 * $request->getResponseCode()
185 * } catch (HttpException $e) {
191 PHP_METHOD(HttpRequestPool
, __construct
)
193 int argc
= ZEND_NUM_ARGS();
194 zval
***argv
= safe_emalloc(argc
, sizeof(zval
*), 0);
195 getObject(http_requestpool_object
, obj
);
197 if (SUCCESS
== zend_get_parameters_array_ex(argc
, argv
)) {
200 for (i
= 0; i
< argc
; ++i
) {
201 if (Z_TYPE_PP(argv
[i
]) == IS_OBJECT
&& instanceof_function(Z_OBJCE_PP(argv
[i
]), http_request_object_ce TSRMLS_CC
)) {
202 http_request_pool_attach(&obj
->pool
, *(argv
[i
]));
210 /* {{{ proto void HttpRequestPool::__destruct()
212 * Clean up HttpRequestPool object.
214 PHP_METHOD(HttpRequestPool
, __destruct
)
216 getObject(http_requestpool_object
, obj
);
220 http_request_pool_detach_all(&obj
->pool
);
224 /* {{{ proto void HttpRequestPool::reset()
226 * Detach all attached HttpRequest objects.
228 PHP_METHOD(HttpRequestPool
, reset
)
230 getObject(http_requestpool_object
, obj
);
234 obj
->iterator
.pos
= 0;
235 http_request_pool_detach_all(&obj
->pool
);
238 /* {{{ proto bool HttpRequestPool::attach(HttpRequest request)
240 * Attach an HttpRequest object to this HttpRequestPool.
241 * WARNING: set all options prior attaching!
243 * Expects the parameter to be an HttpRequest object not alread attached to
244 * antother HttpRequestPool object.
246 * Returns TRUE on success, or FALSE on failure.
248 * Throws HttpInvalidParamException, HttpRequestException,
249 * HttpRequestPoolException, HttpEncodingException.
251 PHP_METHOD(HttpRequestPool
, attach
)
254 STATUS status
= FAILURE
;
255 getObject(http_requestpool_object
, obj
);
258 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "O", &request
, http_request_object_ce
)) {
259 if (obj
->iterator
.pos
> 0 && obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
)) {
260 http_error(HE_THROW
, HTTP_E_REQUEST_POOL
, "Cannot attach to the HttpRequestPool while the iterator is active");
262 status
= http_request_pool_attach(&obj
->pool
, request
);
266 RETURN_SUCCESS(status
);
270 /* {{{ proto bool HttpRequestPool::detach(HttpRequest request)
272 * Detach an HttpRequest object from this HttpRequestPool.
274 * Expects the parameter to be an HttpRequest object attached to this
275 * HttpRequestPool object.
277 * Returns TRUE on success, or FALSE on failure.
279 * Throws HttpInvalidParamException, HttpRequestPoolException.
281 PHP_METHOD(HttpRequestPool
, detach
)
284 STATUS status
= FAILURE
;
285 getObject(http_requestpool_object
, obj
);
288 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "O", &request
, http_request_object_ce
)) {
289 obj
->iterator
.pos
= -1;
290 status
= http_request_pool_detach(&obj
->pool
, request
);
293 RETURN_SUCCESS(status
);
297 /* {{{ proto bool HttpRequestPool::send()
299 * Send all attached HttpRequest objects in parallel.
301 * Returns TRUE on success, or FALSE on failure.
303 * Throws HttpSocketException, HttpRequestException,
304 * HttpRequestPoolException, HttpMalformedHeaderException.
306 PHP_METHOD(HttpRequestPool
, send
)
309 getObject(http_requestpool_object
, obj
);
314 status
= http_request_pool_send(&obj
->pool
);
317 RETURN_SUCCESS(status
);
321 /* {{{ proto protected bool HttpRequestPool::socketPerform()
323 * Returns TRUE until each request has finished its transaction.
328 * class MyPool extends HttpRequestPool
330 * public function send()
332 * while ($this->socketPerform()) {
333 * if (!$this->socketSelect()) {
334 * throw new HttpSocketExcpetion;
339 * protected final function socketPerform()
341 * $result = parent::socketPerform();
342 * foreach ($this->getFinishedRequests() as $r) {
344 * // handle response of finished request
352 PHP_METHOD(HttpRequestPool
, socketPerform
)
354 getObject(http_requestpool_object
, obj
);
358 if (0 < http_request_pool_perform(&obj
->pool
)) {
366 /* {{{ proto protected bool HttpRequestPool::socketSelect()
368 * See HttpRequestPool::socketPerform().
370 * Returns TRUE on success, or FALSE on failure.
372 PHP_METHOD(HttpRequestPool
, socketSelect
)
374 getObject(http_requestpool_object
, obj
);
378 RETURN_SUCCESS(http_request_pool_select(&obj
->pool
));
382 /* implements Iterator */
384 /* {{{ proto bool HttpRequestPool::valid()
386 * Implements Iterator::valid().
388 PHP_METHOD(HttpRequestPool
, valid
)
393 getObject(http_requestpool_object
, obj
);
394 RETURN_BOOL(obj
->iterator
.pos
>= 0 && obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
));
399 /* {{{ proto HttpRequest HttpRequestPool::current()
401 * Implements Iterator::current().
403 PHP_METHOD(HttpRequestPool
, current
)
409 zval
**current
= NULL
;
410 zend_llist_position lpos
;
411 getObject(http_requestpool_object
, obj
);
413 if (obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
)) {
414 for ( current
= zend_llist_get_first_ex(&obj
->pool
.handles
, &lpos
);
415 current
&& obj
->iterator
.pos
!= pos
++;
416 current
= zend_llist_get_next_ex(&obj
->pool
.handles
, &lpos
));
418 RETURN_OBJECT(*current
);
426 /* {{{ proto int HttpRequestPool::key()
428 * Implements Iterator::key().
430 PHP_METHOD(HttpRequestPool
, key
)
435 getObject(http_requestpool_object
, obj
);
436 RETURN_LONG(obj
->iterator
.pos
);
441 /* {{{ proto void HttpRequestPool::next()
443 * Implements Iterator::next().
445 PHP_METHOD(HttpRequestPool
, next
)
448 getObject(http_requestpool_object
, obj
);
449 ++(obj
->iterator
.pos
);
454 /* {{{ proto void HttpRequestPool::rewind()
456 * Implements Iterator::rewind().
458 PHP_METHOD(HttpRequestPool
, rewind
)
461 getObject(http_requestpool_object
, obj
);
462 obj
->iterator
.pos
= 0;
467 /* {{{ proto array HttpRequestPool::getAttachedRequests()
469 * Get attached HttpRequest objects.
471 * Returns an array containing all currently attached HttpRequest objects.
473 PHP_METHOD(HttpRequestPool
, getAttachedRequests
)
475 getObject(http_requestpool_object
, obj
);
479 array_init(return_value
);
480 zend_llist_apply_with_argument(&obj
->pool
.handles
,
481 (llist_apply_with_arg_func_t
) http_requestpool_object_llist2array
,
482 return_value TSRMLS_CC
);
486 /* {{{ proto array HttpRequestPool::getFinishedRequests()
488 * Get attached HttpRequest objects that already have finished their work.
490 * Returns an array containing all attached HttpRequest objects that
491 * already have finished their work.
493 PHP_METHOD(HttpRequestPool
, getFinishedRequests
)
495 getObject(http_requestpool_object
, obj
);
499 array_init(return_value
);
500 zend_llist_apply_with_argument(&obj
->pool
.finished
,
501 (llist_apply_with_arg_func_t
) http_requestpool_object_llist2array
,
502 return_value TSRMLS_CC
);
506 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
513 * vim600: noet sw=4 ts=4 fdm=marker
514 * vim<600: noet sw=4 ts=4