X-Git-Url: https://git.m6w6.name/?p=m6w6%2Fext-http;a=blobdiff_plain;f=http_message_object.c;h=d588192e2fc0e8e523eba35c1297f32f6a2090ff;hp=18d3793dea0d90a55216af845a9eefdff253f168;hb=39feb7a7e30bb4b393a6f76aa2f35d4e9275523e;hpb=629a41cd128726e4ed346aedb2028e7380388107 diff --git a/http_message_object.c b/http_message_object.c index 18d3793..d588192 100644 --- a/http_message_object.c +++ b/http_message_object.c @@ -30,7 +30,7 @@ #include "php_http_exception_object.h" #include "phpstr/phpstr.h" -#include "missing.h" +#include "missing.h" ZEND_EXTERN_MODULE_GLOBALS(http); @@ -47,6 +47,10 @@ HTTP_BEGIN_ARGS(fromString, 1, 1) HTTP_END_ARGS; HTTP_EMPTY_ARGS(getBody, 0); +HTTP_BEGIN_ARGS(setBody, 0, 1) + HTTP_ARG_VAL(body, 0) +HTTP_END_ARGS; + HTTP_EMPTY_ARGS(getHeaders, 0); HTTP_BEGIN_ARGS(setHeaders, 0, 1) HTTP_ARG_VAL(headers, 0) @@ -103,6 +107,7 @@ zend_class_entry *http_message_object_ce; zend_function_entry http_message_object_fe[] = { HTTP_MESSAGE_ME(__construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR) HTTP_MESSAGE_ME(getBody, ZEND_ACC_PUBLIC) + HTTP_MESSAGE_ME(setBody, ZEND_ACC_PUBLIC) HTTP_MESSAGE_ME(getHeaders, ZEND_ACC_PUBLIC) HTTP_MESSAGE_ME(setHeaders, ZEND_ACC_PUBLIC) HTTP_MESSAGE_ME(addHeaders, ZEND_ACC_PUBLIC) @@ -123,7 +128,8 @@ zend_function_entry http_message_object_fe[] = { ZEND_MALIAS(HttpMessage, __toString, toString, HTTP_ARGS(HttpMessage, toString), ZEND_ACC_PUBLIC) HTTP_MESSAGE_ME(fromString, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC) - {NULL, NULL, NULL} + + EMPTY_FUNCTION_ENTRY }; static zend_object_handlers http_message_object_handlers; @@ -154,9 +160,6 @@ zend_object_value _http_message_object_new_ex(zend_class_entry *ce, http_message o = ecalloc(1, sizeof(http_message_object)); o->zo.ce = ce; - o->message = NULL; - o->parent.handle = 0; - o->parent.handlers = NULL; if (msg) { o->message = msg; @@ -183,9 +186,11 @@ static inline void _http_message_object_declare_default_properties(TSRMLS_D) { zend_class_entry *ce = http_message_object_ce; - DCL_CONST(long, "NONE", HTTP_MSG_NONE); - DCL_CONST(long, "REQUEST", HTTP_MSG_REQUEST); - DCL_CONST(long, "RESPONSE", HTTP_MSG_RESPONSE); +#ifndef WONKY + DCL_CONST(long, "TYPE_NONE", HTTP_MSG_NONE); + DCL_CONST(long, "TYPE_REQUEST", HTTP_MSG_REQUEST); + DCL_CONST(long, "TYPE_RESPONSE", HTTP_MSG_RESPONSE); +#endif DCL_PROP(PROTECTED, long, type, HTTP_MSG_NONE); DCL_PROP(PROTECTED, string, body, ""); @@ -223,41 +228,32 @@ static zval *_http_message_object_read_prop(zval *object, zval *member, int type getObjectEx(http_message_object, obj, object); http_message *msg = obj->message; zval *return_value; +#ifdef WONKY + ulong h = zend_get_hash_value(Z_STRVAL_P(member), Z_STRLEN_P(member)+1); +#else + zend_property_info *pinfo = zend_get_property_info(obj->zo.ce, member, 1 TSRMLS_CC); + + if (!pinfo || ACC_PROP_PUBLIC(pinfo->flags)) { + return zend_get_std_object_handlers()->read_property(object, member, type TSRMLS_CC); + } +#endif return_value = &EG(uninitialized_zval); return_value->refcount = 0; return_value->is_ref = 0; -#if 0 - fprintf(stderr, "Read HttpMessage::$%s\n", Z_STRVAL_P(member)); +#ifdef WONKY + switch (h) +#else + switch (pinfo->h) #endif - if (!EG(scope) || !instanceof_function(EG(scope), obj->zo.ce TSRMLS_CC)) { - zend_error(HE_WARNING, "Cannot access protected property %s::$%s", obj->zo.ce->name, Z_STRVAL_P(member)); - return EG(uninitialized_zval_ptr); - } - - switch (zend_get_hash_value(Z_STRVAL_P(member), Z_STRLEN_P(member) + 1)) { case HTTP_MSG_PROPHASH_TYPE: RETVAL_LONG(msg->type); break; case HTTP_MSG_PROPHASH_HTTP_VERSION: - switch (msg->type) - { - case HTTP_MSG_REQUEST: - RETVAL_DOUBLE(msg->info.request.http_version); - break; - - case HTTP_MSG_RESPONSE: - RETVAL_DOUBLE(msg->info.response.http_version); - break; - - case HTTP_MSG_NONE: - default: - RETVAL_NULL(); - break; - } + RETVAL_DOUBLE(msg->http.version); break; case HTTP_MSG_PROPHASH_BODY: @@ -283,25 +279,22 @@ static zval *_http_message_object_read_prop(zval *object, zval *member, int type case HTTP_MSG_PROPHASH_PARENT_MESSAGE: if (msg->parent) { RETVAL_OBJVAL(obj->parent); - Z_TYPE_P(return_value) = IS_OBJECT; - return_value->value.obj = obj->parent; - zend_objects_store_add_ref(return_value TSRMLS_CC); } else { RETVAL_NULL(); } break; case HTTP_MSG_PROPHASH_REQUEST_METHOD: - if (HTTP_MSG_TYPE(REQUEST, msg) && msg->info.request.method) { - RETVAL_STRING(msg->info.request.method, 1); + if (HTTP_MSG_TYPE(REQUEST, msg) && msg->http.info.request.method) { + RETVAL_STRING(msg->http.info.request.method, 1); } else { RETVAL_NULL(); } break; case HTTP_MSG_PROPHASH_REQUEST_URI: - if (HTTP_MSG_TYPE(REQUEST, msg) && msg->info.request.URI) { - RETVAL_STRING(msg->info.request.URI, 1); + if (HTTP_MSG_TYPE(REQUEST, msg) && msg->http.info.request.URI) { + RETVAL_STRING(msg->http.info.request.URI, 1); } else { RETVAL_NULL(); } @@ -309,14 +302,26 @@ static zval *_http_message_object_read_prop(zval *object, zval *member, int type case HTTP_MSG_PROPHASH_RESPONSE_CODE: if (HTTP_MSG_TYPE(RESPONSE, msg)) { - RETVAL_LONG(msg->info.response.code); + RETVAL_LONG(msg->http.info.response.code); } else { RETVAL_NULL(); } break; - + + case HTTP_MSG_PROPHASH_RESPONSE_STATUS: + if (HTTP_MSG_TYPE(RESPONSE, msg) && msg->http.info.response.status) { + RETVAL_STRING(msg->http.info.response.status, 1); + } else { + RETVAL_NULL(); + } + break; + default: +#ifdef WONKY + return zend_get_std_object_handlers()->read_property(object, member, type TSRMLS_CC); +#else RETVAL_NULL(); +#endif break; } @@ -327,48 +332,31 @@ static void _http_message_object_write_prop(zval *object, zval *member, zval *va { getObjectEx(http_message_object, obj, object); http_message *msg = obj->message; - -#if 0 - fprintf(stderr, "Write HttpMessage::$%s\n", Z_STRVAL_P(member)); -#endif - if (!EG(scope) || !instanceof_function(EG(scope), obj->zo.ce TSRMLS_CC)) { - zend_error(HE_WARNING, "Cannot access protected property %s::$%s", obj->zo.ce->name, Z_STRVAL_P(member)); +#ifdef WONKY + ulong h = zend_get_hash_value(Z_STRVAL_P(member), Z_STRLEN_P(member) + 1); +#else + zend_property_info *pinfo = zend_get_property_info(obj->zo.ce, member, 1 TSRMLS_CC); + + if (!pinfo || ACC_PROP_PUBLIC(pinfo->flags)) { + zend_get_std_object_handlers()->write_property(object, member, value TSRMLS_CC); + return; } +#endif - switch (zend_get_hash_value(Z_STRVAL_P(member), Z_STRLEN_P(member) + 1)) +#ifdef WONKY + switch (h) +#else + switch (pinfo->h) +#endif { case HTTP_MSG_PROPHASH_TYPE: convert_to_long_ex(&value); - if ((http_message_type) Z_LVAL_P(value) != msg->type) { - if (HTTP_MSG_TYPE(REQUEST, msg)) { - if (msg->info.request.method) { - efree(msg->info.request.method); - } - if (msg->info.request.URI) { - efree(msg->info.request.URI); - } - } - msg->type = Z_LVAL_P(value); - if (HTTP_MSG_TYPE(REQUEST, msg)) { - msg->info.request.method = NULL; - msg->info.request.URI = NULL; - } - } - + http_message_set_type(msg, Z_LVAL_P(value)); break; case HTTP_MSG_PROPHASH_HTTP_VERSION: convert_to_double_ex(&value); - switch (msg->type) - { - case HTTP_MSG_REQUEST: - msg->info.request.http_version = Z_DVAL_P(value); - break; - - case HTTP_MSG_RESPONSE: - msg->info.response.http_version = Z_DVAL_P(value); - break; - } + msg->http.version = Z_DVAL_P(value); break; case HTTP_MSG_PROPHASH_BODY: @@ -394,31 +382,38 @@ static void _http_message_object_write_prop(zval *object, zval *member, zval *va break; case HTTP_MSG_PROPHASH_REQUEST_METHOD: - convert_to_string_ex(&value); if (HTTP_MSG_TYPE(REQUEST, msg)) { - if (msg->info.request.method) { - efree(msg->info.request.method); - } - msg->info.request.method = estrndup(Z_STRVAL_P(value), Z_STRLEN_P(value)); + convert_to_string_ex(&value); + STR_SET(msg->http.info.request.method, estrndup(Z_STRVAL_P(value), Z_STRLEN_P(value))); } break; case HTTP_MSG_PROPHASH_REQUEST_URI: - convert_to_string_ex(&value); if (HTTP_MSG_TYPE(REQUEST, msg)) { - if (msg->info.request.URI) { - efree(msg->info.request.URI); - } - msg->info.request.URI = estrndup(Z_STRVAL_P(value), Z_STRLEN_P(value)); + convert_to_string_ex(&value); + STR_SET(msg->http.info.request.URI, estrndup(Z_STRVAL_P(value), Z_STRLEN_P(value))); } break; case HTTP_MSG_PROPHASH_RESPONSE_CODE: - convert_to_long_ex(&value); if (HTTP_MSG_TYPE(RESPONSE, msg)) { - msg->info.response.code = Z_LVAL_P(value); + convert_to_long_ex(&value); + msg->http.info.response.code = Z_LVAL_P(value); } break; + + case HTTP_MSG_PROPHASH_RESPONSE_STATUS: + if (HTTP_MSG_TYPE(RESPONSE, msg)) { + convert_to_string_ex(&value); + STR_SET(msg->http.info.response.status, estrndup(Z_STRVAL_P(value), Z_STRLEN_P(value))); + } + break; + + default: +#ifdef WONKY + zend_get_std_object_handlers()->write_property(object, member, value TSRMLS_CC); +#endif + break; } } @@ -427,63 +422,63 @@ static HashTable *_http_message_object_get_props(zval *object TSRMLS_DC) zval *headers; getObjectEx(http_message_object, obj, object); http_message *msg = obj->message; + HashTable *props = OBJ_PROP(obj); + zval array; + + INIT_ZARR(array, props); -#define ASSOC_PROP(obj, ptype, name, val) \ +#define ASSOC_PROP(array, ptype, name, val) \ { \ - zval array; \ char *m_prop_name; \ int m_prop_len; \ - Z_ARRVAL(array) = OBJ_PROP(obj); \ - zend_mangle_property_name(&m_prop_name, &m_prop_len, "*", 1, name, lenof(name), 1); \ + zend_mangle_property_name(&m_prop_name, &m_prop_len, "*", 1, name, lenof(name), 0); \ add_assoc_ ##ptype## _ex(&array, m_prop_name, sizeof(name)+4, val); \ + efree(m_prop_name); \ } -#define ASSOC_STRING(obj, name, val) ASSOC_STRINGL(obj, name, val, strlen(val)) -#define ASSOC_STRINGL(obj, name, val, len) \ +#define ASSOC_STRING(array, name, val) ASSOC_STRINGL(array, name, val, strlen(val)) +#define ASSOC_STRINGL(array, name, val, len) \ { \ - zval array; \ char *m_prop_name; \ int m_prop_len; \ - Z_ARRVAL(array) = OBJ_PROP(obj); \ - zend_mangle_property_name(&m_prop_name, &m_prop_len, "*", 1, name, lenof(name), 1); \ + zend_mangle_property_name(&m_prop_name, &m_prop_len, "*", 1, name, lenof(name), 0); \ add_assoc_stringl_ex(&array, m_prop_name, sizeof(name)+4, val, len, 1); \ + efree(m_prop_name); \ } - zend_hash_clean(OBJ_PROP(obj)); - - ASSOC_PROP(obj, long, "type", msg->type); - ASSOC_STRINGL(obj, "body", PHPSTR_VAL(msg), PHPSTR_LEN(msg)); - - MAKE_STD_ZVAL(headers); - array_init(headers); - - zend_hash_copy(Z_ARRVAL_P(headers), &msg->hdrs, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *)); - ASSOC_PROP(obj, zval, "headers", headers); + ASSOC_PROP(array, long, "type", msg->type); + ASSOC_PROP(array, double, "httpVersion", msg->http.version); switch (msg->type) { case HTTP_MSG_REQUEST: - ASSOC_PROP(obj, double, "httpVersion", msg->info.request.http_version); - ASSOC_PROP(obj, long, "responseCode", 0); - ASSOC_STRING(obj, "requestMethod", msg->info.request.method); - ASSOC_STRING(obj, "requestUri", msg->info.request.URI); + ASSOC_PROP(array, long, "responseCode", 0); + ASSOC_STRINGL(array, "responseStatus", "", 0); + ASSOC_STRING(array, "requestMethod", msg->http.info.request.method); + ASSOC_STRING(array, "requestUri", msg->http.info.request.URI); break; case HTTP_MSG_RESPONSE: - ASSOC_PROP(obj, double, "httpVersion", msg->info.response.http_version); - ASSOC_PROP(obj, long, "responseCode", msg->info.response.code); - ASSOC_STRING(obj, "requestMethod", ""); - ASSOC_STRING(obj, "requestUri", ""); + ASSOC_PROP(array, long, "responseCode", msg->http.info.response.code); + ASSOC_STRING(array, "responseStatus", msg->http.info.response.status); + ASSOC_STRINGL(array, "requestMethod", "", 0); + ASSOC_STRINGL(array, "requestUri", "", 0); break; case HTTP_MSG_NONE: default: - ASSOC_PROP(obj, double, "httpVersion", 0.0); - ASSOC_PROP(obj, long, "responseCode", 0); - ASSOC_STRING(obj, "requestMethod", ""); - ASSOC_STRING(obj, "requestUri", ""); + ASSOC_PROP(array, long, "responseCode", 0); + ASSOC_STRINGL(array, "responseStatus", "", 0); + ASSOC_STRINGL(array, "requestMethod", "", 0); + ASSOC_STRINGL(array, "requestUri", "", 0); break; } + MAKE_STD_ZVAL(headers); + array_init(headers); + zend_hash_copy(Z_ARRVAL_P(headers), &msg->hdrs, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *)); + ASSOC_PROP(array, zval, "headers", headers); + ASSOC_STRINGL(array, "body", PHPSTR_VAL(msg), PHPSTR_LEN(msg)); + return OBJ_PROP(obj); } @@ -492,6 +487,13 @@ static HashTable *_http_message_object_get_props(zval *object TSRMLS_DC) /* {{{ proto void HttpMessage::__construct([string message]) * * Instantiate a new HttpMessage object. + * + * Accepts an optional string parameter containing a single or several + * consecutive HTTP messages. The constructed object will actually + * represent the *last* message of the passed string. If there were + * prior messages, those can be accessed by HttpMessage::getParentMessage(). + * + * Throws HttpMalformedHeaderException. */ PHP_METHOD(HttpMessage, __construct) { @@ -515,7 +517,14 @@ PHP_METHOD(HttpMessage, __construct) /* {{{ proto static HttpMessage HttpMessage::fromString(string raw_message) * - * Create an HttpMessage object from a string. + * Create an HttpMessage object from a string. Kind of a static constructor. + * + * Expects a string parameter containing a sinlge or several consecutive + * HTTP messages. + * + * Returns an HttpMessage object on success or NULL on failure. + * + * Throws HttpMalformedHeadersException. */ PHP_METHOD(HttpMessage, fromString) { @@ -523,22 +532,24 @@ PHP_METHOD(HttpMessage, fromString) int length = 0; http_message *msg = NULL; - if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &string, &length)) { - RETURN_NULL(); - } - - if (!(msg = http_message_parse(string, length))) { - RETURN_NULL(); + RETVAL_NULL(); + + SET_EH_THROW_HTTP(); + if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &string, &length)) { + if (msg = http_message_parse(string, length)) { + Z_TYPE_P(return_value) = IS_OBJECT; + return_value->value.obj = http_message_object_from_msg(msg); + } } - - Z_TYPE_P(return_value) = IS_OBJECT; - return_value->value.obj = http_message_object_from_msg(msg); + SET_EH_NORMAL(); } /* }}} */ /* {{{ proto string HttpMessage::getBody() * - * Get the body of the parsed Message. + * Get the body of the parsed HttpMessage. + * + * Returns the message body as string. */ PHP_METHOD(HttpMessage, getBody) { @@ -551,9 +562,31 @@ PHP_METHOD(HttpMessage, getBody) } /* }}} */ +/* {{{ proto void HttpMessage::setBody(string body) + * + * Set the body of the HttpMessage. + * NOTE: Don't forget to update any headers accordingly. + * + * Expects a string parameter containing the new body of the message. + */ +PHP_METHOD(HttpMessage, setBody) +{ + char *body; + int len; + getObject(http_message_object, obj); + + if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &body, &len)) { + phpstr_dtor(PHPSTR(obj->message)); + phpstr_from_string_ex(PHPSTR(obj->message), body, len); + } +} +/* }}} */ + /* {{{ proto array HttpMessage::getHeaders() * * Get Message Headers. + * + * Returns an associative array containing the messages HTTP headers. */ PHP_METHOD(HttpMessage, getHeaders) { @@ -563,7 +596,7 @@ PHP_METHOD(HttpMessage, getHeaders) zval headers; getObject(http_message_object, obj); - Z_ARRVAL(headers) = &obj->message->hdrs; + INIT_ZARR(headers, &obj->message->hdrs); array_init(return_value); array_copy(&headers, return_value); } @@ -573,6 +606,9 @@ PHP_METHOD(HttpMessage, getHeaders) /* {{{ proto void HttpMessage::setHeaders(array headers) * * Sets new headers. + * + * Expects an associative array as parameter containing the new HTTP headers, + * which will replace *all* previous HTTP headers of the message. */ PHP_METHOD(HttpMessage, setHeaders) { @@ -584,7 +620,7 @@ PHP_METHOD(HttpMessage, setHeaders) } zend_hash_clean(&obj->message->hdrs); - Z_ARRVAL(old_headers) = &obj->message->hdrs; + INIT_ZARR(old_headers, &obj->message->hdrs); array_copy(new_headers, &old_headers); } /* }}} */ @@ -592,6 +628,12 @@ PHP_METHOD(HttpMessage, setHeaders) /* {{{ proto void HttpMessage::addHeaders(array headers[, bool append = false]) * * Add headers. If append is true, headers with the same name will be separated, else overwritten. + * + * Expects an associative array as parameter containing the additional HTTP headers + * to add to the messages existing headers. If the optional bool parameter is true, + * and a header with the same name of one to add exists already, this respective + * header will be converted to an array containing both header values, otherwise + * it will be overwritten with the new header value. */ PHP_METHOD(HttpMessage, addHeaders) { @@ -603,7 +645,7 @@ PHP_METHOD(HttpMessage, addHeaders) return; } - Z_ARRVAL(old_headers) = &obj->message->hdrs; + INIT_ZARR(old_headers, &obj->message->hdrs); if (append) { array_append(new_headers, &old_headers); } else { @@ -612,9 +654,11 @@ PHP_METHOD(HttpMessage, addHeaders) } /* }}} */ -/* {{{ proto long HttpMessage::getType() +/* {{{ proto int HttpMessage::getType() * * Get Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE) + * + * Returns the HttpMessage::TYPE. */ PHP_METHOD(HttpMessage, getType) { @@ -627,9 +671,11 @@ PHP_METHOD(HttpMessage, getType) } /* }}} */ -/* {{{ proto void HttpMessage::setType(long type) +/* {{{ proto void HttpMessage::setType(int type) * * Set Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE) + * + * Exptects an int parameter, the HttpMessage::TYPE. */ PHP_METHOD(HttpMessage, setType) { @@ -643,9 +689,12 @@ PHP_METHOD(HttpMessage, setType) } /* }}} */ -/* {{{ proto long HttpMessage::getResponseCode() +/* {{{ proto int HttpMessage::getResponseCode() * * Get the Response Code of the Message. + * + * Returns the HTTP response code if the message is of type + * HttpMessage::TYPE_RESPONSE, else FALSE. */ PHP_METHOD(HttpMessage, getResponseCode) { @@ -653,32 +702,27 @@ PHP_METHOD(HttpMessage, getResponseCode) IF_RETVAL_USED { getObject(http_message_object, obj); - - if (!HTTP_MSG_TYPE(RESPONSE, obj->message)) { - http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_RESPONSE"); - RETURN_NULL(); - } - - RETURN_LONG(obj->message->info.response.code); + HTTP_CHECK_MESSAGE_TYPE_RESPONSE(obj->message, RETURN_FALSE); + RETURN_LONG(obj->message->http.info.response.code); } } /* }}} */ -/* {{{ proto bool HttpMessage::setResponseCode(long code) +/* {{{ proto bool HttpMessage::setResponseCode(int code) * * Set the response code of an HTTP Response Message. - * Returns false if the Message is not of type HTTP_MSG_RESPONSE, - * or if the response code is out of range (100-510). + * + * Expects an int parameter with the HTTP response code. + * + * Returns TRUE on success, or FALSE if the message is not of type + * HttpMessage::TYPE_RESPONSE or the response code is out of range (100-510). */ PHP_METHOD(HttpMessage, setResponseCode) { long code; getObject(http_message_object, obj); - if (!HTTP_MSG_TYPE(RESPONSE, obj->message)) { - http_error(HE_WARNING, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_RESPONSE"); - RETURN_FALSE; - } + HTTP_CHECK_MESSAGE_TYPE_RESPONSE(obj->message, RETURN_FALSE); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "l", &code)) { RETURN_FALSE; @@ -688,7 +732,7 @@ PHP_METHOD(HttpMessage, setResponseCode) RETURN_FALSE; } - obj->message->info.response.code = code; + obj->message->http.info.response.code = code; RETURN_TRUE; } /* }}} */ @@ -696,7 +740,9 @@ PHP_METHOD(HttpMessage, setResponseCode) /* {{{ proto string HttpMessage::getRequestMethod() * * Get the Request Method of the Message. - * Returns false if the Message is not of type HTTP_MSG_REQUEST. + * + * Returns the request method name on success, or FALSE if the message is + * not of type HttpMessage::TYPE_REQUEST. */ PHP_METHOD(HttpMessage, getRequestMethod) { @@ -704,13 +750,8 @@ PHP_METHOD(HttpMessage, getRequestMethod) IF_RETVAL_USED { getObject(http_message_object, obj); - - if (!HTTP_MSG_TYPE(REQUEST, obj->message)) { - http_error(HE_NOTICE, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_REQUEST"); - RETURN_NULL(); - } - - RETURN_STRING(obj->message->info.request.method, 1); + HTTP_CHECK_MESSAGE_TYPE_REQUEST(obj->message, RETURN_FALSE); + RETURN_STRING(obj->message->http.info.request.method, 1); } } /* }}} */ @@ -718,7 +759,11 @@ PHP_METHOD(HttpMessage, getRequestMethod) /* {{{ proto bool HttpMessage::setRequestMethod(string method) * * Set the Request Method of the HTTP Message. - * Returns false if the Message is not of type HTTP_MSG_REQUEST. + * + * Expects a string parameter containing the request method name. + * + * Returns TRUE on success, or FALSE if the message is not of type + * HttpMessage::TYPE_REQUEST or an invalid request method was supplied. */ PHP_METHOD(HttpMessage, setRequestMethod) { @@ -726,10 +771,7 @@ PHP_METHOD(HttpMessage, setRequestMethod) int method_len; getObject(http_message_object, obj); - if (!HTTP_MSG_TYPE(REQUEST, obj->message)) { - http_error(HE_WARNING, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_REQUEST"); - RETURN_FALSE; - } + HTTP_CHECK_MESSAGE_TYPE_REQUEST(obj->message, RETURN_FALSE); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &method, &method_len)) { RETURN_FALSE; @@ -743,7 +785,7 @@ PHP_METHOD(HttpMessage, setRequestMethod) RETURN_FALSE; } - STR_SET(obj->message->info.request.method, estrndup(method, method_len)); + STR_SET(obj->message->http.info.request.method, estrndup(method, method_len)); RETURN_TRUE; } /* }}} */ @@ -751,6 +793,9 @@ PHP_METHOD(HttpMessage, setRequestMethod) /* {{{ proto string HttpMessage::getRequestUri() * * Get the Request URI of the Message. + * + * Returns the request uri as string on success, or FALSE if the message + * is not of type HttpMessage::TYPE_REQUEST. */ PHP_METHOD(HttpMessage, getRequestUri) { @@ -758,13 +803,8 @@ PHP_METHOD(HttpMessage, getRequestUri) IF_RETVAL_USED { getObject(http_message_object, obj); - - if (!HTTP_MSG_TYPE(REQUEST, obj->message)) { - http_error(HE_WARNING, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_REQUEST"); - RETURN_NULL(); - } - - RETURN_STRING(obj->message->info.request.URI, 1); + HTTP_CHECK_MESSAGE_TYPE_REQUEST(obj->message, RETURN_FALSE); + RETURN_STRING(obj->message->http.info.request.URI, 1); } } /* }}} */ @@ -772,8 +812,11 @@ PHP_METHOD(HttpMessage, getRequestUri) /* {{{ proto bool HttpMessage::setRequestUri(string URI) * * Set the Request URI of the HTTP Message. - * Returns false if the Message is not of type HTTP_MSG_REQUEST, - * or if paramtere URI was empty. + * + * Expects a string parameters containing the request uri. + * + * Returns TRUE on success, or FALSE if the message is not of type + * HttpMessage::TYPE_REQUEST or supplied URI was empty. */ PHP_METHOD(HttpMessage, setRequestUri) { @@ -781,19 +824,16 @@ PHP_METHOD(HttpMessage, setRequestUri) int URIlen; getObject(http_message_object, obj); - if (!HTTP_MSG_TYPE(REQUEST, obj->message)) { - http_error(HE_WARNING, HTTP_E_MESSAGE_TYPE, "HttpMessage is not of type HTTP_MSG_REQUEST"); - RETURN_FALSE; - } if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &URI, &URIlen)) { RETURN_FALSE; } + HTTP_CHECK_MESSAGE_TYPE_REQUEST(obj->message, RETURN_FALSE); if (URIlen < 1) { http_error(HE_WARNING, HTTP_E_INVALID_PARAM, "Cannot set HttpMessage::requestUri to an empty string"); RETURN_FALSE; } - STR_SET(obj->message->info.request.URI, estrndup(URI, URIlen)); + STR_SET(obj->message->http.info.request.URI, estrndup(URI, URIlen)); RETURN_TRUE; } /* }}} */ @@ -801,6 +841,8 @@ PHP_METHOD(HttpMessage, setRequestUri) /* {{{ proto string HttpMessage::getHttpVersion() * * Get the HTTP Protocol Version of the Message. + * + * Returns the HTTP protocol version as string. */ PHP_METHOD(HttpMessage, getHttpVersion) { @@ -808,24 +850,9 @@ PHP_METHOD(HttpMessage, getHttpVersion) IF_RETVAL_USED { char ver[4] = {0}; - double version; getObject(http_message_object, obj); - switch (obj->message->type) - { - case HTTP_MSG_RESPONSE: - version = obj->message->info.response.http_version; - break; - - case HTTP_MSG_REQUEST: - version = obj->message->info.request.http_version; - break; - - case HTTP_MSG_NONE: - default: - RETURN_NULL(); - } - sprintf(ver, "%1.1lf", version); + sprintf(ver, "%1.1lf", obj->message->http.version); RETURN_STRINGL(ver, 3, 1); } } @@ -834,7 +861,10 @@ PHP_METHOD(HttpMessage, getHttpVersion) /* {{{ proto bool HttpMessage::setHttpVersion(string version) * * Set the HTTP Protocol version of the Message. - * Returns false if version is invalid (1.0 and 1.1). + * + * Expects a string parameter containing the HTTP protocol version. + * + * Returns TRUE on success, or FALSE if supplied version is out of range (1.0/1.1). */ PHP_METHOD(HttpMessage, setHttpVersion) { @@ -846,11 +876,6 @@ PHP_METHOD(HttpMessage, setHttpVersion) return; } - if (HTTP_MSG_TYPE(NONE, obj->message)) { - http_error(HE_WARNING, HTTP_E_MESSAGE_TYPE, "Message is neither of type HTTP_MSG_RESPONSE nor HTTP_MSG_REQUEST"); - RETURN_FALSE; - } - convert_to_double(zv); sprintf(v, "%1.1lf", Z_DVAL_P(zv)); if (strcmp(v, "1.0") && strcmp(v, "1.1")) { @@ -858,11 +883,7 @@ PHP_METHOD(HttpMessage, setHttpVersion) RETURN_FALSE; } - if (HTTP_MSG_TYPE(RESPONSE, obj->message)) { - obj->message->info.response.http_version = Z_DVAL_P(zv); - } else { - obj->message->info.request.http_version = Z_DVAL_P(zv); - } + obj->message->http.version = Z_DVAL_P(zv); RETURN_TRUE; } /* }}} */ @@ -870,6 +891,8 @@ PHP_METHOD(HttpMessage, setHttpVersion) /* {{{ proto HttpMessage HttpMessage::getParentMessage() * * Get parent Message. + * + * Returns the parent HttpMessage on success, or NULL if there's none. */ PHP_METHOD(HttpMessage, getParentMessage) { @@ -890,6 +913,9 @@ PHP_METHOD(HttpMessage, getParentMessage) /* {{{ proto bool HttpMessage::send() * * Send the Message according to its type as Response or Request. + * This provides limited functionality compared to HttpRequest and HttpResponse. + * + * Returns TRUE on success, or FALSE on failure. */ PHP_METHOD(HttpMessage, send) { @@ -901,16 +927,21 @@ PHP_METHOD(HttpMessage, send) } /* }}} */ -/* {{{ proto string HttpMessage::toString([bool include_parent = true]) +/* {{{ proto string HttpMessage::toString([bool include_parent = false]) * * Get the string representation of the Message. + * + * Accepts a bool parameter which specifies whether the returned string + * should also contain any parent messages. + * + * Returns the full message as string. */ PHP_METHOD(HttpMessage, toString) { IF_RETVAL_USED { char *string; size_t length; - zend_bool include_parent = 1; + zend_bool include_parent = 0; getObject(http_message_object, obj); if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &include_parent)) {