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 HTTP_BEGIN_ARGS(enablePipelining
, 0)
71 HTTP_ARG_VAL(enable
, 0)
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 Iterator */
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 /* implmenents Countable */
94 HTTP_REQPOOL_ME(count
, ZEND_ACC_PUBLIC
)
96 HTTP_REQPOOL_ME(getAttachedRequests
, ZEND_ACC_PUBLIC
)
97 HTTP_REQPOOL_ME(getFinishedRequests
, ZEND_ACC_PUBLIC
)
99 HTTP_REQPOOL_ME(enablePipelining
, ZEND_ACC_PUBLIC
)
103 static zend_object_handlers http_requestpool_object_handlers
;
105 PHP_MINIT_FUNCTION(http_requestpool_object
)
107 HTTP_REGISTER_CLASS_EX(HttpRequestPool
, http_requestpool_object
, NULL
, 0);
108 http_requestpool_object_handlers
.clone_obj
= NULL
;
110 #if defined(HAVE_SPL) && !defined(WONKY)
111 zend_class_implements(http_requestpool_object_ce TSRMLS_CC
, 2, spl_ce_Countable
, zend_ce_iterator
);
113 zend_class_implements(http_requestpool_object_ce TSRMLS_CC
, 1, zend_ce_iterator
);
119 zend_object_value
_http_requestpool_object_new(zend_class_entry
*ce TSRMLS_DC
)
121 zend_object_value ov
;
122 http_requestpool_object
*o
;
124 o
= ecalloc(1, sizeof(http_requestpool_object
));
127 http_request_pool_init(&o
->pool
);
129 ALLOC_HASHTABLE(OBJ_PROP(o
));
130 zend_hash_init(OBJ_PROP(o
), zend_hash_num_elements(&ce
->default_properties
), NULL
, ZVAL_PTR_DTOR
, 0);
131 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
133 ov
.handle
= putObject(http_requestpool_object
, o
);
134 ov
.handlers
= &http_requestpool_object_handlers
;
139 void _http_requestpool_object_free(zend_object
*object TSRMLS_DC
)
141 http_requestpool_object
*o
= (http_requestpool_object
*) object
;
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[, ...]])
157 Creates a new HttpRequestPool object instance. */
158 PHP_METHOD(HttpRequestPool
, __construct
)
160 int argc
= ZEND_NUM_ARGS();
161 zval
***argv
= safe_emalloc(argc
, sizeof(zval
*), 0);
162 getObject(http_requestpool_object
, obj
);
165 if (SUCCESS
== zend_get_parameters_array_ex(argc
, argv
)) {
168 for (i
= 0; i
< argc
; ++i
) {
169 if (Z_TYPE_PP(argv
[i
]) == IS_OBJECT
&& instanceof_function(Z_OBJCE_PP(argv
[i
]), http_request_object_ce TSRMLS_CC
)) {
170 http_request_pool_attach(&obj
->pool
, *(argv
[i
]));
176 http_final(HTTP_EX_CE(request_pool
));
180 /* {{{ proto void HttpRequestPool::__destruct()
181 Clean up HttpRequestPool object. */
182 PHP_METHOD(HttpRequestPool
, __destruct
)
184 getObject(http_requestpool_object
, obj
);
188 http_request_pool_detach_all(&obj
->pool
);
192 /* {{{ proto void HttpRequestPool::reset()
193 Detach all attached HttpRequest objects. */
194 PHP_METHOD(HttpRequestPool
, reset
)
196 getObject(http_requestpool_object
, obj
);
200 obj
->iterator
.pos
= 0;
201 http_request_pool_detach_all(&obj
->pool
);
204 /* {{{ proto bool HttpRequestPool::attach(HttpRequest request)
205 Attach an HttpRequest object to this HttpRequestPool. WARNING: set all options prior attaching! */
206 PHP_METHOD(HttpRequestPool
, attach
)
209 STATUS status
= FAILURE
;
210 getObject(http_requestpool_object
, obj
);
213 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "O", &request
, http_request_object_ce
)) {
214 if (obj
->iterator
.pos
> 0 && obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
)) {
215 http_error(HE_THROW
, HTTP_E_REQUEST_POOL
, "Cannot attach to the HttpRequestPool while the iterator is active");
217 status
= http_request_pool_attach(&obj
->pool
, request
);
221 RETURN_SUCCESS(status
);
225 /* {{{ proto bool HttpRequestPool::detach(HttpRequest request)
226 Detach an HttpRequest object from this HttpRequestPool. */
227 PHP_METHOD(HttpRequestPool
, detach
)
230 STATUS status
= FAILURE
;
231 getObject(http_requestpool_object
, obj
);
234 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "O", &request
, http_request_object_ce
)) {
235 obj
->iterator
.pos
= -1;
236 status
= http_request_pool_detach(&obj
->pool
, request
);
239 RETURN_SUCCESS(status
);
243 /* {{{ proto bool HttpRequestPool::send()
244 Send all attached HttpRequest objects in parallel. */
245 PHP_METHOD(HttpRequestPool
, send
)
248 getObject(http_requestpool_object
, obj
);
253 status
= http_request_pool_send(&obj
->pool
);
256 /* rethrow as HttpRequestPoolException */
257 http_final(HTTP_EX_CE(request_pool
));
259 RETURN_SUCCESS(status
);
263 /* {{{ proto protected bool HttpRequestPool::socketPerform()
264 Returns TRUE until each request has finished its transaction. */
265 PHP_METHOD(HttpRequestPool
, socketPerform
)
267 getObject(http_requestpool_object
, obj
);
271 if (0 < http_request_pool_perform(&obj
->pool
)) {
279 /* {{{ proto protected bool HttpRequestPool::socketSelect() */
280 PHP_METHOD(HttpRequestPool
, socketSelect
)
282 getObject(http_requestpool_object
, obj
);
286 RETURN_SUCCESS(http_request_pool_select(&obj
->pool
));
290 /* {{{ proto bool HttpRequestPool::valid()
291 Implements Iterator::valid(). */
292 PHP_METHOD(HttpRequestPool
, valid
)
296 if (return_value_used
) {
297 getObject(http_requestpool_object
, obj
);
298 RETURN_BOOL(obj
->iterator
.pos
>= 0 && obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
));
303 /* {{{ proto HttpRequest HttpRequestPool::current()
304 Implements Iterator::current(). */
305 PHP_METHOD(HttpRequestPool
, current
)
309 if (return_value_used
) {
311 zval
**current
= NULL
;
312 zend_llist_position lpos
;
313 getObject(http_requestpool_object
, obj
);
315 if (obj
->iterator
.pos
< zend_llist_count(&obj
->pool
.handles
)) {
316 for ( current
= zend_llist_get_first_ex(&obj
->pool
.handles
, &lpos
);
317 current
&& obj
->iterator
.pos
!= pos
++;
318 current
= zend_llist_get_next_ex(&obj
->pool
.handles
, &lpos
));
320 RETURN_OBJECT(*current
, 1);
328 /* {{{ proto int HttpRequestPool::key()
329 Implements Iterator::key(). */
330 PHP_METHOD(HttpRequestPool
, key
)
334 if (return_value_used
) {
335 getObject(http_requestpool_object
, obj
);
336 RETURN_LONG(obj
->iterator
.pos
);
341 /* {{{ proto void HttpRequestPool::next()
342 Implements Iterator::next(). */
343 PHP_METHOD(HttpRequestPool
, next
)
346 getObject(http_requestpool_object
, obj
);
347 ++(obj
->iterator
.pos
);
352 /* {{{ proto void HttpRequestPool::rewind()
353 Implements Iterator::rewind(). */
354 PHP_METHOD(HttpRequestPool
, rewind
)
357 getObject(http_requestpool_object
, obj
);
358 obj
->iterator
.pos
= 0;
363 /* {{{ proto int HttpRequestPool::count()
364 Implements Countable::count(). */
365 PHP_METHOD(HttpRequestPool
, count
)
368 getObject(http_requestpool_object
, obj
);
369 RETURN_LONG((long) zend_llist_count(&obj
->pool
.handles
));
374 /* {{{ proto array HttpRequestPool::getAttachedRequests()
375 Get attached HttpRequest objects. */
376 PHP_METHOD(HttpRequestPool
, getAttachedRequests
)
378 getObject(http_requestpool_object
, obj
);
382 array_init(return_value
);
383 zend_llist_apply_with_argument(&obj
->pool
.handles
,
384 (llist_apply_with_arg_func_t
) http_requestpool_object_llist2array
,
385 return_value TSRMLS_CC
);
389 /* {{{ proto array HttpRequestPool::getFinishedRequests()
390 Get attached HttpRequest objects that already have finished their work. */
391 PHP_METHOD(HttpRequestPool
, getFinishedRequests
)
393 getObject(http_requestpool_object
, obj
);
397 array_init(return_value
);
398 zend_llist_apply_with_argument(&obj
->pool
.finished
,
399 (llist_apply_with_arg_func_t
) http_requestpool_object_llist2array
,
400 return_value TSRMLS_CC
);
404 /* {{{ proto bool HttpRequest::enablePiplelinig([bool enable = true])
405 Enables pipelining support for all attached requests if support in libcurl is given. */
406 PHP_METHOD(HttpRequestPool
, enablePipelining
)
408 zend_bool enable
= 1;
409 getObject(http_requestpool_object
, obj
);
411 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &enable
)) {
414 #if defined(HAVE_CURL_MULTI_SETOPT) && HTTP_CURL_VERSION(7,16,0)
415 if (CURLM_OK
== curl_multi_setopt(obj
->pool
.ch
, CURLMOPT_PIPELINING
, (long) enable
)) {
423 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
430 * vim600: noet sw=4 ts=4 fdm=marker
431 * vim<600: noet sw=4 ts=4