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

3079 lines
114 KiB
PHP
Raw Normal View History

2016-11-01 19:14:35 +01:00
<?php
2018-11-06 03:57:36 +01:00
namespace Psalm\Internal\Analyzer\Statements\Expression;
2016-11-01 19:14:35 +01:00
use PhpParser;
use Psalm\Codebase;
2018-11-06 03:57:36 +01:00
use Psalm\Internal\Analyzer\ClassLikeAnalyzer;
use Psalm\Internal\Analyzer\FunctionLikeAnalyzer;
use Psalm\Internal\Analyzer\MethodAnalyzer;
use Psalm\Internal\Analyzer\Statements\ExpressionAnalyzer;
use Psalm\Internal\Analyzer\StatementsAnalyzer;
use Psalm\Internal\Analyzer\TypeAnalyzer;
use Psalm\Internal\Codebase\CallMap;
use Psalm\Internal\Type\TypeCombination;
use Psalm\CodeLocation;
2016-11-02 07:29:00 +01:00
use Psalm\Context;
2016-12-29 06:14:06 +01:00
use Psalm\Issue\ImplicitToStringCast;
2016-11-01 19:14:35 +01:00
use Psalm\Issue\InvalidArgument;
2017-09-16 19:16:21 +02:00
use Psalm\Issue\InvalidPassByReference;
2016-11-01 19:14:35 +01:00
use Psalm\Issue\InvalidScalarArgument;
use Psalm\Issue\MixedArgument;
use Psalm\Issue\MixedArgumentTypeCoercion;
use Psalm\Issue\NoValue;
use Psalm\Issue\NullArgument;
use Psalm\Issue\PossiblyFalseArgument;
use Psalm\Issue\PossiblyInvalidArgument;
2017-02-11 23:55:08 +01:00
use Psalm\Issue\PossiblyNullArgument;
2016-11-01 19:14:35 +01:00
use Psalm\Issue\TooFewArguments;
use Psalm\Issue\TooManyArguments;
use Psalm\Issue\ArgumentTypeCoercion;
2016-11-01 19:14:35 +01:00
use Psalm\Issue\UndefinedFunction;
use Psalm\IssueBuffer;
2017-02-10 02:35:17 +01:00
use Psalm\Storage\ClassLikeStorage;
use Psalm\Storage\FunctionLikeParameter;
2017-02-10 02:35:17 +01:00
use Psalm\Storage\FunctionLikeStorage;
2016-11-01 19:14:35 +01:00
use Psalm\Type;
use Psalm\Type\Atomic\ObjectLike;
use Psalm\Type\Atomic\TArray;
use Psalm\Type\Atomic\TClassString;
use Psalm\Type\Atomic\TCallable;
2018-11-09 16:56:27 +01:00
use Psalm\Type\Atomic\TEmpty;
use Psalm\Type\Atomic\TNamedObject;
2018-11-09 16:56:27 +01:00
use Psalm\Type\Atomic\TNonEmptyArray;
use function strtolower;
use function strpos;
use function explode;
use function count;
use function in_array;
use function array_reverse;
use function array_filter;
use function is_string;
use function assert;
use function preg_match;
use function preg_replace;
use function is_int;
use function substr;
use function array_merge;
2016-11-01 19:14:35 +01:00
/**
* @internal
*/
2018-11-06 03:57:36 +01:00
class CallAnalyzer
2016-11-01 19:14:35 +01:00
{
2017-02-10 02:35:17 +01:00
/**
2018-11-06 03:57:36 +01:00
* @param FunctionLikeAnalyzer $source
2017-02-10 02:35:17 +01:00
* @param string $method_name
* @param Context $context
2017-05-27 02:16:18 +02:00
*
* @return void
2017-02-10 02:35:17 +01:00
*/
public static function collectSpecialInformation(
2018-11-06 03:57:36 +01:00
FunctionLikeAnalyzer $source,
2017-02-10 02:35:17 +01:00
$method_name,
Context $context
) {
$fq_class_name = (string)$source->getFQCLN();
2016-11-02 07:29:00 +01:00
2018-11-11 18:01:14 +01:00
$project_analyzer = $source->getFileAnalyzer()->project_analyzer;
2018-11-06 03:57:36 +01:00
$codebase = $source->getCodebase();
2017-02-10 02:35:17 +01:00
if ($context->collect_mutations &&
$context->self &&
(
$context->self === $fq_class_name ||
2018-02-01 06:50:01 +01:00
$codebase->classExtends(
2017-02-10 02:35:17 +01:00
$context->self,
$fq_class_name
)
)
) {
$method_id = $fq_class_name . '::' . strtolower($method_name);
if ($method_id !== $source->getMethodId()) {
2018-01-24 19:38:53 +01:00
if ($context->collect_initializations) {
if (isset($context->initialized_methods[$method_id])) {
return;
}
if ($context->initialized_methods === null) {
$context->initialized_methods = [];
}
$context->initialized_methods[$method_id] = true;
}
$project_analyzer->getMethodMutations(
$method_id,
$context,
$source->getRootFilePath(),
$source->getRootFileName()
);
}
2017-02-10 02:35:17 +01:00
} elseif ($context->collect_initializations &&
$context->self &&
(
$context->self === $fq_class_name
|| $codebase->classlikes->classExtends(
2017-02-10 02:35:17 +01:00
$context->self,
$fq_class_name
)
) &&
$source->getMethodName() !== $method_name
2017-02-10 02:35:17 +01:00
) {
$method_id = $fq_class_name . '::' . strtolower($method_name);
2019-01-09 14:35:53 +01:00
$declaring_method_id = $codebase->methods->getDeclaringMethodId($method_id);
if (isset($context->vars_in_scope['$this'])) {
foreach ($context->vars_in_scope['$this']->getTypes() as $atomic_type) {
if ($atomic_type instanceof TNamedObject) {
if ($fq_class_name === $atomic_type->value) {
$alt_declaring_method_id = $declaring_method_id;
} else {
2019-01-09 14:35:53 +01:00
$fq_class_name = $atomic_type->value;
2019-01-09 14:35:53 +01:00
$method_id = $fq_class_name . '::' . strtolower($method_name);
$alt_declaring_method_id = $codebase->methods->getDeclaringMethodId($method_id);
}
2019-01-09 14:35:53 +01:00
if ($alt_declaring_method_id) {
$declaring_method_id = $alt_declaring_method_id;
break;
}
2019-01-09 14:35:53 +01:00
if (!$atomic_type->extra_types) {
continue;
}
2019-01-09 14:35:53 +01:00
foreach ($atomic_type->extra_types as $intersection_type) {
if ($intersection_type instanceof TNamedObject) {
$fq_class_name = $intersection_type->value;
$method_id = $fq_class_name . '::' . strtolower($method_name);
2019-01-09 14:35:53 +01:00
$alt_declaring_method_id = $codebase->methods->getDeclaringMethodId($method_id);
2019-01-09 14:35:53 +01:00
if ($alt_declaring_method_id) {
$declaring_method_id = $alt_declaring_method_id;
break 2;
2019-01-09 14:35:53 +01:00
}
}
}
}
}
}
2019-01-09 14:35:53 +01:00
if (!$declaring_method_id) {
// can happen for __call
return;
2019-01-09 14:35:53 +01:00
}
2017-02-10 02:35:17 +01:00
if (isset($context->initialized_methods[$declaring_method_id])) {
return;
}
if ($context->initialized_methods === null) {
$context->initialized_methods = [];
}
$context->initialized_methods[$declaring_method_id] = true;
2018-02-04 00:52:35 +01:00
$method_storage = $codebase->methods->getStorage($declaring_method_id);
2017-02-10 02:35:17 +01:00
2018-11-11 18:01:14 +01:00
$class_analyzer = $source->getSource();
2017-02-10 02:35:17 +01:00
if ($class_analyzer instanceof ClassLikeAnalyzer && !$method_storage->is_static) {
2017-02-10 02:35:17 +01:00
$local_vars_in_scope = [];
$local_vars_possibly_in_scope = [];
foreach ($context->vars_in_scope as $var => $_) {
2017-02-10 02:35:17 +01:00
if (strpos($var, '$this->') !== 0 && $var !== '$this') {
$local_vars_in_scope[$var] = $context->vars_in_scope[$var];
}
}
foreach ($context->vars_possibly_in_scope as $var => $_) {
2017-02-10 02:35:17 +01:00
if (strpos($var, '$this->') !== 0 && $var !== '$this') {
$local_vars_possibly_in_scope[$var] = $context->vars_possibly_in_scope[$var];
}
}
if ($fq_class_name === $source->getFQCLN()) {
$class_analyzer->getMethodMutations(strtolower($method_name), $context);
} else {
list($declaring_fq_class_name) = explode('::', $declaring_method_id);
$old_self = $context->self;
$context->self = $declaring_fq_class_name;
$project_analyzer->getMethodMutations(
$declaring_method_id,
$context,
$source->getRootFilePath(),
$source->getRootFileName()
);
$context->self = $old_self;
}
2017-02-10 02:35:17 +01:00
foreach ($local_vars_in_scope as $var => $type) {
$context->vars_in_scope[$var] = $type;
}
2018-01-28 18:43:19 +01:00
foreach ($local_vars_possibly_in_scope as $var => $_) {
2017-12-03 00:28:18 +01:00
$context->vars_possibly_in_scope[$var] = true;
2017-02-10 02:35:17 +01:00
}
}
}
2016-11-01 19:14:35 +01:00
}
2017-02-10 02:35:17 +01:00
/**
* @param string|null $method_id
* @param array<int, PhpParser\Node\Arg> $args
* @param array<string, array<string, array{Type\Union, 1?:int}>>|null &$generic_params
2017-02-10 02:35:17 +01:00
* @param Context $context
* @param CodeLocation $code_location
2018-11-11 18:01:14 +01:00
* @param StatementsAnalyzer $statements_analyzer
2017-05-27 02:16:18 +02:00
*
2017-02-10 02:35:17 +01:00
* @return false|null
*/
protected static function checkMethodArgs(
$method_id,
array $args,
&$generic_params,
2017-02-10 02:35:17 +01:00
Context $context,
CodeLocation $code_location,
2018-11-11 18:01:14 +01:00
StatementsAnalyzer $statements_analyzer
2017-02-10 02:35:17 +01:00
) {
$codebase = $statements_analyzer->getCodebase();
2017-02-10 02:35:17 +01:00
$method_params = $method_id
? $codebase->methods->getMethodParams($method_id, $statements_analyzer, $args, $context)
2017-02-10 02:35:17 +01:00
: null;
if (self::checkFunctionArguments(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
2017-02-10 02:35:17 +01:00
$args,
$method_params,
$method_id,
$context,
$generic_params
2017-02-10 02:35:17 +01:00
) === false) {
return false;
}
if (!$method_id || $method_params === null) {
return;
}
list($fq_class_name, $method_name) = explode('::', $method_id);
$fq_class_name = $codebase->classlikes->getUnAliasedName($fq_class_name);
$class_storage = $codebase->classlike_storage_provider->get($fq_class_name);
2017-11-02 20:07:39 +01:00
$method_storage = null;
if (isset($class_storage->declaring_method_ids[strtolower($method_name)])) {
$declaring_method_id = $class_storage->declaring_method_ids[strtolower($method_name)];
list($declaring_fq_class_name, $declaring_method_name) = explode('::', $declaring_method_id);
if ($declaring_fq_class_name !== $fq_class_name) {
$declaring_class_storage = $codebase->classlike_storage_provider->get($declaring_fq_class_name);
2017-11-02 20:07:39 +01:00
} else {
$declaring_class_storage = $class_storage;
}
if (!isset($declaring_class_storage->methods[strtolower($declaring_method_name)])) {
throw new \UnexpectedValueException('Storage should not be empty here');
}
$method_storage = $declaring_class_storage->methods[strtolower($declaring_method_name)];
if ($declaring_class_storage->user_defined
&& !$method_storage->has_docblock_param_types
&& isset($declaring_class_storage->documenting_method_ids[$method_name])
) {
$documenting_method_id = $declaring_class_storage->documenting_method_ids[$method_name];
$documenting_method_storage = $codebase->methods->getStorage($documenting_method_id);
if ($documenting_method_storage->template_types) {
$method_storage = $documenting_method_storage;
}
}
if (!$context->isSuppressingExceptions($statements_analyzer)) {
$context->mergeFunctionExceptions($method_storage, $code_location);
}
2017-11-02 20:07:39 +01:00
}
2017-02-10 02:35:17 +01:00
if (self::checkFunctionLikeArgumentsMatch(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$args,
$method_id,
$method_params,
$method_storage,
$class_storage,
$generic_params,
$code_location,
$context
) === false) {
return false;
2016-11-01 19:14:35 +01:00
}
2016-11-02 07:29:00 +01:00
return null;
2016-11-01 19:14:35 +01:00
}
/**
2018-11-11 18:01:14 +01:00
* @param StatementsAnalyzer $statements_analyzer
* @param array<int, PhpParser\Node\Arg> $args
2017-01-01 23:39:39 +01:00
* @param array<int, FunctionLikeParameter>|null $function_params
* @param array<string, array<string, array{Type\Union, 1?:int}>>|null $generic_params
* @param string|null $method_id
* @param Context $context
2017-05-27 02:16:18 +02:00
*
2016-11-02 07:29:00 +01:00
* @return false|null
2016-11-01 19:14:35 +01:00
*/
2016-11-02 07:29:00 +01:00
protected static function checkFunctionArguments(
2018-11-11 18:01:14 +01:00
StatementsAnalyzer $statements_analyzer,
2016-11-02 07:29:00 +01:00
array $args,
2017-05-05 03:57:26 +02:00
$function_params,
$method_id,
Context $context,
$generic_params = null
2016-11-02 07:29:00 +01:00
) {
$last_param = $function_params
? $function_params[count($function_params) - 1]
: null;
// if this modifies the array type based on further args
if ($method_id && in_array($method_id, ['array_push', 'array_unshift'], true) && $function_params) {
if (self::handleArrayAddition($statements_analyzer, $args, $context) === false) {
return false;
}
return;
}
if ($method_id && $method_id === 'array_splice' && $function_params && count($args) > 1) {
if (self::handleArraySplice($statements_analyzer, $args, $context) === false) {
return false;
}
2016-11-01 19:14:35 +01:00
return;
}
if ($method_id === 'array_map' && count($args) === 2) {
$args = array_reverse($args, true);
}
foreach ($args as $argument_offset => $arg) {
if ($function_params !== null) {
$param = $argument_offset < count($function_params)
? $function_params[$argument_offset]
: ($last_param && $last_param->is_variadic ? $last_param : null);
2016-11-01 19:14:35 +01:00
$by_ref = $param && $param->by_ref;
$by_ref_type = null;
if ($by_ref && $param) {
$by_ref_type = $param->type ? clone $param->type : Type::getMixed();
}
if ($by_ref
&& $by_ref_type
&& !($arg->value instanceof PhpParser\Node\Expr\Closure
|| $arg->value instanceof PhpParser\Node\Expr\ConstFetch
2019-06-07 19:23:52 +02:00
|| $arg->value instanceof PhpParser\Node\Expr\ClassConstFetch
|| $arg->value instanceof PhpParser\Node\Expr\FuncCall
|| $arg->value instanceof PhpParser\Node\Expr\MethodCall
|| $arg->value instanceof PhpParser\Node\Expr\StaticCall
|| $arg->value instanceof PhpParser\Node\Expr\Assign
|| $arg->value instanceof PhpParser\Node\Expr\Array_
)
) {
if (self::handleByRefFunctionArg(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$method_id,
$argument_offset,
$arg,
$context
) === false) {
return false;
}
continue;
}
$toggled_class_exists = false;
if ($method_id === 'class_exists'
&& $argument_offset === 0
&& !$context->inside_class_exists
) {
$context->inside_class_exists = true;
$toggled_class_exists = true;
}
2016-11-01 19:14:35 +01:00
$codebase = $statements_analyzer->getCodebase();
if ($arg->value instanceof PhpParser\Node\Expr\Closure
&& $generic_params
&& $param
&& $param->type
&& !$arg->value->getDocComment()
&& !array_filter(
$arg->value->params,
function (PhpParser\Node\Param $closure_param) : bool {
return !!$closure_param->type;
}
)
) {
if (count($args) === 2
&& (($argument_offset === 1 && $method_id === 'array_filter')
|| ($argument_offset === 0 && $method_id === 'array_map'))
) {
$replaced_type = new Type\Union([
new Type\Atomic\TCallable(
'callable',
[
new \Psalm\Storage\FunctionLikeParameter(
'function',
false,
new Type\Union([
new Type\Atomic\TTemplateParam(
'ArrayValue',
Type::getMixed()
)
])
)
]
)
]);
} else {
$replaced_type = clone $param->type;
}
$empty_generic_params = [];
$replaced_type->replaceTemplateTypesWithStandins(
$generic_params,
$empty_generic_params,
$codebase,
null
);
$replaced_type->replaceTemplateTypesWithArgTypes(
$generic_params
);
$closure_id = $statements_analyzer->getFilePath()
. ':' . $arg->value->getLine()
. ':' . (int)$arg->value->getAttribute('startFilePos')
. ':-:closure';
$closure_storage = $codebase->getClosureStorage($statements_analyzer->getFilePath(), $closure_id);
foreach ($replaced_type->getTypes() as $replaced_type_part) {
if ($replaced_type_part instanceof Type\Atomic\TCallable
|| $replaced_type_part instanceof Type\Atomic\TFn
) {
foreach ($closure_storage->params as $closure_param_offset => $param_storage) {
if (isset($replaced_type_part->params[$closure_param_offset]->type)
&& !$replaced_type_part->params[$closure_param_offset]->type->hasTemplate()
) {
$param_storage->type = $replaced_type_part->params[$closure_param_offset]->type;
}
}
}
}
}
$was_inside_call = $context->inside_call;
$context->inside_call = true;
if (ExpressionAnalyzer::analyze($statements_analyzer, $arg->value, $context) === false) {
return false;
}
if (!$was_inside_call) {
$context->inside_call = false;
}
if (count($args) === 2
&& (($argument_offset === 0 && $method_id === 'array_filter')
|| ($argument_offset === 1 || $method_id === 'array_map'))
) {
$generic_param_type = new Type\Union([
new Type\Atomic\TArray([
Type::getArrayKey(),
new Type\Union([
new Type\Atomic\TTemplateParam(
'ArrayValue',
Type::getMixed()
)
])
])
]);
$template_types = ['ArrayValue' => ['' => [Type::getMixed()]]];
if ($generic_params === null) {
$generic_params = [];
}
$generic_param_type->replaceTemplateTypesWithStandins(
$template_types,
$generic_params,
$codebase,
isset($arg->value->inferredType)
? $arg->value->inferredType
: null
);
}
if ($context->collect_references
&& ($arg->value instanceof PhpParser\Node\Expr\AssignOp
|| $arg->value instanceof PhpParser\Node\Expr\PreInc
|| $arg->value instanceof PhpParser\Node\Expr\PreDec)
) {
$var_id = ExpressionAnalyzer::getVarId(
$arg->value->var,
$statements_analyzer->getFQCLN(),
$statements_analyzer
);
if ($var_id) {
$context->hasVariable($var_id, $statements_analyzer);
}
}
if ($toggled_class_exists) {
$context->inside_class_exists = false;
}
continue;
}
if (self::evaluateAribitraryParam(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$arg,
$context
) === false) {
return false;
}
}
}
/**
* @return false|null
*/
private static function evaluateAribitraryParam(
StatementsAnalyzer $statements_analyzer,
PhpParser\Node\Arg $arg,
Context $context
) {
// there are a bunch of things we want to evaluate even when we don't
// know what function/method is being called
if ($arg->value instanceof PhpParser\Node\Expr\Closure
|| $arg->value instanceof PhpParser\Node\Expr\ConstFetch
2019-06-07 19:23:52 +02:00
|| $arg->value instanceof PhpParser\Node\Expr\ClassConstFetch
|| $arg->value instanceof PhpParser\Node\Expr\FuncCall
|| $arg->value instanceof PhpParser\Node\Expr\MethodCall
|| $arg->value instanceof PhpParser\Node\Expr\StaticCall
|| $arg->value instanceof PhpParser\Node\Expr\Assign
|| $arg->value instanceof PhpParser\Node\Expr\ArrayDimFetch
|| $arg->value instanceof PhpParser\Node\Expr\PropertyFetch
|| $arg->value instanceof PhpParser\Node\Expr\Array_
2019-07-23 00:04:52 +02:00
|| $arg->value instanceof PhpParser\Node\Expr\BinaryOp
) {
if (ExpressionAnalyzer::analyze($statements_analyzer, $arg->value, $context) === false) {
return false;
}
}
if ($arg->value instanceof PhpParser\Node\Expr\PropertyFetch
&& $arg->value->name instanceof PhpParser\Node\Identifier
) {
$var_id = '$' . $arg->value->name->name;
} else {
$var_id = ExpressionAnalyzer::getVarId(
$arg->value,
$statements_analyzer->getFQCLN(),
$statements_analyzer
);
}
if ($var_id) {
if (!$context->hasVariable($var_id, $statements_analyzer)
|| $context->vars_in_scope[$var_id]->isNull()
) {
// 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;
if (strpos($var_id, '-') === false
&& strpos($var_id, '[') === false
&& !$statements_analyzer->hasVariable($var_id)
) {
$location = new CodeLocation($statements_analyzer, $arg->value);
$statements_analyzer->registerVariable(
$var_id,
$location,
null
);
$statements_analyzer->registerVariableUses([$location->getHash() => $location]);
}
} else {
$context->removeVarFromConflictingClauses(
$var_id,
$context->vars_in_scope[$var_id],
$statements_analyzer
);
foreach ($context->vars_in_scope[$var_id]->getTypes() as $type) {
if ($type instanceof TArray && $type->type_params[1]->isEmpty()) {
$context->vars_in_scope[$var_id]->removeType('array');
$context->vars_in_scope[$var_id]->addType(
new TArray(
[Type::getArrayKey(), Type::getMixed()]
)
);
}
}
}
}
}
/**
* @param string|null $method_id
* @return false|null
*/
private static function handleByRefFunctionArg(
StatementsAnalyzer $statements_analyzer,
$method_id,
int $argument_offset,
PhpParser\Node\Arg $arg,
Context $context
) {
$var_id = ExpressionAnalyzer::getVarId(
$arg->value,
$statements_analyzer->getFQCLN(),
$statements_analyzer
);
$builtin_array_functions = [
'shuffle', 'sort', 'rsort', 'usort', 'ksort', 'asort',
'krsort', 'arsort', 'natcasesort', 'natsort', 'reset',
'end', 'next', 'prev', 'array_pop', 'array_shift',
];
if (($var_id && isset($context->vars_in_scope[$var_id]))
|| ($method_id
&& in_array(
$method_id,
$builtin_array_functions,
true
))
) {
// if the variable is in scope, get or we're in a special array function,
// figure out its type before proceeding
2018-11-06 03:57:36 +01:00
if (ExpressionAnalyzer::analyze(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$arg->value,
$context
) === false) {
return false;
}
}
// special handling for array sort
if ($argument_offset === 0
&& $method_id
&& in_array(
$method_id,
$builtin_array_functions,
true
)
) {
if (in_array($method_id, ['array_pop', 'array_shift'], true)) {
self::handleByRefArrayAdjustment($statements_analyzer, $arg, $context);
return;
}
// noops
if (in_array($method_id, ['reset', 'end', 'next', 'prev', 'ksort'], true)) {
return;
}
if (isset($arg->value->inferredType)
&& $arg->value->inferredType->hasArray()
) {
/** @var TArray|ObjectLike */
$array_type = $arg->value->inferredType->getTypes()['array'];
if ($array_type instanceof ObjectLike) {
$array_type = $array_type->getGenericArrayType();
}
if (in_array($method_id, ['shuffle', 'sort', 'rsort', 'usort'], true)) {
$tvalue = $array_type->type_params[1];
$by_ref_type = new Type\Union([new TArray([Type::getInt(), clone $tvalue])]);
} else {
$by_ref_type = new Type\Union([clone $array_type]);
}
2018-11-06 03:57:36 +01:00
ExpressionAnalyzer::assignByRefParam(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$arg->value,
$by_ref_type,
$by_ref_type,
$context,
false
);
return;
}
}
if ($method_id === 'socket_select') {
if (ExpressionAnalyzer::analyze(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$arg->value,
$context
) === false) {
return false;
}
}
}
/**
* @param StatementsAnalyzer $statements_analyzer
* @param array<int, PhpParser\Node\Arg> $args
* @param Context $context
*
* @return false|null
*/
private static function handleArrayAddition(
StatementsAnalyzer $statements_analyzer,
array $args,
Context $context
) {
$array_arg = $args[0]->value;
if (ExpressionAnalyzer::analyze(
$statements_analyzer,
$array_arg,
$context
) === false) {
return false;
}
if (isset($array_arg->inferredType) && $array_arg->inferredType->hasArray()) {
/** @var TArray|ObjectLike */
$array_type = $array_arg->inferredType->getTypes()['array'];
if ($array_type instanceof ObjectLike) {
$array_type = $array_type->getGenericArrayType();
}
$by_ref_type = new Type\Union([clone $array_type]);
foreach ($args as $argument_offset => $arg) {
if ($argument_offset === 0) {
continue;
2016-11-01 19:14:35 +01:00
}
if (ExpressionAnalyzer::analyze(
$statements_analyzer,
$arg->value,
$context
) === false) {
return false;
}
if (!isset($arg->value->inferredType) || $arg->value->inferredType->hasMixed()) {
$by_ref_type = Type::combineUnionTypes(
$by_ref_type,
new Type\Union([new TArray([Type::getInt(), Type::getMixed()])])
);
} elseif ($arg->unpack) {
$by_ref_type = Type::combineUnionTypes(
$by_ref_type,
clone $arg->value->inferredType
);
} else {
$by_ref_type = Type::combineUnionTypes(
$by_ref_type,
new Type\Union(
[
new TArray(
[
Type::getInt(),
clone $arg->value->inferredType
]
),
]
)
);
}
}
ExpressionAnalyzer::assignByRefParam(
$statements_analyzer,
$array_arg,
$by_ref_type,
$by_ref_type,
$context,
false
);
}
return;
}
/**
* @param StatementsAnalyzer $statements_analyzer
* @param array<int, PhpParser\Node\Arg> $args
* @param Context $context
*
* @return false|null
*/
private static function handleArraySplice(
StatementsAnalyzer $statements_analyzer,
array $args,
Context $context
) {
$array_arg = $args[0]->value;
if (ExpressionAnalyzer::analyze(
$statements_analyzer,
$array_arg,
$context
) === false) {
return false;
}
$offset_arg = $args[1]->value;
if (ExpressionAnalyzer::analyze(
$statements_analyzer,
$offset_arg,
$context
) === false) {
return false;
}
if (!isset($args[2])) {
return;
}
2016-11-01 19:14:35 +01:00
$length_arg = $args[2]->value;
if (ExpressionAnalyzer::analyze(
$statements_analyzer,
$length_arg,
$context
) === false) {
return false;
}
if (!isset($args[3])) {
return;
}
$replacement_arg = $args[3]->value;
if (ExpressionAnalyzer::analyze(
$statements_analyzer,
$replacement_arg,
$context
) === false) {
return false;
}
if (isset($replacement_arg->inferredType)
&& !$replacement_arg->inferredType->hasArray()
&& $replacement_arg->inferredType->hasString()
&& $replacement_arg->inferredType->isSingle()
) {
$replacement_arg->inferredType = new Type\Union([
new Type\Atomic\TArray([Type::getInt(), $replacement_arg->inferredType])
]);
}
if (isset($array_arg->inferredType)
&& $array_arg->inferredType->hasArray()
&& isset($replacement_arg->inferredType)
&& $replacement_arg->inferredType->hasArray()
) {
/** @var TArray|ObjectLike */
$array_type = $array_arg->inferredType->getTypes()['array'];
if ($array_type instanceof ObjectLike) {
$array_type = $array_type->getGenericArrayType();
}
2018-01-29 00:13:38 +01:00
/** @var TArray|ObjectLike */
$replacement_array_type = $replacement_arg->inferredType->getTypes()['array'];
if ($replacement_array_type instanceof ObjectLike) {
$replacement_array_type = $replacement_array_type->getGenericArrayType();
2016-11-01 19:14:35 +01:00
}
$by_ref_type = TypeCombination::combineTypes([$array_type, $replacement_array_type]);
ExpressionAnalyzer::assignByRefParam(
$statements_analyzer,
$array_arg,
$by_ref_type,
$by_ref_type,
$context,
false
);
return;
2016-11-01 19:14:35 +01:00
}
$array_type = Type::getArray();
ExpressionAnalyzer::assignByRefParam(
$statements_analyzer,
$array_arg,
$array_type,
$array_type,
$context,
false
);
2016-12-07 20:13:39 +01:00
}
/**
* @return void
*/
private static function handleByRefArrayAdjustment(
StatementsAnalyzer $statements_analyzer,
PhpParser\Node\Arg $arg,
Context $context
) {
$var_id = ExpressionAnalyzer::getVarId(
$arg->value,
$statements_analyzer->getFQCLN(),
$statements_analyzer
);
if ($var_id) {
$context->removeVarFromConflictingClauses($var_id, null, $statements_analyzer);
if (isset($context->vars_in_scope[$var_id])) {
$array_type = clone $context->vars_in_scope[$var_id];
$array_atomic_types = $array_type->getTypes();
foreach ($array_atomic_types as $array_atomic_type) {
if ($array_atomic_type instanceof ObjectLike) {
$generic_array_type = $array_atomic_type->getGenericArrayType();
if ($generic_array_type instanceof TNonEmptyArray) {
if (!$context->inside_loop && $generic_array_type->count !== null) {
if ($generic_array_type->count === 0) {
$generic_array_type = new TArray(
[
new Type\Union([new TEmpty]),
new Type\Union([new TEmpty]),
]
);
} else {
$generic_array_type->count--;
}
} else {
$generic_array_type = new TArray($generic_array_type->type_params);
}
}
$array_type->addType($generic_array_type);
} elseif ($array_atomic_type instanceof TNonEmptyArray) {
if (!$context->inside_loop && $array_atomic_type->count !== null) {
if ($array_atomic_type->count === 0) {
$array_atomic_type = new TArray(
[
new Type\Union([new TEmpty]),
new Type\Union([new TEmpty]),
]
);
} else {
$array_atomic_type->count--;
}
} else {
$array_atomic_type = new TArray($array_atomic_type->type_params);
}
$array_type->addType($array_atomic_type);
}
}
$context->vars_in_scope[$var_id] = $array_type;
}
}
}
2016-12-07 20:13:39 +01:00
/**
2018-11-11 18:01:14 +01:00
* @param StatementsAnalyzer $statements_analyzer
* @param array<int, PhpParser\Node\Arg> $args
* @param string|null $method_id
2017-02-10 02:35:17 +01:00
* @param array<int,FunctionLikeParameter> $function_params
* @param FunctionLikeStorage|null $function_storage
* @param ClassLikeStorage|null $class_storage
* @param array<string, array<string, array{Type\Union, 1?:int}>>|null $generic_params
* @param CodeLocation $code_location
* @param Context $context
2017-05-27 02:16:18 +02:00
*
2016-12-07 20:13:39 +01:00
* @return false|null
*/
protected static function checkFunctionLikeArgumentsMatch(
2018-11-11 18:01:14 +01:00
StatementsAnalyzer $statements_analyzer,
2016-12-07 20:13:39 +01:00
array $args,
$method_id,
2017-02-10 02:35:17 +01:00
array $function_params,
$function_storage,
$class_storage,
&$generic_params,
CodeLocation $code_location,
Context $context
2016-12-07 20:13:39 +01:00
) {
2018-02-04 00:52:35 +01:00
$in_call_map = $method_id ? CallMap::inCallMap($method_id) : false;
2016-12-07 20:13:39 +01:00
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;
2018-11-11 18:01:14 +01:00
$codebase = $statements_analyzer->getCodebase();
2016-12-07 20:13:39 +01:00
if ($method_id) {
if ($in_call_map || !strpos($method_id, '::')) {
2018-02-04 00:52:35 +01:00
$is_variadic = $codebase->functions->isVariadic(
2018-11-06 03:57:36 +01:00
$codebase,
strtolower($method_id),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getRootFilePath()
);
2016-12-07 20:13:39 +01:00
} else {
$fq_class_name = explode('::', $method_id)[0];
2018-02-04 00:52:35 +01:00
$is_variadic = $codebase->methods->isVariadic($method_id);
2016-12-07 20:13:39 +01:00
}
}
if ($method_id && strpos($method_id, '::')) {
$codebase->methods->getCasedMethodId($method_id);
} elseif ($function_storage) {
$cased_method_id = $function_storage->cased_name;
2016-11-01 19:14:35 +01:00
}
$calling_class_storage = $class_storage;
$static_fq_class_name = $fq_class_name;
$self_fq_class_name = $fq_class_name;
if ($method_id && strpos($method_id, '::')) {
2018-02-04 00:52:35 +01:00
$declaring_method_id = $codebase->methods->getDeclaringMethodId($method_id);
if ($declaring_method_id && $declaring_method_id !== $method_id) {
list($self_fq_class_name) = explode('::', $declaring_method_id);
$class_storage = $codebase->classlike_storage_provider->get($self_fq_class_name);
}
$appearing_method_id = $codebase->methods->getAppearingMethodId($method_id);
if ($appearing_method_id && $declaring_method_id !== $appearing_method_id) {
list($self_fq_class_name) = explode('::', $appearing_method_id);
}
}
2016-11-01 19:14:35 +01:00
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;
}
$last_param = $function_params
? $function_params[count($function_params) - 1]
: null;
2017-02-10 02:35:17 +01:00
$template_types = null;
if ($function_storage) {
2019-01-13 00:18:23 +01:00
$template_types = self::getTemplateTypesForFunction(
$function_storage,
$class_storage,
$calling_class_storage
);
2019-01-20 00:11:39 +01:00
if ($template_types) {
foreach ($args as $argument_offset => $arg) {
$function_param = count($function_params) > $argument_offset
? $function_params[$argument_offset]
: ($last_param && $last_param->is_variadic ? $last_param : null);
if (!$function_param
|| !$function_param->type
|| !isset($arg->value->inferredType)
) {
continue;
}
$empty_generic_params = [];
$function_param->type->replaceTemplateTypesWithStandins(
$template_types,
$empty_generic_params,
$codebase,
$arg->value->inferredType,
false
);
2016-11-01 19:14:35 +01:00
}
}
}
$existing_generic_params = $generic_params ?: [];
foreach ($existing_generic_params as $template_name => $type_map) {
foreach ($type_map as $class => $type) {
$existing_generic_params[$template_name][$class][0] = clone $type[0];
}
}
$function_param_count = count($function_params);
foreach ($args as $argument_offset => $arg) {
$function_param = $function_param_count > $argument_offset
? $function_params[$argument_offset]
: ($last_param && $last_param->is_variadic ? $last_param : null);
if ($function_param
&& $function_param->by_ref
&& $method_id !== 'extract'
) {
if (self::handlePossiblyMatchingByRefParam(
$statements_analyzer,
$codebase,
$method_id,
$cased_method_id,
$last_param,
$function_params,
$function_storage,
$argument_offset,
$arg,
$context,
$generic_params,
$template_types
) === false) {
2019-06-30 18:06:49 +02:00
return;
}
2016-11-01 19:14:35 +01:00
}
if (self::checkFunctionLikeArgumentMatches(
$statements_analyzer,
$cased_method_id,
$self_fq_class_name,
$static_fq_class_name,
$function_param,
$argument_offset,
$arg,
$context,
$existing_generic_params,
$generic_params,
$template_types
) === false) {
return false;
}
2016-11-01 19:14:35 +01:00
}
2017-02-10 02:35:17 +01:00
if ($method_id === 'array_map' || $method_id === 'array_filter') {
if ($method_id === 'array_map' && count($args) < 2) {
if (IssueBuffer::accepts(
new TooFewArguments(
'Too few arguments for ' . $method_id,
$code_location,
$method_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
2019-06-30 18:06:49 +02:00
// fall through
}
} elseif ($method_id === 'array_filter' && count($args) < 1) {
if (IssueBuffer::accepts(
new TooFewArguments(
'Too few arguments for ' . $method_id,
$code_location,
$method_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
2019-06-30 18:06:49 +02:00
// fall through
}
}
if (self::checkArrayFunctionArgumentsMatch(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$args,
$method_id,
$context->check_functions
) === false
) {
return false;
}
2019-06-30 18:06:49 +02:00
return null;
}
2017-02-10 02:35:17 +01:00
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)
. ' - expecting ' . count($function_params) . ' but saw ' . count($args),
$code_location,
$method_id ?: ''
2017-02-10 02:35:17 +01:00
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2017-02-10 02:35:17 +01:00
)) {
// fall through
}
2017-02-10 02:35:17 +01:00
return null;
}
2017-02-10 02:35:17 +01:00
if (!$has_packed_var && count($args) < count($function_params)) {
if ($function_storage) {
$expected_param_count = $function_storage->required_param_count;
} else {
for ($i = 0, $j = count($function_params); $i < $j; ++$i) {
$param = $function_params[$i];
if ($param->is_optional || $param->is_variadic) {
break;
}
}
$expected_param_count = $i;
}
for ($i = count($args), $j = count($function_params); $i < $j; ++$i) {
2017-02-10 02:35:17 +01:00
$param = $function_params[$i];
2017-02-10 02:35:17 +01:00
if (!$param->is_optional && !$param->is_variadic) {
if (IssueBuffer::accepts(
new TooFewArguments(
'Too few arguments for method ' . $cased_method_id
. ' - expecting ' . $expected_param_count . ' but saw ' . count($args),
$code_location,
$method_id ?: ''
2017-02-10 02:35:17 +01:00
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2017-02-10 02:35:17 +01:00
)) {
2019-06-30 18:06:49 +02:00
// fall through
}
2017-02-10 02:35:17 +01:00
break;
}
if ($param->is_optional
&& $param->type
&& $param->default_type
&& !$param->is_variadic
&& $template_types
) {
if ($generic_params === null) {
$generic_params = [];
}
$param_type = clone $param->type;
$param_type->replaceTemplateTypesWithStandins(
$template_types,
$generic_params,
$codebase,
clone $param->default_type,
true
);
}
}
}
}
/**
* @param string|null $cased_method_id
* @param string|null $self_fq_class_name
* @param string|null $static_fq_class_name
* @param FunctionLikeParameter|null $function_param
* @param array<string, array<string, array{Type\Union, 1?:int}>> $existing_generic_params
* @param array<string, array<string, array{Type\Union, 1?:int}>> $generic_params
* @param array<string, array<string, array{Type\Union}>> $template_types
* @return false|null
*/
private static function checkFunctionLikeArgumentMatches(
StatementsAnalyzer $statements_analyzer,
$cased_method_id,
$self_fq_class_name,
$static_fq_class_name,
$function_param,
int $argument_offset,
PhpParser\Node\Arg $arg,
Context $context,
array $existing_generic_params,
array &$generic_params = null,
array $template_types = null
) {
$codebase = $statements_analyzer->getCodebase();
if (!isset($arg->value->inferredType)) {
if ($function_param && !$function_param->by_ref) {
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());
}
$param_type = $function_param->type;
if ($function_param->is_variadic
&& $param_type
&& $param_type->hasArray()
) {
/** @var TArray */
$array_type = $param_type->getTypes()['array'];
$param_type = $array_type->type_params[1];
}
if ($param_type && !$param_type->hasMixed()) {
if (IssueBuffer::accepts(
new MixedArgument(
'Argument ' . ($argument_offset + 1) . ' of ' . $cased_method_id
. ' cannot be mixed, expecting ' . $param_type,
new CodeLocation($statements_analyzer->getSource(), $arg->value),
$cased_method_id
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
}
}
return;
}
if (self::checkFunctionLikeTypeMatches(
$statements_analyzer,
$codebase,
$cased_method_id,
$self_fq_class_name,
$static_fq_class_name,
$function_param,
$arg->value->inferredType,
$argument_offset,
$arg,
$context,
$existing_generic_params,
$generic_params,
$template_types
) === false) {
return false;
}
}
/**
* @param string|null $method_id
* @param string|null $cased_method_id
* @param FunctionLikeParameter|null $last_param
* @param array<int, FunctionLikeParameter> $function_params
* @param array<string, array<string, array{Type\Union, 1?:int}>> $generic_params
* @param array<string, array<string, array{Type\Union}>> $template_types
* @param FunctionLikeStorage|null $function_storage
* @return false|null
*/
private static function handlePossiblyMatchingByRefParam(
StatementsAnalyzer $statements_analyzer,
Codebase $codebase,
$method_id,
$cased_method_id,
$last_param,
$function_params,
$function_storage,
int $argument_offset,
PhpParser\Node\Arg $arg,
Context $context,
array &$generic_params = null,
array $template_types = null
) {
if ($arg->value instanceof PhpParser\Node\Scalar
2019-02-21 19:26:37 +01:00
|| $arg->value instanceof PhpParser\Node\Expr\Cast
|| $arg->value instanceof PhpParser\Node\Expr\Array_
|| $arg->value instanceof PhpParser\Node\Expr\ClassConstFetch
|| (
(
$arg->value instanceof PhpParser\Node\Expr\ConstFetch
|| $arg->value instanceof PhpParser\Node\Expr\FuncCall
|| $arg->value instanceof PhpParser\Node\Expr\MethodCall
|| $arg->value instanceof PhpParser\Node\Expr\StaticCall
) && (
!isset($arg->value->inferredType)
|| !$arg->value->inferredType->by_ref
)
)
) {
if (IssueBuffer::accepts(
new InvalidPassByReference(
'Parameter ' . ($argument_offset + 1) . ' of ' . $cased_method_id . ' expects a variable',
new CodeLocation($statements_analyzer->getSource(), $arg->value)
),
$statements_analyzer->getSuppressedIssues()
)) {
2019-06-30 18:06:49 +02:00
// fall through
}
2019-06-30 18:06:49 +02:00
return false;
}
if (!in_array(
$method_id,
[
'shuffle', 'sort', 'rsort', 'usort', 'ksort', 'asort',
'krsort', 'arsort', 'natcasesort', 'natsort', 'reset',
'end', 'next', 'prev', 'array_pop', 'array_shift',
'array_push', 'array_unshift', 'socket_select', 'array_splice',
],
true
)) {
$by_ref_type = null;
$by_ref_out_type = null;
$check_null_ref = true;
if ($last_param) {
if ($argument_offset < count($function_params)) {
$function_param = $function_params[$argument_offset];
} else {
$function_param = $last_param;
}
$by_ref_type = $function_param->type;
if (isset($function_storage->param_out_types[$argument_offset])) {
$by_ref_out_type = $function_storage->param_out_types[$argument_offset];
}
if ($by_ref_type && $by_ref_type->isNullable()) {
$check_null_ref = false;
}
if ($template_types && $by_ref_type) {
if ($generic_params === null) {
$generic_params = [];
}
$original_by_ref_type = clone $by_ref_type;
$by_ref_type = clone $by_ref_type;
$by_ref_type->replaceTemplateTypesWithStandins(
$template_types,
$generic_params,
$codebase,
isset($arg->value->inferredType)
? $arg->value->inferredType
: null
);
if ($generic_params) {
$original_by_ref_type->replaceTemplateTypesWithArgTypes(
$generic_params
);
$by_ref_type = $original_by_ref_type;
}
}
if ($by_ref_type && $function_param->is_variadic && $arg->unpack) {
$by_ref_type = new Type\Union([
new Type\Atomic\TArray([
Type::getInt(),
$by_ref_type,
]),
]);
}
}
$by_ref_type = $by_ref_type ?: Type::getMixed();
ExpressionAnalyzer::assignByRefParam(
$statements_analyzer,
$arg->value,
$by_ref_type,
$by_ref_out_type ?: $by_ref_type,
$context,
$method_id && (strpos($method_id, '::') !== false || !CallMap::inCallMap($method_id)),
$check_null_ref
);
}
}
/**
* @param string|null $cased_method_id
* @param string|null $self_fq_class_name
* @param string|null $static_fq_class_name
* @param array<string, array<string, array{Type\Union, 1?:int}>> $existing_generic_params
* @param array<string, array<string, array{Type\Union, 1?:int}>> $generic_params
* @param array<string, array<string, array{Type\Union}>> $template_types
* @param FunctionLikeParameter|null $function_param
* @return false|null
*/
private static function checkFunctionLikeTypeMatches(
StatementsAnalyzer $statements_analyzer,
Codebase $codebase,
$cased_method_id,
$self_fq_class_name,
$static_fq_class_name,
$function_param,
Type\Union $arg_type,
int $argument_offset,
PhpParser\Node\Arg $arg,
Context $context,
array $existing_generic_params = null,
array &$generic_params = null,
array $template_types = null
) {
if (!$function_param) {
return;
}
if (!$function_param->type) {
if (!$codebase->infer_types_from_usage) {
return;
}
$param_type = Type::getMixed();
} else {
$param_type = clone $function_param->type;
}
if ($existing_generic_params) {
$empty_generic_params = [];
$param_type->replaceTemplateTypesWithStandins(
$existing_generic_params,
$empty_generic_params,
$codebase,
$arg->value->inferredType
);
$arg_type->replaceTemplateTypesWithStandins(
$existing_generic_params,
$empty_generic_params,
$codebase,
$arg->value->inferredType
);
}
if ($template_types) {
if ($generic_params === null) {
$generic_params = [];
}
$arg_type_param = $arg_type;
if ($arg->unpack) {
if ($arg_type->hasArray()) {
/** @var Type\Atomic\TArray|Type\Atomic\ObjectLike */
$array_atomic_type = $arg_type->getTypes()['array'];
if ($array_atomic_type instanceof Type\Atomic\ObjectLike) {
$array_atomic_type = $array_atomic_type->getGenericArrayType();
}
$arg_type_param = $array_atomic_type->type_params[1];
} else {
$arg_type_param = Type::getMixed();
}
}
$param_type->replaceTemplateTypesWithStandins(
$template_types,
$generic_params,
$codebase,
$arg_type_param
);
}
if (!$context->check_variables) {
return;
}
$parent_class = null;
if ($self_fq_class_name) {
$classlike_storage = $codebase->classlike_storage_provider->get($self_fq_class_name);
$parent_class = $classlike_storage->parent_class;
}
$fleshed_out_type = ExpressionAnalyzer::fleshOutType(
$codebase,
$param_type,
$self_fq_class_name,
$static_fq_class_name,
$parent_class
);
$fleshed_out_signature_type = $function_param->signature_type
? ExpressionAnalyzer::fleshOutType(
$codebase,
$function_param->signature_type,
$self_fq_class_name,
$static_fq_class_name,
$parent_class
)
: null;
if ($arg->unpack) {
if ($arg_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 (IssueBuffer::accepts(
new MixedArgument(
'Argument ' . ($argument_offset + 1) . ' of ' . $cased_method_id
. ' cannot be mixed, expecting array',
new CodeLocation($statements_analyzer->getSource(), $arg->value),
$cased_method_id
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
return;
}
if ($arg_type->hasArray()) {
/** @var Type\Atomic\TArray|Type\Atomic\ObjectLike */
$array_atomic_type = $arg_type->getTypes()['array'];
if ($array_atomic_type instanceof Type\Atomic\ObjectLike) {
$array_atomic_type = $array_atomic_type->getGenericArrayType();
}
$arg_type = $array_atomic_type->type_params[1];
} else {
foreach ($arg_type->getTypes() as $atomic_type) {
if (!$atomic_type->isIterable($codebase)) {
if (IssueBuffer::accepts(
new InvalidArgument(
'Argument ' . ($argument_offset + 1) . ' of ' . $cased_method_id
. ' expects array, ' . $atomic_type->getId() . ' provided',
new CodeLocation($statements_analyzer->getSource(), $arg->value),
$cased_method_id
),
$statements_analyzer->getSuppressedIssues()
)) {
2019-06-30 18:06:49 +02:00
// fall through
}
2019-06-30 18:06:49 +02:00
continue;
}
}
return;
}
}
if (self::checkFunctionArgumentType(
$statements_analyzer,
$arg_type,
$fleshed_out_type,
$fleshed_out_signature_type,
$cased_method_id,
$argument_offset,
new CodeLocation($statements_analyzer->getSource(), $arg->value),
$arg->value,
$context,
$function_param->by_ref,
$function_param->is_variadic,
$arg->unpack
) === false) {
return false;
}
}
2019-01-13 00:18:23 +01:00
/**
* @return array<string, array<string, array{Type\Union}>>
2019-01-13 00:18:23 +01:00
*/
private static function getTemplateTypesForFunction(
FunctionLikeStorage $function_storage,
ClassLikeStorage $class_storage = null,
ClassLikeStorage $calling_class_storage = null
) : array {
$template_types = [];
if ($function_storage->template_types) {
$template_types = $function_storage->template_types;
}
if ($class_storage) {
if ($calling_class_storage
&& $class_storage !== $calling_class_storage
&& $calling_class_storage->template_type_extends
) {
foreach ($calling_class_storage->template_type_extends as $class_name => $type_map) {
2019-01-13 00:18:23 +01:00
foreach ($type_map as $template_name => $type) {
if (is_string($template_name) && $class_name === $class_storage->name) {
$output_type = null;
foreach ($type->getTypes() as $atomic_type) {
if ($atomic_type instanceof Type\Atomic\TTemplateParam
&& $atomic_type->defining_class
&& isset(
$calling_class_storage
->template_type_extends
[$atomic_type->defining_class]
[$atomic_type->param_name]
)
) {
$output_type_candidate = $calling_class_storage
->template_type_extends[$atomic_type->defining_class][$atomic_type->param_name];
} else {
$output_type_candidate = new Type\Union([$atomic_type]);
}
if (!$output_type) {
$output_type = $output_type_candidate;
} else {
$output_type = Type::combineUnionTypes(
$output_type_candidate,
$output_type
);
}
2019-01-13 00:18:23 +01:00
}
$template_types[$template_name][$class_storage->name] = [$output_type ?: Type::getMixed()];
2019-01-13 00:18:23 +01:00
}
}
}
} elseif ($class_storage->template_types) {
foreach ($class_storage->template_types as $template_name => $type) {
$template_types[$template_name] = $type;
}
}
}
foreach ($template_types as $key => $type_map) {
foreach ($type_map as $class => $type) {
$template_types[$key][$class][0] = clone $type[0];
}
2019-01-13 00:18:23 +01:00
}
return $template_types;
}
/**
2018-11-11 18:01:14 +01:00
* @param StatementsAnalyzer $statements_analyzer
* @param array<int, PhpParser\Node\Arg> $args
* @param string $method_id
2017-05-27 02:16:18 +02:00
*
* @return false|null
*/
protected static function checkArrayFunctionArgumentsMatch(
2018-11-11 18:01:14 +01:00
StatementsAnalyzer $statements_analyzer,
array $args,
$method_id,
bool $check_functions
) {
$closure_index = $method_id === 'array_map' ? 0 : 1;
2016-11-01 19:14:35 +01:00
$array_arg_types = [];
foreach ($args as $i => $arg) {
if ($i === 0 && $method_id === 'array_map') {
continue;
}
if ($i === 1 && $method_id === 'array_filter') {
break;
}
2017-02-11 01:10:13 +01:00
$array_arg = isset($arg->value) ? $arg->value : null;
/** @var ObjectLike|TArray|null */
$array_arg_type = $array_arg
&& isset($array_arg->inferredType)
&& isset($array_arg->inferredType->getTypes()['array'])
? $array_arg->inferredType->getTypes()['array']
: null;
if ($array_arg_type instanceof ObjectLike) {
$array_arg_type = $array_arg_type->getGenericArrayType();
}
$array_arg_types[] = $array_arg_type;
}
2016-11-01 19:14:35 +01:00
/** @var null|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
: null;
if ($closure_arg && $closure_arg_type) {
$min_closure_param_count = $max_closure_param_count = count($array_arg_types);
if ($method_id === 'array_filter') {
$max_closure_param_count = count($args) > 2 ? 2 : 1;
}
foreach ($closure_arg_type->getTypes() as $closure_type) {
2019-06-30 18:06:49 +02:00
self::checkArrayFunctionClosureType(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$method_id,
$closure_type,
$closure_arg,
$min_closure_param_count,
$max_closure_param_count,
$array_arg_types,
$check_functions
2019-06-30 18:06:49 +02:00
);
}
}
}
2016-11-01 19:14:35 +01:00
/**
* @param string $method_id
* @param int $min_closure_param_count
* @param int $max_closure_param_count [description]
* @param (TArray|null)[] $array_arg_types
*
2019-06-30 18:06:49 +02:00
* @return void
*/
private static function checkArrayFunctionClosureType(
2018-11-11 18:01:14 +01:00
StatementsAnalyzer $statements_analyzer,
$method_id,
Type\Atomic $closure_type,
PhpParser\Node\Arg $closure_arg,
$min_closure_param_count,
$max_closure_param_count,
array $array_arg_types,
bool $check_functions
) {
2018-11-11 18:01:14 +01:00
$codebase = $statements_analyzer->getCodebase();
2016-11-01 19:14:35 +01:00
if (!$closure_type instanceof Type\Atomic\TFn) {
if (!$closure_arg->value instanceof PhpParser\Node\Scalar\String_
&& !$closure_arg->value instanceof PhpParser\Node\Expr\Array_
&& !$closure_arg->value instanceof PhpParser\Node\Expr\BinaryOp\Concat
) {
return;
}
2016-11-01 19:14:35 +01:00
$function_ids = self::getFunctionIdsFromCallableArg(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$closure_arg->value
);
$closure_types = [];
2016-12-07 20:13:39 +01:00
foreach ($function_ids as $function_id) {
$function_id = strtolower($function_id);
if (strpos($function_id, '::') !== false) {
$function_id_parts = explode('&', $function_id);
2016-11-01 19:14:35 +01:00
foreach ($function_id_parts as $function_id_part) {
list($callable_fq_class_name, $method_name) = explode('::', $function_id_part);
2016-11-01 19:14:35 +01:00
switch ($callable_fq_class_name) {
case 'self':
case 'static':
case 'parent':
2018-11-11 18:01:14 +01:00
$container_class = $statements_analyzer->getFQCLN();
2016-11-01 19:14:35 +01:00
if ($callable_fq_class_name === 'parent') {
2018-11-11 18:01:14 +01:00
$container_class = $statements_analyzer->getParentFQCLN();
}
if (!$container_class) {
continue 2;
}
$callable_fq_class_name = $container_class;
}
if (!$codebase->classOrInterfaceExists($callable_fq_class_name)) {
return;
}
$function_id_part = $callable_fq_class_name . '::' . $method_name;
try {
$method_storage = $codebase->methods->getStorage($function_id_part);
} catch (\UnexpectedValueException $e) {
// the method may not exist, but we're suppressing that issue
continue;
}
$closure_types[] = new Type\Atomic\TFn(
'Closure',
$method_storage->params,
$method_storage->return_type ?: Type::getMixed()
);
}
} else {
if (!$check_functions) {
continue;
}
if (!$codebase->functions->functionExists($statements_analyzer, $function_id)) {
continue;
}
$function_storage = $codebase->functions->getStorage(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$function_id
);
2016-11-01 19:14:35 +01:00
if (CallMap::inCallMap($function_id)) {
$callmap_callables = CallMap::getCallablesFromCallMap($function_id);
if ($callmap_callables === null) {
throw new \UnexpectedValueException('This should not happen');
}
$passing_callmap_callables = [];
foreach ($callmap_callables as $callmap_callable) {
$required_param_count = 0;
assert($callmap_callable->params !== null);
foreach ($callmap_callable->params as $i => $param) {
if (!$param->is_optional && !$param->is_variadic) {
$required_param_count = $i + 1;
}
}
if ($required_param_count <= $max_closure_param_count) {
$passing_callmap_callables[] = $callmap_callable;
}
}
if ($passing_callmap_callables) {
foreach ($passing_callmap_callables as $passing_callmap_callable) {
$closure_types[] = $passing_callmap_callable;
}
} else {
$closure_types[] = $callmap_callables[0];
}
} else {
$closure_types[] = new Type\Atomic\TFn(
'Closure',
$function_storage->params,
$function_storage->return_type ?: Type::getMixed()
);
}
}
}
} else {
$closure_types = [$closure_type];
}
foreach ($closure_types as $closure_type) {
if ($closure_type->params === null) {
continue;
}
2019-06-30 18:06:49 +02:00
self::checkArrayFunctionClosureTypeArgs(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$method_id,
$closure_type,
$closure_arg,
$min_closure_param_count,
$max_closure_param_count,
$array_arg_types
2019-06-30 18:06:49 +02:00
);
}
}
/**
* @param Type\Atomic\TFn|Type\Atomic\TCallable $closure_type
* @param string $method_id
* @param int $min_closure_param_count
* @param int $max_closure_param_count
* @param (TArray|null)[] $array_arg_types
*
2019-06-30 18:06:49 +02:00
* @return void
*/
private static function checkArrayFunctionClosureTypeArgs(
2018-11-11 18:01:14 +01:00
StatementsAnalyzer $statements_analyzer,
$method_id,
Type\Atomic $closure_type,
PhpParser\Node\Arg $closure_arg,
$min_closure_param_count,
$max_closure_param_count,
array $array_arg_types
) {
2018-11-11 18:01:14 +01:00
$codebase = $statements_analyzer->getCodebase();
$closure_params = $closure_type->params;
if ($closure_params === null) {
throw new \UnexpectedValueException('Closure params should not be null here');
}
$required_param_count = 0;
foreach ($closure_params as $i => $param) {
if (!$param->is_optional && !$param->is_variadic) {
$required_param_count = $i + 1;
}
}
if (count($closure_params) < $min_closure_param_count) {
$argument_text = $min_closure_param_count === 1 ? 'one argument' : $min_closure_param_count . ' arguments';
2018-03-02 06:07:19 +01:00
if (IssueBuffer::accepts(
new TooManyArguments(
2018-03-02 06:07:19 +01:00
'The callable passed to ' . $method_id . ' will be called with ' . $argument_text . ', expecting '
2018-03-02 06:03:07 +01:00
. $required_param_count,
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $closure_arg),
$method_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
2019-06-30 18:06:49 +02:00
// fall through
}
2019-06-30 18:06:49 +02:00
return;
} elseif ($required_param_count > $max_closure_param_count) {
$argument_text = $max_closure_param_count === 1 ? 'one argument' : $max_closure_param_count . ' arguments';
2018-03-02 06:07:19 +01:00
if (IssueBuffer::accepts(
new TooFewArguments(
2018-03-02 06:07:19 +01:00
'The callable passed to ' . $method_id . ' will be called with ' . $argument_text . ', expecting '
2018-03-02 06:03:07 +01:00
. $required_param_count,
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $closure_arg),
$method_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
2019-06-30 18:06:49 +02:00
// fall through
}
2019-06-30 18:06:49 +02:00
return;
}
// abandon attempt to validate closure params if we have an extra arg for ARRAY_FILTER
if ($method_id === 'array_filter' && $max_closure_param_count > 1) {
return;
}
$i = 0;
foreach ($closure_params as $closure_param) {
if (!isset($array_arg_types[$i])) {
++$i;
continue;
}
/** @var Type\Atomic\TArray */
$array_arg_type = $array_arg_types[$i];
$input_type = $array_arg_type->type_params[1];
if ($input_type->hasMixed()) {
++$i;
continue;
}
$closure_param_type = $closure_param->type;
if (!$closure_param_type) {
++$i;
continue;
}
2019-07-10 07:35:57 +02:00
$union_comparison_results = new \Psalm\Internal\Analyzer\TypeComparisonResult();
2018-11-06 03:57:36 +01:00
$type_match_found = TypeAnalyzer::isContainedBy(
$codebase,
$input_type,
$closure_param_type,
false,
false,
2019-07-10 07:35:57 +02:00
$union_comparison_results
);
2019-07-10 07:35:57 +02:00
if ($union_comparison_results->type_coerced) {
if ($union_comparison_results->type_coerced_from_mixed) {
if (IssueBuffer::accepts(
new MixedArgumentTypeCoercion(
'First parameter of closure passed to function ' . $method_id . ' expects ' .
$closure_param_type->getId() . ', parent type ' . $input_type->getId() . ' provided',
new CodeLocation($statements_analyzer->getSource(), $closure_arg),
$method_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
// keep soldiering on
}
} else {
if (IssueBuffer::accepts(
new ArgumentTypeCoercion(
'First parameter of closure passed to function ' . $method_id . ' expects ' .
$closure_param_type->getId() . ', parent type ' . $input_type->getId() . ' provided',
new CodeLocation($statements_analyzer->getSource(), $closure_arg),
$method_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
// keep soldiering on
2016-11-01 19:14:35 +01:00
}
}
}
2019-07-10 07:35:57 +02:00
if (!$union_comparison_results->type_coerced && !$type_match_found) {
$types_can_be_identical = TypeAnalyzer::canExpressionTypesBeIdentical(
2018-11-06 03:57:36 +01:00
$codebase,
$input_type,
$closure_param_type
);
2019-07-10 07:35:57 +02:00
if ($union_comparison_results->scalar_type_match_found) {
if (IssueBuffer::accepts(
new InvalidScalarArgument(
'First parameter of closure passed to function ' . $method_id . ' expects ' .
$closure_param_type->getId() . ', ' . $input_type->getId() . ' provided',
new CodeLocation($statements_analyzer->getSource(), $closure_arg),
$method_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
} elseif ($types_can_be_identical) {
if (IssueBuffer::accepts(
new PossiblyInvalidArgument(
'First parameter of closure passed to function ' . $method_id . ' expects '
. $closure_param_type->getId() . ', possibly different type '
. $input_type->getId() . ' provided',
new CodeLocation($statements_analyzer->getSource(), $closure_arg),
$method_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
} elseif (IssueBuffer::accepts(
new InvalidArgument(
'First parameter of closure passed to function ' . $method_id . ' expects ' .
$closure_param_type->getId() . ', ' . $input_type->getId() . ' provided',
new CodeLocation($statements_analyzer->getSource(), $closure_arg),
$method_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
2019-06-30 18:06:49 +02:00
// fall through
2016-11-01 19:14:35 +01:00
}
}
++$i;
2016-11-01 19:14:35 +01:00
}
}
/**
2018-11-11 18:01:14 +01:00
* @param StatementsAnalyzer $statements_analyzer
2016-11-02 07:29:00 +01:00
* @param Type\Union $input_type
* @param Type\Union $param_type
* @param string|null $cased_method_id
2016-11-02 07:29:00 +01:00
* @param int $argument_offset
* @param CodeLocation $code_location
* @param bool $by_ref
2018-06-28 23:05:50 +02:00
* @param bool $variadic
2017-05-27 02:16:18 +02:00
*
2016-11-02 07:29:00 +01:00
* @return null|false
2016-11-01 19:14:35 +01:00
*/
public static function checkFunctionArgumentType(
2018-11-11 18:01:14 +01:00
StatementsAnalyzer $statements_analyzer,
2016-11-01 19:14:35 +01:00
Type\Union $input_type,
Type\Union $param_type,
?Type\Union $signature_param_type,
2016-11-01 19:14:35 +01:00
$cased_method_id,
int $argument_offset,
CodeLocation $code_location,
PhpParser\Node\Expr $input_expr,
Context $context,
bool $by_ref = false,
bool $variadic = false,
bool $unpack = false
2016-11-01 19:14:35 +01:00
) {
2018-11-11 18:01:14 +01:00
$codebase = $statements_analyzer->getCodebase();
if ($param_type->hasMixed()) {
if ($codebase->infer_types_from_usage
&& !$input_type->hasMixed()
&& !$param_type->from_docblock
&& $cased_method_id
&& strpos($cased_method_id, '::')
&& !strpos($cased_method_id, '__')
) {
2019-05-31 16:37:26 +02:00
$declaring_method_id = $codebase->methods->getDeclaringMethodId($cased_method_id);
2019-05-31 16:37:26 +02:00
if ($declaring_method_id) {
$id_lc = strtolower($declaring_method_id);
2019-05-31 16:37:26 +02:00
if (!isset($codebase->analyzer->possible_method_param_types[$id_lc][$argument_offset])) {
$codebase->analyzer->possible_method_param_types[$id_lc][$argument_offset]
= clone $input_type;
2019-05-31 16:37:26 +02:00
} else {
$codebase->analyzer->possible_method_param_types[$id_lc][$argument_offset]
= Type::combineUnionTypes(
$codebase->analyzer->possible_method_param_types[$id_lc][$argument_offset],
clone $input_type,
$codebase
);
2019-05-31 16:37:26 +02:00
}
}
}
return null;
}
$method_identifier = $cased_method_id ? ' of ' . $cased_method_id : '';
if ($input_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());
}
2016-11-01 19:14:35 +01:00
if (IssueBuffer::accepts(
new MixedArgument(
'Argument ' . ($argument_offset + 1) . $method_identifier . ' cannot be mixed, expecting ' .
2016-11-02 07:29:00 +01:00
$param_type,
$code_location,
$cased_method_id
2016-11-01 19:14:35 +01:00
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2016-11-01 19:14:35 +01:00
)) {
2018-06-28 23:05:50 +02:00
// fall through
2016-11-01 19:14:35 +01:00
}
if (!$by_ref
&& !($variadic xor $unpack)
&& $cased_method_id !== 'echo'
) {
self::coerceValueAfterGatekeeperArgument(
$statements_analyzer,
$input_type,
false,
$input_expr,
$param_type,
$signature_param_type,
$context,
$unpack
);
}
2016-11-02 07:29:00 +01:00
return null;
2016-11-01 19:14:35 +01:00
}
if ($input_type->isNever()) {
if (IssueBuffer::accepts(
new NoValue(
'This function or method call never returns output',
$code_location
),
$statements_analyzer->getSuppressedIssues()
)) {
2019-06-30 18:06:49 +02:00
// fall through
}
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());
}
2018-11-06 03:57:36 +01:00
$param_type = TypeAnalyzer::simplifyUnionType(
$codebase,
$param_type
);
2019-07-10 07:35:57 +02:00
$union_comparison_results = new \Psalm\Internal\Analyzer\TypeComparisonResult();
2018-11-06 03:57:36 +01:00
$type_match_found = TypeAnalyzer::isContainedBy(
2018-02-04 00:52:35 +01:00
$codebase,
2016-11-02 07:29:00 +01:00
$input_type,
$param_type,
true,
true,
2019-07-10 07:35:57 +02:00
$union_comparison_results
2016-11-02 07:29:00 +01:00
);
2016-11-01 19:14:35 +01:00
$replace_input_type = false;
if ($union_comparison_results->replacement_union_type) {
$replace_input_type = true;
$input_type = $union_comparison_results->replacement_union_type;
}
2019-04-17 21:45:40 +02:00
if ($type_match_found
&& $param_type->hasCallableType()
) {
$potential_method_ids = [];
foreach ($input_type->getTypes() as $input_type_part) {
if ($input_type_part instanceof Type\Atomic\ObjectLike) {
$potential_method_id = TypeAnalyzer::getCallableMethodIdFromObjectLike(
$input_type_part,
2019-04-27 23:38:24 +02:00
$codebase,
$context->calling_method_id,
$statements_analyzer->getFilePath()
2019-04-17 21:45:40 +02:00
);
if ($potential_method_id) {
$potential_method_ids[] = $potential_method_id;
}
} elseif ($input_type_part instanceof Type\Atomic\TLiteralString) {
$potential_method_ids[] = $input_type_part->value;
}
}
foreach ($potential_method_ids as $potential_method_id) {
if (strpos($potential_method_id, '::')) {
$codebase->methods->methodExists(
$potential_method_id,
$context->calling_method_id,
null,
$statements_analyzer,
$statements_analyzer->getFilePath()
);
}
}
}
if ($context->strict_types
&& !$input_type->hasArray()
&& !$param_type->from_docblock
&& $cased_method_id !== 'echo'
&& $cased_method_id !== 'sprintf'
) {
2019-07-10 07:35:57 +02:00
$union_comparison_results->scalar_type_match_found = false;
2019-07-10 07:35:57 +02:00
if ($union_comparison_results->to_string_cast) {
$union_comparison_results->to_string_cast = false;
$type_match_found = false;
}
}
2019-07-10 07:35:57 +02:00
if ($union_comparison_results->type_coerced) {
if ($union_comparison_results->type_coerced_from_mixed) {
if (IssueBuffer::accepts(
new MixedArgumentTypeCoercion(
'Argument ' . ($argument_offset + 1) . $method_identifier . ' expects ' . $param_type->getId() .
', parent type ' . $input_type->getId() . ' provided',
$code_location,
$cased_method_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
// keep soldiering on
}
} else {
if (IssueBuffer::accepts(
new ArgumentTypeCoercion(
'Argument ' . ($argument_offset + 1) . $method_identifier . ' expects ' . $param_type->getId() .
', parent type ' . $input_type->getId() . ' provided',
$code_location,
$cased_method_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
// keep soldiering on
}
2016-11-01 19:14:35 +01:00
}
}
2019-07-10 07:35:57 +02:00
if ($union_comparison_results->to_string_cast && $cased_method_id !== 'echo') {
2016-12-29 06:14:06 +01:00
if (IssueBuffer::accepts(
new ImplicitToStringCast(
'Argument ' . ($argument_offset + 1) . $method_identifier . ' expects ' .
$param_type->getId() . ', ' . $input_type->getId() . ' provided with a __toString method',
2016-12-29 06:14:06 +01:00
$code_location
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2016-12-29 06:14:06 +01:00
)) {
// fall through
}
}
2019-07-10 07:35:57 +02:00
if (!$type_match_found && !$union_comparison_results->type_coerced) {
2018-11-06 03:57:36 +01:00
$types_can_be_identical = TypeAnalyzer::canBeContainedBy(
2018-02-04 00:52:35 +01:00
$codebase,
$input_type,
$param_type,
true,
true
);
2019-07-10 07:35:57 +02:00
if ($union_comparison_results->scalar_type_match_found) {
if ($cased_method_id !== 'echo') {
if (IssueBuffer::accepts(
new InvalidScalarArgument(
'Argument ' . ($argument_offset + 1) . $method_identifier . ' expects ' .
$param_type->getId() . ', ' . $input_type->getId() . ' provided',
$code_location,
$cased_method_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
2016-11-01 19:14:35 +01:00
}
} elseif ($types_can_be_identical) {
if (IssueBuffer::accepts(
new PossiblyInvalidArgument(
'Argument ' . ($argument_offset + 1) . $method_identifier . ' expects ' . $param_type->getId() .
', possibly different type ' . $input_type->getId() . ' provided',
$code_location,
$cased_method_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
} else {
if (IssueBuffer::accepts(
new InvalidArgument(
'Argument ' . ($argument_offset + 1) . $method_identifier . ' expects ' . $param_type->getId() .
', ' . $input_type->getId() . ' provided',
$code_location,
$cased_method_id
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
2016-11-01 19:14:35 +01:00
}
return;
}
if ($input_expr instanceof PhpParser\Node\Scalar\String_
|| $input_expr instanceof PhpParser\Node\Expr\Array_
|| $input_expr instanceof PhpParser\Node\Expr\BinaryOp\Concat
) {
foreach ($param_type->getTypes() as $param_type_part) {
if ($param_type_part instanceof TClassString
&& $input_expr instanceof PhpParser\Node\Scalar\String_
) {
2018-11-06 03:57:36 +01:00
if (ClassLikeAnalyzer::checkFullyQualifiedClassLikeName(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$input_expr->value,
$code_location,
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
) === false
) {
2019-06-30 18:06:49 +02:00
return;
}
} elseif ($param_type_part instanceof TArray
&& $input_expr instanceof PhpParser\Node\Expr\Array_
) {
foreach ($param_type_part->type_params[1]->getTypes() as $param_array_type_part) {
if ($param_array_type_part instanceof TClassString) {
foreach ($input_expr->items as $item) {
if ($item && $item->value instanceof PhpParser\Node\Scalar\String_) {
2018-11-06 03:57:36 +01:00
if (ClassLikeAnalyzer::checkFullyQualifiedClassLikeName(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$item->value->value,
$code_location,
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
) === false
) {
2019-06-30 18:06:49 +02:00
return;
}
}
}
}
}
} elseif ($param_type_part instanceof TCallable) {
$function_ids = self::getFunctionIdsFromCallableArg(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$input_expr
);
foreach ($function_ids as $function_id) {
if (strpos($function_id, '::') !== false) {
$function_id_parts = explode('&', $function_id);
$non_existent_method_ids = [];
$has_valid_method = false;
foreach ($function_id_parts as $function_id_part) {
list($callable_fq_class_name, $method_name) = explode('::', $function_id_part);
switch ($callable_fq_class_name) {
case 'self':
case 'static':
case 'parent':
2018-11-11 18:01:14 +01:00
$container_class = $statements_analyzer->getFQCLN();
if ($callable_fq_class_name === 'parent') {
2018-11-11 18:01:14 +01:00
$container_class = $statements_analyzer->getParentFQCLN();
}
if (!$container_class) {
continue 2;
}
$callable_fq_class_name = $container_class;
}
$function_id_part = $callable_fq_class_name . '::' . $method_name;
2018-11-06 03:57:36 +01:00
if (ClassLikeAnalyzer::checkFullyQualifiedClassLikeName(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$callable_fq_class_name,
$code_location,
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
) === false
) {
2019-06-30 18:06:49 +02:00
return;
}
if (!$codebase->classOrInterfaceExists($callable_fq_class_name)) {
return;
}
if (!$codebase->methodExists($function_id_part)
&& !$codebase->methodExists($callable_fq_class_name . '::__call')
) {
$non_existent_method_ids[] = $function_id_part;
} else {
$has_valid_method = true;
}
}
if (!$has_valid_method && !$param_type->hasString() && !$param_type->hasArray()) {
2018-11-06 03:57:36 +01:00
if (MethodAnalyzer::checkMethodExists(
$codebase,
$non_existent_method_ids[0],
$code_location,
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
) === false
) {
2019-06-30 18:06:49 +02:00
return;
}
}
} else {
if (!$param_type->hasString() && !$param_type->hasArray() && self::checkFunctionExists(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
2018-01-03 03:23:48 +01:00
$function_id,
$code_location,
false
2018-01-03 03:23:48 +01:00
) === false
) {
2019-06-30 18:06:49 +02:00
return;
}
}
}
}
}
2016-11-01 19:14:35 +01:00
}
2016-11-02 07:29:00 +01:00
if (!$param_type->isNullable() && $cased_method_id !== 'echo') {
if ($input_type->isNull()) {
if (IssueBuffer::accepts(
new NullArgument(
'Argument ' . ($argument_offset + 1) . $method_identifier . ' cannot be null, ' .
'null value provided to parameter with type ' . $param_type->getId(),
$code_location,
$cased_method_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
2019-06-30 18:06:49 +02:00
// fall through
}
return null;
}
if ($input_type->isNullable() && !$input_type->ignore_nullable_issues) {
if (IssueBuffer::accepts(
new PossiblyNullArgument(
'Argument ' . ($argument_offset + 1) . $method_identifier . ' cannot be null, possibly ' .
'null value provided',
$code_location,
$cased_method_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
}
}
if ($input_type->isFalsable()
&& !$param_type->hasBool()
&& !$param_type->hasScalar()
&& !$input_type->ignore_falsable_issues
) {
if (IssueBuffer::accepts(
new PossiblyFalseArgument(
'Argument ' . ($argument_offset + 1) . $method_identifier . ' cannot be false, possibly ' .
'false value provided',
$code_location,
$cased_method_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
}
if ($type_match_found
&& !$by_ref
&& !($variadic xor $unpack)
2019-01-11 20:46:03 +01:00
&& $cased_method_id !== 'echo'
) {
self::coerceValueAfterGatekeeperArgument(
$statements_analyzer,
$input_type,
$replace_input_type,
$input_expr,
$param_type,
$signature_param_type,
$context,
$unpack
);
}
return null;
}
private static function coerceValueAfterGatekeeperArgument(
StatementsAnalyzer $statements_analyzer,
Type\Union $input_type,
bool $input_type_changed,
PhpParser\Node\Expr $input_expr,
Type\Union $param_type,
?Type\Union $signature_param_type,
Context $context,
bool $unpack
) : void {
2019-05-21 18:11:17 +02:00
if ($param_type->hasMixed()) {
return;
}
if (!$input_type_changed && $param_type->from_docblock && !$input_type->hasMixed()) {
$input_type = clone $input_type;
2019-05-21 18:11:17 +02:00
foreach ($param_type->getTypes() as $param_atomic_type) {
if ($param_atomic_type instanceof Type\Atomic\TGenericObject) {
foreach ($input_type->getTypes() as $input_atomic_type) {
if ($input_atomic_type instanceof Type\Atomic\TGenericObject
&& $input_atomic_type->value === $param_atomic_type->value
) {
foreach ($input_atomic_type->type_params as $i => $type_param) {
if ($type_param->isEmpty() && isset($param_atomic_type->type_params[$i])) {
2019-05-21 18:11:17 +02:00
$input_type_changed = true;
2019-05-21 18:11:17 +02:00
$input_atomic_type->type_params[$i] = clone $param_atomic_type->type_params[$i];
}
}
}
}
}
}
if (!$input_type_changed) {
return;
}
}
$var_id = ExpressionAnalyzer::getVarId(
$input_expr,
$statements_analyzer->getFQCLN(),
$statements_analyzer
);
if ($var_id) {
$input_type = clone $input_type;
if ($input_type->isNullable() && !$param_type->isNullable()) {
$input_type->removeType('null');
}
2017-12-18 05:22:26 +01:00
if ($input_type->getId() === $param_type->getId()) {
$input_type->from_docblock = false;
foreach ($input_type->getTypes() as $atomic_type) {
$atomic_type->from_docblock = false;
}
} elseif ($input_type->hasMixed() && $signature_param_type) {
$input_type = clone $signature_param_type;
if ($input_type->isNullable()) {
$input_type->ignore_nullable_issues = true;
}
}
$context->removeVarFromConflictingClauses($var_id, null, $statements_analyzer);
if ($unpack) {
$input_type = new Type\Union([
new TArray([
Type::getInt(),
$input_type
]),
]);
}
$context->vars_in_scope[$var_id] = $input_type;
}
2016-11-01 19:14:35 +01:00
}
/**
* @param PhpParser\Node\Scalar\String_|PhpParser\Node\Expr\Array_|PhpParser\Node\Expr\BinaryOp\Concat
* $callable_arg
*
* @return string[]
*/
public static function getFunctionIdsFromCallableArg(
\Psalm\FileSource $file_source,
$callable_arg
) {
if ($callable_arg instanceof PhpParser\Node\Expr\BinaryOp\Concat) {
if ($callable_arg->left instanceof PhpParser\Node\Expr\ClassConstFetch
&& $callable_arg->left->class instanceof PhpParser\Node\Name
&& $callable_arg->left->name instanceof PhpParser\Node\Identifier
&& strtolower($callable_arg->left->name->name) === 'class'
&& !in_array(strtolower($callable_arg->left->class->parts[0]), ['self', 'static', 'parent'])
&& $callable_arg->right instanceof PhpParser\Node\Scalar\String_
&& preg_match('/^::[A-Za-z0-9]+$/', $callable_arg->right->value)
) {
2018-10-17 20:37:32 +02:00
return [
(string) $callable_arg->left->class->getAttribute('resolvedName') . $callable_arg->right->value
];
}
return [];
}
if ($callable_arg instanceof PhpParser\Node\Scalar\String_) {
return [preg_replace('/^\\\/', '', $callable_arg->value)];
}
if (count($callable_arg->items) !== 2) {
return [];
}
2018-01-14 00:33:32 +01:00
if (!isset($callable_arg->items[0]) || !isset($callable_arg->items[1])) {
throw new \UnexpectedValueException('These should never be unset');
}
$class_arg = $callable_arg->items[0]->value;
$method_name_arg = $callable_arg->items[1]->value;
if (!$method_name_arg instanceof PhpParser\Node\Scalar\String_) {
return [];
}
if ($class_arg instanceof PhpParser\Node\Scalar\String_) {
return [preg_replace('/^\\\/', '', $class_arg->value) . '::' . $method_name_arg->value];
}
if ($class_arg instanceof PhpParser\Node\Expr\ClassConstFetch
&& $class_arg->name instanceof PhpParser\Node\Identifier
&& strtolower($class_arg->name->name) === 'class'
&& $class_arg->class instanceof PhpParser\Node\Name
) {
2018-11-06 03:57:36 +01:00
$fq_class_name = ClassLikeAnalyzer::getFQCLNFromNameObject(
$class_arg->class,
$file_source->getAliases()
);
return [$fq_class_name . '::' . $method_name_arg->value];
}
if (!isset($class_arg->inferredType) || !$class_arg->inferredType->hasObjectType()) {
return [];
}
$method_ids = [];
foreach ($class_arg->inferredType->getTypes() as $type_part) {
if ($type_part instanceof TNamedObject) {
$method_id = $type_part->value . '::' . $method_name_arg->value;
if ($type_part->extra_types) {
foreach ($type_part->extra_types as $extra_type) {
if ($extra_type instanceof Type\Atomic\TTemplateParam
|| $extra_type instanceof Type\Atomic\TObjectWithProperties
) {
throw new \UnexpectedValueException('Shouldnt get a generic param here');
}
$method_id .= '&' . $extra_type->value . '::' . $method_name_arg->value;
}
}
$method_ids[] = $method_id;
}
}
return $method_ids;
}
2016-11-01 19:14:35 +01:00
/**
2018-11-11 18:01:14 +01:00
* @param StatementsAnalyzer $statements_analyzer
2016-11-01 19:14:35 +01:00
* @param string $function_id
* @param CodeLocation $code_location
* @param bool $can_be_in_root_scope if true, the function can be shortened to the root version
2017-05-27 02:16:18 +02:00
*
2016-11-01 19:14:35 +01:00
* @return bool
*/
2016-11-02 07:29:00 +01:00
protected static function checkFunctionExists(
2018-11-11 18:01:14 +01:00
StatementsAnalyzer $statements_analyzer,
&$function_id,
CodeLocation $code_location,
$can_be_in_root_scope
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);
2018-11-11 18:01:14 +01:00
$codebase = $statements_analyzer->getCodebase();
2018-11-11 18:01:14 +01:00
if (!$codebase->functions->functionExists($statements_analyzer, $function_id)) {
$root_function_id = preg_replace('/.*\\\/', '', $function_id);
if ($can_be_in_root_scope
&& $function_id !== $root_function_id
2018-11-11 18:01:14 +01:00
&& $codebase->functions->functionExists($statements_analyzer, $root_function_id)
) {
$function_id = $root_function_id;
} else {
if (IssueBuffer::accepts(
new UndefinedFunction(
'Function ' . $cased_function_id . ' does not exist',
$code_location,
$function_id
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
return false;
2016-11-01 19:14:35 +01:00
}
}
return true;
}
/**
* @param PhpParser\Node\Identifier|PhpParser\Node\Name $expr
* @param \Psalm\Storage\Assertion[] $assertions
* @param array<int, PhpParser\Node\Arg> $args
* @param Context $context
* @param array<string, array<string, array{Type\Union}>> $template_type_map,
2018-11-11 18:01:14 +01:00
* @param StatementsAnalyzer $statements_analyzer
*
* @return void
*/
protected static function applyAssertionsToContext(
$expr,
array $assertions,
array $args,
array $template_type_map,
Context $context,
2018-11-11 18:01:14 +01:00
StatementsAnalyzer $statements_analyzer
) {
$type_assertions = [];
$asserted_keys = [];
foreach ($assertions as $assertion) {
$assertion_var_id = null;
2019-01-05 20:50:11 +01:00
$arg_value = null;
if (is_int($assertion->var_id)) {
if (!isset($args[$assertion->var_id])) {
continue;
}
$arg_value = $args[$assertion->var_id]->value;
2018-11-11 18:01:14 +01:00
$arg_var_id = ExpressionAnalyzer::getArrayVarId($arg_value, null, $statements_analyzer);
if ($arg_var_id) {
$assertion_var_id = $arg_var_id;
}
} elseif (isset($context->vars_in_scope[$assertion->var_id])) {
$assertion_var_id = $assertion->var_id;
}
if ($assertion_var_id) {
$rule = $assertion->rule[0][0];
$prefix = '';
if ($rule[0] === '!') {
$prefix .= '!';
$rule = substr($rule, 1);
}
if ($rule[0] === '=') {
$prefix .= '=';
$rule = substr($rule, 1);
}
if ($rule[0] === '~') {
$prefix .= '~';
$rule = substr($rule, 1);
}
if (isset($template_type_map[$rule])) {
foreach ($template_type_map[$rule] as $template_map) {
if ($template_map[0]->hasMixed()) {
continue 2;
}
$replacement_atomic_types = $template_map[0]->getTypes();
if (count($replacement_atomic_types) > 1) {
continue 2;
}
$ored_type_assertions = [];
foreach ($replacement_atomic_types as $replacement_atomic_type) {
if ($replacement_atomic_type instanceof Type\Atomic\TMixed) {
continue 3;
}
if ($replacement_atomic_type instanceof Type\Atomic\TArray
|| $replacement_atomic_type instanceof Type\Atomic\ObjectLike
) {
$ored_type_assertions[] = $prefix . 'array';
} elseif ($replacement_atomic_type instanceof Type\Atomic\TNamedObject) {
$ored_type_assertions[] = $prefix . $replacement_atomic_type->value;
} elseif ($replacement_atomic_type instanceof Type\Atomic\Scalar) {
$ored_type_assertions[] = $prefix . $replacement_atomic_type->getId();
} elseif ($replacement_atomic_type instanceof Type\Atomic\TNull) {
$ored_type_assertions[] = $prefix . 'null';
} elseif ($replacement_atomic_type instanceof Type\Atomic\TTemplateParam) {
$ored_type_assertions[] = $prefix . $replacement_atomic_type->param_name;
}
}
if ($ored_type_assertions) {
$type_assertions[$assertion_var_id] = [$ored_type_assertions];
}
2018-11-16 17:50:07 +01:00
}
} else {
$type_assertions[$assertion_var_id] = $assertion->rule;
}
2019-01-05 20:50:11 +01:00
} elseif ($arg_value && $assertion->rule === [['!falsy']]) {
$assert_clauses = \Psalm\Type\Algebra::getFormula(
$arg_value,
$statements_analyzer->getFQCLN(),
$statements_analyzer,
$statements_analyzer->getCodebase()
);
$simplified_clauses = \Psalm\Type\Algebra::simplifyCNF(
array_merge($context->clauses, $assert_clauses)
);
$assert_type_assertions = \Psalm\Type\Algebra::getTruthsFromFormula(
$simplified_clauses
);
$type_assertions = array_merge($type_assertions, $assert_type_assertions);
}
}
$changed_vars = [];
foreach ($type_assertions as $var_id => $_) {
$asserted_keys[$var_id] = true;
}
if ($type_assertions) {
// while in an and, we allow scope to boil over to support
// statements of the form if ($x && $x->foo())
$op_vars_in_scope = \Psalm\Type\Reconciler::reconcileKeyedTypes(
$type_assertions,
$context->vars_in_scope,
$changed_vars,
$asserted_keys,
$statements_analyzer,
$template_type_map,
$context->inside_loop,
new CodeLocation($statements_analyzer->getSource(), $expr)
);
foreach ($changed_vars as $changed_var) {
if (isset($op_vars_in_scope[$changed_var])) {
$op_vars_in_scope[$changed_var]->from_docblock = true;
foreach ($op_vars_in_scope[$changed_var]->getTypes() as $changed_atomic_type) {
$changed_atomic_type->from_docblock = true;
if ($changed_atomic_type instanceof Type\Atomic\TNamedObject
&& $changed_atomic_type->extra_types
) {
foreach ($changed_atomic_type->extra_types as $extra_type) {
$extra_type->from_docblock = true;
}
}
}
}
}
$context->vars_in_scope = $op_vars_in_scope;
}
}
2016-11-01 19:14:35 +01:00
}