getCodebase(); $file_storage_provider = $codebase->file_storage_provider; $file_storage = $file_storage_provider->get($source->getFilePath()); $namespace = $source->getNamespace(); $function_id = ($namespace ? strtolower($namespace) . '\\' : '') . strtolower($function->name->name); if (!isset($file_storage->functions[$function_id])) { throw new \UnexpectedValueException( 'Function ' . $function_id . ' should be defined in ' . $source->getFilePath() ); } $storage = $file_storage->functions[$function_id]; parent::__construct($function, $source, $storage); } /** * @param string $function_id * @param array $call_args * * @return Type\Union */ public static function getReturnTypeFromCallMapWithArgs( StatementsAnalyzer $statements_analyzer, $function_id, array $call_args, Context $context ) { $call_map_key = strtolower($function_id); $call_map = CallMap::getCallMap(); $codebase = $statements_analyzer->getCodebase(); if (!isset($call_map[$call_map_key])) { throw new \InvalidArgumentException('Function ' . $function_id . ' was not found in callmap'); } if (!$call_args) { switch ($call_map_key) { case 'getenv': return new Type\Union([new Type\Atomic\TArray([Type::getArrayKey(), Type::getString()])]); case 'gettimeofday': return new Type\Union([ new Type\Atomic\TArray([ Type::getString(), Type::getInt() ]) ]); case 'microtime': return Type::getString(); case 'hrtime': return new Type\Union([ new Type\Atomic\ObjectLike([ Type::getInt(), Type::getInt() ]) ]); case 'get_called_class': return new Type\Union([new Type\Atomic\TClassString($context->self ?: 'object')]); case 'get_parent_class': if ($context->self && $codebase->classExists($context->self)) { $classlike_storage = $codebase->classlike_storage_provider->get($context->self); if ($classlike_storage->parent_classes) { return new Type\Union([ new Type\Atomic\TClassString( array_values($classlike_storage->parent_classes)[0] ) ]); } } } } else { switch ($call_map_key) { case 'pathinfo': if (isset($call_args[1])) { return Type::getString(); } return Type::getArray(); case 'count': if (($first_arg_type = $statements_analyzer->node_data->getType($call_args[0]->value))) { $atomic_types = $first_arg_type->getAtomicTypes(); if (count($atomic_types) === 1) { if (isset($atomic_types['array'])) { if ($atomic_types['array'] instanceof Type\Atomic\TCallableArray || $atomic_types['array'] instanceof Type\Atomic\TCallableList || $atomic_types['array'] instanceof Type\Atomic\TCallableObjectLikeArray ) { return Type::getInt(false, 2); } if ($atomic_types['array'] instanceof Type\Atomic\TNonEmptyArray) { return new Type\Union([ $atomic_types['array']->count !== null ? new Type\Atomic\TLiteralInt($atomic_types['array']->count) : new Type\Atomic\TInt ]); } if ($atomic_types['array'] instanceof Type\Atomic\TNonEmptyList) { return new Type\Union([ $atomic_types['array']->count !== null ? new Type\Atomic\TLiteralInt($atomic_types['array']->count) : new Type\Atomic\TInt ]); } if ($atomic_types['array'] instanceof Type\Atomic\ObjectLike && $atomic_types['array']->sealed ) { return new Type\Union([ new Type\Atomic\TLiteralInt(count($atomic_types['array']->properties)) ]); } } } } break; case 'var_export': case 'highlight_string': case 'highlight_file': if (isset($call_args[1]) && ($second_arg_type = $statements_analyzer->node_data->getType($call_args[1]->value)) ) { if ((string) $second_arg_type === 'true') { return Type::getString(); } return new Type\Union([ new Type\Atomic\TString, $call_map_key === 'var_export' ? new Type\Atomic\TNull : new Type\Atomic\TBool ]); } return $call_map_key === 'var_export' ? Type::getVoid() : Type::getBool(); case 'print_r': if (isset($call_args[1]) && ($second_arg_type = $statements_analyzer->node_data->getType($call_args[1]->value)) ) { if ((string) $second_arg_type === 'true') { return Type::getString(); } } return new Type\Union([ new Type\Atomic\TString, new Type\Atomic\TTrue ]); case 'microtime': if (($first_arg_type = $statements_analyzer->node_data->getType($call_args[0]->value))) { if ((string) $first_arg_type === 'true') { return Type::getFloat(); } if ((string) $first_arg_type === 'false') { return Type::getString(); } } return new Type\Union([ new Type\Atomic\TFloat, new Type\Atomic\TString ]); case 'hrtime': if (($first_arg_type = $statements_analyzer->node_data->getType($call_args[0]->value))) { if ((string) $first_arg_type === 'true') { $int = Type::getInt(); $int->from_calculation = true; return $int; } if ((string) $first_arg_type === 'false') { return new Type\Union([ new Type\Atomic\ObjectLike([ Type::getInt(), Type::getInt() ]) ]); } return new Type\Union([ new Type\Atomic\ObjectLike([ Type::getInt(), Type::getInt() ]), new Type\Atomic\TInt() ]); } $int = Type::getInt(); $int->from_calculation = true; return $int; case 'getenv': return new Type\Union([new Type\Atomic\TString, new Type\Atomic\TFalse]); case 'gettimeofday': if (($first_arg_type = $statements_analyzer->node_data->getType($call_args[0]->value))) { if ((string) $first_arg_type === 'true') { return Type::getFloat(); } if ((string) $first_arg_type === 'false') { return new Type\Union([ new Type\Atomic\TArray([ Type::getString(), Type::getInt() ]) ]); } } break; case 'abs': if (isset($call_args[0]->value)) { $first_arg = $call_args[0]->value; if ($first_arg_type = $statements_analyzer->node_data->getType($first_arg)) { $numeric_types = []; foreach ($first_arg_type->getAtomicTypes() as $inner_type) { if ($inner_type->isNumericType()) { $numeric_types[] = $inner_type; } } if ($numeric_types) { return new Type\Union($numeric_types); } } } break; case 'min': case 'max': if (isset($call_args[0])) { $first_arg = $call_args[0]->value; if ($first_arg_type = $statements_analyzer->node_data->getType($first_arg)) { if ($first_arg_type->hasArray()) { /** @psalm-suppress PossiblyUndefinedStringArrayOffset */ $array_type = $first_arg_type->getAtomicTypes()['array']; if ($array_type instanceof Type\Atomic\ObjectLike) { return $array_type->getGenericValueType(); } if ($array_type instanceof Type\Atomic\TArray) { return clone $array_type->type_params[1]; } if ($array_type instanceof Type\Atomic\TList) { return clone $array_type->type_param; } } elseif ($first_arg_type->hasScalarType() && isset($call_args[1]) && ($second_arg = $call_args[1]->value) && ($second_arg_type = $statements_analyzer->node_data->getType($second_arg)) && $second_arg_type->hasScalarType() ) { return Type::combineUnionTypes($first_arg_type, $second_arg_type); } } } break; case 'round': if (isset($call_args[1])) { $second_arg = $call_args[1]->value; if (($second_arg_type = $statements_analyzer->node_data->getType($second_arg)) && $second_arg_type->isSingleIntLiteral() ) { switch ($second_arg_type->getSingleIntLiteral()->value) { case 0: return Type::getInt(true); default: return Type::getFloat(); } } return new Type\Union([new Type\Atomic\TInt, new Type\Atomic\TFloat]); } return Type::getInt(true); case 'get_parent_class': // this is unreliable, as it's hard to know exactly what's wanted - attempted this in // https://github.com/vimeo/psalm/commit/355ed831e1c69c96bbf9bf2654ef64786cbe9fd7 // but caused problems where it didn’t know exactly what level of child we // were receiving. // // Really this should only work on instances we've created with new Foo(), // but that requires more work break; } } if (!$call_map[$call_map_key][0]) { return Type::getMixed(); } $call_map_return_type = Type::parseString($call_map[$call_map_key][0]); switch ($call_map_key) { case 'mb_strpos': case 'mb_strrpos': case 'mb_stripos': case 'mb_strripos': case 'strpos': case 'strrpos': case 'stripos': case 'strripos': case 'strstr': case 'stristr': case 'strrchr': case 'strpbrk': case 'array_search': break; default: if ($call_map_return_type->isFalsable() && $codebase->config->ignore_internal_falsable_issues ) { $call_map_return_type->ignore_falsable_issues = true; } } switch ($call_map_key) { case 'array_replace': case 'array_replace_recursive': if ($codebase->config->ignore_internal_nullable_issues) { $call_map_return_type->ignore_nullable_issues = true; } break; } return $call_map_return_type; } /** * @param array $call_args */ public static function taintBuiltinFunctionReturn( StatementsAnalyzer $statements_analyzer, string $function_id, array $call_args, Type\Union $return_type ) : void { $codebase = $statements_analyzer->getCodebase(); if (!$codebase->taint) { return; } switch ($function_id) { case 'htmlspecialchars': if (($first_arg_type = $statements_analyzer->node_data->getType($call_args[0]->value)) && $first_arg_type->tainted ) { // input is now safe from tainted sql and html $return_type->tainted = $first_arg_type->tainted & ~(Type\Union::TAINTED_INPUT_SQL | Type\Union::TAINTED_INPUT_HTML); $return_type->sources = $first_arg_type->sources; } break; case 'strtolower': case 'strtoupper': case 'sprintf': case 'preg_quote': case 'substr': if (($first_arg_type = $statements_analyzer->node_data->getType($call_args[0]->value)) && $first_arg_type->tainted ) { $return_type->tainted = $first_arg_type->tainted; $return_type->sources = $first_arg_type->sources; } break; case 'str_replace': case 'preg_replace': $first_arg_type = $statements_analyzer->node_data->getType($call_args[0]->value); $third_arg_type = $statements_analyzer->node_data->getType($call_args[2]->value); $first_arg_taint = $first_arg_type->tainted ?? 0; $third_arg_taint = $third_arg_type->tainted ?? 0; if ($first_arg_taint || $third_arg_taint) { $return_type->tainted = $first_arg_taint | $third_arg_taint; $return_type->sources = $first_arg_type->sources ?? []; } break; case 'htmlentities': case 'striptags': if (($first_arg_type = $statements_analyzer->node_data->getType($call_args[0]->value)) && $first_arg_type->tainted ) { // input is now safe from tainted html $return_type->tainted = $first_arg_type->tainted & ~Type\Union::TAINTED_INPUT_HTML; $return_type->sources = $first_arg_type->sources; } break; } } /** * @return string */ public function getFunctionId() { $namespace = $this->source->getNamespace(); return ($namespace ? strtolower($namespace) . '\\' : '') . strtolower($this->function->name->name); } }