mirror of
https://github.com/danog/psalm.git
synced 2024-12-15 02:47:02 +01:00
618 lines
22 KiB
PHP
618 lines
22 KiB
PHP
<?php
|
|
namespace Psalm\Internal\PhpVisitor;
|
|
|
|
use function array_pop;
|
|
use function count;
|
|
use function end;
|
|
use function implode;
|
|
use function in_array;
|
|
use function is_string;
|
|
use PhpParser;
|
|
use Psalm\Aliases;
|
|
use Psalm\Codebase;
|
|
use Psalm\CodeLocation;
|
|
use Psalm\Exception\DocblockParseException;
|
|
use Psalm\Exception\TypeParseTreeException;
|
|
use Psalm\FileSource;
|
|
use Psalm\Internal\Analyzer\ClassLikeAnalyzer;
|
|
use Psalm\Internal\Analyzer\CommentAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\Expression\SimpleTypeInferer;
|
|
use Psalm\Internal\Scanner\FileScanner;
|
|
use Psalm\Internal\Scanner\PhpStormMetaScanner;
|
|
use Psalm\Internal\Type\TypeAlias;
|
|
use Psalm\Internal\Type\TypeParser;
|
|
use Psalm\Issue\InvalidDocblock;
|
|
use Psalm\Storage\FileStorage;
|
|
use Psalm\Storage\MethodStorage;
|
|
use Psalm\Type;
|
|
use function strpos;
|
|
use function strtolower;
|
|
|
|
/**
|
|
* @internal
|
|
*/
|
|
class ReflectorVisitor extends PhpParser\NodeVisitorAbstract implements FileSource
|
|
{
|
|
/**
|
|
* @var Aliases
|
|
*/
|
|
private $aliases;
|
|
|
|
/**
|
|
* @var string[]
|
|
*/
|
|
private $fq_classlike_names = [];
|
|
|
|
/**
|
|
* @var FileScanner
|
|
*/
|
|
private $file_scanner;
|
|
|
|
/**
|
|
* @var Codebase
|
|
*/
|
|
private $codebase;
|
|
|
|
/**
|
|
* @var string
|
|
*/
|
|
private $file_path;
|
|
|
|
/**
|
|
* @var bool
|
|
*/
|
|
private $scan_deep;
|
|
|
|
/**
|
|
* @var FileStorage
|
|
*/
|
|
private $file_storage;
|
|
|
|
/**
|
|
* @var array<Reflector\FunctionLikeNodeScanner>
|
|
*/
|
|
private $functionlike_node_scanners = [];
|
|
|
|
/**
|
|
* @var array<Reflector\ClassLikeNodeScanner>
|
|
*/
|
|
private $classlike_node_scanners = [];
|
|
|
|
/**
|
|
* @var array<class-string<\Psalm\Plugin\Hook\AfterClassLikeVisitInterface>>
|
|
*/
|
|
private $after_classlike_check_plugins;
|
|
|
|
/**
|
|
* @var PhpParser\Node\Name|null
|
|
*/
|
|
private $namespace_name;
|
|
|
|
/**
|
|
* @var PhpParser\Node\Expr|null
|
|
*/
|
|
private $exists_cond_expr;
|
|
|
|
/**
|
|
* @var ?int
|
|
*/
|
|
private $skip_if_descendants = null;
|
|
|
|
/**
|
|
* @var array<string, TypeAlias>
|
|
*/
|
|
private $type_aliases = [];
|
|
|
|
/**
|
|
* @var array<int, bool>
|
|
*/
|
|
private $bad_classes = [];
|
|
|
|
public function __construct(
|
|
Codebase $codebase,
|
|
FileScanner $file_scanner,
|
|
FileStorage $file_storage
|
|
) {
|
|
$this->codebase = $codebase;
|
|
$this->file_scanner = $file_scanner;
|
|
$this->file_path = $file_scanner->file_path;
|
|
$this->scan_deep = $file_scanner->will_analyze;
|
|
$this->file_storage = $file_storage;
|
|
$this->aliases = $this->file_storage->aliases = new Aliases();
|
|
$this->after_classlike_check_plugins = $this->codebase->config->after_visit_classlikes;
|
|
}
|
|
|
|
public function enterNode(PhpParser\Node $node): ?int
|
|
{
|
|
foreach ($node->getComments() as $comment) {
|
|
if ($comment instanceof PhpParser\Comment\Doc && !$node instanceof PhpParser\Node\Stmt\ClassLike) {
|
|
$self_fqcln = $node instanceof PhpParser\Node\Stmt\ClassLike
|
|
&& $node->name !== null
|
|
? ($this->aliases->namespace ? $this->aliases->namespace . '\\' : '') . $node->name->name
|
|
: null;
|
|
|
|
try {
|
|
$type_aliases = CommentAnalyzer::getTypeAliasesFromComment(
|
|
$comment,
|
|
$this->aliases,
|
|
$this->type_aliases,
|
|
$self_fqcln
|
|
);
|
|
|
|
foreach ($type_aliases as $type_alias) {
|
|
// finds issues, if there are any
|
|
TypeParser::parseTokens($type_alias->replacement_tokens);
|
|
}
|
|
|
|
$this->type_aliases += $type_aliases;
|
|
} catch (DocblockParseException $e) {
|
|
$this->file_storage->docblock_issues[] = new InvalidDocblock(
|
|
(string)$e->getMessage(),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
);
|
|
} catch (TypeParseTreeException $e) {
|
|
$this->file_storage->docblock_issues[] = new InvalidDocblock(
|
|
(string)$e->getMessage(),
|
|
new CodeLocation($this->file_scanner, $node, null, true)
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($node instanceof PhpParser\Node\Stmt\Namespace_) {
|
|
$this->handleNamespace($node);
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\Use_) {
|
|
$this->handleUse($node);
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\GroupUse) {
|
|
$this->handleGroupUse($node);
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\ClassLike) {
|
|
if ($this->skip_if_descendants) {
|
|
return null;
|
|
}
|
|
|
|
$classlike_node_scanner = new Reflector\ClassLikeNodeScanner(
|
|
$this->codebase,
|
|
$this->file_storage,
|
|
$this->file_scanner,
|
|
$this->aliases,
|
|
$this->namespace_name
|
|
);
|
|
|
|
$this->classlike_node_scanners[] = $classlike_node_scanner;
|
|
|
|
if ($classlike_node_scanner->start($node) === false) {
|
|
$this->bad_classes[\spl_object_id($node)] = true;
|
|
return PhpParser\NodeTraverser::DONT_TRAVERSE_CHILDREN;
|
|
}
|
|
|
|
$this->type_aliases += $classlike_node_scanner->type_aliases;
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\TryCatch) {
|
|
foreach ($node->catches as $catch) {
|
|
foreach ($catch->types as $catch_type) {
|
|
$catch_fqcln = ClassLikeAnalyzer::getFQCLNFromNameObject($catch_type, $this->aliases);
|
|
|
|
if (!in_array(strtolower($catch_fqcln), ['self', 'static', 'parent'], true)) {
|
|
$this->codebase->scanner->queueClassLikeForScanning($catch_fqcln);
|
|
$this->file_storage->referenced_classlikes[strtolower($catch_fqcln)] = $catch_fqcln;
|
|
}
|
|
}
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\FunctionLike) {
|
|
if ($node instanceof PhpParser\Node\Stmt\Function_
|
|
|| $node instanceof PhpParser\Node\Stmt\ClassMethod
|
|
) {
|
|
if ($this->skip_if_descendants) {
|
|
return null;
|
|
}
|
|
}
|
|
|
|
$classlike_storage = null;
|
|
|
|
if ($this->classlike_node_scanners) {
|
|
$classlike_node_scanner = end($this->classlike_node_scanners);
|
|
$classlike_storage = $classlike_node_scanner->storage;
|
|
}
|
|
|
|
$functionlike_types = [];
|
|
|
|
if ($this->functionlike_node_scanners) {
|
|
$functionlike_node_scanner = end($this->functionlike_node_scanners);
|
|
$functionlike_storage = $functionlike_node_scanner->storage;
|
|
$functionlike_types = $functionlike_storage->template_types ?? [];
|
|
}
|
|
|
|
$functionlike_node_scanner = new Reflector\FunctionLikeNodeScanner(
|
|
$this->codebase,
|
|
$this->file_scanner,
|
|
$this->file_storage,
|
|
$this->aliases,
|
|
$this->type_aliases,
|
|
$classlike_storage,
|
|
$functionlike_types
|
|
);
|
|
|
|
$functionlike_node_scanner->start($node);
|
|
|
|
$this->functionlike_node_scanners[] = $functionlike_node_scanner;
|
|
|
|
if (!$this->scan_deep) {
|
|
return PhpParser\NodeTraverser::DONT_TRAVERSE_CHILDREN;
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\Global_) {
|
|
$functionlike_node_scanner = end($this->functionlike_node_scanners);
|
|
|
|
if ($functionlike_node_scanner && $functionlike_node_scanner->storage) {
|
|
foreach ($node->vars as $var) {
|
|
if ($var instanceof PhpParser\Node\Expr\Variable) {
|
|
if (is_string($var->name) && $var->name !== 'argv' && $var->name !== 'argc') {
|
|
$var_id = '$' . $var->name;
|
|
|
|
$functionlike_node_scanner->storage->global_variables[$var_id] = true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\TraitUse) {
|
|
if ($this->skip_if_descendants) {
|
|
return null;
|
|
}
|
|
|
|
if (!$this->classlike_node_scanners) {
|
|
throw new \LogicException('$this->classlike_node_scanners should not be empty');
|
|
}
|
|
|
|
$classlike_node_scanner = end($this->classlike_node_scanners);
|
|
|
|
$classlike_node_scanner->handleTraitUse($node);
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\Const_) {
|
|
foreach ($node->consts as $const) {
|
|
$const_type = SimpleTypeInferer::infer(
|
|
$this->codebase,
|
|
new \Psalm\Internal\Provider\NodeDataProvider(),
|
|
$const->value,
|
|
$this->aliases
|
|
) ?: Type::getMixed();
|
|
|
|
$fq_const_name = Type::getFQCLNFromString($const->name->name, $this->aliases);
|
|
|
|
if ($this->codebase->register_stub_files || $this->codebase->register_autoload_files) {
|
|
$this->codebase->addGlobalConstantType($fq_const_name, $const_type);
|
|
}
|
|
|
|
$this->file_storage->constants[$fq_const_name] = $const_type;
|
|
$this->file_storage->declaring_constants[$fq_const_name] = $this->file_path;
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\If_ && !$this->skip_if_descendants) {
|
|
if (!$this->fq_classlike_names && !$this->functionlike_node_scanners) {
|
|
$this->exists_cond_expr = $node->cond;
|
|
|
|
if (Reflector\ExpressionResolver::enterConditional(
|
|
$this->codebase,
|
|
$this->file_path,
|
|
$this->exists_cond_expr
|
|
) === false
|
|
) {
|
|
// the else node should terminate the agreement
|
|
$this->skip_if_descendants = $node->else ? $node->else->getLine() : $node->getLine();
|
|
}
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\Else_) {
|
|
if ($this->skip_if_descendants === $node->getLine()) {
|
|
$this->skip_if_descendants = null;
|
|
$this->exists_cond_expr = null;
|
|
} elseif (!$this->skip_if_descendants) {
|
|
if ($this->exists_cond_expr
|
|
&& Reflector\ExpressionResolver::enterConditional(
|
|
$this->codebase,
|
|
$this->file_path,
|
|
$this->exists_cond_expr
|
|
) === true
|
|
) {
|
|
$this->skip_if_descendants = $node->getLine();
|
|
}
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Expr) {
|
|
$functionlike_storage = null;
|
|
|
|
if ($this->functionlike_node_scanners) {
|
|
$functionlike_node_scanner = end($this->functionlike_node_scanners);
|
|
$functionlike_storage = $functionlike_node_scanner->storage;
|
|
}
|
|
|
|
Reflector\ExpressionScanner::scan(
|
|
$this->codebase,
|
|
$this->file_scanner,
|
|
$this->file_storage,
|
|
$this->aliases,
|
|
$node,
|
|
$functionlike_storage,
|
|
$this->skip_if_descendants
|
|
);
|
|
}
|
|
|
|
if ($doc_comment = $node->getDocComment()) {
|
|
$var_comments = [];
|
|
|
|
$template_types = [];
|
|
|
|
if ($this->classlike_node_scanners) {
|
|
$classlike_node_scanner = end($this->classlike_node_scanners);
|
|
$classlike_storage = $classlike_node_scanner->storage;
|
|
$template_types = $classlike_storage->template_types ?? [];
|
|
}
|
|
|
|
if ($this->functionlike_node_scanners) {
|
|
$functionlike_node_scanner = end($this->functionlike_node_scanners);
|
|
$functionlike_storage = $functionlike_node_scanner->storage;
|
|
$template_types += $functionlike_storage->template_types ?? [];
|
|
}
|
|
|
|
try {
|
|
$var_comments = CommentAnalyzer::getTypeFromComment(
|
|
$doc_comment,
|
|
$this->file_scanner,
|
|
$this->aliases,
|
|
$template_types,
|
|
$this->type_aliases
|
|
);
|
|
} catch (DocblockParseException $e) {
|
|
// do nothing
|
|
}
|
|
|
|
foreach ($var_comments as $var_comment) {
|
|
if (!$var_comment->type) {
|
|
continue;
|
|
}
|
|
|
|
$var_type = $var_comment->type;
|
|
$var_type->queueClassLikesForScanning($this->codebase, $this->file_storage);
|
|
}
|
|
}
|
|
|
|
if ($node instanceof PhpParser\Node\Expr\Assign
|
|
|| $node instanceof PhpParser\Node\Expr\AssignOp
|
|
|| $node instanceof PhpParser\Node\Expr\AssignRef
|
|
) {
|
|
if ($node->var instanceof PhpParser\Node\Expr\PropertyFetch
|
|
&& $node->var->var instanceof PhpParser\Node\Expr\Variable
|
|
&& $node->var->var->name === 'this'
|
|
&& $node->var->name instanceof PhpParser\Node\Identifier
|
|
) {
|
|
if ($this->functionlike_node_scanners) {
|
|
$functionlike_node_scanner = end($this->functionlike_node_scanners);
|
|
$functionlike_storage = $functionlike_node_scanner->storage;
|
|
|
|
if ($functionlike_storage instanceof MethodStorage) {
|
|
$functionlike_storage->this_property_mutations[$node->var->name->name] = true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
private function handleNamespace(PhpParser\Node\Stmt\Namespace_ $node) : void
|
|
{
|
|
$this->file_storage->aliases = $this->aliases;
|
|
|
|
$this->namespace_name = $node->name;
|
|
|
|
$this->aliases = new Aliases(
|
|
$node->name ? implode('\\', $node->name->parts) : '',
|
|
$this->aliases->uses,
|
|
$this->aliases->functions,
|
|
$this->aliases->constants,
|
|
$this->aliases->uses_flipped,
|
|
$this->aliases->functions_flipped,
|
|
$this->aliases->constants_flipped
|
|
);
|
|
|
|
$this->file_storage->namespace_aliases[(int) $node->getAttribute('startFilePos')] = $this->aliases;
|
|
|
|
if ($node->stmts) {
|
|
$this->aliases->namespace_first_stmt_start = (int) $node->stmts[0]->getAttribute('startFilePos');
|
|
}
|
|
}
|
|
|
|
private function handleUse(PhpParser\Node\Stmt\Use_ $node) : void
|
|
{
|
|
foreach ($node->uses as $use) {
|
|
$use_path = implode('\\', $use->name->parts);
|
|
|
|
$use_alias = $use->alias ? $use->alias->name : $use->name->getLast();
|
|
|
|
switch ($use->type !== PhpParser\Node\Stmt\Use_::TYPE_UNKNOWN ? $use->type : $node->type) {
|
|
case PhpParser\Node\Stmt\Use_::TYPE_FUNCTION:
|
|
$this->aliases->functions[strtolower($use_alias)] = $use_path;
|
|
$this->aliases->functions_flipped[strtolower($use_path)] = $use_alias;
|
|
break;
|
|
|
|
case PhpParser\Node\Stmt\Use_::TYPE_CONSTANT:
|
|
$this->aliases->constants[$use_alias] = $use_path;
|
|
$this->aliases->constants_flipped[$use_path] = $use_alias;
|
|
break;
|
|
|
|
case PhpParser\Node\Stmt\Use_::TYPE_NORMAL:
|
|
$this->aliases->uses[strtolower($use_alias)] = $use_path;
|
|
$this->aliases->uses_flipped[strtolower($use_path)] = $use_alias;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!$this->aliases->uses_start) {
|
|
$this->aliases->uses_start = (int) $node->getAttribute('startFilePos');
|
|
}
|
|
|
|
$this->aliases->uses_end = (int) $node->getAttribute('endFilePos') + 1;
|
|
}
|
|
|
|
private function handleGroupUse(PhpParser\Node\Stmt\GroupUse $node) : void
|
|
{
|
|
$use_prefix = implode('\\', $node->prefix->parts);
|
|
|
|
foreach ($node->uses as $use) {
|
|
$use_path = $use_prefix . '\\' . implode('\\', $use->name->parts);
|
|
$use_alias = $use->alias ? $use->alias->name : $use->name->getLast();
|
|
|
|
switch ($use->type !== PhpParser\Node\Stmt\Use_::TYPE_UNKNOWN ? $use->type : $node->type) {
|
|
case PhpParser\Node\Stmt\Use_::TYPE_FUNCTION:
|
|
$this->aliases->functions[strtolower($use_alias)] = $use_path;
|
|
$this->aliases->functions_flipped[strtolower($use_path)] = $use_alias;
|
|
break;
|
|
|
|
case PhpParser\Node\Stmt\Use_::TYPE_CONSTANT:
|
|
$this->aliases->constants[$use_alias] = $use_path;
|
|
$this->aliases->constants_flipped[$use_path] = $use_alias;
|
|
break;
|
|
|
|
case PhpParser\Node\Stmt\Use_::TYPE_NORMAL:
|
|
$this->aliases->uses[strtolower($use_alias)] = $use_path;
|
|
$this->aliases->uses_flipped[strtolower($use_path)] = $use_alias;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!$this->aliases->uses_start) {
|
|
$this->aliases->uses_start = (int) $node->getAttribute('startFilePos');
|
|
}
|
|
|
|
$this->aliases->uses_end = (int) $node->getAttribute('endFilePos') + 1;
|
|
}
|
|
|
|
/**
|
|
* @return null
|
|
*/
|
|
public function leaveNode(PhpParser\Node $node)
|
|
{
|
|
if ($node instanceof PhpParser\Node\Stmt\Namespace_) {
|
|
if (!$this->file_storage->aliases) {
|
|
throw new \UnexpectedValueException('File storage liases should not be null');
|
|
}
|
|
|
|
$this->aliases = $this->file_storage->aliases;
|
|
|
|
if ($this->codebase->register_stub_files
|
|
&& $node->name
|
|
&& $node->name->parts === ['PHPSTORM_META']
|
|
) {
|
|
foreach ($node->stmts as $meta_stmt) {
|
|
if ($meta_stmt instanceof PhpParser\Node\Stmt\Expression
|
|
&& $meta_stmt->expr instanceof PhpParser\Node\Expr\FuncCall
|
|
&& $meta_stmt->expr->name instanceof PhpParser\Node\Name
|
|
&& $meta_stmt->expr->name->parts === ['override']
|
|
&& count($meta_stmt->expr->args) > 1
|
|
) {
|
|
PhpStormMetaScanner::handleOverride($meta_stmt->expr->args, $this->codebase);
|
|
}
|
|
}
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\ClassLike) {
|
|
if ($this->skip_if_descendants) {
|
|
return null;
|
|
}
|
|
|
|
if (isset($this->bad_classes[\spl_object_id($node)])) {
|
|
return null;
|
|
}
|
|
|
|
if (!$this->classlike_node_scanners) {
|
|
throw new \UnexpectedValueException('$this->classlike_node_scanners cannot be empty');
|
|
}
|
|
|
|
$classlike_node_scanner = array_pop($this->classlike_node_scanners);
|
|
|
|
$classlike_storage = $classlike_node_scanner->finish($node);
|
|
|
|
if ($classlike_storage->has_visitor_issues) {
|
|
$this->file_storage->has_visitor_issues = true;
|
|
}
|
|
|
|
if ($this->after_classlike_check_plugins) {
|
|
$file_manipulations = [];
|
|
|
|
foreach ($this->after_classlike_check_plugins as $plugin_fq_class_name) {
|
|
$plugin_fq_class_name::afterClassLikeVisit(
|
|
$node,
|
|
$classlike_storage,
|
|
$this,
|
|
$this->codebase,
|
|
$file_manipulations
|
|
);
|
|
}
|
|
}
|
|
|
|
if (!$this->file_storage->has_visitor_issues) {
|
|
$this->codebase->cacheClassLikeStorage($classlike_storage, $this->file_path);
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\FunctionLike) {
|
|
if ($this->skip_if_descendants) {
|
|
return null;
|
|
}
|
|
|
|
if (!$this->functionlike_node_scanners) {
|
|
if ($this->file_storage->has_visitor_issues) {
|
|
return null;
|
|
}
|
|
|
|
throw new \UnexpectedValueException(
|
|
'There should be function storages for line ' . $this->file_path . ':' . $node->getLine()
|
|
);
|
|
}
|
|
|
|
$functionlike_node_scanner = array_pop($this->functionlike_node_scanners);
|
|
|
|
if ($functionlike_node_scanner->storage) {
|
|
if ($functionlike_node_scanner->storage->docblock_issues
|
|
&& (strpos($this->file_path, 'CoreGenericFunctions.phpstub')
|
|
|| strpos($this->file_path, 'CoreGenericClasses.phpstub'))
|
|
) {
|
|
throw new \UnexpectedValueException('Error with core stub file docblocks');
|
|
}
|
|
|
|
if ($functionlike_node_scanner->storage->has_visitor_issues) {
|
|
$this->file_storage->has_visitor_issues = true;
|
|
}
|
|
}
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\If_ && $node->getLine() === $this->skip_if_descendants) {
|
|
$this->exists_cond_expr = null;
|
|
$this->skip_if_descendants = null;
|
|
} elseif ($node instanceof PhpParser\Node\Stmt\Else_ && $node->getLine() === $this->skip_if_descendants) {
|
|
$this->exists_cond_expr = null;
|
|
$this->skip_if_descendants = null;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
public function getFilePath(): string
|
|
{
|
|
return $this->file_path;
|
|
}
|
|
|
|
public function getFileName(): string
|
|
{
|
|
return $this->file_scanner->getFileName();
|
|
}
|
|
|
|
public function getRootFilePath(): string
|
|
{
|
|
return $this->file_scanner->getRootFilePath();
|
|
}
|
|
|
|
public function getRootFileName(): string
|
|
{
|
|
return $this->file_scanner->getRootFileName();
|
|
}
|
|
|
|
public function getAliases(): Aliases
|
|
{
|
|
return $this->aliases;
|
|
}
|
|
|
|
public function afterTraverse(array $nodes): void
|
|
{
|
|
$this->file_storage->type_aliases = $this->type_aliases;
|
|
}
|
|
}
|