projects / m6w6 / ext-http / blob
? search:


fc17c4377092df3e78a9abd88934546a3348265e
[m6w6/ext-http] / http_querystring_object.c
1 /*
2 +--------------------------------------------------------------------+
3 | PECL :: http |
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 +--------------------------------------------------------------------+
11 */
12
13 /* $Id$ */
14
15 #define HTTP_WANT_SAPI
16 #include "php_http.h"
17
18 #ifdef ZEND_ENGINE_2
19
20 #include "php_variables.h"
21 #include "zend_interfaces.h"
22
23 #include "php_http_api.h"
24 #include "php_http_url_api.h"
25 #include "php_http_querystring_object.h"
26 #include "php_http_exception_object.h"
27
28 #define HTTP_BEGIN_ARGS(method, ret_ref, req_args) HTTP_BEGIN_ARGS_EX(HttpQueryString, method, ret_ref, req_args)
29 #define HTTP_EMPTY_ARGS(method, ret_ref) HTTP_EMPTY_ARGS_EX(HttpQueryString, method, ret_ref)
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)
32
33 HTTP_BEGIN_ARGS(__construct, 0, 0)
34 HTTP_ARG_VAL(global, 0)
35 HTTP_ARG_VAL(params, 0)
36 HTTP_END_ARGS;
37
38 HTTP_BEGIN_ARGS(getInstance, 0, 0)
39 HTTP_ARG_VAL(global, 0)
40 HTTP_END_ARGS;
41
42 HTTP_EMPTY_ARGS(toArray, 0);
43 HTTP_EMPTY_ARGS(toString, 0);
44
45 HTTP_BEGIN_ARGS(get, 0, 0)
46 HTTP_ARG_VAL(name, 0)
47 HTTP_ARG_VAL(type, 0)
48 HTTP_ARG_VAL(defval, 0)
49 HTTP_ARG_VAL(delete, 0)
50 HTTP_END_ARGS;
51
52 HTTP_BEGIN_ARGS(set, 0, 2)
53 HTTP_ARG_VAL(name, 0)
54 HTTP_ARG_VAL(value, 0)
55 HTTP_END_ARGS;
56
57 HTTP_BEGIN_ARGS(__getter, 0, 1)
58 HTTP_ARG_VAL(name, 0)
59 HTTP_ARG_VAL(defval, 0)
60 HTTP_ARG_VAL(delete, 0)
61 HTTP_END_ARGS;
62
63 #define http_querystring_object_declare_default_properties() _http_querystring_object_declare_default_properties(TSRMLS_C)
64 static inline void _http_querystring_object_declare_default_properties(TSRMLS_D);
65
66 #define GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(http_querystring_object_ce, n)
67 #define SET_STATIC_PROP(n, v) SET_STATIC_PROP_EX(http_querystring_object_ce, n, v)
68 #define OBJ_PROP_CE http_querystring_object_ce
69 zend_class_entry *http_querystring_object_ce;
70 zend_function_entry http_querystring_object_fe[] = {
71 HTTP_QUERYSTRING_ME(__construct, ZEND_ACC_PUBLIC|ZEND_ACC_CTOR|ZEND_ACC_FINAL)
72
73 HTTP_QUERYSTRING_ME(toArray, ZEND_ACC_PUBLIC)
74 HTTP_QUERYSTRING_ME(toString, ZEND_ACC_PUBLIC)
75 ZEND_MALIAS(HttpQueryString, __toString, toString, HTTP_ARGS(HttpQueryString, toString), ZEND_ACC_PUBLIC)
76
77 HTTP_QUERYSTRING_ME(get, ZEND_ACC_PUBLIC)
78 HTTP_QUERYSTRING_ME(set, ZEND_ACC_PUBLIC)
79
80 HTTP_QUERYSTRING_ME(getInstance, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC)
81
82 HTTP_QUERYSTRING_GME(getBool, ZEND_ACC_PUBLIC)
83 HTTP_QUERYSTRING_GME(getInt, ZEND_ACC_PUBLIC)
84 HTTP_QUERYSTRING_GME(getFloat, ZEND_ACC_PUBLIC)
85 HTTP_QUERYSTRING_GME(getString, ZEND_ACC_PUBLIC)
86 HTTP_QUERYSTRING_GME(getArray, ZEND_ACC_PUBLIC)
87 HTTP_QUERYSTRING_GME(getObject, ZEND_ACC_PUBLIC)
88
89 EMPTY_FUNCTION_ENTRY
90 };
91 static zend_object_handlers http_querystring_object_handlers;
92
93 PHP_MINIT_FUNCTION(http_querystring_object)
94 {
95 HTTP_REGISTER_CLASS_EX(HttpQueryString, http_querystring_object, NULL, 0);
96
97 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_BOOL", HTTP_QUERYSTRING_TYPE_BOOL);
98 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_INT", HTTP_QUERYSTRING_TYPE_INT);
99 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_FLOAT", HTTP_QUERYSTRING_TYPE_FLOAT);
100 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_STRING", HTTP_QUERYSTRING_TYPE_STRING);
101 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_ARRAY", HTTP_QUERYSTRING_TYPE_ARRAY);
102 HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_OBJECT", HTTP_QUERYSTRING_TYPE_OBJECT);
103
104 return SUCCESS;
105 }
106
107 zend_object_value _http_querystring_object_new(zend_class_entry *ce TSRMLS_DC)
108 {
109 return http_querystring_object_new_ex(ce, NULL);
110 }
111
112 zend_object_value _http_querystring_object_new_ex(zend_class_entry *ce, http_querystring_object **ptr TSRMLS_DC)
113 {
114 zend_object_value ov;
115 http_querystring_object *o;
116
117 o = ecalloc(1, sizeof(http_querystring_object));
118 o->zo.ce = ce;
119
120 if (ptr) {
121 *ptr = o;
122 }
123
124 ALLOC_HASHTABLE(OBJ_PROP(o));
125 zend_hash_init(OBJ_PROP(o), 0, NULL, ZVAL_PTR_DTOR, 0);
126 zend_hash_copy(OBJ_PROP(o), &ce->default_properties, (copy_ctor_func_t) zval_add_ref, NULL, sizeof(zval *));
127
128 ov.handle = putObject(http_querystring_object, o);
129 ov.handlers = &http_querystring_object_handlers;
130
131 return ov;
132 }
133
134 static inline void _http_querystring_object_declare_default_properties(TSRMLS_D)
135 {
136 zend_class_entry *ce = http_querystring_object_ce;
137
138 DCL_STATIC_PROP_N(PRIVATE, instance);
139
140 DCL_PROP_N(PRIVATE, queryArray);
141 DCL_PROP(PRIVATE, string, queryString, "");
142
143 #ifndef WONKY
144 DCL_CONST(long, "TYPE_BOOL", HTTP_QUERYSTRING_TYPE_BOOL);
145 DCL_CONST(long, "TYPE_INT", HTTP_QUERYSTRING_TYPE_INT);
146 DCL_CONST(long, "TYPE_FLOAT", HTTP_QUERYSTRING_TYPE_FLOAT);
147 DCL_CONST(long, "TYPE_STRING", HTTP_QUERYSTRING_TYPE_STRING);
148 DCL_CONST(long, "TYPE_ARRAY", HTTP_QUERYSTRING_TYPE_ARRAY);
149 DCL_CONST(long, "TYPE_OBJECT", HTTP_QUERYSTRING_TYPE_OBJECT);
150 #endif
151 }
152
153 void _http_querystring_object_free(zend_object *object TSRMLS_DC)
154 {
155 http_querystring_object *o = (http_querystring_object *) object;
156
157 if (OBJ_PROP(o)) {
158 zend_hash_destroy(OBJ_PROP(o));
159 FREE_HASHTABLE(OBJ_PROP(o));
160 }
161 efree(o);
162 }
163
164 #define http_querystring_update(qa, qs) _http_querystring_update((qa), (qs) TSRMLS_CC)
165 static inline void _http_querystring_update(zval *qarray, zval *qstring TSRMLS_DC)
166 {
167 char *s = NULL;
168 size_t l = 0;
169
170 if (Z_TYPE_P(qarray) != IS_ARRAY) {
171 convert_to_array(qarray);
172 }
173 if (SUCCESS == http_urlencode_hash_ex(Z_ARRVAL_P(qarray), 0, NULL, 0, &s, &l)) {
174 zval_dtor(qstring);
175 ZVAL_STRINGL(qstring, s, l, 0);
176 } else {
177 http_error(HE_WARNING, HTTP_E_QUERYSTRING, "Failed to update query string");
178 }
179 }
180
181 #define http_querystring_modify_ex(a, k, l, v) _http_querystring_modify_ex((a), (k), (l), (v) TSRMLS_CC)
182 static inline int _http_querystring_modify_ex(zval *qarray, char *key, uint keylen, zval *data TSRMLS_DC)
183 {
184 if (Z_TYPE_P(data) == IS_NULL) {
185 if (SUCCESS != zend_hash_del(Z_ARRVAL_P(qarray), key, keylen)) {
186 return 0;
187 }
188 } else {
189 ZVAL_ADDREF(data);
190 add_assoc_zval(qarray, key, data);
191 }
192 return 1;
193 }
194
195 #define http_querystring_modify_array(q, a) _http_querystring_modify_array((q), (a) TSRMLS_CC)
196 static inline int _http_querystring_modify_array(zval *qarray, zval *array TSRMLS_DC)
197 {
198 zval **value;
199 HashPosition pos;
200 char *key = NULL;
201 uint keylen = 0;
202 ulong idx = 0;
203 int rv = 0;
204
205 FOREACH_KEYLENVAL(pos, array, key, keylen, idx, value) {
206 if (key) {
207 if (http_querystring_modify_ex(qarray, key, keylen, *value)) {
208 rv = 1;
209 }
210 } else {
211 keylen = spprintf(&key, 0, "%lu", idx);
212 if (http_querystring_modify_ex(qarray, key, keylen, *value)) {
213 rv = 1;
214 }
215 efree(key);
216 }
217 key = NULL;
218 }
219
220 return rv;
221 }
222
223 #define http_querystring_modify(q, p) _http_querystring_modify((q), (p) TSRMLS_CC)
224 static inline int _http_querystring_modify(zval *qarray, zval *params TSRMLS_DC)
225 {
226 if (Z_TYPE_P(params) == IS_ARRAY) {
227 return http_querystring_modify_array(qarray, params);
228 } else {
229 int rv;
230 zval array;
231
232 INIT_PZVAL(&array);
233 array_init(&array);
234
235 ZVAL_ADDREF(params);
236 convert_to_string_ex(&params);
237 sapi_module.treat_data(PARSE_STRING, estrdup(Z_STRVAL_P(params)), &array TSRMLS_CC);
238 zval_ptr_dtor(&params);
239 rv = http_querystring_modify_array(qarray, &array);
240 zval_dtor(&array);
241 return rv;
242 }
243 }
244
245 #define http_querystring_instantiate(g) _http_querystring_instantiate((g) TSRMLS_CC)
246 static inline zval *_http_querystring_instantiate(zend_bool global TSRMLS_DC)
247 {
248 zval *zobj, *zglobal;
249
250 MAKE_STD_ZVAL(zglobal);
251 ZVAL_BOOL(zglobal, global);
252
253 MAKE_STD_ZVAL(zobj);
254 Z_TYPE_P(zobj) = IS_OBJECT;
255 Z_OBJVAL_P(zobj) = http_querystring_object_new(http_querystring_object_ce);
256 zend_call_method_with_1_params(&zobj, Z_OBJCE_P(zobj), NULL, "__construct", NULL, zglobal);
257
258 zval_ptr_dtor(&zglobal);
259
260 return zobj;
261 }
262
263 #define http_querystring_get(o, t, n, l, def, del, r) _http_querystring_get((o), (t), (n), (l), (def), (del), (r) TSRMLS_CC)
264 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)
265 {
266 zval **arrval, *qarray = GET_PROP(queryArray);
267
268 if ((Z_TYPE_P(qarray) == IS_ARRAY) && (SUCCESS == zend_hash_find(Z_ARRVAL_P(qarray), name, name_len + 1, (void **) &arrval))) {
269 RETVAL_ZVAL(*arrval, 1, 0);
270
271 if (type) {
272 convert_to_type(type, return_value);
273 }
274
275 if (del && (SUCCESS == zend_hash_del(Z_ARRVAL_P(qarray), name, name_len + 1))) {
276 http_querystring_update(qarray, GET_PROP(queryString));
277 }
278 } else if(defval) {
279 RETURN_ZVAL(defval, 1, 0);
280 }
281 }
282
283 /* {{{ proto void HttpQueryString::__construct([bool global = true[, mixed add])
284 *
285 * Creates a new HttpQueryString object instance.
286 * Operates on and modifies $_GET and $_SERVER['QUERY_STRING'] if global is TRUE.
287 */
288 PHP_METHOD(HttpQueryString, __construct)
289 {
290 zend_bool global = 1;
291 zval *params = NULL, *qarray = NULL, *qstring = NULL, **_GET, **_SERVER, **QUERY_STRING;
292
293 SET_EH_THROW_HTTP();
294 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|bz", &global, &params)) {
295 if (global) {
296 if ( (SUCCESS == zend_hash_find(&EG(symbol_table), "_SERVER", sizeof("_SERVER"), (void **) &_SERVER)) &&
297 (Z_TYPE_PP(_SERVER) == IS_ARRAY) &&
298 (SUCCESS == zend_hash_find(Z_ARRVAL_PP(_SERVER), "QUERY_STRING", sizeof("QUERY_STRING"), (void **) &QUERY_STRING))) {
299
300 qstring = *QUERY_STRING;
301
302 if ((SUCCESS == zend_hash_find(&EG(symbol_table), "_GET", sizeof("_GET"), (void **) &_GET)) && (Z_TYPE_PP(_GET) == IS_ARRAY)) {
303 qarray = *_GET;
304 } else {
305 http_error(HE_WARNING, HTTP_E_QUERYSTRING, "Could not acquire reference to superglobal GET array");
306 }
307 } else {
308 http_error(HE_WARNING, HTTP_E_QUERYSTRING, "Could not acquire reference to QUERY_STRING");
309 }
310
311 if (qarray && qstring) {
312 if (Z_TYPE_P(qstring) != IS_STRING) {
313 convert_to_string(qstring);
314 }
315
316 SET_PROP(queryArray, qarray);
317 SET_PROP(queryString, qstring);
318 GET_PROP(queryArray)->is_ref = 1;
319 GET_PROP(queryString)->is_ref = 1;
320
321 if (params && http_querystring_modify(GET_PROP(queryArray), params)) {
322 http_querystring_update(GET_PROP(queryArray), GET_PROP(queryString));
323 }
324 }
325 } else {
326 qarray = ecalloc(1, sizeof(zval));
327 array_init(qarray);
328
329 SET_PROP(queryArray, qarray);
330 UPD_STRL(queryString, "", 0);
331
332 if (params && http_querystring_modify(qarray, params)) {
333 http_querystring_update(qarray, GET_PROP(queryString));
334 }
335 }
336 }
337 SET_EH_NORMAL();
338 }
339 /* }}} */
340
341 /* {{{ proto string HttpQueryString::toString()
342 *
343 * Returns the string representation.
344 */
345 PHP_METHOD(HttpQueryString, toString)
346 {
347 NO_ARGS;
348 RETURN_PROP(queryString);
349 }
350 /* }}} */
351
352 /* {{{ proto array HttpQueryString::toArray()
353 *
354 * Returns the array representation.
355 */
356 PHP_METHOD(HttpQueryString, toArray)
357 {
358 NO_ARGS;
359 RETURN_PROP(queryArray);
360 }
361 /* }}} */
362
363 /* {{{ proto mixed HttpQueryString::get([string key[, mixed type = 0[, mixed defval = NULL[, bool delete = false]]]])
364 *
365 * Get (part of) the query string.
366 *
367 * The type parameter is either one of the HttpQueryString::TYPE_* constants or a type abbreviation like
368 * "b" for bool, "i" for int, "f" for float, "s" for string, "a" for array and "o" for a stdClass object.
369 */
370 PHP_METHOD(HttpQueryString, get)
371 {
372 char *name = NULL;
373 int name_len = 0;
374 long type = 0;
375 zend_bool del = 0;
376 zval *ztype = NULL, *defval = NULL;
377
378 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|szzb", &name, &name_len, &ztype, &defval, &del)) {
379 if (name && name_len) {
380 if (ztype) {
381 if (Z_TYPE_P(ztype) == IS_LONG) {
382 type = Z_LVAL_P(ztype);
383 } else if(Z_TYPE_P(ztype) == IS_STRING) {
384 switch (tolower(Z_STRVAL_P(ztype)[0]))
385 {
386 case 'b': type = HTTP_QUERYSTRING_TYPE_BOOL; break;
387 case 'i': type = HTTP_QUERYSTRING_TYPE_INT; break;
388 case 'f': type = HTTP_QUERYSTRING_TYPE_FLOAT; break;
389 case 's': type = HTTP_QUERYSTRING_TYPE_STRING; break;
390 case 'a': type = HTTP_QUERYSTRING_TYPE_ARRAY; break;
391 case 'o': type = HTTP_QUERYSTRING_TYPE_OBJECT; break;
392 }
393 }
394 }
395 http_querystring_get(getThis(), type, name, name_len, defval, del, return_value);
396 } else {
397 RETURN_PROP(queryString);
398 }
399 }
400 }
401 /* }}} */
402
403 /* {{{ proto string HttpQueryString::set(mixed params)
404 *
405 * Set query string entry/entries. NULL values will unset the variable.
406 */
407 PHP_METHOD(HttpQueryString, set)
408 {
409 zval *params;
410
411 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &params)) {
412 zval *qarray = GET_PROP(queryArray);
413 if (http_querystring_modify(qarray, params)) {
414 http_querystring_update(qarray, GET_PROP(queryString));
415 }
416 }
417
418 IF_RETVAL_USED {
419 RETURN_PROP(queryString);
420 }
421 }
422 /* }}} */
423
424 /* {{{ proto HttpQueryString HttpQueryString::getInstance([bool global = true])
425 *
426 * Get a single instance (differentiates between the global setting).
427 */
428 PHP_METHOD(HttpQueryString, getInstance)
429 {
430 zend_bool global = 1;
431 zval *instance = GET_STATIC_PROP(instance);
432
433 SET_EH_THROW_HTTP();
434 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "|b", &global)) {
435 zval **zobj_ptr = NULL, *zobj = NULL;
436
437 if (Z_TYPE_P(instance) == IS_ARRAY) {
438 if (SUCCESS == zend_hash_index_find(Z_ARRVAL_P(instance), global, (void **) &zobj_ptr)) {
439 RETVAL_ZVAL(*zobj_ptr, 1, 0);
440 } else {
441 zobj = http_querystring_instantiate(global);
442 add_index_zval(instance, global, zobj);
443 RETVAL_OBJECT(zobj, 1);
444 }
445 } else {
446 MAKE_STD_ZVAL(instance);
447 array_init(instance);
448
449 zobj = http_querystring_instantiate(global);
450 add_index_zval(instance, global, zobj);
451 RETVAL_OBJECT(zobj, 1);
452
453 SET_STATIC_PROP(instance, instance);
454 zval_ptr_dtor(&instance);
455 }
456 }
457 SET_EH_NORMAL();
458 }
459 /* }}} */
460
461 /* {{{ Getters by type */
462 #define HTTP_QUERYSTRING_GETTER(method, TYPE) \
463 PHP_METHOD(HttpQueryString, method) \
464 { \
465 char *name; \
466 int name_len; \
467 zval *defval = NULL; \
468 zend_bool del = 0; \
469 if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s|zb", &name, &name_len, &defval, &del)) { \
470 http_querystring_get(getThis(), TYPE, name, name_len, defval, del, return_value); \
471 } \
472 }
473 HTTP_QUERYSTRING_GETTER(getBool, IS_BOOL);
474 HTTP_QUERYSTRING_GETTER(getInt, IS_LONG);
475 HTTP_QUERYSTRING_GETTER(getFloat, IS_DOUBLE);
476 HTTP_QUERYSTRING_GETTER(getString, IS_STRING);
477 HTTP_QUERYSTRING_GETTER(getArray, IS_ARRAY);
478 HTTP_QUERYSTRING_GETTER(getObject, IS_OBJECT);
479 /* }}} */
480
481 #endif /* ZEND_ENGINE_2 */
482
483 /*
484 * Local variables:
485 * tab-width: 4
486 * c-basic-offset: 4
487 * End:
488 * vim600: noet sw=4 ts=4 fdm=marker
489 * vim<600: noet sw=4 ts=4
490 */
491
Extended HTTP Support