Adding exceptional functions

Author: zonuexe

bin/generate-function-metadata.php

@@ -36,12 +36,42 @@ public function enterNode(Node $node)
 			if ($node instanceof Node\Stmt\Function_) {
 				assert(isset($node->namespacedName));
 				$functionName = $node->namespacedName->toLowerString();
+
 				foreach ($node->attrGroups as $attrGroup) {
 					foreach ($attrGroup->attrs as $attr) {
 						if ($attr->name->toString() !== Pure::class) {
 							continue;
 						}
 
+						// The following functions have side effects, but their state is managed within the PHPStan scope:
+						if (in_array($functionName, [
+							'stat',
+							'lstat',
+							'file_exists',
+							'is_writable',
+							'is_writeable',
+							'is_readable',
+							'is_executable',
+							'is_file',
+							'is_dir',
+							'is_link',
+							'filectime',
+							'fileatime',
+							'filemtime',
+							'fileinode',
+							'filegroup',
+							'fileowner',
+							'filesize',
+							'filetype',
+							'fileperms',
+							'json_last_error',
+							'json_last_error_msg',
+						], true)) {
+							$this->functions[] = $functionName;
+							break 2;
+						}
+
+
 						// PhpStorm stub's #[Pure(true)] means the function has side effects but its return value is important.
 						// In PHPStan's criteria, these functions are simply considered as ['hasSideEffect' => true].
 						if (isset($attr->args[0]->value->name->name) && $attr->args[0]->value->name->name === 'true') {
@@ -99,6 +129,11 @@ public function enterNode(Node $node)
 	}
 	foreach ($visitor->impureFunctions as $functionName) {
 		if (array_key_exists($functionName, $metadata)) {
+			if (in_array($functionName, [
+				'ob_get_contents',
+			], true)) {
+				continue;
+			}
 			if ($metadata[$functionName]['hasSideEffects']) {
 				throw new ShouldNotHappenException($functionName);
 			}

resources/functionMetadata.php

@@ -888,18 +888,18 @@
 	'fgets' => ['hasSideEffects' => true],
 	'fgetss' => ['hasSideEffects' => true],
 	'file' => ['hasSideEffects' => true],
-	'file_exists' => ['hasSideEffects' => true],
+	'file_exists' => ['hasSideEffects' => false],
 	'file_get_contents' => ['hasSideEffects' => true],
 	'file_put_contents' => ['hasSideEffects' => true],
-	'fileatime' => ['hasSideEffects' => true],
-	'filectime' => ['hasSideEffects' => true],
-	'filegroup' => ['hasSideEffects' => true],
-	'fileinode' => ['hasSideEffects' => true],
-	'filemtime' => ['hasSideEffects' => true],
-	'fileowner' => ['hasSideEffects' => true],
-	'fileperms' => ['hasSideEffects' => true],
-	'filesize' => ['hasSideEffects' => true],
-	'filetype' => ['hasSideEffects' => true],
+	'fileatime' => ['hasSideEffects' => false],
+	'filectime' => ['hasSideEffects' => false],
+	'filegroup' => ['hasSideEffects' => false],
+	'fileinode' => ['hasSideEffects' => false],
+	'filemtime' => ['hasSideEffects' => false],
+	'fileowner' => ['hasSideEffects' => false],
+	'fileperms' => ['hasSideEffects' => false],
+	'filesize' => ['hasSideEffects' => false],
+	'filetype' => ['hasSideEffects' => false],
 	'filter_has_var' => ['hasSideEffects' => false],
 	'filter_id' => ['hasSideEffects' => false],
 	'filter_input' => ['hasSideEffects' => false],
@@ -1223,34 +1223,34 @@
 	'is_array' => ['hasSideEffects' => false],
 	'is_bool' => ['hasSideEffects' => false],
 	'is_countable' => ['hasSideEffects' => false],
-	'is_dir' => ['hasSideEffects' => true],
+	'is_dir' => ['hasSideEffects' => false],
 	'is_double' => ['hasSideEffects' => false],
-	'is_executable' => ['hasSideEffects' => true],
-	'is_file' => ['hasSideEffects' => true],
+	'is_executable' => ['hasSideEffects' => false],
+	'is_file' => ['hasSideEffects' => false],
 	'is_finite' => ['hasSideEffects' => false],
 	'is_float' => ['hasSideEffects' => false],
 	'is_infinite' => ['hasSideEffects' => false],
 	'is_int' => ['hasSideEffects' => false],
 	'is_integer' => ['hasSideEffects' => false],
 	'is_iterable' => ['hasSideEffects' => false],
-	'is_link' => ['hasSideEffects' => true],
+	'is_link' => ['hasSideEffects' => false],
 	'is_long' => ['hasSideEffects' => false],
 	'is_nan' => ['hasSideEffects' => false],
 	'is_null' => ['hasSideEffects' => false],
 	'is_numeric' => ['hasSideEffects' => false],
 	'is_object' => ['hasSideEffects' => false],
-	'is_readable' => ['hasSideEffects' => true],
+	'is_readable' => ['hasSideEffects' => false],
 	'is_real' => ['hasSideEffects' => false],
 	'is_resource' => ['hasSideEffects' => false],
 	'is_scalar' => ['hasSideEffects' => false],
 	'is_string' => ['hasSideEffects' => false],
 	'is_subclass_of' => ['hasSideEffects' => false],
 	'is_uploaded_file' => ['hasSideEffects' => true],
-	'is_writable' => ['hasSideEffects' => true],
-	'is_writeable' => ['hasSideEffects' => true],
+	'is_writable' => ['hasSideEffects' => false],
+	'is_writeable' => ['hasSideEffects' => false],
 	'iterator_count' => ['hasSideEffects' => false],
 	'join' => ['hasSideEffects' => false],
-	'json_last_error' => ['hasSideEffects' => true],
+	'json_last_error' => ['hasSideEffects' => false],
 	'json_last_error_msg' => ['hasSideEffects' => false],
 	'json_validate' => ['hasSideEffects' => false],
 	'key' => ['hasSideEffects' => false],
@@ -1285,7 +1285,7 @@
 	'log10' => ['hasSideEffects' => false],
 	'log1p' => ['hasSideEffects' => false],
 	'long2ip' => ['hasSideEffects' => false],
-	'lstat' => ['hasSideEffects' => true],
+	'lstat' => ['hasSideEffects' => false],
 	'ltrim' => ['hasSideEffects' => false],
 	'max' => ['hasSideEffects' => false],
 	'mb_check_encoding' => ['hasSideEffects' => false],
@@ -1496,7 +1496,7 @@
 	'spl_object_hash' => ['hasSideEffects' => false],
 	'sprintf' => ['hasSideEffects' => false],
 	'sqrt' => ['hasSideEffects' => false],
-	'stat' => ['hasSideEffects' => true],
+	'stat' => ['hasSideEffects' => false],
 	'str_contains' => ['hasSideEffects' => false],
 	'str_decrement' => ['hasSideEffects' => false],
 	'str_ends_with' => ['hasSideEffects' => false],