etsy/phan

<?php

declare(strict_types=1);

use ast\Node;
use Phan\Config;
use Phan\Language\Context;
use Phan\Language\Element\Variable;
use Phan\PluginV3;
use Phan\PluginV3\PluginAwarePostAnalysisVisitor;
use Phan\PluginV3\PostAnalyzeNodeCapability;

/**
 * This plugin detects undeclared variables within isset() checks.
 */
class InvalidVariableIssetPlugin extends PluginV3 implements PostAnalyzeNodeCapability
{

    /**
     * @return string - name of PluginAwarePostAnalysisVisitor subclass
     *
     * @override
     */
    public static function getPostAnalyzeNodeVisitorClassName(): string
    {
        return InvalidVariableIssetVisitor::class;
    }
}

/**
 * This plugin checks isset nodes (\ast\AST_ISSET) to see if they contain undeclared variables
 */
class InvalidVariableIssetVisitor extends PluginAwarePostAnalysisVisitor
{

    /** define classes to parse */
    private const CLASSES = [
        ast\AST_STATIC_CALL,
        ast\AST_STATIC_PROP,
    ];

    /** define expression to parse */
    private const EXPRESSIONS = [
        ast\AST_CALL,
        ast\AST_DIM,
        ast\AST_INSTANCEOF,
        ast\AST_METHOD_CALL,
        ast\AST_PROP,
    ];

    // A plugin's visitors should not override visit() unless they need to.

    /** @override */
    public function visitIsset(Node $node): Context
    {
        $argument = $node->children['var'];
        $variable = $argument;

        // get variable name from argument
        while (!isset($variable->children['name'])) {
            if (!$variable instanceof Node) {
                // e.g. 'foo' in `isset('foo'[$i])` or `isset('foo'->bar)`.
                $this->emit(
                    'PhanPluginInvalidVariableIsset',
                    "Unexpected expression in isset()",
                    []
                );
                return $this->context;
            }
            if (in_array($variable->kind, self::EXPRESSIONS, true)) {
                $variable = $variable->children['expr'];
            } elseif (in_array($variable->kind, self::CLASSES, true)) {
                $variable = $variable->children['class'];
            } else {
                return $this->context;
            }
        }
        if (!$variable instanceof Node) {
            $this->emit(
                'PhanPluginUnexpectedExpressionIsset',
                "Unexpected expression in isset()",
                []
            );
            return $this->context;
        }
        $name = $variable->children['name'] ?? null;

        // emit issue if name is not declared
        // Check for edge cases such as isset($$var)
        if (is_string($name)) {
            if ($variable->kind !== ast\AST_VAR) {
                // e.g. ast\AST_NAME of an ast\AST_CONST
                return $this->context;
            }
            if (!Variable::isHardcodedVariableInScopeWithName($name, $this->context->isInGlobalScope())
                && !$this->context->getScope()->hasVariableWithName($name)
                && !(
                    $this->context->isInGlobalScope() && Config::getValue('ignore_undeclared_variables_in_global_scope')
                )
            ) {
                $this->emit(
                    'PhanPluginUndeclaredVariableIsset',
                    'undeclared variable ${VARIABLE} in isset()',
                    [$name]
                );
            }
        } elseif ($variable->kind !== ast\AST_VAR) {
            // emit issue if argument is not array access
            $this->emit(
                'PhanPluginInvalidVariableIsset',
                "non array/property access in isset()",
                []
            );
            return $this->context;
        } elseif (!is_string($name)) {
            // emit issue if argument is not array access
            $this->emit(
                'PhanPluginComplexVariableInIsset',
                "Unanalyzable complex variable expression in isset",
                []
            );
        }
        return $this->context;
    }
}

return new InvalidVariableIssetPlugin();