Support ${'variable'}('foo') dynamic function calls

spaze · Dec 7, 2024 · f3f41e5 · f3f41e5
1 parent 02d0741
commit f3f41e5
Show file tree

Hide file tree

Showing 14 changed files with 60 additions and 5 deletions.
diff --git a/src/Calls/FunctionCalls.php b/src/Calls/FunctionCalls.php
@@ -5,6 +5,7 @@
 
 use PhpParser\Node;
 use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Name;
 use PhpParser\Node\Scalar\String_;
 use PHPStan\Analyser\Scope;
@@ -17,6 +18,7 @@
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\ErrorIdentifiers;
+use Spaze\PHPStan\Rules\Disallowed\Type\TypeResolver;
 
 /**
  * Reports on dynamically calling a disallowed function.
@@ -36,12 +38,15 @@ class FunctionCalls implements Rule
 
 	private Normalizer $normalizer;
 
+	private TypeResolver $typeResolver;
+
 
 	/**
 	 * @param DisallowedCallsRuleErrors $disallowedCallsRuleErrors
 	 * @param DisallowedCallFactory $disallowedCallFactory
 	 * @param ReflectionProvider $reflectionProvider
 	 * @param Normalizer $normalizer
+	 * @param TypeResolver $typeResolver
 	 * @param array $forbiddenCalls
 	 * @phpstan-param ForbiddenCallsConfig $forbiddenCalls
 	 * @noinspection PhpUndefinedClassInspection ForbiddenCallsConfig is a type alias defined in PHPStan config
@@ -52,12 +57,14 @@ public function __construct(
 		DisallowedCallFactory $disallowedCallFactory,
 		ReflectionProvider $reflectionProvider,
 		Normalizer $normalizer,
+		TypeResolver $typeResolver,
 		array $forbiddenCalls
 	) {
 		$this->disallowedCallsRuleErrors = $disallowedCallsRuleErrors;
 		$this->disallowedCalls = $disallowedCallFactory->createFromConfig($forbiddenCalls);
 		$this->reflectionProvider = $reflectionProvider;
 		$this->normalizer = $normalizer;
+		$this->typeResolver = $typeResolver;
 	}
 
 
@@ -83,8 +90,8 @@ public function processNode(Node $node, Scope $scope): array
 			$names = [$namespacedName, $node->name];
 		} elseif ($node->name instanceof String_) {
 			$names = [new Name($this->normalizer->normalizeNamespace($node->name->value))];
-		} elseif ($node->name instanceof Node\Expr\Variable && is_string($node->name->name)) {
-			$value = $scope->getVariableType($node->name->name)->getConstantScalarValues()[0];
+		} elseif ($node->name instanceof Variable) {
+			$value = $this->typeResolver->getVariableStringValue($node->name, $scope);
 			if (!is_string($value)) {
 				return [];
 			}

diff --git a/src/Type/TypeResolver.php b/src/Type/TypeResolver.php
@@ -4,7 +4,9 @@
 namespace Spaze\PHPStan\Rules\Disallowed\Type;
 
 use PhpParser\Node\Expr;
+use PhpParser\Node\Expr\Variable;
 use PhpParser\Node\Name;
+use PhpParser\Node\Scalar\String_;
 use PHPStan\Analyser\Scope;
 use PHPStan\Type\ObjectType;
 use PHPStan\Type\Type;
@@ -22,4 +24,16 @@ public function getType($class, Scope $scope): Type
 		return $class instanceof Name ? new ObjectType($scope->resolveName($class)) : $scope->getType($class);
 	}
 
+
+	public function getVariableStringValue(Variable $variable, Scope $scope): ?string
+	{
+		$variableNameNode = $variable->name;
+		$variableName = $variableNameNode instanceof String_ ? $variableNameNode->value : $variableNameNode;
+		if (!is_string($variableName)) {
+			return null;
+		}
+		$value = $scope->getVariableType($variableName)->getConstantScalarValues()[0];
+		return is_string($value) ? $value : null;
+	}
+
 }
diff --git a/tests/Calls/FunctionCallsAllowInFunctionsTest.php b/tests/Calls/FunctionCallsAllowInFunctionsTest.php
@@ -9,6 +9,7 @@
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
+use Spaze\PHPStan\Rules\Disallowed\Type\TypeResolver;
 
 class FunctionCallsAllowInFunctionsTest extends RuleTestCase
 {
@@ -24,6 +25,7 @@ protected function getRule(): Rule
 			$container->getByType(DisallowedCallFactory::class),
 			$this->createReflectionProvider(),
 			$container->getByType(Normalizer::class),
+			$container->getByType(TypeResolver::class),
 			[
 				[
 					'function' => 'md*()',

diff --git a/tests/Calls/FunctionCallsAllowInMethodsTest.php b/tests/Calls/FunctionCallsAllowInMethodsTest.php
@@ -9,6 +9,7 @@
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
+use Spaze\PHPStan\Rules\Disallowed\Type\TypeResolver;
 
 class FunctionCallsAllowInMethodsTest extends RuleTestCase
 {
@@ -24,6 +25,7 @@ protected function getRule(): Rule
 			$container->getByType(DisallowedCallFactory::class),
 			$this->createReflectionProvider(),
 			$container->getByType(Normalizer::class),
+			$container->getByType(TypeResolver::class),
 			[
 				[
 					'function' => 'md5_file()',

diff --git a/tests/Calls/FunctionCallsDefinedInTest.php b/tests/Calls/FunctionCallsDefinedInTest.php
@@ -9,6 +9,7 @@
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
+use Spaze\PHPStan\Rules\Disallowed\Type\TypeResolver;
 
 class FunctionCallsDefinedInTest extends RuleTestCase
 {
@@ -24,6 +25,7 @@ protected function getRule(): Rule
 			$container->getByType(DisallowedCallFactory::class),
 			$this->createReflectionProvider(),
 			$container->getByType(Normalizer::class),
+			$container->getByType(TypeResolver::class),
 			[
 				[
 					'function' => '\\Foo\\Bar\\Waldo\\f*()',

diff --git a/tests/Calls/FunctionCallsInMultipleNamespacesTest.php b/tests/Calls/FunctionCallsInMultipleNamespacesTest.php
@@ -9,6 +9,7 @@
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
+use Spaze\PHPStan\Rules\Disallowed\Type\TypeResolver;
 
 class FunctionCallsInMultipleNamespacesTest extends RuleTestCase
 {
@@ -24,6 +25,7 @@ protected function getRule(): Rule
 			$container->getByType(DisallowedCallFactory::class),
 			$this->createReflectionProvider(),
 			$container->getByType(Normalizer::class),
+			$container->getByType(TypeResolver::class),
 			[
 				[
 					'function' => '__()',

diff --git a/tests/Calls/FunctionCallsNamedParamsTest.php b/tests/Calls/FunctionCallsNamedParamsTest.php
@@ -10,6 +10,7 @@
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
+use Spaze\PHPStan\Rules\Disallowed\Type\TypeResolver;
 
 /**
  * @requires PHP >= 8.0
@@ -29,6 +30,7 @@ protected function getRule(): Rule
 			$container->getByType(DisallowedCallFactory::class),
 			$this->createReflectionProvider(),
 			$container->getByType(Normalizer::class),
+			$container->getByType(TypeResolver::class),
 			[
 				[
 					'function' => 'Foo\Bar\Waldo\foo()',

diff --git a/tests/Calls/FunctionCallsParamsMessagesTest.php b/tests/Calls/FunctionCallsParamsMessagesTest.php
@@ -9,6 +9,7 @@
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
+use Spaze\PHPStan\Rules\Disallowed\Type\TypeResolver;
 
 class FunctionCallsParamsMessagesTest extends RuleTestCase
 {
@@ -24,6 +25,7 @@ protected function getRule(): Rule
 			$container->getByType(DisallowedCallFactory::class),
 			$this->createReflectionProvider(),
 			$container->getByType(Normalizer::class),
+			$container->getByType(TypeResolver::class),
 			[
 				[
 					'function' => '\Foo\Bar\Waldo\config()',

diff --git a/tests/Calls/FunctionCallsTest.php b/tests/Calls/FunctionCallsTest.php
@@ -9,6 +9,7 @@
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
+use Spaze\PHPStan\Rules\Disallowed\Type\TypeResolver;
 use Waldo\Quux\Blade;
 
 class FunctionCallsTest extends RuleTestCase
@@ -25,6 +26,7 @@ protected function getRule(): Rule
 			$container->getByType(DisallowedCallFactory::class),
 			$this->createReflectionProvider(),
 			$container->getByType(Normalizer::class),
+			$container->getByType(TypeResolver::class),
 			[
 				[
 					'function' => '\var_dump()',
@@ -335,9 +337,17 @@ public function testRule(): void
 				114,
 			],
 			[
-				'Calling Foo\Bar\Waldo() is forbidden, whoa, a namespace. [Foo\Bar\Waldo() matches Foo\Bar\waldo()]',
+				'Calling Foo\Bar\waldo() is forbidden, whoa, a namespace.',
 				115,
 			],
+			[
+				'Calling Foo\Bar\waldo() is forbidden, whoa, a namespace.',
+				117,
+			],
+			[
+				'Calling Foo\Bar\Waldo() is forbidden, whoa, a namespace. [Foo\Bar\Waldo() matches Foo\Bar\waldo()]',
+				118,
+			],
 		]);
 		$this->analyse([__DIR__ . '/../src/disallowed-allow/functionCalls.php'], [
 			[

diff --git a/tests/Calls/FunctionCallsTypeStringParamsInvalidFlagsConfigTest.php b/tests/Calls/FunctionCallsTypeStringParamsInvalidFlagsConfigTest.php
@@ -8,6 +8,7 @@
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
+use Spaze\PHPStan\Rules\Disallowed\Type\TypeResolver;
 
 class FunctionCallsTypeStringParamsInvalidFlagsConfigTest extends PHPStanTestCase
 {
@@ -25,6 +26,7 @@ public function testException(): void
 			$container->getByType(DisallowedCallFactory::class),
 			$this->createReflectionProvider(),
 			$container->getByType(Normalizer::class),
+			$container->getByType(TypeResolver::class),
 			[
 				[
 					'function' => '\Foo\Bar\Waldo\intParam1()',

diff --git a/tests/Calls/FunctionCallsTypeStringParamsTest.php b/tests/Calls/FunctionCallsTypeStringParamsTest.php
@@ -9,6 +9,7 @@
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
+use Spaze\PHPStan\Rules\Disallowed\Type\TypeResolver;
 
 class FunctionCallsTypeStringParamsTest extends RuleTestCase
 {
@@ -24,6 +25,7 @@ protected function getRule(): Rule
 			$container->getByType(DisallowedCallFactory::class),
 			$this->createReflectionProvider(),
 			$container->getByType(Normalizer::class),
+			$container->getByType(TypeResolver::class),
 			[
 				[
 					'function' => '\Foo\Bar\Waldo\config()',

diff --git a/tests/Calls/FunctionCallsUnsupportedParamConfigTest.php b/tests/Calls/FunctionCallsUnsupportedParamConfigTest.php
@@ -8,6 +8,7 @@
 use Spaze\PHPStan\Rules\Disallowed\DisallowedCallFactory;
 use Spaze\PHPStan\Rules\Disallowed\Normalizer\Normalizer;
 use Spaze\PHPStan\Rules\Disallowed\RuleErrors\DisallowedCallsRuleErrors;
+use Spaze\PHPStan\Rules\Disallowed\Type\TypeResolver;
 
 class FunctionCallsUnsupportedParamConfigTest extends PHPStanTestCase
 {
@@ -25,6 +26,7 @@ public function testUnsupportedArrayInParamConfig(): void
 			$container->getByType(DisallowedCallFactory::class),
 			$this->createReflectionProvider(),
 			$container->getByType(Normalizer::class),
+			$container->getByType(TypeResolver::class),
 			[
 				[
 					'function' => [

diff --git a/tests/src/disallowed-allow/functionCalls.php b/tests/src/disallowed-allow/functionCalls.php
@@ -108,8 +108,11 @@
 
 $sneaky = 'Foo\Bar\waldo';
 $sneaky('foo');
-('Foo\Bar\waldo')('foo');
+${'sneaky'}('foo');
 
 $sneaky = '\Foo\Bar\waldo';
 $sneaky('foo');
+${'sneaky'}('foo');
+
+('Foo\Bar\waldo')('foo');
 ('\Foo\Bar\Waldo')('foo');
diff --git a/tests/src/disallowed/functionCalls.php b/tests/src/disallowed/functionCalls.php
@@ -108,8 +108,11 @@
 
 $sneaky = 'Foo\Bar\waldo';
 $sneaky('foo');
-('Foo\Bar\waldo')('foo');
+${'sneaky'}('foo');
 
 $sneaky = '\Foo\Bar\waldo';
 $sneaky('foo');
+${'sneaky'}('foo');
+
+('Foo\Bar\waldo')('foo');
 ('\Foo\Bar\Waldo')('foo');