Skip to content

Commit ca8ce77

Browse files
jmikolajmikola
committed
Merge pull request #40 from jmikola/phpc-274
PHPC-274: Fix zval_to_bson() encoding of BSON\Serializable objects
2 parents 7399cec + 56e5567 commit ca8ce77

File tree

5 files changed

+288
-69
lines changed

5 files changed

+288
-69
lines changed

‎src/bson.c‎

Lines changed: 49 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -607,34 +607,43 @@ void object_to_bson(zval *object, php_phongo_bson_flags_t flags, const char *key
607607

608608
if (instanceof_function(Z_OBJCE_P(object), php_phongo_type_ce TSRMLS_CC)) {
609609
if (instanceof_function(Z_OBJCE_P(object), php_phongo_serializable_ce TSRMLS_CC)) {
610-
zval *retval = NULL;
610+
zval *obj_data = NULL;
611+
bson_t child;
612+
HashTable *tmp_ht;
611613

612-
zend_call_method_with_0_params(&object, NULL, NULL, BSON_SERIALIZE_FUNC_NAME, &retval);
613-
if (retval) {
614-
bson_t child;
615-
HashTable *tmp_ht;
614+
zend_call_method_with_0_params(&object, NULL, NULL, BSON_SERIALIZE_FUNC_NAME, &obj_data);
616615

617-
convert_to_array_ex(&retval);
618-
tmp_ht = HASH_OF(retval);
616+
if (!obj_data) {
617+
/* zend_call_method() failed */
618+
return;
619+
}
619620

620-
if (tmp_ht) {
621-
tmp_ht->nApplyCount++;
622-
}
621+
if (Z_TYPE_P(obj_data) != IS_ARRAY) {
622+
phongo_throw_exception(PHONGO_ERROR_RUNTIME TSRMLS_CC, "Expected %s() to return an array, %s given", BSON_SERIALIZE_FUNC_NAME, zend_get_type_by_const(Z_TYPE_P(obj_data)));
623+
zval_ptr_dtor(&obj_data);
623624

624-
bson_append_document_begin(bson, key, key_len, &child);
625-
if (instanceof_function(Z_OBJCE_P(object), php_phongo_persistable_ce TSRMLS_CC)) {
626-
if (flags & PHONGO_BSON_ADD_CHILD_ODS) {
627-
bson_append_binary(&child, PHONGO_ODM_FIELD_NAME, -1, 0x80, (const uint8_t *)Z_OBJCE_P(object)->name, strlen(Z_OBJCE_P(object)->name));
628-
}
629-
}
630-
zval_to_bson(retval, flags, &child, NULL TSRMLS_CC);
631-
bson_append_document_end(bson, &child);
625+
return;
626+
}
632627

633-
if (tmp_ht) {
634-
tmp_ht->nApplyCount--;
628+
tmp_ht = HASH_OF(obj_data);
629+
630+
if (tmp_ht) {
631+
tmp_ht->nApplyCount++;
632+
}
633+
634+
bson_append_document_begin(bson, key, key_len, &child);
635+
if (instanceof_function(Z_OBJCE_P(object), php_phongo_persistable_ce TSRMLS_CC)) {
636+
if (flags & PHONGO_BSON_ADD_CHILD_ODS) {
637+
bson_append_binary(&child, PHONGO_ODM_FIELD_NAME, -1, 0x80, (const uint8_t *)Z_OBJCE_P(object)->name, strlen(Z_OBJCE_P(object)->name));
635638
}
636-
zval_ptr_dtor(&retval);
637639
}
640+
zval_to_bson(obj_data, flags, &child, NULL TSRMLS_CC);
641+
bson_append_document_end(bson, &child);
642+
643+
if (tmp_ht) {
644+
tmp_ht->nApplyCount--;
645+
}
646+
zval_ptr_dtor(&obj_data);
638647
return;
639648
}
640649

@@ -763,23 +772,30 @@ PHONGO_API void zval_to_bson(zval *data, php_phongo_bson_flags_t flags, bson_t *
763772

764773
switch(Z_TYPE_P(data)) {
765774
case IS_OBJECT:
766-
if (instanceof_function(Z_OBJCE_P(data), php_phongo_persistable_ce TSRMLS_CC)) {
775+
if (instanceof_function(Z_OBJCE_P(data), php_phongo_serializable_ce TSRMLS_CC)) {
776+
zend_call_method_with_0_params(&data, NULL, NULL, BSON_SERIALIZE_FUNC_NAME, &obj_data);
767777

768-
if (flags & PHONGO_BSON_ADD_ODS) {
769-
bson_append_binary(bson, PHONGO_ODM_FIELD_NAME, -1, 0x80, (const uint8_t *)Z_OBJCE_P(data)->name, strlen(Z_OBJCE_P(data)->name));
778+
if (!obj_data) {
779+
/* zend_call_method() failed */
780+
return;
770781
}
771782

772-
zend_call_method_with_0_params(&data, NULL, NULL, BSON_SERIALIZE_FUNC_NAME, &obj_data);
773-
if(obj_data) {
774-
if (Z_TYPE_P(obj_data) == IS_ARRAY) {
775-
ht_data = HASH_OF(obj_data);
776-
} else {
777-
phongo_throw_exception(PHONGO_ERROR_RUNTIME TSRMLS_CC, "%s", "Return value expected to be array");
778-
zval_ptr_dtor(&obj_data);
779-
}
783+
if (Z_TYPE_P(obj_data) != IS_ARRAY) {
784+
phongo_throw_exception(PHONGO_ERROR_RUNTIME TSRMLS_CC, "Expected %s() to return an array, %s given", BSON_SERIALIZE_FUNC_NAME, zend_get_type_by_const(Z_TYPE_P(obj_data)));
785+
zval_ptr_dtor(&obj_data);
780786

781-
break;
787+
return;
782788
}
789+
790+
ht_data = HASH_OF(obj_data);
791+
792+
if (instanceof_function(Z_OBJCE_P(data), php_phongo_persistable_ce TSRMLS_CC)) {
793+
if (flags & PHONGO_BSON_ADD_ODS) {
794+
bson_append_binary(bson, PHONGO_ODM_FIELD_NAME, -1, 0x80, (const uint8_t *)Z_OBJCE_P(data)->name, strlen(Z_OBJCE_P(data)->name));
795+
}
796+
}
797+
798+
break;
783799
}
784800
/* break intentionally omitted */
785801

‎tests/bson/bson-encode-002.phpt‎

Lines changed: 102 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -6,65 +6,130 @@ BSON encoding: Encoding objects into BSON representation
66
<?php
77
require_once __DIR__ . "/../utils/basic.inc";
88

9-
class MyClass implements BSON\Serializable, BSON\Unserializable {
10-
function bsonSerialize() {
11-
return array(
12-
"random" => "class",
13-
"data"
14-
);
9+
class AssociativeArray implements BSON\Serializable, BSON\Unserializable
10+
{
11+
public function bsonSerialize()
12+
{
13+
return array("random" => "class", "data");
1514
}
16-
function bsonUnserialize(array $data) {
17-
var_dump(__METHOD__, $data);
15+
16+
public function bsonUnserialize(array $data)
17+
{
18+
echo __METHOD__, "() was called with data:\n";
19+
var_dump($data);
1820
}
1921
}
20-
class MyClass2 implements BSON\Serializable, BSON\Unserializable {
21-
function bsonSerialize() {
22-
return array(
23-
1, 2, 3,
24-
);
22+
23+
class NumericArray implements BSON\Serializable, BSON\Unserializable
24+
{
25+
public function bsonSerialize()
26+
{
27+
return array(1, 2, 3);
2528
}
26-
function bsonUnserialize(array $data) {
27-
var_dump(__METHOD__, $data);
29+
30+
public function bsonUnserialize(array $data)
31+
{
32+
echo __METHOD__, "() was called with data:\n";
33+
var_dump($data);
2834
}
2935
}
3036

31-
$tests = array(
32-
array("stuff" => new MyClass),
33-
array("stuff" => new MyClass2),
34-
);
37+
echo "Testing top-level AssociativeArray:\n";
38+
$bson = BSON\fromArray(new AssociativeArray);
39+
echo BSON\toJSON($bson), "\n";
40+
echo "Encoded BSON:\n";
41+
hex_dump($bson);
42+
$value = BSON\toArray($bson, array("document" => 'AssociativeArray'));
43+
echo "Decoded BSON:\n";
44+
var_dump($value);
45+
46+
echo "\nTesting embedded AssociativeArray:\n";
47+
$bson = BSON\fromArray(array('embed' => new AssociativeArray));
48+
echo BSON\toJSON($bson), "\n";
49+
echo "Encoded BSON:\n";
50+
hex_dump($bson);
51+
$value = BSON\toArray($bson, array("document" => 'AssociativeArray'));
52+
echo "Decoded BSON:\n";
53+
var_dump($value);
54+
55+
echo "\nTesting top-level NumericArray:\n";
56+
$bson = BSON\fromArray(new NumericArray);
57+
echo BSON\toJSON($bson), "\n";
58+
echo "Encoded BSON:\n";
59+
hex_dump($bson);
60+
$value = BSON\toArray($bson, array("document" => 'NumericArray'));
61+
echo "Decoded BSON:\n";
62+
var_dump($value);
63+
64+
echo "\nTesting embedded NumericArray:\n";
65+
$bson = BSON\fromArray(array('embed' => new NumericArray));
66+
echo BSON\toJSON($bson), "\n";
67+
echo "Encoded BSON:\n";
68+
hex_dump($bson);
69+
$value = BSON\toArray($bson, array("document" => 'NumericArray'));
70+
echo "Decoded BSON:\n";
71+
var_dump($value);
3572

36-
foreach($tests as $n => $test) {
37-
$s = BSON\fromArray($test);
38-
echo "Test#{$n} ", BSON\toJSON($s), "\n";
39-
hex_dump($s);
40-
$obj = BSON\toArray($s, array("document" => get_class($test["stuff"])));
41-
var_dump($obj);
42-
}
4373
?>
4474
===DONE===
4575
<?php exit(0); ?>
4676
--EXPECTF--
47-
Test#0 { "stuff" : { "random" : "class", "0" : "data" } }
48-
0 : 2f 00 00 00 03 73 74 75 66 66 00 23 00 00 00 02 [/....stuff.#....]
77+
Testing top-level AssociativeArray:
78+
{ "random" : "class", "0" : "data" }
79+
Encoded BSON:
80+
0 : 23 00 00 00 02 72 61 6e 64 6f 6d 00 06 00 00 00 [#....random.....]
81+
10 : 63 6c 61 73 73 00 02 30 00 05 00 00 00 64 61 74 [class..0.....dat]
82+
20 : 61 00 00 [a..]
83+
Decoded BSON:
84+
array(2) {
85+
["random"]=>
86+
string(5) "class"
87+
[0]=>
88+
string(4) "data"
89+
}
90+
91+
Testing embedded AssociativeArray:
92+
{ "embed" : { "random" : "class", "0" : "data" } }
93+
Encoded BSON:
94+
0 : 2f 00 00 00 03 65 6d 62 65 64 00 23 00 00 00 02 [/....embed.#....]
4995
10 : 72 61 6e 64 6f 6d 00 06 00 00 00 63 6c 61 73 73 [random.....class]
5096
20 : 00 02 30 00 05 00 00 00 64 61 74 61 00 00 00 [..0.....data...]
51-
string(24) "MyClass::bsonUnserialize"
97+
AssociativeArray::bsonUnserialize() was called with data:
5298
array(2) {
5399
["random"]=>
54100
string(5) "class"
55101
[0]=>
56102
string(4) "data"
57103
}
104+
Decoded BSON:
58105
array(1) {
59-
["stuff"]=>
60-
object(MyClass)#%d (0) {
106+
["embed"]=>
107+
object(AssociativeArray)#%d (0) {
61108
}
62109
}
63-
Test#1 { "stuff" : { "0" : 1, "1" : 2, "2" : 3 } }
64-
0 : 26 00 00 00 03 73 74 75 66 66 00 1a 00 00 00 10 [&....stuff......]
110+
111+
Testing top-level NumericArray:
112+
{ "0" : 1, "1" : 2, "2" : 3 }
113+
Encoded BSON:
114+
0 : 1a 00 00 00 10 30 00 01 00 00 00 10 31 00 02 00 [.....0......1...]
115+
10 : 00 00 10 32 00 03 00 00 00 00 [...2......]
116+
Decoded BSON:
117+
array(3) {
118+
[0]=>
119+
int(1)
120+
[1]=>
121+
int(2)
122+
[2]=>
123+
int(3)
124+
}
125+
126+
Testing embedded NumericArray:
127+
{ "embed" : { "0" : 1, "1" : 2, "2" : 3 } }
128+
Encoded BSON:
129+
0 : 26 00 00 00 03 65 6d 62 65 64 00 1a 00 00 00 10 [&....embed......]
65130
10 : 30 00 01 00 00 00 10 31 00 02 00 00 00 10 32 00 [0......1......2.]
66131
20 : 03 00 00 00 00 00 [......]
67-
string(25) "MyClass2::bsonUnserialize"
132+
NumericArray::bsonUnserialize() was called with data:
68133
array(3) {
69134
[0]=>
70135
int(1)
@@ -73,9 +138,10 @@ array(3) {
73138
[2]=>
74139
int(3)
75140
}
141+
Decoded BSON:
76142
array(1) {
77-
["stuff"]=>
78-
object(MyClass2)#%d (0) {
143+
["embed"]=>
144+
object(NumericArray)#%d (0) {
79145
}
80146
}
81147
===DONE===

‎tests/bson/bson-encode_error-001.phpt‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
--TEST--
2+
BSON encoding error when bsonSerialize() for root document does not return an array
3+
--SKIPIF--
4+
<?php require __DIR__ . "/../utils/basic-skipif.inc"?>
5+
--FILE--
6+
<?php
7+
require_once __DIR__ . "/../utils/basic.inc";
8+
9+
class MyClass implements BSON\Serializable
10+
{
11+
private $value;
12+
13+
public function __construct($value)
14+
{
15+
$this->value = $value;
16+
}
17+
18+
public function bsonSerialize()
19+
{
20+
return $this->value;
21+
}
22+
}
23+
24+
$invalidValues = array(new stdClass, 'foo', 1, true);
25+
26+
foreach ($invalidValues as $invalidValue) {
27+
try {
28+
BSON\fromArray(new MyClass($invalidValue));
29+
} catch (MongoDB\Driver\Exception\RuntimeException $e) {
30+
echo $e->getMessage(), "\n";
31+
}
32+
}
33+
34+
?>
35+
===DONE===
36+
<?php exit(0); ?>
37+
--EXPECT--
38+
Expected bsonSerialize() to return an array, object given
39+
Expected bsonSerialize() to return an array, string given
40+
Expected bsonSerialize() to return an array, integer given
41+
Expected bsonSerialize() to return an array, boolean given
42+
===DONE===

‎tests/bson/bson-encode_error-002.phpt‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
--TEST--
2+
BSON encoding error when bsonSerialize() for embedded document does not return an array
3+
--SKIPIF--
4+
<?php require __DIR__ . "/../utils/basic-skipif.inc"?>
5+
--FILE--
6+
<?php
7+
require_once __DIR__ . "/../utils/basic.inc";
8+
9+
class MyClass implements BSON\Serializable
10+
{
11+
private $value;
12+
13+
public function __construct($value)
14+
{
15+
$this->value = $value;
16+
}
17+
18+
public function bsonSerialize()
19+
{
20+
return $this->value;
21+
}
22+
}
23+
24+
$invalidValues = array(new stdClass, 'foo', 1, true);
25+
26+
foreach ($invalidValues as $invalidValue) {
27+
try {
28+
$bson = BSON\fromArray(array('embed' => new MyClass($invalidValue)));
29+
} catch (MongoDB\Driver\Exception\RuntimeException $e) {
30+
echo $e->getMessage(), "\n";
31+
}
32+
}
33+
34+
?>
35+
===DONE===
36+
<?php exit(0); ?>
37+
--EXPECT--
38+
Expected bsonSerialize() to return an array, object given
39+
Expected bsonSerialize() to return an array, string given
40+
Expected bsonSerialize() to return an array, integer given
41+
Expected bsonSerialize() to return an array, boolean given
42+
===DONE===

0 commit comments

Comments
 (0)