X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=blobdiff_plain;f=http_requestpool_object.c;h=902574dc9255198f39238a8ff42e9309b5d983df;hp=2f1b4175cfaf1d9ed1fc770c42f3053bd25b6948;hb=f2d0dbf38d7b00455d3dfba8f2de087105ae0f35;hpb=902d195a198f4976c8ff081a95cdd3e315c14f5f diff --git a/http_requestpool_object.c b/http_requestpool_object.c index 2f1b417..902574d 100644 --- a/http_requestpool_object.c +++ b/http_requestpool_object.c @@ -1,62 +1,119 @@ /* - +----------------------------------------------------------------------+ - | 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-2005, 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 "php_http_requestpool_object.h" +#include "zend_interfaces.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" -#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 -HTTP_DECLARE_ARG_PASS_INFO(); +#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_REQPOOL_ME(method, visibility) PHP_ME(HttpRequestPool, method, HTTP_ARGS(HttpRequestPool, method), visibility) + +HTTP_BEGIN_ARGS_AR(HttpRequestPool, __construct, 0, 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_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, 0); +HTTP_EMPTY_ARGS(socketPerform, 0); +HTTP_EMPTY_ARGS(socketSelect, 0); + +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, 0); + +HTTP_EMPTY_ARGS(getAttachedRequests, 0); +HTTP_EMPTY_ARGS(getFinishedRequests, 0); #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); zend_class_entry *http_requestpool_object_ce; zend_function_entry http_requestpool_object_fe[] = { - PHP_ME(HttpRequestPool, __construct, http_arg_pass_ref_all, 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) - PHP_ME(HttpRequestPool, reset, NULL, ZEND_ACC_PUBLIC) - - PHP_ME(HttpRequestPool, socketSend, NULL, ZEND_ACC_PROTECTED) - PHP_ME(HttpRequestPool, socketSelect, NULL, ZEND_ACC_PROTECTED) - PHP_ME(HttpRequestPool, socketRead, NULL, ZEND_ACC_PROTECTED) - - {NULL, NULL, NULL} + 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) + + HTTP_REQPOOL_ME(socketPerform, ZEND_ACC_PROTECTED) + HTTP_REQPOOL_ME(socketSelect, ZEND_ACC_PROTECTED) + + /* implements Interator */ + 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) + + 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); +#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 + + http_requestpool_object_handlers.clone_obj = NULL; + return SUCCESS; } zend_object_value _http_requestpool_object_new(zend_class_entry *ce TSRMLS_DC) @@ -73,7 +130,7 @@ zend_object_value _http_requestpool_object_new(zend_class_entry *ce TSRMLS_DC) zend_hash_init(OBJ_PROP(o), 0, 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 = 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; @@ -98,6 +155,384 @@ void _http_requestpool_object_free(zend_object *object TSRMLS_DC) efree(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 ### */ + +/* {{{ proto void HttpRequestPool::__construct([HttpRequest request[, ...]]) + * + * Instantiate a new HttpRequestPool object. An HttpRequestPool is + * 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. + * + * Accepts virtual infinite optional parameters each referencing an + * HttpRequest object. + * + * Throws HttpRequestPoolException (HttpRequestException, HttpInvalidParamException). + * + * Example: + * 
+ * send();
+ *     foreach($pool as $request) {
+ *         printf("%s is %s (%d)\n",
+ *             $request->getUrl(),
+ *             $request->getResponseCode() ? 'alive' : 'not alive',
+ *             $request->getResponseCode()
+ *         );
+ *     }
+ * } catch (HttpException $e) {
+ *     echo $e;
+ * }
+ * ?>
+ *
+ */ +PHP_METHOD(HttpRequestPool, __construct) +{ + int argc = ZEND_NUM_ARGS(); + 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; + + 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_try { + http_request_pool_attach(&obj->pool, *(argv[i])); + } http_request_pool_catch(); + } + } + http_request_pool_final(); + } + efree(argv); + 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); +} +/* }}} */ + +/* {{{ proto void HttpRequestPool::reset() + * + * Detach all attached HttpRequest objects. + */ +PHP_METHOD(HttpRequestPool, reset) +{ + getObject(http_requestpool_object, obj); + + NO_ARGS; + + obj->iterator.pos = 0; + http_request_pool_detach_all(&obj->pool); +} + +/* {{{ proto bool HttpRequestPool::attach(HttpRequest request) + * + * 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 + * antother HttpRequestPool object. + * + * Returns TRUE on success, or FALSE on failure. + * + * Throws HttpInvalidParamException, HttpRequestException, + * HttpRequestPoolException, HttpEncodingException. + */ +PHP_METHOD(HttpRequestPool, attach) +{ + 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. + * + * Expects the parameter to be an HttpRequest object attached to this + * HttpRequestPool object. + * + * Returns TRUE on success, or FALSE on failure. + * + * Throws HttpInvalidParamException, HttpRequestPoolException. + */ +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. + * + * Returns TRUE on success, or FALSE on failure. + * + * Throws HttpRequestPoolException (HttpSocketException, HttpRequestException, HttpMalformedHeaderException). + */ +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(); + + RETURN_SUCCESS(status); +} +/* }}} */ + +/* {{{ proto protected bool HttpRequestPool::socketPerform() + * + * Returns TRUE until each request has finished its transaction. + * + * Usage: + * 
+ * 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;
+ *     }
+ * } 
+ * ?>
+ *
+ */ +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() + * + * See HttpRequestPool::socketPerform(). + * + * Returns TRUE on success, or FALSE on failure. + */ +PHP_METHOD(HttpRequestPool, socketSelect) +{ + getObject(http_requestpool_object, obj); + + NO_ARGS; + + RETURN_SUCCESS(http_request_pool_select(&obj->pool)); +} +/* }}} */ + +/* implements Iterator */ + +/* {{{ proto bool HttpRequestPool::valid() + * + * Implements Iterator::valid(). + */ +PHP_METHOD(HttpRequestPool, valid) +{ + NO_ARGS; + + IF_RETVAL_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_RETVAL_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); + } + } + RETURN_NULL(); + } +} +/* }}} */ + +/* {{{ proto int HttpRequestPool::key() + * + * Implements Iterator::key(). + */ +PHP_METHOD(HttpRequestPool, key) +{ + NO_ARGS; + + IF_RETVAL_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. + * + * 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); +} +/* }}} */ + #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */ /*