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                                 Z_OBJ_ADDREF_P(request);
 107
 108 #if HTTP_DEBUG_REQPOOLS
 109                                 fprintf(stderr, "> %d HttpRequests attached to pool %p\n", zend_llist_count(&pool->handles), pool);
 110 #endif
 111                                 return SUCCESS;
 112                         }
 113                 }
 114                 efree(body->data);
 115                 efree(body);
 116         }
 117         return FAILURE;
 118 }
 119 /* }}} */
 120
 121 /* {{{ STATUS http_request_pool_detach(http_request_pool *, zval *) */
 122 PHP_HTTP_API STATUS _http_request_pool_detach(http_request_pool *pool, zval *request TSRMLS_DC)
 123 {
 124         getObjectEx(http_request_object, req, request);
 125
 126 #if HTTP_DEBUG_REQPOOLS
 127         fprintf(stderr, "Detaching HttpRequest(#%d) %p from pool %p\n", Z_OBJ_HANDLE_P(request), req, pool);
 128 #endif
 129
 130         if (!req->pool) {
 131                 /* not attached to any pool */
 132 #if HTTP_DEBUG_REQPOOLS
 133                 fprintf(stderr, "HttpRequest object(#%d) %p is not attached to any HttpRequestPool\n", Z_OBJ_HANDLE_P(request), req);
 134 #endif
 135         } else if (req->pool != pool) {
 136                 http_error_ex(HE_WARNING, HTTP_E_INVALID_PARAM, "HttpRequest object(#%d) is not attached to this HttpRequestPool", Z_OBJ_HANDLE_P(request));
 137         } else {
 138                 CURLMcode code;
 139
 140                 req->pool = NULL;
 141                 zend_llist_del_element(&pool->handles, request, http_request_pool_compare_handles);
 142                 zend_llist_del_element(&pool->finished, request, http_request_pool_compare_handles);
 143
 144 #if HTTP_DEBUG_REQPOOLS
 145                 fprintf(stderr, "> %d HttpRequests remaining in pool %p\n", zend_llist_count(&pool->handles), pool);
 146 #endif
 147
 148                 if (CURLM_OK != (code = curl_multi_remove_handle(pool->ch, req->ch))) {
 149                         http_error_ex(HE_WARNING, HTTP_E_REQUEST_POOL, "Could not detach HttpRequest object from the HttpRequestPool: %s", curl_multi_strerror(code));
 150                 } else {
 151                         return SUCCESS;
 152                 }
 153         }
 154         return FAILURE;
 155 }
 156 /* }}} */
 157
 158 /* {{{ void http_request_pool_detach_all(http_request_pool *) */
 159 PHP_HTTP_API void _http_request_pool_detach_all(http_request_pool *pool TSRMLS_DC)
 160 {
 161         int count = zend_llist_count(&pool->handles);
 162
 163 #if HTTP_DEBUG_REQPOOLS
 164         fprintf(stderr, "Detaching %d requests from pool %p\n", count, pool);
 165 #endif
 166
 167         /*
 168          * we cannot apply a function to the llist which actually detaches
 169          * the curl handle *and* removes the llist element --
 170          * so let's get our hands dirty
 171          */
 172         if (count) {
 173                 int i = 0;
 174                 zend_llist_position pos;
 175                 zval **handle, **handles = emalloc(count * sizeof(zval *));
 176
 177                 for (handle = zend_llist_get_first_ex(&pool->handles, &pos); handle; handle = zend_llist_get_next_ex(&pool->handles, &pos)) {
 178                         handles[i++] = *handle;
 179                 }
 180
 181                 /* should never happen */
 182                 if (i != count) {
 183                         zend_error(E_ERROR, "number of fetched request handles do not match overall count");
 184                         count = i;
 185                 }
 186
 187                 for (i = 0; i < count; ++i) {
 188                         http_request_pool_detach(pool, handles[i]);
 189                 }
 190                 efree(handles);
 191         }
 192
 193 #if HTTP_DEBUG_REQPOOLS
 194         fprintf(stderr, "Destroying %d request bodies of pool %p\n", zend_llist_count(&pool->bodies), pool);
 195 #endif
 196
 197         /* free created bodies too */
 198         zend_llist_clean(&pool->bodies);
 199 }
 200
 201 /* {{{ STATUS http_request_pool_send(http_request_pool *) */
 202 PHP_HTTP_API STATUS _http_request_pool_send(http_request_pool *pool TSRMLS_DC)
 203 {
 204 #if HTTP_DEBUG_REQPOOLS
 205         fprintf(stderr, "Attempt to send %d requests of pool %p\n", zend_llist_count(&pool->handles), pool);
 206 #endif
 207
 208         while (http_request_pool_perform(pool)) {
 209                 if (SUCCESS != http_request_pool_select(pool)) {
 210 #ifdef PHP_WIN32
 211                         http_error(HE_WARNING, HTTP_E_SOCKET, WSAGetLastError());
 212 #else
 213                         http_error(HE_WARNING, HTTP_E_SOCKET, strerror(errno));
 214 #endif
 215                         return FAILURE;
 216                 }
 217         }
 218
 219 #if HTTP_DEBUG_REQPOOLS
 220         fprintf(stderr, "Finished sending %d HttpRequests of pool %p (still unfinished: %d)\n", zend_llist_count(&pool->handles), pool, pool->unfinished);
 221 #endif
 222
 223         return SUCCESS;
 224 }
 225 /* }}} */
 226
 227 /* {{{ void http_request_pool_dtor(http_request_pool *) */
 228 PHP_HTTP_API void _http_request_pool_dtor(http_request_pool *pool TSRMLS_DC)
 229 {
 230 #if HTTP_DEBUG_REQPOOLS
 231         fprintf(stderr, "Destructing request pool %p\n", pool);
 232 #endif
 233
 234         pool->unfinished = 0;
 235         zend_llist_clean(&pool->finished);
 236         zend_llist_clean(&pool->handles);
 237         zend_llist_clean(&pool->bodies);
 238         curl_multi_cleanup(pool->ch);
 239 }
 240 /* }}} */
 241
 242 /* {{{ STATUS http_request_pool_select(http_request_pool *) */
 243 PHP_HTTP_API STATUS _http_request_pool_select(http_request_pool *pool)
 244 {
 245         int MAX;
 246         fd_set R, W, E;
 247         struct timeval timeout = {1, 0};
 248
 249         FD_ZERO(&R);
 250         FD_ZERO(&W);
 251         FD_ZERO(&E);
 252
 253         curl_multi_fdset(pool->ch, &R, &W, &E, &MAX);
 254         return (-1 != select(MAX + 1, &R, &W, &E, &timeout)) ? SUCCESS : FAILURE;
 255 }
 256 /* }}} */
 257
 258 /* {{{ int http_request_pool_perform(http_request_pool *) */
 259 PHP_HTTP_API int _http_request_pool_perform(http_request_pool *pool TSRMLS_DC)
 260 {
 261         CURLMsg *msg;
 262         int remaining = 0;
 263
 264         while (CURLM_CALL_MULTI_PERFORM == curl_multi_perform(pool->ch, &pool->unfinished));
 265
 266         while (msg = curl_multi_info_read(pool->ch, &remaining)) {
 267                 if (CURLMSG_DONE == msg->msg) {
 268
 269 #if HTTP_DEBUG_REQPOOLS
 270                         fprintf(stderr, "Done CURL handle: %p (remaining: %d)\n", msg->easy_handle, remaining);
 271 #endif
 272
 273                         zend_llist_apply_with_argument(&pool->handles, (llist_apply_with_arg_func_t) http_request_pool_responsehandler, msg->easy_handle TSRMLS_CC);
 274                 }
 275         }
 276
 277         return pool->unfinished;
 278 }
 279 /* }}} */
 280
 281 /* {{{ STATUS http_request_pool_requesthandler(zval *, http_request_body *) */
 282 STATUS _http_request_pool_requesthandler(zval *request, http_request_body *body TSRMLS_DC)
 283 {
 284         getObjectEx(http_request_object, req, request);
 285         if (SUCCESS == http_request_object_requesthandler(req, request, body)) {
 286                 http_request_conv(req->ch, &req->response, &req->request);
 287                 return SUCCESS;
 288         }
 289         return FAILURE;
 290 }
 291 /* }}} */
 292
 293 /* {{{ void http_request_pool_responsehandler(zval **) */
 294 void _http_request_pool_responsehandler(zval **req, CURL *ch TSRMLS_DC)
 295 {
 296         getObjectEx(http_request_object, obj, *req);
 297
 298         if (obj->ch == ch) {
 299
 300 #if HTTP_DEBUG_REQPOOLS
 301                 fprintf(stderr, "Fetching data from HttpRequest(#%d) %p of pool %p\n", Z_OBJ_HANDLE_PP(req), obj, obj->pool);
 302 #endif
 303
 304                 ZVAL_ADDREF(*req);
 305                 Z_OBJ_ADDREF_PP(req);
 306                 zend_llist_add_element(&obj->pool->finished, req);
 307                 http_request_object_responsehandler(obj, *req);
 308         }
 309 }
 310 /* }}} */
 311
 312 /*#*/
 313
 314 /* {{{ static void http_request_pool_freebody(http_request_ctx **) */
 315 static void http_request_pool_freebody(http_request_callback_ctx **body)
 316 {
 317         HTTP_REQUEST_CALLBACK_DATA(*body, http_request_body *, b);
 318         http_request_body_free(b);
 319         efree(*body);
 320 }
 321 /* }}} */
 322
 323 /* {{{ static int http_request_pool_compare_handles(void *, void *) */
 324 static int http_request_pool_compare_handles(void *h1, void *h2)
 325 {
 326         return (Z_OBJ_HANDLE_PP((zval **) h1) == Z_OBJ_HANDLE_P((zval *) h2));
 327 }
 328 /* }}} */
 329
 330 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
 331
 332
 333 /*
 334  * Local variables:
 335  * tab-width: 4
 336  * c-basic-offset: 4
 337  * End:
 338  * vim600: noet sw=4 ts=4 fdm=marker
 339  * vim<600: noet sw=4 ts=4
 340  */
 341