mirror of
https://github.com/danog/psalm.git
synced 2024-12-14 10:17:33 +01:00
2231 lines
84 KiB
PHP
2231 lines
84 KiB
PHP
<?php
|
|
namespace Psalm\Internal\Analyzer;
|
|
|
|
use PhpParser;
|
|
use Psalm\Aliases;
|
|
use Psalm\Internal\Analyzer\Statements\Block\DoAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\Block\ForAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\Block\ForeachAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\Block\IfAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\Block\SwitchAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\Block\TryAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\Block\WhileAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\Expression\Assignment\PropertyAssignmentAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\Expression\BinaryOpAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\Expression\CallAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\Expression\Fetch\ConstFetchAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\ExpressionAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\ReturnAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\ThrowAnalyzer;
|
|
use Psalm\Internal\Provider\FileProvider;
|
|
use Psalm\Internal\Visitor\CheckTrivialExprVisitor;
|
|
use Psalm\Codebase;
|
|
use Psalm\CodeLocation;
|
|
use Psalm\Config;
|
|
use Psalm\Context;
|
|
use Psalm\DocComment;
|
|
use Psalm\Exception\DocblockParseException;
|
|
use Psalm\FileManipulation;
|
|
use Psalm\Internal\FileManipulation\FileManipulationBuffer;
|
|
use Psalm\Issue\ContinueOutsideLoop;
|
|
use Psalm\Issue\ForbiddenCode;
|
|
use Psalm\Issue\ForbiddenEcho;
|
|
use Psalm\Issue\InvalidDocblock;
|
|
use Psalm\Issue\InvalidGlobal;
|
|
use Psalm\Issue\UnevaluatedCode;
|
|
use Psalm\Issue\UnrecognizedStatement;
|
|
use Psalm\Issue\UnusedVariable;
|
|
use Psalm\IssueBuffer;
|
|
use Psalm\StatementsSource;
|
|
use Psalm\Type;
|
|
use function strtolower;
|
|
use function fwrite;
|
|
use const STDERR;
|
|
use function array_filter;
|
|
use function array_map;
|
|
use function preg_split;
|
|
use function array_diff;
|
|
use function is_string;
|
|
use function get_class;
|
|
use function in_array;
|
|
use function strrpos;
|
|
use function strlen;
|
|
use function substr;
|
|
use function array_key_exists;
|
|
use function count;
|
|
use function array_shift;
|
|
use function explode;
|
|
use function array_pop;
|
|
use function implode;
|
|
use function array_change_key_case;
|
|
use function token_get_all;
|
|
use function token_name;
|
|
use function array_slice;
|
|
use function array_reverse;
|
|
use function is_array;
|
|
use function trim;
|
|
use function is_null;
|
|
use function array_column;
|
|
use function array_combine;
|
|
use Psalm\Storage\FunctionLikeParameter;
|
|
|
|
/**
|
|
* @internal
|
|
*/
|
|
class StatementsAnalyzer extends SourceAnalyzer implements StatementsSource
|
|
{
|
|
/**
|
|
* @var SourceAnalyzer
|
|
*/
|
|
protected $source;
|
|
|
|
/**
|
|
* @var FileAnalyzer
|
|
*/
|
|
protected $file_analyzer;
|
|
|
|
/**
|
|
* @var Codebase
|
|
*/
|
|
protected $codebase;
|
|
|
|
/**
|
|
* @var array<string, CodeLocation>
|
|
*/
|
|
private $all_vars = [];
|
|
|
|
/**
|
|
* @var array<string, int>
|
|
*/
|
|
private $var_branch_points = [];
|
|
|
|
/**
|
|
* Possibly undefined variables should be initialised if we're altering code
|
|
*
|
|
* @var array<string, int>|null
|
|
*/
|
|
private $vars_to_initialize;
|
|
|
|
/**
|
|
* @var array<string, FunctionAnalyzer>
|
|
*/
|
|
private $function_analyzers = [];
|
|
|
|
/**
|
|
* @var array<string, array{0: string, 1: CodeLocation}>
|
|
*/
|
|
private $unused_var_locations = [];
|
|
|
|
/**
|
|
* @var array<string, bool>
|
|
*/
|
|
private $used_var_locations = [];
|
|
|
|
/**
|
|
* @var ?array<string, bool>
|
|
*/
|
|
private $byref_uses;
|
|
|
|
/**
|
|
* @var array{description:string, specials:array<string, array<int, string>>}|null
|
|
*/
|
|
private $parsed_docblock = null;
|
|
|
|
/**
|
|
* @var array<string, CodeLocation>
|
|
*/
|
|
private $removed_unref_vars = [];
|
|
|
|
/**
|
|
* @var ?string
|
|
*/
|
|
private $fake_this_class = null;
|
|
|
|
/**
|
|
* @param SourceAnalyzer $source
|
|
*/
|
|
public function __construct(SourceAnalyzer $source)
|
|
{
|
|
$this->source = $source;
|
|
$this->file_analyzer = $source->getFileAnalyzer();
|
|
$this->codebase = $source->getCodebase();
|
|
}
|
|
|
|
/**
|
|
* Checks an array of statements for validity
|
|
*
|
|
* @param array<PhpParser\Node\Stmt> $stmts
|
|
* @param Context $context
|
|
* @param Context|null $global_context
|
|
* @param bool $root_scope
|
|
*
|
|
* @return null|false
|
|
*/
|
|
public function analyze(
|
|
array $stmts,
|
|
Context $context,
|
|
Context $global_context = null,
|
|
$root_scope = false
|
|
) {
|
|
$has_returned = false;
|
|
|
|
// hoist functions to the top
|
|
foreach ($stmts as $stmt) {
|
|
if ($stmt instanceof PhpParser\Node\Stmt\Function_) {
|
|
try {
|
|
$function_analyzer = new FunctionAnalyzer($stmt, $this->source);
|
|
$this->function_analyzers[strtolower($stmt->name->name)] = $function_analyzer;
|
|
} catch (\UnexpectedValueException $e) {
|
|
// do nothing
|
|
}
|
|
}
|
|
}
|
|
|
|
$project_analyzer = $this->getFileAnalyzer()->project_analyzer;
|
|
$codebase = $project_analyzer->getCodebase();
|
|
|
|
if ($codebase->config->hoist_constants) {
|
|
foreach ($stmts as $stmt) {
|
|
if ($stmt instanceof PhpParser\Node\Stmt\Const_) {
|
|
foreach ($stmt->consts as $const) {
|
|
$this->setConstType(
|
|
$const->name->name,
|
|
self::getSimpleType($codebase, $const->value, $this->getAliases(), $this)
|
|
?: Type::getMixed(),
|
|
$context
|
|
);
|
|
}
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Expression
|
|
&& $stmt->expr instanceof PhpParser\Node\Expr\FuncCall
|
|
&& $stmt->expr->name instanceof PhpParser\Node\Name
|
|
&& $stmt->expr->name->parts === ['define']
|
|
&& isset($stmt->expr->args[1])
|
|
) {
|
|
$const_name = static::getConstName($stmt->expr->args[0]->value, $codebase, $this->getAliases());
|
|
if ($const_name !== null) {
|
|
$this->setConstType(
|
|
$const_name,
|
|
self::getSimpleType($codebase, $stmt->expr->args[1]->value, $this->getAliases(), $this)
|
|
?: Type::getMixed(),
|
|
$context
|
|
);
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$original_context = null;
|
|
|
|
if ($context->loop_scope) {
|
|
$original_context = clone $context->loop_scope->loop_parent_context;
|
|
}
|
|
|
|
$plugin_classes = $codebase->config->after_statement_checks;
|
|
|
|
foreach ($stmts as $stmt) {
|
|
$ignore_variable_property = false;
|
|
$ignore_variable_method = false;
|
|
|
|
if ($has_returned && !($stmt instanceof PhpParser\Node\Stmt\Nop) &&
|
|
!($stmt instanceof PhpParser\Node\Stmt\InlineHTML)
|
|
) {
|
|
if ($context->collect_references) {
|
|
if (IssueBuffer::accepts(
|
|
new UnevaluatedCode(
|
|
'Expressions after return/throw/continue',
|
|
new CodeLocation($this->source, $stmt)
|
|
),
|
|
$this->source->getSuppressedIssues()
|
|
)) {
|
|
return false;
|
|
}
|
|
}
|
|
break;
|
|
}
|
|
|
|
if ($project_analyzer->debug_lines) {
|
|
fwrite(STDERR, $this->getFilePath() . ':' . $stmt->getLine() . "\n");
|
|
}
|
|
|
|
/*
|
|
if (isset($context->vars_in_scope['$array']) && !$stmt instanceof PhpParser\Node\Stmt\Nop) {
|
|
var_dump($stmt->getLine(), $context->vars_in_scope['$array']);
|
|
}
|
|
*/
|
|
|
|
$new_issues = null;
|
|
|
|
if ($docblock = $stmt->getDocComment()) {
|
|
try {
|
|
$this->parsed_docblock = DocComment::parsePreservingLength($docblock);
|
|
} catch (DocblockParseException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
(string)$e->getMessage(),
|
|
new CodeLocation($this->getSource(), $stmt, null, true)
|
|
)
|
|
)) {
|
|
// fall through
|
|
}
|
|
|
|
$this->parsed_docblock = null;
|
|
}
|
|
|
|
$comments = $this->parsed_docblock;
|
|
|
|
if (isset($comments['specials']['psalm-scope-this'])) {
|
|
$trimmed = trim(\reset($comments['specials']['psalm-scope-this']));
|
|
|
|
if (!$codebase->classExists($trimmed)) {
|
|
if (IssueBuffer::accepts(
|
|
new \Psalm\Issue\UndefinedDocblockClass(
|
|
'Scope class ' . $trimmed . ' does not exist',
|
|
new CodeLocation($this->getSource(), $stmt, null, true),
|
|
$trimmed
|
|
)
|
|
)) {
|
|
// fall through
|
|
}
|
|
} else {
|
|
$this_type = Type::parseString($trimmed);
|
|
$context->self = $trimmed;
|
|
$context->vars_in_scope['$this'] = $this_type;
|
|
$this->setFQCLN($trimmed);
|
|
}
|
|
}
|
|
|
|
if (isset($comments['specials']['psalm-suppress'])) {
|
|
$suppressed = array_filter(
|
|
array_map(
|
|
/**
|
|
* @param string $line
|
|
*
|
|
* @return string
|
|
*/
|
|
function ($line) {
|
|
return preg_split('/[\s]+/', $line)[0];
|
|
},
|
|
$comments['specials']['psalm-suppress']
|
|
)
|
|
);
|
|
|
|
if ($suppressed) {
|
|
$new_issues = [];
|
|
|
|
foreach ($suppressed as $offset => $issue_type) {
|
|
$offset += $docblock->getFilePos();
|
|
$new_issues[$offset] = $issue_type;
|
|
|
|
if ($issue_type === 'InaccessibleMethod') {
|
|
continue;
|
|
}
|
|
|
|
if ($codebase->track_unused_suppressions) {
|
|
IssueBuffer::addUnusedSuppression($this->getFilePath(), $offset, $issue_type);
|
|
}
|
|
}
|
|
|
|
$this->addSuppressedIssues($new_issues);
|
|
}
|
|
}
|
|
|
|
if (isset($comments['specials']['psalm-ignore-variable-method'])) {
|
|
$context->ignore_variable_method = $ignore_variable_method = true;
|
|
}
|
|
|
|
if (isset($comments['specials']['psalm-ignore-variable-property'])) {
|
|
$context->ignore_variable_property = $ignore_variable_property = true;
|
|
}
|
|
} else {
|
|
$this->parsed_docblock = null;
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Stmt\If_) {
|
|
if (IfAnalyzer::analyze($this, $stmt, $context) === false) {
|
|
return false;
|
|
}
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\TryCatch) {
|
|
if (TryAnalyzer::analyze($this, $stmt, $context) === false) {
|
|
return false;
|
|
}
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\For_) {
|
|
if (ForAnalyzer::analyze($this, $stmt, $context) === false) {
|
|
return false;
|
|
}
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Foreach_) {
|
|
if (ForeachAnalyzer::analyze($this, $stmt, $context) === false) {
|
|
return false;
|
|
}
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\While_) {
|
|
if (WhileAnalyzer::analyze($this, $stmt, $context) === false) {
|
|
return false;
|
|
}
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Do_) {
|
|
DoAnalyzer::analyze($this, $stmt, $context);
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Const_) {
|
|
$this->analyzeConstAssignment($stmt, $context);
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Unset_) {
|
|
$this->analyzeUnset($stmt, $context);
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Return_) {
|
|
$has_returned = true;
|
|
ReturnAnalyzer::analyze($this, $stmt, $context);
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Throw_) {
|
|
$has_returned = true;
|
|
ThrowAnalyzer::analyze($this, $stmt, $context);
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Switch_) {
|
|
SwitchAnalyzer::analyze($this, $stmt, $context);
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Break_) {
|
|
$loop_scope = $context->loop_scope;
|
|
if ($loop_scope && $original_context) {
|
|
if ($context->inside_case && !$stmt->num) {
|
|
$loop_scope->final_actions[] = ScopeAnalyzer::ACTION_LEAVE_SWITCH;
|
|
} else {
|
|
$loop_scope->final_actions[] = ScopeAnalyzer::ACTION_BREAK;
|
|
}
|
|
|
|
$redefined_vars = $context->getRedefinedVars($loop_scope->loop_parent_context->vars_in_scope);
|
|
|
|
if ($loop_scope->possibly_redefined_loop_parent_vars === null) {
|
|
$loop_scope->possibly_redefined_loop_parent_vars = $redefined_vars;
|
|
} else {
|
|
foreach ($redefined_vars as $var => $type) {
|
|
if ($type->hasMixed()) {
|
|
$loop_scope->possibly_redefined_loop_parent_vars[$var] = $type;
|
|
} elseif (isset($loop_scope->possibly_redefined_loop_parent_vars[$var])) {
|
|
$loop_scope->possibly_redefined_loop_parent_vars[$var] = Type::combineUnionTypes(
|
|
$type,
|
|
$loop_scope->possibly_redefined_loop_parent_vars[$var]
|
|
);
|
|
} else {
|
|
$loop_scope->possibly_redefined_loop_parent_vars[$var] = $type;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($loop_scope->iteration_count === 0) {
|
|
foreach ($context->vars_in_scope as $var_id => $type) {
|
|
if (!isset($loop_scope->loop_parent_context->vars_in_scope[$var_id])) {
|
|
if (isset($loop_scope->possibly_defined_loop_parent_vars[$var_id])) {
|
|
$loop_scope->possibly_defined_loop_parent_vars[$var_id] = Type::combineUnionTypes(
|
|
$type,
|
|
$loop_scope->possibly_defined_loop_parent_vars[$var_id]
|
|
);
|
|
} else {
|
|
$loop_scope->possibly_defined_loop_parent_vars[$var_id] = $type;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($context->collect_references && (!$context->case_scope || $stmt->num)) {
|
|
foreach ($context->unreferenced_vars as $var_id => $locations) {
|
|
if (isset($loop_scope->unreferenced_vars[$var_id])) {
|
|
$loop_scope->unreferenced_vars[$var_id] += $locations;
|
|
} else {
|
|
$loop_scope->unreferenced_vars[$var_id] = $locations;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$case_scope = $context->case_scope;
|
|
if ($case_scope) {
|
|
foreach ($context->vars_in_scope as $var_id => $type) {
|
|
if ($case_scope->parent_context !== $context) {
|
|
if ($case_scope->break_vars === null) {
|
|
$case_scope->break_vars = [];
|
|
}
|
|
|
|
if (isset($case_scope->break_vars[$var_id])) {
|
|
$case_scope->break_vars[$var_id] = Type::combineUnionTypes(
|
|
$type,
|
|
$case_scope->break_vars[$var_id]
|
|
);
|
|
} else {
|
|
$case_scope->break_vars[$var_id] = $type;
|
|
}
|
|
}
|
|
}
|
|
if ($context->collect_references) {
|
|
foreach ($context->unreferenced_vars as $var_id => $locations) {
|
|
if (isset($case_scope->unreferenced_vars[$var_id])) {
|
|
$case_scope->unreferenced_vars[$var_id] += $locations;
|
|
} else {
|
|
$case_scope->unreferenced_vars[$var_id] = $locations;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$has_returned = true;
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Continue_) {
|
|
$loop_scope = $context->loop_scope;
|
|
if ($loop_scope === null) {
|
|
if (!$context->inside_case) {
|
|
if (IssueBuffer::accepts(
|
|
new ContinueOutsideLoop(
|
|
'Continue call outside loop context',
|
|
new CodeLocation($this->source, $stmt)
|
|
),
|
|
$this->source->getSuppressedIssues()
|
|
)) {
|
|
return false;
|
|
}
|
|
}
|
|
} elseif ($original_context) {
|
|
if ($context->inside_case && !$stmt->num) {
|
|
$loop_scope->final_actions[] = ScopeAnalyzer::ACTION_LEAVE_SWITCH;
|
|
} else {
|
|
$loop_scope->final_actions[] = ScopeAnalyzer::ACTION_CONTINUE;
|
|
}
|
|
|
|
$redefined_vars = $context->getRedefinedVars($original_context->vars_in_scope);
|
|
|
|
if ($loop_scope->redefined_loop_vars === null) {
|
|
$loop_scope->redefined_loop_vars = $redefined_vars;
|
|
} else {
|
|
foreach ($loop_scope->redefined_loop_vars as $redefined_var => $type) {
|
|
if (!isset($redefined_vars[$redefined_var])) {
|
|
unset($loop_scope->redefined_loop_vars[$redefined_var]);
|
|
} else {
|
|
$loop_scope->redefined_loop_vars[$redefined_var] = Type::combineUnionTypes(
|
|
$redefined_vars[$redefined_var],
|
|
$type
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
foreach ($redefined_vars as $var => $type) {
|
|
if ($type->hasMixed()) {
|
|
$loop_scope->possibly_redefined_loop_vars[$var] = $type;
|
|
} elseif (isset($loop_scope->possibly_redefined_loop_vars[$var])) {
|
|
$loop_scope->possibly_redefined_loop_vars[$var] = Type::combineUnionTypes(
|
|
$type,
|
|
$loop_scope->possibly_redefined_loop_vars[$var]
|
|
);
|
|
} else {
|
|
$loop_scope->possibly_redefined_loop_vars[$var] = $type;
|
|
}
|
|
}
|
|
|
|
if ($context->collect_references && (!$context->case_scope || $stmt->num)) {
|
|
foreach ($context->unreferenced_vars as $var_id => $locations) {
|
|
if (isset($loop_scope->unreferenced_vars[$var_id])) {
|
|
$loop_scope->unreferenced_vars[$var_id] += $locations;
|
|
} else {
|
|
$loop_scope->unreferenced_vars[$var_id] = $locations;
|
|
}
|
|
|
|
if (isset($loop_scope->possibly_unreferenced_vars[$var_id])) {
|
|
$loop_scope->possibly_unreferenced_vars[$var_id] += $locations;
|
|
} else {
|
|
$loop_scope->possibly_unreferenced_vars[$var_id] = $locations;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
$case_scope = $context->case_scope;
|
|
if ($case_scope && $context->collect_references) {
|
|
foreach ($context->unreferenced_vars as $var_id => $locations) {
|
|
if (isset($case_scope->unreferenced_vars[$var_id])) {
|
|
$case_scope->unreferenced_vars[$var_id] += $locations;
|
|
} else {
|
|
$case_scope->unreferenced_vars[$var_id] = $locations;
|
|
}
|
|
}
|
|
}
|
|
|
|
$has_returned = true;
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Static_) {
|
|
$this->analyzeStatic($stmt, $context);
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Echo_) {
|
|
$echo_param = new FunctionLikeParameter(
|
|
'var',
|
|
false
|
|
);
|
|
|
|
$echo_param->sink = Type\Union::TAINTED_INPUT_HTML
|
|
| Type\Union::TAINTED_USER_SECRET
|
|
| Type\Union::TAINTED_SYSTEM_SECRET;
|
|
|
|
foreach ($stmt->exprs as $i => $expr) {
|
|
$context->inside_call = true;
|
|
ExpressionAnalyzer::analyze($this, $expr, $context);
|
|
$context->inside_call = false;
|
|
|
|
if (isset($expr->inferredType)) {
|
|
if (CallAnalyzer::checkFunctionArgumentType(
|
|
$this,
|
|
$expr->inferredType,
|
|
Type::getString(),
|
|
null,
|
|
'echo',
|
|
(int)$i,
|
|
new CodeLocation($this->getSource(), $expr),
|
|
$expr,
|
|
$context,
|
|
$echo_param,
|
|
false,
|
|
false,
|
|
true,
|
|
new CodeLocation($this->source, $stmt)
|
|
) === false) {
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($codebase->config->forbid_echo) {
|
|
if (IssueBuffer::accepts(
|
|
new ForbiddenEcho(
|
|
'Use of echo',
|
|
new CodeLocation($this->source, $stmt)
|
|
),
|
|
$this->source->getSuppressedIssues()
|
|
)) {
|
|
return false;
|
|
}
|
|
} elseif (isset($codebase->config->forbidden_functions['echo'])) {
|
|
if (IssueBuffer::accepts(
|
|
new ForbiddenCode(
|
|
'Use of echo',
|
|
new CodeLocation($this->source, $stmt)
|
|
),
|
|
$this->source->getSuppressedIssues()
|
|
)) {
|
|
// continue
|
|
}
|
|
}
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Function_) {
|
|
foreach ($stmt->stmts as $function_stmt) {
|
|
if ($function_stmt instanceof PhpParser\Node\Stmt\Global_) {
|
|
foreach ($function_stmt->vars as $var) {
|
|
if ($var instanceof PhpParser\Node\Expr\Variable) {
|
|
if (is_string($var->name)) {
|
|
$var_id = '$' . $var->name;
|
|
|
|
// registers variable in global context
|
|
$context->hasVariable($var_id, $this);
|
|
}
|
|
}
|
|
}
|
|
} elseif (!$function_stmt instanceof PhpParser\Node\Stmt\Nop) {
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!$codebase->register_stub_files
|
|
&& !$codebase->register_autoload_files
|
|
) {
|
|
$function_id = strtolower($stmt->name->name);
|
|
$function_context = new Context($context->self);
|
|
$function_context->strict_types = $context->strict_types;
|
|
$config = Config::getInstance();
|
|
$function_context->collect_references = $codebase->collect_references;
|
|
$function_context->collect_exceptions = $config->check_for_throws_docblock;
|
|
|
|
if (isset($this->function_analyzers[$function_id])) {
|
|
$this->function_analyzers[$function_id]->analyze($function_context, $context);
|
|
|
|
if ($config->reportIssueInFile('InvalidReturnType', $this->getFilePath())) {
|
|
$method_id = $this->function_analyzers[$function_id]->getMethodId();
|
|
|
|
$function_storage = $codebase->functions->getStorage(
|
|
$this,
|
|
$method_id
|
|
);
|
|
|
|
$return_type = $function_storage->return_type;
|
|
$return_type_location = $function_storage->return_type_location;
|
|
|
|
$this->function_analyzers[$function_id]->verifyReturnType(
|
|
$this,
|
|
$return_type,
|
|
$this->getFQCLN(),
|
|
$return_type_location
|
|
);
|
|
}
|
|
}
|
|
}
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Expression) {
|
|
if (ExpressionAnalyzer::analyze($this, $stmt->expr, $context, false, $global_context) === false) {
|
|
return false;
|
|
}
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\InlineHTML) {
|
|
// do nothing
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Global_) {
|
|
if (!$context->collect_initializations && !$global_context) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidGlobal(
|
|
'Cannot use global scope here',
|
|
new CodeLocation($this->source, $stmt)
|
|
),
|
|
$this->source->getSuppressedIssues()
|
|
)) {
|
|
// fall through
|
|
}
|
|
}
|
|
|
|
$source = $this->getSource();
|
|
$function_storage = $source instanceof FunctionLikeAnalyzer
|
|
? $source->getFunctionLikeStorage($this)
|
|
: null;
|
|
|
|
foreach ($stmt->vars as $var) {
|
|
if ($var instanceof PhpParser\Node\Expr\Variable) {
|
|
if (is_string($var->name)) {
|
|
$var_id = '$' . $var->name;
|
|
|
|
if ($var->name === 'argv' || $var->name === 'argc') {
|
|
$context->vars_in_scope[$var_id] = $this->getGlobalType($var_id);
|
|
} elseif (isset($function_storage->global_types[$var_id])) {
|
|
$context->vars_in_scope[$var_id] = clone $function_storage->global_types[$var_id];
|
|
$context->vars_possibly_in_scope[$var_id] = true;
|
|
} else {
|
|
$context->vars_in_scope[$var_id] =
|
|
$global_context && $global_context->hasVariable($var_id, $this)
|
|
? clone $global_context->vars_in_scope[$var_id]
|
|
: $this->getGlobalType($var_id);
|
|
|
|
$context->vars_possibly_in_scope[$var_id] = true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Property) {
|
|
foreach ($stmt->props as $prop) {
|
|
if ($prop->default) {
|
|
ExpressionAnalyzer::analyze($this, $prop->default, $context);
|
|
|
|
if (isset($prop->default->inferredType)) {
|
|
if (PropertyAssignmentAnalyzer::analyzeInstance(
|
|
$this,
|
|
$prop,
|
|
$prop->name->name,
|
|
$prop->default,
|
|
$prop->default->inferredType,
|
|
$context
|
|
) === false) {
|
|
// fall through
|
|
}
|
|
}
|
|
}
|
|
}
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\ClassConst) {
|
|
$const_visibility = \ReflectionProperty::IS_PUBLIC;
|
|
|
|
if ($stmt->isProtected()) {
|
|
$const_visibility = \ReflectionProperty::IS_PROTECTED;
|
|
}
|
|
|
|
if ($stmt->isPrivate()) {
|
|
$const_visibility = \ReflectionProperty::IS_PRIVATE;
|
|
}
|
|
|
|
foreach ($stmt->consts as $const) {
|
|
ExpressionAnalyzer::analyze($this, $const->value, $context);
|
|
|
|
if (isset($const->value->inferredType) && !$const->value->inferredType->hasMixed()) {
|
|
$codebase->classlikes->setConstantType(
|
|
(string)$this->getFQCLN(),
|
|
$const->name->name,
|
|
$const->value->inferredType,
|
|
$const_visibility
|
|
);
|
|
}
|
|
}
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Class_) {
|
|
try {
|
|
$class_analyzer = new ClassAnalyzer($stmt, $this->source, $stmt->name ? $stmt->name->name : null);
|
|
$class_analyzer->analyze(null, $global_context);
|
|
} catch (\InvalidArgumentException $e) {
|
|
// disregard this exception, we'll likely see it elsewhere in the form
|
|
// of an issue
|
|
}
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Nop) {
|
|
if (($doc_comment = $stmt->getDocComment()) && $this->parsed_docblock) {
|
|
$var_comments = [];
|
|
|
|
try {
|
|
$var_comments = CommentAnalyzer::arrayToDocblocks(
|
|
$doc_comment,
|
|
$this->parsed_docblock,
|
|
$this->getSource(),
|
|
$this->getSource()->getAliases(),
|
|
$this->getSource()->getTemplateTypeMap()
|
|
);
|
|
} catch (DocblockParseException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
(string)$e->getMessage(),
|
|
new CodeLocation($this->getSource(), $stmt, null, true)
|
|
)
|
|
)) {
|
|
// fall through
|
|
}
|
|
}
|
|
|
|
foreach ($var_comments as $var_comment) {
|
|
if (!$var_comment->var_id || !$var_comment->type) {
|
|
continue;
|
|
}
|
|
|
|
$comment_type = ExpressionAnalyzer::fleshOutType(
|
|
$codebase,
|
|
$var_comment->type,
|
|
$context->self,
|
|
$context->self,
|
|
$this->getParentFQCLN()
|
|
);
|
|
|
|
$context->vars_in_scope[$var_comment->var_id] = $comment_type;
|
|
}
|
|
}
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Goto_) {
|
|
// do nothing
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Label) {
|
|
// do nothing
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\Declare_) {
|
|
foreach ($stmt->declares as $declaration) {
|
|
if ((string) $declaration->key === 'strict_types'
|
|
&& $declaration->value instanceof PhpParser\Node\Scalar\LNumber
|
|
&& $declaration->value->value === 1
|
|
) {
|
|
$context->strict_types = true;
|
|
}
|
|
}
|
|
} elseif ($stmt instanceof PhpParser\Node\Stmt\HaltCompiler) {
|
|
$has_returned = true;
|
|
} else {
|
|
if (IssueBuffer::accepts(
|
|
new UnrecognizedStatement(
|
|
'Psalm does not understand ' . get_class($stmt),
|
|
new CodeLocation($this->source, $stmt)
|
|
),
|
|
$this->getSuppressedIssues()
|
|
)) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if ($context->loop_scope
|
|
&& $context->loop_scope->final_actions
|
|
&& !in_array(ScopeAnalyzer::ACTION_NONE, $context->loop_scope->final_actions, true)
|
|
) {
|
|
//$has_returned = true;
|
|
}
|
|
|
|
if ($plugin_classes) {
|
|
$file_manipulations = [];
|
|
|
|
foreach ($plugin_classes as $plugin_fq_class_name) {
|
|
if ($plugin_fq_class_name::afterStatementAnalysis(
|
|
$stmt,
|
|
$context,
|
|
$this->getSource(),
|
|
$codebase,
|
|
$file_manipulations
|
|
) === false) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if ($file_manipulations) {
|
|
FileManipulationBuffer::add($this->getFilePath(), $file_manipulations);
|
|
}
|
|
}
|
|
|
|
if ($new_issues) {
|
|
$this->removeSuppressedIssues($new_issues);
|
|
}
|
|
|
|
if ($ignore_variable_property) {
|
|
$context->ignore_variable_property = false;
|
|
}
|
|
|
|
if ($ignore_variable_method) {
|
|
$context->ignore_variable_method = false;
|
|
}
|
|
}
|
|
|
|
if ($root_scope
|
|
&& $context->collect_references
|
|
&& !$context->collect_initializations
|
|
&& $codebase->find_unused_variables
|
|
&& $context->check_variables
|
|
) {
|
|
$this->checkUnreferencedVars($stmts);
|
|
}
|
|
|
|
if ($codebase->alter_code && $root_scope && $this->vars_to_initialize) {
|
|
$file_contents = $codebase->getFileContents($this->getFilePath());
|
|
|
|
foreach ($this->vars_to_initialize as $var_id => $branch_point) {
|
|
$newline_pos = (int)strrpos($file_contents, "\n", $branch_point - strlen($file_contents)) + 1;
|
|
$indentation = substr($file_contents, $newline_pos, $branch_point - $newline_pos);
|
|
FileManipulationBuffer::add($this->getFilePath(), [
|
|
new FileManipulation($branch_point, $branch_point, $var_id . ' = null;' . "\n" . $indentation),
|
|
]);
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* @param CodeLocation $var_loc
|
|
* @param int $end_bound
|
|
* @param bool $assign_ref
|
|
* @return FileManipulation
|
|
*/
|
|
private function getPartialRemovalBounds(
|
|
CodeLocation $var_loc,
|
|
int $end_bound,
|
|
bool $assign_ref = false
|
|
): FileManipulation {
|
|
$var_start_loc= $var_loc->raw_file_start;
|
|
$stmt_content = $this->getSource()->getCodebase()->file_provider->getContents($var_loc->file_path);
|
|
$str_for_token = "<?php\n" . substr($stmt_content, $var_start_loc, $end_bound - $var_start_loc + 1);
|
|
$token_list = array_slice(token_get_all($str_for_token), 1); //Ignore "<?php"
|
|
|
|
$offset_count = strlen($token_list[0][1]);
|
|
$iter = 1;
|
|
|
|
// Check if second token is just whitespace
|
|
if (is_array($token_list[$iter]) && strlen(trim($token_list[$iter][1])) == 0) {
|
|
$offset_count += strlen($token_list[1][1]);
|
|
$iter++;
|
|
}
|
|
|
|
// Add offset for assignment operator
|
|
if (is_string($token_list[$iter])) {
|
|
$offset_count += 1;
|
|
} else {
|
|
$offset_count += strlen($token_list[$iter][1]);
|
|
}
|
|
$iter++;
|
|
|
|
// Remove any whitespace following assignment operator token (e.g "=", "+=")
|
|
if (is_array($token_list[$iter]) && strlen(trim($token_list[$iter][1])) == 0) {
|
|
$offset_count += strlen($token_list[$iter][1]);
|
|
$iter++;
|
|
}
|
|
|
|
// If we are dealing with assignment by reference, we need to handle "&" and any whitespace after
|
|
if ($assign_ref) {
|
|
$offset_count += 1;
|
|
$iter++;
|
|
// Handle any whitespace after "&"
|
|
if (is_array($token_list[$iter]) && strlen(trim($token_list[$iter][1])) == 0) {
|
|
$offset_count += strlen($token_list[$iter][1]);
|
|
}
|
|
}
|
|
|
|
$file_man_start = $var_start_loc;
|
|
$file_man_end = $var_start_loc + $offset_count;
|
|
|
|
return new FileManipulation($file_man_start, $file_man_end, "", false);
|
|
}
|
|
|
|
/**
|
|
* @param PhpParser\Node\Expr\Assign|PhpParser\Node\Expr\AssignOp|PhpParser\Node\Expr\AssignRef $cur_assign
|
|
* @param array<string, CodeLocation> $var_loc_map
|
|
* @return void
|
|
*/
|
|
private function markRemovedChainAssignVar(PhpParser\Node\Expr $cur_assign, array $var_loc_map): void
|
|
{
|
|
$var = $cur_assign->var;
|
|
if ($var instanceof PhpParser\Node\Expr\Variable && is_string($var->name)) {
|
|
$var_name = "$" . $var->name;
|
|
$var_loc = $var_loc_map[$var_name];
|
|
$this->removed_unref_vars[$var_name] = $var_loc;
|
|
|
|
$rhs_exp = $cur_assign->expr;
|
|
if ($rhs_exp instanceof PhpParser\Node\Expr\Assign
|
|
|| $rhs_exp instanceof PhpParser\Node\Expr\AssignOp
|
|
|| $rhs_exp instanceof PhpParser\Node\Expr\AssignRef
|
|
) {
|
|
$this->markRemovedChainAssignVar($rhs_exp, $var_loc_map);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param PhpParser\Node\Expr\Assign|PhpParser\Node\Expr\AssignOp|PhpParser\Node\Expr\AssignRef $cur_assign
|
|
* @param array<string, CodeLocation> $var_loc_map
|
|
* @return bool
|
|
*/
|
|
private function checkRemovableChainAssignment(PhpParser\Node\Expr $cur_assign, array $var_loc_map): bool
|
|
{
|
|
// Check if current assignment expr's variable is removable
|
|
$var = $cur_assign->var;
|
|
if ($var instanceof PhpParser\Node\Expr\Variable && is_string($var->name)) {
|
|
$var_loc = $cur_assign->var->getStartFilePos();
|
|
$var_name = "$" . $var->name;
|
|
|
|
if (array_key_exists($var_name, $var_loc_map) &&
|
|
$var_loc_map[$var_name]->raw_file_start === $var_loc) {
|
|
$curr_removable = true;
|
|
} else {
|
|
$curr_removable = false;
|
|
}
|
|
|
|
if ($curr_removable) {
|
|
$rhs_exp = $cur_assign->expr;
|
|
|
|
if ($rhs_exp instanceof PhpParser\Node\Expr\Assign
|
|
|| $rhs_exp instanceof PhpParser\Node\Expr\AssignOp
|
|
|| $rhs_exp instanceof PhpParser\Node\Expr\AssignRef
|
|
) {
|
|
$rhs_removable = $this->checkRemovableChainAssignment($rhs_exp, $var_loc_map);
|
|
return $rhs_removable;
|
|
}
|
|
}
|
|
return $curr_removable;
|
|
} else {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param array<PhpParser\Node\Stmt> $stmts
|
|
* @param string $var_id
|
|
* @param CodeLocation $original_location
|
|
* @return array{
|
|
* 0: PhpParser\Node\Stmt|null,
|
|
* 1: PhpParser\Node\Expr\Assign|PhpParser\Node\Expr\AssignOp|PhpParser\Node\Expr\AssignRef|null
|
|
* }
|
|
*/
|
|
private function findAssignStmt(array $stmts, string $var_id, CodeLocation $original_location)
|
|
{
|
|
$assign_stmt = null;
|
|
$assign_exp = null;
|
|
$assign_exp_found = false;
|
|
|
|
$i = 0;
|
|
while ($i<count($stmts) && !$assign_exp_found) {
|
|
$stmt = $stmts[$i];
|
|
if ($stmt instanceof PhpParser\Node\Stmt\Expression) {
|
|
$search_result = $this->findAssignExp($stmt->expr, $var_id, $original_location->raw_file_start);
|
|
$target_exp = $search_result[0];
|
|
$levels_taken = $search_result[1];
|
|
|
|
if (!is_null($target_exp)) {
|
|
$assign_exp_found = true;
|
|
$assign_exp = $target_exp;
|
|
$assign_stmt = $levels_taken === 1 ? $stmt : null;
|
|
}
|
|
}
|
|
$i+=1;
|
|
}
|
|
|
|
return [$assign_stmt, $assign_exp];
|
|
}
|
|
|
|
/**
|
|
* @param PhpParser\Node\Expr $current_node
|
|
* @param string $var_id
|
|
* @param int $var_start_loc
|
|
* @param int $search_level
|
|
* @return array{
|
|
* 0: PhpParser\Node\Expr\Assign|PhpParser\Node\Expr\AssignOp|PhpParser\Node\Expr\AssignRef|null,
|
|
* 1: int
|
|
* }
|
|
*/
|
|
private function findAssignExp(
|
|
PhpParser\Node\Expr $current_node,
|
|
string $var_id,
|
|
int $var_start_loc,
|
|
int $search_level = 1
|
|
) {
|
|
if ($current_node instanceof PhpParser\Node\Expr\Assign
|
|
|| $current_node instanceof PhpPArser\Node\Expr\AssignOp
|
|
|| $current_node instanceof PhpParser\Node\Expr\AssignRef
|
|
) {
|
|
$var = $current_node->var;
|
|
|
|
if ($var instanceof PhpParser\Node\Expr\Variable
|
|
&& $var->name === substr($var_id, 1)
|
|
&& $var->getStartFilePos() === $var_start_loc
|
|
) {
|
|
return [$current_node, $search_level];
|
|
}
|
|
|
|
$rhs_exp = $current_node->expr;
|
|
$rhs_search_result = $this->findAssignExp($rhs_exp, $var_id, $var_start_loc, $search_level + 1);
|
|
return [$rhs_search_result[0], $rhs_search_result[1]];
|
|
} else {
|
|
return [null, $search_level];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param CodeLocation $var_loc
|
|
* @return bool
|
|
*/
|
|
private function checkIfVarRemoved(string $var_id, CodeLocation $var_loc): bool
|
|
{
|
|
return array_key_exists($var_id, $this->removed_unref_vars)
|
|
&& $this->removed_unref_vars[$var_id] === $var_loc;
|
|
}
|
|
|
|
/**
|
|
* @param array<PhpParser\Node\Stmt> $stmts
|
|
* @return void
|
|
*/
|
|
public function checkUnreferencedVars(array $stmts)
|
|
{
|
|
$source = $this->getSource();
|
|
$codebase = $source->getCodebase();
|
|
$function_storage = $source instanceof FunctionLikeAnalyzer ? $source->getFunctionLikeStorage($this) : null;
|
|
if ($codebase->alter_code) {
|
|
// Reverse array to deal with chain of assignments
|
|
$this->unused_var_locations = array_reverse($this->unused_var_locations);
|
|
}
|
|
$var_list = array_column($this->unused_var_locations, 0);
|
|
$loc_list = array_column($this->unused_var_locations, 1);
|
|
$var_loc_map = array_combine($var_list, $loc_list);
|
|
|
|
$project_analyzer = $this->getProjectAnalyzer();
|
|
|
|
foreach ($this->unused_var_locations as $hash => list($var_id, $original_location)) {
|
|
if ($var_id === '$_' || isset($this->used_var_locations[$hash])) {
|
|
continue;
|
|
}
|
|
|
|
if ((!$function_storage
|
|
|| !array_key_exists(substr($var_id, 1), $function_storage->param_types))
|
|
&& !isset($this->byref_uses[$var_id])
|
|
&& !$this->isSuperGlobal($var_id)
|
|
) {
|
|
$issue = new UnusedVariable(
|
|
'Variable ' . $var_id . ' is never referenced',
|
|
$original_location
|
|
);
|
|
|
|
if ($codebase->alter_code
|
|
&& !$this->checkIfVarRemoved($var_id, $original_location)
|
|
&& isset($project_analyzer->getIssuesToFix()['UnusedVariable'])
|
|
&& !IssueBuffer::isSuppressed($issue, $this->getSuppressedIssues())
|
|
) {
|
|
$search_result = $this->findAssignStmt($stmts, $var_id, $original_location);
|
|
$assign_stmt = $search_result[0];
|
|
$assign_exp = $search_result[1];
|
|
$chain_assignment = false;
|
|
|
|
if (!is_null($assign_stmt) && !is_null($assign_exp)) {
|
|
// Check if we have to remove assignment statemnt as expression (i.e. just "$var = ")
|
|
|
|
// Consider chain of assignments
|
|
/** @var PhpParser\Node\Expr\Assign | PhpParser\Node\Expr\AssignOp |
|
|
PhpParser\Node\Expr\AssignRef $assign_exp */
|
|
/** @var PhpParser\Node\Expr $rhs_exp */
|
|
$rhs_exp = $assign_exp->expr;
|
|
if ($rhs_exp instanceof PhpParser\Node\Expr\Assign
|
|
|| $rhs_exp instanceof PhpParser\Node\Expr\AssignOp
|
|
|| $rhs_exp instanceof PhpParser\Node\Expr\AssignRef
|
|
) {
|
|
$chain_assignment = true;
|
|
$removable_stmt = $this->checkRemovableChainAssignment($assign_exp, $var_loc_map);
|
|
} else {
|
|
$removable_stmt = true;
|
|
}
|
|
|
|
if ($removable_stmt) {
|
|
$traverser = new PhpParser\NodeTraverser();
|
|
$visitor = new CheckTrivialExprVisitor();
|
|
$traverser->addVisitor($visitor);
|
|
$traverser->traverse([$rhs_exp]);
|
|
|
|
$rhs_exp_trivial = (count($visitor->getNonTrivialExpr()) == 0);
|
|
|
|
if ($rhs_exp_trivial) {
|
|
$treat_as_expr = false;
|
|
} else {
|
|
$treat_as_expr = true;
|
|
}
|
|
} else {
|
|
$treat_as_expr = true;
|
|
}
|
|
|
|
if ($treat_as_expr) {
|
|
$is_assign_ref = $assign_exp instanceof PhpParser\Node\Expr\AssignRef;
|
|
$new_file_manipulation = $this->getPartialRemovalBounds(
|
|
$original_location,
|
|
$assign_stmt->getEndFilePos(),
|
|
$is_assign_ref
|
|
);
|
|
$this->removed_unref_vars[$var_id] = $original_location;
|
|
} else {
|
|
// Remove whole assignment statement
|
|
$new_file_manipulation = new FileManipulation(
|
|
$assign_stmt->getStartFilePos(),
|
|
$assign_stmt->getEndFilePos() + 1,
|
|
"",
|
|
false,
|
|
true
|
|
);
|
|
|
|
// If statement we are removing is a chain of assignments, mark other variables as removed
|
|
if ($chain_assignment) {
|
|
$this->markRemovedChainAssignVar($assign_exp, $var_loc_map);
|
|
} else {
|
|
$this->removed_unref_vars[$var_id] = $original_location;
|
|
}
|
|
}
|
|
|
|
FileManipulationBuffer::add($original_location->file_path, [$new_file_manipulation]);
|
|
} elseif (!is_null($assign_exp)) {
|
|
$is_assign_ref = $assign_exp instanceof PhpParser\Node\Expr\AssignRef;
|
|
$new_file_manipulation = $this->getPartialRemovalBounds(
|
|
$original_location,
|
|
$assign_exp->getEndFilePos(),
|
|
$is_assign_ref
|
|
);
|
|
|
|
FileManipulationBuffer::add($original_location->file_path, [$new_file_manipulation]);
|
|
$this->removed_unref_vars[$var_id] = $original_location;
|
|
}
|
|
}
|
|
|
|
if (IssueBuffer::accepts(
|
|
$issue,
|
|
$this->getSuppressedIssues()
|
|
)) {
|
|
// fall through
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return void
|
|
*/
|
|
private function analyzeUnset(PhpParser\Node\Stmt\Unset_ $stmt, Context $context)
|
|
{
|
|
$context->inside_unset = true;
|
|
|
|
foreach ($stmt->vars as $var) {
|
|
ExpressionAnalyzer::analyze($this, $var, $context);
|
|
|
|
$var_id = ExpressionAnalyzer::getArrayVarId(
|
|
$var,
|
|
$this->getFQCLN(),
|
|
$this
|
|
);
|
|
|
|
if ($var_id) {
|
|
$context->remove($var_id);
|
|
}
|
|
|
|
if ($var instanceof PhpParser\Node\Expr\ArrayDimFetch && $var->dim) {
|
|
$root_var_id = ExpressionAnalyzer::getArrayVarId(
|
|
$var->var,
|
|
$this->getFQCLN(),
|
|
$this
|
|
);
|
|
|
|
if ($root_var_id && isset($context->vars_in_scope[$root_var_id])) {
|
|
$root_type = clone $context->vars_in_scope[$root_var_id];
|
|
|
|
foreach ($root_type->getTypes() as $atomic_root_type) {
|
|
if ($atomic_root_type instanceof Type\Atomic\ObjectLike) {
|
|
if ($var->dim instanceof PhpParser\Node\Scalar\String_
|
|
|| $var->dim instanceof PhpParser\Node\Scalar\LNumber
|
|
) {
|
|
if (isset($atomic_root_type->properties[$var->dim->value])) {
|
|
unset($atomic_root_type->properties[$var->dim->value]);
|
|
}
|
|
|
|
if (!$atomic_root_type->properties) {
|
|
if ($atomic_root_type->had_mixed_value) {
|
|
$root_type->addType(
|
|
new Type\Atomic\TArray([
|
|
new Type\Union([new Type\Atomic\TArrayKey]),
|
|
new Type\Union([new Type\Atomic\TMixed]),
|
|
])
|
|
);
|
|
} else {
|
|
$root_type->addType(
|
|
new Type\Atomic\TArray([
|
|
new Type\Union([new Type\Atomic\TEmpty]),
|
|
new Type\Union([new Type\Atomic\TEmpty]),
|
|
])
|
|
);
|
|
}
|
|
}
|
|
} else {
|
|
$atomic_root_type->sealed = false;
|
|
|
|
$root_type->addType(
|
|
$atomic_root_type->getGenericArrayType()
|
|
);
|
|
}
|
|
} elseif ($atomic_root_type instanceof Type\Atomic\TNonEmptyArray) {
|
|
$root_type->addType(
|
|
new Type\Atomic\TArray($atomic_root_type->type_params)
|
|
);
|
|
} elseif ($atomic_root_type instanceof Type\Atomic\TNonEmptyMixed) {
|
|
$root_type->addType(
|
|
new Type\Atomic\TMixed()
|
|
);
|
|
}
|
|
}
|
|
|
|
$context->vars_in_scope[$root_var_id] = $root_type;
|
|
|
|
$context->removeVarFromConflictingClauses(
|
|
$root_var_id,
|
|
$context->vars_in_scope[$root_var_id],
|
|
$this
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
$context->inside_unset = false;
|
|
}
|
|
|
|
/**
|
|
* @param PhpParser\Node\Stmt\Static_ $stmt
|
|
* @param Context $context
|
|
*
|
|
* @return false|null
|
|
*/
|
|
private function analyzeStatic(PhpParser\Node\Stmt\Static_ $stmt, Context $context)
|
|
{
|
|
$codebase = $this->getCodebase();
|
|
|
|
if ($context->mutation_free) {
|
|
if (IssueBuffer::accepts(
|
|
new \Psalm\Issue\ImpureStaticVariable(
|
|
'Cannot use a static variable in a mutation-free context',
|
|
new CodeLocation($this, $stmt)
|
|
),
|
|
$this->getSuppressedIssues()
|
|
)) {
|
|
// fall through
|
|
}
|
|
}
|
|
|
|
foreach ($stmt->vars as $var) {
|
|
if (!is_string($var->var->name)) {
|
|
continue;
|
|
}
|
|
|
|
$var_id = '$' . $var->var->name;
|
|
|
|
$doc_comment = $stmt->getDocComment();
|
|
|
|
$comment_type = null;
|
|
|
|
if ($doc_comment && $this->parsed_docblock) {
|
|
$var_comments = [];
|
|
|
|
try {
|
|
$var_comments = CommentAnalyzer::arrayToDocblocks(
|
|
$doc_comment,
|
|
$this->parsed_docblock,
|
|
$this->getSource(),
|
|
$this->getSource()->getAliases(),
|
|
$this->getSource()->getTemplateTypeMap()
|
|
);
|
|
} catch (\Psalm\Exception\IncorrectDocblockException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new \Psalm\Issue\MissingDocblockType(
|
|
(string)$e->getMessage(),
|
|
new CodeLocation($this, $var)
|
|
)
|
|
)) {
|
|
// fall through
|
|
}
|
|
} catch (DocblockParseException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
(string)$e->getMessage(),
|
|
new CodeLocation($this->getSource(), $var)
|
|
)
|
|
)) {
|
|
// fall through
|
|
}
|
|
}
|
|
|
|
foreach ($var_comments as $var_comment) {
|
|
if (!$var_comment->type) {
|
|
continue;
|
|
}
|
|
|
|
try {
|
|
$var_comment_type = ExpressionAnalyzer::fleshOutType(
|
|
$codebase,
|
|
$var_comment->type,
|
|
$context->self,
|
|
$context->self,
|
|
$this->getParentFQCLN()
|
|
);
|
|
|
|
$var_comment_type->setFromDocblock();
|
|
|
|
$var_comment_type->check(
|
|
$this,
|
|
new CodeLocation($this->getSource(), $var),
|
|
$this->getSuppressedIssues()
|
|
);
|
|
|
|
if ($codebase->alter_code
|
|
&& $var_comment->type_start
|
|
&& $var_comment->type_end
|
|
&& $var_comment->line_number
|
|
) {
|
|
$type_location = new CodeLocation\DocblockTypeLocation(
|
|
$this,
|
|
$var_comment->type_start,
|
|
$var_comment->type_end,
|
|
$var_comment->line_number
|
|
);
|
|
|
|
$codebase->classlikes->handleDocblockTypeInMigration(
|
|
$codebase,
|
|
$this,
|
|
$var_comment_type,
|
|
$type_location,
|
|
$context->calling_method_id
|
|
);
|
|
}
|
|
|
|
if (!$var_comment->var_id || $var_comment->var_id === $var_id) {
|
|
$comment_type = $var_comment_type;
|
|
continue;
|
|
}
|
|
|
|
$context->vars_in_scope[$var_comment->var_id] = $var_comment_type;
|
|
} catch (\UnexpectedValueException $e) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidDocblock(
|
|
(string)$e->getMessage(),
|
|
new CodeLocation($this, $var)
|
|
)
|
|
)) {
|
|
// fall through
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($comment_type) {
|
|
$context->byref_constraints[$var_id] = new \Psalm\Internal\ReferenceConstraint($comment_type);
|
|
}
|
|
}
|
|
|
|
if ($var->default) {
|
|
if (ExpressionAnalyzer::analyze($this, $var->default, $context) === false) {
|
|
return false;
|
|
}
|
|
|
|
if ($comment_type
|
|
&& isset($var->default->inferredType)
|
|
&& !TypeAnalyzer::isContainedBy(
|
|
$codebase,
|
|
$var->default->inferredType,
|
|
$comment_type
|
|
)
|
|
) {
|
|
if (IssueBuffer::accepts(
|
|
new \Psalm\Issue\ReferenceConstraintViolation(
|
|
$var_id . ' of type ' . $comment_type->getId() . ' cannot be assigned type '
|
|
. $var->default->inferredType->getId(),
|
|
new CodeLocation($this, $var)
|
|
)
|
|
)) {
|
|
// fall through
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($context->check_variables) {
|
|
$context->vars_in_scope[$var_id] = $comment_type ? clone $comment_type : Type::getMixed();
|
|
$context->vars_possibly_in_scope[$var_id] = true;
|
|
$context->assigned_var_ids[$var_id] = true;
|
|
$this->byref_uses[$var_id] = true;
|
|
|
|
$location = new CodeLocation($this, $var);
|
|
|
|
if ($context->collect_references) {
|
|
$context->unreferenced_vars[$var_id] = [$location->getHash() => $location];
|
|
}
|
|
|
|
$this->registerVariable(
|
|
$var_id,
|
|
$location,
|
|
$context->branch_point
|
|
);
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* @param PhpParser\Node\Expr $stmt
|
|
* @param ?array<string, Type\Union> $existing_class_constants
|
|
* @param string $fq_classlike_name
|
|
*
|
|
* @return Type\Union|null
|
|
*/
|
|
public static function getSimpleType(
|
|
\Psalm\Codebase $codebase,
|
|
PhpParser\Node\Expr $stmt,
|
|
\Psalm\Aliases $aliases,
|
|
\Psalm\FileSource $file_source = null,
|
|
array $existing_class_constants = null,
|
|
$fq_classlike_name = null
|
|
) {
|
|
if ($stmt instanceof PhpParser\Node\Expr\BinaryOp) {
|
|
if ($stmt instanceof PhpParser\Node\Expr\BinaryOp\Concat) {
|
|
$left = self::getSimpleType(
|
|
$codebase,
|
|
$stmt->left,
|
|
$aliases,
|
|
$file_source,
|
|
$existing_class_constants,
|
|
$fq_classlike_name
|
|
);
|
|
$right = self::getSimpleType(
|
|
$codebase,
|
|
$stmt->right,
|
|
$aliases,
|
|
$file_source,
|
|
$existing_class_constants,
|
|
$fq_classlike_name
|
|
);
|
|
|
|
if ($left
|
|
&& $right
|
|
&& $left->isSingleStringLiteral()
|
|
&& $right->isSingleStringLiteral()
|
|
) {
|
|
$result = $left->getSingleStringLiteral()->value . $right->getSingleStringLiteral()->value;
|
|
|
|
if (strlen($result) < 50) {
|
|
return Type::getString($result);
|
|
}
|
|
}
|
|
|
|
return Type::getString();
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Expr\BinaryOp\BooleanAnd
|
|
|| $stmt instanceof PhpParser\Node\Expr\BinaryOp\BooleanOr
|
|
|| $stmt instanceof PhpParser\Node\Expr\BinaryOp\LogicalAnd
|
|
|| $stmt instanceof PhpParser\Node\Expr\BinaryOp\LogicalOr
|
|
|| $stmt instanceof PhpParser\Node\Expr\BinaryOp\Equal
|
|
|| $stmt instanceof PhpParser\Node\Expr\BinaryOp\NotEqual
|
|
|| $stmt instanceof PhpParser\Node\Expr\BinaryOp\Identical
|
|
|| $stmt instanceof PhpParser\Node\Expr\BinaryOp\NotIdentical
|
|
|| $stmt instanceof PhpParser\Node\Expr\BinaryOp\Greater
|
|
|| $stmt instanceof PhpParser\Node\Expr\BinaryOp\GreaterOrEqual
|
|
|| $stmt instanceof PhpParser\Node\Expr\BinaryOp\Smaller
|
|
|| $stmt instanceof PhpParser\Node\Expr\BinaryOp\SmallerOrEqual
|
|
) {
|
|
return Type::getBool();
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Expr\BinaryOp\Coalesce) {
|
|
return null;
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Expr\BinaryOp\Spaceship) {
|
|
return Type::getInt();
|
|
}
|
|
|
|
$stmt->left->inferredType = self::getSimpleType(
|
|
$codebase,
|
|
$stmt->left,
|
|
$aliases,
|
|
$file_source,
|
|
$existing_class_constants,
|
|
$fq_classlike_name
|
|
);
|
|
$stmt->right->inferredType = self::getSimpleType(
|
|
$codebase,
|
|
$stmt->right,
|
|
$aliases,
|
|
$file_source,
|
|
$existing_class_constants,
|
|
$fq_classlike_name
|
|
);
|
|
|
|
if (!$stmt->left->inferredType || !$stmt->right->inferredType) {
|
|
return null;
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Expr\BinaryOp\Plus ||
|
|
$stmt instanceof PhpParser\Node\Expr\BinaryOp\Minus ||
|
|
$stmt instanceof PhpParser\Node\Expr\BinaryOp\Mod ||
|
|
$stmt instanceof PhpParser\Node\Expr\BinaryOp\Mul ||
|
|
$stmt instanceof PhpParser\Node\Expr\BinaryOp\Pow
|
|
) {
|
|
BinaryOpAnalyzer::analyzeNonDivArithmeticOp(
|
|
$file_source instanceof StatementsSource ? $file_source : null,
|
|
$stmt->left,
|
|
$stmt->right,
|
|
$stmt,
|
|
$result_type
|
|
);
|
|
|
|
if ($result_type) {
|
|
return $result_type;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Expr\BinaryOp\Div
|
|
&& ($stmt->left->inferredType->hasInt() || $stmt->left->inferredType->hasFloat())
|
|
&& ($stmt->right->inferredType->hasInt() || $stmt->right->inferredType->hasFloat())
|
|
) {
|
|
return Type::combineUnionTypes(Type::getFloat(), Type::getInt());
|
|
}
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Expr\ConstFetch) {
|
|
if (strtolower($stmt->name->parts[0]) === 'false') {
|
|
return Type::getFalse();
|
|
} elseif (strtolower($stmt->name->parts[0]) === 'true') {
|
|
return Type::getTrue();
|
|
} elseif (strtolower($stmt->name->parts[0]) === 'null') {
|
|
return Type::getNull();
|
|
} elseif ($stmt->name->parts[0] === '__NAMESPACE__') {
|
|
return Type::getString($aliases->namespace);
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Scalar\MagicConst\Namespace_) {
|
|
return Type::getString($aliases->namespace);
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Expr\ClassConstFetch) {
|
|
if ($stmt->class instanceof PhpParser\Node\Name
|
|
&& $stmt->name instanceof PhpParser\Node\Identifier
|
|
&& $fq_classlike_name
|
|
&& $stmt->class->parts !== ['static']
|
|
&& $stmt->class->parts !== ['parent']
|
|
) {
|
|
if (isset($existing_class_constants[$stmt->name->name])) {
|
|
if ($stmt->class->parts === ['self']) {
|
|
return clone $existing_class_constants[$stmt->name->name];
|
|
}
|
|
}
|
|
|
|
if ($stmt->class->parts === ['self']) {
|
|
$const_fq_class_name = $fq_classlike_name;
|
|
} else {
|
|
$const_fq_class_name = ClassLikeAnalyzer::getFQCLNFromNameObject(
|
|
$stmt->class,
|
|
$aliases
|
|
);
|
|
}
|
|
|
|
if (strtolower($const_fq_class_name) === strtolower($fq_classlike_name)
|
|
&& isset($existing_class_constants[$stmt->name->name])
|
|
) {
|
|
return clone $existing_class_constants[$stmt->name->name];
|
|
}
|
|
|
|
if (strtolower($stmt->name->name) === 'class') {
|
|
return Type::getLiteralClassString($const_fq_class_name);
|
|
}
|
|
|
|
if ($existing_class_constants === null) {
|
|
try {
|
|
$foreign_class_constants = $codebase->classlikes->getConstantsForClass(
|
|
$const_fq_class_name,
|
|
\ReflectionProperty::IS_PRIVATE
|
|
);
|
|
|
|
if (isset($foreign_class_constants[$stmt->name->name])) {
|
|
return clone $foreign_class_constants[$stmt->name->name];
|
|
}
|
|
|
|
return null;
|
|
} catch (\InvalidArgumentException $e) {
|
|
return null;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($stmt->name instanceof PhpParser\Node\Identifier && strtolower($stmt->name->name) === 'class') {
|
|
return Type::getClassString();
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Scalar\String_) {
|
|
return Type::getString(strlen($stmt->value) < 30 ? $stmt->value : null);
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Scalar\LNumber) {
|
|
return Type::getInt(false, $stmt->value);
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Scalar\DNumber) {
|
|
return Type::getFloat($stmt->value);
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Expr\Array_) {
|
|
if (count($stmt->items) === 0) {
|
|
return Type::getEmptyArray();
|
|
}
|
|
|
|
$item_key_type = null;
|
|
$item_value_type = null;
|
|
|
|
$property_types = [];
|
|
$class_strings = [];
|
|
|
|
$can_create_objectlike = true;
|
|
|
|
foreach ($stmt->items as $int_offset => $item) {
|
|
if ($item === null) {
|
|
continue;
|
|
}
|
|
|
|
$single_item_key_type = null;
|
|
|
|
if ($item->key) {
|
|
$single_item_key_type = self::getSimpleType(
|
|
$codebase,
|
|
$item->key,
|
|
$aliases,
|
|
$file_source,
|
|
$existing_class_constants,
|
|
$fq_classlike_name
|
|
);
|
|
|
|
if ($single_item_key_type) {
|
|
if ($item_key_type) {
|
|
$item_key_type = Type::combineUnionTypes(
|
|
$single_item_key_type,
|
|
$item_key_type,
|
|
$codebase,
|
|
false,
|
|
true,
|
|
30
|
|
);
|
|
} else {
|
|
$item_key_type = $single_item_key_type;
|
|
}
|
|
}
|
|
} else {
|
|
$item_key_type = Type::getInt();
|
|
}
|
|
|
|
if ($item_value_type && !$can_create_objectlike) {
|
|
continue;
|
|
}
|
|
|
|
$single_item_value_type = self::getSimpleType(
|
|
$codebase,
|
|
$item->value,
|
|
$aliases,
|
|
$file_source,
|
|
$existing_class_constants,
|
|
$fq_classlike_name
|
|
);
|
|
|
|
if (!$single_item_value_type) {
|
|
return null;
|
|
}
|
|
|
|
if ($item->key instanceof PhpParser\Node\Scalar\String_
|
|
|| $item->key instanceof PhpParser\Node\Scalar\LNumber
|
|
|| !$item->key
|
|
) {
|
|
if (count($property_types) <= 50) {
|
|
$property_types[$item->key ? $item->key->value : $int_offset] = $single_item_value_type;
|
|
} else {
|
|
$can_create_objectlike = false;
|
|
}
|
|
} else {
|
|
$dim_type = $single_item_key_type;
|
|
|
|
if (!$dim_type) {
|
|
return null;
|
|
}
|
|
|
|
$dim_atomic_types = $dim_type->getTypes();
|
|
|
|
if (count($dim_atomic_types) > 1 || $dim_type->hasMixed() || count($property_types) > 50) {
|
|
$can_create_objectlike = false;
|
|
} else {
|
|
$atomic_type = array_shift($dim_atomic_types);
|
|
|
|
if ($atomic_type instanceof Type\Atomic\TLiteralInt
|
|
|| $atomic_type instanceof Type\Atomic\TLiteralString
|
|
) {
|
|
if ($atomic_type instanceof Type\Atomic\TLiteralClassString) {
|
|
$class_strings[$atomic_type->value] = true;
|
|
}
|
|
|
|
$property_types[$atomic_type->value] = $single_item_value_type;
|
|
} else {
|
|
$can_create_objectlike = false;
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($item_value_type) {
|
|
$item_value_type = Type::combineUnionTypes(
|
|
$single_item_value_type,
|
|
$item_value_type,
|
|
$codebase,
|
|
false,
|
|
true,
|
|
30
|
|
);
|
|
} else {
|
|
$item_value_type = $single_item_value_type;
|
|
}
|
|
}
|
|
|
|
// if this array looks like an object-like array, let's return that instead
|
|
if ($item_value_type
|
|
&& $item_key_type
|
|
&& ($item_key_type->hasString() || $item_key_type->hasInt())
|
|
&& $can_create_objectlike
|
|
) {
|
|
$objectlike = new Type\Atomic\ObjectLike($property_types, $class_strings);
|
|
$objectlike->sealed = true;
|
|
return new Type\Union([$objectlike]);
|
|
}
|
|
|
|
if (!$item_key_type || !$item_value_type) {
|
|
return null;
|
|
}
|
|
|
|
return new Type\Union([
|
|
new Type\Atomic\TNonEmptyArray([
|
|
$item_key_type,
|
|
$item_value_type,
|
|
]),
|
|
]);
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Expr\Cast\Int_) {
|
|
return Type::getInt();
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Expr\Cast\Double) {
|
|
return Type::getFloat();
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Expr\Cast\Bool_) {
|
|
return Type::getBool();
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Expr\Cast\String_) {
|
|
return Type::getString();
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Expr\Cast\Object_) {
|
|
return Type::getObject();
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Expr\Cast\Array_) {
|
|
return Type::getArray();
|
|
}
|
|
|
|
if ($stmt instanceof PhpParser\Node\Expr\UnaryMinus || $stmt instanceof PhpParser\Node\Expr\UnaryPlus) {
|
|
$type_to_invert = self::getSimpleType(
|
|
$codebase,
|
|
$stmt->expr,
|
|
$aliases,
|
|
$file_source,
|
|
$existing_class_constants,
|
|
$fq_classlike_name
|
|
);
|
|
|
|
if (!$type_to_invert) {
|
|
return null;
|
|
}
|
|
|
|
foreach ($type_to_invert->getTypes() as $type_part) {
|
|
if ($type_part instanceof Type\Atomic\TLiteralInt
|
|
&& $stmt instanceof PhpParser\Node\Expr\UnaryMinus
|
|
) {
|
|
$type_part->value = -$type_part->value;
|
|
} elseif ($type_part instanceof Type\Atomic\TLiteralFloat
|
|
&& $stmt instanceof PhpParser\Node\Expr\UnaryMinus
|
|
) {
|
|
$type_part->value = -$type_part->value;
|
|
}
|
|
}
|
|
|
|
return $type_to_invert;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* @param PhpParser\Node\Stmt\Const_ $stmt
|
|
* @param Context $context
|
|
*
|
|
* @return void
|
|
*/
|
|
private function analyzeConstAssignment(PhpParser\Node\Stmt\Const_ $stmt, Context $context)
|
|
{
|
|
foreach ($stmt->consts as $const) {
|
|
ExpressionAnalyzer::analyze($this, $const->value, $context);
|
|
|
|
$this->setConstType(
|
|
$const->name->name,
|
|
isset($const->value->inferredType) ? $const->value->inferredType : Type::getMixed(),
|
|
$context
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param string $const_name
|
|
* @param bool $is_fully_qualified
|
|
* @param Context $context
|
|
*
|
|
* @return Type\Union|null
|
|
*/
|
|
public function getConstType(
|
|
$const_name,
|
|
$is_fully_qualified,
|
|
Context $context
|
|
) {
|
|
$aliased_constants = $this->getAliases()->constants;
|
|
|
|
if (isset($aliased_constants[$const_name])) {
|
|
$fq_const_name = $aliased_constants[$const_name];
|
|
} elseif ($is_fully_qualified) {
|
|
$fq_const_name = $const_name;
|
|
} else {
|
|
$fq_const_name = Type::getFQCLNFromString($const_name, $this->getAliases());
|
|
}
|
|
|
|
if ($fq_const_name) {
|
|
$const_name_parts = explode('\\', $fq_const_name);
|
|
$const_name = array_pop($const_name_parts);
|
|
$namespace_name = implode('\\', $const_name_parts);
|
|
$namespace_constants = NamespaceAnalyzer::getConstantsForNamespace(
|
|
$namespace_name,
|
|
\ReflectionProperty::IS_PUBLIC
|
|
);
|
|
|
|
if (isset($namespace_constants[$const_name])) {
|
|
return $namespace_constants[$const_name];
|
|
}
|
|
}
|
|
|
|
if ($context->hasVariable($fq_const_name, $this)) {
|
|
return $context->vars_in_scope[$fq_const_name];
|
|
}
|
|
|
|
$file_path = $this->getRootFilePath();
|
|
$codebase = $this->getCodebase();
|
|
|
|
$file_storage_provider = $codebase->file_storage_provider;
|
|
|
|
$file_storage = $file_storage_provider->get($file_path);
|
|
|
|
if (isset($file_storage->declaring_constants[$const_name])) {
|
|
$constant_file_path = $file_storage->declaring_constants[$const_name];
|
|
|
|
return $file_storage_provider->get($constant_file_path)->constants[$const_name];
|
|
}
|
|
|
|
if (isset($file_storage->declaring_constants[$fq_const_name])) {
|
|
$constant_file_path = $file_storage->declaring_constants[$fq_const_name];
|
|
|
|
return $file_storage_provider->get($constant_file_path)->constants[$fq_const_name];
|
|
}
|
|
|
|
return ConstFetchAnalyzer::getGlobalConstType($codebase, $fq_const_name, $const_name)
|
|
?? ConstFetchAnalyzer::getGlobalConstType($codebase, $const_name, $const_name);
|
|
}
|
|
|
|
/**
|
|
* @param string $const_name
|
|
* @param Type\Union $const_type
|
|
* @param Context $context
|
|
*
|
|
* @return void
|
|
*/
|
|
public function setConstType($const_name, Type\Union $const_type, Context $context)
|
|
{
|
|
$context->vars_in_scope[$const_name] = $const_type;
|
|
$context->constants[$const_name] = $const_type;
|
|
|
|
if ($this->source instanceof NamespaceAnalyzer) {
|
|
$this->source->setConstType($const_name, $const_type);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @param string $var_name
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function hasVariable($var_name)
|
|
{
|
|
return isset($this->all_vars[$var_name]);
|
|
}
|
|
|
|
/**
|
|
* @param string $var_id
|
|
* @param CodeLocation $location
|
|
* @param int|null $branch_point
|
|
*
|
|
* @return void
|
|
*/
|
|
public function registerVariable($var_id, CodeLocation $location, $branch_point)
|
|
{
|
|
$this->all_vars[$var_id] = $location;
|
|
|
|
if ($branch_point) {
|
|
$this->var_branch_points[$var_id] = $branch_point;
|
|
}
|
|
|
|
$this->registerVariableAssignment($var_id, $location);
|
|
}
|
|
|
|
/**
|
|
* @param string $var_id
|
|
* @param CodeLocation $location
|
|
*
|
|
* @return void
|
|
*/
|
|
public function registerVariableAssignment($var_id, CodeLocation $location)
|
|
{
|
|
$this->unused_var_locations[$location->getHash()] = [$var_id, $location];
|
|
}
|
|
|
|
/**
|
|
* @param array<string, CodeLocation> $locations
|
|
* @return void
|
|
*/
|
|
public function registerVariableUses(array $locations)
|
|
{
|
|
foreach ($locations as $hash => $_) {
|
|
unset($this->unused_var_locations[$hash]);
|
|
$this->used_var_locations[$hash] = true;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return array<string, array{0: string, 1: CodeLocation}>
|
|
*/
|
|
public function getUnusedVarLocations()
|
|
{
|
|
return $this->unused_var_locations;
|
|
}
|
|
|
|
/**
|
|
* The first appearance of the variable in this set of statements being evaluated
|
|
*
|
|
* @param string $var_id
|
|
*
|
|
* @return CodeLocation|null
|
|
*/
|
|
public function getFirstAppearance($var_id)
|
|
{
|
|
return isset($this->all_vars[$var_id]) ? $this->all_vars[$var_id] : null;
|
|
}
|
|
|
|
/**
|
|
* @param string $var_id
|
|
*
|
|
* @return int|null
|
|
*/
|
|
public function getBranchPoint($var_id)
|
|
{
|
|
return isset($this->var_branch_points[$var_id]) ? $this->var_branch_points[$var_id] : null;
|
|
}
|
|
|
|
/**
|
|
* @param string $var_id
|
|
* @param int $branch_point
|
|
*
|
|
* @return void
|
|
*/
|
|
public function addVariableInitialization($var_id, $branch_point)
|
|
{
|
|
$this->vars_to_initialize[$var_id] = $branch_point;
|
|
}
|
|
|
|
public function getFileAnalyzer() : FileAnalyzer
|
|
{
|
|
return $this->file_analyzer;
|
|
}
|
|
|
|
public function getCodebase() : Codebase
|
|
{
|
|
return $this->codebase;
|
|
}
|
|
|
|
/**
|
|
* @return array<string, FunctionAnalyzer>
|
|
*/
|
|
public function getFunctionAnalyzers()
|
|
{
|
|
return $this->function_analyzers;
|
|
}
|
|
|
|
/**
|
|
* @param PhpParser\Node\Expr $first_arg_value
|
|
*
|
|
* @return null|string
|
|
*/
|
|
public static function getConstName($first_arg_value, Codebase $codebase, Aliases $aliases)
|
|
{
|
|
$const_name = null;
|
|
|
|
if ($first_arg_value instanceof PhpParser\Node\Scalar\String_) {
|
|
$const_name = $first_arg_value->value;
|
|
} elseif (isset($first_arg_value->inferredType)) {
|
|
if ($first_arg_value->inferredType->isSingleStringLiteral()) {
|
|
$const_name = $first_arg_value->inferredType->getSingleStringLiteral()->value;
|
|
}
|
|
} else {
|
|
$simple_type = self::getSimpleType($codebase, $first_arg_value, $aliases);
|
|
if ($simple_type && $simple_type->isSingleStringLiteral()) {
|
|
$const_name = $simple_type->getSingleStringLiteral()->value;
|
|
}
|
|
}
|
|
|
|
return $const_name;
|
|
}
|
|
|
|
public function isSuperGlobal(string $var_id) : bool
|
|
{
|
|
return in_array(
|
|
$var_id,
|
|
[
|
|
'$GLOBALS',
|
|
'$_SERVER',
|
|
'$_GET',
|
|
'$_POST',
|
|
'$_FILES',
|
|
'$_COOKIE',
|
|
'$_SESSION',
|
|
'$_REQUEST',
|
|
'$_ENV',
|
|
'$http_response_header'
|
|
],
|
|
true
|
|
);
|
|
}
|
|
|
|
public function getGlobalType(string $var_id) : Type\Union
|
|
{
|
|
$config = Config::getInstance();
|
|
|
|
if (isset($config->globals[$var_id])) {
|
|
return Type::parseString($config->globals[$var_id]);
|
|
}
|
|
|
|
if ($var_id === '$argv') {
|
|
return new Type\Union([
|
|
new Type\Atomic\TArray([Type::getInt(), Type::getString()]),
|
|
]);
|
|
}
|
|
|
|
if ($var_id === '$argc') {
|
|
return Type::getInt();
|
|
}
|
|
|
|
if ($this->isSuperGlobal($var_id)) {
|
|
return Type::getArray();
|
|
}
|
|
|
|
return Type::getMixed();
|
|
}
|
|
|
|
/**
|
|
* @param array<string, bool> $byref_uses
|
|
* @return void
|
|
*/
|
|
public function setByRefUses(array $byref_uses)
|
|
{
|
|
$this->byref_uses = $byref_uses;
|
|
}
|
|
|
|
/**
|
|
* @return array<string, array<array-key, CodeLocation>>
|
|
*/
|
|
public function getUncaughtThrows(Context $context)
|
|
{
|
|
$uncaught_throws = [];
|
|
|
|
if ($context->collect_exceptions) {
|
|
if ($context->possibly_thrown_exceptions) {
|
|
$config = $this->codebase->config;
|
|
$ignored_exceptions = array_change_key_case(
|
|
$context->is_global ?
|
|
$config->ignored_exceptions_in_global_scope :
|
|
$config->ignored_exceptions
|
|
);
|
|
$ignored_exceptions_and_descendants = array_change_key_case(
|
|
$context->is_global ?
|
|
$config->ignored_exceptions_and_descendants_in_global_scope :
|
|
$config->ignored_exceptions_and_descendants
|
|
);
|
|
|
|
foreach ($context->possibly_thrown_exceptions as $possibly_thrown_exception => $codelocations) {
|
|
if (isset($ignored_exceptions[strtolower($possibly_thrown_exception)])) {
|
|
continue;
|
|
}
|
|
|
|
$is_expected = false;
|
|
|
|
foreach ($ignored_exceptions_and_descendants as $expected_exception => $_) {
|
|
if ($expected_exception === $possibly_thrown_exception
|
|
|| $this->codebase->classExtends($possibly_thrown_exception, $expected_exception)
|
|
) {
|
|
$is_expected = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!$is_expected) {
|
|
$uncaught_throws[$possibly_thrown_exception] = $codelocations;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return $uncaught_throws;
|
|
}
|
|
|
|
/**
|
|
* @return array{description:string, specials:array<string, array<int, string>>}|null
|
|
*/
|
|
public function getParsedDocblock() : ?array
|
|
{
|
|
return $this->parsed_docblock;
|
|
}
|
|
|
|
public function getFQCLN()
|
|
{
|
|
if ($this->fake_this_class) {
|
|
return $this->fake_this_class;
|
|
}
|
|
|
|
return parent::getFQCLN();
|
|
}
|
|
|
|
public function setFQCLN(string $fake_this_class) : void
|
|
{
|
|
$this->fake_this_class = $fake_this_class;
|
|
}
|
|
}
|