git.m6w6.name Git - m6w6/ext-http/blob - http_requestpool_object.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-2007, 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 "zend_interfaces.h"
  21
  22 #include "php_http_api.h"
  23 #include "php_http_exception_object.h"
  24 #include "php_http_request_api.h"
  25 #include "php_http_request_object.h"
  26 #include "php_http_request_pool_api.h"
  27 #include "php_http_requestpool_object.h"
  28
  29 #if defined(HAVE_SPL) && !defined(WONKY)
  30 /* SPL doesn't install its headers */
  31 extern PHPAPI zend_class_entry *spl_ce_Countable;
  32 #endif
  33
  34 #define HTTP_BEGIN_ARGS(method, req_args)       HTTP_BEGIN_ARGS_EX(HttpRequestPool, method, 0, req_args)
  35 #define HTTP_EMPTY_ARGS(method)                         HTTP_EMPTY_ARGS_EX(HttpRequestPool, method, 0)
  36 #define HTTP_REQPOOL_ME(method, visibility)     PHP_ME(HttpRequestPool, method, HTTP_ARGS(HttpRequestPool, method), visibility)
  37
  38 HTTP_EMPTY_ARGS(__construct);
  39
  40 HTTP_EMPTY_ARGS(__destruct);
  41 HTTP_EMPTY_ARGS(reset);
  42
  43 HTTP_BEGIN_ARGS(attach, 1)
  44         HTTP_ARG_OBJ(HttpRequest, request, 0)
  45 HTTP_END_ARGS;
  46
  47 HTTP_BEGIN_ARGS(detach, 1)
  48         HTTP_ARG_OBJ(HttpRequest, request, 0)
  49 HTTP_END_ARGS;
  50
  51 HTTP_EMPTY_ARGS(send);
  52 HTTP_EMPTY_ARGS(socketPerform);
  53 HTTP_BEGIN_ARGS(socketSelect, 0)
  54         HTTP_ARG_VAL(timeout, 0)
  55 HTTP_END_ARGS;
  56
  57 HTTP_EMPTY_ARGS(valid);
  58 HTTP_EMPTY_ARGS(current);
  59 HTTP_EMPTY_ARGS(key);
  60 HTTP_EMPTY_ARGS(next);
  61 HTTP_EMPTY_ARGS(rewind);
  62
  63 HTTP_EMPTY_ARGS(count);
  64
  65 HTTP_EMPTY_ARGS(getAttachedRequests);
  66 HTTP_EMPTY_ARGS(getFinishedRequests);
  67
  68 HTTP_BEGIN_ARGS(enablePipelining, 0)
  69         HTTP_ARG_VAL(enable, 0)
  70 HTTP_END_ARGS;
  71
  72 HTTP_BEGIN_ARGS(enableEvents, 0)
  73         HTTP_ARG_VAL(enable, 0)
  74 HTTP_END_ARGS;
  75
  76 zend_class_entry *http_requestpool_object_ce;
  77 zend_function_entry http_requestpool_object_fe[] = {
  78         HTTP_REQPOOL_ME(__construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
  79         HTTP_REQPOOL_ME(__destruct, ZEND_ACC_PUBLIC|ZEND_ACC_DTOR)
  80         HTTP_REQPOOL_ME(attach, ZEND_ACC_PUBLIC)
  81         HTTP_REQPOOL_ME(detach, ZEND_ACC_PUBLIC)
  82         HTTP_REQPOOL_ME(send, ZEND_ACC_PUBLIC)
  83         HTTP_REQPOOL_ME(reset, ZEND_ACC_PUBLIC)
  84
  85         HTTP_REQPOOL_ME(socketPerform, ZEND_ACC_PROTECTED)
  86         HTTP_REQPOOL_ME(socketSelect, ZEND_ACC_PROTECTED)
  87
  88         /* implements Iterator */
  89         HTTP_REQPOOL_ME(valid, ZEND_ACC_PUBLIC)
  90         HTTP_REQPOOL_ME(current, ZEND_ACC_PUBLIC)
  91         HTTP_REQPOOL_ME(key, ZEND_ACC_PUBLIC)
  92         HTTP_REQPOOL_ME(next, ZEND_ACC_PUBLIC)
  93         HTTP_REQPOOL_ME(rewind, ZEND_ACC_PUBLIC)
  94
  95         /* implmenents Countable */
  96         HTTP_REQPOOL_ME(count, ZEND_ACC_PUBLIC)
  97
  98         HTTP_REQPOOL_ME(getAttachedRequests, ZEND_ACC_PUBLIC)
  99         HTTP_REQPOOL_ME(getFinishedRequests, ZEND_ACC_PUBLIC)
 100
 101         HTTP_REQPOOL_ME(enablePipelining, ZEND_ACC_PUBLIC)
 102         HTTP_REQPOOL_ME(enableEvents, ZEND_ACC_PUBLIC)
 103
 104         EMPTY_FUNCTION_ENTRY
 105 };
 106 static zend_object_handlers http_requestpool_object_handlers;
 107
 108 PHP_MINIT_FUNCTION(http_requestpool_object)
 109 {
 110         HTTP_REGISTER_CLASS_EX(HttpRequestPool, http_requestpool_object, NULL, 0);
 111         http_requestpool_object_handlers.clone_obj = NULL;
 112
 113 #if defined(HAVE_SPL) && !defined(WONKY)
 114         zend_class_implements(http_requestpool_object_ce TSRMLS_CC, 2, spl_ce_Countable, zend_ce_iterator);
 115 #else
 116         zend_class_implements(http_requestpool_object_ce TSRMLS_CC, 1, zend_ce_iterator);
 117 #endif
 118
 119         return SUCCESS;
 120 }
 121
 122 zend_object_value _http_requestpool_object_new(zend_class_entry *ce TSRMLS_DC)
 123 {
 124         zend_object_value ov;
 125         http_requestpool_object *o;
 126
 127         o = ecalloc(1, sizeof(http_requestpool_object));
 128         o->zo.ce = ce;
 129
 130         http_request_pool_init(&o->pool);
 131
 132         ALLOC_HASHTABLE(OBJ_PROP(o));
 133         zend_hash_init(OBJ_PROP(o), zend_hash_num_elements(&ce->default_properties), NULL, ZVAL_PTR_DTOR, 0);
 134         zend_hash_copy(OBJ_PROP(o), &ce->default_properties, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
 135
 136         ov.handle = putObject(http_requestpool_object, o);
 137         ov.handlers = &http_requestpool_object_handlers;
 138
 139         return ov;
 140 }
 141
 142 void _http_requestpool_object_free(zend_object *object TSRMLS_DC)
 143 {
 144         http_requestpool_object *o = (http_requestpool_object *) object;
 145
 146         http_request_pool_dtor(&o->pool);
 147         freeObject(o);
 148 }
 149
 150 #define http_requestpool_object_llist2array _http_requestpool_object_llist2array
 151 static void _http_requestpool_object_llist2array(zval **req, zval *array TSRMLS_DC)
 152 {
 153         ZVAL_ADDREF(*req);
 154         add_next_index_zval(array, *req);
 155 }
 156
 157 /* ### USERLAND ### */
 158
 159 /* {{{ proto void HttpRequestPool::__construct([HttpRequest request[, ...]])
 160         Creates a new HttpRequestPool object instance. */
 161 PHP_METHOD(HttpRequestPool, __construct)
 162 {
 163         int argc = ZEND_NUM_ARGS();
 164         zval ***argv = safe_emalloc(argc, sizeof(zval *), 0);
 165         getObject(http_requestpool_object, obj);
 166
 167         SET_EH_THROW_HTTP();
 168         if (SUCCESS == zend_get_parameters_array_ex(argc, argv)) {
 169                 int i;
 170
 171                 for (i = 0; i < argc; ++i) {
 172                         if (Z_TYPE_PP(argv[i]) == IS_OBJECT && instanceof_function(Z_OBJCE_PP(argv[i]), http_request_object_ce TSRMLS_CC)) {
 173                                 http_request_pool_attach(&obj->pool, *(argv[i]));
 174                         }
 175                 }
 176         }
 177         efree(argv);
 178         http_final(HTTP_EX_CE(request_pool));
 179         SET_EH_NORMAL();
 180 }
 181 /* }}} */
 182
 183 /* {{{ proto void HttpRequestPool::__destruct()
 184         Clean up HttpRequestPool object. */
 185 PHP_METHOD(HttpRequestPool, __destruct)
 186 {
 187         getObject(http_requestpool_object, obj);
 188
 189         NO_ARGS;
 190
 191         http_request_pool_detach_all(&obj->pool);
 192 }
 193 /* }}} */
 194
 195 /* {{{ proto void HttpRequestPool::reset()
 196         Detach all attached HttpRequest objects. */
 197 PHP_METHOD(HttpRequestPool, reset)
 198 {
 199         getObject(http_requestpool_object, obj);
 200
 201         NO_ARGS;
 202
 203         obj->iterator.pos = 0;
 204         http_request_pool_detach_all(&obj->pool);
 205 }
 206
 207 /* {{{ proto bool HttpRequestPool::attach(HttpRequest request)
 208         Attach an HttpRequest object to this HttpRequestPool. WARNING: set all options prior attaching! */
 209 PHP_METHOD(HttpRequestPool, attach)
 210 {
 211         zval *request;
 212         STATUS status = FAILURE;
 213         getObject(http_requestpool_object, obj);
 214
 215         SET_EH_THROW_HTTP();
 216         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "O", &request, http_request_object_ce)) {
 217                 if (obj->iterator.pos > 0 && obj->iterator.pos < zend_llist_count(&obj->pool.handles)) {
 218                         http_error(HE_THROW, HTTP_E_REQUEST_POOL, "Cannot attach to the HttpRequestPool while the iterator is active");
 219                 } else {
 220                         status = http_request_pool_attach(&obj->pool, request);
 221                 }
 222         }
 223         SET_EH_NORMAL();
 224         RETURN_SUCCESS(status);
 225 }
 226 /* }}} */
 227
 228 /* {{{ proto bool HttpRequestPool::detach(HttpRequest request)
 229         Detach an HttpRequest object from this HttpRequestPool. */
 230 PHP_METHOD(HttpRequestPool, detach)
 231 {
 232         zval *request;
 233         STATUS status = FAILURE;
 234         getObject(http_requestpool_object, obj);
 235
 236         SET_EH_THROW_HTTP();
 237         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "O", &request, http_request_object_ce)) {
 238                 obj->iterator.pos = -1;
 239                 status = http_request_pool_detach(&obj->pool, request);
 240         }
 241         SET_EH_NORMAL();
 242         RETURN_SUCCESS(status);
 243 }
 244 /* }}} */
 245
 246 /* {{{ proto bool HttpRequestPool::send()
 247         Send all attached HttpRequest objects in parallel. */
 248 PHP_METHOD(HttpRequestPool, send)
 249 {
 250         STATUS status;
 251         getObject(http_requestpool_object, obj);
 252
 253         NO_ARGS;
 254
 255         SET_EH_THROW_HTTP();
 256         status = http_request_pool_send(&obj->pool);
 257         SET_EH_NORMAL();
 258
 259         /* rethrow as HttpRequestPoolException */
 260         http_final(HTTP_EX_CE(request_pool));
 261
 262         RETURN_SUCCESS(status);
 263 }
 264 /* }}} */
 265
 266 /* {{{ proto protected bool HttpRequestPool::socketPerform()
 267         Returns TRUE until each request has finished its transaction. */
 268 PHP_METHOD(HttpRequestPool, socketPerform)
 269 {
 270         getObject(http_requestpool_object, obj);
 271
 272         NO_ARGS;
 273
 274         if (0 < http_request_pool_perform(&obj->pool)) {
 275                 RETURN_TRUE;
 276         } else {
 277                 RETURN_FALSE;
 278         }
 279 }
 280 /* }}} */
 281
 282 /* {{{ proto protected bool HttpRequestPool::socketSelect([double timeout]) */
 283 PHP_METHOD(HttpRequestPool, socketSelect)
 284 {
 285         double timeout = 0;
 286         struct timeval custom_timeout, *custom_timeout_ptr = NULL;
 287         getObject(http_requestpool_object, obj);
 288
 289         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|d", &timeout)) {
 290                 RETURN_FALSE;
 291         }
 292         if (ZEND_NUM_ARGS() && timeout > 0) {
 293                 custom_timeout.tv_sec = (time_t) timeout;
 294                 custom_timeout.tv_usec = HTTP_USEC(timeout) % HTTP_MCROSEC;
 295                 custom_timeout_ptr = &custom_timeout;
 296         }
 297
 298         RETURN_SUCCESS(http_request_pool_select_ex(&obj->pool, custom_timeout_ptr));
 299 }
 300 /* }}} */
 301
 302 /* {{{ proto bool HttpRequestPool::valid()
 303         Implements Iterator::valid(). */
 304 PHP_METHOD(HttpRequestPool, valid)
 305 {
 306         NO_ARGS;
 307
 308         if (return_value_used) {
 309                 getObject(http_requestpool_object, obj);
 310                 RETURN_BOOL(obj->iterator.pos >= 0 && obj->iterator.pos < zend_llist_count(&obj->pool.handles));
 311         }
 312 }
 313 /* }}} */
 314
 315 /* {{{ proto HttpRequest HttpRequestPool::current()
 316         Implements Iterator::current(). */
 317 PHP_METHOD(HttpRequestPool, current)
 318 {
 319         NO_ARGS;
 320
 321         if (return_value_used) {
 322                 long pos = 0;
 323                 zval **current = NULL;
 324                 zend_llist_position lpos;
 325                 getObject(http_requestpool_object, obj);
 326
 327                 if (obj->iterator.pos < zend_llist_count(&obj->pool.handles)) {
 328                         for (   current = zend_llist_get_first_ex(&obj->pool.handles, &lpos);
 329                                         current && obj->iterator.pos != pos++;
 330                                         current = zend_llist_get_next_ex(&obj->pool.handles, &lpos));
 331                         if (current) {
 332                                 RETURN_OBJECT(*current, 1);
 333                         }
 334                 }
 335                 RETURN_NULL();
 336         }
 337 }
 338 /* }}} */
 339
 340 /* {{{ proto int HttpRequestPool::key()
 341         Implements Iterator::key(). */
 342 PHP_METHOD(HttpRequestPool, key)
 343 {
 344         NO_ARGS;
 345
 346         if (return_value_used) {
 347                 getObject(http_requestpool_object, obj);
 348                 RETURN_LONG(obj->iterator.pos);
 349         }
 350 }
 351 /* }}} */
 352
 353 /* {{{ proto void HttpRequestPool::next()
 354         Implements Iterator::next(). */
 355 PHP_METHOD(HttpRequestPool, next)
 356 {
 357         NO_ARGS {
 358                 getObject(http_requestpool_object, obj);
 359                 ++(obj->iterator.pos);
 360         }
 361 }
 362 /* }}} */
 363
 364 /* {{{ proto void HttpRequestPool::rewind()
 365         Implements Iterator::rewind(). */
 366 PHP_METHOD(HttpRequestPool, rewind)
 367 {
 368         NO_ARGS {
 369                 getObject(http_requestpool_object, obj);
 370                 obj->iterator.pos = 0;
 371         }
 372 }
 373 /* }}} */
 374
 375 /* {{{ proto int HttpRequestPool::count()
 376         Implements Countable::count(). */
 377 PHP_METHOD(HttpRequestPool, count)
 378 {
 379         NO_ARGS {
 380                 getObject(http_requestpool_object, obj);
 381                 RETURN_LONG((long) zend_llist_count(&obj->pool.handles));
 382         }
 383 }
 384 /* }}} */
 385
 386 /* {{{ proto array HttpRequestPool::getAttachedRequests()
 387         Get attached HttpRequest objects. */
 388 PHP_METHOD(HttpRequestPool, getAttachedRequests)
 389 {
 390         getObject(http_requestpool_object, obj);
 391
 392         NO_ARGS;
 393
 394         array_init(return_value);
 395         zend_llist_apply_with_argument(&obj->pool.handles,
 396                 (llist_apply_with_arg_func_t) http_requestpool_object_llist2array,
 397                 return_value TSRMLS_CC);
 398 }
 399 /* }}} */
 400
 401 /* {{{ proto array HttpRequestPool::getFinishedRequests()
 402         Get attached HttpRequest objects that already have finished their work. */
 403 PHP_METHOD(HttpRequestPool, getFinishedRequests)
 404 {
 405         getObject(http_requestpool_object, obj);
 406
 407         NO_ARGS;
 408
 409         array_init(return_value);
 410         zend_llist_apply_with_argument(&obj->pool.finished,
 411                 (llist_apply_with_arg_func_t) http_requestpool_object_llist2array,
 412                 return_value TSRMLS_CC);
 413 }
 414 /* }}} */
 415
 416 /* {{{ proto bool HttpRequestPool::enablePipelining([bool enable = true])
 417         Enables pipelining support for all attached requests if support in libcurl is given. */
 418 PHP_METHOD(HttpRequestPool, enablePipelining)
 419 {
 420         zend_bool enable = 1;
 421 #if defined(HAVE_CURL_MULTI_SETOPT) && HTTP_CURL_VERSION(7,16,0)
 422         getObject(http_requestpool_object, obj);
 423 #endif
 424
 425         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &enable)) {
 426                 RETURN_FALSE;
 427         }
 428 #if defined(HAVE_CURL_MULTI_SETOPT) && HTTP_CURL_VERSION(7,16,0)
 429         if (CURLM_OK == curl_multi_setopt(obj->pool.ch, CURLMOPT_PIPELINING, (long) enable)) {
 430                 RETURN_TRUE;
 431         }
 432 #endif
 433         RETURN_FALSE;
 434 }
 435 /* }}} */
 436
 437 /* {{{ proto bool HttpRequestPool::enableEvents([bool enable = true])
 438         Enables event-driven I/O if support in libcurl is given. */
 439 PHP_METHOD(HttpRequestPool, enableEvents)
 440 {
 441         zend_bool enable = 1;
 442 #if defined(HTTP_HAVE_EVENT)
 443         getObject(http_requestpool_object, obj);
 444 #endif
 445
 446         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &enable)) {
 447 #if defined(HTTP_HAVE_EVENT)
 448                 obj->pool.useevents = enable;
 449                 RETURN_TRUE;
 450 #endif
 451         }
 452         RETURN_FALSE;
 453 }
 454 /* }}} */
 455
 456 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
 457
 458 /*
 459  * Local variables:
 460  * tab-width: 4
 461  * c-basic-offset: 4
 462  * End:
 463  * vim600: noet sw=4 ts=4 fdm=marker
 464  * vim<600: noet sw=4 ts=4
 465  */
 466