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

985 lines
41 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\Statements\ExpressionAnalyzer;
use Psalm\Internal\Analyzer\Statements\Expression\AssertionFinder;
2018-11-06 03:57:36 +01:00
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;
use Psalm\Issue\DeprecatedFunction;
2018-01-29 00:29:38 +01:00
use Psalm\Issue\ForbiddenCode;
use Psalm\Issue\MixedFunctionCall;
2018-01-29 00:29:38 +01:00
use Psalm\Issue\InvalidFunctionCall;
use Psalm\Issue\ImpureFunctionCall;
2018-01-29 00:29:38 +01:00
use Psalm\Issue\NullFunctionCall;
use Psalm\Issue\PossiblyInvalidFunctionCall;
use Psalm\Issue\PossiblyNullFunctionCall;
use Psalm\Issue\UnusedFunctionCall;
2018-01-29 00:29:38 +01:00
use Psalm\IssueBuffer;
use Psalm\Storage\Assertion;
2018-01-29 00:29:38 +01:00
use Psalm\Type;
use Psalm\Type\Atomic\TCallableObject;
use Psalm\Type\Atomic\TCallableString;
2019-02-22 03:40:06 +01:00
use Psalm\Type\Atomic\TTemplateParam;
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;
use function count;
2019-09-29 22:04:32 +02:00
use function in_array;
use function reset;
use function implode;
use function strtolower;
use function array_merge;
use function is_string;
use function array_map;
use function extension_loaded;
use function strpos;
use Psalm\Internal\Type\TemplateResult;
2018-01-29 00:29:38 +01:00
/**
* @internal
*/
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) {
$was_in_call = $context->inside_call;
$context->inside_call = true;
2018-11-11 18:01:14 +01:00
if (ExpressionAnalyzer::analyze($statements_analyzer, $stmt->name, $context) === false) {
if (!$was_in_call) {
$context->inside_call = false;
}
2019-06-16 00:15:04 +02:00
return;
2018-01-29 00:29:38 +01:00
}
if (!$was_in_call) {
$context->inside_call = false;
}
if ($stmt_name_type = $statements_analyzer->node_data->getType($stmt->name)) {
if ($stmt_name_type->isNull()) {
2018-01-29 00:29:38 +01:00
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_type->isNullable()) {
2018-01-29 00:29:38 +01:00
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_type->getTypes() as $var_type_part) {
if ($var_type_part instanceof Type\Atomic\TFn || $var_type_part instanceof Type\Atomic\TCallable) {
2018-01-29 00:29:38 +01:00
$function_params = $var_type_part->params;
if (($stmt_type = $statements_analyzer->node_data->getType($stmt))
&& $var_type_part->return_type
) {
$statements_analyzer->node_data->setType(
$stmt,
Type::combineUnionTypes(
$stmt_type,
$var_type_part->return_type
)
2018-01-29 00:29:38 +01:00
);
} else {
$statements_analyzer->node_data->setType(
$stmt,
$var_type_part->return_type ?: Type::getMixed()
);
2018-01-29 00:29:38 +01:00
}
$function_exists = true;
$has_valid_function_call_type = true;
2019-02-22 03:40:06 +01:00
} elseif ($var_type_part instanceof TMixed || $var_type_part instanceof TTemplateParam) {
2018-01-29 00:29:38 +01:00
$has_valid_function_call_type = true;
if (IssueBuffer::accepts(
new MixedFunctionCall(
'Cannot call function on mixed',
new CodeLocation($statements_analyzer->getSource(), $stmt)
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
} elseif ($var_type_part instanceof TCallableObject
|| $var_type_part instanceof TCallableString
) {
// this is fine
$has_valid_function_call_type = true;
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 {
$old_data_provider = $statements_analyzer->node_data;
$statements_analyzer->node_data = clone $statements_analyzer->node_data;
$fake_method_call = new PhpParser\Node\Expr\MethodCall(
$stmt->name,
new PhpParser\Node\Identifier('__invoke', $stmt->name->getAttributes()),
$stmt->args
);
$suppressed_issues = $statements_analyzer->getSuppressedIssues();
if (!in_array('PossiblyNullReference', $suppressed_issues, true)) {
$statements_analyzer->addSuppressedIssues(['PossiblyNullReference']);
}
if (!in_array('InternalMethod', $suppressed_issues, true)) {
$statements_analyzer->addSuppressedIssues(['InternalMethod']);
2018-04-01 00:57:13 +02:00
}
2018-05-09 01:49:25 +02:00
\Psalm\Internal\Analyzer\Statements\Expression\Call\MethodCallAnalyzer::analyze(
$statements_analyzer,
$fake_method_call,
$context,
false
2018-05-09 01:49:25 +02:00
);
if (!in_array('PossiblyNullReference', $suppressed_issues, true)) {
$statements_analyzer->removeSuppressedIssues(['PossiblyNullReference']);
}
if (!in_array('InternalMethod', $suppressed_issues, true)) {
$statements_analyzer->removeSuppressedIssues(['InternalMethod']);
}
$fake_method_call_type = $statements_analyzer->node_data->getType($fake_method_call);
$statements_analyzer->node_data = $old_data_provider;
if ($stmt_type = $statements_analyzer->node_data->getType($stmt)) {
$statements_analyzer->node_data->setType(
$stmt,
Type::combineUnionTypes(
$fake_method_call_type ?: Type::getMixed(),
$stmt_type
)
2018-05-09 01:49:25 +02:00
);
} else {
$statements_analyzer->node_data->setType(
$stmt,
$fake_method_call_type ?: Type::getMixed()
);
2018-05-09 01:49:25 +02:00
}
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
)) {
2019-06-16 00:15:04 +02:00
return;
2018-01-29 00:29:38 +01:00
}
} 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
)) {
2019-06-16 00:15:04 +02:00
return;
2018-01-29 00:29:38 +01:00
}
}
}
}
if (!$statements_analyzer->node_data->getType($stmt)) {
$statements_analyzer->node_data->setType($stmt, Type::getMixed());
2018-01-29 00:29:38 +01:00
}
} else {
2019-01-05 20:50:11 +01:00
$original_function_id = implode('\\', $stmt->name->parts);
2018-01-29 00:29:38 +01:00
2019-01-05 20:50:11 +01:00
if (!$stmt->name instanceof PhpParser\Node\Name\FullyQualified) {
$function_id = $codebase_functions->getFullyQualifiedFunctionNameFromString(
$original_function_id,
$statements_analyzer
);
} else {
$function_id = $original_function_id;
}
$namespaced_function_exists = $codebase_functions->functionExists(
$statements_analyzer,
strtolower($function_id)
);
if (!$namespaced_function_exists
&& !$stmt->name instanceof PhpParser\Node\Name\FullyQualified
) {
$in_call_map = CallMap::inCallMap($original_function_id);
$is_stubbed = $codebase_functions->hasStubbedFunction($original_function_id);
if ($is_stubbed || $in_call_map) {
$function_id = $original_function_id;
}
} else {
$in_call_map = CallMap::inCallMap($function_id);
$is_stubbed = $codebase_functions->hasStubbedFunction($function_id);
}
if ($is_stubbed || $in_call_map || $namespaced_function_exists) {
$function_exists = true;
}
2018-01-29 00:29:38 +01:00
if ($function_exists
2019-10-20 05:03:59 +02:00
&& $codebase->store_node_types
&& !$context->collect_initializations
&& !$context->collect_mutations
) {
ArgumentMapPopulator::recordArgumentPositions(
$statements_analyzer,
$stmt,
$codebase,
$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();
2019-01-05 20:50:11 +01:00
$is_predefined = isset($predefined_functions[strtolower($original_function_id)])
|| isset($predefined_functions[strtolower($function_id)]);
2018-01-29 00:29:38 +01:00
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;
2018-01-29 00:29:38 +01:00
}
}
} else {
$function_exists = true;
}
if ($function_exists) {
$function_params = null;
if ($codebase->functions->params_provider->has($function_id)) {
$function_params = $codebase->functions->params_provider->getFunctionParams(
2018-11-11 18:01:14 +01:00
$statements_analyzer,
$function_id,
$stmt->args
2018-01-29 00:29:38 +01:00
);
}
2018-01-29 00:29:38 +01:00
if ($function_params === null) {
if (!$in_call_map || $is_stubbed) {
$function_storage = $codebase_functions->getStorage(
$statements_analyzer,
strtolower($function_id)
);
$function_params = $function_storage->params;
2018-01-29 00:29:38 +01:00
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) {
$function_callable = \Psalm\Internal\Codebase\CallMap::getCallableFromCallMapById(
$codebase,
$function_id,
$stmt->args,
$statements_analyzer->node_data
);
$function_params = $function_callable->params;
}
2018-01-29 00:29:38 +01:00
}
if ($codebase->store_node_types
&& !$context->collect_initializations
&& !$context->collect_mutations
) {
$codebase->analyzer->addNodeReference(
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFilePath(),
$stmt->name,
$function_id . '()'
);
}
2018-01-29 00:29:38 +01:00
}
}
$set_inside_conditional = false;
if ($function instanceof PhpParser\Node\Name
&& $function->parts === ['assert']
&& !$context->inside_conditional
) {
$context->inside_conditional = true;
$set_inside_conditional = true;
}
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 ($set_inside_conditional) {
$context->inside_conditional = false;
}
$template_result = null;
2018-01-29 00:29:38 +01:00
if ($function_exists) {
if ($stmt->name instanceof PhpParser\Node\Name && $function_id) {
2018-01-29 00:29:38 +01:00
if (!$is_stubbed && $in_call_map) {
$function_callable = \Psalm\Internal\Codebase\CallMap::getCallableFromCallMapById(
$codebase,
$function_id,
$stmt->args,
$statements_analyzer->node_data
2018-01-29 00:29:38 +01:00
);
$function_params = $function_callable->params;
2018-01-29 00:29:38 +01:00
}
}
$template_result = new TemplateResult([], []);
2018-01-29 00:29:38 +01:00
// 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,
$template_result,
2018-04-10 03:50:38 +02:00
$code_location,
$context
) === false) {
2018-01-29 00:29:38 +01:00
// fall through
}
if ($stmt->name instanceof PhpParser\Node\Name && $function_id) {
$stmt_type = null;
if ($codebase->functions->return_type_provider->has($function_id)) {
$stmt_type = $codebase->functions->return_type_provider->getReturnType(
$statements_analyzer,
$function_id,
$stmt->args,
$context,
new CodeLocation($statements_analyzer->getSource(), $stmt->name)
);
}
2018-01-29 00:29:38 +01:00
if (!$stmt_type) {
if (!$in_call_map || $is_stubbed) {
if ($function_storage && $function_storage->template_types) {
foreach ($function_storage->template_types as $template_name => $_) {
if (!isset($template_result->generic_params[$template_name])) {
$template_result->generic_params[$template_name] = ['' => [Type::getEmpty(), 0]];
}
2018-01-29 00:29:38 +01:00
}
}
2018-01-29 00:29:38 +01:00
if ($function_storage && !$context->isSuppressingExceptions($statements_analyzer)) {
$context->mergeFunctionExceptions(
$function_storage,
2019-03-24 21:08:05 +01:00
new CodeLocation($statements_analyzer->getSource(), $stmt)
);
}
2018-01-29 00:29:38 +01:00
try {
if ($function_storage && $function_storage->return_type) {
$return_type = clone $function_storage->return_type;
if ($template_result->generic_params && $function_storage->template_types) {
$return_type->replaceTemplateTypesWithArgTypes(
$template_result->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) {
$plugin_fq_class_name::afterFunctionCallAnalysis(
$stmt,
$function_id,
$context,
$statements_analyzer->getSource(),
$codebase,
$file_manipulations,
$return_type
);
}
if ($file_manipulations) {
FileManipulationBuffer::add(
$statements_analyzer->getFilePath(),
$file_manipulations
);
}
}
if ($return_type === null) {
throw new \UnexpectedValueException('$return_type shouldnt be null here');
}
$statements_analyzer->node_data->setType($stmt, $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(
$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
$statements_analyzer->node_data->setType($stmt, Type::getMixed());
2018-01-29 00:29:38 +01:00
}
} else {
$stmt_type = FunctionAnalyzer::getReturnTypeFromCallMapWithArgs(
$statements_analyzer,
$function_id,
$stmt->args,
$context
);
if ($codebase->taint) {
FunctionAnalyzer::taintBuiltinFunctionReturn(
$statements_analyzer,
$function_id,
$stmt->args,
$stmt_type
);
}
2018-01-29 00:29:38 +01:00
}
}
if ($stmt_type) {
$statements_analyzer->node_data->setType($stmt, $stmt_type);
}
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
if ($assert_type_assertions) {
$changed_var_ids = [];
// 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_var_ids,
[],
$statements_analyzer,
[],
$context->inside_loop,
new CodeLocation($statements_analyzer->getSource(), $stmt)
);
2018-01-29 00:29:38 +01:00
foreach ($changed_var_ids as $var_id => $_) {
if (isset($op_vars_in_scope[$var_id])) {
$op_vars_in_scope[$var_id]->from_docblock = true;
}
2018-01-29 00:29:38 +01:00
}
$context->vars_in_scope = $op_vars_in_scope;
}
2018-01-29 00:29:38 +01:00
}
}
if ($stmt->name instanceof PhpParser\Node\Name
&& ($stmt->name->parts === ['get_class'] || $stmt->name->parts === ['gettype'])
2018-01-29 00:29:38 +01:00
) {
if ($stmt->args) {
$var = $stmt->args[0]->value;
2018-01-29 00:29:38 +01:00
if ($var instanceof PhpParser\Node\Expr\Variable
&& is_string($var->name)
) {
$var_id = '$' . $var->name;
if (isset($context->vars_in_scope[$var_id])) {
$atomic_type = $stmt->name->parts === ['get_class']
? new Type\Atomic\GetClassT($var_id, $context->vars_in_scope[$var_id])
: new Type\Atomic\GetTypeT($var_id);
2018-01-29 00:29:38 +01:00
$statements_analyzer->node_data->setType($stmt, new Type\Union([$atomic_type]));
}
} elseif ($var_type = $statements_analyzer->node_data->getType($var)) {
$class_string_types = [];
foreach ($var_type->getTypes() as $class_type) {
if ($class_type instanceof Type\Atomic\TNamedObject) {
$class_string_types[] = new Type\Atomic\TClassString($class_type->value, clone $class_type);
}
}
if ($class_string_types) {
$statements_analyzer->node_data->setType($stmt, new Type\Union($class_string_types));
}
}
} elseif ($stmt->name->parts === ['get_class']
&& ($get_class_name = $statements_analyzer->getFQCLN())
) {
$statements_analyzer->node_data->setType(
$stmt,
new Type\Union([
new Type\Atomic\TClassString(
$get_class_name,
new Type\Atomic\TNamedObject($get_class_name)
)
])
);
2018-01-29 00:29:38 +01:00
}
}
2019-02-24 07:33:25 +01:00
if ($codebase->store_node_types
&& !$context->collect_initializations
&& !$context->collect_mutations
&& ($stmt_type = $statements_analyzer->node_data->getType($stmt))
) {
$codebase->analyzer->addNodeType(
2018-11-11 18:01:14 +01:00
$statements_analyzer->getFilePath(),
$stmt,
(string) $stmt_type
);
}
if (!$context->collect_initializations
&& !$context->collect_mutations
&& ($context->mutation_free
|| $context->external_mutation_free
|| $codebase->find_unused_variables
|| !$config->remember_property_assignments_after_call)
) {
$must_use = true;
$callmap_function_pure = $function_id && $in_call_map
? $codebase->functions->isCallMapFunctionPure($codebase, $function_id, $stmt->args, $must_use)
: null;
if (($function_storage
&& !$function_storage->pure)
|| ($callmap_function_pure === false)
) {
if ($context->mutation_free || $context->external_mutation_free) {
if (IssueBuffer::accepts(
new ImpureFunctionCall(
2019-08-30 18:36:35 +02:00
'Cannot call an impure function from a mutation-free context',
new CodeLocation($statements_analyzer, $stmt->name)
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
}
if (!$config->remember_property_assignments_after_call) {
$context->removeAllObjectVars();
}
} elseif ($function_id
&& (($function_storage && $function_storage->pure && $must_use)
|| ($callmap_function_pure === true && $must_use))
&& $codebase->find_unused_variables
&& !$context->inside_conditional
&& !$context->inside_unset
) {
if (!$context->inside_assignment && !$context->inside_call) {
if (IssueBuffer::accepts(
new UnusedFunctionCall(
'The call to ' . $function_id . ' is not used',
new CodeLocation($statements_analyzer, $stmt->name),
$function_id
),
$statements_analyzer->getSuppressedIssues()
)) {
// fall through
}
} else {
2019-08-17 05:33:28 +02:00
/** @psalm-suppress UndefinedPropertyAssignment */
$stmt->pure = true;
}
}
}
if ($function_storage) {
$generic_params = $template_result ? $template_result->generic_params : [];
if ($function_storage->assertions && $stmt->name instanceof PhpParser\Node\Name) {
self::applyAssertionsToContext(
$stmt->name,
null,
$function_storage->assertions,
$stmt->args,
$generic_params,
$context,
2018-11-11 18:01:14 +01:00
$statements_analyzer
);
}
if ($function_storage->if_true_assertions) {
$statements_analyzer->node_data->setIfTrueAssertions(
$stmt,
array_map(
function (Assertion $assertion) use ($generic_params) : Assertion {
return $assertion->getUntemplatedCopy($generic_params ?: []);
},
$function_storage->if_true_assertions
)
);
}
if ($function_storage->if_false_assertions) {
$statements_analyzer->node_data->setIfFalseAssertions(
$stmt,
array_map(
function (Assertion $assertion) use ($generic_params) : Assertion {
return $assertion->getUntemplatedCopy($generic_params ?: []);
},
$function_storage->if_false_assertions
)
);
}
if ($function_storage->deprecated && $function_id) {
if (IssueBuffer::accepts(
new DeprecatedFunction(
'The function ' . $function_id . ' has been marked as deprecated',
$code_location,
$function_id
),
$statements_analyzer->getSuppressedIssues()
)) {
// continue
}
}
}
if ($function instanceof PhpParser\Node\Name) {
$first_arg = isset($stmt->args[0]) ? $stmt->args[0] : null;
if ($function->parts === ['method_exists']) {
$second_arg = isset($stmt->args[1]) ? $stmt->args[1] : null;
if ($first_arg
&& $first_arg->value instanceof PhpParser\Node\Expr\Variable
&& $second_arg
&& $second_arg->value instanceof PhpParser\Node\Scalar\String_
) {
// do nothing
} else {
$context->check_methods = false;
}
} elseif ($function->parts === ['class_exists']) {
if ($first_arg) {
if ($first_arg->value instanceof PhpParser\Node\Scalar\String_) {
$context->phantom_classes[strtolower($first_arg->value->value)] = true;
} elseif ($first_arg->value instanceof PhpParser\Node\Expr\ClassConstFetch
&& $first_arg->value->class instanceof PhpParser\Node\Name
&& $first_arg->value->name instanceof PhpParser\Node\Identifier
&& $first_arg->value->name->name === 'class'
) {
$resolved_name = (string) $first_arg->value->class->getAttribute('resolvedName');
2019-06-27 16:17:11 +02:00
if (!$codebase->classlikes->classExists($resolved_name)) {
$context->phantom_classes[strtolower($resolved_name)] = true;
}
}
}
} elseif ($function->parts === ['interface_exists']) {
if ($first_arg) {
if ($first_arg->value instanceof PhpParser\Node\Scalar\String_) {
$context->phantom_classes[strtolower($first_arg->value->value)] = true;
} elseif ($first_arg->value instanceof PhpParser\Node\Expr\ClassConstFetch
&& $first_arg->value->class instanceof PhpParser\Node\Name
&& $first_arg->value->name instanceof PhpParser\Node\Identifier
&& $first_arg->value->name->name === 'class'
) {
$resolved_name = (string) $first_arg->value->class->getAttribute('resolvedName');
if (!$codebase->classlikes->interfaceExists($resolved_name)) {
$context->phantom_classes[strtolower($resolved_name)] = true;
2019-06-27 16:17:11 +02:00
}
}
}
} 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;
2019-04-13 17:31:22 +02:00
} elseif (strtolower($function->parts[0]) === 'var_dump'
|| strtolower($function->parts[0]) === '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()
)) {
2019-03-23 15:58:26 +01:00
// continue
}
} 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()
)) {
2019-03-23 15:58:26 +01:00
// continue
}
} elseif ($function->parts === ['define']) {
2019-02-18 19:51:27 +01:00
if ($first_arg) {
$fq_const_name = StatementsAnalyzer::getConstName(
$first_arg->value,
$statements_analyzer->node_data,
$codebase,
$statements_analyzer->getAliases()
);
2019-02-18 19:51:27 +01:00
if ($fq_const_name !== null) {
2019-02-18 19:51:27 +01:00
$second_arg = $stmt->args[1];
$context->inside_call = true;
2019-02-18 19:51:27 +01:00
ExpressionAnalyzer::analyze($statements_analyzer, $second_arg->value, $context);
$context->inside_call = false;
2019-02-18 19:51:27 +01:00
$statements_analyzer->setConstType(
$fq_const_name,
$statements_analyzer->node_data->getType($second_arg->value) ?: Type::getMixed(),
2019-02-18 19:51:27 +01:00
$context
);
}
} else {
$context->check_consts = false;
}
} elseif ($first_arg
&& $function_id
&& strpos($function_id, 'is_') === 0
&& $function_id !== 'is_a'
) {
$stmt_assertions = $statements_analyzer->node_data->getAssertions($stmt);
if ($stmt_assertions !== null) {
$assertions = $stmt_assertions;
} else {
$assertions = AssertionFinder::processFunctionCall(
$stmt,
$context->self,
$statements_analyzer,
$context->inside_negation
);
}
$changed_vars = [];
$referenced_var_ids = array_map(
function (array $_) : bool {
return true;
},
$assertions
);
if ($assertions) {
Reconciler::reconcileKeyedTypes(
$assertions,
$context->vars_in_scope,
$changed_vars,
$referenced_var_ids,
$statements_analyzer,
[],
$context->inside_loop,
new CodeLocation($statements_analyzer->getSource(), $stmt)
);
}
}
}
2019-10-14 23:10:30 +02:00
if ($codebase->taint
&& $function_id
&& $in_call_map
&& $codebase->functions->isCallMapFunctionPure($codebase, $function_id, $stmt->args)
&& ($stmt_type = $statements_analyzer->node_data->getType($stmt))
2019-10-14 23:10:30 +02:00
) {
if ($function_id === 'substr'
&& isset($stmt->args[0])
&& ($first_arg_type = $statements_analyzer->node_data->getType($stmt->args[0]->value))
) {
$stmt_type->sources = $first_arg_type->sources ?? null;
$stmt_type->tainted = $first_arg_type->tainted ?? null;
2019-10-14 23:10:30 +02:00
}
if (($function_id === 'str_replace' || $function_id === 'preg_replace')
&& count($stmt->args) >= 3
) {
$second_arg_type = $statements_analyzer->node_data->getType($stmt->args[1]->value);
$third_arg_type = $statements_analyzer->node_data->getType($stmt->args[2]->value);
$stmt_type->sources = array_merge(
$second_arg_type->sources ?? [],
$third_arg_type->sources ?? []
2019-10-14 23:10:30 +02:00
);
$stmt_type->tainted = ($second_arg_type->tainted ?? 0) | ($third_arg_type->tainted ?? 0);
2019-10-14 23:10:30 +02:00
}
}
if (!$statements_analyzer->node_data->getType($stmt)) {
$statements_analyzer->node_data->setType($stmt, Type::getMixed());
}
2018-01-29 00:29:38 +01:00
return null;
}
}