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-2011, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
13 #include "php_http_api.h"
15 static php_http_params_token_t def_param_sep
= {",", 1}, *def_param_sep_ptr
[] = {&def_param_sep
, NULL
};
16 static php_http_params_token_t def_arg_sep
= {";", 1}, *def_arg_sep_ptr
[] = {&def_arg_sep
, NULL
};
17 static php_http_params_token_t def_val_sep
= {"=", 1}, *def_val_sep_ptr
[] = {&def_val_sep
, NULL
};
18 static php_http_params_opts_t def_opts
= {
19 .param
= def_param_sep_ptr
,
20 .arg
= def_arg_sep_ptr
,
21 .val
= def_val_sep_ptr
24 PHP_HTTP_API php_http_params_opts_t
*php_http_params_opts_default_get(php_http_params_opts_t
*opts
)
27 opts
= emalloc(sizeof(*opts
));
30 memcpy(opts
, &def_opts
, sizeof(def_opts
));
35 typedef struct php_http_params_state
{
36 php_http_params_token_t input
;
37 php_http_params_token_t param
;
38 php_http_params_token_t arg
;
39 php_http_params_token_t val
;
45 } php_http_params_state_t
;
47 static inline void sanitize_string(char *str
, size_t len
, zval
*zv TSRMLS_DC
)
50 php_trim(str
, len
, NULL
, 0, zv
, 3 TSRMLS_CC
);
53 if (Z_STRVAL_P(zv
)[0] == '"' && Z_STRVAL_P(zv
)[Z_STRLEN_P(zv
) - 1] == '"') {
54 size_t deq_len
= Z_STRLEN_P(zv
) - 2;
55 char *deq
= estrndup(Z_STRVAL_P(zv
) + 1, deq_len
);
58 ZVAL_STRINGL(zv
, deq
, deq_len
, 0);
62 php_stripslashes(Z_STRVAL_P(zv
), &Z_STRLEN_P(zv
) TSRMLS_CC
);
65 static void push_param(HashTable
*params
, php_http_params_state_t
*state
, const php_http_params_opts_t
*opts TSRMLS_DC
)
68 if (0 < (state
->val
.len
= state
->input
.str
- state
->val
.str
)) {
69 sanitize_string(state
->val
.str
, state
->val
.len
, *(state
->current
.val
) TSRMLS_CC
);
71 } else if (state
->arg
.str
) {
72 if (0 < (state
->arg
.len
= state
->input
.str
- state
->arg
.str
)) {
76 sanitize_string(state
->arg
.str
, state
->arg
.len
, &key TSRMLS_CC
);
80 zend_symtable_update(Z_ARRVAL_PP(state
->current
.args
), Z_STRVAL(key
), Z_STRLEN(key
) + 1, (void *) &val
, sizeof(zval
*), (void *) &state
->current
.val
);
84 } else if (state
->param
.str
) {
85 if (0 < (state
->param
.len
= state
->input
.str
- state
->param
.str
)) {
86 zval
*prm
, *arg
, *val
, key
;
89 sanitize_string(state
->param
.str
, state
->param
.len
, &key TSRMLS_CC
);
95 zend_hash_update(Z_ARRVAL_P(prm
), "value", sizeof("value"), (void *) &val
, sizeof(zval
*), (void *) &state
->current
.val
);
99 zend_hash_update(Z_ARRVAL_P(prm
), "arguments", sizeof("arguments"), (void *) &arg
, sizeof(zval
*), (void *) &state
->current
.args
);
101 zend_symtable_update(params
, Z_STRVAL(key
), Z_STRLEN(key
) + 1, (void *) &prm
, sizeof(zval
*), (void *) &state
->current
.param
);
108 static inline zend_bool
check_str(const char *chk_str
, size_t chk_len
, const char *sep_str
, size_t sep_len
) {
109 return 0 < sep_len
&& chk_len
>= sep_len
&& !memcmp(chk_str
, sep_str
, sep_len
);
112 static size_t check_sep(php_http_params_state_t
*state
, php_http_params_token_t
**separators
)
114 php_http_params_token_t
**sep
= separators
;
116 if (sep
) while (*sep
) {
117 if (check_str(state
->input
.str
, state
->input
.len
, (*sep
)->str
, (*sep
)->len
)) {
125 PHP_HTTP_API HashTable
*php_http_params_parse(HashTable
*params
, const php_http_params_opts_t
*opts TSRMLS_DC
)
127 php_http_params_state_t state
= {{NULL
,0}, {NULL
,0}, {NULL
,0}, {NULL
,0}, {NULL
,NULL
,NULL
}};
129 state
.input
.str
= opts
->input
.str
;
130 state
.input
.len
= opts
->input
.len
;
133 ALLOC_HASHTABLE(params
);
134 ZEND_INIT_SYMTABLE(params
);
137 while (state
.input
.len
) {
138 if (!state
.param
.str
) {
140 state
.param
.str
= state
.input
.str
;
143 /* are we at a param separator? */
144 if (0 < (sep_len
= check_sep(&state
, opts
->param
))) {
145 push_param(params
, &state
, opts TSRMLS_CC
);
147 /* start off with a new param */
148 state
.param
.str
= state
.input
.str
+ sep_len
;
150 state
.arg
.str
= NULL
;
152 state
.val
.str
= NULL
;
155 /* are we at an arg separator? */
156 if (0 < (sep_len
= check_sep(&state
, opts
->arg
))) {
157 push_param(params
, &state
, opts TSRMLS_CC
);
159 /* continue with a new arg */
160 state
.arg
.str
= state
.input
.str
+ sep_len
;
162 state
.val
.str
= NULL
;
165 /* are we at a val separator? */
166 if (0 < (sep_len
= check_sep(&state
, opts
->val
))) {
167 /* only handle separator if we're not already reading in a val */
168 if (!state
.val
.str
) {
169 push_param(params
, &state
, opts TSRMLS_CC
);
171 state
.val
.str
= state
.input
.str
+ sep_len
;
181 push_param(params
, &state
, opts TSRMLS_CC
);
186 #define PHP_HTTP_BEGIN_ARGS(method, req_args) PHP_HTTP_BEGIN_ARGS_EX(HttpParams, method, 0, req_args)
187 #define PHP_HTTP_EMPTY_ARGS(method) PHP_HTTP_EMPTY_ARGS_EX(HttpParams, method, 0)
188 #define PHP_HTTP_PARAMS_ME(method, visibility) PHP_ME(HttpParams, method, PHP_HTTP_ARGS(HttpParams, method), visibility)
189 #define PHP_HTTP_PARAMS_GME(method, visibility) PHP_ME(HttpParams, method, PHP_HTTP_ARGS(HttpParams, __getter), visibility)
191 PHP_HTTP_BEGIN_ARGS(__construct
, 0)
192 PHP_HTTP_ARG_VAL(params
, 0)
193 PHP_HTTP_ARG_VAL(param_sep
, 0)
194 PHP_HTTP_ARG_VAL(arg_sep
, 0)
195 PHP_HTTP_ARG_VAL(val_sep
, 0)
198 PHP_HTTP_EMPTY_ARGS(toArray
);
199 PHP_HTTP_EMPTY_ARGS(toString
);
201 PHP_HTTP_BEGIN_ARGS(offsetExists
, 1)
202 PHP_HTTP_ARG_VAL(name
, 0)
205 PHP_HTTP_BEGIN_ARGS(offsetUnset
, 1)
206 PHP_HTTP_ARG_VAL(name
, 0)
209 PHP_HTTP_BEGIN_ARGS(offsetGet
, 1)
210 PHP_HTTP_ARG_VAL(name
, 0)
213 PHP_HTTP_BEGIN_ARGS(offsetSet
, 2)
214 PHP_HTTP_ARG_VAL(name
, 0)
215 PHP_HTTP_ARG_VAL(value
, 0)
218 zend_class_entry
*php_http_params_class_entry
;
219 zend_function_entry php_http_params_method_entry
[] = {
220 PHP_HTTP_PARAMS_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
|ZEND_ACC_FINAL
)
222 PHP_HTTP_PARAMS_ME(toArray
, ZEND_ACC_PUBLIC
)
223 PHP_HTTP_PARAMS_ME(toString
, ZEND_ACC_PUBLIC
)
224 ZEND_MALIAS(HttpParams
, __toString
, toString
, PHP_HTTP_ARGS(HttpParams
, toString
), ZEND_ACC_PUBLIC
)
226 PHP_HTTP_PARAMS_ME(offsetExists
, ZEND_ACC_PUBLIC
)
227 PHP_HTTP_PARAMS_ME(offsetUnset
, ZEND_ACC_PUBLIC
)
228 PHP_HTTP_PARAMS_ME(offsetSet
, ZEND_ACC_PUBLIC
)
229 PHP_HTTP_PARAMS_ME(offsetGet
, ZEND_ACC_PUBLIC
)
234 PHP_MINIT_FUNCTION(http_params
)
236 PHP_HTTP_REGISTER_CLASS(http
, Params
, http_params
, php_http_object_class_entry
, 0);
238 zend_class_implements(php_http_params_class_entry TSRMLS_CC
, 1, zend_ce_arrayaccess
);
240 zend_declare_class_constant_stringl(php_http_params_class_entry
, ZEND_STRL("DEF_PARAM_SEP"), ZEND_STRL(",") TSRMLS_CC
);
241 zend_declare_class_constant_stringl(php_http_params_class_entry
, ZEND_STRL("DEF_ARG_SEP"), ZEND_STRL(";") TSRMLS_CC
);
242 zend_declare_class_constant_stringl(php_http_params_class_entry
, ZEND_STRL("DEF_VAL_SEP"), ZEND_STRL("=") TSRMLS_CC
);
243 zend_declare_class_constant_stringl(php_http_params_class_entry
, ZEND_STRL("COOKIE_PARAM_SEP"), ZEND_STRL("") TSRMLS_CC
);
245 zend_declare_property_null(php_http_params_class_entry
, ZEND_STRL("params"), ZEND_ACC_PUBLIC TSRMLS_CC
);
246 zend_declare_property_stringl(php_http_params_class_entry
, ZEND_STRL("param_sep"), ZEND_STRL(","), ZEND_ACC_PUBLIC TSRMLS_CC
);
247 zend_declare_property_stringl(php_http_params_class_entry
, ZEND_STRL("arg_sep"), ZEND_STRL(";"), ZEND_ACC_PUBLIC TSRMLS_CC
);
248 zend_declare_property_stringl(php_http_params_class_entry
, ZEND_STRL("val_sep"), ZEND_STRL("="), ZEND_ACC_PUBLIC TSRMLS_CC
);
253 static php_http_params_token_t
**parse_sep(zval
*zv TSRMLS_DC
)
257 php_http_params_token_t
**ret
, **tmp
;
263 zv
= php_http_ztyp(IS_ARRAY
, zv
);
264 ret
= ecalloc(zend_hash_num_elements(Z_ARRVAL_P(zv
)) + 1, sizeof(*ret
));
267 FOREACH_VAL(pos
, zv
, sep
) {
268 zval
*zt
= php_http_ztyp(IS_STRING
, *sep
);
270 if (Z_STRLEN_P(zt
)) {
271 *tmp
= emalloc(sizeof(**tmp
));
272 (*tmp
)->str
= estrndup(Z_STRVAL_P(zt
), (*tmp
)->len
= Z_STRLEN_P(zt
));
283 static void free_sep(php_http_params_token_t
**separator
) {
284 php_http_params_token_t
**sep
= separator
;
287 STR_FREE((*sep
)->str
);
295 PHP_METHOD(HttpParams
, __construct
)
297 with_error_handling(EH_THROW
, php_http_exception_class_entry
) {
298 zval
*zcopy
, *zparams
= NULL
, *param_sep
= NULL
, *arg_sep
= NULL
, *val_sep
= NULL
;
300 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|z!/z/z/z/", &zparams
, ¶m_sep
, &arg_sep
, &val_sep
)) {
301 switch (ZEND_NUM_ARGS()) {
303 zend_update_property(php_http_params_class_entry
, getThis(), ZEND_STRL("val_sep"), val_sep TSRMLS_CC
);
306 zend_update_property(php_http_params_class_entry
, getThis(), ZEND_STRL("arg_sep"), arg_sep TSRMLS_CC
);
309 zend_update_property(php_http_params_class_entry
, getThis(), ZEND_STRL("param_sep"), param_sep TSRMLS_CC
);
314 switch (Z_TYPE_P(zparams
)) {
317 zcopy
= php_http_zsep(1, IS_ARRAY
, zparams
);
318 zend_update_property(php_http_params_class_entry
, getThis(), ZEND_STRL("params"), zcopy TSRMLS_CC
);
319 zval_ptr_dtor(&zcopy
);
322 zcopy
= php_http_ztyp(IS_STRING
, zparams
);
323 if (Z_STRLEN_P(zcopy
)) {
324 php_http_params_opts_t opts
= {
326 .str
= Z_STRVAL_P(zcopy
),
327 .len
= Z_STRLEN_P(zcopy
)
329 .param
= parse_sep(zend_read_property(php_http_params_class_entry
, getThis(), ZEND_STRL("param_sep"), 0 TSRMLS_CC
) TSRMLS_CC
),
330 .arg
= parse_sep(zend_read_property(php_http_params_class_entry
, getThis(), ZEND_STRL("arg_sep"), 0 TSRMLS_CC
) TSRMLS_CC
),
331 .val
= parse_sep(zend_read_property(php_http_params_class_entry
, getThis(), ZEND_STRL("val_sep"), 0 TSRMLS_CC
) TSRMLS_CC
)
334 MAKE_STD_ZVAL(zparams
);
336 php_http_params_parse(Z_ARRVAL_P(zparams
), &opts TSRMLS_CC
);
337 zend_update_property(php_http_params_class_entry
, getThis(), ZEND_STRL("params"), zparams TSRMLS_CC
);
338 zval_ptr_dtor(&zparams
);
340 free_sep(opts
.param
);
344 zval_ptr_dtor(&zcopy
);
348 MAKE_STD_ZVAL(zparams
);
350 zend_update_property(php_http_params_class_entry
, getThis(), ZEND_STRL("params"), zparams TSRMLS_CC
);
351 zval_ptr_dtor(&zparams
);
354 } end_error_handling();
357 PHP_METHOD(HttpParams
, toArray
)
359 if (SUCCESS
!= zend_parse_parameters_none()) {
362 RETURN_PROP(php_http_params_class_entry
, "params");
365 PHP_METHOD(HttpParams
, toString
)
367 zval
*zparams
, *zpsep
, *zasep
, *zvsep
;
368 zval
**zparam
, **zvalue
, **zargs
, **zarg
;
369 HashPosition pos1
, pos2
;
370 php_http_array_hashkey_t key1
= php_http_array_hashkey_init(0), key2
= php_http_array_hashkey_init(0);
371 php_http_buffer_t buf
;
373 zparams
= php_http_ztyp(IS_ARRAY
, zend_read_property(php_http_params_class_entry
, getThis(), ZEND_STRL("params"), 0 TSRMLS_CC
));
374 zpsep
= php_http_ztyp(IS_STRING
, zend_read_property(php_http_params_class_entry
, getThis(), ZEND_STRL("param_sep"), 0 TSRMLS_CC
));
375 zasep
= php_http_ztyp(IS_STRING
, zend_read_property(php_http_params_class_entry
, getThis(), ZEND_STRL("arg_sep"), 0 TSRMLS_CC
));
376 zvsep
= php_http_ztyp(IS_STRING
, zend_read_property(php_http_params_class_entry
, getThis(), ZEND_STRL("val_sep"), 0 TSRMLS_CC
));
377 php_http_buffer_init(&buf
);
379 FOREACH_KEYVAL(pos1
, zparams
, key1
, zparam
) {
381 if (PHP_HTTP_BUFFER_LEN(&buf
)) {
382 php_http_buffer_append(&buf
, Z_STRVAL_P(zpsep
), Z_STRLEN_P(zpsep
));
386 if (key1
.type
== HASH_KEY_IS_STRING
) {
387 php_http_buffer_append(&buf
, key1
.str
, key1
.len
- 1);
389 php_http_buffer_appendf(&buf
, "%lu", key1
.num
);
392 if (Z_TYPE_PP(zparam
) == IS_ARRAY
) {
394 if (SUCCESS
== zend_hash_find(Z_ARRVAL_PP(zparam
), ZEND_STRS("value"), (void *) &zvalue
)) {
395 if (Z_TYPE_PP(zvalue
) != IS_BOOL
) {
396 zval
*tmp
= php_http_ztyp(IS_STRING
, *zvalue
);
398 php_http_buffer_append(&buf
, Z_STRVAL_P(zvsep
), Z_STRLEN_P(zvsep
));
399 php_http_buffer_append(&buf
, Z_STRVAL_P(tmp
), Z_STRLEN_P(tmp
));
401 } else if (!Z_BVAL_PP(zvalue
)) {
402 php_http_buffer_append(&buf
, Z_STRVAL_P(zvsep
), Z_STRLEN_P(zvsep
));
403 php_http_buffer_appends(&buf
, "0");
407 if (SUCCESS
== zend_hash_find(Z_ARRVAL_PP(zparam
), ZEND_STRS("arguments"), (void *) &zargs
)) {
408 if (Z_TYPE_PP(zargs
) == IS_ARRAY
) {
409 FOREACH_KEYVAL(pos2
, *zargs
, key2
, zarg
) {
411 if (PHP_HTTP_BUFFER_LEN(&buf
)) {
412 php_http_buffer_append(&buf
, Z_STRVAL_P(zasep
), Z_STRLEN_P(zasep
));
416 if (key2
.type
== HASH_KEY_IS_STRING
) {
417 php_http_buffer_append(&buf
, key2
.str
, key2
.len
- 1);
419 php_http_buffer_appendf(&buf
, "%lu", key2
.num
);
422 if (Z_TYPE_PP(zarg
) != IS_BOOL
) {
423 zval
*tmp
= php_http_ztyp(IS_STRING
, *zarg
);
426 Z_STRVAL_P(tmp
) = php_addslashes(Z_STRVAL_P(tmp
), Z_STRLEN_P(tmp
), &escaped_len
, 1 TSRMLS_CC
);
427 php_http_buffer_append(&buf
, Z_STRVAL_P(zvsep
), Z_STRLEN_P(zvsep
));
428 if (escaped_len
!= Z_STRLEN_P(tmp
)) {
429 php_http_buffer_appends(&buf
, "\"");
430 php_http_buffer_append(&buf
, Z_STRVAL_P(tmp
), Z_STRLEN_P(tmp
) = escaped_len
);
431 php_http_buffer_appends(&buf
, "\"");
433 php_http_buffer_append(&buf
, Z_STRVAL_P(tmp
), Z_STRLEN_P(tmp
));
436 } else if (!Z_BVAL_PP(zarg
)) {
437 php_http_buffer_append(&buf
, Z_STRVAL_P(zvsep
), Z_STRLEN_P(zvsep
));
438 php_http_buffer_appends(&buf
, "0");
446 zval_ptr_dtor(&zparams
);
447 zval_ptr_dtor(&zpsep
);
448 zval_ptr_dtor(&zasep
);
449 zval_ptr_dtor(&zvsep
);
451 php_http_buffer_fix(&buf
);
452 php_http_buffer_shrink(&buf
);
453 RETVAL_PHP_HTTP_BUFFER_VAL(&buf
);
456 PHP_METHOD(HttpParams
, offsetExists
)
461 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &name_str
, &name_len
)) {
462 zval
**zparam
, *zparams
= php_http_ztyp(IS_ARRAY
, zend_read_property(php_http_params_class_entry
, getThis(), ZEND_STRL("params"), 0 TSRMLS_CC
));
464 if (SUCCESS
== zend_symtable_find(Z_ARRVAL_P(zparams
), name_str
, name_len
+ 1, (void *) &zparam
)) {
465 RETVAL_BOOL(Z_TYPE_PP(zparam
) != IS_NULL
);
469 zval_ptr_dtor(&zparams
);
473 PHP_METHOD(HttpParams
, offsetGet
)
478 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &name_str
, &name_len
)) {
479 zval
**zparam
, *zparams
= php_http_ztyp(IS_ARRAY
, zend_read_property(php_http_params_class_entry
, getThis(), ZEND_STRL("params"), 0 TSRMLS_CC
));
481 if (SUCCESS
== zend_symtable_find(Z_ARRVAL_P(zparams
), name_str
, name_len
+ 1, (void *) &zparam
)) {
482 RETVAL_ZVAL(*zparam
, 1, 0);
485 zval_ptr_dtor(&zparams
);
490 PHP_METHOD(HttpParams
, offsetUnset
)
495 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &name_str
, &name_len
)) {
496 zval
*zparams
= php_http_zsep(1, IS_ARRAY
, zend_read_property(php_http_params_class_entry
, getThis(), ZEND_STRL("params"), 0 TSRMLS_CC
));
498 zend_symtable_del(Z_ARRVAL_P(zparams
), name_str
, name_len
+ 1);
499 zend_update_property(php_http_params_class_entry
, getThis(), ZEND_STRL("params"), zparams TSRMLS_CC
);
501 zval_ptr_dtor(&zparams
);
505 PHP_METHOD(HttpParams
, offsetSet
)
511 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sz", &name_str
, &name_len
, &nvalue
)) {
512 zval
**zparam
, *zparams
= php_http_zsep(1, IS_ARRAY
, zend_read_property(php_http_params_class_entry
, getThis(), ZEND_STRL("params"), 0 TSRMLS_CC
));
515 if (Z_TYPE_P(nvalue
) == IS_ARRAY
) {
518 if (SUCCESS
== zend_symtable_find(Z_ARRVAL_P(zparams
), name_str
, name_len
+ 1, (void *) &zparam
)) {
519 new_zparam
= php_http_zsep(1, IS_ARRAY
, *zparam
);
520 array_join(Z_ARRVAL_P(nvalue
), Z_ARRVAL_P(new_zparam
), 0, 0);
523 Z_ADDREF_P(new_zparam
);
525 add_assoc_zval_ex(zparams
, name_str
, name_len
+ 1, new_zparam
);
529 if (SUCCESS
== zend_symtable_find(Z_ARRVAL_P(zparams
), name_str
, name_len
+ 1, (void *) &zparam
)) {
530 tmp
= php_http_zsep(1, IS_ARRAY
, *zparam
);
537 add_assoc_zval_ex(tmp
, ZEND_STRS("value"), nvalue
);
538 add_assoc_zval_ex(zparams
, name_str
, name_len
+ 1, tmp
);
541 zval
*tmp
= php_http_ztyp(IS_STRING
, nvalue
), *arr
;
545 add_assoc_bool_ex(arr
, ZEND_STRS("value"), 1);
546 add_assoc_zval_ex(zparams
, Z_STRVAL_P(tmp
), Z_STRLEN_P(tmp
) + 1, arr
);
550 zend_update_property(php_http_params_class_entry
, getThis(), ZEND_STRL("params"), zparams TSRMLS_CC
);
551 zval_ptr_dtor(&zparams
);
560 * vim600: noet sw=4 ts=4 fdm=marker
561 * vim<600: noet sw=4 ts=4