2 +--------------------------------------------------------------------+
4 +--------------------------------------------------------------------+
5 | Redistribution and use in source and binary forms, with or without |
6 | modification, are permitted provided that the conditions mentioned |
7 | in the accompanying LICENSE file are met. |
8 +--------------------------------------------------------------------+
9 | Copyright (c) 2004-2005, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
24 #include "php_http_api.h"
25 #include "php_http_message_api.h"
26 #include "php_http_message_object.h"
27 #include "php_http_exception_object.h"
30 # include "zend_interfaces.h"
31 # if defined(HAVE_SPL)
32 /* SPL doesn't install its headers */
33 extern PHPAPI zend_class_entry
*spl_ce_Countable
;
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 HTTP_EMPTY_ARGS(count
, 0);
97 HTTP_EMPTY_ARGS(serialize
, 0);
98 HTTP_BEGIN_ARGS(unserialize
, 0, 1)
99 HTTP_ARG_VAL(serialized
, 0)
102 #define http_message_object_declare_default_properties() _http_message_object_declare_default_properties(TSRMLS_C)
103 static inline void _http_message_object_declare_default_properties(TSRMLS_D
);
104 #define http_message_object_read_prop _http_message_object_read_prop
105 static zval
*_http_message_object_read_prop(zval
*object
, zval
*member
, int type TSRMLS_DC
);
106 #define http_message_object_write_prop _http_message_object_write_prop
107 static void _http_message_object_write_prop(zval
*object
, zval
*member
, zval
*value TSRMLS_DC
);
108 #define http_message_object_get_props _http_message_object_get_props
109 static HashTable
*_http_message_object_get_props(zval
*object TSRMLS_DC
);
111 zend_class_entry
*http_message_object_ce
;
112 zend_function_entry http_message_object_fe
[] = {
113 HTTP_MESSAGE_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
114 HTTP_MESSAGE_ME(getBody
, ZEND_ACC_PUBLIC
)
115 HTTP_MESSAGE_ME(setBody
, ZEND_ACC_PUBLIC
)
116 HTTP_MESSAGE_ME(getHeaders
, ZEND_ACC_PUBLIC
)
117 HTTP_MESSAGE_ME(setHeaders
, ZEND_ACC_PUBLIC
)
118 HTTP_MESSAGE_ME(addHeaders
, ZEND_ACC_PUBLIC
)
119 HTTP_MESSAGE_ME(getType
, ZEND_ACC_PUBLIC
)
120 HTTP_MESSAGE_ME(setType
, ZEND_ACC_PUBLIC
)
121 HTTP_MESSAGE_ME(getResponseCode
, ZEND_ACC_PUBLIC
)
122 HTTP_MESSAGE_ME(setResponseCode
, ZEND_ACC_PUBLIC
)
123 HTTP_MESSAGE_ME(getRequestMethod
, ZEND_ACC_PUBLIC
)
124 HTTP_MESSAGE_ME(setRequestMethod
, ZEND_ACC_PUBLIC
)
125 HTTP_MESSAGE_ME(getRequestUri
, ZEND_ACC_PUBLIC
)
126 HTTP_MESSAGE_ME(setRequestUri
, ZEND_ACC_PUBLIC
)
127 HTTP_MESSAGE_ME(getHttpVersion
, ZEND_ACC_PUBLIC
)
128 HTTP_MESSAGE_ME(setHttpVersion
, ZEND_ACC_PUBLIC
)
129 HTTP_MESSAGE_ME(getParentMessage
, ZEND_ACC_PUBLIC
)
130 HTTP_MESSAGE_ME(send
, ZEND_ACC_PUBLIC
)
131 HTTP_MESSAGE_ME(toString
, ZEND_ACC_PUBLIC
)
133 /* implements Countable */
134 HTTP_MESSAGE_ME(count
, ZEND_ACC_PUBLIC
)
136 /* implements Serializable */
137 HTTP_MESSAGE_ME(serialize
, ZEND_ACC_PUBLIC
)
138 HTTP_MESSAGE_ME(unserialize
, ZEND_ACC_PUBLIC
)
140 ZEND_MALIAS(HttpMessage
, __toString
, toString
, HTTP_ARGS(HttpMessage
, toString
), ZEND_ACC_PUBLIC
)
142 HTTP_MESSAGE_ME(fromString
, ZEND_ACC_PUBLIC
|ZEND_ACC_STATIC
)
146 static zend_object_handlers http_message_object_handlers
;
148 PHP_MINIT_FUNCTION(http_message_object
)
150 HTTP_REGISTER_CLASS_EX(HttpMessage
, http_message_object
, NULL
, 0);
153 zend_class_implements(http_message_object_ce TSRMLS_CC
, 2, spl_ce_Countable
, zend_ce_serializable
);
155 zend_class_implements(http_message_object_ce TSRMLS_CC
, 1, zend_ce_serializable
);
159 HTTP_LONG_CONSTANT("HTTP_MSG_NONE", HTTP_MSG_NONE
);
160 HTTP_LONG_CONSTANT("HTTP_MSG_REQUEST", HTTP_MSG_REQUEST
);
161 HTTP_LONG_CONSTANT("HTTP_MSG_RESPONSE", HTTP_MSG_RESPONSE
);
163 http_message_object_handlers
.clone_obj
= _http_message_object_clone_obj
;
164 http_message_object_handlers
.read_property
= http_message_object_read_prop
;
165 http_message_object_handlers
.write_property
= http_message_object_write_prop
;
166 http_message_object_handlers
.get_properties
= http_message_object_get_props
;
167 http_message_object_handlers
.get_property_ptr_ptr
= NULL
;
172 zend_object_value
_http_message_object_new(zend_class_entry
*ce TSRMLS_DC
)
174 return http_message_object_new_ex(ce
, NULL
, NULL
);
177 zend_object_value
_http_message_object_new_ex(zend_class_entry
*ce
, http_message
*msg
, http_message_object
**ptr TSRMLS_DC
)
179 zend_object_value ov
;
180 http_message_object
*o
;
182 o
= ecalloc(1, sizeof(http_message_object
));
192 o
->parent
= http_message_object_new_ex(ce
, msg
->parent
, NULL
);
196 ALLOC_HASHTABLE(OBJ_PROP(o
));
197 zend_hash_init(OBJ_PROP(o
), 0, NULL
, ZVAL_PTR_DTOR
, 0);
199 ov
.handle
= putObject(http_message_object
, o
);
200 ov
.handlers
= &http_message_object_handlers
;
205 zend_object_value
_http_message_object_clone_obj(zval
*this_ptr TSRMLS_DC
)
207 getObject(http_message_object
, obj
);
208 return http_message_object_new_ex(Z_OBJCE_P(this_ptr
), http_message_dup(obj
->message
), NULL
);
211 static inline void _http_message_object_declare_default_properties(TSRMLS_D
)
213 zend_class_entry
*ce
= http_message_object_ce
;
216 DCL_CONST(long, "TYPE_NONE", HTTP_MSG_NONE
);
217 DCL_CONST(long, "TYPE_REQUEST", HTTP_MSG_REQUEST
);
218 DCL_CONST(long, "TYPE_RESPONSE", HTTP_MSG_RESPONSE
);
221 DCL_PROP(PROTECTED
, long, type
, HTTP_MSG_NONE
);
222 DCL_PROP(PROTECTED
, string
, body
, "");
223 DCL_PROP(PROTECTED
, string
, requestMethod
, "");
224 DCL_PROP(PROTECTED
, string
, requestUri
, "");
225 DCL_PROP(PROTECTED
, long, responseCode
, 0);
226 DCL_PROP_N(PROTECTED
, httpVersion
);
227 DCL_PROP_N(PROTECTED
, headers
);
228 DCL_PROP_N(PROTECTED
, parentMessage
);
231 void _http_message_object_free(zend_object
*object TSRMLS_DC
)
233 http_message_object
*o
= (http_message_object
*) object
;
236 zend_hash_destroy(OBJ_PROP(o
));
237 FREE_HASHTABLE(OBJ_PROP(o
));
240 http_message_dtor(o
->message
);
246 static zval
*_http_message_object_read_prop(zval
*object
, zval
*member
, int type TSRMLS_DC
)
248 getObjectEx(http_message_object
, obj
, object
);
249 http_message
*msg
= obj
->message
;
252 ulong h
= zend_get_hash_value(Z_STRVAL_P(member
), Z_STRLEN_P(member
)+1);
254 zend_property_info
*pinfo
= zend_get_property_info(obj
->zo
.ce
, member
, 1 TSRMLS_CC
);
256 if (!pinfo
|| ACC_PROP_PUBLIC(pinfo
->flags
)) {
257 return zend_get_std_object_handlers()->read_property(object
, member
, type TSRMLS_CC
);
261 if (type
== BP_VAR_W
) {
262 zend_error(E_ERROR
, "Cannot access HttpMessage properties by reference or array key/index");
266 ALLOC_ZVAL(return_value
);
267 return_value
->refcount
= 0;
268 return_value
->is_ref
= 0;
276 case HTTP_MSG_PROPHASH_TYPE
:
277 case HTTP_MSG_CHILD_PROPHASH_TYPE
:
278 RETVAL_LONG(msg
->type
);
281 case HTTP_MSG_PROPHASH_HTTP_VERSION
:
282 case HTTP_MSG_CHILD_PROPHASH_HTTP_VERSION
:
283 RETVAL_DOUBLE(msg
->http
.version
);
286 case HTTP_MSG_PROPHASH_BODY
:
287 case HTTP_MSG_CHILD_PROPHASH_BODY
:
288 phpstr_fix(PHPSTR(msg
));
289 RETVAL_PHPSTR(PHPSTR(msg
), 0, 1);
292 case HTTP_MSG_PROPHASH_HEADERS
:
293 case HTTP_MSG_CHILD_PROPHASH_HEADERS
:
294 array_init(return_value
);
295 zend_hash_copy(Z_ARRVAL_P(return_value
), &msg
->hdrs
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
298 case HTTP_MSG_PROPHASH_PARENT_MESSAGE
:
299 case HTTP_MSG_CHILD_PROPHASH_PARENT_MESSAGE
:
301 RETVAL_OBJVAL(obj
->parent
);
307 case HTTP_MSG_PROPHASH_REQUEST_METHOD
:
308 case HTTP_MSG_CHILD_PROPHASH_REQUEST_METHOD
:
309 if (HTTP_MSG_TYPE(REQUEST
, msg
) && msg
->http
.info
.request
.method
) {
310 RETVAL_STRING(msg
->http
.info
.request
.method
, 1);
316 case HTTP_MSG_PROPHASH_REQUEST_URI
:
317 case HTTP_MSG_CHILD_PROPHASH_REQUEST_URI
:
318 if (HTTP_MSG_TYPE(REQUEST
, msg
) && msg
->http
.info
.request
.URI
) {
319 RETVAL_STRING(msg
->http
.info
.request
.URI
, 1);
325 case HTTP_MSG_PROPHASH_RESPONSE_CODE
:
326 case HTTP_MSG_CHILD_PROPHASH_RESPONSE_CODE
:
327 if (HTTP_MSG_TYPE(RESPONSE
, msg
)) {
328 RETVAL_LONG(msg
->http
.info
.response
.code
);
334 case HTTP_MSG_PROPHASH_RESPONSE_STATUS
:
335 case HTTP_MSG_CHILD_PROPHASH_RESPONSE_STATUS
:
336 if (HTTP_MSG_TYPE(RESPONSE
, msg
) && msg
->http
.info
.response
.status
) {
337 RETVAL_STRING(msg
->http
.info
.response
.status
, 1);
345 return zend_get_std_object_handlers()->read_property(object
, member
, type TSRMLS_CC
);
355 static void _http_message_object_write_prop(zval
*object
, zval
*member
, zval
*value TSRMLS_DC
)
357 getObjectEx(http_message_object
, obj
, object
);
358 http_message
*msg
= obj
->message
;
361 ulong h
= zend_get_hash_value(Z_STRVAL_P(member
), Z_STRLEN_P(member
) + 1);
363 zend_property_info
*pinfo
= zend_get_property_info(obj
->zo
.ce
, member
, 1 TSRMLS_CC
);
365 if (!pinfo
|| ACC_PROP_PUBLIC(pinfo
->flags
)) {
366 zend_get_std_object_handlers()->write_property(object
, member
, value TSRMLS_CC
);
371 cpy
= zval_copy(Z_TYPE_P(value
), value
);
379 case HTTP_MSG_PROPHASH_TYPE
:
380 case HTTP_MSG_CHILD_PROPHASH_TYPE
:
381 convert_to_long(cpy
);
382 http_message_set_type(msg
, Z_LVAL_P(cpy
));
385 case HTTP_MSG_PROPHASH_HTTP_VERSION
:
386 case HTTP_MSG_CHILD_PROPHASH_HTTP_VERSION
:
387 convert_to_double(cpy
);
388 msg
->http
.version
= Z_DVAL_P(cpy
);
391 case HTTP_MSG_PROPHASH_BODY
:
392 case HTTP_MSG_CHILD_PROPHASH_BODY
:
393 convert_to_string(cpy
);
394 phpstr_dtor(PHPSTR(msg
));
395 phpstr_from_string_ex(PHPSTR(msg
), Z_STRVAL_P(cpy
), Z_STRLEN_P(cpy
));
398 case HTTP_MSG_PROPHASH_HEADERS
:
399 case HTTP_MSG_CHILD_PROPHASH_HEADERS
:
400 convert_to_array(cpy
);
401 zend_hash_clean(&msg
->hdrs
);
402 zend_hash_copy(&msg
->hdrs
, Z_ARRVAL_P(cpy
), (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
405 case HTTP_MSG_PROPHASH_PARENT_MESSAGE
:
406 case HTTP_MSG_CHILD_PROPHASH_PARENT_MESSAGE
:
407 if (Z_TYPE_P(value
) == IS_OBJECT
&& instanceof_function(Z_OBJCE_P(value
), http_message_object_ce TSRMLS_CC
)) {
410 tmp
.value
.obj
= obj
->parent
;
413 Z_OBJ_ADDREF_P(value
);
414 obj
->parent
= value
->value
.obj
;
418 case HTTP_MSG_PROPHASH_REQUEST_METHOD
:
419 case HTTP_MSG_CHILD_PROPHASH_REQUEST_METHOD
:
420 if (HTTP_MSG_TYPE(REQUEST
, msg
)) {
421 convert_to_string(cpy
);
422 STR_SET(msg
->http
.info
.request
.method
, estrndup(Z_STRVAL_P(cpy
), Z_STRLEN_P(cpy
)));
426 case HTTP_MSG_PROPHASH_REQUEST_URI
:
427 case HTTP_MSG_CHILD_PROPHASH_REQUEST_URI
:
428 if (HTTP_MSG_TYPE(REQUEST
, msg
)) {
429 convert_to_string(cpy
);
430 STR_SET(msg
->http
.info
.request
.URI
, estrndup(Z_STRVAL_P(cpy
), Z_STRLEN_P(cpy
)));
434 case HTTP_MSG_PROPHASH_RESPONSE_CODE
:
435 case HTTP_MSG_CHILD_PROPHASH_RESPONSE_CODE
:
436 if (HTTP_MSG_TYPE(RESPONSE
, msg
)) {
437 convert_to_long(cpy
);
438 msg
->http
.info
.response
.code
= Z_LVAL_P(cpy
);
442 case HTTP_MSG_PROPHASH_RESPONSE_STATUS
:
443 case HTTP_MSG_CHILD_PROPHASH_RESPONSE_STATUS
:
444 if (HTTP_MSG_TYPE(RESPONSE
, msg
)) {
445 convert_to_string(cpy
);
446 STR_SET(msg
->http
.info
.response
.status
, estrndup(Z_STRVAL_P(cpy
), Z_STRLEN_P(cpy
)));
452 zend_get_std_object_handlers()->write_property(object
, member
, value TSRMLS_CC
);
459 static HashTable
*_http_message_object_get_props(zval
*object TSRMLS_DC
)
462 getObjectEx(http_message_object
, obj
, object
);
463 http_message
*msg
= obj
->message
;
464 HashTable
*props
= OBJ_PROP(obj
);
467 INIT_ZARR(array
, props
);
469 #define ASSOC_PROP(array, ptype, name, val) \
473 zend_mangle_property_name(&m_prop_name, &m_prop_len, "*", 1, name, lenof(name), 0); \
474 add_assoc_ ##ptype## _ex(&array, m_prop_name, sizeof(name)+3, val); \
475 efree(m_prop_name); \
477 #define ASSOC_STRING(array, name, val) ASSOC_STRINGL(array, name, val, strlen(val))
478 #define ASSOC_STRINGL(array, name, val, len) \
482 zend_mangle_property_name(&m_prop_name, &m_prop_len, "*", 1, name, lenof(name), 0); \
483 add_assoc_stringl_ex(&array, m_prop_name, sizeof(name)+3, val, len, 1); \
484 efree(m_prop_name); \
487 ASSOC_PROP(array
, long, "type", msg
->type
);
488 ASSOC_PROP(array
, double, "httpVersion", msg
->http
.version
);
492 case HTTP_MSG_REQUEST
:
493 ASSOC_PROP(array
, long, "responseCode", 0);
494 ASSOC_STRINGL(array
, "responseStatus", "", 0);
495 ASSOC_STRING(array
, "requestMethod", msg
->http
.info
.request
.method
);
496 ASSOC_STRING(array
, "requestUri", msg
->http
.info
.request
.URI
);
499 case HTTP_MSG_RESPONSE
:
500 ASSOC_PROP(array
, long, "responseCode", msg
->http
.info
.response
.code
);
501 ASSOC_STRING(array
, "responseStatus", msg
->http
.info
.response
.status
);
502 ASSOC_STRINGL(array
, "requestMethod", "", 0);
503 ASSOC_STRINGL(array
, "requestUri", "", 0);
508 ASSOC_PROP(array
, long, "responseCode", 0);
509 ASSOC_STRINGL(array
, "responseStatus", "", 0);
510 ASSOC_STRINGL(array
, "requestMethod", "", 0);
511 ASSOC_STRINGL(array
, "requestUri", "", 0);
515 MAKE_STD_ZVAL(headers
);
517 zend_hash_copy(Z_ARRVAL_P(headers
), &msg
->hdrs
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
518 ASSOC_PROP(array
, zval
, "headers", headers
);
519 ASSOC_STRINGL(array
, "body", PHPSTR_VAL(msg
), PHPSTR_LEN(msg
));
521 return OBJ_PROP(obj
);
524 /* ### USERLAND ### */
526 /* {{{ proto void HttpMessage::__construct([string message])
528 * Instantiate a new HttpMessage object.
530 * Accepts an optional string parameter containing a single or several
531 * consecutive HTTP messages. The constructed object will actually
532 * represent the *last* message of the passed string. If there were
533 * prior messages, those can be accessed by HttpMessage::getParentMessage().
535 * Throws HttpMalformedHeaderException.
537 PHP_METHOD(HttpMessage
, __construct
)
540 char *message
= NULL
;
542 getObject(http_message_object
, obj
);
545 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|s", &message
, &length
) && message
&& length
) {
546 http_message
*msg
= obj
->message
;
548 http_message_dtor(msg
);
549 if ((obj
->message
= http_message_parse_ex(msg
, message
, length
))) {
550 if (obj
->message
->parent
) {
551 obj
->parent
= http_message_object_new_ex(Z_OBJCE_P(getThis()), obj
->message
->parent
, NULL
);
554 obj
->message
= http_message_init(msg
);
558 obj
->message
= http_message_new();
564 /* {{{ proto static HttpMessage HttpMessage::fromString(string raw_message)
566 * Create an HttpMessage object from a string. Kind of a static constructor.
568 * Expects a string parameter containing a sinlge or several consecutive
571 * Returns an HttpMessage object on success or NULL on failure.
573 * Throws HttpMalformedHeadersException.
575 PHP_METHOD(HttpMessage
, fromString
)
579 http_message
*msg
= NULL
;
584 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &string
, &length
)) {
585 if ((msg
= http_message_parse(string
, length
))) {
586 ZVAL_OBJVAL(return_value
, http_message_object_new_ex(http_message_object_ce
, msg
, NULL
));
593 /* {{{ proto string HttpMessage::getBody()
595 * Get the body of the parsed HttpMessage.
597 * Returns the message body as string.
599 PHP_METHOD(HttpMessage
, getBody
)
604 getObject(http_message_object
, obj
);
605 RETURN_PHPSTR(&obj
->message
->body
, PHPSTR_FREE_NOT
, 1);
610 /* {{{ proto void HttpMessage::setBody(string body)
612 * Set the body of the HttpMessage.
613 * NOTE: Don't forget to update any headers accordingly.
615 * Expects a string parameter containing the new body of the message.
617 PHP_METHOD(HttpMessage
, setBody
)
621 getObject(http_message_object
, obj
);
623 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &body
, &len
)) {
624 phpstr_dtor(PHPSTR(obj
->message
));
625 phpstr_from_string_ex(PHPSTR(obj
->message
), body
, len
);
630 /* {{{ proto array HttpMessage::getHeaders()
632 * Get Message Headers.
634 * Returns an associative array containing the messages HTTP headers.
636 PHP_METHOD(HttpMessage
, getHeaders
)
642 getObject(http_message_object
, obj
);
644 INIT_ZARR(headers
, &obj
->message
->hdrs
);
645 array_init(return_value
);
646 array_copy(&headers
, return_value
);
651 /* {{{ proto void HttpMessage::setHeaders(array headers)
655 * Expects an associative array as parameter containing the new HTTP headers,
656 * which will replace *all* previous HTTP headers of the message.
658 PHP_METHOD(HttpMessage
, setHeaders
)
660 zval
*new_headers
, old_headers
;
661 getObject(http_message_object
, obj
);
663 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a/", &new_headers
)) {
667 zend_hash_clean(&obj
->message
->hdrs
);
668 INIT_ZARR(old_headers
, &obj
->message
->hdrs
);
669 array_copy(new_headers
, &old_headers
);
673 /* {{{ proto void HttpMessage::addHeaders(array headers[, bool append = false])
675 * Add headers. If append is true, headers with the same name will be separated, else overwritten.
677 * Expects an associative array as parameter containing the additional HTTP headers
678 * to add to the messages existing headers. If the optional bool parameter is true,
679 * and a header with the same name of one to add exists already, this respective
680 * header will be converted to an array containing both header values, otherwise
681 * it will be overwritten with the new header value.
683 PHP_METHOD(HttpMessage
, addHeaders
)
685 zval old_headers
, *new_headers
;
686 zend_bool append
= 0;
687 getObject(http_message_object
, obj
);
689 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "a|b", &new_headers
, &append
)) {
693 INIT_ZARR(old_headers
, &obj
->message
->hdrs
);
695 array_append(new_headers
, &old_headers
);
697 array_merge(new_headers
, &old_headers
);
702 /* {{{ proto int HttpMessage::getType()
704 * Get Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE)
706 * Returns the HttpMessage::TYPE.
708 PHP_METHOD(HttpMessage
, getType
)
713 getObject(http_message_object
, obj
);
714 RETURN_LONG(obj
->message
->type
);
719 /* {{{ proto void HttpMessage::setType(int type)
721 * Set Message Type. (HTTP_MSG_NONE|HTTP_MSG_REQUEST|HTTP_MSG_RESPONSE)
723 * Exptects an int parameter, the HttpMessage::TYPE.
725 PHP_METHOD(HttpMessage
, setType
)
728 getObject(http_message_object
, obj
);
730 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &type
)) {
733 http_message_set_type(obj
->message
, type
);
737 /* {{{ proto int HttpMessage::getResponseCode()
739 * Get the Response Code of the Message.
741 * Returns the HTTP response code if the message is of type
742 * HttpMessage::TYPE_RESPONSE, else FALSE.
744 PHP_METHOD(HttpMessage
, getResponseCode
)
749 getObject(http_message_object
, obj
);
750 HTTP_CHECK_MESSAGE_TYPE_RESPONSE(obj
->message
, RETURN_FALSE
);
751 RETURN_LONG(obj
->message
->http
.info
.response
.code
);
756 /* {{{ proto bool HttpMessage::setResponseCode(int code)
758 * Set the response code of an HTTP Response Message.
760 * Expects an int parameter with the HTTP response code.
762 * Returns TRUE on success, or FALSE if the message is not of type
763 * HttpMessage::TYPE_RESPONSE or the response code is out of range (100-510).
765 PHP_METHOD(HttpMessage
, setResponseCode
)
768 getObject(http_message_object
, obj
);
770 HTTP_CHECK_MESSAGE_TYPE_RESPONSE(obj
->message
, RETURN_FALSE
);
772 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "l", &code
)) {
775 if (code
< 100 || code
> 510) {
776 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Invalid response code (100-510): %ld", code
);
780 obj
->message
->http
.info
.response
.code
= code
;
785 /* {{{ proto string HttpMessage::getRequestMethod()
787 * Get the Request Method of the Message.
789 * Returns the request method name on success, or FALSE if the message is
790 * not of type HttpMessage::TYPE_REQUEST.
792 PHP_METHOD(HttpMessage
, getRequestMethod
)
797 getObject(http_message_object
, obj
);
798 HTTP_CHECK_MESSAGE_TYPE_REQUEST(obj
->message
, RETURN_FALSE
);
799 RETURN_STRING(obj
->message
->http
.info
.request
.method
, 1);
804 /* {{{ proto bool HttpMessage::setRequestMethod(string method)
806 * Set the Request Method of the HTTP Message.
808 * Expects a string parameter containing the request method name.
810 * Returns TRUE on success, or FALSE if the message is not of type
811 * HttpMessage::TYPE_REQUEST or an invalid request method was supplied.
813 PHP_METHOD(HttpMessage
, setRequestMethod
)
817 getObject(http_message_object
, obj
);
819 HTTP_CHECK_MESSAGE_TYPE_REQUEST(obj
->message
, RETURN_FALSE
);
821 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &method
, &method_len
)) {
824 if (method_len
< 1) {
825 http_error(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Cannot set HttpMessage::requestMethod to an empty string");
828 if (SUCCESS
!= http_check_method(method
)) {
829 http_error_ex(HE_WARNING
, HTTP_E_REQUEST_METHOD
, "Unkown request method: %s", method
);
833 STR_SET(obj
->message
->http
.info
.request
.method
, estrndup(method
, method_len
));
838 /* {{{ proto string HttpMessage::getRequestUri()
840 * Get the Request URI of the Message.
842 * Returns the request uri as string on success, or FALSE if the message
843 * is not of type HttpMessage::TYPE_REQUEST.
845 PHP_METHOD(HttpMessage
, getRequestUri
)
850 getObject(http_message_object
, obj
);
851 HTTP_CHECK_MESSAGE_TYPE_REQUEST(obj
->message
, RETURN_FALSE
);
852 RETURN_STRING(obj
->message
->http
.info
.request
.URI
, 1);
857 /* {{{ proto bool HttpMessage::setRequestUri(string URI)
859 * Set the Request URI of the HTTP Message.
861 * Expects a string parameters containing the request uri.
863 * Returns TRUE on success, or FALSE if the message is not of type
864 * HttpMessage::TYPE_REQUEST or supplied URI was empty.
866 PHP_METHOD(HttpMessage
, setRequestUri
)
870 getObject(http_message_object
, obj
);
872 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &URI
, &URIlen
)) {
875 HTTP_CHECK_MESSAGE_TYPE_REQUEST(obj
->message
, RETURN_FALSE
);
877 http_error(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Cannot set HttpMessage::requestUri to an empty string");
881 STR_SET(obj
->message
->http
.info
.request
.URI
, estrndup(URI
, URIlen
));
886 /* {{{ proto string HttpMessage::getHttpVersion()
888 * Get the HTTP Protocol Version of the Message.
890 * Returns the HTTP protocol version as string.
892 PHP_METHOD(HttpMessage
, getHttpVersion
)
898 getObject(http_message_object
, obj
);
900 sprintf(ver
, "%1.1lf", obj
->message
->http
.version
);
901 RETURN_STRINGL(ver
, 3, 1);
906 /* {{{ proto bool HttpMessage::setHttpVersion(string version)
908 * Set the HTTP Protocol version of the Message.
910 * Expects a string parameter containing the HTTP protocol version.
912 * Returns TRUE on success, or FALSE if supplied version is out of range (1.0/1.1).
914 PHP_METHOD(HttpMessage
, setHttpVersion
)
918 getObject(http_message_object
, obj
);
920 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z/", &zv
)) {
924 convert_to_double(zv
);
925 sprintf(v
, "%1.1lf", Z_DVAL_P(zv
));
926 if (strcmp(v
, "1.0") && strcmp(v
, "1.1")) {
927 http_error_ex(HE_WARNING
, HTTP_E_INVALID_PARAM
, "Invalid HTTP protocol version (1.0 or 1.1): %s", v
);
931 obj
->message
->http
.version
= Z_DVAL_P(zv
);
936 /* {{{ proto HttpMessage HttpMessage::getParentMessage()
938 * Get parent Message.
940 * Returns the parent HttpMessage on success, or NULL if there's none.
942 PHP_METHOD(HttpMessage
, getParentMessage
)
947 getObject(http_message_object
, obj
);
949 if (obj
->message
->parent
) {
950 RETVAL_OBJVAL(obj
->parent
);
958 /* {{{ proto bool HttpMessage::send()
960 * Send the Message according to its type as Response or Request.
961 * This provides limited functionality compared to HttpRequest and HttpResponse.
963 * Returns TRUE on success, or FALSE on failure.
965 PHP_METHOD(HttpMessage
, send
)
967 getObject(http_message_object
, obj
);
971 RETURN_SUCCESS(http_message_send(obj
->message
));
975 /* {{{ proto string HttpMessage::toString([bool include_parent = false])
977 * Get the string representation of the Message.
979 * Accepts a bool parameter which specifies whether the returned string
980 * should also contain any parent messages.
982 * Returns the full message as string.
984 PHP_METHOD(HttpMessage
, toString
)
989 zend_bool include_parent
= 0;
990 getObject(http_message_object
, obj
);
992 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &include_parent
)) {
996 if (include_parent
) {
997 http_message_serialize(obj
->message
, &string
, &length
);
999 http_message_tostring(obj
->message
, &string
, &length
);
1001 RETURN_STRINGL(string
, length
, 0);
1006 /* {{{ proto int HttpMessage::count()
1008 * Implements Countable.
1010 * Returns the number of parent messages + 1.
1012 PHP_METHOD(HttpMessage
, count
)
1017 getObject(http_message_object
, obj
);
1019 for (i
= 0, msg
= obj
->message
; msg
; msg
= msg
->parent
, ++i
);
1025 /* {{{ proto string HttpMessage::serialize()
1027 * Implements Serializable.
1029 * Returns the serialized representation of the HttpMessage.
1031 PHP_METHOD(HttpMessage
, serialize
)
1036 getObject(http_message_object
, obj
);
1038 http_message_serialize(obj
->message
, &string
, &length
);
1039 RETURN_STRINGL(string
, length
, 0);
1044 /* {{{ proto void HttpMessage::unserialize(string serialized)
1046 * Implements Serializable.
1048 * Re-constructs the HttpMessage based upon the serialized string.
1050 PHP_METHOD(HttpMessage
, unserialize
)
1054 getObject(http_message_object
, obj
);
1056 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &serialized
, &length
)) {
1057 http_message_dtor(obj
->message
);
1058 if (!http_message_parse_ex(obj
->message
, serialized
, (size_t) length
)) {
1059 http_error(HE_ERROR
, HTTP_E_RUNTIME
, "Could not unserialize HttpMessage");
1060 http_message_init(obj
->message
);
1066 #endif /* ZEND_ENGINE_2 */
1073 * vim600: noet sw=4 ts=4 fdm=marker
1074 * vim<600: noet sw=4 ts=4