- rename HttpQueryString::getInstance() to HttpQueryString::singleton()
[m6w6/ext-http] / http_querystring_object.c
index e026052e3c3394cb5c87c5c0f2f133b85276c6ef..79f1b64a612d1b1069fe2d06b639a9d2b72831cf 100644 (file)
 #include "php_variables.h"
 #include "zend_interfaces.h"
 
+#ifdef HAVE_ICONV
+#      include "ext/standard/url.h"
+#      include "ext/iconv/php_iconv.h"
+#endif
+
 #include "php_http_api.h"
 #include "php_http_url_api.h"
 #include "php_http_querystring_object.h"
 #include "php_http_exception_object.h"
 
-#define HTTP_BEGIN_ARGS(method, ret_ref, req_args)     HTTP_BEGIN_ARGS_EX(HttpQueryString, method, ret_ref, req_args)
-#define HTTP_EMPTY_ARGS(method, ret_ref)                       HTTP_EMPTY_ARGS_EX(HttpQueryString, method, ret_ref)
+#define HTTP_BEGIN_ARGS(method, req_args)                      HTTP_BEGIN_ARGS_EX(HttpQueryString, method, 0, req_args)
+#define HTTP_EMPTY_ARGS(method)                                                HTTP_EMPTY_ARGS_EX(HttpQueryString, method, 0)
 #define HTTP_QUERYSTRING_ME(method, visibility)                PHP_ME(HttpQueryString, method, HTTP_ARGS(HttpQueryString, method), visibility)
 #define HTTP_QUERYSTRING_GME(method, visibility)       PHP_ME(HttpQueryString, method, HTTP_ARGS(HttpQueryString, __getter), visibility)
 
-HTTP_BEGIN_ARGS(__construct, 0, 0)
+HTTP_BEGIN_ARGS(__construct, 0)
        HTTP_ARG_VAL(global, 0)
        HTTP_ARG_VAL(params, 0)
 HTTP_END_ARGS;
 
-HTTP_BEGIN_ARGS(getInstance, 0, 0)
+#ifndef WONKY
+HTTP_BEGIN_ARGS(singleton, 0)
        HTTP_ARG_VAL(global, 0)
 HTTP_END_ARGS;
+#endif
 
-HTTP_EMPTY_ARGS(toArray, 0);
-HTTP_EMPTY_ARGS(toString, 0);
+HTTP_EMPTY_ARGS(toArray);
+HTTP_EMPTY_ARGS(toString);
 
-HTTP_BEGIN_ARGS(get, 0, 0)
+HTTP_BEGIN_ARGS(get, 0)
        HTTP_ARG_VAL(name, 0)
        HTTP_ARG_VAL(type, 0)
        HTTP_ARG_VAL(defval, 0)
        HTTP_ARG_VAL(delete, 0)
 HTTP_END_ARGS;
 
-HTTP_BEGIN_ARGS(set, 0, 1)
+HTTP_BEGIN_ARGS(set, 1)
        HTTP_ARG_VAL(params, 0)
 HTTP_END_ARGS;
 
-HTTP_BEGIN_ARGS(__getter, 0, 1)
+HTTP_BEGIN_ARGS(__getter, 1)
        HTTP_ARG_VAL(name, 0)
        HTTP_ARG_VAL(defval, 0)
        HTTP_ARG_VAL(delete, 0)
 HTTP_END_ARGS;
 
-#define http_querystring_object_declare_default_properties() _http_querystring_object_declare_default_properties(TSRMLS_C)
-static inline void _http_querystring_object_declare_default_properties(TSRMLS_D);
+#ifdef HAVE_ICONV
+HTTP_BEGIN_ARGS(xlate, 2)
+       HTTP_ARG_VAL(from_encoding, 0)
+       HTTP_ARG_VAL(to_encoding, 0)
+HTTP_END_ARGS;
+#endif
+
+HTTP_EMPTY_ARGS(serialize);
+HTTP_BEGIN_ARGS(unserialize, 1)
+       HTTP_ARG_VAL(serialized, 0)
+HTTP_END_ARGS;
 
-#define GET_STATIC_PROP(n) *GET_STATIC_PROP_EX(http_querystring_object_ce, n)
-#define SET_STATIC_PROP(n, v) SET_STATIC_PROP_EX(http_querystring_object_ce, n, v)
 #define OBJ_PROP_CE http_querystring_object_ce
 zend_class_entry *http_querystring_object_ce;
 zend_function_entry http_querystring_object_fe[] = {
@@ -76,8 +90,6 @@ zend_function_entry http_querystring_object_fe[] = {
        HTTP_QUERYSTRING_ME(get, ZEND_ACC_PUBLIC)
        HTTP_QUERYSTRING_ME(set, ZEND_ACC_PUBLIC)
        
-       HTTP_QUERYSTRING_ME(getInstance, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC)
-       
        HTTP_QUERYSTRING_GME(getBool, ZEND_ACC_PUBLIC)
        HTTP_QUERYSTRING_GME(getInt, ZEND_ACC_PUBLIC)
        HTTP_QUERYSTRING_GME(getFloat, ZEND_ACC_PUBLIC)
@@ -85,6 +97,17 @@ zend_function_entry http_querystring_object_fe[] = {
        HTTP_QUERYSTRING_GME(getArray, ZEND_ACC_PUBLIC)
        HTTP_QUERYSTRING_GME(getObject, ZEND_ACC_PUBLIC)
        
+#ifndef WONKY
+       HTTP_QUERYSTRING_ME(singleton, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC)
+#endif
+#ifdef HAVE_ICONV
+       HTTP_QUERYSTRING_ME(xlate, ZEND_ACC_PUBLIC)
+#endif
+       
+       /* Implements Serializable */
+       HTTP_QUERYSTRING_ME(serialize, ZEND_ACC_PUBLIC)
+       HTTP_QUERYSTRING_ME(unserialize, ZEND_ACC_PUBLIC)
+       
        EMPTY_FUNCTION_ENTRY
 };
 static zend_object_handlers http_querystring_object_handlers;
@@ -93,6 +116,23 @@ PHP_MINIT_FUNCTION(http_querystring_object)
 {
        HTTP_REGISTER_CLASS_EX(HttpQueryString, http_querystring_object, NULL, 0);
        
+#ifndef WONKY
+       zend_class_implements(http_querystring_object_ce TSRMLS_CC, 1, zend_ce_serializable);
+#endif
+       
+       DCL_STATIC_PROP_N(PRIVATE, instance);
+       DCL_PROP_N(PRIVATE, queryArray);
+       DCL_PROP(PRIVATE, string, queryString, "");
+       
+#ifndef WONKY
+       DCL_CONST(long, "TYPE_BOOL", HTTP_QUERYSTRING_TYPE_BOOL);
+       DCL_CONST(long, "TYPE_INT", HTTP_QUERYSTRING_TYPE_INT);
+       DCL_CONST(long, "TYPE_FLOAT", HTTP_QUERYSTRING_TYPE_FLOAT);
+       DCL_CONST(long, "TYPE_STRING", HTTP_QUERYSTRING_TYPE_STRING);
+       DCL_CONST(long, "TYPE_ARRAY", HTTP_QUERYSTRING_TYPE_ARRAY);
+       DCL_CONST(long, "TYPE_OBJECT", HTTP_QUERYSTRING_TYPE_OBJECT);
+#endif
+       
        HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_BOOL", HTTP_QUERYSTRING_TYPE_BOOL);
        HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_INT", HTTP_QUERYSTRING_TYPE_INT);
        HTTP_LONG_CONSTANT("HTTP_QUERYSTRING_TYPE_FLOAT", HTTP_QUERYSTRING_TYPE_FLOAT);
@@ -130,25 +170,6 @@ zend_object_value _http_querystring_object_new_ex(zend_class_entry *ce, http_que
        return ov;
 }
 
-static inline void _http_querystring_object_declare_default_properties(TSRMLS_D)
-{
-       zend_class_entry *ce = http_querystring_object_ce;
-
-       DCL_STATIC_PROP_N(PRIVATE, instance);
-       
-       DCL_PROP_N(PRIVATE, queryArray);
-       DCL_PROP(PRIVATE, string, queryString, "");
-       
-#ifndef WONKY
-       DCL_CONST(long, "TYPE_BOOL", HTTP_QUERYSTRING_TYPE_BOOL);
-       DCL_CONST(long, "TYPE_INT", HTTP_QUERYSTRING_TYPE_INT);
-       DCL_CONST(long, "TYPE_FLOAT", HTTP_QUERYSTRING_TYPE_FLOAT);
-       DCL_CONST(long, "TYPE_STRING", HTTP_QUERYSTRING_TYPE_STRING);
-       DCL_CONST(long, "TYPE_ARRAY", HTTP_QUERYSTRING_TYPE_ARRAY);
-       DCL_CONST(long, "TYPE_OBJECT", HTTP_QUERYSTRING_TYPE_OBJECT);
-#endif
-}
-
 void _http_querystring_object_free(zend_object *object TSRMLS_DC)
 {
        http_querystring_object *o = (http_querystring_object *) object;
@@ -160,7 +181,36 @@ void _http_querystring_object_free(zend_object *object TSRMLS_DC)
        efree(o);
 }
 
+/* {{{ querystring helpers */
 #define http_querystring_update(qa, qs) _http_querystring_update((qa), (qs) TSRMLS_CC)
+static inline void _http_querystring_update(zval *qarray, zval *qstring TSRMLS_DC);
+#define http_querystring_modify_array_ex(q, k, kl, pe) _http_querystring_modify_array_ex((q), (k), (kl), (pe) TSRMLS_CC)
+static inline int _http_querystring_modify_array_ex(zval *qarray, char *key, int keylen, zval *params_entry TSRMLS_DC);
+#define http_querystring_modify_array(q, p) _http_querystring_modify_array((q), (p) TSRMLS_CC)
+static inline int _http_querystring_modify_array(zval *qarray, zval *params TSRMLS_DC);
+#define http_querystring_modify(q, p) _http_querystring_modify((q), (p) TSRMLS_CC)
+static inline int _http_querystring_modify(zval *qarray, zval *params TSRMLS_DC);
+#define http_querystring_get(o, t, n, l, def, del, r) _http_querystring_get((o), (t), (n), (l), (def), (del), (r) TSRMLS_CC)
+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);
+#ifndef WONKY
+#define http_querystring_instantiate(g) _http_querystring_instantiate((g) TSRMLS_CC)
+static inline zval *_http_querystring_instantiate(zend_bool global TSRMLS_DC)
+{
+       zval *zobj, *zglobal;
+       
+       MAKE_STD_ZVAL(zglobal);
+       ZVAL_BOOL(zglobal, global);
+       
+       MAKE_STD_ZVAL(zobj);
+       Z_TYPE_P(zobj) = IS_OBJECT;
+       Z_OBJVAL_P(zobj) = http_querystring_object_new(http_querystring_object_ce);
+       zend_call_method_with_1_params(&zobj, Z_OBJCE_P(zobj), NULL, "__construct", NULL, zglobal);
+       
+       zval_ptr_dtor(&zglobal);
+       
+       return zobj;
+}
+#endif /* WONKY */
 static inline void _http_querystring_update(zval *qarray, zval *qstring TSRMLS_DC)
 {
        char *s = NULL;
@@ -176,39 +226,51 @@ static inline void _http_querystring_update(zval *qarray, zval *qstring TSRMLS_D
                http_error(HE_WARNING, HTTP_E_QUERYSTRING, "Failed to update query string");
        }
 }
-
-#define http_querystring_modify_ex(a, k, l, v) _http_querystring_modify_ex((a), (k), (l), (v) TSRMLS_CC)
-static inline int _http_querystring_modify_ex(zval *qarray, char *key, uint keylen, zval *data TSRMLS_DC)
+static inline int _http_querystring_modify_array_ex(zval *qarray, char *key, int keylen, zval *params_entry TSRMLS_DC)
 {
-       if (Z_TYPE_P(data) == IS_NULL) {
-               if (SUCCESS != zend_hash_del(Z_ARRVAL_P(qarray), key, keylen)) {
+       zval **qarray_entry;
+       
+       /* delete */
+       if (Z_TYPE_P(params_entry) == IS_NULL) {
+               return (SUCCESS == zend_hash_del(Z_ARRVAL_P(qarray), key, keylen));
+       }
+       
+       /* update */
+       if (SUCCESS == zend_hash_find(Z_ARRVAL_P(qarray), key, keylen, (void **) &qarray_entry)) {
+               zval equal;
+               
+               /* recursive */
+               if (Z_TYPE_P(params_entry) == IS_ARRAY) {
+                        return http_querystring_modify_array(*qarray_entry, params_entry);
+               }
+               /* equal */
+               if ((SUCCESS == is_equal_function(&equal, *qarray_entry, params_entry TSRMLS_CC)) && Z_BVAL(equal)) {
                        return 0;
                }
-       } else {
-               ZVAL_ADDREF(data);
-               add_assoc_zval(qarray, key, data);
        }
+       
+       /* add */
+       ZVAL_ADDREF(params_entry);
+       add_assoc_zval_ex(qarray, key, keylen, params_entry);
        return 1;
 }
-
-#define http_querystring_modify_array(q, a) _http_querystring_modify_array((q), (a) TSRMLS_CC)
-static inline int _http_querystring_modify_array(zval *qarray, zval *array TSRMLS_DC)
+static inline int _http_querystring_modify_array(zval *qarray, zval *params TSRMLS_DC)
 {
-       zval **value;
-       HashPosition pos;
-       char *key = NULL;
-       uint keylen = 0;
-       ulong idx = 0;
        int rv = 0;
-               
-       FOREACH_KEYLENVAL(pos, array, key, keylen, idx, value) {
+       char *key;
+       uint keylen;
+       ulong idx;
+       HashPosition pos;
+       zval **params_entry;
+       
+       FOREACH_KEYLENVAL(pos, params, key, keylen, idx, params_entry) {
                if (key) {
-                       if (http_querystring_modify_ex(qarray, key, keylen, *value)) {
+                       if (http_querystring_modify_array_ex(qarray, key, keylen, *params_entry)) {
                                rv = 1;
                        }
                } else {
                        keylen = spprintf(&key, 0, "%lu", idx);
-                       if (http_querystring_modify_ex(qarray, key, keylen, *value)) {
+                       if (http_querystring_modify_array_ex(qarray, key, keylen, *params_entry)) {
                                rv = 1;
                        }
                        efree(key);
@@ -218,14 +280,17 @@ static inline int _http_querystring_modify_array(zval *qarray, zval *array TSRML
        
        return rv;
 }
-
-#define http_querystring_modify(q, p) _http_querystring_modify((q), (p) TSRMLS_CC)
 static inline int _http_querystring_modify(zval *qarray, zval *params TSRMLS_DC)
 {
-       if ((Z_TYPE_P(params) == IS_OBJECT) && instanceof_function(Z_OBJCE_P(params), http_querystring_object_ce TSRMLS_CC)) {
-               return http_querystring_modify_array(qarray, GET_PROP_EX(params, queryArray));
-       } else if (Z_TYPE_P(params) == IS_ARRAY) {
+       if (Z_TYPE_P(params) == IS_ARRAY) {
                return http_querystring_modify_array(qarray, params);
+       } else if (Z_TYPE_P(params) == IS_OBJECT) {
+               if (!instanceof_function(Z_OBJCE_P(params), http_querystring_object_ce TSRMLS_CC)) {
+                       zval temp_array;
+                       INIT_ZARR(temp_array, HASH_OF(params));
+                       return http_querystring_modify_array(qarray, &temp_array);
+               }
+               return http_querystring_modify_array(qarray, GET_PROP_EX(params, queryArray));
        } else {
                int rv;
                zval array;
@@ -242,26 +307,6 @@ static inline int _http_querystring_modify(zval *qarray, zval *params TSRMLS_DC)
                return rv;
        }
 }
-
-#define http_querystring_instantiate(g) _http_querystring_instantiate((g) TSRMLS_CC)
-static inline zval *_http_querystring_instantiate(zend_bool global TSRMLS_DC)
-{
-       zval *zobj, *zglobal;
-       
-       MAKE_STD_ZVAL(zglobal);
-       ZVAL_BOOL(zglobal, global);
-       
-       MAKE_STD_ZVAL(zobj);
-       Z_TYPE_P(zobj) = IS_OBJECT;
-       Z_OBJVAL_P(zobj) = http_querystring_object_new(http_querystring_object_ce);
-       zend_call_method_with_1_params(&zobj, Z_OBJCE_P(zobj), NULL, "__construct", NULL, zglobal);
-       
-       zval_ptr_dtor(&zglobal);
-       
-       return zobj;
-}
-
-#define http_querystring_get(o, t, n, l, def, del, r) _http_querystring_get((o), (t), (n), (l), (def), (del), (r) TSRMLS_CC)
 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)
 {
        zval **arrval, *qarray = GET_PROP(queryArray);
@@ -280,8 +325,9 @@ static inline void _http_querystring_get(zval *this_ptr, int type, char *name, u
                RETURN_ZVAL(defval, 1, 0);
        }
 }
+/* }}} */
 
-/* {{{ proto void HttpQueryString::__construct([bool global = true[, mixed add])
+/* {{{ proto final void HttpQueryString::__construct([bool global = true[, mixed add])
  *
  * Creates a new HttpQueryString object instance.
  * Operates on and modifies $_GET and $_SERVER['QUERY_STRING'] if global is TRUE.
@@ -382,13 +428,19 @@ PHP_METHOD(HttpQueryString, get)
                                if (Z_TYPE_P(ztype) == IS_LONG) {
                                        type = Z_LVAL_P(ztype);
                                } else if(Z_TYPE_P(ztype) == IS_STRING) {
-                                       switch (tolower(Z_STRVAL_P(ztype)[0]))
+                                       switch (Z_STRVAL_P(ztype)[0])
                                        {
+                                               case 'B': 
                                                case 'b':       type = HTTP_QUERYSTRING_TYPE_BOOL;              break;
+                                               case 'I':
                                                case 'i':       type = HTTP_QUERYSTRING_TYPE_INT;               break;
+                                               case 'F':
                                                case 'f':       type = HTTP_QUERYSTRING_TYPE_FLOAT;             break;  
+                                               case 'S':
                                                case 's':       type = HTTP_QUERYSTRING_TYPE_STRING;    break;
+                                               case 'A':
                                                case 'a':       type = HTTP_QUERYSTRING_TYPE_ARRAY;             break;
+                                               case 'O':
                                                case 'o':       type = HTTP_QUERYSTRING_TYPE_OBJECT;    break;
                                        }
                                }
@@ -422,11 +474,12 @@ PHP_METHOD(HttpQueryString, set)
 }
 /* }}} */
 
-/* {{{ proto HttpQueryString HttpQueryString::getInstance([bool global = true])
+#ifndef WONKY
+/* {{{ proto HttpQueryString HttpQueryString::singleton([bool global = true])
  *
  * Get a single instance (differentiates between the global setting).
  */
-PHP_METHOD(HttpQueryString, getInstance)
+PHP_METHOD(HttpQueryString, singleton)
 {
        zend_bool global = 1;
        zval *instance = GET_STATIC_PROP(instance);
@@ -458,6 +511,7 @@ PHP_METHOD(HttpQueryString, getInstance)
        SET_EH_NORMAL();
 }
 /* }}} */
+#endif
 
 /* {{{ Getters by type */
 #define HTTP_QUERYSTRING_GETTER(method, TYPE) \
@@ -479,6 +533,77 @@ HTTP_QUERYSTRING_GETTER(getArray, IS_ARRAY);
 HTTP_QUERYSTRING_GETTER(getObject, IS_OBJECT);
 /* }}} */
 
+#ifdef HAVE_ICONV
+/* {{{ proto bool HttpQueryString::xlate(string ie, string oe)
+ *
+ * Converts the query string from the source encoding ie to the target encoding oe.
+ * WARNING: Don't use any character set that can contain NUL bytes like UTF-16.
+ *
+ * Returns TRUE on success or FALSE on failure.
+ */
+PHP_METHOD(HttpQueryString, xlate)
+{
+       char *ie, *oe, *er = NULL;
+       int ie_len, oe_len;
+       size_t er_len = 0;
+       zval *qa, *qs;
+       
+       if (SUCCESS != zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "ss", &ie, &ie_len, &oe, &oe_len)) {
+               RETURN_FALSE;
+       }
+       
+       qa = GET_PROP(queryArray);
+       qs = GET_PROP(queryString);
+       Z_STRLEN_P(qs) = php_url_decode(Z_STRVAL_P(qs), Z_STRLEN_P(qs));
+       if (PHP_ICONV_ERR_SUCCESS == php_iconv_string(Z_STRVAL_P(qs), (size_t) Z_STRLEN_P(qs), &er, &er_len, oe, ie)) {
+               efree(Z_STRVAL_P(qs));
+               ZVAL_STRINGL(qs, er, er_len, 0);
+               http_querystring_modify(qa, qs);
+               RETVAL_TRUE;
+       } else {
+               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);
+               RETVAL_FALSE;
+       }
+       http_querystring_update(qa, qs);
+}
+/* }}} */
+#endif /* HAVE_ICONV */
+
+/* {{{ proto string HttpQueryString::serialize()
+ *
+ * Implements Serializable.
+ */
+PHP_METHOD(HttpQueryString, serialize)
+{
+       NO_ARGS;
+       RETURN_PROP(queryString);
+}
+/* }}} */
+
+/* {{{ proto void HttpQueryString::unserialize(string serialized)
+ *
+ * Implements Serializable.
+ */
+PHP_METHOD(HttpQueryString, unserialize)
+{
+       zval *serialized;
+       
+       SET_EH_THROW_HTTP();
+       if (SUCCESS == zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "z", &serialized)) {
+               if (Z_TYPE_P(serialized) == IS_STRING) {
+                       zval *qa = GET_PROP(queryArray);
+                       
+                       zend_hash_clean(Z_ARRVAL_P(qa));
+                       http_querystring_modify(qa, serialized);
+                       http_querystring_update(qa, GET_PROP(queryString));
+               } else {
+                       http_error(HE_WARNING, HTTP_E_QUERYSTRING, "Expected a string as parameter");
+               }
+       }
+       SET_EH_NORMAL();
+}
+/* }}} */
+
 #endif /* ZEND_ENGINE_2 */
 
 /*