PHPC-682: Do not use mongoc_bulk_operation_t private API

This adds php_phongo_bulkwrite_t fields to track extra information that we report in the BulkWrite debug handler.

Author: jmikola

php_phongo.c

@@ -517,22 +517,32 @@ mongoc_bulk_operation_t *phongo_bulkwrite_init(zend_bool ordered) { /* {{{ */
 	return mongoc_bulk_operation_new(ordered);
 } /* }}} */
 
-bool phongo_execute_write(mongoc_client_t *client, const char *namespace, mongoc_bulk_operation_t *bulk, const mongoc_write_concern_t *write_concern, int server_id, zval *return_value, int return_value_used TSRMLS_DC) /* {{{ */
+bool phongo_execute_write(mongoc_client_t *client, const char *namespace, php_phongo_bulkwrite_t  *bulk_write, const mongoc_write_concern_t *write_concern, int server_id, zval *return_value, int return_value_used TSRMLS_DC) /* {{{ */
 {
 	bson_error_t error;
-	char *dbname;
-	char *collname;
 	int success;
 	bson_t reply = BSON_INITIALIZER;
+	mongoc_bulk_operation_t *bulk = bulk_write->bulk;
 	php_phongo_writeresult_t *writeresult;
 
-	if (!phongo_split_namespace(namespace, &dbname, &collname)) {
+	/* Since BulkWrite objects can currently be executed multiple times, ensure
+	 * that the database and collection name are freed before we overwrite them.
+	 * This may be removed once PHPC-676 is implemented. */
+	if (bulk_write->database) {
+		efree(bulk_write->database);
+	}
+
+	if (bulk_write->collection) {
+		efree(bulk_write->collection);
+	}
+
+	if (!phongo_split_namespace(namespace, &bulk_write->database, &bulk_write->collection)) {
 		phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT TSRMLS_CC, "%s: %s", "Invalid namespace provided", namespace);
 		return false;
 	}
 
-	mongoc_bulk_operation_set_database(bulk, dbname);
-	mongoc_bulk_operation_set_collection(bulk, collname);
+	mongoc_bulk_operation_set_database(bulk, bulk_write->database);
+	mongoc_bulk_operation_set_collection(bulk, bulk_write->collection);
 	mongoc_bulk_operation_set_client(bulk, client);
 
 	/* If a write concern was not specified, libmongoc will use the client's
@@ -543,14 +553,12 @@ bool phongo_execute_write(mongoc_client_t *client, const char *namespace, mongoc
 		write_concern = mongoc_client_get_write_concern(client);
 	}
 
-	efree(dbname);
-	efree(collname);
-
 	if (server_id > 0) {
 		mongoc_bulk_operation_set_hint(bulk, server_id);
 	}
 
 	success = mongoc_bulk_operation_execute(bulk, &reply, &error);
+	bulk_write->executed = true;
 
 	/* Write succeeded and the user doesn't care for the results */
 	if (success && !return_value_used) {

php_phongo.h

@@ -143,7 +143,7 @@ void                     phongo_readpreference_init  (zval *return_value, const
 void                     phongo_writeconcern_init    (zval *return_value, const mongoc_write_concern_t *write_concern TSRMLS_DC);
 bool                     phongo_query_init           (php_phongo_query_t *query, bson_t *filter, bson_t *options TSRMLS_DC);
 mongoc_bulk_operation_t* phongo_bulkwrite_init       (zend_bool ordered);
-bool                     phongo_execute_write        (mongoc_client_t *client, const char *namespace, mongoc_bulk_operation_t *bulk, const mongoc_write_concern_t *write_concern, int server_id, zval *return_value, int return_value_used TSRMLS_DC);
+bool                     phongo_execute_write        (mongoc_client_t *client, const char *namespace, php_phongo_bulkwrite_t  *bulk_write, const mongoc_write_concern_t *write_concern, int server_id, zval *return_value, int return_value_used TSRMLS_DC);
 int                      phongo_execute_command      (mongoc_client_t *client, const char *db,        const bson_t *command,           const mongoc_read_prefs_t *read_preference, int server_id, zval *return_value, int return_value_used TSRMLS_DC);
 int                      phongo_execute_query        (mongoc_client_t *client, const char *namespace, const php_phongo_query_t *query, const mongoc_read_prefs_t *read_preference, int server_id, zval *return_value, int return_value_used TSRMLS_DC);
 

php_phongo_structs-5.h

@@ -88,6 +88,10 @@ typedef struct {
 	zend_object              std;
 	mongoc_bulk_operation_t *bulk;
 	size_t                   num_ops;
+	bool                     ordered;
+	char                    *database;
+	char                    *collection;
+	bool                     executed;
 } php_phongo_bulkwrite_t;
 
 typedef struct {

php_phongo_structs-7.h

@@ -87,6 +87,10 @@ typedef struct {
 typedef struct {
 	mongoc_bulk_operation_t *bulk;
 	size_t                   num_ops;
+	bool                     ordered;
+	char                    *database;
+	char                    *collection;
+	bool                     executed;
 	zend_object              std;
 } php_phongo_bulkwrite_t;
 

src/MongoDB/BulkWrite.c

@@ -76,6 +76,7 @@ PHP_METHOD(BulkWrite, __construct)
 	}
 
 	intern->bulk = phongo_bulkwrite_init(ordered);
+	intern->ordered = ordered;
 	intern->num_ops = 0;
 
 	if (options && php_array_exists(options, "bypassDocumentValidation")) {
@@ -286,6 +287,14 @@ static void php_phongo_bulkwrite_free_object(phongo_free_object_arg *object TSRM
 		mongoc_bulk_operation_destroy(intern->bulk);
 	}
 
+	if (intern->database) {
+		efree(intern->database);
+	}
+
+	if (intern->collection) {
+		efree(intern->collection);
+	}
+
 #if PHP_VERSION_ID < 70000
 	efree(intern);
 #endif
@@ -329,20 +338,20 @@ HashTable *php_phongo_bulkwrite_get_debug_info(zval *object, int *is_temp TSRMLS
 	intern = Z_BULKWRITE_OBJ_P(object);
 	array_init(&retval);
 
-	if (intern->bulk->database) {
-		ADD_ASSOC_STRING(&retval, "database", intern->bulk->database);
+	if (intern->database) {
+		ADD_ASSOC_STRING(&retval, "database", intern->database);
 	} else {
 		ADD_ASSOC_NULL_EX(&retval, "database");
 	}
 
-	if (intern->bulk->collection) {
-		ADD_ASSOC_STRING(&retval, "collection", intern->bulk->collection);
+	if (intern->collection) {
+		ADD_ASSOC_STRING(&retval, "collection", intern->collection);
 	} else {
 		ADD_ASSOC_NULL_EX(&retval, "collection");
 	}
 
-	ADD_ASSOC_BOOL_EX(&retval, "ordered", intern->bulk->flags.ordered);
-	ADD_ASSOC_BOOL_EX(&retval, "executed", intern->bulk->executed);
+	ADD_ASSOC_BOOL_EX(&retval, "ordered", intern->ordered);
+	ADD_ASSOC_BOOL_EX(&retval, "executed", intern->executed);
 	ADD_ASSOC_LONG_EX(&retval, "server_id", mongoc_bulk_operation_get_hint(intern->bulk));
 
 	if (mongoc_bulk_operation_get_write_concern(intern->bulk)) {

src/MongoDB/Manager.c

@@ -152,7 +152,7 @@ PHP_METHOD(Manager, executeBulkWrite)
 
 
 	bulk = Z_BULKWRITE_OBJ_P(zbulk);
-	phongo_execute_write(intern->client, namespace, bulk->bulk, phongo_write_concern_from_zval(zwrite_concern TSRMLS_CC), -1, return_value, return_value_used TSRMLS_CC);
+	phongo_execute_write(intern->client, namespace, bulk, phongo_write_concern_from_zval(zwrite_concern TSRMLS_CC), -1, return_value, return_value_used TSRMLS_CC);
 }
 /* }}} */
 

src/MongoDB/Server.c

@@ -128,7 +128,7 @@ PHP_METHOD(Server, executeBulkWrite)
 
 
 	bulk = Z_BULKWRITE_OBJ_P(zbulk);
-	phongo_execute_write(intern->client, namespace, bulk->bulk, phongo_write_concern_from_zval(zwrite_concern TSRMLS_CC), intern->server_id, return_value, return_value_used TSRMLS_CC);
+	phongo_execute_write(intern->client, namespace, bulk, phongo_write_concern_from_zval(zwrite_concern TSRMLS_CC), intern->server_id, return_value, return_value_used TSRMLS_CC);
 }
 /* }}} */
 /* {{{ proto string Server::getHost()