From aa931f5b858c3d8513e883ae913f0704557ca540 Mon Sep 17 00:00:00 2001 From: Michael Wallner Date: Tue, 18 Oct 2005 09:34:42 +0000 Subject: [PATCH] - add HttpRequestPool::getFinishedRequests(), so now it's possible to process finished requests while others are still running --- http_request_pool_api.c | 72 ++++++++++++++++++++++++---------- http_requestpool_object.c | 66 ++++++++++++++++++++++++++++--- package2.xml | 1 + php_http_request_pool_api.h | 7 ++-- php_http_requestpool_object.h | 2 + tests/HttpRequestPool_002.phpt | 49 +++++++++++++++++++++++ 6 files changed, 168 insertions(+), 29 deletions(-) create mode 100644 tests/HttpRequestPool_002.phpt diff --git a/http_request_pool_api.c b/http_request_pool_api.c index cca4fba..f557494 100644 --- a/http_request_pool_api.c +++ b/http_request_pool_api.c @@ -47,9 +47,11 @@ static int http_request_pool_compare_handles(void *h1, void *h2); PHP_HTTP_API http_request_pool *_http_request_pool_init(http_request_pool *pool TSRMLS_DC) { zend_bool free_pool; + #if HTTP_DEBUG_REQPOOLS fprintf(stderr, "Initializing request pool %p\n", pool); #endif + if ((free_pool = (!pool))) { pool = emalloc(sizeof(http_request_pool)); pool->ch = NULL; @@ -64,11 +66,14 @@ PHP_HTTP_API http_request_pool *_http_request_pool_init(http_request_pool *pool } pool->unfinished = 0; + zend_llist_init(&pool->finished, sizeof(zval *), (llist_dtor_func_t) ZVAL_PTR_DTOR, 0); zend_llist_init(&pool->handles, sizeof(zval *), (llist_dtor_func_t) ZVAL_PTR_DTOR, 0); zend_llist_init(&pool->bodies, sizeof(http_request_callback_ctx *), (llist_dtor_func_t) http_request_pool_freebody, 0); + #if HTTP_DEBUG_REQPOOLS fprintf(stderr, "Initialized request pool %p\n", pool); #endif + return pool; } /* }}} */ @@ -77,9 +82,11 @@ PHP_HTTP_API http_request_pool *_http_request_pool_init(http_request_pool *pool PHP_HTTP_API STATUS _http_request_pool_attach(http_request_pool *pool, zval *request TSRMLS_DC) { getObjectEx(http_request_object, req, request); + #if HTTP_DEBUG_REQPOOLS fprintf(stderr, "Attaching HttpRequest(#%d) %p to pool %p\n", Z_OBJ_HANDLE_P(request), req, pool); #endif + if (req->pool) { http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "HttpRequest object(#%d) is already member of %s HttpRequestPool", Z_OBJ_HANDLE_P(request), req->pool == pool ? "this" : "another"); } else { @@ -118,9 +125,11 @@ PHP_HTTP_API STATUS _http_request_pool_attach(http_request_pool *pool, zval *req PHP_HTTP_API STATUS _http_request_pool_detach(http_request_pool *pool, zval *request TSRMLS_DC) { getObjectEx(http_request_object, req, request); + #if HTTP_DEBUG_REQPOOLS fprintf(stderr, "Detaching HttpRequest(#%d) %p from pool %p\n", Z_OBJ_HANDLE_P(request), req, pool); #endif + if (!req->pool) { /* not attached to any pool */ #if HTTP_DEBUG_REQPOOLS @@ -133,9 +142,12 @@ PHP_HTTP_API STATUS _http_request_pool_detach(http_request_pool *pool, zval *req req->pool = NULL; zend_llist_del_element(&pool->handles, request, http_request_pool_compare_handles); + zend_llist_del_element(&pool->finished, request, http_request_pool_compare_handles); + #if HTTP_DEBUG_REQPOOLS fprintf(stderr, "> %d HttpRequests remaining in pool %p\n", zend_llist_count(&pool->handles), pool); #endif + if (CURLM_OK != (code = curl_multi_remove_handle(pool->ch, req->ch))) { http_error_ex(HE_WARNING, HTTP_E_REQUEST_POOL, "Could not detach HttpRequest object from the HttpRequestPool: %s", curl_multi_strerror(code)); } else { @@ -150,9 +162,11 @@ PHP_HTTP_API STATUS _http_request_pool_detach(http_request_pool *pool, zval *req PHP_HTTP_API void _http_request_pool_detach_all(http_request_pool *pool TSRMLS_DC) { int count = zend_llist_count(&pool->handles); + #if HTTP_DEBUG_REQPOOLS fprintf(stderr, "Detaching %d requests from pool %p\n", count, pool); #endif + /* * we cannot apply a function to the llist which actually detaches * the curl handle *and* removes the llist element -- @@ -166,19 +180,23 @@ PHP_HTTP_API void _http_request_pool_detach_all(http_request_pool *pool TSRMLS_D for (handle = zend_llist_get_first_ex(&pool->handles, &pos); handle; handle = zend_llist_get_next_ex(&pool->handles, &pos)) { handles[i++] = *handle; } + /* should never happen */ if (i != count) { zend_error(E_ERROR, "number of fetched request handles do not match overall count"); count = i; } + for (i = 0; i < count; ++i) { http_request_pool_detach(pool, handles[i]); } efree(handles); } + #if HTTP_DEBUG_REQPOOLS fprintf(stderr, "Destroying %d request bodies of pool %p\n", zend_llist_count(&pool->bodies), pool); #endif + /* free created bodies too */ zend_llist_clean(&pool->bodies); } @@ -189,6 +207,7 @@ PHP_HTTP_API STATUS _http_request_pool_send(http_request_pool *pool TSRMLS_DC) #if HTTP_DEBUG_REQPOOLS fprintf(stderr, "Attempt to send %d requests of pool %p\n", zend_llist_count(&pool->handles), pool); #endif + while (http_request_pool_perform(pool)) { if (SUCCESS != http_request_pool_select(pool)) { #ifdef PHP_WIN32 @@ -199,21 +218,11 @@ PHP_HTTP_API STATUS _http_request_pool_send(http_request_pool *pool TSRMLS_DC) return FAILURE; } } + #if HTTP_DEBUG_REQPOOLS fprintf(stderr, "Finished sending %d HttpRequests of pool %p (still unfinished: %d)\n", zend_llist_count(&pool->handles), pool, pool->unfinished); - { - int remaining = 0; - CURLMsg *msg; - /* - * FIXXME: populate --somehow - */ - do { - if (msg = curl_multi_info_read(pool->ch, &remaining)) - fprintf(stderr, "CURL: %s (%d)\n", curl_easy_strerror(msg->data.result), msg->data.result); - } while (remaining); - } #endif - zend_llist_apply(&pool->handles, (llist_apply_func_t) http_request_pool_responsehandler TSRMLS_CC); + return SUCCESS; } /* }}} */ @@ -224,7 +233,9 @@ PHP_HTTP_API void _http_request_pool_dtor(http_request_pool *pool TSRMLS_DC) #if HTTP_DEBUG_REQPOOLS fprintf(stderr, "Destructing request pool %p\n", pool); #endif + pool->unfinished = 0; + zend_llist_clean(&pool->finished); zend_llist_clean(&pool->handles); zend_llist_clean(&pool->bodies); curl_multi_cleanup(pool->ch); @@ -248,9 +259,24 @@ PHP_HTTP_API STATUS _http_request_pool_select(http_request_pool *pool) /* }}} */ /* {{{ int http_request_pool_perform(http_request_pool *) */ -PHP_HTTP_API int _http_request_pool_perform(http_request_pool *pool) +PHP_HTTP_API int _http_request_pool_perform(http_request_pool *pool TSRMLS_DC) { + CURLMsg *msg; + int remaining = 0; + while (CURLM_CALL_MULTI_PERFORM == curl_multi_perform(pool->ch, &pool->unfinished)); + + while (msg = curl_multi_info_read(pool->ch, &remaining)) { + if (CURLMSG_DONE == msg->msg) { + +#if HTTP_DEBUG_REQPOOLS + fprintf(stderr, "Done CURL handle: %p (remaining: %d)\n", msg->easy_handle, remaining); +#endif + + zend_llist_apply_with_argument(&pool->handles, (llist_apply_with_arg_func_t) http_request_pool_responsehandler, msg->easy_handle TSRMLS_CC); + } + } + return pool->unfinished; } /* }}} */ @@ -268,13 +294,21 @@ STATUS _http_request_pool_requesthandler(zval *request, http_request_body *body /* }}} */ /* {{{ void http_request_pool_responsehandler(zval **) */ -void _http_request_pool_responsehandler(zval **req TSRMLS_DC) +void _http_request_pool_responsehandler(zval **req, CURL *ch TSRMLS_DC) { getObjectEx(http_request_object, obj, *req); + + if (obj->ch == ch) { + #if HTTP_DEBUG_REQPOOLS - fprintf(stderr, "Fetching data from HttpRequest(#%d) %p of pool %p\n", Z_OBJ_HANDLE_PP(req), obj, obj->pool); + fprintf(stderr, "Fetching data from HttpRequest(#%d) %p of pool %p\n", Z_OBJ_HANDLE_PP(req), obj, obj->pool); #endif - http_request_object_responsehandler(obj, *req); + + zval_add_ref(req); + zend_objects_store_add_ref(*req TSRMLS_CC); + zend_llist_add_element(&obj->pool->finished, req); + http_request_object_responsehandler(obj, *req); + } } /* }}} */ @@ -292,11 +326,7 @@ static void http_request_pool_freebody(http_request_callback_ctx **body) /* {{{ static int http_request_pool_compare_handles(void *, void *) */ static int http_request_pool_compare_handles(void *h1, void *h2) { - int match = (Z_OBJ_HANDLE_PP((zval **) h1) == Z_OBJ_HANDLE_P((zval *) h2)); -#if HTTP_DEBUG_REQPOOLS - /* if(match) fprintf(stderr, "OK\n"); */ -#endif - return match; + return (Z_OBJ_HANDLE_PP((zval **) h1) == Z_OBJ_HANDLE_P((zval *) h2)); } /* }}} */ diff --git a/http_requestpool_object.c b/http_requestpool_object.c index 58aec24..f9f463c 100644 --- a/http_requestpool_object.c +++ b/http_requestpool_object.c @@ -68,6 +68,13 @@ HTTP_EMPTY_ARGS(key, 0); HTTP_EMPTY_ARGS(next, 0); HTTP_EMPTY_ARGS(rewind, 0); +HTTP_EMPTY_ARGS(getAttachedRequests, 0); +HTTP_EMPTY_ARGS(getFinishedRequests, 0); + +HTTP_BEGIN_ARGS(setRequestOptions, 0) + HTTP_ARG_VAL(options, 0) +HTTP_END_ARGS; + #define http_requestpool_object_declare_default_properties() _http_requestpool_object_declare_default_properties(TSRMLS_C) static inline void _http_requestpool_object_declare_default_properties(TSRMLS_D); @@ -89,6 +96,9 @@ zend_function_entry http_requestpool_object_fe[] = { HTTP_REQPOOL_ME(key, ZEND_ACC_PUBLIC) HTTP_REQPOOL_ME(next, ZEND_ACC_PUBLIC) HTTP_REQPOOL_ME(rewind, ZEND_ACC_PUBLIC) + + HTTP_REQPOOL_ME(getAttachedRequests, ZEND_ACC_PUBLIC) + HTTP_REQPOOL_ME(getFinishedRequests, ZEND_ACC_PUBLIC) EMPTY_FUNCTION_ENTRY }; @@ -140,6 +150,14 @@ void _http_requestpool_object_free(zend_object *object TSRMLS_DC) efree(o); } +#define http_requestpool_object_llist2array _http_requestpool_object_llist2array +static void _http_requestpool_object_llist2array(zval **req, zval *array TSRMLS_DC) +{ + zval_add_ref(req); + zend_objects_store_add_ref(*req TSRMLS_CC); + add_next_index_zval(array, *req); +} + /* ### USERLAND ### */ /* {{{ proto void HttpRequestPool::__construct([HttpRequest request[, ...]]) @@ -314,12 +332,27 @@ PHP_METHOD(HttpRequestPool, send) * Usage: * 
  * socketPerform()) {
- *         do_something_else();
- *         if (!$pool->socketSelect()) {
- *             die('Socket error');
+ * class MyPool extends HttpRequestPool
+ * {
+ *     public function send()
+ *     {
+ *         while ($this->socketPerform()) {
+ *             $this->handleRequests();
+ *             if (!$this->socketSelect()) {
+ *                 throw new HttpSocketExcpetion;
+ *             }
+ *         }
+ *         $this->handleRequests();
+ *     }
+ *     
+ *     private function handleRequests()
+ *     {
+ *         foreach ($this->getFinishedRequests() as $r) {
+ *             $this->detach($r);
+ *             // handle response of finished request
  *         }
  *     }
+ * } 
  * ?>
  *
*/ @@ -332,7 +365,6 @@ PHP_METHOD(HttpRequestPool, socketPerform) if (0 < http_request_pool_perform(&obj->pool)) { RETURN_TRUE; } else { - zend_llist_apply(&obj->pool.handles, (llist_apply_func_t) http_request_pool_responsehandler TSRMLS_CC); RETURN_FALSE; } } @@ -439,6 +471,30 @@ PHP_METHOD(HttpRequestPool, rewind) } /* }}} */ +PHP_METHOD(HttpRequestPool, getAttachedRequests) +{ + getObject(http_requestpool_object, obj); + + NO_ARGS; + + array_init(return_value); + zend_llist_apply_with_argument(&obj->pool.handles, + (llist_apply_with_arg_func_t) http_requestpool_object_llist2array, + return_value TSRMLS_CC); +} + +PHP_METHOD(HttpRequestPool, getFinishedRequests) +{ + getObject(http_requestpool_object, obj); + + NO_ARGS; + + array_init(return_value); + zend_llist_apply_with_argument(&obj->pool.finished, + (llist_apply_with_arg_func_t) http_requestpool_object_llist2array, + return_value TSRMLS_CC); +} + #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */ /* diff --git a/package2.xml b/package2.xml index 7e41801..155f847 100644 --- a/package2.xml +++ b/package2.xml @@ -40,6 +40,7 @@ PHP License diff --git a/php_http_request_pool_api.h b/php_http_request_pool_api.h index 9f87005..ead52dd 100644 --- a/php_http_request_pool_api.h +++ b/php_http_request_pool_api.h @@ -31,13 +31,14 @@ typedef struct { CURLM *ch; + zend_llist finished; zend_llist handles; zend_llist bodies; int unfinished; } http_request_pool; #define http_request_pool_responsehandler _http_request_pool_responsehandler -extern void _http_request_pool_responsehandler(zval **req TSRMLS_DC); +extern void _http_request_pool_responsehandler(zval **req, CURL *ch TSRMLS_DC); #define http_request_pool_requesthandler(r, b) _http_request_pool_requesthandler((r), (b) TSRMLS_CC) extern STATUS _http_request_pool_requesthandler(zval *request, http_request_body *body TSRMLS_DC); @@ -59,8 +60,8 @@ PHP_HTTP_API STATUS _http_request_pool_send(http_request_pool *pool TSRMLS_DC); #define http_request_pool_select _http_request_pool_select PHP_HTTP_API STATUS _http_request_pool_select(http_request_pool *pool); -#define http_request_pool_perform _http_request_pool_perform -PHP_HTTP_API int _http_request_pool_perform(http_request_pool *pool); +#define http_request_pool_perform(p) _http_request_pool_perform((p) TSRMLS_CC) +PHP_HTTP_API int _http_request_pool_perform(http_request_pool *pool TSRMLS_DC); #define http_request_pool_dtor(p) _http_request_pool_dtor((p) TSRMLS_CC) PHP_HTTP_API void _http_request_pool_dtor(http_request_pool *pool TSRMLS_DC); diff --git a/php_http_requestpool_object.h b/php_http_requestpool_object.h index 49bb78c..19e4bc3 100644 --- a/php_http_requestpool_object.h +++ b/php_http_requestpool_object.h @@ -59,6 +59,8 @@ PHP_METHOD(HttpRequestPool, current); PHP_METHOD(HttpRequestPool, key); PHP_METHOD(HttpRequestPool, next); PHP_METHOD(HttpRequestPool, rewind); +PHP_METHOD(HttpRequestPool, getAttachedRequests); +PHP_METHOD(HttpRequestPool, getFinishedRequests); #endif #endif diff --git a/tests/HttpRequestPool_002.phpt b/tests/HttpRequestPool_002.phpt new file mode 100644 index 0000000..053f1f6 --- /dev/null +++ b/tests/HttpRequestPool_002.phpt @@ -0,0 +1,49 @@ +--TEST-- +extending HttpRequestPool +--SKIPIF-- + +--FILE-- +socketPerform()) { + $this->handleRequests(); + if (!$this->socketSelect()) { + throw new HttpSocketException; + } + } + $this->handleRequests(); + } + + private function handleRequests() + { + echo "."; + foreach ($this->getFinishedRequests() as $r) { + echo "=", $r->getResponseCode(), "="; + $this->detach($r); + } + } +} + +$pool = new MyPool( + new HttpRequest('http://www.php.net/', HTTP_METH_HEAD), + new HttpRequest('http://at.php.net/', HTTP_METH_HEAD), + new HttpRequest('http://de.php.net/', HTTP_METH_HEAD), + new HttpRequest('http://ch.php.net/', HTTP_METH_HEAD) +); + +$pool->send(); + +echo "\nDone\n"; +?> +--EXPECTREGEX-- +.+TEST +\.+=200=\.+=200=\.+=200=\.+=200= +Done -- 2.30.2