- changelog, new test files
[m6w6/ext-http] / http_requestpool_object.c
index 28aa366e399465c6565867837d54fc37e6aa4aab..f4f0f9918359b71208561205ff763f37631e764b 100644 (file)
@@ -29,6 +29,8 @@
 #include "php_http_request_object.h"
 #include "php_http_exception_object.h"
 
+#include "zend_interfaces.h"
+
 #ifdef PHP_WIN32
 #      include <winsock2.h>
 #endif
@@ -56,10 +58,14 @@ HTTP_BEGIN_ARGS(detach, 1)
 HTTP_END_ARGS;
 
 HTTP_EMPTY_ARGS(send, 0);
-HTTP_EMPTY_ARGS(socketSend, 0);
+HTTP_EMPTY_ARGS(socketPerform, 0);
 HTTP_EMPTY_ARGS(socketSelect, 0);
-HTTP_EMPTY_ARGS(socketRead, 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);
 
 #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);
@@ -73,17 +79,24 @@ zend_function_entry http_requestpool_object_fe[] = {
        HTTP_REQPOOL_ME(send, ZEND_ACC_PUBLIC)
        HTTP_REQPOOL_ME(reset, ZEND_ACC_PUBLIC)
 
-       HTTP_REQPOOL_ME(socketSend, ZEND_ACC_PROTECTED)
+       HTTP_REQPOOL_ME(socketPerform, ZEND_ACC_PROTECTED)
        HTTP_REQPOOL_ME(socketSelect, ZEND_ACC_PROTECTED)
-       HTTP_REQPOOL_ME(socketRead, ZEND_ACC_PROTECTED)
 
-       {NULL, NULL, NULL}
+       /* 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)
+
+       EMPTY_FUNCTION_ENTRY
 };
 static zend_object_handlers http_requestpool_object_handlers;
 
 void _http_requestpool_object_init(INIT_FUNC_ARGS)
 {
        HTTP_REGISTER_CLASS_EX(HttpRequestPool, http_requestpool_object, NULL, 0);
+       zend_class_implements(http_requestpool_object_ce TSRMLS_CC, 1, zend_ce_iterator);
 }
 
 zend_object_value _http_requestpool_object_new(zend_class_entry *ce TSRMLS_DC)
@@ -100,7 +113,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;
@@ -131,23 +144,34 @@ void _http_requestpool_object_free(zend_object *object TSRMLS_DC)
  *
  * 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 HttpRequestException, HttpRequestPoolException, HttpInvalidParamException.
+ * 
  * Example:
  * <pre>
  * <?php
- *     $urls = array('www.php.net', 'pecl.php.net', 'pear.php.net')
- *     $pool = new HttpRequestPool;
- *     foreach ($urls as $url) {
- *         $req[$url] = new HttpRequest("http://$url", HTTP_HEAD);
- *         $pool->attach($req[$url]);
- *     }
+ * try {
+ *     $pool = new HttpRequestPool(
+ *         new HttpRequest('http://www.google.com/', HttpRequest::METH_HEAD),
+ *         new HttpRequest('http://www.php.net/', HttpRequest::METH_HEAD)
+ *     );
  *     $pool->send();
- *     foreach ($urls as $url) {
- *         printf("%s (%s) is %s\n",
- *             $url, $req[$url]->getResponseInfo('effective_url'),
- *             $r->getResponseCode() == 200 ? 'alive' : 'not alive'
+ *     foreach($pool as $request) {
+ *         printf("%s is %s (%d)\n",
+ *             $request->getUrl(),
+ *             $request->getResponseCode() ? 'alive' : 'not alive',
+ *             $request->getResponseCode()
  *         );
  *     }
+ * } catch (HttpException $e) {
+ *     echo $e;
+ * }
  * ?>
  * </pre>
  */
@@ -200,7 +224,15 @@ PHP_METHOD(HttpRequestPool, reset)
 /* {{{ proto bool HttpRequestPool::attach(HttpRequest request)
  *
  * Attach an HttpRequest object to this HttpRequestPool.
- * NOTE: set all options prior attaching!
+ * 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)
 {
@@ -220,6 +252,13 @@ PHP_METHOD(HttpRequestPool, attach)
 /* {{{ 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)
 {
@@ -239,6 +278,11 @@ PHP_METHOD(HttpRequestPool, detach)
 /* {{{ proto bool HttpRequestPool::send()
  *
  * Send all attached HttpRequest objects in parallel.
+ * 
+ * Returns TRUE on success, or FALSE on failure.
+ * 
+ * Throws HttpSocketException, HttpRequestException, 
+ * HttpRequestPoolException, HttpMalformedHeaderException.
  */
 PHP_METHOD(HttpRequestPool, send)
 {
@@ -255,34 +299,42 @@ PHP_METHOD(HttpRequestPool, send)
 }
 /* }}} */
 
-/* {{{ proto protected bool HttpRequestPool::socketSend()
+/* {{{ proto protected bool HttpRequestPool::socketPerform()
  *
+ * Returns TRUE until each request has finished its transaction.
+ * 
  * Usage:
  * <pre>
  * <?php
- *     while ($pool->socketSend()) {
+ *     while ($pool->socketPerform()) {
  *         do_something_else();
  *         if (!$pool->socketSelect()) {
  *             die('Socket error');
  *         }
  *     }
- *     $pool->socketRead();
  * ?>
  * </pre>
  */
-PHP_METHOD(HttpRequestPool, socketSend)
+PHP_METHOD(HttpRequestPool, socketPerform)
 {
        getObject(http_requestpool_object, obj);
 
        NO_ARGS;
 
-       RETURN_BOOL(0 < http_request_pool_perform(&obj->pool));
+       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;
+       }
 }
 /* }}} */
 
 /* {{{ proto protected bool HttpRequestPool::socketSelect()
  *
- * See HttpRequestPool::socketSend().
+ * See HttpRequestPool::socketPerform().
+ * 
+ * Returns TRUE on success, or FALSE on failure.
  */
 PHP_METHOD(HttpRequestPool, socketSelect)
 {
@@ -294,17 +346,88 @@ PHP_METHOD(HttpRequestPool, socketSelect)
 }
 /* }}} */
 
-/* {{{ proto protected void HttpRequestPool::socketRead()
+/* implements Iterator */
+
+/* {{{ proto bool HttpRequestPool::valid()
  *
- * See HttpRequestPool::socketSend().
+ * Implements Iterator::valid().
  */
-PHP_METHOD(HttpRequestPool, socketRead)
+PHP_METHOD(HttpRequestPool, valid)
 {
-       getObject(http_requestpool_object, obj);
+       NO_ARGS;
+
+       IF_RETVAL_USED {
+               getObject(http_requestpool_object, obj);
+               RETURN_BOOL(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;
 
-       zend_llist_apply(&obj->pool.handles, (llist_apply_func_t) http_request_pool_responsehandler TSRMLS_CC);
+       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;
+       }
 }
 /* }}} */