2 +----------------------------------------------------------------------+
4 +----------------------------------------------------------------------+
5 | This source file is subject to version 3.0 of the PHP license, that |
6 | is bundled with this package in the file LICENSE, and is available |
7 | through the world-wide-web at http://www.php.net/license/3_0.txt. |
8 | If you did not receive a copy of the PHP license and are unable to |
9 | obtain it through the world-wide-web, please send a note to |
10 | license@php.net so we can mail you a copy immediately. |
11 +----------------------------------------------------------------------+
12 | Copyright (c) 2004-2005 Michael Wallner <mike@php.net> |
13 +----------------------------------------------------------------------+
27 #include "php_http_api.h"
28 #include "php_http_std_defs.h"
29 #include "php_http_message_object.h"
30 #include "php_http_exception_object.h"
32 #include "phpstr/phpstr.h"
35 ZEND_EXTERN_MODULE_GLOBALS(http
);
37 #define HTTP_BEGIN_ARGS(method, ret_ref, req_args) HTTP_BEGIN_ARGS_EX(HttpMessage, method, ret_ref, req_args)
38 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpMessage, method, ret_ref)
39 #define HTTP_MESSAGE_ME(method, visibility) PHP_ME(HttpMessage, method, HTTP_ARGS(HttpMessage, method), visibility)
41 HTTP_BEGIN_ARGS(__construct
, 0, 0)
42 HTTP_ARG_VAL(message
, 0)
45 HTTP_BEGIN_ARGS(fromString
, 1, 1)
46 HTTP_ARG_VAL(message
, 0)
49 HTTP_EMPTY_ARGS(getBody
, 0);
50 HTTP_BEGIN_ARGS(setBody
, 0, 1)
54 HTTP_EMPTY_ARGS(getHeaders
, 0);
55 HTTP_BEGIN_ARGS(setHeaders
, 0, 1)
56 HTTP_ARG_VAL(headers
, 0)
59 HTTP_BEGIN_ARGS(addHeaders
, 0, 1)
60 HTTP_ARG_VAL(headers
, 0)
61 HTTP_ARG_VAL(append
, 0)
64 HTTP_EMPTY_ARGS(getType
, 0);
65 HTTP_BEGIN_ARGS(setType
, 0, 1)
69 HTTP_EMPTY_ARGS(getResponseCode
, 0);
70 HTTP_BEGIN_ARGS(setResponseCode
, 0, 1)
71 HTTP_ARG_VAL(response_code
, 0)
74 HTTP_EMPTY_ARGS(getRequestMethod
, 0);
75 HTTP_BEGIN_ARGS(setRequestMethod
, 0, 1)
76 HTTP_ARG_VAL(request_method
, 0)
79 HTTP_EMPTY_ARGS(getRequestUri
, 0);
80 HTTP_BEGIN_ARGS(setRequestUri
, 0, 1)
84 HTTP_EMPTY_ARGS(getHttpVersion
, 0);
85 HTTP_BEGIN_ARGS(setHttpVersion
, 0, 1)
86 HTTP_ARG_VAL(http_version
, 0)
89 HTTP_EMPTY_ARGS(getParentMessage
, 1);
90 HTTP_EMPTY_ARGS(send
, 0);
91 HTTP_BEGIN_ARGS(toString
, 0, 0)
92 HTTP_ARG_VAL(include_parent
, 0)
95 #define http_message_object_declare_default_properties() _http_message_object_declare_default_properties(TSRMLS_C)
96 static inline void _http_message_object_declare_default_properties(TSRMLS_D
);
97 #define http_message_object_read_prop _http_message_object_read_prop
98 static zval
*_http_message_object_read_prop(zval
*object
, zval
*member
, int type TSRMLS_DC
);
99 #define http_message_object_write_prop _http_message_object_write_prop
100 static void _http_message_object_write_prop(zval
*object
, zval
*member
, zval
*value TSRMLS_DC
);
101 #define http_message_object_get_props _http_message_object_get_props
102 static HashTable
*_http_message_object_get_props(zval
*object TSRMLS_DC
);
103 #define http_message_object_clone_obj _http_message_object_clone_obj
104 static inline zend_object_value
_http_message_object_clone_obj(zval
*object TSRMLS_DC
);
106 zend_class_entry
*http_message_object_ce
;
107 zend_function_entry http_message_object_fe
[] = {
108 HTTP_MESSAGE_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
109 HTTP_MESSAGE_ME(getBody
, ZEND_ACC_PUBLIC
)
110 HTTP_MESSAGE_ME(setBody
, ZEND_ACC_PUBLIC
)
111 HTTP_MESSAGE_ME(getHeaders
, ZEND_ACC_PUBLIC
)
112 HTTP_MESSAGE_ME(setHeaders
, ZEND_ACC_PUBLIC
)
113 HTTP_MESSAGE_ME(addHeaders
, ZEND_ACC_PUBLIC
)
114 HTTP_MESSAGE_ME(getType
, ZEND_ACC_PUBLIC
)
115 HTTP_MESSAGE_ME(setType
, ZEND_ACC_PUBLIC
)
116 HTTP_MESSAGE_ME(getResponseCode
, ZEND_ACC_PUBLIC
)
117 HTTP_MESSAGE_ME(setResponseCode
, ZEND_ACC_PUBLIC
)
118 HTTP_MESSAGE_ME(getRequestMethod
, ZEND_ACC_PUBLIC
)
119 HTTP_MESSAGE_ME(setRequestMethod
, ZEND_ACC_PUBLIC
)
120 HTTP_MESSAGE_ME(getRequestUri
, ZEND_ACC_PUBLIC
)
121 HTTP_MESSAGE_ME(setRequestUri
, ZEND_ACC_PUBLIC
)
122 HTTP_MESSAGE_ME(getHttpVersion
, ZEND_ACC_PUBLIC
)
123 HTTP_MESSAGE_ME(setHttpVersion
, ZEND_ACC_PUBLIC
)
124 HTTP_MESSAGE_ME(getParentMessage
, ZEND_ACC_PUBLIC
)
125 HTTP_MESSAGE_ME(send
, ZEND_ACC_PUBLIC
)
126 HTTP_MESSAGE_ME(toString
, ZEND_ACC_PUBLIC
)
128 ZEND_MALIAS(HttpMessage
, __toString
, toString
, HTTP_ARGS(HttpMessage
, toString
), ZEND_ACC_PUBLIC
)
130 HTTP_MESSAGE_ME(fromString
, ZEND_ACC_PUBLIC
|ZEND_ACC_STATIC
)
134 static zend_object_handlers http_message_object_handlers
;
136 PHP_MINIT_FUNCTION(http_message_object
)
138 HTTP_REGISTER_CLASS_EX(HttpMessage
, http_message_object
, NULL
, 0);
140 HTTP_LONG_CONSTANT("HTTP_MSG_NONE", HTTP_MSG_NONE
);
141 HTTP_LONG_CONSTANT("HTTP_MSG_REQUEST", HTTP_MSG_REQUEST
);
142 HTTP_LONG_CONSTANT("HTTP_MSG_RESPONSE", HTTP_MSG_RESPONSE
);
144 http_message_object_handlers
.clone_obj
= http_message_object_clone_obj
;
145 http_message_object_handlers
.read_property
= http_message_object_read_prop
;
146 http_message_object_handlers
.write_property
= http_message_object_write_prop
;
147 http_message_object_handlers
.get_properties
= http_message_object_get_props
;
148 http_message_object_handlers
.get_property_ptr_ptr
= NULL
;
153 zend_object_value
_http_message_object_new(zend_class_entry
*ce TSRMLS_DC
)
155 return http_message_object_new_ex(ce
, NULL
);
158 zend_object_value
_http_message_object_new_ex(zend_class_entry
*ce
, http_message
*msg TSRMLS_DC
)
160 zend_object_value ov
;
161 http_message_object
*o
;
163 o
= ecalloc(1, sizeof(http_message_object
));
169 o
->parent
= http_message_object_from_msg(msg
->parent
);
173 ALLOC_HASHTABLE(OBJ_PROP(o
));
174 zend_hash_init(OBJ_PROP(o
), 0, NULL
, ZVAL_PTR_DTOR
, 0);
176 ov
.handle
= putObject(http_message_object
, o
);
177 ov
.handlers
= &http_message_object_handlers
;
182 zend_object_value
_http_message_object_clone(zval
*this_ptr TSRMLS_DC
)
184 return http_message_object_clone_obj(this_ptr TSRMLS_CC
);
187 static inline void _http_message_object_declare_default_properties(TSRMLS_D
)
189 zend_class_entry
*ce
= http_message_object_ce
;
192 DCL_CONST(long, "TYPE_NONE", HTTP_MSG_NONE
);
193 DCL_CONST(long, "TYPE_REQUEST", HTTP_MSG_REQUEST
);
194 DCL_CONST(long, "TYPE_RESPONSE", HTTP_MSG_RESPONSE
);
197 DCL_PROP(PROTECTED
, long, type
, HTTP_MSG_NONE
);
198 DCL_PROP(PROTECTED
, string
, body
, "");
199 DCL_PROP(PROTECTED
, string
, requestMethod
, "");
200 DCL_PROP(PROTECTED
, string
, requestUri
, "");
201 DCL_PROP(PROTECTED
, long, responseCode
, 0);
202 DCL_PROP_N(PROTECTED
, httpVersion
);
203 DCL_PROP_N(PROTECTED
, headers
);
204 DCL_PROP_N(PROTECTED
, parentMessage
);
207 void _http_message_object_free(zend_object
*object TSRMLS_DC
)
209 http_message_object
*o
= (http_message_object
*) object
;
212 zend_hash_destroy(OBJ_PROP(o
));
213 FREE_HASHTABLE(OBJ_PROP(o
));
216 http_message_dtor(o
->message
);
222 static inline zend_object_value
_http_message_object_clone_obj(zval
*this_ptr TSRMLS_DC
)
224 getObject(http_message_object
, obj
);
225 return http_message_object_from_msg(http_message_dup(obj
->message
));
228 static zval
*_http_message_object_read_prop(zval
*object
, zval
*member
, int type TSRMLS_DC
)
230 getObjectEx(http_message_object
, obj
, object
);
231 http_message
*msg
= obj
->message
;
234 ulong h
= zend_get_hash_value(Z_STRVAL_P(member
), Z_STRLEN_P(member
)+1);
236 zend_property_info
*pinfo
= zend_get_property_info(obj
->zo
.ce
, member
, 1 TSRMLS_CC
);
238 if (!pinfo
|| ACC_PROP_PUBLIC(pinfo
->flags
)) {
239 return zend_get_std_object_handlers()->read_property(object
, member
, type TSRMLS_CC
);
243 return_value
= &EG(uninitialized_zval
);
244 return_value
->refcount
= 0;
245 return_value
->is_ref
= 0;
253 case HTTP_MSG_PROPHASH_TYPE
:
254 RETVAL_LONG(msg
->type
);
257 case HTTP_MSG_PROPHASH_HTTP_VERSION
:
258 RETVAL_DOUBLE(msg
->http
.version
);
261 case HTTP_MSG_PROPHASH_BODY
:
262 phpstr_fix(PHPSTR(msg
));
263 RETVAL_PHPSTR(PHPSTR(msg
), 0, 1);
266 case HTTP_MSG_PROPHASH_HEADERS
:
267 /* This is needed for situations like
268 * $this->headers['foo'] = 'bar';
270 if (type
== BP_VAR_W
) {
271 return_value
->refcount
= 1;
272 return_value
->is_ref
= 1;
273 Z_TYPE_P(return_value
) = IS_ARRAY
;
274 Z_ARRVAL_P(return_value
) = &msg
->hdrs
;
276 array_init(return_value
);
277 zend_hash_copy(Z_ARRVAL_P(return_value
), &msg
->hdrs
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
281 case HTTP_MSG_PROPHASH_PARENT_MESSAGE
:
283 RETVAL_OBJVAL(obj
->parent
);
289 case HTTP_MSG_PROPHASH_REQUEST_METHOD
:
290 if (HTTP_MSG_TYPE(REQUEST
, msg
) && msg
->http
.info
.request
.method
) {
291 RETVAL_STRING(msg
->http
.info
.request
.method
, 1);
297 case HTTP_MSG_PROPHASH_REQUEST_URI
:
298 if (HTTP_MSG_TYPE(REQUEST
, msg
) && msg
->http
.info
.request
.URI
) {
299 RETVAL_STRING(msg
->http
.info
.request
.URI
, 1);
305 case HTTP_MSG_PROPHASH_RESPONSE_CODE
:
306 if (HTTP_MSG_TYPE(RESPONSE
, msg
)) {
307 RETVAL_LONG(msg
->http
.info
.response
.code
);
313 case HTTP_MSG_PROPHASH_RESPONSE_STATUS
:
314 if (HTTP_MSG_TYPE(RESPONSE
, msg
) && msg
->http
.info
.response
.status
) {
315 RETVAL_STRING(msg
->http
.info
.response
.status
, 1);
323 return zend_get_std_object_handlers()->read_property(object
, member
, type TSRMLS_CC
);
333 static void _http_message_object_write_prop(zval
*object
, zval
*member
, zval
*value TSRMLS_DC
)
335 getObjectEx(http_message_object
, obj
, object
);
336 http_message
*msg
= obj
->message
;
338 ulong h
= zend_get_hash_value(Z_STRVAL_P(member
), Z_STRLEN_P(member
) + 1);
340 zend_property_info
*pinfo
= zend_get_property_info(obj
->zo
.ce
, member
, 1 TSRMLS_CC
);
342 if (!pinfo
|| ACC_PROP_PUBLIC(pinfo
->flags
)) {
343 zend_get_std_object_handlers()->write_property(object
, member
, value TSRMLS_CC
);
354 case HTTP_MSG_PROPHASH_TYPE
:
355 convert_to_long_ex(&value
);
356 http_message_set_type(msg
, Z_LVAL_P(value
));
359 case HTTP_MSG_PROPHASH_HTTP_VERSION
:
360 convert_to_double_ex(&value
);
361 msg
->http
.version
= Z_DVAL_P(value
);
364 case HTTP_MSG_PROPHASH_BODY
:
365 convert_to_string_ex(&value
);
366 phpstr_dtor(PHPSTR(msg
));
367 phpstr_from_string_ex(PHPSTR(msg
), Z_STRVAL_P(value
), Z_STRLEN_P(value
));
370 case HTTP_MSG_PROPHASH_HEADERS
:
371 convert_to_array_ex(&value
);
372 zend_hash_clean(&msg
->hdrs
);
373 zend_hash_copy(&msg
->hdrs
, Z_ARRVAL_P(value
), (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
376 case HTTP_MSG_PROPHASH_PARENT_MESSAGE
:
377 if (Z_TYPE_P(value
) == IS_OBJECT
&& instanceof_function(Z_OBJCE_P(value
), http_message_object_ce TSRMLS_CC
)) {
380 tmp
.value
.obj
= obj
->parent
;
383 Z_OBJ_ADDREF_P(value
);
384 obj
->parent
= value
->value
.obj
;
388 case HTTP_MSG_PROPHASH_REQUEST_METHOD
:
389 if (HTTP_MSG_TYPE(REQUEST
, msg
)) {
390 convert_to_string_ex(&value
);
391 STR_SET(msg
->http
.info
.request
.method
, estrndup(Z_STRVAL_P(value
), Z_STRLEN_P(value
)));
395 case HTTP_MSG_PROPHASH_REQUEST_URI
:
396 if (HTTP_MSG_TYPE(REQUEST
, msg
)) {
397 convert_to_string_ex(&value
);
398 STR_SET(msg
->http
.info
.request
.URI
, estrndup(Z_STRVAL_P(value
), Z_STRLEN_P(value
)));
402 case HTTP_MSG_PROPHASH_RESPONSE_CODE
:
403 if (HTTP_MSG_TYPE(RESPONSE
, msg
)) {
404 convert_to_long_ex(&value
);
405 msg
->http
.info
.response
.code
= Z_LVAL_P(value
);
409 case HTTP_MSG_PROPHASH_RESPONSE_STATUS
:
410 if (HTTP_MSG_TYPE(RESPONSE
, msg
)) {
411 convert_to_string_ex(&value
);
412 STR_SET(msg
->http
.info
.response
.status
, estrndup(Z_STRVAL_P(value
), Z_STRLEN_P(value
)));
418 zend_get_std_object_handlers()->write_property(object
, member
, value TSRMLS_CC
);
424 static HashTable
*_http_message_object_get_props(zval
*object TSRMLS_DC
)
427 getObjectEx(http_message_object
, obj
, object
);
428 http_message
*msg
= obj
->message
;
429 HashTable
*props
= OBJ_PROP(obj
);
432 INIT_ZARR(array
, props
);
434 #define ASSOC_PROP(array, ptype, name, val) \
438 zend_mangle_property_name(&m_prop_name, &m_prop_len, "*", 1, name, lenof(name), 0); \
439 add_assoc_ ##ptype## _ex(&array, m_prop_name, sizeof(name)+4, val); \
440 efree(m_prop_name); \
442 #define ASSOC_STRING(array, name, val) ASSOC_STRINGL(array, name, val, strlen(val))
443 #define ASSOC_STRINGL(array, name, val, len) \
447 zend_mangle_property_name(&m_prop_name, &m_prop_len, "*", 1, name, lenof(name), 0); \
448 add_assoc_stringl_ex(&array, m_prop_name, sizeof(name)+4, val, len, 1); \
449 efree(m_prop_name); \
452 ASSOC_PROP(array
, long, "type", msg
->type
);
453 ASSOC_PROP(array
, double, "httpVersion", msg
->http
.version
);
457 case HTTP_MSG_REQUEST
:
458 ASSOC_PROP(array
, long, "responseCode", 0);
459 ASSOC_STRINGL(array
, "responseStatus", "", 0);
460 ASSOC_STRING(array
, "requestMethod", msg
->http
.info
.request
.method
);
461 ASSOC_STRING(array
, "requestUri", msg
->http
.info
.request
.URI
);
464 case HTTP_MSG_RESPONSE
:
465 ASSOC_PROP(array
, long, "responseCode", msg
->http
.info
.response
.code
);
466 ASSOC_STRING(array
, "responseStatus", msg
->http
.info
.response
.status
);
467 ASSOC_STRINGL(array
, "requestMethod", "", 0);
468 ASSOC_STRINGL(array
, "requestUri", "", 0);
473 ASSOC_PROP(array
, long, "responseCode", 0);
474 ASSOC_STRINGL(array
, "responseStatus", "", 0);
475 ASSOC_STRINGL(array
, "requestMethod", "", 0);
476 ASSOC_STRINGL(array
, "requestUri", "", 0);
480 MAKE_STD_ZVAL(headers
);
482 zend_hash_copy(Z_ARRVAL_P(headers
), &msg
->hdrs
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
483 ASSOC_PROP(array
, zval
, "headers", headers
);
484 ASSOC_STRINGL(array
, "body", PHPSTR_VAL(msg
), PHPSTR_LEN(msg
));
486 return OBJ_PROP(obj
);
489 /* ### USERLAND ### */
491 /* {{{ proto void HttpMessage::__construct([string message])
493 * Instantiate a new HttpMessage object.
495 * Accepts an optional string parameter containing a single or several
496 * consecutive HTTP messages. The constructed object will actually
497 * represent the *last* message of the passed string. If there were
498 * prior messages, those can be accessed by HttpMessage::getParentMessage().
500 * Throws HttpMalformedHeaderException.
502 PHP_METHOD(HttpMessage
, __construct
)
504 char *message
= NULL
;
506 getObject(http_message_object
, obj
);
509 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &message
, &length
) && message
&& length
) {
510 if (obj
->message
= http_message_parse(message
, length
)) {
511 if (obj
->message
->parent
) {
512 obj
->parent
= http_message_object_from_msg(obj
->message
->parent
);
515 } else if (!obj
->message
) {
516 obj
->message
= http_message_new();
522 /* {{{ proto static HttpMessage HttpMessage::fromString(string raw_message)
524 * Create an HttpMessage object from a string. Kind of a static constructor.
526 * Expects a string parameter containing a sinlge or several consecutive
529 * Returns an HttpMessage object on success or NULL on failure.
531 * Throws HttpMalformedHeadersException.
533 PHP_METHOD(HttpMessage
, fromString
)
537 http_message
*msg
= NULL
;
542 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &string
, &length
)) {
543 if (msg
= http_message_parse(string
, length
)) {
544 Z_TYPE_P(return_value
) = IS_OBJECT
;
545 return_value
->value
.obj
= http_message_object_from_msg(msg
);
552 /* {{{ proto string HttpMessage::getBody()
554 * Get the body of the parsed HttpMessage.
556 * Returns the message body as string.
558 PHP_METHOD(HttpMessage
, getBody
)
563 getObject(http_message_object
, obj
);
564 RETURN_PHPSTR(&obj
->message
->body
, PHPSTR_FREE_NOT
, 1);
569 /* {{{ proto void HttpMessage::setBody(string body)
571 * Set the body of the HttpMessage.
572 * NOTE: Don't forget to update any headers accordingly.
574 * Expects a string parameter containing the new body of the message.
576 PHP_METHOD(HttpMessage
, setBody
)
580 getObject(http_message_object
, obj
);
582 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &body
, &len
)) {
583 phpstr_dtor(PHPSTR(obj
->message
));
584 phpstr_from_string_ex(PHPSTR(obj
->message
), body
, len
);
589 /* {{{ proto array HttpMessage::getHeaders()
591 * Get Message Headers.
593 * Returns an associative array containing the messages HTTP headers.
595 PHP_METHOD(HttpMessage
, getHeaders
)
601 getObject(http_message_object
, obj
);
603 INIT_ZARR(headers
, &obj
->message
->hdrs
);
604 array_init(return_value
);
605 array_copy(&headers
, return_value
);
610 /* {{{ proto void HttpMessage::setHeaders(array headers)
614 * Expects an associative array as parameter containing the new HTTP headers,
615 * which will replace *all* previous HTTP headers of the message.
617 PHP_METHOD(HttpMessage
, setHeaders
)
619 zval
*new_headers
, old_headers
;
620 getObject(http_message_object
, obj
);
622 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &new_headers
)) {
626 zend_hash_clean(&obj
->message
->hdrs
);
627 INIT_ZARR(old_headers
, &obj
->message
->hdrs
);
628 array_copy(new_headers
, &old_headers
);
632 /* {{{ proto void HttpMessage::addHeaders(array headers[, bool append = false])
634 * Add headers. If append is true, headers with the same name will be separated, else overwritten.
636 * Expects an associative array as parameter containing the additional HTTP headers
637 * to add to the messages existing headers. If the optional bool parameter is true,
638 * and a header with the same name of one to add exists already, this respective
639 * header will be converted to an array containing both header values, otherwise
640 * it will be overwritten with the new header value.
642 PHP_METHOD(HttpMessage
, addHeaders
)
644 zval old_headers
, *new_headers
;
645 zend_bool append
= 0;
646 getObject(http_message_object
, obj
);
648 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|b", &new_headers
, &append
)) {
652 INIT_ZARR(old_headers
, &obj
->message
->hdrs
);
654 array_append(new_headers
, &old_headers
);
656 array_merge(new_headers
, &old_headers
);
661 /* {{{ proto int HttpMessage::getType()
663 * Get Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE)
665 * Returns the HttpMessage::TYPE.
667 PHP_METHOD(HttpMessage
, getType
)
672 getObject(http_message_object
, obj
);
673 RETURN_LONG(obj
->message
->type
);
678 /* {{{ proto void HttpMessage::setType(int type)
680 * Set Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE)
682 * Exptects an int parameter, the HttpMessage::TYPE.
684 PHP_METHOD(HttpMessage
, setType
)
687 getObject(http_message_object
, obj
);
689 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &type
)) {
692 http_message_set_type(obj
->message
, type
);
696 /* {{{ proto int HttpMessage::getResponseCode()
698 * Get the Response Code of the Message.
700 * Returns the HTTP response code if the message is of type
701 * HttpMessage::TYPE_RESPONSE, else FALSE.
703 PHP_METHOD(HttpMessage
, getResponseCode
)
708 getObject(http_message_object
, obj
);
709 HTTP_CHECK_MESSAGE_TYPE_RESPONSE(obj
->message
, RETURN_FALSE
);
710 RETURN_LONG(obj
->message
->http
.info
.response
.code
);
715 /* {{{ proto bool HttpMessage::setResponseCode(int code)
717 * Set the response code of an HTTP Response Message.
719 * Expects an int parameter with the HTTP response code.
721 * Returns TRUE on success, or FALSE if the message is not of type
722 * HttpMessage::TYPE_RESPONSE or the response code is out of range (100-510).
724 PHP_METHOD(HttpMessage
, setResponseCode
)
727 getObject(http_message_object
, obj
);
729 HTTP_CHECK_MESSAGE_TYPE_RESPONSE(obj
->message
, RETURN_FALSE
);
731 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &code
)) {
734 if (code
< 100 || code
> 510) {
735 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Invalid response code (100-510): %ld", code
);
739 obj
->message
->http
.info
.response
.code
= code
;
744 /* {{{ proto string HttpMessage::getRequestMethod()
746 * Get the Request Method of the Message.
748 * Returns the request method name on success, or FALSE if the message is
749 * not of type HttpMessage::TYPE_REQUEST.
751 PHP_METHOD(HttpMessage
, getRequestMethod
)
756 getObject(http_message_object
, obj
);
757 HTTP_CHECK_MESSAGE_TYPE_REQUEST(obj
->message
, RETURN_FALSE
);
758 RETURN_STRING(obj
->message
->http
.info
.request
.method
, 1);
763 /* {{{ proto bool HttpMessage::setRequestMethod(string method)
765 * Set the Request Method of the HTTP Message.
767 * Expects a string parameter containing the request method name.
769 * Returns TRUE on success, or FALSE if the message is not of type
770 * HttpMessage::TYPE_REQUEST or an invalid request method was supplied.
772 PHP_METHOD(HttpMessage
, setRequestMethod
)
776 getObject(http_message_object
, obj
);
778 HTTP_CHECK_MESSAGE_TYPE_REQUEST(obj
->message
, RETURN_FALSE
);
780 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &method
, &method_len
)) {
783 if (method_len
< 1) {
784 http_error(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Cannot set HttpMessage::requestMethod to an empty string");
787 if (SUCCESS
!= http_check_method(method
)) {
788 http_error_ex(HE_WARNING
, HTTP_E_REQUEST_METHOD
, "Unkown request method: %s", method
);
792 STR_SET(obj
->message
->http
.info
.request
.method
, estrndup(method
, method_len
));
797 /* {{{ proto string HttpMessage::getRequestUri()
799 * Get the Request URI of the Message.
801 * Returns the request uri as string on success, or FALSE if the message
802 * is not of type HttpMessage::TYPE_REQUEST.
804 PHP_METHOD(HttpMessage
, getRequestUri
)
809 getObject(http_message_object
, obj
);
810 HTTP_CHECK_MESSAGE_TYPE_REQUEST(obj
->message
, RETURN_FALSE
);
811 RETURN_STRING(obj
->message
->http
.info
.request
.URI
, 1);
816 /* {{{ proto bool HttpMessage::setRequestUri(string URI)
818 * Set the Request URI of the HTTP Message.
820 * Expects a string parameters containing the request uri.
822 * Returns TRUE on success, or FALSE if the message is not of type
823 * HttpMessage::TYPE_REQUEST or supplied URI was empty.
825 PHP_METHOD(HttpMessage
, setRequestUri
)
829 getObject(http_message_object
, obj
);
831 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &URI
, &URIlen
)) {
834 HTTP_CHECK_MESSAGE_TYPE_REQUEST(obj
->message
, RETURN_FALSE
);
836 http_error(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Cannot set HttpMessage::requestUri to an empty string");
840 STR_SET(obj
->message
->http
.info
.request
.URI
, estrndup(URI
, URIlen
));
845 /* {{{ proto string HttpMessage::getHttpVersion()
847 * Get the HTTP Protocol Version of the Message.
849 * Returns the HTTP protocol version as string.
851 PHP_METHOD(HttpMessage
, getHttpVersion
)
857 getObject(http_message_object
, obj
);
859 sprintf(ver
, "%1.1lf", obj
->message
->http
.version
);
860 RETURN_STRINGL(ver
, 3, 1);
865 /* {{{ proto bool HttpMessage::setHttpVersion(string version)
867 * Set the HTTP Protocol version of the Message.
869 * Expects a string parameter containing the HTTP protocol version.
871 * Returns TRUE on success, or FALSE if supplied version is out of range (1.0/1.1).
873 PHP_METHOD(HttpMessage
, setHttpVersion
)
877 getObject(http_message_object
, obj
);
879 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z/", &zv
)) {
883 convert_to_double(zv
);
884 sprintf(v
, "%1.1lf", Z_DVAL_P(zv
));
885 if (strcmp(v
, "1.0") && strcmp(v
, "1.1")) {
886 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Invalid HTTP protocol version (1.0 or 1.1): %s", v
);
890 obj
->message
->http
.version
= Z_DVAL_P(zv
);
895 /* {{{ proto HttpMessage HttpMessage::getParentMessage()
897 * Get parent Message.
899 * Returns the parent HttpMessage on success, or NULL if there's none.
901 PHP_METHOD(HttpMessage
, getParentMessage
)
906 getObject(http_message_object
, obj
);
908 if (obj
->message
->parent
) {
909 RETVAL_OBJVAL(obj
->parent
);
917 /* {{{ proto bool HttpMessage::send()
919 * Send the Message according to its type as Response or Request.
920 * This provides limited functionality compared to HttpRequest and HttpResponse.
922 * Returns TRUE on success, or FALSE on failure.
924 PHP_METHOD(HttpMessage
, send
)
926 getObject(http_message_object
, obj
);
930 RETURN_SUCCESS(http_message_send(obj
->message
));
934 /* {{{ proto string HttpMessage::toString([bool include_parent = false])
936 * Get the string representation of the Message.
938 * Accepts a bool parameter which specifies whether the returned string
939 * should also contain any parent messages.
941 * Returns the full message as string.
943 PHP_METHOD(HttpMessage
, toString
)
948 zend_bool include_parent
= 0;
949 getObject(http_message_object
, obj
);
951 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &include_parent
)) {
955 if (include_parent
) {
956 http_message_serialize(obj
->message
, &string
, &length
);
958 http_message_tostring(obj
->message
, &string
, &length
);
960 RETURN_STRINGL(string
, length
, 0);
965 #endif /* ZEND_ENGINE_2 */
972 * vim600: noet sw=4 ts=4 fdm=marker
973 * vim<600: noet sw=4 ts=4