- add doc progress checker
[m6w6/ext-http] / http_request_pool_api.c
index 64224fe5df87217a7a341bf4da62e9372e19240a..27e1f0d819e819dd0fa363bcfd04131369397dbd 100644 (file)
@@ -1,76 +1,73 @@
 /*
-   +----------------------------------------------------------------------+
-   | PECL :: http                                                         |
-   +----------------------------------------------------------------------+
-   | This source file is subject to version 3.0 of the PHP license, that  |
-   | is bundled with this package in the file LICENSE, and is available   |
-   | through the world-wide-web at http://www.php.net/license/3_0.txt.    |
-   | If you did not receive a copy of the PHP license and are unable to   |
-   | obtain it through the world-wide-web, please send a note to          |
-   | license@php.net so we can mail you a copy immediately.               |
-   +----------------------------------------------------------------------+
-   | Copyright (c) 2004-2005 Michael Wallner <mike@php.net>               |
-   +----------------------------------------------------------------------+
+    +--------------------------------------------------------------------+
+    | PECL :: http                                                       |
+    +--------------------------------------------------------------------+
+    | Redistribution and use in source and binary forms, with or without |
+    | modification, are permitted provided that the conditions mentioned |
+    | in the accompanying LICENSE file are met.                          |
+    +--------------------------------------------------------------------+
+    | Copyright (c) 2004-2007, Michael Wallner <mike@php.net>            |
+    +--------------------------------------------------------------------+
 */
 
 /* $Id$ */
 
-#ifdef HAVE_CONFIG_H
-#      include "config.h"
-#endif
-#include "php.h"
+#define HTTP_WANT_CURL
+#include "php_http.h"
 
 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
 
-#include "php_http.h"
-#include "php_http_std_defs.h"
 #include "php_http_api.h"
+#include "php_http_exception_object.h"
+#include "php_http_persistent_handle_api.h"
 #include "php_http_request_api.h"
-#include "php_http_request_pool_api.h"
 #include "php_http_request_object.h"
+#include "php_http_request_pool_api.h"
 #include "php_http_requestpool_object.h"
 
 #ifndef HTTP_DEBUG_REQPOOLS
 #      define HTTP_DEBUG_REQPOOLS 0
 #endif
 
-ZEND_EXTERN_MODULE_GLOBALS(http);
-
-#ifndef HAVE_CURL_MULTI_STRERROR
-#      define curl_multi_strerror(dummy) "unknown error"
-#endif
-
-static void http_request_pool_freebody(http_request_callback_ctx **body);
 static int http_request_pool_compare_handles(void *h1, void *h2);
 
+PHP_MINIT_FUNCTION(http_request_pool)
+{
+       if (SUCCESS != http_persistent_handle_provide("http_request_pool", curl_multi_init, (http_persistent_handle_dtor) curl_multi_cleanup, NULL)) {
+               return FAILURE;
+       }
+       return SUCCESS;
+}
+
 /* {{{ http_request_pool *http_request_pool_init(http_request_pool *) */
 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;
        }
 
-       if (!pool->ch) {
-               if (!(pool->ch = curl_multi_init())) {
-                       http_error(HE_WARNING, HTTP_E_REQUEST, "Could not initialize curl");
-                       if (free_pool) {
-                               efree(pool);
-                       }
-                       return NULL;
+       if (SUCCESS != http_persistent_handle_acquire("http_request_pool", &pool->ch)) {
+               if (free_pool) {
+                       efree(pool);
                }
+               return NULL;
        }
 
        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;
 }
 /* }}} */
@@ -79,38 +76,31 @@ 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 if (SUCCESS != http_request_object_requesthandler(req, request)) {
+               http_error_ex(HE_WARNING, HTTP_E_REQUEST, "Could not initialize HttpRequest object(#%d) for attaching to the HttpRequestPool", Z_OBJ_HANDLE_P(request));
        } else {
-               http_request_callback_ctx *body = http_request_callback_data_ex(http_request_body_new(), 0);
+               CURLMcode code = curl_multi_add_handle(pool->ch, req->request->ch);
 
-               if (SUCCESS != http_request_pool_requesthandler(request, body->data)) {
-                       http_error_ex(HE_WARNING, HTTP_E_REQUEST, "Could not initialize HttpRequest object for attaching to the HttpRequestPool");
+               if ((CURLM_OK != code) && (CURLM_CALL_MULTI_PERFORM != code)) {
+                       http_error_ex(HE_WARNING, HTTP_E_REQUEST_POOL, "Could not attach HttpRequest object(#%d) to the HttpRequestPool: %s", Z_OBJ_HANDLE_P(request), curl_multi_strerror(code));
                } else {
-                       CURLMcode code = curl_multi_add_handle(pool->ch, req->ch);
-
-                       if ((CURLM_OK != code) && (CURLM_CALL_MULTI_PERFORM != code)) {
-                               http_error_ex(HE_WARNING, HTTP_E_REQUEST_POOL, "Could not attach HttpRequest object to the HttpRequestPool: %s", curl_multi_strerror(code));
-                       } else {
-                               req->pool = pool;
+                       req->pool = pool;
 
-                               zend_llist_add_element(&pool->handles, &request);
-                               zend_llist_add_element(&pool->bodies, &body);
-
-                               zval_add_ref(&request);
-                               zend_objects_store_add_ref(request TSRMLS_CC);
+                       ZVAL_ADDREF(request);
+                       zend_llist_add_element(&pool->handles, &request);
 
 #if HTTP_DEBUG_REQPOOLS
-                               fprintf(stderr, "> %d HttpRequests attached to pool %p\n", zend_llist_count(&pool->handles), pool);
+                       fprintf(stderr, "> %d HttpRequests attached to pool %p\n", zend_llist_count(&pool->handles), pool);
 #endif
-                               return SUCCESS;
-                       }
+                       return SUCCESS;
                }
-               efree(body->data);
-               efree(body);
        }
        return FAILURE;
 }
@@ -119,10 +109,13 @@ PHP_HTTP_API STATUS _http_request_pool_attach(http_request_pool *pool, zval *req
 /* {{{ STATUS http_request_pool_detach(http_request_pool *, zval *) */
 PHP_HTTP_API STATUS _http_request_pool_detach(http_request_pool *pool, zval *request TSRMLS_DC)
 {
+       CURLMcode code;
        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
@@ -130,36 +123,30 @@ PHP_HTTP_API STATUS _http_request_pool_detach(http_request_pool *pool, zval *req
 #endif
        } else if (req->pool != pool) {
                http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "HttpRequest object(#%d) is not attached to this HttpRequestPool", Z_OBJ_HANDLE_P(request));
+       } else if (req->request->_in_progress_cb) {
+               http_error_ex(HE_WARNING, HTTP_E_REQUEST_POOL, "HttpRequest object(#%d) cannot be detached from the HttpRequestPool while executing the progress callback", Z_OBJ_HANDLE_P(request));
+       } else if (CURLM_OK != (code = curl_multi_remove_handle(pool->ch, req->request->ch))) {
+               http_error_ex(HE_WARNING, HTTP_E_REQUEST_POOL, "Could not detach HttpRequest object(#%d) from the HttpRequestPool: %s", Z_OBJ_HANDLE_P(request), curl_multi_strerror(code));
        } else {
-               CURLMcode code;
-
                req->pool = NULL;
+               zend_llist_del_element(&pool->finished, request, http_request_pool_compare_handles);
                zend_llist_del_element(&pool->handles, 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 {
-                       return SUCCESS;
-               }
+       
+               return SUCCESS;
        }
        return FAILURE;
 }
 /* }}} */
 
-/* {{{ void http_request_pool_detach_all(http_request_pool *) */
-PHP_HTTP_API void _http_request_pool_detach_all(http_request_pool *pool TSRMLS_DC)
+/* {{{ void http_request_pool_apply(http_request_pool *, http_request_pool_apply_func) */
+PHP_HTTP_API void _http_request_pool_apply(http_request_pool *pool, http_request_pool_apply_func cb 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 --
-        * so let's get our hands dirty
-        */
+       
        if (count) {
                int i = 0;
                zend_llist_position pos;
@@ -168,23 +155,62 @@ 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]);
+                       if (cb(pool, handles[i] TSRMLS_CC)) {
+                               break;
+                       }
                }
                efree(handles);
        }
+}
+/* }}} */
+
+/* {{{ void http_request_pool_apply_with_arg(http_request_pool *, http_request_pool_apply_with_arg_func, void *) */
+PHP_HTTP_API void _http_request_pool_apply_with_arg(http_request_pool *pool, http_request_pool_apply_with_arg_func cb, void *arg TSRMLS_DC)
+{
+       int count = zend_llist_count(&pool->handles);
+       
+       if (count) {
+               int i = 0;
+               zend_llist_position pos;
+               zval **handle, **handles = emalloc(count * sizeof(zval *));
+
+               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) {
+                       if (cb(pool, handles[i], arg TSRMLS_CC)) {
+                               break;
+                       }
+               }
+               efree(handles);
+       }
+}
+/* }}} */
+
+/* {{{ void http_request_pool_detach_all(http_request_pool *) */
+PHP_HTTP_API void _http_request_pool_detach_all(http_request_pool *pool TSRMLS_DC)
+{
 #if HTTP_DEBUG_REQPOOLS
-       fprintf(srderr, "Destroying %d request bodies of pool %p\n", zend_llist_count(&pool->bodies), pool);
+       fprintf(stderr, "Detaching %d requests from pool %p\n", zend_llist_count(&pool->handles), pool);
 #endif
-       /* free created bodies too */
-       zend_llist_clean(&pool->bodies);
+       http_request_pool_apply(pool, _http_request_pool_detach);
 }
-
+/* }}} */
 
 /* {{{ STATUS http_request_pool_send(http_request_pool *) */
 PHP_HTTP_API STATUS _http_request_pool_send(http_request_pool *pool TSRMLS_DC)
@@ -192,23 +218,23 @@ 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 HTTP_DEBUG_REQPOOLS
-               fprintf(stderr, "> %d unfinished requests of pool %p remaining\n", pool->unfinished, pool);
-#endif
                if (SUCCESS != http_request_pool_select(pool)) {
 #ifdef PHP_WIN32
-                       http_error(HE_WARNING, HTTP_E_SOCKET, WSAGetLastError());
+                       /* see http://msdn.microsoft.com/library/en-us/winsock/winsock/windows_sockets_error_codes_2.asp */
+                       http_error_ex(HE_WARNING, HTTP_E_SOCKET, "WinSock error: %d", WSAGetLastError());
 #else
                        http_error(HE_WARNING, HTTP_E_SOCKET, strerror(errno));
 #endif
                        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);
 #endif
-       zend_llist_apply(&pool->handles, (llist_apply_func_t) http_request_pool_responsehandler TSRMLS_CC);
+       
        return SUCCESS;
 }
 /* }}} */
@@ -219,79 +245,100 @@ 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);
+       http_persistent_handle_release("http_request_pool", &pool->ch);
 }
 /* }}} */
 
+#ifdef PHP_WIN32
+#      define SELECT_ERROR SOCKET_ERROR
+#else
+#      define SELECT_ERROR -1
+#endif
+
 /* {{{ STATUS http_request_pool_select(http_request_pool *) */
 PHP_HTTP_API STATUS _http_request_pool_select(http_request_pool *pool)
 {
        int MAX;
        fd_set R, W, E;
        struct timeval timeout = {1, 0};
+#ifdef HAVE_CURL_MULTI_TIMEOUT
+       long max_tout = 1000;
+       
+       if ((CURLM_OK == curl_multi_timeout(pool->ch, &max_tout)) && (max_tout != -1)) {
+               timeout.tv_sec = max_tout / 1000;
+               timeout.tv_usec = (max_tout % 1000) * 1000;
+       }
+#endif
 
        FD_ZERO(&R);
        FD_ZERO(&W);
        FD_ZERO(&E);
 
-       curl_multi_fdset(pool->ch, &R, &W, &E, &MAX);
-       return (-1 != select(MAX + 1, &R, &W, &E, &timeout)) ? SUCCESS : FAILURE;
+       if (CURLM_OK == curl_multi_fdset(pool->ch, &R, &W, &E, &MAX)) {
+               if (MAX == -1) {
+                       http_sleep((double) timeout.tv_sec + (double) (timeout.tv_usec / HTTP_MCROSEC));
+                       return SUCCESS;
+               } else if (SELECT_ERROR != select(MAX + 1, &R, &W, &E, &timeout)) {
+                       return SUCCESS;
+               }
+       }
+       return FAILURE;
 }
 /* }}} */
 
 /* {{{ 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));
-       return pool->unfinished;
-}
-/* }}} */
-
-/* {{{ STATUS http_request_pool_requesthandler(zval *, http_request_body *) */
-STATUS _http_request_pool_requesthandler(zval *request, http_request_body *body TSRMLS_DC)
-{
-       getObjectEx(http_request_object, req, request);
-       if (SUCCESS == http_request_object_requesthandler(req, request, body)) {
-               http_request_conv(req->ch, &req->response, &req->request);
-               return SUCCESS;
+       
+       while ((msg = curl_multi_info_read(pool->ch, &remaining))) {
+               if (CURLMSG_DONE == msg->msg) {
+                               if (CURLE_OK != msg->data.result) {
+                                       http_request *r = NULL;
+                                       curl_easy_getinfo(msg->easy_handle, CURLINFO_PRIVATE, &r);
+                                       http_error_ex(HE_WARNING, HTTP_E_REQUEST, "%s; %s (%s)", curl_easy_strerror(msg->data.result), r?r->_error:"", r?r->url:"");
+                               }
+                               http_request_pool_apply_with_arg(pool, _http_request_pool_responsehandler, msg->easy_handle);
+               }
        }
-       return FAILURE;
+       
+       return pool->unfinished;
 }
 /* }}} */
 
-/* {{{ void http_request_pool_responsehandler(zval **) */
-void _http_request_pool_responsehandler(zval **req TSRMLS_DC)
+/* {{{ void http_request_pool_responsehandler(http_request_pool *, zval *, void *) */
+int _http_request_pool_responsehandler(http_request_pool *pool, zval *req, void *ch TSRMLS_DC)
 {
-       getObjectEx(http_request_object, obj, *req);
+       getObjectEx(http_request_object, obj, req);
+       
+       if ((!ch) || obj->request->ch == (CURL *) 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_P(req), obj, obj->pool);
 #endif
-       http_request_object_responsehandler(obj, *req);
+               
+               ZVAL_ADDREF(req);
+               zend_llist_add_element(&obj->pool->finished, &req);
+               http_request_object_responsehandler(obj, req);
+               return 1;
+       }
+       return 0;
 }
 /* }}} */
 
 /*#*/
 
-/* {{{ static void http_request_pool_freebody(http_request_ctx **) */
-static void http_request_pool_freebody(http_request_callback_ctx **body)
-{
-       HTTP_REQUEST_CALLBACK_DATA(*body, http_request_body *, b);
-       http_request_body_free(b);
-       efree(*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));
 }
 /* }}} */