Chris@0: <?php
Chris@0: 
Chris@0: /*
Chris@0:  * This file is part of Psy Shell.
Chris@0:  *
Chris@0:  * (c) 2012-2018 Justin Hileman
Chris@0:  *
Chris@0:  * For the full copyright and license information, please view the LICENSE
Chris@0:  * file that was distributed with this source code.
Chris@0:  */
Chris@0: 
Chris@0: namespace Psy\CodeCleaner;
Chris@0: 
Chris@0: use PhpParser\Node;
Chris@0: use PhpParser\Node\Expr;
Chris@0: use PhpParser\Node\Expr\ClassConstFetch;
Chris@0: use PhpParser\Node\Expr\ConstFetch;
Chris@0: use PhpParser\Node\Identifier;
Chris@0: use Psy\Exception\FatalErrorException;
Chris@0: 
Chris@0: /**
Chris@0:  * Validate that namespaced constant references will succeed.
Chris@0:  *
Chris@0:  * This pass throws a FatalErrorException rather than letting PHP run
Chris@0:  * headfirst into a real fatal error and die.
Chris@0:  *
Chris@0:  * @todo Detect constants defined in the current code snippet?
Chris@0:  *       ... Might not be worth it, since it would need to both be defining and
Chris@0:  *       referencing a namespaced constant, which doesn't seem like that big of
Chris@0:  *       a target for failure
Chris@0:  */
Chris@0: class ValidConstantPass extends NamespaceAwarePass
Chris@0: {
Chris@0:     /**
Chris@0:      * Validate that namespaced constant references will succeed.
Chris@0:      *
Chris@0:      * Note that this does not (yet) detect constants defined in the current code
Chris@0:      * snippet. It won't happen very often, so we'll punt for now.
Chris@0:      *
Chris@0:      * @throws FatalErrorException if a constant reference is not defined
Chris@0:      *
Chris@0:      * @param Node $node
Chris@0:      */
Chris@0:     public function leaveNode(Node $node)
Chris@0:     {
Chris@4:         if ($node instanceof ConstFetch && \count($node->name->parts) > 1) {
Chris@0:             $name = $this->getFullyQualifiedName($node->name);
Chris@4:             if (!\defined($name)) {
Chris@4:                 $msg = \sprintf('Undefined constant %s', $name);
Chris@0:                 throw new FatalErrorException($msg, 0, E_ERROR, null, $node->getLine());
Chris@0:             }
Chris@0:         } elseif ($node instanceof ClassConstFetch) {
Chris@0:             $this->validateClassConstFetchExpression($node);
Chris@0:         }
Chris@0:     }
Chris@0: 
Chris@0:     /**
Chris@0:      * Validate a class constant fetch expression.
Chris@0:      *
Chris@0:      * @throws FatalErrorException if a class constant is not defined
Chris@0:      *
Chris@0:      * @param ClassConstFetch $stmt
Chris@0:      */
Chris@0:     protected function validateClassConstFetchExpression(ClassConstFetch $stmt)
Chris@0:     {
Chris@0:         // For PHP Parser 4.x
Chris@0:         $constName = $stmt->name instanceof Identifier ? $stmt->name->toString() : $stmt->name;
Chris@0: 
Chris@0:         // give the `class` pseudo-constant a pass
Chris@0:         if ($constName === 'class') {
Chris@0:             return;
Chris@0:         }
Chris@0: 
Chris@0:         // if class name is an expression, give it a pass for now
Chris@0:         if (!$stmt->class instanceof Expr) {
Chris@0:             $className = $this->getFullyQualifiedName($stmt->class);
Chris@0: 
Chris@0:             // if the class doesn't exist, don't throw an exception… it might be
Chris@0:             // defined in the same line it's used or something stupid like that.
Chris@4:             if (\class_exists($className) || \interface_exists($className)) {
Chris@0:                 $refl = new \ReflectionClass($className);
Chris@0:                 if (!$refl->hasConstant($constName)) {
Chris@4:                     $constType = \class_exists($className) ? 'Class' : 'Interface';
Chris@4:                     $msg = \sprintf('%s constant \'%s::%s\' not found', $constType, $className, $constName);
Chris@0:                     throw new FatalErrorException($msg, 0, E_ERROR, null, $stmt->getLine());
Chris@0:                 }
Chris@0:             }
Chris@0:         }
Chris@0:     }
Chris@0: }