1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-17 03:47:04 +01:00
psalm/src/Psalm/Internal/Analyzer/Statements/Expression/Fetch/InstancePropertyFetchAnalyzer.php

1157 lines
45 KiB
PHP
Raw Normal View History

2018-01-14 18:09:40 +01:00
<?php
2018-11-06 03:57:36 +01:00
namespace Psalm\Internal\Analyzer\Statements\Expression\Fetch;
2018-01-14 18:09:40 +01:00
use PhpParser;
2018-11-06 03:57:36 +01:00
use Psalm\Internal\Analyzer\ClassLikeAnalyzer;
use Psalm\Internal\Analyzer\FunctionLikeAnalyzer;
use Psalm\Internal\Analyzer\NamespaceAnalyzer;
2018-11-06 03:57:36 +01:00
use Psalm\Internal\Analyzer\Statements\ExpressionAnalyzer;
use Psalm\Internal\Analyzer\Statements\Expression\CallAnalyzer;
2020-05-18 21:13:27 +02:00
use Psalm\Internal\Analyzer\Statements\Expression\ExpressionIdentifier;
2018-11-06 03:57:36 +01:00
use Psalm\Internal\Analyzer\StatementsAnalyzer;
use Psalm\Internal\Type\TemplateResult;
2018-01-14 18:09:40 +01:00
use Psalm\CodeLocation;
use Psalm\Context;
use Psalm\Issue\DeprecatedProperty;
use Psalm\Issue\InvalidPropertyFetch;
use Psalm\Issue\InternalProperty;
2018-01-14 18:09:40 +01:00
use Psalm\Issue\MissingPropertyType;
use Psalm\Issue\MixedPropertyFetch;
use Psalm\Issue\NoInterfaceProperties;
use Psalm\Issue\NullPropertyFetch;
use Psalm\Issue\PossiblyInvalidPropertyFetch;
use Psalm\Issue\PossiblyNullPropertyFetch;
use Psalm\Issue\UndefinedClass;
use Psalm\Issue\UndefinedDocblockClass;
use Psalm\Issue\UndefinedMagicPropertyFetch;
2018-01-14 18:09:40 +01:00
use Psalm\Issue\UndefinedPropertyFetch;
use Psalm\Issue\UndefinedThisPropertyFetch;
use Psalm\Issue\UninitializedProperty;
2018-01-14 18:09:40 +01:00
use Psalm\IssueBuffer;
use Psalm\Storage\PropertyStorage;
2018-01-14 18:09:40 +01:00
use Psalm\Type;
use Psalm\Storage\ClassLikeStorage;
2018-01-14 18:09:40 +01:00
use Psalm\Type\Atomic\TGenericObject;
use Psalm\Type\Atomic\TNamedObject;
use Psalm\Type\Atomic\TNull;
use Psalm\Type\Atomic\TObject;
use Psalm\Type\Atomic\TObjectWithProperties;
use function strtolower;
use function array_values;
use function in_array;
use function array_keys;
2020-05-22 04:47:58 +02:00
use Psalm\Internal\Taint\TaintNode;
2018-01-14 18:09:40 +01:00
/**
* @internal
*/
class InstancePropertyFetchAnalyzer
2018-01-14 18:09:40 +01:00
{
public static function analyze(
2018-11-11 18:01:14 +01:00
StatementsAnalyzer $statements_analyzer,
2018-01-14 18:09:40 +01:00
PhpParser\Node\Expr\PropertyFetch $stmt,
Context $context,
bool $in_assignment = false
2020-05-18 21:13:27 +02:00
) : bool {
if (!$stmt->name instanceof PhpParser\Node\Identifier) {
2018-11-11 18:01:14 +01:00
if (ExpressionAnalyzer::analyze($statements_analyzer, $stmt->name, $context) === false) {
2018-01-14 18:09:40 +01:00
return false;
}
}
2018-11-11 18:01:14 +01:00
if (ExpressionAnalyzer::analyze($statements_analyzer, $stmt->var, $context) === false) {
2018-01-14 18:09:40 +01:00
return false;
}
if ($stmt->name instanceof PhpParser\Node\Identifier) {
$prop_name = $stmt->name->name;
} elseif (($stmt_name_type = $statements_analyzer->node_data->getType($stmt->name))
&& $stmt_name_type->isSingleStringLiteral()
) {
$prop_name = $stmt_name_type->getSingleStringLiteral()->value;
} else {
$prop_name = null;
}
2018-11-11 18:01:14 +01:00
$codebase = $statements_analyzer->getCodebase();
2018-01-14 18:09:40 +01:00
2020-05-18 21:13:27 +02:00
$stmt_var_id = ExpressionIdentifier::getArrayVarId(
2018-01-14 18:09:40 +01:00
$stmt->var,
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFQCLN(),
$statements_analyzer
2018-01-14 18:09:40 +01:00
);
2020-05-18 21:13:27 +02:00
$var_id = ExpressionIdentifier::getArrayVarId(
2018-01-14 18:09:40 +01:00
$stmt,
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFQCLN(),
$statements_analyzer
2018-01-14 18:09:40 +01:00
);
$stmt_type = null;
2018-01-14 18:09:40 +01:00
2018-11-11 18:01:14 +01:00
if ($var_id && $context->hasVariable($var_id, $statements_analyzer)) {
$stmt_type = $context->vars_in_scope[$var_id];
2018-01-14 18:09:40 +01:00
// we don't need to check anything
$statements_analyzer->node_data->setType($stmt, $stmt_type);
2018-01-14 18:09:40 +01:00
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());
}
2019-02-24 07:33:25 +01:00
if ($codebase->store_node_types
&& !$context->collect_initializations
&& !$context->collect_mutations
) {
$codebase->analyzer->addNodeType(
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFilePath(),
$stmt->name,
2020-02-23 23:03:27 +01:00
$stmt_type->getId()
);
}
if ($stmt_var_id === '$this'
&& !$stmt_type->initialized
&& $context->collect_initializations
&& ($stmt_var_type = $statements_analyzer->node_data->getType($stmt->var))
&& $stmt_var_type->hasObjectType()
&& $stmt->name instanceof PhpParser\Node\Identifier
) {
$source = $statements_analyzer->getSource();
$property_id = null;
foreach ($stmt_var_type->getAtomicTypes() as $lhs_type_part) {
if ($lhs_type_part instanceof TNamedObject) {
if (!$codebase->classExists($lhs_type_part->value)) {
continue;
}
$property_id = $lhs_type_part->value . '::$' . $stmt->name->name;
}
}
if ($property_id
&& $source instanceof FunctionLikeAnalyzer
&& $source->getMethodName() === '__construct'
&& !$context->inside_unset
) {
if ($context->inside_isset
|| ($context->inside_assignment
&& isset($context->vars_in_scope[$var_id])
&& $context->vars_in_scope[$var_id]->isNullable()
)
) {
$stmt_type->initialized = true;
} else {
if (IssueBuffer::accepts(
new UninitializedProperty(
'Cannot use uninitialized property ' . $var_id,
new CodeLocation($statements_analyzer->getSource(), $stmt),
$var_id
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
$stmt_type->addType(new Type\Atomic\TNull);
}
}
}
if (($stmt_var_type = $statements_analyzer->node_data->getType($stmt->var))
&& $stmt_var_type->hasObjectType()
&& $stmt->name instanceof PhpParser\Node\Identifier
2018-01-14 18:09:40 +01:00
) {
// log the appearance
foreach ($stmt_var_type->getAtomicTypes() as $lhs_type_part) {
2018-01-14 18:09:40 +01:00
if ($lhs_type_part instanceof TNamedObject) {
2018-02-01 06:50:01 +01:00
if (!$codebase->classExists($lhs_type_part->value)) {
continue;
}
$property_id = $lhs_type_part->value . '::$' . $stmt->name->name;
2018-01-14 18:09:40 +01:00
self::processTaints(
$statements_analyzer,
$stmt,
$stmt_type,
$property_id,
$codebase->classlike_storage_provider->get($lhs_type_part->value),
$in_assignment
);
$codebase->properties->propertyExists(
2018-01-14 18:09:40 +01:00
$property_id,
2020-01-05 23:19:57 +01:00
true,
$statements_analyzer,
$context,
$codebase->collect_locations
2018-11-11 18:01:14 +01:00
? new CodeLocation($statements_analyzer->getSource(), $stmt)
: null
2018-01-14 18:09:40 +01:00
);
if ($codebase->store_node_types
&& !$context->collect_initializations
&& !$context->collect_mutations
) {
$codebase->analyzer->addNodeReference(
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFilePath(),
$stmt->name,
$property_id
);
}
2018-01-14 18:09:40 +01:00
}
}
}
2020-05-18 21:13:27 +02:00
return true;
2018-01-14 18:09:40 +01:00
}
2018-11-11 18:01:14 +01:00
if ($stmt_var_id && $context->hasVariable($stmt_var_id, $statements_analyzer)) {
2018-01-14 18:09:40 +01:00
$stmt_var_type = $context->vars_in_scope[$stmt_var_id];
} else {
$stmt_var_type = $statements_analyzer->node_data->getType($stmt->var);
2018-01-14 18:09:40 +01:00
}
if (!$stmt_var_type) {
2020-05-18 21:13:27 +02:00
return true;
2018-01-14 18:09:40 +01:00
}
if ($stmt_var_type->isNull()) {
if (IssueBuffer::accepts(
new NullPropertyFetch(
'Cannot get property on null variable ' . $stmt_var_id,
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt)
2018-01-14 18:09:40 +01:00
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2018-01-14 18:09:40 +01:00
)) {
return false;
}
2020-05-18 21:13:27 +02:00
return true;
2018-01-14 18:09:40 +01:00
}
if ($stmt_var_type->isEmpty()) {
if (IssueBuffer::accepts(
new MixedPropertyFetch(
'Cannot fetch property on empty var ' . $stmt_var_id,
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt)
2018-01-14 18:09:40 +01:00
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2018-01-14 18:09:40 +01:00
)) {
return false;
}
2020-05-18 21:13:27 +02:00
return true;
2018-01-14 18:09:40 +01:00
}
if ($stmt_var_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) {
2019-04-27 23:38:24 +02:00
$codebase->analyzer->addMixedMemberName(
'$' . $stmt->name->name,
$context->calling_method_id ?: $statements_analyzer->getFileName()
2019-04-27 23:38:24 +02:00
);
}
2018-01-14 18:09:40 +01:00
if (IssueBuffer::accepts(
new MixedPropertyFetch(
'Cannot fetch property on mixed var ' . $stmt_var_id,
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt)
2018-01-14 18:09:40 +01:00
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2018-01-14 18:09:40 +01:00
)) {
// fall through
}
2020-02-23 23:03:27 +01:00
$statements_analyzer->node_data->setType($stmt, Type::getMixed());
2018-01-14 18:09:40 +01:00
2020-02-23 23:03:27 +01:00
if ($codebase->store_node_types
&& !$context->collect_initializations
&& !$context->collect_mutations
) {
$codebase->analyzer->addNodeType(
$statements_analyzer->getFilePath(),
$stmt->name,
$stmt_var_type->getId()
);
}
2018-01-14 18:09:40 +01:00
}
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->getRootFilePath());
}
if ($stmt_var_type->isNullable() && !$stmt_var_type->ignore_nullable_issues) {
if (!$context->inside_isset) {
if (IssueBuffer::accepts(
new PossiblyNullPropertyFetch(
'Cannot get property on possibly null variable ' . $stmt_var_id . ' of type ' . $stmt_var_type,
new CodeLocation($statements_analyzer->getSource(), $stmt)
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
} else {
$statements_analyzer->node_data->setType($stmt, Type::getNull());
2018-01-14 18:09:40 +01:00
}
}
if (!$prop_name) {
if ($stmt_var_type->hasObjectType() && !$context->ignore_variable_property) {
foreach ($stmt_var_type->getAtomicTypes() 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()
2019-04-27 23:38:24 +02:00
);
}
}
}
2020-05-18 21:13:27 +02:00
return true;
2018-01-14 18:09:40 +01:00
}
$invalid_fetch_types = [];
$has_valid_fetch_type = false;
foreach ($stmt_var_type->getAtomicTypes() as $lhs_type_part) {
2018-01-14 18:09:40 +01:00
if ($lhs_type_part instanceof TNull) {
continue;
}
2019-02-22 03:40:06 +01:00
if ($lhs_type_part instanceof Type\Atomic\TTemplateParam) {
2019-01-08 22:55:53 +01:00
$extra_types = $lhs_type_part->extra_types;
$lhs_type_part = array_values(
$lhs_type_part->as->getAtomicTypes()
2019-01-08 22:55:53 +01:00
)[0];
$lhs_type_part->from_docblock = true;
if ($lhs_type_part instanceof TNamedObject) {
$lhs_type_part->extra_types = $extra_types;
}
}
if ($lhs_type_part instanceof Type\Atomic\TMixed) {
$statements_analyzer->node_data->setType($stmt, Type::getMixed());
continue;
}
if ($lhs_type_part instanceof Type\Atomic\TFalse && $stmt_var_type->ignore_falsable_issues) {
continue;
}
2018-01-14 18:09:40 +01:00
if (!$lhs_type_part instanceof TNamedObject && !$lhs_type_part instanceof TObject) {
$invalid_fetch_types[] = (string)$lhs_type_part;
continue;
}
$has_valid_fetch_type = true;
if ($lhs_type_part instanceof TObjectWithProperties
&& isset($lhs_type_part->properties[$prop_name])
) {
if ($stmt_type = $statements_analyzer->node_data->getType($stmt)) {
$statements_analyzer->node_data->setType(
$stmt,
Type::combineUnionTypes(
$lhs_type_part->properties[$prop_name],
$stmt_type
)
);
} else {
$statements_analyzer->node_data->setType($stmt, $lhs_type_part->properties[$prop_name]);
}
continue;
}
2018-01-14 18:09:40 +01:00
// 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
2018-02-07 19:57:45 +01:00
if ($lhs_type_part instanceof TObject
|| in_array(strtolower($lhs_type_part->value), ['stdclass', 'simplexmlelement'], true)
2018-01-14 18:09:40 +01:00
) {
$statements_analyzer->node_data->setType($stmt, Type::getMixed());
2018-01-14 18:09:40 +01:00
continue;
}
2018-11-06 03:57:36 +01:00
if (ExpressionAnalyzer::isMock($lhs_type_part->value)) {
$statements_analyzer->node_data->setType($stmt, Type::getMixed());
2018-01-14 18:09:40 +01:00
continue;
}
$intersection_types = $lhs_type_part->getIntersectionTypes() ?: [];
$fq_class_name = $lhs_type_part->value;
$override_property_visibility = false;
2020-01-06 03:58:18 +01:00
$has_magic_getter = false;
$class_exists = false;
$interface_exists = false;
if (!$codebase->classExists($lhs_type_part->value)) {
2018-02-01 06:50:01 +01:00
if ($codebase->interfaceExists($lhs_type_part->value)) {
$interface_exists = true;
$interface_storage = $codebase->classlike_storage_provider->get($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()
)) {
2020-05-18 21:13:27 +02:00
return true;
}
if (!$codebase->methodExists($fq_class_name . '::__set')) {
2020-05-18 21:13:27 +02:00
return true;
}
}
}
if (!$class_exists && !$interface_exists) {
if ($lhs_type_part->from_docblock) {
if (IssueBuffer::accepts(
new UndefinedDocblockClass(
'Cannot set properties of undefined docblock class ' . $lhs_type_part->value,
new CodeLocation($statements_analyzer->getSource(), $stmt),
$lhs_type_part->value
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
} else {
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
}
2018-01-14 18:09:40 +01:00
}
2020-05-18 21:13:27 +02:00
return true;
2018-01-14 18:09:40 +01:00
}
} else {
$class_exists = true;
2018-01-14 18:09:40 +01:00
}
2020-05-10 15:04:30 +02:00
$class_storage = $codebase->classlike_storage_provider->get($fq_class_name);
$property_id = $fq_class_name . '::$' . $prop_name;
2018-01-14 18:09:40 +01:00
2020-05-10 15:04:30 +02:00
$naive_property_exists = $codebase->properties->propertyExists(
$property_id,
true,
$statements_analyzer,
$context,
$codebase->collect_locations ? new CodeLocation($statements_analyzer->getSource(), $stmt) : null
);
// add method before changing fq_class_name
$get_method_id = new \Psalm\Internal\MethodIdentifier($fq_class_name, '__get');
2020-05-10 15:04:30 +02:00
if (!$naive_property_exists
&& $class_storage->mixin instanceof Type\Atomic\TNamedObject
) {
$new_property_id = $class_storage->mixin->value . '::$' . $prop_name;
try {
$new_class_storage = $codebase->classlike_storage_provider->get($class_storage->mixin->value);
} catch (\InvalidArgumentException $e) {
$new_class_storage = null;
}
if ($new_class_storage
&& ($codebase->properties->propertyExists(
2020-05-25 07:23:28 +02:00
$new_property_id,
true,
$statements_analyzer,
$context,
$codebase->collect_locations
? new CodeLocation($statements_analyzer->getSource(), $stmt)
: null
)
|| isset($new_class_storage->pseudo_property_get_types['$' . $prop_name]))
2020-05-10 15:04:30 +02:00
) {
$fq_class_name = $class_storage->mixin->value;
$lhs_type_part = clone $class_storage->mixin;
$class_storage = $new_class_storage;
if (!isset($new_class_storage->pseudo_property_get_types['$' . $prop_name])) {
$naive_property_exists = true;
}
$property_id = $new_property_id;
}
}
if ((!$naive_property_exists
|| ($stmt_var_id !== '$this'
&& $fq_class_name !== $context->self
2018-11-06 03:57:36 +01:00
&& ClassLikeAnalyzer::checkPropertyVisibility(
$property_id,
$context,
2018-11-11 18:01:14 +01:00
$statements_analyzer,
new CodeLocation($statements_analyzer->getSource(), $stmt),
$statements_analyzer->getSuppressedIssues(),
false
) !== true)
)
&& $codebase->methods->methodExists(
$get_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()
)
) {
2020-01-06 03:58:18 +01:00
$has_magic_getter = true;
if (isset($class_storage->pseudo_property_get_types['$' . $prop_name])) {
$stmt_type = clone $class_storage->pseudo_property_get_types['$' . $prop_name];
$statements_analyzer->node_data->setType($stmt, $stmt_type);
self::processTaints(
$statements_analyzer,
$stmt,
$stmt_type,
$property_id,
$class_storage,
$in_assignment
);
continue;
}
2018-01-14 18:09:40 +01:00
$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('__get', $stmt->name->getAttributes()),
[
new PhpParser\Node\Arg(
new PhpParser\Node\Scalar\String_(
$prop_name,
$stmt->name->getAttributes()
)
)
]
);
$suppressed_issues = $statements_analyzer->getSuppressedIssues();
if (!in_array('PossiblyNullReference', $suppressed_issues, true)) {
$statements_analyzer->addSuppressedIssues(['PossiblyNullReference']);
}
if (!in_array('InternalMethod', $suppressed_issues, true)) {
$statements_analyzer->addSuppressedIssues(['InternalMethod']);
}
\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']);
}
2019-05-30 14:53:20 +02:00
if (!in_array('InternalMethod', $suppressed_issues, true)) {
$statements_analyzer->removeSuppressedIssues(['InternalMethod']);
}
$fake_method_call_type = $statements_analyzer->node_data->getType($fake_method_call);
$statements_analyzer->node_data = $old_data_provider;
if ($fake_method_call_type) {
$statements_analyzer->node_data->setType($stmt, $fake_method_call_type);
} else {
$statements_analyzer->node_data->setType($stmt, Type::getMixed());
}
$property_id = $lhs_type_part->value . '::$' . $prop_name;
/*
* If we have an explicit list of all allowed magic properties on the class, and we're
* not in that list, fall through
*/
if (!$class_storage->sealed_properties && !$override_property_visibility) {
continue;
2018-01-14 18:09:40 +01:00
}
2020-05-11 03:09:48 +02:00
if (!$class_exists) {
2020-05-10 15:04:30 +02:00
$property_id = $lhs_type_part->value . '::$' . $prop_name;
if (IssueBuffer::accepts(
new UndefinedMagicPropertyFetch(
'Magic instance property ' . $property_id . ' is not defined',
new CodeLocation($statements_analyzer->getSource(), $stmt),
$property_id
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
2020-05-10 15:04:30 +02:00
continue;
}
}
if ($codebase->store_node_types
&& !$context->collect_initializations
&& !$context->collect_mutations
) {
$codebase->analyzer->addNodeReference(
$statements_analyzer->getFilePath(),
$stmt->name,
$property_id
);
2018-01-14 18:09:40 +01:00
}
$config = $statements_analyzer->getProjectAnalyzer()->getConfig();
2020-05-10 15:04:30 +02:00
if (!$naive_property_exists) {
if ($config->use_phpdoc_property_without_magic_or_parent
&& isset($class_storage->pseudo_property_get_types['$' . $prop_name])
) {
$stmt_type = clone $class_storage->pseudo_property_get_types['$' . $prop_name];
$statements_analyzer->node_data->setType($stmt, $stmt_type);
self::processTaints(
$statements_analyzer,
$stmt,
$stmt_type,
$property_id,
$class_storage,
$in_assignment
);
continue;
}
2019-01-31 23:48:48 +01:00
if ($fq_class_name !== $context->self
&& $context->self
&& $codebase->classlikes->classExtends($fq_class_name, $context->self)
2019-01-31 23:48:48 +01:00
&& $codebase->properties->propertyExists(
$context->self . '::$' . $prop_name,
2020-01-05 23:19:57 +01:00
true,
$statements_analyzer,
$context,
$codebase->collect_locations
? new CodeLocation($statements_analyzer->getSource(), $stmt)
: null
2019-01-31 23:48:48 +01:00
)
) {
$property_id = $context->self . '::$' . $prop_name;
} else {
if ($context->inside_isset || $context->collect_initializations) {
2020-05-18 21:13:27 +02:00
return true;
2018-01-14 18:09:40 +01:00
}
2019-01-31 23:48:48 +01:00
if ($stmt_var_id === '$this') {
if (IssueBuffer::accepts(
new UndefinedThisPropertyFetch(
'Instance property ' . $property_id . ' is not defined',
new CodeLocation($statements_analyzer->getSource(), $stmt),
$property_id
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
} else {
2020-01-06 03:58:18 +01:00
if ($has_magic_getter) {
if (IssueBuffer::accepts(
new UndefinedMagicPropertyFetch(
'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 UndefinedPropertyFetch(
'Instance property ' . $property_id . ' is not defined',
new CodeLocation($statements_analyzer->getSource(), $stmt),
$property_id
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
2019-01-31 23:48:48 +01:00
}
2018-01-14 18:09:40 +01:00
}
$stmt_type = Type::getMixed();
$statements_analyzer->node_data->setType($stmt, $stmt_type);
2019-01-31 23:48:48 +01:00
if ($var_id) {
$context->vars_in_scope[$var_id] = $stmt_type;
2019-01-31 23:48:48 +01:00
}
2020-05-18 21:13:27 +02:00
return true;
2019-01-31 23:48:48 +01:00
}
2018-01-14 18:09:40 +01:00
}
if (!$override_property_visibility) {
if (ClassLikeAnalyzer::checkPropertyVisibility(
$property_id,
$context,
$statements_analyzer,
new CodeLocation($statements_analyzer->getSource(), $stmt),
$statements_analyzer->getSuppressedIssues()
) === false) {
return false;
}
2018-01-14 18:09:40 +01:00
}
$declaring_property_class = $codebase->properties->getDeclaringClassForProperty(
$property_id,
2020-01-06 00:37:07 +01:00
true,
$statements_analyzer
);
2018-01-14 18:09:40 +01:00
if ($declaring_property_class === null) {
continue;
}
2019-06-04 06:32:19 +02:00
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
2018-01-14 18:09:40 +01:00
);
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,
new CodeLocation($statements_analyzer->getSource(), $stmt),
$property_id
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
}
}
$class_property_type = $codebase->properties->getPropertyType(
$property_id,
false,
$statements_analyzer,
$context
);
2018-01-14 18:09:40 +01:00
2019-01-11 23:21:50 +01:00
if (!$class_property_type) {
if ($declaring_class_storage->location
&& $config->isInProjectDirs(
$declaring_class_storage->location->file_path
)
) {
if (IssueBuffer::accepts(
new MissingPropertyType(
'Property ' . $fq_class_name . '::$' . $prop_name
. ' does not have a declared type',
new CodeLocation($statements_analyzer->getSource(), $stmt)
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
2018-01-14 18:09:40 +01:00
}
$class_property_type = Type::getMixed();
} else {
2020-05-11 04:45:01 +02:00
$class_property_type = \Psalm\Internal\Type\TypeExpander::expandUnion(
2018-11-06 03:57:36 +01:00
$codebase,
2018-01-14 18:09:40 +01:00
clone $class_property_type,
$declaring_class_storage->name,
$declaring_class_storage->name,
$declaring_class_storage->parent_class
2018-01-14 18:09:40 +01:00
);
if ($declaring_class_storage->template_types) {
if (!$lhs_type_part instanceof TGenericObject) {
$type_params = [];
foreach ($declaring_class_storage->template_types as $type_map) {
$type_params[] = clone array_values($type_map)[0][0];
}
$lhs_type_part = new TGenericObject($lhs_type_part->value, $type_params);
}
$class_property_type = self::localizePropertyType(
$codebase,
$class_property_type,
$lhs_type_part,
$class_storage,
$declaring_class_storage
);
}
2018-01-14 18:09:40 +01:00
if ($lhs_type_part instanceof TGenericObject) {
$class_property_type = self::localizePropertyType(
$codebase,
$class_property_type,
$lhs_type_part,
$class_storage,
$declaring_class_storage
);
2018-01-14 18:09:40 +01:00
}
}
self::processTaints(
$statements_analyzer,
$stmt,
$class_property_type,
$property_id,
$class_storage,
$in_assignment
);
if ($stmt_type = $statements_analyzer->node_data->getType($stmt)) {
$statements_analyzer->node_data->setType(
$stmt,
Type::combineUnionTypes($class_property_type, $stmt_type)
);
2018-01-14 18:09:40 +01:00
} else {
$statements_analyzer->node_data->setType($stmt, $class_property_type);
2018-01-14 18:09:40 +01:00
}
}
$stmt_type = $statements_analyzer->node_data->getType($stmt);
if ($stmt_var_type->isNullable() && !$context->inside_isset && $stmt_type) {
$stmt_type->addType(new TNull);
if ($stmt_var_type->ignore_nullable_issues) {
$stmt_type->ignore_nullable_issues = true;
}
}
2019-02-24 07:33:25 +01:00
if ($codebase->store_node_types
&& !$context->collect_initializations
&& !$context->collect_mutations
&& ($stmt_type = $statements_analyzer->node_data->getType($stmt))
) {
$codebase->analyzer->addNodeType(
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFilePath(),
$stmt->name,
2020-02-23 23:03:27 +01:00
$stmt_type->getId()
);
}
2018-01-14 18:09:40 +01:00
if ($invalid_fetch_types) {
$lhs_type_part = $invalid_fetch_types[0];
if ($has_valid_fetch_type) {
if (IssueBuffer::accepts(
new PossiblyInvalidPropertyFetch(
'Cannot fetch property on possible non-object ' . $stmt_var_id . ' of type ' . $lhs_type_part,
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt)
2018-01-14 18:09:40 +01:00
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2018-01-14 18:09:40 +01:00
)) {
// fall through
}
} else {
if (IssueBuffer::accepts(
new InvalidPropertyFetch(
'Cannot fetch property on non-object ' . $stmt_var_id . ' of type ' . $lhs_type_part,
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt)
2018-01-14 18:09:40 +01:00
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2018-01-14 18:09:40 +01:00
)) {
// fall through
}
}
}
if ($var_id) {
$context->vars_in_scope[$var_id] = $statements_analyzer->node_data->getType($stmt) ?: Type::getMixed();
2018-01-14 18:09:40 +01:00
}
2020-05-18 21:13:27 +02:00
return true;
2018-01-14 18:09:40 +01:00
}
public static function localizePropertyType(
\Psalm\Codebase $codebase,
Type\Union $class_property_type,
TGenericObject $lhs_type_part,
ClassLikeStorage $calling_class_storage,
ClassLikeStorage $declaring_class_storage
) : Type\Union {
$template_types = CallAnalyzer::getTemplateTypesForCall(
$codebase,
$declaring_class_storage,
$declaring_class_storage->name,
$calling_class_storage,
2020-07-05 21:21:44 +02:00
$calling_class_storage->template_types ?: []
);
$extended_types = $calling_class_storage->template_type_extends;
if ($template_types) {
if ($calling_class_storage->template_types) {
foreach ($lhs_type_part->type_params as $param_offset => $lhs_param_type) {
$i = -1;
foreach ($calling_class_storage->template_types as $calling_param_name => $_) {
$i++;
if ($i === $param_offset) {
$template_types[$calling_param_name][$calling_class_storage->name] = [
$lhs_param_type,
0
];
break;
}
}
}
}
foreach ($template_types as $type_name => $_) {
if (isset($extended_types[$declaring_class_storage->name][$type_name])) {
$mapped_type = $extended_types[$declaring_class_storage->name][$type_name];
foreach ($mapped_type->getAtomicTypes() as $mapped_type_atomic) {
if (!$mapped_type_atomic instanceof Type\Atomic\TTemplateParam) {
continue;
}
$param_name = $mapped_type_atomic->param_name;
$position = false;
if (isset($calling_class_storage->template_types[$param_name])) {
$position = \array_search(
$param_name,
array_keys($calling_class_storage->template_types)
);
}
if ($position !== false && isset($lhs_type_part->type_params[$position])) {
$template_types[$type_name][$declaring_class_storage->name] = [
$lhs_type_part->type_params[$position],
0
];
}
}
}
}
$class_property_type->replaceTemplateTypesWithArgTypes(
new TemplateResult([], $template_types),
$codebase
);
}
return $class_property_type;
}
private static function processTaints(
StatementsAnalyzer $statements_analyzer,
PhpParser\Node\Expr\PropertyFetch $stmt,
Type\Union $type,
string $property_id,
\Psalm\Storage\ClassLikeStorage $class_storage,
bool $in_assignment
) : 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) {
$var_type = $statements_analyzer->node_data->getType($stmt->var);
if ($var_type && \in_array('TaintedInput', $statements_analyzer->getSuppressedIssues())) {
$var_type->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(
$var_node,
$property_node,
'property-fetch'
. ($stmt->name instanceof PhpParser\Node\Identifier ? '-' . $stmt->name : '')
);
if ($var_type && $var_type->parent_nodes) {
foreach ($var_type->parent_nodes as $parent_node) {
$codebase->taint->addPath(
$parent_node,
$var_node,
'='
);
}
}
$type->parent_nodes = [$property_node];
}
} else {
2020-05-22 05:43:13 +02:00
$code_location = new CodeLocation($statements_analyzer, $stmt->name);
$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,
2020-05-22 05:43:13 +02:00
null,
2020-05-22 04:47:58 +02:00
null
);
2020-05-22 05:43:13 +02:00
$codebase->taint->addTaintNode($property_node);
if ($in_assignment) {
$codebase->taint->addPath($localized_property_node, $property_node, 'property-assignment');
} else {
$codebase->taint->addPath($property_node, $localized_property_node, 'property-fetch');
}
$type->parent_nodes[] = $localized_property_node;
}
}
2018-01-14 18:09:40 +01:00
}