PHPC-2096: Implement Manager::getEncryptedFieldsMap()

PHPLIB will need to access the encryptedFieldsMap autoEncryption option.

Author: jmikola

src/MongoDB/Manager.c

@@ -608,6 +608,21 @@ static PHP_METHOD(Manager, executeBulkWrite)
 	}
 } /* }}} */
 
+/* {{{ proto array|object|null MongoDB\Driver\Manager::getEncryptedFieldsMap()
+   Returns the autoEncryption.encryptedFieldsMap driver option */
+static PHP_METHOD(Manager, getEncryptedFieldsMap)
+{
+	php_phongo_manager_t* intern;
+
+	intern = Z_MANAGER_OBJ_P(getThis());
+
+	PHONGO_PARSE_PARAMETERS_NONE();
+
+	if (!Z_ISUNDEF(intern->enc_fields_map)) {
+		RETURN_ZVAL(&intern->enc_fields_map, 1, 0);
+	}
+} /* }}} */
+
 /* {{{ proto MongoDB\Driver\ReadConcern MongoDB\Driver\Manager::getReadConcern()
    Returns the ReadConcern associated with this Manager */
 static PHP_METHOD(Manager, getReadConcern)
@@ -894,6 +909,7 @@ static zend_function_entry php_phongo_manager_me[] = {
 	PHP_ME(Manager, executeReadWriteCommand, ai_Manager_executeCommand, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
 	PHP_ME(Manager, executeQuery, ai_Manager_executeQuery, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
 	PHP_ME(Manager, executeBulkWrite, ai_Manager_executeBulkWrite, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
+	PHP_ME(Manager, getEncryptedFieldsMap, ai_Manager_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
 	PHP_ME(Manager, getReadConcern, ai_Manager_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
 	PHP_ME(Manager, getReadPreference, ai_Manager_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
 	PHP_ME(Manager, getServers, ai_Manager_void, ZEND_ACC_PUBLIC | ZEND_ACC_FINAL)
@@ -938,6 +954,10 @@ static void php_phongo_manager_free_object(zend_object* object) /* {{{ */
 		efree(intern->client_hash);
 	}
 
+	if (!Z_ISUNDEF(intern->enc_fields_map)) {
+		zval_ptr_dtor(&intern->enc_fields_map);
+	}
+
 	/* Free the keyVaultClient last to ensure that potential non-persistent
 	 * clients are destroyed in the correct order */
 	if (!Z_ISUNDEF(intern->key_vault_client_manager)) {

src/phongo_client.c

@@ -1303,6 +1303,10 @@ static bool phongo_manager_set_auto_encryption_opts(php_phongo_manager_t* manage
 		mongoc_auto_encryption_opts_set_encrypted_fields_map(auto_encryption_opts, &bson_map);
 
 		bson_destroy(&bson_map);
+
+		/* Copy the encryptedFieldsMap to the Manager since PHPLIB may need to
+		 * access it for createCollection and dropCollection helpers. */
+		ZVAL_ZVAL(&manager->enc_fields_map, enc_fields_map, 1, 0);
 	}
 
 	if (php_array_existsc(zAutoEncryptionOpts, "keyVaultClient")) {

src/phongo_structs.h

@@ -81,6 +81,7 @@ typedef struct {
 	char*            client_hash;
 	size_t           client_hash_len;
 	bool             use_persistent_client;
+	zval             enc_fields_map;
 	zval             key_vault_client_manager;
 	HashTable*       subscribers;
 	zend_object      std;

tests/manager/manager-getencryptedfieldsmap-001.phpt

@@ -0,0 +1,81 @@
+--TEST--
+MongoDB\Driver\Manager::getEncryptedFieldsMap()
+--FILE--
+<?php
+
+/* autoEncryption requires keyVaultNamespace and a kmsProvider. Additionally,
+ * disable mongocryptd spawning since it is not required for this test. */
+$baseOptions = [
+    'keyVaultNamespace' => 'encryption.__keyVault',
+    'kmsProviders' => ['local' => ['key' => new MongoDB\BSON\Binary(str_repeat('0', 96), 0)]],
+    'extraOptions' => ['mongocryptdBypassSpawn' => true],
+];
+
+$encryptedFields = [
+    'escCollection' => 'escCollectionName',
+    'eccCollection' => 'eccCollectionName',
+    'ecocCollection' => 'ecocCollectionName',
+    'fields' => [
+        [
+            'path' => 'foo',
+            'keyId' => new MongoDB\BSON\Binary(str_repeat('0', 16), MongoDB\BSON\Binary::TYPE_UUID),
+            'bsonType' => 'string',
+            'queries' => ['queryType' => 'equality'],
+        ],
+    ],
+];
+
+$tests = [
+    [],
+    ['autoEncryption' => $baseOptions],
+    ['autoEncryption' => ['encryptedFieldsMap' => []] + $baseOptions],
+    ['autoEncryption' => ['encryptedFieldsMap' => ['db.coll' => $encryptedFields]] + $baseOptions],
+];
+
+foreach ($tests as $i => $driverOptions) {
+    $manager = new MongoDB\Driver\Manager(null, [], $driverOptions);
+    var_dump($manager->getEncryptedFieldsMap());
+}
+
+?>
+===DONE===
+<?php exit(0); ?>
+--EXPECTF--
+NULL
+NULL
+array(0) {
+}
+array(1) {
+  ["db.coll"]=>
+  array(4) {
+    ["escCollection"]=>
+    string(17) "escCollectionName"
+    ["eccCollection"]=>
+    string(17) "eccCollectionName"
+    ["ecocCollection"]=>
+    string(18) "ecocCollectionName"
+    ["fields"]=>
+    array(1) {
+      [0]=>
+      array(4) {
+        ["path"]=>
+        string(3) "foo"
+        ["keyId"]=>
+        object(MongoDB\BSON\Binary)#%d (%d) {
+          ["data"]=>
+          string(16) "0000000000000000"
+          ["type"]=>
+          int(4)
+        }
+        ["bsonType"]=>
+        string(6) "string"
+        ["queries"]=>
+        array(1) {
+          ["queryType"]=>
+          string(8) "equality"
+        }
+      }
+    }
+  }
+}
+===DONE===