Remove igbinary dependency

Change-Id: I19a3782fa9154df97460af2bca9c11cd765f50d8
Reviewed-on: http://review.couchbase.org/120727
Tested-by: Build Bot <[email protected]>
Reviewed-by: Sergey Avseyev <[email protected]>

Author: avsej

api/couchbase.php

@@ -15,9 +15,6 @@
  *      necessary, use `new stdClass()` to persist empty JSON object. Note, that only JSON format considered supported by
  *      all Couchbase SDKs, everything else is private implementation (i.e. `"php"` format won't be readable by .NET SDK).
  *   * `"php"` - uses PHP serialize() method to encode the document.
- *   * `"igbinary"` - uses pecl/igbinary to encode the document in even more efficient than `"php"` format. Might not be
- *      available, if the Couchbase PHP SDK didn't find it during build phase, in this case constant
- *      \Couchbase\HAVE_IGBINARY will be false.
  *
  * * `couchbase.encoder.compression` (string), default: `"none"`
  *

config.m4

@@ -147,28 +147,4 @@ COUCHBASE_FILES=" \
   PHP_ADD_BUILD_DIR($ext_builddir/src/couchbase/bucket_manager, 1)
   PHP_ADD_BUILD_DIR($ext_builddir/src/couchbase/cluster_manager, 1)
   PHP_ADD_EXTENSION_DEP(couchbase, json)
-
-
-  AC_MSG_CHECKING([for igbinary support])
-  igbinary_inc_path=""
-  if test -f "$abs_srcdir/include/php/ext/igbinary/igbinary.h"; then
-    igbinary_inc_path="$abs_srcdir/include/php"
-  elif test -f "$abs_srcdir/ext/igbinary/igbinary.h"; then
-    igbinary_inc_path="$abs_srcdir"
-  elif test -f "$phpincludedir/ext/session/igbinary.h"; then
-    igbinary_inc_path="$phpincludedir"
-  elif test -f "$phpincludedir/ext/igbinary/igbinary.h"; then
-    igbinary_inc_path="$phpincludedir"
-  fi
-  if test "$igbinary_inc_path" = ""; then
-    AC_MSG_WARN([Cannot find igbinary.h])
-  else
-    AC_DEFINE(HAVE_COUCHBASE_IGBINARY,1,[Whether igbinary serializer is enabled])
-    IGBINARY_INCLUDES="-I$igbinary_inc_path"
-    ifdef([PHP_ADD_EXTENSION_DEP],
-      [
-        PHP_ADD_EXTENSION_DEP(couchbase, igbinary)
-      ])
-    AC_MSG_RESULT([$igbinary_inc_path])
-  fi
 fi

config.w32

@@ -10,9 +10,6 @@ if (PHP_COUCHBASE != "no") {
             CHECK_HEADER_ADD_INCLUDE("zlib.h", "CFLAGS", "..\\zlib;" + php_usual_include_suspects)) {
             AC_DEFINE("HAVE_COUCHBASE_ZLIB", 1, "Whether zlib compressor is enabled");
         }
-        if (ADD_EXTENSION_DEP('couchbase', 'igbinary')) {
-            AC_DEFINE("HAVE_COUCHBASE_IGBINARY", 1, "Whether igbinary serializer is enabled");
-        }
 
         root_sources =
             "couchbase.c " +

couchbase.c

@@ -27,10 +27,6 @@
 #include <zlib.h>
 #endif
 
-#if HAVE_COUCHBASE_IGBINARY
-#include <ext/igbinary/igbinary.h>
-#endif
-
 #define LOGARGS(lvl) LCB_LOG_##lvl, NULL, "pcbc/ext", __FILE__, __LINE__
 
 typedef unsigned char uint8_t;
@@ -117,10 +113,6 @@ static PHP_INI_MH(OnUpdateFormat)
         PCBCG(enc_format_i) = COUCHBASE_SERTYPE_JSON;
     } else if (!strcmp(str_val, "php") || !strcmp(str_val, "PHP")) {
         PCBCG(enc_format_i) = COUCHBASE_SERTYPE_PHP;
-#ifdef HAVE_COUCHBASE_IGBINARY
-    } else if (!strcmp(str_val, "igbinary") || !strcmp(str_val, "IGBINARY")) {
-        PCBCG(enc_format_i) = COUCHBASE_SERTYPE_IGBINARY;
-#endif
     } else {
         return FAILURE;
     }
@@ -385,7 +377,6 @@ PHP_MINIT_FUNCTION(couchbase)
     PCBC_REGISTER_CONST_RAW(COUCHBASE_VAL_IS_DOUBLE);
     PCBC_REGISTER_CONST_RAW(COUCHBASE_VAL_IS_BOOL);
     PCBC_REGISTER_CONST_RAW(COUCHBASE_VAL_IS_SERIALIZED);
-    PCBC_REGISTER_CONST_RAW(COUCHBASE_VAL_IS_IGBINARY);
     PCBC_REGISTER_CONST_RAW(COUCHBASE_VAL_IS_JSON);
     PCBC_REGISTER_CONST_RAW(COUCHBASE_COMPRESSION_MASK);
     PCBC_REGISTER_CONST_RAW(COUCHBASE_COMPRESSION_NONE);
@@ -394,7 +385,6 @@ PHP_MINIT_FUNCTION(couchbase)
     PCBC_REGISTER_CONST_RAW(COUCHBASE_COMPRESSION_MCISCOMPRESSED);
 
     PCBC_REGISTER_CONST_RAW(COUCHBASE_SERTYPE_JSON);
-    PCBC_REGISTER_CONST_RAW(COUCHBASE_SERTYPE_IGBINARY);
     PCBC_REGISTER_CONST_RAW(COUCHBASE_SERTYPE_PHP);
     PCBC_REGISTER_CONST_RAW(COUCHBASE_CMPRTYPE_NONE);
     PCBC_REGISTER_CONST_RAW(COUCHBASE_CMPRTYPE_ZLIB);
@@ -407,8 +397,6 @@ PHP_MINIT_FUNCTION(couchbase)
     PCBC_REGISTER_CONST_RAW(COUCHBASE_CFFMT_STRING);
 
     REGISTER_NS_LONG_CONSTANT("Couchbase", "ENCODER_FORMAT_JSON", COUCHBASE_SERTYPE_JSON, CONST_CS | CONST_PERSISTENT);
-    REGISTER_NS_LONG_CONSTANT("Couchbase", "ENCODER_FORMAT_IGBINARY", COUCHBASE_SERTYPE_IGBINARY,
-                              CONST_CS | CONST_PERSISTENT);
     REGISTER_NS_LONG_CONSTANT("Couchbase", "ENCODER_FORMAT_PHP", COUCHBASE_SERTYPE_PHP, CONST_CS | CONST_PERSISTENT);
 
     REGISTER_NS_LONG_CONSTANT("Couchbase", "ENCODER_COMPRESSION_NONE", COUCHBASE_CMPRTYPE_NONE,
@@ -418,11 +406,7 @@ PHP_MINIT_FUNCTION(couchbase)
     REGISTER_NS_LONG_CONSTANT("Couchbase", "ENCODER_COMPRESSION_FASTLZ", COUCHBASE_CMPRTYPE_FASTLZ,
                               CONST_CS | CONST_PERSISTENT);
 
-#ifdef HAVE_COUCHBASE_IGBINARY
-    REGISTER_NS_LONG_CONSTANT("Couchbase", "HAVE_IGBINARY", 1, CONST_CS | CONST_PERSISTENT);
-#else
     REGISTER_NS_LONG_CONSTANT("Couchbase", "HAVE_IGBINARY", 0, CONST_CS | CONST_PERSISTENT);
-#endif
 
 #ifdef HAVE_COUCHBASE_ZLIB
     REGISTER_NS_LONG_CONSTANT("Couchbase", "HAVE_ZLIB", 1, CONST_CS | CONST_PERSISTENT);
@@ -458,12 +442,6 @@ static void basic_encoder_v1(zval *value, int sertype, int cmprtype, long cmprth
     zval dtype;
     unsigned int flags = 0;
 
-#ifndef HAVE_COUCHBASE_IGBINARY
-    if (sertype == COUCHBASE_SERTYPE_IGBINARY) {
-        pcbc_log(LOGARGS(WARN), "igbinary extension is not found, fallback to JSON serializer");
-        sertype = COUCHBASE_SERTYPE_JSON;
-    }
-#endif
     ZVAL_UNDEF(&res);
 
     switch (Z_TYPE_P(value)) {
@@ -544,23 +522,6 @@ static void basic_encoder_v1(zval *value, int sertype, int cmprtype, long cmprth
                 smart_str_free(&buf);
             }
             break;
-#ifdef HAVE_COUCHBASE_IGBINARY
-        case COUCHBASE_SERTYPE_IGBINARY:
-            flags = COUCHBASE_VAL_IS_IGBINARY | COUCHBASE_CFFMT_PRIVATE;
-            {
-                uint8_t *buf;
-                size_t len;
-
-                len = 0;
-                if (igbinary_serialize(&buf, &len, value TSRMLS_CC)) {
-                    pcbc_log(LOGARGS(WARN), "Failed to serialize value with igbinary");
-                } else {
-                    PCBC_STRINGL(res, (char *)buf, len);
-                    efree(buf);
-                }
-            }
-            break;
-#endif
         }
     }
 
@@ -777,16 +738,8 @@ static void basic_decoder_v1(char *bytes, size_t bytes_len, unsigned long flags,
             PHP_VAR_UNSERIALIZE_DESTROY(var_hash);
         } break;
         case COUCHBASE_VAL_IS_IGBINARY:
-#if HAVE_COUCHBASE_IGBINARY
-            if (igbinary_unserialize((uint8_t *)bytes, bytes_len, &res TSRMLS_CC)) {
-                pcbc_log(LOGARGS(WARN), "Failed to deserialize value with igbinary");
-                ZVAL_NULL(&res);
-            }
-            break;
-#else
-            pcbc_log(LOGARGS(WARN), "The igbinary extension was not available when the couchbase extension was built.");
+            pcbc_log(LOGARGS(WARN), "The igbinary serialization is not supported.");
             RETURN_NULL();
-#endif
         default:
             pcbc_log(LOGARGS(WARN), "Unknown serialization type: %d", cffmt);
             ZVAL_NULL(&res);
@@ -1062,11 +1015,6 @@ static PHP_MINFO_FUNCTION(couchbase)
     php_info_print_table_row(2, "extension version", PHP_COUCHBASE_VERSION);
     php_info_print_table_row(2, "libcouchbase runtime version", buf);
     php_info_print_table_row(2, "libcouchbase headers version", LCB_VERSION_STRING " (git: " LCB_VERSION_CHANGESET ")");
-#ifdef HAVE_COUCHBASE_IGBINARY
-    php_info_print_table_row(2, "igbinary transcoder", "enabled");
-#else
-    php_info_print_table_row(2, "igbinary transcoder", "disabled (install pecl/igbinary and rebuild pecl/couchbase)");
-#endif
 #ifdef HAVE_COUCHBASE_ZLIB
     php_info_print_table_row(2, "zlib compressor", "enabled");
 #else
@@ -1136,9 +1084,6 @@ static zend_function_entry couchbase_functions[] = {
 #if ZEND_MODULE_API_NO >= 20050617
 static zend_module_dep php_couchbase_deps[] = {
     ZEND_MOD_REQUIRED("json")
-#ifdef HAVE_COUCHBASE_IGBINARY
-    ZEND_MOD_REQUIRED("igbinary")
-#endif
     ZEND_MOD_END
 };
 #endif

tests/CouchbaseMock.php

@@ -2,7 +2,7 @@
 // vim: et ts=4 sw=4 sts=4
 
 class CouchbaseMock {
-    const VERSION = '1.5.23';
+    const VERSION = '1.5.25';
 
     private $jarPath;
     private $ctlServer;

xtests/TranscoderTest.php

@@ -118,15 +118,6 @@ function testCouchbaseBasicEncoderV1() {
         $this->assertEquals(COUCHBASE_VAL_IS_DOUBLE, $res[1] & COUCHBASE_VAL_MASK);
         $this->assertEquals(["1.0", 0x02000002, 0], $res);
 
-        if (\Couchbase\HAVE_IGBINARY) {
-            $options['sertype'] = COUCHBASE_SERTYPE_IGBINARY;
-            $res = \Couchbase\basicEncoderV1(["foo" => 0xabcdef0123456789], $options);
-            $this->assertEquals(COUCHBASE_COMPRESSION_NONE, $res[1] & COUCHBASE_COMPRESSION_MASK);
-            $this->assertEquals(COUCHBASE_CFFMT_PRIVATE, $res[1] & COUCHBASE_CFFMT_MASK);
-            $this->assertEquals(COUCHBASE_VAL_IS_IGBINARY, $res[1] & COUCHBASE_VAL_MASK);
-            $this->assertEquals([hex2bin("0000000214011103666f6f0c43e579bde02468ad"), 0x01000005, 0], $res);
-        }
-
         $options['sertype'] = COUCHBASE_SERTYPE_JSON;
         if (\Couchbase\HAVE_ZLIB) {
             $options['cmprtype'] = COUCHBASE_CMPRTYPE_ZLIB;
@@ -279,22 +270,14 @@ function testCouchbaseBasicDecoderV1() {
         $this->assertEquals(["foo" => 0xabcdef0123456789], $res);
 
         $res = \Couchbase\basicDecoderV1(hex2bin("0000000214011103666f6f0c43e579bde02468ad"), 0x01000005, 0, $options);
-        if (\Couchbase\HAVE_IGBINARY) {
-            $this->assertEquals(["foo" => 0xabcdef0123456789], $res);
-        } else {
-            $this->assertEquals(NULL, $res);
-        }
+        $this->assertEquals(NULL, $res);
 
         $options['jsonassoc'] = false;  // jsonassoc does not affect "binary" encoders
         $res = \Couchbase\basicDecoderV1('a:1:{s:3:"foo";d:1.2379813738877118E+19;}', 0x01000004, 0, $options);
         $this->assertEquals(["foo" => 0xabcdef0123456789], $res);
 
         $res = \Couchbase\basicDecoderV1(hex2bin("0000000214011103666f6f0c43e579bde02468ad"), 0x01000005, 0, $options);
-        if (\Couchbase\HAVE_IGBINARY) {
-            $this->assertEquals(["foo" => 0xabcdef0123456789], $res);
-        } else {
-            $this->assertEquals(NULL, $res);
-        }
+        $this->assertEquals(NULL, $res);
 
         $res = \Couchbase\basicDecoderV1("1.0", 0x02000002, 0, $options);
         $this->assertEquals(1.0, $res);
@@ -331,17 +314,6 @@ function testInvalidInputForPhpSerialize() {
         $this->assertNull($res);
     }
 
-    /**
-     * @expectedException PHPUnit_Framework_Error
-     * @expectedExceptionMessageRegExp /igbinary_unserialize_header/
-     */
-    function testInvalidInputForIgbinary() {
-        if (!\Couchbase\HAVE_IGBINARY) {
-            $this->markTestSkipped('Extension does not support IGBINARY serializer');
-        }
-        \Couchbase\basicDecoderV1(hex2bin("00000214011103666f6f0c43e579bde02468ad"), 0x01000005, 0, []);
-    }
-
     function testCouchbaseDefaultEncoder() {
         $orig = ini_get('couchbase.encoder.format');
         ini_set('couchbase.encoder.format', 'json');