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"
23 #include "php_http_api.h"
24 #include "php_http_querystring_api.h"
25 #include "php_http_querystring_object.h"
26 #include "php_http_exception_object.h"
28 #define HTTP_BEGIN_ARGS(method, req_args) HTTP_BEGIN_ARGS_EX(HttpQueryString, method, 0, req_args)
29 #define HTTP_EMPTY_ARGS(method) HTTP_EMPTY_ARGS_EX(HttpQueryString, method, 0)
30 #define HTTP_QUERYSTRING_ME(method, visibility) PHP_ME(HttpQueryString, method, HTTP_ARGS(HttpQueryString, method), visibility)
31 #define HTTP_QUERYSTRING_GME(method, visibility) PHP_ME(HttpQueryString, method, HTTP_ARGS(HttpQueryString, __getter), visibility)
33 HTTP_BEGIN_ARGS(__construct
, 0)
34 HTTP_ARG_VAL(global
, 0)
35 HTTP_ARG_VAL(params
, 0)
39 HTTP_BEGIN_ARGS(singleton
, 0)
40 HTTP_ARG_VAL(global
, 0)
44 HTTP_EMPTY_ARGS(toArray
);
45 HTTP_EMPTY_ARGS(toString
);
47 HTTP_BEGIN_ARGS(get
, 0)
50 HTTP_ARG_VAL(defval
, 0)
51 HTTP_ARG_VAL(delete, 0)
54 HTTP_BEGIN_ARGS(set
, 1)
55 HTTP_ARG_VAL(params
, 0)
58 HTTP_BEGIN_ARGS(mod
, 0)
59 HTTP_ARG_VAL(params
, 0)
62 HTTP_BEGIN_ARGS(__getter
, 1)
64 HTTP_ARG_VAL(defval
, 0)
65 HTTP_ARG_VAL(delete, 0)
68 #ifdef HTTP_HAVE_ICONV
69 HTTP_BEGIN_ARGS(xlate
, 2)
70 HTTP_ARG_VAL(from_encoding
, 0)
71 HTTP_ARG_VAL(to_encoding
, 0)
75 HTTP_EMPTY_ARGS(serialize
);
76 HTTP_BEGIN_ARGS(unserialize
, 1)
77 HTTP_ARG_VAL(serialized
, 0)
80 HTTP_BEGIN_ARGS(offsetGet
, 1)
81 HTTP_ARG_VAL(offset
, 0)
84 HTTP_BEGIN_ARGS(offsetSet
, 2)
85 HTTP_ARG_VAL(offset
, 0)
86 HTTP_ARG_VAL(value
, 0)
89 HTTP_BEGIN_ARGS(offsetExists
, 1)
90 HTTP_ARG_VAL(offset
, 0)
93 HTTP_BEGIN_ARGS(offsetUnset
, 1)
94 HTTP_ARG_VAL(offset
, 0)
98 #define OBJ_PROP_CE http_querystring_object_ce
99 zend_class_entry
*http_querystring_object_ce
;
100 zend_function_entry http_querystring_object_fe
[] = {
101 HTTP_QUERYSTRING_ME(__construct
, ZEND_ACC_PUBLIC
|ZEND_ACC_CTOR
|ZEND_ACC_FINAL
)
103 HTTP_QUERYSTRING_ME(toArray
, ZEND_ACC_PUBLIC
)
104 HTTP_QUERYSTRING_ME(toString
, ZEND_ACC_PUBLIC
)
105 ZEND_MALIAS(HttpQueryString
, __toString
, toString
, HTTP_ARGS(HttpQueryString
, toString
), ZEND_ACC_PUBLIC
)
107 HTTP_QUERYSTRING_ME(get
, ZEND_ACC_PUBLIC
)
108 HTTP_QUERYSTRING_ME(set
, ZEND_ACC_PUBLIC
)
109 HTTP_QUERYSTRING_ME(mod
, ZEND_ACC_PUBLIC
)
111 HTTP_QUERYSTRING_GME(getBool
, ZEND_ACC_PUBLIC
)
112 HTTP_QUERYSTRING_GME(getInt
, ZEND_ACC_PUBLIC
)
113 HTTP_QUERYSTRING_GME(getFloat
, ZEND_ACC_PUBLIC
)
114 HTTP_QUERYSTRING_GME(getString
, ZEND_ACC_PUBLIC
)
115 HTTP_QUERYSTRING_GME(getArray
, ZEND_ACC_PUBLIC
)
116 HTTP_QUERYSTRING_GME(getObject
, ZEND_ACC_PUBLIC
)
119 HTTP_QUERYSTRING_ME(singleton
, ZEND_ACC_PUBLIC
|ZEND_ACC_STATIC
)
121 #ifdef HTTP_HAVE_ICONV
122 HTTP_QUERYSTRING_ME(xlate
, ZEND_ACC_PUBLIC
)
125 /* Implements Serializable */
126 HTTP_QUERYSTRING_ME(serialize
, ZEND_ACC_PUBLIC
)
127 HTTP_QUERYSTRING_ME(unserialize
, ZEND_ACC_PUBLIC
)
129 /* Implements ArrayAccess */
130 HTTP_QUERYSTRING_ME(offsetGet
, ZEND_ACC_PUBLIC
)
131 HTTP_QUERYSTRING_ME(offsetSet
, ZEND_ACC_PUBLIC
)
132 HTTP_QUERYSTRING_ME(offsetExists
, ZEND_ACC_PUBLIC
)
133 HTTP_QUERYSTRING_ME(offsetUnset
, ZEND_ACC_PUBLIC
)
137 static zend_object_handlers http_querystring_object_handlers
;
139 PHP_MINIT_FUNCTION(http_querystring_object
)
141 HTTP_REGISTER_CLASS_EX(HttpQueryString
, http_querystring_object
, NULL
, 0);
144 zend_class_implements(http_querystring_object_ce TSRMLS_CC
, 2, zend_ce_serializable
, zend_ce_arrayaccess
);
147 DCL_STATIC_PROP_N(PRIVATE
, instance
);
148 DCL_PROP_N(PRIVATE
, queryArray
);
149 DCL_PROP(PRIVATE
, string
, queryString
, "");
152 DCL_CONST(long, "TYPE_BOOL", HTTP_QUERYSTRING_TYPE_BOOL
);
153 DCL_CONST(long, "TYPE_INT", HTTP_QUERYSTRING_TYPE_INT
);
154 DCL_CONST(long, "TYPE_FLOAT", HTTP_QUERYSTRING_TYPE_FLOAT
);
155 DCL_CONST(long, "TYPE_STRING", HTTP_QUERYSTRING_TYPE_STRING
);
156 DCL_CONST(long, "TYPE_ARRAY", HTTP_QUERYSTRING_TYPE_ARRAY
);
157 DCL_CONST(long, "TYPE_OBJECT", HTTP_QUERYSTRING_TYPE_OBJECT
);
160 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_BOOL", HTTP_QUERYSTRING_TYPE_BOOL
);
161 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_INT", HTTP_QUERYSTRING_TYPE_INT
);
162 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_FLOAT", HTTP_QUERYSTRING_TYPE_FLOAT
);
163 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_STRING", HTTP_QUERYSTRING_TYPE_STRING
);
164 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_ARRAY", HTTP_QUERYSTRING_TYPE_ARRAY
);
165 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_OBJECT", HTTP_QUERYSTRING_TYPE_OBJECT
);
170 zend_object_value
_http_querystring_object_new(zend_class_entry
*ce TSRMLS_DC
)
172 return http_querystring_object_new_ex(ce
, NULL
);
175 zend_object_value
_http_querystring_object_new_ex(zend_class_entry
*ce
, http_querystring_object
**ptr TSRMLS_DC
)
177 zend_object_value ov
;
178 http_querystring_object
*o
;
180 o
= ecalloc(1, sizeof(http_querystring_object
));
187 ALLOC_HASHTABLE(OBJ_PROP(o
));
188 zend_hash_init(OBJ_PROP(o
), zend_hash_num_elements(&ce
->default_properties
), NULL
, ZVAL_PTR_DTOR
, 0);
189 zend_hash_copy(OBJ_PROP(o
), &ce
->default_properties
, (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
191 ov
.handle
= putObject(http_querystring_object
, o
);
192 ov
.handlers
= &http_querystring_object_handlers
;
197 void _http_querystring_object_free(zend_object
*object TSRMLS_DC
)
199 http_querystring_object
*o
= (http_querystring_object
*) object
;
202 zend_hash_destroy(OBJ_PROP(o
));
203 FREE_HASHTABLE(OBJ_PROP(o
));
208 /* {{{ querystring helpers */
209 #define http_querystring_instantiate(g) _http_querystring_instantiate((g) TSRMLS_CC)
210 static inline zval
*_http_querystring_instantiate(zend_bool global TSRMLS_DC
)
212 zval
*zobj
, *zglobal
;
214 MAKE_STD_ZVAL(zglobal
);
215 ZVAL_BOOL(zglobal
, global
);
218 Z_TYPE_P(zobj
) = IS_OBJECT
;
219 Z_OBJVAL_P(zobj
) = http_querystring_object_new(http_querystring_object_ce
);
220 zend_call_method_with_1_params(&zobj
, Z_OBJCE_P(zobj
), NULL
, "__construct", NULL
, zglobal
);
222 zval_ptr_dtor(&zglobal
);
227 #define http_querystring_get(o, t, n, l, def, del, r) _http_querystring_get((o), (t), (n), (l), (def), (del), (r) TSRMLS_CC)
228 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
)
230 zval
**arrval
, *qarray
= GET_PROP(queryArray
);
232 if ((Z_TYPE_P(qarray
) == IS_ARRAY
) && (SUCCESS
== zend_hash_find(Z_ARRVAL_P(qarray
), name
, name_len
+ 1, (void *) &arrval
))) {
233 RETVAL_ZVAL(*arrval
, 1, 0);
236 convert_to_type(type
, return_value
);
239 if (del
&& (SUCCESS
== zend_hash_del(Z_ARRVAL_P(qarray
), name
, name_len
+ 1))) {
240 http_querystring_update(qarray
, GET_PROP(queryString
));
243 RETURN_ZVAL(defval
, 1, 0);
248 /* {{{ proto final void HttpQueryString::__construct([bool global = true[, mixed add])
250 * Creates a new HttpQueryString object instance.
251 * Operates on and modifies $_GET and $_SERVER['QUERY_STRING'] if global is TRUE.
253 PHP_METHOD(HttpQueryString
, __construct
)
255 zend_bool global
= 1;
256 zval
*params
= NULL
, *qarray
= NULL
, *qstring
= NULL
, **_GET
, **_SERVER
, **QUERY_STRING
;
259 if (!sapi_module
.treat_data
) {
260 http_error(HE_ERROR
, HTTP_E_QUERYSTRING
, "The SAPI does not have a treat_data function registered");
261 } else if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|bz", &global
, ¶ms
)) {
264 zend_is_auto_global("_SERVER", lenof("_SERVER") TSRMLS_CC
);
266 if ( (SUCCESS
== zend_hash_find(&EG(symbol_table
), "_SERVER", sizeof("_SERVER"), (void *) &_SERVER
)) &&
267 (Z_TYPE_PP(_SERVER
) == IS_ARRAY
) &&
268 (SUCCESS
== zend_hash_find(Z_ARRVAL_PP(_SERVER
), "QUERY_STRING", sizeof("QUERY_STRING"), (void *) &QUERY_STRING
))) {
270 qstring
= *QUERY_STRING
;
272 zend_is_auto_global("_GET", lenof("_GET") TSRMLS_CC
);
274 if ((SUCCESS
== zend_hash_find(&EG(symbol_table
), "_GET", sizeof("_GET"), (void *) &_GET
)) && (Z_TYPE_PP(_GET
) == IS_ARRAY
)) {
277 http_error(HE_WARNING
, HTTP_E_QUERYSTRING
, "Could not acquire reference to superglobal GET array");
280 http_error(HE_WARNING
, HTTP_E_QUERYSTRING
, "Could not acquire reference to QUERY_STRING");
283 if (qarray
&& qstring
) {
284 if (Z_TYPE_P(qstring
) != IS_STRING
) {
285 convert_to_string(qstring
);
288 SET_PROP(queryArray
, qarray
);
289 SET_PROP(queryString
, qstring
);
290 GET_PROP(queryArray
)->is_ref
= 1;
291 GET_PROP(queryString
)->is_ref
= 1;
294 http_querystring_modify(GET_PROP(queryArray
), params
);
296 http_querystring_update(GET_PROP(queryArray
), GET_PROP(queryString
));
299 qarray
= ecalloc(1, sizeof(zval
));
302 SET_PROP(queryArray
, qarray
);
303 UPD_STRL(queryString
, "", 0);
305 if (params
&& http_querystring_modify(qarray
, params
)) {
306 http_querystring_update(qarray
, GET_PROP(queryString
));
314 /* {{{ proto string HttpQueryString::toString()
316 * Returns the string representation.
318 PHP_METHOD(HttpQueryString
, toString
)
321 RETURN_PROP(queryString
);
325 /* {{{ proto array HttpQueryString::toArray()
327 * Returns the array representation.
329 PHP_METHOD(HttpQueryString
, toArray
)
332 RETURN_PROP(queryArray
);
336 /* {{{ proto mixed HttpQueryString::get([string key[, mixed type = 0[, mixed defval = NULL[, bool delete = false]]]])
338 * Get (part of) the query string.
340 * The type parameter is either one of the HttpQueryString::TYPE_* constants or a type abbreviation like
341 * "b" for bool, "i" for int, "f" for float, "s" for string, "a" for array and "o" for a stdClass object.
343 PHP_METHOD(HttpQueryString
, get
)
349 zval
*ztype
= NULL
, *defval
= NULL
;
351 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|szzb", &name
, &name_len
, &ztype
, &defval
, &del
)) {
352 if (name
&& name_len
) {
354 if (Z_TYPE_P(ztype
) == IS_LONG
) {
355 type
= Z_LVAL_P(ztype
);
356 } else if(Z_TYPE_P(ztype
) == IS_STRING
) {
357 switch (Z_STRVAL_P(ztype
)[0]) {
359 case 'b': type
= HTTP_QUERYSTRING_TYPE_BOOL
; break;
361 case 'i': type
= HTTP_QUERYSTRING_TYPE_INT
; break;
363 case 'f': type
= HTTP_QUERYSTRING_TYPE_FLOAT
; break;
365 case 's': type
= HTTP_QUERYSTRING_TYPE_STRING
; break;
367 case 'a': type
= HTTP_QUERYSTRING_TYPE_ARRAY
; break;
369 case 'o': type
= HTTP_QUERYSTRING_TYPE_OBJECT
; break;
373 http_querystring_get(getThis(), type
, name
, name_len
, defval
, del
, return_value
);
375 RETURN_PROP(queryString
);
381 /* {{{ proto string HttpQueryString::set(mixed params)
383 * Set query string entry/entries. NULL values will unset the variable.
385 PHP_METHOD(HttpQueryString
, set
)
389 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", ¶ms
)) {
390 zval
*qarray
= GET_PROP(queryArray
);
391 if (http_querystring_modify(qarray
, params
)) {
392 http_querystring_update(qarray
, GET_PROP(queryString
));
396 if (return_value_used
) {
397 RETURN_PROP(queryString
);
402 /* {{{ proto HttpQueryString HttpQueryString::mod(mixed params)
404 * Copies the query string object and sets provided params at the clone.
405 * This is basically shorthand for:
408 * $newQS = new HttpQueryString(false, $oldQS);
409 * $newQS->set($other_params);
413 PHP_METHOD(HttpQueryString
, mod
)
415 zval
*orig
, *zobj
, *qarr
, *qstr
, *params
;
417 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", ¶ms
)) {
418 zobj
= http_querystring_instantiate(0);
419 orig
= GET_PROP(queryArray
);
420 qarr
= GET_PROP_EX(zobj
, queryArray
);
421 qstr
= GET_PROP_EX(zobj
, queryString
);
423 http_querystring_modify(qarr
, orig
);
424 http_querystring_modify(qarr
, params
);
425 http_querystring_update(qarr
, qstr
);
427 RETURN_ZVAL(zobj
, 1, 1);
433 /* {{{ proto static HttpQueryString HttpQueryString::singleton([bool global = true])
435 * Get a single instance (differentiates between the global setting).
437 PHP_METHOD(HttpQueryString
, singleton
)
439 zend_bool global
= 1;
440 zval
*instance
= GET_STATIC_PROP(instance
);
443 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "|b", &global
)) {
444 zval
**zobj_ptr
= NULL
, *zobj
= NULL
;
446 if (Z_TYPE_P(instance
) == IS_ARRAY
) {
447 if (SUCCESS
== zend_hash_index_find(Z_ARRVAL_P(instance
), global
, (void *) &zobj_ptr
)) {
448 RETVAL_ZVAL(*zobj_ptr
, 1, 0);
450 zobj
= http_querystring_instantiate(global
);
451 add_index_zval(instance
, global
, zobj
);
452 RETVAL_OBJECT(zobj
, 1);
455 MAKE_STD_ZVAL(instance
);
456 array_init(instance
);
458 zobj
= http_querystring_instantiate(global
);
459 add_index_zval(instance
, global
, zobj
);
460 RETVAL_OBJECT(zobj
, 1);
462 SET_STATIC_PROP(instance
, instance
);
463 zval_ptr_dtor(&instance
);
471 /* {{{ Getters by type */
472 #define HTTP_QUERYSTRING_GETTER(method, TYPE) \
473 PHP_METHOD(HttpQueryString, method) \
477 zval *defval = NULL; \
479 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|zb", &name, &name_len, &defval, &del)) { \
480 http_querystring_get(getThis(), TYPE, name, name_len, defval, del, return_value); \
483 HTTP_QUERYSTRING_GETTER(getBool
, IS_BOOL
);
484 HTTP_QUERYSTRING_GETTER(getInt
, IS_LONG
);
485 HTTP_QUERYSTRING_GETTER(getFloat
, IS_DOUBLE
);
486 HTTP_QUERYSTRING_GETTER(getString
, IS_STRING
);
487 HTTP_QUERYSTRING_GETTER(getArray
, IS_ARRAY
);
488 HTTP_QUERYSTRING_GETTER(getObject
, IS_OBJECT
);
491 #ifdef HTTP_HAVE_ICONV
492 /* {{{ proto bool HttpQueryString::xlate(string ie, string oe)
494 * Converts the query string from the source encoding ie to the target encoding oe.
495 * WARNING: Don't use any character set that can contain NUL bytes like UTF-16.
497 * Returns TRUE on success or FALSE on failure.
499 PHP_METHOD(HttpQueryString
, xlate
)
506 if (SUCCESS
!= zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "ss", &ie
, &ie_len
, &oe
, &oe_len
)) {
510 qa
= GET_PROP(queryArray
);
511 qs
= GET_PROP(queryString
);
515 if (SUCCESS
== (rs
= http_querystring_xlate(&xa
, qa
, ie
, oe
))) {
516 zend_hash_clean(Z_ARRVAL_P(qa
));
517 zend_hash_copy(Z_ARRVAL_P(qa
), Z_ARRVAL(xa
), (copy_ctor_func_t
) zval_add_ref
, NULL
, sizeof(zval
*));
518 http_querystring_update(qa
, qs
);
525 #endif /* HAVE_ICONV */
527 /* {{{ proto string HttpQueryString::serialize()
529 * Implements Serializable.
531 PHP_METHOD(HttpQueryString
, serialize
)
534 RETURN_PROP(queryString
);
538 /* {{{ proto void HttpQueryString::unserialize(string serialized)
540 * Implements Serializable.
542 PHP_METHOD(HttpQueryString
, unserialize
)
547 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "z", &serialized
)) {
548 if (Z_TYPE_P(serialized
) == IS_STRING
) {
549 zval
*qa
= GET_PROP(queryArray
);
551 zend_hash_clean(Z_ARRVAL_P(qa
));
552 http_querystring_modify(qa
, serialized
);
553 http_querystring_update(qa
, GET_PROP(queryString
));
555 http_error(HE_WARNING
, HTTP_E_QUERYSTRING
, "Expected a string as parameter");
562 /* {{{ proto mixed HttpQueryString::offsetGet(string offset)
564 * Implements ArrayAccess.
566 PHP_METHOD(HttpQueryString
, offsetGet
)
572 if ( (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &offset_str
, &offset_len
)) &&
573 (SUCCESS
== zend_hash_find(Z_ARRVAL_P(GET_PROP(queryArray
)), offset_str
, offset_len
+ 1, (void *) &value
))) {
574 RETVAL_ZVAL(*value
, 1, 0);
579 /* {{{ proto void HttpQueryString::offsetSet(string offset, mixed value)
581 * Implements ArrayAccess.
583 PHP_METHOD(HttpQueryString
, offsetSet
)
589 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "sz", &offset_str
, &offset_len
, &value
)) {
590 zval
*qarr
= GET_PROP(queryArray
), *qstr
= GET_PROP(queryString
);
593 add_assoc_zval_ex(qarr
, offset_str
, offset_len
+ 1, value
);
594 http_querystring_update(qarr
, qstr
);
599 /* {{{ proto bool HttpQueryString::offsetExists(string offset)
601 * Implements ArrayAccess.
603 PHP_METHOD(HttpQueryString
, offsetExists
)
609 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &offset_str
, &offset_len
)) {
610 RETURN_BOOL((SUCCESS
== zend_hash_find(Z_ARRVAL_P(GET_PROP(queryArray
)), offset_str
, offset_len
+ 1, (void *) &value
)) && (Z_TYPE_PP(value
) != IS_NULL
));
615 /* {{{ proto void HttpQueryString::offsetUnset(string offset)
617 * Implements ArrayAccess.
619 PHP_METHOD(HttpQueryString
, offsetUnset
)
624 if (SUCCESS
== zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC
, "s", &offset_str
, &offset_len
)) {
625 zval
*qarr
= GET_PROP(queryArray
);
627 if (SUCCESS
== zend_hash_del(Z_ARRVAL_P(qarr
), offset_str
, offset_len
+ 1)) {
628 http_querystring_update(qarr
, GET_PROP(queryString
));
634 #endif /* ZEND_ENGINE_2 */
641 * vim600: noet sw=4 ts=4 fdm=marker
642 * vim<600: noet sw=4 ts=4