branch off v1 as R_1_7
[m6w6/ext-http] / http_requestpool_object.c
index a683b05e2bb0ee83ffbc3247a1028df33575b5cf..a0f219cb8429094abeb9f6b97da1f92c1f63ecda 100644 (file)
 /*
-   +----------------------------------------------------------------------+
-   | PECL :: http                                                         |
-   +----------------------------------------------------------------------+
-   | This source file is subject to version 3.0 of the PHP license, that  |
-   | is bundled with this package in the file LICENSE, and is available   |
-   | through the world-wide-web at http://www.php.net/license/3_0.txt.    |
-   | If you did not receive a copy of the PHP license and are unable to   |
-   | obtain it through the world-wide-web, please send a note to          |
-   | license@php.net so we can mail you a copy immediately.               |
-   +----------------------------------------------------------------------+
-   | Copyright (c) 2004-2005 Michael Wallner <mike@php.net>               |
-   +----------------------------------------------------------------------+
+    +--------------------------------------------------------------------+
+    | PECL :: http                                                       |
+    +--------------------------------------------------------------------+
+    | Redistribution and use in source and binary forms, with or without |
+    | modification, are permitted provided that the conditions mentioned |
+    | in the accompanying LICENSE file are met.                          |
+    +--------------------------------------------------------------------+
+    | Copyright (c) 2004-2010, Michael Wallner <mike@php.net>            |
+    +--------------------------------------------------------------------+
 */
 
 /* $Id$ */
 
+#define HTTP_WANT_CURL
+#include "php_http.h"
 
-#ifdef HAVE_CONFIG_H
-#      include "config.h"
-#endif
+#if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
+
+#include "zend_interfaces.h"
 
-#ifdef HTTP_HAVE_CURL
-#      ifdef PHP_WIN32
-#              include <winsock2.h>
-#      endif
-#      include <curl/curl.h>
+#include "php_http_api.h"
+#include "php_http_exception_object.h"
+#include "php_http_request_api.h"
+#include "php_http_request_object.h"
+#include "php_http_request_pool_api.h"
+#include "php_http_requestpool_object.h"
+
+#if defined(HAVE_SPL) && !defined(WONKY)
+/* SPL doesn't install its headers */
+extern PHPAPI zend_class_entry *spl_ce_Countable;
 #endif
 
-#include "php.h"
+#define HTTP_BEGIN_ARGS(method, req_args)      HTTP_BEGIN_ARGS_EX(HttpRequestPool, method, 0, req_args)
+#define HTTP_EMPTY_ARGS(method)                                HTTP_EMPTY_ARGS_EX(HttpRequestPool, method, 0)
+#define HTTP_REQPOOL_ME(method, visibility)    PHP_ME(HttpRequestPool, method, HTTP_ARGS(HttpRequestPool, method), visibility)
 
-#include "php_http_std_defs.h"
-#include "php_http_requestpool_object.h"
-#include "php_http_request_api.h"
+HTTP_EMPTY_ARGS(__construct);
+
+HTTP_EMPTY_ARGS(__destruct);
+HTTP_EMPTY_ARGS(reset);
+
+HTTP_BEGIN_ARGS(attach, 1)
+       HTTP_ARG_OBJ(HttpRequest, request, 0)
+HTTP_END_ARGS;
+
+HTTP_BEGIN_ARGS(detach, 1)
+       HTTP_ARG_OBJ(HttpRequest, request, 0)
+HTTP_END_ARGS;
+
+HTTP_EMPTY_ARGS(send);
+HTTP_EMPTY_ARGS(socketPerform);
+HTTP_BEGIN_ARGS(socketSelect, 0)
+       HTTP_ARG_VAL(timeout, 0)
+HTTP_END_ARGS;
+
+HTTP_EMPTY_ARGS(valid);
+HTTP_EMPTY_ARGS(current);
+HTTP_EMPTY_ARGS(key);
+HTTP_EMPTY_ARGS(next);
+HTTP_EMPTY_ARGS(rewind);
+
+HTTP_EMPTY_ARGS(count);
+
+HTTP_EMPTY_ARGS(getAttachedRequests);
+HTTP_EMPTY_ARGS(getFinishedRequests);
 
-#ifdef ZEND_ENGINE_2
-#ifdef HTTP_HAVE_CURL
+HTTP_BEGIN_ARGS(enablePipelining, 0)
+       HTTP_ARG_VAL(enable, 0)
+HTTP_END_ARGS;
 
-#define http_requestpool_object_declare_default_properties() _http_requestpool_object_declare_default_properties(TSRMLS_C)
-static inline void _http_requestpool_object_declare_default_properties(TSRMLS_D);
+HTTP_BEGIN_ARGS(enableEvents, 0)
+       HTTP_ARG_VAL(enable, 0)
+HTTP_END_ARGS;
 
 zend_class_entry *http_requestpool_object_ce;
 zend_function_entry http_requestpool_object_fe[] = {
-       PHP_ME(HttpRequestPool, __construct, NULL, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
-       PHP_ME(HttpRequestPool, __destruct, NULL, ZEND_ACC_PUBLIC|ZEND_ACC_DTOR)
-       PHP_ME(HttpRequestPool, attach, NULL, ZEND_ACC_PUBLIC)
-       PHP_ME(HttpRequestPool, detach, NULL, ZEND_ACC_PUBLIC)
-       PHP_ME(HttpRequestPool, send, NULL, ZEND_ACC_PUBLIC)
+       HTTP_REQPOOL_ME(__construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR)
+       HTTP_REQPOOL_ME(__destruct, ZEND_ACC_PUBLIC|ZEND_ACC_DTOR)
+       HTTP_REQPOOL_ME(attach, ZEND_ACC_PUBLIC)
+       HTTP_REQPOOL_ME(detach, ZEND_ACC_PUBLIC)
+       HTTP_REQPOOL_ME(send, ZEND_ACC_PUBLIC)
+       HTTP_REQPOOL_ME(reset, ZEND_ACC_PUBLIC)
 
-       {NULL, NULL, NULL}
+       HTTP_REQPOOL_ME(socketPerform, ZEND_ACC_PROTECTED)
+       HTTP_REQPOOL_ME(socketSelect, ZEND_ACC_PROTECTED)
+
+       /* implements Iterator */
+       HTTP_REQPOOL_ME(valid, ZEND_ACC_PUBLIC)
+       HTTP_REQPOOL_ME(current, ZEND_ACC_PUBLIC)
+       HTTP_REQPOOL_ME(key, ZEND_ACC_PUBLIC)
+       HTTP_REQPOOL_ME(next, ZEND_ACC_PUBLIC)
+       HTTP_REQPOOL_ME(rewind, ZEND_ACC_PUBLIC)
+       
+       /* implmenents Countable */
+       HTTP_REQPOOL_ME(count, ZEND_ACC_PUBLIC)
+       
+       HTTP_REQPOOL_ME(getAttachedRequests, ZEND_ACC_PUBLIC)
+       HTTP_REQPOOL_ME(getFinishedRequests, ZEND_ACC_PUBLIC)
+       
+       HTTP_REQPOOL_ME(enablePipelining, ZEND_ACC_PUBLIC)
+       HTTP_REQPOOL_ME(enableEvents, ZEND_ACC_PUBLIC)
+
+       EMPTY_FUNCTION_ENTRY
 };
 static zend_object_handlers http_requestpool_object_handlers;
 
-void _http_requestpool_object_init(INIT_FUNC_ARGS)
+PHP_MINIT_FUNCTION(http_requestpool_object)
 {
        HTTP_REGISTER_CLASS_EX(HttpRequestPool, http_requestpool_object, NULL, 0);
+       http_requestpool_object_handlers.clone_obj = NULL;
+       
+#if defined(HAVE_SPL) && !defined(WONKY)
+       zend_class_implements(http_requestpool_object_ce TSRMLS_CC, 2, spl_ce_Countable, zend_ce_iterator);
+#else
+       zend_class_implements(http_requestpool_object_ce TSRMLS_CC, 1, zend_ce_iterator);
+#endif
+       
+       return SUCCESS;
 }
 
 zend_object_value _http_requestpool_object_new(zend_class_entry *ce TSRMLS_DC)
@@ -66,48 +129,336 @@ zend_object_value _http_requestpool_object_new(zend_class_entry *ce TSRMLS_DC)
 
        http_request_pool_init(&o->pool);
 
+#ifdef ZEND_ENGINE_2_4
+       zend_object_std_init(o, ce TSRMLS_CC);
+       object_properties_init(o, ce);
+#else
        ALLOC_HASHTABLE(OBJ_PROP(o));
-       zend_hash_init(OBJ_PROP(o), 0, NULL, ZVAL_PTR_DTOR, 0);
+       zend_hash_init(OBJ_PROP(o), zend_hash_num_elements(&ce->default_properties), NULL, ZVAL_PTR_DTOR, 0);
        zend_hash_copy(OBJ_PROP(o), &ce->default_properties, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
+#endif
 
-       ov.handle = zend_objects_store_put(o, (zend_objects_store_dtor_t) zend_objects_destroy_object, http_requestpool_object_free, NULL TSRMLS_CC);
+       ov.handle = putObject(http_requestpool_object, o);
        ov.handlers = &http_requestpool_object_handlers;
 
        return ov;
 }
 
-static inline void _http_requestpool_object_declare_default_properties(TSRMLS_D)
+void _http_requestpool_object_free(zend_object *object TSRMLS_DC)
 {
-       zend_class_entry *ce = http_requestpool_object_ce;
+       http_requestpool_object *o = (http_requestpool_object *) object;
 
-       DCL_PROP_N(PROTECTED, pool);
+       http_request_pool_dtor(&o->pool);
+       freeObject(o);
 }
 
-void _http_requestpool_object_free(zend_object *object TSRMLS_DC)
+#define http_requestpool_object_llist2array _http_requestpool_object_llist2array
+static void _http_requestpool_object_llist2array(zval **req, zval *array TSRMLS_DC)
 {
-       http_requestpool_object *o = (http_requestpool_object *) object;
+       ZVAL_ADDREF(*req);
+       add_next_index_zval(array, *req);
+}
+
+/* ### USERLAND ### */
+
+/* {{{ proto void HttpRequestPool::__construct([HttpRequest request[, ...]])
+       Creates a new HttpRequestPool object instance. */
+PHP_METHOD(HttpRequestPool, __construct)
+{
+       int argc = ZEND_NUM_ARGS();
+       zval ***argv = safe_emalloc(argc, sizeof(zval *), 0);
+       getObject(http_requestpool_object, obj);
 
-       if (OBJ_PROP(o)) {
-               zend_hash_destroy(OBJ_PROP(o));
-               FREE_HASHTABLE(OBJ_PROP(o));
+       SET_EH_THROW_HTTP();
+       if (SUCCESS == zend_get_parameters_array_ex(argc, argv)) {
+               int i;
+
+               for (i = 0; i < argc; ++i) {
+                       if (Z_TYPE_PP(argv[i]) == IS_OBJECT && instanceof_function(Z_OBJCE_PP(argv[i]), http_request_object_ce TSRMLS_CC)) {
+                               http_request_pool_attach(&obj->pool, *(argv[i]));
+                       }
+               }
        }
-       http_request_pool_dtor(&o->pool);
-       efree(o);
+       efree(argv);
+       http_final(HTTP_EX_CE(request_pool));
+       SET_EH_NORMAL();
+}
+/* }}} */
+
+/* {{{ proto void HttpRequestPool::__destruct()
+       Clean up HttpRequestPool object. */
+PHP_METHOD(HttpRequestPool, __destruct)
+{
+       getObject(http_requestpool_object, obj);
+
+       NO_ARGS;
+
+       http_request_pool_detach_all(&obj->pool);
 }
+/* }}} */
 
-static void http_requestpool_object_ondestructhandler(zval **request, http_request_pool *pool TSRMLS_DC)
+/* {{{ proto void HttpRequestPool::reset()
+       Detach all attached HttpRequest objects. */
+PHP_METHOD(HttpRequestPool, reset)
 {
-       http_request_pool_detach(pool, *request);
+       getObject(http_requestpool_object, obj);
+
+       NO_ARGS;
+       
+       obj->iterator.pos = 0;
+       http_request_pool_detach_all(&obj->pool);
 }
 
-void _http_requestpool_object_ondestruct(http_request_pool *pool TSRMLS_DC)
+/* {{{ proto bool HttpRequestPool::attach(HttpRequest request)
+       Attach an HttpRequest object to this HttpRequestPool. WARNING: set all options prior attaching! */
+PHP_METHOD(HttpRequestPool, attach)
 {
-       zend_llist_apply_with_argument(&pool->handles, (llist_apply_with_arg_func_t) http_requestpool_object_ondestructhandler, pool TSRMLS_CC);
+       zval *request;
+       STATUS status = FAILURE;
+       getObject(http_requestpool_object, obj);
+
+       SET_EH_THROW_HTTP();
+       if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "O", &request, http_request_object_ce)) {
+               if (obj->iterator.pos > 0 && obj->iterator.pos < zend_llist_count(&obj->pool.handles)) {
+                       http_error(HE_THROW, HTTP_E_REQUEST_POOL, "Cannot attach to the HttpRequestPool while the iterator is active");
+               } else {
+                       status = http_request_pool_attach(&obj->pool, request);
+               }
+       }
+       SET_EH_NORMAL();
+       RETURN_SUCCESS(status);
+}
+/* }}} */
+
+/* {{{ proto bool HttpRequestPool::detach(HttpRequest request)
+       Detach an HttpRequest object from this HttpRequestPool. */
+PHP_METHOD(HttpRequestPool, detach)
+{
+       zval *request;
+       STATUS status = FAILURE;
+       getObject(http_requestpool_object, obj);
+
+       SET_EH_THROW_HTTP();
+       if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "O", &request, http_request_object_ce)) {
+               obj->iterator.pos = -1;
+               status = http_request_pool_detach(&obj->pool, request);
+       }
+       SET_EH_NORMAL();
+       RETURN_SUCCESS(status);
+}
+/* }}} */
+
+/* {{{ proto bool HttpRequestPool::send()
+       Send all attached HttpRequest objects in parallel. */
+PHP_METHOD(HttpRequestPool, send)
+{
+       STATUS status;
+       getObject(http_requestpool_object, obj);
+
+       NO_ARGS;
+
+       SET_EH_THROW_HTTP();
+       status = http_request_pool_send(&obj->pool);
+       SET_EH_NORMAL();
+       
+       /* rethrow as HttpRequestPoolException */
+       http_final(HTTP_EX_CE(request_pool));
+
+       RETURN_SUCCESS(status);
+}
+/* }}} */
+
+/* {{{ proto protected bool HttpRequestPool::socketPerform()
+       Returns TRUE until each request has finished its transaction. */
+PHP_METHOD(HttpRequestPool, socketPerform)
+{
+       getObject(http_requestpool_object, obj);
+
+       NO_ARGS;
+
+       if (0 < http_request_pool_perform(&obj->pool)) {
+               RETURN_TRUE;
+       } else {
+               RETURN_FALSE;
+       }
 }
+/* }}} */
 
+/* {{{ proto protected bool HttpRequestPool::socketSelect([double timeout]) */
+PHP_METHOD(HttpRequestPool, socketSelect)
+{
+       double timeout = 0;
+       struct timeval custom_timeout, *custom_timeout_ptr = NULL;
+       getObject(http_requestpool_object, obj);
+
+       if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|d", &timeout)) {
+               RETURN_FALSE;
+       }
+       if (ZEND_NUM_ARGS() && timeout > 0) {
+               custom_timeout.tv_sec = (time_t) timeout;
+               custom_timeout.tv_usec = HTTP_USEC(timeout) % HTTP_MCROSEC;
+               custom_timeout_ptr = &custom_timeout;
+       }
+
+       RETURN_SUCCESS(http_request_pool_select_ex(&obj->pool, custom_timeout_ptr));
+}
+/* }}} */
+
+/* {{{ proto bool HttpRequestPool::valid()
+       Implements Iterator::valid(). */
+PHP_METHOD(HttpRequestPool, valid)
+{
+       NO_ARGS;
+
+       if (return_value_used) {
+               getObject(http_requestpool_object, obj);
+               RETURN_BOOL(obj->iterator.pos >= 0 && obj->iterator.pos < zend_llist_count(&obj->pool.handles));
+       }
+}
+/* }}} */
+
+/* {{{ proto HttpRequest HttpRequestPool::current()
+       Implements Iterator::current(). */
+PHP_METHOD(HttpRequestPool, current)
+{
+       NO_ARGS;
+
+       if (return_value_used) {
+               long pos = 0;
+               zval **current = NULL;
+               zend_llist_position lpos;
+               getObject(http_requestpool_object, obj);
+
+               if (obj->iterator.pos < zend_llist_count(&obj->pool.handles)) {
+                       for (   current = zend_llist_get_first_ex(&obj->pool.handles, &lpos);
+                                       current && obj->iterator.pos != pos++;
+                                       current = zend_llist_get_next_ex(&obj->pool.handles, &lpos));
+                       if (current) {
+                               RETURN_OBJECT(*current, 1);
+                       }
+               }
+               RETURN_NULL();
+       }
+}
+/* }}} */
+
+/* {{{ proto int HttpRequestPool::key()
+       Implements Iterator::key(). */
+PHP_METHOD(HttpRequestPool, key)
+{
+       NO_ARGS;
+
+       if (return_value_used) {
+               getObject(http_requestpool_object, obj);
+               RETURN_LONG(obj->iterator.pos);
+       }
+}
+/* }}} */
+
+/* {{{ proto void HttpRequestPool::next()
+       Implements Iterator::next(). */
+PHP_METHOD(HttpRequestPool, next)
+{
+       NO_ARGS {
+               getObject(http_requestpool_object, obj);
+               ++(obj->iterator.pos);
+       }
+}
+/* }}} */
+
+/* {{{ proto void HttpRequestPool::rewind()
+       Implements Iterator::rewind(). */
+PHP_METHOD(HttpRequestPool, rewind)
+{
+       NO_ARGS {
+               getObject(http_requestpool_object, obj);
+               obj->iterator.pos = 0;
+       }
+}
+/* }}} */
+
+/* {{{ proto int HttpRequestPool::count()
+       Implements Countable::count(). */
+PHP_METHOD(HttpRequestPool, count)
+{
+       NO_ARGS {
+               getObject(http_requestpool_object, obj);
+               RETURN_LONG((long) zend_llist_count(&obj->pool.handles));
+       }
+}
+/* }}} */
+
+/* {{{ proto array HttpRequestPool::getAttachedRequests()
+       Get attached HttpRequest objects. */
+PHP_METHOD(HttpRequestPool, getAttachedRequests)
+{
+       getObject(http_requestpool_object, obj);
+       
+       NO_ARGS;
+       
+       array_init(return_value);
+       zend_llist_apply_with_argument(&obj->pool.handles, 
+               (llist_apply_with_arg_func_t) http_requestpool_object_llist2array, 
+               return_value TSRMLS_CC);
+}
+/* }}} */
+
+/* {{{ proto array HttpRequestPool::getFinishedRequests()
+       Get attached HttpRequest objects that already have finished their work. */
+PHP_METHOD(HttpRequestPool, getFinishedRequests)
+{
+       getObject(http_requestpool_object, obj);
+       
+       NO_ARGS;
+               
+       array_init(return_value);
+       zend_llist_apply_with_argument(&obj->pool.finished,
+               (llist_apply_with_arg_func_t) http_requestpool_object_llist2array,
+               return_value TSRMLS_CC);
+}
+/* }}} */
+
+/* {{{ proto bool HttpRequestPool::enablePipelining([bool enable = true])
+       Enables pipelining support for all attached requests if support in libcurl is given. */
+PHP_METHOD(HttpRequestPool, enablePipelining)
+{
+       zend_bool enable = 1;
+#if defined(HAVE_CURL_MULTI_SETOPT) && HTTP_CURL_VERSION(7,16,0)
+       getObject(http_requestpool_object, obj);
+#endif
+       
+       if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &enable)) {
+               RETURN_FALSE;
+       }
+#if defined(HAVE_CURL_MULTI_SETOPT) && HTTP_CURL_VERSION(7,16,0)
+       if (CURLM_OK == curl_multi_setopt(obj->pool.ch, CURLMOPT_PIPELINING, (long) enable)) {
+               RETURN_TRUE;
+       }
+#endif
+       RETURN_FALSE;
+}
+/* }}} */
+
+/* {{{ proto bool HttpRequestPool::enableEvents([bool enable = true])
+       Enables event-driven I/O if support in libcurl is given. */
+PHP_METHOD(HttpRequestPool, enableEvents)
+{
+       zend_bool enable = 1;
+#if defined(HTTP_HAVE_EVENT)
+       getObject(http_requestpool_object, obj);
+#endif
+       
+       if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &enable)) {
+#if defined(HTTP_HAVE_EVENT)
+               obj->pool.useevents = enable;
+               RETURN_TRUE;
+#endif
+       }
+       RETURN_FALSE;
+}
+/* }}} */
 
-#endif /* HTTP_HAVE_CURL */
-#endif /* ZEND_ENGINE_2 */
+#endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
 
 /*
  * Local variables: