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-2014, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
13 #include "php_http_api.h"
15 ZEND_RESULT_CODE
php_http_header_parse(const char *header
, size_t length
, HashTable
*headers
, php_http_info_callback_t callback_func
, void **callback_data
)
17 php_http_header_parser_t ctx
;
18 php_http_buffer_t buf
;
19 php_http_header_parser_state_t rs
;
21 if (!php_http_buffer_from_string_ex(&buf
, header
, length
)) {
22 php_error_docref(NULL TSRMLS_CC
, E_WARNING
, "Could not allocate buffer");
26 if (!php_http_header_parser_init(&ctx TSRMLS_CC
)) {
27 php_http_buffer_dtor(&buf
);
28 php_error_docref(NULL TSRMLS_CC
, E_WARNING
, "Could not initialize header parser");
32 rs
= php_http_header_parser_parse(&ctx
, &buf
, PHP_HTTP_HEADER_PARSER_CLEANUP
, headers
, callback_func
, callback_data
);
33 php_http_header_parser_dtor(&ctx
);
34 php_http_buffer_dtor(&buf
);
36 if (rs
== PHP_HTTP_HEADER_PARSER_STATE_FAILURE
) {
37 php_error_docref(NULL TSRMLS_CC
, E_WARNING
, "Could not parse headers");
44 void php_http_header_to_callback(HashTable
*headers
, zend_bool crlf
, php_http_pass_format_callback_t cb
, void *cb_arg TSRMLS_DC
)
46 php_http_arrkey_t key
;
47 zval
*header
, *single_header
;
49 ZEND_HASH_FOREACH_KEY_VAL(headers
, key
.h
, key
.key
, header
)
52 if (zend_string_equals_literal(key
.key
, "Set-Cookie") && Z_TYPE_P(header
) == IS_ARRAY
) {
53 ZEND_HASH_FOREACH_VAL(Z_ARRVAL_P(header
), single_header
)
55 if (Z_TYPE_P(single_header
) == IS_ARRAY
) {
56 php_http_cookie_list_t
*cookie
= php_http_cookie_list_from_struct(NULL
, single_header
);
62 php_http_cookie_list_to_string(cookie
, &buf
, &len
);
63 cb(cb_arg
, crlf
? "Set-Cookie: %s" PHP_HTTP_CRLF
: "Set-Cookie: %s", buf
);
64 php_http_cookie_list_free(&cookie
);
68 zend_string
*zs
= php_http_header_value_to_string(single_header
);
70 cb(cb_arg
, crlf
? "Set-Cookie: %s" PHP_HTTP_CRLF
: "Set-Cookie: %s", zs
->val
);
71 zend_string_release(zs
);
74 ZEND_HASH_FOREACH_END();
76 zend_string
*zs
= php_http_header_value_to_string(header
);
78 cb(cb_arg
, crlf
? "%s: %s" PHP_HTTP_CRLF
: "%s: %s", key
.key
->val
, zs
->val
);
79 zend_string_release(zs
);
83 ZEND_HASH_FOREACH_END();
86 void php_http_header_to_string(php_http_buffer_t
*str
, HashTable
*headers TSRMLS_DC
)
88 php_http_header_to_callback(headers
, 1, (php_http_pass_format_callback_t
) php_http_buffer_appendf
, str TSRMLS_CC
);
91 zend_string
*php_http_header_value_array_to_string(zval
*header
)
94 php_http_buffer_t str
;
96 php_http_buffer_init(&str
);
97 ZEND_HASH_FOREACH_VAL(Z_ARRVAL_P(header
), val
)
99 zend_string
*zs
= php_http_header_value_to_string(val
);
101 php_http_buffer_appendf(&str
, str
.used
? ", %s":"%s", zs
->val
);
102 zend_string_release(zs
);
104 ZEND_HASH_FOREACH_END();
105 php_http_buffer_fix(&str
);
107 return php_http_cs2zs(str
.data
, str
.used
);
110 zend_string
*php_http_header_value_to_string(zval
*header
)
112 switch (Z_TYPE_P(header
)) {
114 return zend_string_init(ZEND_STRL("true"), 0);
116 return zend_string_init(ZEND_STRL("false"), 0);
118 return php_http_header_value_array_to_string(header
);
120 return zval_get_string(header
);
124 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader___construct
, 0, 0, 0)
125 ZEND_ARG_INFO(0, name
)
126 ZEND_ARG_INFO(0, value
)
128 PHP_METHOD(HttpHeader
, __construct
)
130 char *name_str
= NULL
, *value_str
= NULL
;
131 size_t name_len
= 0, value_len
= 0;
133 php_http_expect(SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS(), "|s!s!", &name_str
, &name_len
, &value_str
, &value_len
), invalid_arg
, return);
135 if (name_str
&& name_len
) {
136 char *pretty_str
= estrndup(name_str
, name_len
);
137 zend_update_property_stringl(php_http_header_class_entry
, getThis(), ZEND_STRL("name"), php_http_pretty_key(pretty_str
, name_len
, 1, 1), name_len
);
140 if (value_str
&& value_len
) {
141 zend_update_property_stringl(php_http_header_class_entry
, getThis(), ZEND_STRL("value"), value_str
, value_len
);
145 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_serialize
, 0, 0, 0)
147 PHP_METHOD(HttpHeader
, serialize
)
149 if (SUCCESS
== zend_parse_parameters_none()) {
150 php_http_buffer_t buf
;
153 php_http_buffer_init(&buf
);
154 zs
= zval_get_string(zend_read_property(php_http_header_class_entry
, getThis(), ZEND_STRL("name"), 0));
155 php_http_buffer_appendz(&buf
, zs
);
156 zend_string_release(zs
);
158 zs
= zval_get_string(zend_read_property(php_http_header_class_entry
, getThis(), ZEND_STRL("value"), 0));
160 php_http_buffer_appends(&buf
, ": ");
161 php_http_buffer_appendz(&buf
, zs
);
163 php_http_buffer_appends(&buf
, ":");
165 zend_string_release(zs
);
167 RETURN_STR(php_http_cs2zs(buf
.data
, buf
.used
));
169 RETURN_EMPTY_STRING();
172 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_unserialize
, 0, 0, 1)
173 ZEND_ARG_INFO(0, serialized
)
175 PHP_METHOD(HttpHeader
, unserialize
)
177 char *serialized_str
;
178 size_t serialized_len
;
180 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &serialized_str
, &serialized_len
)) {
183 zend_hash_init(&ht
, 1, NULL
, ZVAL_PTR_DTOR
, 0);
184 if (SUCCESS
== php_http_header_parse(serialized_str
, serialized_len
, &ht
, NULL
, NULL
)) {
185 if (zend_hash_num_elements(&ht
)) {
186 zend_string
*zs
, *key
;
189 zend_hash_internal_pointer_reset(&ht
);
190 switch (zend_hash_get_current_key(&ht
, &key
, &idx
)) {
191 case HASH_KEY_IS_STRING
:
192 zend_update_property_str(php_http_header_class_entry
, getThis(), ZEND_STRL("name"), key
);
194 case HASH_KEY_IS_LONG
:
195 zend_update_property_long(php_http_header_class_entry
, getThis(), ZEND_STRL("name"), idx
);
200 zs
= zval_get_string(zend_hash_get_current_data(&ht
));
201 zend_update_property_str(php_http_header_class_entry
, getThis(), ZEND_STRL("value"), zs
);
202 zend_string_release(zs
);
205 zend_hash_destroy(&ht
);
210 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_match
, 0, 0, 1)
211 ZEND_ARG_INFO(0, value
)
212 ZEND_ARG_INFO(0, flags
)
214 PHP_METHOD(HttpHeader
, match
)
218 zend_long flags
= PHP_HTTP_MATCH_LOOSE
;
221 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS(), "|sl", &val_str
, &val_len
, &flags
)) {
225 zs
= zval_get_string(zend_read_property(php_http_header_class_entry
, getThis(), ZEND_STRL("value"), 0));
226 RETVAL_BOOL(php_http_match(zs
->val
, val_str
, flags
));
227 zend_string_release(zs
);
230 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_negotiate
, 0, 0, 1)
231 ZEND_ARG_INFO(0, supported
)
232 ZEND_ARG_INFO(1, result
)
234 PHP_METHOD(HttpHeader
, negotiate
)
236 HashTable
*supported
, *rs
;
237 zval
*rs_array
= NULL
;
239 char *sep_str
= NULL
;
242 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS(), "H|z", &supported
, &rs_array
)) {
246 ZVAL_DEREF(rs_array
);
248 array_init(rs_array
);
251 zs
= zval_get_string(zend_read_property(php_http_header_class_entry
, getThis(), ZEND_STRL("name"), 0));
252 if (zend_string_equals_literal(zs
, "Accept")) {
255 } else if (zend_string_equals_literal(zs
, "Accept-Language")) {
259 zend_string_release(zs
);
261 zs
= zval_get_string(zend_read_property(php_http_header_class_entry
, getThis(), ZEND_STRL("value"), 0));
262 if ((rs
= php_http_negotiate(zs
->val
, zs
->len
, supported
, sep_str
, sep_len
))) {
263 PHP_HTTP_DO_NEGOTIATE_HANDLE_RESULT(rs
, supported
, rs_array
);
265 PHP_HTTP_DO_NEGOTIATE_HANDLE_DEFAULT(supported
, rs_array
);
267 zend_string_release(zs
);
270 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_getParams
, 0, 0, 0)
271 ZEND_ARG_INFO(0, param_sep
)
272 ZEND_ARG_INFO(0, arg_sep
)
273 ZEND_ARG_INFO(0, val_sep
)
274 ZEND_ARG_INFO(0, flags
)
276 PHP_METHOD(HttpHeader
, getParams
)
278 zval zctor
, zparams_obj
, *zargs
= NULL
;
280 ZVAL_STRINGL(&zctor
, "__construct", lenof("__construct"));
282 object_init_ex(&zparams_obj
, php_http_params_class_entry
);
284 zargs
= (zval
*) ecalloc(ZEND_NUM_ARGS()+1, sizeof(zval
));
285 ZVAL_COPY_VALUE(&zargs
[0], zend_read_property(php_http_header_class_entry
, getThis(), ZEND_STRL("value"), 0));
286 if (ZEND_NUM_ARGS()) {
287 zend_get_parameters_array(ZEND_NUM_ARGS(), ZEND_NUM_ARGS(), &zargs
[1]);
290 if (SUCCESS
== call_user_function(NULL
, &zparams_obj
, &zctor
, return_value
, ZEND_NUM_ARGS()+1, zargs
)) {
291 RETVAL_ZVAL(&zparams_obj
, 0, 1);
294 zval_ptr_dtor(&zctor
);
300 ZEND_BEGIN_ARG_INFO_EX(ai_HttpHeader_parse
, 0, 0, 1)
301 ZEND_ARG_INFO(0, string
)
302 ZEND_ARG_INFO(0, header_class
)
304 PHP_METHOD(HttpHeader
, parse
)
308 zend_class_entry
*ce
= NULL
;
310 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS(), "s|C", &header_str
, &header_len
, &ce
)) {
311 array_init(return_value
);
313 if (SUCCESS
!= php_http_header_parse(header_str
, header_len
, Z_ARRVAL_P(return_value
), NULL
, NULL
)) {
314 zval_dtor(return_value
);
317 if (ce
&& instanceof_function(ce
, php_http_header_class_entry TSRMLS_CC
)) {
318 php_http_arrkey_t key
;
321 ZEND_HASH_FOREACH_KEY_VAL(Z_ARRVAL_P(return_value
), key
.h
, key
.key
, val
)
326 ZVAL_STR_COPY(&zkey
, key
.key
);
328 ZVAL_LONG(&zkey
, key
.h
);
331 object_init_ex(&zho
, ce
);
333 zend_call_method_with_2_params(&zho
, ce
, NULL
, "__construct", NULL
, &zkey
, val
);
335 zval_ptr_dtor(&zkey
);
338 add_assoc_zval_ex(return_value
, key
.key
->val
, key
.key
->len
, &zho
);
340 add_index_zval(return_value
, key
.h
, &zho
);
343 ZEND_HASH_FOREACH_END();
349 static zend_function_entry php_http_header_methods
[] = {
350 PHP_ME(HttpHeader
, __construct
, ai_HttpHeader___construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
)
351 PHP_ME(HttpHeader
, serialize
, ai_HttpHeader_serialize
, ZEND_ACC_PUBLIC
)
352 ZEND_MALIAS(HttpHeader
, __toString
, serialize
, ai_HttpHeader_serialize
, ZEND_ACC_PUBLIC
)
353 ZEND_MALIAS(HttpHeader
, toString
, serialize
, ai_HttpHeader_serialize
, ZEND_ACC_PUBLIC
)
354 PHP_ME(HttpHeader
, unserialize
, ai_HttpHeader_unserialize
, ZEND_ACC_PUBLIC
)
355 PHP_ME(HttpHeader
, match
, ai_HttpHeader_match
, ZEND_ACC_PUBLIC
)
356 PHP_ME(HttpHeader
, negotiate
, ai_HttpHeader_negotiate
, ZEND_ACC_PUBLIC
)
357 PHP_ME(HttpHeader
, getParams
, ai_HttpHeader_getParams
, ZEND_ACC_PUBLIC
)
358 PHP_ME(HttpHeader
, parse
, ai_HttpHeader_parse
, ZEND_ACC_PUBLIC
|ZEND_ACC_STATIC
)
362 zend_class_entry
*php_http_header_class_entry
;
364 PHP_MINIT_FUNCTION(http_header
)
366 zend_class_entry ce
= {0};
368 INIT_NS_CLASS_ENTRY(ce
, "http", "Header", php_http_header_methods
);
369 php_http_header_class_entry
= zend_register_internal_class(&ce
);
370 zend_class_implements(php_http_header_class_entry
, 1, zend_ce_serializable
);
371 zend_declare_class_constant_long(php_http_header_class_entry
, ZEND_STRL("MATCH_LOOSE"), PHP_HTTP_MATCH_LOOSE
);
372 zend_declare_class_constant_long(php_http_header_class_entry
, ZEND_STRL("MATCH_CASE"), PHP_HTTP_MATCH_CASE
);
373 zend_declare_class_constant_long(php_http_header_class_entry
, ZEND_STRL("MATCH_WORD"), PHP_HTTP_MATCH_WORD
);
374 zend_declare_class_constant_long(php_http_header_class_entry
, ZEND_STRL("MATCH_FULL"), PHP_HTTP_MATCH_FULL
);
375 zend_declare_class_constant_long(php_http_header_class_entry
, ZEND_STRL("MATCH_STRICT"), PHP_HTTP_MATCH_STRICT
);
376 zend_declare_property_null(php_http_header_class_entry
, ZEND_STRL("name"), ZEND_ACC_PUBLIC
);
377 zend_declare_property_null(php_http_header_class_entry
, ZEND_STRL("value"), ZEND_ACC_PUBLIC
);
387 * vim600: noet sw=4 ts=4 fdm=marker
388 * vim<600: noet sw=4 ts=4