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-2010, 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 #ifdef ZEND_ENGINE_2_4
 133         zend_object_std_init(o, ce TSRMLS_CC);
 134         object_properties_init(o, ce);
 135 #else
 136         ALLOC_HASHTABLE(OBJ_PROP(o));
 137         zend_hash_init(OBJ_PROP(o), zend_hash_num_elements(&ce->default_properties), NULL, ZVAL_PTR_DTOR, 0);
 138         zend_hash_copy(OBJ_PROP(o), &ce->default_properties, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
 139 #endif
 140
 141         ov.handle = putObject(http_requestpool_object, o);
 142         ov.handlers = &http_requestpool_object_handlers;
 143
 144         return ov;
 145 }
 146
 147 void _http_requestpool_object_free(zend_object *object TSRMLS_DC)
 148 {
 149         http_requestpool_object *o = (http_requestpool_object *) object;
 150
 151         http_request_pool_dtor(&o->pool);
 152         freeObject(o);
 153 }
 154
 155 #define http_requestpool_object_llist2array _http_requestpool_object_llist2array
 156 static void _http_requestpool_object_llist2array(zval **req, zval *array TSRMLS_DC)
 157 {
 158         ZVAL_ADDREF(*req);
 159         add_next_index_zval(array, *req);
 160 }
 161
 162 /* ### USERLAND ### */
 163
 164 /* {{{ proto void HttpRequestPool::__construct([HttpRequest request[, ...]])
 165         Creates a new HttpRequestPool object instance. */
 166 PHP_METHOD(HttpRequestPool, __construct)
 167 {
 168         int argc = ZEND_NUM_ARGS();
 169         zval ***argv = safe_emalloc(argc, sizeof(zval *), 0);
 170         getObject(http_requestpool_object, obj);
 171
 172         SET_EH_THROW_HTTP();
 173         if (SUCCESS == zend_get_parameters_array_ex(argc, argv)) {
 174                 int i;
 175
 176                 for (i = 0; i < argc; ++i) {
 177                         if (Z_TYPE_PP(argv[i]) == IS_OBJECT && instanceof_function(Z_OBJCE_PP(argv[i]), http_request_object_ce TSRMLS_CC)) {
 178                                 http_request_pool_attach(&obj->pool, *(argv[i]));
 179                         }
 180                 }
 181         }
 182         efree(argv);
 183         http_final(HTTP_EX_CE(request_pool));
 184         SET_EH_NORMAL();
 185 }
 186 /* }}} */
 187
 188 /* {{{ proto void HttpRequestPool::__destruct()
 189         Clean up HttpRequestPool object. */
 190 PHP_METHOD(HttpRequestPool, __destruct)
 191 {
 192         getObject(http_requestpool_object, obj);
 193
 194         NO_ARGS;
 195
 196         http_request_pool_detach_all(&obj->pool);
 197 }
 198 /* }}} */
 199
 200 /* {{{ proto void HttpRequestPool::reset()
 201         Detach all attached HttpRequest objects. */
 202 PHP_METHOD(HttpRequestPool, reset)
 203 {
 204         getObject(http_requestpool_object, obj);
 205
 206         NO_ARGS;
 207
 208         obj->iterator.pos = 0;
 209         http_request_pool_detach_all(&obj->pool);
 210 }
 211
 212 /* {{{ proto bool HttpRequestPool::attach(HttpRequest request)
 213         Attach an HttpRequest object to this HttpRequestPool. WARNING: set all options prior attaching! */
 214 PHP_METHOD(HttpRequestPool, attach)
 215 {
 216         zval *request;
 217         STATUS status = FAILURE;
 218         getObject(http_requestpool_object, obj);
 219
 220         SET_EH_THROW_HTTP();
 221         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "O", &request, http_request_object_ce)) {
 222                 if (obj->iterator.pos > 0 && obj->iterator.pos < zend_llist_count(&obj->pool.handles)) {
 223                         http_error(HE_THROW, HTTP_E_REQUEST_POOL, "Cannot attach to the HttpRequestPool while the iterator is active");
 224                 } else {
 225                         status = http_request_pool_attach(&obj->pool, request);
 226                 }
 227         }
 228         SET_EH_NORMAL();
 229         RETURN_SUCCESS(status);
 230 }
 231 /* }}} */
 232
 233 /* {{{ proto bool HttpRequestPool::detach(HttpRequest request)
 234         Detach an HttpRequest object from this HttpRequestPool. */
 235 PHP_METHOD(HttpRequestPool, detach)
 236 {
 237         zval *request;
 238         STATUS status = FAILURE;
 239         getObject(http_requestpool_object, obj);
 240
 241         SET_EH_THROW_HTTP();
 242         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "O", &request, http_request_object_ce)) {
 243                 obj->iterator.pos = -1;
 244                 status = http_request_pool_detach(&obj->pool, request);
 245         }
 246         SET_EH_NORMAL();
 247         RETURN_SUCCESS(status);
 248 }
 249 /* }}} */
 250
 251 /* {{{ proto bool HttpRequestPool::send()
 252         Send all attached HttpRequest objects in parallel. */
 253 PHP_METHOD(HttpRequestPool, send)
 254 {
 255         STATUS status;
 256         getObject(http_requestpool_object, obj);
 257
 258         NO_ARGS;
 259
 260         SET_EH_THROW_HTTP();
 261         status = http_request_pool_send(&obj->pool);
 262         SET_EH_NORMAL();
 263
 264         /* rethrow as HttpRequestPoolException */
 265         http_final(HTTP_EX_CE(request_pool));
 266
 267         RETURN_SUCCESS(status);
 268 }
 269 /* }}} */
 270
 271 /* {{{ proto protected bool HttpRequestPool::socketPerform()
 272         Returns TRUE until each request has finished its transaction. */
 273 PHP_METHOD(HttpRequestPool, socketPerform)
 274 {
 275         getObject(http_requestpool_object, obj);
 276
 277         NO_ARGS;
 278
 279         if (0 < http_request_pool_perform(&obj->pool)) {
 280                 RETURN_TRUE;
 281         } else {
 282                 RETURN_FALSE;
 283         }
 284 }
 285 /* }}} */
 286
 287 /* {{{ proto protected bool HttpRequestPool::socketSelect([double timeout]) */
 288 PHP_METHOD(HttpRequestPool, socketSelect)
 289 {
 290         double timeout = 0;
 291         struct timeval custom_timeout, *custom_timeout_ptr = NULL;
 292         getObject(http_requestpool_object, obj);
 293
 294         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|d", &timeout)) {
 295                 RETURN_FALSE;
 296         }
 297         if (ZEND_NUM_ARGS() && timeout > 0) {
 298                 custom_timeout.tv_sec = (time_t) timeout;
 299                 custom_timeout.tv_usec = HTTP_USEC(timeout) % HTTP_MCROSEC;
 300                 custom_timeout_ptr = &custom_timeout;
 301         }
 302
 303         RETURN_SUCCESS(http_request_pool_select_ex(&obj->pool, custom_timeout_ptr));
 304 }
 305 /* }}} */
 306
 307 /* {{{ proto bool HttpRequestPool::valid()
 308         Implements Iterator::valid(). */
 309 PHP_METHOD(HttpRequestPool, valid)
 310 {
 311         NO_ARGS;
 312
 313         if (return_value_used) {
 314                 getObject(http_requestpool_object, obj);
 315                 RETURN_BOOL(obj->iterator.pos >= 0 && obj->iterator.pos < zend_llist_count(&obj->pool.handles));
 316         }
 317 }
 318 /* }}} */
 319
 320 /* {{{ proto HttpRequest HttpRequestPool::current()
 321         Implements Iterator::current(). */
 322 PHP_METHOD(HttpRequestPool, current)
 323 {
 324         NO_ARGS;
 325
 326         if (return_value_used) {
 327                 long pos = 0;
 328                 zval **current = NULL;
 329                 zend_llist_position lpos;
 330                 getObject(http_requestpool_object, obj);
 331
 332                 if (obj->iterator.pos < zend_llist_count(&obj->pool.handles)) {
 333                         for (   current = zend_llist_get_first_ex(&obj->pool.handles, &lpos);
 334                                         current && obj->iterator.pos != pos++;
 335                                         current = zend_llist_get_next_ex(&obj->pool.handles, &lpos));
 336                         if (current) {
 337                                 RETURN_OBJECT(*current, 1);
 338                         }
 339                 }
 340                 RETURN_NULL();
 341         }
 342 }
 343 /* }}} */
 344
 345 /* {{{ proto int HttpRequestPool::key()
 346         Implements Iterator::key(). */
 347 PHP_METHOD(HttpRequestPool, key)
 348 {
 349         NO_ARGS;
 350
 351         if (return_value_used) {
 352                 getObject(http_requestpool_object, obj);
 353                 RETURN_LONG(obj->iterator.pos);
 354         }
 355 }
 356 /* }}} */
 357
 358 /* {{{ proto void HttpRequestPool::next()
 359         Implements Iterator::next(). */
 360 PHP_METHOD(HttpRequestPool, next)
 361 {
 362         NO_ARGS {
 363                 getObject(http_requestpool_object, obj);
 364                 ++(obj->iterator.pos);
 365         }
 366 }
 367 /* }}} */
 368
 369 /* {{{ proto void HttpRequestPool::rewind()
 370         Implements Iterator::rewind(). */
 371 PHP_METHOD(HttpRequestPool, rewind)
 372 {
 373         NO_ARGS {
 374                 getObject(http_requestpool_object, obj);
 375                 obj->iterator.pos = 0;
 376         }
 377 }
 378 /* }}} */
 379
 380 /* {{{ proto int HttpRequestPool::count()
 381         Implements Countable::count(). */
 382 PHP_METHOD(HttpRequestPool, count)
 383 {
 384         NO_ARGS {
 385                 getObject(http_requestpool_object, obj);
 386                 RETURN_LONG((long) zend_llist_count(&obj->pool.handles));
 387         }
 388 }
 389 /* }}} */
 390
 391 /* {{{ proto array HttpRequestPool::getAttachedRequests()
 392         Get attached HttpRequest objects. */
 393 PHP_METHOD(HttpRequestPool, getAttachedRequests)
 394 {
 395         getObject(http_requestpool_object, obj);
 396
 397         NO_ARGS;
 398
 399         array_init(return_value);
 400         zend_llist_apply_with_argument(&obj->pool.handles,
 401                 (llist_apply_with_arg_func_t) http_requestpool_object_llist2array,
 402                 return_value TSRMLS_CC);
 403 }
 404 /* }}} */
 405
 406 /* {{{ proto array HttpRequestPool::getFinishedRequests()
 407         Get attached HttpRequest objects that already have finished their work. */
 408 PHP_METHOD(HttpRequestPool, getFinishedRequests)
 409 {
 410         getObject(http_requestpool_object, obj);
 411
 412         NO_ARGS;
 413
 414         array_init(return_value);
 415         zend_llist_apply_with_argument(&obj->pool.finished,
 416                 (llist_apply_with_arg_func_t) http_requestpool_object_llist2array,
 417                 return_value TSRMLS_CC);
 418 }
 419 /* }}} */
 420
 421 /* {{{ proto bool HttpRequestPool::enablePipelining([bool enable = true])
 422         Enables pipelining support for all attached requests if support in libcurl is given. */
 423 PHP_METHOD(HttpRequestPool, enablePipelining)
 424 {
 425         zend_bool enable = 1;
 426 #if defined(HAVE_CURL_MULTI_SETOPT) && HTTP_CURL_VERSION(7,16,0)
 427         getObject(http_requestpool_object, obj);
 428 #endif
 429
 430         if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &enable)) {
 431                 RETURN_FALSE;
 432         }
 433 #if defined(HAVE_CURL_MULTI_SETOPT) && HTTP_CURL_VERSION(7,16,0)
 434         if (CURLM_OK == curl_multi_setopt(obj->pool.ch, CURLMOPT_PIPELINING, (long) enable)) {
 435                 RETURN_TRUE;
 436         }
 437 #endif
 438         RETURN_FALSE;
 439 }
 440 /* }}} */
 441
 442 /* {{{ proto bool HttpRequestPool::enableEvents([bool enable = true])
 443         Enables event-driven I/O if support in libcurl is given. */
 444 PHP_METHOD(HttpRequestPool, enableEvents)
 445 {
 446         zend_bool enable = 1;
 447 #if defined(HTTP_HAVE_EVENT)
 448         getObject(http_requestpool_object, obj);
 449 #endif
 450
 451         if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &enable)) {
 452 #if defined(HTTP_HAVE_EVENT)
 453                 obj->pool.useevents = enable;
 454                 RETURN_TRUE;
 455 #endif
 456         }
 457         RETURN_FALSE;
 458 }
 459 /* }}} */
 460
 461 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
 462
 463 /*
 464  * Local variables:
 465  * tab-width: 4
 466  * c-basic-offset: 4
 467  * End:
 468  * vim600: noet sw=4 ts=4 fdm=marker
 469  * vim<600: noet sw=4 ts=4
 470  */
 471