Merge pull request #842

jmikola · jmikola · commit f26f78ed9469 · 2018-05-25T12:19:27.000-04:00
diff --git a/src/MongoDB/BulkWrite.c b/src/MongoDB/BulkWrite.c
@@ -73,15 +73,79 @@ static inline bool php_phongo_bulkwrite_update_has_operators(bson_t* bupdate) /*
 	return false;
 } /* }}} */
 
+/* Returns whether the BSON array's keys are a sequence of integer strings
+ * starting with "0". BSON_APPEND_ARRAY considers it the caller's responsibility
+ * to ensure that the array's keys are properly formatted. */
+static inline bool php_phongo_bulkwrite_bson_array_has_valid_keys(bson_t* array) /* {{{ */
+{
+	bson_iter_t iter;
+
+	if (bson_empty(array)) {
+		return true;
+	}
+
+	if (bson_iter_init(&iter, array)) {
+		char key[12];
+		int  count = 0;
+
+		while (bson_iter_next(&iter)) {
+			bson_snprintf(key, sizeof(key), "%d", count);
+
+			if (0 != strcmp(key, bson_iter_key(&iter))) {
+				return false;
+			}
+
+			count++;
+		}
+	}
+
+	return true;
+} /* }}} */
+
+/* Appends an array field for the given opts document and key. Returns true on
+ * success; otherwise, false is returned and an exception is thrown. */
+static bool php_phongo_bulkwrite_opts_append_array(bson_t* opts, const char* key, zval* zarr TSRMLS_DC) /* {{{ */
+{
+	zval*  value = php_array_fetch(zarr, key);
+	bson_t b     = BSON_INITIALIZER;
+
+	if (Z_TYPE_P(value) != IS_OBJECT && Z_TYPE_P(value) != IS_ARRAY) {
+		phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "Expected \"%s\" option to be array or object, %s given", key, zend_get_type_by_const(Z_TYPE_P(value)));
+		return false;
+	}
+
+	php_phongo_zval_to_bson(value, PHONGO_BSON_NONE, &b, NULL TSRMLS_CC);
+
+	if (EG(exception)) {
+		bson_destroy(&b);
+		return false;
+	}
+
+	if (!php_phongo_bulkwrite_bson_array_has_valid_keys(&b)) {
+		phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "\"%s\" option has invalid keys for a BSON array", key);
+		bson_destroy(&b);
+		return false;
+	}
+
+	if (!BSON_APPEND_ARRAY(opts, key, &b)) {
+		phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "Error appending \"%s\" option", key);
+		bson_destroy(&b);
+		return false;
+	}
+
+	bson_destroy(&b);
+	return true;
+} /* }}} */
+
 /* Appends a document field for the given opts document and key. Returns true on
  * success; otherwise, false is returned and an exception is thrown. */
-static bool php_phongo_bulkwrite_opts_append_document(bson_t* opts, const char* opts_key, zval* zarr, const char* zarr_key TSRMLS_DC) /* {{{ */
+static bool php_phongo_bulkwrite_opts_append_document(bson_t* opts, const char* key, zval* zarr TSRMLS_DC) /* {{{ */
 {
-	zval*  value = php_array_fetch(zarr, zarr_key);
+	zval*  value = php_array_fetch(zarr, key);
 	bson_t b     = BSON_INITIALIZER;
 
 	if (Z_TYPE_P(value) != IS_OBJECT && Z_TYPE_P(value) != IS_ARRAY) {
-		phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "Expected \"%s\" option to be array or object, %s given", zarr_key, zend_get_type_by_const(Z_TYPE_P(value)));
+		phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "Expected \"%s\" option to be array or object, %s given", key, zend_get_type_by_const(Z_TYPE_P(value)));
 		return false;
 	}
 
@@ -92,8 +156,8 @@ static bool php_phongo_bulkwrite_opts_append_document(bson_t* opts, const char*
 		return false;
 	}
 
-	if (!BSON_APPEND_DOCUMENT(opts, opts_key, &b)) {
-		phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "Error appending \"%s\" option", opts_key);
+	if (!BSON_APPEND_DOCUMENT(opts, key, &b)) {
+		phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "Error appending \"%s\" option", key);
 		bson_destroy(&b);
 		return false;
 	}
@@ -114,11 +178,18 @@ static bool php_phongo_bulkwrite_opts_append_document(bson_t* opts, const char*
 		return false;                                                                                            \
 	}
 
-#define PHONGO_BULKWRITE_OPT_DOCUMENT(opt)                                                            \
-	if (zoptions && php_array_existsc(zoptions, (opt))) {                                             \
-		if (!php_phongo_bulkwrite_opts_append_document(boptions, (opt), zoptions, (opt) TSRMLS_CC)) { \
-			return false;                                                                             \
-		}                                                                                             \
+#define PHONGO_BULKWRITE_OPT_ARRAY(opt)                                                     \
+	if (zoptions && php_array_existsc(zoptions, (opt))) {                                   \
+		if (!php_phongo_bulkwrite_opts_append_array(boptions, (opt), zoptions TSRMLS_CC)) { \
+			return false;                                                                   \
+		}                                                                                   \
+	}
+
+#define PHONGO_BULKWRITE_OPT_DOCUMENT(opt)                                                     \
+	if (zoptions && php_array_existsc(zoptions, (opt))) {                                      \
+		if (!php_phongo_bulkwrite_opts_append_document(boptions, (opt), zoptions TSRMLS_CC)) { \
+			return false;                                                                      \
+		}                                                                                      \
 	}
 
 /* Applies options (including defaults) for an update operation. */
@@ -137,7 +208,7 @@ static bool php_phongo_bulkwrite_update_apply_options(bson_t* boptions, zval* zo
 
 	PHONGO_BULKWRITE_APPEND_BOOL("multi", multi);
 	PHONGO_BULKWRITE_APPEND_BOOL("upsert", upsert);
-	PHONGO_BULKWRITE_OPT_DOCUMENT("arrayFilters");
+	PHONGO_BULKWRITE_OPT_ARRAY("arrayFilters");
 	PHONGO_BULKWRITE_OPT_DOCUMENT("collation");
 
 	return true;
diff --git a/src/libmongoc b/src/libmongoc
@@ -1 +1 @@
-Subproject commit 1cb8a16e863cea77a61530b832ed2c7c1dc5c065
+Subproject commit a0e727561d7eaff310c91577c854e7970ff9251c
diff --git a/tests/bulk/bulkwrite-update-arrayFilters-001.phpt b/tests/bulk/bulkwrite-update-arrayFilters-001.phpt
@@ -1,15 +1,15 @@
 --TEST--
 MongoDB\Driver\BulkWrite::update with arrayFilters
---XFAIL--
-START() tests must be reimplemented (PHPC-1179)
 --SKIPIF--
 <?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
-<?php START('THROWAWAY', ["version" => "36-release"]); CLEANUP(THROWAWAY); ?>
+<?php skip_if_not_live(); ?>
+<?php skip_if_server_version('<', '3.6'); ?>
+<?php skip_if_not_clean(); ?>
 --FILE--
 <?php
 require_once __DIR__ . "/../utils/basic.inc";
 
-$manager = new MongoDB\Driver\Manager(THROWAWAY);
+$manager = new MongoDB\Driver\Manager(URI);
 
 $bulk = new MongoDB\Driver\BulkWrite();
 
@@ -35,11 +35,7 @@ $cursor = $manager->executeQuery( DATABASE_NAME . '.' . COLLECTION_NAME, new \Mo
 var_dump($cursor->toArray());
 ?>
 ===DONE===
-<?php DELETE("THROWAWAY"); ?>
 <?php exit(0); ?>
---CLEAN--
-<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
-<?php DELETE("THROWAWAY"); ?>
 --EXPECTF--
 array(%d) {
   [0]=>
diff --git a/tests/bulk/bulkwrite-update_error-003.phpt b/tests/bulk/bulkwrite-update_error-003.phpt
@@ -17,6 +17,14 @@ echo throws(function() use ($bulk) {
 
 echo throws(function() use ($bulk) {
     $bulk->update(['x' => 1], ['$set' => ['y' => 1]], ['collation' => 1]);
+}, 'MongoDB\Driver\Exception\InvalidArgumentException'), "\n\n";
+
+echo throws(function() use ($bulk) {
+    $bulk->update(['x' => 1], ['$set' => ['y' => 1]], ['arrayFilters' => 1]);
+}, 'MongoDB\Driver\Exception\InvalidArgumentException'), "\n\n";
+
+echo throws(function() use ($bulk) {
+    $bulk->update(['x' => 1], ['$set' => ['y' => 1]], ['arrayFilters' => ['foo' => 'bar']]);
 }, 'MongoDB\Driver\Exception\InvalidArgumentException'), "\n";
 
 ?>
@@ -31,4 +39,10 @@ Expected "collation" option to be array or object, int%S given
 
 OK: Got MongoDB\Driver\Exception\InvalidArgumentException
 Expected "collation" option to be array or object, int%S given
+
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+Expected "arrayFilters" option to be array or object, int%S given
+
+OK: Got MongoDB\Driver\Exception\InvalidArgumentException
+"arrayFilters" option has invalid keys for a BSON array
 ===DONE===
diff --git a/tests/command/findAndModify-001.phpt b/tests/command/findAndModify-001.phpt
@@ -1,15 +1,15 @@
 --TEST--
 MongoDB\Driver\Command with findAndModify and arrayFilters
---XFAIL--
-START() tests must be reimplemented (PHPC-1179)
 --SKIPIF--
 <?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
-<?php START('THROWAWAY', ["version" => "36-release"]); CLEANUP(THROWAWAY); ?>
+<?php skip_if_not_live(); ?>
+<?php skip_if_server_version('<', '3.6'); ?>
+<?php skip_if_not_clean(); ?>
 --FILE--
 <?php
 require_once __DIR__ . "/../utils/basic.inc";
 
-$manager = new MongoDB\Driver\Manager(THROWAWAY);
+$manager = new MongoDB\Driver\Manager(URI);
 
 $bulk = new MongoDB\Driver\BulkWrite();
 
@@ -35,11 +35,7 @@ $cursor = $manager->executeQuery( DATABASE_NAME . '.' . COLLECTION_NAME, new \Mo
 var_dump($cursor->toArray());
 ?>
 ===DONE===
-<?php DELETE("THROWAWAY"); ?>
 <?php exit(0); ?>
---CLEAN--
-<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
-<?php DELETE("THROWAWAY"); ?>
 --EXPECTF--
 array(%d) {
   [0]=>
diff --git a/tests/command/update-001.phpt b/tests/command/update-001.phpt
@@ -1,15 +1,15 @@
 --TEST--
 MongoDB\Driver\Command with update and arrayFilters
---XFAIL--
-START() tests must be reimplemented (PHPC-1179)
 --SKIPIF--
 <?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
-<?php START('THROWAWAY', ["version" => "36-release"]); CLEANUP(THROWAWAY); ?>
+<?php skip_if_not_live(); ?>
+<?php skip_if_server_version('<', '3.6'); ?>
+<?php skip_if_not_clean(); ?>
 --FILE--
 <?php
 require_once __DIR__ . "/../utils/basic.inc";
 
-$manager = new MongoDB\Driver\Manager(THROWAWAY);
+$manager = new MongoDB\Driver\Manager(URI);
 
 $bulk = new MongoDB\Driver\BulkWrite();
 
@@ -35,11 +35,7 @@ $cursor = $manager->executeQuery( DATABASE_NAME . '.' . COLLECTION_NAME, new \Mo
 var_dump($cursor->toArray());
 ?>
 ===DONE===
-<?php DELETE("THROWAWAY"); ?>
 <?php exit(0); ?>
---CLEAN--
-<?php require __DIR__ . "/../utils/basic-skipif.inc"; ?>
-<?php DELETE("THROWAWAY"); ?>
 --EXPECTF--
 array(%d) {
   [0]=>
