PHPC-1027: Introduce classes for deprecated BSON types (Undefined)

Author: derickr

config.m4

@@ -174,6 +174,7 @@ if test "$MONGODB" != "no"; then
     src/BSON/Timestamp.c \
     src/BSON/TimestampInterface.c \
     src/BSON/Type.c \
+    src/BSON/Undefined.c \
     src/BSON/Unserializable.c \
     src/BSON/UTCDateTime.c \
     src/BSON/UTCDateTimeInterface.c \

config.w32

@@ -84,7 +84,7 @@ if (PHP_MONGODB != "no") {
 
   EXTENSION("mongodb", "php_phongo.c phongo_compat.c", null, PHP_MONGODB_CFLAGS);
   ADD_SOURCES(configure_module_dirname + "/src", "bson.c bson-encode.c", "mongodb");
-  ADD_SOURCES(configure_module_dirname + "/src/BSON", "Binary.c BinaryInterface.c Decimal128.c Decimal128Interface.c Javascript.c JavascriptInterface.c MaxKey.c MaxKeyInterface.c MinKey.c MinKeyInterface.c ObjectId.c ObjectIdInterface.c Persistable.c Regex.c RegexInterface.c Serializable.c Timestamp.c TimestampInterface.c Type.c Unserializable.c UTCDateTime.c UTCDateTimeInterface.c functions.c", "mongodb");
+  ADD_SOURCES(configure_module_dirname + "/src/BSON", "Binary.c BinaryInterface.c Decimal128.c Decimal128Interface.c Javascript.c JavascriptInterface.c MaxKey.c MaxKeyInterface.c MinKey.c MinKeyInterface.c ObjectId.c ObjectIdInterface.c Persistable.c Regex.c RegexInterface.c Serializable.c Timestamp.c TimestampInterface.c Type.c Undefined.c Unserializable.c UTCDateTime.c UTCDateTimeInterface.c functions.c", "mongodb");
   ADD_SOURCES(configure_module_dirname + "/src/MongoDB", "BulkWrite.c Command.c Cursor.c CursorId.c Manager.c Query.c ReadConcern.c ReadPreference.c Server.c WriteConcern.c WriteConcernError.c WriteError.c WriteResult.c", "mongodb");
   ADD_SOURCES(configure_module_dirname + "/src/MongoDB/Exception", "AuthenticationException.c BulkWriteException.c ConnectionException.c ConnectionTimeoutException.c Exception.c ExecutionTimeoutException.c InvalidArgumentException.c LogicException.c RuntimeException.c SSLConnectionException.c UnexpectedValueException.c WriteException.c", "mongodb");
   ADD_SOURCES(configure_module_dirname + "/src/MongoDB/Monitoring", "CommandFailedEvent.c CommandStartedEvent.c CommandSubscriber.c CommandSucceededEvent.c Subscriber.c functions.c", "mongodb");

php_phongo.c

@@ -2655,6 +2655,7 @@ PHP_MINIT_FUNCTION(mongodb)
 	php_phongo_persistable_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_regex_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_timestamp_init_ce(INIT_FUNC_ARGS_PASSTHRU);
+	php_phongo_undefined_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 	php_phongo_utcdatetime_init_ce(INIT_FUNC_ARGS_PASSTHRU);
 
 	php_phongo_bulkwrite_init_ce(INIT_FUNC_ARGS_PASSTHRU);

php_phongo_classes.h

@@ -88,6 +88,9 @@ static inline php_phongo_regex_t* php_regex_fetch_object(zend_object *obj) {
 static inline php_phongo_timestamp_t* php_timestamp_fetch_object(zend_object *obj) {
     return (php_phongo_timestamp_t *)((char *)obj - XtOffsetOf(php_phongo_timestamp_t, std));
 }
+static inline php_phongo_undefined_t* php_undefined_fetch_object(zend_object *obj) {
+    return (php_phongo_undefined_t *)((char *)obj - XtOffsetOf(php_phongo_undefined_t, std));
+}
 static inline php_phongo_utcdatetime_t* php_utcdatetime_fetch_object(zend_object *obj) {
     return (php_phongo_utcdatetime_t *)((char *)obj - XtOffsetOf(php_phongo_utcdatetime_t, std));
 }
@@ -122,6 +125,7 @@ static inline php_phongo_commandsucceededevent_t* php_commandsucceededevent_fetc
 # define Z_OBJECTID_OBJ_P(zv)          (php_objectid_fetch_object(Z_OBJ_P(zv)))
 # define Z_REGEX_OBJ_P(zv)             (php_regex_fetch_object(Z_OBJ_P(zv)))
 # define Z_TIMESTAMP_OBJ_P(zv)         (php_timestamp_fetch_object(Z_OBJ_P(zv)))
+# define Z_UNDEFINED_OBJ_P(zv)         (php_undefined_fetch_object(Z_OBJ_P(zv)))
 # define Z_UTCDATETIME_OBJ_P(zv)       (php_utcdatetime_fetch_object(Z_OBJ_P(zv)))
 # define Z_COMMANDFAILEDEVENT_OBJ_P(zv)    (php_commandfailedevent_fetch_object(Z_OBJ_P(zv)))
 # define Z_COMMANDSTARTEDEVENT_OBJ_P(zv)   (php_commandstartedevent_fetch_object(Z_OBJ_P(zv)))
@@ -148,6 +152,7 @@ static inline php_phongo_commandsucceededevent_t* php_commandsucceededevent_fetc
 # define Z_OBJ_OBJECTID(zo)            (php_objectid_fetch_object(zo))
 # define Z_OBJ_REGEX(zo)               (php_regex_fetch_object(zo))
 # define Z_OBJ_TIMESTAMP(zo)           (php_timestamp_fetch_object(zo))
+# define Z_OBJ_UNDEFINED(zo)           (php_undefined_fetch_object(zo))
 # define Z_OBJ_UTCDATETIME(zo)         (php_utcdatetime_fetch_object(zo))
 # define Z_OBJ_COMMANDFAILEDEVENT(zo)    (php_commandfailedevent_fetch_object(zo))
 # define Z_OBJ_COMMANDSTARTEDEVENT(zo)   (php_commandstartedevent_fetch_object(zo))
@@ -176,6 +181,7 @@ static inline php_phongo_commandsucceededevent_t* php_commandsucceededevent_fetc
 # define Z_OBJECTID_OBJ_P(zv)          ((php_phongo_objectid_t *)zend_object_store_get_object(zv TSRMLS_CC))
 # define Z_REGEX_OBJ_P(zv)             ((php_phongo_regex_t *)zend_object_store_get_object(zv TSRMLS_CC))
 # define Z_TIMESTAMP_OBJ_P(zv)         ((php_phongo_timestamp_t *)zend_object_store_get_object(zv TSRMLS_CC))
+# define Z_UNDEFINED_OBJ_P(zv)         ((php_phongo_undefined_t *)zend_object_store_get_object(zv TSRMLS_CC))
 # define Z_UTCDATETIME_OBJ_P(zv)       ((php_phongo_utcdatetime_t *)zend_object_store_get_object(zv TSRMLS_CC))
 # define Z_COMMANDFAILEDEVENT_OBJ_P(zv)    ((php_phongo_commandfailedevent_t *)zend_object_store_get_object(zv TSRMLS_CC))
 # define Z_COMMANDSTARTEDEVENT_OBJ_P(zv)   ((php_phongo_commandstartedevent_t *)zend_object_store_get_object(zv TSRMLS_CC))
@@ -202,6 +208,7 @@ static inline php_phongo_commandsucceededevent_t* php_commandsucceededevent_fetc
 # define Z_OBJ_OBJECTID(zo)            ((php_phongo_objectid_t *)zo)
 # define Z_OBJ_REGEX(zo)               ((php_phongo_regex_t *)zo)
 # define Z_OBJ_TIMESTAMP(zo)           ((php_phongo_timestamp_t *)zo)
+# define Z_OBJ_UNDEFINED(zo)           ((php_phongo_undefined_t *)zo)
 # define Z_OBJ_UTCDATETIME(zo)         ((php_phongo_utcdatetime_t *)zo)
 # define Z_OBJ_COMMANDFAILEDEVENT(zo)    ((php_phongo_commandfailedevent_t *)zo)
 # define Z_OBJ_COMMANDSTARTEDEVENT(zo)   ((php_phongo_commandstartedevent_t *)zo)
@@ -254,6 +261,7 @@ extern zend_class_entry *php_phongo_minkey_ce;
 extern zend_class_entry *php_phongo_objectid_ce;
 extern zend_class_entry *php_phongo_regex_ce;
 extern zend_class_entry *php_phongo_timestamp_ce;
+extern zend_class_entry *php_phongo_undefined_ce;
 extern zend_class_entry *php_phongo_utcdatetime_ce;
 
 extern zend_class_entry *php_phongo_binary_interface_ce;
@@ -283,8 +291,9 @@ extern void php_phongo_regex_init_ce(INIT_FUNC_ARGS);
 extern void php_phongo_serializable_init_ce(INIT_FUNC_ARGS);
 extern void php_phongo_timestamp_init_ce(INIT_FUNC_ARGS);
 extern void php_phongo_type_init_ce(INIT_FUNC_ARGS);
-extern void php_phongo_utcdatetime_init_ce(INIT_FUNC_ARGS);
+extern void php_phongo_undefined_init_ce(INIT_FUNC_ARGS);
 extern void php_phongo_unserializable_init_ce(INIT_FUNC_ARGS);
+extern void php_phongo_utcdatetime_init_ce(INIT_FUNC_ARGS);
 
 extern void php_phongo_binary_interface_init_ce(INIT_FUNC_ARGS);
 extern void php_phongo_decimal128_interface_init_ce(INIT_FUNC_ARGS);

php_phongo_structs.h

@@ -201,6 +201,11 @@ typedef struct {
 	PHONGO_ZEND_OBJECT_POST
 } php_phongo_timestamp_t;
 
+typedef struct {
+	PHONGO_ZEND_OBJECT_PRE
+	PHONGO_ZEND_OBJECT_POST
+} php_phongo_undefined_t;
+
 typedef struct {
 	PHONGO_ZEND_OBJECT_PRE
 	bool       initialized;

src/BSON/Undefined.c

@@ -0,0 +1,162 @@
+/*
+ * Copyright 2014-2017 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.
+ */
+
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
+
+#include <php.h>
+#include <Zend/zend_interfaces.h>
+#include <ext/standard/php_var.h>
+#if PHP_VERSION_ID >= 70000
+# include <zend_smart_str.h>
+#else
+# include <ext/standard/php_smart_str.h>
+#endif
+
+#include "phongo_compat.h"
+#include "php_phongo.h"
+
+zend_class_entry *php_phongo_undefined_ce;
+
+/* {{{ proto string MongoDB\BSON\Undefined::__toString()
+   Return the empty string. */
+static PHP_METHOD(Undefined, __toString)
+{
+	PHONGO_RETURN_STRINGL("", 0);
+} /* }}} */
+
+/* {{{ proto array MongoDB\BSON\Undefined::jsonSerialize()
+*/
+static PHP_METHOD(Undefined, jsonSerialize)
+{
+	if (zend_parse_parameters_none() == FAILURE) {
+		return;
+	}
+
+	array_init_size(return_value, 1);
+	ADD_ASSOC_BOOL_EX(return_value, "$undefined", 1);
+} /* }}} */
+
+/* {{{ proto string MongoDB\BSON\Undefined::serialize()
+*/
+static PHP_METHOD(Undefined, serialize)
+{
+	PHONGO_RETURN_STRING("");
+} /* }}} */
+
+/* {{{ proto void MongoDB\BSON\Undefined::unserialize(string $serialized)
+*/
+static PHP_METHOD(Undefined, unserialize)
+{
+	zend_error_handling     error_handling;
+	char                   *serialized;
+	phongo_zpp_char_len     serialized_len;
+
+	zend_replace_error_handling(EH_THROW, phongo_exception_from_phongo_domain(PHONGO_ERROR_INVALID_ARGUMENT), &error_handling TSRMLS_CC);
+
+	if (zend_parse_parameters(ZEND_NUM_ARGS() TSRMLS_CC, "s", &serialized, &serialized_len) == FAILURE) {
+		zend_restore_error_handling(&error_handling TSRMLS_CC);
+		return;
+	}
+	zend_restore_error_handling(&error_handling TSRMLS_CC);
+} /* }}} */
+
+/* {{{ MongoDB\BSON\Undefined function entries */
+ZEND_BEGIN_ARG_INFO_EX(ai_Undefined_unserialize, 0, 0, 1)
+	ZEND_ARG_INFO(0, serialized)
+ZEND_END_ARG_INFO()
+
+ZEND_BEGIN_ARG_INFO_EX(ai_Undefined_void, 0, 0, 0)
+ZEND_END_ARG_INFO()
+
+static zend_function_entry php_phongo_undefined_me[] = {
+	/* __set_state intentionally missing */
+	PHP_ME(Undefined, __toString, ai_Undefined_void, ZEND_ACC_PUBLIC|ZEND_ACC_FINAL)
+	PHP_ME(Undefined, jsonSerialize, ai_Undefined_void, ZEND_ACC_PUBLIC|ZEND_ACC_FINAL)
+	PHP_ME(Undefined, serialize, ai_Undefined_void, ZEND_ACC_PUBLIC|ZEND_ACC_FINAL)
+	PHP_ME(Undefined, unserialize, ai_Undefined_unserialize, ZEND_ACC_PUBLIC|ZEND_ACC_FINAL)
+	ZEND_NAMED_ME(__construct, PHP_FN(MongoDB_disabled___construct), ai_Undefined_void, ZEND_ACC_PRIVATE|ZEND_ACC_FINAL)
+	PHP_FE_END
+};
+/* }}} */
+
+/* {{{ MongoDB\BSON\Undefined object handlers */
+static zend_object_handlers php_phongo_handler_undefined;
+
+static void php_phongo_undefined_free_object(phongo_free_object_arg *object TSRMLS_DC) /* {{{ */
+{
+	php_phongo_undefined_t *intern = Z_OBJ_UNDEFINED(object);
+
+	zend_object_std_dtor(&intern->std TSRMLS_CC);
+
+#if PHP_VERSION_ID < 70000
+	efree(intern);
+#endif
+} /* }}} */
+
+static phongo_create_object_retval php_phongo_undefined_create_object(zend_class_entry *class_type TSRMLS_DC) /* {{{ */
+{
+	php_phongo_undefined_t *intern = NULL;
+
+	intern = PHONGO_ALLOC_OBJECT_T(php_phongo_undefined_t, class_type);
+	zend_object_std_init(&intern->std, class_type TSRMLS_CC);
+	object_properties_init(&intern->std, class_type);
+
+#if PHP_VERSION_ID >= 70000
+	intern->std.handlers = &php_phongo_handler_undefined;
+
+	return &intern->std;
+#else
+	{
+		zend_object_value retval;
+		retval.handle = zend_objects_store_put(intern, (zend_objects_store_dtor_t) zend_objects_destroy_object, php_phongo_undefined_free_object, NULL TSRMLS_CC);
+		retval.handlers = &php_phongo_handler_undefined;
+
+		return retval;
+	}
+#endif
+} /* }}} */
+/* }}} */
+
+void php_phongo_undefined_init_ce(INIT_FUNC_ARGS) /* {{{ */
+{
+	zend_class_entry ce;
+
+	INIT_NS_CLASS_ENTRY(ce, "MongoDB\\BSON", "Undefined", php_phongo_undefined_me);
+	php_phongo_undefined_ce = zend_register_internal_class(&ce TSRMLS_CC);
+	php_phongo_undefined_ce->create_object = php_phongo_undefined_create_object;
+	PHONGO_CE_FINAL(php_phongo_undefined_ce);
+
+	zend_class_implements(php_phongo_undefined_ce TSRMLS_CC, 1, php_phongo_json_serializable_ce);
+	zend_class_implements(php_phongo_undefined_ce TSRMLS_CC, 1, php_phongo_type_ce);
+	zend_class_implements(php_phongo_undefined_ce TSRMLS_CC, 1, zend_ce_serializable);
+
+	memcpy(&php_phongo_handler_undefined, phongo_get_std_object_handlers(), sizeof(zend_object_handlers));
+#if PHP_VERSION_ID >= 70000
+	php_phongo_handler_undefined.free_obj = php_phongo_undefined_free_object;
+	php_phongo_handler_undefined.offset = XtOffsetOf(php_phongo_undefined_t, std);
+#endif
+} /* }}} */
+
+/*
+ * Local variables:
+ * tab-width: 4
+ * c-basic-offset: 4
+ * End:
+ * vim600: noet sw=4 ts=4 fdm=marker
+ * vim<600: noet sw=4 ts=4
+ */

src/bson-encode.c

@@ -270,6 +270,13 @@ static void php_phongo_bson_append_object(bson_t *bson, php_phongo_bson_flags_t
 			return;
 		}
 
+		/* Deprecated types */
+		if (instanceof_function(Z_OBJCE_P(object), php_phongo_undefined_ce TSRMLS_CC)) {
+			mongoc_log(MONGOC_LOG_LEVEL_TRACE, MONGOC_LOG_DOMAIN, "encoding Undefined");
+			bson_append_undefined(bson, key, key_len);
+			return;
+		}
+
 		phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE TSRMLS_CC, "Unexpected %s instance: %s", ZSTR_VAL(php_phongo_type_ce->name), ZSTR_VAL(Z_OBJCE_P(object)->name));
 		return;
 	} else {

src/bson.c

@@ -131,7 +131,30 @@ static bool php_phongo_bson_visit_binary(const bson_iter_t *iter ARG_UNUSED, con
 
 static bool php_phongo_bson_visit_undefined(const bson_iter_t *iter, const char *key, void *data) /* {{{ */
 {
-	mongoc_log(MONGOC_LOG_LEVEL_WARNING, MONGOC_LOG_DOMAIN, "Detected unsupported BSON type 0x06 (undefined) for fieldname \"%s\"", key);
+	zval *retval = PHONGO_BSON_STATE_ZCHILD(data);
+#if PHP_VERSION_ID >= 70000
+	zval zchild;
+
+	object_init_ex(&zchild, php_phongo_undefined_ce);
+
+	if (((php_phongo_bson_state *)data)->is_visiting_array) {
+		add_next_index_zval(retval, &zchild);
+	} else {
+		ADD_ASSOC_ZVAL(retval, key, &zchild);
+	}
+#else
+	zval *zchild = NULL;
+	TSRMLS_FETCH();
+
+	MAKE_STD_ZVAL(zchild);
+	object_init_ex(zchild, php_phongo_undefined_ce);
+
+	if (((php_phongo_bson_state *)data)->is_visiting_array) {
+		add_next_index_zval(retval, zchild);
+	} else {
+		ADD_ASSOC_ZVAL(retval, key, zchild);
+	}
+#endif
 
 	return false;
 } /* }}} */

tests/bson/bson-toPHP_error-005.phpt

@@ -3,7 +3,6 @@ MongoDB\BSON\toPHP(): BSON decoding ignores unsupported BSON types
 --FILE--
 <?php
 $tests = [
-    pack('VCa*xx', 10, 0x06, 'foo'), // undefined
     pack('VCa*xVa*xx12x', 37, 0x0C, 'foo', 11, 'collection'), // DBPointer
     pack('VCa*xVa*xx', 18, 0x0E, 'foo', 4, 'bar'), // symbol
 ];
@@ -18,9 +17,6 @@ ini_set('mongodb.debug', 'off');
 ===DONE===
 <?php exit(0); ?>
 --EXPECTF--
-[%s] PHONGO-BSON: WARNING > Detected unsupported BSON type 0x06 (undefined) for fieldname "foo"
-object(stdClass)#%d (%d) {
-}
 [%s] PHONGO-BSON: WARNING > Detected unsupported BSON type 0x0C (DBPointer) for fieldname "foo"
 object(stdClass)#%d (%d) {
 }