1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-16 19:36:59 +01:00
psalm/src/Psalm/Checker/Statements/Expression/Assignment/PropertyAssignmentChecker.php
Matt Brown 543872f186 Allow @psalm-ignore-falsable-return annotation
Downgrades issues around use of current(), reset(), end() etc.
2018-01-24 18:52:58 -05:00

747 lines
29 KiB
PHP

<?php
namespace Psalm\Checker\Statements\Expression\Assignment;
use PhpParser;
use PhpParser\Node\Expr\PropertyFetch;
use PhpParser\Node\Stmt\PropertyProperty;
use Psalm\Checker\ClassChecker;
use Psalm\Checker\ClassLikeChecker;
use Psalm\Checker\InterfaceChecker;
use Psalm\Checker\MethodChecker;
use Psalm\Checker\Statements\ExpressionChecker;
use Psalm\Checker\StatementsChecker;
use Psalm\Checker\TypeChecker;
use Psalm\CodeLocation;
use Psalm\Context;
use Psalm\Issue\DeprecatedProperty;
use Psalm\Issue\ImplicitToStringCast;
use Psalm\Issue\InvalidPropertyAssignment;
use Psalm\Issue\InvalidPropertyAssignmentValue;
use Psalm\Issue\LoopInvalidation;
use Psalm\Issue\MixedPropertyAssignment;
use Psalm\Issue\MixedTypeCoercion;
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\TypeCoercion;
use Psalm\Issue\UndefinedClass;
use Psalm\Issue\UndefinedPropertyAssignment;
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;
class PropertyAssignmentChecker
{
/**
* @param StatementsChecker $statements_checker
* @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 explictly
*
* @return false|null
*/
public static function analyzeInstance(
StatementsChecker $statements_checker,
$stmt,
$prop_name,
$assignment_value,
Type\Union $assignment_value_type,
Context $context,
$direct_assignment = true
) {
$class_property_types = [];
$project_checker = $statements_checker->getFileChecker()->project_checker;
$property_exists = false;
if ($stmt instanceof PropertyProperty) {
if (!$context->self || !$stmt->default) {
return null;
}
$property_id = $context->self . '::$' . $prop_name;
if (!ClassLikeChecker::propertyExists($project_checker, $property_id)) {
return null;
}
$property_exists = true;
$declaring_property_class = ClassLikeChecker::getDeclaringClassForProperty($project_checker, $property_id);
$class_storage = $project_checker->classlike_storage_provider->get((string)$declaring_property_class);
$class_property_type = $class_storage->properties[$prop_name]->type;
$class_property_types[] = $class_property_type ? clone $class_property_type : Type::getMixed();
$var_id = '$this->' . $prop_name;
} else {
if (ExpressionChecker::analyze($statements_checker, $stmt->var, $context) === false) {
return false;
}
$lhs_type = isset($stmt->var->inferredType) ? $stmt->var->inferredType : null;
if ($lhs_type === null) {
return null;
}
$lhs_var_id = ExpressionChecker::getVarId(
$stmt->var,
$statements_checker->getFQCLN(),
$statements_checker
);
$var_id = ExpressionChecker::getVarId(
$stmt,
$statements_checker->getFQCLN(),
$statements_checker
);
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_checker->getSource(), $stmt->var)
),
$statements_checker->getSuppressedIssues()
)) {
// fall through
}
}
}
if ($lhs_type->isMixed()) {
if (IssueBuffer::accepts(
new MixedPropertyAssignment(
$lhs_var_id . ' of type mixed cannot be assigned to',
new CodeLocation($statements_checker->getSource(), $stmt->var)
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
return null;
}
if ($lhs_type->isNull()) {
if (IssueBuffer::accepts(
new NullPropertyAssignment(
$lhs_var_id . ' of type null cannot be assigned to',
new CodeLocation($statements_checker->getSource(), $stmt->var)
),
$statements_checker->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_checker->getSource(), $stmt->var)
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
}
$has_regular_setter = false;
$invalid_assignment_types = [];
$has_valid_assignment_type = false;
foreach ($lhs_type->getTypes() as $lhs_type_part) {
if ($lhs_type_part instanceof TNull) {
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 ||
(
$lhs_type_part instanceof TNamedObject &&
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 (ExpressionChecker::isMock($lhs_type_part->value)) {
$has_regular_setter = true;
if ($var_id) {
$context->vars_in_scope[$var_id] = Type::getMixed();
}
return null;
}
if (!ClassChecker::classExists($project_checker, $lhs_type_part->value)) {
if (InterfaceChecker::interfaceExists($project_checker, $lhs_type_part->value)) {
if (IssueBuffer::accepts(
new NoInterfaceProperties(
'Interfaces cannot have properties',
new CodeLocation($statements_checker->getSource(), $stmt)
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
return null;
}
if (IssueBuffer::accepts(
new UndefinedClass(
'Cannot set properties of undefined class ' . $lhs_type_part->value,
new CodeLocation($statements_checker->getSource(), $stmt)
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
return null;
}
if ($lhs_var_id !== '$this' &&
MethodChecker::methodExists($project_checker, $lhs_type_part->value . '::__set')
) {
$class_storage = $project_checker->classlike_storage_provider->get((string)$lhs_type_part);
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;
continue;
}
$context->vars_in_scope[$var_id] = Type::getMixed();
}
/*
* 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) {
continue;
}
}
$has_regular_setter = true;
$property_id = $lhs_type_part->value . '::$' . $prop_name;
if (!ClassLikeChecker::propertyExists($project_checker, $property_id)) {
$has_regular_setter = true;
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_checker->getSource(), $stmt)
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
} else {
if (IssueBuffer::accepts(
new UndefinedPropertyAssignment(
'Instance property ' . $property_id . ' is not defined',
new CodeLocation($statements_checker->getSource(), $stmt)
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
}
continue;
}
$property_exists = true;
if (!$context->collect_mutations) {
if (ClassLikeChecker::checkPropertyVisibility(
$property_id,
$context->self,
$statements_checker->getSource(),
new CodeLocation($statements_checker->getSource(), $stmt),
$statements_checker->getSuppressedIssues()
) === false) {
return false;
}
} else {
if (ClassLikeChecker::checkPropertyVisibility(
$property_id,
$context->self,
$statements_checker->getSource(),
new CodeLocation($statements_checker->getSource(), $stmt),
$statements_checker->getSuppressedIssues(),
false
) !== true) {
continue;
}
}
$declaring_property_class = ClassLikeChecker::getDeclaringClassForProperty(
$project_checker,
$lhs_type_part->value . '::$' . $prop_name
);
$class_storage = $project_checker->classlike_storage_provider->get((string)$declaring_property_class);
$property_storage = $class_storage->properties[$prop_name];
if ($property_storage->deprecated) {
if (IssueBuffer::accepts(
new DeprecatedProperty(
$property_id . ' is marked deprecated',
new CodeLocation($statements_checker->getSource(), $stmt)
),
$statements_checker->getSuppressedIssues()
)) {
// fall through
}
}
$class_property_type = $property_storage->type;
if ($class_property_type === false) {
$class_property_type = Type::getMixed();
if (!$assignment_value_type->isMixed()) {
if ($property_storage->suggested_type) {
$property_storage->suggested_type = Type::combineUnionTypes(
$assignment_value_type,
$property_storage->suggested_type
);
} else {
$property_storage->suggested_type =
$lhs_var_id === '$this' &&
($context->inside_constructor || $context->collect_initializations)
? $assignment_value_type
: Type::combineUnionTypes(Type::getNull(), $assignment_value_type);
}
}
} else {
$class_property_type = ExpressionChecker::fleshOutType(
$project_checker,
$class_property_type,
$lhs_type_part->value
);
}
$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_checker->getSource(), $stmt->var)
),
$statements_checker->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_checker->getSource(), $stmt->var)
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
}
}
if (!$has_regular_setter) {
return null;
}
if ($var_id) {
// because we don't want to be assigning for property declarations
$context->vars_in_scope[$var_id] = $assignment_value_type;
}
}
if ($var_id && count($class_property_types) === 1 && isset($class_property_types[0]->getTypes()['stdClass'])) {
$context->vars_in_scope[$var_id] = Type::getMixed();
return null;
}
if (!$property_exists) {
return null;
}
if ($assignment_value_type->isMixed()) {
return null;
}
$invalid_assignment_value_types = [];
$has_valid_assignment_value_type = false;
foreach ($class_property_types as $class_property_type) {
if ($class_property_type->isMixed()) {
continue;
}
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_checker->getSource(),
$assignment_value ?: $stmt,
$context->include_location
)
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
}
if (!$assignment_value_type->ignore_falsable_issues
&& $assignment_value_type->isFalsable()
&& !$class_property_type->hasBool()
) {
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_checker->getSource(),
$assignment_value ?: $stmt,
$context->include_location
)
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
}
$type_match_found = TypeChecker::isContainedBy(
$project_checker,
$assignment_value_type,
$class_property_type,
true,
true,
$has_scalar_match,
$type_coerced,
$type_coerced_from_mixed,
$to_string_cast
);
if ($type_coerced) {
if ($type_coerced_from_mixed) {
if (IssueBuffer::accepts(
new MixedTypeCoercion(
$var_id . ' expects \'' . $class_property_type . '\', '
. ' parent type `' . $assignment_value_type . '` provided',
new CodeLocation(
$statements_checker->getSource(),
$assignment_value ?: $stmt,
$context->include_location
)
),
$statements_checker->getSuppressedIssues()
)) {
// keep soldiering on
}
} else {
if (IssueBuffer::accepts(
new TypeCoercion(
$var_id . ' expects \'' . $class_property_type . '\', '
. ' parent type \'' . $assignment_value_type . '\' provided',
new CodeLocation(
$statements_checker->getSource(),
$assignment_value ?: $stmt,
$context->include_location
)
),
$statements_checker->getSuppressedIssues()
)) {
// keep soldiering on
}
}
}
if ($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_checker->getSource(),
$assignment_value ?: $stmt,
$context->include_location
)
),
$statements_checker->getSuppressedIssues()
)) {
// fall through
}
}
if (!$type_match_found && !$type_coerced) {
$invalid_assignment_value_types[] = (string) $class_property_type;
} else {
$has_valid_assignment_value_type = true;
}
}
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 . '\'',
new CodeLocation(
$statements_checker->getSource(),
$assignment_value ?: $stmt,
$context->include_location
)
),
$statements_checker->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 . '\'',
new CodeLocation(
$statements_checker->getSource(),
$assignment_value ?: $stmt,
$context->include_location
)
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
}
}
return null;
}
/**
* @param StatementsChecker $statements_checker
* @param PhpParser\Node\Expr\StaticPropertyFetch $stmt
* @param PhpParser\Node\Expr|null $assignment_value
* @param Type\Union $assignment_value_type
* @param Context $context
*
* @return false|null
*/
public static function analyzeStatic(
StatementsChecker $statements_checker,
PhpParser\Node\Expr\StaticPropertyFetch $stmt,
$assignment_value,
Type\Union $assignment_value_type,
Context $context
) {
$var_id = ExpressionChecker::getVarId(
$stmt,
$statements_checker->getFQCLN(),
$statements_checker
);
$fq_class_name = (string)$stmt->class->inferredType;
$project_checker = $statements_checker->getFileChecker()->project_checker;
$prop_name = $stmt->name;
if (!is_string($prop_name)) {
return;
}
$property_id = $fq_class_name . '::$' . $prop_name;
if (!ClassLikeChecker::propertyExists($project_checker, $property_id)) {
if ($stmt->class instanceof PhpParser\Node\Name && $stmt->class->parts[0] === 'this') {
if (IssueBuffer::accepts(
new UndefinedThisPropertyAssignment(
'Static property ' . $property_id . ' is not defined',
new CodeLocation($statements_checker->getSource(), $stmt)
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
} else {
if (IssueBuffer::accepts(
new UndefinedPropertyAssignment(
'Static property ' . $property_id . ' is not defined',
new CodeLocation($statements_checker->getSource(), $stmt)
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
}
return;
}
if (ClassLikeChecker::checkPropertyVisibility(
$property_id,
$context->self,
$statements_checker->getSource(),
new CodeLocation($statements_checker->getSource(), $stmt),
$statements_checker->getSuppressedIssues()
) === false) {
return false;
}
$declaring_property_class = ClassLikeChecker::getDeclaringClassForProperty(
$project_checker,
$fq_class_name . '::$' . $prop_name
);
$class_storage = $project_checker->classlike_storage_provider->get((string)$declaring_property_class);
$property_storage = $class_storage->properties[$prop_name];
if ($var_id) {
$context->vars_in_scope[$var_id] = $assignment_value_type;
}
$class_property_type = $property_storage->type;
if ($class_property_type === false) {
$class_property_type = Type::getMixed();
if (!$assignment_value_type->isMixed()) {
if ($property_storage->suggested_type) {
$property_storage->suggested_type = Type::combineUnionTypes(
$assignment_value_type,
$property_storage->suggested_type
);
} else {
$property_storage->suggested_type = Type::combineUnionTypes(
Type::getNull(),
$assignment_value_type
);
}
}
} else {
$class_property_type = clone $class_property_type;
}
if ($assignment_value_type->isMixed()) {
return null;
}
if ($class_property_type->isMixed()) {
return null;
}
$class_property_type = ExpressionChecker::fleshOutType(
$project_checker,
$class_property_type,
$fq_class_name
);
if (!TypeChecker::isContainedBy(
$project_checker,
$assignment_value_type,
$class_property_type
)) {
if (IssueBuffer::accepts(
new InvalidPropertyAssignment(
$var_id . ' with declared type \'' . $class_property_type . '\' cannot be assigned type \'' .
$assignment_value_type . '\'',
new CodeLocation(
$statements_checker->getSource(),
$assignment_value ?: $stmt
)
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
}
if ($var_id) {
$context->vars_in_scope[$var_id] = $assignment_value_type;
}
return null;
}
}