Chris@13: <?php
Chris@13: 
Chris@13: /*
Chris@13:  * This file is part of Psy Shell.
Chris@13:  *
Chris@13:  * (c) 2012-2018 Justin Hileman
Chris@13:  *
Chris@13:  * For the full copyright and license information, please view the LICENSE
Chris@13:  * file that was distributed with this source code.
Chris@13:  */
Chris@13: 
Chris@13: namespace Psy\Command;
Chris@13: 
Chris@13: use Psy\CodeCleaner\NoReturnValue;
Chris@13: use Psy\Context;
Chris@13: use Psy\ContextAware;
Chris@16: use Psy\Exception\ErrorException;
Chris@13: use Psy\Exception\RuntimeException;
Chris@13: use Psy\Util\Mirror;
Chris@13: 
Chris@13: /**
Chris@13:  * An abstract command with helpers for inspecting the current context.
Chris@13:  */
Chris@13: abstract class ReflectingCommand extends Command implements ContextAware
Chris@13: {
Chris@13:     const CLASS_OR_FUNC   = '/^[\\\\\w]+$/';
Chris@13:     const CLASS_MEMBER    = '/^([\\\\\w]+)::(\w+)$/';
Chris@13:     const CLASS_STATIC    = '/^([\\\\\w]+)::\$(\w+)$/';
Chris@13:     const INSTANCE_MEMBER = '/^(\$\w+)(::|->)(\w+)$/';
Chris@13: 
Chris@13:     /**
Chris@13:      * Context instance (for ContextAware interface).
Chris@13:      *
Chris@13:      * @var Context
Chris@13:      */
Chris@13:     protected $context;
Chris@13: 
Chris@13:     /**
Chris@13:      * ContextAware interface.
Chris@13:      *
Chris@13:      * @param Context $context
Chris@13:      */
Chris@13:     public function setContext(Context $context)
Chris@13:     {
Chris@13:         $this->context = $context;
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Get the target for a value.
Chris@13:      *
Chris@13:      * @throws \InvalidArgumentException when the value specified can't be resolved
Chris@13:      *
Chris@13:      * @param string $valueName Function, class, variable, constant, method or property name
Chris@13:      *
Chris@13:      * @return array (class or instance name, member name, kind)
Chris@13:      */
Chris@13:     protected function getTarget($valueName)
Chris@13:     {
Chris@17:         $valueName = \trim($valueName);
Chris@13:         $matches   = [];
Chris@13:         switch (true) {
Chris@17:             case \preg_match(self::CLASS_OR_FUNC, $valueName, $matches):
Chris@13:                 return [$this->resolveName($matches[0], true), null, 0];
Chris@13: 
Chris@17:             case \preg_match(self::CLASS_MEMBER, $valueName, $matches):
Chris@13:                 return [$this->resolveName($matches[1]), $matches[2], Mirror::CONSTANT | Mirror::METHOD];
Chris@13: 
Chris@17:             case \preg_match(self::CLASS_STATIC, $valueName, $matches):
Chris@13:                 return [$this->resolveName($matches[1]), $matches[2], Mirror::STATIC_PROPERTY | Mirror::PROPERTY];
Chris@13: 
Chris@17:             case \preg_match(self::INSTANCE_MEMBER, $valueName, $matches):
Chris@13:                 if ($matches[2] === '->') {
Chris@13:                     $kind = Mirror::METHOD | Mirror::PROPERTY;
Chris@13:                 } else {
Chris@13:                     $kind = Mirror::CONSTANT | Mirror::METHOD;
Chris@13:                 }
Chris@13: 
Chris@13:                 return [$this->resolveObject($matches[1]), $matches[3], $kind];
Chris@13: 
Chris@13:             default:
Chris@13:                 return [$this->resolveObject($valueName), null, 0];
Chris@13:         }
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Resolve a class or function name (with the current shell namespace).
Chris@13:      *
Chris@16:      * @throws ErrorException when `self` or `static` is used in a non-class scope
Chris@16:      *
Chris@13:      * @param string $name
Chris@13:      * @param bool   $includeFunctions (default: false)
Chris@13:      *
Chris@13:      * @return string
Chris@13:      */
Chris@13:     protected function resolveName($name, $includeFunctions = false)
Chris@13:     {
Chris@16:         $shell = $this->getApplication();
Chris@16: 
Chris@16:         // While not *technically* 100% accurate, let's treat `self` and `static` as equivalent.
Chris@17:         if (\in_array(\strtolower($name), ['self', 'static'])) {
Chris@16:             if ($boundClass = $shell->getBoundClass()) {
Chris@16:                 return $boundClass;
Chris@16:             }
Chris@16: 
Chris@16:             if ($boundObject = $shell->getBoundObject()) {
Chris@17:                 return \get_class($boundObject);
Chris@16:             }
Chris@16: 
Chris@17:             $msg = \sprintf('Cannot use "%s" when no class scope is active', \strtolower($name));
Chris@16:             throw new ErrorException($msg, 0, E_USER_ERROR, "eval()'d code", 1);
Chris@16:         }
Chris@16: 
Chris@17:         if (\substr($name, 0, 1) === '\\') {
Chris@13:             return $name;
Chris@13:         }
Chris@13: 
Chris@16:         if ($namespace = $shell->getNamespace()) {
Chris@13:             $fullName = $namespace . '\\' . $name;
Chris@13: 
Chris@17:             if (\class_exists($fullName) || \interface_exists($fullName) || ($includeFunctions && \function_exists($fullName))) {
Chris@13:                 return $fullName;
Chris@13:             }
Chris@13:         }
Chris@13: 
Chris@13:         return $name;
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Get a Reflector and documentation for a function, class or instance, constant, method or property.
Chris@13:      *
Chris@13:      * @param string $valueName Function, class, variable, constant, method or property name
Chris@13:      *
Chris@13:      * @return array (value, Reflector)
Chris@13:      */
Chris@13:     protected function getTargetAndReflector($valueName)
Chris@13:     {
Chris@13:         list($value, $member, $kind) = $this->getTarget($valueName);
Chris@13: 
Chris@13:         return [$value, Mirror::get($value, $member, $kind)];
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Resolve code to a value in the current scope.
Chris@13:      *
Chris@13:      * @throws RuntimeException when the code does not return a value in the current scope
Chris@13:      *
Chris@13:      * @param string $code
Chris@13:      *
Chris@13:      * @return mixed Variable value
Chris@13:      */
Chris@13:     protected function resolveCode($code)
Chris@13:     {
Chris@13:         try {
Chris@13:             $value = $this->getApplication()->execute($code, true);
Chris@13:         } catch (\Exception $e) {
Chris@13:             // Swallow all exceptions?
Chris@13:         }
Chris@13: 
Chris@13:         if (!isset($value) || $value instanceof NoReturnValue) {
Chris@13:             throw new RuntimeException('Unknown target: ' . $code);
Chris@13:         }
Chris@13: 
Chris@13:         return $value;
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Resolve code to an object in the current scope.
Chris@13:      *
Chris@13:      * @throws RuntimeException when the code resolves to a non-object value
Chris@13:      *
Chris@13:      * @param string $code
Chris@13:      *
Chris@13:      * @return object Variable instance
Chris@13:      */
Chris@13:     private function resolveObject($code)
Chris@13:     {
Chris@13:         $value = $this->resolveCode($code);
Chris@13: 
Chris@17:         if (!\is_object($value)) {
Chris@13:             throw new RuntimeException('Unable to inspect a non-object');
Chris@13:         }
Chris@13: 
Chris@13:         return $value;
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * @deprecated Use `resolveCode` instead
Chris@13:      *
Chris@13:      * @param string $name
Chris@13:      *
Chris@13:      * @return mixed Variable instance
Chris@13:      */
Chris@13:     protected function resolveInstance($name)
Chris@13:     {
Chris@17:         @\trigger_error('`resolveInstance` is deprecated; use `resolveCode` instead.', E_USER_DEPRECATED);
Chris@13: 
Chris@13:         return $this->resolveCode($name);
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Get a variable from the current shell scope.
Chris@13:      *
Chris@13:      * @param string $name
Chris@13:      *
Chris@13:      * @return mixed
Chris@13:      */
Chris@13:     protected function getScopeVariable($name)
Chris@13:     {
Chris@13:         return $this->context->get($name);
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Get all scope variables from the current shell scope.
Chris@13:      *
Chris@13:      * @return array
Chris@13:      */
Chris@13:     protected function getScopeVariables()
Chris@13:     {
Chris@13:         return $this->context->getAll();
Chris@13:     }
Chris@13: 
Chris@13:     /**
Chris@13:      * Given a Reflector instance, set command-scope variables in the shell
Chris@13:      * execution context. This is used to inject magic $__class, $__method and
Chris@13:      * $__file variables (as well as a handful of others).
Chris@13:      *
Chris@13:      * @param \Reflector $reflector
Chris@13:      */
Chris@13:     protected function setCommandScopeVariables(\Reflector $reflector)
Chris@13:     {
Chris@13:         $vars = [];
Chris@13: 
Chris@17:         switch (\get_class($reflector)) {
Chris@13:             case 'ReflectionClass':
Chris@13:             case 'ReflectionObject':
Chris@13:                 $vars['__class'] = $reflector->name;
Chris@13:                 if ($reflector->inNamespace()) {
Chris@13:                     $vars['__namespace'] = $reflector->getNamespaceName();
Chris@13:                 }
Chris@13:                 break;
Chris@13: 
Chris@13:             case 'ReflectionMethod':
Chris@17:                 $vars['__method'] = \sprintf('%s::%s', $reflector->class, $reflector->name);
Chris@13:                 $vars['__class'] = $reflector->class;
Chris@13:                 $classReflector = $reflector->getDeclaringClass();
Chris@13:                 if ($classReflector->inNamespace()) {
Chris@13:                     $vars['__namespace'] = $classReflector->getNamespaceName();
Chris@13:                 }
Chris@13:                 break;
Chris@13: 
Chris@13:             case 'ReflectionFunction':
Chris@13:                 $vars['__function'] = $reflector->name;
Chris@13:                 if ($reflector->inNamespace()) {
Chris@13:                     $vars['__namespace'] = $reflector->getNamespaceName();
Chris@13:                 }
Chris@13:                 break;
Chris@13: 
Chris@13:             case 'ReflectionGenerator':
Chris@13:                 $funcReflector = $reflector->getFunction();
Chris@13:                 $vars['__function'] = $funcReflector->name;
Chris@13:                 if ($funcReflector->inNamespace()) {
Chris@13:                     $vars['__namespace'] = $funcReflector->getNamespaceName();
Chris@13:                 }
Chris@13:                 if ($fileName = $reflector->getExecutingFile()) {
Chris@13:                     $vars['__file'] = $fileName;
Chris@13:                     $vars['__line'] = $reflector->getExecutingLine();
Chris@17:                     $vars['__dir']  = \dirname($fileName);
Chris@13:                 }
Chris@13:                 break;
Chris@13: 
Chris@13:             case 'ReflectionProperty':
Chris@16:             case 'ReflectionClassConstant':
Chris@16:             case 'Psy\Reflection\ReflectionClassConstant':
Chris@13:                 $classReflector = $reflector->getDeclaringClass();
Chris@13:                 $vars['__class'] = $classReflector->name;
Chris@13:                 if ($classReflector->inNamespace()) {
Chris@13:                     $vars['__namespace'] = $classReflector->getNamespaceName();
Chris@13:                 }
Chris@13:                 // no line for these, but this'll do
Chris@13:                 if ($fileName = $reflector->getDeclaringClass()->getFileName()) {
Chris@13:                     $vars['__file'] = $fileName;
Chris@17:                     $vars['__dir']  = \dirname($fileName);
Chris@13:                 }
Chris@13:                 break;
Chris@16: 
Chris@16:             case 'Psy\Reflection\ReflectionConstant_':
Chris@16:                 if ($reflector->inNamespace()) {
Chris@16:                     $vars['__namespace'] = $reflector->getNamespaceName();
Chris@16:                 }
Chris@16:                 break;
Chris@13:         }
Chris@13: 
Chris@13:         if ($reflector instanceof \ReflectionClass || $reflector instanceof \ReflectionFunctionAbstract) {
Chris@13:             if ($fileName = $reflector->getFileName()) {
Chris@13:                 $vars['__file'] = $fileName;
Chris@13:                 $vars['__line'] = $reflector->getStartLine();
Chris@17:                 $vars['__dir']  = \dirname($fileName);
Chris@13:             }
Chris@13:         }
Chris@13: 
Chris@13:         $this->context->setCommandScopeVariables($vars);
Chris@13:     }
Chris@13: }