-
Notifications
You must be signed in to change notification settings - Fork 457
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
7 changed files
with
291 additions
and
66 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,111 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace PHPStan\Rules\Functions; | ||
|
|
||
| use PhpParser\Node; | ||
| use PhpParser\Node\Expr\FuncCall; | ||
| use PHPStan\Analyser\Scope; | ||
| use PHPStan\Rules\Rule; | ||
| use PHPStan\Rules\RuleErrorBuilder; | ||
| use PHPStan\Type\Constant\ConstantIntegerType; | ||
| use function array_key_exists; | ||
| use function count; | ||
| use function sprintf; | ||
| use function strtolower; | ||
|
|
||
| /** | ||
| * @implements Rule<Node\Expr\FuncCall> | ||
| */ | ||
| class PrintfArrayParametersRule implements Rule | ||
| { | ||
|
|
||
| public function __construct(private PrintfHelper $printfHelper) | ||
| { | ||
| } | ||
|
|
||
| public function getNodeType(): string | ||
| { | ||
| return FuncCall::class; | ||
| } | ||
|
|
||
| public function processNode(Node $node, Scope $scope): array | ||
| { | ||
| if (!($node->name instanceof Node\Name)) { | ||
| return []; | ||
| } | ||
|
|
||
| $functionsArgumentPositions = [ | ||
| 'vprintf' => 0, | ||
| 'vsprintf' => 0, | ||
| ]; | ||
| $minimumNumberOfArguments = [ | ||
| 'vprintf' => 1, | ||
| 'vsprintf' => 1, | ||
| ]; | ||
|
|
||
| $name = strtolower((string) $node->name); | ||
| if (!array_key_exists($name, $functionsArgumentPositions)) { | ||
| return []; | ||
| } | ||
|
|
||
| $formatArgumentPosition = $functionsArgumentPositions[$name]; | ||
|
|
||
| $args = $node->getArgs(); | ||
| foreach ($args as $arg) { | ||
| if ($arg->unpack) { | ||
| return []; | ||
| } | ||
| } | ||
| $argsCount = count($args); | ||
| if ($argsCount < $minimumNumberOfArguments[$name]) { | ||
| return []; // caught by CallToFunctionParametersRule | ||
| } | ||
|
|
||
| $formatArgType = $scope->getType($args[$formatArgumentPosition]->value); | ||
| $maxPlaceHoldersCount = null; | ||
| foreach ($formatArgType->getConstantStrings() as $formatString) { | ||
| $format = $formatString->getValue(); | ||
| $tempPlaceHoldersCount = $this->printfHelper->getPrintfPlaceholdersCount($format); | ||
| if ($maxPlaceHoldersCount === null) { | ||
| $maxPlaceHoldersCount = $tempPlaceHoldersCount; | ||
| } elseif ($tempPlaceHoldersCount > $maxPlaceHoldersCount) { | ||
| $maxPlaceHoldersCount = $tempPlaceHoldersCount; | ||
| } | ||
| } | ||
|
|
||
| if ($maxPlaceHoldersCount === null) { | ||
| return []; | ||
| } | ||
|
|
||
| $formatArgsCount = 0; | ||
| if (isset($args[1])) { | ||
| $formatArgs = $scope->getType($args[1]->value); | ||
|
|
||
| foreach ($formatArgs->getConstantArrays() as $constantArray) { | ||
| $size = $constantArray->getArraySize(); | ||
| if (!$size instanceof ConstantIntegerType) { | ||
| return []; | ||
| } | ||
| $formatArgsCount = $size->getValue(); | ||
| } | ||
| } | ||
|
|
||
| if ($formatArgsCount !== $maxPlaceHoldersCount) { | ||
| return [ | ||
| RuleErrorBuilder::message(sprintf( | ||
| sprintf( | ||
| '%s, %s.', | ||
| $maxPlaceHoldersCount === 1 ? 'Call to %s contains %d placeholder' : 'Call to %s contains %d placeholders', | ||
| $formatArgsCount === 1 ? '%d value given' : '%d values given', | ||
| ), | ||
| $name, | ||
| $maxPlaceHoldersCount, | ||
| $formatArgsCount, | ||
| ))->identifier(sprintf('argument.%s', $name))->build(), | ||
| ]; | ||
| } | ||
|
|
||
| return []; | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| <?php declare(strict_types = 1); | ||
|
|
||
| namespace PHPStan\Rules\Functions; | ||
|
|
||
| use Nette\Utils\Strings; | ||
| use PHPStan\Php\PhpVersion; | ||
| use function array_filter; | ||
| use function count; | ||
| use function max; | ||
| use function sprintf; | ||
| use function strlen; | ||
| use const PREG_SET_ORDER; | ||
|
|
||
| final class PrintfHelper | ||
| { | ||
|
|
||
| public function __construct(private PhpVersion $phpVersion) | ||
| { | ||
| } | ||
|
|
||
| public function getPrintfPlaceholdersCount(string $format): int | ||
| { | ||
| return $this->getPlaceholdersCount('(?:[bs%s]|l?[cdeEgfFGouxX])', $format); | ||
| } | ||
|
|
||
| public function getScanfPlaceholdersCount(string $format): int | ||
| { | ||
| return $this->getPlaceholdersCount('(?:[cdDeEfinosuxX%s]|\[[^\]]+\])', $format); | ||
| } | ||
|
|
||
| private function getPlaceholdersCount(string $specifiersPattern, string $format): int | ||
| { | ||
| $addSpecifier = ''; | ||
| if ($this->phpVersion->supportsHhPrintfSpecifier()) { | ||
| $addSpecifier .= 'hH'; | ||
| } | ||
|
|
||
| $specifiers = sprintf($specifiersPattern, $addSpecifier); | ||
|
|
||
| $pattern = '~(?<before>%*)%(?:(?<position>\d+)\$)?[-+]?(?:[ 0]|(?:\'[^%]))?(?<width>\*)?-?\d*(?:\.(?:\d+|(?<precision>\*))?)?' . $specifiers . '~'; | ||
|
|
||
| $matches = Strings::matchAll($format, $pattern, PREG_SET_ORDER); | ||
|
|
||
| if (count($matches) === 0) { | ||
| return 0; | ||
| } | ||
|
|
||
| $placeholders = array_filter($matches, static fn (array $match): bool => strlen($match['before']) % 2 === 0); | ||
|
|
||
| if (count($placeholders) === 0) { | ||
| return 0; | ||
| } | ||
|
|
||
| $maxPositionedNumber = 0; | ||
| $maxOrdinaryNumber = 0; | ||
| foreach ($placeholders as $placeholder) { | ||
| if (isset($placeholder['width']) && $placeholder['width'] !== '') { | ||
| $maxOrdinaryNumber++; | ||
| } | ||
|
|
||
| if (isset($placeholder['precision']) && $placeholder['precision'] !== '') { | ||
| $maxOrdinaryNumber++; | ||
| } | ||
|
|
||
| if (isset($placeholder['position']) && $placeholder['position'] !== '') { | ||
| $maxPositionedNumber = max((int) $placeholder['position'], $maxPositionedNumber); | ||
| } else { | ||
| $maxOrdinaryNumber++; | ||
| } | ||
| } | ||
|
|
||
| return max($maxPositionedNumber, $maxOrdinaryNumber); | ||
| } | ||
|
|
||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.