git.m6w6.name Git - m6w6/ext-http/blob - http_request_pool_api.c

   1 /*
   2     +--------------------------------------------------------------------+
   3     | PECL :: http                                                       |
   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     +--------------------------------------------------------------------+
  11 */
  12
  13 /* $Id$ */
  14
  15 #define HTTP_WANT_CURL
  16 #include "php_http.h"
  17
  18 #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
  19
  20 #include "php_http_api.h"
  21 #include "php_http_exception_object.h"
  22 #include "php_http_request_api.h"
  23 #include "php_http_request_object.h"
  24 #include "php_http_request_pool_api.h"
  25 #include "php_http_requestpool_object.h"
  26
  27 #ifndef HTTP_DEBUG_REQPOOLS
  28 #       define HTTP_DEBUG_REQPOOLS 0
  29 #endif
  30
  31 #ifndef HAVE_CURL_MULTI_STRERROR
  32 #       define curl_multi_strerror(dummy) "unknown error"
  33 #endif
  34
  35 static int http_request_pool_compare_handles(void *h1, void *h2);
  36
  37 /* {{{ http_request_pool *http_request_pool_init(http_request_pool *) */
  38 PHP_HTTP_API http_request_pool *_http_request_pool_init(http_request_pool *pool TSRMLS_DC)
  39 {
  40         zend_bool free_pool;
  41
  42 #if HTTP_DEBUG_REQPOOLS
  43         fprintf(stderr, "Initializing request pool %p\n", pool);
  44 #endif
  45
  46         if ((free_pool = (!pool))) {
  47                 pool = emalloc(sizeof(http_request_pool));
  48                 pool->ch = NULL;
  49         }
  50
  51         HTTP_CHECK_CURL_INIT(pool->ch, curl_multi_init(), ;);
  52         if (!pool->ch) {
  53                 if (free_pool) {
  54                         efree(pool);
  55                 }
  56                 return NULL;
  57         }
  58
  59         pool->unfinished = 0;
  60         zend_llist_init(&pool->finished, sizeof(zval *), (llist_dtor_func_t) ZVAL_PTR_DTOR, 0);
  61         zend_llist_init(&pool->handles, sizeof(zval *), (llist_dtor_func_t) ZVAL_PTR_DTOR, 0);
  62
  63 #if HTTP_DEBUG_REQPOOLS
  64         fprintf(stderr, "Initialized request pool %p\n", pool);
  65 #endif
  66
  67         return pool;
  68 }
  69 /* }}} */
  70
  71 /* {{{ STATUS http_request_pool_attach(http_request_pool *, zval *) */
  72 PHP_HTTP_API STATUS _http_request_pool_attach(http_request_pool *pool, zval *request TSRMLS_DC)
  73 {
  74         getObjectEx(http_request_object, req, request);
  75
  76 #if HTTP_DEBUG_REQPOOLS
  77         fprintf(stderr, "Attaching HttpRequest(#%d) %p to pool %p\n", Z_OBJ_HANDLE_P(request), req, pool);
  78 #endif
  79
  80         if (req->pool) {
  81                 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");
  82         } else if (SUCCESS != http_request_object_requesthandler(req, request)) {
  83                 http_error_ex(HE_WARNING, HTTP_E_REQUEST, "Could not initialize HttpRequest object for attaching to the HttpRequestPool");
  84         } else {
  85                 CURLMcode code = curl_multi_add_handle(pool->ch, req->request->ch);
  86
  87                 if ((CURLM_OK != code) && (CURLM_CALL_MULTI_PERFORM != code)) {
  88                         http_error_ex(HE_WARNING, HTTP_E_REQUEST_POOL, "Could not attach HttpRequest object to the HttpRequestPool: %s", curl_multi_strerror(code));
  89                 } else {
  90                         req->pool = pool;
  91
  92                         ZVAL_ADDREF(request);
  93                         zend_llist_add_element(&pool->handles, &request);
  94
  95 #if HTTP_DEBUG_REQPOOLS
  96                         fprintf(stderr, "> %d HttpRequests attached to pool %p\n", zend_llist_count(&pool->handles), pool);
  97 #endif
  98                         return SUCCESS;
  99                 }
 100         }
 101         return FAILURE;
 102 }
 103 /* }}} */
 104
 105 /* {{{ STATUS http_request_pool_detach(http_request_pool *, zval *) */
 106 PHP_HTTP_API STATUS _http_request_pool_detach(http_request_pool *pool, zval *request TSRMLS_DC)
 107 {
 108         CURLMcode code;
 109         getObjectEx(http_request_object, req, request);
 110
 111 #if HTTP_DEBUG_REQPOOLS
 112         fprintf(stderr, "Detaching HttpRequest(#%d) %p from pool %p\n", Z_OBJ_HANDLE_P(request), req, pool);
 113 #endif
 114
 115         if (!req->pool) {
 116                 /* not attached to any pool */
 117 #if HTTP_DEBUG_REQPOOLS
 118                 fprintf(stderr, "HttpRequest object(#%d) %p is not attached to any HttpRequestPool\n", Z_OBJ_HANDLE_P(request), req);
 119 #endif
 120         } else if (req->pool != pool) {
 121                 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "HttpRequest object(#%d) is not attached to this HttpRequestPool", Z_OBJ_HANDLE_P(request));
 122         } else if (CURLM_OK != (code = curl_multi_remove_handle(pool->ch, req->request->ch))) {
 123                 http_error_ex(HE_WARNING, HTTP_E_REQUEST_POOL, "Could not detach HttpRequest object from the HttpRequestPool: %s", curl_multi_strerror(code));
 124         } else {
 125                 req->pool = NULL;
 126                 zend_llist_del_element(&pool->finished, request, http_request_pool_compare_handles);
 127                 zend_llist_del_element(&pool->handles, request, http_request_pool_compare_handles);
 128
 129 #if HTTP_DEBUG_REQPOOLS
 130                 fprintf(stderr, "> %d HttpRequests remaining in pool %p\n", zend_llist_count(&pool->handles), pool);
 131 #endif
 132
 133                 return SUCCESS;
 134         }
 135         return FAILURE;
 136 }
 137 /* }}} */
 138
 139 /* {{{ void http_request_pool_apply(http_request_pool *, http_request_pool_apply_func) */
 140 PHP_HTTP_API void _http_request_pool_apply(http_request_pool *pool, http_request_pool_apply_func cb TSRMLS_DC)
 141 {
 142         int count = zend_llist_count(&pool->handles);
 143
 144         if (count) {
 145                 int i = 0;
 146                 zend_llist_position pos;
 147                 zval **handle, **handles = emalloc(count * sizeof(zval *));
 148
 149                 for (handle = zend_llist_get_first_ex(&pool->handles, &pos); handle; handle = zend_llist_get_next_ex(&pool->handles, &pos)) {
 150                         handles[i++] = *handle;
 151                 }
 152
 153                 /* should never happen */
 154                 if (i != count) {
 155                         zend_error(E_ERROR, "number of fetched request handles do not match overall count");
 156                         count = i;
 157                 }
 158
 159                 for (i = 0; i < count; ++i) {
 160                         if (cb(pool, handles[i] TSRMLS_CC)) {
 161                                 break;
 162                         }
 163                 }
 164                 efree(handles);
 165         }
 166 }
 167 /* }}} */
 168
 169 /* {{{ void http_request_pool_apply_with_arg(http_request_pool *, http_request_pool_apply_with_arg_func, void *) */
 170 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)
 171 {
 172         int count = zend_llist_count(&pool->handles);
 173
 174         if (count) {
 175                 int i = 0;
 176                 zend_llist_position pos;
 177                 zval **handle, **handles = emalloc(count * sizeof(zval *));
 178
 179                 for (handle = zend_llist_get_first_ex(&pool->handles, &pos); handle; handle = zend_llist_get_next_ex(&pool->handles, &pos)) {
 180                         handles[i++] = *handle;
 181                 }
 182
 183                 /* should never happen */
 184                 if (i != count) {
 185                         zend_error(E_ERROR, "number of fetched request handles do not match overall count");
 186                         count = i;
 187                 }
 188
 189                 for (i = 0; i < count; ++i) {
 190                         if (cb(pool, handles[i], arg TSRMLS_CC)) {
 191                                 break;
 192                         }
 193                 }
 194                 efree(handles);
 195         }
 196 }
 197 /* }}} */
 198
 199 /* {{{ void http_request_pool_detach_all(http_request_pool *) */
 200 PHP_HTTP_API void _http_request_pool_detach_all(http_request_pool *pool TSRMLS_DC)
 201 {
 202 #if HTTP_DEBUG_REQPOOLS
 203         fprintf(stderr, "Detaching %d requests from pool %p\n", zend_llist_count(&pool->handles), pool);
 204 #endif
 205         http_request_pool_apply(pool, _http_request_pool_detach);
 206 }
 207 /* }}} */
 208
 209 /* {{{ STATUS http_request_pool_send(http_request_pool *) */
 210 PHP_HTTP_API STATUS _http_request_pool_send(http_request_pool *pool TSRMLS_DC)
 211 {
 212 #if HTTP_DEBUG_REQPOOLS
 213         fprintf(stderr, "Attempt to send %d requests of pool %p\n", zend_llist_count(&pool->handles), pool);
 214 #endif
 215
 216         while (http_request_pool_perform(pool, 0)) {
 217                 if (SUCCESS != http_request_pool_select(pool)) {
 218 #ifdef PHP_WIN32
 219                         /* see http://msdn.microsoft.com/library/en-us/winsock/winsock/windows_sockets_error_codes_2.asp */
 220                         http_error_ex(HE_WARNING, HTTP_E_SOCKET, "WinSock error: %d", WSAGetLastError());
 221 #else
 222                         http_error(HE_WARNING, HTTP_E_SOCKET, strerror(errno));
 223 #endif
 224                         return FAILURE;
 225                 }
 226         }
 227
 228 #if HTTP_DEBUG_REQPOOLS
 229         fprintf(stderr, "Finished sending %d HttpRequests of pool %p (still unfinished: %d)\n", zend_llist_count(&pool->handles), pool, pool->unfinished);
 230 #endif
 231
 232         return SUCCESS;
 233 }
 234 /* }}} */
 235
 236 /* {{{ void http_request_pool_dtor(http_request_pool *) */
 237 PHP_HTTP_API void _http_request_pool_dtor(http_request_pool *pool TSRMLS_DC)
 238 {
 239 #if HTTP_DEBUG_REQPOOLS
 240         fprintf(stderr, "Destructing request pool %p\n", pool);
 241 #endif
 242
 243         pool->unfinished = 0;
 244         zend_llist_clean(&pool->finished);
 245         zend_llist_clean(&pool->handles);
 246         curl_multi_cleanup(pool->ch);
 247 }
 248 /* }}} */
 249
 250 #ifdef PHP_WIN32
 251 #       define SELECT_ERROR SOCKET_ERROR
 252 #else
 253 #       define SELECT_ERROR -1
 254 #endif
 255
 256 /* {{{ STATUS http_request_pool_select(http_request_pool *) */
 257 PHP_HTTP_API STATUS _http_request_pool_select(http_request_pool *pool)
 258 {
 259         int MAX;
 260         fd_set R, W, E;
 261         struct timeval timeout = {1, 0};
 262
 263         FD_ZERO(&R);
 264         FD_ZERO(&W);
 265         FD_ZERO(&E);
 266
 267         if (CURLM_OK == curl_multi_fdset(pool->ch, &R, &W, &E, &MAX)) {
 268                 if (MAX == -1 || SELECT_ERROR != select(MAX + 1, &R, &W, &E, &timeout)) {
 269                         return SUCCESS;
 270                 }
 271         }
 272         return FAILURE;
 273 }
 274 /* }}} */
 275
 276 /* {{{ int http_request_pool_perform(http_request_pool *) */
 277 PHP_HTTP_API int _http_request_pool_perform(http_request_pool *pool, int once TSRMLS_DC)
 278 {
 279         CURLMsg *msg;
 280         int remaining = 0;
 281
 282         while (CURLM_CALL_MULTI_PERFORM == curl_multi_perform(pool->ch, &pool->unfinished));
 283
 284         while ((msg = curl_multi_info_read(pool->ch, &remaining))) {
 285                 if (CURLMSG_DONE == msg->msg) {
 286                                 if (CURLE_OK != msg->data.result) {
 287                                         http_request_pool_try {
 288                                                 http_request *r = NULL;
 289                                                 curl_easy_getinfo(msg->easy_handle, CURLINFO_PRIVATE, &r);
 290                                                 http_error_ex(HE_WARNING, HTTP_E_REQUEST, "%s; %s (%s)", curl_easy_strerror(msg->data.result), r?r->_error:"", r?r->url:"");
 291                                         } http_request_pool_catch();
 292                                 }
 293                                 http_request_pool_try {
 294                                         http_request_pool_apply_with_arg(pool, _http_request_pool_responsehandler, msg->easy_handle);
 295                                 } http_request_pool_catch();
 296                 }
 297         }
 298         if (once || !pool->unfinished) {
 299                 http_request_pool_final();
 300         }
 301
 302         return pool->unfinished;
 303 }
 304 /* }}} */
 305
 306 /* {{{ void http_request_pool_responsehandler(http_request_pool *, zval *, void *) */
 307 int _http_request_pool_responsehandler(http_request_pool *pool, zval *req, void *ch TSRMLS_DC)
 308 {
 309         getObjectEx(http_request_object, obj, req);
 310
 311         if ((!ch) || obj->request->ch == (CURL *) ch) {
 312
 313 #if HTTP_DEBUG_REQPOOLS
 314                 fprintf(stderr, "Fetching data from HttpRequest(#%d) %p of pool %p\n", Z_OBJ_HANDLE_P(req), obj, obj->pool);
 315 #endif
 316
 317                 ZVAL_ADDREF(req);
 318                 zend_llist_add_element(&obj->pool->finished, &req);
 319                 http_request_object_responsehandler(obj, req);
 320                 return 1;
 321         }
 322         return 0;
 323 }
 324 /* }}} */
 325
 326 /*#*/
 327
 328 /* {{{ static int http_request_pool_compare_handles(void *, void *) */
 329 static int http_request_pool_compare_handles(void *h1, void *h2)
 330 {
 331         return (Z_OBJ_HANDLE_PP((zval **) h1) == Z_OBJ_HANDLE_P((zval *) h2));
 332 }
 333 /* }}} */
 334
 335 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
 336
 337
 338 /*
 339  * Local variables:
 340  * tab-width: 4
 341  * c-basic-offset: 4
 342  * End:
 343  * vim600: noet sw=4 ts=4 fdm=marker
 344  * vim<600: noet sw=4 ts=4
 345  */
 346