name; if ($method instanceof PhpParser\Node\Name) { $first_arg = isset($stmt->args[0]) ? $stmt->args[0] : null; if ($method->parts === ['method_exists']) { $context->check_methods = false; } elseif ($method->parts === ['class_exists']) { if ($first_arg && $first_arg->value instanceof PhpParser\Node\Scalar\String_) { $context->addPhantomClass($first_arg->value->value); } else { $context->check_classes = false; } } elseif ($method->parts === ['function_exists']) { $context->check_functions = false; } elseif ($method->parts === ['is_callable']) { $context->check_methods = false; $context->check_functions = false; } elseif ($method->parts === ['defined']) { $context->check_consts = false; } elseif ($method->parts === ['extract']) { $context->check_variables = false; } elseif ($method->parts === ['var_dump'] || $method->parts === ['shell_exec']) { if (IssueBuffer::accepts( new ForbiddenCode( 'Unsafe ' . implode('', $method->parts), new CodeLocation($statements_checker->getSource(), $stmt) ), $statements_checker->getSuppressedIssues() )) { return false; } } elseif ($method->parts === ['define']) { if ($first_arg && $first_arg->value instanceof PhpParser\Node\Scalar\String_) { $second_arg = $stmt->args[1]; ExpressionChecker::analyze($statements_checker, $second_arg->value, $context); $const_name = $first_arg->value->value; $statements_checker->setConstType( $const_name, isset($second_arg->value->inferredType) ? $second_arg->value->inferredType : Type::getMixed(), $context ); } else { $context->check_consts = false; } } } $method_id = null; if ($context->check_functions) { $in_call_map = false; $function_params = null; $code_location = new CodeLocation($statements_checker->getSource(), $stmt); $defined_constants = []; if ($stmt->name instanceof PhpParser\Node\Expr) { if (ExpressionChecker::analyze($statements_checker, $stmt->name, $context) === false) { return false; } if (isset($stmt->name->inferredType)) { foreach ($stmt->name->inferredType->types as $var_type_part) { if ($var_type_part instanceof Type\Atomic\Fn) { $function_params = $var_type_part->params; if ($var_type_part->return_type) { if (isset($stmt->inferredType)) { $stmt->inferredType = Type::combineUnionTypes( $stmt->inferredType, $var_type_part->return_type ); } else { $stmt->inferredType = $var_type_part->return_type; } } } elseif (!$var_type_part instanceof TMixed && (!$var_type_part instanceof TNamedObject || $var_type_part->value !== 'Closure') && !$var_type_part instanceof TCallable && (!$var_type_part instanceof TNamedObject || !MethodChecker::methodExists($var_type_part->value . '::__invoke') ) ) { $var_id = ExpressionChecker::getVarId( $stmt->name, $statements_checker->getFQCLN(), $statements_checker ); if (IssueBuffer::accepts( new InvalidFunctionCall( 'Cannot treat ' . $var_id . ' of type ' . $var_type_part . ' as function', new CodeLocation($statements_checker->getSource(), $stmt) ), $statements_checker->getSuppressedIssues() )) { return false; } } } } if (!isset($stmt->inferredType)) { $stmt->inferredType = Type::getMixed(); } } else { $method_id = implode('\\', $stmt->name->parts); $in_call_map = FunctionChecker::inCallMap($method_id); $is_predefined = true; if (!$in_call_map) { $predefined_functions = Config::getInstance()->getPredefinedFunctions(); $is_predefined = isset($predefined_functions[$method_id]); } if (!$in_call_map && !$stmt->name instanceof PhpParser\Node\Name\FullyQualified) { $method_id = FunctionChecker::getFQFunctionNameFromString($method_id, $statements_checker); } if ($context->self) { //$method_id = $statements_checker->getFQCLN() . '::' . $method_id; } if (!$in_call_map && self::checkFunctionExists($statements_checker, $method_id, $context, $code_location) === false ) { return false; } $function_params = FunctionLikeChecker::getFunctionParamsById( $method_id, $stmt->args, $statements_checker->getFilePath(), $statements_checker->getFileChecker() ); if (!$in_call_map && !$is_predefined) { $defined_constants = FunctionChecker::getDefinedConstants( $method_id, $statements_checker->getFilePath() ); } } if (self::checkFunctionArguments( $statements_checker, $stmt->args, $function_params, $context ) === false) { // fall through } if ($stmt->name instanceof PhpParser\Node\Name && $method_id) { $function_params = FunctionLikeChecker::getFunctionParamsById( $method_id, $stmt->args, $statements_checker->getFilePath(), $statements_checker->getFileChecker() ); } if (self::checkFunctionArgumentsMatch( $statements_checker, $stmt->args, $method_id, $function_params, $context, $code_location ) === false) { // fall through } foreach ($defined_constants as $const_name => $const_type) { $context->constants[$const_name] = clone $const_type; $context->vars_in_scope[$const_name] = clone $const_type; } if ($method_id) { if ($in_call_map) { $stmt->inferredType = FunctionChecker::getReturnTypeFromCallMapWithArgs( $method_id, $stmt->args, $code_location, $statements_checker->getSuppressedIssues() ); } else { try { $stmt->inferredType = FunctionChecker::getFunctionReturnType( $method_id, $statements_checker->getCheckedFilePath() ); } catch (\InvalidArgumentException $e) { // this can happen when the function was defined in the Config startup script $stmt->inferredType = Type::getMixed(); } } } } if ($stmt->name instanceof PhpParser\Node\Name && ($stmt->name->parts === ['get_class'] || $stmt->name->parts === ['gettype']) && $stmt->args ) { $var = $stmt->args[0]->value; if ($var instanceof PhpParser\Node\Expr\Variable && is_string($var->name)) { $stmt->inferredType = new Type\Union([new Type\Atomic\T('$' . $var->name)]); } } return null; } /** * @param StatementsChecker $statements_checker * @param PhpParser\Node\Expr\New_ $stmt * @param Context $context * @return false|null */ public static function analyzeNew( StatementsChecker $statements_checker, PhpParser\Node\Expr\New_ $stmt, Context $context ) { $fq_class_name = null; $file_checker = $statements_checker->getFileChecker(); $late_static = false; if ($stmt->class instanceof PhpParser\Node\Name) { if (!in_array($stmt->class->parts[0], ['self', 'static', 'parent'])) { $fq_class_name = ClassLikeChecker::getFQCLNFromNameObject( $stmt->class, $statements_checker ); if ($context->check_classes) { if ($context->isPhantomClass($fq_class_name)) { return null; } if (ClassLikeChecker::checkFullyQualifiedClassLikeName( $fq_class_name, $file_checker, new CodeLocation($statements_checker->getSource(), $stmt->class), $statements_checker->getSuppressedIssues(), true ) === false) { return false; } } } else { switch ($stmt->class->parts[0]) { case 'self': $fq_class_name = $context->self; break; case 'parent': $fq_class_name = $context->parent; break; case 'static': // @todo maybe we can do better here $fq_class_name = $context->self; $late_static = true; break; } } } elseif ($stmt->class instanceof PhpParser\Node\Stmt\Class_) { $statements_checker->analyze([$stmt->class], $context); $fq_class_name = $stmt->class->name; } else { ExpressionChecker::analyze($statements_checker, $stmt->class, $context); } if ($fq_class_name) { $stmt->inferredType = new Type\Union([new TNamedObject($fq_class_name)]); if (strtolower($fq_class_name) !== 'stdclass' && $context->check_classes && ClassChecker::classExists($fq_class_name, $file_checker) ) { $storage = ClassLikeChecker::$storage[strtolower($fq_class_name)]; // if we're not calling this constructor via new static() if ($storage->abstract && !$late_static) { if (IssueBuffer::accepts( new AbstractInstantiation( 'Unable to instantiate a abstract class ' . $fq_class_name, new CodeLocation($statements_checker->getSource(), $stmt) ), $statements_checker->getSuppressedIssues() )) { return false; } } if (MethodChecker::methodExists($fq_class_name . '::__construct')) { $method_id = $fq_class_name . '::__construct'; $method_params = FunctionLikeChecker::getMethodParamsById($method_id, $stmt->args, $file_checker); if (self::checkFunctionArguments( $statements_checker, $stmt->args, $method_params, $context ) === false) { return false; } // check again after we've processed args $method_params = FunctionLikeChecker::getMethodParamsById($method_id, $stmt->args, $file_checker); if (self::checkFunctionArgumentsMatch( $statements_checker, $stmt->args, $method_id, $method_params, $context, new CodeLocation($statements_checker->getSource(), $stmt) ) === false) { // fall through } if ($fq_class_name === 'ArrayIterator' && isset($stmt->args[0]->value->inferredType)) { /** @var Type\Union */ $first_arg_type = $stmt->args[0]->value->inferredType; if ($first_arg_type->hasGeneric()) { /** @var Type\Union|null */ $key_type = null; /** @var Type\Union|null */ $value_type = null; foreach ($first_arg_type->types as $type) { if ($type instanceof Type\Atomic\TArray) { $first_type_param = count($type->type_params) ? $type->type_params[0] : null; $last_type_param = $type->type_params[count($type->type_params) - 1]; if ($value_type === null) { $value_type = clone $last_type_param; } else { $value_type = Type::combineUnionTypes($value_type, $last_type_param); } if (!$key_type || !$first_type_param) { $key_type = $first_type_param ? clone $first_type_param : Type::getMixed(); } else { $key_type = Type::combineUnionTypes($key_type, $first_type_param); } } } if ($key_type === null) { throw new \UnexpectedValueException('$key_type cannot be null'); } if ($value_type === null) { throw new \UnexpectedValueException('$value_type cannot be null'); } $stmt->inferredType = new Type\Union([ new Type\Atomic\TGenericObject( $fq_class_name, [ $key_type, $value_type ] ) ]); } } } } } return null; } /** * @return false|null */ /** * @param StatementsChecker $statements_checker * @param PhpParser\Node\Expr\MethodCall $stmt * @param Context $context * @return false|null */ public static function analyzeMethodCall( StatementsChecker $statements_checker, PhpParser\Node\Expr\MethodCall $stmt, Context $context ) { if (ExpressionChecker::analyze($statements_checker, $stmt->var, $context) === false) { return false; } $class_type = null; $method_id = null; if ($stmt->var instanceof PhpParser\Node\Expr\Variable) { if (is_string($stmt->var->name) && $stmt->var->name === 'this' && !$statements_checker->getClassName()) { if (IssueBuffer::accepts( new InvalidScope( 'Use of $this in non-class context', new CodeLocation($statements_checker->getSource(), $stmt) ), $statements_checker->getSuppressedIssues() )) { return false; } } } $var_id = ExpressionChecker::getVarId( $stmt->var, $statements_checker->getFQCLN(), $statements_checker ); $class_type = isset($context->vars_in_scope[$var_id]) ? $context->vars_in_scope[$var_id] : null; if (isset($stmt->var->inferredType)) { /** @var Type\Union */ $class_type = $stmt->var->inferredType; } elseif (!$class_type) { $stmt->inferredType = Type::getMixed(); } $source = $statements_checker->getSource(); if (!$context->check_methods || !$context->check_classes) { return null; } $has_mock = false; if ($class_type && is_string($stmt->name)) { /** @var Type\Union|null */ $return_type = null; foreach ($class_type->types as $type) { if (!$type instanceof TNamedObject) { switch (get_class($type)) { case 'Psalm\\Type\\Atomic\\TNull': if (IssueBuffer::accepts( new NullReference( 'Cannot call method ' . $stmt->name . ' on possibly null variable ' . $var_id, new CodeLocation($statements_checker->getSource(), $stmt) ), $statements_checker->getSuppressedIssues() )) { return false; } break; case 'Psalm\\Type\\Atomic\\TInt': case 'Psalm\\Type\\Atomic\\TBool': case 'Psalm\\Type\\Atomic\\TFalse': case 'Psalm\\Type\\Atomic\\TArray': case 'Psalm\\Type\\Atomic\\TString': case 'Psalm\\Type\\Atomic\\TNumericString': if (IssueBuffer::accepts( new InvalidArgument( 'Cannot call method ' . $stmt->name . ' on ' . $class_type . ' variable ' . $var_id, new CodeLocation($statements_checker->getSource(), $stmt) ), $statements_checker->getSuppressedIssues() )) { return false; } break; case 'Psalm\\Type\\Atomic\\TMixed': case 'Psalm\\Type\\Atomic\\TObject': if (IssueBuffer::accepts( new MixedMethodCall( 'Cannot call method ' . $stmt->name . ' on a mixed variable ' . $var_id, new CodeLocation($statements_checker->getSource(), $stmt) ), $statements_checker->getSuppressedIssues() )) { return false; } break; } continue; } $fq_class_name = $type->value; $is_mock = ExpressionChecker::isMock($fq_class_name); $has_mock = $has_mock || $is_mock; if ($fq_class_name === 'static') { $fq_class_name = (string) $context->self; } if ($is_mock || $context->isPhantomClass($fq_class_name) ) { $return_type = Type::getMixed(); continue; } $does_class_exist = ClassLikeChecker::checkFullyQualifiedClassLikeName( $fq_class_name, $statements_checker->getFileChecker(), new CodeLocation($statements_checker->getSource(), $stmt->var), $statements_checker->getSuppressedIssues(), true ); if (!$does_class_exist) { return $does_class_exist; } if (MethodChecker::methodExists($fq_class_name . '::__call')) { $return_type = Type::getMixed(); continue; } $method_id = $fq_class_name . '::' . strtolower($stmt->name); $cased_method_id = $fq_class_name . '::' . $stmt->name; $does_method_exist = MethodChecker::checkMethodExists( $cased_method_id, new CodeLocation($statements_checker->getSource(), $stmt), $statements_checker->getSuppressedIssues() ); if (!$does_method_exist) { return $does_method_exist; } if (FunctionChecker::inCallMap($cased_method_id)) { $return_type_candidate = FunctionChecker::getReturnTypeFromCallMap($method_id); } else { if (MethodChecker::checkMethodVisibility( $method_id, $context->self, $statements_checker->getSource(), new CodeLocation($statements_checker->getSource(), $stmt), $statements_checker->getSuppressedIssues() ) === false) { return false; } if (MethodChecker::checkMethodNotDeprecated( $method_id, new CodeLocation($statements_checker->getSource(), $stmt), $statements_checker->getSuppressedIssues() ) === false) { return false; } $return_type_candidate = MethodChecker::getMethodReturnType($method_id); } if ($stmt->var instanceof PhpParser\Node\Expr\Variable && $stmt->var->name === 'this' && is_string($stmt->name) && $source instanceof FunctionLikeChecker ) { $this_method_id = $source->getMethodId(); $fq_class_name = (string)$statements_checker->getFQCLN(); if ($context->collect_mutations && $context->self && ( $context->self === $fq_class_name || ClassChecker::classExtends( $context->self, $fq_class_name ) ) ) { $file_checker = $source->getFileChecker(); $method_id = $statements_checker->getFQCLN() . '::' . strtolower($stmt->name); if ($file_checker->project_checker->getMethodMutations($method_id, $context) === false) { return false; } } elseif ($context->collect_initializations && $context->self && ( $context->self === $fq_class_name || ClassChecker::classExtends( $context->self, $fq_class_name ) ) ) { $method_id = $statements_checker->getFQCLN() . '::' . strtolower($stmt->name); $declaring_method_id = MethodChecker::getDeclaringMethodId($method_id); $method_storage = MethodChecker::getStorage((string)$declaring_method_id); $class_checker = $source->getSource(); if ($class_checker instanceof ClassLikeChecker && $method_storage->visibility === ClassLikeChecker::VISIBILITY_PRIVATE ) { if ($class_checker->getMethodMutations(strtolower($stmt->name), $context) === false) { return false; } } } } if ($return_type_candidate) { $return_type_candidate = ExpressionChecker::fleshOutTypes( $return_type_candidate, $stmt->args, $fq_class_name, $method_id ); if (!$return_type) { $return_type = $return_type_candidate; } else { $return_type = Type::combineUnionTypes($return_type_candidate, $return_type); } } else { $return_type = Type::getMixed(); } } $stmt->inferredType = $return_type; } $method_params = $method_id ? FunctionLikeChecker::getMethodParamsById($method_id, $stmt->args, $statements_checker->getFileChecker()) : null; if (self::checkFunctionArguments( $statements_checker, $stmt->args, $method_params, $context ) === false) { return false; } // check again after we've processed args $method_params = $method_id ? FunctionLikeChecker::getMethodParamsById($method_id, $stmt->args, $statements_checker->getFileChecker()) : null; if (self::checkFunctionArgumentsMatch( $statements_checker, $stmt->args, $method_id, $method_params, $context, new CodeLocation($statements_checker->getSource(), $stmt), $has_mock ) === false) { return false; } return null; } /** * @param StatementsChecker $statements_checker * @param PhpParser\Node\Expr\StaticCall $stmt * @param Context $context * @return false|null */ public static function analyzeStaticCall( StatementsChecker $statements_checker, PhpParser\Node\Expr\StaticCall $stmt, Context $context ) { if ($stmt->class instanceof PhpParser\Node\Expr\Variable || $stmt->class instanceof PhpParser\Node\Expr\ArrayDimFetch ) { // this is when calling $some_class::staticMethod() - which is a shitty way of doing things // because it can't be statically type-checked return null; } $method_id = null; $fq_class_name = null; $lhs_type = null; $file_checker = $statements_checker->getFileChecker(); if ($stmt->class instanceof PhpParser\Node\Name) { $fq_class_name = null; if (count($stmt->class->parts) === 1 && in_array($stmt->class->parts[0], ['self', 'static', 'parent'])) { if ($stmt->class->parts[0] === 'parent') { $fq_class_name = $statements_checker->getParentFQCLN(); if ($fq_class_name === null) { if (IssueBuffer::accepts( new ParentNotFound( 'Cannot call method on parent as this class does not extend another', new CodeLocation($statements_checker->getSource(), $stmt) ), $statements_checker->getSuppressedIssues() )) { return false; } return; } if (is_string($stmt->name)) { if ($context->collect_mutations) { $method_id = $fq_class_name . '::' . strtolower($stmt->name); if ($file_checker->project_checker->getMethodMutations($method_id, $context) === false) { return false; } } } } else { $namespace = $statements_checker->getNamespace() ? $statements_checker->getNamespace() . '\\' : ''; $fq_class_name = $context->self ?: $namespace . $statements_checker->getClassName(); } if ($context->isPhantomClass($fq_class_name)) { return null; } } elseif ($context->check_classes) { $fq_class_name = ClassLikeChecker::getFQCLNFromNameObject( $stmt->class, $statements_checker ); if ($context->isPhantomClass($fq_class_name)) { return null; } $does_class_exist = ClassLikeChecker::checkFullyQualifiedClassLikeName( $fq_class_name, $file_checker, new CodeLocation($statements_checker->getSource(), $stmt->class), $statements_checker->getSuppressedIssues(), true ); if (!$does_class_exist) { return $does_class_exist; } } if ($fq_class_name) { $lhs_type = new Type\Union([new TNamedObject($fq_class_name)]); } } else { ExpressionChecker::analyze($statements_checker, $stmt->class, $context); /** @var Type\Union */ $lhs_type = $stmt->class->inferredType; } if (!$context->check_methods || !$lhs_type) { return null; } $has_mock = false; foreach ($lhs_type->types as $lhs_type_part) { if (!$lhs_type_part instanceof TNamedObject) { // @todo deal with it continue; } $fq_class_name = $lhs_type_part->value; $is_mock = ExpressionChecker::isMock($fq_class_name); $has_mock = $has_mock || $is_mock; $method_id = null; if (is_string($stmt->name) && !MethodChecker::methodExists($fq_class_name . '::__callStatic') && !$is_mock ) { $method_id = $fq_class_name . '::' . strtolower($stmt->name); $cased_method_id = $fq_class_name . '::' . $stmt->name; $does_method_exist = MethodChecker::checkMethodExists( $cased_method_id, new CodeLocation($statements_checker->getSource(), $stmt), $statements_checker->getSuppressedIssues() ); if (!$does_method_exist) { return $does_method_exist; } if (MethodChecker::checkMethodVisibility( $method_id, $context->self, $statements_checker->getSource(), new CodeLocation($statements_checker->getSource(), $stmt), $statements_checker->getSuppressedIssues() ) === false) { return false; } if ($stmt->class instanceof PhpParser\Node\Name && $stmt->class->parts[0] !== 'parent' && (!$context->self || $statements_checker->isStatic() || !ClassChecker::classExtends($context->self, $fq_class_name) ) ) { if (MethodChecker::checkStatic( $method_id, $stmt->class instanceof PhpParser\Node\Name && $stmt->class->parts[0] === 'self', new CodeLocation($statements_checker->getSource(), $stmt), $statements_checker->getSuppressedIssues() ) === false) { // fall through } } if (MethodChecker::checkMethodNotDeprecated( $method_id, new CodeLocation($statements_checker->getSource(), $stmt), $statements_checker->getSuppressedIssues() ) === false) { // fall through } $return_types = MethodChecker::getMethodReturnType($method_id); if ($return_types) { $return_types = ExpressionChecker::fleshOutTypes( $return_types, $stmt->args, $stmt->class instanceof PhpParser\Node\Name && $stmt->class->parts === ['parent'] ? $statements_checker->getFQCLN() : $fq_class_name, $method_id ); if (isset($stmt->inferredType)) { $stmt->inferredType = Type::combineUnionTypes($stmt->inferredType, $return_types); } else { $stmt->inferredType = $return_types; } } } $method_params = $method_id ? FunctionLikeChecker::getMethodParamsById($method_id, $stmt->args, $file_checker) : null; if (self::checkFunctionArguments( $statements_checker, $stmt->args, $method_params, $context ) === false) { return false; } // get them again $method_params = $method_id ? FunctionLikeChecker::getMethodParamsById($method_id, $stmt->args, $file_checker) : null; if (self::checkFunctionArgumentsMatch( $statements_checker, $stmt->args, $method_id, $method_params, $context, new CodeLocation($statements_checker->getSource(), $stmt), $has_mock ) === false) { return false; } } return null; } /** * @param StatementsChecker $statements_checker * @param array $args * @param array|null $function_params * @param Context $context * @return false|null */ protected static function checkFunctionArguments( StatementsChecker $statements_checker, array $args, array $function_params = null, Context $context ) { $last_param = $function_params ? $function_params[count($function_params) - 1] : null; foreach ($args as $argument_offset => $arg) { if ($arg->value instanceof PhpParser\Node\Expr\PropertyFetch) { if ($function_params !== null) { $by_ref = $argument_offset < count($function_params) ? $function_params[$argument_offset]->by_ref : $last_param && $last_param->is_variadic && $last_param->by_ref; $by_ref_type = null; if ($by_ref && $last_param) { $by_ref_type = $argument_offset < count($function_params) ? clone $function_params[$argument_offset]->type : clone $last_param->type; } if ($by_ref && $by_ref_type) { ExpressionChecker::assignByRefParam($statements_checker, $arg->value, $by_ref_type, $context); } else { if (FetchChecker::analyzePropertyFetch($statements_checker, $arg->value, $context) === false) { return false; } } } else { $var_id = ExpressionChecker::getVarId( $arg->value, $statements_checker->getFQCLN(), $statements_checker ); if ($var_id && (!isset($context->vars_in_scope[$var_id]) || $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; $statements_checker->registerVariable('$' . $var_id, $arg->value->getLine()); } } } elseif ($arg->value instanceof PhpParser\Node\Expr\Variable) { if ($function_params !== null) { $by_ref = $argument_offset < count($function_params) ? $function_params[$argument_offset]->by_ref : $last_param && $last_param->is_variadic && $last_param->by_ref; $by_ref_type = null; if ($by_ref && $last_param) { $by_ref_type = $argument_offset < count($function_params) ? clone $function_params[$argument_offset]->type : clone $last_param->type; } if (ExpressionChecker::analyzeVariable( $statements_checker, $arg->value, $context, $by_ref, $by_ref_type ) === false) { return false; } } elseif (is_string($arg->value->name)) { if (false || !isset($context->vars_in_scope['$' . $arg->value->name]) || $context->vars_in_scope['$' . $arg->value->name]->isNull() ) { // we don't know if it exists, assume it's passed by reference $context->vars_in_scope['$' . $arg->value->name] = Type::getMixed(); $context->vars_possibly_in_scope['$' . $arg->value->name] = true; $statements_checker->registerVariable('$' . $arg->value->name, $arg->value->getLine()); } } } else { if (ExpressionChecker::analyze($statements_checker, $arg->value, $context) === false) { return false; } } } return null; } /** * @param StatementsChecker $statements_checker * @param array $args * @param string|null $method_id * @param array|null $function_params * @param Context $context * @param CodeLocation $code_location * @param boolean $is_mock * @return false|null */ protected static function checkFunctionArgumentsMatch( StatementsChecker $statements_checker, array $args, $method_id, array $function_params = null, Context $context, CodeLocation $code_location, $is_mock = false ) { $in_call_map = $method_id ? FunctionChecker::inCallMap($method_id) : false; $cased_method_id = $method_id; $is_variadic = false; $fq_class_name = null; if ($method_id) { if ($in_call_map || !strpos($method_id, '::')) { $is_variadic = FunctionChecker::isVariadic(strtolower($method_id), $statements_checker->getFilePath()); } else { $fq_class_name = explode('::', $method_id)[0]; $is_variadic = $is_mock || MethodChecker::isVariadic($method_id); } } if ($method_id && strpos($method_id, '::') && !$in_call_map) { $cased_method_id = MethodChecker::getCasedMethodId($method_id); } if ($function_params) { foreach ($function_params as $function_param) { $is_variadic = $is_variadic || $function_param->is_variadic; } } $has_packed_var = false; foreach ($args as $arg) { $has_packed_var = $has_packed_var || $arg->unpack; } $last_param = $function_params ? $function_params[count($function_params) - 1] : null; foreach ($args as $argument_offset => $arg) { if ($function_params !== null && isset($arg->value->inferredType)) { $function_param = count($function_params) > $argument_offset ? $function_params[$argument_offset] : ($last_param && $last_param->is_variadic ? $last_param : null); if ($function_param) { $param_type = $function_param->type; if ($function_param->is_variadic) { if (!$param_type->hasArray() || !$param_type->types['array'] instanceof TArray) { break; } $param_type = clone $param_type->types['array']->type_params[1]; } // for now stop when we encounter a packed argument if ($arg->unpack) { break; } if (self::checkFunctionArgumentType( $statements_checker, $arg->value->inferredType, ExpressionChecker::fleshOutTypes( clone $param_type, [], $fq_class_name, $method_id ), $cased_method_id, $argument_offset, new CodeLocation($statements_checker->getSource(), $arg->value) ) === false) { return false; } } } } if ($function_params !== null && ($method_id === 'array_map' || $method_id === 'array_filter')) { if (self::checkArrayFunctionArgumentsMatch( $statements_checker, $args, $method_id, $function_params, $context, $code_location ) === false ) { return false; } } if ($function_params !== null) { if (!$is_variadic && count($args) > count($function_params) && (!count($function_params) || $function_params[count($function_params) - 1]->name !== '...=') ) { if (IssueBuffer::accepts( new TooManyArguments( 'Too many arguments for method ' . ($cased_method_id ?: $method_id), $code_location ), $statements_checker->getSuppressedIssues() )) { // fall through } return null; } if (!$has_packed_var && count($args) < count($function_params)) { for ($i = count($args); $i < count($function_params); $i++) { $param = $function_params[$i]; if (!$param->is_optional && !$param->is_variadic) { if (IssueBuffer::accepts( new TooFewArguments( 'Too few arguments for method ' . $cased_method_id, $code_location ), $statements_checker->getSuppressedIssues() )) { return false; } break; } } } } } /** * @param StatementsChecker $statements_checker * @param array $args * @param string|null $method_id * @param array $function_params * @param Context $context * @param CodeLocation $code_location * @return false|null */ protected static function checkArrayFunctionArgumentsMatch( StatementsChecker $statements_checker, array $args, $method_id, array $function_params, Context $context, CodeLocation $code_location ) { $closure_index = $method_id === 'array_map' ? 0 : 1; $array_arg_types = []; foreach ($args as $i => $arg) { if ($i === 0 && $method_id === 'array_map') { continue; } if ($i === 1 && $method_id === 'array_filter') { break; } $array_arg = isset($args[$i]->value) ? $args[$i]->value : null; $array_arg_types[] = $array_arg && isset($array_arg->inferredType) && isset($array_arg->inferredType->types['array']) && $array_arg->inferredType->types['array'] instanceof Type\Atomic\TArray ? $array_arg->inferredType->types['array'] : null; } /** @var PhpParser\Node\Arg */ $closure_arg = isset($args[$closure_index]) ? $args[$closure_index] : null; /** @var Type\Union|null */ $closure_arg_type = $closure_arg && isset($closure_arg->value->inferredType) ? $closure_arg->value->inferredType : null; if ($closure_arg_type) { $expected_closure_param_count = $method_id === 'array_filter' ? 1 : count($array_arg_types); foreach ($closure_arg_type->types as $closure_type) { if (!$closure_type instanceof Type\Atomic\Fn) { continue; } if (count($closure_type->params) > $expected_closure_param_count) { if (IssueBuffer::accepts( new TooManyArguments( 'Too many arguments in closure for ' . $method_id, new CodeLocation($statements_checker->getSource(), $closure_arg) ), $statements_checker->getSuppressedIssues() )) { return false; } } elseif (count($closure_type->params) < $expected_closure_param_count) { if (IssueBuffer::accepts( new TooFewArguments( 'You must supply a param in the closure for ' . $method_id, new CodeLocation($statements_checker->getSource(), $closure_arg) ), $statements_checker->getSuppressedIssues() )) { return false; } } $closure_params = $closure_type->params; $closure_return_type = $closure_type->return_type; $i = 0; foreach ($closure_params as $param_name => $closure_param) { if (!$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->isMixed()) { $i++; continue; } $closure_param_type = $closure_param->type; $type_match_found = TypeChecker::isContainedBy( $input_type, $closure_param_type, $statements_checker->getFileChecker(), false, $scalar_type_match_found, $coerced_type ); if ($coerced_type) { if (IssueBuffer::accepts( new TypeCoercion( 'First parameter of closure passed to function ' . $method_id . ' expects ' . $closure_param_type . ', parent type ' . $input_type . ' provided', new CodeLocation($statements_checker->getSource(), $closure_arg) ), $statements_checker->getSuppressedIssues() )) { return false; } } if (!$type_match_found) { if ($scalar_type_match_found) { if (IssueBuffer::accepts( new InvalidScalarArgument( 'First parameter of closure passed to function ' . $method_id . ' expects ' . $closure_param_type . ', ' . $input_type . ' provided', new CodeLocation($statements_checker->getSource(), $closure_arg) ), $statements_checker->getSuppressedIssues() )) { return false; } } elseif (IssueBuffer::accepts( new InvalidArgument( 'First parameter of closure passed to function ' . $method_id . ' expects ' . $closure_param_type . ', ' . $input_type . ' provided', new CodeLocation($statements_checker->getSource(), $closure_arg) ), $statements_checker->getSuppressedIssues() )) { return false; } } $i++; } } } } /** * @param StatementsChecker $statements_checker * @param Type\Union $input_type * @param Type\Union $param_type * @param string|null $cased_method_id * @param int $argument_offset * @param CodeLocation $code_location * @return null|false */ public static function checkFunctionArgumentType( StatementsChecker $statements_checker, Type\Union $input_type, Type\Union $param_type, $cased_method_id, $argument_offset, CodeLocation $code_location ) { if ($param_type->isMixed()) { return null; } $method_identifier = $cased_method_id ? ' of ' . $cased_method_id : ''; if ($input_type->isMixed()) { if (IssueBuffer::accepts( new MixedArgument( 'Argument ' . ($argument_offset + 1) . $method_identifier . ' cannot be mixed, expecting ' . $param_type, $code_location ), $statements_checker->getSuppressedIssues() )) { return false; } return null; } if ($input_type->isNullable() && !$param_type->isNullable() && $cased_method_id !== 'echo') { if (IssueBuffer::accepts( new NullArgument( 'Argument ' . ($argument_offset + 1) . $method_identifier . ' cannot be null, possibly ' . 'null value provided', $code_location ), $statements_checker->getSuppressedIssues() )) { return false; } } $type_match_found = TypeChecker::isContainedBy( $input_type, $param_type, $statements_checker->getFileChecker(), true, $scalar_type_match_found, $coerced_type, $to_string_cast ); if ($coerced_type) { if (IssueBuffer::accepts( new TypeCoercion( 'Argument ' . ($argument_offset + 1) . $method_identifier . ' expects ' . $param_type . ', parent type ' . $input_type . ' provided', $code_location ), $statements_checker->getSuppressedIssues() )) { return false; } } if ($to_string_cast && $cased_method_id !== 'echo') { if (IssueBuffer::accepts( new ImplicitToStringCast( 'Argument ' . ($argument_offset + 1) . $method_identifier . ' expects ' . $param_type . ', ' . $input_type . ' provided with a __toString method', $code_location ), $statements_checker->getSuppressedIssues() )) { // fall through } } if (!$type_match_found && !$coerced_type) { if ($scalar_type_match_found) { if ($cased_method_id !== 'echo') { if (IssueBuffer::accepts( new InvalidScalarArgument( 'Argument ' . ($argument_offset + 1) . $method_identifier . ' expects ' . $param_type . ', ' . $input_type . ' provided', $code_location ), $statements_checker->getSuppressedIssues() )) { return false; } } } elseif (IssueBuffer::accepts( new InvalidArgument( 'Argument ' . ($argument_offset + 1) . $method_identifier . ' expects ' . $param_type . ', ' . $input_type . ' provided', $code_location ), $statements_checker->getSuppressedIssues() )) { return false; } } return null; } /** * @param StatementsChecker $statements_checker * @param string $function_id * @param Context $context * @param CodeLocation $code_location * @return bool */ protected static function checkFunctionExists( StatementsChecker $statements_checker, &$function_id, Context $context, CodeLocation $code_location ) { $cased_function_id = $function_id; $function_id = strtolower($function_id); if (!FunctionChecker::functionExists($function_id, $statements_checker->getFilePath())) { $root_function_id = preg_replace('/.*\\\/', '', $function_id); if ($function_id !== $root_function_id && FunctionChecker::functionExists($root_function_id, $statements_checker->getFilePath()) ) { $function_id = $root_function_id; } else { if (IssueBuffer::accepts( new UndefinedFunction( 'Function ' . $cased_function_id . ' does not exist', $code_location ), $statements_checker->getSuppressedIssues() )) { // fall through } return false; } } return true; } }