1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-12 01:09:38 +01:00
psalm/src/Psalm/Internal/Analyzer/CommentAnalyzer.php

1412 lines
52 KiB
PHP
Raw Normal View History

2016-06-24 00:45:46 +02:00
<?php
2018-11-06 03:57:36 +01:00
namespace Psalm\Internal\Analyzer;
use PhpParser;
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
use Psalm\Aliases;
2018-11-06 03:57:36 +01:00
use Psalm\DocComment;
2016-11-02 07:29:00 +01:00
use Psalm\Exception\DocblockParseException;
use Psalm\Exception\IncorrectDocblockException;
use Psalm\Exception\TypeParseTreeException;
2018-01-21 18:44:46 +01:00
use Psalm\FileSource;
2018-11-06 03:57:36 +01:00
use Psalm\Internal\Scanner\ClassLikeDocblockComment;
use Psalm\Internal\Scanner\FunctionDocblockComment;
use Psalm\Internal\Scanner\VarDocblockComment;
2020-05-29 04:14:41 +02:00
use Psalm\Internal\Scanner\ParsedDocblock;
use Psalm\Internal\Type\ParseTree;
2020-05-28 20:31:09 +02:00
use Psalm\Internal\Type\ParseTreeCreator;
use Psalm\Internal\Type\TypeAlias;
use Psalm\Internal\Type\TypeParser;
use Psalm\Internal\Type\TypeTokenizer;
use Psalm\Type;
use function array_unique;
use function trim;
use function substr_count;
use function strlen;
use function preg_replace;
use function str_replace;
use function preg_match;
use function count;
use function reset;
use function preg_split;
use const PREG_SPLIT_DELIM_CAPTURE;
use const PREG_SPLIT_NO_EMPTY;
use function array_shift;
use function implode;
use function substr;
use function strpos;
use function strtolower;
use function in_array;
use function explode;
use function array_merge;
use const PREG_OFFSET_CAPTURE;
use function rtrim;
2016-06-24 00:45:46 +02:00
/**
* @internal
*/
2018-11-06 03:57:36 +01:00
class CommentAnalyzer
2016-06-24 00:45:46 +02:00
{
const TYPE_REGEX = '(\??\\\?[\(\)A-Za-z0-9_&\<\.=,\>\[\]\-\{\}:|?\\\\]*|\$[a-zA-Z_0-9_]+)';
2016-06-24 00:45:46 +02:00
/**
* @param array<string, array<string, array{Type\Union}>>|null $template_type_map
* @param array<string, TypeAlias> $type_aliases
2017-05-27 02:16:18 +02:00
*
* @throws DocblockParseException if there was a problem parsing the docblock
*
* @return VarDocblockComment[]
2016-06-24 00:45:46 +02:00
*/
2016-11-02 07:29:00 +01:00
public static function getTypeFromComment(
PhpParser\Comment\Doc $comment,
2018-01-21 18:44:46 +01:00
FileSource $source,
Refactor scanning and analysis, introducing multithreading (#191) * Add failing test * Add visitor to soup up classlike references * Move a whole bunch of code into the visitor * Move some methods back, move onto analysis stage * Use the getAliases method everywhere * Fix refs * Fix more refs * Fix some tests * Fix more tests * Fix include tests * Shift config class finding to project checker and fix bugs * Fix a few more tests * transition test to new syntax * Remove var_dump * Delete a bunch of code and fix mutation test * Remove unnecessary visitation * Transition to better mocked out file provider, breaking some cached statement loading * Use different scheme for naming anonymous classes * Fix anonymous class issues * Refactor file/statement loading * Add specific property types * Fix mapped property assignment * Improve how we deal with traits * Fix trait checking * Pass Psalm checks * Add multi-process support * Delay console output until the end * Remove PHP 7 syntax * Update file storage with classes * Fix scanning individual files and add reflection return types * Always turn XDebug off * Add quicker method of getting method mutations * Queue return types for crawling * Interpret all strings as possible classes once we see a `get_class` call * Check invalid return types again * Fix template namespacing issues * Default to class-insensitive file names for includes * Don’t overwrite existing issues data * Add var docblocks for scanning * Add null check * Fix loading of external classes in templates * Only try to populate class when we haven’t yet seen it’s not a class * Fix trait property accessibility * Only ever improve docblock param type * Make param replacement more robust * Fix static const missing inferred type * Fix a few more tests * Register constant definitions * Fix trait aliasing * Skip constant type tests for now * Fix linting issues * Make sure caching is off for tests * Remove unnecessary return * Use emulative parser if on PHP 5.6 * Cache parser for faster first-time parse * Fix constant resolution when scanning classes * Remove test that’s beyond a practical scope * Add back --diff support * Add --help for --threads * Remove unused vars
2017-07-25 22:11:02 +02:00
Aliases $aliases,
?array $template_type_map = null,
2019-06-01 18:25:57 +02:00
?array $type_aliases = null
): array {
$parsed_docblock = DocComment::parsePreservingLength($comment);
return self::arrayToDocblocks(
$comment,
$parsed_docblock,
$source,
$aliases,
$template_type_map,
$type_aliases
);
}
/**
* @param array<string, array<string, array{Type\Union}>>|null $template_type_map
* @param array<string, TypeAlias> $type_aliases
*
* @return VarDocblockComment[]
*
* @throws DocblockParseException if there was a problem parsing the docblock
*/
public static function arrayToDocblocks(
PhpParser\Comment\Doc $comment,
2020-05-29 04:14:41 +02:00
ParsedDocblock $parsed_docblock,
FileSource $source,
Aliases $aliases,
?array $template_type_map = null,
?array $type_aliases = null
) : array {
$var_id = null;
2016-06-24 00:45:46 +02:00
2018-05-20 23:19:53 +02:00
$var_type_tokens = null;
$original_type = null;
2016-06-24 00:45:46 +02:00
$var_comments = [];
2016-06-24 00:45:46 +02:00
2019-06-01 22:57:33 +02:00
$comment_text = $comment->getText();
$var_line_number = $comment->getStartLine();
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->combined_tags['var'])) {
foreach ($parsed_docblock->combined_tags['var'] as $offset => $var_line) {
2017-03-02 04:27:52 +01:00
$var_line = trim($var_line);
2016-06-24 00:45:46 +02:00
2017-03-02 04:27:52 +01:00
if (!$var_line) {
continue;
}
2019-06-01 18:25:57 +02:00
$type_start = null;
$type_end = null;
$line_parts = self::splitDocLine($var_line);
2017-03-02 04:27:52 +01:00
$line_number = $comment->getStartLine() + substr_count($comment_text, "\n", 0, $offset);
2019-06-01 22:57:33 +02:00
2017-03-02 04:27:52 +01:00
if ($line_parts && $line_parts[0]) {
$type_start = $offset + $comment->getStartFilePos();
$type_end = $type_start + strlen($line_parts[0]);
2020-04-03 20:56:11 +02:00
$line_parts[0] = self::sanitizeDocblockType($line_parts[0]);
if ($line_parts[0] === ''
|| ($line_parts[0][0] === '$'
&& !preg_match('/^\$this(\||$)/', $line_parts[0]))
) {
throw new IncorrectDocblockException('Misplaced variable');
}
try {
$var_type_tokens = TypeTokenizer::getFullyQualifiedTokens(
$line_parts[0],
$aliases,
$template_type_map,
2018-07-15 23:23:17 +02:00
$type_aliases
);
} catch (TypeParseTreeException $e) {
throw new DocblockParseException($line_parts[0] . ' is not a valid type');
}
2017-03-02 04:27:52 +01:00
$original_type = $line_parts[0];
2017-03-02 04:27:52 +01:00
$var_line_number = $line_number;
if (count($line_parts) > 1 && $line_parts[1][0] === '$') {
$var_id = $line_parts[1];
2017-03-02 04:27:52 +01:00
}
}
2017-03-02 04:27:52 +01:00
2018-05-20 23:19:53 +02:00
if (!$var_type_tokens || !$original_type) {
continue;
2016-06-24 00:45:46 +02:00
}
try {
$defined_type = TypeParser::parseTokens(
$var_type_tokens,
null,
$template_type_map ?: [],
$type_aliases ?: []
);
} catch (TypeParseTreeException $e) {
throw new DocblockParseException(
$line_parts[0] .
' is not a valid type' .
' (from ' .
$source->getFilePath() .
':' .
$comment->getStartLine() .
')'
);
}
$defined_type->setFromDocblock();
2016-06-24 00:45:46 +02:00
$var_comment = new VarDocblockComment();
$var_comment->type = $defined_type;
$var_comment->original_type = $original_type;
$var_comment->var_id = $var_id;
$var_comment->line_number = $var_line_number;
2019-06-01 18:25:57 +02:00
$var_comment->type_start = $type_start;
$var_comment->type_end = $type_end;
2020-05-29 04:14:41 +02:00
self::decorateVarDocblockComment($var_comment, $parsed_docblock);
$var_comments[] = $var_comment;
}
}
2016-06-24 00:45:46 +02:00
2019-08-11 22:01:37 +02:00
if (!$var_comments
2020-05-29 04:14:41 +02:00
&& (isset($parsed_docblock->tags['deprecated'])
|| isset($parsed_docblock->tags['internal'])
|| isset($parsed_docblock->tags['readonly'])
|| isset($parsed_docblock->tags['psalm-readonly'])
|| isset($parsed_docblock->tags['psalm-readonly-allow-private-mutation'])
2020-06-21 17:43:08 +02:00
|| isset($parsed_docblock->tags['psalm-taint-escape'])
2020-05-29 04:14:41 +02:00
|| isset($parsed_docblock->tags['psalm-internal']))
2019-08-11 22:01:37 +02:00
) {
$var_comment = new VarDocblockComment();
2020-05-29 04:14:41 +02:00
self::decorateVarDocblockComment($var_comment, $parsed_docblock);
2019-08-11 22:01:37 +02:00
$var_comments[] = $var_comment;
}
return $var_comments;
2016-06-24 00:45:46 +02:00
}
2020-05-29 04:14:41 +02:00
private static function decorateVarDocblockComment(
VarDocblockComment $var_comment,
ParsedDocblock $parsed_docblock
) : void {
$var_comment->deprecated = isset($parsed_docblock->tags['deprecated']);
$var_comment->internal = isset($parsed_docblock->tags['internal']);
$var_comment->readonly = isset($parsed_docblock->tags['readonly'])
|| isset($parsed_docblock->tags['psalm-readonly'])
|| isset($parsed_docblock->tags['psalm-readonly-allow-private-mutation']);
$var_comment->allow_private_mutation
= isset($parsed_docblock->tags['psalm-allow-private-mutation'])
|| isset($parsed_docblock->tags['psalm-readonly-allow-private-mutation']);
2020-06-21 17:43:08 +02:00
if (isset($parsed_docblock->tags['psalm-taint-escape'])) {
foreach ($parsed_docblock->tags['psalm-taint-escape'] as $param) {
2020-05-29 04:14:41 +02:00
$param = trim($param);
$var_comment->removed_taints[] = $param;
}
}
if (isset($parsed_docblock->tags['psalm-internal'])) {
$psalm_internal = reset($parsed_docblock->tags['psalm-internal']);
if (!$psalm_internal) {
throw new DocblockParseException('psalm-internal annotation used without specifying namespace');
}
$var_comment->psalm_internal = reset($parsed_docblock->tags['psalm-internal']);
$var_comment->internal = true;
2020-05-29 04:14:41 +02:00
}
}
2020-08-23 19:52:31 +02:00
/**
* @psalm-pure
*/
2020-04-03 20:56:11 +02:00
private static function sanitizeDocblockType(string $docblock_type) : string
{
$docblock_type = preg_replace('@^[ \t]*\*@m', '', $docblock_type);
$docblock_type = preg_replace('/,\n\s+\}/', '}', $docblock_type);
return str_replace("\n", '', $docblock_type);
}
2018-07-15 23:23:17 +02:00
/**
* @param array<string, TypeAlias> $type_aliases
2018-07-15 23:23:17 +02:00
*
* @return array<string, TypeAlias\InlineTypeAlias>
*
* @throws DocblockParseException if there was a problem parsing the docblock
2018-07-15 23:23:17 +02:00
*/
public static function getTypeAliasesFromComment(
PhpParser\Comment\Doc $comment,
2018-07-15 23:23:17 +02:00
Aliases $aliases,
?array $type_aliases,
?string $self_fqcln
): array {
$parsed_docblock = DocComment::parsePreservingLength($comment);
2018-07-15 23:23:17 +02:00
2020-05-29 04:14:41 +02:00
if (!isset($parsed_docblock->tags['psalm-type'])) {
2018-07-15 23:23:17 +02:00
return [];
}
return self::getTypeAliasesFromCommentLines(
2020-05-29 04:14:41 +02:00
$parsed_docblock->tags['psalm-type'],
2018-07-15 23:23:17 +02:00
$aliases,
$type_aliases,
$self_fqcln
2018-07-15 23:23:17 +02:00
);
}
/**
* @param array<string> $type_alias_comment_lines
* @param array<string, TypeAlias> $type_aliases
2018-07-15 23:23:17 +02:00
*
* @return array<string, TypeAlias\InlineTypeAlias>
*
* @throws DocblockParseException if there was a problem parsing the docblock
2018-07-15 23:23:17 +02:00
*/
private static function getTypeAliasesFromCommentLines(
array $type_alias_comment_lines,
Aliases $aliases,
?array $type_aliases,
?string $self_fqcln
): array {
2018-07-15 23:23:17 +02:00
$type_alias_tokens = [];
foreach ($type_alias_comment_lines as $var_line) {
$var_line = trim($var_line);
if (!$var_line) {
continue;
}
$var_line = preg_replace('/[ \t]+/', ' ', preg_replace('@^[ \t]*\*@m', '', $var_line));
$var_line = preg_replace('/,\n\s+\}/', '}', $var_line);
$var_line = str_replace("\n", '', $var_line);
2018-07-15 23:23:17 +02:00
$var_line_parts = preg_split('/( |=)/', $var_line, -1, PREG_SPLIT_DELIM_CAPTURE | PREG_SPLIT_NO_EMPTY);
if (!$var_line_parts) {
continue;
}
2018-07-15 23:23:17 +02:00
$type_alias = array_shift($var_line_parts);
if (!isset($var_line_parts[0])) {
continue;
}
if ($var_line_parts[0] === ' ') {
array_shift($var_line_parts);
}
if ($var_line_parts[0] === '=') {
array_shift($var_line_parts);
}
if (!isset($var_line_parts[0])) {
continue;
}
if ($var_line_parts[0] === ' ') {
array_shift($var_line_parts);
}
2019-06-01 22:57:33 +02:00
$type_string = str_replace("\n", '', implode('', $var_line_parts));
2018-07-15 23:23:17 +02:00
2019-06-16 18:45:02 +02:00
$type_string = preg_replace('/>[^>^\}]*$/', '>', $type_string);
$type_string = preg_replace('/\}[^>^\}]*$/', '}', $type_string);
2018-07-15 23:23:17 +02:00
try {
$type_tokens = TypeTokenizer::getFullyQualifiedTokens(
2018-07-15 23:23:17 +02:00
$type_string,
$aliases,
null,
$type_alias_tokens + $type_aliases,
$self_fqcln
2018-07-15 23:23:17 +02:00
);
} catch (TypeParseTreeException $e) {
throw new DocblockParseException($type_string . ' is not a valid type');
}
$type_alias_tokens[$type_alias] = new TypeAlias\InlineTypeAlias($type_tokens);
2018-07-15 23:23:17 +02:00
}
return $type_alias_tokens;
}
2016-10-14 06:53:43 +02:00
/**
2017-05-27 02:16:18 +02:00
* @throws DocblockParseException if there was a problem parsing the docblock
2016-10-14 06:53:43 +02:00
*/
public static function extractFunctionDocblockInfo(PhpParser\Comment\Doc $comment): FunctionDocblockComment
2018-07-22 04:55:16 +02:00
{
$parsed_docblock = DocComment::parsePreservingLength($comment);
2016-06-24 00:45:46 +02:00
2019-06-01 22:57:33 +02:00
$comment_text = $comment->getText();
2016-11-13 05:59:31 +01:00
$info = new FunctionDocblockComment();
2016-06-24 00:45:46 +02:00
self::checkDuplicatedTags($parsed_docblock);
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->combined_tags['return'])) {
self::extractReturnType(
$comment,
2020-05-29 04:14:41 +02:00
$parsed_docblock->combined_tags['return'],
$info
);
2016-06-24 00:45:46 +02:00
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->combined_tags['param'])) {
foreach ($parsed_docblock->combined_tags['param'] as $offset => $param) {
$line_parts = self::splitDocLine($param);
2016-06-24 00:45:46 +02:00
2017-05-30 05:21:46 +02:00
if (count($line_parts) === 1 && isset($line_parts[0][0]) && $line_parts[0][0] === '$') {
continue;
}
if (count($line_parts) > 1) {
if (preg_match('/^&?(\.\.\.)?&?\$[A-Za-z0-9_]+,?$/', $line_parts[1])
2017-01-15 16:58:44 +01:00
&& $line_parts[0][0] !== '{'
) {
$line_parts[1] = str_replace('&', '', $line_parts[1]);
$line_parts[1] = preg_replace('/,$/', '', $line_parts[1]);
$start = $offset + $comment->getStartFilePos();
2019-06-01 22:57:33 +02:00
$end = $start + strlen($line_parts[0]);
2020-04-03 20:56:11 +02:00
$line_parts[0] = self::sanitizeDocblockType($line_parts[0]);
if ($line_parts[0] === ''
|| ($line_parts[0][0] === '$'
&& !preg_match('/^\$this(\||$)/', $line_parts[0]))
) {
throw new IncorrectDocblockException('Misplaced variable');
}
$info->params[] = [
2019-06-01 22:57:33 +02:00
'name' => trim($line_parts[1]),
'type' => $line_parts[0],
'line_number' => $comment->getStartLine() + substr_count($comment_text, "\n", 0, $offset),
2019-06-01 22:57:33 +02:00
'start' => $start,
'end' => $end,
];
2016-10-15 06:12:57 +02:00
}
} else {
throw new DocblockParseException('Badly-formatted @param');
2016-06-24 00:45:46 +02:00
}
}
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['param-out'])) {
foreach ($parsed_docblock->tags['param-out'] as $offset => $param) {
$line_parts = self::splitDocLine($param);
2019-01-19 19:32:43 +01:00
if (count($line_parts) === 1 && isset($line_parts[0][0]) && $line_parts[0][0] === '$') {
continue;
}
if (count($line_parts) > 1) {
if (!preg_match('/\[[^\]]+\]/', $line_parts[0])
&& preg_match('/^(\.\.\.)?&?\$[A-Za-z0-9_]+,?$/', $line_parts[1])
&& $line_parts[0][0] !== '{'
) {
if ($line_parts[1][0] === '&') {
$line_parts[1] = substr($line_parts[1], 1);
}
$line_parts[0] = str_replace("\n", '', preg_replace('@^[ \t]*\*@m', '', $line_parts[0]));
if ($line_parts[0] === ''
|| ($line_parts[0][0] === '$'
&& !preg_match('/^\$this(\||$)/', $line_parts[0]))
) {
2019-01-19 19:32:43 +01:00
throw new IncorrectDocblockException('Misplaced variable');
}
$line_parts[1] = preg_replace('/,$/', '', $line_parts[1]);
$info->params_out[] = [
2019-06-01 22:57:33 +02:00
'name' => trim($line_parts[1]),
'type' => str_replace("\n", '', $line_parts[0]),
'line_number' => $comment->getStartLine() + substr_count($comment_text, "\n", 0, $offset),
2019-01-19 19:32:43 +01:00
];
}
} else {
throw new DocblockParseException('Badly-formatted @param');
}
}
}
if (isset($parsed_docblock->tags['psalm-self-out'])) {
foreach ($parsed_docblock->tags['psalm-self-out'] as $offset => $param) {
$line_parts = self::splitDocLine($param);
if (count($line_parts) > 0) {
$line_parts[0] = str_replace("\n", '', preg_replace('@^[ \t]*\*@m', '', $line_parts[0]));
$info->self_out = [
'type' => str_replace("\n", '', $line_parts[0]),
'line_number' => $comment->getStartLine() + substr_count($comment_text, "\n", 0, $offset),
];
}
}
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-flow'])) {
2020-06-22 23:53:03 +02:00
foreach ($parsed_docblock->tags['psalm-flow'] as $param) {
$info->flows[] = trim($param);
}
2020-05-22 04:47:58 +02:00
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-taint-sink'])) {
foreach ($parsed_docblock->tags['psalm-taint-sink'] as $param) {
2020-05-22 04:47:58 +02:00
$param_parts = preg_split('/\s+/', trim($param));
if (count($param_parts) === 2) {
2020-06-21 17:43:08 +02:00
$info->taint_sink_params[] = ['name' => $param_parts[1], 'taint' => $param_parts[0]];
}
}
}
// support for MediaWiki taint plugin
if (isset($parsed_docblock->tags['param-taint'])) {
foreach ($parsed_docblock->tags['param-taint'] as $param) {
$param_parts = preg_split('/\s+/', trim($param));
if (count($param_parts) === 2) {
$taint_type = $param_parts[1];
if (substr($taint_type, 0, 5) === 'exec_') {
$taint_type = substr($taint_type, 5);
if ($taint_type === 'tainted') {
$taint_type = 'input';
}
if ($taint_type === 'misc') {
$taint_type = 'text';
}
$info->taint_sink_params[] = ['name' => $param_parts[0], 'taint' => $taint_type];
}
2020-05-22 04:47:58 +02:00
}
}
}
2020-06-21 06:58:56 +02:00
if (isset($parsed_docblock->tags['psalm-taint-source'])) {
foreach ($parsed_docblock->tags['psalm-taint-source'] as $param) {
$param_parts = preg_split('/\s+/', trim($param));
2020-06-21 17:43:08 +02:00
if ($param_parts[0]) {
$info->taint_source_types[] = $param_parts[0];
}
}
} elseif (isset($parsed_docblock->tags['return-taint'])) {
// support for MediaWiki taint plugin
2020-06-21 17:43:08 +02:00
foreach ($parsed_docblock->tags['return-taint'] as $param) {
$param_parts = preg_split('/\s+/', trim($param));
if ($param_parts[0]) {
if ($param_parts[0] === 'tainted') {
$param_parts[0] = 'input';
}
if ($param_parts[0] === 'misc') {
$param_parts[0] = 'text';
}
if ($param_parts[0] !== 'none') {
$info->taint_source_types[] = $param_parts[0];
}
2020-06-21 06:58:56 +02:00
}
}
}
2020-06-21 17:43:08 +02:00
if (isset($parsed_docblock->tags['psalm-taint-unescape'])) {
foreach ($parsed_docblock->tags['psalm-taint-unescape'] as $param) {
$param = trim($param);
2020-05-22 04:47:58 +02:00
$info->added_taints[] = $param;
}
}
2020-06-21 17:43:08 +02:00
if (isset($parsed_docblock->tags['psalm-taint-escape'])) {
foreach ($parsed_docblock->tags['psalm-taint-escape'] as $param) {
2020-05-22 04:47:58 +02:00
$param = trim($param);
$info->removed_taints[] = $param;
}
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-assert-untainted'])) {
foreach ($parsed_docblock->tags['psalm-assert-untainted'] as $param) {
$param = trim($param);
$info->assert_untainted_params[] = ['name' => $param];
}
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-taint-specialize'])) {
$info->specialize_call = true;
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['global'])) {
foreach ($parsed_docblock->tags['global'] as $offset => $global) {
$line_parts = self::splitDocLine($global);
if (count($line_parts) === 1 && isset($line_parts[0][0]) && $line_parts[0][0] === '$') {
continue;
}
if (count($line_parts) > 1) {
if (!preg_match('/\[[^\]]+\]/', $line_parts[0])
&& preg_match('/^(\.\.\.)?&?\$[A-Za-z0-9_]+,?$/', $line_parts[1])
&& $line_parts[0][0] !== '{'
) {
if ($line_parts[1][0] === '&') {
$line_parts[1] = substr($line_parts[1], 1);
}
if ($line_parts[0][0] === '$' && !preg_match('/^\$this(\||$)/', $line_parts[0])) {
throw new IncorrectDocblockException('Misplaced variable');
}
$line_parts[1] = preg_replace('/,$/', '', $line_parts[1]);
$info->globals[] = [
'name' => $line_parts[1],
'type' => $line_parts[0],
'line_number' => $comment->getStartLine() + substr_count($comment_text, "\n", 0, $offset),
];
}
} else {
throw new DocblockParseException('Badly-formatted @param');
}
}
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['deprecated'])) {
2016-11-13 05:59:31 +01:00
$info->deprecated = true;
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['internal'])) {
$info->internal = true;
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-internal'])) {
$psalm_internal = reset($parsed_docblock->tags['psalm-internal']);
if ($psalm_internal) {
$info->psalm_internal = $psalm_internal;
} else {
throw new DocblockParseException('@psalm-internal annotation used without specifying namespace');
}
2020-05-29 04:14:41 +02:00
$info->psalm_internal = reset($parsed_docblock->tags['psalm-internal']);
$info->internal = true;
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-suppress'])) {
foreach ($parsed_docblock->tags['psalm-suppress'] as $offset => $suppress_entry) {
foreach (DocComment::parseSuppressList($suppress_entry) as $issue_offset => $suppressed_issue) {
$info->suppressed_issues[$issue_offset + $offset + $comment->getStartFilePos()] = $suppressed_issue;
}
}
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['throws'])) {
foreach ($parsed_docblock->tags['throws'] as $offset => $throws_entry) {
$throws_class = preg_split('/[\s]+/', $throws_entry)[0];
if (!$throws_class) {
throw new IncorrectDocblockException('Unexpectedly empty @throws');
}
2019-08-13 21:44:18 +02:00
$info->throws[] = [
$throws_class,
$offset + $comment->getStartFilePos(),
$comment->getStartLine() + substr_count($comment->getText(), "\n", 0, $offset)
2019-08-13 21:44:18 +02:00
];
}
}
2020-05-29 04:14:41 +02:00
if (strpos(strtolower($parsed_docblock->description), '@inheritdoc') !== false
|| isset($parsed_docblock->tags['inheritdoc'])
|| isset($parsed_docblock->tags['inheritDoc'])
) {
2018-12-21 17:01:24 +01:00
$info->inheritdoc = true;
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->combined_tags['template'])) {
foreach ($parsed_docblock->combined_tags['template'] as $template_line) {
$template_type = preg_split('/[\s]+/', preg_replace('@^[ \t]*\*@m', '', $template_line));
2017-02-10 02:35:17 +01:00
$template_name = array_shift($template_type);
if (!$template_name) {
throw new IncorrectDocblockException('Empty @template tag');
}
if (count($template_type) > 1
&& in_array(strtolower($template_type[0]), ['as', 'super', 'of'], true)
2019-01-16 15:23:18 +01:00
) {
$template_modifier = strtolower(array_shift($template_type));
$info->templates[] = [
$template_name,
$template_modifier,
implode(' ', $template_type),
false
];
2017-02-10 02:35:17 +01:00
} else {
$info->templates[] = [$template_name, null, null, false];
}
}
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-assert'])) {
foreach ($parsed_docblock->tags['psalm-assert'] as $assertion) {
2019-09-22 03:50:11 +02:00
$line_parts = self::splitDocLine($assertion);
2019-09-22 03:50:11 +02:00
if (count($line_parts) < 2 || $line_parts[1][0] !== '$') {
throw new IncorrectDocblockException('Misplaced variable');
}
2020-04-03 20:56:11 +02:00
$line_parts[0] = self::sanitizeDocblockType($line_parts[0]);
$info->assertions[] = [
2019-09-22 03:50:11 +02:00
'type' => $line_parts[0],
'param_name' => substr($line_parts[1], 1),
];
}
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-assert-if-true'])) {
foreach ($parsed_docblock->tags['psalm-assert-if-true'] as $assertion) {
$line_parts = self::splitDocLine($assertion);
if (count($line_parts) < 2 || $line_parts[1][0] !== '$') {
throw new IncorrectDocblockException('Misplaced variable');
}
$info->if_true_assertions[] = [
'type' => $line_parts[0],
'param_name' => substr($line_parts[1], 1),
];
}
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-assert-if-false'])) {
foreach ($parsed_docblock->tags['psalm-assert-if-false'] as $assertion) {
$line_parts = self::splitDocLine($assertion);
if (count($line_parts) < 2 || $line_parts[1][0] !== '$') {
throw new IncorrectDocblockException('Misplaced variable');
}
$info->if_false_assertions[] = [
'type' => $line_parts[0],
'param_name' => substr($line_parts[1], 1),
];
}
}
2020-05-29 04:14:41 +02:00
$info->variadic = isset($parsed_docblock->tags['psalm-variadic']);
$info->pure = isset($parsed_docblock->tags['psalm-pure'])
|| isset($parsed_docblock->tags['pure']);
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-mutation-free'])) {
$info->mutation_free = true;
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-external-mutation-free'])) {
$info->external_mutation_free = true;
}
2020-08-14 06:27:33 +02:00
if (isset($parsed_docblock->tags['no-named-arguments'])) {
$info->no_named_args = true;
}
2020-05-29 04:14:41 +02:00
$info->ignore_nullable_return = isset($parsed_docblock->tags['psalm-ignore-nullable-return']);
$info->ignore_falsable_return = isset($parsed_docblock->tags['psalm-ignore-falsable-return']);
$info->stub_override = isset($parsed_docblock->tags['psalm-stub-override']);
2016-06-24 00:45:46 +02:00
return $info;
}
2016-10-28 06:11:16 +02:00
2017-02-10 02:35:17 +01:00
/**
2019-06-01 22:57:33 +02:00
* @param array<int, string> $return_specials
* @return void
*/
private static function extractReturnType(
PhpParser\Comment\Doc $comment,
2019-06-01 22:57:33 +02:00
array $return_specials,
FunctionDocblockComment $info
) {
2019-06-01 22:57:33 +02:00
foreach ($return_specials as $offset => $return_block) {
$return_lines = explode("\n", $return_block);
2019-06-01 22:57:33 +02:00
if (!trim($return_lines[0])) {
return;
}
2019-06-01 22:57:33 +02:00
$return_block = trim($return_block);
2019-06-01 22:57:33 +02:00
if (!$return_block) {
return;
}
2019-06-01 22:57:33 +02:00
$line_parts = self::splitDocLine($return_block);
2019-06-01 22:57:33 +02:00
if ($line_parts[0][0] !== '{') {
if ($line_parts[0][0] === '$' && !preg_match('/^\$this(\||$)/', $line_parts[0])) {
throw new IncorrectDocblockException('Misplaced variable');
}
$start = $offset + $comment->getStartFilePos();
2019-06-01 22:57:33 +02:00
$end = $start + strlen($line_parts[0]);
2020-04-03 20:56:11 +02:00
$line_parts[0] = self::sanitizeDocblockType($line_parts[0]);
$info->return_type = array_shift($line_parts);
2019-06-01 22:57:33 +02:00
$info->return_type_description = $line_parts ? implode(' ', $line_parts) : null;
2019-06-01 22:57:33 +02:00
$info->return_type_line_number
= $comment->getStartLine() + substr_count($comment->getText(), "\n", 0, $offset);
2019-06-01 22:57:33 +02:00
$info->return_type_start = $start;
$info->return_type_end = $end;
} else {
throw new DocblockParseException('Badly-formatted @return type');
}
break;
}
}
/**
2017-05-27 02:16:18 +02:00
* @throws DocblockParseException if there was a problem parsing the docblock
*
2017-02-10 02:35:17 +01:00
* @psalm-suppress MixedArrayAccess
*/
public static function extractClassLikeDocblockInfo(
\PhpParser\Node $node,
PhpParser\Comment\Doc $comment,
Aliases $aliases
): ClassLikeDocblockComment {
$parsed_docblock = DocComment::parsePreservingLength($comment);
$codebase = ProjectAnalyzer::getInstance()->getCodebase();
2017-02-10 02:35:17 +01:00
$info = new ClassLikeDocblockComment();
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->combined_tags['template'])) {
foreach ($parsed_docblock->combined_tags['template'] as $offset => $template_line) {
$template_type = preg_split('/[\s]+/', preg_replace('@^[ \t]*\*@m', '', $template_line));
2017-02-10 02:35:17 +01:00
$template_name = array_shift($template_type);
if (!$template_name) {
throw new IncorrectDocblockException('Empty @template tag');
}
if (count($template_type) > 1
&& in_array(strtolower($template_type[0]), ['as', 'super', 'of'], true)
2019-01-16 15:23:18 +01:00
) {
$template_modifier = strtolower(array_shift($template_type));
$info->templates[] = [
$template_name,
$template_modifier,
implode(' ', $template_type),
false,
$offset
];
} else {
$info->templates[] = [$template_name, null, null, false, $offset];
}
}
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->combined_tags['template-covariant'])) {
foreach ($parsed_docblock->combined_tags['template-covariant'] as $offset => $template_line) {
$template_type = preg_split('/[\s]+/', preg_replace('@^[ \t]*\*@m', '', $template_line));
$template_name = array_shift($template_type);
if (!$template_name) {
throw new IncorrectDocblockException('Empty @template-covariant tag');
}
if (count($template_type) > 1
&& in_array(strtolower($template_type[0]), ['as', 'super', 'of'], true)
) {
$template_modifier = strtolower(array_shift($template_type));
$info->templates[] = [
$template_name,
$template_modifier,
implode(' ', $template_type),
true,
$offset
];
2017-02-10 02:35:17 +01:00
} else {
$info->templates[] = [$template_name, null, null, true, $offset];
2017-02-10 02:35:17 +01:00
}
}
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->combined_tags['extends'])) {
foreach ($parsed_docblock->combined_tags['extends'] as $template_line) {
$info->template_extends[] = trim(preg_replace('@^[ \t]*\*@m', '', $template_line));
}
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->combined_tags['implements'])) {
foreach ($parsed_docblock->combined_tags['implements'] as $template_line) {
$info->template_implements[] = trim(preg_replace('@^[ \t]*\*@m', '', $template_line));
}
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-yield'])
) {
2020-05-29 04:14:41 +02:00
$yield = reset($parsed_docblock->tags['psalm-yield']);
$info->yield = trim(preg_replace('@^[ \t]*\*@m', '', $yield));
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['deprecated'])) {
$info->deprecated = true;
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['internal'])) {
$info->internal = true;
}
if (isset($parsed_docblock->tags['final'])) {
$info->final = true;
}
if (isset($parsed_docblock->tags['psalm-consistent-constructor'])) {
$info->consistent_constructor = true;
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-internal'])) {
$psalm_internal = reset($parsed_docblock->tags['psalm-internal']);
if ($psalm_internal) {
$info->psalm_internal = $psalm_internal;
} else {
throw new DocblockParseException('psalm-internal annotation used without specifying namespace');
}
$info->internal = true;
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['mixin'])) {
foreach ($parsed_docblock->tags['mixin'] as $rawMixin) {
$mixin = trim($rawMixin);
$doc_line_parts = self::splitDocLine($mixin);
$mixin = $doc_line_parts[0];
2020-01-03 05:50:19 +01:00
if ($mixin) {
$info->mixins[] = $mixin;
} else {
throw new DocblockParseException('@mixin annotation used without specifying class');
}
}
// backwards compatibility
if ($info->mixins) {
/** @psalm-suppress DeprecatedProperty */
$info->mixin = reset($info->mixins);
2020-01-03 05:50:19 +01:00
}
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-seal-properties'])) {
$info->sealed_properties = true;
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-seal-methods'])) {
$info->sealed_methods = true;
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-immutable'])
|| isset($parsed_docblock->tags['psalm-mutation-free'])
2019-08-30 18:36:35 +02:00
) {
$info->mutation_free = true;
2019-08-31 16:07:23 +02:00
$info->external_mutation_free = true;
$info->taint_specialize = true;
2019-08-30 18:36:35 +02:00
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-external-mutation-free'])) {
2019-08-30 18:36:35 +02:00
$info->external_mutation_free = true;
}
if (isset($parsed_docblock->tags['psalm-taint-specialize'])) {
$info->taint_specialize = true;
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-override-property-visibility'])) {
$info->override_property_visibility = true;
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-override-method-visibility'])) {
$info->override_method_visibility = true;
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-suppress'])) {
foreach ($parsed_docblock->tags['psalm-suppress'] as $offset => $suppress_entry) {
foreach (DocComment::parseSuppressList($suppress_entry) as $issue_offset => $suppressed_issue) {
$info->suppressed_issues[$issue_offset + $offset + $comment->getStartFilePos()] = $suppressed_issue;
}
}
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->tags['psalm-import-type'])) {
foreach ($parsed_docblock->tags['psalm-import-type'] as $offset => $imported_type_entry) {
$info->imported_types[] = [
'line_number' => $comment->getStartLine() + substr_count($comment->getText(), "\n", 0, $offset),
'start_offset' => $comment->getStartFilePos() + $offset,
'end_offset' => $comment->getStartFilePos() + $offset + strlen($imported_type_entry),
'parts' => self::splitDocLine($imported_type_entry) ?: []
];
}
}
2020-05-29 04:14:41 +02:00
if (isset($parsed_docblock->combined_tags['method'])) {
foreach ($parsed_docblock->combined_tags['method'] as $offset => $method_entry) {
$method_entry = preg_replace('/[ \t]+/', ' ', trim($method_entry));
$docblock_lines = [];
$is_static = false;
$has_return = false;
if (!preg_match('/^([a-z_A-Z][a-z_0-9A-Z]+) *\(/', $method_entry, $matches)) {
$doc_line_parts = self::splitDocLine($method_entry);
if ($doc_line_parts[0] === 'static' && !strpos($doc_line_parts[1], '(')) {
$is_static = true;
array_shift($doc_line_parts);
}
if (count($doc_line_parts) > 1) {
$docblock_lines[] = '@return ' . array_shift($doc_line_parts);
$has_return = true;
$method_entry = implode(' ', $doc_line_parts);
}
}
$method_entry = trim(preg_replace('/\/\/.*/', '', $method_entry));
2019-12-11 17:40:47 +01:00
$method_entry = preg_replace(
'/array\(([0-9a-zA-Z_\'\" ]+,)*([0-9a-zA-Z_\'\" ]+)\)/',
'[]',
$method_entry
);
$end_of_method_regex = '/(?<!array\()\) ?(\: ?(\??[\\\\a-zA-Z0-9_]+))?/';
if (preg_match($end_of_method_regex, $method_entry, $matches, PREG_OFFSET_CAPTURE)) {
$method_entry = substr($method_entry, 0, (int) $matches[0][1] + strlen((string) $matches[0][0]));
}
$method_entry = str_replace([', ', '( '], [',', '('], $method_entry);
$method_entry = preg_replace('/ (?!(\$|\.\.\.|&))/', '', trim($method_entry));
2018-06-28 23:39:25 +02:00
// replace array bracket contents
$method_entry = preg_replace('/\[([0-9a-zA-Z_\'\" ]+,)*([0-9a-zA-Z_\'\" ]+)\]/', '[]', $method_entry);
if (!$method_entry) {
throw new DocblockParseException('No @method entry specified');
}
try {
2020-05-28 20:31:09 +02:00
$parse_tree_creator = new ParseTreeCreator(
TypeTokenizer::getFullyQualifiedTokens(
$method_entry,
$aliases,
null
)
);
2020-05-28 20:31:09 +02:00
$method_tree = $parse_tree_creator->create();
} catch (TypeParseTreeException $e) {
throw new DocblockParseException($method_entry . ' is not a valid method');
}
if (!$method_tree instanceof ParseTree\MethodWithReturnTypeTree
&& !$method_tree instanceof ParseTree\MethodTree) {
throw new DocblockParseException($method_entry . ' is not a valid method');
}
if ($method_tree instanceof ParseTree\MethodWithReturnTypeTree) {
if (!$has_return) {
$docblock_lines[] = '@return ' . TypeParser::getTypeFromTree(
$method_tree->children[1],
$codebase
)->toNamespacedString($aliases->namespace, $aliases->uses, null, false);
}
$method_tree = $method_tree->children[0];
}
if (!$method_tree instanceof ParseTree\MethodTree) {
throw new DocblockParseException($method_entry . ' is not a valid method');
}
$args = [];
foreach ($method_tree->children as $method_tree_child) {
if (!$method_tree_child instanceof ParseTree\MethodParamTree) {
throw new DocblockParseException($method_entry . ' is not a valid method');
}
$args[] = ($method_tree_child->byref ? '&' : '')
. ($method_tree_child->variadic ? '...' : '')
. $method_tree_child->name
. ($method_tree_child->default != '' ? ' = ' . $method_tree_child->default : '');
if ($method_tree_child->children) {
try {
$param_type = TypeParser::getTypeFromTree($method_tree_child->children[0], $codebase);
} catch (\Exception $e) {
throw new DocblockParseException(
'Badly-formatted @method string ' . $method_entry . ' - ' . $e
);
}
$param_type_string = $param_type->toNamespacedString('\\', [], null, false);
$docblock_lines[] = '@param ' . $param_type_string . ' '
. ($method_tree_child->variadic ? '...' : '')
. $method_tree_child->name;
}
}
$function_string = 'function ' . $method_tree->value . '(' . implode(', ', $args) . ')';
if ($is_static) {
$function_string = 'static ' . $function_string;
}
$function_docblock = $docblock_lines ? "/**\n * " . implode("\n * ", $docblock_lines) . "\n*/\n" : "";
$php_string = '<?php class A { ' . $function_docblock . ' public ' . $function_string . '{} }';
try {
2020-08-09 22:23:43 +02:00
$statements = \Psalm\Internal\Provider\StatementsProvider::parseStatements(
$php_string,
$codebase->php_major_version . '.' . $codebase->php_minor_version
);
} catch (\Exception $e) {
throw new DocblockParseException('Badly-formatted @method string ' . $method_entry);
}
if (!$statements
|| !$statements[0] instanceof \PhpParser\Node\Stmt\Class_
|| !isset($statements[0]->stmts[0])
|| !$statements[0]->stmts[0] instanceof \PhpParser\Node\Stmt\ClassMethod
) {
throw new DocblockParseException('Badly-formatted @method string ' . $method_entry);
}
/** @var \PhpParser\Comment\Doc */
$node_doc_comment = $node->getDocComment();
$statements[0]->stmts[0]->setAttribute('startLine', $node_doc_comment->getStartLine());
$statements[0]->stmts[0]->setAttribute('startFilePos', $node_doc_comment->getStartFilePos());
$statements[0]->stmts[0]->setAttribute('endFilePos', $node->getAttribute('startFilePos'));
if ($doc_comment = $statements[0]->stmts[0]->getDocComment()) {
$statements[0]->stmts[0]->setDocComment(
new \PhpParser\Comment\Doc(
$doc_comment->getText(),
$comment->getStartLine() + substr_count($comment->getText(), "\n", 0, $offset),
$node_doc_comment->getStartFilePos()
)
);
}
$info->methods[] = $statements[0]->stmts[0];
}
}
if (isset($parsed_docblock->tags['psalm-stub-override'])) {
$info->stub_override = true;
}
2020-05-29 04:14:41 +02:00
self::addMagicPropertyToInfo($comment, $info, $parsed_docblock->tags, 'property');
self::addMagicPropertyToInfo($comment, $info, $parsed_docblock->tags, 'psalm-property');
self::addMagicPropertyToInfo($comment, $info, $parsed_docblock->tags, 'property-read');
self::addMagicPropertyToInfo($comment, $info, $parsed_docblock->tags, 'psalm-property-read');
self::addMagicPropertyToInfo($comment, $info, $parsed_docblock->tags, 'property-write');
self::addMagicPropertyToInfo($comment, $info, $parsed_docblock->tags, 'psalm-property-write');
return $info;
}
/**
* @param array<string, array<int, string>> $specials
2020-03-24 23:32:57 +01:00
* @param 'property'|'psalm-property'|'property-read'|
* 'psalm-property-read'|'property-write'|'psalm-property-write' $property_tag
*
* @throws DocblockParseException
*
*/
2019-06-01 22:57:33 +02:00
protected static function addMagicPropertyToInfo(
PhpParser\Comment\Doc $comment,
ClassLikeDocblockComment $info,
array $specials,
string $property_tag
) : void {
$magic_property_comments = isset($specials[$property_tag]) ? $specials[$property_tag] : [];
2019-06-01 22:57:33 +02:00
foreach ($magic_property_comments as $offset => $property) {
$line_parts = self::splitDocLine($property);
2019-06-14 16:45:00 +02:00
if (count($line_parts) === 1 && isset($line_parts[0][0]) && $line_parts[0][0] === '$') {
continue;
}
if (count($line_parts) > 1) {
2019-06-14 16:45:00 +02:00
if (preg_match('/^&?\$[A-Za-z0-9_]+,?$/', $line_parts[1])
&& $line_parts[0][0] !== '{'
) {
2019-06-14 16:45:00 +02:00
$line_parts[1] = str_replace('&', '', $line_parts[1]);
$line_parts[1] = preg_replace('/,$/', '', $line_parts[1]);
$start = $offset + $comment->getStartFilePos();
2019-06-14 16:45:00 +02:00
$end = $start + strlen($line_parts[0]);
$line_parts[0] = str_replace("\n", '', preg_replace('@^[ \t]*\*@m', '', $line_parts[0]));
2019-06-14 16:45:00 +02:00
if ($line_parts[0] === ''
|| ($line_parts[0][0] === '$'
&& !preg_match('/^\$this(\||$)/', $line_parts[0]))
) {
throw new IncorrectDocblockException('Misplaced variable');
}
$name = trim($line_parts[1]);
if (!preg_match('/^\$([a-zA-Z_\x7f-\xff][a-zA-Z0-9_\x7f-\xff]*)$/', $name)) {
throw new DocblockParseException('Badly-formatted @property name');
}
$info->properties[] = [
'name' => $name,
'type' => $line_parts[0],
'line_number' => $comment->getStartLine() + substr_count($comment->getText(), "\n", 0, $offset),
'tag' => $property_tag,
2019-06-14 16:45:00 +02:00
'start' => $start,
'end' => $end,
];
}
} else {
throw new DocblockParseException('Badly-formatted @property');
}
}
2017-02-10 02:35:17 +01:00
}
2016-10-28 06:11:16 +02:00
/**
2017-05-27 02:16:18 +02:00
* @throws DocblockParseException if an invalid string is found
*
* @return list<string>
2020-08-23 19:52:31 +02:00
*
* @psalm-pure
2016-10-28 06:11:16 +02:00
*/
public static function splitDocLine(string $return_block): array
2016-10-28 06:11:16 +02:00
{
$brackets = '';
$type = '';
$expects_callable_return = false;
$return_block = str_replace("\t", ' ', $return_block);
2018-05-20 23:19:53 +02:00
$quote_char = null;
$escaped = false;
for ($i = 0, $l = strlen($return_block); $i < $l; ++$i) {
2016-10-28 06:11:16 +02:00
$char = $return_block[$i];
$next_char = $i < $l - 1 ? $return_block[$i + 1] : null;
$last_char = $i > 0 ? $return_block[$i - 1] : null;
2016-10-28 06:11:16 +02:00
2018-05-20 23:19:53 +02:00
if ($quote_char) {
if ($char === $quote_char && $i > 1 && !$escaped) {
$quote_char = null;
$type .= $char;
continue;
}
if ($char === '\\' && !$escaped && ($next_char === $quote_char || $next_char === '\\')) {
$escaped = true;
$type .= $char;
continue;
}
$escaped = false;
$type .= $char;
continue;
}
if ($char === '"' || $char === '\'') {
$quote_char = $char;
$type .= $char;
continue;
}
if ($char === ':' && $last_char === ')') {
$expects_callable_return = true;
$type .= $char;
continue;
}
2016-10-28 06:11:16 +02:00
if ($char === '[' || $char === '{' || $char === '(' || $char === '<') {
$brackets .= $char;
2016-11-02 07:29:00 +01:00
} elseif ($char === ']' || $char === '}' || $char === ')' || $char === '>') {
2016-10-28 06:11:16 +02:00
$last_bracket = substr($brackets, -1);
$brackets = substr($brackets, 0, -1);
if (($char === ']' && $last_bracket !== '[')
|| ($char === '}' && $last_bracket !== '{')
|| ($char === ')' && $last_bracket !== '(')
|| ($char === '>' && $last_bracket !== '<')
) {
2016-11-02 07:29:00 +01:00
throw new DocblockParseException('Invalid string ' . $return_block);
2016-10-28 06:11:16 +02:00
}
} elseif ($char === ' ') {
if ($brackets) {
$expects_callable_return = false;
2019-06-01 23:22:33 +02:00
$type .= ' ';
2016-10-28 06:11:16 +02:00
continue;
}
if ($next_char === '|' || $next_char === '&') {
$nexter_char = $i < $l - 2 ? $return_block[$i + 2] : null;
if ($nexter_char === ' ') {
++$i;
2019-06-06 19:57:00 +02:00
$type .= $next_char . ' ';
continue;
}
}
if ($last_char === '|' || $last_char === '&') {
2019-06-06 19:57:00 +02:00
$type .= ' ';
continue;
}
if ($next_char === ':') {
++$i;
2019-06-06 19:57:00 +02:00
$type .= ' :';
$expects_callable_return = true;
continue;
}
if ($expects_callable_return) {
2019-06-06 20:27:49 +02:00
$type .= ' ';
$expects_callable_return = false;
continue;
}
$remaining = trim(preg_replace('@^[ \t]*\* *@m', ' ', substr($return_block, $i + 1)));
2016-11-01 05:39:41 +01:00
if ($remaining) {
return array_merge([rtrim($type)], preg_split('/[ \s]+/', $remaining));
2016-11-01 05:39:41 +01:00
}
return [$type];
2016-10-28 06:11:16 +02:00
}
$expects_callable_return = false;
2016-10-28 06:11:16 +02:00
$type .= $char;
}
return [$type];
}
/**
* @throws DocblockParseException if a duplicate is found
*/
private static function checkDuplicatedTags(ParsedDocblock $parsed_docblock): void
{
if (count($parsed_docblock->tags['return'] ?? []) > 1
|| count($parsed_docblock->tags['psalm-return'] ?? []) > 1
|| count($parsed_docblock->tags['phpstan-return'] ?? []) > 1
) {
throw new DocblockParseException('Found duplicated @return or prefixed @return tag');
}
self::checkDuplicatedParams($parsed_docblock->tags['param'] ?? []);
self::checkDuplicatedParams($parsed_docblock->tags['psalm-param'] ?? []);
self::checkDuplicatedParams($parsed_docblock->tags['phpstan-param'] ?? []);
}
/**
* @param array<int, string> $param
*
*
* @throws DocblockParseException if a duplicate is found
*/
private static function checkDuplicatedParams(array $param): void
{
$list_names = self::extractAllParamNames($param);
if (count($list_names) !== count(array_unique($list_names))) {
throw new DocblockParseException('Found duplicated @param or prefixed @param tag');
}
}
/**
* @param array<int, string> $lines
*
* @return list<string>
2020-08-23 19:52:31 +02:00
*
* @psalm-pure
*/
private static function extractAllParamNames(array $lines): array
{
$names = [];
foreach ($lines as $line) {
$split_by_dollar = explode('$', $line, 2);
if (count($split_by_dollar) > 1) {
$split_by_space = explode(' ', $split_by_dollar[1], 2);
$names[] = $split_by_space[0];
}
}
return $names;
}
2016-06-24 00:45:46 +02:00
}