1
0
mirror of https://github.com/danog/psalm.git synced 2024-12-15 10:57:08 +01:00
psalm/src/Psalm/Context.php
2021-09-26 23:34:32 +02:00

851 lines
22 KiB
PHP

<?php
namespace Psalm;
use Psalm\Internal\Analyzer\StatementsAnalyzer;
use Psalm\Internal\Clause;
use Psalm\Internal\Type\AssertionReconciler;
use Psalm\Storage\FunctionLikeStorage;
use Psalm\Type\Union;
use function array_keys;
use function array_search;
use function count;
use function in_array;
use function is_int;
use function json_encode;
use function preg_match;
use function preg_quote;
use function preg_replace;
use function strpos;
use function strtolower;
class Context
{
/**
* @var array<string, Type\Union>
*/
public $vars_in_scope = [];
/**
* @var array<string, bool>
*/
public $vars_possibly_in_scope = [];
/**
* Whether or not we're inside the conditional of an if/where etc.
*
* This changes whether or not the context is cloned
*
* @var bool
*/
public $inside_conditional = false;
/**
* Whether or not we're inside an isset call
*
* Inside issets Psalm is more lenient about certain things
*
* @var bool
*/
public $inside_isset = false;
/**
* Whether or not we're inside an unset call, where
* we don't care about possibly undefined variables
*
* @var bool
*/
public $inside_unset = false;
/**
* Whether or not we're inside an class_exists call, where
* we don't care about possibly undefined classes
*
* @var bool
*/
public $inside_class_exists = false;
/**
* Whether or not we're inside a function/method call
*
* @var bool
*/
public $inside_call = false;
/**
* Whether or not we're inside any other situation that treats a variable as used
*
* @var bool
*/
public $inside_general_use = false;
/**
* Whether or not we're inside a return expression
*
* @var bool
*/
public $inside_return = false;
/**
* Whether or not we're inside a throw
*
* @var bool
*/
public $inside_throw = false;
/**
* Whether or not we're inside an assignment
*
* @var bool
*/
public $inside_assignment = false;
/**
* @var null|CodeLocation
*/
public $include_location;
/**
* @var string|null
*/
public $self;
/**
* @var string|null
*/
public $parent;
/**
* @var bool
*/
public $check_classes = true;
/**
* @var bool
*/
public $check_variables = true;
/**
* @var bool
*/
public $check_methods = true;
/**
* @var bool
*/
public $check_consts = true;
/**
* @var bool
*/
public $check_functions = true;
/**
* A list of classes checked with class_exists
*
* @var array<lowercase-string,true>
*/
public $phantom_classes = [];
/**
* A list of files checked with file_exists
*
* @var array<string,bool>
*/
public $phantom_files = [];
/**
* A list of clauses in Conjunctive Normal Form
*
* @var list<Clause>
*/
public $clauses = [];
/**
* A list of hashed clauses that have already been factored in
*
* @var list<string|int>
*/
public $reconciled_expression_clauses = [];
/**
* Whether or not to do a deep analysis and collect mutations to this context
*
* @var bool
*/
public $collect_mutations = false;
/**
* Whether or not to do a deep analysis and collect initializations from private or final methods
*
* @var bool
*/
public $collect_initializations = false;
/**
* Whether or not to do a deep analysis and collect initializations from public non-final methods
*
* @var bool
*/
public $collect_nonprivate_initializations = false;
/**
* Stored to prevent re-analysing methods when checking for initialised properties
*
* @var array<string, bool>|null
*/
public $initialized_methods;
/**
* @var array<string, Type\Union>
*/
public $constants = [];
/**
* Whether or not to track exceptions
*
* @var bool
*/
public $collect_exceptions = false;
/**
* A list of variables that have been referenced
*
* @var array<string, bool>
*/
public $referenced_var_ids = [];
/**
* A list of variables that have been passed by reference (where we know their type)
*
* @var array<string, \Psalm\Internal\ReferenceConstraint>
*/
public $byref_constraints = [];
/**
* If this context inherits from a context, it is here
*
* @var Context|null
*/
public $parent_context;
/**
* @var array<string, Type\Union>
*/
public $possible_param_types = [];
/**
* A list of vars that have been assigned to
*
* @var array<string, int>
*/
public $assigned_var_ids = [];
/**
* A list of vars that have been may have been assigned to
*
* @var array<string, bool>
*/
public $possibly_assigned_var_ids = [];
/**
* A list of classes or interfaces that may have been thrown
*
* @var array<string, array<array-key, CodeLocation>>
*/
public $possibly_thrown_exceptions = [];
/**
* @var bool
*/
public $is_global = false;
/**
* @var array<string, bool>
*/
public $protected_var_ids = [];
/**
* If we've branched from the main scope, a byte offset for where that branch happened
*
* @var int|null
*/
public $branch_point;
/**
* What does break mean in this context?
*
* 'loop' means we're breaking out of a loop,
* 'switch' means we're breaking out of a switch
*
* @var list<'loop'|'switch'>
*/
public $break_types = [];
/**
* @var bool
*/
public $inside_loop = false;
/**
* @var Internal\Scope\LoopScope|null
*/
public $loop_scope;
/**
* @var Internal\Scope\CaseScope|null
*/
public $case_scope;
/**
* @var Internal\Scope\FinallyScope|null
*/
public $finally_scope;
/**
* @var Context|null
*/
public $if_context;
/**
* @var \Psalm\Internal\Scope\IfScope|null
*/
public $if_scope;
/**
* @var bool
*/
public $strict_types = false;
/**
* @var string|null
*/
public $calling_function_id;
/**
* @var lowercase-string|null
*/
public $calling_method_id;
/**
* @var bool
*/
public $inside_negation = false;
/**
* @var bool
*/
public $ignore_variable_property = false;
/**
* @var bool
*/
public $ignore_variable_method = false;
/**
* @var bool
*/
public $pure = false;
/**
* @var bool
*/
public $mutation_free = false;
/**
* @var bool
*/
public $external_mutation_free = false;
/**
* @var bool
*/
public $error_suppressing = false;
/**
* @var bool
*/
public $has_returned = false;
/**
* @var array<string, bool>
*/
public $vars_from_global = [];
public function __construct(?string $self = null)
{
$this->self = $self;
}
public function __destruct()
{
$this->case_scope = null;
$this->parent_context = null;
}
public function __clone()
{
foreach ($this->clauses as &$clause) {
$clause = clone $clause;
}
foreach ($this->constants as &$constant) {
$constant = clone $constant;
}
}
/**
* Updates the parent context, looking at the changes within a block and then applying those changes, where
* necessary, to the parent context
*
* @param bool $has_leaving_statements whether or not the parent scope is abandoned between
* $start_context and $end_context
* @param array<string, bool> $updated_vars
*
*/
public function update(
Context $start_context,
Context $end_context,
bool $has_leaving_statements,
array $vars_to_update,
array &$updated_vars
): void {
foreach ($start_context->vars_in_scope as $var_id => $old_type) {
// this is only true if there was some sort of type negation
if (in_array($var_id, $vars_to_update, true)) {
// if we're leaving, we're effectively deleting the possibility of the if types
$new_type = !$has_leaving_statements && $end_context->hasVariable($var_id)
? $end_context->vars_in_scope[$var_id]
: null;
$existing_type = $this->vars_in_scope[$var_id] ?? null;
if (!$existing_type) {
if ($new_type) {
$this->vars_in_scope[$var_id] = clone $new_type;
$updated_vars[$var_id] = true;
}
continue;
}
$existing_type = clone $existing_type;
// if the type changed within the block of statements, process the replacement
// also never allow ourselves to remove all types from a union
if ((!$new_type || !$old_type->equals($new_type))
&& ($new_type || count($existing_type->getAtomicTypes()) > 1)
) {
$existing_type->substitute($old_type, $new_type);
if ($new_type && $new_type->from_docblock) {
$existing_type->setFromDocblock();
}
$updated_vars[$var_id] = true;
}
$this->vars_in_scope[$var_id] = $existing_type;
}
}
}
/**
* @param array<string, Type\Union> $new_vars_in_scope
*
* @return array<string,Type\Union>
*/
public function getRedefinedVars(array $new_vars_in_scope, bool $include_new_vars = false): array
{
$redefined_vars = [];
foreach ($this->vars_in_scope as $var_id => $this_type) {
if (!isset($new_vars_in_scope[$var_id])) {
if ($include_new_vars) {
$redefined_vars[$var_id] = $this_type;
}
continue;
}
$new_type = $new_vars_in_scope[$var_id];
if (!$this_type->equals($new_type)) {
$redefined_vars[$var_id] = $this_type;
}
}
return $redefined_vars;
}
/**
* @return list<string>
*/
public static function getNewOrUpdatedVarIds(Context $original_context, Context $new_context): array
{
$redefined_var_ids = [];
foreach ($new_context->vars_in_scope as $var_id => $context_type) {
if (!isset($original_context->vars_in_scope[$var_id])
|| ($original_context->assigned_var_ids[$var_id] ?? 0)
!== ($new_context->assigned_var_ids[$var_id] ?? 0)
|| !$original_context->vars_in_scope[$var_id]->equals($context_type)
) {
$redefined_var_ids[] = $var_id;
}
}
return $redefined_var_ids;
}
public function remove(string $remove_var_id): void
{
unset(
$this->referenced_var_ids[$remove_var_id],
$this->vars_possibly_in_scope[$remove_var_id]
);
if (isset($this->vars_in_scope[$remove_var_id])) {
$existing_type = $this->vars_in_scope[$remove_var_id];
unset($this->vars_in_scope[$remove_var_id]);
$this->removeDescendents($remove_var_id, $existing_type);
}
}
/**
* @param Clause[] $clauses
* @param array<string, bool> $changed_var_ids
*
* @return array{list<Clause>, list<Clause>}
*
* @psalm-pure
*/
public static function removeReconciledClauses(array $clauses, array $changed_var_ids): array
{
$included_clauses = [];
$rejected_clauses = [];
foreach ($clauses as $c) {
if ($c->wedge) {
$included_clauses[] = $c;
continue;
}
foreach ($c->possibilities as $key => $_) {
if (isset($changed_var_ids[$key])) {
$rejected_clauses[] = $c;
continue 2;
}
}
$included_clauses[] = $c;
}
return [$included_clauses, $rejected_clauses];
}
/**
* @param Clause[] $clauses
*
* @return list<Clause>
*/
public static function filterClauses(
string $remove_var_id,
array $clauses,
?Union $new_type = null,
?StatementsAnalyzer $statements_analyzer = null
): array {
$new_type_string = $new_type ? $new_type->getId() : '';
$clauses_to_keep = [];
foreach ($clauses as $clause) {
$clause = $clause->calculateNegation();
$quoted_remove_var_id = preg_quote($remove_var_id, '/');
foreach ($clause->possibilities as $var_id => $_) {
if (preg_match('/' . $quoted_remove_var_id . '[\]\[\-]/', $var_id)) {
break 2;
}
}
if (!isset($clause->possibilities[$remove_var_id]) ||
$clause->possibilities[$remove_var_id] === [$new_type_string]
) {
$clauses_to_keep[] = $clause;
} elseif ($statements_analyzer &&
$new_type &&
!$new_type->hasMixed()
) {
$type_changed = false;
// if the clause contains any possibilities that would be altered
// by the new type
foreach ($clause->possibilities[$remove_var_id] as $type) {
// if we're negating a type, we generally don't need the clause anymore
if ($type[0] === '!' && $type !== '!falsy' && $type !== '!empty') {
$type_changed = true;
break;
}
// empty and !empty are not definitive for arrays and scalar types
if (($type === '!falsy' || $type === 'falsy') &&
($new_type->hasArray() || $new_type->hasPossiblyNumericType())
) {
$type_changed = true;
break;
}
$result_type = AssertionReconciler::reconcile(
$type,
clone $new_type,
null,
$statements_analyzer,
false,
[],
null,
[],
$failed_reconciliation
);
if ($result_type->getId() !== $new_type_string) {
$type_changed = true;
break;
}
}
if (!$type_changed) {
$clauses_to_keep[] = $clause;
}
}
}
return $clauses_to_keep;
}
public function removeVarFromConflictingClauses(
string $remove_var_id,
?Union $new_type = null,
?StatementsAnalyzer $statements_analyzer = null
): void {
$this->clauses = self::filterClauses($remove_var_id, $this->clauses, $new_type, $statements_analyzer);
if ($this->parent_context) {
$this->parent_context->removeVarFromConflictingClauses($remove_var_id);
}
}
/**
* This method is used after assignments to variables to remove any existing
* items in $vars_in_scope that are now made redundant by an update to some data
*/
public function removeDescendents(
string $remove_var_id,
?Union $existing_type = null,
?Union $new_type = null,
?StatementsAnalyzer $statements_analyzer = null
): void {
if (!$existing_type && isset($this->vars_in_scope[$remove_var_id])) {
$existing_type = $this->vars_in_scope[$remove_var_id];
}
if (!$existing_type) {
return;
}
$existing_type->allow_mutations = true;
$this->removeVarFromConflictingClauses(
$remove_var_id,
$existing_type->hasMixed()
|| ($new_type && $existing_type->from_docblock !== $new_type->from_docblock)
? null
: $new_type,
$statements_analyzer
);
foreach ($this->vars_in_scope as $var_id => $type) {
if (preg_match('/' . preg_quote($remove_var_id, '/') . '[\]\[\-]/', $var_id)) {
unset($this->vars_in_scope[$var_id]);
}
foreach ($type->getAtomicTypes() as $atomic_type) {
if ($atomic_type instanceof Type\Atomic\DependentType
&& $atomic_type->getVarId() === $remove_var_id
) {
$type->addType($atomic_type->getReplacement());
}
}
}
}
public function removeMutableObjectVars(bool $methods_only = false): void
{
$vars_to_remove = [];
foreach ($this->vars_in_scope as $var_id => $type) {
if ($type->has_mutations
&& (strpos($var_id, '->') !== false || strpos($var_id, '::') !== false)
&& (!$methods_only || strpos($var_id, '()'))
) {
$vars_to_remove[] = $var_id;
}
}
if (!$vars_to_remove) {
return;
}
foreach ($vars_to_remove as $var_id) {
unset($this->vars_in_scope[$var_id], $this->vars_possibly_in_scope[$var_id]);
}
$clauses_to_keep = [];
foreach ($this->clauses as $clause) {
$abandon_clause = false;
foreach (array_keys($clause->possibilities) as $key) {
if ((strpos($key, '->') !== false || strpos($key, '::') !== false)
&& (!$methods_only || strpos($key, '()'))
) {
$abandon_clause = true;
break;
}
}
if (!$abandon_clause) {
$clauses_to_keep[] = $clause;
}
}
$this->clauses = $clauses_to_keep;
if ($this->parent_context) {
$this->parent_context->removeMutableObjectVars($methods_only);
}
}
public function updateChecks(Context $op_context): void
{
$this->check_classes = $this->check_classes && $op_context->check_classes;
$this->check_variables = $this->check_variables && $op_context->check_variables;
$this->check_methods = $this->check_methods && $op_context->check_methods;
$this->check_functions = $this->check_functions && $op_context->check_functions;
$this->check_consts = $this->check_consts && $op_context->check_consts;
}
public function isPhantomClass(string $class_name): bool
{
return isset($this->phantom_classes[strtolower($class_name)]);
}
public function hasVariable(string $var_name): bool
{
if (!$var_name) {
return false;
}
$stripped_var = preg_replace('/(->|\[).*$/', '', $var_name);
if ($stripped_var !== '$this' || $var_name !== $stripped_var) {
$this->referenced_var_ids[$var_name] = true;
if (!isset($this->vars_possibly_in_scope[$var_name])
&& !isset($this->vars_in_scope[$var_name])
) {
return false;
}
}
return isset($this->vars_in_scope[$var_name]);
}
public function getScopeSummary() : string
{
$summary = [];
foreach ($this->vars_possibly_in_scope as $k => $_) {
$summary[$k] = true;
}
foreach ($this->vars_in_scope as $k => $v) {
$summary[$k] = $v->getId();
}
return json_encode($summary);
}
public function defineGlobals(): void
{
$globals = [
'$argv' => new Type\Union([
new Type\Atomic\TArray([Type::getInt(), Type::getString()]),
]),
'$argc' => Type::getInt(),
];
$config = Config::getInstance();
foreach ($config->globals as $global_id => $type_string) {
$globals[$global_id] = Type::parseString($type_string);
}
foreach ($globals as $global_id => $type) {
$this->vars_in_scope[$global_id] = $type;
$this->vars_possibly_in_scope[$global_id] = true;
}
}
public function mergeExceptions(Context $other_context): void
{
foreach ($other_context->possibly_thrown_exceptions as $possibly_thrown_exception => $codelocations) {
foreach ($codelocations as $hash => $codelocation) {
$this->possibly_thrown_exceptions[$possibly_thrown_exception][$hash] = $codelocation;
}
}
}
public function isSuppressingExceptions(StatementsAnalyzer $statements_analyzer): bool
{
if (!$this->collect_exceptions) {
return true;
}
$issue_type = $this->is_global ? 'UncaughtThrowInGlobalScope' : 'MissingThrowsDocblock';
$suppressed_issues = $statements_analyzer->getSuppressedIssues();
$suppressed_issue_position = array_search($issue_type, $suppressed_issues, true);
if ($suppressed_issue_position !== false) {
if (is_int($suppressed_issue_position)) {
$file = $statements_analyzer->getFileAnalyzer()->getFilePath();
IssueBuffer::addUsedSuppressions([
$file => [$suppressed_issue_position => true],
]);
}
return true;
}
return false;
}
public function mergeFunctionExceptions(
FunctionLikeStorage $function_storage,
CodeLocation $codelocation
): void {
$hash = $codelocation->getHash();
foreach ($function_storage->throws as $possibly_thrown_exception => $_) {
$this->possibly_thrown_exceptions[$possibly_thrown_exception][$hash] = $codelocation;
}
}
public function insideUse(): bool
{
return $this->inside_assignment
|| $this->inside_return
|| $this->inside_call
|| $this->inside_general_use
|| $this->inside_conditional
|| $this->inside_throw
|| $this->inside_isset;
}
}