- rather use a list of disallowed chars
[m6w6/ext-http] / http_message_object.c
index ae4254a2621810a73074912f3c62d0abde9ff237..5345b26112a0540cf804b159de2d8c513c25612b 100644 (file)
@@ -18,6 +18,7 @@
 
 #ifdef ZEND_ENGINE_2
 
+#include "zend_interfaces.h"
 #include "ext/standard/url.h"
 
 #include "php_http_api.h"
 #include "php_http_request_object.h"
 
 #ifndef WONKY
-#      include "zend_interfaces.h"
 #      ifdef HAVE_SPL
 /* SPL doesn't install its headers */
 extern PHPAPI zend_class_entry *spl_ce_Countable;
 #      endif
 #endif
 
-#define HTTP_BEGIN_ARGS(method, ret_ref, req_args)     HTTP_BEGIN_ARGS_EX(HttpMessage, method, ret_ref, req_args)
-#define HTTP_EMPTY_ARGS(method, ret_ref)                       HTTP_EMPTY_ARGS_EX(HttpMessage, method, ret_ref)
-#define HTTP_MESSAGE_ME(method, visibility)                    PHP_ME(HttpMessage, method, HTTP_ARGS(HttpMessage, method), visibility)
+#define HTTP_BEGIN_ARGS(method, req_args)      HTTP_BEGIN_ARGS_EX(HttpMessage, method, 0, req_args)
+#define HTTP_EMPTY_ARGS(method)                                HTTP_EMPTY_ARGS_EX(HttpMessage, method, 0)
+#define HTTP_MESSAGE_ME(method, visibility)    PHP_ME(HttpMessage, method, HTTP_ARGS(HttpMessage, method), visibility)
 
-HTTP_BEGIN_ARGS(__construct, 0, 0)
+HTTP_BEGIN_ARGS(__construct, 0)
        HTTP_ARG_VAL(message, 0)
 HTTP_END_ARGS;
 
-HTTP_BEGIN_ARGS(fromString, 1, 1)
+HTTP_BEGIN_ARGS(fromString, 1)
        HTTP_ARG_VAL(message, 0)
 HTTP_END_ARGS;
 
-HTTP_EMPTY_ARGS(getBody, 0);
-HTTP_BEGIN_ARGS(setBody, 0, 1)
+HTTP_EMPTY_ARGS(getBody);
+HTTP_BEGIN_ARGS(setBody, 1)
        HTTP_ARG_VAL(body, 0)
 HTTP_END_ARGS;
 
-HTTP_EMPTY_ARGS(getHeaders, 0);
-HTTP_BEGIN_ARGS(setHeaders, 0, 1)
+HTTP_EMPTY_ARGS(getHeaders);
+HTTP_BEGIN_ARGS(setHeaders, 1)
        HTTP_ARG_VAL(headers, 0)
 HTTP_END_ARGS;
 
-HTTP_BEGIN_ARGS(addHeaders, 0, 1)
+HTTP_BEGIN_ARGS(addHeaders, 1)
        HTTP_ARG_VAL(headers, 0)
        HTTP_ARG_VAL(append, 0)
 HTTP_END_ARGS;
 
-HTTP_EMPTY_ARGS(getType, 0);
-HTTP_BEGIN_ARGS(setType, 0, 1)
+HTTP_EMPTY_ARGS(getType);
+HTTP_BEGIN_ARGS(setType, 1)
        HTTP_ARG_VAL(type, 0)
 HTTP_END_ARGS;
 
-HTTP_EMPTY_ARGS(getResponseCode, 0);
-HTTP_BEGIN_ARGS(setResponseCode, 0, 1)
+HTTP_EMPTY_ARGS(getResponseCode);
+HTTP_BEGIN_ARGS(setResponseCode, 1)
        HTTP_ARG_VAL(response_code, 0)
 HTTP_END_ARGS;
 
-HTTP_EMPTY_ARGS(getRequestMethod, 0);
-HTTP_BEGIN_ARGS(setRequestMethod, 0, 1)
+HTTP_EMPTY_ARGS(getResponseStatus);
+HTTP_BEGIN_ARGS(setResponseStatus, 1)
+       HTTP_ARG_VAL(response_status, 0)
+HTTP_END_ARGS;
+
+HTTP_EMPTY_ARGS(getRequestMethod);
+HTTP_BEGIN_ARGS(setRequestMethod, 1)
        HTTP_ARG_VAL(request_method, 0)
 HTTP_END_ARGS;
 
-HTTP_EMPTY_ARGS(getRequestUrl, 0);
-HTTP_BEGIN_ARGS(setRequestUrl, 0, 1)
+HTTP_EMPTY_ARGS(getRequestUrl);
+HTTP_BEGIN_ARGS(setRequestUrl, 1)
        HTTP_ARG_VAL(url, 0)
 HTTP_END_ARGS;
 
-HTTP_EMPTY_ARGS(getHttpVersion, 0);
-HTTP_BEGIN_ARGS(setHttpVersion, 0, 1)
+HTTP_EMPTY_ARGS(getHttpVersion);
+HTTP_BEGIN_ARGS(setHttpVersion, 1)
        HTTP_ARG_VAL(http_version, 0)
 HTTP_END_ARGS;
 
-HTTP_EMPTY_ARGS(getParentMessage, 0);
-HTTP_EMPTY_ARGS(send, 0);
-HTTP_BEGIN_ARGS(toString, 0, 0)
+HTTP_EMPTY_ARGS(getParentMessage);
+HTTP_EMPTY_ARGS(send);
+HTTP_BEGIN_ARGS(toString, 0)
        HTTP_ARG_VAL(include_parent, 0)
 HTTP_END_ARGS;
 
-HTTP_EMPTY_ARGS(toMessageTypeObject, 0);
+HTTP_EMPTY_ARGS(toMessageTypeObject);
 
-HTTP_EMPTY_ARGS(count, 0);
+HTTP_EMPTY_ARGS(count);
 
-HTTP_EMPTY_ARGS(serialize, 0);
-HTTP_BEGIN_ARGS(unserialize, 0, 1)
+HTTP_EMPTY_ARGS(serialize);
+HTTP_BEGIN_ARGS(unserialize, 1)
        HTTP_ARG_VAL(serialized, 0)
 HTTP_END_ARGS;
 
-HTTP_EMPTY_ARGS(rewind, 0);
-HTTP_EMPTY_ARGS(valid, 0);
-HTTP_EMPTY_ARGS(key, 0);
-HTTP_EMPTY_ARGS(current, 0);
-HTTP_EMPTY_ARGS(next, 0);
+HTTP_EMPTY_ARGS(rewind);
+HTTP_EMPTY_ARGS(valid);
+HTTP_EMPTY_ARGS(key);
+HTTP_EMPTY_ARGS(current);
+HTTP_EMPTY_ARGS(next);
 
-HTTP_EMPTY_ARGS(detach, 0);
-HTTP_BEGIN_ARGS(prepend, 0, 1)
+HTTP_EMPTY_ARGS(detach);
+HTTP_BEGIN_ARGS(prepend, 1)
        HTTP_ARG_OBJ(HttpMessage, message, 0)
 HTTP_END_ARGS;
+HTTP_EMPTY_ARGS(reverse);
 
 #define http_message_object_declare_default_properties() _http_message_object_declare_default_properties(TSRMLS_C)
 static inline void _http_message_object_declare_default_properties(TSRMLS_D);
@@ -138,6 +144,8 @@ zend_function_entry http_message_object_fe[] = {
        HTTP_MESSAGE_ME(setType, ZEND_ACC_PUBLIC)
        HTTP_MESSAGE_ME(getResponseCode, ZEND_ACC_PUBLIC)
        HTTP_MESSAGE_ME(setResponseCode, ZEND_ACC_PUBLIC)
+       HTTP_MESSAGE_ME(getResponseStatus, ZEND_ACC_PUBLIC)
+       HTTP_MESSAGE_ME(setResponseStatus, ZEND_ACC_PUBLIC)
        HTTP_MESSAGE_ME(getRequestMethod, ZEND_ACC_PUBLIC)
        HTTP_MESSAGE_ME(setRequestMethod, ZEND_ACC_PUBLIC)
        HTTP_MESSAGE_ME(getRequestUrl, ZEND_ACC_PUBLIC)
@@ -169,6 +177,7 @@ zend_function_entry http_message_object_fe[] = {
        
        HTTP_MESSAGE_ME(detach, ZEND_ACC_PUBLIC)
        HTTP_MESSAGE_ME(prepend, ZEND_ACC_PUBLIC)
+       HTTP_MESSAGE_ME(reverse, ZEND_ACC_PUBLIC)
 
        EMPTY_FUNCTION_ENTRY
 };
@@ -253,6 +262,7 @@ static inline void _http_message_object_declare_default_properties(TSRMLS_D)
        DCL_PROP(PROTECTED, string, body, "");
        DCL_PROP(PROTECTED, string, requestMethod, "");
        DCL_PROP(PROTECTED, string, requestUrl, "");
+       DCL_PROP(PROTECTED, string, responseStatus, "");
        DCL_PROP(PROTECTED, long, responseCode, 0);
        DCL_PROP_N(PROTECTED, httpVersion);
        DCL_PROP_N(PROTECTED, headers);
@@ -604,8 +614,8 @@ PHP_METHOD(HttpMessage, __construct)
  *
  * Create an HttpMessage object from a string. Kind of a static constructor.
  * 
- * Expects a string parameter containing a sinlge or several consecutive
- * HTTP messages.  Accepts an optionsl string parameter specifying the class to use.
+ * Expects a string parameter containing a single or several consecutive
+ * HTTP messages.  Accepts an optional string parameter specifying the class to use.
  * 
  * Returns an HttpMessage object on success or NULL on failure.
  * 
@@ -770,7 +780,7 @@ PHP_METHOD(HttpMessage, getType)
  *
  * Set Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE)
  * 
- * Exptects an int parameter, the HttpMessage::TYPE.
+ * Expects an int parameter, the HttpMessage::TYPE.
  */
 PHP_METHOD(HttpMessage, setType)
 {
@@ -832,6 +842,50 @@ PHP_METHOD(HttpMessage, setResponseCode)
 }
 /* }}} */
 
+/* {{{ proto string HttpMessage::getResponseStatus()
+ *
+ * Get the Response Status of the message (i.e. the string following the response code).
+ *
+ * Returns the HTTP response status string if the message is of type 
+ * HttpMessage::TYPE_RESPONSE, else FALSE.
+ */
+PHP_METHOD(HttpMessage, getResponseStatus)
+{
+       NO_ARGS;
+       
+       IF_RETVAL_USED {
+               getObject(http_message_object, obj);
+               HTTP_CHECK_MESSAGE_TYPE_RESPONSE(obj->message, RETURN_FALSE);
+               RETURN_STRING(obj->message->http.info.response.status, 1);
+       }
+}
+/* }}} */
+
+/* {{{ proto bool HttpMessage::setResponseStatus(string status)
+ *
+ * Set the Response Status of the HTTP message (i.e. the string following the response code).
+ *
+ * Expects a string parameter containing the response status text.
+ *
+ * Returns TRUE on success or FALSE if the message is not of type
+ * HttpMessage::TYPE_RESPONSE.
+ */
+PHP_METHOD(HttpMessage, setResponseStatus)
+{
+       char *status;
+       int status_len;
+       getObject(http_message_object, obj);
+       
+       HTTP_CHECK_MESSAGE_TYPE_RESPONSE(obj->message, RETURN_FALSE);
+       
+       if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &status, &status_len)) {
+               RETURN_FALSE;
+       }
+       STR_SET(obj->message->http.info.response.status, estrdup(status));
+       RETURN_TRUE;
+}
+/* }}} */
+
 /* {{{ proto string HttpMessage::getRequestMethod()
  *
  * Get the Request Method of the Message.
@@ -1189,10 +1243,9 @@ PHP_METHOD(HttpMessage, count)
 {
        NO_ARGS {
                long i;
-               http_message *msg;
                getObject(http_message_object, obj);
                
-               for (i = 0, msg = obj->message; msg; msg = msg->parent, ++i);
+               http_message_count(i, obj->message);
                RETURN_LONG(i);
        }
 }
@@ -1316,6 +1369,65 @@ PHP_METHOD(HttpMessage, prepend)
 }
 /* }}} */
 
+/* {{{ proto HttpMessage HttpMessage::reverse()
+ *
+ * Reorders the message chain in reverse order.
+ *
+ * Returns the most parent HttpMessage object.
+ */
+PHP_METHOD(HttpMessage, reverse)
+{
+       int i;
+       getObject(http_message_object, obj);
+       
+       NO_ARGS;
+       
+       /* count */
+       http_message_count(i, obj->message);
+       
+       if (i > 1) {
+               zval o;
+               zend_object_value *ovalues = NULL;
+               http_message_object **objects = NULL;
+               int last = i - 1;
+               
+               objects = ecalloc(i, sizeof(http_message_object *));
+               ovalues = ecalloc(i, sizeof(zend_object_value));
+       
+               /* we are the first message */
+               objects[0] = obj;
+               ovalues[0] = getThis()->value.obj;
+       
+               /* fetch parents */
+               INIT_PZVAL(&o);
+               o.type = IS_OBJECT;
+               for (i = 1; obj->parent.handle; ++i) {
+                       o.value.obj = obj->parent;
+                       ovalues[i] = o.value.obj;
+                       objects[i] = obj = zend_object_store_get_object(&o TSRMLS_CC);
+               }
+               
+               /* reorder parents */
+               for (last = --i; i; --i) {
+                       objects[i]->message->parent = objects[i-1]->message;
+                       objects[i]->parent = ovalues[i-1];
+               }
+               objects[0]->message->parent = NULL;
+               objects[0]->parent.handle = 0;
+               objects[0]->parent.handlers = NULL;
+               
+               /* add ref (why?) */
+               Z_OBJ_ADDREF_P(getThis());
+               RETVAL_OBJVAL(ovalues[last], 1);
+               
+               efree(objects);
+               efree(ovalues);
+       } else {
+               RETURN_ZVAL(getThis(), 1, 0);
+       }
+}
+/* }}} */
+
 /* {{{ proto void HttpMessage::rewind(void)
  *
  * Implements Iterator.