Fix foreach after the garbage collector is invoked

php_phongo.c

@@ -159,9 +159,10 @@ static HashTable* php_phongo_std_get_gc(zend_object* object, zval** table, int*
 {
 	*table = NULL;
 	*n     = 0;
-	return zend_std_get_properties(object);
+	return object->handlers->get_properties(object);
 }
 
+
 PHP_MINIT_FUNCTION(mongodb) /* {{{ */
 {
 	bson_mem_vtable_t bson_mem_vtable = {
@@ -197,8 +198,6 @@ PHP_MINIT_FUNCTION(mongodb) /* {{{ */
 	/* Disable cloning by default. Individual classes can opt in if they need to
 	 * support this (e.g. BSON objects). */
 	phongo_std_object_handlers.clone_obj = NULL;
-	/* Ensure that get_gc delegates to zend_std_get_properties directly in case
-	 * our class defines a get_properties handler for debugging purposes. */
 	phongo_std_object_handlers.get_gc = php_phongo_std_get_gc;
 
 	/* Initialize zend_class_entry dependencies.

php_phongo.h

@@ -60,28 +60,112 @@ ZEND_TSRMLS_CACHE_EXTERN()
 
 zend_object_handlers* phongo_get_std_object_handlers(void);
 
+#define PHONGO_RETURN_PROPS(is_temp, props) \
+	if (!(is_temp)) { \
+		GC_ADDREF(props); \
+	} \
+	return props;
+
 #define PHONGO_GET_PROPERTY_HASH_INIT_PROPS(is_temp, intern, props, size) \
 	do {                                                                  \
+		if (!(intern)->php_properties) {                                  \
+			ALLOC_HASHTABLE((intern)->php_properties);                    \
+			zend_hash_init((intern)->php_properties, 0, NULL, ZVAL_PTR_DTOR, 0); \
+			GC_ADDREF((intern)->php_properties); \
+		}                                                                 \
 		if (is_temp) {                                                    \
-			ALLOC_HASHTABLE(props);                                       \
-			zend_hash_init((props), (size), NULL, ZVAL_PTR_DTOR, 0);      \
-		} else if ((intern)->properties) {                                \
-			(props) = (intern)->properties;                               \
+			(props) = zend_array_dup((intern)->php_properties);           \
 		} else {                                                          \
-			ALLOC_HASHTABLE(props);                                       \
-			zend_hash_init((props), (size), NULL, ZVAL_PTR_DTOR, 0);      \
+			(props) = zend_array_dup((intern)->php_properties);           \
+			if ((intern)->properties) {                                   \
+				HashTable *__tmp = (intern)->properties; \
+				(intern)->properties = NULL; \
+				zend_hash_release(__tmp);                    \
+			}                                                             \
 			(intern)->properties = (props);                               \
 		}                                                                 \
 	} while (0)
 
 #define PHONGO_GET_PROPERTY_HASH_FREE_PROPS(is_temp, props) \
 	do {                                                    \
 		if (is_temp) {                                      \
-			zend_hash_destroy((props));                     \
-			FREE_HASHTABLE(props);                          \
+			zend_hash_release((props));                     \
 		}                                                   \
 	} while (0)
 
+#define PHONGO_GET_PROPERTY_HANDLERS(_name, _intern_extractor) \
+	static zval* php_phongo_##_name##_read_property(zend_object *zobj, zend_string *member, int type, void **cache_slot, zval *rv) \
+	{ \
+		HashTable *props = _intern_extractor(zobj)->php_properties; \
+		if (!props) { \
+			ALLOC_HASHTABLE(props); \
+			zend_hash_init(props, 0, NULL, ZVAL_PTR_DTOR, 0); \
+			_intern_extractor(zobj)->php_properties = props; \
+		} \
+		return zend_hash_find(props, member); \
+	} \
+	\
+	static zval *php_phongo_##_name##_write_property(zend_object *zobj, zend_string *name, zval *value, void **cache_slot) \
+	{ \
+		Z_TRY_ADDREF_P(value); \
+		HashTable *props = _intern_extractor(zobj)->php_properties; \
+		if (!props) { \
+			ALLOC_HASHTABLE(props); \
+			zend_hash_init(props, 0, NULL, ZVAL_PTR_DTOR, 0); \
+			_intern_extractor(zobj)->php_properties = props; \
+		} \
+		return zend_hash_add_new(props, name, value); \
+	} \
+	static int php_phongo_##_name##_has_property(zend_object *zobj, zend_string *name, int has_set_exists, void **cache_slot) \
+	{ \
+		HashTable *props = _intern_extractor(zobj)->php_properties; \
+		if (!props) { \
+			ALLOC_HASHTABLE(props); \
+			zend_hash_init(props, 0, NULL, ZVAL_PTR_DTOR, 0); \
+			_intern_extractor(zobj)->php_properties = props; \
+		} \
+		zval *value = zend_hash_find(props, name); \
+		if (value) { \
+			if (has_set_exists == ZEND_PROPERTY_NOT_EMPTY) { \
+				return zend_is_true(value); \
+			} \
+			if (has_set_exists < ZEND_PROPERTY_NOT_EMPTY) { \
+				ZEND_ASSERT(has_set_exists == ZEND_PROPERTY_ISSET); \
+				ZVAL_DEREF(value); \
+				return (Z_TYPE_P(value) != IS_NULL); \
+			} \
+			ZEND_ASSERT(has_set_exists == ZEND_PROPERTY_EXISTS); \
+			return true; \
+		} \
+		return false; \
+	} \
+	static void php_phongo_##_name##_unset_property(zend_object *zobj, zend_string *name, void **cache_slot) \
+	{ \
+		HashTable *props = _intern_extractor(zobj)->php_properties; \
+		if (!props) { \
+			ALLOC_HASHTABLE(props); \
+			zend_hash_init(props, 0, NULL, ZVAL_PTR_DTOR, 0); \
+			_intern_extractor(zobj)->php_properties = props; \
+		} \
+		zend_hash_del(props, name); \
+	} \
+	\
+	static zval *php_phongo_##_name##_get_property_ptr_ptr(zend_object *zobj, zend_string *name, int type, void **cache_slot) \
+	{ \
+		HashTable *props = _intern_extractor(zobj)->php_properties; \
+		if (!props) { \
+			ALLOC_HASHTABLE(props); \
+			zend_hash_init(props, 0, NULL, ZVAL_PTR_DTOR, 0); \
+			_intern_extractor(zobj)->php_properties = props; \
+		} \
+		 \
+		zval *value = zend_hash_find(props, name); \
+		if (value) { \
+			return value; \
+		} \
+		return zend_hash_add(props, name, &EG(uninitialized_zval)); \
+	}
+
 #define PHONGO_ZVAL_EXCEPTION_NAME(e) (ZSTR_VAL(e->ce->name))
 
 #define PHONGO_SET_CREATED_BY_PID(intern)          \

src/BSON/Binary.c

@@ -73,7 +73,7 @@ static HashTable* php_phongo_binary_get_properties_hash(zend_object* object, boo
 	PHONGO_GET_PROPERTY_HASH_INIT_PROPS(is_temp, intern, props, 2);
 
 	if (!intern->data) {
-		return props;
+		PHONGO_RETURN_PROPS(is_temp, props);
 	}
 
 	{
@@ -86,7 +86,7 @@ static HashTable* php_phongo_binary_get_properties_hash(zend_object* object, boo
 		zend_hash_str_update(props, "type", sizeof("type") - 1, &type);
 	}
 
-	return props;
+	PHONGO_RETURN_PROPS(is_temp, props);
 }
 
 /* Construct a new BSON binary type */
@@ -213,9 +213,16 @@ static void php_phongo_binary_free_object(zend_object* object)
 		efree(intern->data);
 	}
 
+
 	if (intern->properties) {
-		zend_hash_destroy(intern->properties);
-		FREE_HASHTABLE(intern->properties);
+		HashTable* props = intern->properties;
+		intern->properties = NULL;
+		zend_hash_release(props);
+	}
+	if (intern->php_properties) {
+		HashTable* props = intern->php_properties;
+		intern->php_properties = NULL;
+		zend_hash_release(props);
 	}
 }
 
@@ -281,6 +288,8 @@ static HashTable* php_phongo_binary_get_properties(zend_object* object)
 	return php_phongo_binary_get_properties_hash(object, false);
 }
 
+PHONGO_GET_PROPERTY_HANDLERS(binary, Z_OBJ_BINARY);
+
 void php_phongo_binary_init_ce(INIT_FUNC_ARGS)
 {
 	php_phongo_binary_ce                = register_class_MongoDB_BSON_Binary(php_phongo_binary_interface_ce, php_phongo_json_serializable_ce, php_phongo_type_ce, zend_ce_stringable);
@@ -291,6 +300,11 @@ void php_phongo_binary_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_binary.clone_obj      = php_phongo_binary_clone_object;
 	php_phongo_handler_binary.get_debug_info = php_phongo_binary_get_debug_info;
 	php_phongo_handler_binary.get_properties = php_phongo_binary_get_properties;
+	php_phongo_handler_binary.read_property  = php_phongo_binary_read_property;
+	php_phongo_handler_binary.write_property = php_phongo_binary_write_property;
+	php_phongo_handler_binary.has_property   = php_phongo_binary_has_property;
+	php_phongo_handler_binary.unset_property = php_phongo_binary_unset_property;
+	php_phongo_handler_binary.get_property_ptr_ptr = php_phongo_binary_get_property_ptr_ptr;
 	php_phongo_handler_binary.free_obj       = php_phongo_binary_free_object;
 	php_phongo_handler_binary.offset         = XtOffsetOf(php_phongo_binary_t, std);
 }

src/BSON/DBPointer.c

@@ -74,7 +74,7 @@ HashTable* php_phongo_dbpointer_get_properties_hash(zend_object* object, bool is
 	PHONGO_GET_PROPERTY_HASH_INIT_PROPS(is_temp, intern, props, 2);
 
 	if (!intern->ref) {
-		return props;
+		PHONGO_RETURN_PROPS(is_temp, props);
 	}
 
 	{
@@ -86,7 +86,7 @@ HashTable* php_phongo_dbpointer_get_properties_hash(zend_object* object, bool is
 		zend_hash_str_update(props, "id", sizeof("id") - 1, &id);
 	}
 
-	return props;
+	PHONGO_RETURN_PROPS(is_temp, props);
 }
 
 PHONGO_DISABLED_CONSTRUCTOR(MongoDB_BSON_DBPointer)
@@ -176,9 +176,16 @@ static void php_phongo_dbpointer_free_object(zend_object* object)
 		efree(intern->ref);
 	}
 
+
 	if (intern->properties) {
-		zend_hash_destroy(intern->properties);
-		FREE_HASHTABLE(intern->properties);
+		HashTable* props = intern->properties;
+		intern->properties = NULL;
+		zend_hash_release(props);
+	}
+	if (intern->php_properties) {
+		HashTable* props = intern->php_properties;
+		intern->php_properties = NULL;
+		zend_hash_release(props);
 	}
 }
 
@@ -241,6 +248,8 @@ static HashTable* php_phongo_dbpointer_get_properties(zend_object* object)
 	return php_phongo_dbpointer_get_properties_hash(object, false);
 }
 
+PHONGO_GET_PROPERTY_HANDLERS(dbpointer, Z_OBJ_DBPOINTER);
+
 void php_phongo_dbpointer_init_ce(INIT_FUNC_ARGS)
 {
 	php_phongo_dbpointer_ce                = register_class_MongoDB_BSON_DBPointer(php_phongo_json_serializable_ce, php_phongo_type_ce, zend_ce_stringable);
@@ -251,6 +260,11 @@ void php_phongo_dbpointer_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_dbpointer.clone_obj      = php_phongo_dbpointer_clone_object;
 	php_phongo_handler_dbpointer.get_debug_info = php_phongo_dbpointer_get_debug_info;
 	php_phongo_handler_dbpointer.get_properties = php_phongo_dbpointer_get_properties;
+	php_phongo_handler_dbpointer.read_property  = php_phongo_dbpointer_read_property;
+	php_phongo_handler_dbpointer.write_property = php_phongo_dbpointer_write_property;
+	php_phongo_handler_dbpointer.has_property   = php_phongo_dbpointer_has_property;
+	php_phongo_handler_dbpointer.unset_property = php_phongo_dbpointer_unset_property;
+	php_phongo_handler_dbpointer.get_property_ptr_ptr = php_phongo_dbpointer_get_property_ptr_ptr;
 	php_phongo_handler_dbpointer.free_obj       = php_phongo_dbpointer_free_object;
 	php_phongo_handler_dbpointer.offset         = XtOffsetOf(php_phongo_dbpointer_t, std);
 }

src/BSON/Decimal128.c

@@ -64,7 +64,7 @@ static HashTable* php_phongo_decimal128_get_properties_hash(zend_object* object,
 	PHONGO_GET_PROPERTY_HASH_INIT_PROPS(is_temp, intern, props, 1);
 
 	if (!intern->initialized) {
-		return props;
+		PHONGO_RETURN_PROPS(is_temp, props);
 	}
 
 	bson_decimal128_to_string(&intern->decimal, outbuf);
@@ -76,7 +76,7 @@ static HashTable* php_phongo_decimal128_get_properties_hash(zend_object* object,
 		zend_hash_str_update(props, "dec", sizeof("dec") - 1, &dec);
 	}
 
-	return props;
+	PHONGO_RETURN_PROPS(is_temp, props);
 }
 
 /* Construct a new BSON Decimal128 type */
@@ -168,9 +168,16 @@ static void php_phongo_decimal128_free_object(zend_object* object)
 
 	zend_object_std_dtor(&intern->std);
 
+
 	if (intern->properties) {
-		zend_hash_destroy(intern->properties);
-		FREE_HASHTABLE(intern->properties);
+		HashTable* props = intern->properties;
+		intern->properties = NULL;
+		zend_hash_release(props);
+	}
+	if (intern->php_properties) {
+		HashTable* props = intern->php_properties;
+		intern->php_properties = NULL;
+		zend_hash_release(props);
 	}
 }
 
@@ -216,6 +223,8 @@ static HashTable* php_phongo_decimal128_get_properties(zend_object* object)
 	return php_phongo_decimal128_get_properties_hash(object, false);
 }
 
+PHONGO_GET_PROPERTY_HANDLERS(decimal128, Z_OBJ_DECIMAL128);
+
 void php_phongo_decimal128_init_ce(INIT_FUNC_ARGS)
 {
 	php_phongo_decimal128_ce                = register_class_MongoDB_BSON_Decimal128(php_phongo_decimal128_interface_ce, php_phongo_json_serializable_ce, php_phongo_type_ce, zend_ce_stringable);
@@ -225,6 +234,11 @@ void php_phongo_decimal128_init_ce(INIT_FUNC_ARGS)
 	php_phongo_handler_decimal128.clone_obj      = php_phongo_decimal128_clone_object;
 	php_phongo_handler_decimal128.get_debug_info = php_phongo_decimal128_get_debug_info;
 	php_phongo_handler_decimal128.get_properties = php_phongo_decimal128_get_properties;
+	php_phongo_handler_decimal128.read_property  = php_phongo_decimal128_read_property;
+	php_phongo_handler_decimal128.write_property = php_phongo_decimal128_write_property;
+	php_phongo_handler_decimal128.has_property   = php_phongo_decimal128_has_property;
+	php_phongo_handler_decimal128.unset_property = php_phongo_decimal128_unset_property;
+	php_phongo_handler_decimal128.get_property_ptr_ptr = php_phongo_decimal128_get_property_ptr_ptr;
 	php_phongo_handler_decimal128.free_obj       = php_phongo_decimal128_free_object;
 	php_phongo_handler_decimal128.offset         = XtOffsetOf(php_phongo_decimal128_t, std);
 }

src/BSON/Document.c

@@ -65,7 +65,7 @@ static HashTable* php_phongo_document_get_properties_hash(zend_object* object, b
 	PHONGO_GET_PROPERTY_HASH_INIT_PROPS(is_temp, intern, props, size);
 
 	if (!intern->bson) {
-		return props;
+		PHONGO_RETURN_PROPS(is_temp, props);
 	}
 
 	{
@@ -75,7 +75,7 @@ static HashTable* php_phongo_document_get_properties_hash(zend_object* object, b
 		zend_hash_str_update(props, "data", sizeof("data") - 1, &data);
 	}
 
-	return props;
+	PHONGO_RETURN_PROPS(is_temp, props);
 }
 
 PHONGO_DISABLED_CONSTRUCTOR(MongoDB_BSON_Document)
@@ -446,9 +446,16 @@ static void php_phongo_document_free_object(zend_object* object)
 		bson_destroy(intern->bson);
 	}
 
+
 	if (intern->properties) {
-		zend_hash_destroy(intern->properties);
-		FREE_HASHTABLE(intern->properties);
+		HashTable* props = intern->properties;
+		intern->properties = NULL;
+		zend_hash_release(props);
+	}
+	if (intern->php_properties) {
+		HashTable* props = intern->php_properties;
+		intern->php_properties = NULL;
+		zend_hash_release(props);
 	}
 }
 
@@ -520,7 +527,7 @@ static HashTable* php_phongo_document_get_debug_info(zend_object* object, int* i
 		zend_hash_str_update(props, "value", sizeof("value") - 1, &state.zchild);
 	}
 
-	return props;
+	PHONGO_RETURN_PROPS(is_temp, props);
 
 failure:
 	PHONGO_GET_PROPERTY_HASH_FREE_PROPS(is_temp, props);