etsy/phan

<?php

declare(strict_types=1);

use ast\Node;
use Phan\AST\ASTReverter;
use Phan\AST\UnionTypeVisitor;
use Phan\Language\Type\IntType;
use Phan\Language\Type\StringType;
use Phan\Parse\ParseVisitor;
use Phan\PluginV3;
use Phan\PluginV3\PluginAwarePostAnalysisVisitor;
use Phan\PluginV3\PostAnalyzeNodeCapability;

/**
 * This plugin warns about using `==`/`!=` for string literals.
 * For the vast majority of projects, this will have too many false positives to use.
 * Only use this if you are sure there are no weak type comparisons.
 * (e.g. strings from inputs/dbs used as numbers, floats compared to integers)
 *
 * Also see StrictComparisonPlugin for warning about comparing objects.
 */
class StrictLiteralComparisonPlugin extends PluginV3 implements
    PostAnalyzeNodeCapability
{
    /**
     * @return string - The name of the visitor that will be called (formerly analyzeNode)
     * @override
     */
    public static function getPostAnalyzeNodeVisitorClassName(): string
    {
        return StrictLiteralComparisonVisitor::class;
    }
}

/**
 * Warns about using weak comparison operators when both sides are possibly objects
 */
class StrictLiteralComparisonVisitor extends PluginAwarePostAnalysisVisitor
{
    /**
     * @param Node $node
     * A node of kind ast\AST_BINARY_OP to analyze
     *
     * @override
     */
    public function visitBinaryOp(Node $node): void
    {
        if ($node->flags === ast\flags\BINARY_IS_NOT_EQUAL || $node->flags === ast\flags\BINARY_IS_EQUAL) {
            $this->analyzeEqualityCheck($node);
        }
    }

    /**
     * @param Node $node
     * A node of kind ast\AST_BINARY_OP for `==`/`!=` to analyze
     */
    private function analyzeEqualityCheck(Node $node): void
    {
        ['left' => $left, 'right' => $right] = $node->children;
        $left_is_const = ParseVisitor::isConstExpr($left);
        $right_is_const = ParseVisitor::isConstExpr($right);
        if ($left_is_const === $right_is_const) {
            return;
        }
        $const_type = UnionTypeVisitor::unionTypeFromNode($this->code_base, $this->context, $left_is_const ? $left : $right);
        if ($const_type->isEmpty()) {
            return;
        }
        foreach ($const_type->getTypeSet() as $type) {
            if (!($type instanceof IntType || $type instanceof StringType)) {
                return;
            }
        }
        self::emitPluginIssue(
            $this->code_base,
            $this->context,
            'PhanPluginComparisonNotStrictForScalar',
            "Expected strict equality check when comparing {TYPE} to {TYPE} in {CODE}",
            [
                UnionTypeVisitor::unionTypeFromNode($this->code_base, $this->context, $left),
                UnionTypeVisitor::unionTypeFromNode($this->code_base, $this->context, $right),
                ASTReverter::toShortString($node),
            ]
        );
    }
}

// Every plugin needs to return an instance of itself at the
// end of the file in which it's defined.
return new StrictLiteralComparisonPlugin();