1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-16 11:26:55 +01:00
psalm/src/Psalm/Internal/Analyzer/Statements/Expression/AssignmentAnalyzer.php

999 lines
40 KiB
PHP
Raw Normal View History

2016-11-01 16:37:58 +01:00
<?php
2018-11-06 03:57:36 +01:00
namespace Psalm\Internal\Analyzer\Statements\Expression;
2016-11-01 16:37:58 +01:00
use PhpParser;
2018-11-06 03:57:36 +01:00
use Psalm\Internal\Analyzer\CommentAnalyzer;
use Psalm\Internal\Analyzer\Statements\Block\ForeachAnalyzer;
2018-11-06 03:57:36 +01:00
use Psalm\Internal\Analyzer\Statements\Expression\Assignment\ArrayAssignmentAnalyzer;
use Psalm\Internal\Analyzer\Statements\Expression\Assignment\PropertyAssignmentAnalyzer;
use Psalm\Internal\Analyzer\Statements\ExpressionAnalyzer;
use Psalm\Internal\Analyzer\StatementsAnalyzer;
use Psalm\Internal\Analyzer\TypeAnalyzer;
use Psalm\CodeLocation;
2016-11-01 16:37:58 +01:00
use Psalm\Context;
use Psalm\Exception\DocblockParseException;
use Psalm\Exception\IncorrectDocblockException;
use Psalm\Internal\FileManipulation\FileManipulationBuffer;
use Psalm\Issue\AssignmentToVoid;
use Psalm\Issue\ImpurePropertyAssignment;
use Psalm\Issue\InvalidArrayOffset;
use Psalm\Issue\InvalidDocblock;
2016-11-02 07:29:00 +01:00
use Psalm\Issue\InvalidScope;
use Psalm\Issue\LoopInvalidation;
use Psalm\Issue\MissingDocblockType;
use Psalm\Issue\MixedAssignment;
use Psalm\Issue\NoValue;
use Psalm\Issue\PossiblyUndefinedArrayOffset;
use Psalm\Issue\ReferenceConstraintViolation;
use Psalm\Issue\UnnecessaryVarAnnotation;
2016-11-02 07:29:00 +01:00
use Psalm\IssueBuffer;
2016-11-01 16:37:58 +01:00
use Psalm\Type;
use function is_string;
use function strpos;
use function strtolower;
2016-11-01 16:37:58 +01:00
/**
* @internal
*/
2018-11-06 03:57:36 +01:00
class AssignmentAnalyzer
2016-11-01 16:37:58 +01:00
{
/**
2018-11-11 18:01:14 +01:00
* @param StatementsAnalyzer $statements_analyzer
* @param PhpParser\Node\Expr $assign_var
2016-12-07 00:27:22 +01:00
* @param PhpParser\Node\Expr|null $assign_value This has to be null to support list destructuring
* @param Type\Union|null $assign_value_type
* @param Context $context
* @param ?PhpParser\Comment\Doc $doc_comment
2017-05-27 02:16:18 +02:00
*
2016-11-01 16:37:58 +01:00
* @return false|Type\Union
*/
public static function analyze(
2018-11-11 18:01:14 +01:00
StatementsAnalyzer $statements_analyzer,
2016-11-01 16:37:58 +01:00
PhpParser\Node\Expr $assign_var,
2017-05-05 03:57:26 +02:00
$assign_value,
$assign_value_type,
2016-11-01 16:37:58 +01:00
Context $context,
?PhpParser\Comment\Doc $doc_comment
2016-11-01 16:37:58 +01:00
) {
2018-11-06 03:57:36 +01:00
$var_id = ExpressionAnalyzer::getVarId(
2016-11-01 16:37:58 +01:00
$assign_var,
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFQCLN(),
$statements_analyzer
2016-11-01 16:37:58 +01:00
);
// gets a variable id that *may* contain array keys
2018-11-06 03:57:36 +01:00
$array_var_id = ExpressionAnalyzer::getArrayVarId(
2016-11-01 16:37:58 +01:00
$assign_var,
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFQCLN(),
$statements_analyzer
2016-11-01 16:37:58 +01:00
);
$var_comments = [];
$comment_type = null;
$comment_type_location = null;
$was_in_assignment = $context->inside_assignment;
$context->inside_assignment = true;
2018-11-11 18:01:14 +01:00
$codebase = $statements_analyzer->getCodebase();
2018-11-06 03:57:36 +01:00
$remove_taint = false;
2017-03-02 04:27:52 +01:00
if ($doc_comment) {
2018-11-11 18:01:14 +01:00
$file_path = $statements_analyzer->getRootFilePath();
$file_storage_provider = $codebase->file_storage_provider;
$file_storage = $file_storage_provider->get($file_path);
$template_type_map = $statements_analyzer->getTemplateTypeMap();
try {
2018-11-06 03:57:36 +01:00
$var_comments = CommentAnalyzer::getTypeFromComment(
$doc_comment,
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSource(),
$statements_analyzer->getAliases(),
$template_type_map,
2019-06-01 18:25:57 +02:00
$file_storage->type_aliases
);
} catch (IncorrectDocblockException $e) {
if (IssueBuffer::accepts(
new MissingDocblockType(
(string)$e->getMessage(),
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $assign_var)
)
)) {
// fall through
}
} catch (DocblockParseException $e) {
if (IssueBuffer::accepts(
new InvalidDocblock(
(string)$e->getMessage(),
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $assign_var)
)
)) {
// fall through
}
}
foreach ($var_comments as $var_comment) {
if ($var_comment->remove_taint) {
$remove_taint = true;
}
if (!$var_comment->type) {
continue;
}
try {
2018-11-06 03:57:36 +01:00
$var_comment_type = ExpressionAnalyzer::fleshOutType(
$codebase,
$var_comment->type,
$context->self,
$context->self,
$statements_analyzer->getParentFQCLN()
);
$var_comment_type->setFromDocblock();
2019-01-26 23:30:44 +01:00
$var_comment_type->check(
$statements_analyzer,
new CodeLocation($statements_analyzer->getSource(), $assign_var),
$statements_analyzer->getSuppressedIssues()
);
$type_location = null;
if ($var_comment->type_start
2019-06-01 18:25:57 +02:00
&& $var_comment->type_end
&& $var_comment->line_number
) {
2019-06-04 22:36:32 +02:00
$type_location = new CodeLocation\DocblockTypeLocation(
$statements_analyzer,
$var_comment->type_start,
$var_comment->type_end,
2019-06-05 06:00:42 +02:00
$var_comment->line_number
2019-06-04 22:36:32 +02:00
);
2019-06-01 18:25:57 +02:00
if ($codebase->alter_code) {
$codebase->classlikes->handleDocblockTypeInMigration(
$codebase,
$statements_analyzer,
$var_comment_type,
$type_location,
$context->calling_method_id
);
}
2019-06-01 18:25:57 +02:00
}
if (!$var_comment->var_id || $var_comment->var_id === $var_id) {
$comment_type = $var_comment_type;
$comment_type_location = $type_location;
continue;
}
if ($codebase->find_unused_variables
&& $type_location
&& isset($context->vars_in_scope[$var_comment->var_id])
&& $context->vars_in_scope[$var_comment->var_id]->getId() === $var_comment_type->getId()
) {
$project_analyzer = $statements_analyzer->getProjectAnalyzer();
if ($codebase->alter_code
&& isset($project_analyzer->getIssuesToFix()['UnnecessaryVarAnnotation'])
) {
FileManipulationBuffer::addVarAnnotationToRemove($type_location);
} elseif (IssueBuffer::accepts(
new UnnecessaryVarAnnotation(
'The @var annotation for ' . $var_comment->var_id . ' is unnecessary',
$type_location
)
)) {
// fall through
}
}
$context->vars_in_scope[$var_comment->var_id] = $var_comment_type;
} catch (\UnexpectedValueException $e) {
if (IssueBuffer::accepts(
new InvalidDocblock(
(string)$e->getMessage(),
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $assign_var)
)
)) {
// fall through
}
}
}
2017-03-02 04:27:52 +01:00
}
2016-11-01 16:37:58 +01:00
if ($array_var_id) {
unset($context->referenced_var_ids[$array_var_id]);
}
if ($assign_value) {
if ($var_id && $assign_value instanceof PhpParser\Node\Expr\Closure) {
foreach ($assign_value->uses as $closure_use) {
if ($closure_use->byRef
&& is_string($closure_use->var->name)
&& $var_id === '$' . $closure_use->var->name
) {
$context->vars_in_scope[$var_id] = Type::getClosure();
$context->vars_possibly_in_scope[$var_id] = true;
}
}
}
2016-11-01 16:37:58 +01:00
2018-11-11 18:01:14 +01:00
if (ExpressionAnalyzer::analyze($statements_analyzer, $assign_value, $context) === false) {
if ($var_id) {
if ($array_var_id) {
$context->removeDescendents($array_var_id, null, $assign_value_type);
}
// if we're not exiting immediately, make everything mixed
$context->vars_in_scope[$var_id] = $comment_type ?: Type::getMixed();
}
return false;
}
2016-11-01 16:37:58 +01:00
}
if ($comment_type && $comment_type_location) {
$temp_assign_value_type = $assign_value_type ?: ($assign_value->inferredType ?? null);
if ($codebase->find_unused_variables
&& $temp_assign_value_type
&& $array_var_id
&& $temp_assign_value_type->getId() === $comment_type->getId()
) {
if ($codebase->alter_code
&& isset($statements_analyzer->getProjectAnalyzer()->getIssuesToFix()['UnnecessaryVarAnnotation'])
) {
FileManipulationBuffer::addVarAnnotationToRemove($comment_type_location);
} elseif (IssueBuffer::accepts(
new UnnecessaryVarAnnotation(
'The @var annotation for ' . $array_var_id . ' is unnecessary',
$comment_type_location
)
)) {
// fall through
}
}
$assign_value_type = $comment_type;
2016-12-17 01:22:30 +01:00
} elseif (!$assign_value_type) {
if (isset($assign_value->inferredType)) {
$assign_value_type = $assign_value->inferredType;
} else {
$assign_value_type = Type::getMixed();
}
2016-11-01 16:37:58 +01:00
}
if ($array_var_id && isset($context->vars_in_scope[$array_var_id])) {
2017-04-02 21:26:10 +02:00
// removes dependennt vars from $context
$context->removeDescendents(
$array_var_id,
$context->vars_in_scope[$array_var_id],
$assign_value_type,
2018-11-11 18:01:14 +01:00
$statements_analyzer
2017-04-02 21:26:10 +02:00
);
} else {
2018-11-06 03:57:36 +01:00
$root_var_id = ExpressionAnalyzer::getRootVarId(
$assign_var,
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFQCLN(),
$statements_analyzer
);
if ($root_var_id && isset($context->vars_in_scope[$root_var_id])) {
$context->removeVarFromConflictingClauses(
$root_var_id,
$context->vars_in_scope[$root_var_id],
2018-11-11 18:01:14 +01:00
$statements_analyzer
);
}
}
2018-11-11 18:01:14 +01:00
$codebase = $statements_analyzer->getCodebase();
if ($assign_value_type->hasMixed()) {
$root_var_id = ExpressionAnalyzer::getRootVarId(
$assign_var,
$statements_analyzer->getFQCLN(),
$statements_analyzer
);
if (!$context->collect_initializations
&& !$context->collect_mutations
&& $statements_analyzer->getFilePath() === $statements_analyzer->getRootFilePath()
&& (!(($parent_source = $statements_analyzer->getSource())
instanceof \Psalm\Internal\Analyzer\FunctionLikeAnalyzer)
|| !$parent_source->getSource() instanceof \Psalm\Internal\Analyzer\TraitAnalyzer)
) {
$codebase->analyzer->incrementMixedCount($statements_analyzer->getFilePath());
}
if (!$assign_var instanceof PhpParser\Node\Expr\PropertyFetch
&& !strpos($root_var_id ?? '', '->')
&& !$comment_type
) {
if (IssueBuffer::accepts(
new MixedAssignment(
2019-03-16 17:53:54 +01:00
'Cannot assign' . ($var_id ? ' ' . $var_id . ' ' : ' ') . 'to a mixed type',
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $assign_var)
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
}
} else {
if (!$context->collect_initializations
&& !$context->collect_mutations
&& $statements_analyzer->getFilePath() === $statements_analyzer->getRootFilePath()
&& (!(($parent_source = $statements_analyzer->getSource())
instanceof \Psalm\Internal\Analyzer\FunctionLikeAnalyzer)
|| !$parent_source->getSource() instanceof \Psalm\Internal\Analyzer\TraitAnalyzer)
) {
$codebase->analyzer->incrementNonMixedCount($statements_analyzer->getFilePath());
}
if ($var_id
&& isset($context->byref_constraints[$var_id])
&& ($outer_constraint_type = $context->byref_constraints[$var_id]->type)
) {
2018-11-06 03:57:36 +01:00
if (!TypeAnalyzer::isContainedBy(
2018-02-01 06:50:01 +01:00
$codebase,
$assign_value_type,
$outer_constraint_type,
$assign_value_type->ignore_nullable_issues,
$assign_value_type->ignore_falsable_issues
)
) {
if (IssueBuffer::accepts(
new ReferenceConstraintViolation(
'Variable ' . $var_id . ' is limited to values of type '
. $context->byref_constraints[$var_id]->type
. ' because it is passed by reference, '
. $assign_value_type->getId() . ' type found',
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $assign_var)
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
}
}
}
if ($var_id === '$this' && IssueBuffer::accepts(
new InvalidScope(
'Cannot re-assign ' . $var_id,
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $assign_var)
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
return false;
}
if (isset($context->protected_var_ids[$var_id])) {
if (IssueBuffer::accepts(
new LoopInvalidation(
'Variable ' . $var_id . ' has already been assigned in a for/foreach loop',
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $assign_var)
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
}
2016-11-01 16:37:58 +01:00
if ($assign_var instanceof PhpParser\Node\Expr\Variable && is_string($assign_var->name) && $var_id) {
$context->vars_in_scope[$var_id] = $assign_value_type;
2016-11-01 16:37:58 +01:00
$context->vars_possibly_in_scope[$var_id] = true;
2017-11-25 17:21:45 +01:00
$context->assigned_var_ids[$var_id] = true;
$context->possibly_assigned_var_ids[$var_id] = true;
2018-11-11 18:01:14 +01:00
$location = new CodeLocation($statements_analyzer, $assign_var);
if ($context->collect_references) {
2018-06-17 02:01:33 +02:00
$context->unreferenced_vars[$var_id] = [$location->getHash() => $location];
}
2018-11-11 18:01:14 +01:00
if (!$statements_analyzer->hasVariable($var_id)) {
$statements_analyzer->registerVariable(
$var_id,
$location,
$context->branch_point
);
} else {
2018-11-11 18:01:14 +01:00
$statements_analyzer->registerVariableAssignment(
$var_id,
$location
);
}
if (isset($context->byref_constraints[$var_id])) {
2018-11-11 18:01:14 +01:00
$statements_analyzer->registerVariableUses([$location->getHash() => $location]);
}
2016-12-04 19:35:38 +01:00
} elseif ($assign_var instanceof PhpParser\Node\Expr\List_
|| $assign_var instanceof PhpParser\Node\Expr\Array_
2016-12-04 19:35:38 +01:00
) {
if (!$assign_value_type->hasArray()
&& !$assign_value_type->isMixed()
&& !$assign_value_type->hasArrayAccessInterface($codebase)
) {
if (IssueBuffer::accepts(
new InvalidArrayOffset(
'Cannot destructure non-array of type ' . $assign_value_type->getId(),
new CodeLocation($statements_analyzer->getSource(), $assign_var)
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
}
foreach ($assign_var->items as $offset => $assign_var_item) {
// $assign_var_item can be null e.g. list($a, ) = ['a', 'b']
if (!$assign_var_item) {
2016-11-01 16:37:58 +01:00
continue;
}
$var = $assign_var_item->value;
2016-11-01 19:32:19 +01:00
if ($assign_value instanceof PhpParser\Node\Expr\Array_
2018-01-14 00:33:32 +01:00
&& isset($assign_var_item->value->inferredType)
2016-11-01 19:32:19 +01:00
) {
self::analyze(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
2016-11-02 07:29:00 +01:00
$var,
2018-01-14 00:33:32 +01:00
$assign_var_item->value,
null,
2016-11-02 07:29:00 +01:00
$context,
$doc_comment
);
continue;
}
$list_var_id = ExpressionAnalyzer::getArrayVarId(
$var,
$statements_analyzer->getFQCLN(),
$statements_analyzer
);
$new_assign_type = null;
foreach ($assign_value_type->getTypes() as $assign_value_atomic_type) {
if ($assign_value_atomic_type instanceof Type\Atomic\ObjectLike
&& !$assign_var_item->key
&& isset($assign_value_atomic_type->properties[$offset]) // if object-like has int offsets
) {
$offset_type = $assign_value_atomic_type->properties[(string)$offset];
if ($offset_type->possibly_undefined) {
if (IssueBuffer::accepts(
new PossiblyUndefinedArrayOffset(
'Possibly undefined array key',
new CodeLocation($statements_analyzer->getSource(), $var)
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
$offset_type = clone $offset_type;
$offset_type->possibly_undefined = false;
}
self::analyze(
$statements_analyzer,
$var,
null,
$offset_type,
$context,
$doc_comment
);
continue 2;
}
if ($var instanceof PhpParser\Node\Expr\List_
|| $var instanceof PhpParser\Node\Expr\Array_
) {
if ($assign_value_atomic_type instanceof Type\Atomic\ObjectLike) {
$assign_value_atomic_type = $assign_value_atomic_type->getGenericArrayType();
}
if ($assign_value_atomic_type instanceof Type\Atomic\TList) {
$assign_value_atomic_type = new Type\Atomic\TArray([
Type::getInt(),
$assign_value_atomic_type->type_param
]);
}
2016-11-01 19:32:19 +01:00
self::analyze(
$statements_analyzer,
$var,
null,
$assign_value_atomic_type instanceof Type\Atomic\TArray
? clone $assign_value_atomic_type->type_params[1]
: Type::getMixed(),
$context,
$doc_comment
);
2018-03-21 13:48:30 +01:00
}
if ($list_var_id) {
$context->vars_possibly_in_scope[$list_var_id] = true;
$context->assigned_var_ids[$list_var_id] = true;
$context->possibly_assigned_var_ids[$list_var_id] = true;
2019-10-09 00:44:46 +02:00
$already_in_scope = isset($context->vars_in_scope[$var_id]);
if (strpos($list_var_id, '-') === false && strpos($list_var_id, '[') === false) {
$location = new CodeLocation($statements_analyzer, $var);
2016-11-01 16:37:58 +01:00
if ($context->collect_references) {
$context->unreferenced_vars[$list_var_id] = [$location->getHash() => $location];
}
if (!$statements_analyzer->hasVariable($list_var_id)) {
$statements_analyzer->registerVariable(
$list_var_id,
$location,
$context->branch_point
);
} else {
$statements_analyzer->registerVariableAssignment(
$list_var_id,
$location
);
}
if (isset($context->byref_constraints[$list_var_id])) {
$statements_analyzer->registerVariableUses([$location->getHash() => $location]);
}
}
if ($assign_value_atomic_type instanceof Type\Atomic\TArray) {
$new_assign_type = clone $assign_value_atomic_type->type_params[1];
} elseif ($assign_value_atomic_type instanceof Type\Atomic\TList) {
$new_assign_type = clone $assign_value_atomic_type->type_param;
} elseif ($assign_value_atomic_type instanceof Type\Atomic\ObjectLike) {
if ($assign_var_item->key
&& ($assign_var_item->key instanceof PhpParser\Node\Scalar\String_
|| $assign_var_item->key instanceof PhpParser\Node\Scalar\LNumber)
&& isset($assign_value_atomic_type->properties[$assign_var_item->key->value])
) {
$new_assign_type =
clone $assign_value_atomic_type->properties[$assign_var_item->key->value];
if ($new_assign_type->possibly_undefined) {
if (IssueBuffer::accepts(
new PossiblyUndefinedArrayOffset(
'Possibly undefined array key',
new CodeLocation($statements_analyzer->getSource(), $var)
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
$new_assign_type->possibly_undefined = false;
}
}
} elseif ($assign_value_atomic_type->hasArrayAccessInterface($codebase)) {
ForeachAnalyzer::getKeyValueParamsForTraversableObject(
$assign_value_atomic_type,
$codebase,
$array_access_key_type,
$array_access_value_type
);
$new_assign_type = $array_access_value_type;
}
if ($already_in_scope) {
// removes dependennt vars from $context
$context->removeDescendents(
$list_var_id,
$context->vars_in_scope[$list_var_id],
$new_assign_type,
$statements_analyzer
);
}
}
}
foreach ($var_comments as $var_comment) {
if (!$var_comment->type) {
continue;
}
try {
if ($var_comment->var_id === $list_var_id) {
$var_comment_type = ExpressionAnalyzer::fleshOutType(
$codebase,
$var_comment->type,
$context->self,
$context->self,
$statements_analyzer->getParentFQCLN()
);
$var_comment_type->setFromDocblock();
$new_assign_type = $var_comment_type;
break;
}
} catch (\UnexpectedValueException $e) {
if (IssueBuffer::accepts(
new InvalidDocblock(
(string)$e->getMessage(),
new CodeLocation($statements_analyzer->getSource(), $assign_var)
)
)) {
// fall through
}
}
}
if ($list_var_id) {
$context->vars_in_scope[$list_var_id] = $new_assign_type ?: Type::getMixed();
if ($context->error_suppressing) {
$context->vars_in_scope[$list_var_id]->addType(new Type\Atomic\TNull);
}
2016-11-01 16:37:58 +01:00
}
}
2016-11-02 07:29:00 +01:00
} elseif ($assign_var instanceof PhpParser\Node\Expr\ArrayDimFetch) {
2018-11-06 03:57:36 +01:00
ArrayAssignmentAnalyzer::analyze(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$assign_var,
$context,
$assign_value,
$assign_value_type
);
} elseif ($assign_var instanceof PhpParser\Node\Expr\PropertyFetch) {
if (!$assign_var->name instanceof PhpParser\Node\Identifier) {
// this can happen when the user actually means to type $this-><autocompleted>, but there's
// a variable on the next line
2018-11-11 18:01:14 +01:00
if (ExpressionAnalyzer::analyze($statements_analyzer, $assign_var->var, $context) === false) {
return false;
}
2018-11-11 18:01:14 +01:00
if (ExpressionAnalyzer::analyze($statements_analyzer, $assign_var->name, $context) === false) {
return false;
}
}
if ($assign_var->name instanceof PhpParser\Node\Identifier) {
$prop_name = $assign_var->name->name;
} elseif (isset($assign_var->name->inferredType)
&& $assign_var->name->inferredType->isSingleStringLiteral()
) {
$prop_name = $assign_var->name->inferredType->getSingleStringLiteral()->value;
} else {
$prop_name = null;
}
if ($prop_name) {
2018-11-06 03:57:36 +01:00
PropertyAssignmentAnalyzer::analyzeInstance(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$assign_var,
$prop_name,
$assign_value,
$assign_value_type,
$context
);
} else {
2018-11-11 18:01:14 +01:00
if (ExpressionAnalyzer::analyze($statements_analyzer, $assign_var->var, $context) === false) {
return false;
}
if (isset($assign_var->var->inferredType) && !$context->ignore_variable_property) {
$stmt_var_type = $assign_var->var->inferredType;
if ($stmt_var_type->hasObjectType()) {
foreach ($stmt_var_type->getTypes() as $type) {
if ($type instanceof Type\Atomic\TNamedObject) {
2019-04-27 23:38:24 +02:00
$codebase->analyzer->addMixedMemberName(
strtolower($type->value) . '::$',
$context->calling_method_id ?: $statements_analyzer->getFileName()
);
}
}
}
}
}
2016-11-01 16:37:58 +01:00
if ($var_id) {
$context->vars_possibly_in_scope[$var_id] = true;
}
$method_pure_compatible = !empty($assign_var->var->inferredType->external_mutation_free)
|| isset($assign_var->var->pure);
if (($context->mutation_free || $context->external_mutation_free)
&& !$method_pure_compatible
&& !$context->collect_mutations
&& !$context->collect_initializations
) {
if (IssueBuffer::accepts(
new ImpurePropertyAssignment(
'Cannot assign to a property from a mutation-free context',
new CodeLocation($statements_analyzer, $assign_var)
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
}
2016-11-02 07:29:00 +01:00
} elseif ($assign_var instanceof PhpParser\Node\Expr\StaticPropertyFetch &&
$assign_var->class instanceof PhpParser\Node\Name
2016-11-01 16:37:58 +01:00
) {
2018-11-11 18:01:14 +01:00
if (ExpressionAnalyzer::analyze($statements_analyzer, $assign_var, $context) === false) {
2016-11-01 16:37:58 +01:00
return false;
}
if ($context->check_classes) {
2018-11-06 03:57:36 +01:00
PropertyAssignmentAnalyzer::analyzeStatic(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$assign_var,
$assign_value,
$assign_value_type,
$context
);
}
2016-11-01 16:37:58 +01:00
if ($var_id) {
$context->vars_possibly_in_scope[$var_id] = true;
}
2016-11-01 16:37:58 +01:00
}
if ($var_id && isset($context->vars_in_scope[$var_id])) {
if ($context->vars_in_scope[$var_id]->isVoid()) {
if (IssueBuffer::accepts(
new AssignmentToVoid(
'Cannot assign ' . $var_id . ' to type void',
new CodeLocation($statements_analyzer->getSource(), $assign_var)
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
$context->vars_in_scope[$var_id] = Type::getNull();
if (!$was_in_assignment) {
$context->inside_assignment = false;
}
return $context->vars_in_scope[$var_id];
2016-11-01 16:37:58 +01:00
}
if ($context->vars_in_scope[$var_id]->isNever()) {
if (IssueBuffer::accepts(
new NoValue(
'This function or method call never returns output',
new CodeLocation($statements_analyzer->getSource(), $assign_var)
),
$statements_analyzer->getSuppressedIssues()
)) {
return false;
}
$context->vars_in_scope[$var_id] = Type::getEmpty();
if (!$was_in_assignment) {
$context->inside_assignment = false;
}
return $context->vars_in_scope[$var_id];
}
if ($remove_taint && $context->vars_in_scope[$var_id]->sources) {
$context->vars_in_scope[$var_id]->sources = null;
$context->vars_in_scope[$var_id]->tainted = null;
}
2016-11-01 16:37:58 +01:00
}
if (!$was_in_assignment) {
$context->inside_assignment = false;
}
return $assign_value_type;
2016-11-01 16:37:58 +01:00
}
/**
2018-11-11 18:01:14 +01:00
* @param StatementsAnalyzer $statements_analyzer
2016-11-02 07:29:00 +01:00
* @param PhpParser\Node\Expr\AssignOp $stmt
* @param Context $context
2017-05-27 02:16:18 +02:00
*
2016-11-02 07:29:00 +01:00
* @return false|null
2016-11-01 16:37:58 +01:00
*/
public static function analyzeAssignmentOperation(
2018-11-11 18:01:14 +01:00
StatementsAnalyzer $statements_analyzer,
2016-11-01 16:37:58 +01:00
PhpParser\Node\Expr\AssignOp $stmt,
Context $context
) {
$was_in_assignment = $context->inside_assignment;
$context->inside_assignment = true;
2018-11-11 18:01:14 +01:00
if (ExpressionAnalyzer::analyze($statements_analyzer, $stmt->var, $context) === false) {
2016-11-01 16:37:58 +01:00
return false;
}
2018-11-11 18:01:14 +01:00
if (ExpressionAnalyzer::analyze($statements_analyzer, $stmt->expr, $context) === false) {
2016-11-13 21:39:16 +01:00
return false;
}
2018-11-06 03:57:36 +01:00
$array_var_id = ExpressionAnalyzer::getArrayVarId(
2016-11-13 21:39:16 +01:00
$stmt->var,
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFQCLN(),
$statements_analyzer
2016-11-13 21:39:16 +01:00
);
if ($array_var_id
&& $context->mutation_free
&& $stmt->var instanceof PhpParser\Node\Expr\PropertyFetch
&& isset($stmt->var->var->inferredType)
&& (!$stmt->var->var->inferredType->external_mutation_free
|| $stmt->var->var->inferredType->mutation_free)
) {
if (IssueBuffer::accepts(
new ImpurePropertyAssignment(
2019-09-03 18:16:31 +02:00
'Cannot assign to a property from a mutation-free context',
new CodeLocation($statements_analyzer, $stmt->var)
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
}
if ($array_var_id && $context->collect_references && $stmt->var instanceof PhpParser\Node\Expr\Variable) {
2018-11-11 18:01:14 +01:00
$location = new CodeLocation($statements_analyzer, $stmt->var);
$context->assigned_var_ids[$array_var_id] = true;
$context->possibly_assigned_var_ids[$array_var_id] = true;
2018-11-11 18:01:14 +01:00
$statements_analyzer->registerVariableAssignment(
$array_var_id,
$location
);
$context->unreferenced_vars[$array_var_id] = [$location->getHash() => $location];
}
2016-11-13 21:39:16 +01:00
$var_type = isset($stmt->var->inferredType) ? clone $stmt->var->inferredType : null;
$expr_type = isset($stmt->expr->inferredType) ? $stmt->expr->inferredType : null;
if ($stmt instanceof PhpParser\Node\Expr\AssignOp\Plus
|| $stmt instanceof PhpParser\Node\Expr\AssignOp\Minus
|| $stmt instanceof PhpParser\Node\Expr\AssignOp\Mod
|| $stmt instanceof PhpParser\Node\Expr\AssignOp\Mul
|| $stmt instanceof PhpParser\Node\Expr\AssignOp\Pow
) {
BinaryOpAnalyzer::analyzeNonDivArithmeticOp(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$stmt->var,
$stmt->expr,
$stmt,
2017-09-07 03:44:26 +02:00
$result_type,
$context
);
2016-11-13 21:39:16 +01:00
if ($stmt->var instanceof PhpParser\Node\Expr\ArrayDimFetch) {
2018-11-06 03:57:36 +01:00
ArrayAssignmentAnalyzer::analyze(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$stmt->var,
$context,
$stmt->expr,
$result_type ?: Type::getMixed($context->inside_loop)
);
} elseif ($result_type && $array_var_id) {
$context->vars_in_scope[$array_var_id] = $result_type;
$stmt->inferredType = clone $context->vars_in_scope[$array_var_id];
2016-11-13 21:39:16 +01:00
}
} elseif ($stmt instanceof PhpParser\Node\Expr\AssignOp\Div
&& $var_type
&& $expr_type
2018-05-07 07:26:06 +02:00
&& $var_type->hasDefinitelyNumericType()
&& $expr_type->hasDefinitelyNumericType()
&& $array_var_id
) {
$context->vars_in_scope[$array_var_id] = Type::combineUnionTypes(Type::getFloat(), Type::getInt());
$stmt->inferredType = clone $context->vars_in_scope[$array_var_id];
} elseif ($stmt instanceof PhpParser\Node\Expr\AssignOp\Concat) {
2018-11-06 03:57:36 +01:00
BinaryOpAnalyzer::analyzeConcatOp(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$stmt->var,
$stmt->expr,
$context,
$result_type
);
if ($result_type && $array_var_id) {
$context->vars_in_scope[$array_var_id] = $result_type;
$stmt->inferredType = clone $context->vars_in_scope[$array_var_id];
}
} elseif (isset($stmt->var->inferredType)
&& isset($stmt->expr->inferredType)
&& ($stmt->var->inferredType->hasInt() || $stmt->expr->inferredType->hasInt())
&& ($stmt instanceof PhpParser\Node\Expr\AssignOp\BitwiseOr
|| $stmt instanceof PhpParser\Node\Expr\AssignOp\BitwiseXor
|| $stmt instanceof PhpParser\Node\Expr\AssignOp\BitwiseAnd
|| $stmt instanceof PhpParser\Node\Expr\AssignOp\ShiftLeft
|| $stmt instanceof PhpParser\Node\Expr\AssignOp\ShiftRight
)
) {
BinaryOpAnalyzer::analyzeNonDivArithmeticOp(
$statements_analyzer,
$stmt->var,
$stmt->expr,
$stmt,
$result_type,
$context
);
if ($result_type && $array_var_id) {
$context->vars_in_scope[$array_var_id] = $result_type;
$stmt->inferredType = clone $context->vars_in_scope[$array_var_id];
}
2016-11-13 21:39:16 +01:00
}
2019-08-13 20:07:45 +02:00
if (!$was_in_assignment) {
$context->inside_assignment = false;
}
2016-11-13 21:39:16 +01:00
return null;
2016-11-01 16:37:58 +01:00
}
/**
2018-11-11 18:01:14 +01:00
* @param StatementsAnalyzer $statements_analyzer
* @param PhpParser\Node\Expr\AssignRef $stmt
* @param Context $context
2017-05-27 02:16:18 +02:00
*
* @return false|null
*/
public static function analyzeAssignmentRef(
2018-11-11 18:01:14 +01:00
StatementsAnalyzer $statements_analyzer,
PhpParser\Node\Expr\AssignRef $stmt,
Context $context
) {
$assignment_type = self::analyze(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$stmt->var,
$stmt->expr,
null,
$context,
$stmt->getDocComment()
);
if ($assignment_type === false) {
return false;
}
2018-11-06 03:57:36 +01:00
$lhs_var_id = ExpressionAnalyzer::getVarId(
$stmt->var,
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFQCLN(),
$statements_analyzer
);
2018-11-06 03:57:36 +01:00
$rhs_var_id = ExpressionAnalyzer::getVarId(
$stmt->expr,
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFQCLN(),
$statements_analyzer
);
if ($lhs_var_id) {
$context->vars_in_scope[$lhs_var_id] = $assignment_type;
$context->hasVariable($lhs_var_id, $statements_analyzer);
}
if ($rhs_var_id && !isset($context->vars_in_scope[$rhs_var_id])) {
$context->vars_in_scope[$rhs_var_id] = Type::getMixed();
}
}
2016-11-01 16:37:58 +01:00
}