2 +----------------------------------------------------------------------+
4 +----------------------------------------------------------------------+
5 | This source file is subject to version 3.0 of the PHP license, that |
6 | is bundled with this package in the file LICENSE, and is available |
7 | through the world-wide-web at http://www.php.net/license/3_0.txt. |
8 | If you did not receive a copy of the PHP license and are unable to |
9 | obtain it through the world-wide-web, please send a note to |
10 | license@php.net so we can mail you a copy immediately. |
11 +----------------------------------------------------------------------+
12 | Copyright (c) 2004-2005 Michael Wallner <mike@php.net> |
13 +----------------------------------------------------------------------+
24 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
26 #include "php_http_std_defs.h"
27 #include "php_http_api.h"
28 #include "php_http_requestpool_object.h"
29 #include "php_http_request_pool_api.h"
30 #include "php_http_request_object.h"
31 #include "php_http_exception_object.h"
33 #include "zend_interfaces.h"
36 # include <winsock2.h>
38 #include <curl/curl.h>
40 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpRequestPool, method, 0, req_args)
41 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpRequestPool, method, ret_ref)
42 #define HTTP_REQPOOL_ME(method, visibility) PHP_ME(HttpRequestPool, method, HTTP_ARGS(HttpRequestPool, method), visibility)
44 HTTP_BEGIN_ARGS_AR(HttpRequestPool
, __construct
, 0, 0)
45 HTTP_ARG_OBJ(HttpRequest
, request0
, 0)
46 HTTP_ARG_OBJ(HttpRequest
, request1
, 0)
47 HTTP_ARG_OBJ(HttpRequest
, requestN
, 0)
50 HTTP_EMPTY_ARGS(__destruct
, 0);
51 HTTP_EMPTY_ARGS(reset
, 0);
53 HTTP_BEGIN_ARGS(attach
, 1)
54 HTTP_ARG_OBJ(HttpRequest
, request
, 0)
57 HTTP_BEGIN_ARGS(detach
, 1)
58 HTTP_ARG_OBJ(HttpRequest
, request
, 0)
61 HTTP_EMPTY_ARGS(send
, 0);
62 HTTP_EMPTY_ARGS(socketPerform
, 0);
63 HTTP_EMPTY_ARGS(socketSelect
, 0);
65 HTTP_EMPTY_ARGS(valid
, 0);
66 HTTP_EMPTY_ARGS(current
, 1);
67 HTTP_EMPTY_ARGS(key
, 0);
68 HTTP_EMPTY_ARGS(next
, 0);
69 HTTP_EMPTY_ARGS(rewind
, 0);
71 HTTP_EMPTY_ARGS(getAttachedRequests
, 0);
72 HTTP_EMPTY_ARGS(getFinishedRequests
, 0);
74 HTTP_BEGIN_ARGS(setRequestOptions
, 0)
75 HTTP_ARG_VAL(options
, 0)
78 #define http_requestpool_object_declare_default_properties() _http_requestpool_object_declare_default_properties(TSRMLS_C)
79 static inline void _http_requestpool_object_declare_default_properties(TSRMLS_D
);
81 zend_class_entry
*http_requestpool_object_ce
;
82 zend_function_entry http_requestpool_object_fe
[] = {
83 HTTP_REQPOOL_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
84 HTTP_REQPOOL_ME(__destruct
, ZEND_ACC_PUBLIC
|ZEND_ACC_DTOR
)
85 HTTP_REQPOOL_ME(attach
, ZEND_ACC_PUBLIC
)
86 HTTP_REQPOOL_ME(detach
, ZEND_ACC_PUBLIC
)
87 HTTP_REQPOOL_ME(send
, ZEND_ACC_PUBLIC
)
88 HTTP_REQPOOL_ME(reset
, ZEND_ACC_PUBLIC
)
90 HTTP_REQPOOL_ME(socketPerform
, ZEND_ACC_PROTECTED
)
91 HTTP_REQPOOL_ME(socketSelect
, ZEND_ACC_PROTECTED
)
93 /* implements Interator */
94 HTTP_REQPOOL_ME(valid
, ZEND_ACC_PUBLIC
)
95 HTTP_REQPOOL_ME(current
, ZEND_ACC_PUBLIC
)
96 HTTP_REQPOOL_ME(key
, ZEND_ACC_PUBLIC
)
97 HTTP_REQPOOL_ME(next
, ZEND_ACC_PUBLIC
)
98 HTTP_REQPOOL_ME(rewind
, ZEND_ACC_PUBLIC
)
100 HTTP_REQPOOL_ME(getAttachedRequests
, ZEND_ACC_PUBLIC
)
101 HTTP_REQPOOL_ME(getFinishedRequests
, ZEND_ACC_PUBLIC
)
105 static zend_object_handlers http_requestpool_object_handlers
;
107 PHP_MINIT_FUNCTION(http_requestpool_object
)
109 HTTP_REGISTER_CLASS_EX(HttpRequestPool
, http_requestpool_object
, NULL
, 0);
110 zend_class_implements(http_requestpool_object_ce TSRMLS_CC
, 1, zend_ce_iterator
);
114 zend_object_value
_http_requestpool_object_new(zend_class_entry
*ce TSRMLS_DC
)
116 zend_object_value ov
;
117 http_requestpool_object
*o
;
119 o
= ecalloc(1, sizeof(http_requestpool_object
));
122 http_request_pool_init(&o
->pool
);
124 ALLOC_HASHTABLE(OBJ_PROP(o
));
125 zend_hash_init(OBJ_PROP(o
), 0, NULL
, ZVAL_PTR_DTOR
, 0);
126 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
128 ov
.handle
= putObject(http_requestpool_object
, o
);
129 ov
.handlers
= &http_requestpool_object_handlers
;
134 static inline void _http_requestpool_object_declare_default_properties(TSRMLS_D
)
136 zend_class_entry
*ce
= http_requestpool_object_ce
;
138 DCL_PROP_N(PROTECTED
, pool
);
141 void _http_requestpool_object_free(zend_object
*object TSRMLS_DC
)
143 http_requestpool_object
*o
= (http_requestpool_object
*) object
;
146 zend_hash_destroy(OBJ_PROP(o
));
147 FREE_HASHTABLE(OBJ_PROP(o
));
149 http_request_pool_dtor(&o
->pool
);
153 #define http_requestpool_object_llist2array _http_requestpool_object_llist2array
154 static void _http_requestpool_object_llist2array(zval
**req
, zval
*array TSRMLS_DC
)
157 zend_objects_store_add_ref(*req TSRMLS_CC
);
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 Interator interface.
171 * Accepts virtual infinite optional parameters each referencing an
172 * HttpRequest object.
174 * Throws HttpRequestException, HttpRequestPoolException, 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
);
204 if (SUCCESS
== zend_get_parameters_array_ex(argc
, argv
)) {
207 for (i
= 0; i
< argc
; ++i
) {
208 if (Z_TYPE_PP(argv
[i
]) == IS_OBJECT
&& instanceof_function(Z_OBJCE_PP(argv
[i
]), http_request_object_ce TSRMLS_CC
)) {
209 http_request_pool_attach(&obj
->pool
, *(argv
[i
]));
217 /* {{{ proto void HttpRequestPool::__destruct()
219 * Clean up HttpRequestPool object.
221 PHP_METHOD(HttpRequestPool
, __destruct
)
223 getObject(http_requestpool_object
, obj
);
227 http_request_pool_detach_all(&obj
->pool
);
231 /* {{{ proto void HttpRequestPool::reset()
233 * Detach all attached HttpRequest objects.
235 PHP_METHOD(HttpRequestPool
, reset
)
237 getObject(http_requestpool_object
, obj
);
241 obj
->iterator
.pos
= 0;
242 http_request_pool_detach_all(&obj
->pool
);
245 /* {{{ proto bool HttpRequestPool::attach(HttpRequest request)
247 * Attach an HttpRequest object to this HttpRequestPool.
248 * WARNING: set all options prior attaching!
250 * Expects the parameter to be an HttpRequest object not alread attached to
251 * antother HttpRequestPool object.
253 * Returns TRUE on success, or FALSE on failure.
255 * Throws HttpInvalidParamException, HttpRequestException,
256 * HttpRequestPoolException, HttpEncodingException.
258 PHP_METHOD(HttpRequestPool
, attach
)
261 STATUS status
= FAILURE
;
262 getObject(http_requestpool_object
, obj
);
265 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "O", &request
, http_request_object_ce
)) {
266 if (obj
->iterator
.pos
> 0 && obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
)) {
267 http_error(HE_THROW
, HTTP_E_REQUEST_POOL
, "Cannot attach to the HttpRequestPool while the iterator is active");
269 status
= http_request_pool_attach(&obj
->pool
, request
);
273 RETURN_SUCCESS(status
);
277 /* {{{ proto bool HttpRequestPool::detach(HttpRequest request)
279 * Detach an HttpRequest object from this HttpRequestPool.
281 * Expects the parameter to be an HttpRequest object attached to this
282 * HttpRequestPool object.
284 * Returns TRUE on success, or FALSE on failure.
286 * Throws HttpInvalidParamException, HttpRequestPoolException.
288 PHP_METHOD(HttpRequestPool
, detach
)
291 STATUS status
= FAILURE
;
292 getObject(http_requestpool_object
, obj
);
295 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "O", &request
, http_request_object_ce
)) {
296 obj
->iterator
.pos
= -1;
297 status
= http_request_pool_detach(&obj
->pool
, request
);
300 RETURN_SUCCESS(status
);
304 /* {{{ proto bool HttpRequestPool::send()
306 * Send all attached HttpRequest objects in parallel.
308 * Returns TRUE on success, or FALSE on failure.
310 * Throws HttpSocketException, HttpRequestException,
311 * HttpRequestPoolException, HttpMalformedHeaderException.
313 PHP_METHOD(HttpRequestPool
, send
)
316 getObject(http_requestpool_object
, obj
);
321 status
= http_request_pool_send(&obj
->pool
);
324 RETURN_SUCCESS(status
);
328 /* {{{ proto protected bool HttpRequestPool::socketPerform()
330 * Returns TRUE until each request has finished its transaction.
335 * class MyPool extends HttpRequestPool
337 * public function send()
339 * while ($this->socketPerform()) {
340 * $this->handleRequests();
341 * if (!$this->socketSelect()) {
342 * throw new HttpSocketExcpetion;
345 * $this->handleRequests();
348 * private function handleRequests()
350 * foreach ($this->getFinishedRequests() as $r) {
352 * // handle response of finished request
359 PHP_METHOD(HttpRequestPool
, socketPerform
)
361 getObject(http_requestpool_object
, obj
);
365 if (0 < http_request_pool_perform(&obj
->pool
)) {
373 /* {{{ proto protected bool HttpRequestPool::socketSelect()
375 * See HttpRequestPool::socketPerform().
377 * Returns TRUE on success, or FALSE on failure.
379 PHP_METHOD(HttpRequestPool
, socketSelect
)
381 getObject(http_requestpool_object
, obj
);
385 RETURN_SUCCESS(http_request_pool_select(&obj
->pool
));
389 /* implements Iterator */
391 /* {{{ proto bool HttpRequestPool::valid()
393 * Implements Iterator::valid().
395 PHP_METHOD(HttpRequestPool
, valid
)
400 getObject(http_requestpool_object
, obj
);
401 RETURN_BOOL(obj
->iterator
.pos
>= 0 && obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
));
406 /* {{{ proto HttpRequest HttpRequestPool::current()
408 * Implements Iterator::current().
410 PHP_METHOD(HttpRequestPool
, current
)
416 zval
**current
= NULL
;
417 zend_llist_position lpos
;
418 getObject(http_requestpool_object
, obj
);
420 if (obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
)) {
421 for ( current
= zend_llist_get_first_ex(&obj
->pool
.handles
, &lpos
);
422 current
&& obj
->iterator
.pos
!= pos
++;
423 current
= zend_llist_get_next_ex(&obj
->pool
.handles
, &lpos
));
425 RETURN_OBJECT(*current
);
433 /* {{{ proto int HttpRequestPool::key()
435 * Implements Iterator::key().
437 PHP_METHOD(HttpRequestPool
, key
)
442 getObject(http_requestpool_object
, obj
);
443 RETURN_LONG(obj
->iterator
.pos
);
448 /* {{{ proto void HttpRequestPool::next()
450 * Implements Iterator::next().
452 PHP_METHOD(HttpRequestPool
, next
)
455 getObject(http_requestpool_object
, obj
);
456 ++(obj
->iterator
.pos
);
461 /* {{{ proto void HttpRequestPool::rewind()
463 * Implements Iterator::rewind().
465 PHP_METHOD(HttpRequestPool
, rewind
)
468 getObject(http_requestpool_object
, obj
);
469 obj
->iterator
.pos
= 0;
474 PHP_METHOD(HttpRequestPool
, getAttachedRequests
)
476 getObject(http_requestpool_object
, obj
);
480 array_init(return_value
);
481 zend_llist_apply_with_argument(&obj
->pool
.handles
,
482 (llist_apply_with_arg_func_t
) http_requestpool_object_llist2array
,
483 return_value TSRMLS_CC
);
486 PHP_METHOD(HttpRequestPool
, getFinishedRequests
)
488 getObject(http_requestpool_object
, obj
);
492 array_init(return_value
);
493 zend_llist_apply_with_argument(&obj
->pool
.finished
,
494 (llist_apply_with_arg_func_t
) http_requestpool_object_llist2array
,
495 return_value TSRMLS_CC
);
498 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
505 * vim600: noet sw=4 ts=4 fdm=marker
506 * vim<600: noet sw=4 ts=4