PHPC-779: Switch ObjectID from O to C type serialization

Author: derickr

src/BSON/ObjectID.c

@@ -34,6 +34,12 @@
 #include <ext/standard/info.h>
 #include <Zend/zend_interfaces.h>
 #include <ext/spl/spl_iterators.h>
+#include <ext/standard/php_var.h>
+#if PHP_VERSION_ID >= 70000
+# include <zend_smart_str.h>
+#else
+# include <ext/standard/php_smart_str.h>
+#endif
 /* Our Compatability header */
 #include "phongo_compat.h"
 
@@ -209,6 +215,93 @@ PHP_METHOD(ObjectID, __wakeup)
 }
 /* }}} */
 
+/* {{{ proto string ObjectID::serialize()
+*/
+PHP_METHOD(ObjectID, serialize)
+{
+	php_phongo_objectid_t    *intern;
+#if PHP_VERSION_ID >= 70000
+	zval                      retval;
+#else
+	zval                     *retval;
+#endif
+	php_serialize_data_t      var_hash;
+	smart_str                 buf = { 0 };
+
+	intern = Z_OBJECTID_OBJ_P(getThis());
+
+	if (zend_parse_parameters_none() == FAILURE) {
+		return;
+	}
+
+#if PHP_VERSION_ID >= 70000
+	array_init_size(&retval, 2);
+	ADD_ASSOC_STRINGL(&retval, "oid", intern->oid, 24);
+#else
+	ALLOC_INIT_ZVAL(retval);
+	array_init_size(retval, 2);
+	ADD_ASSOC_STRINGL(retval, "oid", intern->oid, 24);
+#endif
+
+	PHP_VAR_SERIALIZE_INIT(var_hash);
+	php_var_serialize(&buf, &retval, &var_hash TSRMLS_CC);
+	smart_str_0(&buf);
+	PHP_VAR_SERIALIZE_DESTROY(var_hash);
+
+	PHONGO_RETVAL_SMART_STR(buf);
+
+	smart_str_free(&buf);
+	zval_ptr_dtor(&retval);
+}
+/* }}} */
+
+/* {{{ proto string ObjectID::unserialize(string $serialized)
+*/
+PHP_METHOD(ObjectID, unserialize)
+{
+	php_phongo_objectid_t   *intern;
+	zend_error_handling      error_handling;
+	char                    *serialized;
+	phongo_zpp_char_len      serialized_len;
+#if PHP_VERSION_ID >= 70000
+	zval                     props;
+#else
+	zval                    *props;
+#endif
+	php_unserialize_data_t   var_hash;
+
+	intern = Z_OBJECTID_OBJ_P(getThis());
+
+	zend_replace_error_handling(EH_THROW, phongo_exception_from_phongo_domain(PHONGO_ERROR_INVALID_ARGUMENT), &error_handling TSRMLS_CC);
+
+	if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &serialized, &serialized_len) == FAILURE) {
+		zend_restore_error_handling(&error_handling TSRMLS_CC);
+		return;
+	}
+	zend_restore_error_handling(&error_handling TSRMLS_CC);
+
+#if PHP_VERSION_ID < 70000
+	ALLOC_INIT_ZVAL(props);
+#endif
+	PHP_VAR_UNSERIALIZE_INIT(var_hash);
+	if (!php_var_unserialize(&props, (const unsigned char**) &serialized, (unsigned char *) serialized + serialized_len, &var_hash TSRMLS_CC)) {
+		zval_ptr_dtor(&props);
+		phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE TSRMLS_CC, "%s unserialization failed", ZSTR_VAL(php_phongo_objectid_ce->name));
+
+		PHP_VAR_UNSERIALIZE_DESTROY(var_hash);
+		return;
+	}
+	PHP_VAR_UNSERIALIZE_DESTROY(var_hash);
+
+#if PHP_VERSION_ID >= 70000
+	php_phongo_objectid_init_from_hash(intern, HASH_OF(&props) TSRMLS_CC);
+#else
+	php_phongo_objectid_init_from_hash(intern, HASH_OF(props) TSRMLS_CC);
+#endif
+	zval_ptr_dtor(&props);
+}
+/* }}} */
+
 /* {{{ BSON\ObjectID */
 
 ZEND_BEGIN_ARG_INFO_EX(ai_ObjectID___construct, 0, 0, 0)
@@ -219,6 +312,10 @@ ZEND_BEGIN_ARG_INFO_EX(ai_ObjectID___set_state, 0, 0, 1)
 	ZEND_ARG_ARRAY_INFO(0, properties, 0)
 ZEND_END_ARG_INFO()
 
+ZEND_BEGIN_ARG_INFO_EX(ai_ObjectID_unserialize, 0, 0, 1)
+	ZEND_ARG_INFO(0, serialized)
+ZEND_END_ARG_INFO()
+
 ZEND_BEGIN_ARG_INFO_EX(ai_ObjectID_void, 0, 0, 0)
 ZEND_END_ARG_INFO()
 
@@ -228,6 +325,8 @@ static zend_function_entry php_phongo_objectid_me[] = {
 	PHP_ME(ObjectID, __set_state, ai_ObjectID___set_state, ZEND_ACC_PUBLIC|ZEND_ACC_STATIC)
 	PHP_ME(ObjectID, __toString, ai_ObjectID_void, ZEND_ACC_PUBLIC|ZEND_ACC_FINAL)
 	PHP_ME(ObjectID, __wakeup, ai_ObjectID_void, ZEND_ACC_PUBLIC)
+	PHP_ME(ObjectID, serialize, ai_ObjectID_void, ZEND_ACC_PUBLIC|ZEND_ACC_FINAL)
+	PHP_ME(ObjectID, unserialize, ai_ObjectID_unserialize, ZEND_ACC_PUBLIC|ZEND_ACC_FINAL)
 	PHP_FE_END
 };
 
@@ -326,6 +425,7 @@ PHP_MINIT_FUNCTION(ObjectID)
 	PHONGO_CE_FINAL(php_phongo_objectid_ce);
 
 	zend_class_implements(php_phongo_objectid_ce TSRMLS_CC, 1, php_phongo_type_ce);
+	zend_class_implements(php_phongo_objectid_ce TSRMLS_CC, 1, zend_ce_serializable);
 
 	memcpy(&php_phongo_handler_objectid, phongo_get_std_object_handlers(), sizeof(zend_object_handlers));
 	php_phongo_handler_objectid.compare_objects = php_phongo_objectid_compare_objects;

tests/bson/bson-javascript-serialization-001.phpt

@@ -85,7 +85,7 @@ object(MongoDB\BSON\Javascript)#%d (%d) {
     }
   }
 }
-string(206) "C:23:"MongoDB\BSON\Javascript":169:{a:2:{s:4:"code";s:29:"function foo() { return id; }";s:5:"scope";O:8:"stdClass":1:{s:2:"id";O:21:"MongoDB\BSON\ObjectID":1:{s:3:"oid";s:24:"53e2a1c40640fd72175d4603";}}}}"
+string(213) "C:23:"MongoDB\BSON\Javascript":176:{a:2:{s:4:"code";s:29:"function foo() { return id; }";s:5:"scope";O:8:"stdClass":1:{s:2:"id";C:21:"MongoDB\BSON\ObjectID":48:{a:1:{s:3:"oid";s:24:"53e2a1c40640fd72175d4603";}}}}}"
 object(MongoDB\BSON\Javascript)#%d (%d) {
   ["code"]=>
   string(29) "function foo() { return id; }"

tests/bson/bson-objectid-serialization-001.phpt

@@ -15,7 +15,7 @@ object(MongoDB\BSON\ObjectID)#%d (%d) {
   ["oid"]=>
   string(24) "576c25db6118fd406e6e6471"
 }
-string(75) "O:21:"MongoDB\BSON\ObjectID":1:{s:3:"oid";s:24:"576c25db6118fd406e6e6471";}"
+string(82) "C:21:"MongoDB\BSON\ObjectID":48:{a:1:{s:3:"oid";s:24:"576c25db6118fd406e6e6471";}}"
 object(MongoDB\BSON\ObjectID)#%d (%d) {
   ["oid"]=>
   string(24) "576c25db6118fd406e6e6471"

tests/bson/bson-objectid-serialization_error-001.phpt

@@ -6,7 +6,7 @@ MongoDB\BSON\ObjectID unserialization requires "oid" string field
 require_once __DIR__ . '/../utils/tools.php';
 
 echo throws(function() {
-    unserialize('O:21:"MongoDB\BSON\ObjectID":1:{s:3:"oid";i:0;}');
+    unserialize('C:21:"MongoDB\BSON\ObjectID":20:{a:1:{s:3:"oid";i:0;}}');
 }, 'MongoDB\Driver\Exception\InvalidArgumentException'), "\n";
 
 ?>

tests/bson/bson-objectid-serialization_error-002.phpt

@@ -6,11 +6,11 @@ MongoDB\BSON\ObjectID unserialization requires valid hex string
 require_once __DIR__ . '/../utils/tools.php';
 
 echo throws(function() {
-    unserialize('O:21:"MongoDB\BSON\ObjectID":1:{s:3:"oid";s:24:"0123456789abcdefghijklmn";}');
+    unserialize('C:21:"MongoDB\BSON\ObjectID":48:{a:1:{s:3:"oid";s:24:"0123456789abcdefghijklmn";}}');
 }, 'MongoDB\Driver\Exception\InvalidArgumentException'), "\n";
 
 echo throws(function() {
-    unserialize('O:21:"MongoDB\BSON\ObjectID":1:{s:3:"oid";s:7:"INVALID";}');
+    unserialize('C:21:"MongoDB\BSON\ObjectID":30:{a:1:{s:3:"oid";s:7:"INVALID";}}');
 }, 'MongoDB\Driver\Exception\InvalidArgumentException'), "\n";
 
 ?>