X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=blobdiff_plain;f=http_requestpool_object.c;h=ff8f75d4431e073faec37dffefa09a240998935a;hp=dfb9c604f72f6d387f2209e491535f8a3abe1f74;hb=9c3bc2cb7b5217a91a8defbbe7c5c20f33938d59;hpb=712103ef11a9dfcc2495ce43e4a731d9b59d3439 diff --git a/http_requestpool_object.c b/http_requestpool_object.c index dfb9c60..ff8f75d 100644 --- a/http_requestpool_object.c +++ b/http_requestpool_object.c @@ -1,54 +1,48 @@ /* - +----------------------------------------------------------------------+ - | 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 | - +----------------------------------------------------------------------+ + +--------------------------------------------------------------------+ + | 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-2006, Michael Wallner | + +--------------------------------------------------------------------+ */ /* $Id$ */ - -#ifdef HAVE_CONFIG_H -# include "config.h" -#endif -#include "php.h" +#define HTTP_WANT_CURL +#include "php_http.h" #if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL) -#include "php_http_std_defs.h" +#include "zend_interfaces.h" + #include "php_http_api.h" -#include "php_http_requestpool_object.h" -#include "php_http_request_pool_api.h" -#include "php_http_request_object.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" -#include "zend_interfaces.h" - -#ifdef PHP_WIN32 -# include +#if defined(HAVE_SPL) && !defined(WONKY) +/* SPL doesn't install its headers */ +extern PHPAPI zend_class_entry *spl_ce_Countable; #endif -#include #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpRequestPool, method, 0, req_args) -#define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpRequestPool, method, ret_ref) +#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) -HTTP_BEGIN_ARGS_AR(HttpRequestPool, __construct, 0, 0) +HTTP_BEGIN_ARGS(__construct, 0) HTTP_ARG_OBJ(HttpRequest, request0, 0) HTTP_ARG_OBJ(HttpRequest, request1, 0) HTTP_ARG_OBJ(HttpRequest, requestN, 0) HTTP_END_ARGS; -HTTP_EMPTY_ARGS(__destruct, 0); -HTTP_EMPTY_ARGS(reset, 0); +HTTP_EMPTY_ARGS(__destruct); +HTTP_EMPTY_ARGS(reset); HTTP_BEGIN_ARGS(attach, 1) HTTP_ARG_OBJ(HttpRequest, request, 0) @@ -58,18 +52,24 @@ HTTP_BEGIN_ARGS(detach, 1) HTTP_ARG_OBJ(HttpRequest, request, 0) HTTP_END_ARGS; -HTTP_EMPTY_ARGS(send, 0); -HTTP_EMPTY_ARGS(socketPerform, 0); -HTTP_EMPTY_ARGS(socketSelect, 0); +HTTP_EMPTY_ARGS(send); +HTTP_EMPTY_ARGS(socketPerform); +HTTP_EMPTY_ARGS(socketSelect); + +HTTP_EMPTY_ARGS(valid); +HTTP_EMPTY_ARGS(current); +HTTP_EMPTY_ARGS(key); +HTTP_EMPTY_ARGS(next); +HTTP_EMPTY_ARGS(rewind); -HTTP_EMPTY_ARGS(valid, 0); -HTTP_EMPTY_ARGS(current, 1); -HTTP_EMPTY_ARGS(key, 0); -HTTP_EMPTY_ARGS(next, 0); -HTTP_EMPTY_ARGS(rewind, 0); +HTTP_EMPTY_ARGS(count); -#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_EMPTY_ARGS(getAttachedRequests); +HTTP_EMPTY_ARGS(getFinishedRequests); + +HTTP_BEGIN_ARGS(enablePipelining, 0) + HTTP_ARG_VAL(enable, 0) +HTTP_END_ARGS; zend_class_entry *http_requestpool_object_ce; zend_function_entry http_requestpool_object_fe[] = { @@ -83,21 +83,37 @@ zend_function_entry http_requestpool_object_fe[] = { HTTP_REQPOOL_ME(socketPerform, ZEND_ACC_PROTECTED) HTTP_REQPOOL_ME(socketSelect, ZEND_ACC_PROTECTED) - /* implements Interator */ + /* 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) 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) @@ -111,7 +127,7 @@ zend_object_value _http_requestpool_object_new(zend_class_entry *ce TSRMLS_DC) http_request_pool_init(&o->pool); 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 *)); ov.handle = putObject(http_requestpool_object, o); @@ -120,23 +136,19 @@ zend_object_value _http_requestpool_object_new(zend_class_entry *ce TSRMLS_DC) return ov; } -static inline void _http_requestpool_object_declare_default_properties(TSRMLS_D) -{ - zend_class_entry *ce = http_requestpool_object_ce; - - DCL_PROP_N(PROTECTED, pool); -} - void _http_requestpool_object_free(zend_object *object TSRMLS_DC) { http_requestpool_object *o = (http_requestpool_object *) object; - if (OBJ_PROP(o)) { - zend_hash_destroy(OBJ_PROP(o)); - FREE_HASHTABLE(OBJ_PROP(o)); - } http_request_pool_dtor(&o->pool); - efree(o); + freeObject(o); +} + +#define http_requestpool_object_llist2array _http_requestpool_object_llist2array +static void _http_requestpool_object_llist2array(zval **req, zval *array TSRMLS_DC) +{ + ZVAL_ADDREF(*req); + add_next_index_zval(array, *req); } /* ### USERLAND ### */ @@ -147,12 +159,12 @@ void _http_requestpool_object_free(zend_object *object TSRMLS_DC) * able to send several HttpRequests in parallel. * * WARNING: Don't attach/detach HttpRequest objects to the HttpRequestPool - * object while you're using the implemented Interator interface. + * object while you're using the implemented Iterator interface. * * Accepts virtual infinite optional parameters each referencing an * HttpRequest object. * - * Throws HttpRequestException, HttpRequestPoolException, HttpInvalidParamException. + * Throws HttpRequestPoolException (HttpRequestException, HttpInvalidParamException). * * Example: *
@@ -182,6 +194,7 @@ PHP_METHOD(HttpRequestPool, __construct)
 	zval ***argv = safe_emalloc(argc, sizeof(zval *), 0);
 	getObject(http_requestpool_object, obj);
 
+	SET_EH_THROW_HTTP();
 	if (SUCCESS == zend_get_parameters_array_ex(argc, argv)) {
 		int i;
 
@@ -192,6 +205,8 @@ PHP_METHOD(HttpRequestPool, __construct)
 		}
 	}
 	efree(argv);
+	SET_EH_NORMAL();
+	http_final(HTTP_EX_CE(request_pool));
 }
 /* }}} */
 
@@ -228,7 +243,7 @@ PHP_METHOD(HttpRequestPool, reset)
  * Attach an HttpRequest object to this HttpRequestPool.
  * WARNING: set all options prior attaching!
  * 
- * Expects the parameter to be an HttpRequest object not alread attached to
+ * Expects the parameter to be an HttpRequest object not already attached to
  * antother HttpRequestPool object.
  * 
  * Returns TRUE on success, or FALSE on failure.
@@ -288,8 +303,7 @@ PHP_METHOD(HttpRequestPool, detach)
  * 
  * Returns TRUE on success, or FALSE on failure.
  * 
- * Throws HttpSocketException, HttpRequestException, 
- * HttpRequestPoolException, HttpMalformedHeaderException.
+ * Throws HttpRequestPoolException (HttpSocketException, HttpRequestException, HttpMalformedHeaderException).
  */
 PHP_METHOD(HttpRequestPool, send)
 {
@@ -301,6 +315,9 @@ PHP_METHOD(HttpRequestPool, send)
 	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);
 }
@@ -313,12 +330,27 @@ PHP_METHOD(HttpRequestPool, send)
  * Usage:
  * 
  * socketPerform()) {
- *         do_something_else();
- *         if (!$pool->socketSelect()) {
- *             die('Socket error');
+ * class MyPool extends HttpRequestPool
+ * {
+ *     public function send()
+ *     {
+ *         while ($this->socketPerform()) {
+ *             if (!$this->socketSelect()) {
+ *                 throw new HttpSocketExcpetion;
+ *             }
  *         }
  *     }
+ *     
+ *     protected final function socketPerform()
+ *     {
+ *         $result = parent::socketPerform();
+ *         foreach ($this->getFinishedRequests() as $r) {
+ *             $this->detach($r);
+ *             // handle response of finished request
+ *         }
+ *         return $result;
+ *     }
+ * } 
  * ?>
  * 
*/ @@ -331,7 +363,6 @@ PHP_METHOD(HttpRequestPool, socketPerform) if (0 < http_request_pool_perform(&obj->pool)) { RETURN_TRUE; } else { - zend_llist_apply(&obj->pool.handles, (llist_apply_func_t) http_request_pool_responsehandler TSRMLS_CC); RETURN_FALSE; } } @@ -363,7 +394,7 @@ PHP_METHOD(HttpRequestPool, valid) { NO_ARGS; - IF_RETVAL_USED { + if (return_value_used) { getObject(http_requestpool_object, obj); RETURN_BOOL(obj->iterator.pos >= 0 && obj->iterator.pos < zend_llist_count(&obj->pool.handles)); } @@ -378,7 +409,7 @@ PHP_METHOD(HttpRequestPool, current) { NO_ARGS; - IF_RETVAL_USED { + if (return_value_used) { long pos = 0; zval **current = NULL; zend_llist_position lpos; @@ -389,7 +420,7 @@ PHP_METHOD(HttpRequestPool, current) current && obj->iterator.pos != pos++; current = zend_llist_get_next_ex(&obj->pool.handles, &lpos)); if (current) { - RETURN_OBJECT(*current); + RETURN_OBJECT(*current, 1); } } RETURN_NULL(); @@ -405,7 +436,7 @@ PHP_METHOD(HttpRequestPool, key) { NO_ARGS; - IF_RETVAL_USED { + if (return_value_used) { getObject(http_requestpool_object, obj); RETURN_LONG(obj->iterator.pos); } @@ -438,6 +469,83 @@ PHP_METHOD(HttpRequestPool, rewind) } /* }}} */ +/* {{{ proto int HttpRequestPool::count() + * + * Implements Countable. + * + * Returns the number of attached HttpRequest objects. + */ +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. + * + * Returns an array containing all currently 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. + * + * Returns an array containing all 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 HttpRequest::enablePiplelinig([bool enable = true]) + * + * Enables pipelining support for all attached requests if support in libcurl is given. + * + * Returns TRUE on success, or FALSE on failure. + */ +PHP_METHOD(HttpRequestPool, enablePipelining) +{ + zend_bool enable = 1; + getObject(http_requestpool_object, obj); + + 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; +} +/* }}} */ + #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */ /*