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

1231 lines
47 KiB
PHP
Raw Normal View History

2016-11-01 19:14:35 +01:00
<?php
namespace Psalm\Checker\Statements\Expression;
use PhpParser;
use Psalm\Checker\ClassChecker;
use Psalm\Checker\ClassLikeChecker;
use Psalm\Checker\FunctionChecker;
use Psalm\Checker\FunctionLikeChecker;
use Psalm\Checker\MethodChecker;
use Psalm\Checker\StatementsChecker;
use Psalm\Checker\Statements\ExpressionChecker;
use Psalm\Checker\TraitChecker;
use Psalm\CodeLocation;
2016-11-02 07:29:00 +01:00
use Psalm\Context;
2016-11-01 19:14:35 +01:00
use Psalm\Issue\ForbiddenCode;
use Psalm\Issue\InvalidArgument;
use Psalm\Issue\InvalidScalarArgument;
use Psalm\Issue\InvalidScope;
use Psalm\Issue\MixedArgument;
use Psalm\Issue\MixedMethodCall;
use Psalm\Issue\NullReference;
use Psalm\Issue\ParentNotFound;
use Psalm\Issue\TooFewArguments;
use Psalm\Issue\TooManyArguments;
use Psalm\Issue\TypeCoercion;
use Psalm\Issue\UndefinedFunction;
use Psalm\IssueBuffer;
use Psalm\Type;
class CallChecker
{
/**
2016-11-02 07:29:00 +01:00
* @param StatementsChecker $statements_checker
* @param PhpParser\Node\Expr\FuncCall $stmt
* @param Context $context
* @return false|null
2016-11-01 19:14:35 +01:00
*/
2016-11-02 07:29:00 +01:00
public static function checkFunctionCall(
StatementsChecker $statements_checker,
PhpParser\Node\Expr\FuncCall $stmt,
Context $context
) {
2016-11-01 19:14:35 +01:00
$method = $stmt->name;
if ($method instanceof PhpParser\Node\Name) {
$first_arg = isset($stmt->args[0]) ? $stmt->args[0] : null;
if ($method->parts === ['method_exists']) {
$context->check_methods = false;
2016-11-02 07:29:00 +01:00
} elseif ($method->parts === ['class_exists']) {
2016-11-01 19:14:35 +01:00
if ($first_arg && $first_arg->value instanceof PhpParser\Node\Scalar\String_) {
$context->addPhantomClass($first_arg->value->value);
2016-11-02 07:29:00 +01:00
} else {
2016-11-01 19:14:35 +01:00
$context->check_classes = false;
}
2016-11-02 07:29:00 +01:00
} elseif ($method->parts === ['function_exists']) {
2016-11-01 19:14:35 +01:00
$context->check_functions = false;
2016-11-02 07:29:00 +01:00
} elseif ($method->parts === ['is_callable']) {
2016-11-01 19:14:35 +01:00
$context->check_methods = false;
$context->check_functions = false;
2016-11-02 07:29:00 +01:00
} elseif ($method->parts === ['defined']) {
2016-11-01 19:14:35 +01:00
$context->check_consts = false;
2016-11-02 07:29:00 +01:00
} elseif ($method->parts === ['extract']) {
2016-11-01 19:14:35 +01:00
$context->check_variables = false;
2016-11-02 07:29:00 +01:00
} elseif ($method->parts === ['var_dump'] || $method->parts === ['die'] || $method->parts === ['exit']) {
2016-11-01 19:14:35 +01:00
if (IssueBuffer::accepts(
2016-11-02 07:29:00 +01:00
new ForbiddenCode(
'Unsafe ' . implode('', $method->parts),
new CodeLocation($statements_checker->getSource(), $stmt)
2016-11-02 07:29:00 +01:00
),
2016-11-01 19:14:35 +01:00
$statements_checker->getSuppressedIssues()
)) {
return false;
}
2016-11-02 07:29:00 +01:00
} elseif ($method->parts === ['define']) {
2016-11-01 19:14:35 +01:00
if ($first_arg && $first_arg->value instanceof PhpParser\Node\Scalar\String_) {
$second_arg = $stmt->args[1];
ExpressionChecker::check($statements_checker, $second_arg->value, $context);
$const_name = $first_arg->value->value;
$statements_checker->setConstType(
$const_name,
isset($second_arg->value->inferredType) ? $second_arg->value->inferredType : Type::getMixed()
);
2016-11-02 07:29:00 +01:00
} else {
2016-11-01 19:14:35 +01:00
$context->check_consts = false;
}
}
}
$method_id = null;
if ($context->check_functions) {
if (!($stmt->name instanceof PhpParser\Node\Name)) {
2016-11-02 07:29:00 +01:00
return null;
2016-11-01 19:14:35 +01:00
}
2016-11-21 03:49:06 +01:00
$method_id = implode('\\', $stmt->name->parts);
$aliased_functions = $statements_checker->getAliasedFunctions();
if (isset($aliased_functions[strtolower($method_id)])) {
$method_id = $aliased_functions[strtolower($method_id)];
}
2016-11-01 19:14:35 +01:00
if ($context->self) {
2016-11-08 01:16:51 +01:00
//$method_id = $statements_checker->getFQCLN() . '::' . $method_id;
2016-11-01 19:14:35 +01:00
}
$in_call_map = FunctionChecker::inCallMap($method_id);
$code_location = new CodeLocation($statements_checker->getSource(), $stmt);
2016-11-02 07:29:00 +01:00
if (!$in_call_map &&
self::checkFunctionExists($statements_checker, $method_id, $context, $code_location) === false
2016-11-02 07:29:00 +01:00
) {
2016-11-01 19:14:35 +01:00
return false;
}
2016-11-02 07:29:00 +01:00
if (self::checkFunctionArguments(
2016-12-07 20:13:39 +01:00
$statements_checker,
$stmt->args,
$method_id,
$context
) === false) {
// fall through
}
if (self::checkFunctionArgumentsMatch(
2016-11-02 07:29:00 +01:00
$statements_checker,
$stmt->args,
$method_id,
$context,
$code_location
2016-11-02 07:29:00 +01:00
) === false) {
// fall through
2016-11-01 19:14:35 +01:00
}
if ($in_call_map) {
$stmt->inferredType = FunctionChecker::getReturnTypeFromCallMapWithArgs(
$method_id,
$stmt->args,
$code_location,
2016-11-01 19:14:35 +01:00
$statements_checker->getSuppressedIssues()
);
2016-11-02 07:29:00 +01:00
} else {
2016-11-01 19:14:35 +01:00
try {
$stmt->inferredType = FunctionChecker::getFunctionReturnType(
2016-11-02 07:29:00 +01:00
$method_id,
$statements_checker->getCheckedFileName()
);
} catch (\InvalidArgumentException $e) {
2016-11-01 19:14:35 +01:00
// this can happen when the function was defined in the Config startup script
$stmt->inferredType = Type::getMixed();
}
}
}
if ($stmt->name instanceof PhpParser\Node\Name &&
($stmt->name->parts === ['get_class'] || $stmt->name->parts === ['gettype']) &&
$stmt->args
) {
2016-11-01 19:14:35 +01:00
$var = $stmt->args[0]->value;
if ($var instanceof PhpParser\Node\Expr\Variable && is_string($var->name)) {
$stmt->inferredType = new Type\Union([new Type\T('$' . $var->name)]);
}
}
2016-11-02 07:29:00 +01:00
return null;
2016-11-01 19:14:35 +01:00
}
/**
2016-11-02 07:29:00 +01:00
* @param StatementsChecker $statements_checker
* @param PhpParser\Node\Expr\New_ $stmt
* @param Context $context
* @return false|null
2016-11-01 19:14:35 +01:00
*/
public static function checkNew(
StatementsChecker $statements_checker,
PhpParser\Node\Expr\New_ $stmt,
Context $context
) {
$fq_class_name = null;
2016-11-01 19:14:35 +01:00
if ($stmt->class instanceof PhpParser\Node\Name) {
if (!in_array($stmt->class->parts[0], ['self', 'static', 'parent'])) {
if ($context->check_classes) {
2016-11-08 01:16:51 +01:00
$fq_class_name = ClassLikeChecker::getFQCLNFromNameObject(
2016-11-02 07:29:00 +01:00
$stmt->class,
$statements_checker->getNamespace(),
$statements_checker->getAliasedClasses()
);
2016-11-01 19:14:35 +01:00
if ($context->isPhantomClass($fq_class_name)) {
2016-11-02 07:29:00 +01:00
return null;
2016-11-01 19:14:35 +01:00
}
2016-11-08 01:16:51 +01:00
if (ClassLikeChecker::checkFullyQualifiedClassLikeName(
$fq_class_name,
new CodeLocation($statements_checker->getSource(), $stmt->class),
2016-11-02 07:29:00 +01:00
$statements_checker->getSuppressedIssues()
) === false) {
2016-11-01 19:14:35 +01:00
return false;
}
}
2016-11-02 07:29:00 +01:00
} else {
2016-11-01 19:14:35 +01:00
switch ($stmt->class->parts[0]) {
case 'self':
$fq_class_name = $context->self;
2016-11-01 19:14:35 +01:00
break;
case 'parent':
$fq_class_name = $context->parent;
2016-11-01 19:14:35 +01:00
break;
case 'static':
// @todo maybe we can do better here
$fq_class_name = $context->self;
2016-11-01 19:14:35 +01:00
break;
}
}
2016-11-02 07:29:00 +01:00
} elseif ($stmt->class instanceof PhpParser\Node\Stmt\Class_) {
2016-11-01 19:14:35 +01:00
$statements_checker->check([$stmt->class], $context);
$fq_class_name = $stmt->class->name;
2016-11-02 07:29:00 +01:00
} else {
2016-11-01 19:14:35 +01:00
ExpressionChecker::check($statements_checker, $stmt->class, $context);
}
if ($fq_class_name) {
$stmt->inferredType = new Type\Union([new Type\Atomic($fq_class_name)]);
2016-11-01 19:14:35 +01:00
if (MethodChecker::methodExists($fq_class_name . '::__construct')) {
$method_id = $fq_class_name . '::__construct';
2016-11-01 19:14:35 +01:00
2016-11-02 07:29:00 +01:00
if (self::checkFunctionArguments(
2016-12-07 20:13:39 +01:00
$statements_checker,
$stmt->args,
$method_id,
$context
) === false) {
return false;
}
if (self::checkFunctionArgumentsMatch(
2016-11-02 07:29:00 +01:00
$statements_checker,
$stmt->args,
$method_id,
$context,
new CodeLocation($statements_checker->getSource(), $stmt)
2016-11-02 07:29:00 +01:00
) === false) {
2016-12-07 20:13:39 +01:00
// fall through
2016-11-01 19:14:35 +01:00
}
if ($fq_class_name === 'ArrayIterator' && isset($stmt->args[0]->value->inferredType)) {
2016-11-01 19:14:35 +01:00
/** @var Type\Union */
$first_arg_type = $stmt->args[0]->value->inferredType;
if ($first_arg_type->hasGeneric()) {
/** @var Type\Union|null */
$key_type = null;
/** @var Type\Union|null */
$value_type = null;
foreach ($first_arg_type->types as $type) {
if ($type instanceof Type\Generic) {
$first_type_param = count($type->type_params) ? $type->type_params[0] : null;
$last_type_param = $type->type_params[count($type->type_params) - 1];
if ($value_type === null) {
$value_type = clone $last_type_param;
2016-11-02 07:29:00 +01:00
} else {
2016-11-01 19:14:35 +01:00
$value_type = Type::combineUnionTypes($value_type, $last_type_param);
}
if (!$key_type || !$first_type_param) {
$key_type = $first_type_param ? clone $first_type_param : Type::getMixed();
2016-11-02 07:29:00 +01:00
} else {
2016-11-01 19:14:35 +01:00
$key_type = Type::combineUnionTypes($key_type, $first_type_param);
}
}
}
$stmt->inferredType = new Type\Union([
new Type\Generic(
$fq_class_name,
2016-11-01 19:14:35 +01:00
[
$key_type,
$value_type
]
)
]);
}
}
}
}
2016-11-02 07:29:00 +01:00
return null;
2016-11-01 19:14:35 +01:00
}
/**
* @return false|null
*/
2016-11-02 07:29:00 +01:00
/**
* @param StatementsChecker $statements_checker
* @param PhpParser\Node\Expr\MethodCall $stmt
* @param Context $context
* @return false|null
*/
public static function checkMethodCall(
StatementsChecker $statements_checker,
PhpParser\Node\Expr\MethodCall $stmt,
Context $context
) {
2016-11-01 19:14:35 +01:00
if (ExpressionChecker::check($statements_checker, $stmt->var, $context) === false) {
return false;
}
$class_type = null;
$method_id = null;
if ($stmt->var instanceof PhpParser\Node\Expr\Variable) {
if (is_string($stmt->var->name) && $stmt->var->name === 'this' && !$statements_checker->getClassName()) {
if (IssueBuffer::accepts(
2016-11-02 07:29:00 +01:00
new InvalidScope(
'Use of $this in non-class context',
new CodeLocation($statements_checker->getSource(), $stmt)
2016-11-02 07:29:00 +01:00
),
2016-11-01 19:14:35 +01:00
$statements_checker->getSuppressedIssues()
)) {
return false;
}
}
}
2016-11-02 07:29:00 +01:00
$var_id = ExpressionChecker::getVarId(
$stmt->var,
2016-11-08 01:16:51 +01:00
$statements_checker->getFQCLN(),
2016-11-02 07:29:00 +01:00
$statements_checker->getNamespace(),
$statements_checker->getAliasedClasses()
);
2016-11-01 19:14:35 +01:00
$class_type = isset($context->vars_in_scope[$var_id]) ? $context->vars_in_scope[$var_id] : null;
if (isset($stmt->var->inferredType)) {
/** @var Type\Union */
$class_type = $stmt->var->inferredType;
2016-11-02 07:29:00 +01:00
} elseif (!$class_type) {
2016-11-01 19:14:35 +01:00
$stmt->inferredType = Type::getMixed();
}
$source = $statements_checker->getSource();
if ($stmt->var instanceof PhpParser\Node\Expr\Variable
&& $stmt->var->name === 'this'
&& is_string($stmt->name)
&& $source instanceof FunctionLikeChecker
) {
$this_method_id = $source->getMethodId();
if (($this_class = ClassLikeChecker::getThisClass()) &&
(
2016-11-08 01:16:51 +01:00
$this_class === $statements_checker->getFQCLN() ||
ClassChecker::classExtends($this_class, $statements_checker->getFQCLN()) ||
TraitChecker::traitExists($statements_checker->getFQCLN())
2016-11-02 07:29:00 +01:00
)
) {
2016-11-08 01:16:51 +01:00
$method_id = $statements_checker->getFQCLN() . '::' . strtolower($stmt->name);
2016-11-01 19:14:35 +01:00
if ($statements_checker->checkInsideMethod($method_id, $context) === false) {
return false;
}
}
}
if (!$context->check_methods || !$context->check_classes) {
2016-11-02 07:29:00 +01:00
return null;
2016-11-01 19:14:35 +01:00
}
$has_mock = false;
if ($class_type && is_string($stmt->name)) {
/** @var Type\Union|null */
$return_type = null;
foreach ($class_type->types as $type) {
$fq_class_name = $type->value;
2016-11-01 19:14:35 +01:00
$is_mock = ExpressionChecker::isMock($fq_class_name);
2016-11-01 19:14:35 +01:00
$has_mock = $has_mock || $is_mock;
switch ($fq_class_name) {
2016-11-01 19:14:35 +01:00
case 'null':
if (IssueBuffer::accepts(
new NullReference(
'Cannot call method ' . $stmt->name . ' on possibly null variable ' . $var_id,
new CodeLocation($statements_checker->getSource(), $stmt)
2016-11-01 19:14:35 +01:00
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
break;
case 'int':
case 'bool':
case 'false':
case 'array':
case 'string':
if (IssueBuffer::accepts(
new InvalidArgument(
'Cannot call method ' . $stmt->name . ' on ' . $class_type . ' variable ' . $var_id,
new CodeLocation($statements_checker->getSource(), $stmt)
2016-11-01 19:14:35 +01:00
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
break;
case 'mixed':
case 'object':
if (IssueBuffer::accepts(
new MixedMethodCall(
'Cannot call method ' . $stmt->name . ' on a mixed variable ' . $var_id,
new CodeLocation($statements_checker->getSource(), $stmt)
2016-11-01 19:14:35 +01:00
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
break;
case 'static':
$fq_class_name = (string) $context->self;
2016-11-01 19:14:35 +01:00
// fall through to default
default:
if (MethodChecker::methodExists($fq_class_name . '::__call') ||
2016-11-02 07:29:00 +01:00
$is_mock ||
$context->isPhantomClass($fq_class_name)
2016-11-02 07:29:00 +01:00
) {
2016-11-01 19:14:35 +01:00
$return_type = Type::getMixed();
continue;
}
2016-11-08 01:16:51 +01:00
$does_class_exist = ClassLikeChecker::checkFullyQualifiedClassLikeName(
$fq_class_name,
2016-12-08 23:15:51 +01:00
new CodeLocation($statements_checker->getSource(), $stmt->var),
2016-11-01 19:14:35 +01:00
$statements_checker->getSuppressedIssues()
);
if (!$does_class_exist) {
return $does_class_exist;
}
$method_id = $fq_class_name . '::' . strtolower($stmt->name);
$cased_method_id = $fq_class_name . '::' . $stmt->name;
2016-11-01 19:14:35 +01:00
2016-11-02 07:29:00 +01:00
$does_method_exist = MethodChecker::checkMethodExists(
$cased_method_id,
new CodeLocation($statements_checker->getSource(), $stmt),
2016-11-02 07:29:00 +01:00
$statements_checker->getSuppressedIssues()
);
2016-11-01 19:14:35 +01:00
if (!$does_method_exist) {
return $does_method_exist;
}
if (FunctionChecker::inCallMap($cased_method_id)) {
$return_type_candidate = FunctionChecker::getReturnTypeFromCallMap($method_id);
2016-11-02 07:29:00 +01:00
} else {
if (MethodChecker::checkMethodVisibility(
$method_id,
$context->self,
$statements_checker->getSource(),
new CodeLocation($statements_checker->getSource(), $stmt),
2016-11-02 07:29:00 +01:00
$statements_checker->getSuppressedIssues()
) === false) {
2016-11-01 19:14:35 +01:00
return false;
}
2016-11-02 07:29:00 +01:00
if (MethodChecker::checkMethodNotDeprecated(
$method_id,
new CodeLocation($statements_checker->getSource(), $stmt),
2016-11-02 07:29:00 +01:00
$statements_checker->getSuppressedIssues()
) === false) {
2016-11-01 19:14:35 +01:00
return false;
}
$return_type_candidate = MethodChecker::getMethodReturnType($method_id);
2016-11-01 19:14:35 +01:00
}
if ($return_type_candidate) {
2016-11-02 07:29:00 +01:00
$return_type_candidate = ExpressionChecker::fleshOutTypes(
$return_type_candidate,
$stmt->args,
$fq_class_name,
2016-11-02 07:29:00 +01:00
$method_id
);
2016-11-01 19:14:35 +01:00
if (!$return_type) {
$return_type = $return_type_candidate;
2016-11-02 07:29:00 +01:00
} else {
2016-11-01 19:14:35 +01:00
$return_type = Type::combineUnionTypes($return_type_candidate, $return_type);
}
2016-11-02 07:29:00 +01:00
} else {
2016-11-01 19:14:35 +01:00
$return_type = Type::getMixed();
}
}
}
$stmt->inferredType = $return_type;
}
2016-11-02 07:29:00 +01:00
if (self::checkFunctionArguments(
2016-12-07 20:13:39 +01:00
$statements_checker,
$stmt->args,
$method_id,
$context
) === false) {
return false;
}
if (self::checkFunctionArgumentsMatch(
2016-11-02 07:29:00 +01:00
$statements_checker,
$stmt->args,
$method_id,
$context,
new CodeLocation($statements_checker->getSource(), $stmt),
2016-11-02 07:29:00 +01:00
$has_mock
) === false) {
2016-11-01 19:14:35 +01:00
return false;
}
2016-11-02 07:29:00 +01:00
return null;
2016-11-01 19:14:35 +01:00
}
/**
2016-11-02 07:29:00 +01:00
* @param StatementsChecker $statements_checker
* @param PhpParser\Node\Expr\StaticCall $stmt
* @param Context $context
* @return false|null
2016-11-01 19:14:35 +01:00
*/
2016-11-02 07:29:00 +01:00
public static function checkStaticCall(
StatementsChecker $statements_checker,
PhpParser\Node\Expr\StaticCall $stmt,
Context $context
) {
if ($stmt->class instanceof PhpParser\Node\Expr\Variable ||
$stmt->class instanceof PhpParser\Node\Expr\ArrayDimFetch
) {
2016-11-01 19:14:35 +01:00
// this is when calling $some_class::staticMethod() - which is a shitty way of doing things
// because it can't be statically type-checked
2016-11-02 07:29:00 +01:00
return null;
2016-11-01 19:14:35 +01:00
}
$method_id = null;
$fq_class_name = null;
2016-11-01 19:14:35 +01:00
$lhs_type = null;
if ($stmt->class instanceof PhpParser\Node\Name) {
$fq_class_name = null;
2016-11-01 19:14:35 +01:00
if (count($stmt->class->parts) === 1 && in_array($stmt->class->parts[0], ['self', 'static', 'parent'])) {
if ($stmt->class->parts[0] === 'parent') {
$fq_class_name = $statements_checker->getParentClass();
2016-11-05 02:14:04 +01:00
if ($fq_class_name === null) {
2016-11-01 19:14:35 +01:00
if (IssueBuffer::accepts(
2016-11-02 07:29:00 +01:00
new ParentNotFound(
'Cannot call method on parent as this class does not extend another',
new CodeLocation($statements_checker->getSource(), $stmt)
2016-11-02 07:29:00 +01:00
),
2016-11-01 19:14:35 +01:00
$statements_checker->getSuppressedIssues()
)) {
return false;
}
2016-11-05 02:14:04 +01:00
return;
}
2016-11-01 19:14:35 +01:00
} else {
2016-11-05 02:14:04 +01:00
$namespace = $statements_checker->getNamespace()
2016-11-02 07:29:00 +01:00
? $statements_checker->getNamespace() . '\\'
2016-11-05 02:14:04 +01:00
: '';
$fq_class_name = $namespace . $statements_checker->getClassName();
2016-11-01 19:14:35 +01:00
}
if ($context->isPhantomClass($fq_class_name)) {
2016-11-02 07:29:00 +01:00
return null;
2016-11-01 19:14:35 +01:00
}
2016-11-02 07:29:00 +01:00
} elseif ($context->check_classes) {
2016-11-08 01:16:51 +01:00
$fq_class_name = ClassLikeChecker::getFQCLNFromNameObject(
2016-11-01 19:14:35 +01:00
$stmt->class,
$statements_checker->getNamespace(),
$statements_checker->getAliasedClasses()
);
if ($context->isPhantomClass($fq_class_name)) {
2016-11-02 07:29:00 +01:00
return null;
2016-11-01 19:14:35 +01:00
}
2016-11-08 01:16:51 +01:00
$does_class_exist = ClassLikeChecker::checkFullyQualifiedClassLikeName(
$fq_class_name,
2016-12-08 23:15:51 +01:00
new CodeLocation($statements_checker->getSource(), $stmt->class),
2016-11-01 19:14:35 +01:00
$statements_checker->getSuppressedIssues()
);
if (!$does_class_exist) {
return $does_class_exist;
}
}
if ($stmt->class->parts === ['parent'] && is_string($stmt->name)) {
if (ClassLikeChecker::getThisClass()) {
$method_id = $fq_class_name . '::' . strtolower($stmt->name);
2016-11-01 19:14:35 +01:00
if ($statements_checker->checkInsideMethod($method_id, $context) === false) {
return false;
}
}
}
if ($fq_class_name) {
$lhs_type = new Type\Union([new Type\Atomic($fq_class_name)]);
2016-11-01 19:14:35 +01:00
}
2016-11-02 07:29:00 +01:00
} else {
2016-11-01 19:14:35 +01:00
ExpressionChecker::check($statements_checker, $stmt->class, $context);
/** @var Type\Union */
$lhs_type = $stmt->class->inferredType;
}
if (!$context->check_methods || !$lhs_type) {
2016-11-02 07:29:00 +01:00
return null;
2016-11-01 19:14:35 +01:00
}
$has_mock = false;
foreach ($lhs_type->types as $lhs_type_part) {
$fq_class_name = $lhs_type_part->value;
2016-11-01 19:14:35 +01:00
$is_mock = ExpressionChecker::isMock($fq_class_name);
2016-11-01 19:14:35 +01:00
$has_mock = $has_mock || $is_mock;
2016-11-02 07:29:00 +01:00
if (is_string($stmt->name) &&
!MethodChecker::methodExists($fq_class_name . '::__callStatic') &&
2016-11-02 07:29:00 +01:00
!$is_mock
) {
$method_id = $fq_class_name . '::' . strtolower($stmt->name);
$cased_method_id = $fq_class_name . '::' . $stmt->name;
2016-11-01 19:14:35 +01:00
2016-11-02 07:29:00 +01:00
$does_method_exist = MethodChecker::checkMethodExists(
$cased_method_id,
new CodeLocation($statements_checker->getSource(), $stmt),
2016-11-02 07:29:00 +01:00
$statements_checker->getSuppressedIssues()
);
2016-11-01 19:14:35 +01:00
if (!$does_method_exist) {
return $does_method_exist;
}
2016-11-02 07:29:00 +01:00
if (MethodChecker::checkMethodVisibility(
$method_id,
$context->self,
$statements_checker->getSource(),
new CodeLocation($statements_checker->getSource(), $stmt),
2016-11-02 07:29:00 +01:00
$statements_checker->getSuppressedIssues()
) === false) {
2016-11-01 19:14:35 +01:00
return false;
}
if ($stmt->class instanceof PhpParser\Node\Name
&& $stmt->class->parts[0] !== 'parent'
&& $context->self
&& ($statements_checker->isStatic() || !ClassChecker::classExtends($context->self, $fq_class_name))
2016-11-01 19:14:35 +01:00
) {
2016-11-02 07:29:00 +01:00
if (MethodChecker::checkMethodStatic(
$method_id,
new CodeLocation($statements_checker->getSource(), $stmt),
2016-11-02 07:29:00 +01:00
$statements_checker->getSuppressedIssues()
) === false) {
2016-11-01 19:14:35 +01:00
return false;
}
}
2016-11-02 07:29:00 +01:00
if (MethodChecker::checkMethodNotDeprecated(
$method_id,
new CodeLocation($statements_checker->getSource(), $stmt),
2016-11-02 07:29:00 +01:00
$statements_checker->getSuppressedIssues()
) === false) {
2016-11-01 19:14:35 +01:00
return false;
}
$return_types = MethodChecker::getMethodReturnType($method_id);
2016-11-01 19:14:35 +01:00
if ($return_types) {
$return_types = ExpressionChecker::fleshOutTypes(
$return_types,
$stmt->args,
$stmt->class instanceof PhpParser\Node\Name && $stmt->class->parts === ['parent']
2016-11-08 01:16:51 +01:00
? $statements_checker->getFQCLN()
: $fq_class_name,
2016-11-01 19:14:35 +01:00
$method_id
);
if (isset($stmt->inferredType)) {
$stmt->inferredType = Type::combineUnionTypes($stmt->inferredType, $return_types);
2016-11-02 07:29:00 +01:00
} else {
2016-11-01 19:14:35 +01:00
$stmt->inferredType = $return_types;
}
}
}
2016-11-02 07:29:00 +01:00
if (self::checkFunctionArguments(
2016-12-07 20:13:39 +01:00
$statements_checker,
$stmt->args,
$method_id,
$context
) === false) {
return false;
}
if (self::checkFunctionArgumentsMatch(
2016-11-02 07:29:00 +01:00
$statements_checker,
$stmt->args,
$method_id,
$context,
new CodeLocation($statements_checker->getSource(), $stmt),
2016-11-02 07:29:00 +01:00
$has_mock
) === false) {
2016-11-01 19:14:35 +01:00
return false;
}
}
2016-11-02 07:29:00 +01:00
return null;
2016-11-01 19:14:35 +01:00
}
/**
2016-11-02 07:29:00 +01:00
* @param StatementsChecker $statements_checker
* @param array<int, PhpParser\Node\Arg> $args
* @param string|null $method_id
* @param Context $context
* @return false|null
2016-11-01 19:14:35 +01:00
*/
2016-11-02 07:29:00 +01:00
protected static function checkFunctionArguments(
StatementsChecker $statements_checker,
array $args,
$method_id,
2016-12-07 20:13:39 +01:00
Context $context
2016-11-02 07:29:00 +01:00
) {
2016-11-01 19:14:35 +01:00
$function_params = null;
2016-11-05 02:14:04 +01:00
$in_call_map = $method_id ? FunctionChecker::inCallMap($method_id) : false;
2016-11-01 19:14:35 +01:00
if ($method_id) {
2016-11-02 07:29:00 +01:00
$function_params = FunctionLikeChecker::getParamsById(
$method_id,
$args,
$statements_checker->getFileName()
);
2016-11-01 19:14:35 +01:00
}
foreach ($args as $argument_offset => $arg) {
if ($arg->value instanceof PhpParser\Node\Expr\PropertyFetch) {
if ($method_id) {
$by_ref = false;
$by_ref_type = null;
if ($function_params) {
2016-11-02 07:29:00 +01:00
$by_ref = $argument_offset < count($function_params) &&
$function_params[$argument_offset]->by_ref;
$by_ref_type = $by_ref && $argument_offset < count($function_params)
? clone $function_params[$argument_offset]->type
: null;
2016-11-01 19:14:35 +01:00
}
if ($by_ref && $by_ref_type) {
ExpressionChecker::assignByRefParam($statements_checker, $arg->value, $by_ref_type, $context);
2016-11-02 07:29:00 +01:00
} else {
2016-11-01 19:14:35 +01:00
if (FetchChecker::checkPropertyFetch($statements_checker, $arg->value, $context) === false) {
return false;
}
}
2016-11-02 07:29:00 +01:00
} else {
$var_id = ExpressionChecker::getVarId(
$arg->value,
2016-11-08 01:16:51 +01:00
$statements_checker->getFQCLN(),
2016-11-02 07:29:00 +01:00
$statements_checker->getNamespace(),
$statements_checker->getAliasedClasses()
);
2016-11-01 19:14:35 +01:00
2016-11-02 07:29:00 +01:00
if ($var_id &&
(!isset($context->vars_in_scope[$var_id]) || $context->vars_in_scope[$var_id]->isNull())
) {
2016-11-01 19:14:35 +01:00
// we don't know if it exists, assume it's passed by reference
$context->vars_in_scope[$var_id] = Type::getMixed();
$context->vars_possibly_in_scope[$var_id] = true;
$statements_checker->registerVariable('$' . $var_id, $arg->value->getLine());
}
}
2016-11-02 07:29:00 +01:00
} elseif ($arg->value instanceof PhpParser\Node\Expr\Variable) {
2016-11-01 19:14:35 +01:00
if ($method_id) {
$by_ref = false;
$by_ref_type = null;
if ($function_params) {
2016-11-02 07:29:00 +01:00
$by_ref = $argument_offset < count($function_params) &&
$function_params[$argument_offset]->by_ref;
$by_ref_type = $by_ref && $argument_offset < count($function_params)
? clone $function_params[$argument_offset]->type
: null;
2016-11-01 19:14:35 +01:00
}
2016-11-02 07:29:00 +01:00
if (ExpressionChecker::checkVariable(
$statements_checker,
$arg->value,
$context,
$by_ref,
$by_ref_type
) === false) {
2016-11-01 19:14:35 +01:00
return false;
}
} elseif (is_string($arg->value->name)) {
2016-11-02 07:29:00 +01:00
if (false ||
!isset($context->vars_in_scope['$' . $arg->value->name]) ||
$context->vars_in_scope['$' . $arg->value->name]->isNull()
) {
2016-11-01 19:14:35 +01:00
// we don't know if it exists, assume it's passed by reference
$context->vars_in_scope['$' . $arg->value->name] = Type::getMixed();
$context->vars_possibly_in_scope['$' . $arg->value->name] = true;
$statements_checker->registerVariable('$' . $arg->value->name, $arg->value->getLine());
}
}
2016-11-02 07:29:00 +01:00
} else {
2016-11-01 19:14:35 +01:00
if (ExpressionChecker::check($statements_checker, $arg->value, $context) === false) {
return false;
}
}
}
2016-12-07 20:13:39 +01:00
return null;
}
/**
* @param StatementsChecker $statements_checker
* @param array<int, PhpParser\Node\Arg> $args
* @param string|null $method_id
* @param Context $context
* @param CodeLocation $code_location
* @param boolean $is_mock
* @return false|null
*/
protected static function checkFunctionArgumentsMatch(
StatementsChecker $statements_checker,
array $args,
$method_id,
Context $context,
CodeLocation $code_location,
$is_mock = false
) {
2016-11-01 19:14:35 +01:00
// we need to do this calculation after the above vars have already processed
2016-11-02 07:29:00 +01:00
$function_params = $method_id
? FunctionLikeChecker::getParamsById($method_id, $args, $statements_checker->getFileName())
: [];
2016-11-01 19:14:35 +01:00
2016-12-07 20:13:39 +01:00
$in_call_map = $method_id ? FunctionChecker::inCallMap($method_id) : false;
2016-11-01 19:14:35 +01:00
$cased_method_id = $method_id;
2016-12-07 20:13:39 +01:00
$is_variadic = false;
$fq_class_name = null;
if ($method_id) {
if ($in_call_map || !strpos($method_id, '::')) {
$is_variadic = FunctionChecker::isVariadic(strtolower($method_id), $statements_checker->getFileName());
} else {
$fq_class_name = explode('::', $method_id)[0];
$is_variadic = $is_mock || MethodChecker::isVariadic($method_id);
}
}
2016-11-01 19:14:35 +01:00
if ($method_id && strpos($method_id, '::') && !$in_call_map) {
$cased_method_id = MethodChecker::getCasedMethodId($method_id);
}
if ($function_params) {
foreach ($function_params as $function_param) {
$is_variadic = $is_variadic || $function_param->is_variadic;
}
}
$has_packed_var = false;
foreach ($args as $arg) {
$has_packed_var = $has_packed_var || $arg->unpack;
}
foreach ($args as $argument_offset => $arg) {
if ($method_id && $cased_method_id && isset($arg->value->inferredType)) {
if (count($function_params) > $argument_offset) {
$param_type = $function_params[$argument_offset]->type;
// for now stop when we encounter a variadic param pr a packed argument
if ($function_params[$argument_offset]->is_variadic || $arg->unpack) {
break;
}
if (self::checkFunctionArgumentType(
$statements_checker,
$arg->value->inferredType,
ExpressionChecker::fleshOutTypes(
clone $param_type,
[],
$fq_class_name,
2016-11-01 19:14:35 +01:00
$method_id
),
$cased_method_id,
$argument_offset,
new CodeLocation($statements_checker->getSource(), $arg->value)
2016-11-02 07:29:00 +01:00
) === false) {
2016-11-01 19:14:35 +01:00
return false;
}
}
}
}
if ($method_id === 'array_map' || $method_id === 'array_filter') {
$closure_index = $method_id === 'array_map' ? 0 : 1;
$array_arg_types = [];
foreach ($args as $i => $arg) {
if ($i === 0 && $method_id === 'array_map') {
continue;
}
if ($i === 1 && $method_id === 'array_filter') {
break;
}
$array_arg = isset($args[$i]->value) ? $args[$i]->value : null;
$array_arg_types[] = $array_arg
&& isset($array_arg->inferredType)
&& isset($array_arg->inferredType->types['array'])
&& $array_arg->inferredType->types['array'] instanceof Type\Generic
? $array_arg->inferredType->types['array']
: null;
}
2016-12-07 20:13:39 +01:00
/** @var PhpParser\Node\Arg */
$closure_arg = isset($args[$closure_index]) ? $args[$closure_index] : null;
/** @var Type\Union|null */
$closure_arg_type = $closure_arg && isset($closure_arg->value->inferredType)
? $closure_arg->value->inferredType
2016-11-02 07:29:00 +01:00
: null;
2016-11-01 19:14:35 +01:00
2016-12-07 20:13:39 +01:00
if ($closure_arg_type) {
2016-11-01 19:14:35 +01:00
$expected_closure_param_count = $method_id === 'array_filter' ? 1 : count($array_arg_types);
2016-12-07 20:13:39 +01:00
foreach ($closure_arg_type->types as $closure_type) {
if (!$closure_type instanceof Type\Fn) {
2016-11-01 19:14:35 +01:00
continue;
}
2016-12-07 20:13:39 +01:00
if (count($closure_type->parameters) > $expected_closure_param_count) {
2016-11-01 19:14:35 +01:00
if (IssueBuffer::accepts(
2016-12-07 20:13:39 +01:00
new TooManyArguments(
'Too many arguments in closure for ' . ($cased_method_id ?: $method_id),
new CodeLocation($statements_checker->getSource(), $closure_arg)
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
} elseif (count($closure_type->parameters) < $expected_closure_param_count) {
if (IssueBuffer::accepts(
new TooFewArguments(
'You must supply a param in the closure for ' . ($cased_method_id ?: $method_id),
new CodeLocation($statements_checker->getSource(), $closure_arg)
2016-11-01 19:14:35 +01:00
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
}
2016-12-07 20:13:39 +01:00
$closure_params = $closure_type->parameters;
$closure_return_type = $closure_type->return_type;
foreach ($closure_params as $i => $closure_param_type) {
if (!$array_arg_types[$i]) {
continue;
}
/** @var Type\Generic */
$array_arg_type = $array_arg_types[$i];
$input_type = $array_arg_type->type_params[1];
if ($input_type->isMixed()) {
continue;
}
$type_match_found = FunctionLikeChecker::doesParamMatch(
$input_type,
$closure_param_type,
$scalar_type_match_found,
$coerced_type
);
if ($coerced_type) {
2016-11-01 19:14:35 +01:00
if (IssueBuffer::accepts(
2016-12-07 20:13:39 +01:00
new TypeCoercion(
2016-11-02 07:29:00 +01:00
'First parameter of closure passed to function ' . $cased_method_id . ' expects ' .
2016-12-07 20:13:39 +01:00
$closure_param_type . ', parent type ' . $input_type . ' provided',
new CodeLocation($statements_checker->getSource(), $closure_arg)
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
}
if (!$type_match_found) {
if ($scalar_type_match_found) {
if (IssueBuffer::accepts(
new InvalidScalarArgument(
'First parameter of closure passed to function ' . $cased_method_id . ' expects ' .
$closure_param_type . ', ' . $input_type . ' provided',
new CodeLocation($statements_checker->getSource(), $closure_arg)
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
} elseif (IssueBuffer::accepts(
new InvalidArgument(
'First parameter of closure passed to function ' . $cased_method_id . ' expects ' .
$closure_param_type . ', ' . $input_type . ' provided',
new CodeLocation($statements_checker->getSource(), $closure_arg)
2016-11-01 19:14:35 +01:00
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
}
}
}
}
}
if ($method_id) {
if (!$is_variadic
&& count($args) > count($function_params)
&& (!count($function_params) || $function_params[count($function_params) - 1]->name !== '...=')
) {
if (IssueBuffer::accepts(
new TooManyArguments(
'Too many arguments for method ' . ($cased_method_id ?: $method_id),
$code_location
2016-11-01 19:14:35 +01:00
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
2016-11-02 07:29:00 +01:00
return null;
2016-11-01 19:14:35 +01:00
}
if (!$has_packed_var && count($args) < count($function_params)) {
for ($i = count($args); $i < count($function_params); $i++) {
$param = $function_params[$i];
if (!$param->is_optional && !$param->is_variadic) {
if (IssueBuffer::accepts(
2016-11-02 07:29:00 +01:00
new TooFewArguments(
'Too few arguments for method ' . $cased_method_id,
$code_location
2016-11-02 07:29:00 +01:00
),
2016-11-01 19:14:35 +01:00
$statements_checker->getSuppressedIssues()
)) {
return false;
}
break;
}
}
}
}
}
/**
2016-11-02 07:29:00 +01:00
* @param StatementsChecker $statements_checker
* @param Type\Union $input_type
* @param Type\Union $param_type
* @param string $cased_method_id
* @param int $argument_offset
* @param CodeLocation $code_location
2016-11-02 07:29:00 +01:00
* @return null|false
2016-11-01 19:14:35 +01:00
*/
protected static function checkFunctionArgumentType(
StatementsChecker $statements_checker,
Type\Union $input_type,
Type\Union $param_type,
$cased_method_id,
$argument_offset,
CodeLocation $code_location
2016-11-01 19:14:35 +01:00
) {
if ($param_type->isMixed()) {
2016-11-02 07:29:00 +01:00
return null;
2016-11-01 19:14:35 +01:00
}
if ($input_type->isMixed()) {
if (IssueBuffer::accepts(
new MixedArgument(
2016-11-02 07:29:00 +01:00
'Argument ' . ($argument_offset + 1) . ' of ' . $cased_method_id . ' cannot be mixed, expecting ' .
$param_type,
$code_location
2016-11-01 19:14:35 +01:00
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
2016-11-02 07:29:00 +01:00
return null;
2016-11-01 19:14:35 +01:00
}
if ($input_type->isNullable() && !$param_type->isNullable()) {
if (IssueBuffer::accepts(
new NullReference(
2016-11-02 07:29:00 +01:00
'Argument ' . ($argument_offset + 1) . ' of ' . $cased_method_id . ' cannot be null, possibly ' .
'null value provided',
$code_location
2016-11-01 19:14:35 +01:00
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
}
2016-11-02 07:29:00 +01:00
$type_match_found = FunctionLikeChecker::doesParamMatch(
$input_type,
$param_type,
$scalar_type_match_found,
$coerced_type
);
2016-11-01 19:14:35 +01:00
if ($coerced_type) {
if (IssueBuffer::accepts(
new TypeCoercion(
2016-11-02 07:29:00 +01:00
'Argument ' . ($argument_offset + 1) . ' of ' . $cased_method_id . ' expects ' . $param_type .
', parent type ' . $input_type . ' provided',
$code_location
2016-11-01 19:14:35 +01:00
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
}
if (!$type_match_found) {
if ($scalar_type_match_found) {
if (IssueBuffer::accepts(
new InvalidScalarArgument(
2016-11-02 07:29:00 +01:00
'Argument ' . ($argument_offset + 1) . ' of ' . $cased_method_id . ' expects ' . $param_type .
', ' . $input_type . ' provided',
$code_location
2016-11-01 19:14:35 +01:00
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
2016-11-02 07:29:00 +01:00
} elseif (IssueBuffer::accepts(
2016-11-01 19:14:35 +01:00
new InvalidArgument(
2016-11-02 07:29:00 +01:00
'Argument ' . ($argument_offset + 1) . ' of ' . $cased_method_id . ' expects ' . $param_type .
', ' . $input_type . ' provided',
$code_location
2016-11-01 19:14:35 +01:00
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
}
2016-11-02 07:29:00 +01:00
return null;
2016-11-01 19:14:35 +01:00
}
/**
* @param StatementsChecker $statements_checker
* @param string $function_id
* @param Context $context
* @param CodeLocation $code_location
2016-11-01 19:14:35 +01:00
* @return bool
*/
2016-11-02 07:29:00 +01:00
protected static function checkFunctionExists(
StatementsChecker $statements_checker,
$function_id,
Context $context,
CodeLocation $code_location
2016-11-02 07:29:00 +01:00
) {
2016-11-01 19:14:35 +01:00
$cased_function_id = $function_id;
$function_id = strtolower($function_id);
if (!FunctionChecker::functionExists($function_id, $context->file_name)) {
if (IssueBuffer::accepts(
new UndefinedFunction(
'Function ' . $cased_function_id . ' does not exist',
$code_location
2016-11-01 19:14:35 +01:00
),
$statements_checker->getSuppressedIssues()
)) {
return false;
}
}
return true;
}
}