PHPC-1166: Update zend array recursion protection for PHP 7.3

Author: derickr

phongo_compat.c

@@ -32,6 +32,58 @@ void phongo_add_exception_prop(const char* prop, int prop_len, zval* value TSRML
 	}
 }
 
+#ifdef ZEND_HASH_GET_APPLY_COUNT /* PHP 7.2 or earlier recursion protection */
+inline zend_bool php_phongo_zend_hash_apply_protection_begin(HashTable* ht)
+{
+	if (!ht) {
+		return 1;
+	}
+	if (ZEND_HASH_GET_APPLY_COUNT(ht) > 0) {
+		return 0;
+	}
+	if (ZEND_HASH_APPLY_PROTECTION(ht)) {
+		ZEND_HASH_INC_APPLY_COUNT(ht);
+	}
+	return 1;
+}
+
+inline zend_bool php_phongo_zend_hash_apply_protection_end(HashTable* ht)
+{
+	if (!ht) {
+		return 1;
+	}
+	if (ZEND_HASH_GET_APPLY_COUNT(ht) == 0) {
+		return 0;
+	}
+	if (ZEND_HASH_APPLY_PROTECTION(ht)) {
+		ZEND_HASH_DEC_APPLY_COUNT(ht);
+	}
+	return 1;
+}
+#else /* PHP 7.3 or later */
+inline zend_bool php_phongo_zend_hash_apply_protection_begin(zend_array* ht)
+{
+	if (GC_IS_RECURSIVE(ht)) {
+		return 0;
+	}
+	if (!(GC_FLAGS(ht) & GC_IMMUTABLE)) {
+		GC_PROTECT_RECURSION(ht);
+	}
+	return 1;
+}
+
+inline zend_bool php_phongo_zend_hash_apply_protection_end(zend_array* ht)
+{
+	if (!GC_IS_RECURSIVE(ht)) {
+		return 0;
+	}
+	if (!(GC_FLAGS(ht) & GC_IMMUTABLE)) {
+		GC_UNPROTECT_RECURSION(ht);
+	}
+	return 1;
+}
+#endif
+
 /*
  * Local variables:
  * tab-width: 4

phongo_compat.h

@@ -178,7 +178,9 @@
 #error Unsupported architecture (integers are neither 32-bit nor 64-bit)
 #endif
 
-void phongo_add_exception_prop(const char* prop, int prop_len, zval* value TSRMLS_DC);
+void      phongo_add_exception_prop(const char* prop, int prop_len, zval* value TSRMLS_DC);
+zend_bool php_phongo_zend_hash_apply_protection_begin(HashTable* ht);
+zend_bool php_phongo_zend_hash_apply_protection_end(HashTable* ht);
 
 #endif /* PHONGO_COMPAT_H */
 

src/bson-encode.c

@@ -353,53 +353,41 @@ static void php_phongo_bson_append(bson_t* bson, php_phongo_field_path* field_pa
 				bson_t     child;
 				HashTable* tmp_ht = HASH_OF(entry);
 
-				if (tmp_ht && ZEND_HASH_GET_APPLY_COUNT(tmp_ht) > 0) {
+				if (!php_phongo_zend_hash_apply_protection_begin(tmp_ht)) {
 					char* path_string = php_phongo_field_path_as_string(field_path);
 					phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE TSRMLS_CC, "Detected recursion for field path \"%s\"", path_string);
 					efree(path_string);
 					break;
 				}
 
-				if (tmp_ht && ZEND_HASH_APPLY_PROTECTION(tmp_ht)) {
-					ZEND_HASH_INC_APPLY_COUNT(tmp_ht);
-				}
-
 				bson_append_array_begin(bson, key, key_len, &child);
 				php_phongo_field_path_write_type_at_current_level(field_path, PHONGO_FIELD_PATH_ITEM_ARRAY);
 				field_path->size++;
 				php_phongo_zval_to_bson_internal(entry, field_path, flags, &child, NULL TSRMLS_CC);
 				field_path->size--;
 				bson_append_array_end(bson, &child);
 
-				if (tmp_ht && ZEND_HASH_APPLY_PROTECTION(tmp_ht)) {
-					ZEND_HASH_DEC_APPLY_COUNT(tmp_ht);
-				}
+				php_phongo_zend_hash_apply_protection_end(tmp_ht);
 				break;
 			}
 			PHONGO_BREAK_INTENTIONALLY_MISSING
 
 		case IS_OBJECT: {
 			HashTable* tmp_ht = HASH_OF(entry);
 
-			if (tmp_ht && ZEND_HASH_GET_APPLY_COUNT(tmp_ht) > 0) {
+			if (!php_phongo_zend_hash_apply_protection_begin(tmp_ht)) {
 				char* path_string = php_phongo_field_path_as_string(field_path);
 				phongo_throw_exception(PHONGO_ERROR_UNEXPECTED_VALUE TSRMLS_CC, "Detected recursion for field path \"%s\"", path_string);
 				efree(path_string);
 				break;
 			}
 
-			if (tmp_ht && ZEND_HASH_APPLY_PROTECTION(tmp_ht)) {
-				ZEND_HASH_INC_APPLY_COUNT(tmp_ht);
-			}
-
 			php_phongo_field_path_write_type_at_current_level(field_path, PHONGO_FIELD_PATH_ITEM_DOCUMENT);
 			field_path->size++;
 			php_phongo_bson_append_object(bson, field_path, flags, key, key_len, entry TSRMLS_CC);
 			field_path->size--;
 
-			if (tmp_ht && ZEND_HASH_APPLY_PROTECTION(tmp_ht)) {
-				ZEND_HASH_DEC_APPLY_COUNT(tmp_ht);
-			}
+			php_phongo_zend_hash_apply_protection_end(tmp_ht);
 			break;
 		}