Add tests of SplObjectStorage unset/offsetUnset

Author: TysonAndre

ext/spl/spl_observer.c

@@ -47,6 +47,7 @@ PHPAPI zend_object_handlers spl_handler_SplObjectStorage;
 /* Bit flags for marking internal functionality overridden by SplObjectStorage subclasses. */
 #define SOS_OVERRIDDEN_READ_DIMENSION  1
 #define SOS_OVERRIDDEN_WRITE_DIMENSION 2
+#define SOS_OVERRIDDEN_UNSET_DIMENSION 4
 
 typedef struct _spl_SplObjectStorage { /* {{{ */
 	HashTable         storage;
@@ -221,6 +222,9 @@ spl_SplObjectStorageElement *spl_object_storage_attach(spl_SplObjectStorage *int
 
 static int spl_object_storage_detach(spl_SplObjectStorage *intern, zend_object *obj) /* {{{ */
 {
+	if (EXPECTED(!(intern->flags & SOS_OVERRIDDEN_UNSET_DIMENSION))) {
+		return zend_hash_index_del(&intern->storage, obj->handle);
+	}
 	int ret = FAILURE;
 	zend_hash_key key;
 	if (spl_object_storage_get_hash(&key, intern, obj) == FAILURE) {
@@ -284,6 +288,11 @@ static zend_object *spl_object_storage_new_ex(zend_class_entry *class_type, zend
 					SPL_OBJECT_STORAGE_CLASS_HAS_OVERRIDE(class_type, ZEND_STR_OFFSETSET)) {
 					intern->flags |= SOS_OVERRIDDEN_WRITE_DIMENSION;
 				}
+
+				if (intern->fptr_get_hash != NULL ||
+					SPL_OBJECT_STORAGE_CLASS_HAS_OVERRIDE(class_type, ZEND_STR_OFFSETUNSET)) {
+					intern->flags |= SOS_OVERRIDDEN_UNSET_DIMENSION;
+				}
 			}
 			break;
 		}
@@ -487,6 +496,16 @@ static void spl_object_storage_write_dimension(zend_object *object, zval *offset
 	spl_object_storage_attach_handle(intern, Z_OBJ_P(offset), inf);
 }
 
+static void spl_object_storage_unset_dimension(zend_object *object, zval *offset)
+{
+	spl_SplObjectStorage *intern = spl_object_storage_from_obj(object);
+	if (UNEXPECTED(Z_TYPE_P(offset) != IS_OBJECT || (intern->flags & SOS_OVERRIDDEN_UNSET_DIMENSION))) {
+		zend_std_unset_dimension(object, offset);
+		return;
+	}
+	zend_hash_index_del(&intern->storage, Z_OBJ_HANDLE_P(offset));
+}
+
 /* {{{ Detaches an object from the storage */
 PHP_METHOD(SplObjectStorage, detach)
 {
@@ -1330,6 +1349,7 @@ PHP_MINIT_FUNCTION(spl_observer)
 	spl_handler_SplObjectStorage.read_dimension  = spl_object_storage_read_dimension;
 	spl_handler_SplObjectStorage.write_dimension = spl_object_storage_write_dimension;
 	spl_handler_SplObjectStorage.has_dimension   = spl_object_storage_has_dimension;
+	spl_handler_SplObjectStorage.unset_dimension = spl_object_storage_unset_dimension;
 
 	spl_ce_MultipleIterator = register_class_MultipleIterator(zend_ce_iterator);
 	spl_ce_MultipleIterator->create_object = spl_SplObjectStorage_new;

ext/spl/tests/SplObjectStorage_unset.phpt

@@ -0,0 +1,55 @@
+--TEST--
+SplObjectStorage unset and destructor edge cases
+--FILE--
+<?php
+class HasDestructor {
+    public function __destruct() {
+        echo "In destructor. Should no longer be accessible in \$s:\n";
+        var_dump($GLOBALS['s']);
+
+        throw new RuntimeException("thrown from destructor");
+    }
+}
+$o = new stdClass();
+$s = new SplObjectStorage();
+$s[$o] = new HasDestructor();
+try {
+    unset($s[$o]);
+} catch (Exception $e) {
+    echo "Caught: {$e->getMessage()}\n";
+}
+var_dump($s);
+$s[$o] = new HasDestructor();
+try {
+    $s->offsetUnset($o);
+} catch (Exception $e) {
+    echo "Caught: {$e->getMessage()}\n";
+}
+
+var_dump($s);
+?>
+--EXPECT--
+In destructor. Should no longer be accessible in $s:
+object(SplObjectStorage)#2 (1) {
+  ["storage":"SplObjectStorage":private]=>
+  array(0) {
+  }
+}
+Caught: thrown from destructor
+object(SplObjectStorage)#2 (1) {
+  ["storage":"SplObjectStorage":private]=>
+  array(0) {
+  }
+}
+In destructor. Should no longer be accessible in $s:
+object(SplObjectStorage)#2 (1) {
+  ["storage":"SplObjectStorage":private]=>
+  array(0) {
+  }
+}
+Caught: thrown from destructor
+object(SplObjectStorage)#2 (1) {
+  ["storage":"SplObjectStorage":private]=>
+  array(0) {
+  }
+}