# you better don't look inside
[m6w6/ext-http] / http_requestpool_object.c
index 92d13c439319d3fc8a7c563100c538d6344ba759..902574dc9255198f39238a8ff42e9309b5d983df 100644 (file)
@@ -1,40 +1,39 @@
 /*
-   +----------------------------------------------------------------------+
-   | 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-2005, Michael Wallner <mike@php.net>            |
+    +--------------------------------------------------------------------+
 */
 
 /* $Id$ */
 
-
 #ifdef HAVE_CONFIG_H
 #      include "config.h"
 #endif
-#include "php.h"
 
-#if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
+#define HTTP_WANT_CURL
+#include "php_http.h"
 
-#include "php_http_std_defs.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"
+#if defined(ZEND_ENGINE_2) && defined(HTTP_HAVE_CURL)
 
 #include "zend_interfaces.h"
 
-#ifdef PHP_WIN32
-#      include <winsock2.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 <curl/curl.h>
 
 #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)
@@ -67,6 +66,11 @@ 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);
 
@@ -88,15 +92,28 @@ zend_function_entry http_requestpool_object_fe[] = {
        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)
@@ -138,6 +155,13 @@ 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[, ...]])
@@ -151,15 +175,15 @@ void _http_requestpool_object_free(zend_object *object TSRMLS_DC)
  * Accepts virtual infinite optional parameters each referencing an
  * HttpRequest object.
  * 
- * Throws HttpRequestException, HttpRequestPoolException, HttpInvalidParamException.
+ * Throws HttpRequestPoolException (HttpRequestException, HttpInvalidParamException).
  * 
  * Example:
  * <pre>
  * <?php
  * try {
  *     $pool = new HttpRequestPool(
- *         new HttpRequest('http://www.google.com/', HTTP_HEAD),
- *         new HttpRequest('http://www.php.net/', HTTP_HEAD)
+ *         new HttpRequest('http://www.google.com/', HttpRequest::METH_HEAD),
+ *         new HttpRequest('http://www.php.net/', HttpRequest::METH_HEAD)
  *     );
  *     $pool->send();
  *     foreach($pool as $request) {
@@ -181,16 +205,21 @@ 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;
 
                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_try {
+                                       http_request_pool_attach(&obj->pool, *(argv[i]));
+                               } http_request_pool_catch();
                        }
                }
+               http_request_pool_final();
        }
        efree(argv);
+       SET_EH_NORMAL();
 }
 /* }}} */
 
@@ -217,7 +246,8 @@ PHP_METHOD(HttpRequestPool, reset)
        getObject(http_requestpool_object, obj);
 
        NO_ARGS;
-
+       
+       obj->iterator.pos = 0;
        http_request_pool_detach_all(&obj->pool);
 }
 
@@ -242,7 +272,11 @@ PHP_METHOD(HttpRequestPool, attach)
 
        SET_EH_THROW_HTTP();
        if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "O", &request, http_request_object_ce)) {
-               status = http_request_pool_attach(&obj->pool, request);
+               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);
@@ -268,6 +302,7 @@ PHP_METHOD(HttpRequestPool, detach)
 
        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();
@@ -281,8 +316,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)
 {
@@ -306,12 +340,27 @@ PHP_METHOD(HttpRequestPool, send)
  * Usage:
  * <pre>
  * <?php
- *     while ($pool->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;
  *     }
+ * } 
  * ?>
  * </pre>
  */
@@ -324,7 +373,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;
        }
 }
@@ -358,7 +406,7 @@ PHP_METHOD(HttpRequestPool, valid)
 
        IF_RETVAL_USED {
                getObject(http_requestpool_object, obj);
-               RETURN_BOOL(obj->iterator.pos < zend_llist_count(&obj->pool.handles));
+               RETURN_BOOL(obj->iterator.pos >= 0 && obj->iterator.pos < zend_llist_count(&obj->pool.handles));
        }
 }
 /* }}} */
@@ -431,6 +479,60 @@ 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);
+}
+/* }}} */
+
 #endif /* ZEND_ENGINE_2 && HTTP_HAVE_CURL */
 
 /*