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