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-2006, Michael Wallner <mike@php.net> |
10 +--------------------------------------------------------------------+
15 #define HTTP_WANT_SAPI
20 #include "php_variables.h"
21 #include "zend_interfaces.h"
25 # include "ext/iconv/php_iconv.h"
26 # include "ext/standard/url.h"
29 #include "php_http_api.h"
30 #include "php_http_url_api.h"
31 #include "php_http_querystring_object.h"
32 #include "php_http_exception_object.h"
34 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpQueryString, method, 0, req_args)
35 #define HTTP_EMPTY_ARGS(method) HTTP_EMPTY_ARGS_EX(HttpQueryString, method, 0)
36 #define HTTP_QUERYSTRING_ME(method, visibility) PHP_ME(HttpQueryString, method, HTTP_ARGS(HttpQueryString, method), visibility)
37 #define HTTP_QUERYSTRING_GME(method, visibility) PHP_ME(HttpQueryString, method, HTTP_ARGS(HttpQueryString, __getter), visibility)
39 HTTP_BEGIN_ARGS(__construct
, 0)
40 HTTP_ARG_VAL(global
, 0)
41 HTTP_ARG_VAL(params
, 0)
45 HTTP_BEGIN_ARGS(singleton
, 0)
46 HTTP_ARG_VAL(global
, 0)
50 HTTP_EMPTY_ARGS(toArray
);
51 HTTP_EMPTY_ARGS(toString
);
53 HTTP_BEGIN_ARGS(get
, 0)
56 HTTP_ARG_VAL(defval
, 0)
57 HTTP_ARG_VAL(delete, 0)
60 HTTP_BEGIN_ARGS(set
, 1)
61 HTTP_ARG_VAL(params
, 0)
64 HTTP_BEGIN_ARGS(__getter
, 1)
66 HTTP_ARG_VAL(defval
, 0)
67 HTTP_ARG_VAL(delete, 0)
71 HTTP_BEGIN_ARGS(xlate
, 2)
72 HTTP_ARG_VAL(from_encoding
, 0)
73 HTTP_ARG_VAL(to_encoding
, 0)
77 HTTP_EMPTY_ARGS(serialize
);
78 HTTP_BEGIN_ARGS(unserialize
, 1)
79 HTTP_ARG_VAL(serialized
, 0)
82 #define OBJ_PROP_CE http_querystring_object_ce
83 zend_class_entry
*http_querystring_object_ce
;
84 zend_function_entry http_querystring_object_fe
[] = {
85 HTTP_QUERYSTRING_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
|ZEND_ACC_FINAL
)
87 HTTP_QUERYSTRING_ME(toArray
, ZEND_ACC_PUBLIC
)
88 HTTP_QUERYSTRING_ME(toString
, ZEND_ACC_PUBLIC
)
89 ZEND_MALIAS(HttpQueryString
, __toString
, toString
, HTTP_ARGS(HttpQueryString
, toString
), ZEND_ACC_PUBLIC
)
91 HTTP_QUERYSTRING_ME(get
, ZEND_ACC_PUBLIC
)
92 HTTP_QUERYSTRING_ME(set
, ZEND_ACC_PUBLIC
)
94 HTTP_QUERYSTRING_GME(getBool
, ZEND_ACC_PUBLIC
)
95 HTTP_QUERYSTRING_GME(getInt
, ZEND_ACC_PUBLIC
)
96 HTTP_QUERYSTRING_GME(getFloat
, ZEND_ACC_PUBLIC
)
97 HTTP_QUERYSTRING_GME(getString
, ZEND_ACC_PUBLIC
)
98 HTTP_QUERYSTRING_GME(getArray
, ZEND_ACC_PUBLIC
)
99 HTTP_QUERYSTRING_GME(getObject
, ZEND_ACC_PUBLIC
)
102 HTTP_QUERYSTRING_ME(singleton
, ZEND_ACC_PUBLIC
|ZEND_ACC_STATIC
)
105 HTTP_QUERYSTRING_ME(xlate
, ZEND_ACC_PUBLIC
)
108 /* Implements Serializable */
109 HTTP_QUERYSTRING_ME(serialize
, ZEND_ACC_PUBLIC
)
110 HTTP_QUERYSTRING_ME(unserialize
, ZEND_ACC_PUBLIC
)
114 static zend_object_handlers http_querystring_object_handlers
;
116 PHP_MINIT_FUNCTION(http_querystring_object
)
118 HTTP_REGISTER_CLASS_EX(HttpQueryString
, http_querystring_object
, NULL
, 0);
121 zend_class_implements(http_querystring_object_ce TSRMLS_CC
, 1, zend_ce_serializable
);
124 DCL_STATIC_PROP_N(PRIVATE
, instance
);
125 DCL_PROP_N(PRIVATE
, queryArray
);
126 DCL_PROP(PRIVATE
, string
, queryString
, "");
129 DCL_CONST(long, "TYPE_BOOL", HTTP_QUERYSTRING_TYPE_BOOL
);
130 DCL_CONST(long, "TYPE_INT", HTTP_QUERYSTRING_TYPE_INT
);
131 DCL_CONST(long, "TYPE_FLOAT", HTTP_QUERYSTRING_TYPE_FLOAT
);
132 DCL_CONST(long, "TYPE_STRING", HTTP_QUERYSTRING_TYPE_STRING
);
133 DCL_CONST(long, "TYPE_ARRAY", HTTP_QUERYSTRING_TYPE_ARRAY
);
134 DCL_CONST(long, "TYPE_OBJECT", HTTP_QUERYSTRING_TYPE_OBJECT
);
137 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_BOOL", HTTP_QUERYSTRING_TYPE_BOOL
);
138 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_INT", HTTP_QUERYSTRING_TYPE_INT
);
139 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_FLOAT", HTTP_QUERYSTRING_TYPE_FLOAT
);
140 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_STRING", HTTP_QUERYSTRING_TYPE_STRING
);
141 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_ARRAY", HTTP_QUERYSTRING_TYPE_ARRAY
);
142 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_OBJECT", HTTP_QUERYSTRING_TYPE_OBJECT
);
147 zend_object_value
_http_querystring_object_new(zend_class_entry
*ce TSRMLS_DC
)
149 return http_querystring_object_new_ex(ce
, NULL
);
152 zend_object_value
_http_querystring_object_new_ex(zend_class_entry
*ce
, http_querystring_object
**ptr TSRMLS_DC
)
154 zend_object_value ov
;
155 http_querystring_object
*o
;
157 o
= ecalloc(1, sizeof(http_querystring_object
));
164 ALLOC_HASHTABLE(OBJ_PROP(o
));
165 zend_hash_init(OBJ_PROP(o
), 0, NULL
, ZVAL_PTR_DTOR
, 0);
166 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
168 ov
.handle
= putObject(http_querystring_object
, o
);
169 ov
.handlers
= &http_querystring_object_handlers
;
174 void _http_querystring_object_free(zend_object
*object TSRMLS_DC
)
176 http_querystring_object
*o
= (http_querystring_object
*) object
;
179 zend_hash_destroy(OBJ_PROP(o
));
180 FREE_HASHTABLE(OBJ_PROP(o
));
185 /* {{{ querystring helpers */
186 #define http_querystring_update(qa, qs) _http_querystring_update((qa), (qs) TSRMLS_CC)
187 static inline void _http_querystring_update(zval
*qarray
, zval
*qstring TSRMLS_DC
);
188 #define http_querystring_modify_array_ex(q, k, kl, pe) _http_querystring_modify_array_ex((q), (k), (kl), (pe) TSRMLS_CC)
189 static inline int _http_querystring_modify_array_ex(zval
*qarray
, char *key
, int keylen
, zval
*params_entry TSRMLS_DC
);
190 #define http_querystring_modify_array(q, p) _http_querystring_modify_array((q), (p) TSRMLS_CC)
191 static inline int _http_querystring_modify_array(zval
*qarray
, zval
*params TSRMLS_DC
);
192 #define http_querystring_modify(q, p) _http_querystring_modify((q), (p) TSRMLS_CC)
193 static inline int _http_querystring_modify(zval
*qarray
, zval
*params TSRMLS_DC
);
194 #define http_querystring_get(o, t, n, l, def, del, r) _http_querystring_get((o), (t), (n), (l), (def), (del), (r) TSRMLS_CC)
195 static inline void _http_querystring_get(zval
*this_ptr
, int type
, char *name
, uint name_len
, zval
*defval
, zend_bool del
, zval
*return_value TSRMLS_DC
);
197 #define http_querystring_instantiate(g) _http_querystring_instantiate((g) TSRMLS_CC)
198 static inline zval
*_http_querystring_instantiate(zend_bool global TSRMLS_DC
)
200 zval
*zobj
, *zglobal
;
202 MAKE_STD_ZVAL(zglobal
);
203 ZVAL_BOOL(zglobal
, global
);
206 Z_TYPE_P(zobj
) = IS_OBJECT
;
207 Z_OBJVAL_P(zobj
) = http_querystring_object_new(http_querystring_object_ce
);
208 zend_call_method_with_1_params(&zobj
, Z_OBJCE_P(zobj
), NULL
, "__construct", NULL
, zglobal
);
210 zval_ptr_dtor(&zglobal
);
215 static inline void _http_querystring_update(zval
*qarray
, zval
*qstring TSRMLS_DC
)
220 if (Z_TYPE_P(qarray
) != IS_ARRAY
) {
221 convert_to_array(qarray
);
223 if (SUCCESS
== http_urlencode_hash_ex(Z_ARRVAL_P(qarray
), 0, NULL
, 0, &s
, &l
)) {
225 ZVAL_STRINGL(qstring
, s
, l
, 0);
227 http_error(HE_WARNING
, HTTP_E_QUERYSTRING
, "Failed to update query string");
230 static inline int _http_querystring_modify_array_ex(zval
*qarray
, char *key
, int keylen
, zval
*params_entry TSRMLS_DC
)
235 if (Z_TYPE_P(params_entry
) == IS_NULL
) {
236 return (SUCCESS
== zend_hash_del(Z_ARRVAL_P(qarray
), key
, keylen
));
240 if (SUCCESS
== zend_hash_find(Z_ARRVAL_P(qarray
), key
, keylen
, (void **) &qarray_entry
)) {
244 if (Z_TYPE_P(params_entry
) == IS_ARRAY
) {
245 return http_querystring_modify_array(*qarray_entry
, params_entry
);
248 if ((SUCCESS
== is_equal_function(&equal
, *qarray_entry
, params_entry TSRMLS_CC
)) && Z_BVAL(equal
)) {
254 ZVAL_ADDREF(params_entry
);
255 add_assoc_zval_ex(qarray
, key
, keylen
, params_entry
);
258 static inline int _http_querystring_modify_array(zval
*qarray
, zval
*params TSRMLS_DC
)
267 FOREACH_KEYLENVAL(pos
, params
, key
, keylen
, idx
, params_entry
) {
269 if (http_querystring_modify_array_ex(qarray
, key
, keylen
, *params_entry
)) {
273 keylen
= spprintf(&key
, 0, "%lu", idx
);
274 if (http_querystring_modify_array_ex(qarray
, key
, keylen
, *params_entry
)) {
284 static inline int _http_querystring_modify(zval
*qarray
, zval
*params TSRMLS_DC
)
286 if (Z_TYPE_P(params
) == IS_ARRAY
) {
287 return http_querystring_modify_array(qarray
, params
);
288 } else if (Z_TYPE_P(params
) == IS_OBJECT
) {
289 if (!instanceof_function(Z_OBJCE_P(params
), http_querystring_object_ce TSRMLS_CC
)) {
291 INIT_ZARR(temp_array
, HASH_OF(params
));
292 return http_querystring_modify_array(qarray
, &temp_array
);
294 return http_querystring_modify_array(qarray
, GET_PROP_EX(params
, queryArray
));
303 convert_to_string_ex(¶ms
);
304 sapi_module
.treat_data(PARSE_STRING
, estrdup(Z_STRVAL_P(params
)), &array TSRMLS_CC
);
305 zval_ptr_dtor(¶ms
);
306 rv
= http_querystring_modify_array(qarray
, &array
);
311 static inline void _http_querystring_get(zval
*this_ptr
, int type
, char *name
, uint name_len
, zval
*defval
, zend_bool del
, zval
*return_value TSRMLS_DC
)
313 zval
**arrval
, *qarray
= GET_PROP(queryArray
);
315 if ((Z_TYPE_P(qarray
) == IS_ARRAY
) && (SUCCESS
== zend_hash_find(Z_ARRVAL_P(qarray
), name
, name_len
+ 1, (void **) &arrval
))) {
316 RETVAL_ZVAL(*arrval
, 1, 0);
319 convert_to_type(type
, return_value
);
322 if (del
&& (SUCCESS
== zend_hash_del(Z_ARRVAL_P(qarray
), name
, name_len
+ 1))) {
323 http_querystring_update(qarray
, GET_PROP(queryString
));
326 RETURN_ZVAL(defval
, 1, 0);
331 /* {{{ proto final void HttpQueryString::__construct([bool global = true[, mixed add])
333 * Creates a new HttpQueryString object instance.
334 * Operates on and modifies $_GET and $_SERVER['QUERY_STRING'] if global is TRUE.
336 PHP_METHOD(HttpQueryString
, __construct
)
338 zend_bool global
= 1;
339 zval
*params
= NULL
, *qarray
= NULL
, *qstring
= NULL
, **_GET
, **_SERVER
, **QUERY_STRING
;
342 if (!sapi_module
.treat_data
) {
343 http_error(HE_ERROR
, HTTP_E_QUERYSTRING
, "The SAPI does not have a treat_data function registered");
344 } else if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|bz", &global
, ¶ms
)) {
346 if ( (SUCCESS
== zend_hash_find(&EG(symbol_table
), "_SERVER", sizeof("_SERVER"), (void **) &_SERVER
)) &&
347 (Z_TYPE_PP(_SERVER
) == IS_ARRAY
) &&
348 (SUCCESS
== zend_hash_find(Z_ARRVAL_PP(_SERVER
), "QUERY_STRING", sizeof("QUERY_STRING"), (void **) &QUERY_STRING
))) {
350 qstring
= *QUERY_STRING
;
352 if ((SUCCESS
== zend_hash_find(&EG(symbol_table
), "_GET", sizeof("_GET"), (void **) &_GET
)) && (Z_TYPE_PP(_GET
) == IS_ARRAY
)) {
355 http_error(HE_WARNING
, HTTP_E_QUERYSTRING
, "Could not acquire reference to superglobal GET array");
358 http_error(HE_WARNING
, HTTP_E_QUERYSTRING
, "Could not acquire reference to QUERY_STRING");
361 if (qarray
&& qstring
) {
362 if (Z_TYPE_P(qstring
) != IS_STRING
) {
363 convert_to_string(qstring
);
366 SET_PROP(queryArray
, qarray
);
367 SET_PROP(queryString
, qstring
);
368 GET_PROP(queryArray
)->is_ref
= 1;
369 GET_PROP(queryString
)->is_ref
= 1;
371 if (params
&& http_querystring_modify(GET_PROP(queryArray
), params
)) {
372 http_querystring_update(GET_PROP(queryArray
), GET_PROP(queryString
));
376 qarray
= ecalloc(1, sizeof(zval
));
379 SET_PROP(queryArray
, qarray
);
380 UPD_STRL(queryString
, "", 0);
382 if (params
&& http_querystring_modify(qarray
, params
)) {
383 http_querystring_update(qarray
, GET_PROP(queryString
));
391 /* {{{ proto string HttpQueryString::toString()
393 * Returns the string representation.
395 PHP_METHOD(HttpQueryString
, toString
)
398 RETURN_PROP(queryString
);
402 /* {{{ proto array HttpQueryString::toArray()
404 * Returns the array representation.
406 PHP_METHOD(HttpQueryString
, toArray
)
409 RETURN_PROP(queryArray
);
413 /* {{{ proto mixed HttpQueryString::get([string key[, mixed type = 0[, mixed defval = NULL[, bool delete = false]]]])
415 * Get (part of) the query string.
417 * The type parameter is either one of the HttpQueryString::TYPE_* constants or a type abbreviation like
418 * "b" for bool, "i" for int, "f" for float, "s" for string, "a" for array and "o" for a stdClass object.
420 PHP_METHOD(HttpQueryString
, get
)
426 zval
*ztype
= NULL
, *defval
= NULL
;
428 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|szzb", &name
, &name_len
, &ztype
, &defval
, &del
)) {
429 if (name
&& name_len
) {
431 if (Z_TYPE_P(ztype
) == IS_LONG
) {
432 type
= Z_LVAL_P(ztype
);
433 } else if(Z_TYPE_P(ztype
) == IS_STRING
) {
434 switch (Z_STRVAL_P(ztype
)[0])
437 case 'b': type
= HTTP_QUERYSTRING_TYPE_BOOL
; break;
439 case 'i': type
= HTTP_QUERYSTRING_TYPE_INT
; break;
441 case 'f': type
= HTTP_QUERYSTRING_TYPE_FLOAT
; break;
443 case 's': type
= HTTP_QUERYSTRING_TYPE_STRING
; break;
445 case 'a': type
= HTTP_QUERYSTRING_TYPE_ARRAY
; break;
447 case 'o': type
= HTTP_QUERYSTRING_TYPE_OBJECT
; break;
451 http_querystring_get(getThis(), type
, name
, name_len
, defval
, del
, return_value
);
453 RETURN_PROP(queryString
);
459 /* {{{ proto string HttpQueryString::set(mixed params)
461 * Set query string entry/entries. NULL values will unset the variable.
463 PHP_METHOD(HttpQueryString
, set
)
467 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", ¶ms
)) {
468 zval
*qarray
= GET_PROP(queryArray
);
469 if (http_querystring_modify(qarray
, params
)) {
470 http_querystring_update(qarray
, GET_PROP(queryString
));
475 RETURN_PROP(queryString
);
481 /* {{{ proto static HttpQueryString HttpQueryString::singleton([bool global = true])
483 * Get a single instance (differentiates between the global setting).
485 PHP_METHOD(HttpQueryString
, singleton
)
487 zend_bool global
= 1;
488 zval
*instance
= GET_STATIC_PROP(instance
);
491 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &global
)) {
492 zval
**zobj_ptr
= NULL
, *zobj
= NULL
;
494 if (Z_TYPE_P(instance
) == IS_ARRAY
) {
495 if (SUCCESS
== zend_hash_index_find(Z_ARRVAL_P(instance
), global
, (void **) &zobj_ptr
)) {
496 RETVAL_ZVAL(*zobj_ptr
, 1, 0);
498 zobj
= http_querystring_instantiate(global
);
499 add_index_zval(instance
, global
, zobj
);
500 RETVAL_OBJECT(zobj
, 1);
503 MAKE_STD_ZVAL(instance
);
504 array_init(instance
);
506 zobj
= http_querystring_instantiate(global
);
507 add_index_zval(instance
, global
, zobj
);
508 RETVAL_OBJECT(zobj
, 1);
510 SET_STATIC_PROP(instance
, instance
);
511 zval_ptr_dtor(&instance
);
519 /* {{{ Getters by type */
520 #define HTTP_QUERYSTRING_GETTER(method, TYPE) \
521 PHP_METHOD(HttpQueryString, method) \
525 zval *defval = NULL; \
527 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|zb", &name, &name_len, &defval, &del)) { \
528 http_querystring_get(getThis(), TYPE, name, name_len, defval, del, return_value); \
531 HTTP_QUERYSTRING_GETTER(getBool
, IS_BOOL
);
532 HTTP_QUERYSTRING_GETTER(getInt
, IS_LONG
);
533 HTTP_QUERYSTRING_GETTER(getFloat
, IS_DOUBLE
);
534 HTTP_QUERYSTRING_GETTER(getString
, IS_STRING
);
535 HTTP_QUERYSTRING_GETTER(getArray
, IS_ARRAY
);
536 HTTP_QUERYSTRING_GETTER(getObject
, IS_OBJECT
);
540 /* {{{ proto bool HttpQueryString::xlate(string ie, string oe)
542 * Converts the query string from the source encoding ie to the target encoding oe.
543 * WARNING: Don't use any character set that can contain NUL bytes like UTF-16.
545 * Returns TRUE on success or FALSE on failure.
547 PHP_METHOD(HttpQueryString
, xlate
)
549 char *ie
, *oe
, *er
= NULL
;
554 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss", &ie
, &ie_len
, &oe
, &oe_len
)) {
558 qa
= GET_PROP(queryArray
);
559 qs
= GET_PROP(queryString
);
560 Z_STRLEN_P(qs
) = php_url_decode(Z_STRVAL_P(qs
), Z_STRLEN_P(qs
));
561 if (PHP_ICONV_ERR_SUCCESS
== php_iconv_string(Z_STRVAL_P(qs
), (size_t) Z_STRLEN_P(qs
), &er
, &er_len
, oe
, ie
)) {
562 efree(Z_STRVAL_P(qs
));
563 ZVAL_STRINGL(qs
, er
, er_len
, 0);
564 http_querystring_modify(qa
, qs
);
567 http_error_ex(HE_WARNING
, HTTP_E_QUERYSTRING
, "Failed to convert '%.*s' from '%s' to '%s'", Z_STRLEN_P(qs
), Z_STRVAL_P(qs
), ie
, oe
);
570 http_querystring_update(qa
, qs
);
573 #endif /* HAVE_ICONV */
575 /* {{{ proto string HttpQueryString::serialize()
577 * Implements Serializable.
579 PHP_METHOD(HttpQueryString
, serialize
)
582 RETURN_PROP(queryString
);
586 /* {{{ proto void HttpQueryString::unserialize(string serialized)
588 * Implements Serializable.
590 PHP_METHOD(HttpQueryString
, unserialize
)
595 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &serialized
)) {
596 if (Z_TYPE_P(serialized
) == IS_STRING
) {
597 zval
*qa
= GET_PROP(queryArray
);
599 zend_hash_clean(Z_ARRVAL_P(qa
));
600 http_querystring_modify(qa
, serialized
);
601 http_querystring_update(qa
, GET_PROP(queryString
));
603 http_error(HE_WARNING
, HTTP_E_QUERYSTRING
, "Expected a string as parameter");
610 #endif /* ZEND_ENGINE_2 */
617 * vim600: noet sw=4 ts=4 fdm=marker
618 * vim<600: noet sw=4 ts=4