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/Call/FunctionCallAnalyzer.php

573 lines
24 KiB
PHP
Raw Normal View History

2018-01-29 00:29:38 +01:00
<?php
2018-11-06 03:57:36 +01:00
namespace Psalm\Internal\Analyzer\Statements\Expression\Call;
2018-01-29 00:29:38 +01:00
use PhpParser;
2018-11-06 03:57:36 +01:00
use Psalm\Internal\Analyzer\FunctionAnalyzer;
use Psalm\Internal\Analyzer\FunctionLikeAnalyzer;
use Psalm\Internal\Analyzer\ProjectAnalyzer;
use Psalm\Internal\Analyzer\Statements\ExpressionAnalyzer;
use Psalm\Internal\Analyzer\StatementsAnalyzer;
use Psalm\Internal\Codebase\CallMap;
2018-01-29 00:29:38 +01:00
use Psalm\CodeLocation;
use Psalm\Context;
use Psalm\Internal\FileManipulation\FileManipulationBuffer;
2018-01-29 00:29:38 +01:00
use Psalm\Issue\ForbiddenCode;
use Psalm\Issue\InvalidFunctionCall;
use Psalm\Issue\NullFunctionCall;
use Psalm\Issue\PossiblyInvalidFunctionCall;
use Psalm\Issue\PossiblyNullFunctionCall;
use Psalm\IssueBuffer;
use Psalm\Type;
use Psalm\Type\Atomic\TCallable;
use Psalm\Type\Atomic\TGenericParam;
2018-01-29 00:29:38 +01:00
use Psalm\Type\Atomic\TMixed;
use Psalm\Type\Atomic\TNamedObject;
use Psalm\Type\Atomic\TNull;
use Psalm\Type\Atomic\TString;
2018-05-07 07:26:06 +02:00
use Psalm\Type\Algebra;
2018-01-29 00:29:38 +01:00
use Psalm\Type\Reconciler;
2018-11-06 03:57:36 +01:00
class FunctionCallAnalyzer extends \Psalm\Internal\Analyzer\Statements\Expression\CallAnalyzer
2018-01-29 00:29:38 +01:00
{
/**
2018-11-11 18:01:14 +01:00
* @param StatementsAnalyzer $statements_analyzer
2018-01-29 00:29:38 +01:00
* @param PhpParser\Node\Expr\FuncCall $stmt
* @param Context $context
*
* @return false|null
*/
public static function analyze(
2018-11-11 18:01:14 +01:00
StatementsAnalyzer $statements_analyzer,
2018-01-29 00:29:38 +01:00
PhpParser\Node\Expr\FuncCall $stmt,
Context $context
) {
$function = $stmt->name;
2018-01-29 00:29:38 +01:00
$function_id = null;
2018-01-29 00:29:38 +01:00
$function_params = null;
$in_call_map = false;
$is_stubbed = false;
$function_storage = null;
2018-11-11 18:01:14 +01:00
$codebase = $statements_analyzer->getCodebase();
2018-11-06 03:57:36 +01:00
2018-11-11 18:01:14 +01:00
$code_location = new CodeLocation($statements_analyzer->getSource(), $stmt);
2018-02-04 00:52:35 +01:00
$codebase_functions = $codebase->functions;
2018-01-29 00:29:38 +01:00
$config = $codebase->config;
$defined_constants = [];
$global_variables = [];
2018-01-29 00:29:38 +01:00
$function_exists = false;
if ($stmt->name instanceof PhpParser\Node\Expr) {
2018-11-11 18:01:14 +01:00
if (ExpressionAnalyzer::analyze($statements_analyzer, $stmt->name, $context) === false) {
2018-01-29 00:29:38 +01:00
return false;
}
if (isset($stmt->name->inferredType)) {
if ($stmt->name->inferredType->isNull()) {
if (IssueBuffer::accepts(
new NullFunctionCall(
'Cannot call function on null value',
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt)
2018-01-29 00:29:38 +01:00
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2018-01-29 00:29:38 +01:00
)) {
return false;
}
return;
}
if ($stmt->name->inferredType->isNullable()) {
if (IssueBuffer::accepts(
new PossiblyNullFunctionCall(
'Cannot call function on possibly null value',
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt)
2018-01-29 00:29:38 +01:00
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2018-01-29 00:29:38 +01:00
)) {
// fall through
}
}
$invalid_function_call_types = [];
$has_valid_function_call_type = false;
foreach ($stmt->name->inferredType->getTypes() as $var_type_part) {
if ($var_type_part instanceof Type\Atomic\Fn || $var_type_part instanceof Type\Atomic\TCallable) {
2018-01-29 00:29:38 +01:00
$function_params = $var_type_part->params;
if (isset($stmt->inferredType) && $var_type_part->return_type) {
2018-01-29 00:29:38 +01:00
$stmt->inferredType = Type::combineUnionTypes(
$stmt->inferredType,
$var_type_part->return_type
);
} else {
$stmt->inferredType = $var_type_part->return_type ?: Type::getMixed();
2018-01-29 00:29:38 +01:00
}
$function_exists = true;
$has_valid_function_call_type = true;
} elseif ($var_type_part instanceof TMixed || $var_type_part instanceof TGenericParam) {
2018-01-29 00:29:38 +01:00
$has_valid_function_call_type = true;
// @todo maybe emit issue here
2018-03-27 07:05:11 +02:00
} elseif (($var_type_part instanceof TNamedObject && $var_type_part->value === 'Closure')) {
// this is fine
$has_valid_function_call_type = true;
2018-03-02 06:49:53 +01:00
} elseif ($var_type_part instanceof TString
2018-03-02 14:38:16 +01:00
|| $var_type_part instanceof Type\Atomic\TArray
2018-03-02 06:49:53 +01:00
|| ($var_type_part instanceof Type\Atomic\ObjectLike
&& count($var_type_part->properties) === 2)
) {
// this is also kind of fine
2018-01-29 00:29:38 +01:00
$has_valid_function_call_type = true;
} elseif ($var_type_part instanceof TNull) {
// handled above
2018-02-01 06:50:01 +01:00
} elseif (!$var_type_part instanceof TNamedObject
2018-02-04 00:52:35 +01:00
|| !$codebase->classlikes->classOrInterfaceExists($var_type_part->value)
|| !$codebase->methods->methodExists($var_type_part->value . '::__invoke')
2018-01-29 00:29:38 +01:00
) {
$invalid_function_call_types[] = (string)$var_type_part;
2018-04-01 00:57:13 +02:00
} else {
if (self::checkMethodArgs(
$var_type_part->value . '::__invoke',
$stmt->args,
$class_template_params,
$context,
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt),
$statements_analyzer
2018-04-01 00:57:13 +02:00
) === false) {
return false;
}
2018-05-09 01:49:25 +02:00
$invokable_return_type = $codebase->methods->getMethodReturnType(
$var_type_part->value . '::__invoke',
$var_type_part->value
);
if (isset($stmt->inferredType)) {
$stmt->inferredType = Type::combineUnionTypes(
$invokable_return_type ?: Type::getMixed(),
$stmt->inferredType
);
} else {
$stmt->inferredType = $invokable_return_type ?: Type::getMixed();
}
2018-01-29 00:29:38 +01:00
}
}
if ($invalid_function_call_types) {
$var_type_part = reset($invalid_function_call_types);
if ($has_valid_function_call_type) {
if (IssueBuffer::accepts(
new PossiblyInvalidFunctionCall(
'Cannot treat type ' . $var_type_part . ' as callable',
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt)
2018-01-29 00:29:38 +01:00
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2018-01-29 00:29:38 +01:00
)) {
return false;
}
} else {
if (IssueBuffer::accepts(
new InvalidFunctionCall(
'Cannot treat type ' . $var_type_part . ' as callable',
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt)
2018-01-29 00:29:38 +01:00
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2018-01-29 00:29:38 +01:00
)) {
return false;
}
}
}
}
if (!isset($stmt->inferredType)) {
$stmt->inferredType = Type::getMixed();
}
} else {
$function_id = implode('\\', $stmt->name->parts);
2018-01-29 00:29:38 +01:00
$in_call_map = CallMap::inCallMap($function_id);
$is_stubbed = $codebase_functions->hasStubbedFunction($function_id);
2018-01-29 00:29:38 +01:00
$is_predefined = true;
$is_maybe_root_function = !$stmt->name instanceof PhpParser\Node\Name\FullyQualified
&& count($stmt->name->parts) === 1;
2018-01-29 00:29:38 +01:00
if (!$in_call_map) {
$predefined_functions = $config->getPredefinedFunctions();
$is_predefined = isset($predefined_functions[$function_id]);
2018-01-29 00:29:38 +01:00
}
if (!$in_call_map && !$stmt->name instanceof PhpParser\Node\Name\FullyQualified) {
$function_id = $codebase_functions->getFullyQualifiedFunctionNameFromString(
$function_id,
2018-11-11 18:01:14 +01:00
$statements_analyzer
2018-02-04 00:52:35 +01:00
);
2018-01-29 00:29:38 +01:00
}
if (!$in_call_map) {
if ($context->check_functions) {
if (self::checkFunctionExists(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$function_id,
$code_location,
$is_maybe_root_function
2018-01-29 00:29:38 +01:00
) === false
) {
return false;
}
} else {
$function_id = self::getExistingFunctionId(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$function_id,
$is_maybe_root_function
);
2018-01-29 00:29:38 +01:00
}
2018-02-04 00:52:35 +01:00
$function_exists = $is_stubbed || $codebase_functions->functionExists(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
strtolower($function_id)
2018-01-29 00:29:38 +01:00
);
} else {
$function_exists = true;
}
if ($function_exists) {
if (!$in_call_map || $is_stubbed) {
2018-02-04 00:52:35 +01:00
$function_storage = $codebase_functions->getStorage(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
strtolower($function_id)
2018-01-29 00:29:38 +01:00
);
$function_params = $function_storage->params;
if (!$is_predefined) {
$defined_constants = $function_storage->defined_constants;
$global_variables = $function_storage->global_variables;
2018-01-29 00:29:38 +01:00
}
}
if ($in_call_map && !$is_stubbed) {
2018-11-06 03:57:36 +01:00
$function_params = FunctionLikeAnalyzer::getFunctionParamsFromCallMapById(
$codebase,
$function_id,
2018-01-29 00:29:38 +01:00
$stmt->args
);
}
if ($codebase->server_mode) {
$codebase->analyzer->addNodeReference(
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFilePath(),
$stmt->name,
$function_id . '()'
);
}
2018-01-29 00:29:38 +01:00
}
}
if (self::checkFunctionArguments(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
2018-01-29 00:29:38 +01:00
$stmt->args,
$function_params,
$function_id,
2018-01-29 00:29:38 +01:00
$context
) === false) {
// fall through
}
if ($function_exists) {
$generic_params = null;
if ($stmt->name instanceof PhpParser\Node\Name && $function_id) {
2018-01-29 00:29:38 +01:00
if (!$is_stubbed && $in_call_map) {
2018-11-06 03:57:36 +01:00
$function_params = FunctionLikeAnalyzer::getFunctionParamsFromCallMapById(
$codebase,
$function_id,
2018-01-29 00:29:38 +01:00
$stmt->args
);
}
}
// do this here to allow closure param checks
if ($function_params !== null
&& self::checkFunctionLikeArgumentsMatch(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
2018-04-10 03:50:38 +02:00
$stmt->args,
$function_id,
$function_params,
$function_storage,
null,
$generic_params,
$code_location,
$context
) === false) {
2018-01-29 00:29:38 +01:00
// fall through
}
if ($stmt->name instanceof PhpParser\Node\Name && $function_id) {
2018-01-29 00:29:38 +01:00
if (!$in_call_map || $is_stubbed) {
if ($function_storage && $function_storage->template_types) {
foreach ($function_storage->template_types as $template_name => $_) {
if (!isset($generic_params[$template_name])) {
$generic_params[$template_name] = Type::getMixed();
}
}
}
if ($function_storage && $context->collect_exceptions) {
$context->possibly_thrown_exceptions += $function_storage->throws;
}
2018-01-29 00:29:38 +01:00
try {
if ($function_storage && $function_storage->return_type) {
$return_type = clone $function_storage->return_type;
if ($generic_params && $function_storage->template_types) {
$return_type->replaceTemplateTypesWithArgTypes(
$generic_params
);
}
$return_type_location = $function_storage->return_type_location;
if ($config->after_function_checks) {
$file_manipulations = [];
foreach ($config->after_function_checks as $plugin_fq_class_name) {
2018-11-06 03:57:36 +01:00
$plugin_fq_class_name::afterFunctionCallAnalysis(
$stmt,
$function_id,
$context,
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSource(),
$file_manipulations,
$return_type
);
}
if ($file_manipulations) {
/** @psalm-suppress MixedTypeCoercion */
FileManipulationBuffer::add(
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFilePath(),
$file_manipulations
);
}
}
2018-01-29 00:29:38 +01:00
$stmt->inferredType = $return_type;
$return_type->by_ref = $function_storage->returns_by_ref;
// only check the type locally if it's defined externally
if ($return_type_location &&
!$is_stubbed && // makes lookups or array_* functions quicker
!$config->isInProjectDirs($return_type_location->file_path)
) {
$return_type->check(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
new CodeLocation($statements_analyzer->getSource(), $stmt),
$statements_analyzer->getSuppressedIssues(),
$context->phantom_classes
2018-01-29 00:29:38 +01:00
);
}
}
} catch (\InvalidArgumentException $e) {
// this can happen when the function was defined in the Config startup script
$stmt->inferredType = Type::getMixed();
}
} else {
2018-11-06 03:57:36 +01:00
$stmt->inferredType = FunctionAnalyzer::getReturnTypeFromCallMapWithArgs(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$function_id,
2018-01-29 00:29:38 +01:00
$stmt->args,
$context,
2018-01-29 00:29:38 +01:00
$code_location,
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
2018-01-29 00:29:38 +01:00
);
}
}
foreach ($defined_constants as $const_name => $const_type) {
$context->constants[$const_name] = clone $const_type;
$context->vars_in_scope[$const_name] = clone $const_type;
}
foreach ($global_variables as $var_id => $_) {
$context->vars_in_scope[$var_id] = Type::getMixed();
$context->vars_possibly_in_scope[$var_id] = true;
}
2018-01-29 00:29:38 +01:00
if ($config->use_assert_for_type &&
$function instanceof PhpParser\Node\Name &&
$function->parts === ['assert'] &&
2018-01-29 00:29:38 +01:00
isset($stmt->args[0])
) {
2018-05-07 07:26:06 +02:00
$assert_clauses = \Psalm\Type\Algebra::getFormula(
2018-01-29 00:29:38 +01:00
$stmt->args[0]->value,
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFQCLN(),
$statements_analyzer,
2018-11-06 03:57:36 +01:00
$codebase
2018-01-29 00:29:38 +01:00
);
2018-05-07 07:26:06 +02:00
$simplified_clauses = Algebra::simplifyCNF(array_merge($context->clauses, $assert_clauses));
2018-01-29 00:29:38 +01:00
2018-05-07 07:26:06 +02:00
$assert_type_assertions = Algebra::getTruthsFromFormula($simplified_clauses);
2018-01-29 00:29:38 +01:00
$changed_vars = [];
// while in an and, we allow scope to boil over to support
// statements of the form if ($x && $x->foo())
$op_vars_in_scope = Reconciler::reconcileKeyedTypes(
$assert_type_assertions,
$context->vars_in_scope,
$changed_vars,
[],
2018-11-11 18:01:14 +01:00
$statements_analyzer,
new CodeLocation($statements_analyzer->getSource(), $stmt)
2018-01-29 00:29:38 +01:00
);
foreach ($changed_vars as $changed_var) {
if (isset($op_vars_in_scope[$changed_var])) {
$op_vars_in_scope[$changed_var]->from_docblock = true;
}
}
$context->vars_in_scope = $op_vars_in_scope;
}
}
if (!$config->remember_property_assignments_after_call
&& !$in_call_map
&& !$context->collect_initializations
) {
2018-01-29 00:29:38 +01:00
$context->removeAllObjectVars();
}
if ($stmt->name instanceof PhpParser\Node\Name &&
($stmt->name->parts === ['get_class'] || $stmt->name->parts === ['gettype']) &&
$stmt->args
) {
$var = $stmt->args[0]->value;
if ($var instanceof PhpParser\Node\Expr\Variable && is_string($var->name)) {
$atomic_type = $stmt->name->parts === ['get_class']
? new Type\Atomic\GetClassT('$' . $var->name)
: new Type\Atomic\GetTypeT('$' . $var->name);
$stmt->inferredType = new Type\Union([$atomic_type]);
}
}
if ($codebase->server_mode
&& (!$context->collect_initializations
&& !$context->collect_mutations)
&& isset($stmt->inferredType)
) {
$codebase->analyzer->addNodeType(
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFilePath(),
$stmt,
(string) $stmt->inferredType
);
}
if ($function_storage) {
if ($function_storage->assertions && $stmt->name instanceof PhpParser\Node\Name) {
self::applyAssertionsToContext(
$stmt->name,
$function_storage->assertions,
$stmt->args,
$function_storage->template_typeof_params ?: [],
$context,
2018-11-11 18:01:14 +01:00
$statements_analyzer
);
}
if ($function_storage->if_true_assertions) {
$stmt->ifTrueAssertions = $function_storage->if_true_assertions;
}
if ($function_storage->if_false_assertions) {
$stmt->ifFalseAssertions = $function_storage->if_false_assertions;
}
}
if ($function instanceof PhpParser\Node\Name) {
$first_arg = isset($stmt->args[0]) ? $stmt->args[0] : null;
if ($function->parts === ['method_exists']) {
$context->check_methods = false;
} elseif ($function->parts === ['class_exists']) {
if ($first_arg && $first_arg->value instanceof PhpParser\Node\Scalar\String_) {
$context->phantom_classes[strtolower($first_arg->value->value)] = true;
}
} elseif ($function->parts === ['file_exists'] && $first_arg) {
2018-11-06 03:57:36 +01:00
$var_id = ExpressionAnalyzer::getArrayVarId($first_arg->value, null);
if ($var_id) {
$context->phantom_files[$var_id] = true;
}
} elseif ($function->parts === ['extension_loaded']) {
if ($first_arg
&& $first_arg->value instanceof PhpParser\Node\Scalar\String_
) {
if (@extension_loaded($first_arg->value->value)) {
// do nothing
} else {
$context->check_classes = false;
}
}
} elseif ($function->parts === ['function_exists']) {
$context->check_functions = false;
} elseif ($function->parts === ['is_callable']) {
$context->check_methods = false;
$context->check_functions = false;
} elseif ($function->parts === ['defined']) {
$context->check_consts = false;
} elseif ($function->parts === ['extract']) {
$context->check_variables = false;
} elseif ($function->parts === ['var_dump'] || $function->parts === ['shell_exec']) {
if (IssueBuffer::accepts(
new ForbiddenCode(
'Unsafe ' . implode('', $function->parts),
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt)
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
return false;
}
} elseif (isset($codebase->config->forbidden_functions[strtolower((string) $function)])) {
if (IssueBuffer::accepts(
new ForbiddenCode(
'You have forbidden the use of ' . $function,
2018-11-11 18:01:14 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt)
),
2018-11-11 18:01:14 +01:00
$statements_analyzer->getSuppressedIssues()
)) {
return false;
}
} elseif ($function->parts === ['define']) {
if ($first_arg && $first_arg->value instanceof PhpParser\Node\Scalar\String_) {
$second_arg = $stmt->args[1];
2018-11-11 18:01:14 +01:00
ExpressionAnalyzer::analyze($statements_analyzer, $second_arg->value, $context);
$const_name = $first_arg->value->value;
2018-11-11 18:01:14 +01:00
$statements_analyzer->setConstType(
$const_name,
isset($second_arg->value->inferredType) ? $second_arg->value->inferredType : Type::getMixed(),
$context
);
} else {
$context->check_consts = false;
}
}
}
2018-01-29 00:29:38 +01:00
return null;
}
}