ext/standard/dir.c: Directory class should behave like other opaque objects

ext/standard/dir.c

@@ -48,10 +48,17 @@ php_dir_globals dir_globals;
 #endif
 
 static zend_class_entry *dir_class_entry_ptr;
+static zend_object_handlers dir_class_object_handlers;
 
 #define Z_DIRECTORY_PATH_P(zv) OBJ_PROP_NUM(Z_OBJ_P(zv), 0)
 #define Z_DIRECTORY_HANDLE_P(zv) OBJ_PROP_NUM(Z_OBJ_P(zv), 1)
 
+static zend_function *dir_class_get_constructor(zend_object *object)
+{
+	zend_throw_error(NULL, "Cannot directly construct Directory, use dir() instead");
+	return NULL;
+}
+
 #define FETCH_DIRP() \
 	myself = getThis(); \
 	if (!myself) { \
@@ -115,6 +122,12 @@ PHP_MINIT_FUNCTION(dir)
 	register_dir_symbols(module_number);
 
 	dir_class_entry_ptr = register_class_Directory();
+	dir_class_entry_ptr->default_object_handlers = &dir_class_object_handlers;
+
+	memcpy(&dir_class_object_handlers, &std_object_handlers, sizeof(zend_object_handlers));
+	dir_class_object_handlers.get_constructor = dir_class_get_constructor;
+	dir_class_object_handlers.clone_obj = NULL;
+	dir_class_object_handlers.compare = zend_objects_not_comparable;
 
 #ifdef ZTS
 	ts_allocate_id(&dir_globals_id, sizeof(php_dir_globals), NULL, NULL);

ext/standard/dir.stub.php

@@ -87,27 +87,28 @@
  */
 const SCANDIR_SORT_NONE = UNKNOWN;
 
-class Directory
+/**
+ * @strict-properties
+ * @not-serializable
+ */
+final class Directory
 {
     public readonly string $path;
 
     /** @var resource */
     public readonly mixed $handle;
 
     /**
-     * @tentative-return-type
      * @implementation-alias closedir
      */
     public function close(): void {}
 
     /**
-     * @tentative-return-type
      * @implementation-alias rewinddir
      */
     public function rewind(): void {}
 
     /**
-     * @tentative-return-type
      * @implementation-alias readdir
      */
     public function read(): string|false {}

ext/standard/tests/directory/DirectoryClass_cannot_clone.phpt

@@ -0,0 +1,26 @@
+--TEST--
+Cannot serialize instance of Directory class constructed via Reflection.
+--FILE--
+<?php
+
+$d = dir(__DIR__);
+try {
+    $cloned = clone $d;
+    $cloned_files = [];
+    while ($row = $cloned->read()){
+        $cloned_files[] = $row;
+    }
+    var_dump(count($cloned_files));
+    echo "Using original object:\n";
+    $original_files = [];
+    while ($row = $d->read()){
+        $original_files[] = $row;
+    }
+    var_dump(count($original_files));
+} catch (\Throwable $e) {
+    echo $e::class, ': ', $e->getMessage(), PHP_EOL;
+}
+
+?>
+--EXPECT--
+Error: Trying to clone an uncloneable object of class Directory

ext/standard/tests/directory/DirectoryClass_cannot_construct.phpt

@@ -0,0 +1,15 @@
+--TEST--
+Cannot directly instantiate Directory class.
+--FILE--
+<?php
+
+try {
+    $d = new Directory();
+    var_dump($d);
+} catch (\Throwable $e) {
+    echo $e::class, ': ', $e->getMessage(), PHP_EOL;
+}
+
+?>
+--EXPECT--
+Error: Cannot directly construct Directory, use dir() instead

ext/standard/tests/directory/DirectoryClass_cannot_serialize.phpt

@@ -0,0 +1,16 @@
+--TEST--
+Cannot serialize instance of Directory class constructed via Reflection.
+--FILE--
+<?php
+
+$d = dir(__DIR__);
+try {
+    $s = serialize($d);
+    var_dump($s);
+} catch (\Throwable $e) {
+    echo $e::class, ': ', $e->getMessage(), PHP_EOL;
+}
+
+?>
+--EXPECT--
+Exception: Serialization of 'Directory' is not allowed

ext/standard/tests/directory/DirectoryClass_readonly_handle.phpt

@@ -0,0 +1,26 @@
+--TEST--
+Changing Directory::$handle property
+--FILE--
+<?php
+
+$d = dir(__DIR__);
+try {
+    $d->handle = "Havoc!";
+} catch (\Throwable $e) {
+    echo $e::class, ': ', $e->getMessage(), PHP_EOL;
+}
+var_dump($d->handle);
+
+try {
+    unset($d->handle);
+} catch (\Throwable $e) {
+    echo $e::class, ': ', $e->getMessage(), PHP_EOL;
+}
+var_dump($d->handle);
+
+?>
+--EXPECTF--
+Error: Cannot modify readonly property Directory::$handle
+resource(%d) of type (stream)
+Error: Cannot unset readonly property Directory::$handle
+resource(%d) of type (stream)

ext/standard/tests/directory/DirectoryClass_readonly_path.phpt

@@ -0,0 +1,26 @@
+--TEST--
+Changing Directory::$handle property
+--FILE--
+<?php
+
+$d = dir(__DIR__);
+try {
+    $d->path = "Havoc!";
+} catch (\Throwable $e) {
+    echo $e::class, ': ', $e->getMessage(), PHP_EOL;
+}
+var_dump($d->path == __DIR__);
+
+try {
+    unset($d->path);
+} catch (\Throwable $e) {
+    echo $e::class, ': ', $e->getMessage(), PHP_EOL;
+}
+var_dump($d->path == __DIR__);
+
+?>
+--EXPECTF--
+Error: Cannot modify readonly property Directory::$path
+bool(true)
+Error: Cannot unset readonly property Directory::$path
+bool(true)

ext/standard/tests/directory/DirectoryClass_reflection_create_instance_no_construct.phpt

@@ -0,0 +1,30 @@
+--TEST--
+Cannot use instance of Directory class constructed via Reflection.
+--FILE--
+<?php
+
+$rc = new ReflectionClass("Directory");
+var_dump($rc->isInstantiable());
+try {
+    $d = $rc->newInstanceWithoutConstructor();
+} catch (\Throwable $e) {
+    echo $e::class, ': ', $e->getMessage(), PHP_EOL;
+}
+
+var_dump($d);
+try {
+    var_dump($d->read());
+} catch (\Throwable $e) {
+    echo $e::class, ': ', $e->getMessage(), PHP_EOL;
+}
+
+?>
+--EXPECT--
+bool(true)
+object(Directory)#2 (0) {
+  ["path"]=>
+  uninitialized(string)
+  ["handle"]=>
+  uninitialized(mixed)
+}
+Error: Unable to find my handle property

ext/standard/tests/directory/DirectoryClass_basic_001.phpt → ext/standard/tests/directory/DirectoryClass_reflection_structure.phpt

@@ -11,20 +11,10 @@ echo "Structure of Directory class:\n";
 $rc = new ReflectionClass("Directory");
 echo $rc;
 
-echo "Cannot instantiate a valid Directory directly:\n";
-$d = new Directory(getcwd());
-var_dump($d);
-
-try {
-    var_dump($d->read());
-} catch (\Error $e) {
-    echo $e->getMessage() . "\n";
-}
-
 ?>
---EXPECTF--
+--EXPECT--
 Structure of Directory class:
-Class [ <internal%s> class Directory ] {
+Class [ <internal:standard> final class Directory ] {
 
   - Constants [0] {
   }
@@ -45,29 +35,21 @@ Class [ <internal%s> class Directory ] {
 
       - Parameters [0] {
       }
-      - Tentative return [ void ]
+      - Return [ void ]
     }
 
     Method [ <internal:standard> public method rewind ] {
 
       - Parameters [0] {
       }
-      - Tentative return [ void ]
+      - Return [ void ]
     }
 
     Method [ <internal:standard> public method read ] {
 
       - Parameters [0] {
       }
-      - Tentative return [ string|false ]
+      - Return [ string|false ]
     }
   }
 }
-Cannot instantiate a valid Directory directly:
-object(Directory)#%d (0) {
-  ["path"]=>
-  uninitialized(string)
-  ["handle"]=>
-  uninitialized(mixed)
-}
-Unable to find my handle property