Merge branch 2.2.x into 2.3.x

Author: phpstan-bot

src/Rules/Functions/PrintfArrayParametersRule.php

@@ -13,6 +13,7 @@
 use PHPStan\Type\Constant\ConstantIntegerType;
 use PHPStan\Type\IntegerRangeType;
 use PHPStan\Type\IntegerType;
+use PHPStan\Type\Php\PrintfFormatParser;
 use PHPStan\Type\TypeCombinator;
 use function count;
 use function in_array;
@@ -28,7 +29,7 @@ final class PrintfArrayParametersRule implements Rule
 {
 
 	public function __construct(
-		private PrintfHelper $printfHelper,
+		private PrintfFormatParser $printfFormatParser,
 		private ReflectionProvider $reflectionProvider,
 	)
 	{
@@ -66,8 +67,8 @@ public function processNode(Node $node, Scope $scope): array
 		foreach ($formatArgType->getConstantStrings() as $formatString) {
 			$format = $formatString->getValue();
 
-			$count = $this->printfHelper->getPrintfPlaceholdersCount($format);
-			if ($count === null) {
+			$uses = $this->printfFormatParser->parse($format);
+			if ($uses === null) {
 				return [
 					RuleErrorBuilder::message(sprintf(
 						'Call to %s contains an invalid placeholder.',
@@ -76,7 +77,7 @@ public function processNode(Node $node, Scope $scope): array
 				];
 			}
 
-			$placeHoldersCounts[] = $count;
+			$placeHoldersCounts[] = $this->printfFormatParser->getRequiredArgumentsCount($uses);
 		}
 
 		if ($placeHoldersCounts === []) {

src/Rules/Functions/PrintfHelper.php

@@ -14,12 +14,14 @@
 use PHPStan\Type\FloatType;
 use PHPStan\Type\IntegerType;
 use PHPStan\Type\NullType;
+use PHPStan\Type\Php\PrintfFormatParser;
 use PHPStan\Type\StringAlwaysAcceptingObjectWithToStringType;
 use PHPStan\Type\Type;
 use PHPStan\Type\UnionType;
 use PHPStan\Type\VerbosityLevel;
 use function array_key_exists;
 use function count;
+use function in_array;
 use function sprintf;
 
 /**
@@ -40,7 +42,7 @@ final class PrintfParameterTypeRule implements Rule
 	];
 
 	public function __construct(
-		private PrintfHelper $printfHelper,
+		private PrintfFormatParser $printfFormatParser,
 		private ReflectionProvider $reflectionProvider,
 		private RuleLevelHelper $ruleLevelHelper,
 		private bool $checkStrictPrintfPlaceholderTypes,
@@ -92,7 +94,7 @@ public function processNode(Node $node, Scope $scope): array
 
 		$formatString = $formatArgTypeStrings[0];
 		$format = $formatString->getValue();
-		$placeholderMap = $this->printfHelper->getPrintfPlaceholders($format);
+		$placeholderMap = $this->getPlaceholders($format);
 		if ($placeholderMap === null) {
 			// Already reported by PrintfParametersRule.
 			return [];
@@ -171,4 +173,60 @@ public function processNode(Node $node, Scope $scope): array
 		return $errors;
 	}
 
+	/**
+	 * @return array<int, non-empty-list<PrintfPlaceholder>>|null parameter index => placeholders
+	 */
+	private function getPlaceholders(string $format): ?array
+	{
+		$uses = $this->printfFormatParser->parse($format);
+		if ($uses === null) {
+			return null;
+		}
+
+		$placeholdersWithStar = [];
+		foreach ($uses as $use) {
+			if ($use['kind'] === 'value') {
+				continue;
+			}
+
+			$placeholdersWithStar[$use['number']] = true;
+		}
+
+		$placeholders = [];
+		foreach ($uses as $use) {
+			$label = sprintf('"%s"', $use['placeholder']);
+			if ($use['kind'] !== 'value') {
+				$label .= sprintf(' (%s)', $use['kind']);
+				$acceptingType = 'strict-int';
+			} else {
+				if (isset($placeholdersWithStar[$use['number']])) {
+					$label .= ' (value)';
+				}
+				$acceptingType = $this->getAcceptingTypeBySpecifier($use['specifier']);
+			}
+
+			$placeholders[$use['index']][] = new PrintfPlaceholder($label, $use['number'], $acceptingType);
+		}
+
+		return $placeholders;
+	}
+
+	/** @phpstan-return 'string'|'int'|'float'|'mixed' */
+	private function getAcceptingTypeBySpecifier(string $specifier): string
+	{
+		if ($specifier === 's') {
+			return 'string';
+		}
+
+		if (in_array($specifier, ['d', 'u', 'c', 'o', 'x', 'X', 'b'], true)) {
+			return 'int';
+		}
+
+		if (in_array($specifier, ['e', 'E', 'f', 'F', 'g', 'G', 'h', 'H'], true)) {
+			return 'float';
+		}
+
+		return 'mixed';
+	}
+
 }

src/Rules/Functions/PrintfParameterTypeRule.php

@@ -9,10 +9,13 @@
 use PHPStan\Reflection\ReflectionProvider;
 use PHPStan\Rules\Rule;
 use PHPStan\Rules\RuleErrorBuilder;
+use PHPStan\Type\Php\PrintfFormatParser;
+use ValueError;
 use function array_key_exists;
 use function count;
 use function in_array;
 use function sprintf;
+use function sscanf;
 
 /**
  * @implements Rule<Node\Expr\FuncCall>
@@ -35,7 +38,7 @@ final class PrintfParametersRule implements Rule
 	];
 
 	public function __construct(
-		private PrintfHelper $printfHelper,
+		private PrintfFormatParser $printfFormatParser,
 		private ReflectionProvider $reflectionProvider,
 	)
 	{
@@ -81,9 +84,9 @@ public function processNode(Node $node, Scope $scope): array
 			$format = $formatString->getValue();
 
 			if (in_array($name, ['sprintf', 'printf'], true)) {
-				$tempPlaceHoldersCount = $this->printfHelper->getPrintfPlaceholdersCount($format);
+				$tempPlaceHoldersCount = $this->getPrintfPlaceholdersCount($format);
 			} else {
-				$tempPlaceHoldersCount = $this->printfHelper->getScanfPlaceholdersCount($format);
+				$tempPlaceHoldersCount = $this->getScanfPlaceholdersCount($format);
 			}
 
 			if ($tempPlaceHoldersCount === null) {
@@ -126,4 +129,29 @@ public function processNode(Node $node, Scope $scope): array
 		return [];
 	}
 
+	private function getPrintfPlaceholdersCount(string $format): ?int
+	{
+		$uses = $this->printfFormatParser->parse($format);
+		if ($uses === null) {
+			return null;
+		}
+
+		return $this->printfFormatParser->getRequiredArgumentsCount($uses);
+	}
+
+	private function getScanfPlaceholdersCount(string $format): ?int
+	{
+		try {
+			$result = @sscanf('', '%*n' . $format);
+		} catch (ValueError) {
+			return null;
+		}
+
+		if ($result === null) {
+			return null;
+		}
+
+		return count($result);
+	}
+
 }

src/Rules/Functions/PrintfParametersRule.php

@@ -21,7 +21,6 @@ final class PrintfPlaceholder
 	/** @phpstan-param 'strict-int'|'int'|'float'|'string'|'mixed' $acceptingType */
 	public function __construct(
 		public readonly string $label,
-		public readonly int $parameterIndex,
 		public readonly int $placeholderNumber,
 		public readonly string $acceptingType,
 	)