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-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 "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, ret_ref)        HTTP_EMPTY_ARGS_EX(HttpRequestPool, method, ret_ref)
  36 #define HTTP_REQPOOL_ME(method, visibility)     PHP_ME(HttpRequestPool, method, HTTP_ARGS(HttpRequestPool, method), visibility)
  37
  38 HTTP_BEGIN_ARGS(__construct, 0)
  39         HTTP_ARG_OBJ(HttpRequest, request0, 0)
  40         HTTP_ARG_OBJ(HttpRequest, request1, 0)
  41         HTTP_ARG_OBJ(HttpRequest, requestN, 0)
  42 HTTP_END_ARGS;
  43
  44 HTTP_EMPTY_ARGS(__destruct, 0);
  45 HTTP_EMPTY_ARGS(reset, 0);
  46
  47 HTTP_BEGIN_ARGS(attach, 1)
  48         HTTP_ARG_OBJ(HttpRequest, request, 0)
  49 HTTP_END_ARGS;
  50
  51 HTTP_BEGIN_ARGS(detach, 1)
  52         HTTP_ARG_OBJ(HttpRequest, request, 0)
  53 HTTP_END_ARGS;
  54
  55 HTTP_EMPTY_ARGS(send, 0);
  56 HTTP_EMPTY_ARGS(socketPerform, 0);
  57 HTTP_EMPTY_ARGS(socketSelect, 0);
  58
  59 HTTP_EMPTY_ARGS(valid, 0);
  60 HTTP_EMPTY_ARGS(current, 1);
  61 HTTP_EMPTY_ARGS(key, 0);
  62 HTTP_EMPTY_ARGS(next, 0);
  63 HTTP_EMPTY_ARGS(rewind, 0);
  64
  65 HTTP_EMPTY_ARGS(count, 0);
  66
  67 HTTP_EMPTY_ARGS(getAttachedRequests, 0);
  68 HTTP_EMPTY_ARGS(getFinishedRequests, 0);
  69
  70 #define http_requestpool_object_declare_default_properties() _http_requestpool_object_declare_default_properties(TSRMLS_C)
  71 static inline void _http_requestpool_object_declare_default_properties(TSRMLS_D);
  72
  73 zend_class_entry *http_requestpool_object_ce;
  74 zend_function_entry http_requestpool_object_fe[] = {
  75         HTTP_REQPOOL_ME(__construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
  76         HTTP_REQPOOL_ME(__destruct, ZEND_ACC_PUBLIC|ZEND_ACC_DTOR)
  77         HTTP_REQPOOL_ME(attach, ZEND_ACC_PUBLIC)
  78         HTTP_REQPOOL_ME(detach, ZEND_ACC_PUBLIC)
  79         HTTP_REQPOOL_ME(send, ZEND_ACC_PUBLIC)
  80         HTTP_REQPOOL_ME(reset, ZEND_ACC_PUBLIC)
  81
  82         HTTP_REQPOOL_ME(socketPerform, ZEND_ACC_PROTECTED)
  83         HTTP_REQPOOL_ME(socketSelect, ZEND_ACC_PROTECTED)
  84
  85         /* implements Iterator */
  86         HTTP_REQPOOL_ME(valid, ZEND_ACC_PUBLIC)
  87         HTTP_REQPOOL_ME(current, ZEND_ACC_PUBLIC)
  88         HTTP_REQPOOL_ME(key, ZEND_ACC_PUBLIC)
  89         HTTP_REQPOOL_ME(next, ZEND_ACC_PUBLIC)
  90         HTTP_REQPOOL_ME(rewind, ZEND_ACC_PUBLIC)
  91
  92         /* implmenents Countable */
  93         HTTP_REQPOOL_ME(count, ZEND_ACC_PUBLIC)
  94
  95         HTTP_REQPOOL_ME(getAttachedRequests, ZEND_ACC_PUBLIC)
  96         HTTP_REQPOOL_ME(getFinishedRequests, ZEND_ACC_PUBLIC)
  97
  98         EMPTY_FUNCTION_ENTRY
  99 };
 100 static zend_object_handlers http_requestpool_object_handlers;
 101
 102 PHP_MINIT_FUNCTION(http_requestpool_object)
 103 {
 104         HTTP_REGISTER_CLASS_EX(HttpRequestPool, http_requestpool_object, NULL, 0);
 105 #if defined(HAVE_SPL) && !defined(WONKY)
 106         zend_class_implements(http_requestpool_object_ce TSRMLS_CC, 2, spl_ce_Countable, zend_ce_iterator);
 107 #else
 108         zend_class_implements(http_requestpool_object_ce TSRMLS_CC, 1, zend_ce_iterator);
 109 #endif
 110
 111         http_requestpool_object_handlers.clone_obj = NULL;
 112         return SUCCESS;
 113 }
 114
 115 zend_object_value _http_requestpool_object_new(zend_class_entry *ce TSRMLS_DC)
 116 {
 117         zend_object_value ov;
 118         http_requestpool_object *o;
 119
 120         o = ecalloc(1, sizeof(http_requestpool_object));
 121         o->zo.ce = ce;
 122
 123         http_request_pool_init(&o->pool);
 124
 125         ALLOC_HASHTABLE(OBJ_PROP(o));
 126         zend_hash_init(OBJ_PROP(o), 0, NULL, ZVAL_PTR_DTOR, 0);
 127         zend_hash_copy(OBJ_PROP(o), &ce->default_properties, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
 128
 129         ov.handle = putObject(http_requestpool_object, o);
 130         ov.handlers = &http_requestpool_object_handlers;
 131
 132         return ov;
 133 }
 134
 135 static inline void _http_requestpool_object_declare_default_properties(TSRMLS_D)
 136 {
 137         zend_class_entry *ce = http_requestpool_object_ce;
 138
 139         DCL_PROP_N(PROTECTED, pool);
 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         if (OBJ_PROP(o)) {
 147                 zend_hash_destroy(OBJ_PROP(o));
 148                 FREE_HASHTABLE(OBJ_PROP(o));
 149         }
 150         http_request_pool_dtor(&o->pool);
 151         efree(o);
 152 }
 153
 154 #define http_requestpool_object_llist2array _http_requestpool_object_llist2array
 155 static void _http_requestpool_object_llist2array(zval **req, zval *array TSRMLS_DC)
 156 {
 157         ZVAL_ADDREF(*req);
 158         add_next_index_zval(array, *req);
 159 }
 160
 161 /* ### USERLAND ### */
 162
 163 /* {{{ proto void HttpRequestPool::__construct([HttpRequest request[, ...]])
 164  *
 165  * Instantiate a new HttpRequestPool object.  An HttpRequestPool is
 166  * able to send several HttpRequests in parallel.
 167  *
 168  * WARNING: Don't attach/detach HttpRequest objects to the HttpRequestPool
 169  * object while you're using the implemented Iterator interface.
 170  *
 171  * Accepts virtual infinite optional parameters each referencing an
 172  * HttpRequest object.
 173  *
 174  * Throws HttpRequestPoolException (HttpRequestException, HttpInvalidParamException).
 175  *
 176  * Example:
 177  * <pre>
 178  * <?php
 179  * try {
 180  *     $pool = new HttpRequestPool(
 181  *         new HttpRequest('http://www.google.com/', HttpRequest::METH_HEAD),
 182  *         new HttpRequest('http://www.php.net/', HttpRequest::METH_HEAD)
 183  *     );
 184  *     $pool->send();
 185  *     foreach($pool as $request) {
 186  *         printf("%s is %s (%d)\n",
 187  *             $request->getUrl(),
 188  *             $request->getResponseCode() ? 'alive' : 'not alive',
 189  *             $request->getResponseCode()
 190  *         );
 191  *     }
 192  * } catch (HttpException $e) {
 193  *     echo $e;
 194  * }
 195  * ?>
 196  * </pre>
 197  */
 198 PHP_METHOD(HttpRequestPool, __construct)
 199 {
 200         int argc = ZEND_NUM_ARGS();
 201         zval ***argv = safe_emalloc(argc, sizeof(zval *), 0);
 202         getObject(http_requestpool_object, obj);
 203
 204         SET_EH_THROW_HTTP();
 205         if (SUCCESS == zend_get_parameters_array_ex(argc, argv)) {
 206                 int i;
 207
 208                 for (i = 0; i < argc; ++i) {
 209                         if (Z_TYPE_PP(argv[i]) == IS_OBJECT && instanceof_function(Z_OBJCE_PP(argv[i]), http_request_object_ce TSRMLS_CC)) {
 210                                 http_request_pool_try {
 211                                         http_request_pool_attach(&obj->pool, *(argv[i]));
 212                                 } http_request_pool_catch();
 213                         }
 214                 }
 215                 http_request_pool_final();
 216         }
 217         efree(argv);
 218         SET_EH_NORMAL();
 219 }
 220 /* }}} */
 221
 222 /* {{{ proto void HttpRequestPool::__destruct()
 223  *
 224  * Clean up HttpRequestPool object.
 225  */
 226 PHP_METHOD(HttpRequestPool, __destruct)
 227 {
 228         getObject(http_requestpool_object, obj);
 229
 230         NO_ARGS;
 231
 232         http_request_pool_detach_all(&obj->pool);
 233 }
 234 /* }}} */
 235
 236 /* {{{ proto void HttpRequestPool::reset()
 237  *
 238  * Detach all attached HttpRequest objects.
 239  */
 240 PHP_METHOD(HttpRequestPool, reset)
 241 {
 242         getObject(http_requestpool_object, obj);
 243
 244         NO_ARGS;
 245
 246         obj->iterator.pos = 0;
 247         http_request_pool_detach_all(&obj->pool);
 248 }
 249
 250 /* {{{ proto bool HttpRequestPool::attach(HttpRequest request)
 251  *
 252  * Attach an HttpRequest object to this HttpRequestPool.
 253  * WARNING: set all options prior attaching!
 254  *
 255  * Expects the parameter to be an HttpRequest object not alread attached to
 256  * antother HttpRequestPool object.
 257  *
 258  * Returns TRUE on success, or FALSE on failure.
 259  *
 260  * Throws HttpInvalidParamException, HttpRequestException,
 261  * HttpRequestPoolException, HttpEncodingException.
 262  */
 263 PHP_METHOD(HttpRequestPool, attach)
 264 {
 265         zval *request;
 266         STATUS status = FAILURE;
 267         getObject(http_requestpool_object, obj);
 268
 269         SET_EH_THROW_HTTP();
 270         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "O", &request, http_request_object_ce)) {
 271                 if (obj->iterator.pos > 0 && obj->iterator.pos < zend_llist_count(&obj->pool.handles)) {
 272                         http_error(HE_THROW, HTTP_E_REQUEST_POOL, "Cannot attach to the HttpRequestPool while the iterator is active");
 273                 } else {
 274                         status = http_request_pool_attach(&obj->pool, request);
 275                 }
 276         }
 277         SET_EH_NORMAL();
 278         RETURN_SUCCESS(status);
 279 }
 280 /* }}} */
 281
 282 /* {{{ proto bool HttpRequestPool::detach(HttpRequest request)
 283  *
 284  * Detach an HttpRequest object from this HttpRequestPool.
 285  *
 286  * Expects the parameter to be an HttpRequest object attached to this
 287  * HttpRequestPool object.
 288  *
 289  * Returns TRUE on success, or FALSE on failure.
 290  *
 291  * Throws HttpInvalidParamException, HttpRequestPoolException.
 292  */
 293 PHP_METHOD(HttpRequestPool, detach)
 294 {
 295         zval *request;
 296         STATUS status = FAILURE;
 297         getObject(http_requestpool_object, obj);
 298
 299         SET_EH_THROW_HTTP();
 300         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "O", &request, http_request_object_ce)) {
 301                 obj->iterator.pos = -1;
 302                 status = http_request_pool_detach(&obj->pool, request);
 303         }
 304         SET_EH_NORMAL();
 305         RETURN_SUCCESS(status);
 306 }
 307 /* }}} */
 308
 309 /* {{{ proto bool HttpRequestPool::send()
 310  *
 311  * Send all attached HttpRequest objects in parallel.
 312  *
 313  * Returns TRUE on success, or FALSE on failure.
 314  *
 315  * Throws HttpRequestPoolException (HttpSocketException, HttpRequestException, HttpMalformedHeaderException).
 316  */
 317 PHP_METHOD(HttpRequestPool, send)
 318 {
 319         STATUS status;
 320         getObject(http_requestpool_object, obj);
 321
 322         NO_ARGS;
 323
 324         SET_EH_THROW_HTTP();
 325         status = http_request_pool_send(&obj->pool);
 326         SET_EH_NORMAL();
 327
 328         RETURN_SUCCESS(status);
 329 }
 330 /* }}} */
 331
 332 /* {{{ proto protected bool HttpRequestPool::socketPerform()
 333  *
 334  * Returns TRUE until each request has finished its transaction.
 335  *
 336  * Usage:
 337  * <pre>
 338  * <?php
 339  * class MyPool extends HttpRequestPool
 340  * {
 341  *     public function send()
 342  *     {
 343  *         while ($this->socketPerform()) {
 344  *             if (!$this->socketSelect()) {
 345  *                 throw new HttpSocketExcpetion;
 346  *             }
 347  *         }
 348  *     }
 349  *
 350  *     protected final function socketPerform()
 351  *     {
 352  *         $result = parent::socketPerform();
 353  *         foreach ($this->getFinishedRequests() as $r) {
 354  *             $this->detach($r);
 355  *             // handle response of finished request
 356  *         }
 357  *         return $result;
 358  *     }
 359  * }
 360  * ?>
 361  * </pre>
 362  */
 363 PHP_METHOD(HttpRequestPool, socketPerform)
 364 {
 365         getObject(http_requestpool_object, obj);
 366
 367         NO_ARGS;
 368
 369         if (0 < http_request_pool_perform(&obj->pool)) {
 370                 RETURN_TRUE;
 371         } else {
 372                 RETURN_FALSE;
 373         }
 374 }
 375 /* }}} */
 376
 377 /* {{{ proto protected bool HttpRequestPool::socketSelect()
 378  *
 379  * See HttpRequestPool::socketPerform().
 380  *
 381  * Returns TRUE on success, or FALSE on failure.
 382  */
 383 PHP_METHOD(HttpRequestPool, socketSelect)
 384 {
 385         getObject(http_requestpool_object, obj);
 386
 387         NO_ARGS;
 388
 389         RETURN_SUCCESS(http_request_pool_select(&obj->pool));
 390 }
 391 /* }}} */
 392
 393 /* implements Iterator */
 394
 395 /* {{{ proto bool HttpRequestPool::valid()
 396  *
 397  * Implements Iterator::valid().
 398  */
 399 PHP_METHOD(HttpRequestPool, valid)
 400 {
 401         NO_ARGS;
 402
 403         IF_RETVAL_USED {
 404                 getObject(http_requestpool_object, obj);
 405                 RETURN_BOOL(obj->iterator.pos >= 0 && obj->iterator.pos < zend_llist_count(&obj->pool.handles));
 406         }
 407 }
 408 /* }}} */
 409
 410 /* {{{ proto HttpRequest HttpRequestPool::current()
 411  *
 412  * Implements Iterator::current().
 413  */
 414 PHP_METHOD(HttpRequestPool, current)
 415 {
 416         NO_ARGS;
 417
 418         IF_RETVAL_USED {
 419                 long pos = 0;
 420                 zval **current = NULL;
 421                 zend_llist_position lpos;
 422                 getObject(http_requestpool_object, obj);
 423
 424                 if (obj->iterator.pos < zend_llist_count(&obj->pool.handles)) {
 425                         for (   current = zend_llist_get_first_ex(&obj->pool.handles, &lpos);
 426                                         current && obj->iterator.pos != pos++;
 427                                         current = zend_llist_get_next_ex(&obj->pool.handles, &lpos));
 428                         if (current) {
 429                                 RETURN_OBJECT(*current);
 430                         }
 431                 }
 432                 RETURN_NULL();
 433         }
 434 }
 435 /* }}} */
 436
 437 /* {{{ proto int HttpRequestPool::key()
 438  *
 439  * Implements Iterator::key().
 440  */
 441 PHP_METHOD(HttpRequestPool, key)
 442 {
 443         NO_ARGS;
 444
 445         IF_RETVAL_USED {
 446                 getObject(http_requestpool_object, obj);
 447                 RETURN_LONG(obj->iterator.pos);
 448         }
 449 }
 450 /* }}} */
 451
 452 /* {{{ proto void HttpRequestPool::next()
 453  *
 454  * Implements Iterator::next().
 455  */
 456 PHP_METHOD(HttpRequestPool, next)
 457 {
 458         NO_ARGS {
 459                 getObject(http_requestpool_object, obj);
 460                 ++(obj->iterator.pos);
 461         }
 462 }
 463 /* }}} */
 464
 465 /* {{{ proto void HttpRequestPool::rewind()
 466  *
 467  * Implements Iterator::rewind().
 468  */
 469 PHP_METHOD(HttpRequestPool, rewind)
 470 {
 471         NO_ARGS {
 472                 getObject(http_requestpool_object, obj);
 473                 obj->iterator.pos = 0;
 474         }
 475 }
 476 /* }}} */
 477
 478 /* {{{ proto int HttpRequestPool::count()
 479  *
 480  * Implements Countable.
 481  *
 482  * Returns the number of attached HttpRequest objects.
 483  */
 484 PHP_METHOD(HttpRequestPool, count)
 485 {
 486         NO_ARGS {
 487                 getObject(http_requestpool_object, obj);
 488                 RETURN_LONG((long) zend_llist_count(&obj->pool.handles));
 489         }
 490 }
 491 /* }}} */
 492
 493 /* {{{ proto array HttpRequestPool::getAttachedRequests()
 494  *
 495  * Get attached HttpRequest objects.
 496  *
 497  * Returns an array containing all currently attached HttpRequest objects.
 498  */
 499 PHP_METHOD(HttpRequestPool, getAttachedRequests)
 500 {
 501         getObject(http_requestpool_object, obj);
 502
 503         NO_ARGS;
 504
 505         array_init(return_value);
 506         zend_llist_apply_with_argument(&obj->pool.handles,
 507                 (llist_apply_with_arg_func_t) http_requestpool_object_llist2array,
 508                 return_value TSRMLS_CC);
 509 }
 510 /* }}} */
 511
 512 /* {{{ proto array HttpRequestPool::getFinishedRequests()
 513  *
 514  * Get attached HttpRequest objects that already have finished their work.
 515  *
 516  * Returns an array containing all attached HttpRequest objects that
 517  * already have finished their work.
 518  */
 519 PHP_METHOD(HttpRequestPool, getFinishedRequests)
 520 {
 521         getObject(http_requestpool_object, obj);
 522
 523         NO_ARGS;
 524
 525         array_init(return_value);
 526         zend_llist_apply_with_argument(&obj->pool.finished,
 527                 (llist_apply_with_arg_func_t) http_requestpool_object_llist2array,
 528                 return_value TSRMLS_CC);
 529 }
 530 /* }}} */
 531
 532 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
 533
 534 /*
 535  * Local variables:
 536  * tab-width: 4
 537  * c-basic-offset: 4
 538  * End:
 539  * vim600: noet sw=4 ts=4 fdm=marker
 540  * vim<600: noet sw=4 ts=4
 541  */
 542