PCBC-777: workaround for query positional parameters

libcouchbase 3.2.0 introduced change in how positional parameters
handled for queries (see CCBC-1429).

This patch reshapes parameters for 3.2.0 and prepares codes for future
fix in libcouchbase.

Change-Id: Ic3986b48ad3dc4d94114d339a57cac741f3f7676
Reviewed-on: http://review.couchbase.org/c/php-couchbase/+/158291
Tested-by: Build Bot <[email protected]>
Reviewed-by: Sergey Avseyev <[email protected]>

Author: avsej

config.m4

@@ -18,12 +18,12 @@ if test "$PHP_COUCHBASE" != "no"; then
   elif test -x "$PKG_CONFIG" && $PKG_CONFIG --exists libcouchbase; then
     LIBCOUCHBASE_VERSION=`$PKG_CONFIG libcouchbase --modversion`
 
-    if $PKG_CONFIG libcouchbase --atleast-version 3.1.3; then
+    if $PKG_CONFIG libcouchbase --atleast-version 3.2.0; then
       LIBCOUCHBASE_CFLAGS=`$PKG_CONFIG libcouchbase --cflags`
       LIBCOUCHBASE_LIBS=`$PKG_CONFIG libcouchbase --libs`
       AC_MSG_RESULT(from pkgconfig: version $LIBCOUCHBASE_VERSION found)
     else
-      AC_MSG_ERROR([libcouchbase version $LIBCOUCHBASE_VERSION found, must be upgraded to version >= 3.1.3])
+      AC_MSG_ERROR([libcouchbase version $LIBCOUCHBASE_VERSION found, must be upgraded to version >= 3.2.0])
     fi
 
   dnl fallback on standard directory
@@ -50,14 +50,14 @@ if test "$PHP_COUCHBASE" != "no"; then
 
   dnl found in directory
   else
-    AC_MSG_CHECKING([for libcouchbase version >= 3.1.3])
+    AC_MSG_CHECKING([for libcouchbase version >= 3.2.0])
     LCB_VERSION=$($EGREP "define LCB_VERSION " $LIBCOUCHBASE_DIR/include/libcouchbase/configuration.h | $SED -e 's/[[^0-9x]]//g')
     AC_MSG_RESULT([$LCB_VERSION])
     if test "x$LCB_VERSION" = "x0x000000"; then
       AC_MSG_ERROR([seems like libcouchbase is not installed from official tarball or git clone. Do not use github tags to download releases.])
     fi
-    if test $(printf %d $LCB_VERSION) -lt $(printf %d 0x030103); then
-      AC_MSG_ERROR([libcouchbase greater or equal to 3.1.3 required])
+    if test $(printf %d $LCB_VERSION) -lt $(printf %d 0x030200); then
+      AC_MSG_ERROR([libcouchbase greater or equal to 3.2.0 required])
     fi
 
     PHP_ADD_INCLUDE($LIBCOUCHBASE_DIR/include)

src/couchbase/bucket/cbas.c

@@ -324,7 +324,8 @@ static const zend_function_entry pcbc_analytics_options_methods[] = {
 };
 // clang-format on
 
-void do_analytics_query(zval *return_value, lcb_INSTANCE *lcb, zend_string *statement, zval *options, zend_string *scope)
+void do_analytics_query(zval *return_value, lcb_INSTANCE *lcb, zend_string *statement, zval *options,
+                        zend_string *scope)
 {
     lcb_CMDANALYTICS *cmd;
     lcb_cmdanalytics_create(&cmd);
@@ -352,6 +353,7 @@ void do_analytics_query(zval *return_value, lcb_INSTANCE *lcb, zend_string *stat
         }
         prop = pcbc_read_property(pcbc_analytics_options_ce, options, ("positional_params"), 0, &ret);
         if (Z_TYPE_P(prop) == IS_ARRAY) {
+#if LCB_VERSION > 0x030200
             HashTable *ht = HASH_OF(prop);
             zval *entry;
             ZEND_HASH_FOREACH_VAL(ht, entry)
@@ -361,6 +363,26 @@ void do_analytics_query(zval *return_value, lcb_INSTANCE *lcb, zend_string *stat
                 }
             }
             ZEND_HASH_FOREACH_END();
+#else
+            smart_str buf = {0};
+            HashTable *ht = HASH_OF(prop);
+            zval *entry;
+            smart_str_appendc(&buf, '[');
+            ZEND_HASH_FOREACH_VAL(ht, entry)
+            {
+                if (Z_TYPE_P(entry) == IS_STRING) {
+                    smart_str_appendl(&buf, Z_STRVAL_P(entry), Z_STRLEN_P(entry));
+                    smart_str_appendc(&buf, ',');
+                }
+            }
+            if (ZSTR_LEN(buf.s) > 1) {
+                ZSTR_LEN(buf.s) = ZSTR_LEN(buf.s) - 1; /* remove last comma */
+            }
+            smart_str_appendc(&buf, ']');
+            lcb_cmdanalytics_positional_param(cmd, ZSTR_VAL(buf.s), ZSTR_LEN(buf.s));
+            smart_str_free(&buf);
+            ZEND_HASH_FOREACH_END();
+#endif
         }
         prop = pcbc_read_property(pcbc_analytics_options_ce, options, ("raw_params"), 0, &ret);
         if (Z_TYPE_P(prop) == IS_ARRAY) {

src/couchbase/bucket/n1ql.c

@@ -620,6 +620,7 @@ void do_query(zval *return_value, lcb_INSTANCE *lcb, zend_string *statement, zva
         }
         prop = pcbc_read_property(pcbc_query_options_ce, options, ("positional_params"), 0, &ret);
         if (Z_TYPE_P(prop) == IS_ARRAY) {
+#if LCB_VERSION > 0x030200
             HashTable *ht = HASH_OF(prop);
             zval *entry;
             ZEND_HASH_FOREACH_VAL(ht, entry)
@@ -629,6 +630,26 @@ void do_query(zval *return_value, lcb_INSTANCE *lcb, zend_string *statement, zva
                 }
             }
             ZEND_HASH_FOREACH_END();
+#else
+            smart_str buf = {0};
+            HashTable *ht = HASH_OF(prop);
+            zval *entry;
+            smart_str_appendc(&buf, '[');
+            ZEND_HASH_FOREACH_VAL(ht, entry)
+            {
+                if (Z_TYPE_P(entry) == IS_STRING) {
+                    smart_str_appendl(&buf, Z_STRVAL_P(entry), Z_STRLEN_P(entry));
+                    smart_str_appendc(&buf, ',');
+                }
+            }
+            if (ZSTR_LEN(buf.s) > 1) {
+                ZSTR_LEN(buf.s) = ZSTR_LEN(buf.s) - 1; /* remove last comma */
+            }
+            smart_str_appendc(&buf, ']');
+            lcb_cmdquery_positional_param(cmd, ZSTR_VAL(buf.s), ZSTR_LEN(buf.s));
+            smart_str_free(&buf);
+            ZEND_HASH_FOREACH_END();
+#endif
         }
         prop = pcbc_read_property(pcbc_query_options_ce, options, ("raw_params"), 0, &ret);
         if (Z_TYPE_P(prop) == IS_ARRAY) {