mirror of
https://github.com/danog/psalm.git
synced 2024-12-15 19:07:00 +01:00
1283 lines
52 KiB
PHP
1283 lines
52 KiB
PHP
<?php
|
|
namespace Psalm\Internal\Analyzer\Statements\Expression\Assignment;
|
|
|
|
use PhpParser;
|
|
use PhpParser\Node\Expr\PropertyFetch;
|
|
use PhpParser\Node\Stmt\PropertyProperty;
|
|
use Psalm\Internal\Analyzer\ClassAnalyzer;
|
|
use Psalm\Internal\Analyzer\ClassLikeAnalyzer;
|
|
use Psalm\Internal\Analyzer\NamespaceAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\ExpressionAnalyzer;
|
|
use Psalm\Internal\Analyzer\Statements\Expression\ExpressionIdentifier;
|
|
use Psalm\Internal\Analyzer\Statements\Expression\Fetch\InstancePropertyFetchAnalyzer;
|
|
use Psalm\Internal\Analyzer\StatementsAnalyzer;
|
|
use Psalm\Internal\Type\Comparator\UnionTypeComparator;
|
|
use Psalm\CodeLocation;
|
|
use Psalm\Context;
|
|
use Psalm\Issue\DeprecatedProperty;
|
|
use Psalm\Issue\ImplicitToStringCast;
|
|
use Psalm\Issue\ImpurePropertyAssignment;
|
|
use Psalm\Issue\InaccessibleProperty;
|
|
use Psalm\Issue\InternalProperty;
|
|
use Psalm\Issue\InvalidPropertyAssignment;
|
|
use Psalm\Issue\InvalidPropertyAssignmentValue;
|
|
use Psalm\Issue\LoopInvalidation;
|
|
use Psalm\Issue\MixedAssignment;
|
|
use Psalm\Issue\MixedPropertyAssignment;
|
|
use Psalm\Issue\MixedPropertyTypeCoercion;
|
|
use Psalm\Issue\NoInterfaceProperties;
|
|
use Psalm\Issue\NullPropertyAssignment;
|
|
use Psalm\Issue\PossiblyFalsePropertyAssignmentValue;
|
|
use Psalm\Issue\PossiblyInvalidPropertyAssignment;
|
|
use Psalm\Issue\PossiblyInvalidPropertyAssignmentValue;
|
|
use Psalm\Issue\PossiblyNullPropertyAssignment;
|
|
use Psalm\Issue\PossiblyNullPropertyAssignmentValue;
|
|
use Psalm\Issue\PropertyTypeCoercion;
|
|
use Psalm\Issue\UndefinedClass;
|
|
use Psalm\Issue\UndefinedPropertyAssignment;
|
|
use Psalm\Issue\UndefinedMagicPropertyAssignment;
|
|
use Psalm\Issue\UndefinedThisPropertyAssignment;
|
|
use Psalm\IssueBuffer;
|
|
use Psalm\Type;
|
|
use Psalm\Type\Atomic\TNamedObject;
|
|
use Psalm\Type\Atomic\TNull;
|
|
use Psalm\Type\Atomic\TObject;
|
|
use function count;
|
|
use function in_array;
|
|
use function strtolower;
|
|
use Psalm\Internal\Taint\TaintNode;
|
|
|
|
/**
|
|
* @internal
|
|
*/
|
|
class InstancePropertyAssignmentAnalyzer
|
|
{
|
|
/**
|
|
* @param StatementsAnalyzer $statements_analyzer
|
|
* @param PropertyFetch|PropertyProperty $stmt
|
|
* @param string $prop_name
|
|
* @param PhpParser\Node\Expr|null $assignment_value
|
|
* @param Type\Union $assignment_value_type
|
|
* @param Context $context
|
|
* @param bool $direct_assignment whether the variable is assigned explicitly
|
|
*
|
|
* @return false|null
|
|
*/
|
|
public static function analyze(
|
|
StatementsAnalyzer $statements_analyzer,
|
|
$stmt,
|
|
$prop_name,
|
|
$assignment_value,
|
|
Type\Union $assignment_value_type,
|
|
Context $context,
|
|
$direct_assignment = true
|
|
) {
|
|
$class_property_types = [];
|
|
|
|
$codebase = $statements_analyzer->getCodebase();
|
|
|
|
$property_exists = false;
|
|
|
|
$property_ids = [];
|
|
|
|
if ($stmt instanceof PropertyProperty) {
|
|
if (!$context->self || !$stmt->default) {
|
|
return null;
|
|
}
|
|
|
|
$property_id = $context->self . '::$' . $prop_name;
|
|
$property_ids[] = $property_id;
|
|
|
|
$property_exists = true;
|
|
|
|
try {
|
|
$class_property_type = $codebase->properties->getPropertyType(
|
|
$property_id,
|
|
true,
|
|
$statements_analyzer,
|
|
$context
|
|
);
|
|
} catch (\UnexpectedValueException $e) {
|
|
return false;
|
|
}
|
|
|
|
if ($class_property_type) {
|
|
$class_storage = $codebase->classlike_storage_provider->get($context->self);
|
|
|
|
$class_property_type = \Psalm\Internal\Type\TypeExpander::expandUnion(
|
|
$codebase,
|
|
clone $class_property_type,
|
|
$class_storage->name,
|
|
$class_storage->name,
|
|
$class_storage->parent_class
|
|
);
|
|
}
|
|
|
|
$class_property_types[] = $class_property_type ?: Type::getMixed();
|
|
|
|
$var_id = '$this->' . $prop_name;
|
|
} else {
|
|
if (ExpressionAnalyzer::analyze($statements_analyzer, $stmt->var, $context) === false) {
|
|
return false;
|
|
}
|
|
|
|
$lhs_type = $statements_analyzer->node_data->getType($stmt->var);
|
|
|
|
if ($lhs_type === null) {
|
|
return null;
|
|
}
|
|
|
|
$lhs_var_id = ExpressionIdentifier::getVarId(
|
|
$stmt->var,
|
|
$statements_analyzer->getFQCLN(),
|
|
$statements_analyzer
|
|
);
|
|
|
|
$var_id = ExpressionIdentifier::getVarId(
|
|
$stmt,
|
|
$statements_analyzer->getFQCLN(),
|
|
$statements_analyzer
|
|
);
|
|
|
|
if ($var_id) {
|
|
$context->assigned_var_ids[$var_id] = true;
|
|
|
|
if ($direct_assignment && isset($context->protected_var_ids[$var_id])) {
|
|
if (IssueBuffer::accepts(
|
|
new LoopInvalidation(
|
|
'Variable ' . $var_id . ' has already been assigned in a for/foreach loop',
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt->var)
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
// fall through
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($lhs_type->hasMixed()) {
|
|
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 ($stmt->name instanceof PhpParser\Node\Identifier) {
|
|
$codebase->analyzer->addMixedMemberName(
|
|
'$' . $stmt->name->name,
|
|
$context->calling_method_id ?: $statements_analyzer->getFileName()
|
|
);
|
|
}
|
|
|
|
if (IssueBuffer::accepts(
|
|
new MixedPropertyAssignment(
|
|
$lhs_var_id . ' of type mixed cannot be assigned to',
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt->var)
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
return false;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
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 ($lhs_type->isNull()) {
|
|
if (IssueBuffer::accepts(
|
|
new NullPropertyAssignment(
|
|
$lhs_var_id . ' of type null cannot be assigned to',
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt->var)
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
return false;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
if ($lhs_type->isNullable() && !$lhs_type->ignore_nullable_issues) {
|
|
if (IssueBuffer::accepts(
|
|
new PossiblyNullPropertyAssignment(
|
|
$lhs_var_id . ' with possibly null type \'' . $lhs_type . '\' cannot be assigned to',
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt->var)
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
$has_regular_setter = false;
|
|
|
|
$invalid_assignment_types = [];
|
|
|
|
$has_valid_assignment_type = false;
|
|
|
|
$lhs_atomic_types = $lhs_type->getAtomicTypes();
|
|
|
|
while ($lhs_atomic_types) {
|
|
$lhs_type_part = \array_pop($lhs_atomic_types);
|
|
|
|
if ($lhs_type_part instanceof Type\Atomic\TTemplateParam) {
|
|
$lhs_atomic_types = \array_merge(
|
|
$lhs_atomic_types,
|
|
$lhs_type_part->as->getAtomicTypes()
|
|
);
|
|
|
|
continue;
|
|
}
|
|
|
|
if ($lhs_type_part instanceof TNull) {
|
|
continue;
|
|
}
|
|
|
|
if ($lhs_type_part instanceof Type\Atomic\TFalse
|
|
&& $lhs_type->ignore_falsable_issues
|
|
&& count($lhs_type->getAtomicTypes()) > 1
|
|
) {
|
|
continue;
|
|
}
|
|
|
|
if (!$lhs_type_part instanceof TObject && !$lhs_type_part instanceof TNamedObject) {
|
|
$invalid_assignment_types[] = (string)$lhs_type_part;
|
|
|
|
continue;
|
|
}
|
|
|
|
$has_valid_assignment_type = true;
|
|
|
|
// stdClass and SimpleXMLElement are special cases where we cannot infer the return types
|
|
// but we don't want to throw an error
|
|
// Hack has a similar issue: https://github.com/facebook/hhvm/issues/5164
|
|
if ($lhs_type_part instanceof TObject ||
|
|
(
|
|
in_array(
|
|
strtolower($lhs_type_part->value),
|
|
['stdclass', 'simplexmlelement', 'dateinterval', 'domdocument', 'domnode'],
|
|
true
|
|
)
|
|
)
|
|
) {
|
|
if ($var_id) {
|
|
if ($lhs_type_part instanceof TNamedObject &&
|
|
strtolower($lhs_type_part->value) === 'stdclass'
|
|
) {
|
|
$context->vars_in_scope[$var_id] = $assignment_value_type;
|
|
} else {
|
|
$context->vars_in_scope[$var_id] = Type::getMixed();
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
if (ExpressionAnalyzer::isMock($lhs_type_part->value)) {
|
|
if ($var_id) {
|
|
$context->vars_in_scope[$var_id] = Type::getMixed();
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
$intersection_types = $lhs_type_part->getIntersectionTypes() ?: [];
|
|
|
|
$fq_class_name = $lhs_type_part->value;
|
|
|
|
$override_property_visibility = false;
|
|
|
|
$class_exists = false;
|
|
$interface_exists = false;
|
|
|
|
if (!$codebase->classExists($lhs_type_part->value)) {
|
|
if ($codebase->interfaceExists($lhs_type_part->value)) {
|
|
$interface_exists = true;
|
|
$interface_storage = $codebase->classlike_storage_provider->get(
|
|
strtolower($lhs_type_part->value)
|
|
);
|
|
|
|
$override_property_visibility = $interface_storage->override_property_visibility;
|
|
|
|
foreach ($intersection_types as $intersection_type) {
|
|
if ($intersection_type instanceof TNamedObject
|
|
&& $codebase->classExists($intersection_type->value)
|
|
) {
|
|
$fq_class_name = $intersection_type->value;
|
|
$class_exists = true;
|
|
break;
|
|
}
|
|
}
|
|
|
|
if (!$class_exists) {
|
|
if (IssueBuffer::accepts(
|
|
new NoInterfaceProperties(
|
|
'Interfaces cannot have properties',
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt),
|
|
$lhs_type_part->value
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
return null;
|
|
}
|
|
|
|
if (!$codebase->methods->methodExists(
|
|
new \Psalm\Internal\MethodIdentifier(
|
|
$fq_class_name,
|
|
'__set'
|
|
)
|
|
)) {
|
|
return null;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!$class_exists && !$interface_exists) {
|
|
if (IssueBuffer::accepts(
|
|
new UndefinedClass(
|
|
'Cannot set properties of undefined class ' . $lhs_type_part->value,
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt),
|
|
$lhs_type_part->value
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
// fall through
|
|
}
|
|
|
|
return null;
|
|
}
|
|
} else {
|
|
$class_exists = true;
|
|
}
|
|
|
|
$property_id = $fq_class_name . '::$' . $prop_name;
|
|
$property_ids[] = $property_id;
|
|
|
|
$has_magic_setter = false;
|
|
|
|
$set_method_id = new \Psalm\Internal\MethodIdentifier($fq_class_name, '__set');
|
|
|
|
if ((!$codebase->properties->propertyExists($property_id, false, $statements_analyzer, $context)
|
|
|| ($lhs_var_id !== '$this'
|
|
&& $fq_class_name !== $context->self
|
|
&& ClassLikeAnalyzer::checkPropertyVisibility(
|
|
$property_id,
|
|
$context,
|
|
$statements_analyzer,
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt),
|
|
$statements_analyzer->getSuppressedIssues(),
|
|
false
|
|
) !== true)
|
|
)
|
|
&& $codebase->methods->methodExists(
|
|
$set_method_id,
|
|
$context->calling_method_id,
|
|
$codebase->collect_locations
|
|
? new CodeLocation($statements_analyzer->getSource(), $stmt)
|
|
: null,
|
|
!$context->collect_initializations
|
|
&& !$context->collect_mutations
|
|
? $statements_analyzer
|
|
: null,
|
|
$statements_analyzer->getFilePath()
|
|
)
|
|
) {
|
|
$has_magic_setter = true;
|
|
$class_storage = $codebase->classlike_storage_provider->get($fq_class_name);
|
|
|
|
if ($var_id) {
|
|
if (isset($class_storage->pseudo_property_set_types['$' . $prop_name])) {
|
|
$class_property_types[] =
|
|
clone $class_storage->pseudo_property_set_types['$' . $prop_name];
|
|
|
|
$has_regular_setter = true;
|
|
$property_exists = true;
|
|
|
|
if (!$context->collect_initializations) {
|
|
self::taintProperty(
|
|
$statements_analyzer,
|
|
$stmt,
|
|
$property_id,
|
|
$class_storage,
|
|
$assignment_value_type,
|
|
$context
|
|
);
|
|
}
|
|
|
|
continue;
|
|
}
|
|
}
|
|
|
|
if ($assignment_value) {
|
|
if ($var_id) {
|
|
$context->removeVarFromConflictingClauses(
|
|
$var_id,
|
|
Type::getMixed(),
|
|
$statements_analyzer
|
|
);
|
|
|
|
unset($context->vars_in_scope[$var_id]);
|
|
}
|
|
|
|
$old_data_provider = $statements_analyzer->node_data;
|
|
|
|
$statements_analyzer->node_data = clone $statements_analyzer->node_data;
|
|
|
|
$fake_method_call = new PhpParser\Node\Expr\MethodCall(
|
|
$stmt->var,
|
|
new PhpParser\Node\Identifier('__set', $stmt->name->getAttributes()),
|
|
[
|
|
new PhpParser\Node\Arg(
|
|
new PhpParser\Node\Scalar\String_(
|
|
$prop_name,
|
|
$stmt->name->getAttributes()
|
|
)
|
|
),
|
|
new PhpParser\Node\Arg(
|
|
$assignment_value
|
|
)
|
|
]
|
|
);
|
|
|
|
$suppressed_issues = $statements_analyzer->getSuppressedIssues();
|
|
|
|
if (!in_array('PossiblyNullReference', $suppressed_issues, true)) {
|
|
$statements_analyzer->addSuppressedIssues(['PossiblyNullReference']);
|
|
}
|
|
|
|
\Psalm\Internal\Analyzer\Statements\Expression\Call\MethodCallAnalyzer::analyze(
|
|
$statements_analyzer,
|
|
$fake_method_call,
|
|
$context,
|
|
false
|
|
);
|
|
|
|
if (!in_array('PossiblyNullReference', $suppressed_issues, true)) {
|
|
$statements_analyzer->removeSuppressedIssues(['PossiblyNullReference']);
|
|
}
|
|
|
|
$statements_analyzer->node_data = $old_data_provider;
|
|
}
|
|
|
|
/*
|
|
* If we have an explicit list of all allowed magic properties on the class, and we're
|
|
* not in that list, fall through
|
|
*/
|
|
if (!$var_id || !$class_storage->sealed_properties) {
|
|
if (!$context->collect_initializations) {
|
|
self::taintProperty(
|
|
$statements_analyzer,
|
|
$stmt,
|
|
$property_id,
|
|
$class_storage,
|
|
$assignment_value_type,
|
|
$context
|
|
);
|
|
}
|
|
|
|
continue;
|
|
}
|
|
|
|
if (!$class_exists) {
|
|
if (IssueBuffer::accepts(
|
|
new UndefinedMagicPropertyAssignment(
|
|
'Magic instance property ' . $property_id . ' is not defined',
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt),
|
|
$property_id
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
// fall through
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!$class_exists) {
|
|
continue;
|
|
}
|
|
|
|
$has_regular_setter = true;
|
|
|
|
if ($stmt->var instanceof PhpParser\Node\Expr\Variable
|
|
&& $stmt->var->name === 'this'
|
|
&& $context->self
|
|
) {
|
|
$self_property_id = $context->self . '::$' . $prop_name;
|
|
|
|
if ($self_property_id !== $property_id
|
|
&& $codebase->properties->propertyExists(
|
|
$self_property_id,
|
|
false,
|
|
$statements_analyzer,
|
|
$context
|
|
)
|
|
) {
|
|
$property_id = $self_property_id;
|
|
}
|
|
}
|
|
|
|
if ($codebase->taint && !$context->collect_initializations) {
|
|
$class_storage = $codebase->classlike_storage_provider->get($fq_class_name);
|
|
|
|
self::taintProperty(
|
|
$statements_analyzer,
|
|
$stmt,
|
|
$property_id,
|
|
$class_storage,
|
|
$assignment_value_type,
|
|
$context
|
|
);
|
|
}
|
|
|
|
if (!$codebase->properties->propertyExists(
|
|
$property_id,
|
|
false,
|
|
$statements_analyzer,
|
|
$context,
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
|
)) {
|
|
if ($stmt->var instanceof PhpParser\Node\Expr\Variable && $stmt->var->name === 'this') {
|
|
// if this is a proper error, we'll see it on the first pass
|
|
if ($context->collect_mutations) {
|
|
continue;
|
|
}
|
|
|
|
if (IssueBuffer::accepts(
|
|
new UndefinedThisPropertyAssignment(
|
|
'Instance property ' . $property_id . ' is not defined',
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt),
|
|
$property_id
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
// fall through
|
|
}
|
|
} else {
|
|
if ($has_magic_setter) {
|
|
if (IssueBuffer::accepts(
|
|
new UndefinedMagicPropertyAssignment(
|
|
'Magic instance property ' . $property_id . ' is not defined',
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt),
|
|
$property_id
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
// fall through
|
|
}
|
|
} else {
|
|
if (IssueBuffer::accepts(
|
|
new UndefinedPropertyAssignment(
|
|
'Instance property ' . $property_id . ' is not defined',
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt),
|
|
$property_id
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
// fall through
|
|
}
|
|
}
|
|
}
|
|
|
|
continue;
|
|
}
|
|
|
|
if ($codebase->store_node_types
|
|
&& !$context->collect_initializations
|
|
&& !$context->collect_mutations
|
|
) {
|
|
$codebase->analyzer->addNodeReference(
|
|
$statements_analyzer->getFilePath(),
|
|
$stmt->name,
|
|
$property_id
|
|
);
|
|
}
|
|
|
|
$property_exists = true;
|
|
|
|
if (!$override_property_visibility) {
|
|
if (!$context->collect_mutations) {
|
|
if (ClassLikeAnalyzer::checkPropertyVisibility(
|
|
$property_id,
|
|
$context,
|
|
$statements_analyzer,
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
) === false) {
|
|
return false;
|
|
}
|
|
} else {
|
|
if (ClassLikeAnalyzer::checkPropertyVisibility(
|
|
$property_id,
|
|
$context,
|
|
$statements_analyzer,
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt),
|
|
$statements_analyzer->getSuppressedIssues(),
|
|
false
|
|
) !== true) {
|
|
continue;
|
|
}
|
|
}
|
|
}
|
|
|
|
$declaring_property_class = (string) $codebase->properties->getDeclaringClassForProperty(
|
|
$property_id,
|
|
false
|
|
);
|
|
|
|
if ($codebase->properties_to_rename) {
|
|
$declaring_property_id = strtolower($declaring_property_class) . '::$' . $prop_name;
|
|
|
|
foreach ($codebase->properties_to_rename as $original_property_id => $new_property_name) {
|
|
if ($declaring_property_id === $original_property_id) {
|
|
$file_manipulations = [
|
|
new \Psalm\FileManipulation(
|
|
(int) $stmt->name->getAttribute('startFilePos'),
|
|
(int) $stmt->name->getAttribute('endFilePos') + 1,
|
|
$new_property_name
|
|
)
|
|
];
|
|
|
|
\Psalm\Internal\FileManipulation\FileManipulationBuffer::add(
|
|
$statements_analyzer->getFilePath(),
|
|
$file_manipulations
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
$declaring_class_storage = $codebase->classlike_storage_provider->get($declaring_property_class);
|
|
|
|
if (isset($declaring_class_storage->properties[$prop_name])) {
|
|
$property_storage = $declaring_class_storage->properties[$prop_name];
|
|
|
|
if ($property_storage->deprecated) {
|
|
if (IssueBuffer::accepts(
|
|
new DeprecatedProperty(
|
|
$property_id . ' is marked deprecated',
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt),
|
|
$property_id
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
// fall through
|
|
}
|
|
}
|
|
|
|
if ($context->self && ! NamespaceAnalyzer::isWithin($context->self, $property_storage->internal)) {
|
|
if (IssueBuffer::accepts(
|
|
new InternalProperty(
|
|
$property_id . ' is internal to ' . $property_storage->internal
|
|
. ' but called from ' . $context->self,
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt),
|
|
$property_id
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
// fall through
|
|
}
|
|
}
|
|
|
|
self::trackPropertyImpurity(
|
|
$statements_analyzer,
|
|
$stmt,
|
|
$property_id,
|
|
$property_storage,
|
|
$declaring_class_storage,
|
|
$assignment_value_type,
|
|
$context
|
|
);
|
|
|
|
if (!$property_storage->readonly
|
|
&& !$context->collect_mutations
|
|
&& !$context->collect_initializations
|
|
&& isset($context->vars_in_scope[$lhs_var_id])
|
|
&& !$context->vars_in_scope[$lhs_var_id]->allow_mutations
|
|
) {
|
|
if ($context->mutation_free) {
|
|
if (IssueBuffer::accepts(
|
|
new ImpurePropertyAssignment(
|
|
'Cannot assign to a property from a mutation-free context',
|
|
new CodeLocation($statements_analyzer, $stmt)
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
// fall through
|
|
}
|
|
} elseif ($statements_analyzer->getSource()
|
|
instanceof \Psalm\Internal\Analyzer\FunctionLikeAnalyzer
|
|
&& $statements_analyzer->getSource()->track_mutations
|
|
) {
|
|
$statements_analyzer->getSource()->inferred_impure = true;
|
|
}
|
|
}
|
|
|
|
if ($property_storage->getter_method) {
|
|
$getter_id = $lhs_var_id . '->' . $property_storage->getter_method . '()';
|
|
|
|
unset($context->vars_in_scope[$getter_id]);
|
|
}
|
|
}
|
|
|
|
$class_property_type = $codebase->properties->getPropertyType(
|
|
$property_id,
|
|
true,
|
|
$statements_analyzer,
|
|
$context
|
|
);
|
|
|
|
if (!$class_property_type
|
|
|| (isset($declaring_class_storage->properties[$prop_name])
|
|
&& !$declaring_class_storage->properties[$prop_name]->type_location)
|
|
) {
|
|
if (!$class_property_type) {
|
|
$class_property_type = Type::getMixed();
|
|
}
|
|
|
|
$source_analyzer = $statements_analyzer->getSource()->getSource();
|
|
|
|
if ($lhs_var_id === '$this'
|
|
&& $source_analyzer instanceof ClassAnalyzer
|
|
) {
|
|
if (isset($source_analyzer->inferred_property_types[$prop_name])) {
|
|
$source_analyzer->inferred_property_types[$prop_name] = Type::combineUnionTypes(
|
|
$assignment_value_type,
|
|
$source_analyzer->inferred_property_types[$prop_name]
|
|
);
|
|
} else {
|
|
$source_analyzer->inferred_property_types[$prop_name] = $assignment_value_type;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!$class_property_type->isMixed()) {
|
|
$class_storage = $codebase->classlike_storage_provider->get($fq_class_name);
|
|
|
|
$class_property_type = \Psalm\Internal\Type\TypeExpander::expandUnion(
|
|
$codebase,
|
|
clone $class_property_type,
|
|
$fq_class_name,
|
|
$lhs_type_part,
|
|
$declaring_class_storage->parent_class,
|
|
true,
|
|
false,
|
|
$class_storage->final
|
|
);
|
|
|
|
$class_property_type = \Psalm\Internal\Codebase\Methods::localizeType(
|
|
$codebase,
|
|
$class_property_type,
|
|
$fq_class_name,
|
|
$declaring_property_class
|
|
);
|
|
|
|
if ($lhs_type_part instanceof Type\Atomic\TGenericObject) {
|
|
$class_property_type = InstancePropertyFetchAnalyzer::localizePropertyType(
|
|
$codebase,
|
|
$class_property_type,
|
|
$lhs_type_part,
|
|
$class_storage,
|
|
$declaring_class_storage
|
|
);
|
|
}
|
|
|
|
$assignment_value_type = \Psalm\Internal\Codebase\Methods::localizeType(
|
|
$codebase,
|
|
$assignment_value_type,
|
|
$fq_class_name,
|
|
$declaring_property_class
|
|
);
|
|
|
|
if (!$class_property_type->hasMixed() && $assignment_value_type->hasMixed()) {
|
|
if (IssueBuffer::accepts(
|
|
new MixedAssignment(
|
|
'Cannot assign' . ($var_id ? ' ' . $var_id . ' ' : ' ') . 'to a mixed type',
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
// fall through
|
|
}
|
|
}
|
|
}
|
|
|
|
$class_property_types[] = $class_property_type;
|
|
}
|
|
|
|
if ($invalid_assignment_types) {
|
|
$invalid_assignment_type = $invalid_assignment_types[0];
|
|
|
|
if (!$has_valid_assignment_type) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidPropertyAssignment(
|
|
$lhs_var_id . ' with non-object type \'' . $invalid_assignment_type .
|
|
'\' cannot treated as an object',
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt->var)
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
return false;
|
|
}
|
|
} else {
|
|
if (IssueBuffer::accepts(
|
|
new PossiblyInvalidPropertyAssignment(
|
|
$lhs_var_id . ' with possible non-object type \'' . $invalid_assignment_type .
|
|
'\' cannot treated as an object',
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt->var)
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (!$has_regular_setter) {
|
|
return null;
|
|
}
|
|
|
|
if ($var_id) {
|
|
if ($context->collect_initializations
|
|
&& $lhs_var_id === '$this'
|
|
) {
|
|
$assignment_value_type->initialized_class = $context->self;
|
|
}
|
|
|
|
// because we don't want to be assigning for property declarations
|
|
$context->vars_in_scope[$var_id] = $assignment_value_type;
|
|
}
|
|
}
|
|
|
|
if (!$property_exists) {
|
|
return null;
|
|
}
|
|
|
|
if ($assignment_value_type->hasMixed()) {
|
|
return null;
|
|
}
|
|
|
|
$invalid_assignment_value_types = [];
|
|
|
|
$has_valid_assignment_value_type = false;
|
|
|
|
if ($codebase->store_node_types
|
|
&& !$context->collect_initializations
|
|
&& !$context->collect_mutations
|
|
&& count($class_property_types) === 1
|
|
) {
|
|
$codebase->analyzer->addNodeType(
|
|
$statements_analyzer->getFilePath(),
|
|
$stmt->name,
|
|
$class_property_types[0]->getId()
|
|
);
|
|
}
|
|
|
|
foreach ($class_property_types as $class_property_type) {
|
|
if ($class_property_type->hasMixed()) {
|
|
continue;
|
|
}
|
|
|
|
$union_comparison_results = new \Psalm\Internal\Type\Comparator\TypeComparisonResult();
|
|
|
|
$type_match_found = UnionTypeComparator::isContainedBy(
|
|
$codebase,
|
|
$assignment_value_type,
|
|
$class_property_type,
|
|
true,
|
|
true,
|
|
$union_comparison_results
|
|
);
|
|
|
|
if ($type_match_found && $union_comparison_results->replacement_union_type) {
|
|
if ($var_id) {
|
|
$context->vars_in_scope[$var_id] = $union_comparison_results->replacement_union_type;
|
|
}
|
|
}
|
|
|
|
if ($union_comparison_results->type_coerced) {
|
|
if ($union_comparison_results->type_coerced_from_mixed) {
|
|
if (IssueBuffer::accepts(
|
|
new MixedPropertyTypeCoercion(
|
|
$var_id . ' expects \'' . $class_property_type->getId() . '\', '
|
|
. ' parent type `' . $assignment_value_type->getId() . '` provided',
|
|
new CodeLocation(
|
|
$statements_analyzer->getSource(),
|
|
$assignment_value ?: $stmt,
|
|
$context->include_location
|
|
),
|
|
$property_ids[0]
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
// keep soldiering on
|
|
}
|
|
} else {
|
|
if (IssueBuffer::accepts(
|
|
new PropertyTypeCoercion(
|
|
$var_id . ' expects \'' . $class_property_type->getId() . '\', '
|
|
. ' parent type \'' . $assignment_value_type->getId() . '\' provided',
|
|
new CodeLocation(
|
|
$statements_analyzer->getSource(),
|
|
$assignment_value ?: $stmt,
|
|
$context->include_location
|
|
),
|
|
$property_ids[0]
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
// keep soldiering on
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($union_comparison_results->to_string_cast) {
|
|
if (IssueBuffer::accepts(
|
|
new ImplicitToStringCast(
|
|
$var_id . ' expects \'' . $class_property_type . '\', '
|
|
. '\'' . $assignment_value_type . '\' provided with a __toString method',
|
|
new CodeLocation(
|
|
$statements_analyzer->getSource(),
|
|
$assignment_value ?: $stmt,
|
|
$context->include_location
|
|
)
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
// fall through
|
|
}
|
|
}
|
|
|
|
if (!$type_match_found && !$union_comparison_results->type_coerced) {
|
|
if (UnionTypeComparator::canBeContainedBy(
|
|
$codebase,
|
|
$assignment_value_type,
|
|
$class_property_type,
|
|
true,
|
|
true
|
|
)) {
|
|
$has_valid_assignment_value_type = true;
|
|
}
|
|
|
|
$invalid_assignment_value_types[] = $class_property_type->getId();
|
|
} else {
|
|
$has_valid_assignment_value_type = true;
|
|
}
|
|
|
|
if ($type_match_found) {
|
|
if (!$assignment_value_type->ignore_nullable_issues
|
|
&& $assignment_value_type->isNullable()
|
|
&& !$class_property_type->isNullable()
|
|
) {
|
|
if (IssueBuffer::accepts(
|
|
new PossiblyNullPropertyAssignmentValue(
|
|
$var_id . ' with non-nullable declared type \'' . $class_property_type .
|
|
'\' cannot be assigned nullable type \'' . $assignment_value_type . '\'',
|
|
new CodeLocation(
|
|
$statements_analyzer->getSource(),
|
|
$assignment_value ?: $stmt,
|
|
$context->include_location
|
|
),
|
|
$property_ids[0]
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
return false;
|
|
}
|
|
}
|
|
|
|
if (!$assignment_value_type->ignore_falsable_issues
|
|
&& $assignment_value_type->isFalsable()
|
|
&& !$class_property_type->hasBool()
|
|
&& !$class_property_type->hasScalar()
|
|
) {
|
|
if (IssueBuffer::accepts(
|
|
new PossiblyFalsePropertyAssignmentValue(
|
|
$var_id . ' with non-falsable declared type \'' . $class_property_type .
|
|
'\' cannot be assigned possibly false type \'' . $assignment_value_type . '\'',
|
|
new CodeLocation(
|
|
$statements_analyzer->getSource(),
|
|
$assignment_value ?: $stmt,
|
|
$context->include_location
|
|
),
|
|
$property_ids[0]
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if ($invalid_assignment_value_types) {
|
|
$invalid_class_property_type = $invalid_assignment_value_types[0];
|
|
|
|
if (!$has_valid_assignment_value_type) {
|
|
if (IssueBuffer::accepts(
|
|
new InvalidPropertyAssignmentValue(
|
|
$var_id . ' with declared type \'' . $invalid_class_property_type .
|
|
'\' cannot be assigned type \'' . $assignment_value_type->getId() . '\'',
|
|
new CodeLocation(
|
|
$statements_analyzer->getSource(),
|
|
$assignment_value ?: $stmt,
|
|
$context->include_location
|
|
),
|
|
$property_ids[0]
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
return false;
|
|
}
|
|
} else {
|
|
if (IssueBuffer::accepts(
|
|
new PossiblyInvalidPropertyAssignmentValue(
|
|
$var_id . ' with declared type \'' . $invalid_class_property_type .
|
|
'\' cannot be assigned possibly different type \'' .
|
|
$assignment_value_type->getId() . '\'',
|
|
new CodeLocation(
|
|
$statements_analyzer->getSource(),
|
|
$assignment_value ?: $stmt,
|
|
$context->include_location
|
|
),
|
|
$property_ids[0]
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
public static function trackPropertyImpurity(
|
|
StatementsAnalyzer $statements_analyzer,
|
|
PhpParser\Node\Expr\PropertyFetch $stmt,
|
|
string $property_id,
|
|
\Psalm\Storage\PropertyStorage $property_storage,
|
|
\Psalm\Storage\ClassLikeStorage $declaring_class_storage,
|
|
?Type\Union $assignment_value_type,
|
|
Context $context
|
|
): void {
|
|
$codebase = $statements_analyzer->getCodebase();
|
|
|
|
$stmt_var_type = $statements_analyzer->node_data->getType($stmt->var);
|
|
|
|
$property_var_pure_compatible = $stmt_var_type
|
|
&& $stmt_var_type->reference_free
|
|
&& $stmt_var_type->allow_mutations;
|
|
|
|
$appearing_property_class = $codebase->properties->getAppearingClassForProperty(
|
|
$property_id,
|
|
true
|
|
);
|
|
|
|
$project_analyzer = $statements_analyzer->getProjectAnalyzer();
|
|
|
|
if ($appearing_property_class && ($property_storage->readonly || $codebase->alter_code)) {
|
|
$can_set_readonly_property = $context->self
|
|
&& $context->calling_method_id
|
|
&& ($appearing_property_class === $context->self
|
|
|| $codebase->classExtends($context->self, $appearing_property_class))
|
|
&& (\strpos($context->calling_method_id, '::__construct')
|
|
|| \strpos($context->calling_method_id, '::unserialize')
|
|
|| \strpos($context->calling_method_id, '::__unserialize')
|
|
|| \strpos($context->calling_method_id, '::__clone')
|
|
|| $property_storage->allow_private_mutation
|
|
|| $property_var_pure_compatible);
|
|
|
|
if (!$can_set_readonly_property) {
|
|
if ($property_storage->readonly) {
|
|
if (IssueBuffer::accepts(
|
|
new InaccessibleProperty(
|
|
$property_id . ' is marked readonly',
|
|
new CodeLocation($statements_analyzer->getSource(), $stmt)
|
|
),
|
|
$statements_analyzer->getSuppressedIssues()
|
|
)) {
|
|
// fall through
|
|
}
|
|
} elseif (!$declaring_class_storage->mutation_free
|
|
&& isset($project_analyzer->getIssuesToFix()['MissingImmutableAnnotation'])
|
|
&& $statements_analyzer->getSource()
|
|
instanceof \Psalm\Internal\Analyzer\FunctionLikeAnalyzer
|
|
) {
|
|
$codebase->analyzer->addMutableClass($declaring_class_storage->name);
|
|
}
|
|
} elseif ($assignment_value_type
|
|
&& ($declaring_class_storage->mutation_free
|
|
|| $codebase->alter_code)
|
|
) {
|
|
$visitor = new \Psalm\Internal\TypeVisitor\ImmutablePropertyAssignmentVisitor(
|
|
$statements_analyzer,
|
|
$stmt
|
|
);
|
|
|
|
$visitor->traverse($assignment_value_type);
|
|
|
|
if (!$declaring_class_storage->mutation_free
|
|
&& $statements_analyzer->getSource()
|
|
instanceof \Psalm\Internal\Analyzer\FunctionLikeAnalyzer
|
|
&& $statements_analyzer->getSource()->track_mutations
|
|
&& $visitor->has_mutation
|
|
) {
|
|
$statements_analyzer->getSource()->inferred_has_mutation = true;
|
|
$statements_analyzer->getSource()->inferred_impure = true;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
public static function analyzeStatement(
|
|
StatementsAnalyzer $statements_analyzer,
|
|
PhpParser\Node\Stmt\Property $stmt,
|
|
Context $context
|
|
): void {
|
|
foreach ($stmt->props as $prop) {
|
|
if ($prop->default) {
|
|
ExpressionAnalyzer::analyze($statements_analyzer, $prop->default, $context);
|
|
|
|
if ($prop_default_type = $statements_analyzer->node_data->getType($prop->default)) {
|
|
if (self::analyze(
|
|
$statements_analyzer,
|
|
$prop,
|
|
$prop->name->name,
|
|
$prop->default,
|
|
$prop_default_type,
|
|
$context
|
|
) === false) {
|
|
// fall through
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
private static function taintProperty(
|
|
StatementsAnalyzer $statements_analyzer,
|
|
PhpParser\Node\Expr\PropertyFetch $stmt,
|
|
string $property_id,
|
|
\Psalm\Storage\ClassLikeStorage $class_storage,
|
|
Type\Union $assignment_value_type,
|
|
Context $context
|
|
) : void {
|
|
$codebase = $statements_analyzer->getCodebase();
|
|
|
|
if (!$codebase->taint
|
|
|| !$codebase->config->trackTaintsInPath($statements_analyzer->getFilePath())
|
|
) {
|
|
return;
|
|
}
|
|
|
|
$var_location = new CodeLocation($statements_analyzer->getSource(), $stmt->var);
|
|
$property_location = new CodeLocation($statements_analyzer->getSource(), $stmt);
|
|
|
|
if ($class_storage->specialize_instance) {
|
|
$var_id = ExpressionIdentifier::getArrayVarId(
|
|
$stmt->var,
|
|
null,
|
|
$statements_analyzer
|
|
);
|
|
|
|
$var_property_id = ExpressionIdentifier::getArrayVarId(
|
|
$stmt,
|
|
null,
|
|
$statements_analyzer
|
|
);
|
|
|
|
if ($var_id) {
|
|
if (\in_array('TaintedInput', $statements_analyzer->getSuppressedIssues())) {
|
|
$context->vars_in_scope[$var_id]->parent_nodes = [];
|
|
return;
|
|
}
|
|
|
|
$var_node = TaintNode::getForAssignment(
|
|
$var_id,
|
|
$var_location
|
|
);
|
|
|
|
$codebase->taint->addTaintNode($var_node);
|
|
|
|
$property_node = TaintNode::getForAssignment(
|
|
$var_property_id ?: $var_id . '->$property',
|
|
$property_location
|
|
);
|
|
|
|
$codebase->taint->addTaintNode($property_node);
|
|
|
|
$codebase->taint->addPath(
|
|
$property_node,
|
|
$var_node,
|
|
'property-assignment'
|
|
. ($stmt->name instanceof PhpParser\Node\Identifier ? '-' . $stmt->name : '')
|
|
);
|
|
|
|
if ($assignment_value_type->parent_nodes) {
|
|
foreach ($assignment_value_type->parent_nodes as $parent_node) {
|
|
$codebase->taint->addPath($parent_node, $property_node, '=');
|
|
}
|
|
}
|
|
|
|
$stmt_var_type = clone $context->vars_in_scope[$var_id];
|
|
|
|
if ($context->vars_in_scope[$var_id]->parent_nodes) {
|
|
foreach ($context->vars_in_scope[$var_id]->parent_nodes as $parent_node) {
|
|
$codebase->taint->addPath($parent_node, $var_node, '=');
|
|
}
|
|
}
|
|
|
|
$stmt_var_type->parent_nodes = [$var_node];
|
|
|
|
$context->vars_in_scope[$var_id] = $stmt_var_type;
|
|
}
|
|
} else {
|
|
if (\in_array('TaintedInput', $statements_analyzer->getSuppressedIssues())) {
|
|
$assignment_value_type->parent_nodes = [];
|
|
return;
|
|
}
|
|
|
|
|
|
$code_location = new CodeLocation($statements_analyzer->getSource(), $stmt);
|
|
|
|
$localized_property_node = new TaintNode(
|
|
$property_id . '-' . $code_location->file_name . ':' . $code_location->raw_file_start,
|
|
$property_id,
|
|
$code_location,
|
|
null
|
|
);
|
|
|
|
$codebase->taint->addTaintNode($localized_property_node);
|
|
|
|
$property_node = new TaintNode(
|
|
$property_id,
|
|
$property_id,
|
|
null,
|
|
null
|
|
);
|
|
|
|
$codebase->taint->addTaintNode($property_node);
|
|
|
|
$codebase->taint->addPath($localized_property_node, $property_node, 'property-assignment');
|
|
|
|
if ($assignment_value_type->parent_nodes) {
|
|
foreach ($assignment_value_type->parent_nodes as $parent_node) {
|
|
$codebase->taint->addPath($parent_node, $localized_property_node, '=');
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|