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 Z_OBJ_ADDREF_PP(req
);
152 add_next_index_zval(array
, *req
);
155 /* ### USERLAND ### */
157 /* {{{ proto void HttpRequestPool::__construct([HttpRequest request[, ...]])
159 * Instantiate a new HttpRequestPool object. An HttpRequestPool is
160 * able to send several HttpRequests in parallel.
162 * WARNING: Don't attach/detach HttpRequest objects to the HttpRequestPool
163 * object while you're using the implemented Interator interface.
165 * Accepts virtual infinite optional parameters each referencing an
166 * HttpRequest object.
168 * Throws HttpRequestException, HttpRequestPoolException, HttpInvalidParamException.
174 * $pool = new HttpRequestPool(
175 * new HttpRequest('http://www.google.com/', HttpRequest::METH_HEAD),
176 * new HttpRequest('http://www.php.net/', HttpRequest::METH_HEAD)
179 * foreach($pool as $request) {
180 * printf("%s is %s (%d)\n",
181 * $request->getUrl(),
182 * $request->getResponseCode() ? 'alive' : 'not alive',
183 * $request->getResponseCode()
186 * } catch (HttpException $e) {
192 PHP_METHOD(HttpRequestPool
, __construct
)
194 int argc
= ZEND_NUM_ARGS();
195 zval
***argv
= safe_emalloc(argc
, sizeof(zval
*), 0);
196 getObject(http_requestpool_object
, obj
);
198 if (SUCCESS
== zend_get_parameters_array_ex(argc
, argv
)) {
201 for (i
= 0; i
< argc
; ++i
) {
202 if (Z_TYPE_PP(argv
[i
]) == IS_OBJECT
&& instanceof_function(Z_OBJCE_PP(argv
[i
]), http_request_object_ce TSRMLS_CC
)) {
203 http_request_pool_attach(&obj
->pool
, *(argv
[i
]));
211 /* {{{ proto void HttpRequestPool::__destruct()
213 * Clean up HttpRequestPool object.
215 PHP_METHOD(HttpRequestPool
, __destruct
)
217 getObject(http_requestpool_object
, obj
);
221 http_request_pool_detach_all(&obj
->pool
);
225 /* {{{ proto void HttpRequestPool::reset()
227 * Detach all attached HttpRequest objects.
229 PHP_METHOD(HttpRequestPool
, reset
)
231 getObject(http_requestpool_object
, obj
);
235 obj
->iterator
.pos
= 0;
236 http_request_pool_detach_all(&obj
->pool
);
239 /* {{{ proto bool HttpRequestPool::attach(HttpRequest request)
241 * Attach an HttpRequest object to this HttpRequestPool.
242 * WARNING: set all options prior attaching!
244 * Expects the parameter to be an HttpRequest object not alread attached to
245 * antother HttpRequestPool object.
247 * Returns TRUE on success, or FALSE on failure.
249 * Throws HttpInvalidParamException, HttpRequestException,
250 * HttpRequestPoolException, HttpEncodingException.
252 PHP_METHOD(HttpRequestPool
, attach
)
255 STATUS status
= FAILURE
;
256 getObject(http_requestpool_object
, obj
);
259 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "O", &request
, http_request_object_ce
)) {
260 if (obj
->iterator
.pos
> 0 && obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
)) {
261 http_error(HE_THROW
, HTTP_E_REQUEST_POOL
, "Cannot attach to the HttpRequestPool while the iterator is active");
263 status
= http_request_pool_attach(&obj
->pool
, request
);
267 RETURN_SUCCESS(status
);
271 /* {{{ proto bool HttpRequestPool::detach(HttpRequest request)
273 * Detach an HttpRequest object from this HttpRequestPool.
275 * Expects the parameter to be an HttpRequest object attached to this
276 * HttpRequestPool object.
278 * Returns TRUE on success, or FALSE on failure.
280 * Throws HttpInvalidParamException, HttpRequestPoolException.
282 PHP_METHOD(HttpRequestPool
, detach
)
285 STATUS status
= FAILURE
;
286 getObject(http_requestpool_object
, obj
);
289 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "O", &request
, http_request_object_ce
)) {
290 obj
->iterator
.pos
= -1;
291 status
= http_request_pool_detach(&obj
->pool
, request
);
294 RETURN_SUCCESS(status
);
298 /* {{{ proto bool HttpRequestPool::send()
300 * Send all attached HttpRequest objects in parallel.
302 * Returns TRUE on success, or FALSE on failure.
304 * Throws HttpSocketException, HttpRequestException,
305 * HttpRequestPoolException, HttpMalformedHeaderException.
307 PHP_METHOD(HttpRequestPool
, send
)
310 getObject(http_requestpool_object
, obj
);
315 status
= http_request_pool_send(&obj
->pool
);
318 RETURN_SUCCESS(status
);
322 /* {{{ proto protected bool HttpRequestPool::socketPerform()
324 * Returns TRUE until each request has finished its transaction.
329 * class MyPool extends HttpRequestPool
331 * public function send()
333 * while ($this->socketPerform()) {
334 * if (!$this->socketSelect()) {
335 * throw new HttpSocketExcpetion;
340 * protected final function socketPerform()
342 * $result = parent::socketPerform();
343 * foreach ($this->getFinishedRequests() as $r) {
345 * // handle response of finished request
353 PHP_METHOD(HttpRequestPool
, socketPerform
)
355 getObject(http_requestpool_object
, obj
);
359 if (0 < http_request_pool_perform(&obj
->pool
)) {
367 /* {{{ proto protected bool HttpRequestPool::socketSelect()
369 * See HttpRequestPool::socketPerform().
371 * Returns TRUE on success, or FALSE on failure.
373 PHP_METHOD(HttpRequestPool
, socketSelect
)
375 getObject(http_requestpool_object
, obj
);
379 RETURN_SUCCESS(http_request_pool_select(&obj
->pool
));
383 /* implements Iterator */
385 /* {{{ proto bool HttpRequestPool::valid()
387 * Implements Iterator::valid().
389 PHP_METHOD(HttpRequestPool
, valid
)
394 getObject(http_requestpool_object
, obj
);
395 RETURN_BOOL(obj
->iterator
.pos
>= 0 && obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
));
400 /* {{{ proto HttpRequest HttpRequestPool::current()
402 * Implements Iterator::current().
404 PHP_METHOD(HttpRequestPool
, current
)
410 zval
**current
= NULL
;
411 zend_llist_position lpos
;
412 getObject(http_requestpool_object
, obj
);
414 if (obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
)) {
415 for ( current
= zend_llist_get_first_ex(&obj
->pool
.handles
, &lpos
);
416 current
&& obj
->iterator
.pos
!= pos
++;
417 current
= zend_llist_get_next_ex(&obj
->pool
.handles
, &lpos
));
419 RETURN_OBJECT(*current
);
427 /* {{{ proto int HttpRequestPool::key()
429 * Implements Iterator::key().
431 PHP_METHOD(HttpRequestPool
, key
)
436 getObject(http_requestpool_object
, obj
);
437 RETURN_LONG(obj
->iterator
.pos
);
442 /* {{{ proto void HttpRequestPool::next()
444 * Implements Iterator::next().
446 PHP_METHOD(HttpRequestPool
, next
)
449 getObject(http_requestpool_object
, obj
);
450 ++(obj
->iterator
.pos
);
455 /* {{{ proto void HttpRequestPool::rewind()
457 * Implements Iterator::rewind().
459 PHP_METHOD(HttpRequestPool
, rewind
)
462 getObject(http_requestpool_object
, obj
);
463 obj
->iterator
.pos
= 0;
468 /* {{{ proto array HttpRequestPool::getAttachedRequests()
470 * Get attached HttpRequest objects.
472 * Returns an array containing all currently attached HttpRequest objects.
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
);
487 /* {{{ proto array HttpRequestPool::getFinishedRequests()
489 * Get attached HttpRequest objects that already have finished their work.
491 * Returns an array containing all attached HttpRequest objects that
492 * already have finished their work.
494 PHP_METHOD(HttpRequestPool
, getFinishedRequests
)
496 getObject(http_requestpool_object
, obj
);
500 array_init(return_value
);
501 zend_llist_apply_with_argument(&obj
->pool
.finished
,
502 (llist_apply_with_arg_func_t
) http_requestpool_object_llist2array
,
503 return_value TSRMLS_CC
);
507 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
514 * vim600: noet sw=4 ts=4 fdm=marker
515 * vim<600: noet sw=4 ts=4