BulkWriteCommand ctor and insertOne

Author: jmikola

config.m4

@@ -168,6 +168,7 @@ if test "$PHP_MONGODB" != "no"; then
     src/BSON/UTCDateTimeInterface.c \
     src/BSON/functions.c \
     src/MongoDB/BulkWrite.c \
+    src/MongoDB/BulkWriteCommand.c \
     src/MongoDB/ClientEncryption.c \
     src/MongoDB/Command.c \
     src/MongoDB/Cursor.c \

config.w32

@@ -116,7 +116,7 @@ if (PHP_MONGODB != "no") {
   EXTENSION("mongodb", "php_phongo.c", null, PHP_MONGODB_CFLAGS);
   MONGODB_ADD_SOURCES("/src", "phongo_apm.c phongo_atomic.c phongo_bson.c phongo_bson_encode.c phongo_client.c phongo_compat.c phongo_error.c phongo_execute.c phongo_ini.c phongo_log.c phongo_util.c");
   MONGODB_ADD_SOURCES("/src/BSON", "Binary.c BinaryInterface.c Document.c Iterator.c DBPointer.c Decimal128.c Decimal128Interface.c Int64.c Javascript.c JavascriptInterface.c MaxKey.c MaxKeyInterface.c MinKey.c MinKeyInterface.c ObjectId.c ObjectIdInterface.c PackedArray.c Persistable.c Regex.c RegexInterface.c Serializable.c Symbol.c Timestamp.c TimestampInterface.c Type.c Undefined.c Unserializable.c UTCDateTime.c UTCDateTimeInterface.c functions.c");
-  MONGODB_ADD_SOURCES("/src/MongoDB", "BulkWrite.c ClientEncryption.c Command.c Cursor.c CursorId.c CursorInterface.c Manager.c Query.c ReadConcern.c ReadPreference.c Server.c ServerApi.c ServerDescription.c Session.c TopologyDescription.c WriteConcern.c WriteConcernError.c WriteError.c WriteResult.c");
+  MONGODB_ADD_SOURCES("/src/MongoDB", "BulkWrite.c BulkWriteCommand.c ClientEncryption.c Command.c Cursor.c CursorId.c CursorInterface.c Manager.c Query.c ReadConcern.c ReadPreference.c Server.c ServerApi.c ServerDescription.c Session.c TopologyDescription.c WriteConcern.c WriteConcernError.c WriteError.c WriteResult.c");
   MONGODB_ADD_SOURCES("/src/MongoDB/Exception", "AuthenticationException.c BulkWriteException.c CommandException.c ConnectionException.c ConnectionTimeoutException.c EncryptionException.c Exception.c ExecutionTimeoutException.c InvalidArgumentException.c LogicException.c RuntimeException.c ServerException.c SSLConnectionException.c UnexpectedValueException.c WriteException.c");
   MONGODB_ADD_SOURCES("/src/MongoDB/Monitoring", "CommandFailedEvent.c CommandStartedEvent.c CommandSubscriber.c CommandSucceededEvent.c LogSubscriber.c SDAMSubscriber.c Subscriber.c ServerChangedEvent.c ServerClosedEvent.c ServerHeartbeatFailedEvent.c ServerHeartbeatStartedEvent.c ServerHeartbeatSucceededEvent.c ServerOpeningEvent.c TopologyChangedEvent.c TopologyClosedEvent.c TopologyOpeningEvent.c functions.c");
   MONGODB_ADD_SOURCES("/src/libmongoc/src/common/src", PHP_MONGODB_COMMON_SOURCES);

php_phongo.c

@@ -252,6 +252,7 @@ PHP_MINIT_FUNCTION(mongodb) /* {{{ */
 	php_phongo_cursor_interface_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 
 	php_phongo_bulkwrite_init_ce(INIT_FUNC_ARGS_PASSTHRU);
+	php_phongo_bulkwritecommand_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_clientencryption_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_command_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_cursor_init_ce(INIT_FUNC_ARGS_PASSTHRU);

src/MongoDB/BulkWriteCommand.c

@@ -0,0 +1,360 @@
+/*
+ * Copyright 2024-present MongoDB, Inc.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *   http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#include "bson/bson.h"
+#include "mongoc/mongoc.h"
+
+#include <php.h>
+#include <Zend/zend_interfaces.h>
+
+#include "php_array_api.h"
+
+#include "php_phongo.h"
+#include "phongo_bson_encode.h"
+#include "phongo_error.h"
+#include "BulkWriteCommand_arginfo.h"
+
+#include "MongoDB/WriteConcern.h"
+
+#define PHONGO_BULKWRITECOMMAND_BYPASS_UNSET -1
+
+zend_class_entry* php_phongo_bulkwritecommand_ce;
+
+// TODO: Make this a common utility function to share with BulkWrite.c
+/* Extracts the "_id" field of a BSON document into a return value. */
+static void php_phongo_bulkwritecommand_extract_id(bson_t* doc, zval** return_value)
+{
+	zval*                 id = NULL;
+	php_phongo_bson_state state;
+
+	PHONGO_BSON_INIT_STATE(state);
+	state.map.root.type = PHONGO_TYPEMAP_NATIVE_ARRAY;
+
+	/* TODO: Instead of converting the entire document, iterate BSON to obtain
+	 * the bson_value_t of the _id field and then use phongo_bson_value_to_zval
+	 * or phongo_bson_value_to_zval_legacy to populate the return value. */
+	if (!php_phongo_bson_to_zval_ex(doc, &state)) {
+		goto cleanup;
+	}
+
+	id = php_array_fetchc(&state.zchild, "_id");
+
+	if (id) {
+		ZVAL_ZVAL(*return_value, id, 1, 0);
+	}
+
+cleanup:
+	zval_ptr_dtor(&state.zchild);
+}
+
+/* Constructs a new BulkWrite */
+static PHP_METHOD(MongoDB_Driver_BulkWriteCommand, __construct)
+{
+	php_phongo_bulkwritecommand_t* intern;
+	zval*                          options = NULL;
+
+	intern = Z_BULKWRITECOMMAND_OBJ_P(getThis());
+
+	PHONGO_PARSE_PARAMETERS_START(0, 1)
+	Z_PARAM_OPTIONAL
+	Z_PARAM_ARRAY_OR_NULL(options)
+	PHONGO_PARSE_PARAMETERS_END();
+
+	// TODO: Consider removing initialization for zero values
+	intern->bw      = mongoc_bulkwrite_new();
+	intern->bypass  = PHONGO_BULKWRITECOMMAND_BYPASS_UNSET;
+	intern->comment = NULL;
+	intern->let     = NULL;
+	intern->num_ops = 0;
+	intern->ordered = true;
+	intern->verbose = false;
+
+	if (!options) {
+		return;
+	}
+
+	if (php_array_existsc(options, "bypassDocumentValidation")) {
+		intern->bypass = php_array_fetchc_bool(options, "bypassDocumentValidation") ? 1 : 0;
+	}
+
+	if (php_array_existsc(options, "comment")) {
+		zval* value = php_array_fetchc_deref(options, "comment");
+
+		intern->comment = ecalloc(1, sizeof(bson_value_t));
+		phongo_zval_to_bson_value(value, intern->comment);
+
+		if (EG(exception)) {
+			return;
+		}
+	}
+
+	if (php_array_existsc(options, "let")) {
+		zval* value = php_array_fetchc_deref(options, "let");
+
+		if (Z_TYPE_P(value) != IS_OBJECT && Z_TYPE_P(value) != IS_ARRAY) {
+			phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT, "Expected \"let\" option to be array or object, %s given", zend_get_type_by_const(Z_TYPE_P(value)));
+			return;
+		}
+
+		intern->let = bson_new();
+		php_phongo_zval_to_bson(value, PHONGO_BSON_NONE, intern->let, NULL);
+
+		if (EG(exception)) {
+			return;
+		}
+	}
+
+	if (php_array_existsc(options, "ordered")) {
+		intern->ordered = php_array_fetchc_bool(options, "ordered");
+	}
+
+	if (php_array_existsc(options, "verboseResults")) {
+		intern->verbose = php_array_fetchc_bool(options, "verboseResults");
+	}
+}
+
+static PHP_METHOD(MongoDB_Driver_BulkWriteCommand, count)
+{
+	php_phongo_bulkwritecommand_t* intern;
+
+	intern = Z_BULKWRITECOMMAND_OBJ_P(getThis());
+
+	PHONGO_PARSE_PARAMETERS_NONE();
+
+	RETURN_LONG(intern->num_ops);
+}
+
+static PHP_METHOD(MongoDB_Driver_BulkWriteCommand, deleteMany)
+{
+	php_phongo_bulkwritecommand_t* intern;
+
+	intern = Z_BULKWRITECOMMAND_OBJ_P(getThis());
+
+	// TODO: implementation
+	PHONGO_PARSE_PARAMETERS_NONE();
+}
+
+static PHP_METHOD(MongoDB_Driver_BulkWriteCommand, deleteOne)
+{
+	php_phongo_bulkwritecommand_t* intern;
+
+	intern = Z_BULKWRITECOMMAND_OBJ_P(getThis());
+
+	// TODO: implementation
+	PHONGO_PARSE_PARAMETERS_NONE();
+}
+
+static PHP_METHOD(MongoDB_Driver_BulkWriteCommand, execute)
+{
+	php_phongo_bulkwritecommand_t* intern;
+
+	intern = Z_BULKWRITECOMMAND_OBJ_P(getThis());
+
+	PHONGO_PARSE_PARAMETERS_NONE();
+
+	RETURN_LONG(intern->num_ops);
+}
+
+static PHP_METHOD(MongoDB_Driver_BulkWriteCommand, insertOne)
+{
+	php_phongo_bulkwritecommand_t* intern;
+	char*                          ns;
+	size_t                         ns_len;
+	zval*                          zdocument;
+	bson_t                         bdocument = BSON_INITIALIZER;
+	bson_t*                        bson_out  = NULL;
+	bson_error_t                   error     = { 0 };
+
+	intern = Z_BULKWRITECOMMAND_OBJ_P(getThis());
+
+	PHONGO_PARSE_PARAMETERS_START(2, 2)
+	Z_PARAM_STRING(ns, ns_len)
+	Z_PARAM_ARRAY_OR_OBJECT(zdocument)
+	PHONGO_PARSE_PARAMETERS_END();
+
+	if (strlen(ns) != ns_len) {
+		phongo_throw_exception(PHONGO_ERROR_INVALID_ARGUMENT, "Namespace string should not contain null bytes");
+		return;
+	}
+
+	php_phongo_zval_to_bson(zdocument, (PHONGO_BSON_ADD_ID | PHONGO_BSON_RETURN_ID), &bdocument, &bson_out);
+
+	if (EG(exception)) {
+		goto cleanup;
+	}
+
+	if (!mongoc_bulkwrite_append_insertone(intern->bw, ns, &bdocument, NULL, &error)) {
+		phongo_throw_exception_from_bson_error_t(&error);
+		goto cleanup;
+	}
+
+	intern->num_ops++;
+
+	if (!bson_out) {
+		phongo_throw_exception(PHONGO_ERROR_LOGIC, "php_phongo_zval_to_bson() did not return document identifier. Please file a bug report.");
+		goto cleanup;
+	}
+
+	php_phongo_bulkwritecommand_extract_id(bson_out, &return_value);
+
+cleanup:
+	bson_destroy(&bdocument);
+	bson_clear(&bson_out);
+}
+
+static PHP_METHOD(MongoDB_Driver_BulkWriteCommand, replaceOne)
+{
+	php_phongo_bulkwritecommand_t* intern;
+
+	intern = Z_BULKWRITECOMMAND_OBJ_P(getThis());
+
+	// TODO: implementation
+	PHONGO_PARSE_PARAMETERS_NONE();
+}
+
+static PHP_METHOD(MongoDB_Driver_BulkWriteCommand, updateMany)
+{
+	php_phongo_bulkwritecommand_t* intern;
+
+	intern = Z_BULKWRITECOMMAND_OBJ_P(getThis());
+
+	// TODO: implementation
+	PHONGO_PARSE_PARAMETERS_NONE();
+}
+
+static PHP_METHOD(MongoDB_Driver_BulkWriteCommand, updateOne)
+{
+	php_phongo_bulkwritecommand_t* intern;
+
+	intern = Z_BULKWRITECOMMAND_OBJ_P(getThis());
+
+	// TODO: implementation
+	PHONGO_PARSE_PARAMETERS_NONE();
+}
+
+/* MongoDB\Driver\BulkWriteCommand object handlers */
+static zend_object_handlers php_phongo_handler_bulkwritecommand;
+
+static void php_phongo_bulkwritecommand_free_object(zend_object* object)
+{
+	php_phongo_bulkwritecommand_t* intern = Z_OBJ_BULKWRITECOMMAND(object);
+
+	zend_object_std_dtor(&intern->std);
+
+	if (intern->bw) {
+		mongoc_bulkwrite_destroy(intern->bw);
+	}
+
+	if (intern->let) {
+		bson_clear(&intern->let);
+	}
+
+	if (intern->comment) {
+		bson_value_destroy(intern->comment);
+		efree(intern->comment);
+	}
+
+	if (!Z_ISUNDEF(intern->session)) {
+		zval_ptr_dtor(&intern->session);
+	}
+
+	if (intern->write_concern) {
+		mongoc_write_concern_destroy(intern->write_concern);
+	}
+}
+
+static zend_object* php_phongo_bulkwritecommand_create_object(zend_class_entry* class_type)
+{
+	php_phongo_bulkwritecommand_t* intern = zend_object_alloc(sizeof(php_phongo_bulkwritecommand_t), class_type);
+
+	zend_object_std_init(&intern->std, class_type);
+	object_properties_init(&intern->std, class_type);
+
+	intern->std.handlers = &php_phongo_handler_bulkwritecommand;
+
+	return &intern->std;
+}
+
+static HashTable* php_phongo_bulkwritecommand_get_debug_info(zend_object* object, int* is_temp)
+{
+	zval                           retval = ZVAL_STATIC_INIT;
+	php_phongo_bulkwritecommand_t* intern = NULL;
+
+	*is_temp = 1;
+	intern   = Z_OBJ_BULKWRITECOMMAND(object);
+	array_init(&retval);
+
+	if (intern->bypass != PHONGO_BULKWRITECOMMAND_BYPASS_UNSET) {
+		ADD_ASSOC_BOOL_EX(&retval, "bypassDocumentValidation", intern->bypass);
+	} else {
+		ADD_ASSOC_NULL_EX(&retval, "bypassDocumentValidation");
+	}
+
+	if (intern->comment) {
+		zval zv;
+
+		if (!phongo_bson_value_to_zval_legacy(intern->comment, &zv)) {
+			zval_ptr_dtor(&zv);
+			goto done;
+		}
+
+		ADD_ASSOC_ZVAL_EX(&retval, "comment", &zv);
+	}
+
+	if (intern->let) {
+		zval zv;
+
+		if (!php_phongo_bson_to_zval(intern->let, &zv)) {
+			zval_ptr_dtor(&zv);
+			goto done;
+		}
+
+		ADD_ASSOC_ZVAL_EX(&retval, "let", &zv);
+	}
+
+	ADD_ASSOC_BOOL_EX(&retval, "ordered", intern->ordered);
+	ADD_ASSOC_BOOL_EX(&retval, "verboseResults", intern->verbose);
+
+	if (!Z_ISUNDEF(intern->session)) {
+		ADD_ASSOC_ZVAL_EX(&retval, "session", &intern->session);
+		Z_ADDREF(intern->session);
+	} else {
+		ADD_ASSOC_NULL_EX(&retval, "session");
+	}
+
+	if (intern->write_concern) {
+		zval write_concern;
+
+		php_phongo_write_concern_to_zval(&write_concern, intern->write_concern);
+		ADD_ASSOC_ZVAL_EX(&retval, "write_concern", &write_concern);
+	} else {
+		ADD_ASSOC_NULL_EX(&retval, "write_concern");
+	}
+
+done:
+	return Z_ARRVAL(retval);
+}
+
+void php_phongo_bulkwritecommand_init_ce(INIT_FUNC_ARGS)
+{
+	php_phongo_bulkwritecommand_ce                = register_class_MongoDB_Driver_BulkWriteCommand(zend_ce_countable);
+	php_phongo_bulkwritecommand_ce->create_object = php_phongo_bulkwritecommand_create_object;
+
+	memcpy(&php_phongo_handler_bulkwritecommand, phongo_get_std_object_handlers(), sizeof(zend_object_handlers));
+	php_phongo_handler_bulkwritecommand.get_debug_info = php_phongo_bulkwritecommand_get_debug_info;
+	php_phongo_handler_bulkwritecommand.free_obj       = php_phongo_bulkwritecommand_free_object;
+	php_phongo_handler_bulkwritecommand.offset         = XtOffsetOf(php_phongo_bulkwritecommand_t, std);
+}